Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sources:
sourceBlobDigest: sha256:c405cfc4f2de092323a9dd68a09f7c08b563d363bce7463fc8b426d10acacf99
tags:
- latest
- speakeasy-sdk-regen-1756922597
- 0.0.1
targets:
outpost-go:
Expand All @@ -25,10 +26,10 @@ targets:
outpost-ts:
source: Outpost API
sourceNamespace: outpost-api
sourceRevisionDigest: sha256:837897b6e2774d7ba547d9616639367bfce651d53d84190c3ee0cd32cee7e8b1
sourceBlobDigest: sha256:3b1cd63370e0cf368a2049eaa26c9f94cd94a929de42592f8488adb5a6a3f182
sourceRevisionDigest: sha256:e09cf02de047cf6d007545274c477e2a90c561074b9de170d844d9ab9ffbbca6
sourceBlobDigest: sha256:c405cfc4f2de092323a9dd68a09f7c08b563d363bce7463fc8b426d10acacf99
codeSamplesNamespace: outpost-api-typescript-code-samples
codeSamplesRevisionDigest: sha256:73273078c2416ff9b541f2cc8e95cf2a8254fc9ae40d2788122ca4f3e7e74416
codeSamplesRevisionDigest: sha256:b1155400f3addb67547999bf99f4eb4f009470ab62329d57488f78843ff6f9b6
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
45 changes: 33 additions & 12 deletions sdks/outpost-typescript/.speakeasy/gen.lock
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
lockVersion: 2.0.0
id: edb58086-83b9-45a3-9095-52bf57a11009
management:
docChecksum: 3d3f028a2fdd56804d9ae8a2d95a414b
docChecksum: f88900fa0dfdee97044181ff0fbb5027
docVersion: 0.0.1
speakeasyVersion: 1.593.0
generationVersion: 2.669.0
releaseVersion: 0.3.0
configChecksum: f5c74e03d72ead5a348c5b677ad4b9cc
speakeasyVersion: 1.609.0
generationVersion: 2.692.0
releaseVersion: 0.4.0
configChecksum: 261fce5d39cf94a38cacbbd5e21d37f2
repoURL: https://github.com/hookdeck/outpost.git
repoSubDirectory: sdks/outpost-typescript
installationURL: https://gitpkg.now.sh/hookdeck/outpost/sdks/outpost-typescript
Expand All @@ -15,7 +15,8 @@ features:
typescript:
additionalDependencies: 0.1.0
additionalProperties: 0.1.1
core: 3.21.17
constsAndDefaults: 0.1.12
core: 3.21.22
defaultEnabledRetries: 0.1.0
enumUnions: 0.1.0
envVarSecurityUsage: 0.1.2
Expand All @@ -26,6 +27,7 @@ features:
mcpServer: 0.9.3
nameOverrides: 2.81.2
nullables: 0.1.1
pagination: 2.83.0
responseFormat: 0.2.3
retries: 2.83.0
sdkHooks: 0.3.0
Expand All @@ -39,6 +41,8 @@ generatedFiles:
- docs/lib/utils/retryconfig.md
- docs/models/components/awskinesisconfig.md
- docs/models/components/awskinesiscredentials.md
- docs/models/components/awss3config.md
- docs/models/components/awss3credentials.md
- docs/models/components/awssqsconfig.md
- docs/models/components/awssqscredentials.md
- docs/models/components/azureservicebusconfig.md
Expand All @@ -47,13 +51,17 @@ generatedFiles:
- docs/models/components/destination.md
- docs/models/components/destinationawskinesis.md
- docs/models/components/destinationawskinesistype.md
- docs/models/components/destinationawss3.md
- docs/models/components/destinationawss3type.md
- docs/models/components/destinationawssqs.md
- docs/models/components/destinationawssqstype.md
- docs/models/components/destinationazureservicebus.md
- docs/models/components/destinationazureservicebustype.md
- docs/models/components/destinationcreate.md
- docs/models/components/destinationcreateawskinesis.md
- docs/models/components/destinationcreateawskinesistype.md
- docs/models/components/destinationcreateawss3.md
- docs/models/components/destinationcreateawss3type.md
- docs/models/components/destinationcreateawssqs.md
- docs/models/components/destinationcreateawssqstype.md
- docs/models/components/destinationcreateazureservicebus.md
Expand All @@ -73,6 +81,7 @@ generatedFiles:
- docs/models/components/destinationtypeschema.md
- docs/models/components/destinationupdate.md
- docs/models/components/destinationupdateawskinesis.md
- docs/models/components/destinationupdateawss3.md
- docs/models/components/destinationupdateawssqs.md
- docs/models/components/destinationupdatehookdeck.md
- docs/models/components/destinationupdaterabbitmq.md
Expand Down Expand Up @@ -141,9 +150,13 @@ generatedFiles:
- docs/models/operations/listtenanteventdeliveriesrequest.md
- docs/models/operations/listtenanteventsbydestinationglobals.md
- docs/models/operations/listtenanteventsbydestinationrequest.md
- docs/models/operations/listtenanteventsbydestinationresponse.md
- docs/models/operations/listtenanteventsbydestinationresponsebody.md
- docs/models/operations/listtenanteventsbydestinationstatus.md
- docs/models/operations/listtenanteventsglobals.md
- docs/models/operations/listtenanteventsrequest.md
- docs/models/operations/listtenanteventsresponse.md
- docs/models/operations/listtenanteventsresponsebody.md
- docs/models/operations/listtenanteventsstatus.md
- docs/models/operations/listtenanttopicsglobals.md
- docs/models/operations/listtenanttopicsrequest.md
Expand Down Expand Up @@ -259,17 +272,21 @@ generatedFiles:
- src/mcp-server/tools/topicsListJwt.ts
- src/models/components/awskinesisconfig.ts
- src/models/components/awskinesiscredentials.ts
- src/models/components/awss3config.ts
- src/models/components/awss3credentials.ts
- src/models/components/awssqsconfig.ts
- src/models/components/awssqscredentials.ts
- src/models/components/azureservicebusconfig.ts
- src/models/components/azureservicebuscredentials.ts
- src/models/components/deliveryattempt.ts
- src/models/components/destination.ts
- src/models/components/destinationawskinesis.ts
- src/models/components/destinationawss3.ts
- src/models/components/destinationawssqs.ts
- src/models/components/destinationazureservicebus.ts
- src/models/components/destinationcreate.ts
- src/models/components/destinationcreateawskinesis.ts
- src/models/components/destinationcreateawss3.ts
- src/models/components/destinationcreateawssqs.ts
- src/models/components/destinationcreateazureservicebus.ts
- src/models/components/destinationcreatehookdeck.ts
Expand All @@ -281,6 +298,7 @@ generatedFiles:
- src/models/components/destinationtypeschema.ts
- src/models/components/destinationupdate.ts
- src/models/components/destinationupdateawskinesis.ts
- src/models/components/destinationupdateawss3.ts
- src/models/components/destinationupdateawssqs.ts
- src/models/components/destinationupdatehookdeck.ts
- src/models/components/destinationupdaterabbitmq.ts
Expand Down Expand Up @@ -431,7 +449,7 @@ examples:
query: {}
responses:
"200":
application/json: [{"id": "des_webhook_123", "type": "webhook", "topics": ["user.created", "order.shipped"], "disabled_at": null, "created_at": "2024-02-15T10:00:00Z", "config": {"url": "https://my-service.com/webhook/handler"}, "credentials": {"secret": "whsec_abc123def456", "previous_secret": "whsec_prev789xyz012", "previous_secret_invalid_at": "2024-02-16T10:00:00Z"}}, {"id": "des_sqs_456", "type": "aws_sqs", "topics": ["*"], "disabled_at": "2024-03-01T12:00:00Z", "created_at": "2024-02-20T11:30:00Z", "config": {"endpoint": "https://sqs.us-west-2.amazonaws.com", "queue_url": "https://sqs.us-west-2.amazonaws.com/123456789012/my-app-queue"}, "credentials": {"key": "AKIAIOSFODNN7EXAMPLE", "secret": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"}}]
application/json: [{"id": "des_webhook_123", "type": "webhook", "topics": ["user.created", "order.shipped"], "disabled_at": null, "created_at": "2024-02-15T10:00:00Z", "config": {"url": "https://my-service.com/webhook/handler"}, "credentials": {"secret": "whsec_abc123def456", "previous_secret": "whsec_prev789xyz012", "previous_secret_invalid_at": "2024-02-16T10:00:00Z"}}, {"id": "des_sqs_456", "type": "aws_sqs", "topics": ["*"], "disabled_at": "2024-03-01T12:00:00Z", "created_at": "2024-02-20T11:30:00Z", "config": {"endpoint": "https://sqs.us-west-2.amazonaws.com", "queue_url": "https://sqs.us-west-2.amazonaws.com/123456789012/my-app-queue"}, "credentials": {"key": "AKIAIOSFODNN7EXAMPLE", "secret": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"}}, {"id": "des_s3_789", "type": "aws_s3", "topics": ["*"], "disabled_at": null, "created_at": "2024-03-20T12:00:00Z", "config": {"bucket": "my-bucket", "region": "us-east-1"}, "credentials": {"key": "AKIAIOSFODNN7EXAMPLE", "secret": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"}}]
createTenantDestination:
WebhookCreatedExample:
parameters:
Expand Down Expand Up @@ -523,7 +541,7 @@ examples:
tenant_id: "<id>"
responses:
"200":
application/json: [{"type": "webhook", "label": "Webhook", "description": "Send event via an HTTP POST request to a URL", "icon": "<svg />", "instructions": "Enter the URL...", "config_fields": [{"type": "text", "label": "URL", "description": "The URL to send the webhook to.", "required": true, "pattern": "^https?://.*"}], "credential_fields": [{"type": "text", "label": "Secret", "description": "Optional signing secret.", "required": false, "sensitive": true}]}, {"type": "aws_sqs", "label": "AWS SQS", "description": "Send event to an AWS SQS queue", "icon": "<svg />", "instructions": "Enter Queue URL...", "config_fields": [{"type": "text", "label": "Queue URL", "description": "The URL of the SQS queue.", "required": true}, {"type": "text", "label": "Endpoint", "description": "Optional custom AWS endpoint URL.", "required": false}], "credential_fields": [{"type": "text", "label": "Key", "description": "AWS Access Key ID.", "required": true, "sensitive": true}, {"type": "text", "label": "Secret", "description": "AWS Secret Access Key.", "required": true, "sensitive": true}, {"type": "text", "label": "Session", "description": "Optional AWS Session Token.", "required": false, "sensitive": true}]}]
application/json: [{"type": "webhook", "label": "Webhook", "description": "Send event via an HTTP POST request to a URL", "icon": "<svg />", "instructions": "Enter the URL...", "config_fields": [{"type": "text", "label": "URL", "description": "The URL to send the webhook to.", "required": true, "pattern": "^https?://.*"}], "credential_fields": [{"type": "text", "label": "Secret", "description": "Optional signing secret.", "required": false, "sensitive": true}]}, {"type": "aws_sqs", "label": "AWS SQS", "description": "Send event to an AWS SQS queue", "icon": "<svg />", "instructions": "Enter Queue URL...", "config_fields": [{"type": "text", "label": "Queue URL", "description": "The URL of the SQS queue.", "required": true}, {"type": "text", "label": "Endpoint", "description": "Optional custom AWS endpoint URL.", "required": false}], "credential_fields": [{"type": "text", "label": "Key", "description": "AWS Access Key ID.", "required": true, "sensitive": true}, {"type": "text", "label": "Secret", "description": "AWS Secret Access Key.", "required": true, "sensitive": true}, {"type": "text", "label": "Session", "description": "Optional AWS Session Token.", "required": false, "sensitive": true}]}, {"type": "aws_s3", "label": "AWS S3", "description": "Store events in an Amazon S3 bucket", "icon": "<svg />", "instructions": "Enter bucket and region...", "config_fields": [{"type": "text", "label": "Bucket Name", "description": "The name of the S3 bucket.", "required": true}, {"type": "text", "label": "AWS Region", "description": "The AWS region where the bucket is located.", "required": true}], "credential_fields": [{"type": "text", "label": "Key", "description": "AWS Access Key ID.", "required": true, "sensitive": true}, {"type": "text", "label": "Secret", "description": "AWS Secret Access Key.", "required": true, "sensitive": true}]}, {"type": "aws_s3", "label": "AWS S3", "description": "Store events in an Amazon S3 bucket", "icon": "<svg />", "instructions": "Enter bucket and region...", "config_fields": [{"type": "text", "label": "Bucket Name", "description": "The name of the S3 bucket.", "required": true}, {"type": "text", "label": "AWS Region", "description": "The AWS region where the bucket is located.", "required": true}], "credential_fields": [{"type": "text", "label": "Key", "description": "AWS Access Key ID.", "required": true, "sensitive": true}, {"type": "text", "label": "Secret", "description": "AWS Secret Access Key.", "required": true, "sensitive": true}]}]
getTenantDestinationTypeSchema:
WebhookSchemaExample:
parameters:
Expand Down Expand Up @@ -564,10 +582,11 @@ examples:
parameters:
path:
tenant_id: "<id>"
query: {}
query:
limit: 100
responses:
"200":
application/json: [{"id": "evt_123", "destination_id": "des_456", "topic": "user.created", "time": "2024-01-01T00:00:00Z", "successful_at": "2024-01-01T00:00:05Z", "metadata": {"source": "crm"}, "data": {"user_id": "userid", "status": "active"}}, {"id": "evt_789", "destination_id": "des_456", "topic": "order.shipped", "time": "2024-01-02T10:00:00Z", "successful_at": null, "metadata": {"source": "oms"}, "data": {"order_id": "orderid", "tracking": "1Z..."}}]
application/json: {"count": 2, "data": [{"id": "evt_123", "destination_id": "des_456", "topic": "user.created", "time": "2024-01-01T00:00:00Z", "successful_at": "2024-01-01T00:00:05Z", "metadata": {"source": "crm"}, "data": {"user_id": "userid", "status": "active"}}, {"id": "evt_789", "destination_id": "des_456", "topic": "order.shipped", "time": "2024-01-02T10:00:00Z", "successful_at": null, "metadata": {"source": "oms"}, "data": {"order_id": "orderid", "tracking": "1Z..."}}], "next": "", "prev": ""}
getTenantEvent:
EventExample:
parameters:
Expand All @@ -592,10 +611,11 @@ examples:
path:
tenant_id: "<id>"
destination_id: "<id>"
query: {}
query:
limit: 100
responses:
"200":
application/json: [{"id": "evt_123", "destination_id": "des_456", "topic": "user.created", "time": "2024-01-01T00:00:00Z", "successful_at": "2024-01-01T00:00:05Z", "metadata": {"source": "crm"}, "data": {"user_id": "userid", "status": "active"}}, {"id": "evt_789", "destination_id": "des_456", "topic": "order.shipped", "time": "2024-01-02T10:00:00Z", "successful_at": null, "metadata": {"source": "oms"}, "data": {"order_id": "orderid", "tracking": "1Z..."}}]
application/json: {"count": 2, "data": [{"id": "evt_123", "destination_id": "des_456", "topic": "user.created", "time": "2024-01-01T00:00:00Z", "successful_at": "2024-01-01T00:00:05Z", "metadata": {"source": "crm"}, "data": {"user_id": "userid", "status": "active"}}, {"id": "evt_789", "destination_id": "des_456", "topic": "order.shipped", "time": "2024-01-02T10:00:00Z", "successful_at": null, "metadata": {"source": "oms"}, "data": {"order_id": "orderid", "tracking": "1Z..."}}], "next": "", "prev": ""}
getTenantEventByDestination:
EventExample:
parameters:
Expand Down Expand Up @@ -634,3 +654,4 @@ examples:
application/json: {}
examplesVersion: 1.0.2
generatedTests: {}
releaseNotes: "## Typescript SDK Changes Detected:\n* `outpost.events.list()`: \n * `request` **Changed**\n * `response` **Changed** **Breaking** :warning:\n* `outpost.events.listByDestination()`: \n * `request` **Changed**\n * `response` **Changed** **Breaking** :warning:\n* `outpost.destinations.list()`: \n * `request.type` **Changed**\n * `response.[].[awsS3]` **Added**\n* `outpost.destinations.create()`: \n * `request.destinationCreate.[awsS3]` **Added**\n * `response.[aws_s3]` **Added**\n* `outpost.destinations.get()`: `response.[aws_s3]` **Added**\n* `outpost.destinations.update()`: \n * `request.destinationUpdate.[destinationUpdateAwss3]` **Added**\n * `response.[destination].[awsS3]` **Added**\n* `outpost.destinations.enable()`: `response.[aws_s3]` **Added**\n* `outpost.destinations.disable()`: `response.[aws_s3]` **Added**\n* `outpost.schemas.get()`: \n * `request.type` **Changed**\n* `outpost.schemas.getDestinationTypeJwt()`: \n * `request.type` **Changed**\n"
3 changes: 2 additions & 1 deletion sdks/outpost-typescript/.speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ generation:
generateNewTests: false
skipResponseBodyAssertions: false
typescript:
version: 0.3.0
version: 0.4.0
additionalDependencies:
dependencies: {}
devDependencies: {}
Expand Down Expand Up @@ -56,4 +56,5 @@ typescript:
packageName: '@hookdeck/outpost-sdk'
responseFormat: flat
templateVersion: v2
usageSDKInitImports: []
useIndexModules: true
36 changes: 36 additions & 0 deletions sdks/outpost-typescript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Outpost API: The Outpost API is a REST-based JSON API for managing tenants, dest
* [Available Resources and Operations](#available-resources-and-operations)
* [Standalone functions](#standalone-functions)
* [Global Parameters](#global-parameters)
* [Pagination](#pagination)
* [Retries](#retries)
* [Error Handling](#error-handling)
* [Server Selection](#server-selection)
Expand Down Expand Up @@ -362,6 +363,41 @@ run();
```
<!-- End Global Parameters [global-parameters] -->

<!-- Start Pagination [pagination] -->
## Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you
make your SDK calls as usual, but the returned response object will also be an
async iterable that can be consumed using the [`for await...of`][for-await-of]
syntax.

[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of

Here's an example of one such pagination call:

```typescript
import { Outpost } from "@hookdeck/outpost-sdk";

const outpost = new Outpost({
tenantId: "<id>",
security: {
adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
},
});

async function run() {
const result = await outpost.events.list({});

for await (const page of result) {
console.log(page);
}
}

run();

```
<!-- End Pagination [pagination] -->

<!-- Start Retries [retries] -->
## Retries

Expand Down
12 changes: 11 additions & 1 deletion sdks/outpost-typescript/RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,14 @@ Based on:
### Generated
- [typescript v0.3.0] sdks/outpost-typescript
### Releases
- [NPM v0.3.0] https://www.npmjs.com/package/@hookdeck/outpost-sdk/v/0.3.0 - sdks/outpost-typescript
- [NPM v0.3.0] https://www.npmjs.com/package/@hookdeck/outpost-sdk/v/0.3.0 - sdks/outpost-typescript

## 2025-09-03 18:02:59
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.609.0 (2.692.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.4.0] sdks/outpost-typescript
### Releases
- [NPM v0.4.0] https://www.npmjs.com/package/@hookdeck/outpost-sdk/v/0.4.0 - sdks/outpost-typescript
Loading