@tolt/api 0.6.1 → 0.7.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/dist/api/errors/ContentTooLargeError.d.ts +7 -0
- package/dist/api/errors/ContentTooLargeError.js +17 -0
- package/dist/api/errors/index.d.ts +1 -0
- package/dist/api/errors/index.js +1 -0
- package/dist/api/resources/clicks/client/Client.d.ts +6 -1
- package/dist/api/resources/clicks/client/Client.js +15 -4
- package/dist/api/resources/clicks/client/requests/GetClicksRequest.d.ts +1 -1
- package/dist/api/resources/clicks/client/requests/ListClicksRequest.d.ts +10 -5
- package/dist/api/resources/clicks/types/ListClicksRequestOrder.d.ts +1 -0
- package/dist/api/resources/clicks/types/ListClicksRequestOrder.js +1 -0
- package/dist/api/resources/clicks/types/ListClicksRequestSort.d.ts +1 -1
- package/dist/api/resources/clicks/types/ListClicksRequestSort.js +1 -1
- package/dist/api/resources/commissions/client/Client.d.ts +29 -7
- package/dist/api/resources/commissions/client/Client.js +56 -16
- package/dist/api/resources/commissions/client/requests/ApproveCommissionsRequest.d.ts +1 -1
- package/dist/api/resources/commissions/client/requests/BulkApproveCommissionsRequest.d.ts +2 -2
- package/dist/api/resources/commissions/client/requests/BulkDeclineCommissionsRequest.d.ts +2 -2
- package/dist/api/resources/commissions/client/requests/DeclineCommissionsRequest.d.ts +1 -1
- package/dist/api/resources/commissions/client/requests/DeleteCommissionsRequest.d.ts +1 -1
- package/dist/api/resources/commissions/client/requests/GetCommissionsRequest.d.ts +1 -1
- package/dist/api/resources/commissions/client/requests/ListCommissionsRequest.d.ts +14 -5
- package/dist/api/resources/commissions/client/requests/UpdateCommissionsRequest.d.ts +19 -4
- package/dist/api/resources/commissions/client/requests/UpdateCommissionsRequest.js +8 -1
- package/dist/api/resources/commissions/client/requests/index.d.ts +1 -1
- package/dist/api/resources/commissions/client/requests/index.js +1 -1
- package/dist/api/resources/commissions/types/ListCommissionsRequestOrder.d.ts +1 -0
- package/dist/api/resources/commissions/types/ListCommissionsRequestOrder.js +1 -0
- package/dist/api/resources/commissions/types/ListCommissionsRequestSort.d.ts +1 -1
- package/dist/api/resources/commissions/types/ListCommissionsRequestSort.js +1 -1
- package/dist/api/resources/customers/client/Client.d.ts +27 -4
- package/dist/api/resources/customers/client/Client.js +42 -9
- package/dist/api/resources/customers/client/requests/CreateCustomersRequest.d.ts +20 -2
- package/dist/api/resources/customers/client/requests/CreateCustomersRequest.js +1 -0
- package/dist/api/resources/customers/client/requests/DeleteCustomersRequest.d.ts +1 -1
- package/dist/api/resources/customers/client/requests/GetCustomersRequest.d.ts +1 -1
- package/dist/api/resources/customers/client/requests/ListCustomersRequest.d.ts +14 -5
- package/dist/api/resources/customers/client/requests/UpdateCustomersRequest.d.ts +15 -2
- package/dist/api/resources/customers/client/requests/UpdateCustomersRequest.js +1 -0
- package/dist/api/resources/customers/types/ListCustomersRequestOrder.d.ts +1 -0
- package/dist/api/resources/customers/types/ListCustomersRequestOrder.js +1 -0
- package/dist/api/resources/customers/types/ListCustomersRequestSort.d.ts +1 -1
- package/dist/api/resources/customers/types/ListCustomersRequestSort.js +1 -1
- package/dist/api/resources/customers/types/ListCustomersRequestStatus.d.ts +1 -0
- package/dist/api/resources/customers/types/ListCustomersRequestStatus.js +1 -0
- package/dist/api/resources/embed/client/Client.d.ts +5 -2
- package/dist/api/resources/embed/client/Client.js +9 -4
- package/dist/api/resources/embed/client/index.d.ts +1 -1
- package/dist/api/resources/embed/client/index.js +1 -1
- package/dist/api/resources/embed/types/CreateTokenEmbedRequest.d.ts +1 -0
- package/dist/api/resources/embed/types/index.d.ts +1 -0
- package/dist/api/resources/embed/types/index.js +1 -0
- package/dist/api/resources/flows/client/Client.d.ts +7 -1
- package/dist/api/resources/flows/client/Client.js +13 -3
- package/dist/api/resources/flows/client/requests/GetFlowsRequest.d.ts +1 -1
- package/dist/api/resources/flows/client/requests/ListFlowsRequest.d.ts +13 -5
- package/dist/api/resources/flows/types/ListFlowsRequestActive.d.ts +1 -0
- package/dist/api/resources/flows/types/ListFlowsRequestActive.js +1 -0
- package/dist/api/resources/flows/types/ListFlowsRequestOrder.d.ts +1 -0
- package/dist/api/resources/flows/types/ListFlowsRequestOrder.js +1 -0
- package/dist/api/resources/flows/types/ListFlowsRequestSort.d.ts +1 -1
- package/dist/api/resources/flows/types/ListFlowsRequestSort.js +1 -1
- package/dist/api/resources/groups/client/Client.d.ts +7 -1
- package/dist/api/resources/groups/client/Client.js +13 -3
- package/dist/api/resources/groups/client/requests/GetGroupsRequest.d.ts +1 -1
- package/dist/api/resources/groups/client/requests/ListGroupsRequest.d.ts +10 -5
- package/dist/api/resources/groups/types/ListGroupsRequestDefault.d.ts +1 -0
- package/dist/api/resources/groups/types/ListGroupsRequestDefault.js +1 -0
- package/dist/api/resources/groups/types/ListGroupsRequestOrder.d.ts +1 -0
- package/dist/api/resources/groups/types/ListGroupsRequestOrder.js +1 -0
- package/dist/api/resources/groups/types/ListGroupsRequestSort.d.ts +1 -1
- package/dist/api/resources/groups/types/ListGroupsRequestSort.js +1 -1
- package/dist/api/resources/index.d.ts +0 -1
- package/dist/api/resources/index.js +0 -1
- package/dist/api/resources/links/client/Client.d.ts +17 -5
- package/dist/api/resources/links/client/Client.js +37 -11
- package/dist/api/resources/links/client/requests/CreateLinksRequest.d.ts +6 -2
- package/dist/api/resources/links/client/requests/DeleteLinksRequest.d.ts +1 -1
- package/dist/api/resources/links/client/requests/GetLinksRequest.d.ts +1 -1
- package/dist/api/resources/links/client/requests/ListLinksRequest.d.ts +12 -5
- package/dist/api/resources/links/client/requests/UpdateLinksRequest.d.ts +6 -2
- package/dist/api/resources/links/types/ListLinksRequestOrder.d.ts +1 -0
- package/dist/api/resources/links/types/ListLinksRequestOrder.js +1 -0
- package/dist/api/resources/links/types/ListLinksRequestSort.d.ts +1 -1
- package/dist/api/resources/links/types/ListLinksRequestSort.js +1 -1
- package/dist/api/resources/partners/client/Client.d.ts +39 -10
- package/dist/api/resources/partners/client/Client.js +66 -21
- package/dist/api/resources/partners/client/requests/ApprovePartnersRequest.d.ts +1 -1
- package/dist/api/resources/partners/client/requests/BulkApprovePartnersRequest.d.ts +2 -2
- package/dist/api/resources/partners/client/requests/BulkRejectPartnersRequest.d.ts +4 -2
- package/dist/api/resources/partners/client/requests/CreatePartnersRequest.d.ts +21 -7
- package/dist/api/resources/partners/client/requests/CreatePartnersRequest.js +1 -0
- package/dist/api/resources/partners/client/requests/GetPartnersRequest.d.ts +1 -1
- package/dist/api/resources/partners/client/requests/ListPartnersRequest.d.ts +11 -5
- package/dist/api/resources/partners/client/requests/RejectPartnersRequest.d.ts +2 -1
- package/dist/api/resources/partners/client/requests/SuspendPartnersRequest.d.ts +2 -1
- package/dist/api/resources/partners/client/requests/UpdatePartnersRequest.d.ts +10 -2
- package/dist/api/resources/partners/types/ListPartnersRequestOrder.d.ts +1 -0
- package/dist/api/resources/partners/types/ListPartnersRequestOrder.js +1 -0
- package/dist/api/resources/partners/types/ListPartnersRequestSort.d.ts +1 -1
- package/dist/api/resources/partners/types/ListPartnersRequestSort.js +1 -1
- package/dist/api/resources/partners/types/ListPartnersRequestStatus.d.ts +1 -0
- package/dist/api/resources/partners/types/ListPartnersRequestStatus.js +1 -0
- package/dist/api/resources/programs/client/Client.d.ts +7 -1
- package/dist/api/resources/programs/client/Client.js +13 -3
- package/dist/api/resources/programs/client/requests/GetProgramsRequest.d.ts +1 -1
- package/dist/api/resources/programs/client/requests/ListProgramsRequest.d.ts +8 -5
- package/dist/api/resources/programs/types/ListProgramsRequestOrder.d.ts +1 -0
- package/dist/api/resources/programs/types/ListProgramsRequestOrder.js +1 -0
- package/dist/api/resources/programs/types/ListProgramsRequestSort.d.ts +1 -1
- package/dist/api/resources/programs/types/ListProgramsRequestSort.js +1 -1
- package/dist/api/resources/promotionCodes/client/Client.d.ts +27 -5
- package/dist/api/resources/promotionCodes/client/Client.js +46 -10
- package/dist/api/resources/promotionCodes/client/requests/CreatePromotionCodesRequest.d.ts +9 -2
- package/dist/api/resources/promotionCodes/client/requests/CreatePromotionCodesRequest.js +1 -0
- package/dist/api/resources/promotionCodes/client/requests/DeletePromotionCodesRequest.d.ts +1 -1
- package/dist/api/resources/promotionCodes/client/requests/GetPromotionCodesRequest.d.ts +1 -1
- package/dist/api/resources/promotionCodes/client/requests/ListPromotionCodesRequest.d.ts +11 -5
- package/dist/api/resources/promotionCodes/client/requests/UpdatePromotionCodesRequest.d.ts +8 -1
- package/dist/api/resources/promotionCodes/client/requests/UpdatePromotionCodesRequest.js +1 -0
- package/dist/api/resources/promotionCodes/types/ListPromotionCodesRequestOrder.d.ts +1 -0
- package/dist/api/resources/promotionCodes/types/ListPromotionCodesRequestOrder.js +1 -0
- package/dist/api/resources/promotionCodes/types/ListPromotionCodesRequestSort.d.ts +1 -1
- package/dist/api/resources/promotionCodes/types/ListPromotionCodesRequestSort.js +1 -1
- package/dist/api/resources/promotionCodes/types/ListPromotionCodesRequestType.d.ts +1 -0
- package/dist/api/resources/promotionCodes/types/ListPromotionCodesRequestType.js +1 -0
- package/dist/api/resources/reports/client/Client.d.ts +15 -0
- package/dist/api/resources/reports/client/Client.js +30 -5
- package/dist/api/resources/reports/client/requests/CustomerStatsReportsRequest.d.ts +3 -0
- package/dist/api/resources/reports/client/requests/LinksReportsRequest.d.ts +8 -0
- package/dist/api/resources/reports/client/requests/OverviewReportsRequest.d.ts +3 -0
- package/dist/api/resources/reports/client/requests/PartnersReportsRequest.d.ts +8 -0
- package/dist/api/resources/reports/client/requests/TimeseriesReportsRequest.d.ts +5 -0
- package/dist/api/resources/reports/types/LinksReportsRequestOrder.d.ts +1 -0
- package/dist/api/resources/reports/types/LinksReportsRequestOrder.js +1 -0
- package/dist/api/resources/reports/types/LinksReportsRequestSort.d.ts +1 -0
- package/dist/api/resources/reports/types/LinksReportsRequestSort.js +1 -0
- package/dist/api/resources/reports/types/PartnersReportsRequestOrder.d.ts +1 -0
- package/dist/api/resources/reports/types/PartnersReportsRequestOrder.js +1 -0
- package/dist/api/resources/reports/types/PartnersReportsRequestSort.d.ts +1 -0
- package/dist/api/resources/reports/types/PartnersReportsRequestSort.js +1 -0
- package/dist/api/resources/reports/types/TimeseriesReportsRequestGranularity.d.ts +1 -0
- package/dist/api/resources/reports/types/TimeseriesReportsRequestGranularity.js +1 -0
- package/dist/api/resources/transactions/client/Client.d.ts +30 -7
- package/dist/api/resources/transactions/client/Client.js +53 -14
- package/dist/api/resources/transactions/client/requests/CreateTransactionsRequest.d.ts +17 -3
- package/dist/api/resources/transactions/client/requests/DeleteTransactionsRequest.d.ts +1 -1
- package/dist/api/resources/transactions/client/requests/GetTransactionsRequest.d.ts +1 -1
- package/dist/api/resources/transactions/client/requests/ListTransactionsRequest.d.ts +12 -5
- package/dist/api/resources/transactions/client/requests/RefundTransactionsRequest.d.ts +1 -1
- package/dist/api/resources/transactions/client/requests/RerunFlowsTransactionsRequest.d.ts +1 -1
- package/dist/api/resources/transactions/client/requests/UpdateTransactionsRequest.d.ts +13 -2
- package/dist/api/resources/transactions/types/ListTransactionsRequestOrder.d.ts +1 -0
- package/dist/api/resources/transactions/types/ListTransactionsRequestOrder.js +1 -0
- package/dist/api/resources/transactions/types/ListTransactionsRequestSort.d.ts +1 -1
- package/dist/api/resources/transactions/types/ListTransactionsRequestSort.js +1 -1
- package/dist/api/types/Commission.d.ts +1 -1
- package/dist/api/types/Customer.d.ts +2 -2
- package/dist/api/types/Error_.d.ts +1 -0
- package/dist/api/types/Error_.js +1 -0
- package/dist/environments.d.ts +2 -2
- package/dist/environments.js +1 -1
- package/package.json +1 -1
- package/dist/api/resources/embed/client/requests/CreateTokenEmbedRequest.d.ts +0 -14
- package/dist/api/resources/embed/client/requests/index.d.ts +0 -1
- package/dist/api/resources/embed/client/requests/index.js +0 -1
- /package/dist/api/resources/embed/{client/requests → types}/CreateTokenEmbedRequest.js +0 -0
|
@@ -4,26 +4,34 @@ import type * as ToltApi from "../../../../index.js";
|
|
|
4
4
|
* {}
|
|
5
5
|
*/
|
|
6
6
|
export interface ListFlowsRequest {
|
|
7
|
+
/** How many rows to return in one page. */
|
|
7
8
|
limit?: number;
|
|
9
|
+
/** Ranking direction: desc puts the most recently created or updated rows first. */
|
|
8
10
|
order?: ToltApi.ListFlowsRequestOrder;
|
|
9
|
-
/**
|
|
11
|
+
/** Timestamp to order and page by: created_at follows creation order, updated_at follows each item's most recent change. */
|
|
10
12
|
sort?: ToltApi.ListFlowsRequestSort;
|
|
11
13
|
/** Continue after a position: the next_cursor of a previous page, or an item id when sorting by created_at. Cannot be combined with ending_before. */
|
|
12
14
|
starting_after?: string;
|
|
13
15
|
/** Page backward from a position: the prev_cursor of a previous page, or an item id when sorting by created_at. Cannot be combined with starting_after. */
|
|
14
16
|
ending_before?: string;
|
|
15
|
-
/**
|
|
17
|
+
/** Start of a window on when items were created: items created at this time or later are included, for example 2026-01-01T00:00:00Z. Leave it out for no lower bound. */
|
|
16
18
|
created_after?: string;
|
|
17
|
-
/**
|
|
19
|
+
/** End of a window on when items were created: only items created before this time are included. Leave it out for no upper bound. */
|
|
18
20
|
created_before?: string;
|
|
19
|
-
/** Only items
|
|
21
|
+
/** Only items last changed at or after this moment; with sort=updated_at, use it to fetch what changed since a previous sync. */
|
|
20
22
|
updated_after?: string;
|
|
21
|
-
/** Only items
|
|
23
|
+
/** Only items last changed before this moment; pair it with updated_after to fetch what changed in a period. */
|
|
22
24
|
updated_before?: string;
|
|
25
|
+
/** Limit to one program, by its id (prg_...) as returned when listing programs. */
|
|
23
26
|
program_id?: string;
|
|
27
|
+
/** Only flows that run for this partner group, by the group id (grp_...) as returned when listing groups. */
|
|
24
28
|
group_id?: string;
|
|
29
|
+
/** Only flows that belong to this campaign, by its id as returned when listing campaigns. */
|
|
25
30
|
campaign_id?: string;
|
|
31
|
+
/** Only flows triggered by this event, such as transaction_created or lead_created. */
|
|
26
32
|
event?: string;
|
|
33
|
+
/** true lists only active flows, false only paused flows, which do not run. */
|
|
27
34
|
active?: ToltApi.ListFlowsRequestActive;
|
|
35
|
+
/** Text matched anywhere in the flow's name or description, ignoring case. */
|
|
28
36
|
search?: string;
|
|
29
37
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/**
|
|
1
|
+
/** Timestamp to order and page by: created_at follows creation order, updated_at follows each item's most recent change. */
|
|
2
2
|
export declare const ListFlowsRequestSort: {
|
|
3
3
|
readonly CreatedAt: "created_at";
|
|
4
4
|
readonly UpdatedAt: "updated_at";
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
-
/**
|
|
2
|
+
/** Timestamp to order and page by: created_at follows creation order, updated_at follows each item's most recent change. */
|
|
3
3
|
export const ListFlowsRequestSort = {
|
|
4
4
|
CreatedAt: "created_at",
|
|
5
5
|
UpdatedAt: "updated_at",
|
|
@@ -11,11 +11,14 @@ export declare class GroupsClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<GroupsClient.Options>;
|
|
12
12
|
constructor(options: GroupsClient.Options);
|
|
13
13
|
/**
|
|
14
|
+
* Lists partner groups. Filter by program or by the default group, and page with cursors.
|
|
15
|
+
*
|
|
14
16
|
* @param {ToltApi.ListGroupsRequest} request
|
|
15
17
|
* @param {GroupsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
16
18
|
*
|
|
17
19
|
* @throws {@link ToltApi.BadRequestError}
|
|
18
20
|
* @throws {@link ToltApi.UnauthorizedError}
|
|
21
|
+
* @throws {@link ToltApi.ContentTooLargeError}
|
|
19
22
|
* @throws {@link ToltApi.TooManyRequestsError}
|
|
20
23
|
* @throws {@link errors.ToltApiError}
|
|
21
24
|
* @throws {@link errors.ToltApiTimeoutError}
|
|
@@ -26,18 +29,21 @@ export declare class GroupsClient {
|
|
|
26
29
|
list(request?: ToltApi.ListGroupsRequest, requestOptions?: GroupsClient.RequestOptions): core.HttpResponsePromise<ToltApi.ListGroupsResponse>;
|
|
27
30
|
private __list;
|
|
28
31
|
/**
|
|
32
|
+
* Gets a partner group by ID, with the program it belongs to and whether it is the program's default group.
|
|
33
|
+
*
|
|
29
34
|
* @param {ToltApi.GetGroupsRequest} request
|
|
30
35
|
* @param {GroupsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
31
36
|
*
|
|
32
37
|
* @throws {@link ToltApi.UnauthorizedError}
|
|
33
38
|
* @throws {@link ToltApi.NotFoundError}
|
|
39
|
+
* @throws {@link ToltApi.ContentTooLargeError}
|
|
34
40
|
* @throws {@link ToltApi.TooManyRequestsError}
|
|
35
41
|
* @throws {@link errors.ToltApiError}
|
|
36
42
|
* @throws {@link errors.ToltApiTimeoutError}
|
|
37
43
|
*
|
|
38
44
|
* @example
|
|
39
45
|
* await client.groups.get({
|
|
40
|
-
* id: "
|
|
46
|
+
* id: "grp_zUQ8Pt281MsbNDApmDPN3Y2a"
|
|
41
47
|
* })
|
|
42
48
|
*/
|
|
43
49
|
get(request: ToltApi.GetGroupsRequest, requestOptions?: GroupsClient.RequestOptions): core.HttpResponsePromise<ToltApi.GetGroupsResponse>;
|
|
@@ -11,11 +11,14 @@ export class GroupsClient {
|
|
|
11
11
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
12
12
|
}
|
|
13
13
|
/**
|
|
14
|
+
* Lists partner groups. Filter by program or by the default group, and page with cursors.
|
|
15
|
+
*
|
|
14
16
|
* @param {ToltApi.ListGroupsRequest} request
|
|
15
17
|
* @param {GroupsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
16
18
|
*
|
|
17
19
|
* @throws {@link ToltApi.BadRequestError}
|
|
18
20
|
* @throws {@link ToltApi.UnauthorizedError}
|
|
21
|
+
* @throws {@link ToltApi.ContentTooLargeError}
|
|
19
22
|
* @throws {@link ToltApi.TooManyRequestsError}
|
|
20
23
|
* @throws {@link errors.ToltApiError}
|
|
21
24
|
* @throws {@link errors.ToltApiTimeoutError}
|
|
@@ -47,7 +50,7 @@ export class GroupsClient {
|
|
|
47
50
|
const _response = await core.fetcher({
|
|
48
51
|
url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
|
|
49
52
|
(await core.Supplier.get(this._options.environment)) ??
|
|
50
|
-
environments.ToltApiEnvironment.
|
|
53
|
+
environments.ToltApiEnvironment.Default, "v2/groups"),
|
|
51
54
|
method: "GET",
|
|
52
55
|
headers: _headers,
|
|
53
56
|
queryString: core.url
|
|
@@ -70,6 +73,8 @@ export class GroupsClient {
|
|
|
70
73
|
throw new ToltApi.BadRequestError(_response.error.body, _response.rawResponse);
|
|
71
74
|
case 401:
|
|
72
75
|
throw new ToltApi.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
76
|
+
case 413:
|
|
77
|
+
throw new ToltApi.ContentTooLargeError(_response.error.body, _response.rawResponse);
|
|
73
78
|
case 429:
|
|
74
79
|
throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
75
80
|
default:
|
|
@@ -83,18 +88,21 @@ export class GroupsClient {
|
|
|
83
88
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v2/groups");
|
|
84
89
|
}
|
|
85
90
|
/**
|
|
91
|
+
* Gets a partner group by ID, with the program it belongs to and whether it is the program's default group.
|
|
92
|
+
*
|
|
86
93
|
* @param {ToltApi.GetGroupsRequest} request
|
|
87
94
|
* @param {GroupsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
88
95
|
*
|
|
89
96
|
* @throws {@link ToltApi.UnauthorizedError}
|
|
90
97
|
* @throws {@link ToltApi.NotFoundError}
|
|
98
|
+
* @throws {@link ToltApi.ContentTooLargeError}
|
|
91
99
|
* @throws {@link ToltApi.TooManyRequestsError}
|
|
92
100
|
* @throws {@link errors.ToltApiError}
|
|
93
101
|
* @throws {@link errors.ToltApiTimeoutError}
|
|
94
102
|
*
|
|
95
103
|
* @example
|
|
96
104
|
* await client.groups.get({
|
|
97
|
-
* id: "
|
|
105
|
+
* id: "grp_zUQ8Pt281MsbNDApmDPN3Y2a"
|
|
98
106
|
* })
|
|
99
107
|
*/
|
|
100
108
|
get(request, requestOptions) {
|
|
@@ -107,7 +115,7 @@ export class GroupsClient {
|
|
|
107
115
|
const _response = await core.fetcher({
|
|
108
116
|
url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
|
|
109
117
|
(await core.Supplier.get(this._options.environment)) ??
|
|
110
|
-
environments.ToltApiEnvironment.
|
|
118
|
+
environments.ToltApiEnvironment.Default, `v2/groups/${core.url.encodePathParam(id)}`),
|
|
111
119
|
method: "GET",
|
|
112
120
|
headers: _headers,
|
|
113
121
|
queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
|
|
@@ -126,6 +134,8 @@ export class GroupsClient {
|
|
|
126
134
|
throw new ToltApi.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
127
135
|
case 404:
|
|
128
136
|
throw new ToltApi.NotFoundError(_response.error.body, _response.rawResponse);
|
|
137
|
+
case 413:
|
|
138
|
+
throw new ToltApi.ContentTooLargeError(_response.error.body, _response.rawResponse);
|
|
129
139
|
case 429:
|
|
130
140
|
throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
131
141
|
default:
|
|
@@ -4,23 +4,28 @@ import type * as ToltApi from "../../../../index.js";
|
|
|
4
4
|
* {}
|
|
5
5
|
*/
|
|
6
6
|
export interface ListGroupsRequest {
|
|
7
|
+
/** How many rows to return in one page. */
|
|
7
8
|
limit?: number;
|
|
9
|
+
/** Ranking direction: desc puts the most recently created or updated rows first. */
|
|
8
10
|
order?: ToltApi.ListGroupsRequestOrder;
|
|
9
|
-
/**
|
|
11
|
+
/** Timestamp to order and page by: created_at follows creation order, updated_at follows each item's most recent change. */
|
|
10
12
|
sort?: ToltApi.ListGroupsRequestSort;
|
|
11
13
|
/** Continue after a position: the next_cursor of a previous page, or an item id when sorting by created_at. Cannot be combined with ending_before. */
|
|
12
14
|
starting_after?: string;
|
|
13
15
|
/** Page backward from a position: the prev_cursor of a previous page, or an item id when sorting by created_at. Cannot be combined with starting_after. */
|
|
14
16
|
ending_before?: string;
|
|
15
|
-
/**
|
|
17
|
+
/** Start of a window on when items were created: items created at this time or later are included, for example 2026-01-01T00:00:00Z. Leave it out for no lower bound. */
|
|
16
18
|
created_after?: string;
|
|
17
|
-
/**
|
|
19
|
+
/** End of a window on when items were created: only items created before this time are included. Leave it out for no upper bound. */
|
|
18
20
|
created_before?: string;
|
|
19
|
-
/** Only items
|
|
21
|
+
/** Only items last changed at or after this moment; with sort=updated_at, use it to fetch what changed since a previous sync. */
|
|
20
22
|
updated_after?: string;
|
|
21
|
-
/** Only items
|
|
23
|
+
/** Only items last changed before this moment; pair it with updated_after to fetch what changed in a period. */
|
|
22
24
|
updated_before?: string;
|
|
25
|
+
/** Limit to one program, by its id (prg_...) as returned when listing programs. */
|
|
23
26
|
program_id?: string;
|
|
27
|
+
/** Text matched anywhere in the group's name, description or public key, ignoring case. */
|
|
24
28
|
search?: string;
|
|
29
|
+
/** true lists only default groups, where new partners are placed unless another group is chosen; false lists the others. */
|
|
25
30
|
default?: ToltApi.ListGroupsRequestDefault;
|
|
26
31
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/**
|
|
1
|
+
/** Timestamp to order and page by: created_at follows creation order, updated_at follows each item's most recent change. */
|
|
2
2
|
export declare const ListGroupsRequestSort: {
|
|
3
3
|
readonly CreatedAt: "created_at";
|
|
4
4
|
readonly UpdatedAt: "updated_at";
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
-
/**
|
|
2
|
+
/** Timestamp to order and page by: created_at follows creation order, updated_at follows each item's most recent change. */
|
|
3
3
|
export const ListGroupsRequestSort = {
|
|
4
4
|
CreatedAt: "created_at",
|
|
5
5
|
UpdatedAt: "updated_at",
|
|
@@ -7,7 +7,6 @@ export * from "./commissions/types/index.js";
|
|
|
7
7
|
export * from "./customers/client/requests/index.js";
|
|
8
8
|
export * as customers from "./customers/index.js";
|
|
9
9
|
export * from "./customers/types/index.js";
|
|
10
|
-
export * from "./embed/client/requests/index.js";
|
|
11
10
|
export * as embed from "./embed/index.js";
|
|
12
11
|
export * from "./embed/types/index.js";
|
|
13
12
|
export * from "./flows/client/requests/index.js";
|
|
@@ -7,7 +7,6 @@ export * from "./commissions/types/index.js";
|
|
|
7
7
|
export * from "./customers/client/requests/index.js";
|
|
8
8
|
export * as customers from "./customers/index.js";
|
|
9
9
|
export * from "./customers/types/index.js";
|
|
10
|
-
export * from "./embed/client/requests/index.js";
|
|
11
10
|
export * as embed from "./embed/index.js";
|
|
12
11
|
export * from "./embed/types/index.js";
|
|
13
12
|
export * from "./flows/client/requests/index.js";
|
|
@@ -18,6 +18,7 @@ export declare class LinksClient {
|
|
|
18
18
|
*
|
|
19
19
|
* @throws {@link ToltApi.BadRequestError}
|
|
20
20
|
* @throws {@link ToltApi.UnauthorizedError}
|
|
21
|
+
* @throws {@link ToltApi.ContentTooLargeError}
|
|
21
22
|
* @throws {@link ToltApi.TooManyRequestsError}
|
|
22
23
|
* @throws {@link errors.ToltApiError}
|
|
23
24
|
* @throws {@link errors.ToltApiTimeoutError}
|
|
@@ -28,19 +29,24 @@ export declare class LinksClient {
|
|
|
28
29
|
list(request?: ToltApi.ListLinksRequest, requestOptions?: LinksClient.RequestOptions): core.HttpResponsePromise<ToltApi.ListLinksResponse>;
|
|
29
30
|
private __list;
|
|
30
31
|
/**
|
|
32
|
+
* Creates a referral link for a partner. The value must be unique for its parameter, and param defaults to the program's.
|
|
33
|
+
*
|
|
31
34
|
* @param {ToltApi.CreateLinksRequest} request
|
|
32
35
|
* @param {LinksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
33
36
|
*
|
|
34
37
|
* @throws {@link ToltApi.BadRequestError}
|
|
35
38
|
* @throws {@link ToltApi.UnauthorizedError}
|
|
39
|
+
* @throws {@link ToltApi.ConflictError}
|
|
40
|
+
* @throws {@link ToltApi.ContentTooLargeError}
|
|
36
41
|
* @throws {@link ToltApi.TooManyRequestsError}
|
|
37
42
|
* @throws {@link errors.ToltApiError}
|
|
38
43
|
* @throws {@link errors.ToltApiTimeoutError}
|
|
39
44
|
*
|
|
40
45
|
* @example
|
|
41
46
|
* await client.links.create({
|
|
42
|
-
* value: "
|
|
43
|
-
*
|
|
47
|
+
* value: "sam",
|
|
48
|
+
* param: "ref",
|
|
49
|
+
* partner_id: "part_NLYzgNKuSuASvrvoxNtau6SY"
|
|
44
50
|
* })
|
|
45
51
|
*/
|
|
46
52
|
create(request: ToltApi.CreateLinksRequest, requestOptions?: LinksClient.RequestOptions): core.HttpResponsePromise<ToltApi.CreateLinksResponse>;
|
|
@@ -54,6 +60,7 @@ export declare class LinksClient {
|
|
|
54
60
|
* @throws {@link ToltApi.BadRequestError}
|
|
55
61
|
* @throws {@link ToltApi.UnauthorizedError}
|
|
56
62
|
* @throws {@link ToltApi.NotFoundError}
|
|
63
|
+
* @throws {@link ToltApi.ContentTooLargeError}
|
|
57
64
|
* @throws {@link ToltApi.TooManyRequestsError}
|
|
58
65
|
* @throws {@link errors.ToltApiError}
|
|
59
66
|
* @throws {@link errors.ToltApiTimeoutError}
|
|
@@ -74,13 +81,14 @@ export declare class LinksClient {
|
|
|
74
81
|
*
|
|
75
82
|
* @throws {@link ToltApi.UnauthorizedError}
|
|
76
83
|
* @throws {@link ToltApi.NotFoundError}
|
|
84
|
+
* @throws {@link ToltApi.ContentTooLargeError}
|
|
77
85
|
* @throws {@link ToltApi.TooManyRequestsError}
|
|
78
86
|
* @throws {@link errors.ToltApiError}
|
|
79
87
|
* @throws {@link errors.ToltApiTimeoutError}
|
|
80
88
|
*
|
|
81
89
|
* @example
|
|
82
90
|
* await client.links.get({
|
|
83
|
-
* id: "
|
|
91
|
+
* id: "lnk_mtTeeckFa1vMdvDFXretQNs6"
|
|
84
92
|
* })
|
|
85
93
|
*/
|
|
86
94
|
get(request: ToltApi.GetLinksRequest, requestOptions?: LinksClient.RequestOptions): core.HttpResponsePromise<ToltApi.GetLinksResponse>;
|
|
@@ -94,13 +102,16 @@ export declare class LinksClient {
|
|
|
94
102
|
* @throws {@link ToltApi.BadRequestError}
|
|
95
103
|
* @throws {@link ToltApi.UnauthorizedError}
|
|
96
104
|
* @throws {@link ToltApi.NotFoundError}
|
|
105
|
+
* @throws {@link ToltApi.ContentTooLargeError}
|
|
97
106
|
* @throws {@link ToltApi.TooManyRequestsError}
|
|
98
107
|
* @throws {@link errors.ToltApiError}
|
|
99
108
|
* @throws {@link errors.ToltApiTimeoutError}
|
|
100
109
|
*
|
|
101
110
|
* @example
|
|
102
111
|
* await client.links.update({
|
|
103
|
-
* id: "
|
|
112
|
+
* id: "lnk_mtTeeckFa1vMdvDFXretQNs6",
|
|
113
|
+
* param: "ref",
|
|
114
|
+
* value: "sam"
|
|
104
115
|
* })
|
|
105
116
|
*/
|
|
106
117
|
update(request: ToltApi.UpdateLinksRequest, requestOptions?: LinksClient.RequestOptions): core.HttpResponsePromise<ToltApi.UpdateLinksResponse>;
|
|
@@ -114,13 +125,14 @@ export declare class LinksClient {
|
|
|
114
125
|
* @throws {@link ToltApi.BadRequestError}
|
|
115
126
|
* @throws {@link ToltApi.UnauthorizedError}
|
|
116
127
|
* @throws {@link ToltApi.NotFoundError}
|
|
128
|
+
* @throws {@link ToltApi.ContentTooLargeError}
|
|
117
129
|
* @throws {@link ToltApi.TooManyRequestsError}
|
|
118
130
|
* @throws {@link errors.ToltApiError}
|
|
119
131
|
* @throws {@link errors.ToltApiTimeoutError}
|
|
120
132
|
*
|
|
121
133
|
* @example
|
|
122
134
|
* await client.links.delete({
|
|
123
|
-
* id: "
|
|
135
|
+
* id: "lnk_mtTeeckFa1vMdvDFXretQNs6"
|
|
124
136
|
* })
|
|
125
137
|
*/
|
|
126
138
|
delete(request: ToltApi.DeleteLinksRequest, requestOptions?: LinksClient.RequestOptions): core.HttpResponsePromise<ToltApi.DeleteLinksResponse>;
|
|
@@ -19,6 +19,7 @@ export class LinksClient {
|
|
|
19
19
|
*
|
|
20
20
|
* @throws {@link ToltApi.BadRequestError}
|
|
21
21
|
* @throws {@link ToltApi.UnauthorizedError}
|
|
22
|
+
* @throws {@link ToltApi.ContentTooLargeError}
|
|
22
23
|
* @throws {@link ToltApi.TooManyRequestsError}
|
|
23
24
|
* @throws {@link errors.ToltApiError}
|
|
24
25
|
* @throws {@link errors.ToltApiTimeoutError}
|
|
@@ -52,7 +53,7 @@ export class LinksClient {
|
|
|
52
53
|
const _response = await core.fetcher({
|
|
53
54
|
url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
|
|
54
55
|
(await core.Supplier.get(this._options.environment)) ??
|
|
55
|
-
environments.ToltApiEnvironment.
|
|
56
|
+
environments.ToltApiEnvironment.Default, "v2/links"),
|
|
56
57
|
method: "GET",
|
|
57
58
|
headers: _headers,
|
|
58
59
|
queryString: core.url
|
|
@@ -75,6 +76,8 @@ export class LinksClient {
|
|
|
75
76
|
throw new ToltApi.BadRequestError(_response.error.body, _response.rawResponse);
|
|
76
77
|
case 401:
|
|
77
78
|
throw new ToltApi.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
79
|
+
case 413:
|
|
80
|
+
throw new ToltApi.ContentTooLargeError(_response.error.body, _response.rawResponse);
|
|
78
81
|
case 429:
|
|
79
82
|
throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
80
83
|
default:
|
|
@@ -88,19 +91,24 @@ export class LinksClient {
|
|
|
88
91
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v2/links");
|
|
89
92
|
}
|
|
90
93
|
/**
|
|
94
|
+
* Creates a referral link for a partner. The value must be unique for its parameter, and param defaults to the program's.
|
|
95
|
+
*
|
|
91
96
|
* @param {ToltApi.CreateLinksRequest} request
|
|
92
97
|
* @param {LinksClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
93
98
|
*
|
|
94
99
|
* @throws {@link ToltApi.BadRequestError}
|
|
95
100
|
* @throws {@link ToltApi.UnauthorizedError}
|
|
101
|
+
* @throws {@link ToltApi.ConflictError}
|
|
102
|
+
* @throws {@link ToltApi.ContentTooLargeError}
|
|
96
103
|
* @throws {@link ToltApi.TooManyRequestsError}
|
|
97
104
|
* @throws {@link errors.ToltApiError}
|
|
98
105
|
* @throws {@link errors.ToltApiTimeoutError}
|
|
99
106
|
*
|
|
100
107
|
* @example
|
|
101
108
|
* await client.links.create({
|
|
102
|
-
* value: "
|
|
103
|
-
*
|
|
109
|
+
* value: "sam",
|
|
110
|
+
* param: "ref",
|
|
111
|
+
* partner_id: "part_NLYzgNKuSuASvrvoxNtau6SY"
|
|
104
112
|
* })
|
|
105
113
|
*/
|
|
106
114
|
create(request, requestOptions) {
|
|
@@ -112,7 +120,7 @@ export class LinksClient {
|
|
|
112
120
|
const _response = await core.fetcher({
|
|
113
121
|
url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
|
|
114
122
|
(await core.Supplier.get(this._options.environment)) ??
|
|
115
|
-
environments.ToltApiEnvironment.
|
|
123
|
+
environments.ToltApiEnvironment.Default, "v2/links"),
|
|
116
124
|
method: "POST",
|
|
117
125
|
headers: _headers,
|
|
118
126
|
contentType: "application/json",
|
|
@@ -134,6 +142,10 @@ export class LinksClient {
|
|
|
134
142
|
throw new ToltApi.BadRequestError(_response.error.body, _response.rawResponse);
|
|
135
143
|
case 401:
|
|
136
144
|
throw new ToltApi.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
145
|
+
case 409:
|
|
146
|
+
throw new ToltApi.ConflictError(_response.error.body, _response.rawResponse);
|
|
147
|
+
case 413:
|
|
148
|
+
throw new ToltApi.ContentTooLargeError(_response.error.body, _response.rawResponse);
|
|
137
149
|
case 429:
|
|
138
150
|
throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
139
151
|
default:
|
|
@@ -155,6 +167,7 @@ export class LinksClient {
|
|
|
155
167
|
* @throws {@link ToltApi.BadRequestError}
|
|
156
168
|
* @throws {@link ToltApi.UnauthorizedError}
|
|
157
169
|
* @throws {@link ToltApi.NotFoundError}
|
|
170
|
+
* @throws {@link ToltApi.ContentTooLargeError}
|
|
158
171
|
* @throws {@link ToltApi.TooManyRequestsError}
|
|
159
172
|
* @throws {@link errors.ToltApiError}
|
|
160
173
|
* @throws {@link errors.ToltApiTimeoutError}
|
|
@@ -179,7 +192,7 @@ export class LinksClient {
|
|
|
179
192
|
const _response = await core.fetcher({
|
|
180
193
|
url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
|
|
181
194
|
(await core.Supplier.get(this._options.environment)) ??
|
|
182
|
-
environments.ToltApiEnvironment.
|
|
195
|
+
environments.ToltApiEnvironment.Default, "v2/links/by-param-value"),
|
|
183
196
|
method: "GET",
|
|
184
197
|
headers: _headers,
|
|
185
198
|
queryString: core.url
|
|
@@ -204,6 +217,8 @@ export class LinksClient {
|
|
|
204
217
|
throw new ToltApi.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
205
218
|
case 404:
|
|
206
219
|
throw new ToltApi.NotFoundError(_response.error.body, _response.rawResponse);
|
|
220
|
+
case 413:
|
|
221
|
+
throw new ToltApi.ContentTooLargeError(_response.error.body, _response.rawResponse);
|
|
207
222
|
case 429:
|
|
208
223
|
throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
209
224
|
default:
|
|
@@ -224,13 +239,14 @@ export class LinksClient {
|
|
|
224
239
|
*
|
|
225
240
|
* @throws {@link ToltApi.UnauthorizedError}
|
|
226
241
|
* @throws {@link ToltApi.NotFoundError}
|
|
242
|
+
* @throws {@link ToltApi.ContentTooLargeError}
|
|
227
243
|
* @throws {@link ToltApi.TooManyRequestsError}
|
|
228
244
|
* @throws {@link errors.ToltApiError}
|
|
229
245
|
* @throws {@link errors.ToltApiTimeoutError}
|
|
230
246
|
*
|
|
231
247
|
* @example
|
|
232
248
|
* await client.links.get({
|
|
233
|
-
* id: "
|
|
249
|
+
* id: "lnk_mtTeeckFa1vMdvDFXretQNs6"
|
|
234
250
|
* })
|
|
235
251
|
*/
|
|
236
252
|
get(request, requestOptions) {
|
|
@@ -243,7 +259,7 @@ export class LinksClient {
|
|
|
243
259
|
const _response = await core.fetcher({
|
|
244
260
|
url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
|
|
245
261
|
(await core.Supplier.get(this._options.environment)) ??
|
|
246
|
-
environments.ToltApiEnvironment.
|
|
262
|
+
environments.ToltApiEnvironment.Default, `v2/links/${core.url.encodePathParam(id)}`),
|
|
247
263
|
method: "GET",
|
|
248
264
|
headers: _headers,
|
|
249
265
|
queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
|
|
@@ -262,6 +278,8 @@ export class LinksClient {
|
|
|
262
278
|
throw new ToltApi.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
263
279
|
case 404:
|
|
264
280
|
throw new ToltApi.NotFoundError(_response.error.body, _response.rawResponse);
|
|
281
|
+
case 413:
|
|
282
|
+
throw new ToltApi.ContentTooLargeError(_response.error.body, _response.rawResponse);
|
|
265
283
|
case 429:
|
|
266
284
|
throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
267
285
|
default:
|
|
@@ -283,13 +301,16 @@ export class LinksClient {
|
|
|
283
301
|
* @throws {@link ToltApi.BadRequestError}
|
|
284
302
|
* @throws {@link ToltApi.UnauthorizedError}
|
|
285
303
|
* @throws {@link ToltApi.NotFoundError}
|
|
304
|
+
* @throws {@link ToltApi.ContentTooLargeError}
|
|
286
305
|
* @throws {@link ToltApi.TooManyRequestsError}
|
|
287
306
|
* @throws {@link errors.ToltApiError}
|
|
288
307
|
* @throws {@link errors.ToltApiTimeoutError}
|
|
289
308
|
*
|
|
290
309
|
* @example
|
|
291
310
|
* await client.links.update({
|
|
292
|
-
* id: "
|
|
311
|
+
* id: "lnk_mtTeeckFa1vMdvDFXretQNs6",
|
|
312
|
+
* param: "ref",
|
|
313
|
+
* value: "sam"
|
|
293
314
|
* })
|
|
294
315
|
*/
|
|
295
316
|
update(request, requestOptions) {
|
|
@@ -302,7 +323,7 @@ export class LinksClient {
|
|
|
302
323
|
const _response = await core.fetcher({
|
|
303
324
|
url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
|
|
304
325
|
(await core.Supplier.get(this._options.environment)) ??
|
|
305
|
-
environments.ToltApiEnvironment.
|
|
326
|
+
environments.ToltApiEnvironment.Default, `v2/links/${core.url.encodePathParam(id)}`),
|
|
306
327
|
method: "PUT",
|
|
307
328
|
headers: _headers,
|
|
308
329
|
contentType: "application/json",
|
|
@@ -326,6 +347,8 @@ export class LinksClient {
|
|
|
326
347
|
throw new ToltApi.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
327
348
|
case 404:
|
|
328
349
|
throw new ToltApi.NotFoundError(_response.error.body, _response.rawResponse);
|
|
350
|
+
case 413:
|
|
351
|
+
throw new ToltApi.ContentTooLargeError(_response.error.body, _response.rawResponse);
|
|
329
352
|
case 429:
|
|
330
353
|
throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
331
354
|
default:
|
|
@@ -347,13 +370,14 @@ export class LinksClient {
|
|
|
347
370
|
* @throws {@link ToltApi.BadRequestError}
|
|
348
371
|
* @throws {@link ToltApi.UnauthorizedError}
|
|
349
372
|
* @throws {@link ToltApi.NotFoundError}
|
|
373
|
+
* @throws {@link ToltApi.ContentTooLargeError}
|
|
350
374
|
* @throws {@link ToltApi.TooManyRequestsError}
|
|
351
375
|
* @throws {@link errors.ToltApiError}
|
|
352
376
|
* @throws {@link errors.ToltApiTimeoutError}
|
|
353
377
|
*
|
|
354
378
|
* @example
|
|
355
379
|
* await client.links.delete({
|
|
356
|
-
* id: "
|
|
380
|
+
* id: "lnk_mtTeeckFa1vMdvDFXretQNs6"
|
|
357
381
|
* })
|
|
358
382
|
*/
|
|
359
383
|
delete(request, requestOptions) {
|
|
@@ -366,7 +390,7 @@ export class LinksClient {
|
|
|
366
390
|
const _response = await core.fetcher({
|
|
367
391
|
url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
|
|
368
392
|
(await core.Supplier.get(this._options.environment)) ??
|
|
369
|
-
environments.ToltApiEnvironment.
|
|
393
|
+
environments.ToltApiEnvironment.Default, `v2/links/${core.url.encodePathParam(id)}`),
|
|
370
394
|
method: "DELETE",
|
|
371
395
|
headers: _headers,
|
|
372
396
|
queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
|
|
@@ -387,6 +411,8 @@ export class LinksClient {
|
|
|
387
411
|
throw new ToltApi.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
388
412
|
case 404:
|
|
389
413
|
throw new ToltApi.NotFoundError(_response.error.body, _response.rawResponse);
|
|
414
|
+
case 413:
|
|
415
|
+
throw new ToltApi.ContentTooLargeError(_response.error.body, _response.rawResponse);
|
|
390
416
|
case 429:
|
|
391
417
|
throw new ToltApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
392
418
|
default:
|
|
@@ -1,12 +1,16 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* @example
|
|
3
3
|
* {
|
|
4
|
-
* value: "
|
|
5
|
-
*
|
|
4
|
+
* value: "sam",
|
|
5
|
+
* param: "ref",
|
|
6
|
+
* partner_id: "part_NLYzgNKuSuASvrvoxNtau6SY"
|
|
6
7
|
* }
|
|
7
8
|
*/
|
|
8
9
|
export interface CreateLinksRequest {
|
|
10
|
+
/** Slug that identifies the partner in referral URLs, such as `sam` in `?ref=sam`, saved in lowercase. Pick one that no other link uses with the same parameter; a taken slug returns an error. */
|
|
9
11
|
value: string;
|
|
12
|
+
/** Query parameter of the link, e.g. `ref` in `?ref=sam`. Leave it out or send an empty string to use the program's first link parameter, which is what gets stored. */
|
|
10
13
|
param?: string;
|
|
14
|
+
/** Id of the partner who owns the link (part_...), as returned when listing partners. The link is created in that partner's program. */
|
|
11
15
|
partner_id: string;
|
|
12
16
|
}
|