Skip to content

Commit 9dd4a17

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.405.10
1 parent a911607 commit 9dd4a17

Some content is hidden

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

73 files changed

+351
-254
lines changed

‎.speakeasy/gen.lock

+14-14
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
lockVersion: 2.0.0
22
id: f28179cc-ef59-426d-9e85-60cec22fc642
33
management:
4-
docChecksum: 596f43d83d9b42d6000040c93ba5018d
4+
docChecksum: ababac2d9647ce276a0165b7766b1087
55
docVersion: 0.0.1
6-
speakeasyVersion: 1.404.5
7-
generationVersion: 2.426.2
8-
releaseVersion: 0.42.0
9-
configChecksum: ed39e9667468bdf10ea72c83e14cbcba
6+
speakeasyVersion: 1.405.10
7+
generationVersion: 2.429.0
8+
releaseVersion: 0.43.0
9+
configChecksum: c50a7a8016a79d1eb64db414400b4364
1010
repoURL: https://github.com/dubinc/dub-ts.git
1111
installationURL: https://github.com/dubinc/dub-ts
1212
published: true
1313
features:
1414
typescript:
1515
additionalDependencies: 0.1.0
1616
constsAndDefaults: 0.1.11
17-
core: 3.18.0
17+
core: 3.18.2
1818
defaultEnabledRetries: 0.1.0
1919
deprecations: 2.81.1
2020
enumUnions: 0.1.0
2121
envVarSecurityUsage: 0.1.1
22-
errors: 2.82.2
22+
errors: 2.82.3
2323
examples: 2.81.4
24-
flattening: 2.81.1
24+
flattening: 2.82.0
2525
globalSecurity: 2.82.11
2626
globalSecurityCallbacks: 0.1.0
2727
globalSecurityFlattening: 0.1.0
@@ -397,7 +397,7 @@ examples:
397397
speakeasy-default-create-link:
398398
responses:
399399
"200":
400-
application/json: {"id": "<id>", "domain": "lighthearted-kilogram.name", "key": "<key>", "externalId": "<value>", "url": "https://impartial-dump.com", "expiresAt": "<value>", "expiredUrl": "https://big-young.net", "password": "DuL1dlrnUXohO_B", "title": "<value>", "description": "Ameliorated demand-driven superstructure", "image": "https://loremflickr.com/640/480", "video": "<value>", "ios": "<value>", "android": "<value>", "tagId": "<value>", "tags": [], "comments": "<value>", "shortLink": "http://massive-cup.biz", "qrCode": "http://safe-bankruptcy.net", "utm_source": "<value>", "utm_medium": "<value>", "utm_campaign": "<value>", "utm_term": "<value>", "utm_content": "<value>", "userId": "<value>", "workspaceId": "<value>", "lastClicked": "<value>", "createdAt": "<value>", "updatedAt": "<value>", "projectId": "<value>"}
400+
application/json: {"id": "<id>", "domain": "lighthearted-kilogram.name", "key": "<key>", "url": "https://impartial-dump.com", "externalId": "<value>", "identifier": "<value>", "expiresAt": "<value>", "expiredUrl": "https://big-young.net", "password": "DuL1dlrnUXohO_B", "title": "<value>", "description": "Ameliorated demand-driven superstructure", "image": "https://loremflickr.com/640/480", "video": "<value>", "ios": "<value>", "android": "<value>", "tagId": "<value>", "tags": [], "comments": "<value>", "shortLink": "http://massive-cup.biz", "qrCode": "http://safe-bankruptcy.net", "utm_source": "<value>", "utm_medium": "<value>", "utm_campaign": "<value>", "utm_term": "<value>", "utm_content": "<value>", "userId": "<value>", "workspaceId": "<value>", "lastClicked": "<value>", "createdAt": "<value>", "updatedAt": "<value>", "projectId": "<value>"}
401401
"400":
402402
application/json: {"error": {"code": "bad_request", "message": "The requested resource was not found."}}
403403
"401":
@@ -447,7 +447,7 @@ examples:
447447
externalId: "123456"
448448
responses:
449449
"200":
450-
application/json: {"id": "<id>", "domain": "ringed-blow.name", "key": "<key>", "externalId": "<value>", "url": "https://monumental-spaghetti.name", "expiresAt": "<value>", "expiredUrl": "http://wiggly-substitution.info", "password": "fKH9v5zJBmg5IWA", "title": "<value>", "description": "Optional reciprocal projection", "image": "https://loremflickr.com/640/480", "video": "<value>", "ios": "<value>", "android": "<value>", "tagId": "<value>", "tags": [], "comments": "<value>", "shortLink": "https://hefty-festival.net", "qrCode": "https://pale-civilisation.name", "utm_source": "<value>", "utm_medium": "<value>", "utm_campaign": "<value>", "utm_term": "<value>", "utm_content": "<value>", "userId": "<value>", "workspaceId": "<value>", "lastClicked": "<value>", "createdAt": "<value>", "updatedAt": "<value>", "projectId": "<value>"}
450+
application/json: {"id": "<id>", "domain": "ringed-blow.name", "key": "<key>", "url": "https://monumental-spaghetti.name", "externalId": "<value>", "identifier": "<value>", "expiresAt": "<value>", "expiredUrl": "http://wiggly-substitution.info", "password": "fKH9v5zJBmg5IWA", "title": "<value>", "description": "Optional reciprocal projection", "image": "https://loremflickr.com/640/480", "video": "<value>", "ios": "<value>", "android": "<value>", "tagId": "<value>", "tags": [], "comments": "<value>", "shortLink": "https://hefty-festival.net", "qrCode": "https://pale-civilisation.name", "utm_source": "<value>", "utm_medium": "<value>", "utm_campaign": "<value>", "utm_term": "<value>", "utm_content": "<value>", "userId": "<value>", "workspaceId": "<value>", "lastClicked": "<value>", "createdAt": "<value>", "updatedAt": "<value>", "projectId": "<value>"}
451451
"400":
452452
application/json: {"error": {"code": "bad_request", "message": "The requested resource was not found."}}
453453
"401":
@@ -499,7 +499,7 @@ examples:
499499
linkId: "<value>"
500500
responses:
501501
"200":
502-
application/json: {"id": "<id>", "domain": "tidy-amazon.name", "key": "<key>", "externalId": "<value>", "url": "http://grand-pupa.org", "expiresAt": "<value>", "expiredUrl": "http://plastic-powder.info", "password": "KvPKDk8CkuAMJjb", "title": "<value>", "description": "User-friendly foreground interface", "image": "https://loremflickr.com/640/480", "video": "<value>", "ios": "<value>", "android": "<value>", "tagId": "<value>", "tags": [], "comments": "<value>", "shortLink": "http://glossy-roller.info", "qrCode": "https://poor-howard.com", "utm_source": "<value>", "utm_medium": "<value>", "utm_campaign": "<value>", "utm_term": "<value>", "utm_content": "<value>", "userId": "<value>", "workspaceId": "<value>", "lastClicked": "<value>", "createdAt": "<value>", "updatedAt": "<value>", "projectId": "<value>"}
502+
application/json: {"id": "<id>", "domain": "tidy-amazon.name", "key": "<key>", "url": "http://grand-pupa.org", "externalId": "<value>", "identifier": "<value>", "expiresAt": "<value>", "expiredUrl": "http://plastic-powder.info", "password": "KvPKDk8CkuAMJjb", "title": "<value>", "description": "User-friendly foreground interface", "image": "https://loremflickr.com/640/480", "video": "<value>", "ios": "<value>", "android": "<value>", "tagId": "<value>", "tags": [], "comments": "<value>", "shortLink": "http://glossy-roller.info", "qrCode": "https://poor-howard.com", "utm_source": "<value>", "utm_medium": "<value>", "utm_campaign": "<value>", "utm_term": "<value>", "utm_content": "<value>", "userId": "<value>", "workspaceId": "<value>", "lastClicked": "<value>", "createdAt": "<value>", "updatedAt": "<value>", "projectId": "<value>"}
503503
"400":
504504
application/json: {"error": {"code": "bad_request", "message": "The requested resource was not found."}}
505505
"401":
@@ -594,7 +594,7 @@ examples:
594594
speakeasy-default-upsert-link:
595595
responses:
596596
"200":
597-
application/json: {"id": "<id>", "domain": "monthly-hometown.info", "key": "<key>", "externalId": "<value>", "url": "https://honored-equality.info", "expiresAt": "<value>", "expiredUrl": "https://eminent-acknowledgment.net", "password": "wZDcrQrPcHBWicB", "title": "<value>", "description": "Re-engineered 24 hour structure", "image": "https://loremflickr.com/640/480", "video": "<value>", "ios": "<value>", "android": "<value>", "tagId": "<value>", "tags": [], "comments": "<value>", "shortLink": "http://nocturnal-spirituality.com", "qrCode": "https://potable-app.org", "utm_source": "<value>", "utm_medium": "<value>", "utm_campaign": "<value>", "utm_term": "<value>", "utm_content": "<value>", "userId": "<value>", "workspaceId": "<value>", "lastClicked": "<value>", "createdAt": "<value>", "updatedAt": "<value>", "projectId": "<value>"}
597+
application/json: {"id": "<id>", "domain": "monthly-hometown.info", "key": "<key>", "url": "https://honored-equality.info", "externalId": "<value>", "identifier": "<value>", "expiresAt": "<value>", "expiredUrl": "https://eminent-acknowledgment.net", "password": "wZDcrQrPcHBWicB", "title": "<value>", "description": "Re-engineered 24 hour structure", "image": "https://loremflickr.com/640/480", "video": "<value>", "ios": "<value>", "android": "<value>", "tagId": "<value>", "tags": [], "comments": "<value>", "shortLink": "http://nocturnal-spirituality.com", "qrCode": "https://potable-app.org", "utm_source": "<value>", "utm_medium": "<value>", "utm_campaign": "<value>", "utm_term": "<value>", "utm_content": "<value>", "userId": "<value>", "workspaceId": "<value>", "lastClicked": "<value>", "createdAt": "<value>", "updatedAt": "<value>", "projectId": "<value>"}
598598
"400":
599599
application/json: {"error": {"code": "bad_request", "message": "The requested resource was not found."}}
600600
"401":
@@ -710,7 +710,7 @@ examples:
710710
idOrSlug: "<value>"
711711
responses:
712712
"200":
713-
application/json: {"id": "<id>", "name": "<value>", "slug": "<value>", "plan": "business extra", "stripeId": "<value>", "billingCycleStart": "900.65", "stripeConnectId": "<value>", "inviteCode": "<value>", "usage": "5588.34", "usageLimit": "8441.99", "linksUsage": "5442.21", "linksLimit": "8306.36", "salesUsage": "5212.35", "salesLimit": "785.92", "domainsLimit": "9699.61", "tagsLimit": "8661.61", "usersLimit": "4580.49", "aiUsage": "7352.87", "aiLimit": "4508.24", "referralLinkId": "<value>", "conversionEnabled": true, "dotLinkClaimed": true, "createdAt": "<value>", "users": [], "domains": []}
713+
application/json: {"id": "<id>", "name": "<value>", "slug": "<value>", "plan": "business extra", "stripeId": "<value>", "billingCycleStart": "900.65", "stripeConnectId": "<value>", "inviteCode": "<value>", "usage": "5588.34", "usageLimit": "8441.99", "linksUsage": "5442.21", "linksLimit": "8306.36", "salesUsage": "5212.35", "salesLimit": "785.92", "domainsLimit": "9699.61", "tagsLimit": "8661.61", "usersLimit": "4580.49", "aiUsage": "7352.87", "aiLimit": "4508.24", "referralLinkId": "<value>", "conversionEnabled": true, "dotLinkClaimed": true, "createdAt": "<value>", "users": [], "domains": [], "publishableKey": "<value>"}
714714
"400":
715715
application/json: {"error": {"code": "bad_request", "message": "The requested resource was not found."}}
716716
"401":
@@ -736,7 +736,7 @@ examples:
736736
idOrSlug: "<value>"
737737
responses:
738738
"200":
739-
application/json: {"id": "<id>", "name": "<value>", "slug": "<value>", "plan": "enterprise", "stripeId": "<value>", "billingCycleStart": "245.55", "stripeConnectId": "<value>", "inviteCode": "<value>", "usage": "5971.29", "usageLimit": "156.52", "linksUsage": "3446.2", "linksLimit": "7084.55", "salesUsage": "9914.64", "salesLimit": "2703.24", "domainsLimit": "6276.9", "tagsLimit": "6841.99", "usersLimit": "4888.52", "aiUsage": "4430.76", "aiLimit": "9840.08", "referralLinkId": "<value>", "conversionEnabled": true, "dotLinkClaimed": false, "createdAt": "<value>", "users": [], "domains": []}
739+
application/json: {"id": "<id>", "name": "<value>", "slug": "<value>", "plan": "enterprise", "stripeId": "<value>", "billingCycleStart": "245.55", "stripeConnectId": "<value>", "inviteCode": "<value>", "usage": "5971.29", "usageLimit": "156.52", "linksUsage": "3446.2", "linksLimit": "7084.55", "salesUsage": "9914.64", "salesLimit": "2703.24", "domainsLimit": "6276.9", "tagsLimit": "6841.99", "usersLimit": "4888.52", "aiUsage": "4430.76", "aiLimit": "9840.08", "referralLinkId": "<value>", "conversionEnabled": true, "dotLinkClaimed": false, "createdAt": "<value>", "users": [], "domains": [], "publishableKey": "<value>"}
740740
"400":
741741
application/json: {"error": {"code": "bad_request", "message": "The requested resource was not found."}}
742742
"401":

