Skip to content

Commit d53a1c2

Browse files
authored
Merge pull request #479 from hookdeck/speakeasy-sdk-regen-1756922597
chore: 🐝 Update SDK - Generate OUTPOST-TS 0.4.0
2 parents 04fbda6 + 6920309 commit d53a1c2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+1849
-160
lines changed

.speakeasy/workflow.lock

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ sources:
66
sourceBlobDigest: sha256:c405cfc4f2de092323a9dd68a09f7c08b563d363bce7463fc8b426d10acacf99
77
tags:
88
- latest
9+
- speakeasy-sdk-regen-1756922597
910
- 0.0.1
1011
targets:
1112
outpost-go:
@@ -25,10 +26,10 @@ targets:
2526
outpost-ts:
2627
source: Outpost API
2728
sourceNamespace: outpost-api
28-
sourceRevisionDigest: sha256:837897b6e2774d7ba547d9616639367bfce651d53d84190c3ee0cd32cee7e8b1
29-
sourceBlobDigest: sha256:3b1cd63370e0cf368a2049eaa26c9f94cd94a929de42592f8488adb5a6a3f182
29+
sourceRevisionDigest: sha256:e09cf02de047cf6d007545274c477e2a90c561074b9de170d844d9ab9ffbbca6
30+
sourceBlobDigest: sha256:c405cfc4f2de092323a9dd68a09f7c08b563d363bce7463fc8b426d10acacf99
3031
codeSamplesNamespace: outpost-api-typescript-code-samples
31-
codeSamplesRevisionDigest: sha256:73273078c2416ff9b541f2cc8e95cf2a8254fc9ae40d2788122ca4f3e7e74416
32+
codeSamplesRevisionDigest: sha256:b1155400f3addb67547999bf99f4eb4f009470ab62329d57488f78843ff6f9b6
3233
workflow:
3334
workflowVersion: 1.0.0
3435
speakeasyVersion: latest

sdks/outpost-typescript/.speakeasy/gen.lock

