dub 0.64.1 → 0.64.3
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 +3 -1
- package/bin/mcp-server.js +1021 -254
- package/bin/mcp-server.js.map +39 -35
- package/dist/commonjs/funcs/analyticsRetrieve.js +2 -0
- package/dist/commonjs/funcs/analyticsRetrieve.js.map +1 -1
- package/dist/commonjs/funcs/eventsList.js +2 -0
- package/dist/commonjs/funcs/eventsList.js.map +1 -1
- package/dist/commonjs/funcs/partnersList.d.ts +18 -0
- package/dist/commonjs/funcs/partnersList.d.ts.map +1 -0
- package/dist/commonjs/funcs/partnersList.js +133 -0
- package/dist/commonjs/funcs/partnersList.js.map +1 -0
- package/dist/commonjs/lib/config.d.ts +3 -3
- package/dist/commonjs/lib/config.js +3 -3
- package/dist/commonjs/mcp-server/mcp-server.js +1 -1
- package/dist/commonjs/mcp-server/server.d.ts.map +1 -1
- package/dist/commonjs/mcp-server/server.js +3 -1
- package/dist/commonjs/mcp-server/server.js.map +1 -1
- package/dist/commonjs/mcp-server/tools/partnersList.d.ts +8 -0
- package/dist/commonjs/mcp-server/tools/partnersList.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/tools/partnersList.js +54 -0
- package/dist/commonjs/mcp-server/tools/partnersList.js.map +1 -0
- package/dist/commonjs/models/components/analyticstriggers.d.ts +6 -0
- package/dist/commonjs/models/components/analyticstriggers.d.ts.map +1 -1
- package/dist/commonjs/models/components/analyticstriggers.js +2 -0
- package/dist/commonjs/models/components/analyticstriggers.js.map +1 -1
- package/dist/commonjs/models/components/clickevent.d.ts +33 -26
- package/dist/commonjs/models/components/clickevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/clickevent.js +8 -4
- package/dist/commonjs/models/components/clickevent.js.map +1 -1
- package/dist/commonjs/models/components/commissioncreatedevent.d.ts +310 -0
- package/dist/commonjs/models/components/commissioncreatedevent.d.ts.map +1 -0
- package/dist/commonjs/models/components/commissioncreatedevent.js +261 -0
- package/dist/commonjs/models/components/commissioncreatedevent.js.map +1 -0
- package/dist/commonjs/models/components/index.d.ts +1 -0
- package/dist/commonjs/models/components/index.d.ts.map +1 -1
- package/dist/commonjs/models/components/index.js +1 -0
- package/dist/commonjs/models/components/index.js.map +1 -1
- package/dist/commonjs/models/components/leadcreatedevent.d.ts +20 -13
- package/dist/commonjs/models/components/leadcreatedevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/leadcreatedevent.js +8 -4
- package/dist/commonjs/models/components/leadcreatedevent.js.map +1 -1
- package/dist/commonjs/models/components/leadevent.d.ts +35 -26
- package/dist/commonjs/models/components/leadevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/leadevent.js +10 -4
- package/dist/commonjs/models/components/leadevent.js.map +1 -1
- package/dist/commonjs/models/components/linkclickedevent.d.ts +20 -13
- package/dist/commonjs/models/components/linkclickedevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/linkclickedevent.js +8 -4
- package/dist/commonjs/models/components/linkclickedevent.js.map +1 -1
- package/dist/commonjs/models/components/linkschema.d.ts +20 -15
- package/dist/commonjs/models/components/linkschema.d.ts.map +1 -1
- package/dist/commonjs/models/components/linkschema.js +6 -4
- package/dist/commonjs/models/components/linkschema.js.map +1 -1
- package/dist/commonjs/models/components/linkwebhookevent.d.ts +18 -13
- package/dist/commonjs/models/components/linkwebhookevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/linkwebhookevent.js +6 -4
- package/dist/commonjs/models/components/linkwebhookevent.js.map +1 -1
- package/dist/commonjs/models/components/partnerenrolledevent.d.ts +134 -55
- package/dist/commonjs/models/components/partnerenrolledevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/partnerenrolledevent.js +79 -21
- package/dist/commonjs/models/components/partnerenrolledevent.js.map +1 -1
- package/dist/commonjs/models/components/salecreatedevent.d.ts +20 -13
- package/dist/commonjs/models/components/salecreatedevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/salecreatedevent.js +8 -4
- package/dist/commonjs/models/components/salecreatedevent.js.map +1 -1
- package/dist/commonjs/models/components/saleevent.d.ts +123 -109
- package/dist/commonjs/models/components/saleevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/saleevent.js +61 -54
- package/dist/commonjs/models/components/saleevent.js.map +1 -1
- package/dist/commonjs/models/components/webhookevent.d.ts +3 -2
- package/dist/commonjs/models/components/webhookevent.d.ts.map +1 -1
- package/dist/commonjs/models/components/webhookevent.js +3 -0
- package/dist/commonjs/models/components/webhookevent.js.map +1 -1
- package/dist/commonjs/models/operations/bulkcreatelinks.d.ts +14 -14
- package/dist/commonjs/models/operations/bulkcreatelinks.d.ts.map +1 -1
- package/dist/commonjs/models/operations/bulkcreatelinks.js +4 -4
- package/dist/commonjs/models/operations/bulkcreatelinks.js.map +1 -1
- package/dist/commonjs/models/operations/bulkupdatelinks.d.ts +14 -14
- package/dist/commonjs/models/operations/bulkupdatelinks.d.ts.map +1 -1
- package/dist/commonjs/models/operations/bulkupdatelinks.js +4 -4
- package/dist/commonjs/models/operations/bulkupdatelinks.js.map +1 -1
- package/dist/commonjs/models/operations/createlink.d.ts +14 -14
- package/dist/commonjs/models/operations/createlink.d.ts.map +1 -1
- package/dist/commonjs/models/operations/createlink.js +4 -4
- package/dist/commonjs/models/operations/createlink.js.map +1 -1
- package/dist/commonjs/models/operations/createpartner.d.ts +134 -55
- package/dist/commonjs/models/operations/createpartner.d.ts.map +1 -1
- package/dist/commonjs/models/operations/createpartner.js +79 -21
- package/dist/commonjs/models/operations/createpartner.js.map +1 -1
- package/dist/commonjs/models/operations/getlinks.d.ts +1 -1
- package/dist/commonjs/models/operations/getlinkscount.d.ts +1 -1
- package/dist/commonjs/models/operations/index.d.ts +1 -0
- package/dist/commonjs/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/models/operations/index.js +1 -0
- package/dist/commonjs/models/operations/index.js.map +1 -1
- package/dist/commonjs/models/operations/listcommissions.d.ts +136 -4
- package/dist/commonjs/models/operations/listcommissions.d.ts.map +1 -1
- package/dist/commonjs/models/operations/listcommissions.js +95 -5
- package/dist/commonjs/models/operations/listcommissions.js.map +1 -1
- package/dist/commonjs/models/operations/listevents.d.ts +60 -13
- package/dist/commonjs/models/operations/listevents.d.ts.map +1 -1
- package/dist/commonjs/models/operations/listevents.js +34 -6
- package/dist/commonjs/models/operations/listevents.js.map +1 -1
- package/dist/commonjs/models/operations/listpartners.d.ts +549 -0
- package/dist/commonjs/models/operations/listpartners.d.ts.map +1 -0
- package/dist/commonjs/models/operations/listpartners.js +358 -0
- package/dist/commonjs/models/operations/listpartners.js.map +1 -0
- package/dist/commonjs/models/operations/retrieveanalytics.d.ts +60 -13
- package/dist/commonjs/models/operations/retrieveanalytics.d.ts.map +1 -1
- package/dist/commonjs/models/operations/retrieveanalytics.js +35 -6
- package/dist/commonjs/models/operations/retrieveanalytics.js.map +1 -1
- package/dist/commonjs/models/operations/retrievelinks.d.ts +3 -3
- package/dist/commonjs/models/operations/tracksale.d.ts +3 -0
- package/dist/commonjs/models/operations/tracksale.d.ts.map +1 -1
- package/dist/commonjs/models/operations/tracksale.js +1 -0
- package/dist/commonjs/models/operations/tracksale.js.map +1 -1
- package/dist/commonjs/models/operations/updatecommission.d.ts +136 -4
- package/dist/commonjs/models/operations/updatecommission.d.ts.map +1 -1
- package/dist/commonjs/models/operations/updatecommission.js +95 -5
- package/dist/commonjs/models/operations/updatecommission.js.map +1 -1
- package/dist/commonjs/models/operations/updatelink.d.ts +14 -14
- package/dist/commonjs/models/operations/updatelink.d.ts.map +1 -1
- package/dist/commonjs/models/operations/updatelink.js +4 -4
- package/dist/commonjs/models/operations/updatelink.js.map +1 -1
- package/dist/commonjs/models/operations/upsertlink.d.ts +14 -14
- package/dist/commonjs/models/operations/upsertlink.d.ts.map +1 -1
- package/dist/commonjs/models/operations/upsertlink.js +4 -4
- package/dist/commonjs/models/operations/upsertlink.js.map +1 -1
- package/dist/commonjs/sdk/partners.d.ts +7 -0
- package/dist/commonjs/sdk/partners.d.ts.map +1 -1
- package/dist/commonjs/sdk/partners.js +10 -0
- package/dist/commonjs/sdk/partners.js.map +1 -1
- package/dist/esm/funcs/analyticsRetrieve.js +2 -0
- package/dist/esm/funcs/analyticsRetrieve.js.map +1 -1
- package/dist/esm/funcs/eventsList.js +2 -0
- package/dist/esm/funcs/eventsList.js.map +1 -1
- package/dist/esm/funcs/partnersList.d.ts +18 -0
- package/dist/esm/funcs/partnersList.d.ts.map +1 -0
- package/dist/esm/funcs/partnersList.js +106 -0
- package/dist/esm/funcs/partnersList.js.map +1 -0
- package/dist/esm/lib/config.d.ts +3 -3
- package/dist/esm/lib/config.js +3 -3
- package/dist/esm/mcp-server/mcp-server.js +1 -1
- package/dist/esm/mcp-server/server.d.ts.map +1 -1
- package/dist/esm/mcp-server/server.js +3 -1
- package/dist/esm/mcp-server/server.js.map +1 -1
- package/dist/esm/mcp-server/tools/partnersList.d.ts +8 -0
- package/dist/esm/mcp-server/tools/partnersList.d.ts.map +1 -0
- package/dist/esm/mcp-server/tools/partnersList.js +28 -0
- package/dist/esm/mcp-server/tools/partnersList.js.map +1 -0
- package/dist/esm/models/components/analyticstriggers.d.ts +6 -0
- package/dist/esm/models/components/analyticstriggers.d.ts.map +1 -1
- package/dist/esm/models/components/analyticstriggers.js +2 -0
- package/dist/esm/models/components/analyticstriggers.js.map +1 -1
- package/dist/esm/models/components/clickevent.d.ts +33 -26
- package/dist/esm/models/components/clickevent.d.ts.map +1 -1
- package/dist/esm/models/components/clickevent.js +8 -4
- package/dist/esm/models/components/clickevent.js.map +1 -1
- package/dist/esm/models/components/commissioncreatedevent.d.ts +310 -0
- package/dist/esm/models/components/commissioncreatedevent.d.ts.map +1 -0
- package/dist/esm/models/components/commissioncreatedevent.js +227 -0
- package/dist/esm/models/components/commissioncreatedevent.js.map +1 -0
- package/dist/esm/models/components/index.d.ts +1 -0
- package/dist/esm/models/components/index.d.ts.map +1 -1
- package/dist/esm/models/components/index.js +1 -0
- package/dist/esm/models/components/index.js.map +1 -1
- package/dist/esm/models/components/leadcreatedevent.d.ts +20 -13
- package/dist/esm/models/components/leadcreatedevent.d.ts.map +1 -1
- package/dist/esm/models/components/leadcreatedevent.js +8 -4
- package/dist/esm/models/components/leadcreatedevent.js.map +1 -1
- package/dist/esm/models/components/leadevent.d.ts +35 -26
- package/dist/esm/models/components/leadevent.d.ts.map +1 -1
- package/dist/esm/models/components/leadevent.js +10 -4
- package/dist/esm/models/components/leadevent.js.map +1 -1
- package/dist/esm/models/components/linkclickedevent.d.ts +20 -13
- package/dist/esm/models/components/linkclickedevent.d.ts.map +1 -1
- package/dist/esm/models/components/linkclickedevent.js +8 -4
- package/dist/esm/models/components/linkclickedevent.js.map +1 -1
- package/dist/esm/models/components/linkschema.d.ts +20 -15
- package/dist/esm/models/components/linkschema.d.ts.map +1 -1
- package/dist/esm/models/components/linkschema.js +6 -4
- package/dist/esm/models/components/linkschema.js.map +1 -1
- package/dist/esm/models/components/linkwebhookevent.d.ts +18 -13
- package/dist/esm/models/components/linkwebhookevent.d.ts.map +1 -1
- package/dist/esm/models/components/linkwebhookevent.js +6 -4
- package/dist/esm/models/components/linkwebhookevent.js.map +1 -1
- package/dist/esm/models/components/partnerenrolledevent.d.ts +134 -55
- package/dist/esm/models/components/partnerenrolledevent.d.ts.map +1 -1
- package/dist/esm/models/components/partnerenrolledevent.js +78 -20
- package/dist/esm/models/components/partnerenrolledevent.js.map +1 -1
- package/dist/esm/models/components/salecreatedevent.d.ts +20 -13
- package/dist/esm/models/components/salecreatedevent.d.ts.map +1 -1
- package/dist/esm/models/components/salecreatedevent.js +8 -4
- package/dist/esm/models/components/salecreatedevent.js.map +1 -1
- package/dist/esm/models/components/saleevent.d.ts +123 -109
- package/dist/esm/models/components/saleevent.d.ts.map +1 -1
- package/dist/esm/models/components/saleevent.js +58 -51
- package/dist/esm/models/components/saleevent.js.map +1 -1
- package/dist/esm/models/components/webhookevent.d.ts +3 -2
- package/dist/esm/models/components/webhookevent.d.ts.map +1 -1
- package/dist/esm/models/components/webhookevent.js +3 -0
- package/dist/esm/models/components/webhookevent.js.map +1 -1
- package/dist/esm/models/operations/bulkcreatelinks.d.ts +14 -14
- package/dist/esm/models/operations/bulkcreatelinks.d.ts.map +1 -1
- package/dist/esm/models/operations/bulkcreatelinks.js +4 -4
- package/dist/esm/models/operations/bulkcreatelinks.js.map +1 -1
- package/dist/esm/models/operations/bulkupdatelinks.d.ts +14 -14
- package/dist/esm/models/operations/bulkupdatelinks.d.ts.map +1 -1
- package/dist/esm/models/operations/bulkupdatelinks.js +4 -4
- package/dist/esm/models/operations/bulkupdatelinks.js.map +1 -1
- package/dist/esm/models/operations/createlink.d.ts +14 -14
- package/dist/esm/models/operations/createlink.d.ts.map +1 -1
- package/dist/esm/models/operations/createlink.js +4 -4
- package/dist/esm/models/operations/createlink.js.map +1 -1
- package/dist/esm/models/operations/createpartner.d.ts +134 -55
- package/dist/esm/models/operations/createpartner.d.ts.map +1 -1
- package/dist/esm/models/operations/createpartner.js +78 -20
- package/dist/esm/models/operations/createpartner.js.map +1 -1
- package/dist/esm/models/operations/getlinks.d.ts +1 -1
- package/dist/esm/models/operations/getlinkscount.d.ts +1 -1
- package/dist/esm/models/operations/index.d.ts +1 -0
- package/dist/esm/models/operations/index.d.ts.map +1 -1
- package/dist/esm/models/operations/index.js +1 -0
- package/dist/esm/models/operations/index.js.map +1 -1
- package/dist/esm/models/operations/listcommissions.d.ts +136 -4
- package/dist/esm/models/operations/listcommissions.d.ts.map +1 -1
- package/dist/esm/models/operations/listcommissions.js +90 -4
- package/dist/esm/models/operations/listcommissions.js.map +1 -1
- package/dist/esm/models/operations/listevents.d.ts +60 -13
- package/dist/esm/models/operations/listevents.d.ts.map +1 -1
- package/dist/esm/models/operations/listevents.js +33 -5
- package/dist/esm/models/operations/listevents.js.map +1 -1
- package/dist/esm/models/operations/listpartners.d.ts +549 -0
- package/dist/esm/models/operations/listpartners.d.ts.map +1 -0
- package/dist/esm/models/operations/listpartners.js +326 -0
- package/dist/esm/models/operations/listpartners.js.map +1 -0
- package/dist/esm/models/operations/retrieveanalytics.d.ts +60 -13
- package/dist/esm/models/operations/retrieveanalytics.d.ts.map +1 -1
- package/dist/esm/models/operations/retrieveanalytics.js +34 -5
- package/dist/esm/models/operations/retrieveanalytics.js.map +1 -1
- package/dist/esm/models/operations/retrievelinks.d.ts +3 -3
- package/dist/esm/models/operations/tracksale.d.ts +3 -0
- package/dist/esm/models/operations/tracksale.d.ts.map +1 -1
- package/dist/esm/models/operations/tracksale.js +1 -0
- package/dist/esm/models/operations/tracksale.js.map +1 -1
- package/dist/esm/models/operations/updatecommission.d.ts +136 -4
- package/dist/esm/models/operations/updatecommission.d.ts.map +1 -1
- package/dist/esm/models/operations/updatecommission.js +90 -4
- package/dist/esm/models/operations/updatecommission.js.map +1 -1
- package/dist/esm/models/operations/updatelink.d.ts +14 -14
- package/dist/esm/models/operations/updatelink.d.ts.map +1 -1
- package/dist/esm/models/operations/updatelink.js +4 -4
- package/dist/esm/models/operations/updatelink.js.map +1 -1
- package/dist/esm/models/operations/upsertlink.d.ts +14 -14
- package/dist/esm/models/operations/upsertlink.d.ts.map +1 -1
- package/dist/esm/models/operations/upsertlink.js +4 -4
- package/dist/esm/models/operations/upsertlink.js.map +1 -1
- package/dist/esm/sdk/partners.d.ts +7 -0
- package/dist/esm/sdk/partners.d.ts.map +1 -1
- package/dist/esm/sdk/partners.js +10 -0
- package/dist/esm/sdk/partners.js.map +1 -1
- package/docs/sdks/analytics/README.md +1 -0
- package/docs/sdks/commissions/README.md +2 -0
- package/docs/sdks/customers/README.md +5 -0
- package/docs/sdks/domains/README.md +6 -0
- package/docs/sdks/dub/README.md +1 -1
- package/docs/sdks/embedtokens/README.md +1 -0
- package/docs/sdks/events/README.md +1 -0
- package/docs/sdks/folders/README.md +4 -0
- package/docs/sdks/links/README.md +10 -0
- package/docs/sdks/partners/README.md +84 -0
- package/docs/sdks/qrcodes/README.md +1 -0
- package/docs/sdks/tags/README.md +4 -0
- package/docs/sdks/track/README.md +2 -0
- package/docs/sdks/workspaces/README.md +2 -0
- package/examples/README.md +5 -0
- package/examples/linksCreate.example.ts +2 -0
- package/examples/package-lock.json +6 -5
- package/jsr.json +1 -1
- package/package.json +6 -6
- package/src/funcs/analyticsRetrieve.ts +2 -0
- package/src/funcs/eventsList.ts +2 -0
- package/src/funcs/partnersList.ts +227 -0
- package/src/lib/config.ts +3 -3
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +3 -1
- package/src/mcp-server/tools/partnersList.ts +37 -0
- package/src/models/components/analyticstriggers.ts +2 -0
- package/src/models/components/clickevent.ts +41 -30
- package/src/models/components/commissioncreatedevent.ts +503 -0
- package/src/models/components/index.ts +1 -0
- package/src/models/components/leadcreatedevent.ts +28 -17
- package/src/models/components/leadevent.ts +45 -30
- package/src/models/components/linkclickedevent.ts +28 -17
- package/src/models/components/linkschema.ts +26 -19
- package/src/models/components/linkwebhookevent.ts +24 -17
- package/src/models/components/partnerenrolledevent.ts +178 -75
- package/src/models/components/salecreatedevent.ts +28 -17
- package/src/models/components/saleevent.ts +156 -138
- package/src/models/components/webhookevent.ts +12 -2
- package/src/models/operations/bulkcreatelinks.ts +18 -18
- package/src/models/operations/bulkupdatelinks.ts +18 -18
- package/src/models/operations/createlink.ts +18 -18
- package/src/models/operations/createpartner.ts +178 -75
- package/src/models/operations/getlinks.ts +1 -1
- package/src/models/operations/getlinkscount.ts +1 -1
- package/src/models/operations/index.ts +1 -0
- package/src/models/operations/listcommissions.ts +242 -8
- package/src/models/operations/listevents.ts +66 -17
- package/src/models/operations/listpartners.ts +748 -0
- package/src/models/operations/retrieveanalytics.ts +64 -17
- package/src/models/operations/retrievelinks.ts +3 -3
- package/src/models/operations/tracksale.ts +1 -0
- package/src/models/operations/updatecommission.ts +242 -8
- package/src/models/operations/updatelink.ts +18 -18
- package/src/models/operations/upsertlink.ts +18 -18
- package/src/sdk/partners.ts +18 -0
|
@@ -75,14 +75,16 @@ export const Interval = {
|
|
|
75
75
|
export type Interval = ClosedEnum<typeof Interval>;
|
|
76
76
|
|
|
77
77
|
/**
|
|
78
|
-
* The trigger to retrieve analytics for. If undefined,
|
|
78
|
+
* The trigger to retrieve analytics for. If undefined, returns all trigger types.
|
|
79
79
|
*/
|
|
80
80
|
export const Trigger = {
|
|
81
81
|
Qr: "qr",
|
|
82
82
|
Link: "link",
|
|
83
|
+
Pageview: "pageview",
|
|
84
|
+
Deeplink: "deeplink",
|
|
83
85
|
} as const;
|
|
84
86
|
/**
|
|
85
|
-
* The trigger to retrieve analytics for. If undefined,
|
|
87
|
+
* The trigger to retrieve analytics for. If undefined, returns all trigger types.
|
|
86
88
|
*/
|
|
87
89
|
export type Trigger = ClosedEnum<typeof Trigger>;
|
|
88
90
|
|
|
@@ -91,6 +93,18 @@ export type Trigger = ClosedEnum<typeof Trigger>;
|
|
|
91
93
|
*/
|
|
92
94
|
export type RetrieveAnalyticsQueryParamTagIds = string | Array<string>;
|
|
93
95
|
|
|
96
|
+
/**
|
|
97
|
+
* Filter sales by type: 'new' for first-time purchases, 'recurring' for repeat purchases. If undefined, returns both.
|
|
98
|
+
*/
|
|
99
|
+
export const SaleType = {
|
|
100
|
+
New: "new",
|
|
101
|
+
Recurring: "recurring",
|
|
102
|
+
} as const;
|
|
103
|
+
/**
|
|
104
|
+
* Filter sales by type: 'new' for first-time purchases, 'recurring' for repeat purchases. If undefined, returns both.
|
|
105
|
+
*/
|
|
106
|
+
export type SaleType = ClosedEnum<typeof SaleType>;
|
|
107
|
+
|
|
94
108
|
export type RetrieveAnalyticsRequest = {
|
|
95
109
|
/**
|
|
96
110
|
* The type of event to retrieve analytics for. Defaults to `clicks`.
|
|
@@ -177,7 +191,7 @@ export type RetrieveAnalyticsRequest = {
|
|
|
177
191
|
*/
|
|
178
192
|
os?: string | undefined;
|
|
179
193
|
/**
|
|
180
|
-
* The trigger to retrieve analytics for. If undefined,
|
|
194
|
+
* The trigger to retrieve analytics for. If undefined, returns all trigger types.
|
|
181
195
|
*/
|
|
182
196
|
trigger?: Trigger | undefined;
|
|
183
197
|
/**
|
|
@@ -192,10 +206,6 @@ export type RetrieveAnalyticsRequest = {
|
|
|
192
206
|
* The URL to retrieve analytics for.
|
|
193
207
|
*/
|
|
194
208
|
url?: string | undefined;
|
|
195
|
-
/**
|
|
196
|
-
* Deprecated. Use `tagIds` instead. The tag ID to retrieve analytics for.
|
|
197
|
-
*/
|
|
198
|
-
tagId?: string | undefined;
|
|
199
209
|
/**
|
|
200
210
|
* The tag IDs to retrieve analytics for.
|
|
201
211
|
*/
|
|
@@ -204,14 +214,26 @@ export type RetrieveAnalyticsRequest = {
|
|
|
204
214
|
* The folder ID to retrieve analytics for. If not provided, return analytics for unsorted links.
|
|
205
215
|
*/
|
|
206
216
|
folderId?: string | undefined;
|
|
207
|
-
/**
|
|
208
|
-
* Deprecated. Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.
|
|
209
|
-
*/
|
|
210
|
-
qr?: boolean | undefined;
|
|
211
217
|
/**
|
|
212
218
|
* Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.
|
|
213
219
|
*/
|
|
214
220
|
root?: boolean | undefined;
|
|
221
|
+
/**
|
|
222
|
+
* Filter sales by type: 'new' for first-time purchases, 'recurring' for repeat purchases. If undefined, returns both.
|
|
223
|
+
*/
|
|
224
|
+
saleType?: SaleType | undefined;
|
|
225
|
+
/**
|
|
226
|
+
* Search the events by a custom metadata value. Only available for lead and sale events.
|
|
227
|
+
*/
|
|
228
|
+
query?: string | undefined;
|
|
229
|
+
/**
|
|
230
|
+
* Deprecated: Use `tagIds` instead. The tag ID to retrieve analytics for.
|
|
231
|
+
*/
|
|
232
|
+
tagId?: string | undefined;
|
|
233
|
+
/**
|
|
234
|
+
* Deprecated: Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.
|
|
235
|
+
*/
|
|
236
|
+
qr?: boolean | undefined;
|
|
215
237
|
/**
|
|
216
238
|
* The UTM source of the short link.
|
|
217
239
|
*/
|
|
@@ -383,6 +405,25 @@ export function retrieveAnalyticsQueryParamTagIdsFromJSON(
|
|
|
383
405
|
);
|
|
384
406
|
}
|
|
385
407
|
|
|
408
|
+
/** @internal */
|
|
409
|
+
export const SaleType$inboundSchema: z.ZodNativeEnum<typeof SaleType> = z
|
|
410
|
+
.nativeEnum(SaleType);
|
|
411
|
+
|
|
412
|
+
/** @internal */
|
|
413
|
+
export const SaleType$outboundSchema: z.ZodNativeEnum<typeof SaleType> =
|
|
414
|
+
SaleType$inboundSchema;
|
|
415
|
+
|
|
416
|
+
/**
|
|
417
|
+
* @internal
|
|
418
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
419
|
+
*/
|
|
420
|
+
export namespace SaleType$ {
|
|
421
|
+
/** @deprecated use `SaleType$inboundSchema` instead. */
|
|
422
|
+
export const inboundSchema = SaleType$inboundSchema;
|
|
423
|
+
/** @deprecated use `SaleType$outboundSchema` instead. */
|
|
424
|
+
export const outboundSchema = SaleType$outboundSchema;
|
|
425
|
+
}
|
|
426
|
+
|
|
386
427
|
/** @internal */
|
|
387
428
|
export const RetrieveAnalyticsRequest$inboundSchema: z.ZodType<
|
|
388
429
|
RetrieveAnalyticsRequest,
|
|
@@ -414,11 +455,13 @@ export const RetrieveAnalyticsRequest$inboundSchema: z.ZodType<
|
|
|
414
455
|
referer: z.string().optional(),
|
|
415
456
|
refererUrl: z.string().optional(),
|
|
416
457
|
url: z.string().optional(),
|
|
417
|
-
tagId: z.string().optional(),
|
|
418
458
|
tagIds: z.union([z.string(), z.array(z.string())]).optional(),
|
|
419
459
|
folderId: z.string().optional(),
|
|
420
|
-
qr: z.boolean().optional(),
|
|
421
460
|
root: z.boolean().optional(),
|
|
461
|
+
saleType: SaleType$inboundSchema.optional(),
|
|
462
|
+
query: z.string().optional(),
|
|
463
|
+
tagId: z.string().optional(),
|
|
464
|
+
qr: z.boolean().optional(),
|
|
422
465
|
utm_source: z.nullable(z.string()).optional(),
|
|
423
466
|
utm_medium: z.nullable(z.string()).optional(),
|
|
424
467
|
utm_campaign: z.nullable(z.string()).optional(),
|
|
@@ -461,11 +504,13 @@ export type RetrieveAnalyticsRequest$Outbound = {
|
|
|
461
504
|
referer?: string | undefined;
|
|
462
505
|
refererUrl?: string | undefined;
|
|
463
506
|
url?: string | undefined;
|
|
464
|
-
tagId?: string | undefined;
|
|
465
507
|
tagIds?: string | Array<string> | undefined;
|
|
466
508
|
folderId?: string | undefined;
|
|
467
|
-
qr?: boolean | undefined;
|
|
468
509
|
root?: boolean | undefined;
|
|
510
|
+
saleType?: string | undefined;
|
|
511
|
+
query?: string | undefined;
|
|
512
|
+
tagId?: string | undefined;
|
|
513
|
+
qr?: boolean | undefined;
|
|
469
514
|
utm_source?: string | null | undefined;
|
|
470
515
|
utm_medium?: string | null | undefined;
|
|
471
516
|
utm_campaign?: string | null | undefined;
|
|
@@ -504,11 +549,13 @@ export const RetrieveAnalyticsRequest$outboundSchema: z.ZodType<
|
|
|
504
549
|
referer: z.string().optional(),
|
|
505
550
|
refererUrl: z.string().optional(),
|
|
506
551
|
url: z.string().optional(),
|
|
507
|
-
tagId: z.string().optional(),
|
|
508
552
|
tagIds: z.union([z.string(), z.array(z.string())]).optional(),
|
|
509
553
|
folderId: z.string().optional(),
|
|
510
|
-
qr: z.boolean().optional(),
|
|
511
554
|
root: z.boolean().optional(),
|
|
555
|
+
saleType: SaleType$outboundSchema.optional(),
|
|
556
|
+
query: z.string().optional(),
|
|
557
|
+
tagId: z.string().optional(),
|
|
558
|
+
qr: z.boolean().optional(),
|
|
512
559
|
utmSource: z.nullable(z.string()).optional(),
|
|
513
560
|
utmMedium: z.nullable(z.string()).optional(),
|
|
514
561
|
utmCampaign: z.nullable(z.string()).optional(),
|
|
@@ -38,15 +38,15 @@ export type Link = {
|
|
|
38
38
|
*/
|
|
39
39
|
clicks?: number | undefined;
|
|
40
40
|
/**
|
|
41
|
-
* The number of leads the short
|
|
41
|
+
* The number of leads the short link has generated.
|
|
42
42
|
*/
|
|
43
43
|
leads?: number | undefined;
|
|
44
44
|
/**
|
|
45
|
-
* The number of sales the short
|
|
45
|
+
* The total number of sales (includes recurring sales) generated by the short link.
|
|
46
46
|
*/
|
|
47
47
|
sales?: number | undefined;
|
|
48
48
|
/**
|
|
49
|
-
* The total dollar
|
|
49
|
+
* The total dollar value of sales (in cents) generated by the short link.
|
|
50
50
|
*/
|
|
51
51
|
saleAmount?: number | undefined;
|
|
52
52
|
};
|
|
@@ -69,6 +69,72 @@ export const UpdateCommissionStatus = {
|
|
|
69
69
|
} as const;
|
|
70
70
|
export type UpdateCommissionStatus = ClosedEnum<typeof UpdateCommissionStatus>;
|
|
71
71
|
|
|
72
|
+
export type UpdateCommissionPartner = {
|
|
73
|
+
/**
|
|
74
|
+
* The partner's unique ID on Dub.
|
|
75
|
+
*/
|
|
76
|
+
id: string;
|
|
77
|
+
/**
|
|
78
|
+
* The partner's full legal name.
|
|
79
|
+
*/
|
|
80
|
+
name: string;
|
|
81
|
+
/**
|
|
82
|
+
* The partner's email address. Should be a unique value across Dub.
|
|
83
|
+
*/
|
|
84
|
+
email: string | null;
|
|
85
|
+
/**
|
|
86
|
+
* The partner's avatar image.
|
|
87
|
+
*/
|
|
88
|
+
image: string | null;
|
|
89
|
+
/**
|
|
90
|
+
* The date when the partner enabled payouts.
|
|
91
|
+
*/
|
|
92
|
+
payoutsEnabledAt: string | null;
|
|
93
|
+
/**
|
|
94
|
+
* The partner's country (required for tax purposes).
|
|
95
|
+
*/
|
|
96
|
+
country: string | null;
|
|
97
|
+
};
|
|
98
|
+
|
|
99
|
+
export type UpdateCommissionCustomer = {
|
|
100
|
+
/**
|
|
101
|
+
* The unique ID of the customer. You may use either the customer's `id` on Dub (obtained via `/customers` endpoint) or their `externalId` (unique ID within your system, prefixed with `ext_`, e.g. `ext_123`).
|
|
102
|
+
*/
|
|
103
|
+
id: string;
|
|
104
|
+
/**
|
|
105
|
+
* Unique identifier for the customer in the client's app.
|
|
106
|
+
*/
|
|
107
|
+
externalId: string;
|
|
108
|
+
/**
|
|
109
|
+
* Name of the customer.
|
|
110
|
+
*/
|
|
111
|
+
name: string;
|
|
112
|
+
/**
|
|
113
|
+
* Email of the customer.
|
|
114
|
+
*/
|
|
115
|
+
email?: string | null | undefined;
|
|
116
|
+
/**
|
|
117
|
+
* Avatar URL of the customer.
|
|
118
|
+
*/
|
|
119
|
+
avatar?: string | null | undefined;
|
|
120
|
+
/**
|
|
121
|
+
* Country of the customer.
|
|
122
|
+
*/
|
|
123
|
+
country?: string | null | undefined;
|
|
124
|
+
/**
|
|
125
|
+
* Total number of sales for the customer.
|
|
126
|
+
*/
|
|
127
|
+
sales?: number | null | undefined;
|
|
128
|
+
/**
|
|
129
|
+
* Total amount of sales for the customer.
|
|
130
|
+
*/
|
|
131
|
+
saleAmount?: number | null | undefined;
|
|
132
|
+
/**
|
|
133
|
+
* The date the customer was created.
|
|
134
|
+
*/
|
|
135
|
+
createdAt: string;
|
|
136
|
+
};
|
|
137
|
+
|
|
72
138
|
/**
|
|
73
139
|
* The updated commission.
|
|
74
140
|
*/
|
|
@@ -82,10 +148,17 @@ export type UpdateCommissionResponseBody = {
|
|
|
82
148
|
earnings: number;
|
|
83
149
|
currency: string;
|
|
84
150
|
status: UpdateCommissionStatus;
|
|
85
|
-
invoiceId
|
|
86
|
-
description
|
|
151
|
+
invoiceId: string | null;
|
|
152
|
+
description: string | null;
|
|
153
|
+
quantity: number;
|
|
154
|
+
/**
|
|
155
|
+
* The user who created the manual commission.
|
|
156
|
+
*/
|
|
157
|
+
userId?: string | null | undefined;
|
|
87
158
|
createdAt: string;
|
|
88
159
|
updatedAt: string;
|
|
160
|
+
partner: UpdateCommissionPartner;
|
|
161
|
+
customer?: UpdateCommissionCustomer | null | undefined;
|
|
89
162
|
};
|
|
90
163
|
|
|
91
164
|
/** @internal */
|
|
@@ -281,6 +354,153 @@ export namespace UpdateCommissionStatus$ {
|
|
|
281
354
|
export const outboundSchema = UpdateCommissionStatus$outboundSchema;
|
|
282
355
|
}
|
|
283
356
|
|
|
357
|
+
/** @internal */
|
|
358
|
+
export const UpdateCommissionPartner$inboundSchema: z.ZodType<
|
|
359
|
+
UpdateCommissionPartner,
|
|
360
|
+
z.ZodTypeDef,
|
|
361
|
+
unknown
|
|
362
|
+
> = z.object({
|
|
363
|
+
id: z.string(),
|
|
364
|
+
name: z.string(),
|
|
365
|
+
email: z.nullable(z.string()),
|
|
366
|
+
image: z.nullable(z.string()),
|
|
367
|
+
payoutsEnabledAt: z.nullable(z.string()),
|
|
368
|
+
country: z.nullable(z.string()),
|
|
369
|
+
});
|
|
370
|
+
|
|
371
|
+
/** @internal */
|
|
372
|
+
export type UpdateCommissionPartner$Outbound = {
|
|
373
|
+
id: string;
|
|
374
|
+
name: string;
|
|
375
|
+
email: string | null;
|
|
376
|
+
image: string | null;
|
|
377
|
+
payoutsEnabledAt: string | null;
|
|
378
|
+
country: string | null;
|
|
379
|
+
};
|
|
380
|
+
|
|
381
|
+
/** @internal */
|
|
382
|
+
export const UpdateCommissionPartner$outboundSchema: z.ZodType<
|
|
383
|
+
UpdateCommissionPartner$Outbound,
|
|
384
|
+
z.ZodTypeDef,
|
|
385
|
+
UpdateCommissionPartner
|
|
386
|
+
> = z.object({
|
|
387
|
+
id: z.string(),
|
|
388
|
+
name: z.string(),
|
|
389
|
+
email: z.nullable(z.string()),
|
|
390
|
+
image: z.nullable(z.string()),
|
|
391
|
+
payoutsEnabledAt: z.nullable(z.string()),
|
|
392
|
+
country: z.nullable(z.string()),
|
|
393
|
+
});
|
|
394
|
+
|
|
395
|
+
/**
|
|
396
|
+
* @internal
|
|
397
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
398
|
+
*/
|
|
399
|
+
export namespace UpdateCommissionPartner$ {
|
|
400
|
+
/** @deprecated use `UpdateCommissionPartner$inboundSchema` instead. */
|
|
401
|
+
export const inboundSchema = UpdateCommissionPartner$inboundSchema;
|
|
402
|
+
/** @deprecated use `UpdateCommissionPartner$outboundSchema` instead. */
|
|
403
|
+
export const outboundSchema = UpdateCommissionPartner$outboundSchema;
|
|
404
|
+
/** @deprecated use `UpdateCommissionPartner$Outbound` instead. */
|
|
405
|
+
export type Outbound = UpdateCommissionPartner$Outbound;
|
|
406
|
+
}
|
|
407
|
+
|
|
408
|
+
export function updateCommissionPartnerToJSON(
|
|
409
|
+
updateCommissionPartner: UpdateCommissionPartner,
|
|
410
|
+
): string {
|
|
411
|
+
return JSON.stringify(
|
|
412
|
+
UpdateCommissionPartner$outboundSchema.parse(updateCommissionPartner),
|
|
413
|
+
);
|
|
414
|
+
}
|
|
415
|
+
|
|
416
|
+
export function updateCommissionPartnerFromJSON(
|
|
417
|
+
jsonString: string,
|
|
418
|
+
): SafeParseResult<UpdateCommissionPartner, SDKValidationError> {
|
|
419
|
+
return safeParse(
|
|
420
|
+
jsonString,
|
|
421
|
+
(x) => UpdateCommissionPartner$inboundSchema.parse(JSON.parse(x)),
|
|
422
|
+
`Failed to parse 'UpdateCommissionPartner' from JSON`,
|
|
423
|
+
);
|
|
424
|
+
}
|
|
425
|
+
|
|
426
|
+
/** @internal */
|
|
427
|
+
export const UpdateCommissionCustomer$inboundSchema: z.ZodType<
|
|
428
|
+
UpdateCommissionCustomer,
|
|
429
|
+
z.ZodTypeDef,
|
|
430
|
+
unknown
|
|
431
|
+
> = z.object({
|
|
432
|
+
id: z.string(),
|
|
433
|
+
externalId: z.string(),
|
|
434
|
+
name: z.string(),
|
|
435
|
+
email: z.nullable(z.string()).optional(),
|
|
436
|
+
avatar: z.nullable(z.string()).optional(),
|
|
437
|
+
country: z.nullable(z.string()).optional(),
|
|
438
|
+
sales: z.nullable(z.number()).optional(),
|
|
439
|
+
saleAmount: z.nullable(z.number()).optional(),
|
|
440
|
+
createdAt: z.string(),
|
|
441
|
+
});
|
|
442
|
+
|
|
443
|
+
/** @internal */
|
|
444
|
+
export type UpdateCommissionCustomer$Outbound = {
|
|
445
|
+
id: string;
|
|
446
|
+
externalId: string;
|
|
447
|
+
name: string;
|
|
448
|
+
email?: string | null | undefined;
|
|
449
|
+
avatar?: string | null | undefined;
|
|
450
|
+
country?: string | null | undefined;
|
|
451
|
+
sales?: number | null | undefined;
|
|
452
|
+
saleAmount?: number | null | undefined;
|
|
453
|
+
createdAt: string;
|
|
454
|
+
};
|
|
455
|
+
|
|
456
|
+
/** @internal */
|
|
457
|
+
export const UpdateCommissionCustomer$outboundSchema: z.ZodType<
|
|
458
|
+
UpdateCommissionCustomer$Outbound,
|
|
459
|
+
z.ZodTypeDef,
|
|
460
|
+
UpdateCommissionCustomer
|
|
461
|
+
> = z.object({
|
|
462
|
+
id: z.string(),
|
|
463
|
+
externalId: z.string(),
|
|
464
|
+
name: z.string(),
|
|
465
|
+
email: z.nullable(z.string()).optional(),
|
|
466
|
+
avatar: z.nullable(z.string()).optional(),
|
|
467
|
+
country: z.nullable(z.string()).optional(),
|
|
468
|
+
sales: z.nullable(z.number()).optional(),
|
|
469
|
+
saleAmount: z.nullable(z.number()).optional(),
|
|
470
|
+
createdAt: z.string(),
|
|
471
|
+
});
|
|
472
|
+
|
|
473
|
+
/**
|
|
474
|
+
* @internal
|
|
475
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
476
|
+
*/
|
|
477
|
+
export namespace UpdateCommissionCustomer$ {
|
|
478
|
+
/** @deprecated use `UpdateCommissionCustomer$inboundSchema` instead. */
|
|
479
|
+
export const inboundSchema = UpdateCommissionCustomer$inboundSchema;
|
|
480
|
+
/** @deprecated use `UpdateCommissionCustomer$outboundSchema` instead. */
|
|
481
|
+
export const outboundSchema = UpdateCommissionCustomer$outboundSchema;
|
|
482
|
+
/** @deprecated use `UpdateCommissionCustomer$Outbound` instead. */
|
|
483
|
+
export type Outbound = UpdateCommissionCustomer$Outbound;
|
|
484
|
+
}
|
|
485
|
+
|
|
486
|
+
export function updateCommissionCustomerToJSON(
|
|
487
|
+
updateCommissionCustomer: UpdateCommissionCustomer,
|
|
488
|
+
): string {
|
|
489
|
+
return JSON.stringify(
|
|
490
|
+
UpdateCommissionCustomer$outboundSchema.parse(updateCommissionCustomer),
|
|
491
|
+
);
|
|
492
|
+
}
|
|
493
|
+
|
|
494
|
+
export function updateCommissionCustomerFromJSON(
|
|
495
|
+
jsonString: string,
|
|
496
|
+
): SafeParseResult<UpdateCommissionCustomer, SDKValidationError> {
|
|
497
|
+
return safeParse(
|
|
498
|
+
jsonString,
|
|
499
|
+
(x) => UpdateCommissionCustomer$inboundSchema.parse(JSON.parse(x)),
|
|
500
|
+
`Failed to parse 'UpdateCommissionCustomer' from JSON`,
|
|
501
|
+
);
|
|
502
|
+
}
|
|
503
|
+
|
|
284
504
|
/** @internal */
|
|
285
505
|
export const UpdateCommissionResponseBody$inboundSchema: z.ZodType<
|
|
286
506
|
UpdateCommissionResponseBody,
|
|
@@ -293,10 +513,15 @@ export const UpdateCommissionResponseBody$inboundSchema: z.ZodType<
|
|
|
293
513
|
earnings: z.number(),
|
|
294
514
|
currency: z.string(),
|
|
295
515
|
status: UpdateCommissionStatus$inboundSchema,
|
|
296
|
-
invoiceId: z.nullable(z.string())
|
|
297
|
-
description: z.nullable(z.string())
|
|
516
|
+
invoiceId: z.nullable(z.string()),
|
|
517
|
+
description: z.nullable(z.string()),
|
|
518
|
+
quantity: z.number(),
|
|
519
|
+
userId: z.nullable(z.string()).optional(),
|
|
298
520
|
createdAt: z.string(),
|
|
299
521
|
updatedAt: z.string(),
|
|
522
|
+
partner: z.lazy(() => UpdateCommissionPartner$inboundSchema),
|
|
523
|
+
customer: z.nullable(z.lazy(() => UpdateCommissionCustomer$inboundSchema))
|
|
524
|
+
.optional(),
|
|
300
525
|
});
|
|
301
526
|
|
|
302
527
|
/** @internal */
|
|
@@ -307,10 +532,14 @@ export type UpdateCommissionResponseBody$Outbound = {
|
|
|
307
532
|
earnings: number;
|
|
308
533
|
currency: string;
|
|
309
534
|
status: string;
|
|
310
|
-
invoiceId
|
|
311
|
-
description
|
|
535
|
+
invoiceId: string | null;
|
|
536
|
+
description: string | null;
|
|
537
|
+
quantity: number;
|
|
538
|
+
userId?: string | null | undefined;
|
|
312
539
|
createdAt: string;
|
|
313
540
|
updatedAt: string;
|
|
541
|
+
partner: UpdateCommissionPartner$Outbound;
|
|
542
|
+
customer?: UpdateCommissionCustomer$Outbound | null | undefined;
|
|
314
543
|
};
|
|
315
544
|
|
|
316
545
|
/** @internal */
|
|
@@ -325,10 +554,15 @@ export const UpdateCommissionResponseBody$outboundSchema: z.ZodType<
|
|
|
325
554
|
earnings: z.number(),
|
|
326
555
|
currency: z.string(),
|
|
327
556
|
status: UpdateCommissionStatus$outboundSchema,
|
|
328
|
-
invoiceId: z.nullable(z.string())
|
|
329
|
-
description: z.nullable(z.string())
|
|
557
|
+
invoiceId: z.nullable(z.string()),
|
|
558
|
+
description: z.nullable(z.string()),
|
|
559
|
+
quantity: z.number(),
|
|
560
|
+
userId: z.nullable(z.string()).optional(),
|
|
330
561
|
createdAt: z.string(),
|
|
331
562
|
updatedAt: z.string(),
|
|
563
|
+
partner: z.lazy(() => UpdateCommissionPartner$outboundSchema),
|
|
564
|
+
customer: z.nullable(z.lazy(() => UpdateCommissionCustomer$outboundSchema))
|
|
565
|
+
.optional(),
|
|
332
566
|
});
|
|
333
567
|
|
|
334
568
|
/**
|
|
@@ -61,18 +61,6 @@ export type UpdateLinkRequestBody = {
|
|
|
61
61
|
* Whether the short link is archived. Defaults to `false` if not provided.
|
|
62
62
|
*/
|
|
63
63
|
archived?: boolean | undefined;
|
|
64
|
-
/**
|
|
65
|
-
* Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
|
|
66
|
-
*
|
|
67
|
-
* @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
68
|
-
*/
|
|
69
|
-
publicStats?: boolean | undefined;
|
|
70
|
-
/**
|
|
71
|
-
* The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead.
|
|
72
|
-
*
|
|
73
|
-
* @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
74
|
-
*/
|
|
75
|
-
tagId?: string | null | undefined;
|
|
76
64
|
/**
|
|
77
65
|
* The unique IDs of the tags assigned to the short link.
|
|
78
66
|
*/
|
|
@@ -178,6 +166,18 @@ export type UpdateLinkRequestBody = {
|
|
|
178
166
|
* The date and time when the tests were or will be completed.
|
|
179
167
|
*/
|
|
180
168
|
testCompletedAt?: string | null | undefined;
|
|
169
|
+
/**
|
|
170
|
+
* Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
|
|
171
|
+
*
|
|
172
|
+
* @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
173
|
+
*/
|
|
174
|
+
publicStats?: boolean | undefined;
|
|
175
|
+
/**
|
|
176
|
+
* Deprecated: Use `tagIds` instead. The unique ID of the tag assigned to the short link.
|
|
177
|
+
*
|
|
178
|
+
* @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
179
|
+
*/
|
|
180
|
+
tagId?: string | null | undefined;
|
|
181
181
|
};
|
|
182
182
|
|
|
183
183
|
export type UpdateLinkRequest = {
|
|
@@ -356,8 +356,6 @@ export const UpdateLinkRequestBody$inboundSchema: z.ZodType<
|
|
|
356
356
|
partnerId: z.nullable(z.string()).optional(),
|
|
357
357
|
trackConversion: z.boolean().optional(),
|
|
358
358
|
archived: z.boolean().optional(),
|
|
359
|
-
publicStats: z.boolean().optional(),
|
|
360
|
-
tagId: z.nullable(z.string()).optional(),
|
|
361
359
|
tagIds: z.union([z.string(), z.array(z.string())]).optional(),
|
|
362
360
|
tagNames: z.union([z.string(), z.array(z.string())]).optional(),
|
|
363
361
|
folderId: z.nullable(z.string()).optional(),
|
|
@@ -387,6 +385,8 @@ export const UpdateLinkRequestBody$inboundSchema: z.ZodType<
|
|
|
387
385
|
).optional(),
|
|
388
386
|
testStartedAt: z.nullable(z.string()).optional(),
|
|
389
387
|
testCompletedAt: z.nullable(z.string()).optional(),
|
|
388
|
+
publicStats: z.boolean().optional(),
|
|
389
|
+
tagId: z.nullable(z.string()).optional(),
|
|
390
390
|
}).transform((v) => {
|
|
391
391
|
return remap$(v, {
|
|
392
392
|
"utm_source": "utmSource",
|
|
@@ -408,8 +408,6 @@ export type UpdateLinkRequestBody$Outbound = {
|
|
|
408
408
|
partnerId?: string | null | undefined;
|
|
409
409
|
trackConversion?: boolean | undefined;
|
|
410
410
|
archived?: boolean | undefined;
|
|
411
|
-
publicStats?: boolean | undefined;
|
|
412
|
-
tagId?: string | null | undefined;
|
|
413
411
|
tagIds?: string | Array<string> | undefined;
|
|
414
412
|
tagNames?: string | Array<string> | undefined;
|
|
415
413
|
folderId?: string | null | undefined;
|
|
@@ -437,6 +435,8 @@ export type UpdateLinkRequestBody$Outbound = {
|
|
|
437
435
|
testVariants?: Array<UpdateLinkTestVariants$Outbound> | null | undefined;
|
|
438
436
|
testStartedAt?: string | null | undefined;
|
|
439
437
|
testCompletedAt?: string | null | undefined;
|
|
438
|
+
publicStats?: boolean | undefined;
|
|
439
|
+
tagId?: string | null | undefined;
|
|
440
440
|
};
|
|
441
441
|
|
|
442
442
|
/** @internal */
|
|
@@ -454,8 +454,6 @@ export const UpdateLinkRequestBody$outboundSchema: z.ZodType<
|
|
|
454
454
|
partnerId: z.nullable(z.string()).optional(),
|
|
455
455
|
trackConversion: z.boolean().optional(),
|
|
456
456
|
archived: z.boolean().optional(),
|
|
457
|
-
publicStats: z.boolean().optional(),
|
|
458
|
-
tagId: z.nullable(z.string()).optional(),
|
|
459
457
|
tagIds: z.union([z.string(), z.array(z.string())]).optional(),
|
|
460
458
|
tagNames: z.union([z.string(), z.array(z.string())]).optional(),
|
|
461
459
|
folderId: z.nullable(z.string()).optional(),
|
|
@@ -485,6 +483,8 @@ export const UpdateLinkRequestBody$outboundSchema: z.ZodType<
|
|
|
485
483
|
).optional(),
|
|
486
484
|
testStartedAt: z.nullable(z.string()).optional(),
|
|
487
485
|
testCompletedAt: z.nullable(z.string()).optional(),
|
|
486
|
+
publicStats: z.boolean().optional(),
|
|
487
|
+
tagId: z.nullable(z.string()).optional(),
|
|
488
488
|
}).transform((v) => {
|
|
489
489
|
return remap$(v, {
|
|
490
490
|
utmSource: "utm_source",
|
|
@@ -69,18 +69,6 @@ export type UpsertLinkRequestBody = {
|
|
|
69
69
|
* Whether the short link is archived. Defaults to `false` if not provided.
|
|
70
70
|
*/
|
|
71
71
|
archived?: boolean | undefined;
|
|
72
|
-
/**
|
|
73
|
-
* Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
|
|
74
|
-
*
|
|
75
|
-
* @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
76
|
-
*/
|
|
77
|
-
publicStats?: boolean | undefined;
|
|
78
|
-
/**
|
|
79
|
-
* The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead.
|
|
80
|
-
*
|
|
81
|
-
* @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
82
|
-
*/
|
|
83
|
-
tagId?: string | null | undefined;
|
|
84
72
|
/**
|
|
85
73
|
* The unique IDs of the tags assigned to the short link.
|
|
86
74
|
*/
|
|
@@ -189,6 +177,18 @@ export type UpsertLinkRequestBody = {
|
|
|
189
177
|
* The date and time when the tests were or will be completed.
|
|
190
178
|
*/
|
|
191
179
|
testCompletedAt?: string | null | undefined;
|
|
180
|
+
/**
|
|
181
|
+
* Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
|
|
182
|
+
*
|
|
183
|
+
* @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
184
|
+
*/
|
|
185
|
+
publicStats?: boolean | undefined;
|
|
186
|
+
/**
|
|
187
|
+
* Deprecated: Use `tagIds` instead. The unique ID of the tag assigned to the short link.
|
|
188
|
+
*
|
|
189
|
+
* @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
190
|
+
*/
|
|
191
|
+
tagId?: string | null | undefined;
|
|
192
192
|
};
|
|
193
193
|
|
|
194
194
|
/** @internal */
|
|
@@ -361,8 +361,6 @@ export const UpsertLinkRequestBody$inboundSchema: z.ZodType<
|
|
|
361
361
|
prefix: z.string().optional(),
|
|
362
362
|
trackConversion: z.boolean().optional(),
|
|
363
363
|
archived: z.boolean().optional(),
|
|
364
|
-
publicStats: z.boolean().optional(),
|
|
365
|
-
tagId: z.nullable(z.string()).optional(),
|
|
366
364
|
tagIds: z.union([z.string(), z.array(z.string())]).optional(),
|
|
367
365
|
tagNames: z.union([z.string(), z.array(z.string())]).optional(),
|
|
368
366
|
folderId: z.nullable(z.string()).optional(),
|
|
@@ -392,6 +390,8 @@ export const UpsertLinkRequestBody$inboundSchema: z.ZodType<
|
|
|
392
390
|
).optional(),
|
|
393
391
|
testStartedAt: z.nullable(z.string()).optional(),
|
|
394
392
|
testCompletedAt: z.nullable(z.string()).optional(),
|
|
393
|
+
publicStats: z.boolean().optional(),
|
|
394
|
+
tagId: z.nullable(z.string()).optional(),
|
|
395
395
|
}).transform((v) => {
|
|
396
396
|
return remap$(v, {
|
|
397
397
|
"utm_source": "utmSource",
|
|
@@ -415,8 +415,6 @@ export type UpsertLinkRequestBody$Outbound = {
|
|
|
415
415
|
prefix?: string | undefined;
|
|
416
416
|
trackConversion?: boolean | undefined;
|
|
417
417
|
archived?: boolean | undefined;
|
|
418
|
-
publicStats?: boolean | undefined;
|
|
419
|
-
tagId?: string | null | undefined;
|
|
420
418
|
tagIds?: string | Array<string> | undefined;
|
|
421
419
|
tagNames?: string | Array<string> | undefined;
|
|
422
420
|
folderId?: string | null | undefined;
|
|
@@ -444,6 +442,8 @@ export type UpsertLinkRequestBody$Outbound = {
|
|
|
444
442
|
testVariants?: Array<UpsertLinkTestVariants$Outbound> | null | undefined;
|
|
445
443
|
testStartedAt?: string | null | undefined;
|
|
446
444
|
testCompletedAt?: string | null | undefined;
|
|
445
|
+
publicStats?: boolean | undefined;
|
|
446
|
+
tagId?: string | null | undefined;
|
|
447
447
|
};
|
|
448
448
|
|
|
449
449
|
/** @internal */
|
|
@@ -463,8 +463,6 @@ export const UpsertLinkRequestBody$outboundSchema: z.ZodType<
|
|
|
463
463
|
prefix: z.string().optional(),
|
|
464
464
|
trackConversion: z.boolean().optional(),
|
|
465
465
|
archived: z.boolean().optional(),
|
|
466
|
-
publicStats: z.boolean().optional(),
|
|
467
|
-
tagId: z.nullable(z.string()).optional(),
|
|
468
466
|
tagIds: z.union([z.string(), z.array(z.string())]).optional(),
|
|
469
467
|
tagNames: z.union([z.string(), z.array(z.string())]).optional(),
|
|
470
468
|
folderId: z.nullable(z.string()).optional(),
|
|
@@ -494,6 +492,8 @@ export const UpsertLinkRequestBody$outboundSchema: z.ZodType<
|
|
|
494
492
|
).optional(),
|
|
495
493
|
testStartedAt: z.nullable(z.string()).optional(),
|
|
496
494
|
testCompletedAt: z.nullable(z.string()).optional(),
|
|
495
|
+
publicStats: z.boolean().optional(),
|
|
496
|
+
tagId: z.nullable(z.string()).optional(),
|
|
497
497
|
}).transform((v) => {
|
|
498
498
|
return remap$(v, {
|
|
499
499
|
utmSource: "utm_source",
|
package/src/sdk/partners.ts
CHANGED
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
import { partnersAnalytics } from "../funcs/partnersAnalytics.js";
|
|
6
6
|
import { partnersCreate } from "../funcs/partnersCreate.js";
|
|
7
7
|
import { partnersCreateLink } from "../funcs/partnersCreateLink.js";
|
|
8
|
+
import { partnersList } from "../funcs/partnersList.js";
|
|
8
9
|
import { partnersRetrieveLinks } from "../funcs/partnersRetrieveLinks.js";
|
|
9
10
|
import { partnersUpsertLink } from "../funcs/partnersUpsertLink.js";
|
|
10
11
|
import { ClientSDK, RequestOptions } from "../lib/sdks.js";
|
|
@@ -30,6 +31,23 @@ export class Partners extends ClientSDK {
|
|
|
30
31
|
));
|
|
31
32
|
}
|
|
32
33
|
|
|
34
|
+
/**
|
|
35
|
+
* List all partners
|
|
36
|
+
*
|
|
37
|
+
* @remarks
|
|
38
|
+
* List all partners for a partner program.
|
|
39
|
+
*/
|
|
40
|
+
async list(
|
|
41
|
+
request?: operations.ListPartnersRequest | undefined,
|
|
42
|
+
options?: RequestOptions,
|
|
43
|
+
): Promise<Array<operations.ListPartnersResponseBody>> {
|
|
44
|
+
return unwrapAsync(partnersList(
|
|
45
|
+
this,
|
|
46
|
+
request,
|
|
47
|
+
options,
|
|
48
|
+
));
|
|
49
|
+
}
|
|
50
|
+
|
|
33
51
|
/**
|
|
34
52
|
* Create a link for a partner
|
|
35
53
|
*
|