‎.speakeasy/gen.yaml

+2-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ generation:
1212
auth:
1313
oAuth2ClientCredentialsEnabled: false
1414
typescript:
15-
version: 0.42.0
15+
version: 0.43.0
1616
additionalDependencies:
1717
dependencies: {}
1818
devDependencies:
@@ -24,6 +24,7 @@ typescript:
2424
clientServerStatusCodesAsErrors: true
2525
enumFormat: union
2626
flattenGlobalSecurity: true
27+
flatteningOrder: body-first
2728
imports:
2829
option: openapi
2930
paths:

‎.speakeasy/workflow.lock

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
speakeasyVersion: 1.404.5
1+
speakeasyVersion: 1.405.10
22
sources:
33
my-first-source:
44
sourceNamespace: my-first-source
5-
sourceRevisionDigest: sha256:c1c6a72514553cd3a0de7b90f723dd036b50b9b3a426c7d60ae667c477841e44
6-
sourceBlobDigest: sha256:96e2af5fbe31980700d657bb418579d883a79ea65bf354ef89759be188c23207
5+
sourceRevisionDigest: sha256:415cfc1166cac06441d79152b913282ecf31814d07cbfb5f86c3bef16b702f6d
6+
sourceBlobDigest: sha256:7f86df8d348e3d962d3d5656e011b4e75610d2560242671fa0b27f26ba579c1a
77
tags:
88
- latest
99
- main
1010
targets:
1111
my-first-target:
1212
source: my-first-source
1313
sourceNamespace: my-first-source
14-
sourceRevisionDigest: sha256:c1c6a72514553cd3a0de7b90f723dd036b50b9b3a426c7d60ae667c477841e44
15-
sourceBlobDigest: sha256:96e2af5fbe31980700d657bb418579d883a79ea65bf354ef89759be188c23207
14+
sourceRevisionDigest: sha256:415cfc1166cac06441d79152b913282ecf31814d07cbfb5f86c3bef16b702f6d
15+
sourceBlobDigest: sha256:7f86df8d348e3d962d3d5656e011b4e75610d2560242671fa0b27f26ba579c1a
1616
codeSamplesNamespace: code-samples-typescript-my-first-target
17-
codeSamplesRevisionDigest: sha256:60cac25833898f823f4b057dd269f56330d7de61cb9c80aaf7077f08bb707891
17+
codeSamplesRevisionDigest: sha256:5661be67408a0d8e9970235ffa34e29e67906036a33c0aff7d662c1d45d442fe
1818
workflow:
1919
workflowVersion: 1.0.0
2020
speakeasyVersion: latest

