mirror of
https://github.com/LukeHagar/dub-node.git
synced 2025-12-06 04:19:37 +00:00
Generate SDK using Speakeasy
This commit is contained in:
Kiran K
28
.eslintrc.js
Normal file
28
.eslintrc.js
Normal file
@@ -0,0 +1,28 @@
|
||||
/* eslint-env node */
|
||||
module.exports = {
|
||||
root: true,
|
||||
extends: [
|
||||
"eslint:recommended",
|
||||
"plugin:@typescript-eslint/recommended",
|
||||
"plugin:import/recommended",
|
||||
"plugin:import/typescript",
|
||||
],
|
||||
parser: "@typescript-eslint/parser",
|
||||
plugins: ["@typescript-eslint"],
|
||||
settings: {
|
||||
"import/resolver": {
|
||||
typescript: true,
|
||||
node: true,
|
||||
},
|
||||
},
|
||||
rules: {
|
||||
// Handled by typescript compiler
|
||||
"@typescript-eslint/no-unused-vars": "off",
|
||||
"@typescript-eslint/ban-types": "off",
|
||||
"@typescript-eslint/no-namespace": "off",
|
||||
"@typescript-eslint/no-explicit-any": "off",
|
||||
"import/no-named-as-default-member": "off",
|
||||
|
||||
"import/no-default-export": "error",
|
||||
},
|
||||
};
|
||||
1
.genignore
Normal file
1
.genignore
Normal file
@@ -0,0 +1 @@
|
||||
src/index.ts
|
||||
2
.gitattributes
vendored
Normal file
2
.gitattributes
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
# This allows generated code to be indexed correctly
|
||||
*.ts linguist-generated=false
|
||||
26
.github/workflows/sdk_generation.yaml
vendored
Normal file
26
.github/workflows/sdk_generation.yaml
vendored
Normal file
@@ -0,0 +1,26 @@
|
||||
name: Generate
|
||||
permissions:
|
||||
checks: write
|
||||
contents: write
|
||||
pull-requests: write
|
||||
statuses: write
|
||||
"on":
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
force:
|
||||
description: Force generation of SDKs
|
||||
type: boolean
|
||||
default: false
|
||||
schedule:
|
||||
- cron: 0 0 * * *
|
||||
jobs:
|
||||
generate:
|
||||
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
|
||||
with:
|
||||
force: ${{ github.event.inputs.force }}
|
||||
mode: pr
|
||||
speakeasy_version: latest
|
||||
secrets:
|
||||
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
npm_token: ${{ secrets.NPM_TOKEN }}
|
||||
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
||||
15
.github/workflows/sdk_publish.yaml
vendored
Normal file
15
.github/workflows/sdk_publish.yaml
vendored
Normal file
@@ -0,0 +1,15 @@
|
||||
name: Publish
|
||||
"on":
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
paths:
|
||||
- RELEASES.md
|
||||
- '*/RELEASES.md'
|
||||
jobs:
|
||||
publish:
|
||||
uses: speakeasy-api/sdk-generation-action/.github/workflows/sdk-publish.yaml@v15
|
||||
secrets:
|
||||
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
npm_token: ${{ secrets.NPM_TOKEN }}
|
||||
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
||||
10
.gitignore
vendored
Normal file
10
.gitignore
vendored
Normal file
@@ -0,0 +1,10 @@
|
||||
/models
|
||||
/models/errors
|
||||
/types
|
||||
/lib
|
||||
/sdk
|
||||
/hooks
|
||||
/index.*
|
||||
/cjs
|
||||
/node_modules
|
||||
/.tsbuildinfo
|
||||
8
.npmignore
Normal file
8
.npmignore
Normal file
@@ -0,0 +1,8 @@
|
||||
/*
|
||||
/docs/**/*.md
|
||||
!/**/*.ts
|
||||
!/**/*.js
|
||||
!/**/*.map
|
||||
|
||||
/.eslintrc.js
|
||||
/cjs
|
||||
214
.speakeasy/gen.lock
Executable file
214
.speakeasy/gen.lock
Executable file
@@ -0,0 +1,214 @@
|
||||
lockVersion: 2.0.0
|
||||
id: f28179cc-ef59-426d-9e85-60cec22fc642
|
||||
management:
|
||||
docChecksum: a7672fcdce994905df2837c38c661ab7
|
||||
docVersion: 0.0.1
|
||||
speakeasyVersion: 1.250.0
|
||||
generationVersion: 2.304.1
|
||||
releaseVersion: 0.22.2
|
||||
configChecksum: fa330c5c21c9392968bfd8861ad91570
|
||||
repoURL: https://github.com/dubinc/dub-node.git
|
||||
installationURL: https://github.com/dubinc/dub-node
|
||||
published: true
|
||||
features:
|
||||
typescript:
|
||||
acceptHeaders: 2.81.1
|
||||
constsAndDefaults: 0.1.5
|
||||
core: 3.7.1
|
||||
deprecations: 2.81.1
|
||||
flattening: 2.81.1
|
||||
globalSecurity: 2.82.9
|
||||
globalServerURLs: 2.82.4
|
||||
globals: 2.82.1
|
||||
hiddenGlobals: 0.1.0
|
||||
nameOverrides: 2.81.2
|
||||
responseFormat: 0.2.3
|
||||
unions: 2.85.3
|
||||
generatedFiles:
|
||||
- src/sdk/links.ts
|
||||
- src/sdk/qrcodes.ts
|
||||
- src/sdk/analytics.ts
|
||||
- src/sdk/workspaces.ts
|
||||
- src/sdk/tags.ts
|
||||
- src/sdk/metatags.ts
|
||||
- src/sdk/sdk.ts
|
||||
- .eslintrc.js
|
||||
- .npmignore
|
||||
- RUNTIMES.md
|
||||
- package.json
|
||||
- src/lib/base64.ts
|
||||
- src/lib/config.ts
|
||||
- src/lib/encodings.ts
|
||||
- src/lib/http.ts
|
||||
- src/lib/retries.ts
|
||||
- src/lib/schemas.ts
|
||||
- src/lib/sdks.ts
|
||||
- src/lib/security.ts
|
||||
- src/lib/url.ts
|
||||
- src/sdk/index.ts
|
||||
- src/models/errors/sdkerror.ts
|
||||
- src/models/errors/sdkvalidationerror.ts
|
||||
- src/types/blobs.ts
|
||||
- src/types/index.ts
|
||||
- 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
|
||||
- src/models/operations/getlinkinfo.ts
|
||||
- src/models/operations/editlink.ts
|
||||
- src/models/operations/deletelink.ts
|
||||
- src/models/operations/bulkcreatelinks.ts
|
||||
- src/models/operations/getqrcode.ts
|
||||
- src/models/operations/getclicksanalytics.ts
|
||||
- src/models/operations/gettimeseriesanalytics.ts
|
||||
- src/models/operations/getcountryanalytics.ts
|
||||
- src/models/operations/getcityanalytics.ts
|
||||
- src/models/operations/getdeviceanalytics.ts
|
||||
- src/models/operations/getbrowseranalytics.ts
|
||||
- src/models/operations/getosanalytics.ts
|
||||
- src/models/operations/getrefereranalytics.ts
|
||||
- src/models/operations/gettoplinks.ts
|
||||
- src/models/operations/gettopurls.ts
|
||||
- src/models/operations/createworkspace.ts
|
||||
- src/models/operations/getworkspace.ts
|
||||
- src/models/operations/gettags.ts
|
||||
- src/models/operations/createtag.ts
|
||||
- src/models/operations/getmetatags.ts
|
||||
- src/models/errors/index.ts
|
||||
- src/models/components/index.ts
|
||||
- src/models/operations/index.ts
|
||||
- docs/models/components/geo.md
|
||||
- docs/models/components/linkschema.md
|
||||
- docs/models/components/color.md
|
||||
- docs/models/components/tagschema.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/getmetatagsrequest.md
|
||||
- docs/models/operations/getmetatagsresponsebody.md
|
||||
- docs/sdks/dub/README.md
|
||||
- docs/sdks/links/README.md
|
||||
- docs/sdks/qrcodes/README.md
|
||||
- docs/sdks/analytics/README.md
|
||||
- docs/sdks/workspaces/README.md
|
||||
- docs/sdks/tags/README.md
|
||||
- docs/sdks/metatags/README.md
|
||||
- USAGE.md
|
||||
- .gitattributes
|
||||
- src/hooks/hooks.ts
|
||||
- src/hooks/types.ts
|
||||
- src/hooks/index.ts
|
||||
39
.speakeasy/gen.yaml
Executable file
39
.speakeasy/gen.yaml
Executable file
@@ -0,0 +1,39 @@
|
||||
configVersion: 2.0.0
|
||||
generation:
|
||||
sdkClassName: dub
|
||||
maintainOpenAPIOrder: true
|
||||
usageSnippets:
|
||||
optionalPropertyRendering: withExample
|
||||
useClassNamesForArrayFields: true
|
||||
fixes:
|
||||
nameResolutionDec2023: true
|
||||
parameterOrderingFeb2024: true
|
||||
requestResponseComponentNamesFeb2024: true
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: false
|
||||
typescript:
|
||||
version: 0.22.2
|
||||
additionalDependencies:
|
||||
dependencies: {}
|
||||
devDependencies:
|
||||
'@types/node': ^20.12.7
|
||||
vitest: 1.4.0
|
||||
peerDependencies: {}
|
||||
author: Dub
|
||||
clientServerStatusCodesAsErrors: true
|
||||
enumFormat: union
|
||||
flattenGlobalSecurity: true
|
||||
imports:
|
||||
option: openapi
|
||||
paths:
|
||||
callbacks: models/callbacks
|
||||
errors: models/errors
|
||||
operations: models/operations
|
||||
shared: models/components
|
||||
webhooks: models/webhooks
|
||||
inputModelSuffix: input
|
||||
maxMethodParams: 0
|
||||
outputModelSuffix: output
|
||||
packageName: dub
|
||||
responseFormat: flat
|
||||
templateVersion: v2
|
||||
12
.speakeasy/workflow.yaml
Normal file
12
.speakeasy/workflow.yaml
Normal file
@@ -0,0 +1,12 @@
|
||||
workflowVersion: 1.0.0
|
||||
sources:
|
||||
my-first-source:
|
||||
inputs:
|
||||
- location: https://api.dub.co
|
||||
targets:
|
||||
my-first-target:
|
||||
target: typescript
|
||||
source: my-first-source
|
||||
publish:
|
||||
npm:
|
||||
token: $npm_token
|
||||
360
README.md
Normal file
360
README.md
Normal file
@@ -0,0 +1,360 @@
|
||||
# dub
|
||||
|
||||
<div align="left">
|
||||
<a href="https://speakeasyapi.dev/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
|
||||
<a href="https://opensource.org/licenses/MIT">
|
||||
<img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<!-- Start SDK Installation [installation] -->
|
||||
## SDK Installation
|
||||
|
||||
### NPM
|
||||
|
||||
```bash
|
||||
npm add dub
|
||||
```
|
||||
|
||||
### Yarn
|
||||
|
||||
```bash
|
||||
yarn add dub
|
||||
```
|
||||
<!-- End SDK Installation [installation] -->
|
||||
|
||||
<!-- Start Requirements [requirements] -->
|
||||
## Requirements
|
||||
|
||||
For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
|
||||
<!-- End Requirements [requirements] -->
|
||||
|
||||
<!-- Start SDK Example Usage [usage] -->
|
||||
## SDK Example Usage
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import { Dub } from "dub";
|
||||
|
||||
async function run() {
|
||||
const sdk = new Dub({
|
||||
token: "<YOUR_BEARER_TOKEN_HERE>",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
const result = await sdk.links.list({
|
||||
tagIds: ["<value>"],
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
<!-- End SDK Example Usage [usage] -->
|
||||
|
||||
<!-- Start Available Resources and Operations [operations] -->
|
||||
## Available Resources and Operations
|
||||
|
||||
### [links](docs/sdks/links/README.md)
|
||||
|
||||
* [list](docs/sdks/links/README.md#list) - Retrieve a list of links
|
||||
* [create](docs/sdks/links/README.md#create) - Create a new link
|
||||
* [count](docs/sdks/links/README.md#count) - Retrieve the number of links
|
||||
* [get](docs/sdks/links/README.md#get) - Retrieve a link
|
||||
* [update](docs/sdks/links/README.md#update) - Edit a link
|
||||
* [delete](docs/sdks/links/README.md#delete) - Delete a link
|
||||
* [createMany](docs/sdks/links/README.md#createmany) - Bulk create links
|
||||
|
||||
### [qrCodes](docs/sdks/qrcodes/README.md)
|
||||
|
||||
* [get](docs/sdks/qrcodes/README.md#get) - Retrieve a QR code
|
||||
|
||||
### [analytics](docs/sdks/analytics/README.md)
|
||||
|
||||
* [clicks](docs/sdks/analytics/README.md#clicks) - Retrieve clicks analytics
|
||||
* [timeseries](docs/sdks/analytics/README.md#timeseries) - Retrieve timeseries analytics
|
||||
* [countries](docs/sdks/analytics/README.md#countries) - Retrieve country analytics
|
||||
* [cities](docs/sdks/analytics/README.md#cities) - Retrieve city analytics
|
||||
* [devices](docs/sdks/analytics/README.md#devices) - Retrieve device analytics
|
||||
* [browsers](docs/sdks/analytics/README.md#browsers) - Retrieve browser analytics
|
||||
* [os](docs/sdks/analytics/README.md#os) - Retrieve OS analytics
|
||||
* [referers](docs/sdks/analytics/README.md#referers) - Retrieve referer analytics
|
||||
* [topLinks](docs/sdks/analytics/README.md#toplinks) - Retrieve top links
|
||||
* [topUrls](docs/sdks/analytics/README.md#topurls) - Retrieve top URLs
|
||||
|
||||
### [workspaces](docs/sdks/workspaces/README.md)
|
||||
|
||||
* [list](docs/sdks/workspaces/README.md#list) - Retrieve a list of workspaces
|
||||
* [create](docs/sdks/workspaces/README.md#create) - Create a workspace
|
||||
* [get](docs/sdks/workspaces/README.md#get) - Retrieve a workspace
|
||||
|
||||
### [tags](docs/sdks/tags/README.md)
|
||||
|
||||
* [list](docs/sdks/tags/README.md#list) - Retrieve a list of tags
|
||||
* [create](docs/sdks/tags/README.md#create) - Create a new tag
|
||||
|
||||
### [metatags](docs/sdks/metatags/README.md)
|
||||
|
||||
* [get](docs/sdks/metatags/README.md#get) - Retrieve the metatags for a URL
|
||||
<!-- End Available Resources and Operations [operations] -->
|
||||
|
||||
<!-- Start Error Handling [errors] -->
|
||||
## Error Handling
|
||||
|
||||
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 | */* |
|
||||
|
||||
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.
|
||||
|
||||
|
||||
```typescript
|
||||
import { Dub } from "dub";
|
||||
import * as errors from "dub/models/errors";
|
||||
|
||||
async function run() {
|
||||
const sdk = new Dub({
|
||||
token: "<YOUR_BEARER_TOKEN_HERE>",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
let result;
|
||||
try {
|
||||
result = await sdk.links.list({
|
||||
tagIds: ["<value>"],
|
||||
});
|
||||
} catch (err) {
|
||||
switch (true) {
|
||||
case err instanceof errors.SDKValidationError: {
|
||||
// Validation errors can be pretty-printed
|
||||
console.error(err.pretty());
|
||||
// Raw value may also be inspected
|
||||
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;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
<!-- End Error Handling [errors] -->
|
||||
|
||||
<!-- Start Server Selection [server] -->
|
||||
## Server Selection
|
||||
|
||||
### Select Server by Index
|
||||
|
||||
You can override the default server globally by passing a server index to the `serverIdx` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
|
||||
|
||||
| # | Server | Variables |
|
||||
| - | ------ | --------- |
|
||||
| 0 | `https://api.dub.co` | None |
|
||||
|
||||
```typescript
|
||||
import { Dub } from "dub";
|
||||
|
||||
async function run() {
|
||||
const sdk = new Dub({
|
||||
serverIdx: 0,
|
||||
token: "<YOUR_BEARER_TOKEN_HERE>",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
const result = await sdk.links.list({
|
||||
tagIds: ["<value>"],
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
|
||||
|
||||
### Override Server URL Per-Client
|
||||
|
||||
The default server can also be overridden globally by passing a URL to the `serverURL` optional parameter when initializing the SDK client instance. For example:
|
||||
|
||||
```typescript
|
||||
import { Dub } from "dub";
|
||||
|
||||
async function run() {
|
||||
const sdk = new Dub({
|
||||
serverURL: "https://api.dub.co",
|
||||
token: "<YOUR_BEARER_TOKEN_HERE>",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
const result = await sdk.links.list({
|
||||
tagIds: ["<value>"],
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
<!-- End Server Selection [server] -->
|
||||
|
||||
<!-- Start Custom HTTP Client [http-client] -->
|
||||
## Custom HTTP Client
|
||||
|
||||
The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
|
||||
[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This
|
||||
client is a thin wrapper around `fetch` and provides the ability to attach hooks
|
||||
around the request lifecycle that can be used to modify the request or handle
|
||||
errors and response.
|
||||
|
||||
The `HTTPClient` constructor takes an optional `fetcher` argument that can be
|
||||
used to integrate a third-party HTTP client or when writing tests to mock out
|
||||
the HTTP client and feed in fixtures.
|
||||
|
||||
The following example shows how to use the `"beforeRequest"` hook to to add a
|
||||
custom header and a timeout to requests and how to use the `"requestError"` hook
|
||||
to log errors:
|
||||
|
||||
```typescript
|
||||
import { Dub } from "dub";
|
||||
import { HTTPClient } from "dub/lib/http";
|
||||
|
||||
const httpClient = new HTTPClient({
|
||||
// fetcher takes a function that has the same signature as native `fetch`.
|
||||
fetcher: (request) => {
|
||||
return fetch(request);
|
||||
}
|
||||
});
|
||||
|
||||
httpClient.addHook("beforeRequest", (request) => {
|
||||
const nextRequest = new Request(request, {
|
||||
signal: request.signal || AbortSignal.timeout(5000);
|
||||
});
|
||||
|
||||
nextRequest.headers.set("x-custom-header", "custom value");
|
||||
|
||||
return nextRequest;
|
||||
});
|
||||
|
||||
httpClient.addHook("requestError", (error, request) => {
|
||||
console.group("Request Error");
|
||||
console.log("Reason:", `${error}`);
|
||||
console.log("Endpoint:", `${request.method} ${request.url}`);
|
||||
console.groupEnd();
|
||||
});
|
||||
|
||||
const sdk = new Dub({ httpClient });
|
||||
```
|
||||
<!-- End Custom HTTP Client [http-client] -->
|
||||
|
||||
<!-- Start Authentication [security] -->
|
||||
## Authentication
|
||||
|
||||
### Per-Client Security Schemes
|
||||
|
||||
This SDK supports the following security scheme globally:
|
||||
|
||||
| Name | Type | Scheme |
|
||||
| ----------- | ----------- | ----------- |
|
||||
| `token` | http | HTTP Bearer |
|
||||
|
||||
To authenticate with the API the `token` parameter must be set when initializing the SDK client instance. For example:
|
||||
```typescript
|
||||
import { Dub } from "dub";
|
||||
|
||||
async function run() {
|
||||
const sdk = new Dub({
|
||||
token: "<YOUR_BEARER_TOKEN_HERE>",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
const result = await sdk.links.list({
|
||||
tagIds: ["<value>"],
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
<!-- End Authentication [security] -->
|
||||
|
||||
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
||||
|
||||
# Development
|
||||
|
||||
## Maturity
|
||||
|
||||
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
|
||||
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
|
||||
looking for the latest version.
|
||||
|
||||
## Contributions
|
||||
|
||||
While we value open-source contributions to this SDK, this library is generated programmatically.
|
||||
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
|
||||
|
||||
### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
|
||||
79
RELEASES.md
Normal file
79
RELEASES.md
Normal file
@@ -0,0 +1,79 @@
|
||||
|
||||
|
||||
## 2024-04-10 09:37:10
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.245.0 (2.301.3) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.20.0] .
|
||||
|
||||
## 2024-04-10 09:52:35
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.245.0 (2.301.3) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.20.1] .
|
||||
### Releases
|
||||
- [NPM v0.20.1] https://www.npmjs.com/package/dub/v/0.20.1 - .
|
||||
|
||||
## 2024-04-10 11:35:07
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.246.0 (2.302.0) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.20.2] .
|
||||
### Releases
|
||||
- [NPM v0.20.2] https://www.npmjs.com/package/dub/v/0.20.2 - .
|
||||
|
||||
## 2024-04-10 16:28:04
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.246.1 (2.302.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.20.3] .
|
||||
### Releases
|
||||
- [NPM v0.20.3] https://www.npmjs.com/package/dub/v/0.20.3 - .
|
||||
|
||||
## 2024-04-11 09:53:32
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.246.1 (2.302.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.21.0] .
|
||||
### Releases
|
||||
- [NPM v0.21.0] https://www.npmjs.com/package/dub/v/0.21.0 - .
|
||||
|
||||
## 2024-04-11 11:04:25
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.246.1 (2.302.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.22.0] .
|
||||
### Releases
|
||||
- [NPM v0.22.0] https://www.npmjs.com/package/dub/v/0.22.0 - .
|
||||
|
||||
## 2024-04-11 17:45:24
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.250.0 (2.304.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.22.1] .
|
||||
### Releases
|
||||
- [NPM v0.22.1] https://www.npmjs.com/package/dub/v/0.22.1 - .
|
||||
|
||||
## 2024-04-11 19:45:03
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.250.0 (2.304.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.22.2] .
|
||||
### Releases
|
||||
- [NPM v0.22.2] https://www.npmjs.com/package/dub/v/0.22.2 - .
|
||||
22
RUNTIMES.md
Normal file
22
RUNTIMES.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# Supported JavaScript runtimes
|
||||
|
||||
This SDK is intended to be used in JavaScript runtimes that support the following features:
|
||||
|
||||
* [Web Fetch API][web-fetch]
|
||||
* [Web Streams API](web-streams) and in particular `ReadableStream`
|
||||
* [Async iterables][async-iter] using `Symbol.asyncIterator`
|
||||
|
||||
[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
|
||||
[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
|
||||
[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
|
||||
|
||||
Runtime environments that are explicitly supported are:
|
||||
|
||||
- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
|
||||
- Node.js active and maintenance LTS releases
|
||||
- Currently, this is v18 and v20
|
||||
- Bun v1 and above
|
||||
- Deno v1.39
|
||||
- Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
|
||||
|
||||
[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
|
||||
22
USAGE.md
Normal file
22
USAGE.md
Normal file
@@ -0,0 +1,22 @@
|
||||
<!-- Start SDK Example Usage [usage] -->
|
||||
```typescript
|
||||
import { Dub } from "dub";
|
||||
|
||||
async function run() {
|
||||
const sdk = new Dub({
|
||||
token: "<YOUR_BEARER_TOKEN_HERE>",
|
||||
workspaceId: "<value>",
|
||||
});
|
||||
|
||||
const result = await sdk.links.list({
|
||||
tagIds: ["<value>"],
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
<!-- End SDK Example Usage [usage] -->
|
||||
16
docs/models/components/color.md
Normal file
16
docs/models/components/color.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# Color
|
||||
|
||||
The color of the tag.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| -------- | -------- |
|
||||
| `Red` | red |
|
||||
| `Yellow` | yellow |
|
||||
| `Green` | green |
|
||||
| `Blue` | blue |
|
||||
| `Purple` | purple |
|
||||
| `Pink` | pink |
|
||||
| `Brown` | brown |
|
||||
9
docs/models/components/domains.md
Normal file
9
docs/models/components/domains.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# Domains
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
||||
| `slug` | *string* | :heavy_check_mark: | The domain of the workspace. |
|
||||
| `primary` | *boolean* | :heavy_check_mark: | Indicates if the domain is the primary domain. |
|
||||
259
docs/models/components/geo.md
Normal file
259
docs/models/components/geo.md
Normal file
@@ -0,0 +1,259 @@
|
||||
# Geo
|
||||
|
||||
Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. Learn more: https://d.to/geo
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `af` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `al` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `dz` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `as` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ad` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ao` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ai` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `aq` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ag` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ar` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `am` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `aw` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `au` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `at` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `az` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `bs` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `bh` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `bd` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `bb` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `by` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `be` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `bz` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `bj` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `bm` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `bt` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `bo` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ba` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `bw` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `bv` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `br` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `io` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `bn` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `bg` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `bf` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `bi` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `kh` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `cm` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ca` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `cv` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ky` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `cf` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `td` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `cl` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `cn` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `cx` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `cc` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `co` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `km` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `cg` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `cd` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ck` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `cr` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ci` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `hr` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `cu` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `cy` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `cz` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `dk` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `dj` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `dm` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `do` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ec` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `eg` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `sv` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `gq` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `er` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ee` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `et` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `fk` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `fo` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `fj` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `fi` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `fr` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `gf` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `pf` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `tf` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ga` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `gm` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ge` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `de` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `gh` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `gi` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `gr` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `gl` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `gd` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `gp` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `gu` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `gt` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `gn` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `gw` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `gy` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ht` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `hm` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `va` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `hn` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `hk` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `hu` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `is` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `in` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `id` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ir` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `iq` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ie` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `il` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `it` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `jm` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `jp` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `jo` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `kz` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ke` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ki` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `kp` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `kr` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `kw` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `kg` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `la` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `lv` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `lb` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ls` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `lr` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ly` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `li` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `lt` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `lu` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `mo` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `mg` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `mw` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `my` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `mv` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ml` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `mt` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `mh` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `mq` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `mr` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `mu` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `yt` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `mx` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `fm` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `md` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `mc` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `mn` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ms` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ma` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `mz` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `mm` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `na` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `nr` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `np` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `nl` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `nc` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `nz` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ni` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ne` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ng` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `nu` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `nf` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `mk` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `mp` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `no` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `om` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `pk` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `pw` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ps` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `pa` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `pg` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `py` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `pe` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ph` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `pn` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `pl` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `pt` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `pr` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `qa` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `re` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ro` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ru` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `rw` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `sh` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `kn` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `lc` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `pm` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `vc` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ws` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `sm` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `st` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `sa` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `sn` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `sc` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `sl` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `sg` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `sk` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `si` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `sb` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `so` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `za` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `gs` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `es` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `lk` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `sd` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `sr` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `sj` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `sz` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `se` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ch` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `sy` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `tw` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `tj` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `tz` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `th` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `tl` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `tg` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `tk` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `to` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `tt` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `tn` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `tr` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `tm` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `tc` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `tv` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ug` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ua` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ae` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `gb` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `us` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `um` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `uy` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `uz` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `vu` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ve` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `vn` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `vg` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `vi` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `wf` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `eh` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ye` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `zm` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `zw` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ax` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `bq` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `cw` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `gg` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `im` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `je` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `me` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `bl` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `mf` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `rs` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `sx` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `ss` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `xk` | *string* | :heavy_minus_sign: | N/A |
|
||||
41
docs/models/components/linkschema.md
Normal file
41
docs/models/components/linkschema.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# LinkSchema
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *string* | :heavy_check_mark: | The unique ID of the short link. |
|
||||
| `domain` | *string* | :heavy_check_mark: | The domain of the short link. If not provided, the primary domain for the workspace will be used (or `dub.sh` if the workspace has no domains). |
|
||||
| `key` | *string* | :heavy_check_mark: | The short link slug. If not provided, a random 7-character slug will be generated. |
|
||||
| `url` | *string* | :heavy_check_mark: | The destination URL of the short link. |
|
||||
| `archived` | *boolean* | :heavy_minus_sign: | Whether the short link is archived. |
|
||||
| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | The date and time when the short link will expire in ISO-8601 format. |
|
||||
| `expiredUrl` | *string* | :heavy_check_mark: | The URL to redirect to when the short link has expired. |
|
||||
| `password` | *string* | :heavy_check_mark: | The password required to access the destination URL of the short link. |
|
||||
| `proxy` | *boolean* | :heavy_minus_sign: | Whether the short link uses Custom Social Media Cards feature. |
|
||||
| `title` | *string* | :heavy_check_mark: | The title of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true. |
|
||||
| `description` | *string* | :heavy_check_mark: | The description of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true. |
|
||||
| `image` | *string* | :heavy_check_mark: | The image of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true. |
|
||||
| `rewrite` | *boolean* | :heavy_minus_sign: | Whether the short link uses link cloaking. |
|
||||
| `ios` | *string* | :heavy_check_mark: | The iOS destination URL for the short link for iOS device targeting. |
|
||||
| `android` | *string* | :heavy_check_mark: | The Android destination URL for the short link for Android device targeting. |
|
||||
| `geo` | [components.Geo](../../models/components/geo.md) | :heavy_check_mark: | Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. Learn more: https://d.to/geo |
|
||||
| `publicStats` | *boolean* | :heavy_minus_sign: | Whether the short link's stats are publicly accessible. |
|
||||
| ~~`tagId`~~ | *string* | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>The unique ID of the tag assigned to the short link. This field is deprecated – use `tags` instead. |
|
||||
| `tags` | [components.TagSchema](../../models/components/tagschema.md)[] | :heavy_check_mark: | The tags assigned to the short link. |
|
||||
| `comments` | *string* | :heavy_check_mark: | The comments for the short link. |
|
||||
| `shortLink` | *string* | :heavy_check_mark: | The full URL of the short link, including the https protocol (e.g. `https://dub.sh/try`). |
|
||||
| `qrCode` | *string* | :heavy_check_mark: | The full URL of the QR code for the short link (e.g. `https://api.dub.co/qr?url=https://dub.sh/try`). |
|
||||
| `utmSource` | *string* | :heavy_check_mark: | The UTM source of the short link. |
|
||||
| `utmMedium` | *string* | :heavy_check_mark: | The UTM medium of the short link. |
|
||||
| `utmCampaign` | *string* | :heavy_check_mark: | The UTM campaign of the short link. |
|
||||
| `utmTerm` | *string* | :heavy_check_mark: | The UTM term of the short link. |
|
||||
| `utmContent` | *string* | :heavy_check_mark: | The UTM content of the short link. |
|
||||
| `userId` | *string* | :heavy_check_mark: | The user ID of the creator of the short link. |
|
||||
| `workspaceId` | *string* | :heavy_check_mark: | The workspace ID of the short link. |
|
||||
| `clicks` | *number* | :heavy_minus_sign: | The number of clicks on the short link. |
|
||||
| `lastClicked` | *string* | :heavy_check_mark: | The date and time when the short link was last clicked. |
|
||||
| `createdAt` | *string* | :heavy_check_mark: | The date and time when the short link was created. |
|
||||
| `updatedAt` | *string* | :heavy_check_mark: | The date and time when the short link was last updated. |
|
||||
| ~~`projectId`~~ | *string* | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>The project ID of the short link. This field is deprecated – use `workspaceId` instead. |
|
||||
16
docs/models/components/plan.md
Normal file
16
docs/models/components/plan.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# Plan
|
||||
|
||||
The plan of the workspace.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------------- | --------------- |
|
||||
| `Free` | free |
|
||||
| `Pro` | pro |
|
||||
| `Business` | business |
|
||||
| `BusinessPlus` | business plus |
|
||||
| `BusinessExtra` | business extra |
|
||||
| `BusinessMax` | business max |
|
||||
| `Enterprise` | enterprise |
|
||||
11
docs/models/components/role.md
Normal file
11
docs/models/components/role.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Role
|
||||
|
||||
The role of the authenticated user in the workspace.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| -------- | -------- |
|
||||
| `Owner` | owner |
|
||||
| `Member` | member |
|
||||
8
docs/models/components/security.md
Normal file
8
docs/models/components/security.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Security
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `token` | *string* | :heavy_minus_sign: | N/A |
|
||||
10
docs/models/components/tagschema.md
Normal file
10
docs/models/components/tagschema.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# TagSchema
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
|
||||
| `id` | *string* | :heavy_check_mark: | The unique ID of the tag. |
|
||||
| `name` | *string* | :heavy_check_mark: | The name of the tag. |
|
||||
| `color` | [components.Color](../../models/components/color.md) | :heavy_check_mark: | The color of the tag. |
|
||||
8
docs/models/components/users.md
Normal file
8
docs/models/components/users.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Users
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
|
||||
| `role` | [components.Role](../../models/components/role.md) | :heavy_check_mark: | The role of the authenticated user in the workspace. |
|
||||
24
docs/models/components/workspaceschema.md
Normal file
24
docs/models/components/workspaceschema.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# WorkspaceSchema
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||
| `id` | *string* | :heavy_check_mark: | The unique ID of the workspace. |
|
||||
| `name` | *string* | :heavy_check_mark: | The name of the workspace. |
|
||||
| `slug` | *string* | :heavy_check_mark: | The slug of the workspace. |
|
||||
| `logo` | *string* | :heavy_minus_sign: | The logo of the workspace. |
|
||||
| `usage` | *number* | :heavy_check_mark: | The usage of the workspace. |
|
||||
| `usageLimit` | *number* | :heavy_check_mark: | The usage limit of the workspace. |
|
||||
| `linksUsage` | *number* | :heavy_check_mark: | The links usage of the workspace. |
|
||||
| `linksLimit` | *number* | :heavy_check_mark: | The links limit of the workspace. |
|
||||
| `domainsLimit` | *number* | :heavy_check_mark: | The domains limit of the workspace. |
|
||||
| `tagsLimit` | *number* | :heavy_check_mark: | The tags limit of the workspace. |
|
||||
| `usersLimit` | *number* | :heavy_check_mark: | The users limit of the workspace. |
|
||||
| `plan` | [components.Plan](../../models/components/plan.md) | :heavy_check_mark: | The plan of the workspace. |
|
||||
| `stripeId` | *string* | :heavy_check_mark: | The Stripe ID of the workspace. |
|
||||
| `billingCycleStart` | *number* | :heavy_check_mark: | The date and time when the billing cycle starts for the workspace. |
|
||||
| `createdAt` | *string* | :heavy_check_mark: | The date and time when the workspace was created. |
|
||||
| `users` | [components.Users](../../models/components/users.md)[] | :heavy_check_mark: | The role of the authenticated user in the workspace. |
|
||||
| `domains` | [components.Domains](../../models/components/domains.md)[] | :heavy_check_mark: | The domains of the workspace. |
|
||||
10
docs/models/errors/badrequest.md
Normal file
10
docs/models/errors/badrequest.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# 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 |
|
||||
10
docs/models/errors/code.md
Normal file
10
docs/models/errors/code.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# Code
|
||||
|
||||
A short code indicating the error code returned.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `BadRequest` | bad_request |
|
||||
10
docs/models/errors/conflict.md
Normal file
10
docs/models/errors/conflict.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# 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 |
|
||||
10
docs/models/errors/conflictcode.md
Normal file
10
docs/models/errors/conflictcode.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# ConflictCode
|
||||
|
||||
A short code indicating the error code returned.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------- | ---------- |
|
||||
| `Conflict` | conflict |
|
||||
10
docs/models/errors/conflicterror.md
Normal file
10
docs/models/errors/conflicterror.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# ConflictError
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
|
||||
| `code` | [errors.ConflictCode](../../models/errors/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 |
|
||||
10
docs/models/errors/errort.md
Normal file
10
docs/models/errors/errort.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# ErrorT
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
| `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 |
|
||||
10
docs/models/errors/forbidden.md
Normal file
10
docs/models/errors/forbidden.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# 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 |
|
||||
10
docs/models/errors/forbiddencode.md
Normal file
10
docs/models/errors/forbiddencode.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# ForbiddenCode
|
||||
|
||||
A short code indicating the error code returned.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------- | ----------- |
|
||||
| `Forbidden` | forbidden |
|
||||
10
docs/models/errors/forbiddenerror.md
Normal file
10
docs/models/errors/forbiddenerror.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# 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 |
|
||||
10
docs/models/errors/internalservererror.md
Normal file
10
docs/models/errors/internalservererror.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# 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 |
|
||||
10
docs/models/errors/internalservererrorcode.md
Normal file
10
docs/models/errors/internalservererrorcode.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# InternalServerErrorCode
|
||||
|
||||
A short code indicating the error code returned.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------------------- | --------------------- |
|
||||
| `InternalServerError` | internal_server_error |
|
||||
10
docs/models/errors/internalservererrorerror.md
Normal file
10
docs/models/errors/internalservererrorerror.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# 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 |
|
||||
10
docs/models/errors/inviteexpired.md
Normal file
10
docs/models/errors/inviteexpired.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# InviteExpired
|
||||
|
||||
This response is sent when the requested content has been permanently deleted from server, with no forwarding address.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||
| `error` | [errors.InviteExpiredError](../../models/errors/inviteexpirederror.md) | :heavy_check_mark: | N/A |
|
||||
10
docs/models/errors/inviteexpiredcode.md
Normal file
10
docs/models/errors/inviteexpiredcode.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# InviteExpiredCode
|
||||
|
||||
A short code indicating the error code returned.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------------- | --------------- |
|
||||
| `InviteExpired` | invite_expired |
|
||||
10
docs/models/errors/inviteexpirederror.md
Normal file
10
docs/models/errors/inviteexpirederror.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# InviteExpiredError
|
||||
|
||||
|
||||
## 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 |
|
||||
| `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 |
|
||||
10
docs/models/errors/notfound.md
Normal file
10
docs/models/errors/notfound.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# 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 |
|
||||
10
docs/models/errors/notfoundcode.md
Normal file
10
docs/models/errors/notfoundcode.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# NotFoundCode
|
||||
|
||||
A short code indicating the error code returned.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------- | ---------- |
|
||||
| `NotFound` | not_found |
|
||||
10
docs/models/errors/notfounderror.md
Normal file
10
docs/models/errors/notfounderror.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# NotFoundError
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
| `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 |
|
||||
10
docs/models/errors/ratelimitexceeded.md
Normal file
10
docs/models/errors/ratelimitexceeded.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# RateLimitExceeded
|
||||
|
||||
The user has sent too many requests in a given amount of time ("rate limiting")
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
|
||||
| `error` | [errors.RateLimitExceededError](../../models/errors/ratelimitexceedederror.md) | :heavy_check_mark: | N/A |
|
||||
10
docs/models/errors/ratelimitexceededcode.md
Normal file
10
docs/models/errors/ratelimitexceededcode.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# RateLimitExceededCode
|
||||
|
||||
A short code indicating the error code returned.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------------- | ------------------- |
|
||||
| `RateLimitExceeded` | rate_limit_exceeded |
|
||||
10
docs/models/errors/ratelimitexceedederror.md
Normal file
10
docs/models/errors/ratelimitexceedederror.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# RateLimitExceededError
|
||||
|
||||
|
||||
## 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 |
|
||||
| `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 |
|
||||
10
docs/models/errors/unauthorized.md
Normal file
10
docs/models/errors/unauthorized.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# Unauthorized
|
||||
|
||||
Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| `error` | [errors.UnauthorizedError](../../models/errors/unauthorizederror.md) | :heavy_check_mark: | N/A |
|
||||
10
docs/models/errors/unauthorizedcode.md
Normal file
10
docs/models/errors/unauthorizedcode.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# UnauthorizedCode
|
||||
|
||||
A short code indicating the error code returned.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| -------------- | -------------- |
|
||||
| `Unauthorized` | unauthorized |
|
||||
10
docs/models/errors/unauthorizederror.md
Normal file
10
docs/models/errors/unauthorizederror.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# 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 |
|
||||
10
docs/models/errors/unprocessableentity.md
Normal file
10
docs/models/errors/unprocessableentity.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# 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 |
|
||||
10
docs/models/errors/unprocessableentitycode.md
Normal file
10
docs/models/errors/unprocessableentitycode.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# UnprocessableEntityCode
|
||||
|
||||
A short code indicating the error code returned.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------------------- | --------------------- |
|
||||
| `UnprocessableEntity` | unprocessable_entity |
|
||||
10
docs/models/errors/unprocessableentityerror.md
Normal file
10
docs/models/errors/unprocessableentityerror.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# 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 |
|
||||
259
docs/models/operations/bulkcreatelinksgeo.md
Normal file
259
docs/models/operations/bulkcreatelinksgeo.md
Normal file
@@ -0,0 +1,259 @@
|
||||
# BulkCreateLinksGeo
|
||||
|
||||
Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
||||
| `af` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `al` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `dz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `as` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ad` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ao` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ai` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `aq` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ag` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ar` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `am` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `aw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `au` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `at` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `az` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bs` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bh` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bd` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bb` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `by` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `be` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bj` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bt` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bo` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ba` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bv` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `br` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `io` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bf` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bi` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `kh` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ca` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cv` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ky` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cf` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `td` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cl` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cx` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cc` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `co` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `km` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cd` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ck` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ci` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `hr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cu` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cy` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `dk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `dj` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `dm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `do` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ec` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `eg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sv` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gq` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `er` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ee` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `et` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `fk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `fo` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `fj` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `fi` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `fr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gf` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pf` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tf` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ga` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ge` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `de` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gh` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gi` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gl` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gd` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gp` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gu` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gt` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gy` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ht` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `hm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `va` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `hn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `hk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `hu` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `is` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `in` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `id` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ir` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `iq` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ie` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `il` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `it` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `jm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `jp` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `jo` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `kz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ke` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ki` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `kp` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `kr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `kw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `kg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `la` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `lv` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `lb` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ls` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `lr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ly` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `li` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `lt` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `lu` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mo` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `my` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mv` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ml` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mt` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mh` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mq` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mu` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `yt` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mx` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `fm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `md` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mc` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ms` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ma` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `na` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `nr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `np` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `nl` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `nc` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `nz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ni` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ne` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ng` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `nu` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `nf` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mp` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `no` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `om` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ps` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pa` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `py` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pe` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ph` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pl` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pt` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `qa` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `re` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ro` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ru` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `rw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sh` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `kn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `lc` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `vc` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ws` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `st` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sa` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sc` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sl` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `si` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sb` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `so` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `za` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gs` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `es` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `lk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sd` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sj` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `se` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ch` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sy` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tj` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `th` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tl` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `to` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tt` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tc` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tv` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ug` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ua` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ae` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gb` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `us` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `um` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `uy` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `uz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `vu` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ve` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `vn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `vg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `vi` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `wf` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `eh` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ye` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `zm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `zw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ax` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bq` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `im` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `je` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `me` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bl` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mf` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `rs` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sx` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ss` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `xk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
4
docs/models/operations/bulkcreatelinkstagids.md
Normal file
4
docs/models/operations/bulkcreatelinkstagids.md
Normal file
@@ -0,0 +1,4 @@
|
||||
# BulkCreateLinksTagIds
|
||||
|
||||
The unique IDs of the tags assigned to the short link.
|
||||
|
||||
16
docs/models/operations/color.md
Normal file
16
docs/models/operations/color.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# Color
|
||||
|
||||
The color of the tag. If not provided, a random color will be used from the list: red, yellow, green, blue, purple, pink, brown.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| -------- | -------- |
|
||||
| `Red` | red |
|
||||
| `Yellow` | yellow |
|
||||
| `Green` | green |
|
||||
| `Blue` | blue |
|
||||
| `Purple` | purple |
|
||||
| `Pink` | pink |
|
||||
| `Brown` | brown |
|
||||
259
docs/models/operations/country.md
Normal file
259
docs/models/operations/country.md
Normal file
@@ -0,0 +1,259 @@
|
||||
# Country
|
||||
|
||||
The country to retrieve analytics for.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----- | ----- |
|
||||
| `Af` | AF |
|
||||
| `Al` | AL |
|
||||
| `Dz` | DZ |
|
||||
| `As` | AS |
|
||||
| `Ad` | AD |
|
||||
| `Ao` | AO |
|
||||
| `Ai` | AI |
|
||||
| `Aq` | AQ |
|
||||
| `Ag` | AG |
|
||||
| `Ar` | AR |
|
||||
| `Am` | AM |
|
||||
| `Aw` | AW |
|
||||
| `Au` | AU |
|
||||
| `At` | AT |
|
||||
| `Az` | AZ |
|
||||
| `Bs` | BS |
|
||||
| `Bh` | BH |
|
||||
| `Bd` | BD |
|
||||
| `Bb` | BB |
|
||||
| `By` | BY |
|
||||
| `Be` | BE |
|
||||
| `Bz` | BZ |
|
||||
| `Bj` | BJ |
|
||||
| `Bm` | BM |
|
||||
| `Bt` | BT |
|
||||
| `Bo` | BO |
|
||||
| `Ba` | BA |
|
||||
| `Bw` | BW |
|
||||
| `Bv` | BV |
|
||||
| `Br` | BR |
|
||||
| `Io` | IO |
|
||||
| `Bn` | BN |
|
||||
| `Bg` | BG |
|
||||
| `Bf` | BF |
|
||||
| `Bi` | BI |
|
||||
| `Kh` | KH |
|
||||
| `Cm` | CM |
|
||||
| `Ca` | CA |
|
||||
| `Cv` | CV |
|
||||
| `Ky` | KY |
|
||||
| `Cf` | CF |
|
||||
| `Td` | TD |
|
||||
| `Cl` | CL |
|
||||
| `Cn` | CN |
|
||||
| `Cx` | CX |
|
||||
| `Cc` | CC |
|
||||
| `Co` | CO |
|
||||
| `Km` | KM |
|
||||
| `Cg` | CG |
|
||||
| `Cd` | CD |
|
||||
| `Ck` | CK |
|
||||
| `Cr` | CR |
|
||||
| `Ci` | CI |
|
||||
| `Hr` | HR |
|
||||
| `Cu` | CU |
|
||||
| `Cy` | CY |
|
||||
| `Cz` | CZ |
|
||||
| `Dk` | DK |
|
||||
| `Dj` | DJ |
|
||||
| `Dm` | DM |
|
||||
| `Do` | DO |
|
||||
| `Ec` | EC |
|
||||
| `Eg` | EG |
|
||||
| `Sv` | SV |
|
||||
| `Gq` | GQ |
|
||||
| `Er` | ER |
|
||||
| `Ee` | EE |
|
||||
| `Et` | ET |
|
||||
| `Fk` | FK |
|
||||
| `Fo` | FO |
|
||||
| `Fj` | FJ |
|
||||
| `Fi` | FI |
|
||||
| `Fr` | FR |
|
||||
| `Gf` | GF |
|
||||
| `Pf` | PF |
|
||||
| `Tf` | TF |
|
||||
| `Ga` | GA |
|
||||
| `Gm` | GM |
|
||||
| `Ge` | GE |
|
||||
| `De` | DE |
|
||||
| `Gh` | GH |
|
||||
| `Gi` | GI |
|
||||
| `Gr` | GR |
|
||||
| `Gl` | GL |
|
||||
| `Gd` | GD |
|
||||
| `Gp` | GP |
|
||||
| `Gu` | GU |
|
||||
| `Gt` | GT |
|
||||
| `Gn` | GN |
|
||||
| `Gw` | GW |
|
||||
| `Gy` | GY |
|
||||
| `Ht` | HT |
|
||||
| `Hm` | HM |
|
||||
| `Va` | VA |
|
||||
| `Hn` | HN |
|
||||
| `Hk` | HK |
|
||||
| `Hu` | HU |
|
||||
| `Is` | IS |
|
||||
| `In` | IN |
|
||||
| `Id` | ID |
|
||||
| `Ir` | IR |
|
||||
| `Iq` | IQ |
|
||||
| `Ie` | IE |
|
||||
| `Il` | IL |
|
||||
| `It` | IT |
|
||||
| `Jm` | JM |
|
||||
| `Jp` | JP |
|
||||
| `Jo` | JO |
|
||||
| `Kz` | KZ |
|
||||
| `Ke` | KE |
|
||||
| `Ki` | KI |
|
||||
| `Kp` | KP |
|
||||
| `Kr` | KR |
|
||||
| `Kw` | KW |
|
||||
| `Kg` | KG |
|
||||
| `La` | LA |
|
||||
| `Lv` | LV |
|
||||
| `Lb` | LB |
|
||||
| `Ls` | LS |
|
||||
| `Lr` | LR |
|
||||
| `Ly` | LY |
|
||||
| `Li` | LI |
|
||||
| `Lt` | LT |
|
||||
| `Lu` | LU |
|
||||
| `Mo` | MO |
|
||||
| `Mg` | MG |
|
||||
| `Mw` | MW |
|
||||
| `My` | MY |
|
||||
| `Mv` | MV |
|
||||
| `Ml` | ML |
|
||||
| `Mt` | MT |
|
||||
| `Mh` | MH |
|
||||
| `Mq` | MQ |
|
||||
| `Mr` | MR |
|
||||
| `Mu` | MU |
|
||||
| `Yt` | YT |
|
||||
| `Mx` | MX |
|
||||
| `Fm` | FM |
|
||||
| `Md` | MD |
|
||||
| `Mc` | MC |
|
||||
| `Mn` | MN |
|
||||
| `Ms` | MS |
|
||||
| `Ma` | MA |
|
||||
| `Mz` | MZ |
|
||||
| `Mm` | MM |
|
||||
| `Na` | NA |
|
||||
| `Nr` | NR |
|
||||
| `Np` | NP |
|
||||
| `Nl` | NL |
|
||||
| `Nc` | NC |
|
||||
| `Nz` | NZ |
|
||||
| `Ni` | NI |
|
||||
| `Ne` | NE |
|
||||
| `Ng` | NG |
|
||||
| `Nu` | NU |
|
||||
| `Nf` | NF |
|
||||
| `Mk` | MK |
|
||||
| `Mp` | MP |
|
||||
| `No` | NO |
|
||||
| `Om` | OM |
|
||||
| `Pk` | PK |
|
||||
| `Pw` | PW |
|
||||
| `Ps` | PS |
|
||||
| `Pa` | PA |
|
||||
| `Pg` | PG |
|
||||
| `Py` | PY |
|
||||
| `Pe` | PE |
|
||||
| `Ph` | PH |
|
||||
| `Pn` | PN |
|
||||
| `Pl` | PL |
|
||||
| `Pt` | PT |
|
||||
| `Pr` | PR |
|
||||
| `Qa` | QA |
|
||||
| `Re` | RE |
|
||||
| `Ro` | RO |
|
||||
| `Ru` | RU |
|
||||
| `Rw` | RW |
|
||||
| `Sh` | SH |
|
||||
| `Kn` | KN |
|
||||
| `Lc` | LC |
|
||||
| `Pm` | PM |
|
||||
| `Vc` | VC |
|
||||
| `Ws` | WS |
|
||||
| `Sm` | SM |
|
||||
| `St` | ST |
|
||||
| `Sa` | SA |
|
||||
| `Sn` | SN |
|
||||
| `Sc` | SC |
|
||||
| `Sl` | SL |
|
||||
| `Sg` | SG |
|
||||
| `Sk` | SK |
|
||||
| `Si` | SI |
|
||||
| `Sb` | SB |
|
||||
| `So` | SO |
|
||||
| `Za` | ZA |
|
||||
| `Gs` | GS |
|
||||
| `Es` | ES |
|
||||
| `Lk` | LK |
|
||||
| `Sd` | SD |
|
||||
| `Sr` | SR |
|
||||
| `Sj` | SJ |
|
||||
| `Sz` | SZ |
|
||||
| `Se` | SE |
|
||||
| `Ch` | CH |
|
||||
| `Sy` | SY |
|
||||
| `Tw` | TW |
|
||||
| `Tj` | TJ |
|
||||
| `Tz` | TZ |
|
||||
| `Th` | TH |
|
||||
| `Tl` | TL |
|
||||
| `Tg` | TG |
|
||||
| `Tk` | TK |
|
||||
| `To` | TO |
|
||||
| `Tt` | TT |
|
||||
| `Tn` | TN |
|
||||
| `Tr` | TR |
|
||||
| `Tm` | TM |
|
||||
| `Tc` | TC |
|
||||
| `Tv` | TV |
|
||||
| `Ug` | UG |
|
||||
| `Ua` | UA |
|
||||
| `Ae` | AE |
|
||||
| `Gb` | GB |
|
||||
| `Us` | US |
|
||||
| `Um` | UM |
|
||||
| `Uy` | UY |
|
||||
| `Uz` | UZ |
|
||||
| `Vu` | VU |
|
||||
| `Ve` | VE |
|
||||
| `Vn` | VN |
|
||||
| `Vg` | VG |
|
||||
| `Vi` | VI |
|
||||
| `Wf` | WF |
|
||||
| `Eh` | EH |
|
||||
| `Ye` | YE |
|
||||
| `Zm` | ZM |
|
||||
| `Zw` | ZW |
|
||||
| `Ax` | AX |
|
||||
| `Bq` | BQ |
|
||||
| `Cw` | CW |
|
||||
| `Gg` | GG |
|
||||
| `Im` | IM |
|
||||
| `Je` | JE |
|
||||
| `Me` | ME |
|
||||
| `Bl` | BL |
|
||||
| `Mf` | MF |
|
||||
| `Rs` | RS |
|
||||
| `Sx` | SX |
|
||||
| `Ss` | SS |
|
||||
| `Xk` | XK |
|
||||
27
docs/models/operations/createlinkrequestbody.md
Normal file
27
docs/models/operations/createlinkrequestbody.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# CreateLinkRequestBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. If not provided, the primary domain for the workspace will be used (or `dub.sh` if the workspace has no domains). |
|
||||
| `key` | *string* | :heavy_minus_sign: | The short link slug. If not provided, a random 7-character slug will be generated. |
|
||||
| `prefix` | *string* | :heavy_minus_sign: | The prefix of the short link slug for randomly-generated keys (e.g. if prefix is `/c/`, generated keys will be in the `/c/:key` format). Will be ignored if `key` is provided. |
|
||||
| `url` | *string* | :heavy_check_mark: | The destination URL of the short link. |
|
||||
| `archived` | *boolean* | :heavy_minus_sign: | Whether the short link is archived. |
|
||||
| `publicStats` | *boolean* | :heavy_minus_sign: | Whether the short link's stats are publicly accessible. |
|
||||
| ~~`tagId`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead. |
|
||||
| `tagIds` | *operations.TagIds* | :heavy_minus_sign: | The unique IDs of the tags assigned to the short link. |
|
||||
| `comments` | *string* | :heavy_minus_sign: | The comments for the short link. |
|
||||
| `expiresAt` | *string* | :heavy_minus_sign: | The date and time when the short link will expire at. |
|
||||
| `expiredUrl` | *string* | :heavy_minus_sign: | The URL to redirect to when the short link has expired. |
|
||||
| `password` | *string* | :heavy_minus_sign: | The password required to access the destination URL of the short link. |
|
||||
| `proxy` | *boolean* | :heavy_minus_sign: | Whether the short link uses Custom Social Media Cards feature. |
|
||||
| `title` | *string* | :heavy_minus_sign: | The title of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true. |
|
||||
| `description` | *string* | :heavy_minus_sign: | The description of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true. |
|
||||
| `image` | *string* | :heavy_minus_sign: | The image of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true. |
|
||||
| `rewrite` | *boolean* | :heavy_minus_sign: | Whether the short link uses link cloaking. |
|
||||
| `ios` | *string* | :heavy_minus_sign: | The iOS destination URL for the short link for iOS device targeting. |
|
||||
| `android` | *string* | :heavy_minus_sign: | The Android destination URL for the short link for Android device targeting. |
|
||||
| `geo` | [operations.Geo](../../models/operations/geo.md) | :heavy_minus_sign: | Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. |
|
||||
9
docs/models/operations/createtagrequestbody.md
Normal file
9
docs/models/operations/createtagrequestbody.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# CreateTagRequestBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `tag` | *string* | :heavy_check_mark: | The name of the tag to create. |
|
||||
| `color` | [operations.Color](../../models/operations/color.md) | :heavy_minus_sign: | The color of the tag. If not provided, a random color will be used from the list: red, yellow, green, blue, purple, pink, brown. |
|
||||
10
docs/models/operations/createworkspacerequestbody.md
Normal file
10
docs/models/operations/createworkspacerequestbody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# CreateWorkspaceRequestBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `name` | *string* | :heavy_check_mark: | N/A |
|
||||
| `slug` | *string* | :heavy_check_mark: | N/A |
|
||||
| `domain` | *string* | :heavy_minus_sign: | N/A |
|
||||
8
docs/models/operations/deletelinkrequest.md
Normal file
8
docs/models/operations/deletelinkrequest.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# DeleteLinkRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
|
||||
| `linkId` | *string* | :heavy_check_mark: | The id of the link to delete. You can get this via the `getLinkInfo` endpoint. |
|
||||
10
docs/models/operations/deletelinkresponsebody.md
Normal file
10
docs/models/operations/deletelinkresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# DeleteLinkResponseBody
|
||||
|
||||
The deleted link
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------- | ------------------- | ------------------- | ------------------- |
|
||||
| `id` | *string* | :heavy_check_mark: | The ID of the link. |
|
||||
259
docs/models/operations/editlinkgeo.md
Normal file
259
docs/models/operations/editlinkgeo.md
Normal file
@@ -0,0 +1,259 @@
|
||||
# EditLinkGeo
|
||||
|
||||
Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
||||
| `af` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `al` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `dz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `as` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ad` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ao` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ai` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `aq` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ag` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ar` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `am` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `aw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `au` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `at` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `az` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bs` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bh` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bd` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bb` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `by` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `be` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bj` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bt` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bo` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ba` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bv` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `br` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `io` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bf` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bi` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `kh` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ca` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cv` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ky` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cf` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `td` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cl` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cx` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cc` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `co` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `km` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cd` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ck` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ci` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `hr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cu` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cy` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `dk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `dj` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `dm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `do` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ec` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `eg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sv` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gq` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `er` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ee` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `et` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `fk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `fo` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `fj` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `fi` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `fr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gf` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pf` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tf` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ga` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ge` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `de` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gh` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gi` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gl` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gd` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gp` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gu` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gt` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gy` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ht` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `hm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `va` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `hn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `hk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `hu` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `is` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `in` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `id` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ir` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `iq` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ie` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `il` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `it` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `jm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `jp` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `jo` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `kz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ke` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ki` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `kp` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `kr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `kw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `kg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `la` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `lv` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `lb` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ls` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `lr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ly` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `li` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `lt` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `lu` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mo` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `my` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mv` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ml` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mt` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mh` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mq` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mu` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `yt` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mx` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `fm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `md` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mc` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ms` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ma` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `na` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `nr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `np` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `nl` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `nc` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `nz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ni` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ne` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ng` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `nu` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `nf` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mp` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `no` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `om` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ps` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pa` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `py` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pe` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ph` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pl` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pt` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `qa` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `re` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ro` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ru` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `rw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sh` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `kn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `lc` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `vc` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ws` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `st` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sa` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sc` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sl` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `si` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sb` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `so` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `za` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gs` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `es` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `lk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sd` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sj` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `se` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ch` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sy` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tj` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `th` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tl` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `to` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tt` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tc` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tv` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ug` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ua` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ae` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gb` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `us` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `um` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `uy` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `uz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `vu` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ve` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `vn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `vg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `vi` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `wf` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `eh` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ye` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `zm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `zw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ax` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bq` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `im` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `je` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `me` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bl` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mf` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `rs` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sx` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ss` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `xk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
9
docs/models/operations/editlinkrequest.md
Normal file
9
docs/models/operations/editlinkrequest.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# EditLinkRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||
| `linkId` | *string* | :heavy_check_mark: | The id of the link to edit. You can get this via the `getLinkInfo` endpoint. |
|
||||
| `requestBody` | [operations.EditLinkRequestBody](../../models/operations/editlinkrequestbody.md) | :heavy_minus_sign: | N/A |
|
||||
27
docs/models/operations/editlinkrequestbody.md
Normal file
27
docs/models/operations/editlinkrequestbody.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# EditLinkRequestBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `domain` | *string* | :heavy_minus_sign: | The domain of the short link. If not provided, the primary domain for the workspace will be used (or `dub.sh` if the workspace has no domains). |
|
||||
| `key` | *string* | :heavy_minus_sign: | The short link slug. If not provided, a random 7-character slug will be generated. |
|
||||
| `prefix` | *string* | :heavy_minus_sign: | The prefix of the short link slug for randomly-generated keys (e.g. if prefix is `/c/`, generated keys will be in the `/c/:key` format). Will be ignored if `key` is provided. |
|
||||
| `url` | *string* | :heavy_check_mark: | The destination URL of the short link. |
|
||||
| `archived` | *boolean* | :heavy_minus_sign: | Whether the short link is archived. |
|
||||
| `publicStats` | *boolean* | :heavy_minus_sign: | Whether the short link's stats are publicly accessible. |
|
||||
| ~~`tagId`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead. |
|
||||
| `tagIds` | *operations.EditLinkTagIds* | :heavy_minus_sign: | The unique IDs of the tags assigned to the short link. |
|
||||
| `comments` | *string* | :heavy_minus_sign: | The comments for the short link. |
|
||||
| `expiresAt` | *string* | :heavy_minus_sign: | The date and time when the short link will expire at. |
|
||||
| `expiredUrl` | *string* | :heavy_minus_sign: | The URL to redirect to when the short link has expired. |
|
||||
| `password` | *string* | :heavy_minus_sign: | The password required to access the destination URL of the short link. |
|
||||
| `proxy` | *boolean* | :heavy_minus_sign: | Whether the short link uses Custom Social Media Cards feature. |
|
||||
| `title` | *string* | :heavy_minus_sign: | The title of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true. |
|
||||
| `description` | *string* | :heavy_minus_sign: | The description of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true. |
|
||||
| `image` | *string* | :heavy_minus_sign: | The image of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true. |
|
||||
| `rewrite` | *boolean* | :heavy_minus_sign: | Whether the short link uses link cloaking. |
|
||||
| `ios` | *string* | :heavy_minus_sign: | The iOS destination URL for the short link for iOS device targeting. |
|
||||
| `android` | *string* | :heavy_minus_sign: | The Android destination URL for the short link for Android device targeting. |
|
||||
| `geo` | [operations.EditLinkGeo](../../models/operations/editlinkgeo.md) | :heavy_minus_sign: | Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. |
|
||||
4
docs/models/operations/editlinktagids.md
Normal file
4
docs/models/operations/editlinktagids.md
Normal file
@@ -0,0 +1,4 @@
|
||||
# EditLinkTagIds
|
||||
|
||||
The unique IDs of the tags assigned to the short link.
|
||||
|
||||
259
docs/models/operations/geo.md
Normal file
259
docs/models/operations/geo.md
Normal file
@@ -0,0 +1,259 @@
|
||||
# Geo
|
||||
|
||||
Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
||||
| `af` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `al` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `dz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `as` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ad` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ao` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ai` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `aq` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ag` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ar` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `am` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `aw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `au` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `at` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `az` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bs` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bh` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bd` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bb` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `by` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `be` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bj` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bt` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bo` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ba` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bv` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `br` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `io` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bf` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bi` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `kh` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ca` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cv` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ky` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cf` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `td` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cl` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cx` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cc` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `co` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `km` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cd` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ck` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ci` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `hr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cu` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cy` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `dk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `dj` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `dm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `do` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ec` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `eg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sv` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gq` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `er` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ee` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `et` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `fk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `fo` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `fj` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `fi` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `fr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gf` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pf` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tf` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ga` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ge` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `de` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gh` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gi` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gl` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gd` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gp` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gu` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gt` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gy` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ht` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `hm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `va` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `hn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `hk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `hu` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `is` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `in` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `id` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ir` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `iq` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ie` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `il` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `it` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `jm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `jp` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `jo` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `kz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ke` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ki` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `kp` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `kr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `kw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `kg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `la` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `lv` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `lb` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ls` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `lr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ly` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `li` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `lt` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `lu` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mo` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `my` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mv` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ml` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mt` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mh` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mq` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mu` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `yt` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mx` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `fm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `md` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mc` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ms` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ma` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `na` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `nr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `np` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `nl` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `nc` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `nz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ni` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ne` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ng` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `nu` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `nf` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mp` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `no` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `om` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ps` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pa` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `py` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pe` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ph` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pl` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pt` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `qa` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `re` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ro` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ru` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `rw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sh` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `kn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `lc` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `pm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `vc` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ws` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `st` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sa` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sc` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sl` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `si` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sb` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `so` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `za` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gs` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `es` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `lk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sd` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sj` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `se` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ch` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sy` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tj` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `th` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tl` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `to` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tt` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tr` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tc` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `tv` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ug` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ua` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ae` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gb` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `us` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `um` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `uy` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `uz` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `vu` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ve` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `vn` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `vg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `vi` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `wf` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `eh` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ye` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `zm` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `zw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ax` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bq` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `cw` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `gg` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `im` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `je` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `me` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `bl` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `mf` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `rs` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `sx` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `ss` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
| `xk` | *string* | :heavy_minus_sign: | The destination URL of the short link. |
|
||||
259
docs/models/operations/getbrowseranalyticsqueryparamcountry.md
Normal file
259
docs/models/operations/getbrowseranalyticsqueryparamcountry.md
Normal file
@@ -0,0 +1,259 @@
|
||||
# GetBrowserAnalyticsQueryParamCountry
|
||||
|
||||
The country to retrieve analytics for.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----- | ----- |
|
||||
| `Af` | AF |
|
||||
| `Al` | AL |
|
||||
| `Dz` | DZ |
|
||||
| `As` | AS |
|
||||
| `Ad` | AD |
|
||||
| `Ao` | AO |
|
||||
| `Ai` | AI |
|
||||
| `Aq` | AQ |
|
||||
| `Ag` | AG |
|
||||
| `Ar` | AR |
|
||||
| `Am` | AM |
|
||||
| `Aw` | AW |
|
||||
| `Au` | AU |
|
||||
| `At` | AT |
|
||||
| `Az` | AZ |
|
||||
| `Bs` | BS |
|
||||
| `Bh` | BH |
|
||||
| `Bd` | BD |
|
||||
| `Bb` | BB |
|
||||
| `By` | BY |
|
||||
| `Be` | BE |
|
||||
| `Bz` | BZ |
|
||||
| `Bj` | BJ |
|
||||
| `Bm` | BM |
|
||||
| `Bt` | BT |
|
||||
| `Bo` | BO |
|
||||
| `Ba` | BA |
|
||||
| `Bw` | BW |
|
||||
| `Bv` | BV |
|
||||
| `Br` | BR |
|
||||
| `Io` | IO |
|
||||
| `Bn` | BN |
|
||||
| `Bg` | BG |
|
||||
| `Bf` | BF |
|
||||
| `Bi` | BI |
|
||||
| `Kh` | KH |
|
||||
| `Cm` | CM |
|
||||
| `Ca` | CA |
|
||||
| `Cv` | CV |
|
||||
| `Ky` | KY |
|
||||
| `Cf` | CF |
|
||||
| `Td` | TD |
|
||||
| `Cl` | CL |
|
||||
| `Cn` | CN |
|
||||
| `Cx` | CX |
|
||||
| `Cc` | CC |
|
||||
| `Co` | CO |
|
||||
| `Km` | KM |
|
||||
| `Cg` | CG |
|
||||
| `Cd` | CD |
|
||||
| `Ck` | CK |
|
||||
| `Cr` | CR |
|
||||
| `Ci` | CI |
|
||||
| `Hr` | HR |
|
||||
| `Cu` | CU |
|
||||
| `Cy` | CY |
|
||||
| `Cz` | CZ |
|
||||
| `Dk` | DK |
|
||||
| `Dj` | DJ |
|
||||
| `Dm` | DM |
|
||||
| `Do` | DO |
|
||||
| `Ec` | EC |
|
||||
| `Eg` | EG |
|
||||
| `Sv` | SV |
|
||||
| `Gq` | GQ |
|
||||
| `Er` | ER |
|
||||
| `Ee` | EE |
|
||||
| `Et` | ET |
|
||||
| `Fk` | FK |
|
||||
| `Fo` | FO |
|
||||
| `Fj` | FJ |
|
||||
| `Fi` | FI |
|
||||
| `Fr` | FR |
|
||||
| `Gf` | GF |
|
||||
| `Pf` | PF |
|
||||
| `Tf` | TF |
|
||||
| `Ga` | GA |
|
||||
| `Gm` | GM |
|
||||
| `Ge` | GE |
|
||||
| `De` | DE |
|
||||
| `Gh` | GH |
|
||||
| `Gi` | GI |
|
||||
| `Gr` | GR |
|
||||
| `Gl` | GL |
|
||||
| `Gd` | GD |
|
||||
| `Gp` | GP |
|
||||
| `Gu` | GU |
|
||||
| `Gt` | GT |
|
||||
| `Gn` | GN |
|
||||
| `Gw` | GW |
|
||||
| `Gy` | GY |
|
||||
| `Ht` | HT |
|
||||
| `Hm` | HM |
|
||||
| `Va` | VA |
|
||||
| `Hn` | HN |
|
||||
| `Hk` | HK |
|
||||
| `Hu` | HU |
|
||||
| `Is` | IS |
|
||||
| `In` | IN |
|
||||
| `Id` | ID |
|
||||
| `Ir` | IR |
|
||||
| `Iq` | IQ |
|
||||
| `Ie` | IE |
|
||||
| `Il` | IL |
|
||||
| `It` | IT |
|
||||
| `Jm` | JM |
|
||||
| `Jp` | JP |
|
||||
| `Jo` | JO |
|
||||
| `Kz` | KZ |
|
||||
| `Ke` | KE |
|
||||
| `Ki` | KI |
|
||||
| `Kp` | KP |
|
||||
| `Kr` | KR |
|
||||
| `Kw` | KW |
|
||||
| `Kg` | KG |
|
||||
| `La` | LA |
|
||||
| `Lv` | LV |
|
||||
| `Lb` | LB |
|
||||
| `Ls` | LS |
|
||||
| `Lr` | LR |
|
||||
| `Ly` | LY |
|
||||
| `Li` | LI |
|
||||
| `Lt` | LT |
|
||||
| `Lu` | LU |
|
||||
| `Mo` | MO |
|
||||
| `Mg` | MG |
|
||||
| `Mw` | MW |
|
||||
| `My` | MY |
|
||||
| `Mv` | MV |
|
||||
| `Ml` | ML |
|
||||
| `Mt` | MT |
|
||||
| `Mh` | MH |
|
||||
| `Mq` | MQ |
|
||||
| `Mr` | MR |
|
||||
| `Mu` | MU |
|
||||
| `Yt` | YT |
|
||||
| `Mx` | MX |
|
||||
| `Fm` | FM |
|
||||
| `Md` | MD |
|
||||
| `Mc` | MC |
|
||||
| `Mn` | MN |
|
||||
| `Ms` | MS |
|
||||
| `Ma` | MA |
|
||||
| `Mz` | MZ |
|
||||
| `Mm` | MM |
|
||||
| `Na` | NA |
|
||||
| `Nr` | NR |
|
||||
| `Np` | NP |
|
||||
| `Nl` | NL |
|
||||
| `Nc` | NC |
|
||||
| `Nz` | NZ |
|
||||
| `Ni` | NI |
|
||||
| `Ne` | NE |
|
||||
| `Ng` | NG |
|
||||
| `Nu` | NU |
|
||||
| `Nf` | NF |
|
||||
| `Mk` | MK |
|
||||
| `Mp` | MP |
|
||||
| `No` | NO |
|
||||
| `Om` | OM |
|
||||
| `Pk` | PK |
|
||||
| `Pw` | PW |
|
||||
| `Ps` | PS |
|
||||
| `Pa` | PA |
|
||||
| `Pg` | PG |
|
||||
| `Py` | PY |
|
||||
| `Pe` | PE |
|
||||
| `Ph` | PH |
|
||||
| `Pn` | PN |
|
||||
| `Pl` | PL |
|
||||
| `Pt` | PT |
|
||||
| `Pr` | PR |
|
||||
| `Qa` | QA |
|
||||
| `Re` | RE |
|
||||
| `Ro` | RO |
|
||||
| `Ru` | RU |
|
||||
| `Rw` | RW |
|
||||
| `Sh` | SH |
|
||||
| `Kn` | KN |
|
||||
| `Lc` | LC |
|
||||
| `Pm` | PM |
|
||||
| `Vc` | VC |
|
||||
| `Ws` | WS |
|
||||
| `Sm` | SM |
|
||||
| `St` | ST |
|
||||
| `Sa` | SA |
|
||||
| `Sn` | SN |
|
||||
| `Sc` | SC |
|
||||
| `Sl` | SL |
|
||||
| `Sg` | SG |
|
||||
| `Sk` | SK |
|
||||
| `Si` | SI |
|
||||
| `Sb` | SB |
|
||||
| `So` | SO |
|
||||
| `Za` | ZA |
|
||||
| `Gs` | GS |
|
||||
| `Es` | ES |
|
||||
| `Lk` | LK |
|
||||
| `Sd` | SD |
|
||||
| `Sr` | SR |
|
||||
| `Sj` | SJ |
|
||||
| `Sz` | SZ |
|
||||
| `Se` | SE |
|
||||
| `Ch` | CH |
|
||||
| `Sy` | SY |
|
||||
| `Tw` | TW |
|
||||
| `Tj` | TJ |
|
||||
| `Tz` | TZ |
|
||||
| `Th` | TH |
|
||||
| `Tl` | TL |
|
||||
| `Tg` | TG |
|
||||
| `Tk` | TK |
|
||||
| `To` | TO |
|
||||
| `Tt` | TT |
|
||||
| `Tn` | TN |
|
||||
| `Tr` | TR |
|
||||
| `Tm` | TM |
|
||||
| `Tc` | TC |
|
||||
| `Tv` | TV |
|
||||
| `Ug` | UG |
|
||||
| `Ua` | UA |
|
||||
| `Ae` | AE |
|
||||
| `Gb` | GB |
|
||||
| `Us` | US |
|
||||
| `Um` | UM |
|
||||
| `Uy` | UY |
|
||||
| `Uz` | UZ |
|
||||
| `Vu` | VU |
|
||||
| `Ve` | VE |
|
||||
| `Vn` | VN |
|
||||
| `Vg` | VG |
|
||||
| `Vi` | VI |
|
||||
| `Wf` | WF |
|
||||
| `Eh` | EH |
|
||||
| `Ye` | YE |
|
||||
| `Zm` | ZM |
|
||||
| `Zw` | ZW |
|
||||
| `Ax` | AX |
|
||||
| `Bq` | BQ |
|
||||
| `Cw` | CW |
|
||||
| `Gg` | GG |
|
||||
| `Im` | IM |
|
||||
| `Je` | JE |
|
||||
| `Me` | ME |
|
||||
| `Bl` | BL |
|
||||
| `Mf` | MF |
|
||||
| `Rs` | RS |
|
||||
| `Sx` | SX |
|
||||
| `Ss` | SS |
|
||||
| `Xk` | XK |
|
||||
@@ -0,0 +1,15 @@
|
||||
# GetBrowserAnalyticsQueryParamInterval
|
||||
|
||||
The interval to retrieve analytics for.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `Oneh` | 1h |
|
||||
| `TwentyFourh` | 24h |
|
||||
| `Sevend` | 7d |
|
||||
| `Thirtyd` | 30d |
|
||||
| `Ninetyd` | 90d |
|
||||
| `All` | all |
|
||||
19
docs/models/operations/getbrowseranalyticsrequest.md
Normal file
19
docs/models/operations/getbrowseranalyticsrequest.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# GetBrowserAnalyticsRequest
|
||||
|
||||
|
||||
## 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. |
|
||||
@@ -0,0 +1,9 @@
|
||||
# GetBrowserAnalyticsResponseBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
||||
| `browser` | *string* | :heavy_check_mark: | The name of the browser |
|
||||
| `clicks` | *number* | :heavy_check_mark: | The number of clicks from this browser |
|
||||
259
docs/models/operations/getcityanalyticscountry.md
Normal file
259
docs/models/operations/getcityanalyticscountry.md
Normal file
@@ -0,0 +1,259 @@
|
||||
# GetCityAnalyticsCountry
|
||||
|
||||
The 2-letter country code of the city: https://d.to/geo
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----- | ----- |
|
||||
| `Af` | AF |
|
||||
| `Al` | AL |
|
||||
| `Dz` | DZ |
|
||||
| `As` | AS |
|
||||
| `Ad` | AD |
|
||||
| `Ao` | AO |
|
||||
| `Ai` | AI |
|
||||
| `Aq` | AQ |
|
||||
| `Ag` | AG |
|
||||
| `Ar` | AR |
|
||||
| `Am` | AM |
|
||||
| `Aw` | AW |
|
||||
| `Au` | AU |
|
||||
| `At` | AT |
|
||||
| `Az` | AZ |
|
||||
| `Bs` | BS |
|
||||
| `Bh` | BH |
|
||||
| `Bd` | BD |
|
||||
| `Bb` | BB |
|
||||
| `By` | BY |
|
||||
| `Be` | BE |
|
||||
| `Bz` | BZ |
|
||||
| `Bj` | BJ |
|
||||
| `Bm` | BM |
|
||||
| `Bt` | BT |
|
||||
| `Bo` | BO |
|
||||
| `Ba` | BA |
|
||||
| `Bw` | BW |
|
||||
| `Bv` | BV |
|
||||
| `Br` | BR |
|
||||
| `Io` | IO |
|
||||
| `Bn` | BN |
|
||||
| `Bg` | BG |
|
||||
| `Bf` | BF |
|
||||
| `Bi` | BI |
|
||||
| `Kh` | KH |
|
||||
| `Cm` | CM |
|
||||
| `Ca` | CA |
|
||||
| `Cv` | CV |
|
||||
| `Ky` | KY |
|
||||
| `Cf` | CF |
|
||||
| `Td` | TD |
|
||||
| `Cl` | CL |
|
||||
| `Cn` | CN |
|
||||
| `Cx` | CX |
|
||||
| `Cc` | CC |
|
||||
| `Co` | CO |
|
||||
| `Km` | KM |
|
||||
| `Cg` | CG |
|
||||
| `Cd` | CD |
|
||||
| `Ck` | CK |
|
||||
| `Cr` | CR |
|
||||
| `Ci` | CI |
|
||||
| `Hr` | HR |
|
||||
| `Cu` | CU |
|
||||
| `Cy` | CY |
|
||||
| `Cz` | CZ |
|
||||
| `Dk` | DK |
|
||||
| `Dj` | DJ |
|
||||
| `Dm` | DM |
|
||||
| `Do` | DO |
|
||||
| `Ec` | EC |
|
||||
| `Eg` | EG |
|
||||
| `Sv` | SV |
|
||||
| `Gq` | GQ |
|
||||
| `Er` | ER |
|
||||
| `Ee` | EE |
|
||||
| `Et` | ET |
|
||||
| `Fk` | FK |
|
||||
| `Fo` | FO |
|
||||
| `Fj` | FJ |
|
||||
| `Fi` | FI |
|
||||
| `Fr` | FR |
|
||||
| `Gf` | GF |
|
||||
| `Pf` | PF |
|
||||
| `Tf` | TF |
|
||||
| `Ga` | GA |
|
||||
| `Gm` | GM |
|
||||
| `Ge` | GE |
|
||||
| `De` | DE |
|
||||
| `Gh` | GH |
|
||||
| `Gi` | GI |
|
||||
| `Gr` | GR |
|
||||
| `Gl` | GL |
|
||||
| `Gd` | GD |
|
||||
| `Gp` | GP |
|
||||
| `Gu` | GU |
|
||||
| `Gt` | GT |
|
||||
| `Gn` | GN |
|
||||
| `Gw` | GW |
|
||||
| `Gy` | GY |
|
||||
| `Ht` | HT |
|
||||
| `Hm` | HM |
|
||||
| `Va` | VA |
|
||||
| `Hn` | HN |
|
||||
| `Hk` | HK |
|
||||
| `Hu` | HU |
|
||||
| `Is` | IS |
|
||||
| `In` | IN |
|
||||
| `Id` | ID |
|
||||
| `Ir` | IR |
|
||||
| `Iq` | IQ |
|
||||
| `Ie` | IE |
|
||||
| `Il` | IL |
|
||||
| `It` | IT |
|
||||
| `Jm` | JM |
|
||||
| `Jp` | JP |
|
||||
| `Jo` | JO |
|
||||
| `Kz` | KZ |
|
||||
| `Ke` | KE |
|
||||
| `Ki` | KI |
|
||||
| `Kp` | KP |
|
||||
| `Kr` | KR |
|
||||
| `Kw` | KW |
|
||||
| `Kg` | KG |
|
||||
| `La` | LA |
|
||||
| `Lv` | LV |
|
||||
| `Lb` | LB |
|
||||
| `Ls` | LS |
|
||||
| `Lr` | LR |
|
||||
| `Ly` | LY |
|
||||
| `Li` | LI |
|
||||
| `Lt` | LT |
|
||||
| `Lu` | LU |
|
||||
| `Mo` | MO |
|
||||
| `Mg` | MG |
|
||||
| `Mw` | MW |
|
||||
| `My` | MY |
|
||||
| `Mv` | MV |
|
||||
| `Ml` | ML |
|
||||
| `Mt` | MT |
|
||||
| `Mh` | MH |
|
||||
| `Mq` | MQ |
|
||||
| `Mr` | MR |
|
||||
| `Mu` | MU |
|
||||
| `Yt` | YT |
|
||||
| `Mx` | MX |
|
||||
| `Fm` | FM |
|
||||
| `Md` | MD |
|
||||
| `Mc` | MC |
|
||||
| `Mn` | MN |
|
||||
| `Ms` | MS |
|
||||
| `Ma` | MA |
|
||||
| `Mz` | MZ |
|
||||
| `Mm` | MM |
|
||||
| `Na` | NA |
|
||||
| `Nr` | NR |
|
||||
| `Np` | NP |
|
||||
| `Nl` | NL |
|
||||
| `Nc` | NC |
|
||||
| `Nz` | NZ |
|
||||
| `Ni` | NI |
|
||||
| `Ne` | NE |
|
||||
| `Ng` | NG |
|
||||
| `Nu` | NU |
|
||||
| `Nf` | NF |
|
||||
| `Mk` | MK |
|
||||
| `Mp` | MP |
|
||||
| `No` | NO |
|
||||
| `Om` | OM |
|
||||
| `Pk` | PK |
|
||||
| `Pw` | PW |
|
||||
| `Ps` | PS |
|
||||
| `Pa` | PA |
|
||||
| `Pg` | PG |
|
||||
| `Py` | PY |
|
||||
| `Pe` | PE |
|
||||
| `Ph` | PH |
|
||||
| `Pn` | PN |
|
||||
| `Pl` | PL |
|
||||
| `Pt` | PT |
|
||||
| `Pr` | PR |
|
||||
| `Qa` | QA |
|
||||
| `Re` | RE |
|
||||
| `Ro` | RO |
|
||||
| `Ru` | RU |
|
||||
| `Rw` | RW |
|
||||
| `Sh` | SH |
|
||||
| `Kn` | KN |
|
||||
| `Lc` | LC |
|
||||
| `Pm` | PM |
|
||||
| `Vc` | VC |
|
||||
| `Ws` | WS |
|
||||
| `Sm` | SM |
|
||||
| `St` | ST |
|
||||
| `Sa` | SA |
|
||||
| `Sn` | SN |
|
||||
| `Sc` | SC |
|
||||
| `Sl` | SL |
|
||||
| `Sg` | SG |
|
||||
| `Sk` | SK |
|
||||
| `Si` | SI |
|
||||
| `Sb` | SB |
|
||||
| `So` | SO |
|
||||
| `Za` | ZA |
|
||||
| `Gs` | GS |
|
||||
| `Es` | ES |
|
||||
| `Lk` | LK |
|
||||
| `Sd` | SD |
|
||||
| `Sr` | SR |
|
||||
| `Sj` | SJ |
|
||||
| `Sz` | SZ |
|
||||
| `Se` | SE |
|
||||
| `Ch` | CH |
|
||||
| `Sy` | SY |
|
||||
| `Tw` | TW |
|
||||
| `Tj` | TJ |
|
||||
| `Tz` | TZ |
|
||||
| `Th` | TH |
|
||||
| `Tl` | TL |
|
||||
| `Tg` | TG |
|
||||
| `Tk` | TK |
|
||||
| `To` | TO |
|
||||
| `Tt` | TT |
|
||||
| `Tn` | TN |
|
||||
| `Tr` | TR |
|
||||
| `Tm` | TM |
|
||||
| `Tc` | TC |
|
||||
| `Tv` | TV |
|
||||
| `Ug` | UG |
|
||||
| `Ua` | UA |
|
||||
| `Ae` | AE |
|
||||
| `Gb` | GB |
|
||||
| `Us` | US |
|
||||
| `Um` | UM |
|
||||
| `Uy` | UY |
|
||||
| `Uz` | UZ |
|
||||
| `Vu` | VU |
|
||||
| `Ve` | VE |
|
||||
| `Vn` | VN |
|
||||
| `Vg` | VG |
|
||||
| `Vi` | VI |
|
||||
| `Wf` | WF |
|
||||
| `Eh` | EH |
|
||||
| `Ye` | YE |
|
||||
| `Zm` | ZM |
|
||||
| `Zw` | ZW |
|
||||
| `Ax` | AX |
|
||||
| `Bq` | BQ |
|
||||
| `Cw` | CW |
|
||||
| `Gg` | GG |
|
||||
| `Im` | IM |
|
||||
| `Je` | JE |
|
||||
| `Me` | ME |
|
||||
| `Bl` | BL |
|
||||
| `Mf` | MF |
|
||||
| `Rs` | RS |
|
||||
| `Sx` | SX |
|
||||
| `Ss` | SS |
|
||||
| `Xk` | XK |
|
||||
259
docs/models/operations/getcityanalyticsqueryparamcountry.md
Normal file
259
docs/models/operations/getcityanalyticsqueryparamcountry.md
Normal file
@@ -0,0 +1,259 @@
|
||||
# GetCityAnalyticsQueryParamCountry
|
||||
|
||||
The country to retrieve analytics for.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----- | ----- |
|
||||
| `Af` | AF |
|
||||
| `Al` | AL |
|
||||
| `Dz` | DZ |
|
||||
| `As` | AS |
|
||||
| `Ad` | AD |
|
||||
| `Ao` | AO |
|
||||
| `Ai` | AI |
|
||||
| `Aq` | AQ |
|
||||
| `Ag` | AG |
|
||||
| `Ar` | AR |
|
||||
| `Am` | AM |
|
||||
| `Aw` | AW |
|
||||
| `Au` | AU |
|
||||
| `At` | AT |
|
||||
| `Az` | AZ |
|
||||
| `Bs` | BS |
|
||||
| `Bh` | BH |
|
||||
| `Bd` | BD |
|
||||
| `Bb` | BB |
|
||||
| `By` | BY |
|
||||
| `Be` | BE |
|
||||
| `Bz` | BZ |
|
||||
| `Bj` | BJ |
|
||||
| `Bm` | BM |
|
||||
| `Bt` | BT |
|
||||
| `Bo` | BO |
|
||||
| `Ba` | BA |
|
||||
| `Bw` | BW |
|
||||
| `Bv` | BV |
|
||||
| `Br` | BR |
|
||||
| `Io` | IO |
|
||||
| `Bn` | BN |
|
||||
| `Bg` | BG |
|
||||
| `Bf` | BF |
|
||||
| `Bi` | BI |
|
||||
| `Kh` | KH |
|
||||
| `Cm` | CM |
|
||||
| `Ca` | CA |
|
||||
| `Cv` | CV |
|
||||
| `Ky` | KY |
|
||||
| `Cf` | CF |
|
||||
| `Td` | TD |
|
||||
| `Cl` | CL |
|
||||
| `Cn` | CN |
|
||||
| `Cx` | CX |
|
||||
| `Cc` | CC |
|
||||
| `Co` | CO |
|
||||
| `Km` | KM |
|
||||
| `Cg` | CG |
|
||||
| `Cd` | CD |
|
||||
| `Ck` | CK |
|
||||
| `Cr` | CR |
|
||||
| `Ci` | CI |
|
||||
| `Hr` | HR |
|
||||
| `Cu` | CU |
|
||||
| `Cy` | CY |
|
||||
| `Cz` | CZ |
|
||||
| `Dk` | DK |
|
||||
| `Dj` | DJ |
|
||||
| `Dm` | DM |
|
||||
| `Do` | DO |
|
||||
| `Ec` | EC |
|
||||
| `Eg` | EG |
|
||||
| `Sv` | SV |
|
||||
| `Gq` | GQ |
|
||||
| `Er` | ER |
|
||||
| `Ee` | EE |
|
||||
| `Et` | ET |
|
||||
| `Fk` | FK |
|
||||
| `Fo` | FO |
|
||||
| `Fj` | FJ |
|
||||
| `Fi` | FI |
|
||||
| `Fr` | FR |
|
||||
| `Gf` | GF |
|
||||
| `Pf` | PF |
|
||||
| `Tf` | TF |
|
||||
| `Ga` | GA |
|
||||
| `Gm` | GM |
|
||||
| `Ge` | GE |
|
||||
| `De` | DE |
|
||||
| `Gh` | GH |
|
||||
| `Gi` | GI |
|
||||
| `Gr` | GR |
|
||||
| `Gl` | GL |
|
||||
| `Gd` | GD |
|
||||
| `Gp` | GP |
|
||||
| `Gu` | GU |
|
||||
| `Gt` | GT |
|
||||
| `Gn` | GN |
|
||||
| `Gw` | GW |
|
||||
| `Gy` | GY |
|
||||
| `Ht` | HT |
|
||||
| `Hm` | HM |
|
||||
| `Va` | VA |
|
||||
| `Hn` | HN |
|
||||
| `Hk` | HK |
|
||||
| `Hu` | HU |
|
||||
| `Is` | IS |
|
||||
| `In` | IN |
|
||||
| `Id` | ID |
|
||||
| `Ir` | IR |
|
||||
| `Iq` | IQ |
|
||||
| `Ie` | IE |
|
||||
| `Il` | IL |
|
||||
| `It` | IT |
|
||||
| `Jm` | JM |
|
||||
| `Jp` | JP |
|
||||
| `Jo` | JO |
|
||||
| `Kz` | KZ |
|
||||
| `Ke` | KE |
|
||||
| `Ki` | KI |
|
||||
| `Kp` | KP |
|
||||
| `Kr` | KR |
|
||||
| `Kw` | KW |
|
||||
| `Kg` | KG |
|
||||
| `La` | LA |
|
||||
| `Lv` | LV |
|
||||
| `Lb` | LB |
|
||||
| `Ls` | LS |
|
||||
| `Lr` | LR |
|
||||
| `Ly` | LY |
|
||||
| `Li` | LI |
|
||||
| `Lt` | LT |
|
||||
| `Lu` | LU |
|
||||
| `Mo` | MO |
|
||||
| `Mg` | MG |
|
||||
| `Mw` | MW |
|
||||
| `My` | MY |
|
||||
| `Mv` | MV |
|
||||
| `Ml` | ML |
|
||||
| `Mt` | MT |
|
||||
| `Mh` | MH |
|
||||
| `Mq` | MQ |
|
||||
| `Mr` | MR |
|
||||
| `Mu` | MU |
|
||||
| `Yt` | YT |
|
||||
| `Mx` | MX |
|
||||
| `Fm` | FM |
|
||||
| `Md` | MD |
|
||||
| `Mc` | MC |
|
||||
| `Mn` | MN |
|
||||
| `Ms` | MS |
|
||||
| `Ma` | MA |
|
||||
| `Mz` | MZ |
|
||||
| `Mm` | MM |
|
||||
| `Na` | NA |
|
||||
| `Nr` | NR |
|
||||
| `Np` | NP |
|
||||
| `Nl` | NL |
|
||||
| `Nc` | NC |
|
||||
| `Nz` | NZ |
|
||||
| `Ni` | NI |
|
||||
| `Ne` | NE |
|
||||
| `Ng` | NG |
|
||||
| `Nu` | NU |
|
||||
| `Nf` | NF |
|
||||
| `Mk` | MK |
|
||||
| `Mp` | MP |
|
||||
| `No` | NO |
|
||||
| `Om` | OM |
|
||||
| `Pk` | PK |
|
||||
| `Pw` | PW |
|
||||
| `Ps` | PS |
|
||||
| `Pa` | PA |
|
||||
| `Pg` | PG |
|
||||
| `Py` | PY |
|
||||
| `Pe` | PE |
|
||||
| `Ph` | PH |
|
||||
| `Pn` | PN |
|
||||
| `Pl` | PL |
|
||||
| `Pt` | PT |
|
||||
| `Pr` | PR |
|
||||
| `Qa` | QA |
|
||||
| `Re` | RE |
|
||||
| `Ro` | RO |
|
||||
| `Ru` | RU |
|
||||
| `Rw` | RW |
|
||||
| `Sh` | SH |
|
||||
| `Kn` | KN |
|
||||
| `Lc` | LC |
|
||||
| `Pm` | PM |
|
||||
| `Vc` | VC |
|
||||
| `Ws` | WS |
|
||||
| `Sm` | SM |
|
||||
| `St` | ST |
|
||||
| `Sa` | SA |
|
||||
| `Sn` | SN |
|
||||
| `Sc` | SC |
|
||||
| `Sl` | SL |
|
||||
| `Sg` | SG |
|
||||
| `Sk` | SK |
|
||||
| `Si` | SI |
|
||||
| `Sb` | SB |
|
||||
| `So` | SO |
|
||||
| `Za` | ZA |
|
||||
| `Gs` | GS |
|
||||
| `Es` | ES |
|
||||
| `Lk` | LK |
|
||||
| `Sd` | SD |
|
||||
| `Sr` | SR |
|
||||
| `Sj` | SJ |
|
||||
| `Sz` | SZ |
|
||||
| `Se` | SE |
|
||||
| `Ch` | CH |
|
||||
| `Sy` | SY |
|
||||
| `Tw` | TW |
|
||||
| `Tj` | TJ |
|
||||
| `Tz` | TZ |
|
||||
| `Th` | TH |
|
||||
| `Tl` | TL |
|
||||
| `Tg` | TG |
|
||||
| `Tk` | TK |
|
||||
| `To` | TO |
|
||||
| `Tt` | TT |
|
||||
| `Tn` | TN |
|
||||
| `Tr` | TR |
|
||||
| `Tm` | TM |
|
||||
| `Tc` | TC |
|
||||
| `Tv` | TV |
|
||||
| `Ug` | UG |
|
||||
| `Ua` | UA |
|
||||
| `Ae` | AE |
|
||||
| `Gb` | GB |
|
||||
| `Us` | US |
|
||||
| `Um` | UM |
|
||||
| `Uy` | UY |
|
||||
| `Uz` | UZ |
|
||||
| `Vu` | VU |
|
||||
| `Ve` | VE |
|
||||
| `Vn` | VN |
|
||||
| `Vg` | VG |
|
||||
| `Vi` | VI |
|
||||
| `Wf` | WF |
|
||||
| `Eh` | EH |
|
||||
| `Ye` | YE |
|
||||
| `Zm` | ZM |
|
||||
| `Zw` | ZW |
|
||||
| `Ax` | AX |
|
||||
| `Bq` | BQ |
|
||||
| `Cw` | CW |
|
||||
| `Gg` | GG |
|
||||
| `Im` | IM |
|
||||
| `Je` | JE |
|
||||
| `Me` | ME |
|
||||
| `Bl` | BL |
|
||||
| `Mf` | MF |
|
||||
| `Rs` | RS |
|
||||
| `Sx` | SX |
|
||||
| `Ss` | SS |
|
||||
| `Xk` | XK |
|
||||
15
docs/models/operations/getcityanalyticsqueryparaminterval.md
Normal file
15
docs/models/operations/getcityanalyticsqueryparaminterval.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# GetCityAnalyticsQueryParamInterval
|
||||
|
||||
The interval to retrieve analytics for.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `Oneh` | 1h |
|
||||
| `TwentyFourh` | 24h |
|
||||
| `Sevend` | 7d |
|
||||
| `Thirtyd` | 30d |
|
||||
| `Ninetyd` | 90d |
|
||||
| `All` | all |
|
||||
19
docs/models/operations/getcityanalyticsrequest.md
Normal file
19
docs/models/operations/getcityanalyticsrequest.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# GetCityAnalyticsRequest
|
||||
|
||||
|
||||
## 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. |
|
||||
10
docs/models/operations/getcityanalyticsresponsebody.md
Normal file
10
docs/models/operations/getcityanalyticsresponsebody.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetCityAnalyticsResponseBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
||||
| `city` | *string* | :heavy_check_mark: | The name of the city |
|
||||
| `country` | [operations.GetCityAnalyticsCountry](../../models/operations/getcityanalyticscountry.md) | :heavy_check_mark: | The 2-letter country code of the city: https://d.to/geo |
|
||||
| `clicks` | *number* | :heavy_check_mark: | The number of clicks from this city |
|
||||
19
docs/models/operations/getclicksanalyticsrequest.md
Normal file
19
docs/models/operations/getclicksanalyticsrequest.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# GetClicksAnalyticsRequest
|
||||
|
||||
|
||||
## 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. |
|
||||
259
docs/models/operations/getcountryanalyticscountry.md
Normal file
259
docs/models/operations/getcountryanalyticscountry.md
Normal file
@@ -0,0 +1,259 @@
|
||||
# GetCountryAnalyticsCountry
|
||||
|
||||
The 2-letter country code: https://d.to/geo
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----- | ----- |
|
||||
| `Af` | AF |
|
||||
| `Al` | AL |
|
||||
| `Dz` | DZ |
|
||||
| `As` | AS |
|
||||
| `Ad` | AD |
|
||||
| `Ao` | AO |
|
||||
| `Ai` | AI |
|
||||
| `Aq` | AQ |
|
||||
| `Ag` | AG |
|
||||
| `Ar` | AR |
|
||||
| `Am` | AM |
|
||||
| `Aw` | AW |
|
||||
| `Au` | AU |
|
||||
| `At` | AT |
|
||||
| `Az` | AZ |
|
||||
| `Bs` | BS |
|
||||
| `Bh` | BH |
|
||||
| `Bd` | BD |
|
||||
| `Bb` | BB |
|
||||
| `By` | BY |
|
||||
| `Be` | BE |
|
||||
| `Bz` | BZ |
|
||||
| `Bj` | BJ |
|
||||
| `Bm` | BM |
|
||||
| `Bt` | BT |
|
||||
| `Bo` | BO |
|
||||
| `Ba` | BA |
|
||||
| `Bw` | BW |
|
||||
| `Bv` | BV |
|
||||
| `Br` | BR |
|
||||
| `Io` | IO |
|
||||
| `Bn` | BN |
|
||||
| `Bg` | BG |
|
||||
| `Bf` | BF |
|
||||
| `Bi` | BI |
|
||||
| `Kh` | KH |
|
||||
| `Cm` | CM |
|
||||
| `Ca` | CA |
|
||||
| `Cv` | CV |
|
||||
| `Ky` | KY |
|
||||
| `Cf` | CF |
|
||||
| `Td` | TD |
|
||||
| `Cl` | CL |
|
||||
| `Cn` | CN |
|
||||
| `Cx` | CX |
|
||||
| `Cc` | CC |
|
||||
| `Co` | CO |
|
||||
| `Km` | KM |
|
||||
| `Cg` | CG |
|
||||
| `Cd` | CD |
|
||||
| `Ck` | CK |
|
||||
| `Cr` | CR |
|
||||
| `Ci` | CI |
|
||||
| `Hr` | HR |
|
||||
| `Cu` | CU |
|
||||
| `Cy` | CY |
|
||||
| `Cz` | CZ |
|
||||
| `Dk` | DK |
|
||||
| `Dj` | DJ |
|
||||
| `Dm` | DM |
|
||||
| `Do` | DO |
|
||||
| `Ec` | EC |
|
||||
| `Eg` | EG |
|
||||
| `Sv` | SV |
|
||||
| `Gq` | GQ |
|
||||
| `Er` | ER |
|
||||
| `Ee` | EE |
|
||||
| `Et` | ET |
|
||||
| `Fk` | FK |
|
||||
| `Fo` | FO |
|
||||
| `Fj` | FJ |
|
||||
| `Fi` | FI |
|
||||
| `Fr` | FR |
|
||||
| `Gf` | GF |
|
||||
| `Pf` | PF |
|
||||
| `Tf` | TF |
|
||||
| `Ga` | GA |
|
||||
| `Gm` | GM |
|
||||
| `Ge` | GE |
|
||||
| `De` | DE |
|
||||
| `Gh` | GH |
|
||||
| `Gi` | GI |
|
||||
| `Gr` | GR |
|
||||
| `Gl` | GL |
|
||||
| `Gd` | GD |
|
||||
| `Gp` | GP |
|
||||
| `Gu` | GU |
|
||||
| `Gt` | GT |
|
||||
| `Gn` | GN |
|
||||
| `Gw` | GW |
|
||||
| `Gy` | GY |
|
||||
| `Ht` | HT |
|
||||
| `Hm` | HM |
|
||||
| `Va` | VA |
|
||||
| `Hn` | HN |
|
||||
| `Hk` | HK |
|
||||
| `Hu` | HU |
|
||||
| `Is` | IS |
|
||||
| `In` | IN |
|
||||
| `Id` | ID |
|
||||
| `Ir` | IR |
|
||||
| `Iq` | IQ |
|
||||
| `Ie` | IE |
|
||||
| `Il` | IL |
|
||||
| `It` | IT |
|
||||
| `Jm` | JM |
|
||||
| `Jp` | JP |
|
||||
| `Jo` | JO |
|
||||
| `Kz` | KZ |
|
||||
| `Ke` | KE |
|
||||
| `Ki` | KI |
|
||||
| `Kp` | KP |
|
||||
| `Kr` | KR |
|
||||
| `Kw` | KW |
|
||||
| `Kg` | KG |
|
||||
| `La` | LA |
|
||||
| `Lv` | LV |
|
||||
| `Lb` | LB |
|
||||
| `Ls` | LS |
|
||||
| `Lr` | LR |
|
||||
| `Ly` | LY |
|
||||
| `Li` | LI |
|
||||
| `Lt` | LT |
|
||||
| `Lu` | LU |
|
||||
| `Mo` | MO |
|
||||
| `Mg` | MG |
|
||||
| `Mw` | MW |
|
||||
| `My` | MY |
|
||||
| `Mv` | MV |
|
||||
| `Ml` | ML |
|
||||
| `Mt` | MT |
|
||||
| `Mh` | MH |
|
||||
| `Mq` | MQ |
|
||||
| `Mr` | MR |
|
||||
| `Mu` | MU |
|
||||
| `Yt` | YT |
|
||||
| `Mx` | MX |
|
||||
| `Fm` | FM |
|
||||
| `Md` | MD |
|
||||
| `Mc` | MC |
|
||||
| `Mn` | MN |
|
||||
| `Ms` | MS |
|
||||
| `Ma` | MA |
|
||||
| `Mz` | MZ |
|
||||
| `Mm` | MM |
|
||||
| `Na` | NA |
|
||||
| `Nr` | NR |
|
||||
| `Np` | NP |
|
||||
| `Nl` | NL |
|
||||
| `Nc` | NC |
|
||||
| `Nz` | NZ |
|
||||
| `Ni` | NI |
|
||||
| `Ne` | NE |
|
||||
| `Ng` | NG |
|
||||
| `Nu` | NU |
|
||||
| `Nf` | NF |
|
||||
| `Mk` | MK |
|
||||
| `Mp` | MP |
|
||||
| `No` | NO |
|
||||
| `Om` | OM |
|
||||
| `Pk` | PK |
|
||||
| `Pw` | PW |
|
||||
| `Ps` | PS |
|
||||
| `Pa` | PA |
|
||||
| `Pg` | PG |
|
||||
| `Py` | PY |
|
||||
| `Pe` | PE |
|
||||
| `Ph` | PH |
|
||||
| `Pn` | PN |
|
||||
| `Pl` | PL |
|
||||
| `Pt` | PT |
|
||||
| `Pr` | PR |
|
||||
| `Qa` | QA |
|
||||
| `Re` | RE |
|
||||
| `Ro` | RO |
|
||||
| `Ru` | RU |
|
||||
| `Rw` | RW |
|
||||
| `Sh` | SH |
|
||||
| `Kn` | KN |
|
||||
| `Lc` | LC |
|
||||
| `Pm` | PM |
|
||||
| `Vc` | VC |
|
||||
| `Ws` | WS |
|
||||
| `Sm` | SM |
|
||||
| `St` | ST |
|
||||
| `Sa` | SA |
|
||||
| `Sn` | SN |
|
||||
| `Sc` | SC |
|
||||
| `Sl` | SL |
|
||||
| `Sg` | SG |
|
||||
| `Sk` | SK |
|
||||
| `Si` | SI |
|
||||
| `Sb` | SB |
|
||||
| `So` | SO |
|
||||
| `Za` | ZA |
|
||||
| `Gs` | GS |
|
||||
| `Es` | ES |
|
||||
| `Lk` | LK |
|
||||
| `Sd` | SD |
|
||||
| `Sr` | SR |
|
||||
| `Sj` | SJ |
|
||||
| `Sz` | SZ |
|
||||
| `Se` | SE |
|
||||
| `Ch` | CH |
|
||||
| `Sy` | SY |
|
||||
| `Tw` | TW |
|
||||
| `Tj` | TJ |
|
||||
| `Tz` | TZ |
|
||||
| `Th` | TH |
|
||||
| `Tl` | TL |
|
||||
| `Tg` | TG |
|
||||
| `Tk` | TK |
|
||||
| `To` | TO |
|
||||
| `Tt` | TT |
|
||||
| `Tn` | TN |
|
||||
| `Tr` | TR |
|
||||
| `Tm` | TM |
|
||||
| `Tc` | TC |
|
||||
| `Tv` | TV |
|
||||
| `Ug` | UG |
|
||||
| `Ua` | UA |
|
||||
| `Ae` | AE |
|
||||
| `Gb` | GB |
|
||||
| `Us` | US |
|
||||
| `Um` | UM |
|
||||
| `Uy` | UY |
|
||||
| `Uz` | UZ |
|
||||
| `Vu` | VU |
|
||||
| `Ve` | VE |
|
||||
| `Vn` | VN |
|
||||
| `Vg` | VG |
|
||||
| `Vi` | VI |
|
||||
| `Wf` | WF |
|
||||
| `Eh` | EH |
|
||||
| `Ye` | YE |
|
||||
| `Zm` | ZM |
|
||||
| `Zw` | ZW |
|
||||
| `Ax` | AX |
|
||||
| `Bq` | BQ |
|
||||
| `Cw` | CW |
|
||||
| `Gg` | GG |
|
||||
| `Im` | IM |
|
||||
| `Je` | JE |
|
||||
| `Me` | ME |
|
||||
| `Bl` | BL |
|
||||
| `Mf` | MF |
|
||||
| `Rs` | RS |
|
||||
| `Sx` | SX |
|
||||
| `Ss` | SS |
|
||||
| `Xk` | XK |
|
||||
259
docs/models/operations/getcountryanalyticsqueryparamcountry.md
Normal file
259
docs/models/operations/getcountryanalyticsqueryparamcountry.md
Normal file
@@ -0,0 +1,259 @@
|
||||
# GetCountryAnalyticsQueryParamCountry
|
||||
|
||||
The country to retrieve analytics for.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----- | ----- |
|
||||
| `Af` | AF |
|
||||
| `Al` | AL |
|
||||
| `Dz` | DZ |
|
||||
| `As` | AS |
|
||||
| `Ad` | AD |
|
||||
| `Ao` | AO |
|
||||
| `Ai` | AI |
|
||||
| `Aq` | AQ |
|
||||
| `Ag` | AG |
|
||||
| `Ar` | AR |
|
||||
| `Am` | AM |
|
||||
| `Aw` | AW |
|
||||
| `Au` | AU |
|
||||
| `At` | AT |
|
||||
| `Az` | AZ |
|
||||
| `Bs` | BS |
|
||||
| `Bh` | BH |
|
||||
| `Bd` | BD |
|
||||
| `Bb` | BB |
|
||||
| `By` | BY |
|
||||
| `Be` | BE |
|
||||
| `Bz` | BZ |
|
||||
| `Bj` | BJ |
|
||||
| `Bm` | BM |
|
||||
| `Bt` | BT |
|
||||
| `Bo` | BO |
|
||||
| `Ba` | BA |
|
||||
| `Bw` | BW |
|
||||
| `Bv` | BV |
|
||||
| `Br` | BR |
|
||||
| `Io` | IO |
|
||||
| `Bn` | BN |
|
||||
| `Bg` | BG |
|
||||
| `Bf` | BF |
|
||||
| `Bi` | BI |
|
||||
| `Kh` | KH |
|
||||
| `Cm` | CM |
|
||||
| `Ca` | CA |
|
||||
| `Cv` | CV |
|
||||
| `Ky` | KY |
|
||||
| `Cf` | CF |
|
||||
| `Td` | TD |
|
||||
| `Cl` | CL |
|
||||
| `Cn` | CN |
|
||||
| `Cx` | CX |
|
||||
| `Cc` | CC |
|
||||
| `Co` | CO |
|
||||
| `Km` | KM |
|
||||
| `Cg` | CG |
|
||||
| `Cd` | CD |
|
||||
| `Ck` | CK |
|
||||
| `Cr` | CR |
|
||||
| `Ci` | CI |
|
||||
| `Hr` | HR |
|
||||
| `Cu` | CU |
|
||||
| `Cy` | CY |
|
||||
| `Cz` | CZ |
|
||||
| `Dk` | DK |
|
||||
| `Dj` | DJ |
|
||||
| `Dm` | DM |
|
||||
| `Do` | DO |
|
||||
| `Ec` | EC |
|
||||
| `Eg` | EG |
|
||||
| `Sv` | SV |
|
||||
| `Gq` | GQ |
|
||||
| `Er` | ER |
|
||||
| `Ee` | EE |
|
||||
| `Et` | ET |
|
||||
| `Fk` | FK |
|
||||
| `Fo` | FO |
|
||||
| `Fj` | FJ |
|
||||
| `Fi` | FI |
|
||||
| `Fr` | FR |
|
||||
| `Gf` | GF |
|
||||
| `Pf` | PF |
|
||||
| `Tf` | TF |
|
||||
| `Ga` | GA |
|
||||
| `Gm` | GM |
|
||||
| `Ge` | GE |
|
||||
| `De` | DE |
|
||||
| `Gh` | GH |
|
||||
| `Gi` | GI |
|
||||
| `Gr` | GR |
|
||||
| `Gl` | GL |
|
||||
| `Gd` | GD |
|
||||
| `Gp` | GP |
|
||||
| `Gu` | GU |
|
||||
| `Gt` | GT |
|
||||
| `Gn` | GN |
|
||||
| `Gw` | GW |
|
||||
| `Gy` | GY |
|
||||
| `Ht` | HT |
|
||||
| `Hm` | HM |
|
||||
| `Va` | VA |
|
||||
| `Hn` | HN |
|
||||
| `Hk` | HK |
|
||||
| `Hu` | HU |
|
||||
| `Is` | IS |
|
||||
| `In` | IN |
|
||||
| `Id` | ID |
|
||||
| `Ir` | IR |
|
||||
| `Iq` | IQ |
|
||||
| `Ie` | IE |
|
||||
| `Il` | IL |
|
||||
| `It` | IT |
|
||||
| `Jm` | JM |
|
||||
| `Jp` | JP |
|
||||
| `Jo` | JO |
|
||||
| `Kz` | KZ |
|
||||
| `Ke` | KE |
|
||||
| `Ki` | KI |
|
||||
| `Kp` | KP |
|
||||
| `Kr` | KR |
|
||||
| `Kw` | KW |
|
||||
| `Kg` | KG |
|
||||
| `La` | LA |
|
||||
| `Lv` | LV |
|
||||
| `Lb` | LB |
|
||||
| `Ls` | LS |
|
||||
| `Lr` | LR |
|
||||
| `Ly` | LY |
|
||||
| `Li` | LI |
|
||||
| `Lt` | LT |
|
||||
| `Lu` | LU |
|
||||
| `Mo` | MO |
|
||||
| `Mg` | MG |
|
||||
| `Mw` | MW |
|
||||
| `My` | MY |
|
||||
| `Mv` | MV |
|
||||
| `Ml` | ML |
|
||||
| `Mt` | MT |
|
||||
| `Mh` | MH |
|
||||
| `Mq` | MQ |
|
||||
| `Mr` | MR |
|
||||
| `Mu` | MU |
|
||||
| `Yt` | YT |
|
||||
| `Mx` | MX |
|
||||
| `Fm` | FM |
|
||||
| `Md` | MD |
|
||||
| `Mc` | MC |
|
||||
| `Mn` | MN |
|
||||
| `Ms` | MS |
|
||||
| `Ma` | MA |
|
||||
| `Mz` | MZ |
|
||||
| `Mm` | MM |
|
||||
| `Na` | NA |
|
||||
| `Nr` | NR |
|
||||
| `Np` | NP |
|
||||
| `Nl` | NL |
|
||||
| `Nc` | NC |
|
||||
| `Nz` | NZ |
|
||||
| `Ni` | NI |
|
||||
| `Ne` | NE |
|
||||
| `Ng` | NG |
|
||||
| `Nu` | NU |
|
||||
| `Nf` | NF |
|
||||
| `Mk` | MK |
|
||||
| `Mp` | MP |
|
||||
| `No` | NO |
|
||||
| `Om` | OM |
|
||||
| `Pk` | PK |
|
||||
| `Pw` | PW |
|
||||
| `Ps` | PS |
|
||||
| `Pa` | PA |
|
||||
| `Pg` | PG |
|
||||
| `Py` | PY |
|
||||
| `Pe` | PE |
|
||||
| `Ph` | PH |
|
||||
| `Pn` | PN |
|
||||
| `Pl` | PL |
|
||||
| `Pt` | PT |
|
||||
| `Pr` | PR |
|
||||
| `Qa` | QA |
|
||||
| `Re` | RE |
|
||||
| `Ro` | RO |
|
||||
| `Ru` | RU |
|
||||
| `Rw` | RW |
|
||||
| `Sh` | SH |
|
||||
| `Kn` | KN |
|
||||
| `Lc` | LC |
|
||||
| `Pm` | PM |
|
||||
| `Vc` | VC |
|
||||
| `Ws` | WS |
|
||||
| `Sm` | SM |
|
||||
| `St` | ST |
|
||||
| `Sa` | SA |
|
||||
| `Sn` | SN |
|
||||
| `Sc` | SC |
|
||||
| `Sl` | SL |
|
||||
| `Sg` | SG |
|
||||
| `Sk` | SK |
|
||||
| `Si` | SI |
|
||||
| `Sb` | SB |
|
||||
| `So` | SO |
|
||||
| `Za` | ZA |
|
||||
| `Gs` | GS |
|
||||
| `Es` | ES |
|
||||
| `Lk` | LK |
|
||||
| `Sd` | SD |
|
||||
| `Sr` | SR |
|
||||
| `Sj` | SJ |
|
||||
| `Sz` | SZ |
|
||||
| `Se` | SE |
|
||||
| `Ch` | CH |
|
||||
| `Sy` | SY |
|
||||
| `Tw` | TW |
|
||||
| `Tj` | TJ |
|
||||
| `Tz` | TZ |
|
||||
| `Th` | TH |
|
||||
| `Tl` | TL |
|
||||
| `Tg` | TG |
|
||||
| `Tk` | TK |
|
||||
| `To` | TO |
|
||||
| `Tt` | TT |
|
||||
| `Tn` | TN |
|
||||
| `Tr` | TR |
|
||||
| `Tm` | TM |
|
||||
| `Tc` | TC |
|
||||
| `Tv` | TV |
|
||||
| `Ug` | UG |
|
||||
| `Ua` | UA |
|
||||
| `Ae` | AE |
|
||||
| `Gb` | GB |
|
||||
| `Us` | US |
|
||||
| `Um` | UM |
|
||||
| `Uy` | UY |
|
||||
| `Uz` | UZ |
|
||||
| `Vu` | VU |
|
||||
| `Ve` | VE |
|
||||
| `Vn` | VN |
|
||||
| `Vg` | VG |
|
||||
| `Vi` | VI |
|
||||
| `Wf` | WF |
|
||||
| `Eh` | EH |
|
||||
| `Ye` | YE |
|
||||
| `Zm` | ZM |
|
||||
| `Zw` | ZW |
|
||||
| `Ax` | AX |
|
||||
| `Bq` | BQ |
|
||||
| `Cw` | CW |
|
||||
| `Gg` | GG |
|
||||
| `Im` | IM |
|
||||
| `Je` | JE |
|
||||
| `Me` | ME |
|
||||
| `Bl` | BL |
|
||||
| `Mf` | MF |
|
||||
| `Rs` | RS |
|
||||
| `Sx` | SX |
|
||||
| `Ss` | SS |
|
||||
| `Xk` | XK |
|
||||
@@ -0,0 +1,15 @@
|
||||
# GetCountryAnalyticsQueryParamInterval
|
||||
|
||||
The interval to retrieve analytics for.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `Oneh` | 1h |
|
||||
| `TwentyFourh` | 24h |
|
||||
| `Sevend` | 7d |
|
||||
| `Thirtyd` | 30d |
|
||||
| `Ninetyd` | 90d |
|
||||
| `All` | all |
|
||||
19
docs/models/operations/getcountryanalyticsrequest.md
Normal file
19
docs/models/operations/getcountryanalyticsrequest.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# GetCountryAnalyticsRequest
|
||||
|
||||
|
||||
## 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. |
|
||||
@@ -0,0 +1,9 @@
|
||||
# GetCountryAnalyticsResponseBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
||||
| `country` | [operations.GetCountryAnalyticsCountry](../../models/operations/getcountryanalyticscountry.md) | :heavy_check_mark: | The 2-letter country code: https://d.to/geo |
|
||||
| `clicks` | *number* | :heavy_check_mark: | The number of clicks from this country |
|
||||
259
docs/models/operations/getdeviceanalyticsqueryparamcountry.md
Normal file
259
docs/models/operations/getdeviceanalyticsqueryparamcountry.md
Normal file
@@ -0,0 +1,259 @@
|
||||
# GetDeviceAnalyticsQueryParamCountry
|
||||
|
||||
The country to retrieve analytics for.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----- | ----- |
|
||||
| `Af` | AF |
|
||||
| `Al` | AL |
|
||||
| `Dz` | DZ |
|
||||
| `As` | AS |
|
||||
| `Ad` | AD |
|
||||
| `Ao` | AO |
|
||||
| `Ai` | AI |
|
||||
| `Aq` | AQ |
|
||||
| `Ag` | AG |
|
||||
| `Ar` | AR |
|
||||
| `Am` | AM |
|
||||
| `Aw` | AW |
|
||||
| `Au` | AU |
|
||||
| `At` | AT |
|
||||
| `Az` | AZ |
|
||||
| `Bs` | BS |
|
||||
| `Bh` | BH |
|
||||
| `Bd` | BD |
|
||||
| `Bb` | BB |
|
||||
| `By` | BY |
|
||||
| `Be` | BE |
|
||||
| `Bz` | BZ |
|
||||
| `Bj` | BJ |
|
||||
| `Bm` | BM |
|
||||
| `Bt` | BT |
|
||||
| `Bo` | BO |
|
||||
| `Ba` | BA |
|
||||
| `Bw` | BW |
|
||||
| `Bv` | BV |
|
||||
| `Br` | BR |
|
||||
| `Io` | IO |
|
||||
| `Bn` | BN |
|
||||
| `Bg` | BG |
|
||||
| `Bf` | BF |
|
||||
| `Bi` | BI |
|
||||
| `Kh` | KH |
|
||||
| `Cm` | CM |
|
||||
| `Ca` | CA |
|
||||
| `Cv` | CV |
|
||||
| `Ky` | KY |
|
||||
| `Cf` | CF |
|
||||
| `Td` | TD |
|
||||
| `Cl` | CL |
|
||||
| `Cn` | CN |
|
||||
| `Cx` | CX |
|
||||
| `Cc` | CC |
|
||||
| `Co` | CO |
|
||||
| `Km` | KM |
|
||||
| `Cg` | CG |
|
||||
| `Cd` | CD |
|
||||
| `Ck` | CK |
|
||||
| `Cr` | CR |
|
||||
| `Ci` | CI |
|
||||
| `Hr` | HR |
|
||||
| `Cu` | CU |
|
||||
| `Cy` | CY |
|
||||
| `Cz` | CZ |
|
||||
| `Dk` | DK |
|
||||
| `Dj` | DJ |
|
||||
| `Dm` | DM |
|
||||
| `Do` | DO |
|
||||
| `Ec` | EC |
|
||||
| `Eg` | EG |
|
||||
| `Sv` | SV |
|
||||
| `Gq` | GQ |
|
||||
| `Er` | ER |
|
||||
| `Ee` | EE |
|
||||
| `Et` | ET |
|
||||
| `Fk` | FK |
|
||||
| `Fo` | FO |
|
||||
| `Fj` | FJ |
|
||||
| `Fi` | FI |
|
||||
| `Fr` | FR |
|
||||
| `Gf` | GF |
|
||||
| `Pf` | PF |
|
||||
| `Tf` | TF |
|
||||
| `Ga` | GA |
|
||||
| `Gm` | GM |
|
||||
| `Ge` | GE |
|
||||
| `De` | DE |
|
||||
| `Gh` | GH |
|
||||
| `Gi` | GI |
|
||||
| `Gr` | GR |
|
||||
| `Gl` | GL |
|
||||
| `Gd` | GD |
|
||||
| `Gp` | GP |
|
||||
| `Gu` | GU |
|
||||
| `Gt` | GT |
|
||||
| `Gn` | GN |
|
||||
| `Gw` | GW |
|
||||
| `Gy` | GY |
|
||||
| `Ht` | HT |
|
||||
| `Hm` | HM |
|
||||
| `Va` | VA |
|
||||
| `Hn` | HN |
|
||||
| `Hk` | HK |
|
||||
| `Hu` | HU |
|
||||
| `Is` | IS |
|
||||
| `In` | IN |
|
||||
| `Id` | ID |
|
||||
| `Ir` | IR |
|
||||
| `Iq` | IQ |
|
||||
| `Ie` | IE |
|
||||
| `Il` | IL |
|
||||
| `It` | IT |
|
||||
| `Jm` | JM |
|
||||
| `Jp` | JP |
|
||||
| `Jo` | JO |
|
||||
| `Kz` | KZ |
|
||||
| `Ke` | KE |
|
||||
| `Ki` | KI |
|
||||
| `Kp` | KP |
|
||||
| `Kr` | KR |
|
||||
| `Kw` | KW |
|
||||
| `Kg` | KG |
|
||||
| `La` | LA |
|
||||
| `Lv` | LV |
|
||||
| `Lb` | LB |
|
||||
| `Ls` | LS |
|
||||
| `Lr` | LR |
|
||||
| `Ly` | LY |
|
||||
| `Li` | LI |
|
||||
| `Lt` | LT |
|
||||
| `Lu` | LU |
|
||||
| `Mo` | MO |
|
||||
| `Mg` | MG |
|
||||
| `Mw` | MW |
|
||||
| `My` | MY |
|
||||
| `Mv` | MV |
|
||||
| `Ml` | ML |
|
||||
| `Mt` | MT |
|
||||
| `Mh` | MH |
|
||||
| `Mq` | MQ |
|
||||
| `Mr` | MR |
|
||||
| `Mu` | MU |
|
||||
| `Yt` | YT |
|
||||
| `Mx` | MX |
|
||||
| `Fm` | FM |
|
||||
| `Md` | MD |
|
||||
| `Mc` | MC |
|
||||
| `Mn` | MN |
|
||||
| `Ms` | MS |
|
||||
| `Ma` | MA |
|
||||
| `Mz` | MZ |
|
||||
| `Mm` | MM |
|
||||
| `Na` | NA |
|
||||
| `Nr` | NR |
|
||||
| `Np` | NP |
|
||||
| `Nl` | NL |
|
||||
| `Nc` | NC |
|
||||
| `Nz` | NZ |
|
||||
| `Ni` | NI |
|
||||
| `Ne` | NE |
|
||||
| `Ng` | NG |
|
||||
| `Nu` | NU |
|
||||
| `Nf` | NF |
|
||||
| `Mk` | MK |
|
||||
| `Mp` | MP |
|
||||
| `No` | NO |
|
||||
| `Om` | OM |
|
||||
| `Pk` | PK |
|
||||
| `Pw` | PW |
|
||||
| `Ps` | PS |
|
||||
| `Pa` | PA |
|
||||
| `Pg` | PG |
|
||||
| `Py` | PY |
|
||||
| `Pe` | PE |
|
||||
| `Ph` | PH |
|
||||
| `Pn` | PN |
|
||||
| `Pl` | PL |
|
||||
| `Pt` | PT |
|
||||
| `Pr` | PR |
|
||||
| `Qa` | QA |
|
||||
| `Re` | RE |
|
||||
| `Ro` | RO |
|
||||
| `Ru` | RU |
|
||||
| `Rw` | RW |
|
||||
| `Sh` | SH |
|
||||
| `Kn` | KN |
|
||||
| `Lc` | LC |
|
||||
| `Pm` | PM |
|
||||
| `Vc` | VC |
|
||||
| `Ws` | WS |
|
||||
| `Sm` | SM |
|
||||
| `St` | ST |
|
||||
| `Sa` | SA |
|
||||
| `Sn` | SN |
|
||||
| `Sc` | SC |
|
||||
| `Sl` | SL |
|
||||
| `Sg` | SG |
|
||||
| `Sk` | SK |
|
||||
| `Si` | SI |
|
||||
| `Sb` | SB |
|
||||
| `So` | SO |
|
||||
| `Za` | ZA |
|
||||
| `Gs` | GS |
|
||||
| `Es` | ES |
|
||||
| `Lk` | LK |
|
||||
| `Sd` | SD |
|
||||
| `Sr` | SR |
|
||||
| `Sj` | SJ |
|
||||
| `Sz` | SZ |
|
||||
| `Se` | SE |
|
||||
| `Ch` | CH |
|
||||
| `Sy` | SY |
|
||||
| `Tw` | TW |
|
||||
| `Tj` | TJ |
|
||||
| `Tz` | TZ |
|
||||
| `Th` | TH |
|
||||
| `Tl` | TL |
|
||||
| `Tg` | TG |
|
||||
| `Tk` | TK |
|
||||
| `To` | TO |
|
||||
| `Tt` | TT |
|
||||
| `Tn` | TN |
|
||||
| `Tr` | TR |
|
||||
| `Tm` | TM |
|
||||
| `Tc` | TC |
|
||||
| `Tv` | TV |
|
||||
| `Ug` | UG |
|
||||
| `Ua` | UA |
|
||||
| `Ae` | AE |
|
||||
| `Gb` | GB |
|
||||
| `Us` | US |
|
||||
| `Um` | UM |
|
||||
| `Uy` | UY |
|
||||
| `Uz` | UZ |
|
||||
| `Vu` | VU |
|
||||
| `Ve` | VE |
|
||||
| `Vn` | VN |
|
||||
| `Vg` | VG |
|
||||
| `Vi` | VI |
|
||||
| `Wf` | WF |
|
||||
| `Eh` | EH |
|
||||
| `Ye` | YE |
|
||||
| `Zm` | ZM |
|
||||
| `Zw` | ZW |
|
||||
| `Ax` | AX |
|
||||
| `Bq` | BQ |
|
||||
| `Cw` | CW |
|
||||
| `Gg` | GG |
|
||||
| `Im` | IM |
|
||||
| `Je` | JE |
|
||||
| `Me` | ME |
|
||||
| `Bl` | BL |
|
||||
| `Mf` | MF |
|
||||
| `Rs` | RS |
|
||||
| `Sx` | SX |
|
||||
| `Ss` | SS |
|
||||
| `Xk` | XK |
|
||||
@@ -0,0 +1,15 @@
|
||||
# GetDeviceAnalyticsQueryParamInterval
|
||||
|
||||
The interval to retrieve analytics for.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `Oneh` | 1h |
|
||||
| `TwentyFourh` | 24h |
|
||||
| `Sevend` | 7d |
|
||||
| `Thirtyd` | 30d |
|
||||
| `Ninetyd` | 90d |
|
||||
| `All` | all |
|
||||
19
docs/models/operations/getdeviceanalyticsrequest.md
Normal file
19
docs/models/operations/getdeviceanalyticsrequest.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# GetDeviceAnalyticsRequest
|
||||
|
||||
|
||||
## 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. |
|
||||
9
docs/models/operations/getdeviceanalyticsresponsebody.md
Normal file
9
docs/models/operations/getdeviceanalyticsresponsebody.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# GetDeviceAnalyticsResponseBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- |
|
||||
| `device` | *string* | :heavy_check_mark: | The name of the device |
|
||||
| `clicks` | *number* | :heavy_check_mark: | The number of clicks from this device |
|
||||
9
docs/models/operations/getlinkinforequest.md
Normal file
9
docs/models/operations/getlinkinforequest.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# GetLinkInfoRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `domain` | *string* | :heavy_check_mark: | N/A |
|
||||
| `key` | *string* | :heavy_check_mark: | The key of the link to retrieve. E.g. for `d.to/github`, the key is `github`. |
|
||||
4
docs/models/operations/getlinkscountqueryparamtagids.md
Normal file
4
docs/models/operations/getlinkscountqueryparamtagids.md
Normal file
@@ -0,0 +1,4 @@
|
||||
# GetLinksCountQueryParamTagIds
|
||||
|
||||
The tag IDs to filter the links by.
|
||||
|
||||
15
docs/models/operations/getlinkscountrequest.md
Normal file
15
docs/models/operations/getlinkscountrequest.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# GetLinksCountRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `domain` | *string* | :heavy_minus_sign: | The domain to filter the links by. E.g. `ac.me`. If not provided, all links for the workspace will be returned. |
|
||||
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to filter the links by. This field is deprecated – use `tagIds` instead. |
|
||||
| `tagIds` | *operations.GetLinksCountQueryParamTagIds* | :heavy_minus_sign: | The tag IDs to filter the links by. |
|
||||
| `search` | *string* | :heavy_minus_sign: | The search term to filter the links by. The search term will be matched against the short link slug and the destination url. |
|
||||
| `userId` | *string* | :heavy_minus_sign: | The user ID to filter the links by. |
|
||||
| `showArchived` | *boolean* | :heavy_minus_sign: | Whether to include archived links in the response. Defaults to `false` if not provided. |
|
||||
| `withTags` | *boolean* | :heavy_minus_sign: | Whether to include tags in the response. Defaults to `false` if not provided. |
|
||||
| `groupBy` | *operations.GroupBy* | :heavy_minus_sign: | The field to group the links by. |
|
||||
16
docs/models/operations/getlinksrequest.md
Normal file
16
docs/models/operations/getlinksrequest.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# GetLinksRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `domain` | *string* | :heavy_minus_sign: | The domain to filter the links by. E.g. `ac.me`. If not provided, all links for the workspace will be returned. |
|
||||
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to filter the links by. This field is deprecated – use `tagIds` instead. |
|
||||
| `tagIds` | *operations.QueryParamTagIds* | :heavy_minus_sign: | The tag IDs to filter the links by. |
|
||||
| `search` | *string* | :heavy_minus_sign: | The search term to filter the links by. The search term will be matched against the short link slug and the destination url. |
|
||||
| `userId` | *string* | :heavy_minus_sign: | The user ID to filter the links by. |
|
||||
| `showArchived` | *boolean* | :heavy_minus_sign: | Whether to include archived links in the response. Defaults to `false` if not provided. |
|
||||
| `withTags` | *boolean* | :heavy_minus_sign: | Whether to include tags in the response. Defaults to `false` if not provided. |
|
||||
| `sort` | [operations.Sort](../../models/operations/sort.md) | :heavy_minus_sign: | The field to sort the links by. The default is `createdAt`, and sort order is always descending. |
|
||||
| `page` | *number* | :heavy_minus_sign: | The page number for pagination (each page contains 100 links). |
|
||||
8
docs/models/operations/getmetatagsrequest.md
Normal file
8
docs/models/operations/getmetatagsrequest.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetMetatagsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `url` | *string* | :heavy_check_mark: | N/A |
|
||||
12
docs/models/operations/getmetatagsresponsebody.md
Normal file
12
docs/models/operations/getmetatagsresponsebody.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# GetMetatagsResponseBody
|
||||
|
||||
The retrieved metatags
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
|
||||
| `title` | *string* | :heavy_minus_sign: | The meta title tag for the URL |
|
||||
| `description` | *string* | :heavy_minus_sign: | The meta description tag for the URL |
|
||||
| `image` | *string* | :heavy_minus_sign: | The OpenGraph image for the URL |
|
||||
259
docs/models/operations/getosanalyticsqueryparamcountry.md
Normal file
259
docs/models/operations/getosanalyticsqueryparamcountry.md
Normal file
@@ -0,0 +1,259 @@
|
||||
# GetOSAnalyticsQueryParamCountry
|
||||
|
||||
The country to retrieve analytics for.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----- | ----- |
|
||||
| `Af` | AF |
|
||||
| `Al` | AL |
|
||||
| `Dz` | DZ |
|
||||
| `As` | AS |
|
||||
| `Ad` | AD |
|
||||
| `Ao` | AO |
|
||||
| `Ai` | AI |
|
||||
| `Aq` | AQ |
|
||||
| `Ag` | AG |
|
||||
| `Ar` | AR |
|
||||
| `Am` | AM |
|
||||
| `Aw` | AW |
|
||||
| `Au` | AU |
|
||||
| `At` | AT |
|
||||
| `Az` | AZ |
|
||||
| `Bs` | BS |
|
||||
| `Bh` | BH |
|
||||
| `Bd` | BD |
|
||||
| `Bb` | BB |
|
||||
| `By` | BY |
|
||||
| `Be` | BE |
|
||||
| `Bz` | BZ |
|
||||
| `Bj` | BJ |
|
||||
| `Bm` | BM |
|
||||
| `Bt` | BT |
|
||||
| `Bo` | BO |
|
||||
| `Ba` | BA |
|
||||
| `Bw` | BW |
|
||||
| `Bv` | BV |
|
||||
| `Br` | BR |
|
||||
| `Io` | IO |
|
||||
| `Bn` | BN |
|
||||
| `Bg` | BG |
|
||||
| `Bf` | BF |
|
||||
| `Bi` | BI |
|
||||
| `Kh` | KH |
|
||||
| `Cm` | CM |
|
||||
| `Ca` | CA |
|
||||
| `Cv` | CV |
|
||||
| `Ky` | KY |
|
||||
| `Cf` | CF |
|
||||
| `Td` | TD |
|
||||
| `Cl` | CL |
|
||||
| `Cn` | CN |
|
||||
| `Cx` | CX |
|
||||
| `Cc` | CC |
|
||||
| `Co` | CO |
|
||||
| `Km` | KM |
|
||||
| `Cg` | CG |
|
||||
| `Cd` | CD |
|
||||
| `Ck` | CK |
|
||||
| `Cr` | CR |
|
||||
| `Ci` | CI |
|
||||
| `Hr` | HR |
|
||||
| `Cu` | CU |
|
||||
| `Cy` | CY |
|
||||
| `Cz` | CZ |
|
||||
| `Dk` | DK |
|
||||
| `Dj` | DJ |
|
||||
| `Dm` | DM |
|
||||
| `Do` | DO |
|
||||
| `Ec` | EC |
|
||||
| `Eg` | EG |
|
||||
| `Sv` | SV |
|
||||
| `Gq` | GQ |
|
||||
| `Er` | ER |
|
||||
| `Ee` | EE |
|
||||
| `Et` | ET |
|
||||
| `Fk` | FK |
|
||||
| `Fo` | FO |
|
||||
| `Fj` | FJ |
|
||||
| `Fi` | FI |
|
||||
| `Fr` | FR |
|
||||
| `Gf` | GF |
|
||||
| `Pf` | PF |
|
||||
| `Tf` | TF |
|
||||
| `Ga` | GA |
|
||||
| `Gm` | GM |
|
||||
| `Ge` | GE |
|
||||
| `De` | DE |
|
||||
| `Gh` | GH |
|
||||
| `Gi` | GI |
|
||||
| `Gr` | GR |
|
||||
| `Gl` | GL |
|
||||
| `Gd` | GD |
|
||||
| `Gp` | GP |
|
||||
| `Gu` | GU |
|
||||
| `Gt` | GT |
|
||||
| `Gn` | GN |
|
||||
| `Gw` | GW |
|
||||
| `Gy` | GY |
|
||||
| `Ht` | HT |
|
||||
| `Hm` | HM |
|
||||
| `Va` | VA |
|
||||
| `Hn` | HN |
|
||||
| `Hk` | HK |
|
||||
| `Hu` | HU |
|
||||
| `Is` | IS |
|
||||
| `In` | IN |
|
||||
| `Id` | ID |
|
||||
| `Ir` | IR |
|
||||
| `Iq` | IQ |
|
||||
| `Ie` | IE |
|
||||
| `Il` | IL |
|
||||
| `It` | IT |
|
||||
| `Jm` | JM |
|
||||
| `Jp` | JP |
|
||||
| `Jo` | JO |
|
||||
| `Kz` | KZ |
|
||||
| `Ke` | KE |
|
||||
| `Ki` | KI |
|
||||
| `Kp` | KP |
|
||||
| `Kr` | KR |
|
||||
| `Kw` | KW |
|
||||
| `Kg` | KG |
|
||||
| `La` | LA |
|
||||
| `Lv` | LV |
|
||||
| `Lb` | LB |
|
||||
| `Ls` | LS |
|
||||
| `Lr` | LR |
|
||||
| `Ly` | LY |
|
||||
| `Li` | LI |
|
||||
| `Lt` | LT |
|
||||
| `Lu` | LU |
|
||||
| `Mo` | MO |
|
||||
| `Mg` | MG |
|
||||
| `Mw` | MW |
|
||||
| `My` | MY |
|
||||
| `Mv` | MV |
|
||||
| `Ml` | ML |
|
||||
| `Mt` | MT |
|
||||
| `Mh` | MH |
|
||||
| `Mq` | MQ |
|
||||
| `Mr` | MR |
|
||||
| `Mu` | MU |
|
||||
| `Yt` | YT |
|
||||
| `Mx` | MX |
|
||||
| `Fm` | FM |
|
||||
| `Md` | MD |
|
||||
| `Mc` | MC |
|
||||
| `Mn` | MN |
|
||||
| `Ms` | MS |
|
||||
| `Ma` | MA |
|
||||
| `Mz` | MZ |
|
||||
| `Mm` | MM |
|
||||
| `Na` | NA |
|
||||
| `Nr` | NR |
|
||||
| `Np` | NP |
|
||||
| `Nl` | NL |
|
||||
| `Nc` | NC |
|
||||
| `Nz` | NZ |
|
||||
| `Ni` | NI |
|
||||
| `Ne` | NE |
|
||||
| `Ng` | NG |
|
||||
| `Nu` | NU |
|
||||
| `Nf` | NF |
|
||||
| `Mk` | MK |
|
||||
| `Mp` | MP |
|
||||
| `No` | NO |
|
||||
| `Om` | OM |
|
||||
| `Pk` | PK |
|
||||
| `Pw` | PW |
|
||||
| `Ps` | PS |
|
||||
| `Pa` | PA |
|
||||
| `Pg` | PG |
|
||||
| `Py` | PY |
|
||||
| `Pe` | PE |
|
||||
| `Ph` | PH |
|
||||
| `Pn` | PN |
|
||||
| `Pl` | PL |
|
||||
| `Pt` | PT |
|
||||
| `Pr` | PR |
|
||||
| `Qa` | QA |
|
||||
| `Re` | RE |
|
||||
| `Ro` | RO |
|
||||
| `Ru` | RU |
|
||||
| `Rw` | RW |
|
||||
| `Sh` | SH |
|
||||
| `Kn` | KN |
|
||||
| `Lc` | LC |
|
||||
| `Pm` | PM |
|
||||
| `Vc` | VC |
|
||||
| `Ws` | WS |
|
||||
| `Sm` | SM |
|
||||
| `St` | ST |
|
||||
| `Sa` | SA |
|
||||
| `Sn` | SN |
|
||||
| `Sc` | SC |
|
||||
| `Sl` | SL |
|
||||
| `Sg` | SG |
|
||||
| `Sk` | SK |
|
||||
| `Si` | SI |
|
||||
| `Sb` | SB |
|
||||
| `So` | SO |
|
||||
| `Za` | ZA |
|
||||
| `Gs` | GS |
|
||||
| `Es` | ES |
|
||||
| `Lk` | LK |
|
||||
| `Sd` | SD |
|
||||
| `Sr` | SR |
|
||||
| `Sj` | SJ |
|
||||
| `Sz` | SZ |
|
||||
| `Se` | SE |
|
||||
| `Ch` | CH |
|
||||
| `Sy` | SY |
|
||||
| `Tw` | TW |
|
||||
| `Tj` | TJ |
|
||||
| `Tz` | TZ |
|
||||
| `Th` | TH |
|
||||
| `Tl` | TL |
|
||||
| `Tg` | TG |
|
||||
| `Tk` | TK |
|
||||
| `To` | TO |
|
||||
| `Tt` | TT |
|
||||
| `Tn` | TN |
|
||||
| `Tr` | TR |
|
||||
| `Tm` | TM |
|
||||
| `Tc` | TC |
|
||||
| `Tv` | TV |
|
||||
| `Ug` | UG |
|
||||
| `Ua` | UA |
|
||||
| `Ae` | AE |
|
||||
| `Gb` | GB |
|
||||
| `Us` | US |
|
||||
| `Um` | UM |
|
||||
| `Uy` | UY |
|
||||
| `Uz` | UZ |
|
||||
| `Vu` | VU |
|
||||
| `Ve` | VE |
|
||||
| `Vn` | VN |
|
||||
| `Vg` | VG |
|
||||
| `Vi` | VI |
|
||||
| `Wf` | WF |
|
||||
| `Eh` | EH |
|
||||
| `Ye` | YE |
|
||||
| `Zm` | ZM |
|
||||
| `Zw` | ZW |
|
||||
| `Ax` | AX |
|
||||
| `Bq` | BQ |
|
||||
| `Cw` | CW |
|
||||
| `Gg` | GG |
|
||||
| `Im` | IM |
|
||||
| `Je` | JE |
|
||||
| `Me` | ME |
|
||||
| `Bl` | BL |
|
||||
| `Mf` | MF |
|
||||
| `Rs` | RS |
|
||||
| `Sx` | SX |
|
||||
| `Ss` | SS |
|
||||
| `Xk` | XK |
|
||||
15
docs/models/operations/getosanalyticsqueryparaminterval.md
Normal file
15
docs/models/operations/getosanalyticsqueryparaminterval.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# GetOSAnalyticsQueryParamInterval
|
||||
|
||||
The interval to retrieve analytics for.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `Oneh` | 1h |
|
||||
| `TwentyFourh` | 24h |
|
||||
| `Sevend` | 7d |
|
||||
| `Thirtyd` | 30d |
|
||||
| `Ninetyd` | 90d |
|
||||
| `All` | all |
|
||||
19
docs/models/operations/getosanalyticsrequest.md
Normal file
19
docs/models/operations/getosanalyticsrequest.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# GetOSAnalyticsRequest
|
||||
|
||||
|
||||
## 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. |
|
||||
9
docs/models/operations/getosanalyticsresponsebody.md
Normal file
9
docs/models/operations/getosanalyticsresponsebody.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# GetOSAnalyticsResponseBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
|
||||
| `os` | *string* | :heavy_check_mark: | The name of the OS |
|
||||
| `clicks` | *number* | :heavy_check_mark: | The number of clicks from this OS |
|
||||
13
docs/models/operations/getqrcoderequest.md
Normal file
13
docs/models/operations/getqrcoderequest.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# GetQRCodeRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| `url` | *string* | :heavy_minus_sign: | The URL to generate a QR code for. Defaults to `https://dub.co` if not provided. |
|
||||
| `size` | *number* | :heavy_minus_sign: | The size of the QR code in pixels. Defaults to `600` if not provided. |
|
||||
| `level` | [operations.Level](../../models/operations/level.md) | :heavy_minus_sign: | The level of error correction to use for the QR code. Defaults to `L` if not provided. |
|
||||
| `fgColor` | *string* | :heavy_minus_sign: | The foreground color of the QR code in hex format. Defaults to `#000000` if not provided. |
|
||||
| `bgColor` | *string* | :heavy_minus_sign: | The background color of the QR code in hex format. Defaults to `#ffffff` if not provided. |
|
||||
| `includeMargin` | *boolean* | :heavy_minus_sign: | Whether to include a margin around the QR code. Defaults to `false` if not provided. |
|
||||
259
docs/models/operations/getrefereranalyticsqueryparamcountry.md
Normal file
259
docs/models/operations/getrefereranalyticsqueryparamcountry.md
Normal file
@@ -0,0 +1,259 @@
|
||||
# GetRefererAnalyticsQueryParamCountry
|
||||
|
||||
The country to retrieve analytics for.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----- | ----- |
|
||||
| `Af` | AF |
|
||||
| `Al` | AL |
|
||||
| `Dz` | DZ |
|
||||
| `As` | AS |
|
||||
| `Ad` | AD |
|
||||
| `Ao` | AO |
|
||||
| `Ai` | AI |
|
||||
| `Aq` | AQ |
|
||||
| `Ag` | AG |
|
||||
| `Ar` | AR |
|
||||
| `Am` | AM |
|
||||
| `Aw` | AW |
|
||||
| `Au` | AU |
|
||||
| `At` | AT |
|
||||
| `Az` | AZ |
|
||||
| `Bs` | BS |
|
||||
| `Bh` | BH |
|
||||
| `Bd` | BD |
|
||||
| `Bb` | BB |
|
||||
| `By` | BY |
|
||||
| `Be` | BE |
|
||||
| `Bz` | BZ |
|
||||
| `Bj` | BJ |
|
||||
| `Bm` | BM |
|
||||
| `Bt` | BT |
|
||||
| `Bo` | BO |
|
||||
| `Ba` | BA |
|
||||
| `Bw` | BW |
|
||||
| `Bv` | BV |
|
||||
| `Br` | BR |
|
||||
| `Io` | IO |
|
||||
| `Bn` | BN |
|
||||
| `Bg` | BG |
|
||||
| `Bf` | BF |
|
||||
| `Bi` | BI |
|
||||
| `Kh` | KH |
|
||||
| `Cm` | CM |
|
||||
| `Ca` | CA |
|
||||
| `Cv` | CV |
|
||||
| `Ky` | KY |
|
||||
| `Cf` | CF |
|
||||
| `Td` | TD |
|
||||
| `Cl` | CL |
|
||||
| `Cn` | CN |
|
||||
| `Cx` | CX |
|
||||
| `Cc` | CC |
|
||||
| `Co` | CO |
|
||||
| `Km` | KM |
|
||||
| `Cg` | CG |
|
||||
| `Cd` | CD |
|
||||
| `Ck` | CK |
|
||||
| `Cr` | CR |
|
||||
| `Ci` | CI |
|
||||
| `Hr` | HR |
|
||||
| `Cu` | CU |
|
||||
| `Cy` | CY |
|
||||
| `Cz` | CZ |
|
||||
| `Dk` | DK |
|
||||
| `Dj` | DJ |
|
||||
| `Dm` | DM |
|
||||
| `Do` | DO |
|
||||
| `Ec` | EC |
|
||||
| `Eg` | EG |
|
||||
| `Sv` | SV |
|
||||
| `Gq` | GQ |
|
||||
| `Er` | ER |
|
||||
| `Ee` | EE |
|
||||
| `Et` | ET |
|
||||
| `Fk` | FK |
|
||||
| `Fo` | FO |
|
||||
| `Fj` | FJ |
|
||||
| `Fi` | FI |
|
||||
| `Fr` | FR |
|
||||
| `Gf` | GF |
|
||||
| `Pf` | PF |
|
||||
| `Tf` | TF |
|
||||
| `Ga` | GA |
|
||||
| `Gm` | GM |
|
||||
| `Ge` | GE |
|
||||
| `De` | DE |
|
||||
| `Gh` | GH |
|
||||
| `Gi` | GI |
|
||||
| `Gr` | GR |
|
||||
| `Gl` | GL |
|
||||
| `Gd` | GD |
|
||||
| `Gp` | GP |
|
||||
| `Gu` | GU |
|
||||
| `Gt` | GT |
|
||||
| `Gn` | GN |
|
||||
| `Gw` | GW |
|
||||
| `Gy` | GY |
|
||||
| `Ht` | HT |
|
||||
| `Hm` | HM |
|
||||
| `Va` | VA |
|
||||
| `Hn` | HN |
|
||||
| `Hk` | HK |
|
||||
| `Hu` | HU |
|
||||
| `Is` | IS |
|
||||
| `In` | IN |
|
||||
| `Id` | ID |
|
||||
| `Ir` | IR |
|
||||
| `Iq` | IQ |
|
||||
| `Ie` | IE |
|
||||
| `Il` | IL |
|
||||
| `It` | IT |
|
||||
| `Jm` | JM |
|
||||
| `Jp` | JP |
|
||||
| `Jo` | JO |
|
||||
| `Kz` | KZ |
|
||||
| `Ke` | KE |
|
||||
| `Ki` | KI |
|
||||
| `Kp` | KP |
|
||||
| `Kr` | KR |
|
||||
| `Kw` | KW |
|
||||
| `Kg` | KG |
|
||||
| `La` | LA |
|
||||
| `Lv` | LV |
|
||||
| `Lb` | LB |
|
||||
| `Ls` | LS |
|
||||
| `Lr` | LR |
|
||||
| `Ly` | LY |
|
||||
| `Li` | LI |
|
||||
| `Lt` | LT |
|
||||
| `Lu` | LU |
|
||||
| `Mo` | MO |
|
||||
| `Mg` | MG |
|
||||
| `Mw` | MW |
|
||||
| `My` | MY |
|
||||
| `Mv` | MV |
|
||||
| `Ml` | ML |
|
||||
| `Mt` | MT |
|
||||
| `Mh` | MH |
|
||||
| `Mq` | MQ |
|
||||
| `Mr` | MR |
|
||||
| `Mu` | MU |
|
||||
| `Yt` | YT |
|
||||
| `Mx` | MX |
|
||||
| `Fm` | FM |
|
||||
| `Md` | MD |
|
||||
| `Mc` | MC |
|
||||
| `Mn` | MN |
|
||||
| `Ms` | MS |
|
||||
| `Ma` | MA |
|
||||
| `Mz` | MZ |
|
||||
| `Mm` | MM |
|
||||
| `Na` | NA |
|
||||
| `Nr` | NR |
|
||||
| `Np` | NP |
|
||||
| `Nl` | NL |
|
||||
| `Nc` | NC |
|
||||
| `Nz` | NZ |
|
||||
| `Ni` | NI |
|
||||
| `Ne` | NE |
|
||||
| `Ng` | NG |
|
||||
| `Nu` | NU |
|
||||
| `Nf` | NF |
|
||||
| `Mk` | MK |
|
||||
| `Mp` | MP |
|
||||
| `No` | NO |
|
||||
| `Om` | OM |
|
||||
| `Pk` | PK |
|
||||
| `Pw` | PW |
|
||||
| `Ps` | PS |
|
||||
| `Pa` | PA |
|
||||
| `Pg` | PG |
|
||||
| `Py` | PY |
|
||||
| `Pe` | PE |
|
||||
| `Ph` | PH |
|
||||
| `Pn` | PN |
|
||||
| `Pl` | PL |
|
||||
| `Pt` | PT |
|
||||
| `Pr` | PR |
|
||||
| `Qa` | QA |
|
||||
| `Re` | RE |
|
||||
| `Ro` | RO |
|
||||
| `Ru` | RU |
|
||||
| `Rw` | RW |
|
||||
| `Sh` | SH |
|
||||
| `Kn` | KN |
|
||||
| `Lc` | LC |
|
||||
| `Pm` | PM |
|
||||
| `Vc` | VC |
|
||||
| `Ws` | WS |
|
||||
| `Sm` | SM |
|
||||
| `St` | ST |
|
||||
| `Sa` | SA |
|
||||
| `Sn` | SN |
|
||||
| `Sc` | SC |
|
||||
| `Sl` | SL |
|
||||
| `Sg` | SG |
|
||||
| `Sk` | SK |
|
||||
| `Si` | SI |
|
||||
| `Sb` | SB |
|
||||
| `So` | SO |
|
||||
| `Za` | ZA |
|
||||
| `Gs` | GS |
|
||||
| `Es` | ES |
|
||||
| `Lk` | LK |
|
||||
| `Sd` | SD |
|
||||
| `Sr` | SR |
|
||||
| `Sj` | SJ |
|
||||
| `Sz` | SZ |
|
||||
| `Se` | SE |
|
||||
| `Ch` | CH |
|
||||
| `Sy` | SY |
|
||||
| `Tw` | TW |
|
||||
| `Tj` | TJ |
|
||||
| `Tz` | TZ |
|
||||
| `Th` | TH |
|
||||
| `Tl` | TL |
|
||||
| `Tg` | TG |
|
||||
| `Tk` | TK |
|
||||
| `To` | TO |
|
||||
| `Tt` | TT |
|
||||
| `Tn` | TN |
|
||||
| `Tr` | TR |
|
||||
| `Tm` | TM |
|
||||
| `Tc` | TC |
|
||||
| `Tv` | TV |
|
||||
| `Ug` | UG |
|
||||
| `Ua` | UA |
|
||||
| `Ae` | AE |
|
||||
| `Gb` | GB |
|
||||
| `Us` | US |
|
||||
| `Um` | UM |
|
||||
| `Uy` | UY |
|
||||
| `Uz` | UZ |
|
||||
| `Vu` | VU |
|
||||
| `Ve` | VE |
|
||||
| `Vn` | VN |
|
||||
| `Vg` | VG |
|
||||
| `Vi` | VI |
|
||||
| `Wf` | WF |
|
||||
| `Eh` | EH |
|
||||
| `Ye` | YE |
|
||||
| `Zm` | ZM |
|
||||
| `Zw` | ZW |
|
||||
| `Ax` | AX |
|
||||
| `Bq` | BQ |
|
||||
| `Cw` | CW |
|
||||
| `Gg` | GG |
|
||||
| `Im` | IM |
|
||||
| `Je` | JE |
|
||||
| `Me` | ME |
|
||||
| `Bl` | BL |
|
||||
| `Mf` | MF |
|
||||
| `Rs` | RS |
|
||||
| `Sx` | SX |
|
||||
| `Ss` | SS |
|
||||
| `Xk` | XK |
|
||||
@@ -0,0 +1,15 @@
|
||||
# GetRefererAnalyticsQueryParamInterval
|
||||
|
||||
The interval to retrieve analytics for.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `Oneh` | 1h |
|
||||
| `TwentyFourh` | 24h |
|
||||
| `Sevend` | 7d |
|
||||
| `Thirtyd` | 30d |
|
||||
| `Ninetyd` | 90d |
|
||||
| `All` | all |
|
||||
19
docs/models/operations/getrefereranalyticsrequest.md
Normal file
19
docs/models/operations/getrefereranalyticsrequest.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# GetRefererAnalyticsRequest
|
||||
|
||||
|
||||
## 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. |
|
||||
@@ -0,0 +1,9 @@
|
||||
# GetRefererAnalyticsResponseBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||
| `referer` | *string* | :heavy_check_mark: | The name of the referer. If unknown, this will be `(direct)` |
|
||||
| `clicks` | *number* | :heavy_check_mark: | The number of clicks from this referer |
|
||||
7
docs/models/operations/gettagsrequest.md
Normal file
7
docs/models/operations/gettagsrequest.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# GetTagsRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user