From d69034ae19aeed975cc7656e9808fd8d33ef8d96 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Fri, 10 Jan 2025 16:38:05 +0000 Subject: [PATCH] ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.467.1 --- .speakeasy/gen.lock | 19 +- .speakeasy/gen.yaml | 2 +- .speakeasy/workflow.lock | 14 +- RELEASES.md | 12 +- docs/models/components/analyticsbrowsers.md | 2 +- docs/models/components/analyticscities.md | 4 +- .../components/analyticscitiescountry.md | 2 +- docs/models/components/analyticscontinents.md | 2 +- docs/models/components/analyticscountries.md | 2 +- docs/models/components/analyticsreferers.md | 2 +- .../models/components/analyticsrefererurls.md | 2 +- docs/models/components/analyticstoplinks.md | 6 +- docs/models/components/analyticstopurls.md | 2 +- docs/models/components/click.md | 18 +- docs/models/components/clickevent.md | 64 +++--- docs/models/components/code.md | 17 ++ docs/models/components/continent.md | 2 +- docs/models/components/continentcode.md | 2 +- docs/models/components/country.md | 2 +- docs/models/components/countrycode.md | 2 +- docs/models/components/customer.md | 2 +- docs/models/components/data.md | 34 +-- docs/models/components/discount.md | 4 +- docs/models/components/domainschema.md | 8 +- docs/models/components/interval.md | 2 +- docs/models/components/leadcreatedevent.md | 50 ++--- .../components/leadcreatedeventclick.md | 16 +- .../components/leadcreatedeventcustomer.md | 2 +- .../models/components/leadcreatedeventdata.md | 46 ++-- .../components/leadcreatedeventdatalink.md | 4 +- .../components/leadcreatedeventdiscount.md | 4 +- .../components/leadcreatedeventinterval.md | 2 +- .../models/components/leadcreatedeventlink.md | 34 +-- .../components/leadcreatedeventpartner.md | 2 +- docs/models/components/leadevent.md | 67 +++--- docs/models/components/leadeventclick.md | 18 +- .../components/leadeventcustomerlink.md | 4 +- docs/models/components/leadeventlink.md | 34 +-- docs/models/components/link.md | 34 +-- docs/models/components/linkclickedevent.md | 48 ++-- .../components/linkclickedeventclick.md | 18 +- .../models/components/linkclickedeventdata.md | 48 ++-- .../models/components/linkclickedeventlink.md | 34 +-- docs/models/components/linkerrorschema.md | 20 ++ docs/models/components/linkschema.md | 14 +- docs/models/components/linkwebhookevent.md | 33 ++- docs/models/components/partner.md | 2 +- docs/models/components/paymentprocessor.md | 2 +- docs/models/components/plan.md | 2 +- docs/models/components/registereddomain.md | 4 +- docs/models/components/role.md | 2 +- docs/models/components/sale.md | 4 +- docs/models/components/salecreatedevent.md | 54 +++-- .../components/salecreatedeventclick.md | 20 +- .../components/salecreatedeventcustomer.md | 2 +- .../models/components/salecreatedeventdata.md | 49 +++-- .../components/salecreatedeventdatalink.md | 4 +- .../components/salecreatedeventdiscount.md | 6 +- .../models/components/salecreatedeventlink.md | 36 ++- .../components/salecreatedeventpartner.md | 2 +- .../models/components/salecreatedeventsale.md | 4 +- docs/models/components/saleevent.md | 72 +++--- docs/models/components/saleeventclick.md | 16 +- docs/models/components/saleeventcustomer.md | 2 +- .../components/saleeventcustomerlink.md | 4 +- docs/models/components/saleeventdiscount.md | 6 +- docs/models/components/saleeventinterval.md | 2 +- docs/models/components/saleeventlink.md | 36 +-- docs/models/components/saleeventpartner.md | 2 +- docs/models/components/saleeventtype.md | 2 +- docs/models/components/trigger.md | 2 +- docs/models/components/webhookevent.md | 191 ++++++++-------- docs/models/components/workspaceschema.md | 30 +-- .../operations/bulkdeletelinksresponsebody.md | 2 +- docs/models/operations/color.md | 2 +- .../operations/createcustomerdiscount.md | 6 +- docs/models/operations/createcustomerlink.md | 4 +- .../operations/createcustomerpartner.md | 2 +- .../operations/createcustomerresponsebody.md | 2 +- docs/models/operations/createcustomertype.md | 2 +- docs/models/operations/customer.md | 4 +- docs/models/operations/discount.md | 8 +- docs/models/operations/getcustomerdiscount.md | 6 +- docs/models/operations/getcustomerinterval.md | 2 +- docs/models/operations/getcustomerlink.md | 4 +- docs/models/operations/getcustomerpartner.md | 2 +- .../operations/getcustomerresponsebody.md | 2 +- .../models/operations/getcustomersinterval.md | 2 +- .../operations/getcustomersresponsebody.md | 29 +++ docs/models/operations/getcustomertype.md | 2 +- docs/models/operations/getlinksrequest.md | 4 +- docs/models/operations/getlinksresponse.md | 28 +-- docs/models/operations/getqrcoderequest.md | 2 +- docs/models/operations/interval.md | 2 +- docs/models/operations/level.md | 2 +- docs/models/operations/link.md | 4 +- docs/models/operations/listdomainsresponse.md | 8 +- docs/models/operations/listeventsrequest.md | 5 +- .../operations/listeventsresponsebody.md | 207 +++++++++--------- docs/models/operations/order.md | 6 +- docs/models/operations/partner.md | 2 +- docs/models/operations/queryparamevent.md | 2 +- docs/models/operations/queryparamgroupby.md | 2 +- docs/models/operations/queryparaminterval.md | 2 +- docs/models/operations/queryparamsortby.md | 17 ++ docs/models/operations/queryparamsortorder.md | 17 ++ docs/models/operations/queryparamtrigger.md | 2 +- docs/models/operations/responsebody.md | 72 ++++-- .../retrieveanalyticsresponsebody.md | 26 +-- docs/models/operations/sale.md | 4 +- docs/models/operations/sort.md | 8 +- docs/models/operations/sortby.md | 6 +- docs/models/operations/sortorder.md | 17 ++ .../operations/trackleadresponsebody.md | 4 +- docs/models/operations/tracksalecustomer.md | 4 +- .../models/operations/tracksalerequestbody.md | 2 +- .../operations/tracksaleresponsebody.md | 8 +- docs/models/operations/trigger.md | 2 +- .../operations/updatecustomerdiscount.md | 4 +- .../operations/updatecustomerinterval.md | 2 +- docs/models/operations/updatecustomerlink.md | 4 +- .../operations/updatecustomerpartner.md | 2 +- .../operations/updatecustomerresponsebody.md | 2 +- docs/models/operations/updatecustomertype.md | 2 +- docs/models/operations/updatetagcolor.md | 2 +- docs/sdks/customers/README.md | 2 +- docs/sdks/links/README.md | 2 +- jsr.json | 2 +- package-lock.json | 4 +- package.json | 2 +- src/funcs/customersList.ts | 6 +- src/funcs/eventsList.ts | 1 + src/funcs/linksCreateMany.ts | 7 +- src/funcs/linksList.ts | 2 + src/lib/config.ts | 6 +- src/models/components/clickevent.ts | 6 +- src/models/components/index.ts | 1 + src/models/components/leadcreatedevent.ts | 6 +- src/models/components/leadevent.ts | 6 +- src/models/components/linkclickedevent.ts | 6 +- src/models/components/linkerrorschema.ts | 123 +++++++++++ src/models/components/linkschema.ts | 8 +- src/models/components/linkwebhookevent.ts | 6 +- src/models/components/salecreatedevent.ts | 6 +- src/models/components/saleevent.ts | 6 +- src/models/components/workspaceschema.ts | 2 +- src/models/operations/bulkcreatelinks.ts | 54 +++++ src/models/operations/getcustomers.ts | 44 ++-- src/models/operations/getlinks.ts | 89 +++++++- src/models/operations/listevents.ts | 118 +++++++--- src/sdk/customers.ts | 2 +- src/sdk/links.ts | 2 +- 152 files changed, 1455 insertions(+), 946 deletions(-) create mode 100644 docs/models/components/code.md create mode 100644 docs/models/components/linkerrorschema.md create mode 100644 docs/models/operations/getcustomersresponsebody.md create mode 100644 docs/models/operations/queryparamsortby.md create mode 100644 docs/models/operations/queryparamsortorder.md create mode 100644 docs/models/operations/sortorder.md create mode 100644 src/models/components/linkerrorschema.ts diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index f5720e41..84bad49a 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: f28179cc-ef59-426d-9e85-60cec22fc642 management: - docChecksum: a1673689081e8ce390ebd113f53dedd4 + docChecksum: a6a1e65c1a9ddd2d1b445252e12b8157 docVersion: 0.0.1 - speakeasyVersion: 1.465.0 - generationVersion: 2.486.6 - releaseVersion: 0.46.11 - configChecksum: 85546426f45a37e7631ff9b6852598ec + speakeasyVersion: 1.467.1 + generationVersion: 2.492.3 + releaseVersion: 0.46.12 + configChecksum: dfa902336db61b73370eca4535e8afab repoURL: https://github.com/dubinc/dub-ts.git installationURL: https://github.com/dubinc/dub-ts published: true @@ -20,7 +20,7 @@ features: enumUnions: 0.1.0 envVarSecurityUsage: 0.1.2 errors: 2.84.0 - examples: 2.81.4 + examples: 2.81.5 flattening: 2.82.1 globalSecurity: 2.82.12 globalSecurityCallbacks: 0.1.0 @@ -62,6 +62,7 @@ generatedFiles: - docs/models/components/click.md - docs/models/components/clickevent.md - docs/models/components/clickeventgeo.md + - docs/models/components/code.md - docs/models/components/color.md - docs/models/components/continent.md - docs/models/components/continentcode.md @@ -100,6 +101,7 @@ generatedFiles: - docs/models/components/linkclickedeventevent.md - docs/models/components/linkclickedeventgeo.md - docs/models/components/linkclickedeventlink.md + - docs/models/components/linkerrorschema.md - docs/models/components/linkgeotargeting.md - docs/models/components/linkschema.md - docs/models/components/linkwebhookevent.md @@ -213,6 +215,7 @@ generatedFiles: - docs/models/operations/getcustomerresponsebody.md - docs/models/operations/getcustomersinterval.md - docs/models/operations/getcustomersrequest.md + - docs/models/operations/getcustomersresponsebody.md - docs/models/operations/getcustomertype.md - docs/models/operations/getlinkinforequest.md - docs/models/operations/getlinkscountqueryparamtagids.md @@ -240,6 +243,8 @@ generatedFiles: - docs/models/operations/queryparamevent.md - docs/models/operations/queryparamgroupby.md - docs/models/operations/queryparaminterval.md + - docs/models/operations/queryparamsortby.md + - docs/models/operations/queryparamsortorder.md - docs/models/operations/queryparamtagids.md - docs/models/operations/queryparamtagnames.md - docs/models/operations/queryparamtrigger.md @@ -251,6 +256,7 @@ generatedFiles: - docs/models/operations/sale.md - docs/models/operations/sort.md - docs/models/operations/sortby.md + - docs/models/operations/sortorder.md - docs/models/operations/tagids.md - docs/models/operations/tagnames.md - docs/models/operations/three.md @@ -370,6 +376,7 @@ generatedFiles: - src/models/components/leadcreatedevent.ts - src/models/components/leadevent.ts - src/models/components/linkclickedevent.ts + - src/models/components/linkerrorschema.ts - src/models/components/linkgeotargeting.ts - src/models/components/linkschema.ts - src/models/components/linkwebhookevent.ts diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 641b9001..81fcfad7 100755 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -13,7 +13,7 @@ generation: oAuth2ClientCredentialsEnabled: false oAuth2PasswordEnabled: false typescript: - version: 0.46.11 + version: 0.46.12 additionalDependencies: dependencies: {} devDependencies: diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index e85b7f83..7450824e 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,21 +1,21 @@ -speakeasyVersion: 1.465.0 +speakeasyVersion: 1.467.1 sources: my-first-source: sourceNamespace: my-first-source - sourceRevisionDigest: sha256:38a3a17fa2be1760f620ee60b4b6718c0b2321e71b710cdbb26dbe38a74cdcb7 - sourceBlobDigest: sha256:71553e2ce6438f512c90c2db95f513c06e41731247256475044c7189c64bd985 + sourceRevisionDigest: sha256:85104d38e2650d5a3d27beab8a68a5350a049aab20fc5dd589eb5d1fe52f9a17 + sourceBlobDigest: sha256:e455cd12338a6074213fe801f891abdf883b45dae8c4f90f6ac421ee4b3c4449 tags: - latest - - speakeasy-sdk-regen-1736296006 + - speakeasy-sdk-regen-1736382385 - 0.0.1 targets: my-first-target: source: my-first-source sourceNamespace: my-first-source - sourceRevisionDigest: sha256:38a3a17fa2be1760f620ee60b4b6718c0b2321e71b710cdbb26dbe38a74cdcb7 - sourceBlobDigest: sha256:71553e2ce6438f512c90c2db95f513c06e41731247256475044c7189c64bd985 + sourceRevisionDigest: sha256:85104d38e2650d5a3d27beab8a68a5350a049aab20fc5dd589eb5d1fe52f9a17 + sourceBlobDigest: sha256:e455cd12338a6074213fe801f891abdf883b45dae8c4f90f6ac421ee4b3c4449 codeSamplesNamespace: code-samples-typescript-my-first-target - codeSamplesRevisionDigest: sha256:76a738404a0aebb0e34f368a543debada41c0917e309bd936c3c95f410b7c1f5 + codeSamplesRevisionDigest: sha256:29a54be63def879e23b254d819a884b21717470cbd25d9ce7d56e5c66a34bdf8 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/RELEASES.md b/RELEASES.md index 37d3428c..3d02ae80 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -1116,4 +1116,14 @@ Based on: ### Generated - [typescript v0.46.11] . ### Releases -- [NPM v0.46.11] https://www.npmjs.com/package/dub/v/0.46.11 - . \ No newline at end of file +- [NPM v0.46.11] https://www.npmjs.com/package/dub/v/0.46.11 - . + +## 2025-01-10 16:36:46 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.467.1 (2.492.3) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v0.46.12] . +### Releases +- [NPM v0.46.12] https://www.npmjs.com/package/dub/v/0.46.12 - . \ No newline at end of file diff --git a/docs/models/components/analyticsbrowsers.md b/docs/models/components/analyticsbrowsers.md index 44655a60..ef9cfd82 100644 --- a/docs/models/components/analyticsbrowsers.md +++ b/docs/models/components/analyticsbrowsers.md @@ -6,7 +6,7 @@ import { AnalyticsBrowsers } from "dub/models/components"; let value: AnalyticsBrowsers = { - browser: "Firefox", + browser: "Chrome", }; ``` diff --git a/docs/models/components/analyticscities.md b/docs/models/components/analyticscities.md index 79aaf040..b93f0c3d 100644 --- a/docs/models/components/analyticscities.md +++ b/docs/models/components/analyticscities.md @@ -6,8 +6,8 @@ import { AnalyticsCities } from "dub/models/components"; let value: AnalyticsCities = { - city: "Anissamouth", - country: "BL", + city: "Wilbertside", + country: "GD", }; ``` diff --git a/docs/models/components/analyticscitiescountry.md b/docs/models/components/analyticscitiescountry.md index 6ea5e91e..feb7a1f6 100644 --- a/docs/models/components/analyticscitiescountry.md +++ b/docs/models/components/analyticscitiescountry.md @@ -7,7 +7,7 @@ The 2-letter country code of the city: https://d.to/geo ```typescript import { AnalyticsCitiesCountry } from "dub/models/components"; -let value: AnalyticsCitiesCountry = "FJ"; +let value: AnalyticsCitiesCountry = "BS"; ``` ## Values diff --git a/docs/models/components/analyticscontinents.md b/docs/models/components/analyticscontinents.md index 1a92f121..ea13dce2 100644 --- a/docs/models/components/analyticscontinents.md +++ b/docs/models/components/analyticscontinents.md @@ -6,7 +6,7 @@ import { AnalyticsContinents } from "dub/models/components"; let value: AnalyticsContinents = { - continent: "SA", + continent: "OC", }; ``` diff --git a/docs/models/components/analyticscountries.md b/docs/models/components/analyticscountries.md index 717a9b75..a047f01b 100644 --- a/docs/models/components/analyticscountries.md +++ b/docs/models/components/analyticscountries.md @@ -6,7 +6,7 @@ import { AnalyticsCountries } from "dub/models/components"; let value: AnalyticsCountries = { - country: "ES", + country: "NR", }; ``` diff --git a/docs/models/components/analyticsreferers.md b/docs/models/components/analyticsreferers.md index 175332ec..176a508d 100644 --- a/docs/models/components/analyticsreferers.md +++ b/docs/models/components/analyticsreferers.md @@ -6,7 +6,7 @@ import { AnalyticsReferers } from "dub/models/components"; let value: AnalyticsReferers = { - referer: "waterlogged-sediment.name", + referer: "present-sushi.biz", }; ``` diff --git a/docs/models/components/analyticsrefererurls.md b/docs/models/components/analyticsrefererurls.md index d8eb2ee1..2a53a986 100644 --- a/docs/models/components/analyticsrefererurls.md +++ b/docs/models/components/analyticsrefererurls.md @@ -6,7 +6,7 @@ import { AnalyticsRefererUrls } from "dub/models/components"; let value: AnalyticsRefererUrls = { - refererUrl: "https://frank-steak.name", + refererUrl: "https://pointless-adult.info", }; ``` diff --git a/docs/models/components/analyticstoplinks.md b/docs/models/components/analyticstoplinks.md index 1d9a08b9..9eb2d3b4 100644 --- a/docs/models/components/analyticstoplinks.md +++ b/docs/models/components/analyticstoplinks.md @@ -8,11 +8,11 @@ import { AnalyticsTopLinks } from "dub/models/components"; let value: AnalyticsTopLinks = { link: "", id: "", - domain: "afraid-folklore.com", + domain: "creamy-wedding.info", key: "", shortLink: "", - url: "https://livid-king.name", - createdAt: "1716387842609", + url: "https://productive-fundraising.com/", + createdAt: "1730917345329", }; ``` diff --git a/docs/models/components/analyticstopurls.md b/docs/models/components/analyticstopurls.md index 5a404279..53bc50d3 100644 --- a/docs/models/components/analyticstopurls.md +++ b/docs/models/components/analyticstopurls.md @@ -6,7 +6,7 @@ import { AnalyticsTopUrls } from "dub/models/components"; let value: AnalyticsTopUrls = { - url: "https://super-cop-out.name/", + url: "https://merry-declaration.com/", }; ``` diff --git a/docs/models/components/click.md b/docs/models/components/click.md index 1d0f7b30..0ab314ec 100644 --- a/docs/models/components/click.md +++ b/docs/models/components/click.md @@ -7,17 +7,17 @@ import { Click } from "dub/models/components"; let value: Click = { id: "", - url: "https://windy-version.org", - country: "Samoa", - city: "North Gwendolyn", + url: "https://untimely-sand.biz", + country: "Belarus", + city: "Darionville", region: "", - continent: "Antarctica", - device: "Desktop", + continent: "Africa", + device: "Mobile", browser: "Chrome", - os: "Blackberry", - referer: "advanced-rust.com", - refererUrl: "https://brisk-pilot.biz/", - ip: "142.220.186.69", + os: "WebOS", + referer: "crafty-bin.com", + refererUrl: "https://exotic-hepatitis.name", + ip: "f521:65af:f683:b1fb:b58c:684a:0b1b:6cfe", }; ``` diff --git a/docs/models/components/clickevent.md b/docs/models/components/clickevent.md index 25794cf2..fc5f557f 100644 --- a/docs/models/components/clickevent.md +++ b/docs/models/components/clickevent.md @@ -9,32 +9,33 @@ let value: ClickEvent = { event: "click", click: { id: "", - url: "https://illiterate-valentine.biz/", - country: "Canada", - city: "Kenner", + url: "https://worldly-sundae.name/", + country: "Turks and Caicos Islands", + city: "Theresiahaven", region: "", continent: "South America", - device: "Desktop", - browser: "Firefox", - os: "iOS", - referer: "blushing-possession.biz", - refererUrl: "https://bare-bar.org/", - ip: "deb6:f7a8:f37e:1da6:5b8a:7f22:7de8:f7fe", + device: "Mobile", + browser: "Chrome", + os: "MacOS", + referer: "illiterate-valentine.biz", + refererUrl: "https://unfortunate-hydrolyze.org/", + ip: "169.112.19.178", }, link: { id: "", - domain: "stylish-wallaby.org", + domain: "experienced-antelope.com", key: "", - url: "https://rundown-fisherman.com", + url: "https://untried-redesign.org/", externalId: "", tenantId: "", - expiresAt: "1738275448873", - expiredUrl: "https://ironclad-lender.net/", - password: "YgqyFEb_rPX71rM", + expiresAt: "1757737597554", + expiredUrl: "https://frugal-yogurt.info", + password: "MD1aZN7QCLAAY_F", title: "", - description: "kiddingly woot amid", - image: "https://loremflickr.com/1620/1622?lock=269768544161309", - video: "https://picsum.videos/seed/DX6R1xpwm/2949/440", + description: + "sneaky never hmph though unfortunately hmph ha gadzooks although cap", + image: "https://picsum.photos/seed/wmb1wQn/3468/117", + video: "https://loremflickr.com/892/323?lock=1994161906050562", ios: "", android: "", geo: {}, @@ -43,15 +44,16 @@ let value: ClickEvent = { { id: "", name: "", - color: "yellow", + color: "red", }, ], webhookIds: [ "", ], - comments: "dead midst hm upright indeed", - shortLink: "https://major-pleasure.biz/", - qrCode: "https://clear-cut-coal.com", + comments: + "drat skeletal without kielbasa with vibration swanling drat squiggly", + shortLink: "https://exhausted-cycle.com", + qrCode: "https://free-ignorance.info", utmSource: "", utmMedium: "", utmCampaign: "", @@ -60,24 +62,24 @@ let value: ClickEvent = { userId: "", workspaceId: "", lastClicked: "", - createdAt: "1735377144762", - updatedAt: "1736214092483", + createdAt: "1729531460127", + updatedAt: "1736513582528", projectId: "", programId: "", }, clickId: "", linkId: "", - domain: "definitive-nun.com", + domain: "cool-hoof.org", key: "", - url: "https://self-assured-vibration.name", - continent: "Asia", - country: "Mali", - city: "Madera", + url: "https://carefree-cleaner.biz", + continent: "Africa", + country: "Iran", + city: "New Delbertstead", device: "Desktop", browser: "Safari", - os: "iOS", - qr: 13.83, - ip: "81.219.117.113", + os: "Symbian", + qr: 3917.97, + ip: "64.123.10.163", }; ``` diff --git a/docs/models/components/code.md b/docs/models/components/code.md new file mode 100644 index 00000000..f6b4e049 --- /dev/null +++ b/docs/models/components/code.md @@ -0,0 +1,17 @@ +# Code + +The error code. + +## Example Usage + +```typescript +import { Code } from "dub/models/components"; + +let value: Code = "bad_request"; +``` + +## Values + +```typescript +"bad_request" | "not_found" | "internal_server_error" | "unauthorized" | "forbidden" | "rate_limit_exceeded" | "invite_expired" | "invite_pending" | "exceeded_limit" | "conflict" | "unprocessable_entity" +``` \ No newline at end of file diff --git a/docs/models/components/continent.md b/docs/models/components/continent.md index ac24ab8d..af62122e 100644 --- a/docs/models/components/continent.md +++ b/docs/models/components/continent.md @@ -7,7 +7,7 @@ The 2-letter ISO 3166-1 code representing the continent associated with the loca ```typescript import { Continent } from "dub/models/components"; -let value: Continent = "AF"; +let value: Continent = "NA"; ``` ## Values diff --git a/docs/models/components/continentcode.md b/docs/models/components/continentcode.md index 4476b7b3..692c6538 100644 --- a/docs/models/components/continentcode.md +++ b/docs/models/components/continentcode.md @@ -7,7 +7,7 @@ The continent to retrieve analytics for. ```typescript import { ContinentCode } from "dub/models/components"; -let value: ContinentCode = "AN"; +let value: ContinentCode = "SA"; ``` ## Values diff --git a/docs/models/components/country.md b/docs/models/components/country.md index 6e3114cf..d5b3c73c 100644 --- a/docs/models/components/country.md +++ b/docs/models/components/country.md @@ -7,7 +7,7 @@ The 2-letter ISO 3166-1 country code for the country associated with the locatio ```typescript import { Country } from "dub/models/components"; -let value: Country = "PH"; +let value: Country = "FJ"; ``` ## Values diff --git a/docs/models/components/countrycode.md b/docs/models/components/countrycode.md index 5923b3b0..9c1d118f 100644 --- a/docs/models/components/countrycode.md +++ b/docs/models/components/countrycode.md @@ -7,7 +7,7 @@ The country to retrieve analytics for. ```typescript import { CountryCode } from "dub/models/components"; -let value: CountryCode = "BT"; +let value: CountryCode = "ME"; ``` ## Values diff --git a/docs/models/components/customer.md b/docs/models/components/customer.md index 27003e3a..b3aa40a1 100644 --- a/docs/models/components/customer.md +++ b/docs/models/components/customer.md @@ -9,7 +9,7 @@ let value: Customer = { id: "", externalId: "", name: "", - createdAt: "1724527973849", + createdAt: "1712068149003", }; ``` diff --git a/docs/models/components/data.md b/docs/models/components/data.md index dedd0a95..1310b20e 100644 --- a/docs/models/components/data.md +++ b/docs/models/components/data.md @@ -7,18 +7,18 @@ import { Data } from "dub/models/components"; let value: Data = { id: "", - domain: "fuzzy-cassava.info", + domain: "likely-fishery.com", key: "", - url: "https://variable-chainstay.com/", + url: "https://quick-witted-bowler.biz/", externalId: "", tenantId: "", - expiresAt: "1739232335748", - expiredUrl: "https://knotty-cinder.name", - password: "T3ZA7Q6tE5jTBtD", + expiresAt: "1762891692653", + expiredUrl: "https://dramatic-coast.org", + password: "2LJyvKYT3ZA7Q6t", title: "", - description: "unless hmph towards yet whoa premise customise gah", - image: "https://picsum.photos/seed/JUhGoh/3463/2806", - video: "https://loremflickr.com/3878/1395?lock=3500100439292678", + description: "cantaloupe inside towards ignorance", + image: "https://loremflickr.com/1737/1114?lock=1678072896472828", + video: "https://loremflickr.com/3919/3469?lock=8680677987618172", ios: "", android: "", geo: {}, @@ -27,16 +27,16 @@ let value: Data = { { id: "", name: "", - color: "blue", + color: "green", }, ], webhookIds: [ "", ], comments: - "blah beyond blah bitter ah versus alongside ouch whenever since ah especially gladly although syringe but ew", - shortLink: "https://subtle-igloo.org/", - qrCode: "https://alive-heartache.net", + "boo oxidise hard-to-find before astride oof throughout postbox hence", + shortLink: "https://growing-sermon.com/", + qrCode: "https://ordinary-grouper.name/", utmSource: "", utmMedium: "", utmCampaign: "", @@ -45,8 +45,8 @@ let value: Data = { userId: "", workspaceId: "", lastClicked: "", - createdAt: "1712152780611", - updatedAt: "1736274120419", + createdAt: "1713394164549", + updatedAt: "1736519229044", projectId: "", programId: "", }; @@ -93,9 +93,9 @@ let value: Data = { | `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: | N/A | -| `leads` | *number* | :heavy_minus_sign: | [BETA]: The number of leads the short links has generated. | -| `sales` | *number* | :heavy_minus_sign: | [BETA]: The number of sales the short links has generated. | -| `saleAmount` | *number* | :heavy_minus_sign: | [BETA]: The total dollar amount of sales the short links has generated (in cents). | +| `leads` | *number* | :heavy_minus_sign: | The number of leads the short links has generated. | +| `sales` | *number* | :heavy_minus_sign: | The number of sales the short links has generated. | +| `saleAmount` | *number* | :heavy_minus_sign: | The total dollar amount of sales the short links has generated (in cents). | | `createdAt` | *string* | :heavy_check_mark: | N/A | | `updatedAt` | *string* | :heavy_check_mark: | N/A | | ~~`projectId`~~ | *string* | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The project ID of the short link. This field is deprecated – use `workspaceId` instead. | diff --git a/docs/models/components/discount.md b/docs/models/components/discount.md index f585b477..112e00a8 100644 --- a/docs/models/components/discount.md +++ b/docs/models/components/discount.md @@ -9,9 +9,9 @@ let value: Discount = { id: "", couponId: "", couponTestId: "", - amount: 1272.94, + amount: 439.75, type: "flat", - duration: 1418.17, + duration: 5200.81, interval: "month", }; ``` diff --git a/docs/models/components/domainschema.md b/docs/models/components/domainschema.md index b11e602e..117c7ab4 100644 --- a/docs/models/components/domainschema.md +++ b/docs/models/components/domainschema.md @@ -12,12 +12,12 @@ let value: DomainSchema = { expiredUrl: "https://acme.com/expired", notFoundUrl: "https://acme.com/not-found", logo: "", - createdAt: "1731942608286", - updatedAt: "1736286708283", + createdAt: "1729019155491", + updatedAt: "1736517602937", registeredDomain: { id: "", - createdAt: "1714712668154", - expiresAt: "1755208557013", + createdAt: "1730412972223", + expiresAt: "1739910888011", }, }; ``` diff --git a/docs/models/components/interval.md b/docs/models/components/interval.md index 20649156..9e379a3f 100644 --- a/docs/models/components/interval.md +++ b/docs/models/components/interval.md @@ -5,7 +5,7 @@ ```typescript import { Interval } from "dub/models/components"; -let value: Interval = "month"; +let value: Interval = "year"; ``` ## Values diff --git a/docs/models/components/leadcreatedevent.md b/docs/models/components/leadcreatedevent.md index 05431ade..d9235a3a 100644 --- a/docs/models/components/leadcreatedevent.md +++ b/docs/models/components/leadcreatedevent.md @@ -10,43 +10,43 @@ import { LeadCreatedEvent } from "dub/models/components"; let value: LeadCreatedEvent = { id: "", event: "lead.created", - createdAt: "1704905271672", + createdAt: "1728162855468", data: { eventName: "", customer: { id: "", externalId: "", name: "", - createdAt: "1725339155688", + createdAt: "1718027555180", }, click: { id: "", - url: "https://assured-knuckle.org/", - country: "Anguilla", - city: "New Karianetown", + url: "https://cuddly-license.biz/", + country: "New Caledonia", + city: "Port Olen", region: "", - continent: "Africa", + continent: "Antarctica", device: "Mobile", - browser: "Firefox", - os: "MacOS", - referer: "crushing-numeric.biz", - refererUrl: "https://prime-allocation.com/", - ip: "36.194.23.38", + browser: "Safari", + os: "Chrome OS", + referer: "circular-knuckle.info", + refererUrl: "https://our-fen.biz/", + ip: "4bf9:b3bf:b53e:7a99:aeef:4cff:a7d2:6ad6", }, link: { id: "", - domain: "kaleidoscopic-character.net", + domain: "untried-icebreaker.com", key: "", - url: "https://uncomfortable-annual.org/", + url: "https://wicked-fold.name", externalId: "", tenantId: "", - expiresAt: "1741150742964", - expiredUrl: "https://good-larva.com", - password: "f5x_91mJmXmbkVg", + expiresAt: "1754914757303", + expiredUrl: "https://critical-sprinkles.net", + password: "VPYyqKmelmwvP6S", title: "", - description: "tapioca phew strict pointless whoever responsibility", - image: "https://picsum.photos/seed/rw0cQL4/1727/3019", - video: "https://picsum.videos/seed/QC3DT/2539/83", + description: "likewise inspection populist", + image: "https://picsum.photos/seed/8w81KYA43j/1597/2168", + video: "https://picsum.videos/seed/ZSvCji8/1524/16", ios: "", android: "", geo: {}, @@ -55,15 +55,15 @@ let value: LeadCreatedEvent = { { id: "", name: "", - color: "pink", + color: "blue", }, ], webhookIds: [ "", ], - comments: "equally apud upward inside during arrange", - shortLink: "https://nocturnal-morning.org", - qrCode: "https://flawed-defendant.info/", + comments: "tray across psst helpless angle during", + shortLink: "https://untimely-encouragement.name", + qrCode: "https://artistic-object.info/", utmSource: "", utmMedium: "", utmCampaign: "", @@ -72,8 +72,8 @@ let value: LeadCreatedEvent = { userId: "", workspaceId: "", lastClicked: "", - createdAt: "1723049673755", - updatedAt: "1736276646502", + createdAt: "1705423906918", + updatedAt: "1736481446885", projectId: "", programId: "", }, diff --git a/docs/models/components/leadcreatedeventclick.md b/docs/models/components/leadcreatedeventclick.md index 397bc6fc..86b7a8db 100644 --- a/docs/models/components/leadcreatedeventclick.md +++ b/docs/models/components/leadcreatedeventclick.md @@ -7,17 +7,17 @@ import { LeadCreatedEventClick } from "dub/models/components"; let value: LeadCreatedEventClick = { id: "", - url: "https://prestigious-celsius.net/", - country: "Kazakhstan", - city: "Lake Cierra", + url: "https://dull-feather.com/", + country: "Gambia", + city: "North Dakota", region: "", continent: "Antarctica", device: "Desktop", - browser: "Safari", - os: "Chrome OS", - referer: "mindless-cappelletti.com", - refererUrl: "https://mindless-premier.info/", - ip: "8091:7fc5:89a0:02d9:c6af:b63b:3eb3:f2aa", + browser: "Firefox", + os: "MacOS", + referer: "shameful-flint.com", + refererUrl: "https://delectable-backburn.com", + ip: "177.164.1.203", }; ``` diff --git a/docs/models/components/leadcreatedeventcustomer.md b/docs/models/components/leadcreatedeventcustomer.md index c561cfe2..1a8c5d98 100644 --- a/docs/models/components/leadcreatedeventcustomer.md +++ b/docs/models/components/leadcreatedeventcustomer.md @@ -9,7 +9,7 @@ let value: LeadCreatedEventCustomer = { id: "", externalId: "", name: "", - createdAt: "1718623395373", + createdAt: "1719978158007", }; ``` diff --git a/docs/models/components/leadcreatedeventdata.md b/docs/models/components/leadcreatedeventdata.md index 6d383cbe..b879e224 100644 --- a/docs/models/components/leadcreatedeventdata.md +++ b/docs/models/components/leadcreatedeventdata.md @@ -11,36 +11,36 @@ let value: LeadCreatedEventData = { id: "", externalId: "", name: "", - createdAt: "1720861337623", + createdAt: "1708610196075", }, click: { id: "", - url: "https://disloyal-reasoning.info/", - country: "Cyprus", - city: "Hoffman Estates", + url: "https://grave-leading.net/", + country: "Lebanon", + city: "Hampton", region: "", continent: "Africa", - device: "Mobile", + device: "Desktop", browser: "Chrome", - os: "Windows Phone", - referer: "posh-vestment.biz", - refererUrl: "https://violent-publicity.info/", - ip: "993b:5d8c:a3df:b2b9:7c75:a4bf:9b3b:fb53", + os: "Android", + referer: "worthy-story.biz", + refererUrl: "https://intrepid-role.com/", + ip: "29.160.106.217", }, link: { id: "", - domain: "upright-fen.info", + domain: "fond-jump.net", key: "", - url: "https://jam-packed-roundabout.org/", + url: "https://giving-circumference.name", externalId: "", tenantId: "", - expiresAt: "1756381486402", - expiredUrl: "https://different-mechanic.net", - password: "dhtMYwKnAUXmpeV", + expiresAt: "1741010090630", + expiredUrl: "https://natural-completion.net", + password: "jLPPfR1JCVQDE72", title: "", - description: "nor unused furthermore", - image: "https://picsum.photos/seed/8kDmpktn8c/2141/264", - video: "https://picsum.videos/seed/EqSmH/317/1871", + description: "gladly since gee whoever beside prance", + image: "https://loremflickr.com/2023/940?lock=170245687979181", + video: "https://loremflickr.com/2954/753?lock=127111341303348", ios: "", android: "", geo: {}, @@ -49,16 +49,16 @@ let value: LeadCreatedEventData = { { id: "", name: "", - color: "green", + color: "yellow", }, ], webhookIds: [ "", ], comments: - "smoothly absentmindedly gifted scrap materialise during scope aha hexagon french gah relieve minus", - shortLink: "https://illiterate-self-confidence.net", - qrCode: "https://meager-approach.info", + "ew why lest unless overplay wriggler furthermore knickers deed rewrite carefully seriously defensive stock lucky diversity deprave amid", + shortLink: "https://flimsy-membership.name", + qrCode: "https://difficult-edge.org", utmSource: "", utmMedium: "", utmCampaign: "", @@ -67,8 +67,8 @@ let value: LeadCreatedEventData = { userId: "", workspaceId: "", lastClicked: "", - createdAt: "1720506357668", - updatedAt: "1736252453417", + createdAt: "1727643126708", + updatedAt: "1736479464082", projectId: "", programId: "", }, diff --git a/docs/models/components/leadcreatedeventdatalink.md b/docs/models/components/leadcreatedeventdatalink.md index 474b35c8..ff9e1afd 100644 --- a/docs/models/components/leadcreatedeventdatalink.md +++ b/docs/models/components/leadcreatedeventdatalink.md @@ -7,9 +7,9 @@ import { LeadCreatedEventDataLink } from "dub/models/components"; let value: LeadCreatedEventDataLink = { id: "", - domain: "regal-coordination.biz", + domain: "young-gerbil.info", key: "", - shortLink: "https://tender-e-mail.name/", + shortLink: "https://scary-heroine.net/", programId: "", }; ``` diff --git a/docs/models/components/leadcreatedeventdiscount.md b/docs/models/components/leadcreatedeventdiscount.md index 0324ea5f..a4e1af51 100644 --- a/docs/models/components/leadcreatedeventdiscount.md +++ b/docs/models/components/leadcreatedeventdiscount.md @@ -9,9 +9,9 @@ let value: LeadCreatedEventDiscount = { id: "", couponId: "", couponTestId: "", - amount: 3247.86, + amount: 6204.21, type: "flat", - duration: 6029.32, + duration: 7577.47, interval: "month", }; ``` diff --git a/docs/models/components/leadcreatedeventinterval.md b/docs/models/components/leadcreatedeventinterval.md index cca72b49..4a8d50d0 100644 --- a/docs/models/components/leadcreatedeventinterval.md +++ b/docs/models/components/leadcreatedeventinterval.md @@ -5,7 +5,7 @@ ```typescript import { LeadCreatedEventInterval } from "dub/models/components"; -let value: LeadCreatedEventInterval = "month"; +let value: LeadCreatedEventInterval = "year"; ``` ## Values diff --git a/docs/models/components/leadcreatedeventlink.md b/docs/models/components/leadcreatedeventlink.md index cfd0a341..8ecee951 100644 --- a/docs/models/components/leadcreatedeventlink.md +++ b/docs/models/components/leadcreatedeventlink.md @@ -7,18 +7,18 @@ import { LeadCreatedEventLink } from "dub/models/components"; let value: LeadCreatedEventLink = { id: "", - domain: "complete-angle.org", + domain: "great-platter.com", key: "", - url: "https://well-groomed-knight.name/", + url: "https://agreeable-skean.biz/", externalId: "", tenantId: "", - expiresAt: "1739172135326", - expiredUrl: "https://shameless-legend.com", - password: "1JCVQDE72GBJoyV", + expiresAt: "1757799585418", + expiredUrl: "https://concrete-tray.name/", + password: "uozFv6pAqvW3Sg1", title: "", - description: "um dull quiet supposing", - image: "https://loremflickr.com/1369/1215?lock=706942974514141", - video: "https://loremflickr.com/2503/2023?lock=496517585752415", + description: "tenant despite and um bashfully aside mainstream", + image: "https://loremflickr.com/2704/1113?lock=1735234795159217", + video: "https://picsum.videos/seed/wp6t9AJW/1679/2614", ios: "", android: "", geo: {}, @@ -27,16 +27,16 @@ let value: LeadCreatedEventLink = { { id: "", name: "", - color: "red", + color: "green", }, ], webhookIds: [ "", ], comments: - "via and painfully stark dredger drat case healthily yuck sternly lest volleyball fast pish except entire", - shortLink: "https://remorseful-premium.name/", - qrCode: "https://french-ocelot.biz/", + "furthermore meh woot round whereas whenever essence frankly folklore fen but", + shortLink: "https://left-drug.net", + qrCode: "https://crooked-advertisement.org/", utmSource: "", utmMedium: "", utmCampaign: "", @@ -45,8 +45,8 @@ let value: LeadCreatedEventLink = { userId: "", workspaceId: "", lastClicked: "", - createdAt: "1720520213848", - updatedAt: "1736242450686", + createdAt: "1720518281493", + updatedAt: "1736485286005", projectId: "", programId: "", }; @@ -93,9 +93,9 @@ let value: LeadCreatedEventLink = { | `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: | N/A | -| `leads` | *number* | :heavy_minus_sign: | [BETA]: The number of leads the short links has generated. | -| `sales` | *number* | :heavy_minus_sign: | [BETA]: The number of sales the short links has generated. | -| `saleAmount` | *number* | :heavy_minus_sign: | [BETA]: The total dollar amount of sales the short links has generated (in cents). | +| `leads` | *number* | :heavy_minus_sign: | The number of leads the short links has generated. | +| `sales` | *number* | :heavy_minus_sign: | The number of sales the short links has generated. | +| `saleAmount` | *number* | :heavy_minus_sign: | The total dollar amount of sales the short links has generated (in cents). | | `createdAt` | *string* | :heavy_check_mark: | N/A | | `updatedAt` | *string* | :heavy_check_mark: | N/A | | ~~`projectId`~~ | *string* | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The project ID of the short link. This field is deprecated – use `workspaceId` instead. | diff --git a/docs/models/components/leadcreatedeventpartner.md b/docs/models/components/leadcreatedeventpartner.md index 61a4718a..56282406 100644 --- a/docs/models/components/leadcreatedeventpartner.md +++ b/docs/models/components/leadcreatedeventpartner.md @@ -8,7 +8,7 @@ import { LeadCreatedEventPartner } from "dub/models/components"; let value: LeadCreatedEventPartner = { id: "", name: "", - email: "Bradford.Harris60@gmail.com", + email: "Ally63@yahoo.com", }; ``` diff --git a/docs/models/components/leadevent.md b/docs/models/components/leadevent.md index d3e599cd..5e91fe69 100644 --- a/docs/models/components/leadevent.md +++ b/docs/models/components/leadevent.md @@ -11,33 +11,32 @@ let value: LeadEvent = { eventName: "", click: { id: "", - url: "https://alive-horst.name", - country: "Suriname", - city: "Vladimirboro", + url: "https://our-bungalow.biz", + country: "Jersey", + city: "South Jenaburgh", region: "", - continent: "Africa", - device: "Desktop", + continent: "Europe", + device: "Mobile", browser: "Chrome", - os: "BeOS", - referer: "entire-experience.net", - refererUrl: "https://normal-presume.info", - ip: "2.130.21.13", + os: "Windows Phone", + referer: "productive-unibody.net", + refererUrl: "https://lustrous-convection.org", + ip: "120.17.241.247", }, link: { id: "", - domain: "wicked-stranger.com", + domain: "self-assured-following.biz", key: "", - url: "https://waterlogged-duster.biz/", + url: "https://colossal-lifestyle.com/", externalId: "", tenantId: "", - expiresAt: "1758107559082", - expiredUrl: "https://favorable-waist.name/", - password: "RFjrcwRBhuiUyok", + expiresAt: "1746515460564", + expiredUrl: "https://shabby-airmail.info", + password: "rNN9o7ldVcHQrz2", title: "", - description: - "coin neglect newsprint quizzically grandson incidentally whose", - image: "https://loremflickr.com/1266/3307?lock=5710399072487564", - video: "https://loremflickr.com/3004/624?lock=8040791304525371", + description: "phew er solidly doing lightly inside carpool yuck", + image: "https://loremflickr.com/796/3824?lock=5750106884988154", + video: "https://picsum.videos/seed/N6odG6/1124/3791", ios: "", android: "", geo: {}, @@ -46,15 +45,15 @@ let value: LeadEvent = { { id: "", name: "", - color: "red", + color: "green", }, ], webhookIds: [ "", ], - comments: "mockingly but printer irritably expansion", - shortLink: "https://unhealthy-strategy.name", - qrCode: "https://negligible-singing.com/", + comments: "before when excluding worthless up transcend since while sermon", + shortLink: "https://substantial-shore.com/", + qrCode: "https://meager-comestible.com", utmSource: "", utmMedium: "", utmCampaign: "", @@ -63,8 +62,8 @@ let value: LeadEvent = { userId: "", workspaceId: "", lastClicked: "", - createdAt: "1730026855739", - updatedAt: "1736217317009", + createdAt: "1729376540619", + updatedAt: "1736489689678", projectId: "", programId: "", }, @@ -72,21 +71,21 @@ let value: LeadEvent = { id: "", externalId: "", name: "", - createdAt: "1730510811942", + createdAt: "1735990901329", }, clickId: "", linkId: "", - domain: "strident-atrium.name", + domain: "worst-wriggler.com", key: "", - url: "https://deafening-chops.net", - continent: "Australia", - country: "Wallis and Futuna", - city: "Yonkers", + url: "https://exhausted-impostor.net", + continent: "Antarctica", + country: "Mauritius", + city: "North Beulahbury", device: "Desktop", - browser: "Safari", - os: "Linux", - qr: 4582.12, - ip: "4c42:2709:e811:63f3:bccb:f8bc:8fd2:9bfe", + browser: "Firefox", + os: "Blackberry", + qr: 4016.88, + ip: "16.71.43.247", }; ``` diff --git a/docs/models/components/leadeventclick.md b/docs/models/components/leadeventclick.md index 008ac7a9..20b57e14 100644 --- a/docs/models/components/leadeventclick.md +++ b/docs/models/components/leadeventclick.md @@ -7,17 +7,17 @@ import { LeadEventClick } from "dub/models/components"; let value: LeadEventClick = { id: "", - url: "https://uncommon-underneath.org/", - country: "Guinea", - city: "San Mateo", + url: "https://humble-sideboard.net/", + country: "Uruguay", + city: "Fort Okey", region: "", - continent: "Europe", - device: "Desktop", + continent: "Asia", + device: "Mobile", browser: "Chrome", - os: "MacOS", - referer: "utter-emergent.info", - refererUrl: "https://spanish-starboard.com/", - ip: "215.209.26.40", + os: "BeOS", + referer: "chubby-custody.biz", + refererUrl: "https://silver-lift.info/", + ip: "108.16.53.238", }; ``` diff --git a/docs/models/components/leadeventcustomerlink.md b/docs/models/components/leadeventcustomerlink.md index 89568c0f..48136a9f 100644 --- a/docs/models/components/leadeventcustomerlink.md +++ b/docs/models/components/leadeventcustomerlink.md @@ -7,9 +7,9 @@ import { LeadEventCustomerLink } from "dub/models/components"; let value: LeadEventCustomerLink = { id: "", - domain: "productive-unibody.net", + domain: "earnest-safe.com", key: "", - shortLink: "https://lustrous-convection.org", + shortLink: "https://energetic-lace.net/", programId: "", }; ``` diff --git a/docs/models/components/leadeventlink.md b/docs/models/components/leadeventlink.md index f33e46de..6c4aa15a 100644 --- a/docs/models/components/leadeventlink.md +++ b/docs/models/components/leadeventlink.md @@ -7,18 +7,18 @@ import { LeadEventLink } from "dub/models/components"; let value: LeadEventLink = { id: "", - domain: "frugal-beret.info", + domain: "ecstatic-strait.net", key: "", - url: "https://oddball-devil.name/", + url: "https://pessimistic-captain.net/", externalId: "", tenantId: "", - expiresAt: "1740006448565", - expiredUrl: "https://violent-grandpa.biz", - password: "8NGDmdBvjBt52Gg", + expiresAt: "1756630052266", + expiredUrl: "https://lone-toaster.com", + password: "dH1nMtfGDQugbxd", title: "", - description: "cutover bah hunt during up er store", - image: "https://loremflickr.com/1968/3595?lock=4797852104095977", - video: "https://loremflickr.com/1305/1266?lock=3900814876790075", + description: "flat zowie indeed stale", + image: "https://picsum.photos/seed/Rrurz/1378/3083", + video: "https://picsum.videos/seed/opOld3SU/2485/1993", ios: "", android: "", geo: {}, @@ -27,16 +27,16 @@ let value: LeadEventLink = { { id: "", name: "", - color: "green", + color: "red", }, ], webhookIds: [ "", ], comments: - "grown meanwhile heartbeat whoa burgeon opposite apprehensive legitimize geez mmm forearm before substantiate mosh noted abaft ick phooey alongside", - shortLink: "https://lasting-agreement.info/", - qrCode: "https://excited-mortise.net/", + "stage inside sternly uh-huh bathrobe submissive meh nor mmm elevator", + shortLink: "https://palatable-toothpick.net/", + qrCode: "https://noted-topsail.info", utmSource: "", utmMedium: "", utmCampaign: "", @@ -45,8 +45,8 @@ let value: LeadEventLink = { userId: "", workspaceId: "", lastClicked: "", - createdAt: "1712201426879", - updatedAt: "1736267369595", + createdAt: "1732548212239", + updatedAt: "1736512696716", projectId: "", programId: "", }; @@ -93,9 +93,9 @@ let value: LeadEventLink = { | `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: | N/A | -| `leads` | *number* | :heavy_minus_sign: | [BETA]: The number of leads the short links has generated. | -| `sales` | *number* | :heavy_minus_sign: | [BETA]: The number of sales the short links has generated. | -| `saleAmount` | *number* | :heavy_minus_sign: | [BETA]: The total dollar amount of sales the short links has generated (in cents). | +| `leads` | *number* | :heavy_minus_sign: | The number of leads the short links has generated. | +| `sales` | *number* | :heavy_minus_sign: | The number of sales the short links has generated. | +| `saleAmount` | *number* | :heavy_minus_sign: | The total dollar amount of sales the short links has generated (in cents). | | `createdAt` | *string* | :heavy_check_mark: | N/A | | `updatedAt` | *string* | :heavy_check_mark: | N/A | | ~~`projectId`~~ | *string* | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The project ID of the short link. This field is deprecated – use `workspaceId` instead. | diff --git a/docs/models/components/link.md b/docs/models/components/link.md index 7bffe483..c73cf9d2 100644 --- a/docs/models/components/link.md +++ b/docs/models/components/link.md @@ -7,18 +7,18 @@ import { Link } from "dub/models/components"; let value: Link = { id: "", - domain: "competent-awareness.biz", + domain: "another-horst.name", key: "", - url: "https://lasting-plugin.net/", + url: "https://responsible-dusk.com", externalId: "", tenantId: "", - expiresAt: "1745241209963", - expiredUrl: "https://delirious-scorpion.com/", - password: "cjj9DXD3LlRWIQS", + expiresAt: "1748910462162", + expiredUrl: "https://deserted-teriyaki.name", + password: "LtLeFvbch70lLYr", title: "", - description: "provided rotating than optimistic as by summer horde", - image: "https://loremflickr.com/273/1008?lock=2280543531407454", - video: "https://loremflickr.com/525/49?lock=5570774932555238", + description: "quickly oof boo almighty yowza deeply", + image: "https://picsum.photos/seed/MheFf/2555/1961", + video: "https://loremflickr.com/2663/2069?lock=4996183616789047", ios: "", android: "", geo: {}, @@ -27,16 +27,16 @@ let value: Link = { { id: "", name: "", - color: "brown", + color: "green", }, ], webhookIds: [ "", ], comments: - "scenario hippodrome vain tag polyester when psst wide-eyed yowza near digestive traffic ouch substantiate into ew a sidetrack popularity clamor", - shortLink: "https://trusting-knitting.org", - qrCode: "https://vague-someplace.org", + "innocently hence pish hyphenation trim bravely teammate marketplace gazebo atop per about holster minority eek where", + shortLink: "https://judicious-legging.net/", + qrCode: "https://enchanted-handle.name/", utmSource: "", utmMedium: "", utmCampaign: "", @@ -45,8 +45,8 @@ let value: Link = { userId: "", workspaceId: "", lastClicked: "", - createdAt: "1733770428720", - updatedAt: "1736216872204", + createdAt: "1732962235743", + updatedAt: "1736494107395", projectId: "", programId: "", }; @@ -93,9 +93,9 @@ let value: 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: | N/A | -| `leads` | *number* | :heavy_minus_sign: | [BETA]: The number of leads the short links has generated. | -| `sales` | *number* | :heavy_minus_sign: | [BETA]: The number of sales the short links has generated. | -| `saleAmount` | *number* | :heavy_minus_sign: | [BETA]: The total dollar amount of sales the short links has generated (in cents). | +| `leads` | *number* | :heavy_minus_sign: | The number of leads the short links has generated. | +| `sales` | *number* | :heavy_minus_sign: | The number of sales the short links has generated. | +| `saleAmount` | *number* | :heavy_minus_sign: | The total dollar amount of sales the short links has generated (in cents). | | `createdAt` | *string* | :heavy_check_mark: | N/A | | `updatedAt` | *string* | :heavy_check_mark: | N/A | | ~~`projectId`~~ | *string* | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The project ID of the short link. This field is deprecated – use `workspaceId` instead. | diff --git a/docs/models/components/linkclickedevent.md b/docs/models/components/linkclickedevent.md index fb66cfd5..c0baf4d2 100644 --- a/docs/models/components/linkclickedevent.md +++ b/docs/models/components/linkclickedevent.md @@ -10,36 +10,36 @@ import { LinkClickedEvent } from "dub/models/components"; let value: LinkClickedEvent = { id: "", event: "link.clicked", - createdAt: "1706558761477", + createdAt: "1708295207659", data: { click: { id: "", - url: "https://queasy-acquaintance.biz", - country: "Philippines", - city: "New Crawfordport", + url: "https://breakable-cornet.org/", + country: "Angola", + city: "Presleyland", region: "", - continent: "South America", - device: "Desktop", - browser: "Safari", - os: "iOS", - referer: "bustling-fowl.org", - refererUrl: "https://terrible-coil.info", - ip: "cbb1:7aed:928b:d66d:b43a:bbf8:80ce:aae0", + continent: "Antarctica", + device: "Mobile", + browser: "Firefox", + os: "Windows Phone", + referer: "decent-seal.com", + refererUrl: "https://stale-futon.biz/", + ip: "83.87.178.61", }, link: { id: "", - domain: "clean-giant.com", + domain: "golden-sanity.org", key: "", - url: "https://obvious-cycle.name/", + url: "https://cautious-maintainer.name", externalId: "", tenantId: "", - expiresAt: "1765609712527", - expiredUrl: "https://expert-bonnet.org", - password: "DLdImWmbZShDNG4", + expiresAt: "1746431008702", + expiredUrl: "https://speedy-minister.com", + password: "cv8joDt038kVZ7G", title: "", - description: "deduction cop ack creak exaggerate", - image: "https://loremflickr.com/3319/3766?lock=8143688530542841", - video: "https://picsum.videos/seed/ePlYQUzicw/1341/1299", + description: "serene scientific aboard", + image: "https://loremflickr.com/3855/2076?lock=6143394842599669", + video: "https://picsum.videos/seed/63JE0d/1076/427", ios: "", android: "", geo: {}, @@ -55,9 +55,9 @@ let value: LinkClickedEvent = { "", ], comments: - "lox ew developmental baseboard basket out and likewise libel cow but banish encouragement concrete pfft terrible", - shortLink: "https://plain-nun.info", - qrCode: "https://frilly-baritone.info/", + "insert immediately mechanically zowie given wherever jealously", + shortLink: "https://bright-mentor.biz/", + qrCode: "https://vengeful-smog.biz", utmSource: "", utmMedium: "", utmCampaign: "", @@ -66,8 +66,8 @@ let value: LinkClickedEvent = { userId: "", workspaceId: "", lastClicked: "", - createdAt: "1731553525670", - updatedAt: "1736265322805", + createdAt: "1707818652139", + updatedAt: "1736522737871", projectId: "", programId: "", }, diff --git a/docs/models/components/linkclickedeventclick.md b/docs/models/components/linkclickedeventclick.md index 0525c30b..527165f6 100644 --- a/docs/models/components/linkclickedeventclick.md +++ b/docs/models/components/linkclickedeventclick.md @@ -7,17 +7,17 @@ import { LinkClickedEventClick } from "dub/models/components"; let value: LinkClickedEventClick = { id: "", - url: "https://unlucky-dusk.biz/", - country: "Uganda", - city: "West Montanaboro", + url: "https://precious-sauerkraut.org/", + country: "Slovenia", + city: "Port Andreaneberg", region: "", - continent: "Antarctica", + continent: "Europe", device: "Desktop", - browser: "Safari", - os: "Symbian", - referer: "angelic-collaboration.org", - refererUrl: "https://new-silk.com", - ip: "247.212.191.39", + browser: "Firefox", + os: "Android", + referer: "internal-eyebrow.com", + refererUrl: "https://whole-numeric.biz", + ip: "8fde:e31b:daf1:43d4:16ec:7c65:ca93:b58a", }; ``` diff --git a/docs/models/components/linkclickedeventdata.md b/docs/models/components/linkclickedeventdata.md index 9756ba7e..9fe3c9a7 100644 --- a/docs/models/components/linkclickedeventdata.md +++ b/docs/models/components/linkclickedeventdata.md @@ -8,32 +8,32 @@ import { LinkClickedEventData } from "dub/models/components"; let value: LinkClickedEventData = { click: { id: "", - url: "https://short-term-stool.biz", - country: "Brazil", - city: "Maxshire", + url: "https://giving-ravioli.biz/", + country: "Switzerland", + city: "Wainoworth", region: "", - continent: "Asia", - device: "Desktop", - browser: "Firefox", - os: "Blackberry", - referer: "obvious-puritan.info", - refererUrl: "https://dense-eyebrow.net", - ip: "171.73.47.76", + continent: "Antarctica", + device: "Mobile", + browser: "Chrome", + os: "Windows", + referer: "wavy-vestment.com", + refererUrl: "https://majestic-strategy.name/", + ip: "aeaa:0281:88ec:fd90:6bd7:6e7e:62be:d4fa", }, link: { id: "", - domain: "unfortunate-incandescence.biz", + domain: "glittering-meadow.net", key: "", - url: "https://acceptable-restaurant.biz/", + url: "https://whopping-icebreaker.org/", externalId: "", tenantId: "", - expiresAt: "1755156197939", - expiredUrl: "https://tame-cook.com/", - password: "x9PGykiRoLMO7x9", + expiresAt: "1742505444366", + expiredUrl: "https://darling-adaptation.biz/", + password: "GIuJbPtvCVpCFOB", title: "", - description: "but jealously overfeed warp", - image: "https://picsum.photos/seed/dLuZAV/185/2633", - video: "https://picsum.videos/seed/PqIz7IH/49/619", + description: "pro yet blue ugh nautical barring whereas", + image: "https://picsum.photos/seed/hiKrp1i/3152/1984", + video: "https://picsum.videos/seed/1jtUn/3441/3214", ios: "", android: "", geo: {}, @@ -42,16 +42,16 @@ let value: LinkClickedEventData = { { id: "", name: "", - color: "red", + color: "green", }, ], webhookIds: [ "", ], comments: - "energetically sharply swiftly exalted gee unlike before coin after kindheartedly whereas obvious matter", - shortLink: "https://whole-legend.com/", - qrCode: "https://filthy-bump.net", + "unless separate gadzooks fall boohoo if loyally singe search until for perfection overcooked horde", + shortLink: "https://obvious-carnival.net", + qrCode: "https://clean-meander.info", utmSource: "", utmMedium: "", utmCampaign: "", @@ -60,8 +60,8 @@ let value: LinkClickedEventData = { userId: "", workspaceId: "", lastClicked: "", - createdAt: "1711005373592", - updatedAt: "1736222810289", + createdAt: "1719461328406", + updatedAt: "1736477168066", projectId: "", programId: "", }, diff --git a/docs/models/components/linkclickedeventlink.md b/docs/models/components/linkclickedeventlink.md index 625c05d1..aa0b5442 100644 --- a/docs/models/components/linkclickedeventlink.md +++ b/docs/models/components/linkclickedeventlink.md @@ -7,18 +7,19 @@ import { LinkClickedEventLink } from "dub/models/components"; let value: LinkClickedEventLink = { id: "", - domain: "live-tuber.org", + domain: "warlike-saloon.info", key: "", - url: "https://sleepy-account.org/", + url: "https://similar-hawk.info", externalId: "", tenantId: "", - expiresAt: "1749449637840", - expiredUrl: "https://hidden-embossing.biz", - password: "f3sY2zKOrjOfgCE", + expiresAt: "1740792075533", + expiredUrl: "https://taut-eyeliner.net", + password: "ZkHhGUL9uEEIrl3", title: "", - description: "however gadzooks pliers drat down glorious", - image: "https://picsum.photos/seed/mygCZPm5Xo/2765/1983", - video: "https://loremflickr.com/1174/1266?lock=8617650485784400", + description: + "meh suspiciously youthfully frenetically eek since grade waft whoever", + image: "https://picsum.photos/seed/zziCfbpH/1274/3368", + video: "https://picsum.videos/seed/95bBP/2486/3859", ios: "", android: "", geo: {}, @@ -33,9 +34,10 @@ let value: LinkClickedEventLink = { webhookIds: [ "", ], - comments: "cautiously depend hopeful ew stunning perspire pfft behind hmph", - shortLink: "https://similar-airline.com", - qrCode: "https://liquid-thorn.info/", + comments: + "anti fast advocate weird qualified woot concerning huzzah grouper ugh clavicle", + shortLink: "https://warm-tributary.com/", + qrCode: "https://aching-wheel.info", utmSource: "", utmMedium: "", utmCampaign: "", @@ -44,8 +46,8 @@ let value: LinkClickedEventLink = { userId: "", workspaceId: "", lastClicked: "", - createdAt: "1713863083789", - updatedAt: "1736263106632", + createdAt: "1735691928680", + updatedAt: "1736472415057", projectId: "", programId: "", }; @@ -92,9 +94,9 @@ let value: LinkClickedEventLink = { | `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: | N/A | -| `leads` | *number* | :heavy_minus_sign: | [BETA]: The number of leads the short links has generated. | -| `sales` | *number* | :heavy_minus_sign: | [BETA]: The number of sales the short links has generated. | -| `saleAmount` | *number* | :heavy_minus_sign: | [BETA]: The total dollar amount of sales the short links has generated (in cents). | +| `leads` | *number* | :heavy_minus_sign: | The number of leads the short links has generated. | +| `sales` | *number* | :heavy_minus_sign: | The number of sales the short links has generated. | +| `saleAmount` | *number* | :heavy_minus_sign: | The total dollar amount of sales the short links has generated (in cents). | | `createdAt` | *string* | :heavy_check_mark: | N/A | | `updatedAt` | *string* | :heavy_check_mark: | N/A | | ~~`projectId`~~ | *string* | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The project ID of the short link. This field is deprecated – use `workspaceId` instead. | diff --git a/docs/models/components/linkerrorschema.md b/docs/models/components/linkerrorschema.md new file mode 100644 index 00000000..b0a840fa --- /dev/null +++ b/docs/models/components/linkerrorschema.md @@ -0,0 +1,20 @@ +# LinkErrorSchema + +## Example Usage + +```typescript +import { LinkErrorSchema } from "dub/models/components"; + +let value: LinkErrorSchema = { + error: "", + code: "unprocessable_entity", +}; +``` + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | +| `link` | *any* | :heavy_minus_sign: | The link that caused the error. | +| `error` | *string* | :heavy_check_mark: | The error message. | +| `code` | [components.Code](../../models/components/code.md) | :heavy_check_mark: | The error code. | \ No newline at end of file diff --git a/docs/models/components/linkschema.md b/docs/models/components/linkschema.md index 74ee7f1b..f99584c7 100644 --- a/docs/models/components/linkschema.md +++ b/docs/models/components/linkschema.md @@ -12,7 +12,7 @@ let value: LinkSchema = { url: "https://insignificant-parsnip.info", externalId: "", tenantId: "", - expiresAt: "1764423112154", + expiresAt: "1764649994668", expiredUrl: "https://ideal-scratch.name", password: "VxpjslLkzRHjLWz", title: "", @@ -45,8 +45,8 @@ let value: LinkSchema = { userId: "", workspaceId: "", lastClicked: "", - createdAt: "1735099783382", - updatedAt: "1736238999964", + createdAt: "1735326665895", + updatedAt: "1736465882477", projectId: "", programId: "", }; @@ -60,7 +60,7 @@ let value: LinkSchema = { | `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. | -| `trackConversion` | *boolean* | :heavy_minus_sign: | [BETA] Whether to track conversions for the short link. | +| `trackConversion` | *boolean* | :heavy_minus_sign: | Whether to track conversions for the short link. | | `externalId` | *string* | :heavy_check_mark: | The ID of the link in your database. If set, it can be used to identify the link in future API requests (must be prefixed with 'ext_' when passed as a query parameter). This key is unique across your workspace. | | `tenantId` | *string* | :heavy_check_mark: | The ID of the tenant that created the link inside your system. If set, it can be used to fetch all links for a tenant. | | `archived` | *boolean* | :heavy_minus_sign: | Whether the short link is archived. | @@ -93,9 +93,9 @@ let value: LinkSchema = { | `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. | -| `leads` | *number* | :heavy_minus_sign: | [BETA]: The number of leads the short links has generated. | -| `sales` | *number* | :heavy_minus_sign: | [BETA]: The number of sales the short links has generated. | -| `saleAmount` | *number* | :heavy_minus_sign: | [BETA]: The total dollar amount of sales the short links has generated (in cents). | +| `leads` | *number* | :heavy_minus_sign: | The number of leads the short links has generated. | +| `sales` | *number* | :heavy_minus_sign: | The number of sales the short links has generated. | +| `saleAmount` | *number* | :heavy_minus_sign: | The total dollar amount of sales the short links has generated (in cents). | | `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.

