Skip to content

Commit 344fbe8

Browse files
authored
Merge pull request #641 from hookdeck/speakeasy-sdk-regen-1768569631
chore: 🐝 Update SDK - Generate OUTPOST-TS 0.6.0
2 parents 0312985 + 3a689a4 commit 344fbe8

File tree

238 files changed

+5930
-6226
lines changed

Some content is hidden

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

238 files changed

+5930
-6226
lines changed

.speakeasy/workflow.lock

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sources:
66
sourceBlobDigest: sha256:e3b85ac9da28706696320ca22b6ca215624531b31c3d79474802b1dbf485bd4d
77
tags:
88
- latest
9-
- speakeasy-sdk-regen-1768565776
9+
- speakeasy-sdk-regen-1768569631
1010
- 0.0.1
1111
Outpost API (Python):
1212
sourceNamespace: outpost-api
@@ -37,7 +37,7 @@ targets:
3737
sourceRevisionDigest: sha256:1534dabb139bd405d19820be4eddbd8540fc924fa5a267332a7296f8663dd15a
3838
sourceBlobDigest: sha256:e3b85ac9da28706696320ca22b6ca215624531b31c3d79474802b1dbf485bd4d
3939
codeSamplesNamespace: outpost-api-typescript-code-samples
40-
codeSamplesRevisionDigest: sha256:e84a77ce14d887b056d89141a76a7f58be0c6b48bfb370390564d1a9e58f1265
40+
codeSamplesRevisionDigest: sha256:e4836ddc6ae9b814e565d258fb1c82739b633df197e95c217a595c7e09bebf2e
4141
workflow:
4242
workflowVersion: 1.0.0
4343
speakeasyVersion: latest

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

Lines changed: 1839 additions & 378 deletions
Large diffs are not rendered by default.

sdks/outpost-typescript/README.md

