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
4 changes: 2 additions & 2 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sources:
sourceBlobDigest: sha256:e3b85ac9da28706696320ca22b6ca215624531b31c3d79474802b1dbf485bd4d
tags:
- latest
- speakeasy-sdk-regen-1768565776
- speakeasy-sdk-regen-1768569631
- 0.0.1
Outpost API (Python):
sourceNamespace: outpost-api
Expand Down Expand Up @@ -37,7 +37,7 @@ targets:
sourceRevisionDigest: sha256:1534dabb139bd405d19820be4eddbd8540fc924fa5a267332a7296f8663dd15a
sourceBlobDigest: sha256:e3b85ac9da28706696320ca22b6ca215624531b31c3d79474802b1dbf485bd4d
codeSamplesNamespace: outpost-api-typescript-code-samples
codeSamplesRevisionDigest: sha256:e84a77ce14d887b056d89141a76a7f58be0c6b48bfb370390564d1a9e58f1265
codeSamplesRevisionDigest: sha256:e4836ddc6ae9b814e565d258fb1c82739b633df197e95c217a595c7e09bebf2e
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
2,217 changes: 1,839 additions & 378 deletions sdks/outpost-typescript/.speakeasy/gen.lock

Large diffs are not rendered by default.

72 changes: 21 additions & 51 deletions sdks/outpost-typescript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ 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 @@ -225,7 +224,7 @@ run();
<details open>
<summary>Available methods</summary>

### [destinations](docs/sdks/destinations/README.md)
### [Destinations](docs/sdks/destinations/README.md)

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

### [events](docs/sdks/events/README.md)
### [Events](docs/sdks/events/README.md)

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

### [health](docs/sdks/health/README.md)
### [Health](docs/sdks/health/README.md)

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

### [publish](docs/sdks/publish/README.md)
### [Publish](docs/sdks/publish/README.md)

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

### [schemas](docs/sdks/schemas/README.md)
### [Schemas](docs/sdks/schemas/README.md)

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

### [tenants](docs/sdks/tenants/README.md)
### [Tenants](docs/sdks/tenants/README.md)

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

### [topics](docs/sdks/topics/README.md)
### [Topics](docs/sdks/topics/README.md)