‎README.md

+17-6
Original file line numberDiff line numberDiff line change
@@ -164,9 +164,21 @@ run();
164164
<!-- Start Error Handling [errors] -->
165165
## Error Handling
166166

167-
All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
167+
All SDK methods return a response object or throw an error. By default, an API error will throw a `errors.SDKError`.
168168

169-
| Error Object | Status Code | Content Type |
169+
If a HTTP request fails, an operation my also throw an error from the `models/errors/httpclienterrors.ts` module:
170+
171+
| HTTP Client Error | Description |
172+
| ---------------------------------------------------- | ---------------------------------------------------- |
173+
| RequestAbortedError | HTTP request was aborted by the client |
174+
| RequestTimeoutError | HTTP request timed out due to an AbortSignal signal |
175+
| ConnectionError | HTTP client was unable to make a request to a server |
176+
| InvalidRequestError | Any input used to create a request is invalid |
177+
| UnexpectedClientError | Unrecognised or unexpected error |
178+
179+
In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. For example, the `create` method may throw the following errors:
180+
181+
| Error Type | Status Code | Content Type |
170182
| -------------------------- | -------------------------- | -------------------------- |
171183
| errors.BadRequest | 400 | application/json |
172184
| errors.Unauthorized | 401 | application/json |
@@ -177,10 +189,7 @@ All SDK methods return a response object or throw an error. If Error objects are
177189
| errors.UnprocessableEntity | 422 | application/json |
178190
| errors.RateLimitExceeded | 429 | application/json |
179191
| errors.InternalServerError | 500 | application/json |
180-
| errors.SDKError | 4xx-5xx | */* |
181-
182-
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
183-
192+
| errors.SDKError | 4XX, 5XX | \*/\* |
184193

