@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
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// Generated from OpenAPI spec. Do not edit by hand.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
exports.ManagementClient = exports.WebstoreResource = exports.WebhooksResource = exports.UpsellSettingsResource = exports.TrialsResource = exports.TierGroupsResource = exports.TagsResource = exports.SubscriptionsResource = exports.StoreResource = exports.SalesResource = exports.RolesResource = exports.RegionalPricingResource = exports.ProductsResource = exports.ProductDependentMigrationsResource = exports.PaymentSettingsResource = exports.PaymentsResource = exports.PaymentMethodTypesResource = exports.OrdersResource = exports.NavlinksResource = exports.MarketingResource = exports.InvoicesResource = exports.InvitesResource = exports.GlobalCommandsResource = exports.GiftcardsResource = exports.GameServersResource = exports.DownloadableFilesResource = exports.DiscordResource = exports.DeliveryResource = exports.DataMigrationsResource = exports.
|
|
4
|
+
exports.ManagementClient = exports.WebstoreResource = exports.WebhooksResource = exports.UpsellSettingsResource = exports.TrialsResource = exports.TierGroupsResource = exports.TagsResource = exports.SubscriptionsResource = exports.StoreResource = exports.SalesResource = exports.RolesResource = exports.RegionalPricingResource = exports.ProductsResource = exports.ProductDependentMigrationsResource = exports.PaymentSettingsResource = exports.PaymentsResource = exports.PaymentMethodTypesResource = exports.OrdersResource = exports.NavlinksResource = exports.MarketingResource = exports.InvoicesResource = exports.InvitesResource = exports.GlobalCommandsResource = exports.GiftcardsResource = exports.GameServersResource = exports.DownloadableFilesResource = exports.DiscordResource = exports.DeliveryResource = exports.DataMigrationsResource = exports.CustomVariablesResource = exports.CustomersResource = exports.CustomerPortalSessionsResource = exports.CouponsResource = exports.CheckoutStyleResource = exports.CheckoutResource = exports.BansResource = exports.AffiliateLinksResource = void 0;
|
|
5
5
|
exports.createManagementClient = createManagementClient;
|
|
6
6
|
const http_js_1 = require("../../runtime/http.js");
|
|
7
7
|
class AffiliateLinksResource {
|
|
@@ -9,21 +9,49 @@ class AffiliateLinksResource {
|
|
|
9
9
|
constructor(http) {
|
|
10
10
|
this.http = http;
|
|
11
11
|
}
|
|
12
|
+
/**
|
|
13
|
+
* Create affiliate link
|
|
14
|
+
*
|
|
15
|
+
* Creates a new affiliate link in the specified store.
|
|
16
|
+
*/
|
|
12
17
|
createAffiliateLink(body, opts) {
|
|
13
18
|
return this.http.request("POST", "/v1/stores/{storeId}/affiliate-links", {
|
|
14
19
|
body,
|
|
15
20
|
opts,
|
|
16
21
|
});
|
|
17
22
|
}
|
|
23
|
+
/**
|
|
24
|
+
* Delete affiliate link by ID
|
|
25
|
+
*
|
|
26
|
+
* Deletes an affiliate link by the ID for the specified store.
|
|
27
|
+
* @param affiliateLinkId The ID of the affiliate link.
|
|
28
|
+
*/
|
|
18
29
|
deleteAffiliateLink(affiliateLinkId, opts) {
|
|
19
30
|
return this.http.request("DELETE", "/v1/stores/{storeId}/affiliate-links/{affiliateLinkId}", { path: { affiliateLinkId }, opts });
|
|
20
31
|
}
|
|
32
|
+
/**
|
|
33
|
+
* Get affiliate link by ID
|
|
34
|
+
*
|
|
35
|
+
* Retrieves an affiliate link by the ID for the specified store.
|
|
36
|
+
* @param affiliateLinkId The ID of the affiliate link.
|
|
37
|
+
*/
|
|
21
38
|
getAffiliateLink(affiliateLinkId, opts) {
|
|
22
39
|
return this.http.request("GET", "/v1/stores/{storeId}/affiliate-links/{affiliateLinkId}", { path: { affiliateLinkId }, opts });
|
|
23
40
|
}
|
|
41
|
+
/**
|
|
42
|
+
* Get affiliate links
|
|
43
|
+
*
|
|
44
|
+
* Retrieves all affiliate links for the specified store.
|
|
45
|
+
*/
|
|
24
46
|
getAffiliateLinks(opts) {
|
|
25
47
|
return this.http.request("GET", "/v1/stores/{storeId}/affiliate-links", { opts });
|
|
26
48
|
}
|
|
49
|
+
/**
|
|
50
|
+
* Update affiliate link by ID
|
|
51
|
+
*
|
|
52
|
+
* Performs a delta update of an affiliate link by the ID for the specified store.
|
|
53
|
+
* @param affiliateLinkId The ID of the affiliate link.
|
|
54
|
+
*/
|
|
27
55
|
updateAffiliateLink(affiliateLinkId, body, opts) {
|
|
28
56
|
return this.http.request("PATCH", "/v1/stores/{storeId}/affiliate-links/{affiliateLinkId}", { path: { affiliateLinkId }, body, opts });
|
|
29
57
|
}
|
|
@@ -34,27 +62,60 @@ class BansResource {
|
|
|
34
62
|
constructor(http) {
|
|
35
63
|
this.http = http;
|
|
36
64
|
}
|
|
65
|
+
/**
|
|
66
|
+
* Check for ban by identities
|
|
67
|
+
*
|
|
68
|
+
* Checks whether any of the supplied identities are banned in the specified store.
|
|
69
|
+
*/
|
|
37
70
|
checkForBanByIdentities(body, opts) {
|
|
38
71
|
return this.http.request("POST", "/v1/stores/{storeId}/bans/check", { body, opts });
|
|
39
72
|
}
|
|
73
|
+
/**
|
|
74
|
+
* Create ban
|
|
75
|
+
*
|
|
76
|
+
* Creates a new ban in the specified store.
|
|
77
|
+
*/
|
|
40
78
|
createBan(body, opts) {
|
|
41
79
|
return this.http.request("POST", "/v1/stores/{storeId}/bans", { body, opts });
|
|
42
80
|
}
|
|
81
|
+
/**
|
|
82
|
+
* Delete ban by ID
|
|
83
|
+
*
|
|
84
|
+
* Deletes a ban by the ID for the specified store.
|
|
85
|
+
* @param banId The ID of the ban.
|
|
86
|
+
*/
|
|
43
87
|
deleteBan(banId, opts) {
|
|
44
88
|
return this.http.request("DELETE", "/v1/stores/{storeId}/bans/{banId}", {
|
|
45
89
|
path: { banId },
|
|
46
90
|
opts,
|
|
47
91
|
});
|
|
48
92
|
}
|
|
93
|
+
/**
|
|
94
|
+
* Get ban by ID
|
|
95
|
+
*
|
|
96
|
+
* Retrieves a ban by the ID for the specified store.
|
|
97
|
+
* @param banId The ID of the ban.
|
|
98
|
+
*/
|
|
49
99
|
getBan(banId, opts) {
|
|
50
100
|
return this.http.request("GET", "/v1/stores/{storeId}/bans/{banId}", {
|
|
51
101
|
path: { banId },
|
|
52
102
|
opts,
|
|
53
103
|
});
|
|
54
104
|
}
|
|
105
|
+
/**
|
|
106
|
+
* Get bans
|
|
107
|
+
*
|
|
108
|
+
* Retrieves all bans for the specified store.
|
|
109
|
+
*/
|
|
55
110
|
getBans(query, opts) {
|
|
56
111
|
return this.http.request("GET", "/v1/stores/{storeId}/bans", { query, opts });
|
|
57
112
|
}
|
|
113
|
+
/**
|
|
114
|
+
* Update ban by ID
|
|
115
|
+
*
|
|
116
|
+
* Updates a ban by the ID for the specified store.
|
|
117
|
+
* @param banId The ID of the ban.
|
|
118
|
+
*/
|
|
58
119
|
updateBan(banId, body, opts) {
|
|
59
120
|
return this.http.request("PATCH", "/v1/stores/{storeId}/bans/{banId}", {
|
|
60
121
|
path: { banId },
|
|
@@ -64,92 +125,6 @@ class BansResource {
|
|
|
64
125
|
}
|
|
65
126
|
}
|
|
66
127
|
exports.BansResource = BansResource;
|
|
67
|
-
class BillingResource {
|
|
68
|
-
http;
|
|
69
|
-
constructor(http) {
|
|
70
|
-
this.http = http;
|
|
71
|
-
}
|
|
72
|
-
/**
|
|
73
|
-
* Change subscription payment method
|
|
74
|
-
*
|
|
75
|
-
* Starts a session for the store owner to replace the card the subscription is billed to.
|
|
76
|
-
*/
|
|
77
|
-
changeSubscriptionPaymentMethod(opts) {
|
|
78
|
-
return this.http.request("POST", "/v1/stores/{storeId}/billing/payment-method/change", { opts });
|
|
79
|
-
}
|
|
80
|
-
/**
|
|
81
|
-
* Change subscription plan
|
|
82
|
-
*
|
|
83
|
-
* Moves the store onto a different plan. When the change needs paying for, the response
|
|
84
|
-
* carries a 'session_url' the store owner must complete.
|
|
85
|
-
*/
|
|
86
|
-
changeSubscriptionPlan(body, opts) {
|
|
87
|
-
return this.http.request("POST", "/v1/stores/{storeId}/billing/plans/change", { body, opts });
|
|
88
|
-
}
|
|
89
|
-
/**
|
|
90
|
-
* Continue current subscription
|
|
91
|
-
*
|
|
92
|
-
* Cancels a pending downgrade or cancellation, keeping the store on its current plan.
|
|
93
|
-
*/
|
|
94
|
-
continueCurrentSubscription(opts) {
|
|
95
|
-
return this.http.request("POST", "/v1/stores/{storeId}/billing/plans/continue", { opts });
|
|
96
|
-
}
|
|
97
|
-
/**
|
|
98
|
-
* Get available plans
|
|
99
|
-
*
|
|
100
|
-
* Retrieves the plans a store can subscribe to.
|
|
101
|
-
*/
|
|
102
|
-
getPublicPlans(opts) {
|
|
103
|
-
return this.http.request("GET", "/v1/stores/{storeId}/billing/plans", {
|
|
104
|
-
opts,
|
|
105
|
-
});
|
|
106
|
-
}
|
|
107
|
-
/**
|
|
108
|
-
* Get billing details
|
|
109
|
-
*
|
|
110
|
-
* Retrieves the billing address and tax details the store is invoiced under.
|
|
111
|
-
*/
|
|
112
|
-
getStoreBillingDetails(opts) {
|
|
113
|
-
return this.http.request("GET", "/v1/stores/{storeId}/billing/details", { opts });
|
|
114
|
-
}
|
|
115
|
-
/**
|
|
116
|
-
* Get billing status
|
|
117
|
-
*
|
|
118
|
-
* Retrieves the store's plan, limits, feature flags and subscription state.
|
|
119
|
-
*/
|
|
120
|
-
getStoreBillingStatus(opts) {
|
|
121
|
-
return this.http.request("GET", "/v1/stores/{storeId}/billing/status", {
|
|
122
|
-
opts,
|
|
123
|
-
});
|
|
124
|
-
}
|
|
125
|
-
/**
|
|
126
|
-
* Get subscription invoices
|
|
127
|
-
*
|
|
128
|
-
* Retrieves the invoices raised against the store's own subscription.
|
|
129
|
-
*/
|
|
130
|
-
getStoreInvoices(query, opts) {
|
|
131
|
-
return this.http.request("GET", "/v1/stores/{storeId}/billing/invoices", { query, opts });
|
|
132
|
-
}
|
|
133
|
-
/**
|
|
134
|
-
* Get invoice URL
|
|
135
|
-
*
|
|
136
|
-
* Issues a fresh link to the hosted invoice. Prefer this over the 'invoice_url' carried by
|
|
137
|
-
* the invoice list, which is recorded once and may have expired.
|
|
138
|
-
* @param invoiceId The ID of the invoice to link to.
|
|
139
|
-
*/
|
|
140
|
-
getStoreInvoiceUrl(invoiceId, opts) {
|
|
141
|
-
return this.http.request("GET", "/v1/stores/{storeId}/billing/invoices/{invoiceId}/url", { path: { invoiceId }, opts });
|
|
142
|
-
}
|
|
143
|
-
/**
|
|
144
|
-
* Update billing details
|
|
145
|
-
*
|
|
146
|
-
* Replaces the billing address and tax details the store is invoiced under.
|
|
147
|
-
*/
|
|
148
|
-
updateStoreBillingDetails(body, opts) {
|
|
149
|
-
return this.http.request("PUT", "/v1/stores/{storeId}/billing/details", { body, opts });
|
|
150
|
-
}
|
|
151
|
-
}
|
|
152
|
-
exports.BillingResource = BillingResource;
|
|
153
128
|
class CheckoutResource {
|
|
154
129
|
http;
|
|
155
130
|
constructor(http) {
|
|
@@ -223,40 +198,56 @@ class CouponsResource {
|
|
|
223
198
|
constructor(http) {
|
|
224
199
|
this.http = http;
|
|
225
200
|
}
|
|
226
|
-
|
|
201
|
+
/**
|
|
202
|
+
* Create coupon
|
|
203
|
+
*
|
|
204
|
+
* Creates a new coupon in the specified store.
|
|
205
|
+
*/
|
|
206
|
+
createCoupon(body, opts) {
|
|
227
207
|
return this.http.request("POST", "/v1/stores/{storeId}/coupons", { body, opts });
|
|
228
208
|
}
|
|
229
209
|
/**
|
|
230
|
-
*
|
|
210
|
+
* Delete coupon by ID
|
|
211
|
+
*
|
|
212
|
+
* Deletes a coupon by the ID for the specified store.
|
|
213
|
+
* @param couponId The ID of the coupon.
|
|
231
214
|
*/
|
|
232
|
-
|
|
215
|
+
deleteCoupon(couponId, opts) {
|
|
233
216
|
return this.http.request("DELETE", "/v1/stores/{storeId}/coupons/{couponId}", {
|
|
234
217
|
path: { couponId },
|
|
235
218
|
opts,
|
|
236
219
|
});
|
|
237
220
|
}
|
|
238
221
|
/**
|
|
239
|
-
*
|
|
222
|
+
* Get coupon by ID
|
|
223
|
+
*
|
|
224
|
+
* Retrieves a coupon by the ID for the specified store.
|
|
225
|
+
* @param couponId The ID of the coupon.
|
|
240
226
|
*/
|
|
241
|
-
|
|
227
|
+
getCouponById(couponId, opts) {
|
|
242
228
|
return this.http.request("GET", "/v1/stores/{storeId}/coupons/{couponId}", {
|
|
243
229
|
path: { couponId },
|
|
244
230
|
opts,
|
|
245
231
|
});
|
|
246
232
|
}
|
|
247
233
|
/**
|
|
248
|
-
*
|
|
234
|
+
* Get coupons
|
|
235
|
+
*
|
|
236
|
+
* Retrieves all coupons for the specified store.
|
|
249
237
|
*/
|
|
250
|
-
|
|
238
|
+
getCoupons(query, opts) {
|
|
251
239
|
return this.http.request("GET", "/v1/stores/{storeId}/coupons", {
|
|
252
240
|
query,
|
|
253
241
|
opts,
|
|
254
242
|
});
|
|
255
243
|
}
|
|
256
244
|
/**
|
|
257
|
-
*
|
|
245
|
+
* Update coupon by ID
|
|
246
|
+
*
|
|
247
|
+
* Performs a delta update of a coupon by the ID for the specified store.
|
|
248
|
+
* @param couponId The ID of the coupon.
|
|
258
249
|
*/
|
|
259
|
-
|
|
250
|
+
updateCoupon(couponId, body, opts) {
|
|
260
251
|
return this.http.request("PATCH", "/v1/stores/{storeId}/coupons/{couponId}", {
|
|
261
252
|
path: { couponId },
|
|
262
253
|
body,
|
|
@@ -365,6 +356,7 @@ class CustomersResource {
|
|
|
365
356
|
* Update customer
|
|
366
357
|
*
|
|
367
358
|
* Updates an existing customer based on the fields passed.
|
|
359
|
+
* @param customerId The ID of the customer.
|
|
368
360
|
*/
|
|
369
361
|
updateCustomer(customerId, body, opts) {
|
|
370
362
|
return this.http.request("PATCH", "/v1/stores/{storeId}/customers/{customerId}", {
|
|
@@ -386,7 +378,7 @@ class CustomVariablesResource {
|
|
|
386
378
|
* Creates a new custom variable for the specified store.
|
|
387
379
|
* Custom variables allow customers to provide additional input when purchasing products.
|
|
388
380
|
*/
|
|
389
|
-
|
|
381
|
+
createCustomVariable(body, opts) {
|
|
390
382
|
return this.http.request("POST", "/v1/stores/{storeId}/custom-variables", {
|
|
391
383
|
body,
|
|
392
384
|
opts,
|
|
@@ -399,7 +391,7 @@ class CustomVariablesResource {
|
|
|
399
391
|
* This will also delete all associated options and cannot be undone.
|
|
400
392
|
* @param customVariableId The ID of the custom variable to delete.
|
|
401
393
|
*/
|
|
402
|
-
|
|
394
|
+
deleteCustomVariable(customVariableId, opts) {
|
|
403
395
|
return this.http.request("DELETE", "/v1/stores/{storeId}/custom-variables/{customVariableId}", { path: { customVariableId }, opts });
|
|
404
396
|
}
|
|
405
397
|
/**
|
|
@@ -408,7 +400,7 @@ class CustomVariablesResource {
|
|
|
408
400
|
* Retrieves a specific custom variable by ID from the specified store.
|
|
409
401
|
* @param customVariableId The ID of the custom variable to retrieve.
|
|
410
402
|
*/
|
|
411
|
-
|
|
403
|
+
getCustomVariableById(customVariableId, opts) {
|
|
412
404
|
return this.http.request("GET", "/v1/stores/{storeId}/custom-variables/{customVariableId}", { path: { customVariableId }, opts });
|
|
413
405
|
}
|
|
414
406
|
/**
|
|
@@ -416,7 +408,7 @@ class CustomVariablesResource {
|
|
|
416
408
|
*
|
|
417
409
|
* Retrieves all custom variables for the specified store.
|
|
418
410
|
*/
|
|
419
|
-
|
|
411
|
+
getCustomVariables(opts) {
|
|
420
412
|
return this.http.request("GET", "/v1/stores/{storeId}/custom-variables", { opts });
|
|
421
413
|
}
|
|
422
414
|
/**
|
|
@@ -426,29 +418,21 @@ class CustomVariablesResource {
|
|
|
426
418
|
* Only the fields specified in the request will be updated.
|
|
427
419
|
* @param customVariableId The ID of the custom variable to update.
|
|
428
420
|
*/
|
|
429
|
-
|
|
421
|
+
updateCustomVariable(customVariableId, body, opts) {
|
|
430
422
|
return this.http.request("PATCH", "/v1/stores/{storeId}/custom-variables/{customVariableId}", { path: { customVariableId }, body, opts });
|
|
431
423
|
}
|
|
432
424
|
}
|
|
433
425
|
exports.CustomVariablesResource = CustomVariablesResource;
|
|
434
|
-
class DashboardResource {
|
|
435
|
-
http;
|
|
436
|
-
constructor(http) {
|
|
437
|
-
this.http = http;
|
|
438
|
-
}
|
|
439
|
-
getDashboardSearchHints(opts) {
|
|
440
|
-
return this.http.request("GET", "/v1/stores/{storeId}/dashboard/search-hints", { opts });
|
|
441
|
-
}
|
|
442
|
-
searchDashboard(query, opts) {
|
|
443
|
-
return this.http.request("GET", "/v1/stores/{storeId}/dashboard/search", { query, opts });
|
|
444
|
-
}
|
|
445
|
-
}
|
|
446
|
-
exports.DashboardResource = DashboardResource;
|
|
447
426
|
class DataMigrationsResource {
|
|
448
427
|
http;
|
|
449
428
|
constructor(http) {
|
|
450
429
|
this.http = http;
|
|
451
430
|
}
|
|
431
|
+
/**
|
|
432
|
+
* Get data migrations
|
|
433
|
+
*
|
|
434
|
+
* Retrieves all data migration tasks for the specified store.
|
|
435
|
+
*/
|
|
452
436
|
getDataMigrations(query, opts) {
|
|
453
437
|
return this.http.request("GET", "/v1/stores/{storeId}/data-migrations", { query, opts });
|
|
454
438
|
}
|
|
@@ -466,6 +450,7 @@ class DeliveryResource {
|
|
|
466
450
|
* Assign a delivery item to a customer
|
|
467
451
|
*
|
|
468
452
|
* Allows you to assign a delivery item to a customer
|
|
453
|
+
* @param customerId The ID of the customer to assign the delivery item to.
|
|
469
454
|
*/
|
|
470
455
|
assignDeliveryItem(customerId, body, opts) {
|
|
471
456
|
return this.http.request("POST", "/v1/stores/{storeId}/customers/{customerId}/delivery/items", { path: { customerId }, body, opts });
|
|
@@ -482,6 +467,7 @@ class DeliveryResource {
|
|
|
482
467
|
* Get command attempts associated with a customer
|
|
483
468
|
*
|
|
484
469
|
* Retrieves command attempts associated with a customer
|
|
470
|
+
* @param customerId The ID of the customer.
|
|
485
471
|
*/
|
|
486
472
|
getCommandAttemptsForCustomer(customerId, query, opts) {
|
|
487
473
|
return this.http.request("GET", "/v1/stores/{storeId}/customers/{customerId}/delivery/commands", { path: { customerId }, query, opts });
|
|
@@ -490,12 +476,16 @@ class DeliveryResource {
|
|
|
490
476
|
* Get delivery items associated with a customer
|
|
491
477
|
*
|
|
492
478
|
* Retrieves delivery items associated with a customer
|
|
479
|
+
* @param customerId The ID of the customer.
|
|
493
480
|
*/
|
|
494
481
|
getCustomerDeliveryItems(customerId, query, opts) {
|
|
495
482
|
return this.http.request("GET", "/v1/stores/{storeId}/customers/{customerId}/delivery/items", { path: { customerId }, query, opts });
|
|
496
483
|
}
|
|
497
484
|
/**
|
|
498
485
|
* Returns delivery items in which an associated command attempt is for the gameserver
|
|
486
|
+
*
|
|
487
|
+
* Retrieves all delivery items that have a command attempt targeting the game server.
|
|
488
|
+
* @param gameServerId The ID of the game server.
|
|
499
489
|
*/
|
|
500
490
|
getGameServerDeliveryItems(gameServerId, query, opts) {
|
|
501
491
|
return this.http.request("GET", "/v1/stores/{storeId}/gameservers/{gameServerId}/delivery/items", { path: { gameServerId }, query, opts });
|
|
@@ -522,6 +512,9 @@ class DeliveryResource {
|
|
|
522
512
|
}
|
|
523
513
|
/**
|
|
524
514
|
* Resend commands for a given Gameserver
|
|
515
|
+
*
|
|
516
|
+
* Re-enqueues delivery commands for a game server, narrowed by the filters in the request body.
|
|
517
|
+
* @param gameServerId The ID of the game server.
|
|
525
518
|
*/
|
|
526
519
|
resendDeliveryCommandsForGameServer(gameServerId, body, opts) {
|
|
527
520
|
return this.http.request("POST", "/v1/stores/{storeId}/gameservers/{gameServerId}/delivery/commands/resend", { path: { gameServerId }, body, opts });
|
|
@@ -547,44 +540,123 @@ class DiscordResource {
|
|
|
547
540
|
constructor(http) {
|
|
548
541
|
this.http = http;
|
|
549
542
|
}
|
|
543
|
+
/**
|
|
544
|
+
* Set product version Discord actions
|
|
545
|
+
*
|
|
546
|
+
* Replaces the Discord actions configured for a product version in the specified store.
|
|
547
|
+
* @param productVersionId The ID of the product version.
|
|
548
|
+
*/
|
|
550
549
|
createAction(productVersionId, body, opts) {
|
|
551
550
|
return this.http.request("PUT", "/v1/stores/{storeId}/product_versions/{productVersionId}/discord_actions", { path: { productVersionId }, body, opts });
|
|
552
551
|
}
|
|
552
|
+
/**
|
|
553
|
+
* Create Discord server link
|
|
554
|
+
*
|
|
555
|
+
* Creates a new link token that can be used to connect a Discord server to the specified store.
|
|
556
|
+
*/
|
|
553
557
|
createDiscordServerLink(opts) {
|
|
554
558
|
return this.http.request("POST", "/v1/stores/{storeId}/discord/links", {
|
|
555
559
|
opts,
|
|
556
560
|
});
|
|
557
561
|
}
|
|
562
|
+
/**
|
|
563
|
+
* Delete Discord server link
|
|
564
|
+
*
|
|
565
|
+
* Deletes a Discord server link by the token for the specified store.
|
|
566
|
+
* @param token The token of the Discord server link.
|
|
567
|
+
*/
|
|
558
568
|
deleteDiscordServerLinks(token, opts) {
|
|
559
|
-
return this.http.request("DELETE", "/v1/stores/{storeId}/discord/links/{token}", {
|
|
569
|
+
return this.http.request("DELETE", "/v1/stores/{storeId}/discord/links/{token}", {
|
|
570
|
+
path: { token },
|
|
571
|
+
opts,
|
|
572
|
+
});
|
|
560
573
|
}
|
|
574
|
+
/**
|
|
575
|
+
* Unlink Discord user from delivery item
|
|
576
|
+
*
|
|
577
|
+
* Removes the Discord user link from a delivery item in the specified store.
|
|
578
|
+
* @param inventoryItemId The ID of the delivery item.
|
|
579
|
+
*/
|
|
561
580
|
deleteUserToDeliveryItemLink(inventoryItemId, opts) {
|
|
562
581
|
return this.http.request("DELETE", "/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/link", { path: { inventoryItemId }, opts });
|
|
563
582
|
}
|
|
583
|
+
/**
|
|
584
|
+
* Get product version Discord actions
|
|
585
|
+
*
|
|
586
|
+
* Retrieves all Discord actions configured for a product version in the specified store.
|
|
587
|
+
* @param productVersionId The ID of the product version.
|
|
588
|
+
*/
|
|
564
589
|
getActions(productVersionId, opts) {
|
|
565
590
|
return this.http.request("GET", "/v1/stores/{storeId}/product_versions/{productVersionId}/discord_actions", { path: { productVersionId }, opts });
|
|
566
591
|
}
|
|
592
|
+
/**
|
|
593
|
+
* Get Discord action execution history
|
|
594
|
+
*
|
|
595
|
+
* Retrieves the history of Discord actions executed for an order in the specified store.
|
|
596
|
+
* @param orderId The ID of the order.
|
|
597
|
+
*/
|
|
567
598
|
getDiscordActionExecutionHistory(orderId, opts) {
|
|
568
599
|
return this.http.request("GET", "/v1/stores/{storeId}/orders/{orderId}/discord/queued", { path: { orderId }, opts });
|
|
569
600
|
}
|
|
601
|
+
/**
|
|
602
|
+
* Get Discord server links
|
|
603
|
+
*
|
|
604
|
+
* Retrieves all Discord server links for the specified store.
|
|
605
|
+
*/
|
|
570
606
|
getDiscordServerLinks(opts) {
|
|
571
607
|
return this.http.request("GET", "/v1/stores/{storeId}/discord/links", { opts });
|
|
572
608
|
}
|
|
609
|
+
/**
|
|
610
|
+
* Get Discord server roles
|
|
611
|
+
*
|
|
612
|
+
* Retrieves all roles for a Discord server linked to the specified store.
|
|
613
|
+
* @param discordServerId The ID of the Discord server.
|
|
614
|
+
*/
|
|
573
615
|
getDiscordServerRoles(discordServerId, opts) {
|
|
574
616
|
return this.http.request("GET", "/v1/stores/{storeId}/discord/{discordServerId}/roles", { path: { discordServerId }, opts });
|
|
575
617
|
}
|
|
618
|
+
/**
|
|
619
|
+
* Get Discord server text channels
|
|
620
|
+
*
|
|
621
|
+
* Retrieves all text channels for a Discord server linked to the specified store.
|
|
622
|
+
* @param discordServerId The ID of the Discord server.
|
|
623
|
+
*/
|
|
576
624
|
getDiscordServerTextChannels(discordServerId, opts) {
|
|
577
625
|
return this.http.request("GET", "/v1/stores/{storeId}/discord/{discordServerId}/discord/text_channels", { path: { discordServerId }, opts });
|
|
578
626
|
}
|
|
627
|
+
/**
|
|
628
|
+
* Get linked Discord accounts
|
|
629
|
+
*
|
|
630
|
+
* Retrieves the Discord accounts linked to an order for the specified store.
|
|
631
|
+
* @param orderId The ID of the order.
|
|
632
|
+
*/
|
|
579
633
|
getLinkedDiscordAccounts(orderId, opts) {
|
|
580
634
|
return this.http.request("GET", "/v1/stores/{storeId}/orders/{orderId}/discord", { path: { orderId }, opts });
|
|
581
635
|
}
|
|
636
|
+
/**
|
|
637
|
+
* Get queued Discord actions for delivery item
|
|
638
|
+
*
|
|
639
|
+
* Retrieves all queued Discord actions for a delivery item in the specified store.
|
|
640
|
+
* @param inventoryItemId The ID of the delivery item.
|
|
641
|
+
*/
|
|
582
642
|
getQueuedDiscordActionForDeliveryItem(inventoryItemId, opts) {
|
|
583
643
|
return this.http.request("GET", "/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/queued", { path: { inventoryItemId }, opts });
|
|
584
644
|
}
|
|
645
|
+
/**
|
|
646
|
+
* Get Discord user linked to delivery item
|
|
647
|
+
*
|
|
648
|
+
* Retrieves the Discord profile linked to a delivery item in the specified store.
|
|
649
|
+
* @param inventoryItemId The ID of the delivery item.
|
|
650
|
+
*/
|
|
585
651
|
getUserToDeliveryItemLinks(inventoryItemId, opts) {
|
|
586
652
|
return this.http.request("GET", "/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/link", { path: { inventoryItemId }, opts });
|
|
587
653
|
}
|
|
654
|
+
/**
|
|
655
|
+
* Link Discord user to delivery item
|
|
656
|
+
*
|
|
657
|
+
* Links a Discord user to a delivery item in the specified store.
|
|
658
|
+
* @param inventoryItemId The ID of the delivery item.
|
|
659
|
+
*/
|
|
588
660
|
setUserToDeliveryItemLink(inventoryItemId, query, opts) {
|
|
589
661
|
return this.http.request("PUT", "/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/link", { path: { inventoryItemId }, query, opts });
|
|
590
662
|
}
|
|
@@ -604,6 +676,12 @@ class DownloadableFilesResource {
|
|
|
604
676
|
finishDownloadableFileUpload(productId, downloadableFileId, opts) {
|
|
605
677
|
return this.http.request("POST", "/v1/stores/{storeId}/products/{productId}/downloadable-files/{downloadableFileId}/finish", { path: { productId, downloadableFileId }, opts });
|
|
606
678
|
}
|
|
679
|
+
/**
|
|
680
|
+
* Get downloadable files
|
|
681
|
+
*
|
|
682
|
+
* Retrieves all downloadable files for a product in the specified store.
|
|
683
|
+
* @param productId The ID of the product.
|
|
684
|
+
*/
|
|
607
685
|
getDownloadableFiles(productId, opts) {
|
|
608
686
|
return this.http.request("GET", "/v1/stores/{storeId}/products/{productId}/downloadable-files", { path: { productId }, opts });
|
|
609
687
|
}
|
|
@@ -619,6 +697,8 @@ class GameServersResource {
|
|
|
619
697
|
}
|
|
620
698
|
/**
|
|
621
699
|
* Create a new Game Server for a store
|
|
700
|
+
*
|
|
701
|
+
* Creates a new game server in the specified store.
|
|
622
702
|
*/
|
|
623
703
|
createGameServer(body, opts) {
|
|
624
704
|
return this.http.request("POST", "/v1/stores/{storeId}/gameservers", {
|
|
@@ -628,6 +708,9 @@ class GameServersResource {
|
|
|
628
708
|
}
|
|
629
709
|
/**
|
|
630
710
|
* Create a console for a game server.
|
|
711
|
+
*
|
|
712
|
+
* Creates a new console for a game server in the specified store.
|
|
713
|
+
* @param gameServerId The ID of the game server.
|
|
631
714
|
*/
|
|
632
715
|
createGameServerConsole(gameServerId, body, opts) {
|
|
633
716
|
return this.http.request("POST", "/v1/stores/{storeId}/gameservers/{gameServerId}/console", { path: { gameServerId }, body, opts });
|
|
@@ -643,30 +726,44 @@ class GameServersResource {
|
|
|
643
726
|
}
|
|
644
727
|
/**
|
|
645
728
|
* Delete an associated game server console.
|
|
729
|
+
*
|
|
730
|
+
* Deletes the console associated with a game server in the specified store.
|
|
731
|
+
* @param gameServerId The ID of the game server.
|
|
646
732
|
*/
|
|
647
733
|
deleteGameServerConsole(gameServerId, opts) {
|
|
648
734
|
return this.http.request("DELETE", "/v1/stores/{storeId}/gameservers/{gameServerId}/console", { path: { gameServerId }, opts });
|
|
649
735
|
}
|
|
650
736
|
/**
|
|
651
737
|
* Get a Game Server by ID for a store
|
|
738
|
+
*
|
|
739
|
+
* Retrieves a game server by the ID for the specified store.
|
|
740
|
+
* @param gameServerId The ID of the game server.
|
|
652
741
|
*/
|
|
653
742
|
getGameServer(gameServerId, opts) {
|
|
654
743
|
return this.http.request("GET", "/v1/stores/{storeId}/gameservers/{gameServerId}", { path: { gameServerId }, opts });
|
|
655
744
|
}
|
|
656
745
|
/**
|
|
657
746
|
* Get the associated console for a game server.
|
|
747
|
+
*
|
|
748
|
+
* Retrieves the console associated with a game server in the specified store.
|
|
749
|
+
* @param gameServerId The ID of the game server.
|
|
658
750
|
*/
|
|
659
751
|
getGameServerConsole(gameServerId, opts) {
|
|
660
752
|
return this.http.request("GET", "/v1/stores/{storeId}/gameservers/{gameServerId}/console", { path: { gameServerId }, opts });
|
|
661
753
|
}
|
|
662
754
|
/**
|
|
663
755
|
* Get console messages for a game server.
|
|
756
|
+
*
|
|
757
|
+
* Retrieves recent console messages for a game server in the specified store.
|
|
758
|
+
* @param gameServerId The ID of the game server.
|
|
664
759
|
*/
|
|
665
760
|
getGameServerConsoleMessages(gameServerId, opts) {
|
|
666
761
|
return this.http.request("GET", "/v1/stores/{storeId}/gameservers/{gameServerId}/console/messages", { path: { gameServerId }, opts });
|
|
667
762
|
}
|
|
668
763
|
/**
|
|
669
764
|
* Get Game Servers for a store
|
|
765
|
+
*
|
|
766
|
+
* Retrieves all game servers for the specified store.
|
|
670
767
|
*/
|
|
671
768
|
getGameServers(opts) {
|
|
672
769
|
return this.http.request("GET", "/v1/stores/{storeId}/gameservers", {
|
|
@@ -681,12 +778,18 @@ class GameServersResource {
|
|
|
681
778
|
}
|
|
682
779
|
/**
|
|
683
780
|
* Update a Game Server By ID for a store
|
|
781
|
+
*
|
|
782
|
+
* Performs a delta update of a game server by the ID for the specified store.
|
|
783
|
+
* @param gameServerId The ID of the game server.
|
|
684
784
|
*/
|
|
685
785
|
updateGameServer(gameServerId, body, opts) {
|
|
686
786
|
return this.http.request("PATCH", "/v1/stores/{storeId}/gameservers/{gameServerId}", { path: { gameServerId }, body, opts });
|
|
687
787
|
}
|
|
688
788
|
/**
|
|
689
789
|
* Update a console for a game server.
|
|
790
|
+
*
|
|
791
|
+
* Performs a delta update of the console for a game server in the specified store.
|
|
792
|
+
* @param gameServerId The ID of the game server.
|
|
690
793
|
*/
|
|
691
794
|
updateGameServerConsole(gameServerId, body, opts) {
|
|
692
795
|
return this.http.request("PATCH", "/v1/stores/{storeId}/gameservers/{gameServerId}/console", { path: { gameServerId }, body, opts });
|
|
@@ -700,12 +803,17 @@ class GiftcardsResource {
|
|
|
700
803
|
}
|
|
701
804
|
/**
|
|
702
805
|
* Create a Gift Card for a store
|
|
806
|
+
*
|
|
807
|
+
* Creates a new gift card in the specified store.
|
|
703
808
|
*/
|
|
704
809
|
createGiftCard(body, opts) {
|
|
705
810
|
return this.http.request("POST", "/v1/stores/{storeId}/giftcards", { body, opts });
|
|
706
811
|
}
|
|
707
812
|
/**
|
|
708
813
|
* Delete a Gift Card By ID for a store
|
|
814
|
+
*
|
|
815
|
+
* Deletes a gift card by the ID for the specified store.
|
|
816
|
+
* @param giftCardId The ID of the gift card.
|
|
709
817
|
*/
|
|
710
818
|
deleteGiftCard(giftCardId, opts) {
|
|
711
819
|
return this.http.request("DELETE", "/v1/stores/{storeId}/giftcards/{giftCardId}", {
|
|
@@ -715,6 +823,9 @@ class GiftcardsResource {
|
|
|
715
823
|
}
|
|
716
824
|
/**
|
|
717
825
|
* Get a Gift Card By ID for a store
|
|
826
|
+
*
|
|
827
|
+
* Retrieves a gift card by the ID for the specified store.
|
|
828
|
+
* @param giftCardId The ID of the gift card.
|
|
718
829
|
*/
|
|
719
830
|
getGiftCard(giftCardId, opts) {
|
|
720
831
|
return this.http.request("GET", "/v1/stores/{storeId}/giftcards/{giftCardId}", {
|
|
@@ -724,6 +835,8 @@ class GiftcardsResource {
|
|
|
724
835
|
}
|
|
725
836
|
/**
|
|
726
837
|
* Get Gift Cards for a store
|
|
838
|
+
*
|
|
839
|
+
* Retrieves all gift cards for the specified store.
|
|
727
840
|
*/
|
|
728
841
|
getGiftCards(query, opts) {
|
|
729
842
|
return this.http.request("GET", "/v1/stores/{storeId}/giftcards", {
|
|
@@ -733,6 +846,9 @@ class GiftcardsResource {
|
|
|
733
846
|
}
|
|
734
847
|
/**
|
|
735
848
|
* Update a Gift Card By ID for a store
|
|
849
|
+
*
|
|
850
|
+
* Performs a delta update of a gift card by the ID for the specified store.
|
|
851
|
+
* @param giftCardId The ID of the gift card.
|
|
736
852
|
*/
|
|
737
853
|
updateGiftCard(giftCardId, body, opts) {
|
|
738
854
|
return this.http.request("PATCH", "/v1/stores/{storeId}/giftcards/{giftCardId}", {
|
|
@@ -780,6 +896,7 @@ class GlobalCommandsResource {
|
|
|
780
896
|
* Update global command
|
|
781
897
|
*
|
|
782
898
|
* Updates a global command for a store.
|
|
899
|
+
* @param globalCommandId The ID of the global command.
|
|
783
900
|
*/
|
|
784
901
|
updateGlobalCommand(globalCommandId, body, opts) {
|
|
785
902
|
return this.http.request("PATCH", "/v1/stores/{storeId}/global-commands/{globalCommandId}", { path: { globalCommandId }, body, opts });
|
|
@@ -863,72 +980,153 @@ class MarketingResource {
|
|
|
863
980
|
constructor(http) {
|
|
864
981
|
this.http = http;
|
|
865
982
|
}
|
|
983
|
+
/**
|
|
984
|
+
* Activate email template by ID
|
|
985
|
+
*
|
|
986
|
+
* Activates an email template by the ID for the specified store, so it is sent in place of the
|
|
987
|
+
* default template for its type.
|
|
988
|
+
* @param templateId The ID of the email template.
|
|
989
|
+
*/
|
|
866
990
|
activateEmailTemplate(templateId, opts) {
|
|
867
991
|
return this.http.request("POST", "/v1/stores/{storeId}/marketing/email/templates/{templateId}/activate", { path: { templateId }, opts });
|
|
868
992
|
}
|
|
993
|
+
/**
|
|
994
|
+
* Create email template
|
|
995
|
+
*
|
|
996
|
+
* Creates a new email template in the specified store.
|
|
997
|
+
*/
|
|
869
998
|
createEmailTemplate(body, opts) {
|
|
870
999
|
return this.http.request("POST", "/v1/stores/{storeId}/marketing/email/templates", { body, opts });
|
|
871
1000
|
}
|
|
1001
|
+
/**
|
|
1002
|
+
* Deactivate email template by ID
|
|
1003
|
+
*
|
|
1004
|
+
* Deactivates an email template by the ID for the specified store, so the default template for
|
|
1005
|
+
* its type is sent instead.
|
|
1006
|
+
* @param templateId The ID of the email template.
|
|
1007
|
+
*/
|
|
872
1008
|
deactivateEmailTemplate(templateId, opts) {
|
|
873
1009
|
return this.http.request("POST", "/v1/stores/{storeId}/marketing/email/templates/{templateId}/deactivate", { path: { templateId }, opts });
|
|
874
1010
|
}
|
|
1011
|
+
/**
|
|
1012
|
+
* Deactivate email template by type
|
|
1013
|
+
*
|
|
1014
|
+
* Deactivates the active email template of the supplied type for the specified store.
|
|
1015
|
+
*/
|
|
875
1016
|
deactivateEmailTemplateByType(body, opts) {
|
|
876
1017
|
return this.http.request("POST", "/v1/stores/{storeId}/marketing/email/templates/deactivate", { body, opts });
|
|
877
1018
|
}
|
|
1019
|
+
/**
|
|
1020
|
+
* Delete email template by ID
|
|
1021
|
+
*
|
|
1022
|
+
* Deletes an email template by the ID for the specified store.
|
|
1023
|
+
* @param templateId The ID of the email template.
|
|
1024
|
+
*/
|
|
878
1025
|
deleteEmailTemplate(templateId, opts) {
|
|
879
1026
|
return this.http.request("DELETE", "/v1/stores/{storeId}/marketing/email/templates/{templateId}", { path: { templateId }, opts });
|
|
880
1027
|
}
|
|
881
1028
|
finishEmailBrandingImageUpload(body, opts) {
|
|
882
1029
|
return this.http.request("POST", "/v1/stores/{storeId}/marketing/email/branding/image-upload-finish", { body, opts });
|
|
883
1030
|
}
|
|
1031
|
+
/**
|
|
1032
|
+
* Get email branding
|
|
1033
|
+
*
|
|
1034
|
+
* Retrieves the email branding for the specified store.
|
|
1035
|
+
*/
|
|
884
1036
|
getEmailBranding(opts) {
|
|
885
1037
|
return this.http.request("GET", "/v1/stores/{storeId}/marketing/email/branding", { opts });
|
|
886
1038
|
}
|
|
887
1039
|
getEmailBrandingImageUploadUrl(query, opts) {
|
|
888
1040
|
return this.http.request("GET", "/v1/stores/{storeId}/marketing/email/branding/image-upload-url", { query, opts });
|
|
889
1041
|
}
|
|
1042
|
+
/**
|
|
1043
|
+
* Get email deliveries
|
|
1044
|
+
*
|
|
1045
|
+
* Retrieves all email deliveries for the specified store.
|
|
1046
|
+
*/
|
|
890
1047
|
getEmailDeliveries(query, opts) {
|
|
891
1048
|
return this.http.request("GET", "/v1/stores/{storeId}/marketing/email/deliveries", { query, opts });
|
|
892
1049
|
}
|
|
1050
|
+
/**
|
|
1051
|
+
* Get email delivery by ID
|
|
1052
|
+
*
|
|
1053
|
+
* Retrieves an email delivery by the ID for the specified store.
|
|
1054
|
+
* @param emailDeliveryId The ID of the email delivery.
|
|
1055
|
+
*/
|
|
893
1056
|
getEmailDelivery(emailDeliveryId, opts) {
|
|
894
1057
|
return this.http.request("GET", "/v1/stores/{storeId}/marketing/email/deliveries/{emailDeliveryId}", { path: { emailDeliveryId }, opts });
|
|
895
1058
|
}
|
|
1059
|
+
/**
|
|
1060
|
+
* Get email template by ID
|
|
1061
|
+
*
|
|
1062
|
+
* Retrieves an email template by the ID for the specified store.
|
|
1063
|
+
* @param templateId The ID of the email template.
|
|
1064
|
+
*/
|
|
896
1065
|
getEmailTemplate(templateId, opts) {
|
|
897
1066
|
return this.http.request("GET", "/v1/stores/{storeId}/marketing/email/templates/{templateId}", { path: { templateId }, opts });
|
|
898
1067
|
}
|
|
1068
|
+
/**
|
|
1069
|
+
* Get email template definitions
|
|
1070
|
+
*
|
|
1071
|
+
* Retrieves the email template definitions available to the specified store.
|
|
1072
|
+
*/
|
|
899
1073
|
getEmailTemplateDefinitions(opts) {
|
|
900
1074
|
return this.http.request("GET", "/v1/stores/{storeId}/marketing/email/template-definitions", { opts });
|
|
901
1075
|
}
|
|
1076
|
+
/**
|
|
1077
|
+
* Get email templates
|
|
1078
|
+
*
|
|
1079
|
+
* Retrieves all email templates for the specified store.
|
|
1080
|
+
*/
|
|
902
1081
|
getEmailTemplates(query, opts) {
|
|
903
1082
|
return this.http.request("GET", "/v1/stores/{storeId}/marketing/email/templates", { query, opts });
|
|
904
1083
|
}
|
|
905
1084
|
/**
|
|
906
1085
|
* Gets the abandoned checkout behaviour for a store
|
|
1086
|
+
*
|
|
1087
|
+
* Retrieves the abandoned checkout configuration for the specified store.
|
|
907
1088
|
*/
|
|
908
1089
|
getStoreAbandonedCheckoutConfigurationOptions(opts) {
|
|
909
1090
|
return this.http.request("GET", "/v1/stores/{storeId}/marketing/abandoned-checkouts/configuration", { opts });
|
|
910
1091
|
}
|
|
911
1092
|
/**
|
|
912
1093
|
* Gets the purchase follow up behaviour for a store
|
|
1094
|
+
*
|
|
1095
|
+
* Retrieves the purchase follow up configuration for the specified store.
|
|
913
1096
|
*/
|
|
914
1097
|
getStorePurchaseFollowUpConfigurationOptions(opts) {
|
|
915
1098
|
return this.http.request("GET", "/v1/stores/{storeId}/marketing/purchase-follow-ups/configuration", { opts });
|
|
916
1099
|
}
|
|
917
1100
|
/**
|
|
918
1101
|
* Sets the abandoned checkout behaviour for a store
|
|
1102
|
+
*
|
|
1103
|
+
* Updates the abandoned checkout configuration for the specified store.
|
|
919
1104
|
*/
|
|
920
1105
|
setStoreAbandonedCheckoutConfigurationOptions(body, opts) {
|
|
921
1106
|
return this.http.request("PUT", "/v1/stores/{storeId}/marketing/abandoned-checkouts/configuration", { body, opts });
|
|
922
1107
|
}
|
|
923
1108
|
/**
|
|
924
1109
|
* Sets the purchase follow up behaviour for a store
|
|
1110
|
+
*
|
|
1111
|
+
* Updates the purchase follow up configuration for the specified store.
|
|
925
1112
|
*/
|
|
926
1113
|
setStorePurchaseFollowUpConfigurationOptions(body, opts) {
|
|
927
1114
|
return this.http.request("PUT", "/v1/stores/{storeId}/marketing/purchase-follow-ups/configuration", { body, opts });
|
|
928
1115
|
}
|
|
1116
|
+
/**
|
|
1117
|
+
* Update email branding
|
|
1118
|
+
*
|
|
1119
|
+
* Performs a delta update of the email branding for the specified store.
|
|
1120
|
+
*/
|
|
929
1121
|
updateEmailBranding(body, opts) {
|
|
930
1122
|
return this.http.request("PATCH", "/v1/stores/{storeId}/marketing/email/branding", { body, opts });
|
|
931
1123
|
}
|
|
1124
|
+
/**
|
|
1125
|
+
* Update email template by ID
|
|
1126
|
+
*
|
|
1127
|
+
* Performs a delta update of an email template by the ID for the specified store.
|
|
1128
|
+
* @param templateId The ID of the email template.
|
|
1129
|
+
*/
|
|
932
1130
|
updateEmailTemplate(templateId, body, opts) {
|
|
933
1131
|
return this.http.request("PATCH", "/v1/stores/{storeId}/marketing/email/templates/{templateId}", { path: { templateId }, body, opts });
|
|
934
1132
|
}
|
|
@@ -941,12 +1139,17 @@ class NavlinksResource {
|
|
|
941
1139
|
}
|
|
942
1140
|
/**
|
|
943
1141
|
* Create a new NavLink for a store
|
|
1142
|
+
*
|
|
1143
|
+
* Creates a new navigation link in the specified store.
|
|
944
1144
|
*/
|
|
945
1145
|
createNavLink(body, opts) {
|
|
946
1146
|
return this.http.request("POST", "/v1/stores/{storeId}/navlinks", { body, opts });
|
|
947
1147
|
}
|
|
948
1148
|
/**
|
|
949
1149
|
* Delete a NavLink for a store
|
|
1150
|
+
*
|
|
1151
|
+
* Deletes a navigation link by the ID for the specified store.
|
|
1152
|
+
* @param navLinkId The ID of the navigation link.
|
|
950
1153
|
*/
|
|
951
1154
|
deleteNavLink(navLinkId, opts) {
|
|
952
1155
|
return this.http.request("DELETE", "/v1/stores/{storeId}/navlinks/{navLinkId}", {
|
|
@@ -956,6 +1159,9 @@ class NavlinksResource {
|
|
|
956
1159
|
}
|
|
957
1160
|
/**
|
|
958
1161
|
* Get a NavLink by ID for a store
|
|
1162
|
+
*
|
|
1163
|
+
* Retrieves a navigation link by the ID for the specified store.
|
|
1164
|
+
* @param navLinkId The ID of the navigation link.
|
|
959
1165
|
*/
|
|
960
1166
|
getNavLink(navLinkId, opts) {
|
|
961
1167
|
return this.http.request("GET", "/v1/stores/{storeId}/navlinks/{navLinkId}", {
|
|
@@ -965,12 +1171,17 @@ class NavlinksResource {
|
|
|
965
1171
|
}
|
|
966
1172
|
/**
|
|
967
1173
|
* Get all NavLinks for a store
|
|
1174
|
+
*
|
|
1175
|
+
* Retrieves all navigation links for the specified store.
|
|
968
1176
|
*/
|
|
969
1177
|
getNavLinks(opts) {
|
|
970
1178
|
return this.http.request("GET", "/v1/stores/{storeId}/navlinks", { opts });
|
|
971
1179
|
}
|
|
972
1180
|
/**
|
|
973
1181
|
* Update a NavLink By ID for a store
|
|
1182
|
+
*
|
|
1183
|
+
* Performs a delta update of a navigation link by the ID for the specified store.
|
|
1184
|
+
* @param navLinkId The ID of the navigation link.
|
|
974
1185
|
*/
|
|
975
1186
|
updateNavLink(navLinkId, body, opts) {
|
|
976
1187
|
return this.http.request("PATCH", "/v1/stores/{storeId}/navlinks/{navLinkId}", {
|
|
@@ -981,6 +1192,8 @@ class NavlinksResource {
|
|
|
981
1192
|
}
|
|
982
1193
|
/**
|
|
983
1194
|
* Update the sort orders of NavLinks for a Store
|
|
1195
|
+
*
|
|
1196
|
+
* Updates the sort order of navigation links in the specified store.
|
|
984
1197
|
*/
|
|
985
1198
|
updateNavLinkOrder(body, opts) {
|
|
986
1199
|
return this.http.request("PATCH", "/v1/stores/{storeId}/navlinks/sort-orders", {
|
|
@@ -1073,6 +1286,7 @@ class PaymentsResource {
|
|
|
1073
1286
|
* Get payment by ID
|
|
1074
1287
|
*
|
|
1075
1288
|
* Retrieves a payment by an ID.
|
|
1289
|
+
* @param paymentId The ID of the payment.
|
|
1076
1290
|
*/
|
|
1077
1291
|
getPaymentById(paymentId, opts) {
|
|
1078
1292
|
return this.http.request("GET", "/v1/stores/{storeId}/payments/{paymentId}", {
|
|
@@ -1235,7 +1449,10 @@ class ProductsResource {
|
|
|
1235
1449
|
* Updates the sort order of products in the specified store.
|
|
1236
1450
|
*/
|
|
1237
1451
|
updateProductSortOrder(body, opts) {
|
|
1238
|
-
return this.http.request("POST", "/v1/stores/{storeId}/products/sort-order", {
|
|
1452
|
+
return this.http.request("POST", "/v1/stores/{storeId}/products/sort-order", {
|
|
1453
|
+
body,
|
|
1454
|
+
opts,
|
|
1455
|
+
});
|
|
1239
1456
|
}
|
|
1240
1457
|
}
|
|
1241
1458
|
exports.ProductsResource = ProductsResource;
|
|
@@ -1244,18 +1461,47 @@ class RegionalPricingResource {
|
|
|
1244
1461
|
constructor(http) {
|
|
1245
1462
|
this.http = http;
|
|
1246
1463
|
}
|
|
1464
|
+
/**
|
|
1465
|
+
* Get product pricing regions
|
|
1466
|
+
*
|
|
1467
|
+
* Retrieves the regional pricing for a product in the specified store.
|
|
1468
|
+
* @param productId The ID of the product.
|
|
1469
|
+
*/
|
|
1247
1470
|
getProductPricingRegions(productId, opts) {
|
|
1248
1471
|
return this.http.request("GET", "/v1/stores/{storeId}/products/{productId}/pricing/regions", { path: { productId }, opts });
|
|
1249
1472
|
}
|
|
1473
|
+
/**
|
|
1474
|
+
* Get pricing region groups
|
|
1475
|
+
*
|
|
1476
|
+
* Retrieves the pricing region groups available to the specified store.
|
|
1477
|
+
*/
|
|
1250
1478
|
getStorePricingRegionGroups(opts) {
|
|
1251
1479
|
return this.http.request("GET", "/v1/stores/{storeId}/products/pricing/region-groups", { opts });
|
|
1252
1480
|
}
|
|
1481
|
+
/**
|
|
1482
|
+
* Get store pricing regions
|
|
1483
|
+
*
|
|
1484
|
+
* Retrieves the regional pricing configuration for the specified store.
|
|
1485
|
+
*/
|
|
1253
1486
|
getStorePricingRegions(opts) {
|
|
1254
1487
|
return this.http.request("GET", "/v1/stores/{storeId}/products/pricing/regions", { opts });
|
|
1255
1488
|
}
|
|
1489
|
+
/**
|
|
1490
|
+
* Update product pricing region
|
|
1491
|
+
*
|
|
1492
|
+
* Performs a delta update of the regional pricing override for a product in the specified store.
|
|
1493
|
+
* @param productId The ID of the product.
|
|
1494
|
+
* @param regionId The ID of the pricing region.
|
|
1495
|
+
*/
|
|
1256
1496
|
setProductPricingRegionOverride(productId, regionId, body, opts) {
|
|
1257
1497
|
return this.http.request("PATCH", "/v1/stores/{storeId}/products/{productId}/pricing/regions/{regionId}", { path: { productId, regionId }, body, opts });
|
|
1258
1498
|
}
|
|
1499
|
+
/**
|
|
1500
|
+
* Update store pricing region
|
|
1501
|
+
*
|
|
1502
|
+
* Performs a delta update of the regional pricing override for the specified store.
|
|
1503
|
+
* @param regionId The ID of the pricing region.
|
|
1504
|
+
*/
|
|
1259
1505
|
setStorePricingRegionOverride(regionId, body, opts) {
|
|
1260
1506
|
return this.http.request("PATCH", "/v1/stores/{storeId}/products/pricing/regions/{regionId}", { path: { regionId }, body, opts });
|
|
1261
1507
|
}
|
|
@@ -1303,12 +1549,17 @@ class SalesResource {
|
|
|
1303
1549
|
}
|
|
1304
1550
|
/**
|
|
1305
1551
|
* Create a sale by ID for a store
|
|
1552
|
+
*
|
|
1553
|
+
* Creates a new sale in the specified store.
|
|
1306
1554
|
*/
|
|
1307
1555
|
createSale(body, opts) {
|
|
1308
1556
|
return this.http.request("POST", "/v1/stores/{storeId}/sales", { body, opts });
|
|
1309
1557
|
}
|
|
1310
1558
|
/**
|
|
1311
1559
|
* Delete a sale by ID for a store
|
|
1560
|
+
*
|
|
1561
|
+
* Deletes a sale by the ID for the specified store.
|
|
1562
|
+
* @param saleId The ID of the sale.
|
|
1312
1563
|
*/
|
|
1313
1564
|
deleteSaleById(saleId, opts) {
|
|
1314
1565
|
return this.http.request("DELETE", "/v1/stores/{storeId}/sales/{saleId}", {
|
|
@@ -1318,6 +1569,9 @@ class SalesResource {
|
|
|
1318
1569
|
}
|
|
1319
1570
|
/**
|
|
1320
1571
|
* Get a sale by ID for a store
|
|
1572
|
+
*
|
|
1573
|
+
* Retrieves a sale by the ID for the specified store.
|
|
1574
|
+
* @param saleId The ID of the sale.
|
|
1321
1575
|
*/
|
|
1322
1576
|
getSale(saleId, opts) {
|
|
1323
1577
|
return this.http.request("GET", "/v1/stores/{storeId}/sales/{saleId}", {
|
|
@@ -1327,12 +1581,17 @@ class SalesResource {
|
|
|
1327
1581
|
}
|
|
1328
1582
|
/**
|
|
1329
1583
|
* Get sales associated with a store.
|
|
1584
|
+
*
|
|
1585
|
+
* Retrieves all sales for the specified store.
|
|
1330
1586
|
*/
|
|
1331
1587
|
getSales(opts) {
|
|
1332
1588
|
return this.http.request("GET", "/v1/stores/{storeId}/sales", { opts });
|
|
1333
1589
|
}
|
|
1334
1590
|
/**
|
|
1335
1591
|
* Update a sale by ID for a store
|
|
1592
|
+
*
|
|
1593
|
+
* Performs a delta update of a sale by the ID for the specified store.
|
|
1594
|
+
* @param saleId The ID of the sale.
|
|
1336
1595
|
*/
|
|
1337
1596
|
updateSale(saleId, body, opts) {
|
|
1338
1597
|
return this.http.request("PATCH", "/v1/stores/{storeId}/sales/{saleId}", {
|
|
@@ -1544,12 +1803,17 @@ class TagsResource {
|
|
|
1544
1803
|
}
|
|
1545
1804
|
/**
|
|
1546
1805
|
* Create a new tag
|
|
1806
|
+
*
|
|
1807
|
+
* Creates a new tag in the specified store.
|
|
1547
1808
|
*/
|
|
1548
1809
|
createTag(body, opts) {
|
|
1549
1810
|
return this.http.request("POST", "/v1/stores/{storeId}/tags", { body, opts });
|
|
1550
1811
|
}
|
|
1551
1812
|
/**
|
|
1552
1813
|
* Delete a tag by ID
|
|
1814
|
+
*
|
|
1815
|
+
* Deletes a tag by the ID for the specified store.
|
|
1816
|
+
* @param tagId The ID of the tag.
|
|
1553
1817
|
*/
|
|
1554
1818
|
deleteTag(tagId, opts) {
|
|
1555
1819
|
return this.http.request("DELETE", "/v1/stores/{storeId}/tags/{tagId}", {
|
|
@@ -1561,6 +1825,7 @@ class TagsResource {
|
|
|
1561
1825
|
* Delete tag image
|
|
1562
1826
|
*
|
|
1563
1827
|
* Deletes an image for a tag
|
|
1828
|
+
* @param tagId The ID of the tag.
|
|
1564
1829
|
*/
|
|
1565
1830
|
deleteTagImage(tagId, opts) {
|
|
1566
1831
|
return this.http.request("DELETE", "/v1/stores/{storeId}/tags/{tagId}/image", {
|
|
@@ -1578,6 +1843,9 @@ class TagsResource {
|
|
|
1578
1843
|
}
|
|
1579
1844
|
/**
|
|
1580
1845
|
* Get a tag by an ID
|
|
1846
|
+
*
|
|
1847
|
+
* Retrieves a tag by the ID for the specified store.
|
|
1848
|
+
* @param tagId The ID of the tag.
|
|
1581
1849
|
*/
|
|
1582
1850
|
getTag(tagId, opts) {
|
|
1583
1851
|
return this.http.request("GET", "/v1/stores/{storeId}/tags/{tagId}", {
|
|
@@ -1595,12 +1863,17 @@ class TagsResource {
|
|
|
1595
1863
|
}
|
|
1596
1864
|
/**
|
|
1597
1865
|
* Get all tags for a store
|
|
1866
|
+
*
|
|
1867
|
+
* Retrieves all tags for the specified store.
|
|
1598
1868
|
*/
|
|
1599
1869
|
getTags(opts) {
|
|
1600
1870
|
return this.http.request("GET", "/v1/stores/{storeId}/tags", { opts });
|
|
1601
1871
|
}
|
|
1602
1872
|
/**
|
|
1603
1873
|
* Update a tag by ID
|
|
1874
|
+
*
|
|
1875
|
+
* Performs a delta update of a tag by the ID for the specified store.
|
|
1876
|
+
* @param tagId The ID of the tag.
|
|
1604
1877
|
*/
|
|
1605
1878
|
updateTag(tagId, body, opts) {
|
|
1606
1879
|
return this.http.request("PATCH", "/v1/stores/{storeId}/tags/{tagId}", {
|
|
@@ -1618,6 +1891,8 @@ class TierGroupsResource {
|
|
|
1618
1891
|
}
|
|
1619
1892
|
/**
|
|
1620
1893
|
* Create a new tier group
|
|
1894
|
+
*
|
|
1895
|
+
* Creates a new tier group in the specified store.
|
|
1621
1896
|
*/
|
|
1622
1897
|
createTierGroup(body, opts) {
|
|
1623
1898
|
return this.http.request("POST", "/v1/stores/{storeId}/tier-groups", {
|
|
@@ -1627,6 +1902,9 @@ class TierGroupsResource {
|
|
|
1627
1902
|
}
|
|
1628
1903
|
/**
|
|
1629
1904
|
* Delete a tier group by ID
|
|
1905
|
+
*
|
|
1906
|
+
* Deletes a tier group by the ID for the specified store.
|
|
1907
|
+
* @param tierGroupId The ID of the tier group.
|
|
1630
1908
|
*/
|
|
1631
1909
|
deleteTierGroup(tierGroupId, opts) {
|
|
1632
1910
|
return this.http.request("DELETE", "/v1/stores/{storeId}/tier-groups/{tierGroupId}", {
|
|
@@ -1636,12 +1914,17 @@ class TierGroupsResource {
|
|
|
1636
1914
|
}
|
|
1637
1915
|
/**
|
|
1638
1916
|
* Get a tier group by ID
|
|
1917
|
+
*
|
|
1918
|
+
* Retrieves a tier group by the ID for the specified store.
|
|
1919
|
+
* @param tierGroupId The ID of the tier group.
|
|
1639
1920
|
*/
|
|
1640
1921
|
getTierGroup(tierGroupId, opts) {
|
|
1641
1922
|
return this.http.request("GET", "/v1/stores/{storeId}/tier-groups/{tierGroupId}", { path: { tierGroupId }, opts });
|
|
1642
1923
|
}
|
|
1643
1924
|
/**
|
|
1644
1925
|
* List all tier groups for a store
|
|
1926
|
+
*
|
|
1927
|
+
* Retrieves all tier groups for the specified store.
|
|
1645
1928
|
*/
|
|
1646
1929
|
listTierGroups(opts) {
|
|
1647
1930
|
return this.http.request("GET", "/v1/stores/{storeId}/tier-groups", {
|
|
@@ -1650,6 +1933,9 @@ class TierGroupsResource {
|
|
|
1650
1933
|
}
|
|
1651
1934
|
/**
|
|
1652
1935
|
* Update a tier group by ID
|
|
1936
|
+
*
|
|
1937
|
+
* Performs a delta update of a tier group by the ID for the specified store.
|
|
1938
|
+
* @param tierGroupId The ID of the tier group.
|
|
1653
1939
|
*/
|
|
1654
1940
|
updateTierGroup(tierGroupId, body, opts) {
|
|
1655
1941
|
return this.http.request("PATCH", "/v1/stores/{storeId}/tier-groups/{tierGroupId}", { path: { tierGroupId }, body, opts });
|
|
@@ -1690,6 +1976,9 @@ class TrialsResource {
|
|
|
1690
1976
|
}
|
|
1691
1977
|
/**
|
|
1692
1978
|
* Get a trial by ID for a store
|
|
1979
|
+
*
|
|
1980
|
+
* Retrieves a trial by the ID for the specified store.
|
|
1981
|
+
* @param trialId The ID of the trial.
|
|
1693
1982
|
*/
|
|
1694
1983
|
getTrial(trialId, opts) {
|
|
1695
1984
|
return this.http.request("GET", "/v1/stores/{storeId}/trials/{trialId}", {
|
|
@@ -1699,6 +1988,8 @@ class TrialsResource {
|
|
|
1699
1988
|
}
|
|
1700
1989
|
/**
|
|
1701
1990
|
* Get trials for a store
|
|
1991
|
+
*
|
|
1992
|
+
* Retrieves all trials for the specified store.
|
|
1702
1993
|
*/
|
|
1703
1994
|
getTrials(query, opts) {
|
|
1704
1995
|
return this.http.request("GET", "/v1/stores/{storeId}/trials", {
|
|
@@ -1736,30 +2027,68 @@ class WebhooksResource {
|
|
|
1736
2027
|
constructor(http) {
|
|
1737
2028
|
this.http = http;
|
|
1738
2029
|
}
|
|
2030
|
+
/**
|
|
2031
|
+
* Create webhook
|
|
2032
|
+
*
|
|
2033
|
+
* Creates a new webhook subscription in the specified store.
|
|
2034
|
+
*/
|
|
1739
2035
|
createSubscription(body, opts) {
|
|
1740
2036
|
return this.http.request("POST", "/v1/stores/{storeId}/webhooks", {
|
|
1741
2037
|
body,
|
|
1742
2038
|
opts,
|
|
1743
2039
|
});
|
|
1744
2040
|
}
|
|
2041
|
+
/**
|
|
2042
|
+
* Delete webhook by ID
|
|
2043
|
+
*
|
|
2044
|
+
* Deletes a webhook subscription by the ID for the specified store.
|
|
2045
|
+
* @param webhookId The ID of the webhook.
|
|
2046
|
+
*/
|
|
1745
2047
|
deleteSubscription(webhookId, opts) {
|
|
1746
2048
|
return this.http.request("DELETE", "/v1/stores/{storeId}/webhooks/{webhookId}", {
|
|
1747
2049
|
path: { webhookId },
|
|
1748
2050
|
opts,
|
|
1749
2051
|
});
|
|
1750
2052
|
}
|
|
2053
|
+
/**
|
|
2054
|
+
* Get webhook history
|
|
2055
|
+
*
|
|
2056
|
+
* Retrieves the delivery history of a webhook subscription by the ID for the specified store.
|
|
2057
|
+
* @param webhookId The ID of the webhook.
|
|
2058
|
+
*/
|
|
1751
2059
|
getHistory(webhookId, query, opts) {
|
|
1752
2060
|
return this.http.request("GET", "/v1/stores/{storeId}/webhooks/{webhookId}/history", { path: { webhookId }, query, opts });
|
|
1753
2061
|
}
|
|
2062
|
+
/**
|
|
2063
|
+
* Get webhooks
|
|
2064
|
+
*
|
|
2065
|
+
* Retrieves all webhook subscriptions for the specified store.
|
|
2066
|
+
*/
|
|
1754
2067
|
getSubscriptions(opts) {
|
|
1755
2068
|
return this.http.request("GET", "/v1/stores/{storeId}/webhooks", { opts });
|
|
1756
2069
|
}
|
|
2070
|
+
/**
|
|
2071
|
+
* Get webhook variables
|
|
2072
|
+
*
|
|
2073
|
+
* Retrieves the variables available to webhook payload templates for the specified store.
|
|
2074
|
+
*/
|
|
1757
2075
|
getVariables(opts) {
|
|
1758
2076
|
return this.http.request("GET", "/v1/stores/{storeId}/webhooks/variables", { opts });
|
|
1759
2077
|
}
|
|
2078
|
+
/**
|
|
2079
|
+
* Resend webhook events
|
|
2080
|
+
*
|
|
2081
|
+
* Resends the supplied webhook events for the specified store.
|
|
2082
|
+
*/
|
|
1760
2083
|
resend(body, opts) {
|
|
1761
2084
|
return this.http.request("POST", "/v1/stores/{storeId}/webhooks/resend", { body, opts });
|
|
1762
2085
|
}
|
|
2086
|
+
/**
|
|
2087
|
+
* Update webhook by ID
|
|
2088
|
+
*
|
|
2089
|
+
* Performs a delta update of a webhook subscription by the ID for the specified store.
|
|
2090
|
+
* @param webhookId The ID of the webhook.
|
|
2091
|
+
*/
|
|
1763
2092
|
updateSubscription(webhookId, body, opts) {
|
|
1764
2093
|
return this.http.request("PATCH", "/v1/stores/{storeId}/webhooks/{webhookId}", { path: { webhookId }, body, opts });
|
|
1765
2094
|
}
|
|
@@ -1770,23 +2099,45 @@ class WebstoreResource {
|
|
|
1770
2099
|
constructor(http) {
|
|
1771
2100
|
this.http = http;
|
|
1772
2101
|
}
|
|
2102
|
+
/**
|
|
2103
|
+
* Create webstore module
|
|
2104
|
+
*
|
|
2105
|
+
* Adds a module to the store's webstore. The module's 'type' decides which 'settings' it accepts.
|
|
2106
|
+
*/
|
|
1773
2107
|
createWebstoreModule(body, opts) {
|
|
1774
|
-
return this.http.request("PUT", "/v1/
|
|
2108
|
+
return this.http.request("PUT", "/v1/stores/{storeId}/webstore/modules", {
|
|
1775
2109
|
body,
|
|
1776
2110
|
opts,
|
|
1777
2111
|
});
|
|
1778
2112
|
}
|
|
2113
|
+
/**
|
|
2114
|
+
* Create template
|
|
2115
|
+
*
|
|
2116
|
+
* Creates an empty template on the store's webstore. Add files to it, then set it as the
|
|
2117
|
+
* webstore's default template to serve it to customers.
|
|
2118
|
+
*/
|
|
1779
2119
|
createWebstoreTemplate(body, opts) {
|
|
1780
|
-
return this.http.request("PUT", "/v1/
|
|
1781
|
-
body,
|
|
1782
|
-
opts,
|
|
1783
|
-
});
|
|
2120
|
+
return this.http.request("PUT", "/v1/stores/{storeId}/webstore/templates", { body, opts });
|
|
1784
2121
|
}
|
|
2122
|
+
/**
|
|
2123
|
+
* Create template file
|
|
2124
|
+
*
|
|
2125
|
+
* Adds a file to a template. Its 'file_name' and 'content_type' decide where the file is served
|
|
2126
|
+
* from and whether it is public.
|
|
2127
|
+
* @param templateId The ID of the template to add the file to.
|
|
2128
|
+
*/
|
|
1785
2129
|
createWebstoreTemplateFile(templateId, body, opts) {
|
|
1786
|
-
return this.http.request("PUT", "/v1/
|
|
2130
|
+
return this.http.request("PUT", "/v1/stores/{storeId}/webstore/templates/{templateId}/files", { path: { templateId }, body, opts });
|
|
1787
2131
|
}
|
|
2132
|
+
/**
|
|
2133
|
+
* Create template variable
|
|
2134
|
+
*
|
|
2135
|
+
* Adds a variable to a template. Its 'variable' is the name the template's files reference it
|
|
2136
|
+
* by, and 'type' decides how 'value' is parsed when the template renders.
|
|
2137
|
+
* @param templateId The ID of the template to add the variable to.
|
|
2138
|
+
*/
|
|
1788
2139
|
createWebstoreTemplateVariable(templateId, body, opts) {
|
|
1789
|
-
return this.http.request("PUT", "/v1/
|
|
2140
|
+
return this.http.request("PUT", "/v1/stores/{storeId}/webstore/templates/{templateId}/variables", { path: { templateId }, body, opts });
|
|
1790
2141
|
}
|
|
1791
2142
|
/**
|
|
1792
2143
|
* Delete custom domain
|
|
@@ -1795,34 +2146,80 @@ class WebstoreResource {
|
|
|
1795
2146
|
* slug.
|
|
1796
2147
|
*/
|
|
1797
2148
|
deleteWebstoreCustomDomain(opts) {
|
|
1798
|
-
return this.http.request("DELETE", "/v1/
|
|
2149
|
+
return this.http.request("DELETE", "/v1/stores/{storeId}/webstore/custom-domain", {
|
|
2150
|
+
opts,
|
|
2151
|
+
});
|
|
1799
2152
|
}
|
|
2153
|
+
/**
|
|
2154
|
+
* Delete webstore module
|
|
2155
|
+
*
|
|
2156
|
+
* Permanently removes a module from the store's webstore.
|
|
2157
|
+
* @param moduleId The ID of the module.
|
|
2158
|
+
*/
|
|
1800
2159
|
deleteWebstoreModule(moduleId, opts) {
|
|
1801
|
-
return this.http.request("DELETE", "/v1/
|
|
2160
|
+
return this.http.request("DELETE", "/v1/stores/{storeId}/webstore/modules/{moduleId}", {
|
|
1802
2161
|
path: { moduleId },
|
|
1803
2162
|
opts,
|
|
1804
2163
|
});
|
|
1805
2164
|
}
|
|
2165
|
+
/**
|
|
2166
|
+
* Delete template
|
|
2167
|
+
*
|
|
2168
|
+
* Permanently deletes a template and all of its files. Switch the webstore to another template
|
|
2169
|
+
* first if this one is its current template.
|
|
2170
|
+
* @param templateId The ID of the template.
|
|
2171
|
+
*/
|
|
1806
2172
|
deleteWebstoreTemplate(templateId, opts) {
|
|
1807
|
-
return this.http.request("DELETE", "/v1/
|
|
1808
|
-
path: { templateId },
|
|
1809
|
-
opts,
|
|
1810
|
-
});
|
|
2173
|
+
return this.http.request("DELETE", "/v1/stores/{storeId}/webstore/templates/{templateId}", { path: { templateId }, opts });
|
|
1811
2174
|
}
|
|
2175
|
+
/**
|
|
2176
|
+
* Delete template file
|
|
2177
|
+
*
|
|
2178
|
+
* Permanently deletes a template file. Files whose 'is_deletable' is false cannot be removed.
|
|
2179
|
+
* @param templateId The ID of the template.
|
|
2180
|
+
* @param templateFileId The ID of the template file.
|
|
2181
|
+
*/
|
|
1812
2182
|
deleteWebstoreTemplateFile(templateId, templateFileId, opts) {
|
|
1813
|
-
return this.http.request("DELETE", "/v1/
|
|
2183
|
+
return this.http.request("DELETE", "/v1/stores/{storeId}/webstore/templates/{templateId}/files/{templateFileId}", { path: { templateId, templateFileId }, opts });
|
|
1814
2184
|
}
|
|
2185
|
+
/**
|
|
2186
|
+
* Delete template variable
|
|
2187
|
+
*
|
|
2188
|
+
* Permanently deletes a template variable.
|
|
2189
|
+
* @param templateId The ID of the template.
|
|
2190
|
+
* @param templateVariableId The ID of the template variable.
|
|
2191
|
+
*/
|
|
1815
2192
|
deleteWebstoreTemplateVariable(templateId, templateVariableId, opts) {
|
|
1816
|
-
return this.http.request("DELETE", "/v1/
|
|
2193
|
+
return this.http.request("DELETE", "/v1/stores/{storeId}/webstore/templates/{templateId}/variables/{templateVariableId}", { path: { templateId, templateVariableId }, opts });
|
|
1817
2194
|
}
|
|
2195
|
+
/**
|
|
2196
|
+
* Update template to latest version
|
|
2197
|
+
*
|
|
2198
|
+
* Downloads the newest published version of a marketplace template over the installed copy,
|
|
2199
|
+
* replacing its files.
|
|
2200
|
+
* @param templateId The ID of the template to update.
|
|
2201
|
+
*/
|
|
1818
2202
|
downloadWebstoreTemplateUpdate(templateId, opts) {
|
|
1819
|
-
return this.http.request("POST", "/v1/
|
|
2203
|
+
return this.http.request("POST", "/v1/stores/{storeId}/webstore/templates/{templateId}/update", { path: { templateId }, opts });
|
|
1820
2204
|
}
|
|
2205
|
+
/**
|
|
2206
|
+
* Duplicate template
|
|
2207
|
+
*
|
|
2208
|
+
* Copies a template and its files into a new template on the same webstore and returns it.
|
|
2209
|
+
* @param templateId The ID of the template to copy.
|
|
2210
|
+
*/
|
|
1821
2211
|
duplicateWebstoreTemplate(templateId, opts) {
|
|
1822
|
-
return this.http.request("POST", "/v1/
|
|
2212
|
+
return this.http.request("POST", "/v1/stores/{storeId}/webstore/templates/{templateId}/duplicate", { path: { templateId }, opts });
|
|
1823
2213
|
}
|
|
2214
|
+
/**
|
|
2215
|
+
* Finish template upload
|
|
2216
|
+
*
|
|
2217
|
+
* Imports the files from an archive uploaded to the URL returned by the upload URL endpoint
|
|
2218
|
+
* into the template, and reports any files that could not be imported.
|
|
2219
|
+
* @param templateId The ID of the template the files are imported into.
|
|
2220
|
+
*/
|
|
1824
2221
|
finishWebstoreTemplateUpload(templateId, opts) {
|
|
1825
|
-
return this.http.request("POST", "/v1/
|
|
2222
|
+
return this.http.request("POST", "/v1/stores/{storeId}/webstore/templates/{templateId}/upload_finish", { path: { templateId }, opts });
|
|
1826
2223
|
}
|
|
1827
2224
|
/**
|
|
1828
2225
|
* Get webstore
|
|
@@ -1831,7 +2228,7 @@ class WebstoreResource {
|
|
|
1831
2228
|
* state and the template it currently renders.
|
|
1832
2229
|
*/
|
|
1833
2230
|
getWebstore(opts) {
|
|
1834
|
-
return this.http.request("GET", "/v1/
|
|
2231
|
+
return this.http.request("GET", "/v1/stores/{storeId}/webstore", { opts });
|
|
1835
2232
|
}
|
|
1836
2233
|
/**
|
|
1837
2234
|
* Get custom domain
|
|
@@ -1840,42 +2237,123 @@ class WebstoreResource {
|
|
|
1840
2237
|
* outstanding for ownership and SSL verification.
|
|
1841
2238
|
*/
|
|
1842
2239
|
getWebstoreCustomDomain(opts) {
|
|
1843
|
-
return this.http.request("GET", "/v1/
|
|
2240
|
+
return this.http.request("GET", "/v1/stores/{storeId}/webstore/custom-domain", { opts });
|
|
1844
2241
|
}
|
|
2242
|
+
/**
|
|
2243
|
+
* Get webstore modules
|
|
2244
|
+
*
|
|
2245
|
+
* Retrieves all modules on the store's webstore, in sort order.
|
|
2246
|
+
*/
|
|
1845
2247
|
getWebstoreModules(opts) {
|
|
1846
|
-
return this.http.request("GET", "/v1/
|
|
1847
|
-
opts,
|
|
1848
|
-
});
|
|
2248
|
+
return this.http.request("GET", "/v1/stores/{storeId}/webstore/modules", { opts });
|
|
1849
2249
|
}
|
|
2250
|
+
/**
|
|
2251
|
+
* Get template
|
|
2252
|
+
*
|
|
2253
|
+
* Retrieves a template. Pass 'include' as 'files' to embed its files, content included, in
|
|
2254
|
+
* 'template_files'.
|
|
2255
|
+
* @param templateId The ID of the template.
|
|
2256
|
+
*/
|
|
1850
2257
|
getWebstoreTemplate(templateId, query, opts) {
|
|
1851
|
-
return this.http.request("GET", "/v1/
|
|
2258
|
+
return this.http.request("GET", "/v1/stores/{storeId}/webstore/templates/{templateId}", { path: { templateId }, query, opts });
|
|
1852
2259
|
}
|
|
2260
|
+
/**
|
|
2261
|
+
* Get template archive
|
|
2262
|
+
*
|
|
2263
|
+
* Creates a temporary URL to download the template's files as an archive.
|
|
2264
|
+
* @param templateId The ID of the template.
|
|
2265
|
+
*/
|
|
1853
2266
|
getWebstoreTemplateArchive(templateId, opts) {
|
|
1854
|
-
return this.http.request("GET", "/v1/
|
|
2267
|
+
return this.http.request("GET", "/v1/stores/{storeId}/webstore/templates/{templateId}/archive", { path: { templateId }, opts });
|
|
1855
2268
|
}
|
|
2269
|
+
/**
|
|
2270
|
+
* Get template file
|
|
2271
|
+
*
|
|
2272
|
+
* Retrieves a single template file, content included.
|
|
2273
|
+
* @param templateId The ID of the template.
|
|
2274
|
+
* @param templateFileId The ID of the template file.
|
|
2275
|
+
*/
|
|
1856
2276
|
getWebstoreTemplateFile(templateId, templateFileId, opts) {
|
|
1857
|
-
return this.http.request("GET", "/v1/
|
|
2277
|
+
return this.http.request("GET", "/v1/stores/{storeId}/webstore/templates/{templateId}/files/{templateFileId}", { path: { templateId, templateFileId }, opts });
|
|
1858
2278
|
}
|
|
2279
|
+
/**
|
|
2280
|
+
* Get template files
|
|
2281
|
+
*
|
|
2282
|
+
* Retrieves the files of a template without their content. Fetch a single file to read its
|
|
2283
|
+
* content.
|
|
2284
|
+
* @param templateId The ID of the template.
|
|
2285
|
+
*/
|
|
1859
2286
|
getWebstoreTemplateFiles(templateId, opts) {
|
|
1860
|
-
return this.http.request("GET", "/v1/
|
|
2287
|
+
return this.http.request("GET", "/v1/stores/{storeId}/webstore/templates/{templateId}/files", { path: { templateId }, opts });
|
|
1861
2288
|
}
|
|
2289
|
+
/**
|
|
2290
|
+
* Get latest template version
|
|
2291
|
+
*
|
|
2292
|
+
* Retrieves the newest published version available for a template installed from the
|
|
2293
|
+
* marketplace. 'version' is null when there is no update or the template is not
|
|
2294
|
+
* marketplace-based.
|
|
2295
|
+
* @param templateId The ID of the template.
|
|
2296
|
+
*/
|
|
1862
2297
|
getWebstoreTemplateLatestVersion(templateId, opts) {
|
|
1863
|
-
return this.http.request("GET", "/v1/
|
|
2298
|
+
return this.http.request("GET", "/v1/stores/{storeId}/webstore/templates/{templateId}/update", { path: { templateId }, opts });
|
|
2299
|
+
}
|
|
2300
|
+
/**
|
|
2301
|
+
* Create template preview URL
|
|
2302
|
+
*
|
|
2303
|
+
* Creates a short-lived link that renders the template without caching. The link expires
|
|
2304
|
+
* after 15 minutes.
|
|
2305
|
+
* @param templateId The ID of the template to preview.
|
|
2306
|
+
*/
|
|
2307
|
+
getWebstoreTemplatePreviewUrl(templateId, opts) {
|
|
2308
|
+
return this.http.request("POST", "/v1/stores/{storeId}/webstore/templates/{templateId}/preview", { path: { templateId }, opts });
|
|
1864
2309
|
}
|
|
2310
|
+
/**
|
|
2311
|
+
* Get templates
|
|
2312
|
+
*
|
|
2313
|
+
* Retrieves the templates of the store's webstore, without their files. The one customers see
|
|
2314
|
+
* is the webstore's 'current_template_id'.
|
|
2315
|
+
*/
|
|
1865
2316
|
getWebstoreTemplates(opts) {
|
|
1866
|
-
return this.http.request("GET", "/v1/
|
|
2317
|
+
return this.http.request("GET", "/v1/stores/{storeId}/webstore/templates", { opts });
|
|
1867
2318
|
}
|
|
2319
|
+
/**
|
|
2320
|
+
* Get template schema
|
|
2321
|
+
*
|
|
2322
|
+
* Retrieves the schema a template declares: its author, support contacts, update source and
|
|
2323
|
+
* the settings a store can configure.
|
|
2324
|
+
* @param templateId The ID of the template.
|
|
2325
|
+
*/
|
|
1868
2326
|
getWebstoreTemplateSchema(templateId, opts) {
|
|
1869
|
-
return this.http.request("GET", "/v1/
|
|
2327
|
+
return this.http.request("GET", "/v1/stores/{storeId}/webstore/templates/{templateId}/schema", { path: { templateId }, opts });
|
|
1870
2328
|
}
|
|
2329
|
+
/**
|
|
2330
|
+
* Get template upload URL
|
|
2331
|
+
*
|
|
2332
|
+
* Creates a pre-signed URL for uploading an archive of template files. Upload the archive to
|
|
2333
|
+
* it, then finish the upload to import the files into the template.
|
|
2334
|
+
* @param templateId The ID of the template the files are imported into.
|
|
2335
|
+
*/
|
|
1871
2336
|
getWebstoreTemplateUploadUrl(templateId, query, opts) {
|
|
1872
|
-
return this.http.request("GET", "/v1/
|
|
2337
|
+
return this.http.request("GET", "/v1/stores/{storeId}/webstore/templates/{templateId}/upload_url", { path: { templateId }, query, opts });
|
|
1873
2338
|
}
|
|
2339
|
+
/**
|
|
2340
|
+
* Get template variables
|
|
2341
|
+
*
|
|
2342
|
+
* Retrieves the variables of a template with their current values.
|
|
2343
|
+
* @param templateId The ID of the template.
|
|
2344
|
+
*/
|
|
1874
2345
|
getWebstoreTemplateVariables(templateId, opts) {
|
|
1875
|
-
return this.http.request("GET", "/v1/
|
|
2346
|
+
return this.http.request("GET", "/v1/stores/{storeId}/webstore/templates/{templateId}/variables", { path: { templateId }, opts });
|
|
1876
2347
|
}
|
|
1877
|
-
|
|
1878
|
-
|
|
2348
|
+
/**
|
|
2349
|
+
* Install marketplace template
|
|
2350
|
+
*
|
|
2351
|
+
* Installs a template from the marketplace into the store's webstore and returns the ID of the
|
|
2352
|
+
* installed copy.
|
|
2353
|
+
* @param marketplaceTemplateId The ID of the marketplace template to install.
|
|
2354
|
+
*/
|
|
2355
|
+
installMarketplaceTemplate(marketplaceTemplateId, opts) {
|
|
2356
|
+
return this.http.request("POST", "/v1/stores/{storeId}/webstore/marketplace/templates/{marketplaceTemplateId}/install", { path: { marketplaceTemplateId }, opts });
|
|
1879
2357
|
}
|
|
1880
2358
|
/**
|
|
1881
2359
|
* Set custom domain
|
|
@@ -1883,7 +2361,7 @@ class WebstoreResource {
|
|
|
1883
2361
|
* Attaches a custom domain to the store's webstore and begins verification.
|
|
1884
2362
|
*/
|
|
1885
2363
|
setWebstoreCustomDomain(body, opts) {
|
|
1886
|
-
return this.http.request("POST", "/v1/
|
|
2364
|
+
return this.http.request("POST", "/v1/stores/{storeId}/webstore/custom-domain", { body, opts });
|
|
1887
2365
|
}
|
|
1888
2366
|
/**
|
|
1889
2367
|
* Set default template
|
|
@@ -1891,7 +2369,7 @@ class WebstoreResource {
|
|
|
1891
2369
|
* Sets the template the webstore renders for customers.
|
|
1892
2370
|
*/
|
|
1893
2371
|
setWebstoreDefaultTemplate(body, opts) {
|
|
1894
|
-
return this.http.request("POST", "/v1/
|
|
2372
|
+
return this.http.request("POST", "/v1/stores/{storeId}/webstore/set-default-template", {
|
|
1895
2373
|
body,
|
|
1896
2374
|
opts,
|
|
1897
2375
|
});
|
|
@@ -1903,22 +2381,58 @@ class WebstoreResource {
|
|
|
1903
2381
|
* slug already taken by another store is rejected.
|
|
1904
2382
|
*/
|
|
1905
2383
|
setWebstoreSlug(body, opts) {
|
|
1906
|
-
return this.http.request("POST", "/v1/
|
|
2384
|
+
return this.http.request("POST", "/v1/stores/{storeId}/webstore/set-slug", {
|
|
2385
|
+
body,
|
|
2386
|
+
opts,
|
|
2387
|
+
});
|
|
1907
2388
|
}
|
|
2389
|
+
/**
|
|
2390
|
+
* Update webstore module
|
|
2391
|
+
*
|
|
2392
|
+
* Performs a delta update of a module on the store's webstore.
|
|
2393
|
+
* @param moduleId The ID of the module.
|
|
2394
|
+
*/
|
|
1908
2395
|
updateWebstoreModule(moduleId, body, opts) {
|
|
1909
|
-
return this.http.request("PUT", "/v1/
|
|
2396
|
+
return this.http.request("PUT", "/v1/stores/{storeId}/webstore/modules/{moduleId}", { path: { moduleId }, body, opts });
|
|
1910
2397
|
}
|
|
2398
|
+
/**
|
|
2399
|
+
* Update template
|
|
2400
|
+
*
|
|
2401
|
+
* Performs a delta update of a template's name and compatibility mode.
|
|
2402
|
+
* @param templateId The ID of the template.
|
|
2403
|
+
*/
|
|
1911
2404
|
updateWebstoreTemplate(templateId, body, opts) {
|
|
1912
|
-
return this.http.request("PUT", "/v1/
|
|
2405
|
+
return this.http.request("PUT", "/v1/stores/{storeId}/webstore/templates/{templateId}", { path: { templateId }, body, opts });
|
|
1913
2406
|
}
|
|
2407
|
+
/**
|
|
2408
|
+
* Update template file content
|
|
2409
|
+
*
|
|
2410
|
+
* Replaces the content of a template file. If the template is the webstore's current template,
|
|
2411
|
+
* customers see the change immediately.
|
|
2412
|
+
* @param templateId The ID of the template.
|
|
2413
|
+
* @param templateFileId The ID of the template file.
|
|
2414
|
+
*/
|
|
1914
2415
|
updateWebstoreTemplateFile(templateId, templateFileId, body, opts) {
|
|
1915
|
-
return this.http.request("PUT", "/v1/
|
|
2416
|
+
return this.http.request("PUT", "/v1/stores/{storeId}/webstore/templates/{templateId}/files/{templateFileId}", { path: { templateId, templateFileId }, body, opts });
|
|
1916
2417
|
}
|
|
2418
|
+
/**
|
|
2419
|
+
* Update template schema variables
|
|
2420
|
+
*
|
|
2421
|
+
* Sets values for the settings the template's schema defines.
|
|
2422
|
+
* @param templateId The ID of the template.
|
|
2423
|
+
*/
|
|
1917
2424
|
updateWebstoreTemplateSchemaVariables(templateId, body, opts) {
|
|
1918
|
-
return this.http.request("PUT", "/v1/
|
|
2425
|
+
return this.http.request("PUT", "/v1/stores/{storeId}/webstore/templates/{templateId}/schema/variables", { path: { templateId }, body, opts });
|
|
1919
2426
|
}
|
|
2427
|
+
/**
|
|
2428
|
+
* Update template variable
|
|
2429
|
+
*
|
|
2430
|
+
* Performs a delta update of a template variable.
|
|
2431
|
+
* @param templateId The ID of the template.
|
|
2432
|
+
* @param templateVariableId The ID of the template variable.
|
|
2433
|
+
*/
|
|
1920
2434
|
updateWebstoreTemplateVariable(templateId, templateVariableId, body, opts) {
|
|
1921
|
-
return this.http.request("PUT", "/v1/
|
|
2435
|
+
return this.http.request("PUT", "/v1/stores/{storeId}/webstore/templates/{templateId}/variables/{templateVariableId}", { path: { templateId, templateVariableId }, body, opts });
|
|
1922
2436
|
}
|
|
1923
2437
|
/**
|
|
1924
2438
|
* Verify custom domain
|
|
@@ -1927,7 +2441,7 @@ class WebstoreResource {
|
|
|
1927
2441
|
* records returned when the domain was set have been published.
|
|
1928
2442
|
*/
|
|
1929
2443
|
verifyWebstoreCustomDomain(opts) {
|
|
1930
|
-
return this.http.request("POST", "/v1/
|
|
2444
|
+
return this.http.request("POST", "/v1/stores/{storeId}/webstore/custom-domain/verify", {
|
|
1931
2445
|
opts,
|
|
1932
2446
|
});
|
|
1933
2447
|
}
|
|
@@ -1939,14 +2453,12 @@ class ManagementClient {
|
|
|
1939
2453
|
$http;
|
|
1940
2454
|
affiliateLinks;
|
|
1941
2455
|
bans;
|
|
1942
|
-
billing;
|
|
1943
2456
|
checkout;
|
|
1944
2457
|
checkoutStyle;
|
|
1945
2458
|
coupons;
|
|
1946
|
-
|
|
2459
|
+
customerPortalSessions;
|
|
1947
2460
|
customers;
|
|
1948
2461
|
customVariables;
|
|
1949
|
-
dashboard;
|
|
1950
2462
|
dataMigrations;
|
|
1951
2463
|
delivery;
|
|
1952
2464
|
discord;
|
|
@@ -1979,14 +2491,12 @@ class ManagementClient {
|
|
|
1979
2491
|
this.$http = http;
|
|
1980
2492
|
this.affiliateLinks = new AffiliateLinksResource(http);
|
|
1981
2493
|
this.bans = new BansResource(http);
|
|
1982
|
-
this.billing = new BillingResource(http);
|
|
1983
2494
|
this.checkout = new CheckoutResource(http);
|
|
1984
2495
|
this.checkoutStyle = new CheckoutStyleResource(http);
|
|
1985
2496
|
this.coupons = new CouponsResource(http);
|
|
1986
|
-
this.
|
|
2497
|
+
this.customerPortalSessions = new CustomerPortalSessionsResource(http);
|
|
1987
2498
|
this.customers = new CustomersResource(http);
|
|
1988
2499
|
this.customVariables = new CustomVariablesResource(http);
|
|
1989
|
-
this.dashboard = new DashboardResource(http);
|
|
1990
2500
|
this.dataMigrations = new DataMigrationsResource(http);
|
|
1991
2501
|
this.delivery = new DeliveryResource(http);
|
|
1992
2502
|
this.discord = new DiscordResource(http);
|