* [list](docs/sdks/topics/README.md#list) - List Available Topics (for Tenant)
* [listJwt](docs/sdks/topics/README.md#listjwt) - List Available Topics)
Expand Down Expand Up @@ -313,6 +313,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
- [`tenantsGet`](docs/sdks/tenants/README.md#get) - Get Tenant
- [`tenantsGetPortalUrl`](docs/sdks/tenants/README.md#getportalurl) - Get Portal Redirect URL
- [`tenantsGetToken`](docs/sdks/tenants/README.md#gettoken) - Get Tenant JWT Token
- [`tenantsListTenants`](docs/sdks/tenants/README.md#listtenants) - List Tenants
- [`tenantsUpsert`](docs/sdks/tenants/README.md#upsert) - Create or Update Tenant
- [`topicsList`](docs/sdks/topics/README.md#list) - List Available Topics (for Tenant)
- [`topicsListJwt`](docs/sdks/topics/README.md#listjwt) - List Available Topics)
Expand Down Expand Up @@ -359,41 +360,6 @@ 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 Expand Up @@ -502,16 +468,10 @@ run();
```

### Error Classes
**Primary errors:**
**Primary error:**
* [`OutpostError`](./src/models/errors/outposterror.ts): The base class for HTTP error responses.
* [`BadRequestError`](./src/models/errors/badrequesterror.ts): A collection of codes that generally means the end user got something wrong in making the request.
* [`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.
* [`NotFoundError`](./src/models/errors/notfounderror.ts): Status codes relating to the resource/entity they are requesting not being found or endpoints/routes not existing.
* [`TimeoutError`](./src/models/errors/timeouterror.ts): Timeouts occurred with the request.
* [`RateLimitedError`](./src/models/errors/ratelimitederror.ts): Status codes relating to the client being rate limited by the server. Status code `429`.
* [`InternalServerError`](./src/models/errors/internalservererror.ts): A collection of status codes that generally mean the server failed in an unexpected way.

<details><summary>Less common errors (6)</summary>
<details><summary>Less common errors (14)</summary>

<br />

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


**Inherit from [`OutpostError`](./src/models/errors/outposterror.ts)**:
* [`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.*
* [`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.*
* [`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.*
* [`TimeoutError`](./src/models/errors/timeouterror.ts): Timeouts occurred with the request. Applicable to 5 of 27 methods.*
* [`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.*
* [`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.*
* [`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.*
* [`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.*
* [`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.

</details>

\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
<!-- End Error Handling [errors] -->

<!-- Start Server Selection [server] -->
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 @@ -38,4 +38,14 @@ Based on:
### 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
- [NPM v0.4.0] https://www.npmjs.com/package/@hookdeck/outpost-sdk/v/0.4.0 - sdks/outpost-typescript

## 2026-01-16 13:20:12
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.686.1 (2.796.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.6.0] sdks/outpost-typescript
### Releases
- [NPM v0.6.0] https://www.npmjs.com/package/@hookdeck/outpost-sdk/v/0.6.0 - sdks/outpost-typescript
8 changes: 8 additions & 0 deletions sdks/outpost-typescript/docs/models/components/destination.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ const value: components.DestinationWebhook = {
],
disabledAt: null,
createdAt: new Date("2024-02-15T10:00:00Z"),
updatedAt: new Date("2024-02-15T10:00:00Z"),
config: {
url: "https://my-service.com/webhook/handler",
},
Expand All @@ -37,6 +38,7 @@ const value: components.DestinationAWSSQS = {
],
disabledAt: new Date("2024-03-01T12:00:00Z"),
createdAt: new Date("2024-02-20T11:30:00Z"),
updatedAt: new Date("2024-02-20T11:30:00Z"),
config: {
endpoint: "https://sqs.us-west-2.amazonaws.com",
queueUrl: "https://sqs.us-west-2.amazonaws.com/123456789012/my-app-queue",
Expand All @@ -59,6 +61,7 @@ const value: components.DestinationRabbitMQ = {
],
disabledAt: null,
createdAt: new Date("2024-01-10T09:00:00Z"),
updatedAt: new Date("2024-01-10T09:00:00Z"),
config: {
serverUrl: "amqp.cloudamqp.com:5671",
exchange: "events-exchange",
Expand All @@ -82,6 +85,7 @@ const value: components.DestinationHookdeck = {
],
disabledAt: null,
createdAt: new Date("2024-04-01T10:00:00Z"),
updatedAt: new Date("2024-04-01T10:00:00Z"),
config: {},
credentials: {
token: "hd_token_...",
Expand All @@ -101,6 +105,7 @@ const value: components.DestinationAWSKinesis = {
],
disabledAt: null,
createdAt: new Date("2024-03-10T15:30:00Z"),
updatedAt: new Date("2024-03-10T15:30:00Z"),
config: {
streamName: "production-events",
region: "eu-west-1",
Expand All @@ -123,6 +128,7 @@ const value: components.DestinationAzureServiceBus = {
],
disabledAt: null,
createdAt: new Date("2024-05-01T10:00:00Z"),
updatedAt: new Date("2024-05-01T10:00:00Z"),
config: {
name: "my-queue-or-topic",
},
Expand All @@ -144,6 +150,7 @@ const value: components.DestinationAwss3 = {
],
disabledAt: null,
createdAt: new Date("2024-03-20T12:00:00Z"),
updatedAt: new Date("2024-03-20T12:00:00Z"),
config: {
bucket: "my-bucket",
region: "us-east-1",
Expand All @@ -167,6 +174,7 @@ const value: components.DestinationGCPPubSub = {
],
disabledAt: null,
createdAt: new Date("2024-03-10T14:30:00Z"),
updatedAt: new Date("2024-03-10T14:30:00Z"),
config: {
projectId: "my-project-123",
topic: "events-topic",
Expand Down
Loading