185194
```typescript
186195
import { Dub } from "dub";
@@ -272,6 +281,8 @@ async function run() {
272281
run();
273282

274283
```
284+
285+
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
275286
<!-- End Error Handling [errors] -->
276287

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

‎RELEASES.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -786,4 +786,14 @@ Based on:
786786
### Generated
787787
- [typescript v0.42.0] .
788788
### Releases
789-
- [NPM v0.42.0] https://www.npmjs.com/package/dub/v/0.42.0 - .
789+
- [NPM v0.42.0] https://www.npmjs.com/package/dub/v/0.42.0 - .
790+
791+
## 2024-10-02 19:03:31
792+
### Changes
793+
Based on:
794+
- OpenAPI Doc
795+
- Speakeasy CLI 1.405.10 (2.429.0) https://github.com/speakeasy-api/speakeasy
796+
### Generated
797+
- [typescript v0.43.0] .
798+
### Releases
799+
- [NPM v0.43.0] https://www.npmjs.com/package/dub/v/0.43.0 - .

‎docs/models/components/clickevent.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,9 @@ let value: ClickEvent = {
2424
id: "<id>",
2525
domain: "flustered-alliance.net",
2626
key: "<key>",
27-
externalId: "<id>",
2827
url: "https://honored-lobster.org/",
28+
externalId: "<id>",
29+
identifier: "<value>",
2930
expiresAt: "<value>",
3031
expiredUrl: "https://impressive-airmail.info/",
3132
password: "4WcZXcnQlJRb6Gu",

0 commit comments

Comments
 (0)