@paynow-gg/typescript-sdk 2.1.2 → 2.1.4
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/cjs/generated/management/client.d.ts +614 -75
- package/dist/cjs/generated/management/client.d.ts.map +1 -1
- package/dist/cjs/generated/management/client.js +675 -165
- package/dist/cjs/generated/management/client.js.map +1 -1
- package/dist/cjs/generated/management/types.d.ts +1426 -196
- package/dist/cjs/generated/management/types.d.ts.map +1 -1
- package/dist/cjs/generated/storefront/types.d.ts +4 -0
- package/dist/cjs/generated/storefront/types.d.ts.map +1 -1
- package/dist/esm/generated/management/client.d.ts +614 -75
- package/dist/esm/generated/management/client.d.ts.map +1 -1
- package/dist/esm/generated/management/client.js +674 -162
- package/dist/esm/generated/management/client.js.map +1 -1
- package/dist/esm/generated/management/types.d.ts +1426 -196
- package/dist/esm/generated/management/types.d.ts.map +1 -1
- package/dist/esm/generated/storefront/types.d.ts +4 -0
- package/dist/esm/generated/storefront/types.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -5,21 +5,49 @@ export class AffiliateLinksResource {
|
|
|
5
5
|
constructor(http) {
|
|
6
6
|
this.http = http;
|
|
7
7
|
}
|
|
8
|
+
/**
|
|
9
|
+
* Create affiliate link
|
|
10
|
+
*
|
|
11
|
+
* Creates a new affiliate link in the specified store.
|
|
12
|
+
*/
|
|
8
13
|
createAffiliateLink(body, opts) {
|
|
9
14
|
return this.http.request("POST", "/v1/stores/{storeId}/affiliate-links", {
|
|
10
15
|
body,
|
|
11
16
|
opts,
|
|
12
17
|
});
|
|
13
18
|
}
|
|
19
|
+
/**
|
|
20
|
+
* Delete affiliate link by ID
|
|
21
|
+
*
|
|
22
|
+
* Deletes an affiliate link by the ID for the specified store.
|
|
23
|
+
* @param affiliateLinkId The ID of the affiliate link.
|
|
24
|
+
*/
|
|
14
25
|
deleteAffiliateLink(affiliateLinkId, opts) {
|
|
15
26
|
return this.http.request("DELETE", "/v1/stores/{storeId}/affiliate-links/{affiliateLinkId}", { path: { affiliateLinkId }, opts });
|
|
16
27
|
}
|
|
28
|
+
/**
|
|
29
|
+
* Get affiliate link by ID
|
|
30
|
+
*
|
|
31
|
+
* Retrieves an affiliate link by the ID for the specified store.
|
|
32
|
+
* @param affiliateLinkId The ID of the affiliate link.
|
|
33
|
+
*/
|
|
17
34
|
getAffiliateLink(affiliateLinkId, opts) {
|
|
18
35
|
return this.http.request("GET", "/v1/stores/{storeId}/affiliate-links/{affiliateLinkId}", { path: { affiliateLinkId }, opts });
|
|
19
36
|
}
|
|
37
|
+
/**
|
|
38
|
+
* Get affiliate links
|
|
39
|
+
*
|
|
40
|
+
* Retrieves all affiliate links for the specified store.
|
|
41
|
+
*/
|
|
20
42
|
getAffiliateLinks(opts) {
|
|
21
43
|
return this.http.request("GET", "/v1/stores/{storeId}/affiliate-links", { opts });
|
|
22
44
|
}
|
|
45
|
+
/**
|
|
46
|
+
* Update affiliate link by ID
|
|
47
|
+
*
|
|
48
|
+
* Performs a delta update of an affiliate link by the ID for the specified store.
|
|
49
|
+
* @param affiliateLinkId The ID of the affiliate link.
|
|
50
|
+
*/
|
|
23
51
|
updateAffiliateLink(affiliateLinkId, body, opts) {
|
|
24
52
|
return this.http.request("PATCH", "/v1/stores/{storeId}/affiliate-links/{affiliateLinkId}", { path: { affiliateLinkId }, body, opts });
|
|
25
53
|
}
|
|
@@ -29,118 +57,66 @@ export class BansResource {
|
|
|
29
57
|
constructor(http) {
|
|
30
58
|
this.http = http;
|
|
31
59
|
}
|
|
32
|
-
checkForBanByIdentities(body, opts) {
|
|
33
|
-
return this.http.request("POST", "/v1/stores/{storeId}/bans/check", { body, opts });
|
|
34
|
-
}
|
|
35
|
-
createBan(body, opts) {
|
|
36
|
-
return this.http.request("POST", "/v1/stores/{storeId}/bans", { body, opts });
|
|
37
|
-
}
|
|
38
|
-
deleteBan(banId, opts) {
|
|
39
|
-
return this.http.request("DELETE", "/v1/stores/{storeId}/bans/{banId}", {
|
|
40
|
-
path: { banId },
|
|
41
|
-
opts,
|
|
42
|
-
});
|
|
43
|
-
}
|
|
44
|
-
getBan(banId, opts) {
|
|
45
|
-
return this.http.request("GET", "/v1/stores/{storeId}/bans/{banId}", {
|
|
46
|
-
path: { banId },
|
|
47
|
-
opts,
|
|
48
|
-
});
|
|
49
|
-
}
|
|
50
|
-
getBans(query, opts) {
|
|
51
|
-
return this.http.request("GET", "/v1/stores/{storeId}/bans", { query, opts });
|
|
52
|
-
}
|
|
53
|
-
updateBan(banId, body, opts) {
|
|
54
|
-
return this.http.request("PATCH", "/v1/stores/{storeId}/bans/{banId}", {
|
|
55
|
-
path: { banId },
|
|
56
|
-
body,
|
|
57
|
-
opts,
|
|
58
|
-
});
|
|
59
|
-
}
|
|
60
|
-
}
|
|
61
|
-
export class BillingResource {
|
|
62
|
-
http;
|
|
63
|
-
constructor(http) {
|
|
64
|
-
this.http = http;
|
|
65
|
-
}
|
|
66
|
-
/**
|
|
67
|
-
* Change subscription payment method
|
|
68
|
-
*
|
|
69
|
-
* Starts a session for the store owner to replace the card the subscription is billed to.
|
|
70
|
-
*/
|
|
71
|
-
changeSubscriptionPaymentMethod(opts) {
|
|
72
|
-
return this.http.request("POST", "/v1/stores/{storeId}/billing/payment-method/change", { opts });
|
|
73
|
-
}
|
|
74
60
|
/**
|
|
75
|
-
*
|
|
61
|
+
* Check for ban by identities
|
|
76
62
|
*
|
|
77
|
-
*
|
|
78
|
-
* carries a 'session_url' the store owner must complete.
|
|
63
|
+
* Checks whether any of the supplied identities are banned in the specified store.
|
|
79
64
|
*/
|
|
80
|
-
|
|
81
|
-
return this.http.request("POST", "/v1/stores/{storeId}/
|
|
65
|
+
checkForBanByIdentities(body, opts) {
|
|
66
|
+
return this.http.request("POST", "/v1/stores/{storeId}/bans/check", { body, opts });
|
|
82
67
|
}
|
|
83
68
|
/**
|
|
84
|
-
*
|
|
69
|
+
* Create ban
|
|
85
70
|
*
|
|
86
|
-
*
|
|
71
|
+
* Creates a new ban in the specified store.
|
|
87
72
|
*/
|
|
88
|
-
|
|
89
|
-
return this.http.request("POST", "/v1/stores/{storeId}/
|
|
73
|
+
createBan(body, opts) {
|
|
74
|
+
return this.http.request("POST", "/v1/stores/{storeId}/bans", { body, opts });
|
|
90
75
|
}
|
|
91
76
|
/**
|
|
92
|
-
*
|
|
77
|
+
* Delete ban by ID
|
|
93
78
|
*
|
|
94
|
-
*
|
|
79
|
+
* Deletes a ban by the ID for the specified store.
|
|
80
|
+
* @param banId The ID of the ban.
|
|
95
81
|
*/
|
|
96
|
-
|
|
97
|
-
return this.http.request("
|
|
82
|
+
deleteBan(banId, opts) {
|
|
83
|
+
return this.http.request("DELETE", "/v1/stores/{storeId}/bans/{banId}", {
|
|
84
|
+
path: { banId },
|
|
98
85
|
opts,
|
|
99
86
|
});
|
|
100
87
|
}
|
|
101
88
|
/**
|
|
102
|
-
* Get
|
|
103
|
-
*
|
|
104
|
-
* Retrieves the billing address and tax details the store is invoiced under.
|
|
105
|
-
*/
|
|
106
|
-
getStoreBillingDetails(opts) {
|
|
107
|
-
return this.http.request("GET", "/v1/stores/{storeId}/billing/details", { opts });
|
|
108
|
-
}
|
|
109
|
-
/**
|
|
110
|
-
* Get billing status
|
|
89
|
+
* Get ban by ID
|
|
111
90
|
*
|
|
112
|
-
* Retrieves
|
|
91
|
+
* Retrieves a ban by the ID for the specified store.
|
|
92
|
+
* @param banId The ID of the ban.
|
|
113
93
|
*/
|
|
114
|
-
|
|
115
|
-
return this.http.request("GET", "/v1/stores/{storeId}/
|
|
94
|
+
getBan(banId, opts) {
|
|
95
|
+
return this.http.request("GET", "/v1/stores/{storeId}/bans/{banId}", {
|
|
96
|
+
path: { banId },
|
|
116
97
|
opts,
|
|
117
98
|
});
|
|
118
99
|
}
|
|
119
100
|
/**
|
|
120
|
-
* Get
|
|
101
|
+
* Get bans
|
|
121
102
|
*
|
|
122
|
-
* Retrieves
|
|
103
|
+
* Retrieves all bans for the specified store.
|
|
123
104
|
*/
|
|
124
|
-
|
|
125
|
-
return this.http.request("GET", "/v1/stores/{storeId}/
|
|
126
|
-
}
|
|
127
|
-
/**
|
|
128
|
-
* Get invoice URL
|
|
129
|
-
*
|
|
130
|
-
* Issues a fresh link to the hosted invoice. Prefer this over the 'invoice_url' carried by
|
|
131
|
-
* the invoice list, which is recorded once and may have expired.
|
|
132
|
-
* @param invoiceId The ID of the invoice to link to.
|
|
133
|
-
*/
|
|
134
|
-
getStoreInvoiceUrl(invoiceId, opts) {
|
|
135
|
-
return this.http.request("GET", "/v1/stores/{storeId}/billing/invoices/{invoiceId}/url", { path: { invoiceId }, opts });
|
|
105
|
+
getBans(query, opts) {
|
|
106
|
+
return this.http.request("GET", "/v1/stores/{storeId}/bans", { query, opts });
|
|
136
107
|
}
|
|
137
108
|
/**
|
|
138
|
-
* Update
|
|
109
|
+
* Update ban by ID
|
|
139
110
|
*
|
|
140
|
-
*
|
|
111
|
+
* Updates a ban by the ID for the specified store.
|
|
112
|
+
* @param banId The ID of the ban.
|
|
141
113
|
*/
|
|
142
|
-
|
|
143
|
-
return this.http.request("
|
|
114
|
+
updateBan(banId, body, opts) {
|
|
115
|
+
return this.http.request("PATCH", "/v1/stores/{storeId}/bans/{banId}", {
|
|
116
|
+
path: { banId },
|
|
117
|
+
body,
|
|
118
|
+
opts,
|
|
119
|
+
});
|
|
144
120
|
}
|
|
145
121
|
}
|
|
146
122
|
export class CheckoutResource {
|
|
@@ -214,40 +190,56 @@ export class CouponsResource {
|
|
|
214
190
|
constructor(http) {
|
|
215
191
|
this.http = http;
|
|
216
192
|
}
|
|
217
|
-
|
|
193
|
+
/**
|
|
194
|
+
* Create coupon
|
|
195
|
+
*
|
|
196
|
+
* Creates a new coupon in the specified store.
|
|
197
|
+
*/
|
|
198
|
+
createCoupon(body, opts) {
|
|
218
199
|
return this.http.request("POST", "/v1/stores/{storeId}/coupons", { body, opts });
|
|
219
200
|
}
|
|
220
201
|
/**
|
|
221
|
-
*
|
|
202
|
+
* Delete coupon by ID
|
|
203
|
+
*
|
|
204
|
+
* Deletes a coupon by the ID for the specified store.
|
|
205
|
+
* @param couponId The ID of the coupon.
|
|
222
206
|
*/
|
|
223
|
-
|
|
207
|
+
deleteCoupon(couponId, opts) {
|
|
224
208
|
return this.http.request("DELETE", "/v1/stores/{storeId}/coupons/{couponId}", {
|
|
225
209
|
path: { couponId },
|
|
226
210
|
opts,
|
|
227
211
|
});
|
|
228
212
|
}
|
|
229
213
|
/**
|
|
230
|
-
*
|
|
214
|
+
* Get coupon by ID
|
|
215
|
+
*
|
|
216
|
+
* Retrieves a coupon by the ID for the specified store.
|
|
217
|
+
* @param couponId The ID of the coupon.
|
|
231
218
|
*/
|
|
232
|
-
|
|
219
|
+
getCouponById(couponId, opts) {
|
|
233
220
|
return this.http.request("GET", "/v1/stores/{storeId}/coupons/{couponId}", {
|
|
234
221
|
path: { couponId },
|
|
235
222
|
opts,
|
|
236
223
|
});
|
|
237
224
|
}
|
|
238
225
|
/**
|
|
239
|
-
*
|
|
226
|
+
* Get coupons
|
|
227
|
+
*
|
|
228
|
+
* Retrieves all coupons for the specified store.
|
|
240
229
|
*/
|
|
241
|
-
|
|
230
|
+
getCoupons(query, opts) {
|
|
242
231
|
return this.http.request("GET", "/v1/stores/{storeId}/coupons", {
|
|
243
232
|
query,
|
|
244
233
|
opts,
|
|
245
234
|
});
|
|
246
235
|
}
|
|
247
236
|
/**
|
|
248
|
-
*
|
|
237
|
+
* Update coupon by ID
|
|
238
|
+
*
|
|
239
|
+
* Performs a delta update of a coupon by the ID for the specified store.
|
|
240
|
+
* @param couponId The ID of the coupon.
|
|
249
241
|
*/
|
|
250
|
-
|
|
242
|
+
updateCoupon(couponId, body, opts) {
|
|
251
243
|
return this.http.request("PATCH", "/v1/stores/{storeId}/coupons/{couponId}", {
|
|
252
244
|
path: { couponId },
|
|
253
245
|
body,
|
|
@@ -354,6 +346,7 @@ export class CustomersResource {
|
|
|
354
346
|
* Update customer
|
|
355
347
|
*
|
|
356
348
|
* Updates an existing customer based on the fields passed.
|
|
349
|
+
* @param customerId The ID of the customer.
|
|
357
350
|
*/
|
|
358
351
|
updateCustomer(customerId, body, opts) {
|
|
359
352
|
return this.http.request("PATCH", "/v1/stores/{storeId}/customers/{customerId}", {
|
|
@@ -374,7 +367,7 @@ export class CustomVariablesResource {
|
|
|
374
367
|
* Creates a new custom variable for the specified store.
|
|
375
368
|
* Custom variables allow customers to provide additional input when purchasing products.
|
|
376
369
|
*/
|
|
377
|
-
|
|
370
|
+
createCustomVariable(body, opts) {
|
|
378
371
|
return this.http.request("POST", "/v1/stores/{storeId}/custom-variables", {
|
|
379
372
|
body,
|
|
380
373
|
opts,
|
|
@@ -387,7 +380,7 @@ export class CustomVariablesResource {
|
|
|
387
380
|
* This will also delete all associated options and cannot be undone.
|
|
388
381
|
* @param customVariableId The ID of the custom variable to delete.
|
|
389
382
|
*/
|
|
390
|
-
|
|
383
|
+
deleteCustomVariable(customVariableId, opts) {
|
|
391
384
|
return this.http.request("DELETE", "/v1/stores/{storeId}/custom-variables/{customVariableId}", { path: { customVariableId }, opts });
|
|
392
385
|
}
|
|
393
386
|
/**
|
|
@@ -396,7 +389,7 @@ export class CustomVariablesResource {
|
|
|
396
389
|
* Retrieves a specific custom variable by ID from the specified store.
|
|
397
390
|
* @param customVariableId The ID of the custom variable to retrieve.
|
|
398
391
|
*/
|
|
399
|
-
|
|
392
|
+
getCustomVariableById(customVariableId, opts) {
|
|
400
393
|
return this.http.request("GET", "/v1/stores/{storeId}/custom-variables/{customVariableId}", { path: { customVariableId }, opts });
|
|
401
394
|
}
|
|
402
395
|
/**
|
|
@@ -404,7 +397,7 @@ export class CustomVariablesResource {
|
|
|
404
397
|
*
|
|
405
398
|
* Retrieves all custom variables for the specified store.
|
|
406
399
|
*/
|
|
407
|
-
|
|
400
|
+
getCustomVariables(opts) {
|
|
408
401
|
return this.http.request("GET", "/v1/stores/{storeId}/custom-variables", { opts });
|
|
409
402
|
}
|
|
410
403
|
/**
|
|
@@ -414,27 +407,20 @@ export class CustomVariablesResource {
|
|
|
414
407
|
* Only the fields specified in the request will be updated.
|
|
415
408
|
* @param customVariableId The ID of the custom variable to update.
|
|
416
409
|
*/
|
|
417
|
-
|
|
410
|
+
updateCustomVariable(customVariableId, body, opts) {
|
|
418
411
|
return this.http.request("PATCH", "/v1/stores/{storeId}/custom-variables/{customVariableId}", { path: { customVariableId }, body, opts });
|
|
419
412
|
}
|
|
420
413
|
}
|
|
421
|
-
export class DashboardResource {
|
|
422
|
-
http;
|
|
423
|
-
constructor(http) {
|
|
424
|
-
this.http = http;
|
|
425
|
-
}
|
|
426
|
-
getDashboardSearchHints(opts) {
|
|
427
|
-
return this.http.request("GET", "/v1/stores/{storeId}/dashboard/search-hints", { opts });
|
|
428
|
-
}
|
|
429
|
-
searchDashboard(query, opts) {
|
|
430
|
-
return this.http.request("GET", "/v1/stores/{storeId}/dashboard/search", { query, opts });
|
|
431
|
-
}
|
|
432
|
-
}
|
|
433
414
|
export class DataMigrationsResource {
|
|
434
415
|
http;
|
|
435
416
|
constructor(http) {
|
|
436
417
|
this.http = http;
|
|
437
418
|
}
|
|
419
|
+
/**
|
|
420
|
+
* Get data migrations
|
|
421
|
+
*
|
|
422
|
+
* Retrieves all data migration tasks for the specified store.
|
|
423
|
+
*/
|
|
438
424
|
getDataMigrations(query, opts) {
|
|
439
425
|
return this.http.request("GET", "/v1/stores/{storeId}/data-migrations", { query, opts });
|
|
440
426
|
}
|
|
@@ -451,6 +437,7 @@ export class DeliveryResource {
|
|
|
451
437
|
* Assign a delivery item to a customer
|
|
452
438
|
*
|
|
453
439
|
* Allows you to assign a delivery item to a customer
|
|
440
|
+
* @param customerId The ID of the customer to assign the delivery item to.
|
|
454
441
|
*/
|
|
455
442
|
assignDeliveryItem(customerId, body, opts) {
|
|
456
443
|
return this.http.request("POST", "/v1/stores/{storeId}/customers/{customerId}/delivery/items", { path: { customerId }, body, opts });
|
|
@@ -467,6 +454,7 @@ export class DeliveryResource {
|
|
|
467
454
|
* Get command attempts associated with a customer
|
|
468
455
|
*
|
|
469
456
|
* Retrieves command attempts associated with a customer
|
|
457
|
+
* @param customerId The ID of the customer.
|
|
470
458
|
*/
|
|
471
459
|
getCommandAttemptsForCustomer(customerId, query, opts) {
|
|
472
460
|
return this.http.request("GET", "/v1/stores/{storeId}/customers/{customerId}/delivery/commands", { path: { customerId }, query, opts });
|
|
@@ -475,12 +463,16 @@ export class DeliveryResource {
|
|
|
475
463
|
* Get delivery items associated with a customer
|
|
476
464
|
*
|
|
477
465
|
* Retrieves delivery items associated with a customer
|
|
466
|
+
* @param customerId The ID of the customer.
|
|
478
467
|
*/
|
|
479
468
|
getCustomerDeliveryItems(customerId, query, opts) {
|
|
480
469
|
return this.http.request("GET", "/v1/stores/{storeId}/customers/{customerId}/delivery/items", { path: { customerId }, query, opts });
|
|
481
470
|
}
|
|
482
471
|
/**
|
|
483
472
|
* Returns delivery items in which an associated command attempt is for the gameserver
|
|
473
|
+
*
|
|
474
|
+
* Retrieves all delivery items that have a command attempt targeting the game server.
|
|
475
|
+
* @param gameServerId The ID of the game server.
|
|
484
476
|
*/
|
|
485
477
|
getGameServerDeliveryItems(gameServerId, query, opts) {
|
|
486
478
|
return this.http.request("GET", "/v1/stores/{storeId}/gameservers/{gameServerId}/delivery/items", { path: { gameServerId }, query, opts });
|
|
@@ -507,6 +499,9 @@ export class DeliveryResource {
|
|
|
507
499
|
}
|
|
508
500
|
/**
|
|
509
501
|
* Resend commands for a given Gameserver
|
|
502
|
+
*
|
|
503
|
+
* Re-enqueues delivery commands for a game server, narrowed by the filters in the request body.
|
|
504
|
+
* @param gameServerId The ID of the game server.
|
|
510
505
|
*/
|
|
511
506
|
resendDeliveryCommandsForGameServer(gameServerId, body, opts) {
|
|
512
507
|
return this.http.request("POST", "/v1/stores/{storeId}/gameservers/{gameServerId}/delivery/commands/resend", { path: { gameServerId }, body, opts });
|
|
@@ -531,44 +526,123 @@ export class DiscordResource {
|
|
|
531
526
|
constructor(http) {
|
|
532
527
|
this.http = http;
|
|
533
528
|
}
|
|
529
|
+
/**
|
|
530
|
+
* Set product version Discord actions
|
|
531
|
+
*
|
|
532
|
+
* Replaces the Discord actions configured for a product version in the specified store.
|
|
533
|
+
* @param productVersionId The ID of the product version.
|
|
534
|
+
*/
|
|
534
535
|
createAction(productVersionId, body, opts) {
|
|
535
536
|
return this.http.request("PUT", "/v1/stores/{storeId}/product_versions/{productVersionId}/discord_actions", { path: { productVersionId }, body, opts });
|
|
536
537
|
}
|
|
538
|
+
/**
|
|
539
|
+
* Create Discord server link
|
|
540
|
+
*
|
|
541
|
+
* Creates a new link token that can be used to connect a Discord server to the specified store.
|
|
542
|
+
*/
|
|
537
543
|
createDiscordServerLink(opts) {
|
|
538
544
|
return this.http.request("POST", "/v1/stores/{storeId}/discord/links", {
|
|
539
545
|
opts,
|
|
540
546
|
});
|
|
541
547
|
}
|
|
548
|
+
/**
|
|
549
|
+
* Delete Discord server link
|
|
550
|
+
*
|
|
551
|
+
* Deletes a Discord server link by the token for the specified store.
|
|
552
|
+
* @param token The token of the Discord server link.
|
|
553
|
+
*/
|
|
542
554
|
deleteDiscordServerLinks(token, opts) {
|
|
543
|
-
return this.http.request("DELETE", "/v1/stores/{storeId}/discord/links/{token}", {
|
|
555
|
+
return this.http.request("DELETE", "/v1/stores/{storeId}/discord/links/{token}", {
|
|
556
|
+
path: { token },
|
|
557
|
+
opts,
|
|
558
|
+
});
|
|
544
559
|
}
|
|
560
|
+
/**
|
|
561
|
+
* Unlink Discord user from delivery item
|
|
562
|
+
*
|
|
563
|
+
* Removes the Discord user link from a delivery item in the specified store.
|
|
564
|
+
* @param inventoryItemId The ID of the delivery item.
|
|
565
|
+
*/
|
|
545
566
|
deleteUserToDeliveryItemLink(inventoryItemId, opts) {
|
|
546
567
|
return this.http.request("DELETE", "/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/link", { path: { inventoryItemId }, opts });
|
|
547
568
|
}
|
|
569
|
+
/**
|
|
570
|
+
* Get product version Discord actions
|
|
571
|
+
*
|
|
572
|
+
* Retrieves all Discord actions configured for a product version in the specified store.
|
|
573
|
+
* @param productVersionId The ID of the product version.
|
|
574
|
+
*/
|
|
548
575
|
getActions(productVersionId, opts) {
|
|
549
576
|
return this.http.request("GET", "/v1/stores/{storeId}/product_versions/{productVersionId}/discord_actions", { path: { productVersionId }, opts });
|
|
550
577
|
}
|
|
578
|
+
/**
|
|
579
|
+
* Get Discord action execution history
|
|
580
|
+
*
|
|
581
|
+
* Retrieves the history of Discord actions executed for an order in the specified store.
|
|
582
|
+
* @param orderId The ID of the order.
|
|
583
|
+
*/
|
|
551
584
|
getDiscordActionExecutionHistory(orderId, opts) {
|
|
552
585
|
return this.http.request("GET", "/v1/stores/{storeId}/orders/{orderId}/discord/queued", { path: { orderId }, opts });
|
|
553
586
|
}
|
|
587
|
+
/**
|
|
588
|
+
* Get Discord server links
|
|
589
|
+
*
|
|
590
|
+
* Retrieves all Discord server links for the specified store.
|
|
591
|
+
*/
|
|
554
592
|
getDiscordServerLinks(opts) {
|
|
555
593
|
return this.http.request("GET", "/v1/stores/{storeId}/discord/links", { opts });
|
|
556
594
|
}
|
|
595
|
+
/**
|
|
596
|
+
* Get Discord server roles
|
|
597
|
+
*
|
|
598
|
+
* Retrieves all roles for a Discord server linked to the specified store.
|
|
599
|
+
* @param discordServerId The ID of the Discord server.
|
|
600
|
+
*/
|
|
557
601
|
getDiscordServerRoles(discordServerId, opts) {
|
|
558
602
|
return this.http.request("GET", "/v1/stores/{storeId}/discord/{discordServerId}/roles", { path: { discordServerId }, opts });
|
|
559
603
|
}
|
|
604
|
+
/**
|
|
605
|
+
* Get Discord server text channels
|
|
606
|
+
*
|
|
607
|
+
* Retrieves all text channels for a Discord server linked to the specified store.
|
|
608
|
+
* @param discordServerId The ID of the Discord server.
|
|
609
|
+
*/
|
|
560
610
|
getDiscordServerTextChannels(discordServerId, opts) {
|
|
561
611
|
return this.http.request("GET", "/v1/stores/{storeId}/discord/{discordServerId}/discord/text_channels", { path: { discordServerId }, opts });
|
|
562
612
|
}
|
|
613
|
+
/**
|
|
614
|
+
* Get linked Discord accounts
|
|
615
|
+
*
|
|
616
|
+
* Retrieves the Discord accounts linked to an order for the specified store.
|
|
617
|
+
* @param orderId The ID of the order.
|
|
618
|
+
*/
|
|
563
619
|
getLinkedDiscordAccounts(orderId, opts) {
|
|
564
620
|
return this.http.request("GET", "/v1/stores/{storeId}/orders/{orderId}/discord", { path: { orderId }, opts });
|
|
565
621
|
}
|
|
622
|
+
/**
|
|
623
|
+
* Get queued Discord actions for delivery item
|
|
624
|
+
*
|
|
625
|
+
* Retrieves all queued Discord actions for a delivery item in the specified store.
|
|
626
|
+
* @param inventoryItemId The ID of the delivery item.
|
|
627
|
+
*/
|
|
566
628
|
getQueuedDiscordActionForDeliveryItem(inventoryItemId, opts) {
|
|
567
629
|
return this.http.request("GET", "/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/queued", { path: { inventoryItemId }, opts });
|
|
568
630
|
}
|
|
631
|
+
/**
|
|
632
|
+
* Get Discord user linked to delivery item
|
|
633
|
+
*
|
|
634
|
+
* Retrieves the Discord profile linked to a delivery item in the specified store.
|
|
635
|
+
* @param inventoryItemId The ID of the delivery item.
|
|
636
|
+
*/
|
|
569
637
|
getUserToDeliveryItemLinks(inventoryItemId, opts) {
|
|
570
638
|
return this.http.request("GET", "/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/link", { path: { inventoryItemId }, opts });
|
|
571
639
|
}
|
|
640
|
+
/**
|
|
641
|
+
* Link Discord user to delivery item
|
|
642
|
+
*
|
|
643
|
+
* Links a Discord user to a delivery item in the specified store.
|
|
644
|
+
* @param inventoryItemId The ID of the delivery item.
|
|
645
|
+
*/
|
|
572
646
|
setUserToDeliveryItemLink(inventoryItemId, query, opts) {
|
|
573
647
|
return this.http.request("PUT", "/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/link", { path: { inventoryItemId }, query, opts });
|
|
574
648
|
}
|
|
@@ -587,6 +661,12 @@ export class DownloadableFilesResource {
|
|
|
587
661
|
finishDownloadableFileUpload(productId, downloadableFileId, opts) {
|
|
588
662
|
return this.http.request("POST", "/v1/stores/{storeId}/products/{productId}/downloadable-files/{downloadableFileId}/finish", { path: { productId, downloadableFileId }, opts });
|
|
589
663
|
}
|
|
664
|
+
/**
|
|
665
|
+
* Get downloadable files
|
|
666
|
+
*
|
|
667
|
+
* Retrieves all downloadable files for a product in the specified store.
|
|
668
|
+
* @param productId The ID of the product.
|
|
669
|
+
*/
|
|
590
670
|
getDownloadableFiles(productId, opts) {
|
|
591
671
|
return this.http.request("GET", "/v1/stores/{storeId}/products/{productId}/downloadable-files", { path: { productId }, opts });
|
|
592
672
|
}
|
|
@@ -601,6 +681,8 @@ export class GameServersResource {
|
|
|
601
681
|
}
|
|
602
682
|
/**
|
|
603
683
|
* Create a new Game Server for a store
|
|
684
|
+
*
|
|
685
|
+
* Creates a new game server in the specified store.
|
|
604
686
|
*/
|
|
605
687
|
createGameServer(body, opts) {
|
|
606
688
|
return this.http.request("POST", "/v1/stores/{storeId}/gameservers", {
|
|
@@ -610,6 +692,9 @@ export class GameServersResource {
|
|
|
610
692
|
}
|
|
611
693
|
/**
|
|
612
694
|
* Create a console for a game server.
|
|
695
|
+
*
|
|
696
|
+
* Creates a new console for a game server in the specified store.
|
|
697
|
+
* @param gameServerId The ID of the game server.
|
|
613
698
|
*/
|
|
614
699
|
createGameServerConsole(gameServerId, body, opts) {
|
|
615
700
|
return this.http.request("POST", "/v1/stores/{storeId}/gameservers/{gameServerId}/console", { path: { gameServerId }, body, opts });
|
|
@@ -625,30 +710,44 @@ export class GameServersResource {
|
|
|
625
710
|
}
|
|
626
711
|
/**
|
|
627
712
|
* Delete an associated game server console.
|
|
713
|
+
*
|
|
714
|
+
* Deletes the console associated with a game server in the specified store.
|
|
715
|
+
* @param gameServerId The ID of the game server.
|
|
628
716
|
*/
|
|
629
717
|
deleteGameServerConsole(gameServerId, opts) {
|
|
630
718
|
return this.http.request("DELETE", "/v1/stores/{storeId}/gameservers/{gameServerId}/console", { path: { gameServerId }, opts });
|
|
631
719
|
}
|
|
632
720
|
/**
|
|
633
721
|
* Get a Game Server by ID for a store
|
|
722
|
+
*
|
|
723
|
+
* Retrieves a game server by the ID for the specified store.
|
|
724
|
+
* @param gameServerId The ID of the game server.
|
|
634
725
|
*/
|
|
635
726
|
getGameServer(gameServerId, opts) {
|
|
636
727
|
return this.http.request("GET", "/v1/stores/{storeId}/gameservers/{gameServerId}", { path: { gameServerId }, opts });
|
|
637
728
|
}
|
|
638
729
|
/**
|
|
639
730
|
* Get the associated console for a game server.
|
|
731
|
+
*
|
|
732
|
+
* Retrieves the console associated with a game server in the specified store.
|
|
733
|
+
* @param gameServerId The ID of the game server.
|
|
640
734
|
*/
|
|
641
735
|
getGameServerConsole(gameServerId, opts) {
|
|
642
736
|
return this.http.request("GET", "/v1/stores/{storeId}/gameservers/{gameServerId}/console", { path: { gameServerId }, opts });
|
|
643
737
|
}
|
|
644
738
|
/**
|
|
645
739
|
* Get console messages for a game server.
|
|
740
|
+
*
|
|
741
|
+
* Retrieves recent console messages for a game server in the specified store.
|
|
742
|
+
* @param gameServerId The ID of the game server.
|
|
646
743
|
*/
|
|
647
744
|
getGameServerConsoleMessages(gameServerId, opts) {
|
|
648
745
|
return this.http.request("GET", "/v1/stores/{storeId}/gameservers/{gameServerId}/console/messages", { path: { gameServerId }, opts });
|
|
649
746
|
}
|
|
650
747
|
/**
|
|
651
748
|
* Get Game Servers for a store
|
|
749
|
+
*
|
|
750
|
+
* Retrieves all game servers for the specified store.
|
|
652
751
|
*/
|
|
653
752
|
getGameServers(opts) {
|
|
654
753
|
return this.http.request("GET", "/v1/stores/{storeId}/gameservers", {
|
|
@@ -663,12 +762,18 @@ export class GameServersResource {
|
|
|
663
762
|
}
|
|
664
763
|
/**
|
|
665
764
|
* Update a Game Server By ID for a store
|
|
765
|
+
*
|
|
766
|
+
* Performs a delta update of a game server by the ID for the specified store.
|
|
767
|
+
* @param gameServerId The ID of the game server.
|
|
666
768
|
*/
|
|
667
769
|
updateGameServer(gameServerId, body, opts) {
|
|
668
770
|
return this.http.request("PATCH", "/v1/stores/{storeId}/gameservers/{gameServerId}", { path: { gameServerId }, body, opts });
|
|
669
771
|
}
|
|
670
772
|
/**
|
|
671
773
|
* Update a console for a game server.
|
|
774
|
+
*
|
|
775
|
+
* Performs a delta update of the console for a game server in the specified store.
|
|
776
|
+
* @param gameServerId The ID of the game server.
|
|
672
777
|
*/
|
|
673
778
|
updateGameServerConsole(gameServerId, body, opts) {
|
|
674
779
|
return this.http.request("PATCH", "/v1/stores/{storeId}/gameservers/{gameServerId}/console", { path: { gameServerId }, body, opts });
|
|
@@ -681,12 +786,17 @@ export class GiftcardsResource {
|
|
|
681
786
|
}
|
|
682
787
|
/**
|
|
683
788
|
* Create a Gift Card for a store
|
|
789
|
+
*
|
|
790
|
+
* Creates a new gift card in the specified store.
|
|
684
791
|
*/
|
|
685
792
|
createGiftCard(body, opts) {
|
|
686
793
|
return this.http.request("POST", "/v1/stores/{storeId}/giftcards", { body, opts });
|
|
687
794
|
}
|
|
688
795
|
/**
|
|
689
796
|
* Delete a Gift Card By ID for a store
|
|
797
|
+
*
|
|
798
|
+
* Deletes a gift card by the ID for the specified store.
|
|
799
|
+
* @param giftCardId The ID of the gift card.
|
|
690
800
|
*/
|
|
691
801
|
deleteGiftCard(giftCardId, opts) {
|
|
692
802
|
return this.http.request("DELETE", "/v1/stores/{storeId}/giftcards/{giftCardId}", {
|
|
@@ -696,6 +806,9 @@ export class GiftcardsResource {
|
|
|
696
806
|
}
|
|
697
807
|
/**
|
|
698
808
|
* Get a Gift Card By ID for a store
|
|
809
|
+
*
|
|
810
|
+
* Retrieves a gift card by the ID for the specified store.
|
|
811
|
+
* @param giftCardId The ID of the gift card.
|
|
699
812
|
*/
|
|
700
813
|
getGiftCard(giftCardId, opts) {
|
|
701
814
|
return this.http.request("GET", "/v1/stores/{storeId}/giftcards/{giftCardId}", {
|
|
@@ -705,6 +818,8 @@ export class GiftcardsResource {
|
|
|
705
818
|
}
|
|
706
819
|
/**
|
|
707
820
|
* Get Gift Cards for a store
|
|
821
|
+
*
|
|
822
|
+
* Retrieves all gift cards for the specified store.
|
|
708
823
|
*/
|
|
709
824
|
getGiftCards(query, opts) {
|
|
710
825
|
return this.http.request("GET", "/v1/stores/{storeId}/giftcards", {
|
|
@@ -714,6 +829,9 @@ export class GiftcardsResource {
|
|
|
714
829
|
}
|
|
715
830
|
/**
|
|
716
831
|
* Update a Gift Card By ID for a store
|
|
832
|
+
*
|
|
833
|
+
* Performs a delta update of a gift card by the ID for the specified store.
|
|
834
|
+
* @param giftCardId The ID of the gift card.
|
|
717
835
|
*/
|
|
718
836
|
updateGiftCard(giftCardId, body, opts) {
|
|
719
837
|
return this.http.request("PATCH", "/v1/stores/{storeId}/giftcards/{giftCardId}", {
|
|
@@ -760,6 +878,7 @@ export class GlobalCommandsResource {
|
|
|
760
878
|
* Update global command
|
|
761
879
|
*
|
|
762
880
|
* Updates a global command for a store.
|
|
881
|
+
* @param globalCommandId The ID of the global command.
|
|
763
882
|
*/
|
|
764
883
|
updateGlobalCommand(globalCommandId, body, opts) {
|
|
765
884
|
return this.http.request("PATCH", "/v1/stores/{storeId}/global-commands/{globalCommandId}", { path: { globalCommandId }, body, opts });
|
|
@@ -840,72 +959,153 @@ export class MarketingResource {
|
|
|
840
959
|
constructor(http) {
|
|
841
960
|
this.http = http;
|
|
842
961
|
}
|
|
962
|
+
/**
|
|
963
|
+
* Activate email template by ID
|
|
964
|
+
*
|
|
965
|
+
* Activates an email template by the ID for the specified store, so it is sent in place of the
|
|
966
|
+
* default template for its type.
|
|
967
|
+
* @param templateId The ID of the email template.
|
|
968
|
+
*/
|
|
843
969
|
activateEmailTemplate(templateId, opts) {
|
|
844
970
|
return this.http.request("POST", "/v1/stores/{storeId}/marketing/email/templates/{templateId}/activate", { path: { templateId }, opts });
|
|
845
971
|
}
|
|
972
|
+
/**
|
|
973
|
+
* Create email template
|
|
974
|
+
*
|
|
975
|
+
* Creates a new email template in the specified store.
|
|
976
|
+
*/
|
|
846
977
|
createEmailTemplate(body, opts) {
|
|
847
978
|
return this.http.request("POST", "/v1/stores/{storeId}/marketing/email/templates", { body, opts });
|
|
848
979
|
}
|
|
980
|
+
/**
|
|
981
|
+
* Deactivate email template by ID
|
|
982
|
+
*
|
|
983
|
+
* Deactivates an email template by the ID for the specified store, so the default template for
|
|
984
|
+
* its type is sent instead.
|
|
985
|
+
* @param templateId The ID of the email template.
|
|
986
|
+
*/
|
|
849
987
|
deactivateEmailTemplate(templateId, opts) {
|
|
850
988
|
return this.http.request("POST", "/v1/stores/{storeId}/marketing/email/templates/{templateId}/deactivate", { path: { templateId }, opts });
|
|
851
989
|
}
|
|
990
|
+
/**
|
|
991
|
+
* Deactivate email template by type
|
|
992
|
+
*
|
|
993
|
+
* Deactivates the active email template of the supplied type for the specified store.
|
|
994
|
+
*/
|
|
852
995
|
deactivateEmailTemplateByType(body, opts) {
|
|
853
996
|
return this.http.request("POST", "/v1/stores/{storeId}/marketing/email/templates/deactivate", { body, opts });
|
|
854
997
|
}
|
|
998
|
+
/**
|
|
999
|
+
* Delete email template by ID
|
|
1000
|
+
*
|
|
1001
|
+
* Deletes an email template by the ID for the specified store.
|
|
1002
|
+
* @param templateId The ID of the email template.
|
|
1003
|
+
*/
|
|
855
1004
|
deleteEmailTemplate(templateId, opts) {
|
|
856
1005
|
return this.http.request("DELETE", "/v1/stores/{storeId}/marketing/email/templates/{templateId}", { path: { templateId }, opts });
|
|
857
1006
|
}
|
|
858
1007
|
finishEmailBrandingImageUpload(body, opts) {
|
|
859
1008
|
return this.http.request("POST", "/v1/stores/{storeId}/marketing/email/branding/image-upload-finish", { body, opts });
|
|
860
1009
|
}
|
|
1010
|
+
/**
|
|
1011
|
+
* Get email branding
|
|
1012
|
+
*
|
|
1013
|
+
* Retrieves the email branding for the specified store.
|
|
1014
|
+
*/
|
|
861
1015
|
getEmailBranding(opts) {
|
|
862
1016
|
return this.http.request("GET", "/v1/stores/{storeId}/marketing/email/branding", { opts });
|
|
863
1017
|
}
|
|
864
1018
|
getEmailBrandingImageUploadUrl(query, opts) {
|
|
865
1019
|
return this.http.request("GET", "/v1/stores/{storeId}/marketing/email/branding/image-upload-url", { query, opts });
|
|
866
1020
|
}
|
|
1021
|
+
/**
|
|
1022
|
+
* Get email deliveries
|
|
1023
|
+
*
|
|
1024
|
+
* Retrieves all email deliveries for the specified store.
|
|
1025
|
+
*/
|
|
867
1026
|
getEmailDeliveries(query, opts) {
|
|
868
1027
|
return this.http.request("GET", "/v1/stores/{storeId}/marketing/email/deliveries", { query, opts });
|
|
869
1028
|
}
|
|
1029
|
+
/**
|
|
1030
|
+
* Get email delivery by ID
|
|
1031
|
+
*
|
|
1032
|
+
* Retrieves an email delivery by the ID for the specified store.
|
|
1033
|
+
* @param emailDeliveryId The ID of the email delivery.
|
|
1034
|
+
*/
|
|
870
1035
|
getEmailDelivery(emailDeliveryId, opts) {
|
|
871
1036
|
return this.http.request("GET", "/v1/stores/{storeId}/marketing/email/deliveries/{emailDeliveryId}", { path: { emailDeliveryId }, opts });
|
|
872
1037
|
}
|
|
1038
|
+
/**
|
|
1039
|
+
* Get email template by ID
|
|
1040
|
+
*
|
|
1041
|
+
* Retrieves an email template by the ID for the specified store.
|
|
1042
|
+
* @param templateId The ID of the email template.
|
|
1043
|
+
*/
|
|
873
1044
|
getEmailTemplate(templateId, opts) {
|
|
874
1045
|
return this.http.request("GET", "/v1/stores/{storeId}/marketing/email/templates/{templateId}", { path: { templateId }, opts });
|
|
875
1046
|
}
|
|
1047
|
+
/**
|
|
1048
|
+
* Get email template definitions
|
|
1049
|
+
*
|
|
1050
|
+
* Retrieves the email template definitions available to the specified store.
|
|
1051
|
+
*/
|
|
876
1052
|
getEmailTemplateDefinitions(opts) {
|
|
877
1053
|
return this.http.request("GET", "/v1/stores/{storeId}/marketing/email/template-definitions", { opts });
|
|
878
1054
|
}
|
|
1055
|
+
/**
|
|
1056
|
+
* Get email templates
|
|
1057
|
+
*
|
|
1058
|
+
* Retrieves all email templates for the specified store.
|
|
1059
|
+
*/
|
|
879
1060
|
getEmailTemplates(query, opts) {
|
|
880
1061
|
return this.http.request("GET", "/v1/stores/{storeId}/marketing/email/templates", { query, opts });
|
|
881
1062
|
}
|
|
882
1063
|
/**
|
|
883
1064
|
* Gets the abandoned checkout behaviour for a store
|
|
1065
|
+
*
|
|
1066
|
+
* Retrieves the abandoned checkout configuration for the specified store.
|
|
884
1067
|
*/
|
|
885
1068
|
getStoreAbandonedCheckoutConfigurationOptions(opts) {
|
|
886
1069
|
return this.http.request("GET", "/v1/stores/{storeId}/marketing/abandoned-checkouts/configuration", { opts });
|
|
887
1070
|
}
|
|
888
1071
|
/**
|
|
889
1072
|
* Gets the purchase follow up behaviour for a store
|
|
1073
|
+
*
|
|
1074
|
+
* Retrieves the purchase follow up configuration for the specified store.
|
|
890
1075
|
*/
|
|
891
1076
|
getStorePurchaseFollowUpConfigurationOptions(opts) {
|
|
892
1077
|
return this.http.request("GET", "/v1/stores/{storeId}/marketing/purchase-follow-ups/configuration", { opts });
|
|
893
1078
|
}
|
|
894
1079
|
/**
|
|
895
1080
|
* Sets the abandoned checkout behaviour for a store
|
|
1081
|
+
*
|
|
1082
|
+
* Updates the abandoned checkout configuration for the specified store.
|
|
896
1083
|
*/
|
|
897
1084
|
setStoreAbandonedCheckoutConfigurationOptions(body, opts) {
|
|
898
1085
|
return this.http.request("PUT", "/v1/stores/{storeId}/marketing/abandoned-checkouts/configuration", { body, opts });
|
|
899
1086
|
}
|
|
900
1087
|
/**
|
|
901
1088
|
* Sets the purchase follow up behaviour for a store
|
|
1089
|
+
*
|
|
1090
|
+
* Updates the purchase follow up configuration for the specified store.
|
|
902
1091
|
*/
|
|
903
1092
|
setStorePurchaseFollowUpConfigurationOptions(body, opts) {
|
|
904
1093
|
return this.http.request("PUT", "/v1/stores/{storeId}/marketing/purchase-follow-ups/configuration", { body, opts });
|
|
905
1094
|
}
|
|
1095
|
+
/**
|
|
1096
|
+
* Update email branding
|
|
1097
|
+
*
|
|
1098
|
+
* Performs a delta update of the email branding for the specified store.
|
|
1099
|
+
*/
|
|
906
1100
|
updateEmailBranding(body, opts) {
|
|
907
1101
|
return this.http.request("PATCH", "/v1/stores/{storeId}/marketing/email/branding", { body, opts });
|
|
908
1102
|
}
|
|
1103
|
+
/**
|
|
1104
|
+
* Update email template by ID
|
|
1105
|
+
*
|
|
1106
|
+
* Performs a delta update of an email template by the ID for the specified store.
|
|
1107
|
+
* @param templateId The ID of the email template.
|
|
1108
|
+
*/
|
|
909
1109
|
updateEmailTemplate(templateId, body, opts) {
|
|
910
1110
|
return this.http.request("PATCH", "/v1/stores/{storeId}/marketing/email/templates/{templateId}", { path: { templateId }, body, opts });
|
|
911
1111
|
}
|
|
@@ -917,12 +1117,17 @@ export class NavlinksResource {
|
|
|
917
1117
|
}
|
|
918
1118
|
/**
|
|
919
1119
|
* Create a new NavLink for a store
|
|
1120
|
+
*
|
|
1121
|
+
* Creates a new navigation link in the specified store.
|
|
920
1122
|
*/
|
|
921
1123
|
createNavLink(body, opts) {
|
|
922
1124
|
return this.http.request("POST", "/v1/stores/{storeId}/navlinks", { body, opts });
|
|
923
1125
|
}
|
|
924
1126
|
/**
|
|
925
1127
|
* Delete a NavLink for a store
|
|
1128
|
+
*
|
|
1129
|
+
* Deletes a navigation link by the ID for the specified store.
|
|
1130
|
+
* @param navLinkId The ID of the navigation link.
|
|
926
1131
|
*/
|
|
927
1132
|
deleteNavLink(navLinkId, opts) {
|
|
928
1133
|
return this.http.request("DELETE", "/v1/stores/{storeId}/navlinks/{navLinkId}", {
|
|
@@ -932,6 +1137,9 @@ export class NavlinksResource {
|
|
|
932
1137
|
}
|
|
933
1138
|
/**
|
|
934
1139
|
* Get a NavLink by ID for a store
|
|
1140
|
+
*
|
|
1141
|
+
* Retrieves a navigation link by the ID for the specified store.
|
|
1142
|
+
* @param navLinkId The ID of the navigation link.
|
|
935
1143
|
*/
|
|
936
1144
|
getNavLink(navLinkId, opts) {
|
|
937
1145
|
return this.http.request("GET", "/v1/stores/{storeId}/navlinks/{navLinkId}", {
|
|
@@ -941,12 +1149,17 @@ export class NavlinksResource {
|
|
|
941
1149
|
}
|
|
942
1150
|
/**
|
|
943
1151
|
* Get all NavLinks for a store
|
|
1152
|
+
*
|
|
1153
|
+
* Retrieves all navigation links for the specified store.
|
|
944
1154
|
*/
|
|
945
1155
|
getNavLinks(opts) {
|
|
946
1156
|
return this.http.request("GET", "/v1/stores/{storeId}/navlinks", { opts });
|
|
947
1157
|
}
|
|
948
1158
|
/**
|
|
949
1159
|
* Update a NavLink By ID for a store
|
|
1160
|
+
*
|
|
1161
|
+
* Performs a delta update of a navigation link by the ID for the specified store.
|
|
1162
|
+
* @param navLinkId The ID of the navigation link.
|
|
950
1163
|
*/
|
|
951
1164
|
updateNavLink(navLinkId, body, opts) {
|
|
952
1165
|
return this.http.request("PATCH", "/v1/stores/{storeId}/navlinks/{navLinkId}", {
|
|
@@ -957,6 +1170,8 @@ export class NavlinksResource {
|
|
|
957
1170
|
}
|
|
958
1171
|
/**
|
|
959
1172
|
* Update the sort orders of NavLinks for a Store
|
|
1173
|
+
*
|
|
1174
|
+
* Updates the sort order of navigation links in the specified store.
|
|
960
1175
|
*/
|
|
961
1176
|
updateNavLinkOrder(body, opts) {
|
|
962
1177
|
return this.http.request("PATCH", "/v1/stores/{storeId}/navlinks/sort-orders", {
|
|
@@ -1046,6 +1261,7 @@ export class PaymentsResource {
|
|
|
1046
1261
|
* Get payment by ID
|
|
1047
1262
|
*
|
|
1048
1263
|
* Retrieves a payment by an ID.
|
|
1264
|
+
* @param paymentId The ID of the payment.
|
|
1049
1265
|
*/
|
|
1050
1266
|
getPaymentById(paymentId, opts) {
|
|
1051
1267
|
return this.http.request("GET", "/v1/stores/{storeId}/payments/{paymentId}", {
|
|
@@ -1205,7 +1421,10 @@ export class ProductsResource {
|
|
|
1205
1421
|
* Updates the sort order of products in the specified store.
|
|
1206
1422
|
*/
|
|
1207
1423
|
updateProductSortOrder(body, opts) {
|
|
1208
|
-
return this.http.request("POST", "/v1/stores/{storeId}/products/sort-order", {
|
|
1424
|
+
return this.http.request("POST", "/v1/stores/{storeId}/products/sort-order", {
|
|
1425
|
+
body,
|
|
1426
|
+
opts,
|
|
1427
|
+
});
|
|
1209
1428
|
}
|
|
1210
1429
|
}
|
|
1211
1430
|
export class RegionalPricingResource {
|
|
@@ -1213,18 +1432,47 @@ export class RegionalPricingResource {
|
|
|
1213
1432
|
constructor(http) {
|
|
1214
1433
|
this.http = http;
|
|
1215
1434
|
}
|
|
1435
|
+
/**
|
|
1436
|
+
* Get product pricing regions
|
|
1437
|
+
*
|
|
1438
|
+
* Retrieves the regional pricing for a product in the specified store.
|
|
1439
|
+
* @param productId The ID of the product.
|
|
1440
|
+
*/
|
|
1216
1441
|
getProductPricingRegions(productId, opts) {
|
|
1217
1442
|
return this.http.request("GET", "/v1/stores/{storeId}/products/{productId}/pricing/regions", { path: { productId }, opts });
|
|
1218
1443
|
}
|
|
1444
|
+
/**
|
|
1445
|
+
* Get pricing region groups
|
|
1446
|
+
*
|
|
1447
|
+
* Retrieves the pricing region groups available to the specified store.
|
|
1448
|
+
*/
|
|
1219
1449
|
getStorePricingRegionGroups(opts) {
|
|
1220
1450
|
return this.http.request("GET", "/v1/stores/{storeId}/products/pricing/region-groups", { opts });
|
|
1221
1451
|
}
|
|
1452
|
+
/**
|
|
1453
|
+
* Get store pricing regions
|
|
1454
|
+
*
|
|
1455
|
+
* Retrieves the regional pricing configuration for the specified store.
|
|
1456
|
+
*/
|
|
1222
1457
|
getStorePricingRegions(opts) {
|
|
1223
1458
|
return this.http.request("GET", "/v1/stores/{storeId}/products/pricing/regions", { opts });
|
|
1224
1459
|
}
|
|
1460
|
+
/**
|
|
1461
|
+
* Update product pricing region
|
|
1462
|
+
*
|
|
1463
|
+
* Performs a delta update of the regional pricing override for a product in the specified store.
|
|
1464
|
+
* @param productId The ID of the product.
|
|
1465
|
+
* @param regionId The ID of the pricing region.
|
|
1466
|
+
*/
|
|
1225
1467
|
setProductPricingRegionOverride(productId, regionId, body, opts) {
|
|
1226
1468
|
return this.http.request("PATCH", "/v1/stores/{storeId}/products/{productId}/pricing/regions/{regionId}", { path: { productId, regionId }, body, opts });
|
|
1227
1469
|
}
|
|
1470
|
+
/**
|
|
1471
|
+
* Update store pricing region
|
|
1472
|
+
*
|
|
1473
|
+
* Performs a delta update of the regional pricing override for the specified store.
|
|
1474
|
+
* @param regionId The ID of the pricing region.
|
|
1475
|
+
*/
|
|
1228
1476
|
setStorePricingRegionOverride(regionId, body, opts) {
|
|
1229
1477
|
return this.http.request("PATCH", "/v1/stores/{storeId}/products/pricing/regions/{regionId}", { path: { regionId }, body, opts });
|
|
1230
1478
|
}
|
|
@@ -1270,12 +1518,17 @@ export class SalesResource {
|
|
|
1270
1518
|
}
|
|
1271
1519
|
/**
|
|
1272
1520
|
* Create a sale by ID for a store
|
|
1521
|
+
*
|
|
1522
|
+
* Creates a new sale in the specified store.
|
|
1273
1523
|
*/
|
|
1274
1524
|
createSale(body, opts) {
|
|
1275
1525
|
return this.http.request("POST", "/v1/stores/{storeId}/sales", { body, opts });
|
|
1276
1526
|
}
|
|
1277
1527
|
/**
|
|
1278
1528
|
* Delete a sale by ID for a store
|
|
1529
|
+
*
|
|
1530
|
+
* Deletes a sale by the ID for the specified store.
|
|
1531
|
+
* @param saleId The ID of the sale.
|
|
1279
1532
|
*/
|
|
1280
1533
|
deleteSaleById(saleId, opts) {
|
|
1281
1534
|
return this.http.request("DELETE", "/v1/stores/{storeId}/sales/{saleId}", {
|
|
@@ -1285,6 +1538,9 @@ export class SalesResource {
|
|
|
1285
1538
|
}
|
|
1286
1539
|
/**
|
|
1287
1540
|
* Get a sale by ID for a store
|
|
1541
|
+
*
|
|
1542
|
+
* Retrieves a sale by the ID for the specified store.
|
|
1543
|
+
* @param saleId The ID of the sale.
|
|
1288
1544
|
*/
|
|
1289
1545
|
getSale(saleId, opts) {
|
|
1290
1546
|
return this.http.request("GET", "/v1/stores/{storeId}/sales/{saleId}", {
|
|
@@ -1294,12 +1550,17 @@ export class SalesResource {
|
|
|
1294
1550
|
}
|
|
1295
1551
|
/**
|
|
1296
1552
|
* Get sales associated with a store.
|
|
1553
|
+
*
|
|
1554
|
+
* Retrieves all sales for the specified store.
|
|
1297
1555
|
*/
|
|
1298
1556
|
getSales(opts) {
|
|
1299
1557
|
return this.http.request("GET", "/v1/stores/{storeId}/sales", { opts });
|
|
1300
1558
|
}
|
|
1301
1559
|
/**
|
|
1302
1560
|
* Update a sale by ID for a store
|
|
1561
|
+
*
|
|
1562
|
+
* Performs a delta update of a sale by the ID for the specified store.
|
|
1563
|
+
* @param saleId The ID of the sale.
|
|
1303
1564
|
*/
|
|
1304
1565
|
updateSale(saleId, body, opts) {
|
|
1305
1566
|
return this.http.request("PATCH", "/v1/stores/{storeId}/sales/{saleId}", {
|
|
@@ -1508,12 +1769,17 @@ export class TagsResource {
|
|
|
1508
1769
|
}
|
|
1509
1770
|
/**
|
|
1510
1771
|
* Create a new tag
|
|
1772
|
+
*
|
|
1773
|
+
* Creates a new tag in the specified store.
|
|
1511
1774
|
*/
|
|
1512
1775
|
createTag(body, opts) {
|
|
1513
1776
|
return this.http.request("POST", "/v1/stores/{storeId}/tags", { body, opts });
|
|
1514
1777
|
}
|
|
1515
1778
|
/**
|
|
1516
1779
|
* Delete a tag by ID
|
|
1780
|
+
*
|
|
1781
|
+
* Deletes a tag by the ID for the specified store.
|
|
1782
|
+
* @param tagId The ID of the tag.
|
|
1517
1783
|
*/
|
|
1518
1784
|
deleteTag(tagId, opts) {
|
|
1519
1785
|
return this.http.request("DELETE", "/v1/stores/{storeId}/tags/{tagId}", {
|
|
@@ -1525,6 +1791,7 @@ export class TagsResource {
|
|
|
1525
1791
|
* Delete tag image
|
|
1526
1792
|
*
|
|
1527
1793
|
* Deletes an image for a tag
|
|
1794
|
+
* @param tagId The ID of the tag.
|
|
1528
1795
|
*/
|
|
1529
1796
|
deleteTagImage(tagId, opts) {
|
|
1530
1797
|
return this.http.request("DELETE", "/v1/stores/{storeId}/tags/{tagId}/image", {
|
|
@@ -1542,6 +1809,9 @@ export class TagsResource {
|
|
|
1542
1809
|
}
|
|
1543
1810
|
/**
|
|
1544
1811
|
* Get a tag by an ID
|
|
1812
|
+
*
|
|
1813
|
+
* Retrieves a tag by the ID for the specified store.
|
|
1814
|
+
* @param tagId The ID of the tag.
|
|
1545
1815
|
*/
|
|
1546
1816
|
getTag(tagId, opts) {
|
|
1547
1817
|
return this.http.request("GET", "/v1/stores/{storeId}/tags/{tagId}", {
|
|
@@ -1559,12 +1829,17 @@ export class TagsResource {
|
|
|
1559
1829
|
}
|
|
1560
1830
|
/**
|
|
1561
1831
|
* Get all tags for a store
|
|
1832
|
+
*
|
|
1833
|
+
* Retrieves all tags for the specified store.
|
|
1562
1834
|
*/
|
|
1563
1835
|
getTags(opts) {
|
|
1564
1836
|
return this.http.request("GET", "/v1/stores/{storeId}/tags", { opts });
|
|
1565
1837
|
}
|
|
1566
1838
|
/**
|
|
1567
1839
|
* Update a tag by ID
|
|
1840
|
+
*
|
|
1841
|
+
* Performs a delta update of a tag by the ID for the specified store.
|
|
1842
|
+
* @param tagId The ID of the tag.
|
|
1568
1843
|
*/
|
|
1569
1844
|
updateTag(tagId, body, opts) {
|
|
1570
1845
|
return this.http.request("PATCH", "/v1/stores/{storeId}/tags/{tagId}", {
|
|
@@ -1581,6 +1856,8 @@ export class TierGroupsResource {
|
|
|
1581
1856
|
}
|
|
1582
1857
|
/**
|
|
1583
1858
|
* Create a new tier group
|
|
1859
|
+
*
|
|
1860
|
+
* Creates a new tier group in the specified store.
|
|
1584
1861
|
*/
|
|
1585
1862
|
createTierGroup(body, opts) {
|
|
1586
1863
|
return this.http.request("POST", "/v1/stores/{storeId}/tier-groups", {
|
|
@@ -1590,6 +1867,9 @@ export class TierGroupsResource {
|
|
|
1590
1867
|
}
|
|
1591
1868
|
/**
|
|
1592
1869
|
* Delete a tier group by ID
|
|
1870
|
+
*
|
|
1871
|
+
* Deletes a tier group by the ID for the specified store.
|
|
1872
|
+
* @param tierGroupId The ID of the tier group.
|
|
1593
1873
|
*/
|
|
1594
1874
|
deleteTierGroup(tierGroupId, opts) {
|
|
1595
1875
|
return this.http.request("DELETE", "/v1/stores/{storeId}/tier-groups/{tierGroupId}", {
|
|
@@ -1599,12 +1879,17 @@ export class TierGroupsResource {
|
|
|
1599
1879
|
}
|
|
1600
1880
|
/**
|
|
1601
1881
|
* Get a tier group by ID
|
|
1882
|
+
*
|
|
1883
|
+
* Retrieves a tier group by the ID for the specified store.
|
|
1884
|
+
* @param tierGroupId The ID of the tier group.
|
|
1602
1885
|
*/
|
|
1603
1886
|
getTierGroup(tierGroupId, opts) {
|
|
1604
1887
|
return this.http.request("GET", "/v1/stores/{storeId}/tier-groups/{tierGroupId}", { path: { tierGroupId }, opts });
|
|
1605
1888
|
}
|
|
1606
1889
|
/**
|
|
1607
1890
|
* List all tier groups for a store
|
|
1891
|
+
*
|
|
1892
|
+
* Retrieves all tier groups for the specified store.
|
|
1608
1893
|
*/
|
|
1609
1894
|
listTierGroups(opts) {
|
|
1610
1895
|
return this.http.request("GET", "/v1/stores/{storeId}/tier-groups", {
|
|
@@ -1613,6 +1898,9 @@ export class TierGroupsResource {
|
|
|
1613
1898
|
}
|
|
1614
1899
|
/**
|
|
1615
1900
|
* Update a tier group by ID
|
|
1901
|
+
*
|
|
1902
|
+
* Performs a delta update of a tier group by the ID for the specified store.
|
|
1903
|
+
* @param tierGroupId The ID of the tier group.
|
|
1616
1904
|
*/
|
|
1617
1905
|
updateTierGroup(tierGroupId, body, opts) {
|
|
1618
1906
|
return this.http.request("PATCH", "/v1/stores/{storeId}/tier-groups/{tierGroupId}", { path: { tierGroupId }, body, opts });
|
|
@@ -1652,6 +1940,9 @@ export class TrialsResource {
|
|
|
1652
1940
|
}
|
|
1653
1941
|
/**
|
|
1654
1942
|
* Get a trial by ID for a store
|
|
1943
|
+
*
|
|
1944
|
+
* Retrieves a trial by the ID for the specified store.
|
|
1945
|
+
* @param trialId The ID of the trial.
|
|
1655
1946
|
*/
|
|
1656
1947
|
getTrial(trialId, opts) {
|
|
1657
1948
|
return this.http.request("GET", "/v1/stores/{storeId}/trials/{trialId}", {
|
|
@@ -1661,6 +1952,8 @@ export class TrialsResource {
|
|
|
1661
1952
|
}
|
|
1662
1953
|
/**
|
|
1663
1954
|
* Get trials for a store
|
|
1955
|
+
*
|
|
1956
|
+
* Retrieves all trials for the specified store.
|
|
1664
1957
|
*/
|
|
1665
1958
|
getTrials(query, opts) {
|
|
1666
1959
|
return this.http.request("GET", "/v1/stores/{storeId}/trials", {
|
|
@@ -1696,30 +1989,68 @@ export class WebhooksResource {
|
|
|
1696
1989
|
constructor(http) {
|
|
1697
1990
|
this.http = http;
|
|
1698
1991
|
}
|
|
1992
|
+
/**
|
|
1993
|
+
* Create webhook
|
|
1994
|
+
*
|
|
1995
|
+
* Creates a new webhook subscription in the specified store.
|
|
1996
|
+
*/
|
|
1699
1997
|
createSubscription(body, opts) {
|
|
1700
1998
|
return this.http.request("POST", "/v1/stores/{storeId}/webhooks", {
|
|
1701
1999
|
body,
|
|
1702
2000
|
opts,
|
|
1703
2001
|
});
|
|
1704
2002
|
}
|
|
2003
|
+
/**
|
|
2004
|
+
* Delete webhook by ID
|
|
2005
|
+
*
|
|
2006
|
+
* Deletes a webhook subscription by the ID for the specified store.
|
|
2007
|
+
* @param webhookId The ID of the webhook.
|
|
2008
|
+
*/
|
|
1705
2009
|
deleteSubscription(webhookId, opts) {
|
|
1706
2010
|
return this.http.request("DELETE", "/v1/stores/{storeId}/webhooks/{webhookId}", {
|
|
1707
2011
|
path: { webhookId },
|
|
1708
2012
|
opts,
|
|
1709
2013
|
});
|
|
1710
2014
|
}
|
|
2015
|
+
/**
|
|
2016
|
+
* Get webhook history
|
|
2017
|
+
*
|
|
2018
|
+
* Retrieves the delivery history of a webhook subscription by the ID for the specified store.
|
|
2019
|
+
* @param webhookId The ID of the webhook.
|
|
2020
|
+
*/
|
|
1711
2021
|
getHistory(webhookId, query, opts) {
|
|
1712
2022
|
return this.http.request("GET", "/v1/stores/{storeId}/webhooks/{webhookId}/history", { path: { webhookId }, query, opts });
|
|
1713
2023
|
}
|
|
2024
|
+
/**
|
|
2025
|
+
* Get webhooks
|
|
2026
|
+
*
|
|
2027
|
+
* Retrieves all webhook subscriptions for the specified store.
|
|
2028
|
+
*/
|
|
1714
2029
|
getSubscriptions(opts) {
|
|
1715
2030
|
return this.http.request("GET", "/v1/stores/{storeId}/webhooks", { opts });
|
|
1716
2031
|
}
|
|
2032
|
+
/**
|
|
2033
|
+
* Get webhook variables
|
|
2034
|
+
*
|
|
2035
|
+
* Retrieves the variables available to webhook payload templates for the specified store.
|
|
2036
|
+
*/
|
|
1717
2037
|
getVariables(opts) {
|
|
1718
2038
|
return this.http.request("GET", "/v1/stores/{storeId}/webhooks/variables", { opts });
|
|
1719
2039
|
}
|
|
2040
|
+
/**
|
|
2041
|
+
* Resend webhook events
|
|
2042
|
+
*
|
|
2043
|
+
* Resends the supplied webhook events for the specified store.
|
|
2044
|
+
*/
|
|
1720
2045
|
resend(body, opts) {
|
|
1721
2046
|
return this.http.request("POST", "/v1/stores/{storeId}/webhooks/resend", { body, opts });
|
|
1722
2047
|
}
|
|
2048
|
+
/**
|
|
2049
|
+
* Update webhook by ID
|
|
2050
|
+
*
|
|
2051
|
+
* Performs a delta update of a webhook subscription by the ID for the specified store.
|
|
2052
|
+
* @param webhookId The ID of the webhook.
|
|
2053
|
+
*/
|
|
1723
2054
|
updateSubscription(webhookId, body, opts) {
|
|
1724
2055
|
return this.http.request("PATCH", "/v1/stores/{storeId}/webhooks/{webhookId}", { path: { webhookId }, body, opts });
|
|
1725
2056
|
}
|
|
@@ -1729,23 +2060,45 @@ export class WebstoreResource {
|
|
|
1729
2060
|
constructor(http) {
|
|
1730
2061
|
this.http = http;
|
|
1731
2062
|
}
|
|
2063
|
+
/**
|
|
2064
|
+
* Create webstore module
|
|
2065
|
+
*
|
|
2066
|
+
* Adds a module to the store's webstore. The module's 'type' decides which 'settings' it accepts.
|
|
2067
|
+
*/
|
|
1732
2068
|
createWebstoreModule(body, opts) {
|
|
1733
|
-
return this.http.request("PUT", "/v1/
|
|
2069
|
+
return this.http.request("PUT", "/v1/stores/{storeId}/webstore/modules", {
|
|
1734
2070
|
body,
|
|
1735
2071
|
opts,
|
|
1736
2072
|
});
|
|
1737
2073
|
}
|
|
2074
|
+
/**
|
|
2075
|
+
* Create template
|
|
2076
|
+
*
|
|
2077
|
+
* Creates an empty template on the store's webstore. Add files to it, then set it as the
|
|
2078
|
+
* webstore's default template to serve it to customers.
|
|
2079
|
+
*/
|
|
1738
2080
|
createWebstoreTemplate(body, opts) {
|
|
1739
|
-
return this.http.request("PUT", "/v1/
|
|
1740
|
-
body,
|
|
1741
|
-
opts,
|
|
1742
|
-
});
|
|
2081
|
+
return this.http.request("PUT", "/v1/stores/{storeId}/webstore/templates", { body, opts });
|
|
1743
2082
|
}
|
|
2083
|
+
/**
|
|
2084
|
+
* Create template file
|
|
2085
|
+
*
|
|
2086
|
+
* Adds a file to a template. Its 'file_name' and 'content_type' decide where the file is served
|
|
2087
|
+
* from and whether it is public.
|
|
2088
|
+
* @param templateId The ID of the template to add the file to.
|
|
2089
|
+
*/
|
|
1744
2090
|
createWebstoreTemplateFile(templateId, body, opts) {
|
|
1745
|
-
return this.http.request("PUT", "/v1/
|
|
2091
|
+
return this.http.request("PUT", "/v1/stores/{storeId}/webstore/templates/{templateId}/files", { path: { templateId }, body, opts });
|
|
1746
2092
|
}
|
|
2093
|
+
/**
|
|
2094
|
+
* Create template variable
|
|
2095
|
+
*
|
|
2096
|
+
* Adds a variable to a template. Its 'variable' is the name the template's files reference it
|
|
2097
|
+
* by, and 'type' decides how 'value' is parsed when the template renders.
|
|
2098
|
+
* @param templateId The ID of the template to add the variable to.
|
|
2099
|
+
*/
|
|
1747
2100
|
createWebstoreTemplateVariable(templateId, body, opts) {
|
|
1748
|
-
return this.http.request("PUT", "/v1/
|
|
2101
|
+
return this.http.request("PUT", "/v1/stores/{storeId}/webstore/templates/{templateId}/variables", { path: { templateId }, body, opts });
|
|
1749
2102
|
}
|
|
1750
2103
|
/**
|
|
1751
2104
|
* Delete custom domain
|
|
@@ -1754,34 +2107,80 @@ export class WebstoreResource {
|
|
|
1754
2107
|
* slug.
|
|
1755
2108
|
*/
|
|
1756
2109
|
deleteWebstoreCustomDomain(opts) {
|
|
1757
|
-
return this.http.request("DELETE", "/v1/
|
|
2110
|
+
return this.http.request("DELETE", "/v1/stores/{storeId}/webstore/custom-domain", {
|
|
2111
|
+
opts,
|
|
2112
|
+
});
|
|
1758
2113
|
}
|
|
2114
|
+
/**
|
|
2115
|
+
* Delete webstore module
|
|
2116
|
+
*
|
|
2117
|
+
* Permanently removes a module from the store's webstore.
|
|
2118
|
+
* @param moduleId The ID of the module.
|
|
2119
|
+
*/
|
|
1759
2120
|
deleteWebstoreModule(moduleId, opts) {
|
|
1760
|
-
return this.http.request("DELETE", "/v1/
|
|
2121
|
+
return this.http.request("DELETE", "/v1/stores/{storeId}/webstore/modules/{moduleId}", {
|
|
1761
2122
|
path: { moduleId },
|
|
1762
2123
|
opts,
|
|
1763
2124
|
});
|
|
1764
2125
|
}
|
|
2126
|
+
/**
|
|
2127
|
+
* Delete template
|
|
2128
|
+
*
|
|
2129
|
+
* Permanently deletes a template and all of its files. Switch the webstore to another template
|
|
2130
|
+
* first if this one is its current template.
|
|
2131
|
+
* @param templateId The ID of the template.
|
|
2132
|
+
*/
|
|
1765
2133
|
deleteWebstoreTemplate(templateId, opts) {
|
|
1766
|
-
return this.http.request("DELETE", "/v1/
|
|
1767
|
-
path: { templateId },
|
|
1768
|
-
opts,
|
|
1769
|
-
});
|
|
2134
|
+
return this.http.request("DELETE", "/v1/stores/{storeId}/webstore/templates/{templateId}", { path: { templateId }, opts });
|
|
1770
2135
|
}
|
|
2136
|
+
/**
|
|
2137
|
+
* Delete template file
|
|
2138
|
+
*
|
|
2139
|
+
* Permanently deletes a template file. Files whose 'is_deletable' is false cannot be removed.
|
|
2140
|
+
* @param templateId The ID of the template.
|
|
2141
|
+
* @param templateFileId The ID of the template file.
|
|
2142
|
+
*/
|
|
1771
2143
|
deleteWebstoreTemplateFile(templateId, templateFileId, opts) {
|
|
1772
|
-
return this.http.request("DELETE", "/v1/
|
|
2144
|
+
return this.http.request("DELETE", "/v1/stores/{storeId}/webstore/templates/{templateId}/files/{templateFileId}", { path: { templateId, templateFileId }, opts });
|
|
1773
2145
|
}
|
|
2146
|
+
/**
|
|
2147
|
+
* Delete template variable
|
|
2148
|
+
*
|
|
2149
|
+
* Permanently deletes a template variable.
|
|
2150
|
+
* @param templateId The ID of the template.
|
|
2151
|
+
* @param templateVariableId The ID of the template variable.
|
|
2152
|
+
*/
|
|
1774
2153
|
deleteWebstoreTemplateVariable(templateId, templateVariableId, opts) {
|
|
1775
|
-
return this.http.request("DELETE", "/v1/
|
|
2154
|
+
return this.http.request("DELETE", "/v1/stores/{storeId}/webstore/templates/{templateId}/variables/{templateVariableId}", { path: { templateId, templateVariableId }, opts });
|
|
1776
2155
|
}
|
|
2156
|
+
/**
|
|
2157
|
+
* Update template to latest version
|
|
2158
|
+
*
|
|
2159
|
+
* Downloads the newest published version of a marketplace template over the installed copy,
|
|
2160
|
+
* replacing its files.
|
|
2161
|
+
* @param templateId The ID of the template to update.
|
|
2162
|
+
*/
|
|
1777
2163
|
downloadWebstoreTemplateUpdate(templateId, opts) {
|
|
1778
|
-
return this.http.request("POST", "/v1/
|
|
2164
|
+
return this.http.request("POST", "/v1/stores/{storeId}/webstore/templates/{templateId}/update", { path: { templateId }, opts });
|
|
1779
2165
|
}
|
|
2166
|
+
/**
|
|
2167
|
+
* Duplicate template
|
|
2168
|
+
*
|
|
2169
|
+
* Copies a template and its files into a new template on the same webstore and returns it.
|
|
2170
|
+
* @param templateId The ID of the template to copy.
|
|
2171
|
+
*/
|
|
1780
2172
|
duplicateWebstoreTemplate(templateId, opts) {
|
|
1781
|
-
return this.http.request("POST", "/v1/
|
|
2173
|
+
return this.http.request("POST", "/v1/stores/{storeId}/webstore/templates/{templateId}/duplicate", { path: { templateId }, opts });
|
|
1782
2174
|
}
|
|
2175
|
+
/**
|
|
2176
|
+
* Finish template upload
|
|
2177
|
+
*
|
|
2178
|
+
* Imports the files from an archive uploaded to the URL returned by the upload URL endpoint
|
|
2179
|
+
* into the template, and reports any files that could not be imported.
|
|
2180
|
+
* @param templateId The ID of the template the files are imported into.
|
|
2181
|
+
*/
|
|
1783
2182
|
finishWebstoreTemplateUpload(templateId, opts) {
|
|
1784
|
-
return this.http.request("POST", "/v1/
|
|
2183
|
+
return this.http.request("POST", "/v1/stores/{storeId}/webstore/templates/{templateId}/upload_finish", { path: { templateId }, opts });
|
|
1785
2184
|
}
|
|
1786
2185
|
/**
|
|
1787
2186
|
* Get webstore
|
|
@@ -1790,7 +2189,7 @@ export class WebstoreResource {
|
|
|
1790
2189
|
* state and the template it currently renders.
|
|
1791
2190
|
*/
|
|
1792
2191
|
getWebstore(opts) {
|
|
1793
|
-
return this.http.request("GET", "/v1/
|
|
2192
|
+
return this.http.request("GET", "/v1/stores/{storeId}/webstore", { opts });
|
|
1794
2193
|
}
|
|
1795
2194
|
/**
|
|
1796
2195
|
* Get custom domain
|
|
@@ -1799,42 +2198,123 @@ export class WebstoreResource {
|
|
|
1799
2198
|
* outstanding for ownership and SSL verification.
|
|
1800
2199
|
*/
|
|
1801
2200
|
getWebstoreCustomDomain(opts) {
|
|
1802
|
-
return this.http.request("GET", "/v1/
|
|
2201
|
+
return this.http.request("GET", "/v1/stores/{storeId}/webstore/custom-domain", { opts });
|
|
1803
2202
|
}
|
|
2203
|
+
/**
|
|
2204
|
+
* Get webstore modules
|
|
2205
|
+
*
|
|
2206
|
+
* Retrieves all modules on the store's webstore, in sort order.
|
|
2207
|
+
*/
|
|
1804
2208
|
getWebstoreModules(opts) {
|
|
1805
|
-
return this.http.request("GET", "/v1/
|
|
1806
|
-
opts,
|
|
1807
|
-
});
|
|
2209
|
+
return this.http.request("GET", "/v1/stores/{storeId}/webstore/modules", { opts });
|
|
1808
2210
|
}
|
|
2211
|
+
/**
|
|
2212
|
+
* Get template
|
|
2213
|
+
*
|
|
2214
|
+
* Retrieves a template. Pass 'include' as 'files' to embed its files, content included, in
|
|
2215
|
+
* 'template_files'.
|
|
2216
|
+
* @param templateId The ID of the template.
|
|
2217
|
+
*/
|
|
1809
2218
|
getWebstoreTemplate(templateId, query, opts) {
|
|
1810
|
-
return this.http.request("GET", "/v1/
|
|
2219
|
+
return this.http.request("GET", "/v1/stores/{storeId}/webstore/templates/{templateId}", { path: { templateId }, query, opts });
|
|
1811
2220
|
}
|
|
2221
|
+
/**
|
|
2222
|
+
* Get template archive
|
|
2223
|
+
*
|
|
2224
|
+
* Creates a temporary URL to download the template's files as an archive.
|
|
2225
|
+
* @param templateId The ID of the template.
|
|
2226
|
+
*/
|
|
1812
2227
|
getWebstoreTemplateArchive(templateId, opts) {
|
|
1813
|
-
return this.http.request("GET", "/v1/
|
|
2228
|
+
return this.http.request("GET", "/v1/stores/{storeId}/webstore/templates/{templateId}/archive", { path: { templateId }, opts });
|
|
1814
2229
|
}
|
|
2230
|
+
/**
|
|
2231
|
+
* Get template file
|
|
2232
|
+
*
|
|
2233
|
+
* Retrieves a single template file, content included.
|
|
2234
|
+
* @param templateId The ID of the template.
|
|
2235
|
+
* @param templateFileId The ID of the template file.
|
|
2236
|
+
*/
|
|
1815
2237
|
getWebstoreTemplateFile(templateId, templateFileId, opts) {
|
|
1816
|
-
return this.http.request("GET", "/v1/
|
|
2238
|
+
return this.http.request("GET", "/v1/stores/{storeId}/webstore/templates/{templateId}/files/{templateFileId}", { path: { templateId, templateFileId }, opts });
|
|
1817
2239
|
}
|
|
2240
|
+
/**
|
|
2241
|
+
* Get template files
|
|
2242
|
+
*
|
|
2243
|
+
* Retrieves the files of a template without their content. Fetch a single file to read its
|
|
2244
|
+
* content.
|
|
2245
|
+
* @param templateId The ID of the template.
|
|
2246
|
+
*/
|
|
1818
2247
|
getWebstoreTemplateFiles(templateId, opts) {
|
|
1819
|
-
return this.http.request("GET", "/v1/
|
|
2248
|
+
return this.http.request("GET", "/v1/stores/{storeId}/webstore/templates/{templateId}/files", { path: { templateId }, opts });
|
|
1820
2249
|
}
|
|
2250
|
+
/**
|
|
2251
|
+
* Get latest template version
|
|
2252
|
+
*
|
|
2253
|
+
* Retrieves the newest published version available for a template installed from the
|
|
2254
|
+
* marketplace. 'version' is null when there is no update or the template is not
|
|
2255
|
+
* marketplace-based.
|
|
2256
|
+
* @param templateId The ID of the template.
|
|
2257
|
+
*/
|
|
1821
2258
|
getWebstoreTemplateLatestVersion(templateId, opts) {
|
|
1822
|
-
return this.http.request("GET", "/v1/
|
|
2259
|
+
return this.http.request("GET", "/v1/stores/{storeId}/webstore/templates/{templateId}/update", { path: { templateId }, opts });
|
|
2260
|
+
}
|
|
2261
|
+
/**
|
|
2262
|
+
* Create template preview URL
|
|
2263
|
+
*
|
|
2264
|
+
* Creates a short-lived link that renders the template without caching. The link expires
|
|
2265
|
+
* after 15 minutes.
|
|
2266
|
+
* @param templateId The ID of the template to preview.
|
|
2267
|
+
*/
|
|
2268
|
+
getWebstoreTemplatePreviewUrl(templateId, opts) {
|
|
2269
|
+
return this.http.request("POST", "/v1/stores/{storeId}/webstore/templates/{templateId}/preview", { path: { templateId }, opts });
|
|
1823
2270
|
}
|
|
2271
|
+
/**
|
|
2272
|
+
* Get templates
|
|
2273
|
+
*
|
|
2274
|
+
* Retrieves the templates of the store's webstore, without their files. The one customers see
|
|
2275
|
+
* is the webstore's 'current_template_id'.
|
|
2276
|
+
*/
|
|
1824
2277
|
getWebstoreTemplates(opts) {
|
|
1825
|
-
return this.http.request("GET", "/v1/
|
|
2278
|
+
return this.http.request("GET", "/v1/stores/{storeId}/webstore/templates", { opts });
|
|
1826
2279
|
}
|
|
2280
|
+
/**
|
|
2281
|
+
* Get template schema
|
|
2282
|
+
*
|
|
2283
|
+
* Retrieves the schema a template declares: its author, support contacts, update source and
|
|
2284
|
+
* the settings a store can configure.
|
|
2285
|
+
* @param templateId The ID of the template.
|
|
2286
|
+
*/
|
|
1827
2287
|
getWebstoreTemplateSchema(templateId, opts) {
|
|
1828
|
-
return this.http.request("GET", "/v1/
|
|
2288
|
+
return this.http.request("GET", "/v1/stores/{storeId}/webstore/templates/{templateId}/schema", { path: { templateId }, opts });
|
|
1829
2289
|
}
|
|
2290
|
+
/**
|
|
2291
|
+
* Get template upload URL
|
|
2292
|
+
*
|
|
2293
|
+
* Creates a pre-signed URL for uploading an archive of template files. Upload the archive to
|
|
2294
|
+
* it, then finish the upload to import the files into the template.
|
|
2295
|
+
* @param templateId The ID of the template the files are imported into.
|
|
2296
|
+
*/
|
|
1830
2297
|
getWebstoreTemplateUploadUrl(templateId, query, opts) {
|
|
1831
|
-
return this.http.request("GET", "/v1/
|
|
2298
|
+
return this.http.request("GET", "/v1/stores/{storeId}/webstore/templates/{templateId}/upload_url", { path: { templateId }, query, opts });
|
|
1832
2299
|
}
|
|
2300
|
+
/**
|
|
2301
|
+
* Get template variables
|
|
2302
|
+
*
|
|
2303
|
+
* Retrieves the variables of a template with their current values.
|
|
2304
|
+
* @param templateId The ID of the template.
|
|
2305
|
+
*/
|
|
1833
2306
|
getWebstoreTemplateVariables(templateId, opts) {
|
|
1834
|
-
return this.http.request("GET", "/v1/
|
|
2307
|
+
return this.http.request("GET", "/v1/stores/{storeId}/webstore/templates/{templateId}/variables", { path: { templateId }, opts });
|
|
1835
2308
|
}
|
|
1836
|
-
|
|
1837
|
-
|
|
2309
|
+
/**
|
|
2310
|
+
* Install marketplace template
|
|
2311
|
+
*
|
|
2312
|
+
* Installs a template from the marketplace into the store's webstore and returns the ID of the
|
|
2313
|
+
* installed copy.
|
|
2314
|
+
* @param marketplaceTemplateId The ID of the marketplace template to install.
|
|
2315
|
+
*/
|
|
2316
|
+
installMarketplaceTemplate(marketplaceTemplateId, opts) {
|
|
2317
|
+
return this.http.request("POST", "/v1/stores/{storeId}/webstore/marketplace/templates/{marketplaceTemplateId}/install", { path: { marketplaceTemplateId }, opts });
|
|
1838
2318
|
}
|
|
1839
2319
|
/**
|
|
1840
2320
|
* Set custom domain
|
|
@@ -1842,7 +2322,7 @@ export class WebstoreResource {
|
|
|
1842
2322
|
* Attaches a custom domain to the store's webstore and begins verification.
|
|
1843
2323
|
*/
|
|
1844
2324
|
setWebstoreCustomDomain(body, opts) {
|
|
1845
|
-
return this.http.request("POST", "/v1/
|
|
2325
|
+
return this.http.request("POST", "/v1/stores/{storeId}/webstore/custom-domain", { body, opts });
|
|
1846
2326
|
}
|
|
1847
2327
|
/**
|
|
1848
2328
|
* Set default template
|
|
@@ -1850,7 +2330,7 @@ export class WebstoreResource {
|
|
|
1850
2330
|
* Sets the template the webstore renders for customers.
|
|
1851
2331
|
*/
|
|
1852
2332
|
setWebstoreDefaultTemplate(body, opts) {
|
|
1853
|
-
return this.http.request("POST", "/v1/
|
|
2333
|
+
return this.http.request("POST", "/v1/stores/{storeId}/webstore/set-default-template", {
|
|
1854
2334
|
body,
|
|
1855
2335
|
opts,
|
|
1856
2336
|
});
|
|
@@ -1862,22 +2342,58 @@ export class WebstoreResource {
|
|
|
1862
2342
|
* slug already taken by another store is rejected.
|
|
1863
2343
|
*/
|
|
1864
2344
|
setWebstoreSlug(body, opts) {
|
|
1865
|
-
return this.http.request("POST", "/v1/
|
|
2345
|
+
return this.http.request("POST", "/v1/stores/{storeId}/webstore/set-slug", {
|
|
2346
|
+
body,
|
|
2347
|
+
opts,
|
|
2348
|
+
});
|
|
1866
2349
|
}
|
|
2350
|
+
/**
|
|
2351
|
+
* Update webstore module
|
|
2352
|
+
*
|
|
2353
|
+
* Performs a delta update of a module on the store's webstore.
|
|
2354
|
+
* @param moduleId The ID of the module.
|
|
2355
|
+
*/
|
|
1867
2356
|
updateWebstoreModule(moduleId, body, opts) {
|
|
1868
|
-
return this.http.request("PUT", "/v1/
|
|
2357
|
+
return this.http.request("PUT", "/v1/stores/{storeId}/webstore/modules/{moduleId}", { path: { moduleId }, body, opts });
|
|
1869
2358
|
}
|
|
2359
|
+
/**
|
|
2360
|
+
* Update template
|
|
2361
|
+
*
|
|
2362
|
+
* Performs a delta update of a template's name and compatibility mode.
|
|
2363
|
+
* @param templateId The ID of the template.
|
|
2364
|
+
*/
|
|
1870
2365
|
updateWebstoreTemplate(templateId, body, opts) {
|
|
1871
|
-
return this.http.request("PUT", "/v1/
|
|
2366
|
+
return this.http.request("PUT", "/v1/stores/{storeId}/webstore/templates/{templateId}", { path: { templateId }, body, opts });
|
|
1872
2367
|
}
|
|
2368
|
+
/**
|
|
2369
|
+
* Update template file content
|
|
2370
|
+
*
|
|
2371
|
+
* Replaces the content of a template file. If the template is the webstore's current template,
|
|
2372
|
+
* customers see the change immediately.
|
|
2373
|
+
* @param templateId The ID of the template.
|
|
2374
|
+
* @param templateFileId The ID of the template file.
|
|
2375
|
+
*/
|
|
1873
2376
|
updateWebstoreTemplateFile(templateId, templateFileId, body, opts) {
|
|
1874
|
-
return this.http.request("PUT", "/v1/
|
|
2377
|
+
return this.http.request("PUT", "/v1/stores/{storeId}/webstore/templates/{templateId}/files/{templateFileId}", { path: { templateId, templateFileId }, body, opts });
|
|
1875
2378
|
}
|
|
2379
|
+
/**
|
|
2380
|
+
* Update template schema variables
|
|
2381
|
+
*
|
|
2382
|
+
* Sets values for the settings the template's schema defines.
|
|
2383
|
+
* @param templateId The ID of the template.
|
|
2384
|
+
*/
|
|
1876
2385
|
updateWebstoreTemplateSchemaVariables(templateId, body, opts) {
|
|
1877
|
-
return this.http.request("PUT", "/v1/
|
|
2386
|
+
return this.http.request("PUT", "/v1/stores/{storeId}/webstore/templates/{templateId}/schema/variables", { path: { templateId }, body, opts });
|
|
1878
2387
|
}
|
|
2388
|
+
/**
|
|
2389
|
+
* Update template variable
|
|
2390
|
+
*
|
|
2391
|
+
* Performs a delta update of a template variable.
|
|
2392
|
+
* @param templateId The ID of the template.
|
|
2393
|
+
* @param templateVariableId The ID of the template variable.
|
|
2394
|
+
*/
|
|
1879
2395
|
updateWebstoreTemplateVariable(templateId, templateVariableId, body, opts) {
|
|
1880
|
-
return this.http.request("PUT", "/v1/
|
|
2396
|
+
return this.http.request("PUT", "/v1/stores/{storeId}/webstore/templates/{templateId}/variables/{templateVariableId}", { path: { templateId, templateVariableId }, body, opts });
|
|
1881
2397
|
}
|
|
1882
2398
|
/**
|
|
1883
2399
|
* Verify custom domain
|
|
@@ -1886,7 +2402,7 @@ export class WebstoreResource {
|
|
|
1886
2402
|
* records returned when the domain was set have been published.
|
|
1887
2403
|
*/
|
|
1888
2404
|
verifyWebstoreCustomDomain(opts) {
|
|
1889
|
-
return this.http.request("POST", "/v1/
|
|
2405
|
+
return this.http.request("POST", "/v1/stores/{storeId}/webstore/custom-domain/verify", {
|
|
1890
2406
|
opts,
|
|
1891
2407
|
});
|
|
1892
2408
|
}
|
|
@@ -1897,14 +2413,12 @@ export class ManagementClient {
|
|
|
1897
2413
|
$http;
|
|
1898
2414
|
affiliateLinks;
|
|
1899
2415
|
bans;
|
|
1900
|
-
billing;
|
|
1901
2416
|
checkout;
|
|
1902
2417
|
checkoutStyle;
|
|
1903
2418
|
coupons;
|
|
1904
|
-
|
|
2419
|
+
customerPortalSessions;
|
|
1905
2420
|
customers;
|
|
1906
2421
|
customVariables;
|
|
1907
|
-
dashboard;
|
|
1908
2422
|
dataMigrations;
|
|
1909
2423
|
delivery;
|
|
1910
2424
|
discord;
|
|
@@ -1937,14 +2451,12 @@ export class ManagementClient {
|
|
|
1937
2451
|
this.$http = http;
|
|
1938
2452
|
this.affiliateLinks = new AffiliateLinksResource(http);
|
|
1939
2453
|
this.bans = new BansResource(http);
|
|
1940
|
-
this.billing = new BillingResource(http);
|
|
1941
2454
|
this.checkout = new CheckoutResource(http);
|
|
1942
2455
|
this.checkoutStyle = new CheckoutStyleResource(http);
|
|
1943
2456
|
this.coupons = new CouponsResource(http);
|
|
1944
|
-
this.
|
|
2457
|
+
this.customerPortalSessions = new CustomerPortalSessionsResource(http);
|
|
1945
2458
|
this.customers = new CustomersResource(http);
|
|
1946
2459
|
this.customVariables = new CustomVariablesResource(http);
|
|
1947
|
-
this.dashboard = new DashboardResource(http);
|
|
1948
2460
|
this.dataMigrations = new DataMigrationsResource(http);
|
|
1949
2461
|
this.delivery = new DeliveryResource(http);
|
|
1950
2462
|
this.discord = new DiscordResource(http);
|