Lines changed: 21 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ 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)
3029
* [Retries](#retries)
3130
* [Error Handling](#error-handling)
3231
* [Server Selection](#server-selection)
@@ -225,7 +224,7 @@ run();
225224
<details open>
226225
<summary>Available methods</summary>
227226

228-
### [destinations](docs/sdks/destinations/README.md)
227+
### [Destinations](docs/sdks/destinations/README.md)
229228

230229
* [list](docs/sdks/destinations/README.md#list) - List Destinations
231230
* [create](docs/sdks/destinations/README.md#create) - Create Destination
@@ -235,7 +234,7 @@ run();
235234
* [enable](docs/sdks/destinations/README.md#enable) - Enable Destination
236235
* [disable](docs/sdks/destinations/README.md#disable) - Disable Destination
237236

238-
### [events](docs/sdks/events/README.md)
237+
### [Events](docs/sdks/events/README.md)
239238

240239
* [list](docs/sdks/events/README.md#list) - List Events
241240
* [get](docs/sdks/events/README.md#get) - Get Event
@@ -244,30 +243,31 @@ run();
244243
* [getByDestination](docs/sdks/events/README.md#getbydestination) - Get Event by Destination
245244
* [retry](docs/sdks/events/README.md#retry) - Retry Event Delivery
246245

247-
### [health](docs/sdks/health/README.md)
246+
### [Health](docs/sdks/health/README.md)
248247

249248
* [check](docs/sdks/health/README.md#check) - Health Check
250249

251-
### [publish](docs/sdks/publish/README.md)
250+
### [Publish](docs/sdks/publish/README.md)
252251

253252
* [event](docs/sdks/publish/README.md#event) - Publish Event
254253

255-
### [schemas](docs/sdks/schemas/README.md)
254+
### [Schemas](docs/sdks/schemas/README.md)
256255

257256
* [listTenantDestinationTypes](docs/sdks/schemas/README.md#listtenantdestinationtypes) - List Destination Type Schemas (for Tenant)
258257
* [get](docs/sdks/schemas/README.md#get) - Get Destination Type Schema (for Tenant)
259258
* [listDestinationTypesJwt](docs/sdks/schemas/README.md#listdestinationtypesjwt) - List Destination Type Schemas (JWT Auth)
260259
* [getDestinationTypeJwt](docs/sdks/schemas/README.md#getdestinationtypejwt) - Get Destination Type Schema
261260

262-
### [tenants](docs/sdks/tenants/README.md)
261+
### [Tenants](docs/sdks/tenants/README.md)
263262

263+
* [listTenants](docs/sdks/tenants/README.md#listtenants) - List Tenants
264264
* [upsert](docs/sdks/tenants/README.md#upsert) - Create or Update Tenant
265265
* [get](docs/sdks/tenants/README.md#get) - Get Tenant
266266
* [delete](docs/sdks/tenants/README.md#delete) - Delete Tenant
267267
* [getPortalUrl](docs/sdks/tenants/README.md#getportalurl) - Get Portal Redirect URL
268268
* [getToken](docs/sdks/tenants/README.md#gettoken) - Get Tenant JWT Token
269269

270-
### [topics](docs/sdks/topics/README.md)
270+
### [Topics](docs/sdks/topics/README.md)
271271

272272
* [list](docs/sdks/topics/README.md#list) - List Available Topics (for Tenant)
273273
* [listJwt](docs/sdks/topics/README.md#listjwt) - List Available Topics)
@@ -313,6 +313,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
313313
- [`tenantsGet`](docs/sdks/tenants/README.md#get) - Get Tenant
314314
- [`tenantsGetPortalUrl`](docs/sdks/tenants/README.md#getportalurl) - Get Portal Redirect URL
315315
- [`tenantsGetToken`](docs/sdks/tenants/README.md#gettoken) - Get Tenant JWT Token
316+
- [`tenantsListTenants`](docs/sdks/tenants/README.md#listtenants) - List Tenants
316317
- [`tenantsUpsert`](docs/sdks/tenants/README.md#upsert) - Create or Update Tenant
317318
- [`topicsList`](docs/sdks/topics/README.md#list) - List Available Topics (for Tenant)
318319
- [`topicsListJwt`](docs/sdks/topics/README.md#listjwt) - List Available Topics)
@@ -359,41 +360,6 @@ run();
359360
```
360361
<!-- End Global Parameters [global-parameters] -->
361362

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

@@ -502,16 +468,10 @@ run();
502468
```
503469

504470
### Error Classes
505-
**Primary errors:**
471+
**Primary error:**
506472
* [`OutpostError`](./src/models/errors/outposterror.ts): The base class for HTTP error responses.
507-
* [`BadRequestError`](./src/models/errors/badrequesterror.ts): A collection of codes that generally means the end user got something wrong in making the request.
508-
* [`UnauthorizedError`](./src/models/errors/unauthorizederror.ts): A collection of codes that generally means the client was not authenticated correctly for the request they want to make.
509-
* [`NotFoundError`](./src/models/errors/notfounderror.ts): Status codes relating to the resource/entity they are requesting not being found or endpoints/routes not existing.
510-
* [`TimeoutError`](./src/models/errors/timeouterror.ts): Timeouts occurred with the request.
511-
* [`RateLimitedError`](./src/models/errors/ratelimitederror.ts): Status codes relating to the client being rate limited by the server. Status code `429`.
512-
* [`InternalServerError`](./src/models/errors/internalservererror.ts): A collection of status codes that generally mean the server failed in an unexpected way.
513473

514-
<details><summary>Less common errors (6)</summary>
474+
<details><summary>Less common errors (14)</summary>
515475

516476
<br />
517477

@@ -524,9 +484,19 @@ run();
524484

525485

526486
**Inherit from [`OutpostError`](./src/models/errors/outposterror.ts)**:
487+
* [`BadRequestError`](./src/models/errors/badrequesterror.ts): A collection of codes that generally means the end user got something wrong in making the request. Applicable to 5 of 27 methods.*
488+
* [`UnauthorizedError`](./src/models/errors/unauthorizederror.ts): A collection of codes that generally means the client was not authenticated correctly for the request they want to make. Applicable to 5 of 27 methods.*
489+
* [`NotFoundError`](./src/models/errors/notfounderror.ts): Status codes relating to the resource/entity they are requesting not being found or endpoints/routes not existing. Applicable to 5 of 27 methods.*
490+
* [`TimeoutError`](./src/models/errors/timeouterror.ts): Timeouts occurred with the request. Applicable to 5 of 27 methods.*
491+
* [`RateLimitedError`](./src/models/errors/ratelimitederror.ts): Status codes relating to the client being rate limited by the server. Status code `429`. Applicable to 5 of 27 methods.*
492+
* [`InternalServerError`](./src/models/errors/internalservererror.ts): A collection of status codes that generally mean the server failed in an unexpected way. Applicable to 5 of 27 methods.*
493+
* [`ListTenantsBadRequestError`](./src/models/errors/listtenantsbadrequesterror.ts): Invalid request parameters (e.g., invalid cursor, both next and prev provided). Status code `400`. Applicable to 1 of 27 methods.*
494+
* [`NotImplementedError`](./src/models/errors/notimplementederror.ts): List Tenants feature is not available. Requires Redis with RediSearch module. Status code `501`. Applicable to 1 of 27 methods.*
527495
* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
528496

529497
</details>
498+
499+
\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
530500
<!-- End Error Handling [errors] -->
531501

532502
<!-- Start Server Selection [server] -->

sdks/outpost-typescript/RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,14 @@ Based on:
3838
### Generated
3939
- [typescript v0.4.0] sdks/outpost-typescript
4040
### Releases
41-
- [NPM v0.4.0] https://www.npmjs.com/package/@hookdeck/outpost-sdk/v/0.4.0 - sdks/outpost-typescript
41+
- [NPM v0.4.0] https://www.npmjs.com/package/@hookdeck/outpost-sdk/v/0.4.0 - sdks/outpost-typescript
42+
43+
## 2026-01-16 13:20:12
44+
### Changes
45+
Based on:
46+
- OpenAPI Doc
47+
- Speakeasy CLI 1.686.1 (2.796.1) https://github.com/speakeasy-api/speakeasy
48+
### Generated
49+
- [typescript v0.6.0] sdks/outpost-typescript
50+
### Releases
51+
- [NPM v0.6.0] https://www.npmjs.com/package/@hookdeck/outpost-sdk/v/0.6.0 - sdks/outpost-typescript

sdks/outpost-typescript/docs/models/components/destination.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ const value: components.DestinationWebhook = {
1515
],
1616
disabledAt: null,
1717
createdAt: new Date("2024-02-15T10:00:00Z"),
18+
updatedAt: new Date("2024-02-15T10:00:00Z"),
1819
config: {
1920
url: "https://my-service.com/webhook/handler",
2021
},
@@ -37,6 +38,7 @@ const value: components.DestinationAWSSQS = {
3738
],
3839
disabledAt: new Date("2024-03-01T12:00:00Z"),
3940
createdAt: new Date("2024-02-20T11:30:00Z"),
41+
updatedAt: new Date("2024-02-20T11:30:00Z"),
4042
config: {
4143
endpoint: "https://sqs.us-west-2.amazonaws.com",
4244
queueUrl: "https://sqs.us-west-2.amazonaws.com/123456789012/my-app-queue",
@@ -59,6 +61,7 @@ const value: components.DestinationRabbitMQ = {
5961
],
6062
disabledAt: null,
6163
createdAt: new Date("2024-01-10T09:00:00Z"),
64+
updatedAt: new Date("2024-01-10T09:00:00Z"),
6265
config: {
6366
serverUrl: "amqp.cloudamqp.com:5671",
6467
exchange: "events-exchange",
@@ -82,6 +85,7 @@ const value: components.DestinationHookdeck = {
8285
],
8386
disabledAt: null,
8487
createdAt: new Date("2024-04-01T10:00:00Z"),
88+
updatedAt: new Date("2024-04-01T10:00:00Z"),
8589
config: {},
8690
credentials: {
8791
token: "hd_token_...",
@@ -101,6 +105,7 @@ const value: components.DestinationAWSKinesis = {
101105
],
102106
disabledAt: null,
103107
createdAt: new Date("2024-03-10T15:30:00Z"),
108+
updatedAt: new Date("2024-03-10T15:30:00Z"),
104109
config: {
105110
streamName: "production-events",
106111
region: "eu-west-1",
@@ -123,6 +128,7 @@ const value: components.DestinationAzureServiceBus = {
123128
],
124129
disabledAt: null,
125130
createdAt: new Date("2024-05-01T10:00:00Z"),
131+
updatedAt: new Date("2024-05-01T10:00:00Z"),
126132
config: {
127133
name: "my-queue-or-topic",
128134
},
@@ -144,6 +150,7 @@ const value: components.DestinationAwss3 = {
144150
],
145151
disabledAt: null,
146152
createdAt: new Date("2024-03-20T12:00:00Z"),
153+
updatedAt: new Date("2024-03-20T12:00:00Z"),
147154
config: {
148155
bucket: "my-bucket",
149156
region: "us-east-1",
@@ -167,6 +174,7 @@ const value: components.DestinationGCPPubSub = {
167174
],
168175
disabledAt: null,
169176
createdAt: new Date("2024-03-10T14:30:00Z"),
177+
updatedAt: new Date("2024-03-10T14:30:00Z"),
170178
config: {
171179
projectId: "my-project-123",
172180
topic: "events-topic",

0 commit comments

Comments
 (0)