Lines changed: 33 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
lockVersion: 2.0.0
22
id: edb58086-83b9-45a3-9095-52bf57a11009
33
management:
4-
docChecksum: 3d3f028a2fdd56804d9ae8a2d95a414b
4+
docChecksum: f88900fa0dfdee97044181ff0fbb5027
55
docVersion: 0.0.1
6-
speakeasyVersion: 1.593.0
7-
generationVersion: 2.669.0
8-
releaseVersion: 0.3.0
9-
configChecksum: f5c74e03d72ead5a348c5b677ad4b9cc
6+
speakeasyVersion: 1.609.0
7+
generationVersion: 2.692.0
8+
releaseVersion: 0.4.0
9+
configChecksum: 261fce5d39cf94a38cacbbd5e21d37f2
1010
repoURL: https://github.com/hookdeck/outpost.git
1111
repoSubDirectory: sdks/outpost-typescript
1212
installationURL: https://gitpkg.now.sh/hookdeck/outpost/sdks/outpost-typescript
@@ -15,7 +15,8 @@ features:
1515
typescript:
1616
additionalDependencies: 0.1.0
1717
additionalProperties: 0.1.1
18-
core: 3.21.17
18+
constsAndDefaults: 0.1.12
19+
core: 3.21.22
1920
defaultEnabledRetries: 0.1.0
2021
enumUnions: 0.1.0
2122
envVarSecurityUsage: 0.1.2
@@ -26,6 +27,7 @@ features:
2627
mcpServer: 0.9.3
2728
nameOverrides: 2.81.2
2829
nullables: 0.1.1
30+
pagination: 2.83.0
2931
responseFormat: 0.2.3
3032
retries: 2.83.0
3133
sdkHooks: 0.3.0
@@ -39,6 +41,8 @@ generatedFiles:
3941
- docs/lib/utils/retryconfig.md
4042
- docs/models/components/awskinesisconfig.md
4143
- docs/models/components/awskinesiscredentials.md
44+
- docs/models/components/awss3config.md
45+
- docs/models/components/awss3credentials.md
4246
- docs/models/components/awssqsconfig.md
4347
- docs/models/components/awssqscredentials.md
4448
- docs/models/components/azureservicebusconfig.md
@@ -47,13 +51,17 @@ generatedFiles:
4751
- docs/models/components/destination.md
4852
- docs/models/components/destinationawskinesis.md
4953
- docs/models/components/destinationawskinesistype.md
54+
- docs/models/components/destinationawss3.md
55+
- docs/models/components/destinationawss3type.md
5056
- docs/models/components/destinationawssqs.md
5157
- docs/models/components/destinationawssqstype.md
5258
- docs/models/components/destinationazureservicebus.md
5359
- docs/models/components/destinationazureservicebustype.md
5460
- docs/models/components/destinationcreate.md
5561
- docs/models/components/destinationcreateawskinesis.md
5662
- docs/models/components/destinationcreateawskinesistype.md
63+
- docs/models/components/destinationcreateawss3.md
64+
- docs/models/components/destinationcreateawss3type.md
5765
- docs/models/components/destinationcreateawssqs.md
5866
- docs/models/components/destinationcreateawssqstype.md
5967
- docs/models/components/destinationcreateazureservicebus.md
@@ -73,6 +81,7 @@ generatedFiles:
7381
- docs/models/components/destinationtypeschema.md
7482
- docs/models/components/destinationupdate.md
7583
- docs/models/components/destinationupdateawskinesis.md
84+
- docs/models/components/destinationupdateawss3.md
7685
- docs/models/components/destinationupdateawssqs.md
7786
- docs/models/components/destinationupdatehookdeck.md
7887
- docs/models/components/destinationupdaterabbitmq.md
@@ -141,9 +150,13 @@ generatedFiles:
141150
- docs/models/operations/listtenanteventdeliveriesrequest.md
142151
- docs/models/operations/listtenanteventsbydestinationglobals.md
143152
- docs/models/operations/listtenanteventsbydestinationrequest.md
153+
- docs/models/operations/listtenanteventsbydestinationresponse.md
154+
- docs/models/operations/listtenanteventsbydestinationresponsebody.md
144155
- docs/models/operations/listtenanteventsbydestinationstatus.md
145156
- docs/models/operations/listtenanteventsglobals.md
146157
- docs/models/operations/listtenanteventsrequest.md
158+
- docs/models/operations/listtenanteventsresponse.md
159+
- docs/models/operations/listtenanteventsresponsebody.md
147160
- docs/models/operations/listtenanteventsstatus.md
148161
- docs/models/operations/listtenanttopicsglobals.md
149162
- docs/models/operations/listtenanttopicsrequest.md
@@ -259,17 +272,21 @@ generatedFiles:
259272
- src/mcp-server/tools/topicsListJwt.ts
260273
- src/models/components/awskinesisconfig.ts
261274
- src/models/components/awskinesiscredentials.ts
275+
- src/models/components/awss3config.ts
276+
- src/models/components/awss3credentials.ts
262277
- src/models/components/awssqsconfig.ts
263278
- src/models/components/awssqscredentials.ts
264279
- src/models/components/azureservicebusconfig.ts
265280
- src/models/components/azureservicebuscredentials.ts
266281
- src/models/components/deliveryattempt.ts
267282
- src/models/components/destination.ts
268283
- src/models/components/destinationawskinesis.ts
284+
- src/models/components/destinationawss3.ts
269285
- src/models/components/destinationawssqs.ts
270286
- src/models/components/destinationazureservicebus.ts
271287
- src/models/components/destinationcreate.ts
272288
- src/models/components/destinationcreateawskinesis.ts
289+
- src/models/components/destinationcreateawss3.ts
273290
- src/models/components/destinationcreateawssqs.ts
274291
- src/models/components/destinationcreateazureservicebus.ts
275292
- src/models/components/destinationcreatehookdeck.ts
@@ -281,6 +298,7 @@ generatedFiles:
281298
- src/models/components/destinationtypeschema.ts
282299
- src/models/components/destinationupdate.ts
283300
- src/models/components/destinationupdateawskinesis.ts
301+
- src/models/components/destinationupdateawss3.ts
284302
- src/models/components/destinationupdateawssqs.ts
285303
- src/models/components/destinationupdatehookdeck.ts
286304
- src/models/components/destinationupdaterabbitmq.ts
@@ -431,7 +449,7 @@ examples:
431449
query: {}
432450
responses:
433451
"200":
434-
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"}}]
452+
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"}}]
435453
createTenantDestination:
436454
WebhookCreatedExample:
437455
parameters:
@@ -523,7 +541,7 @@ examples:
523541
tenant_id: "<id>"
524542
responses:
525543
"200":
526-
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}]}]
544+
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}]}]
527545
getTenantDestinationTypeSchema:
528546
WebhookSchemaExample:
529547
parameters:
@@ -564,10 +582,11 @@ examples:
564582
parameters:
565583
path:
566584
tenant_id: "<id>"
567-
query: {}
585+
query:
586+
limit: 100
568587
responses:
569588
"200":
570-
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..."}}]
589+
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": ""}
571590
getTenantEvent:
572591
EventExample:
573592
parameters:
@@ -592,10 +611,11 @@ examples:
592611
path:
593612
tenant_id: "<id>"
594613
destination_id: "<id>"
595-
query: {}
614+
query:
615+
limit: 100
596616
responses:
597617
"200":
598-
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..."}}]
618+
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": ""}
599619
getTenantEventByDestination:
600620
EventExample:
601621
parameters:
@@ -634,3 +654,4 @@ examples:
634654
application/json: {}
635655
examplesVersion: 1.0.2
636656
generatedTests: {}
657+
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"

