dub 0.40.0 → 0.41.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -38
- package/dist/commonjs/funcs/analyticsRetrieve.d.ts +1 -1
- package/dist/commonjs/funcs/analyticsRetrieve.d.ts.map +1 -1
- package/dist/commonjs/funcs/analyticsRetrieve.js +53 -53
- package/dist/commonjs/funcs/analyticsRetrieve.js.map +1 -1
- package/dist/commonjs/funcs/domainsCreate.d.ts +1 -1
- package/dist/commonjs/funcs/domainsCreate.d.ts.map +1 -1
- package/dist/commonjs/funcs/domainsCreate.js +31 -31
- package/dist/commonjs/funcs/domainsCreate.js.map +1 -1
- package/dist/commonjs/funcs/domainsDelete.d.ts +1 -1
- package/dist/commonjs/funcs/domainsDelete.d.ts.map +1 -1
- package/dist/commonjs/funcs/domainsDelete.js +32 -32
- package/dist/commonjs/funcs/domainsDelete.js.map +1 -1
- package/dist/commonjs/funcs/domainsList.d.ts +1 -1
- package/dist/commonjs/funcs/domainsList.d.ts.map +1 -1
- package/dist/commonjs/funcs/domainsList.js +42 -42
- package/dist/commonjs/funcs/domainsList.js.map +1 -1
- package/dist/commonjs/funcs/domainsUpdate.d.ts +1 -1
- package/dist/commonjs/funcs/domainsUpdate.d.ts.map +1 -1
- package/dist/commonjs/funcs/domainsUpdate.js +32 -32
- package/dist/commonjs/funcs/domainsUpdate.js.map +1 -1
- package/dist/commonjs/funcs/eventsList.d.ts +1 -1
- package/dist/commonjs/funcs/eventsList.d.ts.map +1 -1
- package/dist/commonjs/funcs/eventsList.js +56 -56
- package/dist/commonjs/funcs/eventsList.js.map +1 -1
- package/dist/commonjs/funcs/linksCount.d.ts +1 -1
- package/dist/commonjs/funcs/linksCount.d.ts.map +1 -1
- package/dist/commonjs/funcs/linksCount.js +41 -41
- package/dist/commonjs/funcs/linksCount.js.map +1 -1
- package/dist/commonjs/funcs/linksCreate.d.ts +1 -1
- package/dist/commonjs/funcs/linksCreate.d.ts.map +1 -1
- package/dist/commonjs/funcs/linksCreate.js +31 -31
- package/dist/commonjs/funcs/linksCreate.js.map +1 -1
- package/dist/commonjs/funcs/linksCreateMany.d.ts +1 -1
- package/dist/commonjs/funcs/linksCreateMany.d.ts.map +1 -1
- package/dist/commonjs/funcs/linksCreateMany.js +31 -31
- package/dist/commonjs/funcs/linksCreateMany.js.map +1 -1
- package/dist/commonjs/funcs/linksDelete.d.ts +1 -1
- package/dist/commonjs/funcs/linksDelete.d.ts.map +1 -1
- package/dist/commonjs/funcs/linksDelete.js +32 -32
- package/dist/commonjs/funcs/linksDelete.js.map +1 -1
- package/dist/commonjs/funcs/linksDeleteMany.d.ts +1 -1
- package/dist/commonjs/funcs/linksDeleteMany.d.ts.map +1 -1
- package/dist/commonjs/funcs/linksDeleteMany.js +33 -33
- package/dist/commonjs/funcs/linksDeleteMany.js.map +1 -1
- package/dist/commonjs/funcs/linksGet.d.ts +1 -1
- package/dist/commonjs/funcs/linksGet.d.ts.map +1 -1
- package/dist/commonjs/funcs/linksGet.js +36 -36
- package/dist/commonjs/funcs/linksGet.js.map +1 -1
- package/dist/commonjs/funcs/linksList.d.ts +1 -1
- package/dist/commonjs/funcs/linksList.d.ts.map +1 -1
- package/dist/commonjs/funcs/linksList.js +48 -48
- package/dist/commonjs/funcs/linksList.js.map +1 -1
- package/dist/commonjs/funcs/linksUpdate.d.ts +1 -1
- package/dist/commonjs/funcs/linksUpdate.d.ts.map +1 -1
- package/dist/commonjs/funcs/linksUpdate.js +32 -32
- package/dist/commonjs/funcs/linksUpdate.js.map +1 -1
- package/dist/commonjs/funcs/linksUpdateMany.d.ts +1 -1
- package/dist/commonjs/funcs/linksUpdateMany.d.ts.map +1 -1
- package/dist/commonjs/funcs/linksUpdateMany.js +31 -31
- package/dist/commonjs/funcs/linksUpdateMany.js.map +1 -1
- package/dist/commonjs/funcs/linksUpsert.d.ts +1 -1
- package/dist/commonjs/funcs/linksUpsert.d.ts.map +1 -1
- package/dist/commonjs/funcs/linksUpsert.js +31 -31
- package/dist/commonjs/funcs/linksUpsert.js.map +1 -1
- package/dist/commonjs/funcs/metatagsGet.d.ts +1 -1
- package/dist/commonjs/funcs/metatagsGet.d.ts.map +1 -1
- package/dist/commonjs/funcs/metatagsGet.js +31 -31
- package/dist/commonjs/funcs/metatagsGet.js.map +1 -1
- package/dist/commonjs/funcs/qrCodesGet.d.ts +1 -1
- package/dist/commonjs/funcs/qrCodesGet.d.ts.map +1 -1
- package/dist/commonjs/funcs/qrCodesGet.js +38 -38
- package/dist/commonjs/funcs/qrCodesGet.js.map +1 -1
- package/dist/commonjs/funcs/tagsCreate.d.ts +1 -1
- package/dist/commonjs/funcs/tagsCreate.d.ts.map +1 -1
- package/dist/commonjs/funcs/tagsCreate.js +31 -31
- package/dist/commonjs/funcs/tagsCreate.js.map +1 -1
- package/dist/commonjs/funcs/tagsDelete.d.ts +1 -1
- package/dist/commonjs/funcs/tagsDelete.d.ts.map +1 -1
- package/dist/commonjs/funcs/tagsDelete.js +32 -32
- package/dist/commonjs/funcs/tagsDelete.js.map +1 -1
- package/dist/commonjs/funcs/tagsList.d.ts +1 -1
- package/dist/commonjs/funcs/tagsList.d.ts.map +1 -1
- package/dist/commonjs/funcs/tagsList.js +22 -22
- package/dist/commonjs/funcs/tagsList.js.map +1 -1
- package/dist/commonjs/funcs/tagsUpdate.d.ts +1 -1
- package/dist/commonjs/funcs/tagsUpdate.d.ts.map +1 -1
- package/dist/commonjs/funcs/tagsUpdate.js +32 -32
- package/dist/commonjs/funcs/tagsUpdate.js.map +1 -1
- package/dist/commonjs/funcs/trackCustomer.d.ts +1 -1
- package/dist/commonjs/funcs/trackCustomer.d.ts.map +1 -1
- package/dist/commonjs/funcs/trackCustomer.js +31 -31
- package/dist/commonjs/funcs/trackCustomer.js.map +1 -1
- package/dist/commonjs/funcs/trackLead.d.ts +1 -1
- package/dist/commonjs/funcs/trackLead.d.ts.map +1 -1
- package/dist/commonjs/funcs/trackLead.js +31 -31
- package/dist/commonjs/funcs/trackLead.js.map +1 -1
- package/dist/commonjs/funcs/trackSale.d.ts +1 -1
- package/dist/commonjs/funcs/trackSale.d.ts.map +1 -1
- package/dist/commonjs/funcs/trackSale.js +31 -31
- package/dist/commonjs/funcs/trackSale.js.map +1 -1
- package/dist/commonjs/funcs/workspacesGet.d.ts +1 -1
- package/dist/commonjs/funcs/workspacesGet.d.ts.map +1 -1
- package/dist/commonjs/funcs/workspacesGet.js +32 -32
- package/dist/commonjs/funcs/workspacesGet.js.map +1 -1
- package/dist/commonjs/funcs/workspacesUpdate.d.ts +1 -1
- package/dist/commonjs/funcs/workspacesUpdate.d.ts.map +1 -1
- package/dist/commonjs/funcs/workspacesUpdate.js +32 -32
- package/dist/commonjs/funcs/workspacesUpdate.js.map +1 -1
- package/dist/commonjs/lib/config.d.ts +3 -3
- package/dist/commonjs/lib/config.js +3 -3
- package/dist/commonjs/lib/sdks.d.ts +5 -8
- package/dist/commonjs/lib/sdks.d.ts.map +1 -1
- package/dist/commonjs/lib/sdks.js +34 -18
- package/dist/commonjs/lib/sdks.js.map +1 -1
- package/dist/commonjs/models/components/leadevent.d.ts +2 -21
- package/dist/commonjs/models/components/leadevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/leadevent.js +2 -12
- package/dist/commonjs/models/components/leadevent.js.map +1 -1
- package/dist/commonjs/models/components/saleevent.d.ts +2 -21
- package/dist/commonjs/models/components/saleevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/saleevent.js +2 -12
- package/dist/commonjs/models/components/saleevent.js.map +1 -1
- package/dist/commonjs/models/operations/tracklead.d.ts +1 -1
- package/dist/commonjs/sdk/analytics.d.ts +1 -1
- package/dist/commonjs/sdk/analytics.d.ts.map +1 -1
- package/dist/commonjs/sdk/analytics.js.map +1 -1
- package/dist/commonjs/sdk/domains.d.ts +10 -10
- package/dist/commonjs/sdk/domains.d.ts.map +1 -1
- package/dist/commonjs/sdk/domains.js +13 -13
- package/dist/commonjs/sdk/domains.js.map +1 -1
- package/dist/commonjs/sdk/events.d.ts +1 -1
- package/dist/commonjs/sdk/events.d.ts.map +1 -1
- package/dist/commonjs/sdk/events.js.map +1 -1
- package/dist/commonjs/sdk/links.d.ts +20 -20
- package/dist/commonjs/sdk/links.d.ts.map +1 -1
- package/dist/commonjs/sdk/links.js +24 -24
- package/dist/commonjs/sdk/links.js.map +1 -1
- package/dist/commonjs/sdk/sdk.js +9 -9
- package/dist/commonjs/sdk/tags.d.ts +10 -10
- package/dist/commonjs/sdk/tags.d.ts.map +1 -1
- package/dist/commonjs/sdk/tags.js +13 -13
- package/dist/commonjs/sdk/tags.js.map +1 -1
- package/dist/esm/funcs/analyticsRetrieve.d.ts +1 -1
- package/dist/esm/funcs/analyticsRetrieve.d.ts.map +1 -1
- package/dist/esm/funcs/analyticsRetrieve.js +54 -54
- package/dist/esm/funcs/analyticsRetrieve.js.map +1 -1
- package/dist/esm/funcs/domainsCreate.d.ts +1 -1
- package/dist/esm/funcs/domainsCreate.d.ts.map +1 -1
- package/dist/esm/funcs/domainsCreate.js +32 -32
- package/dist/esm/funcs/domainsCreate.js.map +1 -1
- package/dist/esm/funcs/domainsDelete.d.ts +1 -1
- package/dist/esm/funcs/domainsDelete.d.ts.map +1 -1
- package/dist/esm/funcs/domainsDelete.js +33 -33
- package/dist/esm/funcs/domainsDelete.js.map +1 -1
- package/dist/esm/funcs/domainsList.d.ts +1 -1
- package/dist/esm/funcs/domainsList.d.ts.map +1 -1
- package/dist/esm/funcs/domainsList.js +43 -43
- package/dist/esm/funcs/domainsList.js.map +1 -1
- package/dist/esm/funcs/domainsUpdate.d.ts +1 -1
- package/dist/esm/funcs/domainsUpdate.d.ts.map +1 -1
- package/dist/esm/funcs/domainsUpdate.js +33 -33
- package/dist/esm/funcs/domainsUpdate.js.map +1 -1
- package/dist/esm/funcs/eventsList.d.ts +1 -1
- package/dist/esm/funcs/eventsList.d.ts.map +1 -1
- package/dist/esm/funcs/eventsList.js +57 -57
- package/dist/esm/funcs/eventsList.js.map +1 -1
- package/dist/esm/funcs/linksCount.d.ts +1 -1
- package/dist/esm/funcs/linksCount.d.ts.map +1 -1
- package/dist/esm/funcs/linksCount.js +42 -42
- package/dist/esm/funcs/linksCount.js.map +1 -1
- package/dist/esm/funcs/linksCreate.d.ts +1 -1
- package/dist/esm/funcs/linksCreate.d.ts.map +1 -1
- package/dist/esm/funcs/linksCreate.js +32 -32
- package/dist/esm/funcs/linksCreate.js.map +1 -1
- package/dist/esm/funcs/linksCreateMany.d.ts +1 -1
- package/dist/esm/funcs/linksCreateMany.d.ts.map +1 -1
- package/dist/esm/funcs/linksCreateMany.js +32 -32
- package/dist/esm/funcs/linksCreateMany.js.map +1 -1
- package/dist/esm/funcs/linksDelete.d.ts +1 -1
- package/dist/esm/funcs/linksDelete.d.ts.map +1 -1
- package/dist/esm/funcs/linksDelete.js +33 -33
- package/dist/esm/funcs/linksDelete.js.map +1 -1
- package/dist/esm/funcs/linksDeleteMany.d.ts +1 -1
- package/dist/esm/funcs/linksDeleteMany.d.ts.map +1 -1
- package/dist/esm/funcs/linksDeleteMany.js +34 -34
- package/dist/esm/funcs/linksDeleteMany.js.map +1 -1
- package/dist/esm/funcs/linksGet.d.ts +1 -1
- package/dist/esm/funcs/linksGet.d.ts.map +1 -1
- package/dist/esm/funcs/linksGet.js +37 -37
- package/dist/esm/funcs/linksGet.js.map +1 -1
- package/dist/esm/funcs/linksList.d.ts +1 -1
- package/dist/esm/funcs/linksList.d.ts.map +1 -1
- package/dist/esm/funcs/linksList.js +49 -49
- package/dist/esm/funcs/linksList.js.map +1 -1
- package/dist/esm/funcs/linksUpdate.d.ts +1 -1
- package/dist/esm/funcs/linksUpdate.d.ts.map +1 -1
- package/dist/esm/funcs/linksUpdate.js +33 -33
- package/dist/esm/funcs/linksUpdate.js.map +1 -1
- package/dist/esm/funcs/linksUpdateMany.d.ts +1 -1
- package/dist/esm/funcs/linksUpdateMany.d.ts.map +1 -1
- package/dist/esm/funcs/linksUpdateMany.js +32 -32
- package/dist/esm/funcs/linksUpdateMany.js.map +1 -1
- package/dist/esm/funcs/linksUpsert.d.ts +1 -1
- package/dist/esm/funcs/linksUpsert.d.ts.map +1 -1
- package/dist/esm/funcs/linksUpsert.js +32 -32
- package/dist/esm/funcs/linksUpsert.js.map +1 -1
- package/dist/esm/funcs/metatagsGet.d.ts +1 -1
- package/dist/esm/funcs/metatagsGet.d.ts.map +1 -1
- package/dist/esm/funcs/metatagsGet.js +32 -32
- package/dist/esm/funcs/metatagsGet.js.map +1 -1
- package/dist/esm/funcs/qrCodesGet.d.ts +1 -1
- package/dist/esm/funcs/qrCodesGet.d.ts.map +1 -1
- package/dist/esm/funcs/qrCodesGet.js +39 -39
- package/dist/esm/funcs/qrCodesGet.js.map +1 -1
- package/dist/esm/funcs/tagsCreate.d.ts +1 -1
- package/dist/esm/funcs/tagsCreate.d.ts.map +1 -1
- package/dist/esm/funcs/tagsCreate.js +32 -32
- package/dist/esm/funcs/tagsCreate.js.map +1 -1
- package/dist/esm/funcs/tagsDelete.d.ts +1 -1
- package/dist/esm/funcs/tagsDelete.d.ts.map +1 -1
- package/dist/esm/funcs/tagsDelete.js +33 -33
- package/dist/esm/funcs/tagsDelete.js.map +1 -1
- package/dist/esm/funcs/tagsList.d.ts +1 -1
- package/dist/esm/funcs/tagsList.d.ts.map +1 -1
- package/dist/esm/funcs/tagsList.js +22 -22
- package/dist/esm/funcs/tagsList.js.map +1 -1
- package/dist/esm/funcs/tagsUpdate.d.ts +1 -1
- package/dist/esm/funcs/tagsUpdate.d.ts.map +1 -1
- package/dist/esm/funcs/tagsUpdate.js +33 -33
- package/dist/esm/funcs/tagsUpdate.js.map +1 -1
- package/dist/esm/funcs/trackCustomer.d.ts +1 -1
- package/dist/esm/funcs/trackCustomer.d.ts.map +1 -1
- package/dist/esm/funcs/trackCustomer.js +32 -32
- package/dist/esm/funcs/trackCustomer.js.map +1 -1
- package/dist/esm/funcs/trackLead.d.ts +1 -1
- package/dist/esm/funcs/trackLead.d.ts.map +1 -1
- package/dist/esm/funcs/trackLead.js +32 -32
- package/dist/esm/funcs/trackLead.js.map +1 -1
- package/dist/esm/funcs/trackSale.d.ts +1 -1
- package/dist/esm/funcs/trackSale.d.ts.map +1 -1
- package/dist/esm/funcs/trackSale.js +32 -32
- package/dist/esm/funcs/trackSale.js.map +1 -1
- package/dist/esm/funcs/workspacesGet.d.ts +1 -1
- package/dist/esm/funcs/workspacesGet.d.ts.map +1 -1
- package/dist/esm/funcs/workspacesGet.js +33 -33
- package/dist/esm/funcs/workspacesGet.js.map +1 -1
- package/dist/esm/funcs/workspacesUpdate.d.ts +1 -1
- package/dist/esm/funcs/workspacesUpdate.d.ts.map +1 -1
- package/dist/esm/funcs/workspacesUpdate.js +33 -33
- package/dist/esm/funcs/workspacesUpdate.js.map +1 -1
- package/dist/esm/lib/config.d.ts +3 -3
- package/dist/esm/lib/config.js +3 -3
- package/dist/esm/lib/sdks.d.ts +5 -8
- package/dist/esm/lib/sdks.d.ts.map +1 -1
- package/dist/esm/lib/sdks.js +34 -18
- package/dist/esm/lib/sdks.js.map +1 -1
- package/dist/esm/models/components/leadevent.d.ts +2 -21
- package/dist/esm/models/components/leadevent.d.ts.map +1 -1
- package/dist/esm/models/components/leadevent.js +2 -12
- package/dist/esm/models/components/leadevent.js.map +1 -1
- package/dist/esm/models/components/saleevent.d.ts +2 -21
- package/dist/esm/models/components/saleevent.d.ts.map +1 -1
- package/dist/esm/models/components/saleevent.js +2 -12
- package/dist/esm/models/components/saleevent.js.map +1 -1
- package/dist/esm/models/operations/tracklead.d.ts +1 -1
- package/dist/esm/sdk/analytics.d.ts +1 -1
- package/dist/esm/sdk/analytics.d.ts.map +1 -1
- package/dist/esm/sdk/analytics.js.map +1 -1
- package/dist/esm/sdk/domains.d.ts +10 -10
- package/dist/esm/sdk/domains.d.ts.map +1 -1
- package/dist/esm/sdk/domains.js +13 -13
- package/dist/esm/sdk/domains.js.map +1 -1
- package/dist/esm/sdk/events.d.ts +1 -1
- package/dist/esm/sdk/events.d.ts.map +1 -1
- package/dist/esm/sdk/events.js.map +1 -1
- package/dist/esm/sdk/links.d.ts +20 -20
- package/dist/esm/sdk/links.d.ts.map +1 -1
- package/dist/esm/sdk/links.js +24 -24
- package/dist/esm/sdk/links.js.map +1 -1
- package/dist/esm/sdk/sdk.js +9 -9
- package/dist/esm/sdk/tags.d.ts +10 -10
- package/dist/esm/sdk/tags.d.ts.map +1 -1
- package/dist/esm/sdk/tags.js +13 -13
- package/dist/esm/sdk/tags.js.map +1 -1
- package/docs/sdks/analytics/README.md +2 -2
- package/docs/sdks/domains/README.md +41 -41
- package/docs/sdks/events/README.md +2 -2
- package/docs/sdks/links/README.md +72 -72
- package/docs/sdks/tags/README.md +30 -30
- package/package.json +1 -1
- package/src/funcs/analyticsRetrieve.ts +72 -70
- package/src/funcs/domainsCreate.ts +47 -49
- package/src/funcs/domainsDelete.ts +47 -47
- package/src/funcs/domainsList.ts +58 -57
- package/src/funcs/domainsUpdate.ts +47 -50
- package/src/funcs/eventsList.ts +73 -72
- package/src/funcs/linksCount.ts +58 -57
- package/src/funcs/linksCreate.ts +47 -47
- package/src/funcs/linksCreateMany.ts +47 -47
- package/src/funcs/linksDelete.ts +47 -47
- package/src/funcs/linksDeleteMany.ts +48 -48
- package/src/funcs/linksGet.ts +53 -52
- package/src/funcs/linksList.ts +67 -66
- package/src/funcs/linksUpdate.ts +47 -50
- package/src/funcs/linksUpdateMany.ts +47 -47
- package/src/funcs/linksUpsert.ts +47 -47
- package/src/funcs/metatagsGet.ts +36 -36
- package/src/funcs/qrCodesGet.ts +53 -53
- package/src/funcs/tagsCreate.ts +47 -47
- package/src/funcs/tagsDelete.ts +47 -47
- package/src/funcs/tagsList.ts +34 -34
- package/src/funcs/tagsUpdate.ts +47 -50
- package/src/funcs/trackCustomer.ts +47 -47
- package/src/funcs/trackLead.ts +47 -47
- package/src/funcs/trackSale.ts +47 -47
- package/src/funcs/workspacesGet.ts +47 -47
- package/src/funcs/workspacesUpdate.ts +47 -50
- package/src/lib/config.ts +3 -3
- package/src/lib/sdks.ts +24 -24
- package/src/models/components/leadevent.ts +4 -33
- package/src/models/components/saleevent.ts +4 -33
- package/src/models/operations/tracklead.ts +1 -1
- package/src/sdk/analytics.ts +1 -1
- package/src/sdk/domains.ts +24 -24
- package/src/sdk/events.ts +1 -1
- package/src/sdk/links.ts +38 -38
- package/src/sdk/sdk.ts +9 -9
- package/src/sdk/tags.ts +22 -22
|
@@ -5,20 +5,20 @@
|
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
-
* [list](#list) - Retrieve a list of links
|
|
9
8
|
* [create](#create) - Create a new link
|
|
9
|
+
* [list](#list) - Retrieve a list of links
|
|
10
10
|
* [count](#count) - Retrieve links count
|
|
11
11
|
* [get](#get) - Retrieve a link
|
|
12
|
-
* [delete](#delete) - Delete a link
|
|
13
12
|
* [update](#update) - Update a link
|
|
13
|
+
* [delete](#delete) - Delete a link
|
|
14
14
|
* [createMany](#createmany) - Bulk create links
|
|
15
|
-
* [deleteMany](#deletemany) - Bulk delete links
|
|
16
15
|
* [updateMany](#updatemany) - Bulk update links
|
|
16
|
+
* [deleteMany](#deletemany) - Bulk delete links
|
|
17
17
|
* [upsert](#upsert) - Upsert a link
|
|
18
18
|
|
|
19
|
-
##
|
|
19
|
+
## create
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
Create a new link for the authenticated workspace.
|
|
22
22
|
|
|
23
23
|
### Example Usage
|
|
24
24
|
|
|
@@ -30,12 +30,10 @@ const dub = new Dub({
|
|
|
30
30
|
});
|
|
31
31
|
|
|
32
32
|
async function run() {
|
|
33
|
-
const result = await dub.links.
|
|
33
|
+
const result = await dub.links.create();
|
|
34
34
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
console.log(page);
|
|
38
|
-
}
|
|
35
|
+
// Handle the result
|
|
36
|
+
console.log(result)
|
|
39
37
|
}
|
|
40
38
|
|
|
41
39
|
run();
|
|
@@ -47,7 +45,7 @@ The standalone function version of this method:
|
|
|
47
45
|
|
|
48
46
|
```typescript
|
|
49
47
|
import { DubCore } from "dub/core.js";
|
|
50
|
-
import {
|
|
48
|
+
import { linksCreate } from "dub/funcs/linksCreate.js";
|
|
51
49
|
|
|
52
50
|
// Use `DubCore` for best tree-shaking performance.
|
|
53
51
|
// You can create one instance of it to use across an application.
|
|
@@ -56,7 +54,7 @@ const dub = new DubCore({
|
|
|
56
54
|
});
|
|
57
55
|
|
|
58
56
|
async function run() {
|
|
59
|
-
const res = await
|
|
57
|
+
const res = await linksCreate(dub);
|
|
60
58
|
|
|
61
59
|
if (!res.ok) {
|
|
62
60
|
throw res.error;
|
|
@@ -64,10 +62,8 @@ async function run() {
|
|
|
64
62
|
|
|
65
63
|
const { value: result } = res;
|
|
66
64
|
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
console.log(page);
|
|
70
|
-
}
|
|
65
|
+
// Handle the result
|
|
66
|
+
console.log(result)
|
|
71
67
|
}
|
|
72
68
|
|
|
73
69
|
run();
|
|
@@ -77,14 +73,14 @@ run();
|
|
|
77
73
|
|
|
78
74
|
| Parameter | Type | Required | Description |
|
|
79
75
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
80
|
-
| `request` | [operations.
|
|
76
|
+
| `request` | [operations.CreateLinkRequestBody](../../models/operations/createlinkrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
81
77
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
82
78
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
83
79
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
84
80
|
|
|
85
81
|
### Response
|
|
86
82
|
|
|
87
|
-
**Promise\<[
|
|
83
|
+
**Promise\<[components.LinkSchema](../../models/components/linkschema.md)\>**
|
|
88
84
|
|
|
89
85
|
### Errors
|
|
90
86
|
|
|
@@ -102,9 +98,9 @@ run();
|
|
|
102
98
|
| errors.SDKError | 4xx-5xx | */* |
|
|
103
99
|
|
|
104
100
|
|
|
105
|
-
##
|
|
101
|
+
## list
|
|
106
102
|
|
|
107
|
-
|
|
103
|
+
Retrieve a paginated list of links for the authenticated workspace.
|
|
108
104
|
|
|
109
105
|
### Example Usage
|
|
110
106
|
|
|
@@ -116,10 +112,12 @@ const dub = new Dub({
|
|
|
116
112
|
});
|
|
117
113
|
|
|
118
114
|
async function run() {
|
|
119
|
-
const result = await dub.links.
|
|
115
|
+
const result = await dub.links.list();
|
|
120
116
|
|
|
121
|
-
|
|
122
|
-
|
|
117
|
+
for await (const page of result) {
|
|
118
|
+
// Handle the page
|
|
119
|
+
console.log(page);
|
|
120
|
+
}
|
|
123
121
|
}
|
|
124
122
|
|
|
125
123
|
run();
|
|
@@ -131,7 +129,7 @@ The standalone function version of this method:
|
|
|
131
129
|
|
|
132
130
|
```typescript
|
|
133
131
|
import { DubCore } from "dub/core.js";
|
|
134
|
-
import {
|
|
132
|
+
import { linksList } from "dub/funcs/linksList.js";
|
|
135
133
|
|
|
136
134
|
// Use `DubCore` for best tree-shaking performance.
|
|
137
135
|
// You can create one instance of it to use across an application.
|
|
@@ -140,7 +138,7 @@ const dub = new DubCore({
|
|
|
140
138
|
});
|
|
141
139
|
|
|
142
140
|
async function run() {
|
|
143
|
-
const res = await
|
|
141
|
+
const res = await linksList(dub);
|
|
144
142
|
|
|
145
143
|
if (!res.ok) {
|
|
146
144
|
throw res.error;
|
|
@@ -148,8 +146,10 @@ async function run() {
|
|
|
148
146
|
|
|
149
147
|
const { value: result } = res;
|
|
150
148
|
|
|
151
|
-
|
|
152
|
-
|
|
149
|
+
for await (const page of result) {
|
|
150
|
+
// Handle the page
|
|
151
|
+
console.log(page);
|
|
152
|
+
}
|
|
153
153
|
}
|
|
154
154
|
|
|
155
155
|
run();
|
|
@@ -159,14 +159,14 @@ run();
|
|
|
159
159
|
|
|
160
160
|
| Parameter | Type | Required | Description |
|
|
161
161
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
162
|
-
| `request` | [operations.
|
|
162
|
+
| `request` | [operations.GetLinksRequest](../../models/operations/getlinksrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
163
163
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
164
164
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
165
165
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
166
166
|
|
|
167
167
|
### Response
|
|
168
168
|
|
|
169
|
-
**Promise\<[
|
|
169
|
+
**Promise\<[operations.GetLinksResponse](../../models/operations/getlinksresponse.md)\>**
|
|
170
170
|
|
|
171
171
|
### Errors
|
|
172
172
|
|
|
@@ -198,7 +198,7 @@ const dub = new Dub({
|
|
|
198
198
|
});
|
|
199
199
|
|
|
200
200
|
async function run() {
|
|
201
|
-
const result = await dub.links.count(
|
|
201
|
+
const result = await dub.links.count();
|
|
202
202
|
|
|
203
203
|
// Handle the result
|
|
204
204
|
console.log(result)
|
|
@@ -222,7 +222,7 @@ const dub = new DubCore({
|
|
|
222
222
|
});
|
|
223
223
|
|
|
224
224
|
async function run() {
|
|
225
|
-
const res = await linksCount(dub
|
|
225
|
+
const res = await linksCount(dub);
|
|
226
226
|
|
|
227
227
|
if (!res.ok) {
|
|
228
228
|
throw res.error;
|
|
@@ -280,7 +280,7 @@ const dub = new Dub({
|
|
|
280
280
|
});
|
|
281
281
|
|
|
282
282
|
async function run() {
|
|
283
|
-
const result = await dub.links.get(
|
|
283
|
+
const result = await dub.links.get();
|
|
284
284
|
|
|
285
285
|
// Handle the result
|
|
286
286
|
console.log(result)
|
|
@@ -304,7 +304,7 @@ const dub = new DubCore({
|
|
|
304
304
|
});
|
|
305
305
|
|
|
306
306
|
async function run() {
|
|
307
|
-
const res = await linksGet(dub
|
|
307
|
+
const res = await linksGet(dub);
|
|
308
308
|
|
|
309
309
|
if (!res.ok) {
|
|
310
310
|
throw res.error;
|
|
@@ -348,9 +348,9 @@ run();
|
|
|
348
348
|
| errors.SDKError | 4xx-5xx | */* |
|
|
349
349
|
|
|
350
350
|
|
|
351
|
-
##
|
|
351
|
+
## update
|
|
352
352
|
|
|
353
|
-
|
|
353
|
+
Update a link for the authenticated workspace. If there's no change, returns it as it is.
|
|
354
354
|
|
|
355
355
|
### Example Usage
|
|
356
356
|
|
|
@@ -362,7 +362,7 @@ const dub = new Dub({
|
|
|
362
362
|
});
|
|
363
363
|
|
|
364
364
|
async function run() {
|
|
365
|
-
const result = await dub.links.
|
|
365
|
+
const result = await dub.links.update("<value>");
|
|
366
366
|
|
|
367
367
|
// Handle the result
|
|
368
368
|
console.log(result)
|
|
@@ -377,7 +377,7 @@ The standalone function version of this method:
|
|
|
377
377
|
|
|
378
378
|
```typescript
|
|
379
379
|
import { DubCore } from "dub/core.js";
|
|
380
|
-
import {
|
|
380
|
+
import { linksUpdate } from "dub/funcs/linksUpdate.js";
|
|
381
381
|
|
|
382
382
|
// Use `DubCore` for best tree-shaking performance.
|
|
383
383
|
// You can create one instance of it to use across an application.
|
|
@@ -386,7 +386,7 @@ const dub = new DubCore({
|
|
|
386
386
|
});
|
|
387
387
|
|
|
388
388
|
async function run() {
|
|
389
|
-
const res = await
|
|
389
|
+
const res = await linksUpdate(dub, "<value>");
|
|
390
390
|
|
|
391
391
|
if (!res.ok) {
|
|
392
392
|
throw res.error;
|
|
@@ -405,14 +405,15 @@ run();
|
|
|
405
405
|
|
|
406
406
|
| Parameter | Type | Required | Description |
|
|
407
407
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
408
|
-
| `linkId` | *string* | :heavy_check_mark: | The id of the link to
|
|
408
|
+
| `linkId` | *string* | :heavy_check_mark: | The id of the link to update. You may use either `linkId` (obtained via `/links/info` endpoint) or `externalId` prefixed with `ext_`. |
|
|
409
|
+
| `requestBody` | [operations.UpdateLinkRequestBody](../../models/operations/updatelinkrequestbody.md) | :heavy_minus_sign: | N/A |
|
|
409
410
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
410
411
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
411
412
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
412
413
|
|
|
413
414
|
### Response
|
|
414
415
|
|
|
415
|
-
**Promise\<[
|
|
416
|
+
**Promise\<[components.LinkSchema](../../models/components/linkschema.md)\>**
|
|
416
417
|
|
|
417
418
|
### Errors
|
|
418
419
|
|
|
@@ -430,9 +431,9 @@ run();
|
|
|
430
431
|
| errors.SDKError | 4xx-5xx | */* |
|
|
431
432
|
|
|
432
433
|
|
|
433
|
-
##
|
|
434
|
+
## delete
|
|
434
435
|
|
|
435
|
-
|
|
436
|
+
Delete a link for the authenticated workspace.
|
|
436
437
|
|
|
437
438
|
### Example Usage
|
|
438
439
|
|
|
@@ -444,7 +445,7 @@ const dub = new Dub({
|
|
|
444
445
|
});
|
|
445
446
|
|
|
446
447
|
async function run() {
|
|
447
|
-
const result = await dub.links.
|
|
448
|
+
const result = await dub.links.delete("<value>");
|
|
448
449
|
|
|
449
450
|
// Handle the result
|
|
450
451
|
console.log(result)
|
|
@@ -459,7 +460,7 @@ The standalone function version of this method:
|
|
|
459
460
|
|
|
460
461
|
```typescript
|
|
461
462
|
import { DubCore } from "dub/core.js";
|
|
462
|
-
import {
|
|
463
|
+
import { linksDelete } from "dub/funcs/linksDelete.js";
|
|
463
464
|
|
|
464
465
|
// Use `DubCore` for best tree-shaking performance.
|
|
465
466
|
// You can create one instance of it to use across an application.
|
|
@@ -468,7 +469,7 @@ const dub = new DubCore({
|
|
|
468
469
|
});
|
|
469
470
|
|
|
470
471
|
async function run() {
|
|
471
|
-
const res = await
|
|
472
|
+
const res = await linksDelete(dub, "<value>");
|
|
472
473
|
|
|
473
474
|
if (!res.ok) {
|
|
474
475
|
throw res.error;
|
|
@@ -487,15 +488,14 @@ run();
|
|
|
487
488
|
|
|
488
489
|
| Parameter | Type | Required | Description |
|
|
489
490
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
490
|
-
| `linkId` | *string* | :heavy_check_mark: | The id of the link to
|
|
491
|
-
| `requestBody` | [operations.UpdateLinkRequestBody](../../models/operations/updatelinkrequestbody.md) | :heavy_minus_sign: | N/A |
|
|
491
|
+
| `linkId` | *string* | :heavy_check_mark: | The id of the link to delete. You may use either `linkId` (obtained via `/links/info` endpoint) or `externalId` prefixed with `ext_`. |
|
|
492
492
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
493
493
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
494
494
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
495
495
|
|
|
496
496
|
### Response
|
|
497
497
|
|
|
498
|
-
**Promise\<[
|
|
498
|
+
**Promise\<[operations.DeleteLinkResponseBody](../../models/operations/deletelinkresponsebody.md)\>**
|
|
499
499
|
|
|
500
500
|
### Errors
|
|
501
501
|
|
|
@@ -595,9 +595,9 @@ run();
|
|
|
595
595
|
| errors.SDKError | 4xx-5xx | */* |
|
|
596
596
|
|
|
597
597
|
|
|
598
|
-
##
|
|
598
|
+
## updateMany
|
|
599
599
|
|
|
600
|
-
Bulk
|
|
600
|
+
Bulk update up to 100 links with the same data for the authenticated workspace.
|
|
601
601
|
|
|
602
602
|
### Example Usage
|
|
603
603
|
|
|
@@ -609,12 +609,7 @@ const dub = new Dub({
|
|
|
609
609
|
});
|
|
610
610
|
|
|
611
611
|
async function run() {
|
|
612
|
-
const result = await dub.links.
|
|
613
|
-
linkIds: [
|
|
614
|
-
"clux0rgak00011...",
|
|
615
|
-
"clux0rgak00022...",
|
|
616
|
-
],
|
|
617
|
-
});
|
|
612
|
+
const result = await dub.links.updateMany();
|
|
618
613
|
|
|
619
614
|
// Handle the result
|
|
620
615
|
console.log(result)
|
|
@@ -629,7 +624,7 @@ The standalone function version of this method:
|
|
|
629
624
|
|
|
630
625
|
```typescript
|
|
631
626
|
import { DubCore } from "dub/core.js";
|
|
632
|
-
import {
|
|
627
|
+
import { linksUpdateMany } from "dub/funcs/linksUpdateMany.js";
|
|
633
628
|
|
|
634
629
|
// Use `DubCore` for best tree-shaking performance.
|
|
635
630
|
// You can create one instance of it to use across an application.
|
|
@@ -638,12 +633,7 @@ const dub = new DubCore({
|
|
|
638
633
|
});
|
|
639
634
|
|
|
640
635
|
async function run() {
|
|
641
|
-
const res = await
|
|
642
|
-
linkIds: [
|
|
643
|
-
"clux0rgak00011...",
|
|
644
|
-
"clux0rgak00022...",
|
|
645
|
-
],
|
|
646
|
-
});
|
|
636
|
+
const res = await linksUpdateMany(dub);
|
|
647
637
|
|
|
648
638
|
if (!res.ok) {
|
|
649
639
|
throw res.error;
|
|
@@ -662,14 +652,14 @@ run();
|
|
|
662
652
|
|
|
663
653
|
| Parameter | Type | Required | Description |
|
|
664
654
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
665
|
-
| `request` | [operations.
|
|
655
|
+
| `request` | [operations.BulkUpdateLinksRequestBody](../../models/operations/bulkupdatelinksrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
666
656
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
667
657
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
668
658
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
669
659
|
|
|
670
660
|
### Response
|
|
671
661
|
|
|
672
|
-
**Promise\<[
|
|
662
|
+
**Promise\<[components.LinkSchema[]](../../models/.md)\>**
|
|
673
663
|
|
|
674
664
|
### Errors
|
|
675
665
|
|
|
@@ -687,9 +677,9 @@ run();
|
|
|
687
677
|
| errors.SDKError | 4xx-5xx | */* |
|
|
688
678
|
|
|
689
679
|
|
|
690
|
-
##
|
|
680
|
+
## deleteMany
|
|
691
681
|
|
|
692
|
-
Bulk
|
|
682
|
+
Bulk delete up to 100 links for the authenticated workspace.
|
|
693
683
|
|
|
694
684
|
### Example Usage
|
|
695
685
|
|
|
@@ -701,7 +691,12 @@ const dub = new Dub({
|
|
|
701
691
|
});
|
|
702
692
|
|
|
703
693
|
async function run() {
|
|
704
|
-
const result = await dub.links.
|
|
694
|
+
const result = await dub.links.deleteMany({
|
|
695
|
+
linkIds: [
|
|
696
|
+
"clux0rgak00011...",
|
|
697
|
+
"clux0rgak00022...",
|
|
698
|
+
],
|
|
699
|
+
});
|
|
705
700
|
|
|
706
701
|
// Handle the result
|
|
707
702
|
console.log(result)
|
|
@@ -716,7 +711,7 @@ The standalone function version of this method:
|
|
|
716
711
|
|
|
717
712
|
```typescript
|
|
718
713
|
import { DubCore } from "dub/core.js";
|
|
719
|
-
import {
|
|
714
|
+
import { linksDeleteMany } from "dub/funcs/linksDeleteMany.js";
|
|
720
715
|
|
|
721
716
|
// Use `DubCore` for best tree-shaking performance.
|
|
722
717
|
// You can create one instance of it to use across an application.
|
|
@@ -725,7 +720,12 @@ const dub = new DubCore({
|
|
|
725
720
|
});
|
|
726
721
|
|
|
727
722
|
async function run() {
|
|
728
|
-
const res = await
|
|
723
|
+
const res = await linksDeleteMany(dub, {
|
|
724
|
+
linkIds: [
|
|
725
|
+
"clux0rgak00011...",
|
|
726
|
+
"clux0rgak00022...",
|
|
727
|
+
],
|
|
728
|
+
});
|
|
729
729
|
|
|
730
730
|
if (!res.ok) {
|
|
731
731
|
throw res.error;
|
|
@@ -744,14 +744,14 @@ run();
|
|
|
744
744
|
|
|
745
745
|
| Parameter | Type | Required | Description |
|
|
746
746
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
747
|
-
| `request` | [operations.
|
|
747
|
+
| `request` | [operations.BulkDeleteLinksRequest](../../models/operations/bulkdeletelinksrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
748
748
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
749
749
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
750
750
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
751
751
|
|
|
752
752
|
### Response
|
|
753
753
|
|
|
754
|
-
**Promise\<[
|
|
754
|
+
**Promise\<[operations.BulkDeleteLinksResponseBody](../../models/operations/bulkdeletelinksresponsebody.md)\>**
|
|
755
755
|
|
|
756
756
|
### Errors
|
|
757
757
|
|