@whop/sdk 0.0.33 → 0.0.35
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/CHANGELOG.md +33 -0
- package/client.d.mts +10 -4
- package/client.d.mts.map +1 -1
- package/client.d.ts +10 -4
- package/client.d.ts.map +1 -1
- package/client.js +6 -0
- package/client.js.map +1 -1
- package/client.mjs +6 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/affiliates/affiliates.d.mts +345 -0
- package/resources/affiliates/affiliates.d.mts.map +1 -0
- package/resources/affiliates/affiliates.d.ts +345 -0
- package/resources/affiliates/affiliates.d.ts.map +1 -0
- package/resources/affiliates/affiliates.js +112 -0
- package/resources/affiliates/affiliates.js.map +1 -0
- package/resources/affiliates/affiliates.mjs +107 -0
- package/resources/affiliates/affiliates.mjs.map +1 -0
- package/resources/affiliates/index.d.mts +3 -0
- package/resources/affiliates/index.d.mts.map +1 -0
- package/resources/affiliates/index.d.ts +3 -0
- package/resources/affiliates/index.d.ts.map +1 -0
- package/resources/affiliates/index.js +9 -0
- package/resources/affiliates/index.js.map +1 -0
- package/resources/affiliates/index.mjs +4 -0
- package/resources/affiliates/index.mjs.map +1 -0
- package/resources/affiliates/overrides.d.mts +443 -0
- package/resources/affiliates/overrides.d.mts.map +1 -0
- package/resources/affiliates/overrides.d.ts +443 -0
- package/resources/affiliates/overrides.d.ts.map +1 -0
- package/resources/affiliates/overrides.js +117 -0
- package/resources/affiliates/overrides.js.map +1 -0
- package/resources/affiliates/overrides.mjs +113 -0
- package/resources/affiliates/overrides.mjs.map +1 -0
- package/resources/affiliates.d.mts +2 -0
- package/resources/affiliates.d.mts.map +1 -0
- package/resources/affiliates.d.ts +2 -0
- package/resources/affiliates.d.ts.map +1 -0
- package/resources/affiliates.js +6 -0
- package/resources/affiliates.js.map +1 -0
- package/resources/affiliates.mjs +3 -0
- package/resources/affiliates.mjs.map +1 -0
- package/resources/ai-chats.d.mts +21 -2
- package/resources/ai-chats.d.mts.map +1 -1
- package/resources/ai-chats.d.ts +21 -2
- package/resources/ai-chats.d.ts.map +1 -1
- package/resources/ai-chats.js +2 -1
- package/resources/ai-chats.js.map +1 -1
- package/resources/ai-chats.mjs +2 -1
- package/resources/ai-chats.mjs.map +1 -1
- package/resources/index.d.mts +3 -2
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +3 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +4 -2
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/payments.d.mts +1 -1
- package/resources/payments.d.mts.map +1 -1
- package/resources/payments.d.ts +1 -1
- package/resources/payments.d.ts.map +1 -1
- package/resources/refunds.d.mts +15 -7
- package/resources/refunds.d.mts.map +1 -1
- package/resources/refunds.d.ts +15 -7
- package/resources/refunds.d.ts.map +1 -1
- package/resources/refunds.js +3 -3
- package/resources/refunds.js.map +1 -1
- package/resources/refunds.mjs +3 -3
- package/resources/refunds.mjs.map +1 -1
- package/resources/setup-intents.d.mts +74 -0
- package/resources/setup-intents.d.mts.map +1 -1
- package/resources/setup-intents.d.ts +74 -0
- package/resources/setup-intents.d.ts.map +1 -1
- package/resources/shared.d.mts +1 -1
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +1 -1
- package/resources/shared.d.ts.map +1 -1
- package/resources/users.d.mts +70 -1
- package/resources/users.d.mts.map +1 -1
- package/resources/users.d.ts +70 -1
- package/resources/users.d.ts.map +1 -1
- package/resources/users.js +8 -0
- package/resources/users.js.map +1 -1
- package/resources/users.mjs +8 -0
- package/resources/users.mjs.map +1 -1
- package/src/client.ts +36 -0
- package/src/resources/affiliates/affiliates.ts +467 -0
- package/src/resources/affiliates/index.ts +32 -0
- package/src/resources/affiliates/overrides.ts +585 -0
- package/src/resources/affiliates.ts +3 -0
- package/src/resources/ai-chats.ts +25 -1
- package/src/resources/index.ts +15 -0
- package/src/resources/payments.ts +1 -0
- package/src/resources/refunds.ts +17 -7
- package/src/resources/setup-intents.ts +90 -0
- package/src/resources/shared.ts +1 -0
- package/src/resources/users.ts +90 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -0,0 +1,443 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../../core/api-promise.mjs";
|
|
3
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagination.mjs";
|
|
4
|
+
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* Affiliates
|
|
7
|
+
*/
|
|
8
|
+
export declare class Overrides extends APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Creates a commission override for an affiliate.
|
|
11
|
+
*
|
|
12
|
+
* Required permissions:
|
|
13
|
+
*
|
|
14
|
+
* - `affiliate:create`
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```ts
|
|
18
|
+
* const override = await client.affiliates.overrides.create(
|
|
19
|
+
* 'aff_xxxxxxxxxxxxxx',
|
|
20
|
+
* {
|
|
21
|
+
* id: 'id',
|
|
22
|
+
* commission_value: 6.9,
|
|
23
|
+
* override_type: 'standard',
|
|
24
|
+
* plan_id: 'plan_xxxxxxxxxxxxx',
|
|
25
|
+
* },
|
|
26
|
+
* );
|
|
27
|
+
* ```
|
|
28
|
+
*/
|
|
29
|
+
create(id: string, body: OverrideCreateParams, options?: RequestOptions): APIPromise<OverrideCreateResponse>;
|
|
30
|
+
/**
|
|
31
|
+
* Retrieves the details of a specific affiliate override.
|
|
32
|
+
*
|
|
33
|
+
* Required permissions:
|
|
34
|
+
*
|
|
35
|
+
* - `affiliate:basic:read`
|
|
36
|
+
*
|
|
37
|
+
* @example
|
|
38
|
+
* ```ts
|
|
39
|
+
* const override = await client.affiliates.overrides.retrieve(
|
|
40
|
+
* 'override_id',
|
|
41
|
+
* { id: 'aff_xxxxxxxxxxxxxx' },
|
|
42
|
+
* );
|
|
43
|
+
* ```
|
|
44
|
+
*/
|
|
45
|
+
retrieve(overrideID: string, params: OverrideRetrieveParams, options?: RequestOptions): APIPromise<OverrideRetrieveResponse>;
|
|
46
|
+
/**
|
|
47
|
+
* Updates an existing affiliate override.
|
|
48
|
+
*
|
|
49
|
+
* Required permissions:
|
|
50
|
+
*
|
|
51
|
+
* - `affiliate:update`
|
|
52
|
+
*
|
|
53
|
+
* @example
|
|
54
|
+
* ```ts
|
|
55
|
+
* const override = await client.affiliates.overrides.update(
|
|
56
|
+
* 'override_id',
|
|
57
|
+
* { id: 'aff_xxxxxxxxxxxxxx' },
|
|
58
|
+
* );
|
|
59
|
+
* ```
|
|
60
|
+
*/
|
|
61
|
+
update(overrideID: string, params: OverrideUpdateParams, options?: RequestOptions): APIPromise<OverrideUpdateResponse>;
|
|
62
|
+
/**
|
|
63
|
+
* Returns a paginated list of overrides for an affiliate.
|
|
64
|
+
*
|
|
65
|
+
* Required permissions:
|
|
66
|
+
*
|
|
67
|
+
* - `affiliate:basic:read`
|
|
68
|
+
*
|
|
69
|
+
* @example
|
|
70
|
+
* ```ts
|
|
71
|
+
* // Automatically fetches more pages as needed.
|
|
72
|
+
* for await (const overrideListResponse of client.affiliates.overrides.list(
|
|
73
|
+
* 'aff_xxxxxxxxxxxxxx',
|
|
74
|
+
* )) {
|
|
75
|
+
* // ...
|
|
76
|
+
* }
|
|
77
|
+
* ```
|
|
78
|
+
*/
|
|
79
|
+
list(id: string, query?: OverrideListParams | null | undefined, options?: RequestOptions): PagePromise<OverrideListResponsesCursorPage, OverrideListResponse>;
|
|
80
|
+
/**
|
|
81
|
+
* Deletes an affiliate override.
|
|
82
|
+
*
|
|
83
|
+
* Required permissions:
|
|
84
|
+
*
|
|
85
|
+
* - `affiliate:update`
|
|
86
|
+
*
|
|
87
|
+
* @example
|
|
88
|
+
* ```ts
|
|
89
|
+
* const override = await client.affiliates.overrides.delete(
|
|
90
|
+
* 'override_id',
|
|
91
|
+
* { id: 'aff_xxxxxxxxxxxxxx' },
|
|
92
|
+
* );
|
|
93
|
+
* ```
|
|
94
|
+
*/
|
|
95
|
+
delete(overrideID: string, params: OverrideDeleteParams, options?: RequestOptions): APIPromise<OverrideDeleteResponse>;
|
|
96
|
+
}
|
|
97
|
+
export type OverrideListResponsesCursorPage = CursorPage<OverrideListResponse>;
|
|
98
|
+
/**
|
|
99
|
+
* Whether the affiliate commission applies to the first payment or all payments
|
|
100
|
+
*/
|
|
101
|
+
export type AffiliateAppliesToPayments = 'first_payment' | 'all_payments';
|
|
102
|
+
/**
|
|
103
|
+
* Whether a rev-share override applies to a single product or all products
|
|
104
|
+
*/
|
|
105
|
+
export type AffiliateAppliesToProducts = 'single_product' | 'all_products';
|
|
106
|
+
/**
|
|
107
|
+
* The role of an affiliate override (standard or rev_share)
|
|
108
|
+
*/
|
|
109
|
+
export type AffiliateOverrideRoles = 'standard' | 'rev_share';
|
|
110
|
+
/**
|
|
111
|
+
* The types of payouts an affiliate can have
|
|
112
|
+
*/
|
|
113
|
+
export type AffiliatePayoutTypes = 'percentage' | 'flat_fee';
|
|
114
|
+
/**
|
|
115
|
+
* The calculation method for affiliate rev-share percentages
|
|
116
|
+
*/
|
|
117
|
+
export type AffiliateRevenueBases = 'pre_fees' | 'post_fees';
|
|
118
|
+
/**
|
|
119
|
+
* An object storing information about the affiliate
|
|
120
|
+
*/
|
|
121
|
+
export interface OverrideCreateResponse {
|
|
122
|
+
/**
|
|
123
|
+
* The unique identifier for the affiliate override.
|
|
124
|
+
*/
|
|
125
|
+
id: string;
|
|
126
|
+
/**
|
|
127
|
+
* Whether the affiliate commission applies to the first payment or all payments
|
|
128
|
+
*/
|
|
129
|
+
applies_to_payments: AffiliateAppliesToPayments | null;
|
|
130
|
+
/**
|
|
131
|
+
* Whether a rev-share override applies to a single product or all products
|
|
132
|
+
*/
|
|
133
|
+
applies_to_products: AffiliateAppliesToProducts | null;
|
|
134
|
+
/**
|
|
135
|
+
* The checkout direct link for referrals (standard overrides only).
|
|
136
|
+
*/
|
|
137
|
+
checkout_direct_link: string | null;
|
|
138
|
+
/**
|
|
139
|
+
* The type of commission (percentage or flat_fee).
|
|
140
|
+
*/
|
|
141
|
+
commission_type: AffiliatePayoutTypes;
|
|
142
|
+
/**
|
|
143
|
+
* The commission value (percentage 1-100 or flat fee in dollars).
|
|
144
|
+
*/
|
|
145
|
+
commission_value: number;
|
|
146
|
+
/**
|
|
147
|
+
* The type of override (standard or rev_share).
|
|
148
|
+
*/
|
|
149
|
+
override_type: AffiliateOverrideRoles;
|
|
150
|
+
/**
|
|
151
|
+
* The plan ID (for standard overrides).
|
|
152
|
+
*/
|
|
153
|
+
plan_id: string | null;
|
|
154
|
+
/**
|
|
155
|
+
* The product page direct link for referrals (standard overrides only).
|
|
156
|
+
*/
|
|
157
|
+
product_direct_link: string | null;
|
|
158
|
+
/**
|
|
159
|
+
* The product ID (for rev-share overrides).
|
|
160
|
+
*/
|
|
161
|
+
product_id: string | null;
|
|
162
|
+
/**
|
|
163
|
+
* The calculation method for affiliate rev-share percentages
|
|
164
|
+
*/
|
|
165
|
+
revenue_basis: AffiliateRevenueBases | null;
|
|
166
|
+
/**
|
|
167
|
+
* The total earnings paid to this affiliate for referrals to this specific plan,
|
|
168
|
+
* in USD.
|
|
169
|
+
*/
|
|
170
|
+
total_referral_earnings_usd: number;
|
|
171
|
+
}
|
|
172
|
+
/**
|
|
173
|
+
* An object storing information about the affiliate
|
|
174
|
+
*/
|
|
175
|
+
export interface OverrideRetrieveResponse {
|
|
176
|
+
/**
|
|
177
|
+
* The unique identifier for the affiliate override.
|
|
178
|
+
*/
|
|
179
|
+
id: string;
|
|
180
|
+
/**
|
|
181
|
+
* Whether the affiliate commission applies to the first payment or all payments
|
|
182
|
+
*/
|
|
183
|
+
applies_to_payments: AffiliateAppliesToPayments | null;
|
|
184
|
+
/**
|
|
185
|
+
* Whether a rev-share override applies to a single product or all products
|
|
186
|
+
*/
|
|
187
|
+
applies_to_products: AffiliateAppliesToProducts | null;
|
|
188
|
+
/**
|
|
189
|
+
* The checkout direct link for referrals (standard overrides only).
|
|
190
|
+
*/
|
|
191
|
+
checkout_direct_link: string | null;
|
|
192
|
+
/**
|
|
193
|
+
* The type of commission (percentage or flat_fee).
|
|
194
|
+
*/
|
|
195
|
+
commission_type: AffiliatePayoutTypes;
|
|
196
|
+
/**
|
|
197
|
+
* The commission value (percentage 1-100 or flat fee in dollars).
|
|
198
|
+
*/
|
|
199
|
+
commission_value: number;
|
|
200
|
+
/**
|
|
201
|
+
* The type of override (standard or rev_share).
|
|
202
|
+
*/
|
|
203
|
+
override_type: AffiliateOverrideRoles;
|
|
204
|
+
/**
|
|
205
|
+
* The plan ID (for standard overrides).
|
|
206
|
+
*/
|
|
207
|
+
plan_id: string | null;
|
|
208
|
+
/**
|
|
209
|
+
* The product page direct link for referrals (standard overrides only).
|
|
210
|
+
*/
|
|
211
|
+
product_direct_link: string | null;
|
|
212
|
+
/**
|
|
213
|
+
* The product ID (for rev-share overrides).
|
|
214
|
+
*/
|
|
215
|
+
product_id: string | null;
|
|
216
|
+
/**
|
|
217
|
+
* The calculation method for affiliate rev-share percentages
|
|
218
|
+
*/
|
|
219
|
+
revenue_basis: AffiliateRevenueBases | null;
|
|
220
|
+
/**
|
|
221
|
+
* The total earnings paid to this affiliate for referrals to this specific plan,
|
|
222
|
+
* in USD.
|
|
223
|
+
*/
|
|
224
|
+
total_referral_earnings_usd: number;
|
|
225
|
+
}
|
|
226
|
+
/**
|
|
227
|
+
* An object storing information about the affiliate
|
|
228
|
+
*/
|
|
229
|
+
export interface OverrideUpdateResponse {
|
|
230
|
+
/**
|
|
231
|
+
* The unique identifier for the affiliate override.
|
|
232
|
+
*/
|
|
233
|
+
id: string;
|
|
234
|
+
/**
|
|
235
|
+
* Whether the affiliate commission applies to the first payment or all payments
|
|
236
|
+
*/
|
|
237
|
+
applies_to_payments: AffiliateAppliesToPayments | null;
|
|
238
|
+
/**
|
|
239
|
+
* Whether a rev-share override applies to a single product or all products
|
|
240
|
+
*/
|
|
241
|
+
applies_to_products: AffiliateAppliesToProducts | null;
|
|
242
|
+
/**
|
|
243
|
+
* The checkout direct link for referrals (standard overrides only).
|
|
244
|
+
*/
|
|
245
|
+
checkout_direct_link: string | null;
|
|
246
|
+
/**
|
|
247
|
+
* The type of commission (percentage or flat_fee).
|
|
248
|
+
*/
|
|
249
|
+
commission_type: AffiliatePayoutTypes;
|
|
250
|
+
/**
|
|
251
|
+
* The commission value (percentage 1-100 or flat fee in dollars).
|
|
252
|
+
*/
|
|
253
|
+
commission_value: number;
|
|
254
|
+
/**
|
|
255
|
+
* The type of override (standard or rev_share).
|
|
256
|
+
*/
|
|
257
|
+
override_type: AffiliateOverrideRoles;
|
|
258
|
+
/**
|
|
259
|
+
* The plan ID (for standard overrides).
|
|
260
|
+
*/
|
|
261
|
+
plan_id: string | null;
|
|
262
|
+
/**
|
|
263
|
+
* The product page direct link for referrals (standard overrides only).
|
|
264
|
+
*/
|
|
265
|
+
product_direct_link: string | null;
|
|
266
|
+
/**
|
|
267
|
+
* The product ID (for rev-share overrides).
|
|
268
|
+
*/
|
|
269
|
+
product_id: string | null;
|
|
270
|
+
/**
|
|
271
|
+
* The calculation method for affiliate rev-share percentages
|
|
272
|
+
*/
|
|
273
|
+
revenue_basis: AffiliateRevenueBases | null;
|
|
274
|
+
/**
|
|
275
|
+
* The total earnings paid to this affiliate for referrals to this specific plan,
|
|
276
|
+
* in USD.
|
|
277
|
+
*/
|
|
278
|
+
total_referral_earnings_usd: number;
|
|
279
|
+
}
|
|
280
|
+
/**
|
|
281
|
+
* An object storing information about the affiliate
|
|
282
|
+
*/
|
|
283
|
+
export interface OverrideListResponse {
|
|
284
|
+
/**
|
|
285
|
+
* The unique identifier for the affiliate override.
|
|
286
|
+
*/
|
|
287
|
+
id: string;
|
|
288
|
+
/**
|
|
289
|
+
* Whether the affiliate commission applies to the first payment or all payments
|
|
290
|
+
*/
|
|
291
|
+
applies_to_payments: AffiliateAppliesToPayments | null;
|
|
292
|
+
/**
|
|
293
|
+
* Whether a rev-share override applies to a single product or all products
|
|
294
|
+
*/
|
|
295
|
+
applies_to_products: AffiliateAppliesToProducts | null;
|
|
296
|
+
/**
|
|
297
|
+
* The checkout direct link for referrals (standard overrides only).
|
|
298
|
+
*/
|
|
299
|
+
checkout_direct_link: string | null;
|
|
300
|
+
/**
|
|
301
|
+
* The type of commission (percentage or flat_fee).
|
|
302
|
+
*/
|
|
303
|
+
commission_type: AffiliatePayoutTypes;
|
|
304
|
+
/**
|
|
305
|
+
* The commission value (percentage 1-100 or flat fee in dollars).
|
|
306
|
+
*/
|
|
307
|
+
commission_value: number;
|
|
308
|
+
/**
|
|
309
|
+
* The type of override (standard or rev_share).
|
|
310
|
+
*/
|
|
311
|
+
override_type: AffiliateOverrideRoles;
|
|
312
|
+
/**
|
|
313
|
+
* The plan ID (for standard overrides).
|
|
314
|
+
*/
|
|
315
|
+
plan_id: string | null;
|
|
316
|
+
/**
|
|
317
|
+
* The product page direct link for referrals (standard overrides only).
|
|
318
|
+
*/
|
|
319
|
+
product_direct_link: string | null;
|
|
320
|
+
/**
|
|
321
|
+
* The product ID (for rev-share overrides).
|
|
322
|
+
*/
|
|
323
|
+
product_id: string | null;
|
|
324
|
+
/**
|
|
325
|
+
* The calculation method for affiliate rev-share percentages
|
|
326
|
+
*/
|
|
327
|
+
revenue_basis: AffiliateRevenueBases | null;
|
|
328
|
+
/**
|
|
329
|
+
* The total earnings paid to this affiliate for referrals to this specific plan,
|
|
330
|
+
* in USD.
|
|
331
|
+
*/
|
|
332
|
+
total_referral_earnings_usd: number;
|
|
333
|
+
}
|
|
334
|
+
/**
|
|
335
|
+
* Represents `true` or `false` values.
|
|
336
|
+
*/
|
|
337
|
+
export type OverrideDeleteResponse = boolean;
|
|
338
|
+
export type OverrideCreateParams = OverrideCreateParams.CreateAffiliateOverrideInputOverrideTypeStandard | OverrideCreateParams.CreateAffiliateOverrideInputOverrideTypeRevShare;
|
|
339
|
+
export declare namespace OverrideCreateParams {
|
|
340
|
+
interface CreateAffiliateOverrideInputOverrideTypeStandard {
|
|
341
|
+
/**
|
|
342
|
+
* The affiliate ID.
|
|
343
|
+
*/
|
|
344
|
+
id: string;
|
|
345
|
+
/**
|
|
346
|
+
* The commission value (percentage 1-100 or flat fee).
|
|
347
|
+
*/
|
|
348
|
+
commission_value: number;
|
|
349
|
+
override_type: 'standard';
|
|
350
|
+
/**
|
|
351
|
+
* The plan ID (required for standard overrides).
|
|
352
|
+
*/
|
|
353
|
+
plan_id: string;
|
|
354
|
+
/**
|
|
355
|
+
* Whether the affiliate commission applies to the first payment or all payments
|
|
356
|
+
*/
|
|
357
|
+
applies_to_payments?: AffiliateAppliesToPayments | null;
|
|
358
|
+
/**
|
|
359
|
+
* The types of payouts an affiliate can have
|
|
360
|
+
*/
|
|
361
|
+
commission_type?: AffiliatePayoutTypes | null;
|
|
362
|
+
}
|
|
363
|
+
interface CreateAffiliateOverrideInputOverrideTypeRevShare {
|
|
364
|
+
/**
|
|
365
|
+
* The affiliate ID.
|
|
366
|
+
*/
|
|
367
|
+
id: string;
|
|
368
|
+
/**
|
|
369
|
+
* The commission value (percentage 1-100 or flat fee).
|
|
370
|
+
*/
|
|
371
|
+
commission_value: number;
|
|
372
|
+
override_type: 'rev_share';
|
|
373
|
+
/**
|
|
374
|
+
* The types of payouts an affiliate can have
|
|
375
|
+
*/
|
|
376
|
+
commission_type?: AffiliatePayoutTypes | null;
|
|
377
|
+
/**
|
|
378
|
+
* The product ID (for rev-share overrides, omit for company-wide).
|
|
379
|
+
*/
|
|
380
|
+
product_id?: string | null;
|
|
381
|
+
/**
|
|
382
|
+
* The calculation method for affiliate rev-share percentages
|
|
383
|
+
*/
|
|
384
|
+
revenue_basis?: AffiliateRevenueBases | null;
|
|
385
|
+
}
|
|
386
|
+
}
|
|
387
|
+
export interface OverrideRetrieveParams {
|
|
388
|
+
/**
|
|
389
|
+
* The affiliate ID.
|
|
390
|
+
*/
|
|
391
|
+
id: string;
|
|
392
|
+
}
|
|
393
|
+
export interface OverrideUpdateParams {
|
|
394
|
+
/**
|
|
395
|
+
* Path param: The affiliate ID.
|
|
396
|
+
*/
|
|
397
|
+
id: string;
|
|
398
|
+
/**
|
|
399
|
+
* Body param: Whether the affiliate commission applies to the first payment or all
|
|
400
|
+
* payments
|
|
401
|
+
*/
|
|
402
|
+
applies_to_payments?: AffiliateAppliesToPayments | null;
|
|
403
|
+
/**
|
|
404
|
+
* Body param: The types of payouts an affiliate can have
|
|
405
|
+
*/
|
|
406
|
+
commission_type?: AffiliatePayoutTypes | null;
|
|
407
|
+
/**
|
|
408
|
+
* Body param: The commission value (percentage 1-100 or flat fee in dollars).
|
|
409
|
+
*/
|
|
410
|
+
commission_value?: number | null;
|
|
411
|
+
/**
|
|
412
|
+
* Body param: The calculation method for affiliate rev-share percentages
|
|
413
|
+
*/
|
|
414
|
+
revenue_basis?: AffiliateRevenueBases | null;
|
|
415
|
+
}
|
|
416
|
+
export interface OverrideListParams extends CursorPageParams {
|
|
417
|
+
/**
|
|
418
|
+
* Returns the elements in the list that come before the specified cursor.
|
|
419
|
+
*/
|
|
420
|
+
before?: string | null;
|
|
421
|
+
/**
|
|
422
|
+
* Returns the first _n_ elements from the list.
|
|
423
|
+
*/
|
|
424
|
+
first?: number | null;
|
|
425
|
+
/**
|
|
426
|
+
* Returns the last _n_ elements from the list.
|
|
427
|
+
*/
|
|
428
|
+
last?: number | null;
|
|
429
|
+
/**
|
|
430
|
+
* The role of an affiliate override (standard or rev_share)
|
|
431
|
+
*/
|
|
432
|
+
override_type?: AffiliateOverrideRoles | null;
|
|
433
|
+
}
|
|
434
|
+
export interface OverrideDeleteParams {
|
|
435
|
+
/**
|
|
436
|
+
* The affiliate ID.
|
|
437
|
+
*/
|
|
438
|
+
id: string;
|
|
439
|
+
}
|
|
440
|
+
export declare namespace Overrides {
|
|
441
|
+
export { type AffiliateAppliesToPayments as AffiliateAppliesToPayments, type AffiliateAppliesToProducts as AffiliateAppliesToProducts, type AffiliateOverrideRoles as AffiliateOverrideRoles, type AffiliatePayoutTypes as AffiliatePayoutTypes, type AffiliateRevenueBases as AffiliateRevenueBases, type OverrideCreateResponse as OverrideCreateResponse, type OverrideRetrieveResponse as OverrideRetrieveResponse, type OverrideUpdateResponse as OverrideUpdateResponse, type OverrideListResponse as OverrideListResponse, type OverrideDeleteResponse as OverrideDeleteResponse, type OverrideListResponsesCursorPage as OverrideListResponsesCursorPage, type OverrideCreateParams as OverrideCreateParams, type OverrideRetrieveParams as OverrideRetrieveParams, type OverrideUpdateParams as OverrideUpdateParams, type OverrideListParams as OverrideListParams, type OverrideDeleteParams as OverrideDeleteParams, };
|
|
442
|
+
}
|
|
443
|
+
//# sourceMappingURL=overrides.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"overrides.d.mts","sourceRoot":"","sources":["../../src/resources/affiliates/overrides.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CACN,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAKvC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAKrC;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,+BAA+B,EAAE,oBAAoB,CAAC;IAOrE;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;CAItC;AAED,MAAM,MAAM,+BAA+B,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,eAAe,GAAG,cAAc,CAAC;AAE1E;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,gBAAgB,GAAG,cAAc,CAAC;AAE3E;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,UAAU,GAAG,WAAW,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,YAAY,GAAG,UAAU,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,UAAU,GAAG,WAAW,CAAC;AAE7D;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,0BAA0B,GAAG,IAAI,CAAC;IAEvD;;OAEG;IACH,mBAAmB,EAAE,0BAA0B,GAAG,IAAI,CAAC;IAEvD;;OAEG;IACH,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,eAAe,EAAE,oBAAoB,CAAC;IAEtC;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,aAAa,EAAE,sBAAsB,CAAC;IAEtC;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,aAAa,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,2BAA2B,EAAE,MAAM,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,0BAA0B,GAAG,IAAI,CAAC;IAEvD;;OAEG;IACH,mBAAmB,EAAE,0BAA0B,GAAG,IAAI,CAAC;IAEvD;;OAEG;IACH,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,eAAe,EAAE,oBAAoB,CAAC;IAEtC;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,aAAa,EAAE,sBAAsB,CAAC;IAEtC;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,aAAa,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,2BAA2B,EAAE,MAAM,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,0BAA0B,GAAG,IAAI,CAAC;IAEvD;;OAEG;IACH,mBAAmB,EAAE,0BAA0B,GAAG,IAAI,CAAC;IAEvD;;OAEG;IACH,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,eAAe,EAAE,oBAAoB,CAAC;IAEtC;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,aAAa,EAAE,sBAAsB,CAAC;IAEtC;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,aAAa,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,2BAA2B,EAAE,MAAM,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,0BAA0B,GAAG,IAAI,CAAC;IAEvD;;OAEG;IACH,mBAAmB,EAAE,0BAA0B,GAAG,IAAI,CAAC;IAEvD;;OAEG;IACH,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,eAAe,EAAE,oBAAoB,CAAC;IAEtC;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,aAAa,EAAE,sBAAsB,CAAC;IAEtC;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,aAAa,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,2BAA2B,EAAE,MAAM,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,OAAO,CAAC;AAE7C,MAAM,MAAM,oBAAoB,GAC5B,oBAAoB,CAAC,gDAAgD,GACrE,oBAAoB,CAAC,gDAAgD,CAAC;AAE1E,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,UAAiB,gDAAgD;QAC/D;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB,aAAa,EAAE,UAAU,CAAC;QAE1B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,mBAAmB,CAAC,EAAE,0BAA0B,GAAG,IAAI,CAAC;QAExD;;WAEG;QACH,eAAe,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAC;KAC/C;IAED,UAAiB,gDAAgD;QAC/D;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB,aAAa,EAAE,WAAW,CAAC;QAE3B;;WAEG;QACH,eAAe,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAC;QAE9C;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,aAAa,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;KAC9C;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,mBAAmB,CAAC,EAAE,0BAA0B,GAAG,IAAI,CAAC;IAExD;;OAEG;IACH,eAAe,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,aAAa,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,aAAa,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;CAC/C;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
|