sdks/outpost-typescript/.speakeasy/gen.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ generation:
2121
generateNewTests: false
2222
skipResponseBodyAssertions: false
2323
typescript:
24-
version: 0.3.0
24+
version: 0.4.0
2525
additionalDependencies:
2626
dependencies: {}
2727
devDependencies: {}
@@ -56,4 +56,5 @@ typescript:
5656
packageName: '@hookdeck/outpost-sdk'
5757
responseFormat: flat
5858
templateVersion: v2
59+
usageSDKInitImports: []
5960
useIndexModules: true

sdks/outpost-typescript/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ Outpost API: The Outpost API is a REST-based JSON API for managing tenants, dest
2626
* [Available Resources and Operations](#available-resources-and-operations)
2727
* [Standalone functions](#standalone-functions)
2828
* [Global Parameters](#global-parameters)
29+
* [Pagination](#pagination)
2930
* [Retries](#retries)
3031
* [Error Handling](#error-handling)
3132
* [Server Selection](#server-selection)
@@ -362,6 +363,41 @@ run();
362363
```
363364
<!-- End Global Parameters [global-parameters] -->
364365

366+
<!-- Start Pagination [pagination] -->
367+
## Pagination
368+
369+
Some of the endpoints in this SDK support pagination. To use pagination, you
370+
make your SDK calls as usual, but the returned response object will also be an
371+
async iterable that can be consumed using the [`for await...of`][for-await-of]
372+
syntax.
373+
374+
[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
375+
376+
Here's an example of one such pagination call:
377+
378+
```typescript
379+
import { Outpost } from "@hookdeck/outpost-sdk";
380+
381+
const outpost = new Outpost({
382+
tenantId: "<id>",
383+
security: {
384+
adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
385+
},
386+
});
387+
388+
async function run() {
389+
const result = await outpost.events.list({});
390+
391+
for await (const page of result) {
392+
console.log(page);
393+
}
394+
}
395+
396+
run();
397+
398+
```
399+
<!-- End Pagination [pagination] -->
400+
365401
<!-- Start Retries [retries] -->
366402
## Retries
367403

sdks/outpost-typescript/RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,14 @@ Based on:
2828
### Generated
2929
- [typescript v0.3.0] sdks/outpost-typescript
3030
### Releases
31-
- [NPM v0.3.0] https://www.npmjs.com/package/@hookdeck/outpost-sdk/v/0.3.0 - sdks/outpost-typescript
31+
- [NPM v0.3.0] https://www.npmjs.com/package/@hookdeck/outpost-sdk/v/0.3.0 - sdks/outpost-typescript
32+
33+
## 2025-09-03 18:02:59
34+
### Changes
35+
Based on:
36+
- OpenAPI Doc
37+
- Speakeasy CLI 1.609.0 (2.692.0) https://github.com/speakeasy-api/speakeasy
38+
### Generated
39+
- [typescript v0.4.0] sdks/outpost-typescript
40+
### Releases
41+
- [NPM v0.4.0] https://www.npmjs.com/package/@hookdeck/outpost-sdk/v/0.4.0 - sdks/outpost-typescript

0 commit comments

Comments
 (0)