mirror of
https://github.com/LukeHagar/dub-node.git
synced 2025-12-06 04:19:37 +00:00
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.260.6 (#81)
Co-authored-by: speakeasybot <bot@speakeasyapi.dev>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
a829b4340d
commit
6a0be4086f
@@ -1,5 +1,4 @@
|
||||
/*
|
||||
/docs/**/*.md
|
||||
**/*
|
||||
!/**/*.ts
|
||||
!/**/*.js
|
||||
!/**/*.map
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
lockVersion: 2.0.0
|
||||
id: f28179cc-ef59-426d-9e85-60cec22fc642
|
||||
management:
|
||||
docChecksum: 59b2c58aae7e82783142168d3327e8c8
|
||||
docChecksum: 9b3afff112a002c5cdcb95800b733810
|
||||
docVersion: 0.0.1
|
||||
speakeasyVersion: 1.257.1
|
||||
generationVersion: 2.308.2
|
||||
releaseVersion: 0.23.1
|
||||
configChecksum: bfc60f1488f62d05649364aba10d384b
|
||||
speakeasyVersion: 1.260.6
|
||||
generationVersion: 2.311.1
|
||||
releaseVersion: 0.24.0
|
||||
configChecksum: 7295cbecb89a751fe5c558989aade82b
|
||||
repoURL: https://github.com/dubinc/dub-node.git
|
||||
installationURL: https://github.com/dubinc/dub-node
|
||||
published: true
|
||||
@@ -14,7 +14,7 @@ features:
|
||||
typescript:
|
||||
acceptHeaders: 2.81.1
|
||||
constsAndDefaults: 0.1.5
|
||||
core: 3.7.2
|
||||
core: 3.8.0
|
||||
deprecations: 2.81.1
|
||||
examples: 2.81.3
|
||||
flattening: 2.81.1
|
||||
@@ -37,6 +37,7 @@ generatedFiles:
|
||||
- .eslintrc.js
|
||||
- .npmignore
|
||||
- RUNTIMES.md
|
||||
- jsr.json
|
||||
- package.json
|
||||
- src/lib/base64.ts
|
||||
- src/lib/config.ts
|
||||
@@ -55,19 +56,6 @@ generatedFiles:
|
||||
- src/types/operations.ts
|
||||
- src/types/rfcdate.ts
|
||||
- tsconfig.json
|
||||
- src/models/components/linkschema.ts
|
||||
- src/models/components/tagschema.ts
|
||||
- src/models/components/workspaceschema.ts
|
||||
- src/models/components/security.ts
|
||||
- src/models/errors/badrequest.ts
|
||||
- src/models/errors/unauthorized.ts
|
||||
- src/models/errors/forbidden.ts
|
||||
- src/models/errors/notfound.ts
|
||||
- src/models/errors/conflict.ts
|
||||
- src/models/errors/inviteexpired.ts
|
||||
- src/models/errors/unprocessableentity.ts
|
||||
- src/models/errors/ratelimitexceeded.ts
|
||||
- src/models/errors/internalservererror.ts
|
||||
- src/models/operations/getlinks.ts
|
||||
- src/models/operations/createlink.ts
|
||||
- src/models/operations/getlinkscount.ts
|
||||
@@ -86,6 +74,7 @@ generatedFiles:
|
||||
- src/models/operations/getrefereranalytics.ts
|
||||
- src/models/operations/gettoplinks.ts
|
||||
- src/models/operations/gettopurls.ts
|
||||
- src/models/operations/getworkspaces.ts
|
||||
- src/models/operations/createworkspace.ts
|
||||
- src/models/operations/getworkspace.ts
|
||||
- src/models/operations/gettags.ts
|
||||
@@ -97,138 +86,180 @@ generatedFiles:
|
||||
- src/models/operations/setprimarydomain.ts
|
||||
- src/models/operations/transferdomain.ts
|
||||
- src/models/operations/getmetatags.ts
|
||||
- src/models/components/linkschema.ts
|
||||
- src/models/components/tagschema.ts
|
||||
- src/models/components/badrequest.ts
|
||||
- src/models/components/unauthorized.ts
|
||||
- src/models/components/forbidden.ts
|
||||
- src/models/components/notfound.ts
|
||||
- src/models/components/conflict.ts
|
||||
- src/models/components/inviteexpired.ts
|
||||
- src/models/components/unprocessableentity.ts
|
||||
- src/models/components/ratelimitexceeded.ts
|
||||
- src/models/components/internalservererror.ts
|
||||
- src/models/components/workspaceschema.ts
|
||||
- src/models/components/security.ts
|
||||
- src/models/errors/index.ts
|
||||
- src/models/components/index.ts
|
||||
- src/models/operations/index.ts
|
||||
- src/models/components/index.ts
|
||||
- docs/models/operations/queryparamtagids.md
|
||||
- docs/models/operations/sort.md
|
||||
- docs/models/operations/getlinksrequest.md
|
||||
- docs/models/operations/getlinksresponse.md
|
||||
- docs/models/operations/tagids.md
|
||||
- docs/models/operations/geo.md
|
||||
- docs/models/operations/createlinkrequestbody.md
|
||||
- docs/models/operations/createlinkresponse.md
|
||||
- docs/models/operations/getlinkscountqueryparamtagids.md
|
||||
- docs/models/operations/two.md
|
||||
- docs/models/operations/one.md
|
||||
- docs/models/operations/groupby.md
|
||||
- docs/models/operations/getlinkscountrequest.md
|
||||
- docs/models/operations/getlinkscountresponse.md
|
||||
- docs/models/operations/getlinkinforequest.md
|
||||
- docs/models/operations/getlinkinforesponse.md
|
||||
- docs/models/operations/editlinktagids.md
|
||||
- docs/models/operations/editlinkgeo.md
|
||||
- docs/models/operations/editlinkrequestbody.md
|
||||
- docs/models/operations/editlinkrequest.md
|
||||
- docs/models/operations/editlinkresponse.md
|
||||
- docs/models/operations/deletelinkrequest.md
|
||||
- docs/models/operations/deletelinkresponsebody.md
|
||||
- docs/models/operations/deletelinkresponse.md
|
||||
- docs/models/operations/bulkcreatelinkstagids.md
|
||||
- docs/models/operations/bulkcreatelinksgeo.md
|
||||
- docs/models/operations/requestbody.md
|
||||
- docs/models/operations/bulkcreatelinksresponse.md
|
||||
- docs/models/operations/level.md
|
||||
- docs/models/operations/getqrcoderequest.md
|
||||
- docs/models/operations/getqrcoderesponse.md
|
||||
- docs/models/operations/interval.md
|
||||
- docs/models/operations/country.md
|
||||
- docs/models/operations/getclicksanalyticsrequest.md
|
||||
- docs/models/operations/getclicksanalyticsresponse.md
|
||||
- docs/models/operations/queryparaminterval.md
|
||||
- docs/models/operations/queryparamcountry.md
|
||||
- docs/models/operations/gettimeseriesanalyticsrequest.md
|
||||
- docs/models/operations/responsebody.md
|
||||
- docs/models/operations/gettimeseriesanalyticsresponse.md
|
||||
- docs/models/operations/getcountryanalyticsqueryparaminterval.md
|
||||
- docs/models/operations/getcountryanalyticsqueryparamcountry.md
|
||||
- docs/models/operations/getcountryanalyticsrequest.md
|
||||
- docs/models/operations/getcountryanalyticscountry.md
|
||||
- docs/models/operations/getcountryanalyticsresponsebody.md
|
||||
- docs/models/operations/getcountryanalyticsresponse.md
|
||||
- docs/models/operations/getcityanalyticsqueryparaminterval.md
|
||||
- docs/models/operations/getcityanalyticsqueryparamcountry.md
|
||||
- docs/models/operations/getcityanalyticsrequest.md
|
||||
- docs/models/operations/getcityanalyticscountry.md
|
||||
- docs/models/operations/getcityanalyticsresponsebody.md
|
||||
- docs/models/operations/getcityanalyticsresponse.md
|
||||
- docs/models/operations/getdeviceanalyticsqueryparaminterval.md
|
||||
- docs/models/operations/getdeviceanalyticsqueryparamcountry.md
|
||||
- docs/models/operations/getdeviceanalyticsrequest.md
|
||||
- docs/models/operations/getdeviceanalyticsresponsebody.md
|
||||
- docs/models/operations/getdeviceanalyticsresponse.md
|
||||
- docs/models/operations/getbrowseranalyticsqueryparaminterval.md
|
||||
- docs/models/operations/getbrowseranalyticsqueryparamcountry.md
|
||||
- docs/models/operations/getbrowseranalyticsrequest.md
|
||||
- docs/models/operations/getbrowseranalyticsresponsebody.md
|
||||
- docs/models/operations/getbrowseranalyticsresponse.md
|
||||
- docs/models/operations/getosanalyticsqueryparaminterval.md
|
||||
- docs/models/operations/getosanalyticsqueryparamcountry.md
|
||||
- docs/models/operations/getosanalyticsrequest.md
|
||||
- docs/models/operations/getosanalyticsresponsebody.md
|
||||
- docs/models/operations/getosanalyticsresponse.md
|
||||
- docs/models/operations/getrefereranalyticsqueryparaminterval.md
|
||||
- docs/models/operations/getrefereranalyticsqueryparamcountry.md
|
||||
- docs/models/operations/getrefereranalyticsrequest.md
|
||||
- docs/models/operations/getrefereranalyticsresponsebody.md
|
||||
- docs/models/operations/getrefereranalyticsresponse.md
|
||||
- docs/models/operations/gettoplinksqueryparaminterval.md
|
||||
- docs/models/operations/gettoplinksqueryparamcountry.md
|
||||
- docs/models/operations/gettoplinksrequest.md
|
||||
- docs/models/operations/gettoplinksresponsebody.md
|
||||
- docs/models/operations/gettoplinksresponse.md
|
||||
- docs/models/operations/gettopurlsqueryparaminterval.md
|
||||
- docs/models/operations/gettopurlsqueryparamcountry.md
|
||||
- docs/models/operations/gettopurlsrequest.md
|
||||
- docs/models/operations/gettopurlsresponsebody.md
|
||||
- docs/models/operations/gettopurlsresponse.md
|
||||
- docs/models/operations/getworkspacesresponse.md
|
||||
- docs/models/operations/createworkspacerequestbody.md
|
||||
- docs/models/operations/createworkspaceresponse.md
|
||||
- docs/models/operations/getworkspacerequest.md
|
||||
- docs/models/operations/getworkspaceresponse.md
|
||||
- docs/models/operations/gettagsrequest.md
|
||||
- docs/models/operations/gettagsresponse.md
|
||||
- docs/models/operations/color.md
|
||||
- docs/models/operations/createtagrequestbody.md
|
||||
- docs/models/operations/createtagresponse.md
|
||||
- docs/models/operations/listdomainsrequest.md
|
||||
- docs/models/operations/listdomainstype.md
|
||||
- docs/models/operations/listdomainsresponsebody.md
|
||||
- docs/models/operations/listdomainsresponse.md
|
||||
- docs/models/operations/type.md
|
||||
- docs/models/operations/adddomainrequestbody.md
|
||||
- docs/models/operations/adddomaintype.md
|
||||
- docs/models/operations/adddomainresponsebody.md
|
||||
- docs/models/operations/adddomainresponse.md
|
||||
- docs/models/operations/deletedomainrequest.md
|
||||
- docs/models/operations/deletedomainresponsebody.md
|
||||
- docs/models/operations/deletedomainresponse.md
|
||||
- docs/models/operations/editdomaintype.md
|
||||
- docs/models/operations/editdomainrequestbody.md
|
||||
- docs/models/operations/editdomainrequest.md
|
||||
- docs/models/operations/editdomaindomainstype.md
|
||||
- docs/models/operations/editdomainresponsebody.md
|
||||
- docs/models/operations/editdomainresponse.md
|
||||
- docs/models/operations/setprimarydomainrequest.md
|
||||
- docs/models/operations/setprimarydomaintype.md
|
||||
- docs/models/operations/setprimarydomainresponsebody.md
|
||||
- docs/models/operations/setprimarydomainresponse.md
|
||||
- docs/models/operations/transferdomainrequestbody.md
|
||||
- docs/models/operations/transferdomainrequest.md
|
||||
- docs/models/operations/transferdomaintype.md
|
||||
- docs/models/operations/transferdomainresponsebody.md
|
||||
- docs/models/operations/transferdomainresponse.md
|
||||
- docs/models/operations/getmetatagsrequest.md
|
||||
- docs/models/operations/getmetatagsresponsebody.md
|
||||
- docs/models/components/geo.md
|
||||
- docs/models/components/linkschema.md
|
||||
- docs/models/components/color.md
|
||||
- docs/models/components/tagschema.md
|
||||
- docs/models/components/code.md
|
||||
- docs/models/components/errort.md
|
||||
- docs/models/components/badrequest.md
|
||||
- docs/models/components/unauthorizedcode.md
|
||||
- docs/models/components/unauthorizederror.md
|
||||
- docs/models/components/unauthorized.md
|
||||
- docs/models/components/forbiddencode.md
|
||||
- docs/models/components/forbiddenerror.md
|
||||
- docs/models/components/forbidden.md
|
||||
- docs/models/components/notfoundcode.md
|
||||
- docs/models/components/notfounderror.md
|
||||
- docs/models/components/notfound.md
|
||||
- docs/models/components/conflictcode.md
|
||||
- docs/models/components/conflicterror.md
|
||||
- docs/models/components/conflict.md
|
||||
- docs/models/components/inviteexpiredcode.md
|
||||
- docs/models/components/inviteexpirederror.md
|
||||
- docs/models/components/inviteexpired.md
|
||||
- docs/models/components/unprocessableentitycode.md
|
||||
- docs/models/components/unprocessableentityerror.md
|
||||
- docs/models/components/unprocessableentity.md
|
||||
- docs/models/components/ratelimitexceededcode.md
|
||||
- docs/models/components/ratelimitexceedederror.md
|
||||
- docs/models/components/ratelimitexceeded.md
|
||||
- docs/models/components/internalservererrorcode.md
|
||||
- docs/models/components/internalservererrorerror.md
|
||||
- docs/models/components/internalservererror.md
|
||||
- docs/models/components/plan.md
|
||||
- docs/models/components/role.md
|
||||
- docs/models/components/users.md
|
||||
- docs/models/components/domains.md
|
||||
- docs/models/components/workspaceschema.md
|
||||
- docs/models/components/security.md
|
||||
- docs/models/errors/code.md
|
||||
- docs/models/errors/errort.md
|
||||
- docs/models/errors/badrequest.md
|
||||
- docs/models/errors/unauthorizedcode.md
|
||||
- docs/models/errors/unauthorizederror.md
|
||||
- docs/models/errors/unauthorized.md
|
||||
- docs/models/errors/forbiddencode.md
|
||||
- docs/models/errors/forbiddenerror.md
|
||||
- docs/models/errors/forbidden.md
|
||||
- docs/models/errors/notfoundcode.md
|
||||
- docs/models/errors/notfounderror.md
|
||||
- docs/models/errors/notfound.md
|
||||
- docs/models/errors/conflictcode.md
|
||||
- docs/models/errors/conflicterror.md
|
||||
- docs/models/errors/conflict.md
|
||||
- docs/models/errors/inviteexpiredcode.md
|
||||
- docs/models/errors/inviteexpirederror.md
|
||||
- docs/models/errors/inviteexpired.md
|
||||
- docs/models/errors/unprocessableentitycode.md
|
||||
- docs/models/errors/unprocessableentityerror.md
|
||||
- docs/models/errors/unprocessableentity.md
|
||||
- docs/models/errors/ratelimitexceededcode.md
|
||||
- docs/models/errors/ratelimitexceedederror.md
|
||||
- docs/models/errors/ratelimitexceeded.md
|
||||
- docs/models/errors/internalservererrorcode.md
|
||||
- docs/models/errors/internalservererrorerror.md
|
||||
- docs/models/errors/internalservererror.md
|
||||
- docs/models/operations/queryparamtagids.md
|
||||
- docs/models/operations/sort.md
|
||||
- docs/models/operations/getlinksrequest.md
|
||||
- docs/models/operations/tagids.md
|
||||
- docs/models/operations/geo.md
|
||||
- docs/models/operations/createlinkrequestbody.md
|
||||
- docs/models/operations/getlinkscountqueryparamtagids.md
|
||||
- docs/models/operations/two.md
|
||||
- docs/models/operations/one.md
|
||||
- docs/models/operations/groupby.md
|
||||
- docs/models/operations/getlinkscountrequest.md
|
||||
- docs/models/operations/getlinkinforequest.md
|
||||
- docs/models/operations/editlinktagids.md
|
||||
- docs/models/operations/editlinkgeo.md
|
||||
- docs/models/operations/editlinkrequestbody.md
|
||||
- docs/models/operations/editlinkrequest.md
|
||||
- docs/models/operations/deletelinkrequest.md
|
||||
- docs/models/operations/deletelinkresponsebody.md
|
||||
- docs/models/operations/bulkcreatelinkstagids.md
|
||||
- docs/models/operations/bulkcreatelinksgeo.md
|
||||
- docs/models/operations/requestbody.md
|
||||
- docs/models/operations/level.md
|
||||
- docs/models/operations/getqrcoderequest.md
|
||||
- docs/models/operations/interval.md
|
||||
- docs/models/operations/country.md
|
||||
- docs/models/operations/getclicksanalyticsrequest.md
|
||||
- docs/models/operations/queryparaminterval.md
|
||||
- docs/models/operations/queryparamcountry.md
|
||||
- docs/models/operations/gettimeseriesanalyticsrequest.md
|
||||
- docs/models/operations/responsebody.md
|
||||
- docs/models/operations/getcountryanalyticsqueryparaminterval.md
|
||||
- docs/models/operations/getcountryanalyticsqueryparamcountry.md
|
||||
- docs/models/operations/getcountryanalyticsrequest.md
|
||||
- docs/models/operations/getcountryanalyticscountry.md
|
||||
- docs/models/operations/getcountryanalyticsresponsebody.md
|
||||
- docs/models/operations/getcityanalyticsqueryparaminterval.md
|
||||
- docs/models/operations/getcityanalyticsqueryparamcountry.md
|
||||
- docs/models/operations/getcityanalyticsrequest.md
|
||||
- docs/models/operations/getcityanalyticscountry.md
|
||||
- docs/models/operations/getcityanalyticsresponsebody.md
|
||||
- docs/models/operations/getdeviceanalyticsqueryparaminterval.md
|
||||
- docs/models/operations/getdeviceanalyticsqueryparamcountry.md
|
||||
- docs/models/operations/getdeviceanalyticsrequest.md
|
||||
- docs/models/operations/getdeviceanalyticsresponsebody.md
|
||||
- docs/models/operations/getbrowseranalyticsqueryparaminterval.md
|
||||
- docs/models/operations/getbrowseranalyticsqueryparamcountry.md
|
||||
- docs/models/operations/getbrowseranalyticsrequest.md
|
||||
- docs/models/operations/getbrowseranalyticsresponsebody.md
|
||||
- docs/models/operations/getosanalyticsqueryparaminterval.md
|
||||
- docs/models/operations/getosanalyticsqueryparamcountry.md
|
||||
- docs/models/operations/getosanalyticsrequest.md
|
||||
- docs/models/operations/getosanalyticsresponsebody.md
|
||||
- docs/models/operations/getrefereranalyticsqueryparaminterval.md
|
||||
- docs/models/operations/getrefereranalyticsqueryparamcountry.md
|
||||
- docs/models/operations/getrefereranalyticsrequest.md
|
||||
- docs/models/operations/getrefereranalyticsresponsebody.md
|
||||
- docs/models/operations/gettoplinksqueryparaminterval.md
|
||||
- docs/models/operations/gettoplinksqueryparamcountry.md
|
||||
- docs/models/operations/gettoplinksrequest.md
|
||||
- docs/models/operations/gettoplinksresponsebody.md
|
||||
- docs/models/operations/gettopurlsqueryparaminterval.md
|
||||
- docs/models/operations/gettopurlsqueryparamcountry.md
|
||||
- docs/models/operations/gettopurlsrequest.md
|
||||
- docs/models/operations/gettopurlsresponsebody.md
|
||||
- docs/models/operations/createworkspacerequestbody.md
|
||||
- docs/models/operations/getworkspacerequest.md
|
||||
- docs/models/operations/gettagsrequest.md
|
||||
- docs/models/operations/color.md
|
||||
- docs/models/operations/createtagrequestbody.md
|
||||
- docs/models/operations/listdomainsrequest.md
|
||||
- docs/models/operations/listdomainstype.md
|
||||
- docs/models/operations/listdomainsresponsebody.md
|
||||
- docs/models/operations/type.md
|
||||
- docs/models/operations/adddomainrequestbody.md
|
||||
- docs/models/operations/adddomaintype.md
|
||||
- docs/models/operations/adddomainresponsebody.md
|
||||
- docs/models/operations/deletedomainrequest.md
|
||||
- docs/models/operations/deletedomainresponsebody.md
|
||||
- docs/models/operations/editdomaintype.md
|
||||
- docs/models/operations/editdomainrequestbody.md
|
||||
- docs/models/operations/editdomainrequest.md
|
||||
- docs/models/operations/editdomaindomainstype.md
|
||||
- docs/models/operations/editdomainresponsebody.md
|
||||
- docs/models/operations/setprimarydomainrequest.md
|
||||
- docs/models/operations/setprimarydomaintype.md
|
||||
- docs/models/operations/setprimarydomainresponsebody.md
|
||||
- docs/models/operations/transferdomainrequestbody.md
|
||||
- docs/models/operations/transferdomainrequest.md
|
||||
- docs/models/operations/transferdomaintype.md
|
||||
- docs/models/operations/transferdomainresponsebody.md
|
||||
- docs/models/operations/getmetatagsrequest.md
|
||||
- docs/models/operations/getmetatagsresponsebody.md
|
||||
- docs/sdks/dub/README.md
|
||||
- docs/sdks/links/README.md
|
||||
- docs/sdks/qrcodes/README.md
|
||||
|
||||
@@ -12,7 +12,7 @@ generation:
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: false
|
||||
typescript:
|
||||
version: 0.23.1
|
||||
version: 0.24.0
|
||||
additionalDependencies:
|
||||
dependencies: {}
|
||||
devDependencies:
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
speakeasyVersion: 1.257.1
|
||||
speakeasyVersion: 1.260.6
|
||||
sources:
|
||||
my-first-source: {}
|
||||
targets:
|
||||
|
||||
51
README.md
51
README.md
@@ -118,18 +118,9 @@ run();
|
||||
|
||||
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.
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
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.
|
||||
|
||||
@@ -158,42 +149,6 @@ async function run() {
|
||||
console.error(err.rawValue);
|
||||
return;
|
||||
}
|
||||
case err instanceof errors.BadRequest: {
|
||||
console.error(err); // handle exception
|
||||
return;
|
||||
}
|
||||
case err instanceof errors.Unauthorized: {
|
||||
console.error(err); // handle exception
|
||||
return;
|
||||
}
|
||||
case err instanceof errors.Forbidden: {
|
||||
console.error(err); // handle exception
|
||||
return;
|
||||
}
|
||||
case err instanceof errors.NotFound: {
|
||||
console.error(err); // handle exception
|
||||
return;
|
||||
}
|
||||
case err instanceof errors.Conflict: {
|
||||
console.error(err); // handle exception
|
||||
return;
|
||||
}
|
||||
case err instanceof errors.InviteExpired: {
|
||||
console.error(err); // handle exception
|
||||
return;
|
||||
}
|
||||
case err instanceof errors.UnprocessableEntity: {
|
||||
console.error(err); // handle exception
|
||||
return;
|
||||
}
|
||||
case err instanceof errors.RateLimitExceeded: {
|
||||
console.error(err); // handle exception
|
||||
return;
|
||||
}
|
||||
case err instanceof errors.InternalServerError: {
|
||||
console.error(err); // handle exception
|
||||
return;
|
||||
}
|
||||
default: {
|
||||
throw err;
|
||||
}
|
||||
|
||||
12
RELEASES.md
12
RELEASES.md
@@ -106,4 +106,14 @@ Based on:
|
||||
### Generated
|
||||
- [typescript v0.23.1] .
|
||||
### Releases
|
||||
- [NPM v0.23.1] https://www.npmjs.com/package/dub/v/0.23.1 - .
|
||||
- [NPM v0.23.1] https://www.npmjs.com/package/dub/v/0.23.1 - .
|
||||
|
||||
## 2024-04-19 01:12:16
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.260.6 (2.311.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.24.0] .
|
||||
### Releases
|
||||
- [NPM v0.24.0] https://www.npmjs.com/package/dub/v/0.24.0 - .
|
||||
8
docs/models/components/badrequest.md
Normal file
8
docs/models/components/badrequest.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# BadRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
|
||||
| `error` | [components.ErrorT](../../models/components/errort.md) | :heavy_check_mark: | N/A |
|
||||
@@ -1,10 +1,8 @@
|
||||
# Unauthorized
|
||||
|
||||
Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
|
||||
# Conflict
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| `error` | [errors.UnauthorizedError](../../models/errors/unauthorizederror.md) | :heavy_check_mark: | N/A |
|
||||
| `error` | [components.ConflictError](../../models/components/conflicterror.md) | :heavy_check_mark: | N/A |
|
||||
@@ -5,6 +5,6 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||
| `code` | [errors.ConflictCode](../../models/errors/conflictcode.md) | :heavy_check_mark: | A short code indicating the error code returned. | conflict |
|
||||
| `code` | [components.ConflictCode](../../models/components/conflictcode.md) | :heavy_check_mark: | A short code indicating the error code returned. | conflict |
|
||||
| `message` | *string* | :heavy_check_mark: | A human readable explanation of what went wrong. | The requested resource was not found. |
|
||||
| `docUrl` | *string* | :heavy_minus_sign: | A link to our documentation with more details about this error code | https://dub.co/docs/api-reference/errors#conflict |
|
||||
@@ -5,6 +5,6 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||
| `code` | [errors.Code](../../models/errors/code.md) | :heavy_check_mark: | A short code indicating the error code returned. | bad_request |
|
||||
| `code` | [components.Code](../../models/components/code.md) | :heavy_check_mark: | A short code indicating the error code returned. | bad_request |
|
||||
| `message` | *string* | :heavy_check_mark: | A human readable explanation of what went wrong. | The requested resource was not found. |
|
||||
| `docUrl` | *string* | :heavy_minus_sign: | A link to our documentation with more details about this error code | https://dub.co/docs/api-reference/errors#bad_request |
|
||||
@@ -1,10 +1,8 @@
|
||||
# InviteExpired
|
||||
|
||||
This response is sent when the requested content has been permanently deleted from server, with no forwarding address.
|
||||
# Forbidden
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||
| `error` | [errors.InviteExpiredError](../../models/errors/inviteexpirederror.md) | :heavy_check_mark: | N/A |
|
||||
| `error` | [components.ForbiddenError](../../models/components/forbiddenerror.md) | :heavy_check_mark: | N/A |
|
||||
@@ -1,10 +1,10 @@
|
||||
# InviteExpiredError
|
||||
# ForbiddenError
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| `code` | [errors.InviteExpiredCode](../../models/errors/inviteexpiredcode.md) | :heavy_check_mark: | A short code indicating the error code returned. | invite_expired |
|
||||
| `code` | [components.ForbiddenCode](../../models/components/forbiddencode.md) | :heavy_check_mark: | A short code indicating the error code returned. | forbidden |
|
||||
| `message` | *string* | :heavy_check_mark: | A human readable explanation of what went wrong. | The requested resource was not found. |
|
||||
| `docUrl` | *string* | :heavy_minus_sign: | A link to our documentation with more details about this error code | https://dub.co/docs/api-reference/errors#invite_expired |
|
||||
| `docUrl` | *string* | :heavy_minus_sign: | A link to our documentation with more details about this error code | https://dub.co/docs/api-reference/errors#forbidden |
|
||||
8
docs/models/components/internalservererror.md
Normal file
8
docs/models/components/internalservererror.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# InternalServerError
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `error` | [components.InternalServerErrorError](../../models/components/internalservererrorerror.md) | :heavy_check_mark: | N/A |
|
||||
10
docs/models/components/internalservererrorerror.md
Normal file
10
docs/models/components/internalservererrorerror.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# InternalServerErrorError
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
||||
| `code` | [components.InternalServerErrorCode](../../models/components/internalservererrorcode.md) | :heavy_check_mark: | A short code indicating the error code returned. | internal_server_error |
|
||||
| `message` | *string* | :heavy_check_mark: | A human readable explanation of what went wrong. | The requested resource was not found. |
|
||||
| `docUrl` | *string* | :heavy_minus_sign: | A link to our documentation with more details about this error code | https://dub.co/docs/api-reference/errors#internal_server_error |
|
||||
@@ -1,10 +1,8 @@
|
||||
# RateLimitExceeded
|
||||
|
||||
The user has sent too many requests in a given amount of time ("rate limiting")
|
||||
# InviteExpired
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
|
||||
| `error` | [errors.RateLimitExceededError](../../models/errors/ratelimitexceedederror.md) | :heavy_check_mark: | N/A |
|
||||
| `error` | [components.InviteExpiredError](../../models/components/inviteexpirederror.md) | :heavy_check_mark: | N/A |
|
||||
@@ -1,10 +1,10 @@
|
||||
# RateLimitExceededError
|
||||
# InviteExpiredError
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||
| `code` | [errors.RateLimitExceededCode](../../models/errors/ratelimitexceededcode.md) | :heavy_check_mark: | A short code indicating the error code returned. | rate_limit_exceeded |
|
||||
| `code` | [components.InviteExpiredCode](../../models/components/inviteexpiredcode.md) | :heavy_check_mark: | A short code indicating the error code returned. | invite_expired |
|
||||
| `message` | *string* | :heavy_check_mark: | A human readable explanation of what went wrong. | The requested resource was not found. |
|
||||
| `docUrl` | *string* | :heavy_minus_sign: | A link to our documentation with more details about this error code | https://dub.co/docs/api-reference/errors#rate_limit_exceeded |
|
||||
| `docUrl` | *string* | :heavy_minus_sign: | A link to our documentation with more details about this error code | https://dub.co/docs/api-reference/errors#invite_expired |
|
||||
8
docs/models/components/notfound.md
Normal file
8
docs/models/components/notfound.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# NotFound
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| `error` | [components.NotFoundError](../../models/components/notfounderror.md) | :heavy_check_mark: | N/A |
|
||||
@@ -5,6 +5,6 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||
| `code` | [errors.NotFoundCode](../../models/errors/notfoundcode.md) | :heavy_check_mark: | A short code indicating the error code returned. | not_found |
|
||||
| `code` | [components.NotFoundCode](../../models/components/notfoundcode.md) | :heavy_check_mark: | A short code indicating the error code returned. | not_found |
|
||||
| `message` | *string* | :heavy_check_mark: | A human readable explanation of what went wrong. | The requested resource was not found. |
|
||||
| `docUrl` | *string* | :heavy_minus_sign: | A link to our documentation with more details about this error code | https://dub.co/docs/api-reference/errors#not_found |
|
||||
8
docs/models/components/ratelimitexceeded.md
Normal file
8
docs/models/components/ratelimitexceeded.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# RateLimitExceeded
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||
| `error` | [components.RateLimitExceededError](../../models/components/ratelimitexceedederror.md) | :heavy_check_mark: | N/A |
|
||||
10
docs/models/components/ratelimitexceedederror.md
Normal file
10
docs/models/components/ratelimitexceedederror.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# RateLimitExceededError
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
||||
| `code` | [components.RateLimitExceededCode](../../models/components/ratelimitexceededcode.md) | :heavy_check_mark: | A short code indicating the error code returned. | rate_limit_exceeded |
|
||||
| `message` | *string* | :heavy_check_mark: | A human readable explanation of what went wrong. | The requested resource was not found. |
|
||||
| `docUrl` | *string* | :heavy_minus_sign: | A link to our documentation with more details about this error code | https://dub.co/docs/api-reference/errors#rate_limit_exceeded |
|
||||
8
docs/models/components/unauthorized.md
Normal file
8
docs/models/components/unauthorized.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Unauthorized
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||
| `error` | [components.UnauthorizedError](../../models/components/unauthorizederror.md) | :heavy_check_mark: | N/A |
|
||||
10
docs/models/components/unauthorizederror.md
Normal file
10
docs/models/components/unauthorizederror.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# UnauthorizedError
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
||||
| `code` | [components.UnauthorizedCode](../../models/components/unauthorizedcode.md) | :heavy_check_mark: | A short code indicating the error code returned. | unauthorized |
|
||||
| `message` | *string* | :heavy_check_mark: | A human readable explanation of what went wrong. | The requested resource was not found. |
|
||||
| `docUrl` | *string* | :heavy_minus_sign: | A link to our documentation with more details about this error code | https://dub.co/docs/api-reference/errors#unauthorized |
|
||||
8
docs/models/components/unprocessableentity.md
Normal file
8
docs/models/components/unprocessableentity.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# UnprocessableEntity
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `error` | [components.UnprocessableEntityError](../../models/components/unprocessableentityerror.md) | :heavy_check_mark: | N/A |
|
||||
10
docs/models/components/unprocessableentityerror.md
Normal file
10
docs/models/components/unprocessableentityerror.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# UnprocessableEntityError
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
||||
| `code` | [components.UnprocessableEntityCode](../../models/components/unprocessableentitycode.md) | :heavy_check_mark: | A short code indicating the error code returned. | unprocessable_entity |
|
||||
| `message` | *string* | :heavy_check_mark: | A human readable explanation of what went wrong. | The requested resource was not found. |
|
||||
| `docUrl` | *string* | :heavy_minus_sign: | A link to our documentation with more details about this error code | https://dub.co/docs/api-reference/errors#unprocessable_entity |
|
||||
@@ -1,10 +0,0 @@
|
||||
# BadRequest
|
||||
|
||||
The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
||||
| `error` | [errors.ErrorT](../../models/errors/errort.md) | :heavy_check_mark: | N/A |
|
||||
@@ -1,10 +0,0 @@
|
||||
# Conflict
|
||||
|
||||
This response is sent when a request conflicts with the current state of the server.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||
| `error` | [errors.ConflictError](../../models/errors/conflicterror.md) | :heavy_check_mark: | N/A |
|
||||
@@ -1,10 +0,0 @@
|
||||
# Forbidden
|
||||
|
||||
The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `error` | [errors.ForbiddenError](../../models/errors/forbiddenerror.md) | :heavy_check_mark: | N/A |
|
||||
@@ -1,10 +0,0 @@
|
||||
# ForbiddenError
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||
| `code` | [errors.ForbiddenCode](../../models/errors/forbiddencode.md) | :heavy_check_mark: | A short code indicating the error code returned. | forbidden |
|
||||
| `message` | *string* | :heavy_check_mark: | A human readable explanation of what went wrong. | The requested resource was not found. |
|
||||
| `docUrl` | *string* | :heavy_minus_sign: | A link to our documentation with more details about this error code | https://dub.co/docs/api-reference/errors#forbidden |
|
||||
@@ -1,10 +0,0 @@
|
||||
# InternalServerError
|
||||
|
||||
The server has encountered a situation it does not know how to handle.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| `error` | [errors.InternalServerErrorError](../../models/errors/internalservererrorerror.md) | :heavy_check_mark: | N/A |
|
||||
@@ -1,10 +0,0 @@
|
||||
# InternalServerErrorError
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||
| `code` | [errors.InternalServerErrorCode](../../models/errors/internalservererrorcode.md) | :heavy_check_mark: | A short code indicating the error code returned. | internal_server_error |
|
||||
| `message` | *string* | :heavy_check_mark: | A human readable explanation of what went wrong. | The requested resource was not found. |
|
||||
| `docUrl` | *string* | :heavy_minus_sign: | A link to our documentation with more details about this error code | https://dub.co/docs/api-reference/errors#internal_server_error |
|
||||
@@ -1,10 +0,0 @@
|
||||
# NotFound
|
||||
|
||||
The server cannot find the requested resource.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||
| `error` | [errors.NotFoundError](../../models/errors/notfounderror.md) | :heavy_check_mark: | N/A |
|
||||
@@ -1,10 +0,0 @@
|
||||
# UnauthorizedError
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||
| `code` | [errors.UnauthorizedCode](../../models/errors/unauthorizedcode.md) | :heavy_check_mark: | A short code indicating the error code returned. | unauthorized |
|
||||
| `message` | *string* | :heavy_check_mark: | A human readable explanation of what went wrong. | The requested resource was not found. |
|
||||
| `docUrl` | *string* | :heavy_minus_sign: | A link to our documentation with more details about this error code | https://dub.co/docs/api-reference/errors#unauthorized |
|
||||
@@ -1,10 +0,0 @@
|
||||
# UnprocessableEntity
|
||||
|
||||
The request was well-formed but was unable to be followed due to semantic errors.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| `error` | [errors.UnprocessableEntityError](../../models/errors/unprocessableentityerror.md) | :heavy_check_mark: | N/A |
|
||||
@@ -1,10 +0,0 @@
|
||||
# UnprocessableEntityError
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||
| `code` | [errors.UnprocessableEntityCode](../../models/errors/unprocessableentitycode.md) | :heavy_check_mark: | A short code indicating the error code returned. | unprocessable_entity |
|
||||
| `message` | *string* | :heavy_check_mark: | A human readable explanation of what went wrong. | The requested resource was not found. |
|
||||
| `docUrl` | *string* | :heavy_minus_sign: | A link to our documentation with more details about this error code | https://dub.co/docs/api-reference/errors#unprocessable_entity |
|
||||
2
docs/models/operations/adddomainresponse.md
Normal file
2
docs/models/operations/adddomainresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# AddDomainResponse
|
||||
|
||||
2
docs/models/operations/bulkcreatelinksresponse.md
Normal file
2
docs/models/operations/bulkcreatelinksresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# BulkCreateLinksResponse
|
||||
|
||||
2
docs/models/operations/createlinkresponse.md
Normal file
2
docs/models/operations/createlinkresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# CreateLinkResponse
|
||||
|
||||
2
docs/models/operations/createtagresponse.md
Normal file
2
docs/models/operations/createtagresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# CreateTagResponse
|
||||
|
||||
2
docs/models/operations/createworkspaceresponse.md
Normal file
2
docs/models/operations/createworkspaceresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# CreateWorkspaceResponse
|
||||
|
||||
2
docs/models/operations/deletedomainresponse.md
Normal file
2
docs/models/operations/deletedomainresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# DeleteDomainResponse
|
||||
|
||||
2
docs/models/operations/deletelinkresponse.md
Normal file
2
docs/models/operations/deletelinkresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# DeleteLinkResponse
|
||||
|
||||
2
docs/models/operations/editdomainresponse.md
Normal file
2
docs/models/operations/editdomainresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# EditDomainResponse
|
||||
|
||||
2
docs/models/operations/editlinkresponse.md
Normal file
2
docs/models/operations/editlinkresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# EditLinkResponse
|
||||
|
||||
@@ -3,17 +3,18 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
|
||||
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
|
||||
| `interval` | [operations.GetBrowserAnalyticsQueryParamInterval](../../models/operations/getbrowseranalyticsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
|
||||
| `country` | [operations.GetBrowserAnalyticsQueryParamCountry](../../models/operations/getbrowseranalyticsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
|
||||
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
|
||||
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
|
||||
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
|
||||
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
|
||||
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
|
||||
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
|
||||
| `excludeRoot` | *boolean* | :heavy_minus_sign: | Whether to exclude the root link from the response. |
|
||||
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
|
||||
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
|
||||
| `interval` | [operations.GetBrowserAnalyticsQueryParamInterval](../../models/operations/getbrowseranalyticsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
|
||||
| `country` | [operations.GetBrowserAnalyticsQueryParamCountry](../../models/operations/getbrowseranalyticsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
|
||||
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
|
||||
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
|
||||
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
|
||||
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
|
||||
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
|
||||
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
|
||||
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
|
||||
| `qr` | *boolean* | :heavy_minus_sign: | Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both. |
|
||||
| `root` | *boolean* | :heavy_minus_sign: | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. |
|
||||
2
docs/models/operations/getbrowseranalyticsresponse.md
Normal file
2
docs/models/operations/getbrowseranalyticsresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# GetBrowserAnalyticsResponse
|
||||
|
||||
@@ -3,17 +3,18 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
|
||||
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
|
||||
| `interval` | [operations.GetCityAnalyticsQueryParamInterval](../../models/operations/getcityanalyticsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
|
||||
| `country` | [operations.GetCityAnalyticsQueryParamCountry](../../models/operations/getcityanalyticsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
|
||||
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
|
||||
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
|
||||
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
|
||||
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
|
||||
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
|
||||
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
|
||||
| `excludeRoot` | *boolean* | :heavy_minus_sign: | Whether to exclude the root link from the response. |
|
||||
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
|
||||
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
|
||||
| `interval` | [operations.GetCityAnalyticsQueryParamInterval](../../models/operations/getcityanalyticsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
|
||||
| `country` | [operations.GetCityAnalyticsQueryParamCountry](../../models/operations/getcityanalyticsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
|
||||
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
|
||||
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
|
||||
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
|
||||
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
|
||||
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
|
||||
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
|
||||
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
|
||||
| `qr` | *boolean* | :heavy_minus_sign: | Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both. |
|
||||
| `root` | *boolean* | :heavy_minus_sign: | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. |
|
||||
2
docs/models/operations/getcityanalyticsresponse.md
Normal file
2
docs/models/operations/getcityanalyticsresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# GetCityAnalyticsResponse
|
||||
|
||||
@@ -3,17 +3,18 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
||||
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
|
||||
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
|
||||
| `interval` | [operations.Interval](../../models/operations/interval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
|
||||
| `country` | [operations.Country](../../models/operations/country.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
|
||||
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
|
||||
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
|
||||
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
|
||||
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
|
||||
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
|
||||
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
|
||||
| `excludeRoot` | *boolean* | :heavy_minus_sign: | Whether to exclude the root link from the response. |
|
||||
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
|
||||
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
|
||||
| `interval` | [operations.Interval](../../models/operations/interval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
|
||||
| `country` | [operations.Country](../../models/operations/country.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
|
||||
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
|
||||
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
|
||||
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
|
||||
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
|
||||
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
|
||||
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
|
||||
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
|
||||
| `qr` | *boolean* | :heavy_minus_sign: | Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both. |
|
||||
| `root` | *boolean* | :heavy_minus_sign: | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. |
|
||||
2
docs/models/operations/getclicksanalyticsresponse.md
Normal file
2
docs/models/operations/getclicksanalyticsresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# GetClicksAnalyticsResponse
|
||||
|
||||
@@ -3,17 +3,18 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
|
||||
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
|
||||
| `interval` | [operations.GetCountryAnalyticsQueryParamInterval](../../models/operations/getcountryanalyticsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
|
||||
| `country` | [operations.GetCountryAnalyticsQueryParamCountry](../../models/operations/getcountryanalyticsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
|
||||
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
|
||||
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
|
||||
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
|
||||
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
|
||||
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
|
||||
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
|
||||
| `excludeRoot` | *boolean* | :heavy_minus_sign: | Whether to exclude the root link from the response. |
|
||||
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
|
||||
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
|
||||
| `interval` | [operations.GetCountryAnalyticsQueryParamInterval](../../models/operations/getcountryanalyticsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
|
||||
| `country` | [operations.GetCountryAnalyticsQueryParamCountry](../../models/operations/getcountryanalyticsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
|
||||
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
|
||||
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
|
||||
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
|
||||
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
|
||||
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
|
||||
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
|
||||
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
|
||||
| `qr` | *boolean* | :heavy_minus_sign: | Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both. |
|
||||
| `root` | *boolean* | :heavy_minus_sign: | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. |
|
||||
2
docs/models/operations/getcountryanalyticsresponse.md
Normal file
2
docs/models/operations/getcountryanalyticsresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# GetCountryAnalyticsResponse
|
||||
|
||||
@@ -3,17 +3,18 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
|
||||
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
|
||||
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
|
||||
| `interval` | [operations.GetDeviceAnalyticsQueryParamInterval](../../models/operations/getdeviceanalyticsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
|
||||
| `country` | [operations.GetDeviceAnalyticsQueryParamCountry](../../models/operations/getdeviceanalyticsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
|
||||
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
|
||||
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
|
||||
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
|
||||
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
|
||||
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
|
||||
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
|
||||
| `excludeRoot` | *boolean* | :heavy_minus_sign: | Whether to exclude the root link from the response. |
|
||||
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
|
||||
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
|
||||
| `interval` | [operations.GetDeviceAnalyticsQueryParamInterval](../../models/operations/getdeviceanalyticsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
|
||||
| `country` | [operations.GetDeviceAnalyticsQueryParamCountry](../../models/operations/getdeviceanalyticsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
|
||||
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
|
||||
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
|
||||
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
|
||||
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
|
||||
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
|
||||
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
|
||||
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
|
||||
| `qr` | *boolean* | :heavy_minus_sign: | Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both. |
|
||||
| `root` | *boolean* | :heavy_minus_sign: | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. |
|
||||
2
docs/models/operations/getdeviceanalyticsresponse.md
Normal file
2
docs/models/operations/getdeviceanalyticsresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# GetDeviceAnalyticsResponse
|
||||
|
||||
2
docs/models/operations/getlinkinforesponse.md
Normal file
2
docs/models/operations/getlinkinforesponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# GetLinkInfoResponse
|
||||
|
||||
2
docs/models/operations/getlinkscountresponse.md
Normal file
2
docs/models/operations/getlinkscountresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# GetLinksCountResponse
|
||||
|
||||
2
docs/models/operations/getlinksresponse.md
Normal file
2
docs/models/operations/getlinksresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# GetLinksResponse
|
||||
|
||||
@@ -3,6 +3,6 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `url` | *string* | :heavy_check_mark: | N/A |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
|
||||
| `url` | *string* | :heavy_check_mark: | The URL to retrieve metatags for. | https://dub.co |
|
||||
@@ -7,6 +7,6 @@ The retrieved metatags
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||
| `title` | *string* | :heavy_check_mark: | The meta title tag for the URL | Dub.co - Link Management for Modern Marketing Teams |
|
||||
| `description` | *string* | :heavy_check_mark: | The meta description tag for the URL | Dub.co is the open-source link management infrastructure ... |
|
||||
| `image` | *string* | :heavy_check_mark: | The OpenGraph image for the URL | https://assets.dub.co/thumbnail.jpg |
|
||||
| `title` | *string* | :heavy_check_mark: | The meta title tag for the URL. | Dub.co - Link Management for Modern Marketing Teams |
|
||||
| `description` | *string* | :heavy_check_mark: | The meta description tag for the URL. | Dub.co is the open-source link management infrastructure ... |
|
||||
| `image` | *string* | :heavy_check_mark: | The OpenGraph image for the URL. | https://assets.dub.co/thumbnail.jpg |
|
||||
@@ -3,17 +3,18 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
||||
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
|
||||
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
|
||||
| `interval` | [operations.GetOSAnalyticsQueryParamInterval](../../models/operations/getosanalyticsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
|
||||
| `country` | [operations.GetOSAnalyticsQueryParamCountry](../../models/operations/getosanalyticsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
|
||||
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
|
||||
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
|
||||
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
|
||||
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
|
||||
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
|
||||
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
|
||||
| `excludeRoot` | *boolean* | :heavy_minus_sign: | Whether to exclude the root link from the response. |
|
||||
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
|
||||
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
|
||||
| `interval` | [operations.GetOSAnalyticsQueryParamInterval](../../models/operations/getosanalyticsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
|
||||
| `country` | [operations.GetOSAnalyticsQueryParamCountry](../../models/operations/getosanalyticsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
|
||||
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
|
||||
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
|
||||
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
|
||||
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
|
||||
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
|
||||
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
|
||||
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
|
||||
| `qr` | *boolean* | :heavy_minus_sign: | Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both. |
|
||||
| `root` | *boolean* | :heavy_minus_sign: | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. |
|
||||
2
docs/models/operations/getosanalyticsresponse.md
Normal file
2
docs/models/operations/getosanalyticsresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# GetOSAnalyticsResponse
|
||||
|
||||
2
docs/models/operations/getqrcoderesponse.md
Normal file
2
docs/models/operations/getqrcoderesponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# GetQRCodeResponse
|
||||
|
||||
@@ -3,17 +3,18 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
|
||||
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
|
||||
| `interval` | [operations.GetRefererAnalyticsQueryParamInterval](../../models/operations/getrefereranalyticsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
|
||||
| `country` | [operations.GetRefererAnalyticsQueryParamCountry](../../models/operations/getrefereranalyticsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
|
||||
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
|
||||
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
|
||||
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
|
||||
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
|
||||
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
|
||||
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
|
||||
| `excludeRoot` | *boolean* | :heavy_minus_sign: | Whether to exclude the root link from the response. |
|
||||
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
|
||||
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
|
||||
| `interval` | [operations.GetRefererAnalyticsQueryParamInterval](../../models/operations/getrefereranalyticsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
|
||||
| `country` | [operations.GetRefererAnalyticsQueryParamCountry](../../models/operations/getrefereranalyticsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
|
||||
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
|
||||
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
|
||||
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
|
||||
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
|
||||
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
|
||||
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
|
||||
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
|
||||
| `qr` | *boolean* | :heavy_minus_sign: | Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both. |
|
||||
| `root` | *boolean* | :heavy_minus_sign: | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. |
|
||||
2
docs/models/operations/getrefereranalyticsresponse.md
Normal file
2
docs/models/operations/getrefereranalyticsresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# GetRefererAnalyticsResponse
|
||||
|
||||
2
docs/models/operations/gettagsresponse.md
Normal file
2
docs/models/operations/gettagsresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# GetTagsResponse
|
||||
|
||||
@@ -3,17 +3,18 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
|
||||
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
|
||||
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
|
||||
| `interval` | [operations.QueryParamInterval](../../models/operations/queryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
|
||||
| `country` | [operations.QueryParamCountry](../../models/operations/queryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
|
||||
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
|
||||
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
|
||||
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
|
||||
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
|
||||
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
|
||||
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
|
||||
| `excludeRoot` | *boolean* | :heavy_minus_sign: | Whether to exclude the root link from the response. |
|
||||
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
|
||||
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
|
||||
| `interval` | [operations.QueryParamInterval](../../models/operations/queryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
|
||||
| `country` | [operations.QueryParamCountry](../../models/operations/queryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
|
||||
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
|
||||
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
|
||||
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
|
||||
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
|
||||
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
|
||||
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
|
||||
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
|
||||
| `qr` | *boolean* | :heavy_minus_sign: | Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both. |
|
||||
| `root` | *boolean* | :heavy_minus_sign: | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. |
|
||||
2
docs/models/operations/gettimeseriesanalyticsresponse.md
Normal file
2
docs/models/operations/gettimeseriesanalyticsresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# GetTimeseriesAnalyticsResponse
|
||||
|
||||
@@ -3,17 +3,18 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
|
||||
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
|
||||
| `interval` | [operations.GetTopLinksQueryParamInterval](../../models/operations/gettoplinksqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
|
||||
| `country` | [operations.GetTopLinksQueryParamCountry](../../models/operations/gettoplinksqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
|
||||
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
|
||||
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
|
||||
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
|
||||
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
|
||||
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
|
||||
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
|
||||
| `excludeRoot` | *boolean* | :heavy_minus_sign: | Whether to exclude the root link from the response. |
|
||||
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
|
||||
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
|
||||
| `interval` | [operations.GetTopLinksQueryParamInterval](../../models/operations/gettoplinksqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
|
||||
| `country` | [operations.GetTopLinksQueryParamCountry](../../models/operations/gettoplinksqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
|
||||
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
|
||||
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
|
||||
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
|
||||
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
|
||||
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
|
||||
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
|
||||
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
|
||||
| `qr` | *boolean* | :heavy_minus_sign: | Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both. |
|
||||
| `root` | *boolean* | :heavy_minus_sign: | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. |
|
||||
2
docs/models/operations/gettoplinksresponse.md
Normal file
2
docs/models/operations/gettoplinksresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# GetTopLinksResponse
|
||||
|
||||
@@ -3,17 +3,18 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
||||
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
|
||||
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
|
||||
| `interval` | [operations.GetTopURLsQueryParamInterval](../../models/operations/gettopurlsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
|
||||
| `country` | [operations.GetTopURLsQueryParamCountry](../../models/operations/gettopurlsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
|
||||
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
|
||||
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
|
||||
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
|
||||
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
|
||||
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
|
||||
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
|
||||
| `excludeRoot` | *boolean* | :heavy_minus_sign: | Whether to exclude the root link from the response. |
|
||||
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. |
|
||||
| `key` | *string* | :heavy_minus_sign: | The short link slug. |
|
||||
| `interval` | [operations.GetTopURLsQueryParamInterval](../../models/operations/gettopurlsqueryparaminterval.md) | :heavy_minus_sign: | The interval to retrieve analytics for. |
|
||||
| `country` | [operations.GetTopURLsQueryParamCountry](../../models/operations/gettopurlsqueryparamcountry.md) | :heavy_minus_sign: | The country to retrieve analytics for. |
|
||||
| `city` | *string* | :heavy_minus_sign: | The city to retrieve analytics for. |
|
||||
| `device` | *string* | :heavy_minus_sign: | The device to retrieve analytics for. |
|
||||
| `browser` | *string* | :heavy_minus_sign: | The browser to retrieve analytics for. |
|
||||
| `os` | *string* | :heavy_minus_sign: | The OS to retrieve analytics for. |
|
||||
| `referer` | *string* | :heavy_minus_sign: | The referer to retrieve analytics for. |
|
||||
| `url` | *string* | :heavy_minus_sign: | The URL to retrieve analytics for. |
|
||||
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to retrieve analytics for. |
|
||||
| `qr` | *boolean* | :heavy_minus_sign: | Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both. |
|
||||
| `root` | *boolean* | :heavy_minus_sign: | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. |
|
||||
2
docs/models/operations/gettopurlsresponse.md
Normal file
2
docs/models/operations/gettopurlsresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# GetTopURLsResponse
|
||||
|
||||
2
docs/models/operations/getworkspaceresponse.md
Normal file
2
docs/models/operations/getworkspaceresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# GetWorkspaceResponse
|
||||
|
||||
2
docs/models/operations/getworkspacesresponse.md
Normal file
2
docs/models/operations/getworkspacesresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# GetWorkspacesResponse
|
||||
|
||||
2
docs/models/operations/listdomainsresponse.md
Normal file
2
docs/models/operations/listdomainsresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# ListDomainsResponse
|
||||
|
||||
2
docs/models/operations/setprimarydomainresponse.md
Normal file
2
docs/models/operations/setprimarydomainresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# SetPrimaryDomainResponse
|
||||
|
||||
2
docs/models/operations/transferdomainresponse.md
Normal file
2
docs/models/operations/transferdomainresponse.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# TransferDomainResponse
|
||||
|
||||
@@ -49,21 +49,12 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[number](../../models/.md)>**
|
||||
**Promise<[operations.GetClicksAnalyticsResponse](../../models/operations/getclicksanalyticsresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## timeseries
|
||||
|
||||
@@ -100,21 +91,12 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[operations.ResponseBody[]](../../models/.md)>**
|
||||
**Promise<[operations.GetTimeseriesAnalyticsResponse](../../models/operations/gettimeseriesanalyticsresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## countries
|
||||
|
||||
@@ -151,21 +133,12 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[operations.GetCountryAnalyticsResponseBody[]](../../models/.md)>**
|
||||
**Promise<[operations.GetCountryAnalyticsResponse](../../models/operations/getcountryanalyticsresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## cities
|
||||
|
||||
@@ -202,21 +175,12 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[operations.GetCityAnalyticsResponseBody[]](../../models/.md)>**
|
||||
**Promise<[operations.GetCityAnalyticsResponse](../../models/operations/getcityanalyticsresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## devices
|
||||
|
||||
@@ -253,21 +217,12 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[operations.GetDeviceAnalyticsResponseBody[]](../../models/.md)>**
|
||||
**Promise<[operations.GetDeviceAnalyticsResponse](../../models/operations/getdeviceanalyticsresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## browsers
|
||||
|
||||
@@ -304,21 +259,12 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[operations.GetBrowserAnalyticsResponseBody[]](../../models/.md)>**
|
||||
**Promise<[operations.GetBrowserAnalyticsResponse](../../models/operations/getbrowseranalyticsresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## os
|
||||
|
||||
@@ -355,21 +301,12 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[operations.GetOSAnalyticsResponseBody[]](../../models/.md)>**
|
||||
**Promise<[operations.GetOSAnalyticsResponse](../../models/operations/getosanalyticsresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## referers
|
||||
|
||||
@@ -406,21 +343,12 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[operations.GetRefererAnalyticsResponseBody[]](../../models/.md)>**
|
||||
**Promise<[operations.GetRefererAnalyticsResponse](../../models/operations/getrefereranalyticsresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## topLinks
|
||||
|
||||
@@ -457,21 +385,12 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[operations.GetTopLinksResponseBody[]](../../models/.md)>**
|
||||
**Promise<[operations.GetTopLinksResponse](../../models/operations/gettoplinksresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## topUrls
|
||||
|
||||
@@ -508,18 +427,9 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[operations.GetTopURLsResponseBody[]](../../models/.md)>**
|
||||
**Promise<[operations.GetTopURLsResponse](../../models/operations/gettopurlsresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
@@ -45,21 +45,12 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[operations.ListDomainsResponseBody[]](../../models/.md)>**
|
||||
**Promise<[operations.ListDomainsResponse](../../models/operations/listdomainsresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## add
|
||||
|
||||
@@ -98,21 +89,12 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[operations.AddDomainResponseBody](../../models/operations/adddomainresponsebody.md)>**
|
||||
**Promise<[operations.AddDomainResponse](../../models/operations/adddomainresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## delete
|
||||
|
||||
@@ -151,21 +133,12 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[operations.DeleteDomainResponseBody](../../models/operations/deletedomainresponsebody.md)>**
|
||||
**Promise<[operations.DeleteDomainResponse](../../models/operations/deletedomainresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## update
|
||||
|
||||
@@ -205,21 +178,12 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[operations.EditDomainResponseBody](../../models/operations/editdomainresponsebody.md)>**
|
||||
**Promise<[operations.EditDomainResponse](../../models/operations/editdomainresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## setPrimary
|
||||
|
||||
@@ -258,21 +222,12 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[operations.SetPrimaryDomainResponseBody](../../models/operations/setprimarydomainresponsebody.md)>**
|
||||
**Promise<[operations.SetPrimaryDomainResponse](../../models/operations/setprimarydomainresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## transfer
|
||||
|
||||
@@ -314,18 +269,9 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[operations.TransferDomainResponseBody](../../models/operations/transferdomainresponsebody.md)>**
|
||||
**Promise<[operations.TransferDomainResponse](../../models/operations/transferdomainresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
@@ -50,21 +50,12 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[components.LinkSchema[]](../../models/.md)>**
|
||||
**Promise<[operations.GetLinksResponse](../../models/operations/getlinksresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## create
|
||||
|
||||
@@ -107,21 +98,12 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[components.LinkSchema](../../models/components/linkschema.md)>**
|
||||
**Promise<[operations.CreateLinkResponse](../../models/operations/createlinkresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## count
|
||||
|
||||
@@ -162,21 +144,12 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[number](../../models/.md)>**
|
||||
**Promise<[operations.GetLinksCountResponse](../../models/operations/getlinkscountresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## get
|
||||
|
||||
@@ -216,21 +189,12 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[components.LinkSchema](../../models/components/linkschema.md)>**
|
||||
**Promise<[operations.GetLinkInfoResponse](../../models/operations/getlinkinforesponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## update
|
||||
|
||||
@@ -277,21 +241,12 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[components.LinkSchema](../../models/components/linkschema.md)>**
|
||||
**Promise<[operations.EditLinkResponse](../../models/operations/editlinkresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## delete
|
||||
|
||||
@@ -330,21 +285,12 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[operations.DeleteLinkResponseBody](../../models/operations/deletelinkresponsebody.md)>**
|
||||
**Promise<[operations.DeleteLinkResponse](../../models/operations/deletelinkresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## createMany
|
||||
|
||||
@@ -389,18 +335,9 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[components.LinkSchema[]](../../models/.md)>**
|
||||
**Promise<[operations.BulkCreateLinksResponse](../../models/operations/bulkcreatelinksresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
|
||||
## get
|
||||
|
||||
Retrieve the metatags for a URL
|
||||
Retrieve the metatags for a URL.
|
||||
|
||||
### Example Usage
|
||||
|
||||
@@ -21,7 +21,7 @@ const dub = new Dub({
|
||||
|
||||
async function run() {
|
||||
const result = await dub.metatags.get({
|
||||
url: "https://brief-micronutrient.org",
|
||||
url: "https://dub.co",
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
|
||||
@@ -40,18 +40,9 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[string](../../models/.md)>**
|
||||
**Promise<[operations.GetQRCodeResponse](../../models/operations/getqrcoderesponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
@@ -41,21 +41,12 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[components.TagSchema[]](../../models/.md)>**
|
||||
**Promise<[operations.GetTagsResponse](../../models/operations/gettagsresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## create
|
||||
|
||||
@@ -94,18 +85,9 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[components.TagSchema](../../models/components/tagschema.md)>**
|
||||
**Promise<[operations.CreateTagResponse](../../models/operations/createtagresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
@@ -41,21 +41,12 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[components.WorkspaceSchema[]](../../models/.md)>**
|
||||
**Promise<[operations.GetWorkspacesResponse](../../models/operations/getworkspacesresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## create
|
||||
|
||||
@@ -95,21 +86,12 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[components.WorkspaceSchema](../../models/components/workspaceschema.md)>**
|
||||
**Promise<[operations.CreateWorkspaceResponse](../../models/operations/createworkspaceresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
## get
|
||||
|
||||
@@ -148,18 +130,9 @@ run();
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[components.WorkspaceSchema](../../models/components/workspaceschema.md)>**
|
||||
**Promise<[operations.GetWorkspaceResponse](../../models/operations/getworkspaceresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| -------------------------- | -------------------------- | -------------------------- |
|
||||
| errors.BadRequest | 400 | application/json |
|
||||
| errors.Unauthorized | 401 | application/json |
|
||||
| errors.Forbidden | 403 | application/json |
|
||||
| errors.NotFound | 404 | application/json |
|
||||
| errors.Conflict | 409 | application/json |
|
||||
| errors.InviteExpired | 410 | application/json |
|
||||
| errors.UnprocessableEntity | 422 | application/json |
|
||||
| errors.RateLimitExceeded | 429 | application/json |
|
||||
| errors.InternalServerError | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
26
jsr.json
Normal file
26
jsr.json
Normal file
@@ -0,0 +1,26 @@
|
||||
|
||||
|
||||
{
|
||||
"name": "dub",
|
||||
"version": "0.24.0",
|
||||
"exports": {
|
||||
".": "./src/index.ts",
|
||||
"./models/errors": "./src/models/errors/index.ts",
|
||||
"./models/components": "./src/models/components/index.ts",
|
||||
"./models/operations": "./src/models/operations/index.ts",
|
||||
"./lib/config": "./src/lib/config.ts",
|
||||
"./lib/http": "./src/lib/http.ts",
|
||||
"./lib/retries": "./src/lib/retries.ts",
|
||||
"./lib/sdks": "./src/lib/sdks.ts",
|
||||
"./types": "./src/types/index.ts"
|
||||
},
|
||||
"publish": {
|
||||
"include": [
|
||||
"LICENSE",
|
||||
"README.md",
|
||||
"RUNTIMES.md",
|
||||
"USAGE.md",
|
||||
"src/**/*.ts"
|
||||
]
|
||||
}
|
||||
}
|
||||
4
package-lock.json
generated
4
package-lock.json
generated
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "dub",
|
||||
"version": "0.23.1",
|
||||
"version": "0.24.0",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "dub",
|
||||
"version": "0.23.1",
|
||||
"version": "0.24.0",
|
||||
"devDependencies": {
|
||||
"@types/jsonpath": "^0.2.4",
|
||||
"@types/node": "^20.12.7",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "dub",
|
||||
"version": "0.23.1",
|
||||
"version": "0.24.0",
|
||||
"author": "Dub",
|
||||
"main": "./index.js",
|
||||
"sideEffects": false,
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
import { HTTPClient } from "./http";
|
||||
import { RetryConfig } from "./retries";
|
||||
import { pathToFunc } from "./url";
|
||||
import { Params, pathToFunc } from "./url";
|
||||
|
||||
/**
|
||||
* Contains the list of servers available to the SDK
|
||||
@@ -47,7 +47,7 @@ export type SDKOptions = {
|
||||
export function serverURLFromOptions(options: SDKOptions): URL | null {
|
||||
let serverURL = options.serverURL;
|
||||
|
||||
const params: Record<string, string> = {};
|
||||
const params: Params = {};
|
||||
|
||||
if (!serverURL) {
|
||||
const serverIdx = options.serverIdx ?? 0;
|
||||
@@ -61,10 +61,10 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
|
||||
return new URL(u);
|
||||
}
|
||||
|
||||
export const SDK_METADATA = Object.freeze({
|
||||
export const SDK_METADATA = {
|
||||
language: "typescript",
|
||||
openapiDocVersion: "0.0.1",
|
||||
sdkVersion: "0.23.1",
|
||||
genVersion: "2.308.2",
|
||||
userAgent: "speakeasy-sdk/typescript 0.23.1 2.308.2 0.0.1 dub",
|
||||
});
|
||||
sdkVersion: "0.24.0",
|
||||
genVersion: "2.311.1",
|
||||
userAgent: "speakeasy-sdk/typescript 0.24.0 2.311.1 0.0.1 dub",
|
||||
} as const;
|
||||
|
||||
@@ -15,7 +15,7 @@ export function encodeMatrix(
|
||||
key: string,
|
||||
value: unknown,
|
||||
options?: { explode?: boolean; charEncoding?: "percent" | "none" },
|
||||
) {
|
||||
): string {
|
||||
let out = "";
|
||||
const pairs: [string, unknown][] = options?.explode
|
||||
? explode(key, value)
|
||||
@@ -65,7 +65,7 @@ export function encodeLabel(
|
||||
key: string,
|
||||
value: unknown,
|
||||
options?: { explode?: boolean; charEncoding?: "percent" | "none" },
|
||||
) {
|
||||
): string {
|
||||
let out = "";
|
||||
const pairs: [string, unknown][] = options?.explode
|
||||
? explode(key, value)
|
||||
@@ -100,7 +100,13 @@ export function encodeLabel(
|
||||
return out;
|
||||
}
|
||||
|
||||
function formEncoder(sep: string) {
|
||||
type FormEncoder = (
|
||||
key: string,
|
||||
value: unknown,
|
||||
options?: { explode?: boolean; charEncoding?: "percent" | "none" },
|
||||
) => string;
|
||||
|
||||
function formEncoder(sep: string): FormEncoder {
|
||||
return (
|
||||
key: string,
|
||||
value: unknown,
|
||||
@@ -157,7 +163,7 @@ export function encodeBodyForm(
|
||||
key: string,
|
||||
value: unknown,
|
||||
options?: { explode?: boolean; charEncoding?: "percent" | "none" },
|
||||
) {
|
||||
): string {
|
||||
let out = "";
|
||||
const pairs: [string, unknown][] = options?.explode
|
||||
? explode(key, value)
|
||||
@@ -200,7 +206,7 @@ export function encodeDeepObject(
|
||||
key: string,
|
||||
value: unknown,
|
||||
options?: { charEncoding?: "percent" | "none" },
|
||||
) {
|
||||
): string {
|
||||
if (value == null) {
|
||||
return "";
|
||||
}
|
||||
@@ -247,7 +253,7 @@ export function encodeJSON(
|
||||
key: string,
|
||||
value: unknown,
|
||||
options?: { explode?: boolean; charEncoding?: "percent" | "none" },
|
||||
) {
|
||||
): string {
|
||||
if (typeof value === "undefined") {
|
||||
return "";
|
||||
}
|
||||
@@ -265,7 +271,7 @@ export const encodeSimple = (
|
||||
key: string,
|
||||
value: unknown,
|
||||
options?: { explode?: boolean; charEncoding?: "percent" | "none" },
|
||||
) => {
|
||||
): string => {
|
||||
let out = "";
|
||||
const pairs: [string, unknown][] = options?.explode
|
||||
? explode(key, value)
|
||||
@@ -337,7 +343,7 @@ function serializeValue(value: unknown): string {
|
||||
return `${value}`;
|
||||
}
|
||||
|
||||
function jsonReplacer(_: string, value: unknown) {
|
||||
function jsonReplacer(_: string, value: unknown): unknown {
|
||||
if (value instanceof Uint8Array) {
|
||||
return bytesToBase64(value);
|
||||
} else {
|
||||
|
||||
@@ -7,7 +7,7 @@ export type Fetcher = (
|
||||
init?: RequestInit,
|
||||
) => Promise<Response>;
|
||||
|
||||
type Awaitable<T> = T | Promise<T>;
|
||||
export type Awaitable<T> = T | Promise<T>;
|
||||
|
||||
const DEFAULT_FETCHER: Fetcher = (input, init) => fetch(input, init);
|
||||
|
||||
@@ -15,9 +15,9 @@ export interface HTTPClientOptions {
|
||||
fetcher?: Fetcher;
|
||||
}
|
||||
|
||||
type BeforeRequestHook = (req: Request) => Awaitable<Request | void>;
|
||||
type RequestErrorHook = (err: unknown, req: Request) => Awaitable<void>;
|
||||
type ResponseHook = (res: Response, req: Request) => Awaitable<void>;
|
||||
export type BeforeRequestHook = (req: Request) => Awaitable<Request | void>;
|
||||
export type RequestErrorHook = (err: unknown, req: Request) => Awaitable<void>;
|
||||
export type ResponseHook = (res: Response, req: Request) => Awaitable<void>;
|
||||
|
||||
export class HTTPClient {
|
||||
private fetcher: Fetcher;
|
||||
@@ -100,7 +100,7 @@ export class HTTPClient {
|
||||
| [hook: "beforeRequest", fn: BeforeRequestHook]
|
||||
| [hook: "requestError", fn: RequestErrorHook]
|
||||
| [hook: "response", fn: ResponseHook]
|
||||
) {
|
||||
): this {
|
||||
let target: unknown[];
|
||||
if (args[0] === "beforeRequest") {
|
||||
target = this.requestHooks;
|
||||
@@ -120,7 +120,7 @@ export class HTTPClient {
|
||||
return this;
|
||||
}
|
||||
|
||||
clone() {
|
||||
clone(): HTTPClient {
|
||||
const child = new HTTPClient(this.options);
|
||||
child.requestHooks = this.requestHooks.slice();
|
||||
child.requestErrorHooks = this.requestErrorHooks.slice();
|
||||
@@ -160,7 +160,7 @@ const codeRangeRE = new RegExp("^[0-9]xx$", "i");
|
||||
export function matchStatusCode(
|
||||
response: Response,
|
||||
codes: number | string | (number | string)[],
|
||||
) {
|
||||
): boolean {
|
||||
const actual = `${response.status}`;
|
||||
const expectedCodes = Array.isArray(codes) ? codes : [codes];
|
||||
if (!expectedCodes.length) {
|
||||
|
||||
@@ -40,7 +40,7 @@ export class ClientSDK {
|
||||
this.client = client;
|
||||
}
|
||||
|
||||
protected createRequest$(conf: RequestConfig, options?: RequestOptions) {
|
||||
protected createRequest$(conf: RequestConfig, options?: RequestOptions): Request {
|
||||
const { method, path, query, headers: opHeaders, security } = conf;
|
||||
|
||||
const base = conf.baseURL ?? this.baseURL;
|
||||
@@ -109,7 +109,7 @@ export class ClientSDK {
|
||||
context: HookContext;
|
||||
errorCodes: number | string | (number | string)[];
|
||||
}
|
||||
) {
|
||||
): Promise<Response> {
|
||||
const { context, errorCodes } = options;
|
||||
|
||||
let response = await this.client.request(await this.hooks$.beforeRequest(context, req));
|
||||
|
||||
@@ -169,7 +169,9 @@ function applyBearer(
|
||||
|
||||
state.headers[spec.fieldName] = value;
|
||||
}
|
||||
export function resolveGlobalSecurity(security: Partial<components.Security> | null | undefined) {
|
||||
export function resolveGlobalSecurity(
|
||||
security: Partial<components.Security> | null | undefined
|
||||
): SecurityState | null {
|
||||
return resolveSecurity([
|
||||
{
|
||||
fieldName: "Authorization",
|
||||
|
||||
@@ -4,10 +4,12 @@
|
||||
|
||||
const hasOwn = Object.prototype.hasOwnProperty;
|
||||
|
||||
export type Params = Partial<Record<string, string | number>>;
|
||||
|
||||
export function pathToFunc(
|
||||
pathPattern: string,
|
||||
options?: { charEncoding?: "percent" | "none" },
|
||||
): (params?: Record<string, string | number>) => string {
|
||||
): (params?: Params) => string {
|
||||
const paramRE = /\{([a-zA-Z0-9_]+?)\}/g;
|
||||
|
||||
return function buildURLPath(params: Record<string, unknown> = {}): string {
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user