The project ID of the short link. This field is deprecated – use `workspaceId` instead. | diff --git a/docs/models/components/linkwebhookevent.md b/docs/models/components/linkwebhookevent.md index b872af49..ccaccc98 100644 --- a/docs/models/components/linkwebhookevent.md +++ b/docs/models/components/linkwebhookevent.md @@ -9,22 +9,22 @@ import { LinkWebhookEvent } from "dub/models/components"; let value: LinkWebhookEvent = { id: "", - event: "link.updated", - createdAt: "1705575825971", + event: "link.deleted", + createdAt: "1707127486770", data: { id: "", - domain: "sorrowful-meal.com", + domain: "spherical-violin.org", key: "", - url: "https://forceful-sweatshop.biz/", + url: "https://cluttered-minor.biz", externalId: "", tenantId: "", - expiresAt: "1765997203037", - expiredUrl: "https://glossy-silk.net", - password: "Hjqn0o4ZIPEcwmv", + expiresAt: "1767123677450", + expiredUrl: "https://pitiful-porter.info", + password: "DyGlwDNI8gr1jyx", title: "", - description: "as pfft grandson inexperienced pike investigate", - image: "https://loremflickr.com/1012/3568?lock=352416681733758", - video: "https://picsum.videos/seed/cQfl43GVu/1529/1698", + description: "meh opposite shoot", + image: "https://loremflickr.com/3834/1385?lock=736565324207501", + video: "https://loremflickr.com/2658/3835?lock=4369929469649753", ios: "", android: "", geo: {}, @@ -33,16 +33,15 @@ let value: LinkWebhookEvent = { { id: "", name: "", - color: "pink", + color: "red", }, ], webhookIds: [ "", ], - comments: - "impish intervention hence ew brr smuggle book ultimately athwart coordinated guidance anti fast advocate weird qualified woot", - shortLink: "https://colossal-hospitalization.info", - qrCode: "https://misguided-fund.net", + comments: "syringe but ew except obtrude", + shortLink: "https://little-eggplant.org/", + qrCode: "https://waterlogged-management.biz/", utmSource: "", utmMedium: "", utmCampaign: "", @@ -51,8 +50,8 @@ let value: LinkWebhookEvent = { userId: "", workspaceId: "", lastClicked: "", - createdAt: "1706884294463", - updatedAt: "1736216830014", + createdAt: "1730646996895", + updatedAt: "1736500896734", projectId: "", programId: "", }, diff --git a/docs/models/components/partner.md b/docs/models/components/partner.md index b10169fa..2c4b08c1 100644 --- a/docs/models/components/partner.md +++ b/docs/models/components/partner.md @@ -8,7 +8,7 @@ import { Partner } from "dub/models/components"; let value: Partner = { id: "", name: "", - email: "Janiya_Welch@gmail.com", + email: "Jordon_Fay59@gmail.com", }; ``` diff --git a/docs/models/components/paymentprocessor.md b/docs/models/components/paymentprocessor.md index 0435e7f4..90249e46 100644 --- a/docs/models/components/paymentprocessor.md +++ b/docs/models/components/paymentprocessor.md @@ -7,7 +7,7 @@ The payment processor via which the sale was made. ```typescript import { PaymentProcessor } from "dub/models/components"; -let value: PaymentProcessor = "stripe"; +let value: PaymentProcessor = "paddle"; ``` ## Values diff --git a/docs/models/components/plan.md b/docs/models/components/plan.md index 66e732de..bb93bb4f 100644 --- a/docs/models/components/plan.md +++ b/docs/models/components/plan.md @@ -7,7 +7,7 @@ The plan of the workspace. ```typescript import { Plan } from "dub/models/components"; -let value: Plan = "business plus"; +let value: Plan = "free"; ``` ## Values diff --git a/docs/models/components/registereddomain.md b/docs/models/components/registereddomain.md index f73a6b92..3795c61e 100644 --- a/docs/models/components/registereddomain.md +++ b/docs/models/components/registereddomain.md @@ -9,8 +9,8 @@ import { RegisteredDomain } from "dub/models/components"; let value: RegisteredDomain = { id: "", - createdAt: "1720923472646", - expiresAt: "1745814620825", + createdAt: "1731310557093", + expiresAt: "1744031744661", }; ``` diff --git a/docs/models/components/role.md b/docs/models/components/role.md index 18490cb7..1d405535 100644 --- a/docs/models/components/role.md +++ b/docs/models/components/role.md @@ -7,7 +7,7 @@ The role of the authenticated user in the workspace. ```typescript import { Role } from "dub/models/components"; -let value: Role = "member"; +let value: Role = "owner"; ``` ## Values diff --git a/docs/models/components/sale.md b/docs/models/components/sale.md index 3217ddf6..9fd10644 100644 --- a/docs/models/components/sale.md +++ b/docs/models/components/sale.md @@ -6,8 +6,8 @@ import { Sale } from "dub/models/components"; let value: Sale = { - amount: 956545, - paymentProcessor: "paddle", + amount: 588662, + paymentProcessor: "stripe", }; ``` diff --git a/docs/models/components/salecreatedevent.md b/docs/models/components/salecreatedevent.md index 47f57729..3ee87de5 100644 --- a/docs/models/components/salecreatedevent.md +++ b/docs/models/components/salecreatedevent.md @@ -10,44 +10,43 @@ import { SaleCreatedEvent } from "dub/models/components"; let value: SaleCreatedEvent = { id: "", event: "sale.created", - createdAt: "1720327382186", + createdAt: "1726018056596", data: { eventName: "", customer: { id: "", externalId: "", name: "", - createdAt: "1716007832489", + createdAt: "1714077524576", }, click: { id: "", - url: "https://hurtful-onset.org", - country: "Canada", - city: "West Phyllisstead", + url: "https://insecure-density.com", + country: "Vanuatu", + city: "New Colthaven", region: "", - continent: "South America", + continent: "Antarctica", device: "Mobile", browser: "Chrome", - os: "WebOS", - referer: "questionable-slide.net", - refererUrl: "https://flawless-awareness.biz/", - ip: "110.57.180.56", + os: "Symbian", + referer: "radiant-heartache.org", + refererUrl: "https://idealistic-coil.net", + ip: "454a:16ad:ca0c:97fe:5b2a:7330:baa6:8d20", }, link: { id: "", - domain: "bossy-spork.com", + domain: "ecstatic-legislature.com", key: "", - url: "https://vengeful-bungalow.name", + url: "https://ruddy-hygienic.org/", externalId: "", tenantId: "", - expiresAt: "1750545814154", - expiredUrl: "https://posh-duster.com", - password: "NuwrEMV588BmBNN", + expiresAt: "1765248977127", + expiredUrl: "https://humble-tool.name/", + password: "Dmx6nHcOz357b57", title: "", - description: - "controvert mozzarella solemnly sinful meanwhile skyline up heating avaricious", - image: "https://picsum.photos/seed/UtUpz/3906/2825", - video: "https://loremflickr.com/3574/1843?lock=3828644371313865", + description: "geez where microblog questioningly", + image: "https://loremflickr.com/433/116?lock=6474907856928254", + video: "https://picsum.videos/seed/uczD7z6x/2773/3170", ios: "", android: "", geo: {}, @@ -56,16 +55,15 @@ let value: SaleCreatedEvent = { { id: "", name: "", - color: "green", + color: "yellow", }, ], webhookIds: [ "", ], - comments: - "space informal minus dark while beyond untimely whenever an representation lest aha analyse firm than given", - shortLink: "https://circular-heartbeat.biz/", - qrCode: "https://early-giant.name", + comments: "chasuble noxious imaginary below whereas yak", + shortLink: "https://squiggly-flint.net/", + qrCode: "https://zealous-cannon.com", utmSource: "", utmMedium: "", utmCampaign: "", @@ -74,14 +72,14 @@ let value: SaleCreatedEvent = { userId: "", workspaceId: "", lastClicked: "", - createdAt: "1715183724717", - updatedAt: "1736271180542", + createdAt: "1728573172702", + updatedAt: "1736489784331", projectId: "", programId: "", }, sale: { - amount: 6052.56, - currency: "CFA Franc BEAC", + amount: 6908.74, + currency: "Swedish Krona", paymentProcessor: "", invoiceId: "", }, diff --git a/docs/models/components/salecreatedeventclick.md b/docs/models/components/salecreatedeventclick.md index 9f6665ee..315884e1 100644 --- a/docs/models/components/salecreatedeventclick.md +++ b/docs/models/components/salecreatedeventclick.md @@ -7,17 +7,17 @@ import { SaleCreatedEventClick } from "dub/models/components"; let value: SaleCreatedEventClick = { id: "", - url: "https://taut-icebreaker.info/", - country: "Monaco", - city: "Ernestineboro", + url: "https://marvelous-hyena.com/", + country: "Niue", + city: "North Joana", region: "", - continent: "Asia", - device: "Mobile", - browser: "Safari", - os: "MacOS", - referer: "shocked-pepper.name", - refererUrl: "https://firsthand-reporter.info/", - ip: "134.217.224.230", + continent: "South America", + device: "Desktop", + browser: "Chrome", + os: "Windows Phone", + referer: "near-advertisement.com", + refererUrl: "https://kooky-cassava.com", + ip: "70d0:233a:2393:aad0:c3e7:b0a4:ee65:3b96", }; ``` diff --git a/docs/models/components/salecreatedeventcustomer.md b/docs/models/components/salecreatedeventcustomer.md index 13ab27b7..bca48132 100644 --- a/docs/models/components/salecreatedeventcustomer.md +++ b/docs/models/components/salecreatedeventcustomer.md @@ -9,7 +9,7 @@ let value: SaleCreatedEventCustomer = { id: "", externalId: "", name: "", - createdAt: "1704826010878", + createdAt: "1706361131102", }; ``` diff --git a/docs/models/components/salecreatedeventdata.md b/docs/models/components/salecreatedeventdata.md index 1cfb61f1..80c2cb3f 100644 --- a/docs/models/components/salecreatedeventdata.md +++ b/docs/models/components/salecreatedeventdata.md @@ -11,36 +11,36 @@ let value: SaleCreatedEventData = { id: "", externalId: "", name: "", - createdAt: "1721675745358", + createdAt: "1721620996072", }, click: { id: "", - url: "https://spiteful-thyme.net/", - country: "Solomon Islands", - city: "Chico", + url: "https://exhausted-substitution.net/", + country: "Switzerland", + city: "North Maximilian", region: "", continent: "South America", device: "Mobile", browser: "Firefox", - os: "BeOS", - referer: "our-yak.net", - refererUrl: "https://sick-ravioli.biz/", - ip: "38da:ef1a:b659:8b4a:bde6:d952:f1b4:d4a3", + os: "Blackberry", + referer: "chubby-duffel.name", + refererUrl: "https://lovable-mozzarella.com", + ip: "a37b:34ed:26d5:0f47:6323:ffec:73aa:bb4b", }, link: { id: "", - domain: "warmhearted-pharmacopoeia.info", + domain: "crazy-litter.com", key: "", - url: "https://monstrous-going.com", + url: "https://reckless-chap.name/", externalId: "", tenantId: "", - expiresAt: "1759040432991", - expiredUrl: "https://elementary-digit.biz", - password: "PfngWJC_8SgB10j", + expiresAt: "1753519875010", + expiredUrl: "https://lighthearted-bidet.com", + password: "l9Z4dKt3x8zYNZj", title: "", - description: "cutover thread vain ick safely ah duster positively", - image: "https://picsum.photos/seed/Ex4acC61mI/2959/1537", - video: "https://picsum.videos/seed/uczD7z6x/2773/3170", + description: "why rarely splurge electrify fooey now punctually", + image: "https://loremflickr.com/1698/2623?lock=7810687478150885", + video: "https://loremflickr.com/311/1151?lock=106407783926604", ios: "", android: "", geo: {}, @@ -49,15 +49,16 @@ let value: SaleCreatedEventData = { { id: "", name: "", - color: "yellow", + color: "red", }, ], webhookIds: [ "", ], - comments: "chasuble noxious imaginary below whereas yak", - shortLink: "https://squiggly-flint.net/", - qrCode: "https://zealous-cannon.com", + comments: + "blindly and foolishly horn immediately putrefy boo feather sans impressionable stable warp devoted obedient shush while gentle worth", + shortLink: "https://smart-skeleton.biz/", + qrCode: "https://jubilant-granny.name/", utmSource: "", utmMedium: "", utmCampaign: "", @@ -66,14 +67,14 @@ let value: SaleCreatedEventData = { userId: "", workspaceId: "", lastClicked: "", - createdAt: "1728346290173", - updatedAt: "1736262901803", + createdAt: "1711663561704", + updatedAt: "1736483306403", projectId: "", programId: "", }, sale: { - amount: 6908.74, - currency: "Swedish Krona", + amount: 8127.52, + currency: "Hryvnia", paymentProcessor: "", invoiceId: "", }, diff --git a/docs/models/components/salecreatedeventdatalink.md b/docs/models/components/salecreatedeventdatalink.md index e9e052dd..6648c5ee 100644 --- a/docs/models/components/salecreatedeventdatalink.md +++ b/docs/models/components/salecreatedeventdatalink.md @@ -7,9 +7,9 @@ import { SaleCreatedEventDataLink } from "dub/models/components"; let value: SaleCreatedEventDataLink = { id: "", - domain: "awesome-hoof.org", + domain: "brown-ostrich.name", key: "", - shortLink: "https://subtle-cannon.biz/", + shortLink: "https://warlike-swim.net", programId: "", }; ``` diff --git a/docs/models/components/salecreatedeventdiscount.md b/docs/models/components/salecreatedeventdiscount.md index 92465bab..8844559b 100644 --- a/docs/models/components/salecreatedeventdiscount.md +++ b/docs/models/components/salecreatedeventdiscount.md @@ -9,9 +9,9 @@ let value: SaleCreatedEventDiscount = { id: "", couponId: "", couponTestId: "", - amount: 9270.50, - type: "percentage", - duration: 4105.23, + amount: 8005.45, + type: "flat", + duration: 6878.83, interval: "year", }; ``` diff --git a/docs/models/components/salecreatedeventlink.md b/docs/models/components/salecreatedeventlink.md index 3f9d5ba8..2d9e065e 100644 --- a/docs/models/components/salecreatedeventlink.md +++ b/docs/models/components/salecreatedeventlink.md @@ -7,19 +7,18 @@ import { SaleCreatedEventLink } from "dub/models/components"; let value: SaleCreatedEventLink = { id: "", - domain: "moral-insolence.biz", + domain: "well-groomed-sesame.name", key: "", - url: "https://steep-subexpression.biz", + url: "https://cloudy-pilot.biz", externalId: "", tenantId: "", - expiresAt: "1739387627707", - expiredUrl: "https://unwilling-tomb.name", - password: "TtNYO0AQ3xs9c3f", + expiresAt: "1758208325723", + expiredUrl: "https://sparse-membership.net", + password: "MaLuZ5N3fiRr6Tu", title: "", - description: - "mobilize rationalize cheese of bewail whose masterpiece why rarely splurge", - image: "https://picsum.photos/seed/e3ha1iwEn/1078/2464", - video: "https://picsum.videos/seed/RgvujG8N2/817/2277", + description: "potable delightfully keenly miskey although swathe evince whoa", + image: "https://loremflickr.com/2218/749?lock=7359362197515764", + video: "https://picsum.videos/seed/SzplUzf/2287/2078", ios: "", android: "", geo: {}, @@ -28,16 +27,15 @@ let value: SaleCreatedEventLink = { { id: "", name: "", - color: "green", + color: "blue", }, ], webhookIds: [ "", ], - comments: - "gladly after adventurously out definite unit supplier jazz gladly aha eyeliner meh than bah", - shortLink: "https://probable-cop-out.biz", - qrCode: "https://shameless-kit.net/", + comments: "settle squid madly uh-huh scotch handle so buttery", + shortLink: "https://questionable-outlaw.com", + qrCode: "https://similar-kielbasa.com/", utmSource: "", utmMedium: "", utmCampaign: "", @@ -46,8 +44,8 @@ let value: SaleCreatedEventLink = { userId: "", workspaceId: "", lastClicked: "", - createdAt: "1729972883689", - updatedAt: "1736262495020", + createdAt: "1721595236493", + updatedAt: "1736513891974", projectId: "", programId: "", }; @@ -94,9 +92,9 @@ let value: SaleCreatedEventLink = { | `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: | N/A | -| `leads` | *number* | :heavy_minus_sign: | [BETA]: The number of leads the short links has generated. | -| `sales` | *number* | :heavy_minus_sign: | [BETA]: The number of sales the short links has generated. | -| `saleAmount` | *number* | :heavy_minus_sign: | [BETA]: The total dollar amount of sales the short links has generated (in cents). | +| `leads` | *number* | :heavy_minus_sign: | The number of leads the short links has generated. | +| `sales` | *number* | :heavy_minus_sign: | The number of sales the short links has generated. | +| `saleAmount` | *number* | :heavy_minus_sign: | The total dollar amount of sales the short links has generated (in cents). | | `createdAt` | *string* | :heavy_check_mark: | N/A | | `updatedAt` | *string* | :heavy_check_mark: | N/A | | ~~`projectId`~~ | *string* | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The project ID of the short link. This field is deprecated – use `workspaceId` instead. | diff --git a/docs/models/components/salecreatedeventpartner.md b/docs/models/components/salecreatedeventpartner.md index 753b3165..b0163e68 100644 --- a/docs/models/components/salecreatedeventpartner.md +++ b/docs/models/components/salecreatedeventpartner.md @@ -8,7 +8,7 @@ import { SaleCreatedEventPartner } from "dub/models/components"; let value: SaleCreatedEventPartner = { id: "", name: "", - email: "Lillie_Ortiz@hotmail.com", + email: "Dena.Carter@yahoo.com", }; ``` diff --git a/docs/models/components/salecreatedeventsale.md b/docs/models/components/salecreatedeventsale.md index 6d8bf2b9..6204e28c 100644 --- a/docs/models/components/salecreatedeventsale.md +++ b/docs/models/components/salecreatedeventsale.md @@ -6,8 +6,8 @@ import { SaleCreatedEventSale } from "dub/models/components"; let value: SaleCreatedEventSale = { - amount: 4711.41, - currency: "Iranian Rial", + amount: 8784.20, + currency: "Peso Uruguayo", paymentProcessor: "", invoiceId: "", }; diff --git a/docs/models/components/saleevent.md b/docs/models/components/saleevent.md index 343b7461..ac2f7f6e 100644 --- a/docs/models/components/saleevent.md +++ b/docs/models/components/saleevent.md @@ -11,18 +11,18 @@ let value: SaleEvent = { eventName: "", link: { id: "", - domain: "whopping-longboat.net", + domain: "discrete-habit.name", key: "", - url: "https://handy-giggle.name/", + url: "https://indolent-programme.net", externalId: "", tenantId: "", - expiresAt: "1747635874447", - expiredUrl: "https://worthless-alliance.biz", - password: "6Kp6OylUX3GZjHd", + expiresAt: "1746532160017", + expiredUrl: "https://pushy-swim.name", + password: "gjwVIxtOegwlPc3", title: "", - description: "somber um the gleefully these oof blah feminize sans", - image: "https://picsum.photos/seed/AA2Z8JOnc6/3426/2881", - video: "https://picsum.videos/seed/9UpiWZcE6E/2994/1811", + description: "zealous vastly fledgling facilitate runway oval", + image: "https://loremflickr.com/138/3994?lock=6668454717749658", + video: "https://loremflickr.com/3284/1492?lock=889549978698192", ios: "", android: "", geo: {}, @@ -38,9 +38,9 @@ let value: SaleEvent = { "", ], comments: - "awesome reach upliftingly till whirlwind enthusiastically towards guidance jealously restfully where defiantly sans yum creature", - shortLink: "https://unfinished-cricket.net/", - qrCode: "https://vast-captain.biz", + "whose plumber awesome reach upliftingly till whirlwind enthusiastically towards guidance jealously restfully", + shortLink: "https://those-allocation.biz", + qrCode: "https://determined-sesame.net/", utmSource: "", utmMedium: "", utmCampaign: "", @@ -49,51 +49,51 @@ let value: SaleEvent = { userId: "", workspaceId: "", lastClicked: "", - createdAt: "1728192199048", - updatedAt: "1736230693521", + createdAt: "1721289888014", + updatedAt: "1736525565634", projectId: "", programId: "", }, click: { id: "", - url: "https://dazzling-community.info/", - country: "Bonaire, Sint Eustatius and Saba", - city: "South Alberto", + url: "https://unripe-caption.com/", + country: "Paraguay", + city: "New Heidicester", region: "", - continent: "Asia", - device: "Desktop", - browser: "Firefox", - os: "BeOS", - referer: "suburban-birdbath.name", - refererUrl: "https://everlasting-riser.org", - ip: "2045:d8f7:36df:4b6d:3e1f:fcca:dbaa:3397", + continent: "South America", + device: "Mobile", + browser: "Safari", + os: "Windows", + referer: "gaseous-lay.info", + refererUrl: "https://funny-underneath.biz/", + ip: "0.216.39.52", }, customer: { id: "", externalId: "", name: "", - createdAt: "1707101749980", + createdAt: "1713041063330", }, sale: { - amount: 844471, - paymentProcessor: "paddle", + amount: 884622, + paymentProcessor: "stripe", }, - saleAmount: 5439.21, + saleAmount: 7975.26, invoiceId: "", paymentProcessor: "", clickId: "", linkId: "", - domain: "wordy-bell.net", + domain: "striking-transparency.com", key: "", - url: "https://hoarse-dash.net/", + url: "https://sick-costume.biz/", continent: "Antarctica", - country: "Spain", - city: "Beerfield", - device: "Mobile", - browser: "Safari", - os: "WebOS", - qr: 5611.21, - ip: "6c6f:407b:0cdf:dffc:da0d:fb73:bafd:c2a6", + country: "Chad", + city: "Bernhardborough", + device: "Desktop", + browser: "Chrome", + os: "iOS", + qr: 941.22, + ip: "211.209.20.153", }; ``` diff --git a/docs/models/components/saleeventclick.md b/docs/models/components/saleeventclick.md index 01530429..b8178922 100644 --- a/docs/models/components/saleeventclick.md +++ b/docs/models/components/saleeventclick.md @@ -7,17 +7,17 @@ import { SaleEventClick } from "dub/models/components"; let value: SaleEventClick = { id: "", - url: "https://mysterious-countess.net", - country: "Niger", - city: "West Andyberg", + url: "https://soggy-planula.biz", + country: "Colombia", + city: "Spinkatown", region: "", - continent: "Africa", + continent: "Europe", device: "Desktop", browser: "Safari", - os: "Windows", - referer: "candid-chainstay.biz", - refererUrl: "https://familiar-requirement.org/", - ip: "e828:6aea:edfa:28f6:2dfd:bcad:e5db:be6f", + os: "Android", + referer: "liquid-lawmaker.com", + refererUrl: "https://sweet-backbone.biz", + ip: "244.170.246.136", }; ``` diff --git a/docs/models/components/saleeventcustomer.md b/docs/models/components/saleeventcustomer.md index efa2c54f..6b8d8d1e 100644 --- a/docs/models/components/saleeventcustomer.md +++ b/docs/models/components/saleeventcustomer.md @@ -9,7 +9,7 @@ let value: SaleEventCustomer = { id: "", externalId: "", name: "", - createdAt: "1713953396770", + createdAt: "1722367187028", }; ``` diff --git a/docs/models/components/saleeventcustomerlink.md b/docs/models/components/saleeventcustomerlink.md index 485fdc47..28c64640 100644 --- a/docs/models/components/saleeventcustomerlink.md +++ b/docs/models/components/saleeventcustomerlink.md @@ -7,9 +7,9 @@ import { SaleEventCustomerLink } from "dub/models/components"; let value: SaleEventCustomerLink = { id: "", - domain: "unsightly-impostor.net", + domain: "stingy-gerbil.info", key: "", - shortLink: "https://remarkable-fat.biz", + shortLink: "https://questionable-fort.org/", programId: "", }; ``` diff --git a/docs/models/components/saleeventdiscount.md b/docs/models/components/saleeventdiscount.md index 5d7c567c..c129575d 100644 --- a/docs/models/components/saleeventdiscount.md +++ b/docs/models/components/saleeventdiscount.md @@ -9,10 +9,10 @@ let value: SaleEventDiscount = { id: "", couponId: "", couponTestId: "", - amount: 1404.40, + amount: 4939.45, type: "flat", - duration: 8304.76, - interval: "month", + duration: 6672.15, + interval: "year", }; ``` diff --git a/docs/models/components/saleeventinterval.md b/docs/models/components/saleeventinterval.md index e8389c75..72f2b2a1 100644 --- a/docs/models/components/saleeventinterval.md +++ b/docs/models/components/saleeventinterval.md @@ -5,7 +5,7 @@ ```typescript import { SaleEventInterval } from "dub/models/components"; -let value: SaleEventInterval = "year"; +let value: SaleEventInterval = "month"; ``` ## Values diff --git a/docs/models/components/saleeventlink.md b/docs/models/components/saleeventlink.md index 9f196cf8..d98b4333 100644 --- a/docs/models/components/saleeventlink.md +++ b/docs/models/components/saleeventlink.md @@ -7,18 +7,19 @@ import { SaleEventLink } from "dub/models/components"; let value: SaleEventLink = { id: "", - domain: "far-off-reward.info", + domain: "critical-shark.name", key: "", - url: "https://well-off-waterspout.org", + url: "https://messy-vista.info", externalId: "", tenantId: "", - expiresAt: "1747624645569", - expiredUrl: "https://probable-hornet.com", - password: "jPkhlmUMazqEo_s", + expiresAt: "1761374753018", + expiredUrl: "https://immense-valuable.name", + password: "Hkbx9iLWrCuIjPk", title: "", - description: "while unless after vainly scoop", - image: "https://loremflickr.com/2111/950?lock=2324390746854989", - video: "https://picsum.videos/seed/ManpGiimO/2129/2813", + description: + "alarmed beyond quaver shaft rekindle vibration tomorrow optimistically", + image: "https://picsum.photos/seed/LwegfxH/3929/1602", + video: "https://picsum.videos/seed/npGiim/3797/2776", ios: "", android: "", geo: {}, @@ -27,15 +28,16 @@ let value: SaleEventLink = { { id: "", name: "", - color: "purple", + color: "pink", }, ], webhookIds: [ "", ], - comments: "enfold though because intermarry colonialism worthy", - shortLink: "https://sniveling-extent.info", - qrCode: "https://lucky-word.org/", + comments: + "sans sweetly solemnly under besides pointless now fooey among entwine capsize unfinished boo upside-down", + shortLink: "https://firm-nougat.name", + qrCode: "https://warm-excess.org", utmSource: "", utmMedium: "", utmCampaign: "", @@ -44,8 +46,8 @@ let value: SaleEventLink = { userId: "", workspaceId: "", lastClicked: "", - createdAt: "1708496426814", - updatedAt: "1736215935596", + createdAt: "1733440650786", + updatedAt: "1736480274898", projectId: "", programId: "", }; @@ -92,9 +94,9 @@ let value: SaleEventLink = { | `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: | N/A | -| `leads` | *number* | :heavy_minus_sign: | [BETA]: The number of leads the short links has generated. | -| `sales` | *number* | :heavy_minus_sign: | [BETA]: The number of sales the short links has generated. | -| `saleAmount` | *number* | :heavy_minus_sign: | [BETA]: The total dollar amount of sales the short links has generated (in cents). | +| `leads` | *number* | :heavy_minus_sign: | The number of leads the short links has generated. | +| `sales` | *number* | :heavy_minus_sign: | The number of sales the short links has generated. | +| `saleAmount` | *number* | :heavy_minus_sign: | The total dollar amount of sales the short links has generated (in cents). | | `createdAt` | *string* | :heavy_check_mark: | N/A | | `updatedAt` | *string* | :heavy_check_mark: | N/A | | ~~`projectId`~~ | *string* | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The project ID of the short link. This field is deprecated – use `workspaceId` instead. | diff --git a/docs/models/components/saleeventpartner.md b/docs/models/components/saleeventpartner.md index d218165e..36c9485d 100644 --- a/docs/models/components/saleeventpartner.md +++ b/docs/models/components/saleeventpartner.md @@ -8,7 +8,7 @@ import { SaleEventPartner } from "dub/models/components"; let value: SaleEventPartner = { id: "", name: "", - email: "Rosa.Nolan89@hotmail.com", + email: "Alexander.Bruen@hotmail.com", }; ``` diff --git a/docs/models/components/saleeventtype.md b/docs/models/components/saleeventtype.md index 756969ac..3866f8d1 100644 --- a/docs/models/components/saleeventtype.md +++ b/docs/models/components/saleeventtype.md @@ -5,7 +5,7 @@ ```typescript import { SaleEventType } from "dub/models/components"; -let value: SaleEventType = "percentage"; +let value: SaleEventType = "flat"; ``` ## Values diff --git a/docs/models/components/trigger.md b/docs/models/components/trigger.md index c0ba7276..78e1b85b 100644 --- a/docs/models/components/trigger.md +++ b/docs/models/components/trigger.md @@ -7,7 +7,7 @@ The type of trigger method: link click or QR scan ```typescript import { Trigger } from "dub/models/components"; -let value: Trigger = "qr"; +let value: Trigger = "link"; ``` ## Values diff --git a/docs/models/components/webhookevent.md b/docs/models/components/webhookevent.md index da289caa..a16d7331 100644 --- a/docs/models/components/webhookevent.md +++ b/docs/models/components/webhookevent.md @@ -10,23 +10,22 @@ Webhook event schema ```typescript const value: components.LinkWebhookEvent = { id: "", - event: "link.created", - createdAt: "1717422338642", + event: "link.deleted", + createdAt: "1727086214269", data: { id: "", - domain: "plump-underpants.com", + domain: "tempting-mentor.info", key: "", - url: "https://bossy-iridescence.info", + url: "https://motionless-institute.net", externalId: "", tenantId: "", - expiresAt: "1742910191749", - expiredUrl: "https://lanky-subsidy.org/", - password: "RsZB3HRZ6pzr9nZ", + expiresAt: "1742146787951", + expiredUrl: "https://intrepid-fax.com/", + password: "qjTiD5kp_nvhVpT", title: "", - description: - "separately utter however across wherever yowza ick moralise which whenever", - image: "https://loremflickr.com/666/2211?lock=1364464656615628", - video: "https://loremflickr.com/649/3853?lock=8479731286439501", + description: "since phony daintily now nephew", + image: "https://loremflickr.com/1721/3636?lock=6284578740569109", + video: "https://loremflickr.com/3881/701?lock=6248504339084924", ios: "", android: "", geo: {}, @@ -35,16 +34,16 @@ const value: components.LinkWebhookEvent = { { id: "", name: "", - color: "red", + color: "pink", }, ], webhookIds: [ "", ], comments: - "boohoo concerning regularly stupendous anti oh conservation throughout shoulder lest blah pfft", - shortLink: "https://mundane-cappelletti.info", - qrCode: "https://oddball-pigpen.org/", + "failing up subsidy except fax hence optimistically militate rusty so after awkwardly", + shortLink: "https://husky-swordfish.com/", + qrCode: "https://aged-importance.name", utmSource: "", utmMedium: "", utmCampaign: "", @@ -53,8 +52,8 @@ const value: components.LinkWebhookEvent = { userId: "", workspaceId: "", lastClicked: "", - createdAt: "1720444848152", - updatedAt: "1736247629598", + createdAt: "1706895169112", + updatedAt: "1736493756716", projectId: "", programId: "", }, @@ -67,37 +66,36 @@ const value: components.LinkWebhookEvent = { const value: components.LinkClickedEvent = { id: "", event: "link.clicked", - createdAt: "1709304603151", + createdAt: "1734773769261", data: { click: { id: "", - url: "https://scornful-hammock.name", - country: "Northern Mariana Islands", - city: "North Emilianostead", + url: "https://shady-nudge.biz/", + country: "Aland Islands", + city: "New Twilafurt", region: "", - continent: "Australia", - device: "Mobile", - browser: "Safari", - os: "Chrome OS", - referer: "concerned-step.name", - refererUrl: "https://same-video.biz", - ip: "8857:e65c:5ac5:9dcf:eaf9:7045:4abe:c57f", + continent: "North America", + device: "Desktop", + browser: "Firefox", + os: "MacOS", + referer: "ugly-rim.org", + refererUrl: "https://enchanted-castanet.org/", + ip: "3c93:3f6e:1a20:c2ff:3ef6:fa78:7dd3:d0e9", }, link: { id: "", - domain: "imaginative-allegation.info", + domain: "squiggly-pupil.info", key: "", - url: "https://incomparable-finer.org", + url: "https://mature-sightseeing.info", externalId: "", tenantId: "", - expiresAt: "1756622448913", - expiredUrl: "https://carefree-scorn.net/", - password: "x5e41nTMaTW6qVd", + expiresAt: "1753025289614", + expiredUrl: "https://pessimistic-euphonium.name/", + password: "10HILeNv2AWrBoE", title: "", - description: - "dishearten tender hm stranger lest veg certainly punctual sermon insist", - image: "https://picsum.photos/seed/2wWUAi/43/3859", - video: "https://loremflickr.com/1320/3591?lock=1180989999837323", + description: "loyalty descent and provided mash out throughout", + image: "https://picsum.photos/seed/JHYiHmoe/1954/537", + video: "https://loremflickr.com/1376/3793?lock=2215686402645453", ios: "", android: "", geo: {}, @@ -106,16 +104,16 @@ const value: components.LinkClickedEvent = { { id: "", name: "", - color: "yellow", + color: "purple", }, ], webhookIds: [ "", ], comments: - "frightfully silver unless save unlawful vague override shakily rewarding", - shortLink: "https://reckless-hexagon.com", - qrCode: "https://unpleasant-hello.org", + "wise finally enlightened aha reiterate besides milestone suckle yum", + shortLink: "https://official-scout.net", + qrCode: "https://inexperienced-heroine.org", utmSource: "", utmMedium: "", utmCampaign: "", @@ -124,8 +122,8 @@ const value: components.LinkClickedEvent = { userId: "", workspaceId: "", lastClicked: "", - createdAt: "1720643412160", - updatedAt: "1736267399429", + createdAt: "1725860417908", + updatedAt: "1736447594134", projectId: "", programId: "", }, @@ -139,43 +137,44 @@ const value: components.LinkClickedEvent = { const value: components.LeadCreatedEvent = { id: "", event: "lead.created", - createdAt: "1731033283089", + createdAt: "1722089449093", data: { eventName: "", customer: { id: "", externalId: "", name: "", - createdAt: "1722569293226", + createdAt: "1716218086436", }, click: { id: "", - url: "https://worldly-developmental.net/", - country: "Lesotho", - city: "Deecester", + url: "https://afraid-nun.net", + country: "Ethiopia", + city: "St. Paul", region: "", - continent: "Africa", - device: "Mobile", - browser: "Safari", - os: "Chrome OS", - referer: "insistent-effector.name", - refererUrl: "https://flashy-knickers.biz", - ip: "48.253.146.187", + continent: "South America", + device: "Desktop", + browser: "Firefox", + os: "Android", + referer: "thin-outset.name", + refererUrl: "https://naughty-outrun.org/", + ip: "ffeb:ad02:2a7e:d8be:ecd1:ebb1:955b:d90f", }, link: { id: "", - domain: "buttery-fun.org", + domain: "white-daddy.com", key: "", - url: "https://darling-optimal.name/", + url: "https://well-documented-thread.name", externalId: "", tenantId: "", - expiresAt: "1762734487584", - expiredUrl: "https://coordinated-disposer.info", - password: "6N8txK6jENW7B9C", + expiresAt: "1746099759110", + expiredUrl: "https://unpleasant-junior.com/", + password: "8LxCjEbgw4qcCST", title: "", - description: "mindless intently sizzling", - image: "https://loremflickr.com/1152/1980?lock=1696952041202833", - video: "https://picsum.videos/seed/P1zBX1wc3A/1743/2954", + description: + "dividend investigate minty louse ferret commonly talkative liberalize", + image: "https://loremflickr.com/976/2888?lock=8921210309936519", + video: "https://loremflickr.com/3381/2138?lock=2580244024002172", ios: "", android: "", geo: {}, @@ -184,16 +183,16 @@ const value: components.LeadCreatedEvent = { { id: "", name: "", - color: "pink", + color: "blue", }, ], webhookIds: [ "", ], comments: - "hourly as whenever antagonize obstruct overburden mountain wrongly plan psst promptly ha that what massive gah newsstand", - shortLink: "https://ornery-summer.org", - qrCode: "https://light-soup.com", + "so optimal abnormally er yahoo indeed respray coagulate submissive ridge veg save hourly as whenever antagonize obstruct overburden mountain", + shortLink: "https://well-groomed-swanling.name/", + qrCode: "https://humble-wasabi.net/", utmSource: "", utmMedium: "", utmCampaign: "", @@ -202,8 +201,8 @@ const value: components.LeadCreatedEvent = { userId: "", workspaceId: "", lastClicked: "", - createdAt: "1726311783363", - updatedAt: "1736258543230", + createdAt: "1710067954911", + updatedAt: "1736480436976", projectId: "", programId: "", }, @@ -217,43 +216,43 @@ const value: components.LeadCreatedEvent = { const value: components.SaleCreatedEvent = { id: "", event: "sale.created", - createdAt: "1710379644991", + createdAt: "1735478082403", data: { eventName: "", customer: { id: "", externalId: "", name: "", - createdAt: "1735446592964", + createdAt: "1721853598334", }, click: { id: "", - url: "https://plump-swath.name/", - country: "Bosnia and Herzegovina", - city: "Glenview", + url: "https://polite-dredger.com/", + country: "Hong Kong", + city: "Agustinastad", region: "", - continent: "South America", + continent: "Australia", device: "Mobile", - browser: "Safari", - os: "Android", - referer: "small-wilderness.name", - refererUrl: "https://aged-premier.org/", - ip: "80.128.18.22", + browser: "Firefox", + os: "Windows Phone", + referer: "sick-technologist.info", + refererUrl: "https://rowdy-approach.net", + ip: "171.120.179.185", }, link: { id: "", - domain: "insecure-diver.info", + domain: "difficult-petticoat.org", key: "", - url: "https://wobbly-unblinking.com/", + url: "https://smart-overcoat.org/", externalId: "", tenantId: "", - expiresAt: "1764133390785", - expiredUrl: "https://mediocre-coin.info/", - password: "gImezSmAGHRuKkd", + expiresAt: "1744734178689", + expiredUrl: "https://gentle-dish.net/", + password: "f5rSP3vrLCz6U3Z", title: "", - description: "toward to numeric positively", - image: "https://loremflickr.com/2925/3385?lock=6978812724792366", - video: "https://picsum.videos/seed/9p4GXNoA/1790/2643", + description: "cloudy stunt toward ha heroine suffice the keenly", + image: "https://picsum.photos/seed/T3rh9/1644/413", + video: "https://loremflickr.com/3135/2860?lock=5699446210998463", ios: "", android: "", geo: {}, @@ -262,16 +261,16 @@ const value: components.SaleCreatedEvent = { { id: "", name: "", - color: "green", + color: "pink", }, ], webhookIds: [ "", ], comments: - "accredit psst instead staid well-groomed rot woot ridge eek positively limping punctually before", - shortLink: "https://quick-witted-bowler.biz/", - qrCode: "https://puny-cricket.com", + "why nor ocelot baggy horn evince black though opposite wisely red middle accurate repeatedly supposing ferociously where", + shortLink: "https://smart-collectivization.name/", + qrCode: "https://definite-injunction.name", utmSource: "", utmMedium: "", utmCampaign: "", @@ -280,14 +279,14 @@ const value: components.SaleCreatedEvent = { userId: "", workspaceId: "", lastClicked: "", - createdAt: "1733287998312", - updatedAt: "1736238557690", + createdAt: "1710818092710", + updatedAt: "1736506025695", projectId: "", programId: "", }, sale: { - amount: 1795.00, - currency: "Zimbabwe Dollar", + amount: 789.96, + currency: "East Caribbean Dollar", paymentProcessor: "", invoiceId: "", }, diff --git a/docs/models/components/workspaceschema.md b/docs/models/components/workspaceschema.md index 83e7b4e9..81e306c8 100644 --- a/docs/models/components/workspaceschema.md +++ b/docs/models/components/workspaceschema.md @@ -12,28 +12,28 @@ let value: WorkspaceSchema = { inviteCode: "", plan: "business extra", stripeId: "", - billingCycleStart: 9703.75, + billingCycleStart: 3842.73, paymentFailedAt: "", stripeConnectId: "", payoutMethodId: "", - usage: 1752.76, - usageLimit: 2019.66, - linksUsage: 6937.23, - linksLimit: 7791.54, - salesUsage: 4905.49, - salesLimit: 6096.86, - domainsLimit: 2126.82, - tagsLimit: 4766.14, - usersLimit: 1120.72, - aiUsage: 3214.22, - aiLimit: 2847.80, + usage: 7034.07, + usageLimit: 3530.75, + linksUsage: 1544.25, + linksLimit: 3126.90, + salesUsage: 8843.24, + salesLimit: 9585.32, + domainsLimit: 2075.13, + tagsLimit: 7884.68, + usersLimit: 2733.49, + aiUsage: 8871.32, + aiLimit: 1655.46, conversionEnabled: false, dotLinkClaimed: false, partnersEnabled: false, - createdAt: "1718785864201", + createdAt: "1725992753135", users: [ { - role: "member", + role: "owner", }, ], domains: [ @@ -57,7 +57,7 @@ let value: WorkspaceSchema = { | `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. | | `paymentFailedAt` | *string* | :heavy_check_mark: | The date and time when the payment failed for the workspace. | -| `stripeConnectId` | *string* | :heavy_check_mark: | [BETA – Dub Conversions]: The Stripe Connect ID of the workspace. | +| `stripeConnectId` | *string* | :heavy_check_mark: | The Stripe Connect ID of the workspace. | | `payoutMethodId` | *string* | :heavy_check_mark: | [BETA – Dub Partners]: The ID of the payment method for partner payouts. | | `usage` | *number* | :heavy_check_mark: | The usage of the workspace. | | `usageLimit` | *number* | :heavy_check_mark: | The usage limit of the workspace. | diff --git a/docs/models/operations/bulkdeletelinksresponsebody.md b/docs/models/operations/bulkdeletelinksresponsebody.md index 8980dae5..e4c1c65f 100644 --- a/docs/models/operations/bulkdeletelinksresponsebody.md +++ b/docs/models/operations/bulkdeletelinksresponsebody.md @@ -8,7 +8,7 @@ The deleted links count. import { BulkDeleteLinksResponseBody } from "dub/models/operations"; let value: BulkDeleteLinksResponseBody = { - deletedCount: 612.50, + deletedCount: 8253.88, }; ``` diff --git a/docs/models/operations/color.md b/docs/models/operations/color.md index 8656e8ea..3c5194f0 100644 --- a/docs/models/operations/color.md +++ b/docs/models/operations/color.md @@ -7,7 +7,7 @@ The color of the tag. If not provided, a random color will be used from the list ```typescript import { Color } from "dub/models/operations"; -let value: Color = "purple"; +let value: Color = "yellow"; ``` ## Values diff --git a/docs/models/operations/createcustomerdiscount.md b/docs/models/operations/createcustomerdiscount.md index 6bc99d9d..97265b35 100644 --- a/docs/models/operations/createcustomerdiscount.md +++ b/docs/models/operations/createcustomerdiscount.md @@ -9,9 +9,9 @@ let value: CreateCustomerDiscount = { id: "", couponId: "", couponTestId: "", - amount: 2933.88, - type: "flat", - duration: 4180.10, + amount: 3855.46, + type: "percentage", + duration: 1823.72, interval: "year", }; ``` diff --git a/docs/models/operations/createcustomerlink.md b/docs/models/operations/createcustomerlink.md index 7adcb317..88843278 100644 --- a/docs/models/operations/createcustomerlink.md +++ b/docs/models/operations/createcustomerlink.md @@ -7,9 +7,9 @@ import { CreateCustomerLink } from "dub/models/operations"; let value: CreateCustomerLink = { id: "", - domain: "celebrated-cricket.biz", + domain: "crooked-hawk.org", key: "", - shortLink: "https://neighboring-yeast.biz", + shortLink: "https://failing-lotion.com/", programId: "", }; ``` diff --git a/docs/models/operations/createcustomerpartner.md b/docs/models/operations/createcustomerpartner.md index e1911eeb..63c67819 100644 --- a/docs/models/operations/createcustomerpartner.md +++ b/docs/models/operations/createcustomerpartner.md @@ -8,7 +8,7 @@ import { CreateCustomerPartner } from "dub/models/operations"; let value: CreateCustomerPartner = { id: "", name: "", - email: "Eliseo27@gmail.com", + email: "Ottilie21@gmail.com", }; ``` diff --git a/docs/models/operations/createcustomerresponsebody.md b/docs/models/operations/createcustomerresponsebody.md index b482034f..3d484040 100644 --- a/docs/models/operations/createcustomerresponsebody.md +++ b/docs/models/operations/createcustomerresponsebody.md @@ -11,7 +11,7 @@ let value: CreateCustomerResponseBody = { id: "", externalId: "", name: "", - createdAt: "1735272719272", + createdAt: "1731524762894", }; ``` diff --git a/docs/models/operations/createcustomertype.md b/docs/models/operations/createcustomertype.md index 8d11816f..4aef290b 100644 --- a/docs/models/operations/createcustomertype.md +++ b/docs/models/operations/createcustomertype.md @@ -5,7 +5,7 @@ ```typescript import { CreateCustomerType } from "dub/models/operations"; -let value: CreateCustomerType = "percentage"; +let value: CreateCustomerType = "flat"; ``` ## Values diff --git a/docs/models/operations/customer.md b/docs/models/operations/customer.md index bc784828..6485db4f 100644 --- a/docs/models/operations/customer.md +++ b/docs/models/operations/customer.md @@ -7,8 +7,8 @@ import { Customer } from "dub/models/operations"; let value: Customer = { name: "", - email: "Oma_Volkman@gmail.com", - avatar: "https://picsum.photos/seed/wzw0lN/1648/1039", + email: "Sterling.Rutherford@hotmail.com", + avatar: "https://picsum.photos/seed/MkSQwt395w/592/665", externalId: "", }; ``` diff --git a/docs/models/operations/discount.md b/docs/models/operations/discount.md index 5613eb20..ef34b201 100644 --- a/docs/models/operations/discount.md +++ b/docs/models/operations/discount.md @@ -9,10 +9,10 @@ let value: Discount = { id: "", couponId: "", couponTestId: "", - amount: 5819.46, - type: "percentage", - duration: 5763.80, - interval: "year", + amount: 4391.60, + type: "flat", + duration: 237.68, + interval: "month", }; ``` diff --git a/docs/models/operations/getcustomerdiscount.md b/docs/models/operations/getcustomerdiscount.md index eeae5d34..80f38d7d 100644 --- a/docs/models/operations/getcustomerdiscount.md +++ b/docs/models/operations/getcustomerdiscount.md @@ -9,9 +9,9 @@ let value: GetCustomerDiscount = { id: "", couponId: "", couponTestId: "", - amount: 7785.88, - type: "percentage", - duration: 6869.79, + amount: 1687.32, + type: "flat", + duration: 8111.96, interval: "month", }; ``` diff --git a/docs/models/operations/getcustomerinterval.md b/docs/models/operations/getcustomerinterval.md index e878ea26..78d3d26a 100644 --- a/docs/models/operations/getcustomerinterval.md +++ b/docs/models/operations/getcustomerinterval.md @@ -5,7 +5,7 @@ ```typescript import { GetCustomerInterval } from "dub/models/operations"; -let value: GetCustomerInterval = "month"; +let value: GetCustomerInterval = "year"; ``` ## Values diff --git a/docs/models/operations/getcustomerlink.md b/docs/models/operations/getcustomerlink.md index e40f041c..3d324f84 100644 --- a/docs/models/operations/getcustomerlink.md +++ b/docs/models/operations/getcustomerlink.md @@ -7,9 +7,9 @@ import { GetCustomerLink } from "dub/models/operations"; let value: GetCustomerLink = { id: "", - domain: "bustling-trash.net", + domain: "accomplished-certification.biz", key: "", - shortLink: "https://heavenly-platter.net", + shortLink: "https://impressionable-commercial.com", programId: "", }; ``` diff --git a/docs/models/operations/getcustomerpartner.md b/docs/models/operations/getcustomerpartner.md index f4a485cb..de2618d3 100644 --- a/docs/models/operations/getcustomerpartner.md +++ b/docs/models/operations/getcustomerpartner.md @@ -8,7 +8,7 @@ import { GetCustomerPartner } from "dub/models/operations"; let value: GetCustomerPartner = { id: "", name: "", - email: "Rachael25@hotmail.com", + email: "Ramiro_Lindgren@hotmail.com", }; ``` diff --git a/docs/models/operations/getcustomerresponsebody.md b/docs/models/operations/getcustomerresponsebody.md index f4c2c46b..8ee0a5bd 100644 --- a/docs/models/operations/getcustomerresponsebody.md +++ b/docs/models/operations/getcustomerresponsebody.md @@ -11,7 +11,7 @@ let value: GetCustomerResponseBody = { id: "", externalId: "", name: "", - createdAt: "1708781654359", + createdAt: "1724542422013", }; ``` diff --git a/docs/models/operations/getcustomersinterval.md b/docs/models/operations/getcustomersinterval.md index f7675a3f..f7351183 100644 --- a/docs/models/operations/getcustomersinterval.md +++ b/docs/models/operations/getcustomersinterval.md @@ -5,7 +5,7 @@ ```typescript import { GetCustomersInterval } from "dub/models/operations"; -let value: GetCustomersInterval = "month"; +let value: GetCustomersInterval = "year"; ``` ## Values diff --git a/docs/models/operations/getcustomersresponsebody.md b/docs/models/operations/getcustomersresponsebody.md new file mode 100644 index 00000000..0f52fb17 --- /dev/null +++ b/docs/models/operations/getcustomersresponsebody.md @@ -0,0 +1,29 @@ +# GetCustomersResponseBody + +## Example Usage + +```typescript +import { GetCustomersResponseBody } from "dub/models/operations"; + +let value: GetCustomersResponseBody = { + id: "", + externalId: "", + name: "", + createdAt: "1720036691696", +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `id` | *string* | :heavy_check_mark: | The unique identifier of the customer in Dub. | +| `externalId` | *string* | :heavy_check_mark: | Unique identifier for the customer in the client's app. | +| `name` | *string* | :heavy_check_mark: | Name of the customer. | +| `email` | *string* | :heavy_minus_sign: | Email of the customer. | +| `avatar` | *string* | :heavy_minus_sign: | Avatar URL of the customer. | +| `country` | *string* | :heavy_minus_sign: | Country of the customer. | +| `createdAt` | *string* | :heavy_check_mark: | The date the customer was created. | +| `link` | [operations.Link](../../models/operations/link.md) | :heavy_minus_sign: | N/A | +| `partner` | [operations.Partner](../../models/operations/partner.md) | :heavy_minus_sign: | N/A | +| `discount` | [operations.Discount](../../models/operations/discount.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getcustomertype.md b/docs/models/operations/getcustomertype.md index 76a4b910..0116da41 100644 --- a/docs/models/operations/getcustomertype.md +++ b/docs/models/operations/getcustomertype.md @@ -5,7 +5,7 @@ ```typescript import { GetCustomerType } from "dub/models/operations"; -let value: GetCustomerType = "percentage"; +let value: GetCustomerType = "flat"; ``` ## Values diff --git a/docs/models/operations/getlinksrequest.md b/docs/models/operations/getlinksrequest.md index 9d583707..3c29108e 100644 --- a/docs/models/operations/getlinksrequest.md +++ b/docs/models/operations/getlinksrequest.md @@ -21,6 +21,8 @@ let value: GetLinksRequest = {}; | `tenantId` | *string* | :heavy_minus_sign: | The ID of the tenant that created the link inside your system. If set, will only return links for the specified tenant. | | | `showArchived` | *boolean* | :heavy_minus_sign: | Whether to include archived links in the response. Defaults to `false` if not provided. | | | `withTags` | *boolean* | :heavy_minus_sign: | DEPRECATED. Filter for links that have at least one tag assigned to them. | | -| `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. | | +| `sortBy` | [operations.SortBy](../../models/operations/sortby.md) | :heavy_minus_sign: | The field to sort the links by. The default is `createdAt`. | | +| `sortOrder` | [operations.SortOrder](../../models/operations/sortorder.md) | :heavy_minus_sign: | The sort order. The default is `desc`. | | +| `sort` | [operations.Sort](../../models/operations/sort.md) | :heavy_minus_sign: | DEPRECATED. Use `sortBy` instead. | | | `page` | *number* | :heavy_minus_sign: | The page number for pagination. | 1 | | `pageSize` | *number* | :heavy_minus_sign: | The number of items per page. | 50 | \ No newline at end of file diff --git a/docs/models/operations/getlinksresponse.md b/docs/models/operations/getlinksresponse.md index 89ce776c..ca12db3d 100644 --- a/docs/models/operations/getlinksresponse.md +++ b/docs/models/operations/getlinksresponse.md @@ -9,19 +9,19 @@ let value: GetLinksResponse = { result: [ { id: "", - domain: "perky-hydrolyze.name", + domain: "hurtful-onset.org", key: "", - url: "https://fine-configuration.name", + url: "https://actual-discourse.net/", externalId: "", tenantId: "", - expiresAt: "1745990010972", - expiredUrl: "https://able-pleasure.com/", - password: "f40ZIsQaDEgLAKP", + expiresAt: "1754402456576", + expiredUrl: "https://neglected-doing.net", + password: "_nKI6c5phyVKlNu", title: "", description: - "where dependency ha gadzooks burdensome pfft nor equate per mid", - image: "https://picsum.photos/seed/n3NFrvT/1591/3266", - video: "https://picsum.videos/seed/6jGT6BGh/3510/717", + "bravely fill essence coincide transparency below wholly barring how scrutinise", + image: "https://picsum.photos/seed/Eqr7aUst/99/734", + video: "https://picsum.videos/seed/ppsRBKI3YH/2665/57", ios: "", android: "", geo: {}, @@ -30,15 +30,15 @@ let value: GetLinksResponse = { { id: "", name: "", - color: "pink", + color: "purple", }, ], webhookIds: [ "", ], - comments: "council absent quietly stake gaseous so", - shortLink: "https://striking-trench.biz", - qrCode: "https://unripe-soybean.info/", + comments: "lazy kick when reckon vice", + shortLink: "https://shadowy-scale.com", + qrCode: "https://wobbly-substitution.org", utmSource: "", utmMedium: "", utmCampaign: "", @@ -47,8 +47,8 @@ let value: GetLinksResponse = { userId: "", workspaceId: "", lastClicked: "", - createdAt: "1719502139293", - updatedAt: "1736275721047", + createdAt: "1715280117171", + updatedAt: "1736514260384", projectId: "", programId: "", }, diff --git a/docs/models/operations/getqrcoderequest.md b/docs/models/operations/getqrcoderequest.md index ebc1c913..42353039 100644 --- a/docs/models/operations/getqrcoderequest.md +++ b/docs/models/operations/getqrcoderequest.md @@ -6,7 +6,7 @@ import { GetQRCodeRequest } from "dub/models/operations"; let value: GetQRCodeRequest = { - url: "https://posh-defendant.info", + url: "https://squeaky-swordfish.com", }; ``` diff --git a/docs/models/operations/interval.md b/docs/models/operations/interval.md index d20d772a..5b851730 100644 --- a/docs/models/operations/interval.md +++ b/docs/models/operations/interval.md @@ -7,7 +7,7 @@ The interval to retrieve analytics for. If undefined, defaults to 24h. ```typescript import { Interval } from "dub/models/operations"; -let value: Interval = "ytd"; +let value: Interval = "24h"; ``` ## Values diff --git a/docs/models/operations/level.md b/docs/models/operations/level.md index edb0a0ce..7529300c 100644 --- a/docs/models/operations/level.md +++ b/docs/models/operations/level.md @@ -7,7 +7,7 @@ The level of error correction to use for the QR code. Defaults to `L` if not pro ```typescript import { Level } from "dub/models/operations"; -let value: Level = "Q"; +let value: Level = "H"; ``` ## Values diff --git a/docs/models/operations/link.md b/docs/models/operations/link.md index f4843256..46f606df 100644 --- a/docs/models/operations/link.md +++ b/docs/models/operations/link.md @@ -7,9 +7,9 @@ import { Link } from "dub/models/operations"; let value: Link = { id: "", - domain: "repentant-perp.info", + domain: "intelligent-thyme.com", key: "", - shortLink: "https://frizzy-necklace.net", + shortLink: "https://rich-disappointment.com/", programId: "", }; ``` diff --git a/docs/models/operations/listdomainsresponse.md b/docs/models/operations/listdomainsresponse.md index 9eef237a..e369dcd9 100644 --- a/docs/models/operations/listdomainsresponse.md +++ b/docs/models/operations/listdomainsresponse.md @@ -14,12 +14,12 @@ let value: ListDomainsResponse = { expiredUrl: "https://acme.com/expired", notFoundUrl: "https://acme.com/not-found", logo: "", - createdAt: "1709378016182", - updatedAt: "1736221884717", + createdAt: "1716020230891", + updatedAt: "1736478842610", registeredDomain: { id: "", - createdAt: "1715451692705", - expiresAt: "1751495084461", + createdAt: "1706160981196", + expiresAt: "1743934359677", }, }, ], diff --git a/docs/models/operations/listeventsrequest.md b/docs/models/operations/listeventsrequest.md index 2286177c..e63712f4 100644 --- a/docs/models/operations/listeventsrequest.md +++ b/docs/models/operations/listeventsrequest.md @@ -38,5 +38,6 @@ let value: ListEventsRequest = {}; | `root` | *boolean* | :heavy_minus_sign: | Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both. | | | `page` | *number* | :heavy_minus_sign: | N/A | | | `limit` | *number* | :heavy_minus_sign: | N/A | | -| `order` | [operations.Order](../../models/operations/order.md) | :heavy_minus_sign: | N/A | | -| `sortBy` | [operations.SortBy](../../models/operations/sortby.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `sortOrder` | [operations.QueryParamSortOrder](../../models/operations/queryparamsortorder.md) | :heavy_minus_sign: | The sort order. The default is `desc`. | | +| `sortBy` | [operations.QueryParamSortBy](../../models/operations/queryparamsortby.md) | :heavy_minus_sign: | The field to sort the events by. The default is `timestamp`. | | +| `order` | [operations.Order](../../models/operations/order.md) | :heavy_minus_sign: | DEPRECATED. Use `sortOrder` instead. | | \ No newline at end of file diff --git a/docs/models/operations/listeventsresponsebody.md b/docs/models/operations/listeventsresponsebody.md index 84debd4d..280f5ac9 100644 --- a/docs/models/operations/listeventsresponsebody.md +++ b/docs/models/operations/listeventsresponsebody.md @@ -13,32 +13,33 @@ const value: components.ClickEvent[] = [ event: "click", click: { id: "", - url: "https://frail-gallery.name/", - country: "Sierra Leone", - city: "Bayamon", + url: "https://red-hunger.name", + country: "Tokelau", + city: "Chula Vista", region: "", - continent: "Europe", + continent: "North America", device: "Mobile", - browser: "Firefox", - os: "WebOS", - referer: "warm-republican.biz", - refererUrl: "https://triangular-essence.com", - ip: "f2e0:0bb7:9bc6:b49f:fbe1:6414:cdba:afe4", + browser: "Chrome", + os: "Android", + referer: "ripe-tarragon.com", + refererUrl: "https://remorseful-dulcimer.net", + ip: "61.0.128.67", }, link: { id: "", - domain: "burdensome-avalanche.info", + domain: "boiling-swim.biz", key: "", - url: "https://experienced-toothbrush.org/", + url: "https://firm-nectarine.name", externalId: "", tenantId: "", - expiresAt: "1759777548176", - expiredUrl: "https://unfortunate-underneath.org/", - password: "9sBgmN8HWP0DxLQ", + expiresAt: "1759409290170", + expiredUrl: "https://austere-story.org/", + password: "ukOSaWshlXx_1Zf", title: "", - description: "galvanize gently from ick meanwhile likewise", - image: "https://loremflickr.com/3448/2651?lock=1005205464699863", - video: "https://loremflickr.com/126/362?lock=7075899800217260", + description: + "forsaken beloved inspection famously conservative scramble officially sticky versus", + image: "https://picsum.photos/seed/i7NY7E02MO/2993/687", + video: "https://picsum.videos/seed/hMcrIGvF3h/1398/1792", ios: "", android: "", geo: {}, @@ -47,16 +48,15 @@ const value: components.ClickEvent[] = [ { id: "", name: "", - color: "pink", + color: "yellow", }, ], webhookIds: [ "", ], - comments: - "drat whenever trim without offensively unless unexpectedly upside-down", - shortLink: "https://slow-membership.biz/", - qrCode: "https://tempting-editor.biz", + comments: "oof hence unhappy um even phooey", + shortLink: "https://marvelous-monocle.info/", + qrCode: "https://stormy-populist.org/", utmSource: "", utmMedium: "", utmCampaign: "", @@ -65,24 +65,24 @@ const value: components.ClickEvent[] = [ userId: "", workspaceId: "", lastClicked: "", - createdAt: "1716085285381", - updatedAt: "1736242454901", + createdAt: "1705865711722", + updatedAt: "1736504930652", projectId: "", programId: "", }, clickId: "", linkId: "", - domain: "curly-tuber.org", + domain: "beloved-elevator.org", key: "", - url: "https://last-scout.info", - continent: "South America", - country: "Trinidad and Tobago", - city: "Jarrodstad", - device: "Desktop", - browser: "Chrome", - os: "iOS", - qr: 7840.75, - ip: "c92b:094c:2a8c:cad5:b72b:7600:57f8:bc73", + url: "https://quixotic-guard.com", + continent: "Antarctica", + country: "Republic of Korea", + city: "Jadetown", + device: "Mobile", + browser: "Firefox", + os: "Windows", + qr: 9392.13, + ip: "43.193.89.156", }, ]; ``` @@ -97,32 +97,32 @@ const value: components.LeadEvent[] = [ eventName: "", click: { id: "", - url: "https://ideal-halt.info/", - country: "Sierra Leone", - city: "North Darrelmouth", + url: "https://intrepid-airmail.biz/", + country: "Colombia", + city: "Farmington", region: "", continent: "North America", - device: "Mobile", - browser: "Chrome", - os: "MacOS", - referer: "memorable-essence.org", - refererUrl: "https://different-resource.info/", - ip: "bedf:12d8:fce3:d0a0:e4d6:0f9f:1b13:b523", + device: "Desktop", + browser: "Safari", + os: "Blackberry", + referer: "acidic-cannon.com", + refererUrl: "https://electric-schnitzel.net/", + ip: "99.220.18.144", }, link: { id: "", - domain: "coordinated-stall.name", + domain: "clean-yarmulke.info", key: "", - url: "https://far-orchid.org", + url: "https://crooked-word.com", externalId: "", tenantId: "", - expiresAt: "1753138981267", - expiredUrl: "https://elastic-vibration.com", - password: "i4V6JejWL8Ztft9", + expiresAt: "1738385218245", + expiredUrl: "https://soupy-diagram.biz", + password: "MzpsWKiGhYtTZnq", title: "", - description: "interestingly gape notwithstanding onto fortunately", - image: "https://picsum.photos/seed/tUHwDJ/483/2378", - video: "https://loremflickr.com/2914/1940?lock=1857055639491229", + description: "uproot rewarding brr even hmph joyfully", + image: "https://picsum.photos/seed/7w2qcQ7/3136/2727", + video: "https://picsum.videos/seed/tAewl6Nm/1899/1541", ios: "", android: "", geo: {}, @@ -131,15 +131,15 @@ const value: components.LeadEvent[] = [ { id: "", name: "", - color: "brown", + color: "yellow", }, ], webhookIds: [ "", ], - comments: "pace blank waft tabletop jealously", - shortLink: "https://substantial-mythology.name/", - qrCode: "https://flimsy-interviewer.biz/", + comments: "overstay shinny before resource better", + shortLink: "https://phony-fund.org/", + qrCode: "https://variable-conservation.name", utmSource: "", utmMedium: "", utmCampaign: "", @@ -148,8 +148,8 @@ const value: components.LeadEvent[] = [ userId: "", workspaceId: "", lastClicked: "", - createdAt: "1715470992833", - updatedAt: "1736251808532", + createdAt: "1705870185102", + updatedAt: "1736504158520", projectId: "", programId: "", }, @@ -157,21 +157,21 @@ const value: components.LeadEvent[] = [ id: "", externalId: "", name: "", - createdAt: "1731364802873", + createdAt: "1706322544941", }, clickId: "", linkId: "", - domain: "vibrant-someplace.name", + domain: "reflecting-custody.name", key: "", - url: "https://great-in-joke.org", - continent: "Asia", - country: "Chad", - city: "Macyland", - device: "Desktop", + url: "https://alert-pneumonia.info/", + continent: "North America", + country: "Austria", + city: "Amosville", + device: "Mobile", browser: "Chrome", - os: "BeOS", - qr: 6746.04, - ip: "154.169.133.194", + os: "MacOS", + qr: 1418.09, + ip: "216.151.202.65", }, ]; ``` @@ -186,18 +186,18 @@ const value: components.SaleEvent[] = [ eventName: "", link: { id: "", - domain: "alive-cork.org", + domain: "powerful-tectonics.name", key: "", - url: "https://blushing-expansion.com/", + url: "https://elastic-vibration.com", externalId: "", tenantId: "", - expiresAt: "1754572568422", - expiredUrl: "https://overdue-numeracy.biz", - password: "7QvWIpK5DD9wbbb", + expiresAt: "1760529356443", + expiredUrl: "https://clear-meadow.biz/", + password: "6JejWL8Ztft9BhC", title: "", - description: "truthfully plus meanwhile", - image: "https://picsum.photos/seed/eL12o9aCRM/149/940", - video: "https://picsum.videos/seed/t395wFCS/1346/3500", + description: "aha ugh uselessly", + image: "https://loremflickr.com/206/122?lock=5797836405904630", + video: "https://loremflickr.com/2121/649?lock=4768675272268462", ios: "", android: "", geo: {}, @@ -206,16 +206,15 @@ const value: components.SaleEvent[] = [ { id: "", name: "", - color: "purple", + color: "brown", }, ], webhookIds: [ "", ], - comments: - "why triumphantly footrest coexist hammock rag display ostrich aboard pfft so finally lest save sightseeing lawful lest if", - shortLink: "https://lovely-sandbar.net/", - qrCode: "https://unfit-assist.org", + comments: "tankful furiously hovel likewise strictly wetly blah", + shortLink: "https://fluffy-giant.info", + qrCode: "https://parallel-mechanic.info", utmSource: "", utmMedium: "", utmCampaign: "", @@ -224,51 +223,51 @@ const value: components.SaleEvent[] = [ userId: "", workspaceId: "", lastClicked: "", - createdAt: "1718213049663", - updatedAt: "1736230433945", + createdAt: "1713811178511", + updatedAt: "1736481952091", projectId: "", programId: "", }, click: { id: "", - url: "https://superior-travel.name", - country: "Saint Helena", - city: "Kamilleshire", + url: "https://gripping-hunt.org/", + country: "Uganda", + city: "Mansfield", region: "", - continent: "North America", - device: "Mobile", + continent: "Europe", + device: "Desktop", browser: "Firefox", - os: "MacOS", - referer: "clean-essence.net", - refererUrl: "https://competent-bid.org/", - ip: "51.100.161.150", + os: "Symbian", + referer: "happy-community.info", + refererUrl: "https://colorless-cash.biz", + ip: "e4de:ba04:fa16:0cfc:d75b:d0c9:dc94:8318", }, customer: { id: "", externalId: "", name: "", - createdAt: "1733892632164", + createdAt: "1724723071821", }, sale: { - amount: 681972, - paymentProcessor: "shopify", + amount: 262835, + paymentProcessor: "paddle", }, - saleAmount: 7115.98, + saleAmount: 6889.51, invoiceId: "", paymentProcessor: "", clickId: "", linkId: "", - domain: "radiant-ruin.name", + domain: "ripe-pop.com", key: "", - url: "https://unruly-possession.info", - continent: "Antarctica", - country: "New Zealand", - city: "Baileyfort", + url: "https://upset-aftermath.name", + continent: "Europe", + country: "Colombia", + city: "Norwalk", device: "Desktop", - browser: "Chrome", - os: "MacOS", - qr: 6567.81, - ip: "c2ce:4aa2:5e8a:bc2a:ab65:4854:f9e8:cadf", + browser: "Safari", + os: "Linux", + qr: 6785.88, + ip: "185.25.243.52", }, ]; ``` diff --git a/docs/models/operations/order.md b/docs/models/operations/order.md index 1d7002ff..f1aad975 100644 --- a/docs/models/operations/order.md +++ b/docs/models/operations/order.md @@ -1,4 +1,8 @@ -# Order +# ~~Order~~ + +DEPRECATED. Use `sortOrder` instead. + +> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ## Example Usage diff --git a/docs/models/operations/partner.md b/docs/models/operations/partner.md index 417cf66c..26f1606f 100644 --- a/docs/models/operations/partner.md +++ b/docs/models/operations/partner.md @@ -8,7 +8,7 @@ import { Partner } from "dub/models/operations"; let value: Partner = { id: "", name: "", - email: "Holly.Rutherford@hotmail.com", + email: "Annetta22@hotmail.com", }; ``` diff --git a/docs/models/operations/queryparamevent.md b/docs/models/operations/queryparamevent.md index 9f42b4dd..d086d5ae 100644 --- a/docs/models/operations/queryparamevent.md +++ b/docs/models/operations/queryparamevent.md @@ -7,7 +7,7 @@ The type of event to retrieve analytics for. Defaults to 'clicks'. ```typescript import { QueryParamEvent } from "dub/models/operations"; -let value: QueryParamEvent = "leads"; +let value: QueryParamEvent = "sales"; ``` ## Values diff --git a/docs/models/operations/queryparamgroupby.md b/docs/models/operations/queryparamgroupby.md index 91d3b534..c8a44b3a 100644 --- a/docs/models/operations/queryparamgroupby.md +++ b/docs/models/operations/queryparamgroupby.md @@ -7,7 +7,7 @@ The parameter to group the analytics data points by. Defaults to `count` if unde ```typescript import { QueryParamGroupBy } from "dub/models/operations"; -let value: QueryParamGroupBy = "regions"; +let value: QueryParamGroupBy = "referer_urls"; ``` ## Values diff --git a/docs/models/operations/queryparaminterval.md b/docs/models/operations/queryparaminterval.md index 1029e95b..34f9ab6e 100644 --- a/docs/models/operations/queryparaminterval.md +++ b/docs/models/operations/queryparaminterval.md @@ -7,7 +7,7 @@ The interval to retrieve events for. Takes precedence over start and end. If und ```typescript import { QueryParamInterval } from "dub/models/operations"; -let value: QueryParamInterval = "90d"; +let value: QueryParamInterval = "1y"; ``` ## Values diff --git a/docs/models/operations/queryparamsortby.md b/docs/models/operations/queryparamsortby.md new file mode 100644 index 00000000..3bcd0073 --- /dev/null +++ b/docs/models/operations/queryparamsortby.md @@ -0,0 +1,17 @@ +# QueryParamSortBy + +The field to sort the events by. The default is `timestamp`. + +## Example Usage + +```typescript +import { QueryParamSortBy } from "dub/models/operations"; + +let value: QueryParamSortBy = "timestamp"; +``` + +## Values + +```typescript +"timestamp" +``` \ No newline at end of file diff --git a/docs/models/operations/queryparamsortorder.md b/docs/models/operations/queryparamsortorder.md new file mode 100644 index 00000000..6f474a9a --- /dev/null +++ b/docs/models/operations/queryparamsortorder.md @@ -0,0 +1,17 @@ +# QueryParamSortOrder + +The sort order. The default is `desc`. + +## Example Usage + +```typescript +import { QueryParamSortOrder } from "dub/models/operations"; + +let value: QueryParamSortOrder = "asc"; +``` + +## Values + +```typescript +"asc" | "desc" +``` \ No newline at end of file diff --git a/docs/models/operations/queryparamtrigger.md b/docs/models/operations/queryparamtrigger.md index 746c89e8..ba634227 100644 --- a/docs/models/operations/queryparamtrigger.md +++ b/docs/models/operations/queryparamtrigger.md @@ -7,7 +7,7 @@ The trigger to retrieve analytics for. If undefined, return both QR and link cli ```typescript import { QueryParamTrigger } from "dub/models/operations"; -let value: QueryParamTrigger = "link"; +let value: QueryParamTrigger = "qr"; ``` ## Values diff --git a/docs/models/operations/responsebody.md b/docs/models/operations/responsebody.md index dc2479da..8481fa2e 100644 --- a/docs/models/operations/responsebody.md +++ b/docs/models/operations/responsebody.md @@ -1,29 +1,63 @@ # ResponseBody -## Example Usage -```typescript -import { ResponseBody } from "dub/models/operations"; +## Supported Types + +### `components.LinkSchema` -let value: ResponseBody = { +```typescript +const value: components.LinkSchema = { id: "", + domain: "unhealthy-doorpost.biz", + key: "", + url: "https://orderly-bungalow.info", externalId: "", - name: "", - createdAt: "1715269372122", + tenantId: "", + expiresAt: "1746996993737", + expiredUrl: "https://innocent-pasta.net", + password: "dw8Qh65bkuKe1jf", + title: "", + description: "pfft overwork through surprisingly axe sunbathe", + image: "https://loremflickr.com/1970/419?lock=3754230433758555", + video: "https://loremflickr.com/742/3683?lock=3390037391098427", + ios: "", + android: "", + geo: {}, + tagId: "", + tags: [ + { + id: "", + name: "", + color: "blue", + }, + ], + webhookIds: [ + "", + ], + comments: "than a yet coolly but pick creature with where that", + shortLink: "https://recent-graffiti.org", + qrCode: "https://narrow-toothpick.net/", + utmSource: "", + utmMedium: "", + utmCampaign: "", + utmTerm: "", + utmContent: "", + userId: "", + workspaceId: "", + lastClicked: "", + createdAt: "1707976502947", + updatedAt: "1736507786813", + projectId: "", + programId: "", }; ``` -## Fields +### `components.LinkErrorSchema` + +```typescript +const value: components.LinkErrorSchema = { + error: "", + code: "conflict", +}; +``` -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the customer in Dub. | -| `externalId` | *string* | :heavy_check_mark: | Unique identifier for the customer in the client's app. | -| `name` | *string* | :heavy_check_mark: | Name of the customer. | -| `email` | *string* | :heavy_minus_sign: | Email of the customer. | -| `avatar` | *string* | :heavy_minus_sign: | Avatar URL of the customer. | -| `country` | *string* | :heavy_minus_sign: | Country of the customer. | -| `createdAt` | *string* | :heavy_check_mark: | The date the customer was created. | -| `link` | [operations.Link](../../models/operations/link.md) | :heavy_minus_sign: | N/A | -| `partner` | [operations.Partner](../../models/operations/partner.md) | :heavy_minus_sign: | N/A | -| `discount` | [operations.Discount](../../models/operations/discount.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/retrieveanalyticsresponsebody.md b/docs/models/operations/retrieveanalyticsresponsebody.md index 890b376c..4dd9809f 100644 --- a/docs/models/operations/retrieveanalyticsresponsebody.md +++ b/docs/models/operations/retrieveanalyticsresponsebody.md @@ -26,7 +26,7 @@ const value: components.AnalyticsTimeseries[] = [ ```typescript const value: components.AnalyticsContinents[] = [ { - continent: "AF", + continent: "SA", }, ]; ``` @@ -36,7 +36,7 @@ const value: components.AnalyticsContinents[] = [ ```typescript const value: components.AnalyticsCountries[] = [ { - country: "RS", + country: "AM", }, ]; ``` @@ -46,8 +46,8 @@ const value: components.AnalyticsCountries[] = [ ```typescript const value: components.AnalyticsCities[] = [ { - city: "Olliebury", - country: "LT", + city: "Port Isabell", + country: "BZ", }, ]; ``` @@ -57,7 +57,7 @@ const value: components.AnalyticsCities[] = [ ```typescript const value: components.AnalyticsDevices[] = [ { - device: "Mobile", + device: "Desktop", }, ]; ``` @@ -77,7 +77,7 @@ const value: components.AnalyticsBrowsers[] = [ ```typescript const value: components.AnalyticsOS[] = [ { - os: "Windows", + os: "Android", }, ]; ``` @@ -87,7 +87,7 @@ const value: components.AnalyticsOS[] = [ ```typescript const value: components.AnalyticsTriggers[] = [ { - trigger: "qr", + trigger: "link", }, ]; ``` @@ -97,7 +97,7 @@ const value: components.AnalyticsTriggers[] = [ ```typescript const value: components.AnalyticsReferers[] = [ { - referer: "far-off-velocity.net", + referer: "wasteful-colon.com", }, ]; ``` @@ -107,7 +107,7 @@ const value: components.AnalyticsReferers[] = [ ```typescript const value: components.AnalyticsRefererUrls[] = [ { - refererUrl: "https://black-and-white-settler.biz", + refererUrl: "https://limited-climb.biz/", }, ]; ``` @@ -119,11 +119,11 @@ const value: components.AnalyticsTopLinks[] = [ { link: "", id: "", - domain: "creamy-summary.com", + domain: "vivacious-providence.name", key: "", shortLink: "", - url: "https://usable-director.net/", - createdAt: "1725488773363", + url: "https://acceptable-cheese.net", + createdAt: "1727538288719", }, ]; ``` @@ -133,7 +133,7 @@ const value: components.AnalyticsTopLinks[] = [ ```typescript const value: components.AnalyticsTopUrls[] = [ { - url: "https://stained-crocodile.net/", + url: "https://outlying-masterpiece.info", }, ]; ``` diff --git a/docs/models/operations/sale.md b/docs/models/operations/sale.md index d7cb5586..c1c22b8b 100644 --- a/docs/models/operations/sale.md +++ b/docs/models/operations/sale.md @@ -6,8 +6,8 @@ import { Sale } from "dub/models/operations"; let value: Sale = { - amount: 7374.84, - currency: "Djibouti Franc", + amount: 3514.21, + currency: "Solomon Islands Dollar", paymentProcessor: "", invoiceId: "", metadata: { diff --git a/docs/models/operations/sort.md b/docs/models/operations/sort.md index 874e40d6..fc5ae1fe 100644 --- a/docs/models/operations/sort.md +++ b/docs/models/operations/sort.md @@ -1,6 +1,8 @@ -# Sort +# ~~Sort~~ -The field to sort the links by. The default is `createdAt`, and sort order is always descending. +DEPRECATED. Use `sortBy` instead. + +> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ## Example Usage @@ -13,5 +15,5 @@ let value: Sort = "lastClicked"; ## Values ```typescript -"createdAt" | "clicks" | "lastClicked" +"createdAt" | "clicks" | "saleAmount" | "lastClicked" ``` \ No newline at end of file diff --git a/docs/models/operations/sortby.md b/docs/models/operations/sortby.md index f1362ca9..d398d4f8 100644 --- a/docs/models/operations/sortby.md +++ b/docs/models/operations/sortby.md @@ -1,15 +1,17 @@ # SortBy +The field to sort the links by. The default is `createdAt`. + ## Example Usage ```typescript import { SortBy } from "dub/models/operations"; -let value: SortBy = "timestamp"; +let value: SortBy = "clicks"; ``` ## Values ```typescript -"timestamp" +"createdAt" | "clicks" | "saleAmount" | "lastClicked" ``` \ No newline at end of file diff --git a/docs/models/operations/sortorder.md b/docs/models/operations/sortorder.md new file mode 100644 index 00000000..b0646da3 --- /dev/null +++ b/docs/models/operations/sortorder.md @@ -0,0 +1,17 @@ +# SortOrder + +The sort order. The default is `desc`. + +## Example Usage + +```typescript +import { SortOrder } from "dub/models/operations"; + +let value: SortOrder = "asc"; +``` + +## Values + +```typescript +"asc" | "desc" +``` \ No newline at end of file diff --git a/docs/models/operations/trackleadresponsebody.md b/docs/models/operations/trackleadresponsebody.md index 10482395..579e8d17 100644 --- a/docs/models/operations/trackleadresponsebody.md +++ b/docs/models/operations/trackleadresponsebody.md @@ -13,8 +13,8 @@ let value: TrackLeadResponseBody = { }, customer: { name: "", - email: "Johathan.Dooley@yahoo.com", - avatar: "https://picsum.photos/seed/tQsVC54/3728/1684", + email: "Libby_Okuneva14@hotmail.com", + avatar: "https://loremflickr.com/3673/1419?lock=8215189336389107", externalId: "", }, }; diff --git a/docs/models/operations/tracksalecustomer.md b/docs/models/operations/tracksalecustomer.md index 82734f2a..8235b79d 100644 --- a/docs/models/operations/tracksalecustomer.md +++ b/docs/models/operations/tracksalecustomer.md @@ -8,8 +8,8 @@ import { TrackSaleCustomer } from "dub/models/operations"; let value: TrackSaleCustomer = { id: "", name: "", - email: "Carmelo_Effertz54@yahoo.com", - avatar: "https://loremflickr.com/177/1296?lock=6813259733912097", + email: "Adrienne_Hills30@hotmail.com", + avatar: "https://loremflickr.com/1515/965?lock=3593190275277714", externalId: "", }; ``` diff --git a/docs/models/operations/tracksalerequestbody.md b/docs/models/operations/tracksalerequestbody.md index a20e504b..00e318dd 100644 --- a/docs/models/operations/tracksalerequestbody.md +++ b/docs/models/operations/tracksalerequestbody.md @@ -6,7 +6,7 @@ import { TrackSaleRequestBody } from "dub/models/operations"; let value: TrackSaleRequestBody = { - amount: 399359, + amount: 637770, paymentProcessor: "shopify", }; ``` diff --git a/docs/models/operations/tracksaleresponsebody.md b/docs/models/operations/tracksaleresponsebody.md index 9cf4d1a7..1e07a658 100644 --- a/docs/models/operations/tracksaleresponsebody.md +++ b/docs/models/operations/tracksaleresponsebody.md @@ -12,13 +12,13 @@ let value: TrackSaleResponseBody = { customer: { id: "", name: "", - email: "Lizzie.MacGyver28@gmail.com", - avatar: "https://picsum.photos/seed/UUZMg/3046/3226", + email: "Genevieve14@gmail.com", + avatar: "https://picsum.photos/seed/NpFcblwI/2439/117", externalId: "", }, sale: { - amount: 2645.59, - currency: "Zloty", + amount: 6668.05, + currency: "Baht", paymentProcessor: "", invoiceId: "", metadata: { diff --git a/docs/models/operations/trigger.md b/docs/models/operations/trigger.md index aa26256c..89d33c51 100644 --- a/docs/models/operations/trigger.md +++ b/docs/models/operations/trigger.md @@ -7,7 +7,7 @@ The trigger to retrieve analytics for. If undefined, return both QR and link cli ```typescript import { Trigger } from "dub/models/operations"; -let value: Trigger = "link"; +let value: Trigger = "qr"; ``` ## Values diff --git a/docs/models/operations/updatecustomerdiscount.md b/docs/models/operations/updatecustomerdiscount.md index 3087ae18..058b781a 100644 --- a/docs/models/operations/updatecustomerdiscount.md +++ b/docs/models/operations/updatecustomerdiscount.md @@ -9,9 +9,9 @@ let value: UpdateCustomerDiscount = { id: "", couponId: "", couponTestId: "", - amount: 2845.14, + amount: 6397.27, type: "percentage", - duration: 1995.96, + duration: 3030.69, interval: "month", }; ``` diff --git a/docs/models/operations/updatecustomerinterval.md b/docs/models/operations/updatecustomerinterval.md index b0ecd6a4..14509238 100644 --- a/docs/models/operations/updatecustomerinterval.md +++ b/docs/models/operations/updatecustomerinterval.md @@ -5,7 +5,7 @@ ```typescript import { UpdateCustomerInterval } from "dub/models/operations"; -let value: UpdateCustomerInterval = "year"; +let value: UpdateCustomerInterval = "month"; ``` ## Values diff --git a/docs/models/operations/updatecustomerlink.md b/docs/models/operations/updatecustomerlink.md index 04b83d55..9b19e4f1 100644 --- a/docs/models/operations/updatecustomerlink.md +++ b/docs/models/operations/updatecustomerlink.md @@ -7,9 +7,9 @@ import { UpdateCustomerLink } from "dub/models/operations"; let value: UpdateCustomerLink = { id: "", - domain: "funny-aftermath.name", + domain: "smooth-impostor.net", key: "", - shortLink: "https://yellowish-brace.org/", + shortLink: "https://lawful-cook.name", programId: "", }; ``` diff --git a/docs/models/operations/updatecustomerpartner.md b/docs/models/operations/updatecustomerpartner.md index 45f1669f..121cdbdf 100644 --- a/docs/models/operations/updatecustomerpartner.md +++ b/docs/models/operations/updatecustomerpartner.md @@ -8,7 +8,7 @@ import { UpdateCustomerPartner } from "dub/models/operations"; let value: UpdateCustomerPartner = { id: "", name: "", - email: "Bill_Brown@yahoo.com", + email: "Jettie43@yahoo.com", }; ``` diff --git a/docs/models/operations/updatecustomerresponsebody.md b/docs/models/operations/updatecustomerresponsebody.md index 9ce5d282..fc5a9388 100644 --- a/docs/models/operations/updatecustomerresponsebody.md +++ b/docs/models/operations/updatecustomerresponsebody.md @@ -11,7 +11,7 @@ let value: UpdateCustomerResponseBody = { id: "", externalId: "", name: "", - createdAt: "1708731762390", + createdAt: "1720309048804", }; ``` diff --git a/docs/models/operations/updatecustomertype.md b/docs/models/operations/updatecustomertype.md index eb4b8b42..398102f2 100644 --- a/docs/models/operations/updatecustomertype.md +++ b/docs/models/operations/updatecustomertype.md @@ -5,7 +5,7 @@ ```typescript import { UpdateCustomerType } from "dub/models/operations"; -let value: UpdateCustomerType = "flat"; +let value: UpdateCustomerType = "percentage"; ``` ## Values diff --git a/docs/models/operations/updatetagcolor.md b/docs/models/operations/updatetagcolor.md index a1bc3859..24f62eec 100644 --- a/docs/models/operations/updatetagcolor.md +++ b/docs/models/operations/updatetagcolor.md @@ -7,7 +7,7 @@ The color of the tag. If not provided, a random color will be used from the list ```typescript import { UpdateTagColor } from "dub/models/operations"; -let value: UpdateTagColor = "pink"; +let value: UpdateTagColor = "blue"; ``` ## Values diff --git a/docs/sdks/customers/README.md b/docs/sdks/customers/README.md index c68c7ce8..40118e3c 100644 --- a/docs/sdks/customers/README.md +++ b/docs/sdks/customers/README.md @@ -75,7 +75,7 @@ run(); ### Response -**Promise\<[operations.ResponseBody[]](../../models/.md)\>** +**Promise\<[operations.GetCustomersResponseBody[]](../../models/.md)\>** ### Errors diff --git a/docs/sdks/links/README.md b/docs/sdks/links/README.md index e13a4e0c..5b8eed9d 100644 --- a/docs/sdks/links/README.md +++ b/docs/sdks/links/README.md @@ -571,7 +571,7 @@ run(); ### Response -**Promise\<[components.LinkSchema[]](../../models/.md)\>** +**Promise\<[operations.ResponseBody[]](../../models/.md)\>** ### Errors diff --git a/jsr.json b/jsr.json index 7d2e5304..5575a0aa 100644 --- a/jsr.json +++ b/jsr.json @@ -2,7 +2,7 @@ { "name": "dub", - "version": "0.46.11", + "version": "0.46.12", "exports": { ".": "./src/index.ts", "./models/errors": "./src/models/errors/index.ts", diff --git a/package-lock.json b/package-lock.json index 24e4dd56..c21c5566 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "dub", - "version": "0.46.11", + "version": "0.46.12", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "dub", - "version": "0.46.11", + "version": "0.46.12", "devDependencies": { "@types/node": "^20.12.7", "@typescript-eslint/eslint-plugin": "^7.7.1", diff --git a/package.json b/package.json index 4d1663af..1d943223 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "dub", - "version": "0.46.11", + "version": "0.46.12", "author": "Dub", "tshy": { "exports": { diff --git a/src/funcs/customersList.ts b/src/funcs/customersList.ts index c7295c2e..0fd083d2 100644 --- a/src/funcs/customersList.ts +++ b/src/funcs/customersList.ts @@ -35,7 +35,7 @@ export async function customersList( options?: RequestOptions, ): Promise< Result< - Array, + Array, | errors.BadRequest | errors.Unauthorized | errors.Forbidden @@ -138,7 +138,7 @@ export async function customersList( }; const [result] = await M.match< - Array, + Array, | errors.BadRequest | errors.Unauthorized | errors.Forbidden @@ -156,7 +156,7 @@ export async function customersList( | RequestTimeoutError | ConnectionError >( - M.json(200, z.array(operations.ResponseBody$inboundSchema)), + M.json(200, z.array(operations.GetCustomersResponseBody$inboundSchema)), M.jsonErr(400, errors.BadRequest$inboundSchema), M.jsonErr(401, errors.Unauthorized$inboundSchema), M.jsonErr(403, errors.Forbidden$inboundSchema), diff --git a/src/funcs/eventsList.ts b/src/funcs/eventsList.ts index 097b62d7..1b4f134c 100644 --- a/src/funcs/eventsList.ts +++ b/src/funcs/eventsList.ts @@ -90,6 +90,7 @@ export async function eventsList( "region": payload?.region, "root": payload?.root, "sortBy": payload?.sortBy, + "sortOrder": payload?.sortOrder, "start": payload?.start, "tagId": payload?.tagId, "tagIds": payload?.tagIds, diff --git a/src/funcs/linksCreateMany.ts b/src/funcs/linksCreateMany.ts index 6fdd25f5..f51e1131 100644 --- a/src/funcs/linksCreateMany.ts +++ b/src/funcs/linksCreateMany.ts @@ -10,7 +10,6 @@ import { safeParse } from "../lib/schemas.js"; import { RequestOptions } from "../lib/sdks.js"; import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; import { pathToFunc } from "../lib/url.js"; -import * as components from "../models/components/index.js"; import { ConnectionError, InvalidRequestError, @@ -36,7 +35,7 @@ export async function linksCreateMany( options?: RequestOptions, ): Promise< Result< - Array, + Array, | errors.BadRequest | errors.Unauthorized | errors.Forbidden @@ -135,7 +134,7 @@ export async function linksCreateMany( }; const [result] = await M.match< - Array, + Array, | errors.BadRequest | errors.Unauthorized | errors.Forbidden @@ -153,7 +152,7 @@ export async function linksCreateMany( | RequestTimeoutError | ConnectionError >( - M.json(200, z.array(components.LinkSchema$inboundSchema)), + M.json(200, z.array(operations.ResponseBody$inboundSchema)), M.jsonErr(400, errors.BadRequest$inboundSchema), M.jsonErr(401, errors.Unauthorized$inboundSchema), M.jsonErr(403, errors.Forbidden$inboundSchema), diff --git a/src/funcs/linksList.ts b/src/funcs/linksList.ts index 42ddff5f..35737564 100644 --- a/src/funcs/linksList.ts +++ b/src/funcs/linksList.ts @@ -83,6 +83,8 @@ export async function linksList( "search": payload?.search, "showArchived": payload?.showArchived, "sort": payload?.sort, + "sortBy": payload?.sortBy, + "sortOrder": payload?.sortOrder, "tagId": payload?.tagId, "tagIds": payload?.tagIds, "tagNames": payload?.tagNames, diff --git a/src/lib/config.ts b/src/lib/config.ts index ff796580..6749d718 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -57,7 +57,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null { export const SDK_METADATA = { language: "typescript", openapiDocVersion: "0.0.1", - sdkVersion: "0.46.11", - genVersion: "2.486.6", - userAgent: "speakeasy-sdk/typescript 0.46.11 2.486.6 0.0.1 dub", + sdkVersion: "0.46.12", + genVersion: "2.492.3", + userAgent: "speakeasy-sdk/typescript 0.46.12 2.492.3 0.0.1 dub", } as const; diff --git a/src/models/components/clickevent.ts b/src/models/components/clickevent.ts index e23cb63e..326a3d8c 100644 --- a/src/models/components/clickevent.ts +++ b/src/models/components/clickevent.ts @@ -411,15 +411,15 @@ export type Link = { clicks?: number | undefined; lastClicked: string; /** - * [BETA]: The number of leads the short links has generated. + * The number of leads the short links has generated. */ leads?: number | undefined; /** - * [BETA]: The number of sales the short links has generated. + * The number of sales the short links has generated. */ sales?: number | undefined; /** - * [BETA]: The total dollar amount of sales the short links has generated (in cents). + * The total dollar amount of sales the short links has generated (in cents). */ saleAmount?: number | undefined; createdAt: string; diff --git a/src/models/components/index.ts b/src/models/components/index.ts index 22bbe920..99593dd1 100644 --- a/src/models/components/index.ts +++ b/src/models/components/index.ts @@ -22,6 +22,7 @@ export * from "./domainschema.js"; export * from "./leadcreatedevent.js"; export * from "./leadevent.js"; export * from "./linkclickedevent.js"; +export * from "./linkerrorschema.js"; export * from "./linkgeotargeting.js"; export * from "./linkschema.js"; export * from "./linkwebhookevent.js"; diff --git a/src/models/components/leadcreatedevent.ts b/src/models/components/leadcreatedevent.ts index 8d73d2fe..946d12dd 100644 --- a/src/models/components/leadcreatedevent.ts +++ b/src/models/components/leadcreatedevent.ts @@ -499,15 +499,15 @@ export type LeadCreatedEventLink = { clicks?: number | undefined; lastClicked: string; /** - * [BETA]: The number of leads the short links has generated. + * The number of leads the short links has generated. */ leads?: number | undefined; /** - * [BETA]: The number of sales the short links has generated. + * The number of sales the short links has generated. */ sales?: number | undefined; /** - * [BETA]: The total dollar amount of sales the short links has generated (in cents). + * The total dollar amount of sales the short links has generated (in cents). */ saleAmount?: number | undefined; createdAt: string; diff --git a/src/models/components/leadevent.ts b/src/models/components/leadevent.ts index ab879389..25ad3150 100644 --- a/src/models/components/leadevent.ts +++ b/src/models/components/leadevent.ts @@ -411,15 +411,15 @@ export type LeadEventLink = { clicks?: number | undefined; lastClicked: string; /** - * [BETA]: The number of leads the short links has generated. + * The number of leads the short links has generated. */ leads?: number | undefined; /** - * [BETA]: The number of sales the short links has generated. + * The number of sales the short links has generated. */ sales?: number | undefined; /** - * [BETA]: The total dollar amount of sales the short links has generated (in cents). + * The total dollar amount of sales the short links has generated (in cents). */ saleAmount?: number | undefined; createdAt: string; diff --git a/src/models/components/linkclickedevent.ts b/src/models/components/linkclickedevent.ts index 331d11e0..103a1f97 100644 --- a/src/models/components/linkclickedevent.ts +++ b/src/models/components/linkclickedevent.ts @@ -411,15 +411,15 @@ export type LinkClickedEventLink = { clicks?: number | undefined; lastClicked: string; /** - * [BETA]: The number of leads the short links has generated. + * The number of leads the short links has generated. */ leads?: number | undefined; /** - * [BETA]: The number of sales the short links has generated. + * The number of sales the short links has generated. */ sales?: number | undefined; /** - * [BETA]: The total dollar amount of sales the short links has generated (in cents). + * The total dollar amount of sales the short links has generated (in cents). */ saleAmount?: number | undefined; createdAt: string; diff --git a/src/models/components/linkerrorschema.ts b/src/models/components/linkerrorschema.ts new file mode 100644 index 00000000..9cd4cf4a --- /dev/null +++ b/src/models/components/linkerrorschema.ts @@ -0,0 +1,123 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { safeParse } from "../../lib/schemas.js"; +import { ClosedEnum } from "../../types/enums.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "../errors/sdkvalidationerror.js"; + +/** + * The error code. + */ +export const Code = { + BadRequest: "bad_request", + NotFound: "not_found", + InternalServerError: "internal_server_error", + Unauthorized: "unauthorized", + Forbidden: "forbidden", + RateLimitExceeded: "rate_limit_exceeded", + InviteExpired: "invite_expired", + InvitePending: "invite_pending", + ExceededLimit: "exceeded_limit", + Conflict: "conflict", + UnprocessableEntity: "unprocessable_entity", +} as const; +/** + * The error code. + */ +export type Code = ClosedEnum; + +export type LinkErrorSchema = { + /** + * The link that caused the error. + */ + link?: any | undefined; + /** + * The error message. + */ + error: string; + /** + * The error code. + */ + code: Code; +}; + +/** @internal */ +export const Code$inboundSchema: z.ZodNativeEnum = z.nativeEnum( + Code, +); + +/** @internal */ +export const Code$outboundSchema: z.ZodNativeEnum = + Code$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace Code$ { + /** @deprecated use `Code$inboundSchema` instead. */ + export const inboundSchema = Code$inboundSchema; + /** @deprecated use `Code$outboundSchema` instead. */ + export const outboundSchema = Code$outboundSchema; +} + +/** @internal */ +export const LinkErrorSchema$inboundSchema: z.ZodType< + LinkErrorSchema, + z.ZodTypeDef, + unknown +> = z.object({ + link: z.any().optional(), + error: z.string(), + code: Code$inboundSchema, +}); + +/** @internal */ +export type LinkErrorSchema$Outbound = { + link?: any | undefined; + error: string; + code: string; +}; + +/** @internal */ +export const LinkErrorSchema$outboundSchema: z.ZodType< + LinkErrorSchema$Outbound, + z.ZodTypeDef, + LinkErrorSchema +> = z.object({ + link: z.any().optional(), + error: z.string(), + code: Code$outboundSchema, +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace LinkErrorSchema$ { + /** @deprecated use `LinkErrorSchema$inboundSchema` instead. */ + export const inboundSchema = LinkErrorSchema$inboundSchema; + /** @deprecated use `LinkErrorSchema$outboundSchema` instead. */ + export const outboundSchema = LinkErrorSchema$outboundSchema; + /** @deprecated use `LinkErrorSchema$Outbound` instead. */ + export type Outbound = LinkErrorSchema$Outbound; +} + +export function linkErrorSchemaToJSON( + linkErrorSchema: LinkErrorSchema, +): string { + return JSON.stringify(LinkErrorSchema$outboundSchema.parse(linkErrorSchema)); +} + +export function linkErrorSchemaFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => LinkErrorSchema$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'LinkErrorSchema' from JSON`, + ); +} diff --git a/src/models/components/linkschema.ts b/src/models/components/linkschema.ts index 24ca85ca..6542ca5b 100644 --- a/src/models/components/linkschema.ts +++ b/src/models/components/linkschema.ts @@ -288,7 +288,7 @@ export type LinkSchema = { */ url: string; /** - * [BETA] Whether to track conversions for the short link. + * Whether to track conversions for the short link. */ trackConversion?: boolean | undefined; /** @@ -422,15 +422,15 @@ export type LinkSchema = { */ lastClicked: string | null; /** - * [BETA]: The number of leads the short links has generated. + * The number of leads the short links has generated. */ leads?: number | undefined; /** - * [BETA]: The number of sales the short links has generated. + * The number of sales the short links has generated. */ sales?: number | undefined; /** - * [BETA]: The total dollar amount of sales the short links has generated (in cents). + * The total dollar amount of sales the short links has generated (in cents). */ saleAmount?: number | undefined; /** diff --git a/src/models/components/linkwebhookevent.ts b/src/models/components/linkwebhookevent.ts index 01c960d9..4308c1a1 100644 --- a/src/models/components/linkwebhookevent.ts +++ b/src/models/components/linkwebhookevent.ts @@ -407,15 +407,15 @@ export type Data = { clicks?: number | undefined; lastClicked: string; /** - * [BETA]: The number of leads the short links has generated. + * The number of leads the short links has generated. */ leads?: number | undefined; /** - * [BETA]: The number of sales the short links has generated. + * The number of sales the short links has generated. */ sales?: number | undefined; /** - * [BETA]: The total dollar amount of sales the short links has generated (in cents). + * The total dollar amount of sales the short links has generated (in cents). */ saleAmount?: number | undefined; createdAt: string; diff --git a/src/models/components/salecreatedevent.ts b/src/models/components/salecreatedevent.ts index 7588b1cf..bbb4fb8e 100644 --- a/src/models/components/salecreatedevent.ts +++ b/src/models/components/salecreatedevent.ts @@ -499,15 +499,15 @@ export type SaleCreatedEventLink = { clicks?: number | undefined; lastClicked: string; /** - * [BETA]: The number of leads the short links has generated. + * The number of leads the short links has generated. */ leads?: number | undefined; /** - * [BETA]: The number of sales the short links has generated. + * The number of sales the short links has generated. */ sales?: number | undefined; /** - * [BETA]: The total dollar amount of sales the short links has generated (in cents). + * The total dollar amount of sales the short links has generated (in cents). */ saleAmount?: number | undefined; createdAt: string; diff --git a/src/models/components/saleevent.ts b/src/models/components/saleevent.ts index 4bd83522..b1e77f30 100644 --- a/src/models/components/saleevent.ts +++ b/src/models/components/saleevent.ts @@ -395,15 +395,15 @@ export type SaleEventLink = { clicks?: number | undefined; lastClicked: string; /** - * [BETA]: The number of leads the short links has generated. + * The number of leads the short links has generated. */ leads?: number | undefined; /** - * [BETA]: The number of sales the short links has generated. + * The number of sales the short links has generated. */ sales?: number | undefined; /** - * [BETA]: The total dollar amount of sales the short links has generated (in cents). + * The total dollar amount of sales the short links has generated (in cents). */ saleAmount?: number | undefined; createdAt: string; diff --git a/src/models/components/workspaceschema.ts b/src/models/components/workspaceschema.ts index f275137a..8ed60f98 100644 --- a/src/models/components/workspaceschema.ts +++ b/src/models/components/workspaceschema.ts @@ -97,7 +97,7 @@ export type WorkspaceSchema = { */ paymentFailedAt: string | null; /** - * [BETA – Dub Conversions]: The Stripe Connect ID of the workspace. + * The Stripe Connect ID of the workspace. */ stripeConnectId: string | null; /** diff --git a/src/models/operations/bulkcreatelinks.ts b/src/models/operations/bulkcreatelinks.ts index 8ff00eb9..02e937bb 100644 --- a/src/models/operations/bulkcreatelinks.ts +++ b/src/models/operations/bulkcreatelinks.ts @@ -162,6 +162,8 @@ export type RequestBody = { webhookIds?: Array | null | undefined; }; +export type ResponseBody = components.LinkErrorSchema | components.LinkSchema; + /** @internal */ export const BulkCreateLinksTagIds$inboundSchema: z.ZodType< BulkCreateLinksTagIds, @@ -422,3 +424,55 @@ export function requestBodyFromJSON( `Failed to parse 'RequestBody' from JSON`, ); } + +/** @internal */ +export const ResponseBody$inboundSchema: z.ZodType< + ResponseBody, + z.ZodTypeDef, + unknown +> = z.union([ + components.LinkErrorSchema$inboundSchema, + components.LinkSchema$inboundSchema, +]); + +/** @internal */ +export type ResponseBody$Outbound = + | components.LinkErrorSchema$Outbound + | components.LinkSchema$Outbound; + +/** @internal */ +export const ResponseBody$outboundSchema: z.ZodType< + ResponseBody$Outbound, + z.ZodTypeDef, + ResponseBody +> = z.union([ + components.LinkErrorSchema$outboundSchema, + components.LinkSchema$outboundSchema, +]); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace ResponseBody$ { + /** @deprecated use `ResponseBody$inboundSchema` instead. */ + export const inboundSchema = ResponseBody$inboundSchema; + /** @deprecated use `ResponseBody$outboundSchema` instead. */ + export const outboundSchema = ResponseBody$outboundSchema; + /** @deprecated use `ResponseBody$Outbound` instead. */ + export type Outbound = ResponseBody$Outbound; +} + +export function responseBodyToJSON(responseBody: ResponseBody): string { + return JSON.stringify(ResponseBody$outboundSchema.parse(responseBody)); +} + +export function responseBodyFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => ResponseBody$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'ResponseBody' from JSON`, + ); +} diff --git a/src/models/operations/getcustomers.ts b/src/models/operations/getcustomers.ts index fdf77a80..f58ec6c8 100644 --- a/src/models/operations/getcustomers.ts +++ b/src/models/operations/getcustomers.ts @@ -75,7 +75,7 @@ export type Discount = { interval: GetCustomersInterval | null; }; -export type ResponseBody = { +export type GetCustomersResponseBody = { /** * The unique identifier of the customer in Dub. */ @@ -391,8 +391,8 @@ export function discountFromJSON( } /** @internal */ -export const ResponseBody$inboundSchema: z.ZodType< - ResponseBody, +export const GetCustomersResponseBody$inboundSchema: z.ZodType< + GetCustomersResponseBody, z.ZodTypeDef, unknown > = z.object({ @@ -409,7 +409,7 @@ export const ResponseBody$inboundSchema: z.ZodType< }); /** @internal */ -export type ResponseBody$Outbound = { +export type GetCustomersResponseBody$Outbound = { id: string; externalId: string; name: string; @@ -423,10 +423,10 @@ export type ResponseBody$Outbound = { }; /** @internal */ -export const ResponseBody$outboundSchema: z.ZodType< - ResponseBody$Outbound, +export const GetCustomersResponseBody$outboundSchema: z.ZodType< + GetCustomersResponseBody$Outbound, z.ZodTypeDef, - ResponseBody + GetCustomersResponseBody > = z.object({ id: z.string(), externalId: z.string(), @@ -444,25 +444,29 @@ export const ResponseBody$outboundSchema: z.ZodType< * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace ResponseBody$ { - /** @deprecated use `ResponseBody$inboundSchema` instead. */ - export const inboundSchema = ResponseBody$inboundSchema; - /** @deprecated use `ResponseBody$outboundSchema` instead. */ - export const outboundSchema = ResponseBody$outboundSchema; - /** @deprecated use `ResponseBody$Outbound` instead. */ - export type Outbound = ResponseBody$Outbound; +export namespace GetCustomersResponseBody$ { + /** @deprecated use `GetCustomersResponseBody$inboundSchema` instead. */ + export const inboundSchema = GetCustomersResponseBody$inboundSchema; + /** @deprecated use `GetCustomersResponseBody$outboundSchema` instead. */ + export const outboundSchema = GetCustomersResponseBody$outboundSchema; + /** @deprecated use `GetCustomersResponseBody$Outbound` instead. */ + export type Outbound = GetCustomersResponseBody$Outbound; } -export function responseBodyToJSON(responseBody: ResponseBody): string { - return JSON.stringify(ResponseBody$outboundSchema.parse(responseBody)); +export function getCustomersResponseBodyToJSON( + getCustomersResponseBody: GetCustomersResponseBody, +): string { + return JSON.stringify( + GetCustomersResponseBody$outboundSchema.parse(getCustomersResponseBody), + ); } -export function responseBodyFromJSON( +export function getCustomersResponseBodyFromJSON( jsonString: string, -): SafeParseResult { +): SafeParseResult { return safeParse( jsonString, - (x) => ResponseBody$inboundSchema.parse(JSON.parse(x)), - `Failed to parse 'ResponseBody' from JSON`, + (x) => GetCustomersResponseBody$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'GetCustomersResponseBody' from JSON`, ); } diff --git a/src/models/operations/getlinks.ts b/src/models/operations/getlinks.ts index 44051a96..3949f6cf 100644 --- a/src/models/operations/getlinks.ts +++ b/src/models/operations/getlinks.ts @@ -21,15 +21,46 @@ export type QueryParamTagIds = string | Array; export type QueryParamTagNames = string | Array; /** - * The field to sort the links by. The default is `createdAt`, and sort order is always descending. + * The field to sort the links by. The default is `createdAt`. + */ +export const SortBy = { + CreatedAt: "createdAt", + Clicks: "clicks", + SaleAmount: "saleAmount", + LastClicked: "lastClicked", +} as const; +/** + * The field to sort the links by. The default is `createdAt`. + */ +export type SortBy = ClosedEnum; + +/** + * The sort order. The default is `desc`. + */ +export const SortOrder = { + Asc: "asc", + Desc: "desc", +} as const; +/** + * The sort order. The default is `desc`. + */ +export type SortOrder = ClosedEnum; + +/** + * DEPRECATED. Use `sortBy` instead. + * + * @deprecated enum: This will be removed in a future release, please migrate away from it as soon as possible. */ export const Sort = { CreatedAt: "createdAt", Clicks: "clicks", + SaleAmount: "saleAmount", LastClicked: "lastClicked", } as const; /** - * The field to sort the links by. The default is `createdAt`, and sort order is always descending. + * DEPRECATED. Use `sortBy` instead. + * + * @deprecated enum: This will be removed in a future release, please migrate away from it as soon as possible. */ export type Sort = ClosedEnum; @@ -71,7 +102,15 @@ export type GetLinksRequest = { */ withTags?: boolean | undefined; /** - * The field to sort the links by. The default is `createdAt`, and sort order is always descending. + * The field to sort the links by. The default is `createdAt`. + */ + sortBy?: SortBy | undefined; + /** + * The sort order. The default is `desc`. + */ + sortOrder?: SortOrder | undefined; + /** + * DEPRECATED. Use `sortBy` instead. */ sort?: Sort | undefined; /** @@ -184,6 +223,44 @@ export function queryParamTagNamesFromJSON( ); } +/** @internal */ +export const SortBy$inboundSchema: z.ZodNativeEnum = z + .nativeEnum(SortBy); + +/** @internal */ +export const SortBy$outboundSchema: z.ZodNativeEnum = + SortBy$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace SortBy$ { + /** @deprecated use `SortBy$inboundSchema` instead. */ + export const inboundSchema = SortBy$inboundSchema; + /** @deprecated use `SortBy$outboundSchema` instead. */ + export const outboundSchema = SortBy$outboundSchema; +} + +/** @internal */ +export const SortOrder$inboundSchema: z.ZodNativeEnum = z + .nativeEnum(SortOrder); + +/** @internal */ +export const SortOrder$outboundSchema: z.ZodNativeEnum = + SortOrder$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace SortOrder$ { + /** @deprecated use `SortOrder$inboundSchema` instead. */ + export const inboundSchema = SortOrder$inboundSchema; + /** @deprecated use `SortOrder$outboundSchema` instead. */ + export const outboundSchema = SortOrder$outboundSchema; +} + /** @internal */ export const Sort$inboundSchema: z.ZodNativeEnum = z.nativeEnum( Sort, @@ -219,6 +296,8 @@ export const GetLinksRequest$inboundSchema: z.ZodType< tenantId: z.string().optional(), showArchived: z.boolean().default(false), withTags: z.boolean().default(false), + sortBy: SortBy$inboundSchema.default("createdAt"), + sortOrder: SortOrder$inboundSchema.default("desc"), sort: Sort$inboundSchema.default("createdAt"), page: z.number().default(1), pageSize: z.number().default(100), @@ -235,6 +314,8 @@ export type GetLinksRequest$Outbound = { tenantId?: string | undefined; showArchived: boolean; withTags: boolean; + sortBy: string; + sortOrder: string; sort: string; page: number; pageSize: number; @@ -255,6 +336,8 @@ export const GetLinksRequest$outboundSchema: z.ZodType< tenantId: z.string().optional(), showArchived: z.boolean().default(false), withTags: z.boolean().default(false), + sortBy: SortBy$outboundSchema.default("createdAt"), + sortOrder: SortOrder$outboundSchema.default("desc"), sort: Sort$outboundSchema.default("createdAt"), page: z.number().default(1), pageSize: z.number().default(100), diff --git a/src/models/operations/listevents.ts b/src/models/operations/listevents.ts index ff3c04f7..1ec47b11 100644 --- a/src/models/operations/listevents.ts +++ b/src/models/operations/listevents.ts @@ -56,16 +56,44 @@ export type QueryParamTrigger = ClosedEnum; */ export type ListEventsQueryParamTagIds = string | Array; -export const Order = { +/** + * The sort order. The default is `desc`. + */ +export const QueryParamSortOrder = { Asc: "asc", Desc: "desc", } as const; -export type Order = ClosedEnum; +/** + * The sort order. The default is `desc`. + */ +export type QueryParamSortOrder = ClosedEnum; -export const SortBy = { +/** + * The field to sort the events by. The default is `timestamp`. + */ +export const QueryParamSortBy = { Timestamp: "timestamp", } as const; -export type SortBy = ClosedEnum; +/** + * The field to sort the events by. The default is `timestamp`. + */ +export type QueryParamSortBy = ClosedEnum; + +/** + * DEPRECATED. Use `sortOrder` instead. + * + * @deprecated enum: This will be removed in a future release, please migrate away from it as soon as possible. + */ +export const Order = { + Asc: "asc", + Desc: "desc", +} as const; +/** + * DEPRECATED. Use `sortOrder` instead. + * + * @deprecated enum: This will be removed in a future release, please migrate away from it as soon as possible. + */ +export type Order = ClosedEnum; export type ListEventsRequest = { /** @@ -166,8 +194,18 @@ export type ListEventsRequest = { root?: boolean | undefined; page?: number | undefined; limit?: number | undefined; + /** + * The sort order. The default is `desc`. + */ + sortOrder?: QueryParamSortOrder | undefined; + /** + * The field to sort the events by. The default is `timestamp`. + */ + sortBy?: QueryParamSortBy | undefined; + /** + * DEPRECATED. Use `sortOrder` instead. + */ order?: Order | undefined; - sortBy?: SortBy | undefined; }; /** @@ -290,42 +328,65 @@ export function listEventsQueryParamTagIdsFromJSON( } /** @internal */ -export const Order$inboundSchema: z.ZodNativeEnum = z.nativeEnum( - Order, -); +export const QueryParamSortOrder$inboundSchema: z.ZodNativeEnum< + typeof QueryParamSortOrder +> = z.nativeEnum(QueryParamSortOrder); /** @internal */ -export const Order$outboundSchema: z.ZodNativeEnum = - Order$inboundSchema; +export const QueryParamSortOrder$outboundSchema: z.ZodNativeEnum< + typeof QueryParamSortOrder +> = QueryParamSortOrder$inboundSchema; /** * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace Order$ { - /** @deprecated use `Order$inboundSchema` instead. */ - export const inboundSchema = Order$inboundSchema; - /** @deprecated use `Order$outboundSchema` instead. */ - export const outboundSchema = Order$outboundSchema; +export namespace QueryParamSortOrder$ { + /** @deprecated use `QueryParamSortOrder$inboundSchema` instead. */ + export const inboundSchema = QueryParamSortOrder$inboundSchema; + /** @deprecated use `QueryParamSortOrder$outboundSchema` instead. */ + export const outboundSchema = QueryParamSortOrder$outboundSchema; } /** @internal */ -export const SortBy$inboundSchema: z.ZodNativeEnum = z - .nativeEnum(SortBy); +export const QueryParamSortBy$inboundSchema: z.ZodNativeEnum< + typeof QueryParamSortBy +> = z.nativeEnum(QueryParamSortBy); /** @internal */ -export const SortBy$outboundSchema: z.ZodNativeEnum = - SortBy$inboundSchema; +export const QueryParamSortBy$outboundSchema: z.ZodNativeEnum< + typeof QueryParamSortBy +> = QueryParamSortBy$inboundSchema; /** * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ -export namespace SortBy$ { - /** @deprecated use `SortBy$inboundSchema` instead. */ - export const inboundSchema = SortBy$inboundSchema; - /** @deprecated use `SortBy$outboundSchema` instead. */ - export const outboundSchema = SortBy$outboundSchema; +export namespace QueryParamSortBy$ { + /** @deprecated use `QueryParamSortBy$inboundSchema` instead. */ + export const inboundSchema = QueryParamSortBy$inboundSchema; + /** @deprecated use `QueryParamSortBy$outboundSchema` instead. */ + export const outboundSchema = QueryParamSortBy$outboundSchema; +} + +/** @internal */ +export const Order$inboundSchema: z.ZodNativeEnum = z.nativeEnum( + Order, +); + +/** @internal */ +export const Order$outboundSchema: z.ZodNativeEnum = + Order$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace Order$ { + /** @deprecated use `Order$inboundSchema` instead. */ + export const inboundSchema = Order$inboundSchema; + /** @deprecated use `Order$outboundSchema` instead. */ + export const outboundSchema = Order$outboundSchema; } /** @internal */ @@ -360,8 +421,9 @@ export const ListEventsRequest$inboundSchema: z.ZodType< root: z.boolean().optional(), page: z.number().default(1), limit: z.number().default(100), + sortOrder: QueryParamSortOrder$inboundSchema.default("desc"), + sortBy: QueryParamSortBy$inboundSchema.default("timestamp"), order: Order$inboundSchema.default("desc"), - sortBy: SortBy$inboundSchema.default("timestamp"), }); /** @internal */ @@ -392,8 +454,9 @@ export type ListEventsRequest$Outbound = { root?: boolean | undefined; page: number; limit: number; - order: string; + sortOrder: string; sortBy: string; + order: string; }; /** @internal */ @@ -428,8 +491,9 @@ export const ListEventsRequest$outboundSchema: z.ZodType< root: z.boolean().optional(), page: z.number().default(1), limit: z.number().default(100), + sortOrder: QueryParamSortOrder$outboundSchema.default("desc"), + sortBy: QueryParamSortBy$outboundSchema.default("timestamp"), order: Order$outboundSchema.default("desc"), - sortBy: SortBy$outboundSchema.default("timestamp"), }); /** diff --git a/src/sdk/customers.ts b/src/sdk/customers.ts index 54a2401e..1a57045d 100644 --- a/src/sdk/customers.ts +++ b/src/sdk/customers.ts @@ -21,7 +21,7 @@ export class Customers extends ClientSDK { async list( request?: operations.GetCustomersRequest | undefined, options?: RequestOptions, - ): Promise> { + ): Promise> { return unwrapAsync(customersList( this, request, diff --git a/src/sdk/links.ts b/src/sdk/links.ts index 41fd87f9..8b2c90bf 100644 --- a/src/sdk/links.ts +++ b/src/sdk/links.ts @@ -132,7 +132,7 @@ export class Links extends ClientSDK { async createMany( request?: Array | undefined, options?: RequestOptions, - ): Promise> { + ): Promise> { return unwrapAsync(linksCreateMany( this, request,