dub 0.10.0 → 0.20.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/sdk_generation.yaml +26 -0
- package/.github/workflows/sdk_publish.yaml +15 -0
- package/.speakeasy/gen.lock +205 -0
- package/.speakeasy/gen.yaml +37 -0
- package/.speakeasy/workflow.yaml +12 -0
- package/README.md +292 -182
- package/docs/sdks/analytics/README.md +535 -0
- package/docs/sdks/dub/README.md +9 -0
- package/docs/sdks/links/README.md +415 -0
- package/docs/sdks/qrcodes/README.md +58 -0
- package/docs/sdks/tags/README.md +113 -0
- package/docs/sdks/workspaces/README.md +168 -0
- package/hooks/hooks.d.ts +20 -0
- package/hooks/hooks.d.ts.map +1 -0
- package/hooks/hooks.js +55 -0
- package/hooks/hooks.js.map +1 -0
- package/hooks/index.d.ts +3 -0
- package/hooks/index.d.ts.map +1 -0
- package/{_shims/auto/runtime-bun.js → hooks/index.js} +6 -5
- package/hooks/index.js.map +1 -0
- package/hooks/types.d.ts +59 -0
- package/hooks/types.d.ts.map +1 -0
- package/hooks/types.js +6 -0
- package/hooks/types.js.map +1 -0
- package/index.d.ts +4 -125
- package/index.d.ts.map +1 -1
- package/index.js +10 -103
- package/index.js.map +1 -1
- package/lib/base64.d.ts +10 -0
- package/lib/base64.d.ts.map +1 -0
- package/lib/base64.js +61 -0
- package/lib/base64.js.map +1 -0
- package/lib/config.d.ts +39 -0
- package/lib/config.d.ts.map +1 -0
- package/lib/config.js +39 -0
- package/lib/config.js.map +1 -0
- package/lib/encodings.d.ts +39 -0
- package/lib/encodings.d.ts.map +1 -0
- package/lib/encodings.js +311 -0
- package/lib/encodings.js.map +1 -0
- package/lib/http.d.ts +46 -0
- package/lib/http.d.ts.map +1 -0
- package/lib/http.js +143 -0
- package/lib/http.js.map +1 -0
- package/lib/retries.d.ts +18 -0
- package/lib/retries.d.ts.map +1 -0
- package/lib/retries.js +157 -0
- package/lib/retries.js.map +1 -0
- package/lib/schemas.d.ts +7 -0
- package/lib/schemas.d.ts.map +1 -0
- package/{shims/web.js → lib/schemas.js} +24 -6
- package/lib/schemas.js.map +1 -0
- package/lib/sdks.d.ts +39 -0
- package/lib/sdks.d.ts.map +1 -0
- package/lib/sdks.js +98 -0
- package/lib/sdks.js.map +1 -0
- package/lib/security.d.ts +57 -0
- package/lib/security.d.ts.map +1 -0
- package/lib/security.js +115 -0
- package/lib/security.js.map +1 -0
- package/lib/url.d.ts +4 -0
- package/lib/url.d.ts.map +1 -0
- package/lib/url.js +26 -0
- package/lib/url.js.map +1 -0
- package/models/components/index.d.ts +5 -0
- package/models/components/index.d.ts.map +1 -0
- package/{_shims/auto/runtime-node.js → models/components/index.js} +8 -5
- package/models/components/index.js.map +1 -0
- package/models/components/linkschema.d.ts +222 -0
- package/models/components/linkschema.d.ts.map +1 -0
- package/models/components/linkschema.js +189 -0
- package/models/components/linkschema.js.map +1 -0
- package/models/components/security.d.ts +16 -0
- package/models/components/security.d.ts.map +1 -0
- package/models/components/security.js +53 -0
- package/models/components/security.js.map +1 -0
- package/models/components/tagschema.d.ts +45 -0
- package/models/components/tagschema.d.ts.map +1 -0
- package/models/components/tagschema.js +76 -0
- package/models/components/tagschema.js.map +1 -0
- package/models/components/workspaceschema.d.ts +178 -0
- package/models/components/workspaceschema.d.ts.map +1 -0
- package/models/components/workspaceschema.js +190 -0
- package/models/components/workspaceschema.js.map +1 -0
- package/models/errors/badrequest.d.ts +65 -0
- package/models/errors/badrequest.d.ts.map +1 -0
- package/models/errors/badrequest.js +111 -0
- package/models/errors/badrequest.js.map +1 -0
- package/models/errors/conflict.d.ts +65 -0
- package/models/errors/conflict.d.ts.map +1 -0
- package/models/errors/conflict.js +111 -0
- package/models/errors/conflict.js.map +1 -0
- package/models/errors/forbidden.d.ts +65 -0
- package/models/errors/forbidden.d.ts.map +1 -0
- package/models/errors/forbidden.js +111 -0
- package/models/errors/forbidden.js.map +1 -0
- package/models/errors/index.d.ts +12 -0
- package/models/errors/index.d.ts.map +1 -0
- package/{_shims/auto/types-node.js → models/errors/index.js} +15 -5
- package/models/errors/index.js.map +1 -0
- package/models/errors/internalservererror.d.ts +65 -0
- package/models/errors/internalservererror.d.ts.map +1 -0
- package/models/errors/internalservererror.js +111 -0
- package/models/errors/internalservererror.js.map +1 -0
- package/models/errors/inviteexpired.d.ts +65 -0
- package/models/errors/inviteexpired.d.ts.map +1 -0
- package/models/errors/inviteexpired.js +111 -0
- package/models/errors/inviteexpired.js.map +1 -0
- package/models/errors/notfound.d.ts +65 -0
- package/models/errors/notfound.d.ts.map +1 -0
- package/models/errors/notfound.js +111 -0
- package/models/errors/notfound.js.map +1 -0
- package/models/errors/ratelimitexceeded.d.ts +65 -0
- package/models/errors/ratelimitexceeded.d.ts.map +1 -0
- package/models/errors/ratelimitexceeded.js +111 -0
- package/models/errors/ratelimitexceeded.js.map +1 -0
- package/models/errors/sdkerror.d.ts +7 -0
- package/models/errors/sdkerror.d.ts.map +1 -0
- package/models/errors/sdkerror.js +19 -0
- package/models/errors/sdkerror.js.map +1 -0
- package/models/errors/sdkvalidationerror.d.ts +17 -0
- package/models/errors/sdkvalidationerror.d.ts.map +1 -0
- package/models/errors/sdkvalidationerror.js +107 -0
- package/models/errors/sdkvalidationerror.js.map +1 -0
- package/models/errors/unauthorized.d.ts +65 -0
- package/models/errors/unauthorized.d.ts.map +1 -0
- package/models/errors/unauthorized.js +111 -0
- package/models/errors/unauthorized.js.map +1 -0
- package/models/errors/unprocessableentity.d.ts +65 -0
- package/models/errors/unprocessableentity.d.ts.map +1 -0
- package/models/errors/unprocessableentity.js +111 -0
- package/models/errors/unprocessableentity.js.map +1 -0
- package/models/operations/bulkcreatelinks.d.ts +146 -0
- package/models/operations/bulkcreatelinks.d.ts.map +1 -0
- package/models/operations/bulkcreatelinks.js +138 -0
- package/models/operations/bulkcreatelinks.js.map +1 -0
- package/models/operations/createlink.d.ts +146 -0
- package/models/operations/createlink.d.ts.map +1 -0
- package/models/operations/createlink.js +141 -0
- package/models/operations/createlink.js.map +1 -0
- package/models/operations/createtag.d.ts +39 -0
- package/models/operations/createtag.d.ts.map +1 -0
- package/models/operations/createtag.js +72 -0
- package/models/operations/createtag.js.map +1 -0
- package/models/operations/createworkspace.d.ts +22 -0
- package/models/operations/createworkspace.d.ts.map +1 -0
- package/models/operations/createworkspace.js +61 -0
- package/models/operations/createworkspace.js.map +1 -0
- package/models/operations/deletelink.d.ts +39 -0
- package/models/operations/deletelink.d.ts.map +1 -0
- package/models/operations/deletelink.js +75 -0
- package/models/operations/deletelink.js.map +1 -0
- package/models/operations/editlink.d.ts +166 -0
- package/models/operations/editlink.d.ts.map +1 -0
- package/models/operations/editlink.js +167 -0
- package/models/operations/editlink.js.map +1 -0
- package/models/operations/getbrowseranalytics.d.ts +378 -0
- package/models/operations/getbrowseranalytics.d.ts.map +1 -0
- package/models/operations/getbrowseranalytics.js +395 -0
- package/models/operations/getbrowseranalytics.js.map +1 -0
- package/models/operations/getcityanalytics.d.ts +641 -0
- package/models/operations/getcityanalytics.d.ts.map +1 -0
- package/models/operations/getcityanalytics.js +657 -0
- package/models/operations/getcityanalytics.js.map +1 -0
- package/models/operations/getclicksanalytics.d.ts +355 -0
- package/models/operations/getclicksanalytics.d.ts.map +1 -0
- package/models/operations/getclicksanalytics.js +369 -0
- package/models/operations/getclicksanalytics.js.map +1 -0
- package/models/operations/getcountryanalytics.d.ts +635 -0
- package/models/operations/getcountryanalytics.d.ts.map +1 -0
- package/models/operations/getcountryanalytics.js +653 -0
- package/models/operations/getcountryanalytics.js.map +1 -0
- package/models/operations/getdeviceanalytics.d.ts +378 -0
- package/models/operations/getdeviceanalytics.d.ts.map +1 -0
- package/models/operations/getdeviceanalytics.js +395 -0
- package/models/operations/getdeviceanalytics.js.map +1 -0
- package/models/operations/getlinkinfo.d.ts +25 -0
- package/models/operations/getlinkinfo.d.ts.map +1 -0
- package/models/operations/getlinkinfo.js +57 -0
- package/models/operations/getlinkinfo.js.map +1 -0
- package/models/operations/getlinks.d.ts +88 -0
- package/models/operations/getlinks.d.ts.map +1 -0
- package/models/operations/getlinks.js +108 -0
- package/models/operations/getlinks.js.map +1 -0
- package/models/operations/getlinkscount.d.ts +93 -0
- package/models/operations/getlinkscount.d.ts.map +1 -0
- package/models/operations/getlinkscount.js +105 -0
- package/models/operations/getlinkscount.js.map +1 -0
- package/models/operations/getosanalytics.d.ts +378 -0
- package/models/operations/getosanalytics.d.ts.map +1 -0
- package/models/operations/getosanalytics.js +395 -0
- package/models/operations/getosanalytics.js.map +1 -0
- package/models/operations/getqrcode.d.ts +60 -0
- package/models/operations/getqrcode.d.ts.map +1 -0
- package/models/operations/getqrcode.js +85 -0
- package/models/operations/getqrcode.js.map +1 -0
- package/models/operations/getrefereranalytics.d.ts +378 -0
- package/models/operations/getrefereranalytics.d.ts.map +1 -0
- package/models/operations/getrefereranalytics.js +395 -0
- package/models/operations/getrefereranalytics.js.map +1 -0
- package/models/operations/gettags.d.ts +10 -0
- package/models/operations/gettags.d.ts.map +1 -0
- package/{shims/node.js → models/operations/gettags.js} +12 -6
- package/models/operations/gettags.js.map +1 -0
- package/models/operations/gettimeseriesanalytics.d.ts +378 -0
- package/models/operations/gettimeseriesanalytics.d.ts.map +1 -0
- package/models/operations/gettimeseriesanalytics.js +395 -0
- package/models/operations/gettimeseriesanalytics.js.map +1 -0
- package/models/operations/gettoplinks.d.ts +378 -0
- package/models/operations/gettoplinks.d.ts.map +1 -0
- package/models/operations/gettoplinks.js +395 -0
- package/models/operations/gettoplinks.js.map +1 -0
- package/models/operations/gettopurls.d.ts +378 -0
- package/models/operations/gettopurls.d.ts.map +1 -0
- package/models/operations/gettopurls.js +395 -0
- package/models/operations/gettopurls.js.map +1 -0
- package/models/operations/getworkspace.d.ts +19 -0
- package/models/operations/getworkspace.d.ts.map +1 -0
- package/models/operations/getworkspace.js +53 -0
- package/models/operations/getworkspace.js.map +1 -0
- package/models/operations/index.d.ts +23 -0
- package/models/operations/index.d.ts.map +1 -0
- package/models/operations/index.js +42 -0
- package/models/operations/index.js.map +1 -0
- package/package.json +25 -98
- package/sdk/analytics.d.ts +78 -0
- package/sdk/analytics.d.ts.map +1 -0
- package/sdk/analytics.js +2044 -0
- package/sdk/analytics.js.map +1 -0
- package/sdk/index.d.ts +2 -0
- package/sdk/index.d.ts.map +1 -0
- package/{_shims/auto/runtime.js → sdk/index.js} +5 -5
- package/sdk/index.js.map +1 -0
- package/sdk/links.d.ts +58 -0
- package/sdk/links.d.ts.map +1 -0
- package/sdk/links.js +1309 -0
- package/sdk/links.js.map +1 -0
- package/sdk/qrcodes.d.ts +21 -0
- package/sdk/qrcodes.d.ts.map +1 -0
- package/sdk/qrcodes.js +249 -0
- package/sdk/qrcodes.js.map +1 -0
- package/sdk/sdk.d.ts +22 -0
- package/sdk/sdk.d.ts.map +1 -0
- package/sdk/sdk.js +59 -0
- package/sdk/sdk.js.map +1 -0
- package/sdk/tags.d.ts +23 -0
- package/sdk/tags.d.ts.map +1 -0
- package/sdk/tags.js +401 -0
- package/sdk/tags.js.map +1 -0
- package/sdk/workspaces.d.ts +30 -0
- package/sdk/workspaces.d.ts.map +1 -0
- package/sdk/workspaces.js +556 -0
- package/sdk/workspaces.js.map +1 -0
- package/src/hooks/hooks.ts +81 -0
- package/src/hooks/index.ts +6 -0
- package/src/hooks/types.ts +74 -0
- package/src/index.ts +8 -209
- package/src/lib/base64.ts +37 -0
- package/src/lib/config.ts +70 -0
- package/src/lib/encodings.ts +384 -0
- package/src/lib/http.ts +215 -0
- package/src/lib/retries.ts +226 -0
- package/src/lib/schemas.ts +22 -0
- package/src/lib/sdks.ts +139 -0
- package/src/lib/security.ts +180 -0
- package/src/lib/url.ts +31 -0
- package/src/models/components/index.ts +8 -0
- package/src/models/components/linkschema.ts +383 -0
- package/src/models/components/security.ts +40 -0
- package/src/models/components/tagschema.ts +79 -0
- package/src/models/components/workspaceschema.ts +316 -0
- package/src/models/errors/badrequest.ts +140 -0
- package/src/models/errors/conflict.ts +140 -0
- package/src/models/errors/forbidden.ts +140 -0
- package/src/models/errors/index.ts +15 -0
- package/src/models/errors/internalservererror.ts +140 -0
- package/src/models/errors/inviteexpired.ts +140 -0
- package/src/models/errors/notfound.ts +140 -0
- package/src/models/errors/ratelimitexceeded.ts +140 -0
- package/src/models/errors/sdkerror.ts +22 -0
- package/src/models/errors/sdkvalidationerror.ts +95 -0
- package/src/models/errors/unauthorized.ts +140 -0
- package/src/models/errors/unprocessableentity.ts +140 -0
- package/src/models/operations/bulkcreatelinks.ts +254 -0
- package/src/models/operations/createlink.ts +255 -0
- package/src/models/operations/createtag.ts +69 -0
- package/src/models/operations/createworkspace.ts +54 -0
- package/src/models/operations/deletelink.ts +84 -0
- package/src/models/operations/editlink.ts +300 -0
- package/src/models/operations/getbrowseranalytics.ts +484 -0
- package/src/models/operations/getcityanalytics.ts +744 -0
- package/src/models/operations/getclicksanalytics.ts +427 -0
- package/src/models/operations/getcountryanalytics.ts +743 -0
- package/src/models/operations/getdeviceanalytics.ts +480 -0
- package/src/models/operations/getlinkinfo.ts +53 -0
- package/src/models/operations/getlinks.ts +155 -0
- package/src/models/operations/getlinkscount.ts +157 -0
- package/src/models/operations/getosanalytics.ts +475 -0
- package/src/models/operations/getqrcode.ts +106 -0
- package/src/models/operations/getrefereranalytics.ts +484 -0
- package/src/models/operations/gettags.ts +18 -0
- package/src/models/operations/gettimeseriesanalytics.ts +476 -0
- package/src/models/operations/gettoplinks.ts +475 -0
- package/src/models/operations/gettopurls.ts +475 -0
- package/src/models/operations/getworkspace.ts +43 -0
- package/src/models/operations/index.ts +26 -0
- package/src/sdk/analytics.ts +2493 -0
- package/src/sdk/index.ts +5 -0
- package/src/sdk/links.ts +1617 -0
- package/src/sdk/qrcodes.ts +276 -0
- package/src/sdk/sdk.ts +66 -0
- package/src/sdk/tags.ts +470 -0
- package/src/sdk/workspaces.ts +670 -0
- package/src/types/blobs.ts +30 -0
- package/src/types/index.ts +8 -0
- package/src/types/operations.ts +25 -0
- package/src/types/rfcdate.ts +54 -0
- package/types/blobs.d.ts +4 -0
- package/types/blobs.d.ts.map +1 -0
- package/{resources/projects/projects.js → types/blobs.js} +23 -24
- package/types/blobs.js.map +1 -0
- package/types/index.d.ts +5 -0
- package/types/index.d.ts.map +1 -0
- package/types/index.js +14 -0
- package/types/index.js.map +1 -0
- package/types/operations.d.ts +13 -0
- package/types/operations.d.ts.map +1 -0
- package/types/operations.js +19 -0
- package/types/operations.js.map +1 -0
- package/types/rfcdate.d.ts +21 -0
- package/types/rfcdate.d.ts.map +1 -0
- package/types/rfcdate.js +46 -0
- package/types/rfcdate.js.map +1 -0
- package/CHANGELOG.md +0 -116
- package/LICENSE +0 -201
- package/_shims/MultipartBody.d.ts +0 -9
- package/_shims/MultipartBody.d.ts.map +0 -1
- package/_shims/MultipartBody.js +0 -16
- package/_shims/MultipartBody.js.map +0 -1
- package/_shims/MultipartBody.mjs +0 -12
- package/_shims/MultipartBody.mjs.map +0 -1
- package/_shims/README.md +0 -46
- package/_shims/auto/runtime-bun.d.ts +0 -5
- package/_shims/auto/runtime-bun.d.ts.map +0 -1
- package/_shims/auto/runtime-bun.js.map +0 -1
- package/_shims/auto/runtime-bun.mjs +0 -2
- package/_shims/auto/runtime-bun.mjs.map +0 -1
- package/_shims/auto/runtime-node.d.ts +0 -5
- package/_shims/auto/runtime-node.d.ts.map +0 -1
- package/_shims/auto/runtime-node.js.map +0 -1
- package/_shims/auto/runtime-node.mjs +0 -2
- package/_shims/auto/runtime-node.mjs.map +0 -1
- package/_shims/auto/runtime.d.ts +0 -5
- package/_shims/auto/runtime.d.ts.map +0 -1
- package/_shims/auto/runtime.js.map +0 -1
- package/_shims/auto/runtime.mjs +0 -2
- package/_shims/auto/runtime.mjs.map +0 -1
- package/_shims/auto/types-node.d.ts +0 -5
- package/_shims/auto/types-node.d.ts.map +0 -1
- package/_shims/auto/types-node.js.map +0 -1
- package/_shims/auto/types-node.mjs +0 -2
- package/_shims/auto/types-node.mjs.map +0 -1
- package/_shims/auto/types.d.ts +0 -101
- package/_shims/auto/types.js +0 -3
- package/_shims/auto/types.mjs +0 -3
- package/_shims/bun-runtime.d.ts +0 -6
- package/_shims/bun-runtime.d.ts.map +0 -1
- package/_shims/bun-runtime.js +0 -14
- package/_shims/bun-runtime.js.map +0 -1
- package/_shims/bun-runtime.mjs +0 -10
- package/_shims/bun-runtime.mjs.map +0 -1
- package/_shims/index.d.ts +0 -81
- package/_shims/index.js +0 -13
- package/_shims/index.mjs +0 -7
- package/_shims/manual-types.d.ts +0 -12
- package/_shims/manual-types.js +0 -3
- package/_shims/manual-types.mjs +0 -3
- package/_shims/node-runtime.d.ts +0 -3
- package/_shims/node-runtime.d.ts.map +0 -1
- package/_shims/node-runtime.js +0 -90
- package/_shims/node-runtime.js.map +0 -1
- package/_shims/node-runtime.mjs +0 -56
- package/_shims/node-runtime.mjs.map +0 -1
- package/_shims/node-types.d.ts +0 -42
- package/_shims/node-types.js +0 -3
- package/_shims/node-types.mjs +0 -3
- package/_shims/registry.d.ts +0 -37
- package/_shims/registry.d.ts.map +0 -1
- package/_shims/registry.js +0 -41
- package/_shims/registry.js.map +0 -1
- package/_shims/registry.mjs +0 -37
- package/_shims/registry.mjs.map +0 -1
- package/_shims/web-runtime.d.ts +0 -5
- package/_shims/web-runtime.d.ts.map +0 -1
- package/_shims/web-runtime.js +0 -78
- package/_shims/web-runtime.js.map +0 -1
- package/_shims/web-runtime.mjs +0 -71
- package/_shims/web-runtime.mjs.map +0 -1
- package/_shims/web-types.d.ts +0 -83
- package/_shims/web-types.js +0 -3
- package/_shims/web-types.mjs +0 -3
- package/core.d.ts +0 -237
- package/core.d.ts.map +0 -1
- package/core.js +0 -868
- package/core.js.map +0 -1
- package/core.mjs +0 -837
- package/core.mjs.map +0 -1
- package/error.d.ts +0 -53
- package/error.d.ts.map +0 -1
- package/error.js +0 -143
- package/error.js.map +0 -1
- package/error.mjs +0 -127
- package/error.mjs.map +0 -1
- package/index.d.mts +0 -127
- package/index.mjs +0 -90
- package/index.mjs.map +0 -1
- package/resource.d.ts +0 -6
- package/resource.d.ts.map +0 -1
- package/resource.js +0 -11
- package/resource.js.map +0 -1
- package/resource.mjs +0 -7
- package/resource.mjs.map +0 -1
- package/resources/index.d.ts +0 -4
- package/resources/index.d.ts.map +0 -1
- package/resources/index.js +0 -11
- package/resources/index.js.map +0 -1
- package/resources/index.mjs +0 -5
- package/resources/index.mjs.map +0 -1
- package/resources/links/bulk.d.ts +0 -274
- package/resources/links/bulk.d.ts.map +0 -1
- package/resources/links/bulk.js +0 -18
- package/resources/links/bulk.js.map +0 -1
- package/resources/links/bulk.mjs +0 -14
- package/resources/links/bulk.mjs.map +0 -1
- package/resources/links/index.d.ts +0 -4
- package/resources/links/index.d.ts.map +0 -1
- package/resources/links/index.js +0 -11
- package/resources/links/index.js.map +0 -1
- package/resources/links/index.mjs +0 -5
- package/resources/links/index.mjs.map +0 -1
- package/resources/links/info.d.ts +0 -186
- package/resources/links/info.d.ts.map +0 -1
- package/resources/links/info.js +0 -18
- package/resources/links/info.js.map +0 -1
- package/resources/links/info.mjs +0 -14
- package/resources/links/info.mjs.map +0 -1
- package/resources/links/links.d.ts +0 -916
- package/resources/links/links.d.ts.map +0 -1
- package/resources/links/links.js +0 -72
- package/resources/links/links.js.map +0 -1
- package/resources/links/links.mjs +0 -45
- package/resources/links/links.mjs.map +0 -1
- package/resources/projects/index.d.ts +0 -3
- package/resources/projects/index.d.ts.map +0 -1
- package/resources/projects/index.js +0 -9
- package/resources/projects/index.js.map +0 -1
- package/resources/projects/index.mjs +0 -4
- package/resources/projects/index.mjs.map +0 -1
- package/resources/projects/projects.d.ts +0 -200
- package/resources/projects/projects.d.ts.map +0 -1
- package/resources/projects/projects.js.map +0 -1
- package/resources/projects/projects.mjs +0 -26
- package/resources/projects/projects.mjs.map +0 -1
- package/resources/projects/tags.d.ts +0 -4
- package/resources/projects/tags.d.ts.map +0 -1
- package/resources/projects/tags.js +0 -9
- package/resources/projects/tags.js.map +0 -1
- package/resources/projects/tags.mjs +0 -5
- package/resources/projects/tags.mjs.map +0 -1
- package/resources/qr.d.ts +0 -45
- package/resources/qr.d.ts.map +0 -1
- package/resources/qr.js +0 -18
- package/resources/qr.js.map +0 -1
- package/resources/qr.mjs +0 -14
- package/resources/qr.mjs.map +0 -1
- package/shims/node.d.ts +0 -29
- package/shims/node.d.ts.map +0 -1
- package/shims/node.js.map +0 -1
- package/shims/node.mjs +0 -5
- package/shims/node.mjs.map +0 -1
- package/shims/web.d.ts +0 -26
- package/shims/web.d.ts.map +0 -1
- package/shims/web.js.map +0 -1
- package/shims/web.mjs +0 -5
- package/shims/web.mjs.map +0 -1
- package/src/_shims/MultipartBody.ts +0 -9
- package/src/_shims/README.md +0 -46
- package/src/_shims/auto/runtime-bun.ts +0 -4
- package/src/_shims/auto/runtime-node.ts +0 -4
- package/src/_shims/auto/runtime.ts +0 -4
- package/src/_shims/auto/types-node.ts +0 -4
- package/src/_shims/auto/types.d.ts +0 -101
- package/src/_shims/auto/types.js +0 -3
- package/src/_shims/auto/types.mjs +0 -3
- package/src/_shims/bun-runtime.ts +0 -14
- package/src/_shims/index.d.ts +0 -81
- package/src/_shims/index.js +0 -13
- package/src/_shims/index.mjs +0 -7
- package/src/_shims/manual-types.d.ts +0 -12
- package/src/_shims/manual-types.js +0 -3
- package/src/_shims/manual-types.mjs +0 -3
- package/src/_shims/node-runtime.ts +0 -83
- package/src/_shims/node-types.d.ts +0 -42
- package/src/_shims/node-types.js +0 -3
- package/src/_shims/node-types.mjs +0 -3
- package/src/_shims/registry.ts +0 -63
- package/src/_shims/web-runtime.ts +0 -103
- package/src/_shims/web-types.d.ts +0 -83
- package/src/_shims/web-types.js +0 -3
- package/src/_shims/web-types.mjs +0 -3
- package/src/core.ts +0 -1145
- package/src/error.ts +0 -146
- package/src/lib/.keep +0 -4
- package/src/resource.ts +0 -11
- package/src/resources/index.ts +0 -20
- package/src/resources/links/bulk.ts +0 -337
- package/src/resources/links/index.ts +0 -15
- package/src/resources/links/info.ts +0 -230
- package/src/resources/links/links.ts +0 -1135
- package/src/resources/projects/index.ts +0 -4
- package/src/resources/projects/projects.ts +0 -253
- package/src/resources/projects/tags.ts +0 -5
- package/src/resources/qr.ts +0 -64
- package/src/shims/node.ts +0 -50
- package/src/shims/web.ts +0 -50
- package/src/tsconfig.json +0 -11
- package/src/uploads.ts +0 -245
- package/src/version.ts +0 -1
- package/uploads.d.ts +0 -75
- package/uploads.d.ts.map +0 -1
- package/uploads.js +0 -163
- package/uploads.js.map +0 -1
- package/uploads.mjs +0 -150
- package/uploads.mjs.map +0 -1
- package/version.d.ts +0 -2
- package/version.d.ts.map +0 -1
- package/version.js +0 -5
- package/version.js.map +0 -1
- package/version.mjs +0 -2
- package/version.mjs.map +0 -1
|
@@ -1,916 +0,0 @@
|
|
|
1
|
-
import * as Core from 'dub/core';
|
|
2
|
-
import { APIResource } from 'dub/resource';
|
|
3
|
-
import * as LinksAPI from 'dub/resources/links/links';
|
|
4
|
-
import * as BulkAPI from 'dub/resources/links/bulk';
|
|
5
|
-
import * as InfoAPI from 'dub/resources/links/info';
|
|
6
|
-
export declare class Links extends APIResource {
|
|
7
|
-
info: InfoAPI.Info;
|
|
8
|
-
bulk: BulkAPI.Bulk;
|
|
9
|
-
/**
|
|
10
|
-
* Create a new link for the authenticated project.
|
|
11
|
-
*/
|
|
12
|
-
create(params: LinkCreateParams, options?: Core.RequestOptions): Core.APIPromise<LinkCreateResponse>;
|
|
13
|
-
/**
|
|
14
|
-
* Edit a link for the authenticated project.
|
|
15
|
-
*/
|
|
16
|
-
update(linkId: string, params: LinkUpdateParams, options?: Core.RequestOptions): Core.APIPromise<LinkUpdateResponse>;
|
|
17
|
-
/**
|
|
18
|
-
* Retrieve a list of links for the authenticated project. The list will be
|
|
19
|
-
* paginated and the provided query parameters allow filtering the returned links.
|
|
20
|
-
*/
|
|
21
|
-
list(params: LinkListParams, options?: Core.RequestOptions): Core.APIPromise<LinkListResponse>;
|
|
22
|
-
/**
|
|
23
|
-
* Delete a link for the authenticated project.
|
|
24
|
-
*/
|
|
25
|
-
deleteLink(linkId: string, params: LinkDeleteLinkParams, options?: Core.RequestOptions): Core.APIPromise<LinkDeleteLinkResponse>;
|
|
26
|
-
}
|
|
27
|
-
export interface LinkCreateResponse {
|
|
28
|
-
/**
|
|
29
|
-
* The unique ID of the short link.
|
|
30
|
-
*/
|
|
31
|
-
id: string;
|
|
32
|
-
/**
|
|
33
|
-
* The Android destination URL for the short link for Android device targeting.
|
|
34
|
-
*/
|
|
35
|
-
android: string | null;
|
|
36
|
-
/**
|
|
37
|
-
* Whether the short link is archived.
|
|
38
|
-
*/
|
|
39
|
-
archived: boolean;
|
|
40
|
-
/**
|
|
41
|
-
* The number of clicks on the short link.
|
|
42
|
-
*/
|
|
43
|
-
clicks: number;
|
|
44
|
-
/**
|
|
45
|
-
* The comments for the short link.
|
|
46
|
-
*/
|
|
47
|
-
comments: string | null;
|
|
48
|
-
/**
|
|
49
|
-
* The date and time when the short link was created.
|
|
50
|
-
*/
|
|
51
|
-
createdAt: string;
|
|
52
|
-
/**
|
|
53
|
-
* The description of the short link generated via `api.dub.co/metatags`. Will be
|
|
54
|
-
* used for Custom Social Media Cards if `proxy` is true.
|
|
55
|
-
*/
|
|
56
|
-
description: string | null;
|
|
57
|
-
/**
|
|
58
|
-
* The domain of the short link. If not provided, the primary domain for the
|
|
59
|
-
* project will be used (or `dub.sh` if the project has no domains).
|
|
60
|
-
*/
|
|
61
|
-
domain: string;
|
|
62
|
-
/**
|
|
63
|
-
* The date and time when the short link will expire in ISO-8601 format. Must be in
|
|
64
|
-
* the future.
|
|
65
|
-
*/
|
|
66
|
-
expiresAt: string | null;
|
|
67
|
-
/**
|
|
68
|
-
* Geo targeting information for the short link in JSON format
|
|
69
|
-
* `{[COUNTRY]: https://example.com }`. Learn more: https://d.to/geo
|
|
70
|
-
*/
|
|
71
|
-
geo: Record<string, string> | null;
|
|
72
|
-
/**
|
|
73
|
-
* The image of the short link generated via `api.dub.co/metatags`. Will be used
|
|
74
|
-
* for Custom Social Media Cards if `proxy` is true.
|
|
75
|
-
*/
|
|
76
|
-
image: string | null;
|
|
77
|
-
/**
|
|
78
|
-
* The iOS destination URL for the short link for iOS device targeting.
|
|
79
|
-
*/
|
|
80
|
-
ios: string | null;
|
|
81
|
-
/**
|
|
82
|
-
* The short link slug. If not provided, a random 7-character slug will be
|
|
83
|
-
* generated.
|
|
84
|
-
*/
|
|
85
|
-
key: string;
|
|
86
|
-
/**
|
|
87
|
-
* The date and time when the short link was last clicked.
|
|
88
|
-
*/
|
|
89
|
-
lastClicked: string | null;
|
|
90
|
-
/**
|
|
91
|
-
* The password required to access the destination URL of the short link.
|
|
92
|
-
*/
|
|
93
|
-
password: string | null;
|
|
94
|
-
/**
|
|
95
|
-
* The project ID of the short link.
|
|
96
|
-
*/
|
|
97
|
-
projectId: string;
|
|
98
|
-
/**
|
|
99
|
-
* Whether the short link uses Custom Social Media Cards feature.
|
|
100
|
-
*/
|
|
101
|
-
proxy: boolean;
|
|
102
|
-
/**
|
|
103
|
-
* Whether the short link's stats are publicly accessible.
|
|
104
|
-
*/
|
|
105
|
-
publicStats: boolean;
|
|
106
|
-
/**
|
|
107
|
-
* The full URL of the QR code for the short link (e.g.
|
|
108
|
-
* `https://api.dub.co/qr?url=https://dub.sh/try`).
|
|
109
|
-
*/
|
|
110
|
-
qrCode: string;
|
|
111
|
-
/**
|
|
112
|
-
* Whether the short link uses link cloaking.
|
|
113
|
-
*/
|
|
114
|
-
rewrite: boolean;
|
|
115
|
-
/**
|
|
116
|
-
* The full URL of the short link, including the https protocol (e.g.
|
|
117
|
-
* `https://dub.sh/try`).
|
|
118
|
-
*/
|
|
119
|
-
shortLink: string;
|
|
120
|
-
/**
|
|
121
|
-
* @deprecated: [DEPRECATED (use `tags` instead)]: The unique ID of the tag
|
|
122
|
-
* assigned to the short link.
|
|
123
|
-
*/
|
|
124
|
-
tagId: string | null;
|
|
125
|
-
/**
|
|
126
|
-
* The tags assigned to the short link.
|
|
127
|
-
*/
|
|
128
|
-
tags: Array<LinkCreateResponse.Tag> | null;
|
|
129
|
-
/**
|
|
130
|
-
* The title of the short link generated via `api.dub.co/metatags`. Will be used
|
|
131
|
-
* for Custom Social Media Cards if `proxy` is true.
|
|
132
|
-
*/
|
|
133
|
-
title: string | null;
|
|
134
|
-
/**
|
|
135
|
-
* The date and time when the short link was last updated.
|
|
136
|
-
*/
|
|
137
|
-
updatedAt: string;
|
|
138
|
-
/**
|
|
139
|
-
* The destination URL of the short link.
|
|
140
|
-
*/
|
|
141
|
-
url: string;
|
|
142
|
-
/**
|
|
143
|
-
* The user ID of the creator of the short link.
|
|
144
|
-
*/
|
|
145
|
-
userId: string;
|
|
146
|
-
/**
|
|
147
|
-
* The UTM campaign of the short link.
|
|
148
|
-
*/
|
|
149
|
-
utm_campaign: string | null;
|
|
150
|
-
/**
|
|
151
|
-
* The UTM content of the short link.
|
|
152
|
-
*/
|
|
153
|
-
utm_content: string | null;
|
|
154
|
-
/**
|
|
155
|
-
* The UTM medium of the short link.
|
|
156
|
-
*/
|
|
157
|
-
utm_medium: string | null;
|
|
158
|
-
/**
|
|
159
|
-
* The UTM source of the short link.
|
|
160
|
-
*/
|
|
161
|
-
utm_source: string | null;
|
|
162
|
-
/**
|
|
163
|
-
* The UTM term of the short link.
|
|
164
|
-
*/
|
|
165
|
-
utm_term: string | null;
|
|
166
|
-
}
|
|
167
|
-
export declare namespace LinkCreateResponse {
|
|
168
|
-
interface Tag {
|
|
169
|
-
/**
|
|
170
|
-
* The unique ID of the tag.
|
|
171
|
-
*/
|
|
172
|
-
id: string;
|
|
173
|
-
/**
|
|
174
|
-
* The color of the tag.
|
|
175
|
-
*/
|
|
176
|
-
color: 'red' | 'yellow' | 'green' | 'blue' | 'purple' | 'pink' | 'brown';
|
|
177
|
-
/**
|
|
178
|
-
* The name of the tag.
|
|
179
|
-
*/
|
|
180
|
-
name: string;
|
|
181
|
-
}
|
|
182
|
-
}
|
|
183
|
-
export interface LinkUpdateResponse {
|
|
184
|
-
/**
|
|
185
|
-
* The unique ID of the short link.
|
|
186
|
-
*/
|
|
187
|
-
id: string;
|
|
188
|
-
/**
|
|
189
|
-
* The Android destination URL for the short link for Android device targeting.
|
|
190
|
-
*/
|
|
191
|
-
android: string | null;
|
|
192
|
-
/**
|
|
193
|
-
* Whether the short link is archived.
|
|
194
|
-
*/
|
|
195
|
-
archived: boolean;
|
|
196
|
-
/**
|
|
197
|
-
* The number of clicks on the short link.
|
|
198
|
-
*/
|
|
199
|
-
clicks: number;
|
|
200
|
-
/**
|
|
201
|
-
* The comments for the short link.
|
|
202
|
-
*/
|
|
203
|
-
comments: string | null;
|
|
204
|
-
/**
|
|
205
|
-
* The date and time when the short link was created.
|
|
206
|
-
*/
|
|
207
|
-
createdAt: string;
|
|
208
|
-
/**
|
|
209
|
-
* The description of the short link generated via `api.dub.co/metatags`. Will be
|
|
210
|
-
* used for Custom Social Media Cards if `proxy` is true.
|
|
211
|
-
*/
|
|
212
|
-
description: string | null;
|
|
213
|
-
/**
|
|
214
|
-
* The domain of the short link. If not provided, the primary domain for the
|
|
215
|
-
* project will be used (or `dub.sh` if the project has no domains).
|
|
216
|
-
*/
|
|
217
|
-
domain: string;
|
|
218
|
-
/**
|
|
219
|
-
* The date and time when the short link will expire in ISO-8601 format. Must be in
|
|
220
|
-
* the future.
|
|
221
|
-
*/
|
|
222
|
-
expiresAt: string | null;
|
|
223
|
-
/**
|
|
224
|
-
* Geo targeting information for the short link in JSON format
|
|
225
|
-
* `{[COUNTRY]: https://example.com }`. Learn more: https://d.to/geo
|
|
226
|
-
*/
|
|
227
|
-
geo: Record<string, string> | null;
|
|
228
|
-
/**
|
|
229
|
-
* The image of the short link generated via `api.dub.co/metatags`. Will be used
|
|
230
|
-
* for Custom Social Media Cards if `proxy` is true.
|
|
231
|
-
*/
|
|
232
|
-
image: string | null;
|
|
233
|
-
/**
|
|
234
|
-
* The iOS destination URL for the short link for iOS device targeting.
|
|
235
|
-
*/
|
|
236
|
-
ios: string | null;
|
|
237
|
-
/**
|
|
238
|
-
* The short link slug. If not provided, a random 7-character slug will be
|
|
239
|
-
* generated.
|
|
240
|
-
*/
|
|
241
|
-
key: string;
|
|
242
|
-
/**
|
|
243
|
-
* The date and time when the short link was last clicked.
|
|
244
|
-
*/
|
|
245
|
-
lastClicked: string | null;
|
|
246
|
-
/**
|
|
247
|
-
* The password required to access the destination URL of the short link.
|
|
248
|
-
*/
|
|
249
|
-
password: string | null;
|
|
250
|
-
/**
|
|
251
|
-
* The project ID of the short link.
|
|
252
|
-
*/
|
|
253
|
-
projectId: string;
|
|
254
|
-
/**
|
|
255
|
-
* Whether the short link uses Custom Social Media Cards feature.
|
|
256
|
-
*/
|
|
257
|
-
proxy: boolean;
|
|
258
|
-
/**
|
|
259
|
-
* Whether the short link's stats are publicly accessible.
|
|
260
|
-
*/
|
|
261
|
-
publicStats: boolean;
|
|
262
|
-
/**
|
|
263
|
-
* The full URL of the QR code for the short link (e.g.
|
|
264
|
-
* `https://api.dub.co/qr?url=https://dub.sh/try`).
|
|
265
|
-
*/
|
|
266
|
-
qrCode: string;
|
|
267
|
-
/**
|
|
268
|
-
* Whether the short link uses link cloaking.
|
|
269
|
-
*/
|
|
270
|
-
rewrite: boolean;
|
|
271
|
-
/**
|
|
272
|
-
* The full URL of the short link, including the https protocol (e.g.
|
|
273
|
-
* `https://dub.sh/try`).
|
|
274
|
-
*/
|
|
275
|
-
shortLink: string;
|
|
276
|
-
/**
|
|
277
|
-
* @deprecated: [DEPRECATED (use `tags` instead)]: The unique ID of the tag
|
|
278
|
-
* assigned to the short link.
|
|
279
|
-
*/
|
|
280
|
-
tagId: string | null;
|
|
281
|
-
/**
|
|
282
|
-
* The tags assigned to the short link.
|
|
283
|
-
*/
|
|
284
|
-
tags: Array<LinkUpdateResponse.Tag> | null;
|
|
285
|
-
/**
|
|
286
|
-
* The title of the short link generated via `api.dub.co/metatags`. Will be used
|
|
287
|
-
* for Custom Social Media Cards if `proxy` is true.
|
|
288
|
-
*/
|
|
289
|
-
title: string | null;
|
|
290
|
-
/**
|
|
291
|
-
* The date and time when the short link was last updated.
|
|
292
|
-
*/
|
|
293
|
-
updatedAt: string;
|
|
294
|
-
/**
|
|
295
|
-
* The destination URL of the short link.
|
|
296
|
-
*/
|
|
297
|
-
url: string;
|
|
298
|
-
/**
|
|
299
|
-
* The user ID of the creator of the short link.
|
|
300
|
-
*/
|
|
301
|
-
userId: string;
|
|
302
|
-
/**
|
|
303
|
-
* The UTM campaign of the short link.
|
|
304
|
-
*/
|
|
305
|
-
utm_campaign: string | null;
|
|
306
|
-
/**
|
|
307
|
-
* The UTM content of the short link.
|
|
308
|
-
*/
|
|
309
|
-
utm_content: string | null;
|
|
310
|
-
/**
|
|
311
|
-
* The UTM medium of the short link.
|
|
312
|
-
*/
|
|
313
|
-
utm_medium: string | null;
|
|
314
|
-
/**
|
|
315
|
-
* The UTM source of the short link.
|
|
316
|
-
*/
|
|
317
|
-
utm_source: string | null;
|
|
318
|
-
/**
|
|
319
|
-
* The UTM term of the short link.
|
|
320
|
-
*/
|
|
321
|
-
utm_term: string | null;
|
|
322
|
-
}
|
|
323
|
-
export declare namespace LinkUpdateResponse {
|
|
324
|
-
interface Tag {
|
|
325
|
-
/**
|
|
326
|
-
* The unique ID of the tag.
|
|
327
|
-
*/
|
|
328
|
-
id: string;
|
|
329
|
-
/**
|
|
330
|
-
* The color of the tag.
|
|
331
|
-
*/
|
|
332
|
-
color: 'red' | 'yellow' | 'green' | 'blue' | 'purple' | 'pink' | 'brown';
|
|
333
|
-
/**
|
|
334
|
-
* The name of the tag.
|
|
335
|
-
*/
|
|
336
|
-
name: string;
|
|
337
|
-
}
|
|
338
|
-
}
|
|
339
|
-
export type LinkListResponse = Array<LinkListResponse.LinkListResponseItem>;
|
|
340
|
-
export declare namespace LinkListResponse {
|
|
341
|
-
interface LinkListResponseItem {
|
|
342
|
-
/**
|
|
343
|
-
* The unique ID of the short link.
|
|
344
|
-
*/
|
|
345
|
-
id: string;
|
|
346
|
-
/**
|
|
347
|
-
* The Android destination URL for the short link for Android device targeting.
|
|
348
|
-
*/
|
|
349
|
-
android: string | null;
|
|
350
|
-
/**
|
|
351
|
-
* Whether the short link is archived.
|
|
352
|
-
*/
|
|
353
|
-
archived: boolean;
|
|
354
|
-
/**
|
|
355
|
-
* The number of clicks on the short link.
|
|
356
|
-
*/
|
|
357
|
-
clicks: number;
|
|
358
|
-
/**
|
|
359
|
-
* The comments for the short link.
|
|
360
|
-
*/
|
|
361
|
-
comments: string | null;
|
|
362
|
-
/**
|
|
363
|
-
* The date and time when the short link was created.
|
|
364
|
-
*/
|
|
365
|
-
createdAt: string;
|
|
366
|
-
/**
|
|
367
|
-
* The description of the short link generated via `api.dub.co/metatags`. Will be
|
|
368
|
-
* used for Custom Social Media Cards if `proxy` is true.
|
|
369
|
-
*/
|
|
370
|
-
description: string | null;
|
|
371
|
-
/**
|
|
372
|
-
* The domain of the short link. If not provided, the primary domain for the
|
|
373
|
-
* project will be used (or `dub.sh` if the project has no domains).
|
|
374
|
-
*/
|
|
375
|
-
domain: string;
|
|
376
|
-
/**
|
|
377
|
-
* The date and time when the short link will expire in ISO-8601 format. Must be in
|
|
378
|
-
* the future.
|
|
379
|
-
*/
|
|
380
|
-
expiresAt: string | null;
|
|
381
|
-
/**
|
|
382
|
-
* Geo targeting information for the short link in JSON format
|
|
383
|
-
* `{[COUNTRY]: https://example.com }`. Learn more: https://d.to/geo
|
|
384
|
-
*/
|
|
385
|
-
geo: Record<string, string> | null;
|
|
386
|
-
/**
|
|
387
|
-
* The image of the short link generated via `api.dub.co/metatags`. Will be used
|
|
388
|
-
* for Custom Social Media Cards if `proxy` is true.
|
|
389
|
-
*/
|
|
390
|
-
image: string | null;
|
|
391
|
-
/**
|
|
392
|
-
* The iOS destination URL for the short link for iOS device targeting.
|
|
393
|
-
*/
|
|
394
|
-
ios: string | null;
|
|
395
|
-
/**
|
|
396
|
-
* The short link slug. If not provided, a random 7-character slug will be
|
|
397
|
-
* generated.
|
|
398
|
-
*/
|
|
399
|
-
key: string;
|
|
400
|
-
/**
|
|
401
|
-
* The date and time when the short link was last clicked.
|
|
402
|
-
*/
|
|
403
|
-
lastClicked: string | null;
|
|
404
|
-
/**
|
|
405
|
-
* The password required to access the destination URL of the short link.
|
|
406
|
-
*/
|
|
407
|
-
password: string | null;
|
|
408
|
-
/**
|
|
409
|
-
* The project ID of the short link.
|
|
410
|
-
*/
|
|
411
|
-
projectId: string;
|
|
412
|
-
/**
|
|
413
|
-
* Whether the short link uses Custom Social Media Cards feature.
|
|
414
|
-
*/
|
|
415
|
-
proxy: boolean;
|
|
416
|
-
/**
|
|
417
|
-
* Whether the short link's stats are publicly accessible.
|
|
418
|
-
*/
|
|
419
|
-
publicStats: boolean;
|
|
420
|
-
/**
|
|
421
|
-
* The full URL of the QR code for the short link (e.g.
|
|
422
|
-
* `https://api.dub.co/qr?url=https://dub.sh/try`).
|
|
423
|
-
*/
|
|
424
|
-
qrCode: string;
|
|
425
|
-
/**
|
|
426
|
-
* Whether the short link uses link cloaking.
|
|
427
|
-
*/
|
|
428
|
-
rewrite: boolean;
|
|
429
|
-
/**
|
|
430
|
-
* The full URL of the short link, including the https protocol (e.g.
|
|
431
|
-
* `https://dub.sh/try`).
|
|
432
|
-
*/
|
|
433
|
-
shortLink: string;
|
|
434
|
-
/**
|
|
435
|
-
* @deprecated: [DEPRECATED (use `tags` instead)]: The unique ID of the tag
|
|
436
|
-
* assigned to the short link.
|
|
437
|
-
*/
|
|
438
|
-
tagId: string | null;
|
|
439
|
-
/**
|
|
440
|
-
* The tags assigned to the short link.
|
|
441
|
-
*/
|
|
442
|
-
tags: Array<LinkListResponseItem.Tag> | null;
|
|
443
|
-
/**
|
|
444
|
-
* The title of the short link generated via `api.dub.co/metatags`. Will be used
|
|
445
|
-
* for Custom Social Media Cards if `proxy` is true.
|
|
446
|
-
*/
|
|
447
|
-
title: string | null;
|
|
448
|
-
/**
|
|
449
|
-
* The date and time when the short link was last updated.
|
|
450
|
-
*/
|
|
451
|
-
updatedAt: string;
|
|
452
|
-
/**
|
|
453
|
-
* The destination URL of the short link.
|
|
454
|
-
*/
|
|
455
|
-
url: string;
|
|
456
|
-
/**
|
|
457
|
-
* The user ID of the creator of the short link.
|
|
458
|
-
*/
|
|
459
|
-
userId: string;
|
|
460
|
-
/**
|
|
461
|
-
* The UTM campaign of the short link.
|
|
462
|
-
*/
|
|
463
|
-
utm_campaign: string | null;
|
|
464
|
-
/**
|
|
465
|
-
* The UTM content of the short link.
|
|
466
|
-
*/
|
|
467
|
-
utm_content: string | null;
|
|
468
|
-
/**
|
|
469
|
-
* The UTM medium of the short link.
|
|
470
|
-
*/
|
|
471
|
-
utm_medium: string | null;
|
|
472
|
-
/**
|
|
473
|
-
* The UTM source of the short link.
|
|
474
|
-
*/
|
|
475
|
-
utm_source: string | null;
|
|
476
|
-
/**
|
|
477
|
-
* The UTM term of the short link.
|
|
478
|
-
*/
|
|
479
|
-
utm_term: string | null;
|
|
480
|
-
}
|
|
481
|
-
namespace LinkListResponseItem {
|
|
482
|
-
interface Tag {
|
|
483
|
-
/**
|
|
484
|
-
* The unique ID of the tag.
|
|
485
|
-
*/
|
|
486
|
-
id: string;
|
|
487
|
-
/**
|
|
488
|
-
* The color of the tag.
|
|
489
|
-
*/
|
|
490
|
-
color: 'red' | 'yellow' | 'green' | 'blue' | 'purple' | 'pink' | 'brown';
|
|
491
|
-
/**
|
|
492
|
-
* The name of the tag.
|
|
493
|
-
*/
|
|
494
|
-
name: string;
|
|
495
|
-
}
|
|
496
|
-
}
|
|
497
|
-
}
|
|
498
|
-
export interface LinkDeleteLinkResponse {
|
|
499
|
-
/**
|
|
500
|
-
* The unique ID of the short link.
|
|
501
|
-
*/
|
|
502
|
-
id: string;
|
|
503
|
-
/**
|
|
504
|
-
* The Android destination URL for the short link for Android device targeting.
|
|
505
|
-
*/
|
|
506
|
-
android: string | null;
|
|
507
|
-
/**
|
|
508
|
-
* Whether the short link is archived.
|
|
509
|
-
*/
|
|
510
|
-
archived: boolean;
|
|
511
|
-
/**
|
|
512
|
-
* The number of clicks on the short link.
|
|
513
|
-
*/
|
|
514
|
-
clicks: number;
|
|
515
|
-
/**
|
|
516
|
-
* The comments for the short link.
|
|
517
|
-
*/
|
|
518
|
-
comments: string | null;
|
|
519
|
-
/**
|
|
520
|
-
* The date and time when the short link was created.
|
|
521
|
-
*/
|
|
522
|
-
createdAt: string;
|
|
523
|
-
/**
|
|
524
|
-
* The description of the short link generated via `api.dub.co/metatags`. Will be
|
|
525
|
-
* used for Custom Social Media Cards if `proxy` is true.
|
|
526
|
-
*/
|
|
527
|
-
description: string | null;
|
|
528
|
-
/**
|
|
529
|
-
* The domain of the short link. If not provided, the primary domain for the
|
|
530
|
-
* project will be used (or `dub.sh` if the project has no domains).
|
|
531
|
-
*/
|
|
532
|
-
domain: string;
|
|
533
|
-
/**
|
|
534
|
-
* The date and time when the short link will expire in ISO-8601 format. Must be in
|
|
535
|
-
* the future.
|
|
536
|
-
*/
|
|
537
|
-
expiresAt: string | null;
|
|
538
|
-
/**
|
|
539
|
-
* Geo targeting information for the short link in JSON format
|
|
540
|
-
* `{[COUNTRY]: https://example.com }`. Learn more: https://d.to/geo
|
|
541
|
-
*/
|
|
542
|
-
geo: Record<string, string> | null;
|
|
543
|
-
/**
|
|
544
|
-
* The image of the short link generated via `api.dub.co/metatags`. Will be used
|
|
545
|
-
* for Custom Social Media Cards if `proxy` is true.
|
|
546
|
-
*/
|
|
547
|
-
image: string | null;
|
|
548
|
-
/**
|
|
549
|
-
* The iOS destination URL for the short link for iOS device targeting.
|
|
550
|
-
*/
|
|
551
|
-
ios: string | null;
|
|
552
|
-
/**
|
|
553
|
-
* The short link slug. If not provided, a random 7-character slug will be
|
|
554
|
-
* generated.
|
|
555
|
-
*/
|
|
556
|
-
key: string;
|
|
557
|
-
/**
|
|
558
|
-
* The date and time when the short link was last clicked.
|
|
559
|
-
*/
|
|
560
|
-
lastClicked: string | null;
|
|
561
|
-
/**
|
|
562
|
-
* The password required to access the destination URL of the short link.
|
|
563
|
-
*/
|
|
564
|
-
password: string | null;
|
|
565
|
-
/**
|
|
566
|
-
* The project ID of the short link.
|
|
567
|
-
*/
|
|
568
|
-
projectId: string;
|
|
569
|
-
/**
|
|
570
|
-
* Whether the short link uses Custom Social Media Cards feature.
|
|
571
|
-
*/
|
|
572
|
-
proxy: boolean;
|
|
573
|
-
/**
|
|
574
|
-
* Whether the short link's stats are publicly accessible.
|
|
575
|
-
*/
|
|
576
|
-
publicStats: boolean;
|
|
577
|
-
/**
|
|
578
|
-
* The full URL of the QR code for the short link (e.g.
|
|
579
|
-
* `https://api.dub.co/qr?url=https://dub.sh/try`).
|
|
580
|
-
*/
|
|
581
|
-
qrCode: string;
|
|
582
|
-
/**
|
|
583
|
-
* Whether the short link uses link cloaking.
|
|
584
|
-
*/
|
|
585
|
-
rewrite: boolean;
|
|
586
|
-
/**
|
|
587
|
-
* The full URL of the short link, including the https protocol (e.g.
|
|
588
|
-
* `https://dub.sh/try`).
|
|
589
|
-
*/
|
|
590
|
-
shortLink: string;
|
|
591
|
-
/**
|
|
592
|
-
* @deprecated: [DEPRECATED (use `tags` instead)]: The unique ID of the tag
|
|
593
|
-
* assigned to the short link.
|
|
594
|
-
*/
|
|
595
|
-
tagId: string | null;
|
|
596
|
-
/**
|
|
597
|
-
* The tags assigned to the short link.
|
|
598
|
-
*/
|
|
599
|
-
tags: Array<LinkDeleteLinkResponse.Tag> | null;
|
|
600
|
-
/**
|
|
601
|
-
* The title of the short link generated via `api.dub.co/metatags`. Will be used
|
|
602
|
-
* for Custom Social Media Cards if `proxy` is true.
|
|
603
|
-
*/
|
|
604
|
-
title: string | null;
|
|
605
|
-
/**
|
|
606
|
-
* The date and time when the short link was last updated.
|
|
607
|
-
*/
|
|
608
|
-
updatedAt: string;
|
|
609
|
-
/**
|
|
610
|
-
* The destination URL of the short link.
|
|
611
|
-
*/
|
|
612
|
-
url: string;
|
|
613
|
-
/**
|
|
614
|
-
* The user ID of the creator of the short link.
|
|
615
|
-
*/
|
|
616
|
-
userId: string;
|
|
617
|
-
/**
|
|
618
|
-
* The UTM campaign of the short link.
|
|
619
|
-
*/
|
|
620
|
-
utm_campaign: string | null;
|
|
621
|
-
/**
|
|
622
|
-
* The UTM content of the short link.
|
|
623
|
-
*/
|
|
624
|
-
utm_content: string | null;
|
|
625
|
-
/**
|
|
626
|
-
* The UTM medium of the short link.
|
|
627
|
-
*/
|
|
628
|
-
utm_medium: string | null;
|
|
629
|
-
/**
|
|
630
|
-
* The UTM source of the short link.
|
|
631
|
-
*/
|
|
632
|
-
utm_source: string | null;
|
|
633
|
-
/**
|
|
634
|
-
* The UTM term of the short link.
|
|
635
|
-
*/
|
|
636
|
-
utm_term: string | null;
|
|
637
|
-
}
|
|
638
|
-
export declare namespace LinkDeleteLinkResponse {
|
|
639
|
-
interface Tag {
|
|
640
|
-
/**
|
|
641
|
-
* The unique ID of the tag.
|
|
642
|
-
*/
|
|
643
|
-
id: string;
|
|
644
|
-
/**
|
|
645
|
-
* The color of the tag.
|
|
646
|
-
*/
|
|
647
|
-
color: 'red' | 'yellow' | 'green' | 'blue' | 'purple' | 'pink' | 'brown';
|
|
648
|
-
/**
|
|
649
|
-
* The name of the tag.
|
|
650
|
-
*/
|
|
651
|
-
name: string;
|
|
652
|
-
}
|
|
653
|
-
}
|
|
654
|
-
export interface LinkCreateParams {
|
|
655
|
-
/**
|
|
656
|
-
* Query param: The slug for the project that the link belongs to. E.g. for
|
|
657
|
-
* `app.dub.co/acme`, the projectSlug is `acme`.
|
|
658
|
-
*/
|
|
659
|
-
projectSlug?: string;
|
|
660
|
-
/**
|
|
661
|
-
* Body param: The destination URL of the short link.
|
|
662
|
-
*/
|
|
663
|
-
url: string;
|
|
664
|
-
/**
|
|
665
|
-
* Body param: The Android destination URL for the short link for Android device
|
|
666
|
-
* targeting.
|
|
667
|
-
*/
|
|
668
|
-
android?: string | null;
|
|
669
|
-
/**
|
|
670
|
-
* Body param: Whether the short link is archived.
|
|
671
|
-
*/
|
|
672
|
-
archived?: boolean;
|
|
673
|
-
/**
|
|
674
|
-
* Body param: The comments for the short link.
|
|
675
|
-
*/
|
|
676
|
-
comments?: string | null;
|
|
677
|
-
/**
|
|
678
|
-
* Body param: The description of the short link generated via
|
|
679
|
-
* `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is
|
|
680
|
-
* true.
|
|
681
|
-
*/
|
|
682
|
-
description?: string | null;
|
|
683
|
-
/**
|
|
684
|
-
* Body param: The domain of the short link. If not provided, the primary domain
|
|
685
|
-
* for the project will be used (or `dub.sh` if the project has no domains).
|
|
686
|
-
*/
|
|
687
|
-
domain?: string;
|
|
688
|
-
/**
|
|
689
|
-
* Body param: The date and time when the short link will expire in ISO-8601
|
|
690
|
-
* format. Must be in the future.
|
|
691
|
-
*/
|
|
692
|
-
expiresAt?: string | null;
|
|
693
|
-
/**
|
|
694
|
-
* Body param: Geo targeting information for the short link in JSON format
|
|
695
|
-
* `{[COUNTRY]: https://example.com }`.
|
|
696
|
-
*/
|
|
697
|
-
geo?: Record<string, string> | null;
|
|
698
|
-
/**
|
|
699
|
-
* Body param: The image of the short link generated via `api.dub.co/metatags`.
|
|
700
|
-
* Will be used for Custom Social Media Cards if `proxy` is true.
|
|
701
|
-
*/
|
|
702
|
-
image?: string | null;
|
|
703
|
-
/**
|
|
704
|
-
* Body param: The iOS destination URL for the short link for iOS device targeting.
|
|
705
|
-
*/
|
|
706
|
-
ios?: string | null;
|
|
707
|
-
/**
|
|
708
|
-
* Body param: The short link slug. If not provided, a random 7-character slug will
|
|
709
|
-
* be generated.
|
|
710
|
-
*/
|
|
711
|
-
key?: string;
|
|
712
|
-
/**
|
|
713
|
-
* Body param: The password required to access the destination URL of the short
|
|
714
|
-
* link.
|
|
715
|
-
*/
|
|
716
|
-
password?: string | null;
|
|
717
|
-
/**
|
|
718
|
-
* Body param: The prefix of the short link slug for randomly-generated keys (e.g.
|
|
719
|
-
* if prefix is `/c/`, generated keys will be in the `/c/:key` format). Will be
|
|
720
|
-
* ignored if `key` is provided.
|
|
721
|
-
*/
|
|
722
|
-
prefix?: string;
|
|
723
|
-
/**
|
|
724
|
-
* Body param: Whether the short link uses Custom Social Media Cards feature.
|
|
725
|
-
*/
|
|
726
|
-
proxy?: boolean;
|
|
727
|
-
/**
|
|
728
|
-
* Body param: Whether the short link's stats are publicly accessible.
|
|
729
|
-
*/
|
|
730
|
-
publicStats?: boolean;
|
|
731
|
-
/**
|
|
732
|
-
* Body param: Whether the short link uses link cloaking.
|
|
733
|
-
*/
|
|
734
|
-
rewrite?: boolean;
|
|
735
|
-
/**
|
|
736
|
-
* Body param: [DEPRECATED (use tagIds instead)]: The unique ID of the tag assigned
|
|
737
|
-
* to the short link.
|
|
738
|
-
*/
|
|
739
|
-
tagId?: string | null;
|
|
740
|
-
/**
|
|
741
|
-
* Body param: The unique IDs of the tags assigned to the short link.
|
|
742
|
-
*/
|
|
743
|
-
tagIds?: string | Array<string>;
|
|
744
|
-
/**
|
|
745
|
-
* Body param: The title of the short link generated via `api.dub.co/metatags`.
|
|
746
|
-
* Will be used for Custom Social Media Cards if `proxy` is true.
|
|
747
|
-
*/
|
|
748
|
-
title?: string | null;
|
|
749
|
-
}
|
|
750
|
-
export interface LinkUpdateParams {
|
|
751
|
-
/**
|
|
752
|
-
* Query param: The slug for the project that the link belongs to. E.g. for
|
|
753
|
-
* `app.dub.co/acme`, the projectSlug is `acme`.
|
|
754
|
-
*/
|
|
755
|
-
projectSlug?: string;
|
|
756
|
-
/**
|
|
757
|
-
* Body param: The destination URL of the short link.
|
|
758
|
-
*/
|
|
759
|
-
url: string;
|
|
760
|
-
/**
|
|
761
|
-
* Body param: The Android destination URL for the short link for Android device
|
|
762
|
-
* targeting.
|
|
763
|
-
*/
|
|
764
|
-
android?: string | null;
|
|
765
|
-
/**
|
|
766
|
-
* Body param: Whether the short link is archived.
|
|
767
|
-
*/
|
|
768
|
-
archived?: boolean;
|
|
769
|
-
/**
|
|
770
|
-
* Body param: The comments for the short link.
|
|
771
|
-
*/
|
|
772
|
-
comments?: string | null;
|
|
773
|
-
/**
|
|
774
|
-
* Body param: The description of the short link generated via
|
|
775
|
-
* `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is
|
|
776
|
-
* true.
|
|
777
|
-
*/
|
|
778
|
-
description?: string | null;
|
|
779
|
-
/**
|
|
780
|
-
* Body param: The domain of the short link. If not provided, the primary domain
|
|
781
|
-
* for the project will be used (or `dub.sh` if the project has no domains).
|
|
782
|
-
*/
|
|
783
|
-
domain?: string;
|
|
784
|
-
/**
|
|
785
|
-
* Body param: The date and time when the short link will expire in ISO-8601
|
|
786
|
-
* format. Must be in the future.
|
|
787
|
-
*/
|
|
788
|
-
expiresAt?: string | null;
|
|
789
|
-
/**
|
|
790
|
-
* Body param: Geo targeting information for the short link in JSON format
|
|
791
|
-
* `{[COUNTRY]: https://example.com }`.
|
|
792
|
-
*/
|
|
793
|
-
geo?: Record<string, string> | null;
|
|
794
|
-
/**
|
|
795
|
-
* Body param: The image of the short link generated via `api.dub.co/metatags`.
|
|
796
|
-
* Will be used for Custom Social Media Cards if `proxy` is true.
|
|
797
|
-
*/
|
|
798
|
-
image?: string | null;
|
|
799
|
-
/**
|
|
800
|
-
* Body param: The iOS destination URL for the short link for iOS device targeting.
|
|
801
|
-
*/
|
|
802
|
-
ios?: string | null;
|
|
803
|
-
/**
|
|
804
|
-
* Body param: The short link slug. If not provided, a random 7-character slug will
|
|
805
|
-
* be generated.
|
|
806
|
-
*/
|
|
807
|
-
key?: string;
|
|
808
|
-
/**
|
|
809
|
-
* Body param: The password required to access the destination URL of the short
|
|
810
|
-
* link.
|
|
811
|
-
*/
|
|
812
|
-
password?: string | null;
|
|
813
|
-
/**
|
|
814
|
-
* Body param: The prefix of the short link slug for randomly-generated keys (e.g.
|
|
815
|
-
* if prefix is `/c/`, generated keys will be in the `/c/:key` format). Will be
|
|
816
|
-
* ignored if `key` is provided.
|
|
817
|
-
*/
|
|
818
|
-
prefix?: string;
|
|
819
|
-
/**
|
|
820
|
-
* Body param: Whether the short link uses Custom Social Media Cards feature.
|
|
821
|
-
*/
|
|
822
|
-
proxy?: boolean;
|
|
823
|
-
/**
|
|
824
|
-
* Body param: Whether the short link's stats are publicly accessible.
|
|
825
|
-
*/
|
|
826
|
-
publicStats?: boolean;
|
|
827
|
-
/**
|
|
828
|
-
* Body param: Whether the short link uses link cloaking.
|
|
829
|
-
*/
|
|
830
|
-
rewrite?: boolean;
|
|
831
|
-
/**
|
|
832
|
-
* Body param: [DEPRECATED (use tagIds instead)]: The unique ID of the tag assigned
|
|
833
|
-
* to the short link.
|
|
834
|
-
*/
|
|
835
|
-
tagId?: string | null;
|
|
836
|
-
/**
|
|
837
|
-
* Body param: The unique IDs of the tags assigned to the short link.
|
|
838
|
-
*/
|
|
839
|
-
tagIds?: string | Array<string>;
|
|
840
|
-
/**
|
|
841
|
-
* Body param: The title of the short link generated via `api.dub.co/metatags`.
|
|
842
|
-
* Will be used for Custom Social Media Cards if `proxy` is true.
|
|
843
|
-
*/
|
|
844
|
-
title?: string | null;
|
|
845
|
-
}
|
|
846
|
-
export interface LinkListParams {
|
|
847
|
-
/**
|
|
848
|
-
* The slug for the project that the link belongs to. E.g. for `app.dub.co/acme`,
|
|
849
|
-
* the projectSlug is `acme`.
|
|
850
|
-
*/
|
|
851
|
-
projectSlug?: string;
|
|
852
|
-
/**
|
|
853
|
-
* The domain to filter the links by. E.g. `ac.me`. If not provided, all links for
|
|
854
|
-
* the project will be returned.
|
|
855
|
-
*/
|
|
856
|
-
domain?: string;
|
|
857
|
-
/**
|
|
858
|
-
* The page number for pagination (each page contains 100 links).
|
|
859
|
-
*/
|
|
860
|
-
page?: number;
|
|
861
|
-
/**
|
|
862
|
-
* The search term to filter the links by. The search term will be matched against
|
|
863
|
-
* the short link slug and the destination url.
|
|
864
|
-
*/
|
|
865
|
-
search?: string;
|
|
866
|
-
/**
|
|
867
|
-
* Whether to include archived links in the response. Defaults to `false` if not
|
|
868
|
-
* provided.
|
|
869
|
-
*/
|
|
870
|
-
showArchived?: boolean;
|
|
871
|
-
/**
|
|
872
|
-
* The field to sort the links by. The default is `createdAt`, and sort order is
|
|
873
|
-
* always descending.
|
|
874
|
-
*/
|
|
875
|
-
sort?: 'createdAt' | 'clicks' | 'lastClicked';
|
|
876
|
-
/**
|
|
877
|
-
* [DEPRECATED (use tagIds instead)]: The tag ID to filter the links by.
|
|
878
|
-
*/
|
|
879
|
-
tagId?: string;
|
|
880
|
-
/**
|
|
881
|
-
* The tag IDs to filter the links by.
|
|
882
|
-
*/
|
|
883
|
-
tagIds?: string | Array<string>;
|
|
884
|
-
/**
|
|
885
|
-
* The user ID to filter the links by.
|
|
886
|
-
*/
|
|
887
|
-
userId?: string;
|
|
888
|
-
/**
|
|
889
|
-
* Whether to include tags in the response. Defaults to `false` if not provided.
|
|
890
|
-
*/
|
|
891
|
-
withTags?: boolean;
|
|
892
|
-
}
|
|
893
|
-
export interface LinkDeleteLinkParams {
|
|
894
|
-
/**
|
|
895
|
-
* The slug for the project that the link belongs to. E.g. for `app.dub.co/acme`,
|
|
896
|
-
* the projectSlug is `acme`.
|
|
897
|
-
*/
|
|
898
|
-
projectSlug?: string;
|
|
899
|
-
}
|
|
900
|
-
export declare namespace Links {
|
|
901
|
-
export import LinkCreateResponse = LinksAPI.LinkCreateResponse;
|
|
902
|
-
export import LinkUpdateResponse = LinksAPI.LinkUpdateResponse;
|
|
903
|
-
export import LinkListResponse = LinksAPI.LinkListResponse;
|
|
904
|
-
export import LinkDeleteLinkResponse = LinksAPI.LinkDeleteLinkResponse;
|
|
905
|
-
export import LinkCreateParams = LinksAPI.LinkCreateParams;
|
|
906
|
-
export import LinkUpdateParams = LinksAPI.LinkUpdateParams;
|
|
907
|
-
export import LinkListParams = LinksAPI.LinkListParams;
|
|
908
|
-
export import LinkDeleteLinkParams = LinksAPI.LinkDeleteLinkParams;
|
|
909
|
-
export import Info = InfoAPI.Info;
|
|
910
|
-
export import InfoRetrieveResponse = InfoAPI.InfoRetrieveResponse;
|
|
911
|
-
export import InfoRetrieveParams = InfoAPI.InfoRetrieveParams;
|
|
912
|
-
export import Bulk = BulkAPI.Bulk;
|
|
913
|
-
export import BulkCreateResponse = BulkAPI.BulkCreateResponse;
|
|
914
|
-
export import BulkCreateParams = BulkAPI.BulkCreateParams;
|
|
915
|
-
}
|
|
916
|
-
//# sourceMappingURL=links.d.ts.map
|