@paynow-gg/typescript-sdk 2.1.3 → 2.1.5

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.
@@ -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.DashboardResource = exports.CustomVariablesResource = exports.CustomersResource = exports.CustomerPortalSessionsResource = exports.CouponsResource = exports.CheckoutStyleResource = exports.CheckoutResource = exports.BillingResource = exports.BansResource = exports.AffiliateLinksResource = void 0;
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,85 +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 plan
74
- *
75
- * Moves the store onto a different plan. When the change needs paying for, the response
76
- * carries a 'session_url' the store owner must complete.
77
- */
78
- changeSubscriptionPlan(body, opts) {
79
- return this.http.request("POST", "/v1/stores/{storeId}/billing/plans/change", { body, opts });
80
- }
81
- /**
82
- * Continue current subscription
83
- *
84
- * Cancels a pending downgrade or cancellation, keeping the store on its current plan.
85
- */
86
- continueCurrentSubscription(opts) {
87
- return this.http.request("POST", "/v1/stores/{storeId}/billing/plans/continue", { opts });
88
- }
89
- /**
90
- * Create payment method update session
91
- *
92
- * Returns a customer portal session scoped to updating the payment method of the store's
93
- * active subscription. The store owner has to visit the returned 'session_url' to complete
94
- * the update.
95
- */
96
- createPaymentMethodUpdateSession(opts) {
97
- return this.http.request("POST", "/v1/stores/{storeId}/billing/payment-method/change", { opts });
98
- }
99
- /**
100
- * Get available plans
101
- *
102
- * Retrieves the plans a store can subscribe to.
103
- */
104
- getPublicPlans(opts) {
105
- return this.http.request("GET", "/v1/stores/{storeId}/billing/plans", {
106
- opts,
107
- });
108
- }
109
- /**
110
- * Get billing details
111
- *
112
- * Retrieves the billing address and tax details the store is invoiced under.
113
- */
114
- getStoreBillingDetails(opts) {
115
- return this.http.request("GET", "/v1/stores/{storeId}/billing/details", { opts });
116
- }
117
- /**
118
- * Get billing orders
119
- *
120
- * Retrieves the orders placed for the store's own subscription. Only the store owner may
121
- * call this.
122
- */
123
- getStoreBillingOrders(query, opts) {
124
- return this.http.request("GET", "/v1/stores/{storeId}/billing/orders", { query, opts });
125
- }
126
- /**
127
- * Get billing status
128
- *
129
- * Retrieves the store's plan, limits, feature flags and subscription state.
130
- */
131
- getStoreBillingStatus(opts) {
132
- return this.http.request("GET", "/v1/stores/{storeId}/billing/status", {
133
- opts,
134
- });
135
- }
136
- /**
137
- * Update billing details
138
- *
139
- * Replaces the billing address and tax details the store is invoiced under.
140
- */
141
- updateStoreBillingDetails(body, opts) {
142
- return this.http.request("PUT", "/v1/stores/{storeId}/billing/details", { body, opts });
143
- }
144
- }
145
- exports.BillingResource = BillingResource;
146
128
  class CheckoutResource {
147
129
  http;
148
130
  constructor(http) {
@@ -216,40 +198,56 @@ class CouponsResource {
216
198
  constructor(http) {
217
199
  this.http = http;
218
200
  }
219
- createCouponForStore(body, opts) {
201
+ /**
202
+ * Create coupon
203
+ *
204
+ * Creates a new coupon in the specified store.
205
+ */
206
+ createCoupon(body, opts) {
220
207
  return this.http.request("POST", "/v1/stores/{storeId}/coupons", { body, opts });
221
208
  }
222
209
  /**
223
- * Deletes a coupon
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.
224
214
  */
225
- deleteCouponForStore(couponId, opts) {
215
+ deleteCoupon(couponId, opts) {
226
216
  return this.http.request("DELETE", "/v1/stores/{storeId}/coupons/{couponId}", {
227
217
  path: { couponId },
228
218
  opts,
229
219
  });
230
220
  }
231
221
  /**
232
- * Retrieves a coupon by ID
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.
233
226
  */
234
- getCouponByIdForStore(couponId, opts) {
227
+ getCouponById(couponId, opts) {
235
228
  return this.http.request("GET", "/v1/stores/{storeId}/coupons/{couponId}", {
236
229
  path: { couponId },
237
230
  opts,
238
231
  });
239
232
  }
240
233
  /**
241
- * Fetches all coupons for a store id
234
+ * Get coupons
235
+ *
236
+ * Retrieves all coupons for the specified store.
242
237
  */
243
- getCouponsForStore(query, opts) {
238
+ getCoupons(query, opts) {
244
239
  return this.http.request("GET", "/v1/stores/{storeId}/coupons", {
245
240
  query,
246
241
  opts,
247
242
  });
248
243
  }
249
244
  /**
250
- * Performs a Delta Update of a Coupon
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.
251
249
  */
252
- updateCouponForStore(couponId, body, opts) {
250
+ updateCoupon(couponId, body, opts) {
253
251
  return this.http.request("PATCH", "/v1/stores/{storeId}/coupons/{couponId}", {
254
252
  path: { couponId },
255
253
  body,
@@ -358,6 +356,7 @@ class CustomersResource {
358
356
  * Update customer
359
357
  *
360
358
  * Updates an existing customer based on the fields passed.
359
+ * @param customerId The ID of the customer.
361
360
  */
362
361
  updateCustomer(customerId, body, opts) {
363
362
  return this.http.request("PATCH", "/v1/stores/{storeId}/customers/{customerId}", {
@@ -379,7 +378,7 @@ class CustomVariablesResource {
379
378
  * Creates a new custom variable for the specified store.
380
379
  * Custom variables allow customers to provide additional input when purchasing products.
381
380
  */
382
- createCustomVariableForStore(body, opts) {
381
+ createCustomVariable(body, opts) {
383
382
  return this.http.request("POST", "/v1/stores/{storeId}/custom-variables", {
384
383
  body,
385
384
  opts,
@@ -392,7 +391,7 @@ class CustomVariablesResource {
392
391
  * This will also delete all associated options and cannot be undone.
393
392
  * @param customVariableId The ID of the custom variable to delete.
394
393
  */
395
- deleteCustomVariableForStore(customVariableId, opts) {
394
+ deleteCustomVariable(customVariableId, opts) {
396
395
  return this.http.request("DELETE", "/v1/stores/{storeId}/custom-variables/{customVariableId}", { path: { customVariableId }, opts });
397
396
  }
398
397
  /**
@@ -401,7 +400,7 @@ class CustomVariablesResource {
401
400
  * Retrieves a specific custom variable by ID from the specified store.
402
401
  * @param customVariableId The ID of the custom variable to retrieve.
403
402
  */
404
- getCustomVariableByIdForStore(customVariableId, opts) {
403
+ getCustomVariableById(customVariableId, opts) {
405
404
  return this.http.request("GET", "/v1/stores/{storeId}/custom-variables/{customVariableId}", { path: { customVariableId }, opts });
406
405
  }
407
406
  /**
@@ -409,7 +408,7 @@ class CustomVariablesResource {
409
408
  *
410
409
  * Retrieves all custom variables for the specified store.
411
410
  */
412
- getCustomVariablesForStore(opts) {
411
+ getCustomVariables(opts) {
413
412
  return this.http.request("GET", "/v1/stores/{storeId}/custom-variables", { opts });
414
413
  }
415
414
  /**
@@ -419,29 +418,21 @@ class CustomVariablesResource {
419
418
  * Only the fields specified in the request will be updated.
420
419
  * @param customVariableId The ID of the custom variable to update.
421
420
  */
422
- updateCustomVariableForStore(customVariableId, body, opts) {
421
+ updateCustomVariable(customVariableId, body, opts) {
423
422
  return this.http.request("PATCH", "/v1/stores/{storeId}/custom-variables/{customVariableId}", { path: { customVariableId }, body, opts });
424
423
  }
425
424
  }
426
425
  exports.CustomVariablesResource = CustomVariablesResource;
427
- class DashboardResource {
428
- http;
429
- constructor(http) {
430
- this.http = http;
431
- }
432
- getDashboardSearchHints(opts) {
433
- return this.http.request("GET", "/v1/stores/{storeId}/dashboard/search-hints", { opts });
434
- }
435
- searchDashboard(query, opts) {
436
- return this.http.request("GET", "/v1/stores/{storeId}/dashboard/search", { query, opts });
437
- }
438
- }
439
- exports.DashboardResource = DashboardResource;
440
426
  class DataMigrationsResource {
441
427
  http;
442
428
  constructor(http) {
443
429
  this.http = http;
444
430
  }
431
+ /**
432
+ * Get data migrations
433
+ *
434
+ * Retrieves all data migration tasks for the specified store.
435
+ */
445
436
  getDataMigrations(query, opts) {
446
437
  return this.http.request("GET", "/v1/stores/{storeId}/data-migrations", { query, opts });
447
438
  }
@@ -459,6 +450,7 @@ class DeliveryResource {
459
450
  * Assign a delivery item to a customer
460
451
  *
461
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.
462
454
  */
463
455
  assignDeliveryItem(customerId, body, opts) {
464
456
  return this.http.request("POST", "/v1/stores/{storeId}/customers/{customerId}/delivery/items", { path: { customerId }, body, opts });
@@ -475,6 +467,7 @@ class DeliveryResource {
475
467
  * Get command attempts associated with a customer
476
468
  *
477
469
  * Retrieves command attempts associated with a customer
470
+ * @param customerId The ID of the customer.
478
471
  */
479
472
  getCommandAttemptsForCustomer(customerId, query, opts) {
480
473
  return this.http.request("GET", "/v1/stores/{storeId}/customers/{customerId}/delivery/commands", { path: { customerId }, query, opts });
@@ -483,12 +476,16 @@ class DeliveryResource {
483
476
  * Get delivery items associated with a customer
484
477
  *
485
478
  * Retrieves delivery items associated with a customer
479
+ * @param customerId The ID of the customer.
486
480
  */
487
481
  getCustomerDeliveryItems(customerId, query, opts) {
488
482
  return this.http.request("GET", "/v1/stores/{storeId}/customers/{customerId}/delivery/items", { path: { customerId }, query, opts });
489
483
  }
490
484
  /**
491
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.
492
489
  */
493
490
  getGameServerDeliveryItems(gameServerId, query, opts) {
494
491
  return this.http.request("GET", "/v1/stores/{storeId}/gameservers/{gameServerId}/delivery/items", { path: { gameServerId }, query, opts });
@@ -515,6 +512,9 @@ class DeliveryResource {
515
512
  }
516
513
  /**
517
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.
518
518
  */
519
519
  resendDeliveryCommandsForGameServer(gameServerId, body, opts) {
520
520
  return this.http.request("POST", "/v1/stores/{storeId}/gameservers/{gameServerId}/delivery/commands/resend", { path: { gameServerId }, body, opts });
@@ -540,44 +540,123 @@ class DiscordResource {
540
540
  constructor(http) {
541
541
  this.http = http;
542
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
+ */
543
549
  createAction(productVersionId, body, opts) {
544
550
  return this.http.request("PUT", "/v1/stores/{storeId}/product_versions/{productVersionId}/discord_actions", { path: { productVersionId }, body, opts });
545
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
+ */
546
557
  createDiscordServerLink(opts) {
547
558
  return this.http.request("POST", "/v1/stores/{storeId}/discord/links", {
548
559
  opts,
549
560
  });
550
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
+ */
551
568
  deleteDiscordServerLinks(token, opts) {
552
- return this.http.request("DELETE", "/v1/stores/{storeId}/discord/links/{token}", { path: { token }, opts });
569
+ return this.http.request("DELETE", "/v1/stores/{storeId}/discord/links/{token}", {
570
+ path: { token },
571
+ opts,
572
+ });
553
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
+ */
554
580
  deleteUserToDeliveryItemLink(inventoryItemId, opts) {
555
581
  return this.http.request("DELETE", "/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/link", { path: { inventoryItemId }, opts });
556
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
+ */
557
589
  getActions(productVersionId, opts) {
558
590
  return this.http.request("GET", "/v1/stores/{storeId}/product_versions/{productVersionId}/discord_actions", { path: { productVersionId }, opts });
559
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
+ */
560
598
  getDiscordActionExecutionHistory(orderId, opts) {
561
599
  return this.http.request("GET", "/v1/stores/{storeId}/orders/{orderId}/discord/queued", { path: { orderId }, opts });
562
600
  }
601
+ /**
602
+ * Get Discord server links
603
+ *
604
+ * Retrieves all Discord server links for the specified store.
605
+ */
563
606
  getDiscordServerLinks(opts) {
564
607
  return this.http.request("GET", "/v1/stores/{storeId}/discord/links", { opts });
565
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
+ */
566
615
  getDiscordServerRoles(discordServerId, opts) {
567
616
  return this.http.request("GET", "/v1/stores/{storeId}/discord/{discordServerId}/roles", { path: { discordServerId }, opts });
568
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
+ */
569
624
  getDiscordServerTextChannels(discordServerId, opts) {
570
625
  return this.http.request("GET", "/v1/stores/{storeId}/discord/{discordServerId}/discord/text_channels", { path: { discordServerId }, opts });
571
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
+ */
572
633
  getLinkedDiscordAccounts(orderId, opts) {
573
634
  return this.http.request("GET", "/v1/stores/{storeId}/orders/{orderId}/discord", { path: { orderId }, opts });
574
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
+ */
575
642
  getQueuedDiscordActionForDeliveryItem(inventoryItemId, opts) {
576
643
  return this.http.request("GET", "/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/queued", { path: { inventoryItemId }, opts });
577
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
+ */
578
651
  getUserToDeliveryItemLinks(inventoryItemId, opts) {
579
652
  return this.http.request("GET", "/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/link", { path: { inventoryItemId }, opts });
580
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
+ */
581
660
  setUserToDeliveryItemLink(inventoryItemId, query, opts) {
582
661
  return this.http.request("PUT", "/v1/stores/{storeId}/inventory/{inventoryItemId}/discord/link", { path: { inventoryItemId }, query, opts });
583
662
  }
@@ -597,6 +676,12 @@ class DownloadableFilesResource {
597
676
  finishDownloadableFileUpload(productId, downloadableFileId, opts) {
598
677
  return this.http.request("POST", "/v1/stores/{storeId}/products/{productId}/downloadable-files/{downloadableFileId}/finish", { path: { productId, downloadableFileId }, opts });
599
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
+ */
600
685
  getDownloadableFiles(productId, opts) {
601
686
  return this.http.request("GET", "/v1/stores/{storeId}/products/{productId}/downloadable-files", { path: { productId }, opts });
602
687
  }
@@ -612,6 +697,8 @@ class GameServersResource {
612
697
  }
613
698
  /**
614
699
  * Create a new Game Server for a store
700
+ *
701
+ * Creates a new game server in the specified store.
615
702
  */
616
703
  createGameServer(body, opts) {
617
704
  return this.http.request("POST", "/v1/stores/{storeId}/gameservers", {
@@ -621,6 +708,9 @@ class GameServersResource {
621
708
  }
622
709
  /**
623
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.
624
714
  */
625
715
  createGameServerConsole(gameServerId, body, opts) {
626
716
  return this.http.request("POST", "/v1/stores/{storeId}/gameservers/{gameServerId}/console", { path: { gameServerId }, body, opts });
@@ -636,30 +726,44 @@ class GameServersResource {
636
726
  }
637
727
  /**
638
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.
639
732
  */
640
733
  deleteGameServerConsole(gameServerId, opts) {
641
734
  return this.http.request("DELETE", "/v1/stores/{storeId}/gameservers/{gameServerId}/console", { path: { gameServerId }, opts });
642
735
  }
643
736
  /**
644
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.
645
741
  */
646
742
  getGameServer(gameServerId, opts) {
647
743
  return this.http.request("GET", "/v1/stores/{storeId}/gameservers/{gameServerId}", { path: { gameServerId }, opts });
648
744
  }
649
745
  /**
650
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.
651
750
  */
652
751
  getGameServerConsole(gameServerId, opts) {
653
752
  return this.http.request("GET", "/v1/stores/{storeId}/gameservers/{gameServerId}/console", { path: { gameServerId }, opts });
654
753
  }
655
754
  /**
656
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.
657
759
  */
658
760
  getGameServerConsoleMessages(gameServerId, opts) {
659
761
  return this.http.request("GET", "/v1/stores/{storeId}/gameservers/{gameServerId}/console/messages", { path: { gameServerId }, opts });
660
762
  }
661
763
  /**
662
764
  * Get Game Servers for a store
765
+ *
766
+ * Retrieves all game servers for the specified store.
663
767
  */
664
768
  getGameServers(opts) {
665
769
  return this.http.request("GET", "/v1/stores/{storeId}/gameservers", {
@@ -674,12 +778,18 @@ class GameServersResource {
674
778
  }
675
779
  /**
676
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.
677
784
  */
678
785
  updateGameServer(gameServerId, body, opts) {
679
786
  return this.http.request("PATCH", "/v1/stores/{storeId}/gameservers/{gameServerId}", { path: { gameServerId }, body, opts });
680
787
  }
681
788
  /**
682
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.
683
793
  */
684
794
  updateGameServerConsole(gameServerId, body, opts) {
685
795
  return this.http.request("PATCH", "/v1/stores/{storeId}/gameservers/{gameServerId}/console", { path: { gameServerId }, body, opts });
@@ -693,12 +803,17 @@ class GiftcardsResource {
693
803
  }
694
804
  /**
695
805
  * Create a Gift Card for a store
806
+ *
807
+ * Creates a new gift card in the specified store.
696
808
  */
697
809
  createGiftCard(body, opts) {
698
810
  return this.http.request("POST", "/v1/stores/{storeId}/giftcards", { body, opts });
699
811
  }
700
812
  /**
701
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.
702
817
  */
703
818
  deleteGiftCard(giftCardId, opts) {
704
819
  return this.http.request("DELETE", "/v1/stores/{storeId}/giftcards/{giftCardId}", {
@@ -708,6 +823,9 @@ class GiftcardsResource {
708
823
  }
709
824
  /**
710
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.
711
829
  */
712
830
  getGiftCard(giftCardId, opts) {
713
831
  return this.http.request("GET", "/v1/stores/{storeId}/giftcards/{giftCardId}", {
@@ -717,6 +835,8 @@ class GiftcardsResource {
717
835
  }
718
836
  /**
719
837
  * Get Gift Cards for a store
838
+ *
839
+ * Retrieves all gift cards for the specified store.
720
840
  */
721
841
  getGiftCards(query, opts) {
722
842
  return this.http.request("GET", "/v1/stores/{storeId}/giftcards", {
@@ -726,6 +846,9 @@ class GiftcardsResource {
726
846
  }
727
847
  /**
728
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.
729
852
  */
730
853
  updateGiftCard(giftCardId, body, opts) {
731
854
  return this.http.request("PATCH", "/v1/stores/{storeId}/giftcards/{giftCardId}", {
@@ -773,6 +896,7 @@ class GlobalCommandsResource {
773
896
  * Update global command
774
897
  *
775
898
  * Updates a global command for a store.
899
+ * @param globalCommandId The ID of the global command.
776
900
  */
777
901
  updateGlobalCommand(globalCommandId, body, opts) {
778
902
  return this.http.request("PATCH", "/v1/stores/{storeId}/global-commands/{globalCommandId}", { path: { globalCommandId }, body, opts });
@@ -856,72 +980,153 @@ class MarketingResource {
856
980
  constructor(http) {
857
981
  this.http = http;
858
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
+ */
859
990
  activateEmailTemplate(templateId, opts) {
860
991
  return this.http.request("POST", "/v1/stores/{storeId}/marketing/email/templates/{templateId}/activate", { path: { templateId }, opts });
861
992
  }
993
+ /**
994
+ * Create email template
995
+ *
996
+ * Creates a new email template in the specified store.
997
+ */
862
998
  createEmailTemplate(body, opts) {
863
999
  return this.http.request("POST", "/v1/stores/{storeId}/marketing/email/templates", { body, opts });
864
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
+ */
865
1008
  deactivateEmailTemplate(templateId, opts) {
866
1009
  return this.http.request("POST", "/v1/stores/{storeId}/marketing/email/templates/{templateId}/deactivate", { path: { templateId }, opts });
867
1010
  }
1011
+ /**
1012
+ * Deactivate email template by type
1013
+ *
1014
+ * Deactivates the active email template of the supplied type for the specified store.
1015
+ */
868
1016
  deactivateEmailTemplateByType(body, opts) {
869
1017
  return this.http.request("POST", "/v1/stores/{storeId}/marketing/email/templates/deactivate", { body, opts });
870
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
+ */
871
1025
  deleteEmailTemplate(templateId, opts) {
872
1026
  return this.http.request("DELETE", "/v1/stores/{storeId}/marketing/email/templates/{templateId}", { path: { templateId }, opts });
873
1027
  }
874
1028
  finishEmailBrandingImageUpload(body, opts) {
875
1029
  return this.http.request("POST", "/v1/stores/{storeId}/marketing/email/branding/image-upload-finish", { body, opts });
876
1030
  }
1031
+ /**
1032
+ * Get email branding
1033
+ *
1034
+ * Retrieves the email branding for the specified store.
1035
+ */
877
1036
  getEmailBranding(opts) {
878
1037
  return this.http.request("GET", "/v1/stores/{storeId}/marketing/email/branding", { opts });
879
1038
  }
880
1039
  getEmailBrandingImageUploadUrl(query, opts) {
881
1040
  return this.http.request("GET", "/v1/stores/{storeId}/marketing/email/branding/image-upload-url", { query, opts });
882
1041
  }
1042
+ /**
1043
+ * Get email deliveries
1044
+ *
1045
+ * Retrieves all email deliveries for the specified store.
1046
+ */
883
1047
  getEmailDeliveries(query, opts) {
884
1048
  return this.http.request("GET", "/v1/stores/{storeId}/marketing/email/deliveries", { query, opts });
885
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
+ */
886
1056
  getEmailDelivery(emailDeliveryId, opts) {
887
1057
  return this.http.request("GET", "/v1/stores/{storeId}/marketing/email/deliveries/{emailDeliveryId}", { path: { emailDeliveryId }, opts });
888
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
+ */
889
1065
  getEmailTemplate(templateId, opts) {
890
1066
  return this.http.request("GET", "/v1/stores/{storeId}/marketing/email/templates/{templateId}", { path: { templateId }, opts });
891
1067
  }
1068
+ /**
1069
+ * Get email template definitions
1070
+ *
1071
+ * Retrieves the email template definitions available to the specified store.
1072
+ */
892
1073
  getEmailTemplateDefinitions(opts) {
893
1074
  return this.http.request("GET", "/v1/stores/{storeId}/marketing/email/template-definitions", { opts });
894
1075
  }
1076
+ /**
1077
+ * Get email templates
1078
+ *
1079
+ * Retrieves all email templates for the specified store.
1080
+ */
895
1081
  getEmailTemplates(query, opts) {
896
1082
  return this.http.request("GET", "/v1/stores/{storeId}/marketing/email/templates", { query, opts });
897
1083
  }
898
1084
  /**
899
1085
  * Gets the abandoned checkout behaviour for a store
1086
+ *
1087
+ * Retrieves the abandoned checkout configuration for the specified store.
900
1088
  */
901
1089
  getStoreAbandonedCheckoutConfigurationOptions(opts) {
902
1090
  return this.http.request("GET", "/v1/stores/{storeId}/marketing/abandoned-checkouts/configuration", { opts });
903
1091
  }
904
1092
  /**
905
1093
  * Gets the purchase follow up behaviour for a store
1094
+ *
1095
+ * Retrieves the purchase follow up configuration for the specified store.
906
1096
  */
907
1097
  getStorePurchaseFollowUpConfigurationOptions(opts) {
908
1098
  return this.http.request("GET", "/v1/stores/{storeId}/marketing/purchase-follow-ups/configuration", { opts });
909
1099
  }
910
1100
  /**
911
1101
  * Sets the abandoned checkout behaviour for a store
1102
+ *
1103
+ * Updates the abandoned checkout configuration for the specified store.
912
1104
  */
913
1105
  setStoreAbandonedCheckoutConfigurationOptions(body, opts) {
914
1106
  return this.http.request("PUT", "/v1/stores/{storeId}/marketing/abandoned-checkouts/configuration", { body, opts });
915
1107
  }
916
1108
  /**
917
1109
  * Sets the purchase follow up behaviour for a store
1110
+ *
1111
+ * Updates the purchase follow up configuration for the specified store.
918
1112
  */
919
1113
  setStorePurchaseFollowUpConfigurationOptions(body, opts) {
920
1114
  return this.http.request("PUT", "/v1/stores/{storeId}/marketing/purchase-follow-ups/configuration", { body, opts });
921
1115
  }
1116
+ /**
1117
+ * Update email branding
1118
+ *
1119
+ * Performs a delta update of the email branding for the specified store.
1120
+ */
922
1121
  updateEmailBranding(body, opts) {
923
1122
  return this.http.request("PATCH", "/v1/stores/{storeId}/marketing/email/branding", { body, opts });
924
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
+ */
925
1130
  updateEmailTemplate(templateId, body, opts) {
926
1131
  return this.http.request("PATCH", "/v1/stores/{storeId}/marketing/email/templates/{templateId}", { path: { templateId }, body, opts });
927
1132
  }
@@ -934,12 +1139,17 @@ class NavlinksResource {
934
1139
  }
935
1140
  /**
936
1141
  * Create a new NavLink for a store
1142
+ *
1143
+ * Creates a new navigation link in the specified store.
937
1144
  */
938
1145
  createNavLink(body, opts) {
939
1146
  return this.http.request("POST", "/v1/stores/{storeId}/navlinks", { body, opts });
940
1147
  }
941
1148
  /**
942
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.
943
1153
  */
944
1154
  deleteNavLink(navLinkId, opts) {
945
1155
  return this.http.request("DELETE", "/v1/stores/{storeId}/navlinks/{navLinkId}", {
@@ -949,6 +1159,9 @@ class NavlinksResource {
949
1159
  }
950
1160
  /**
951
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.
952
1165
  */
953
1166
  getNavLink(navLinkId, opts) {
954
1167
  return this.http.request("GET", "/v1/stores/{storeId}/navlinks/{navLinkId}", {
@@ -958,12 +1171,17 @@ class NavlinksResource {
958
1171
  }
959
1172
  /**
960
1173
  * Get all NavLinks for a store
1174
+ *
1175
+ * Retrieves all navigation links for the specified store.
961
1176
  */
962
1177
  getNavLinks(opts) {
963
1178
  return this.http.request("GET", "/v1/stores/{storeId}/navlinks", { opts });
964
1179
  }
965
1180
  /**
966
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.
967
1185
  */
968
1186
  updateNavLink(navLinkId, body, opts) {
969
1187
  return this.http.request("PATCH", "/v1/stores/{storeId}/navlinks/{navLinkId}", {
@@ -974,6 +1192,8 @@ class NavlinksResource {
974
1192
  }
975
1193
  /**
976
1194
  * Update the sort orders of NavLinks for a Store
1195
+ *
1196
+ * Updates the sort order of navigation links in the specified store.
977
1197
  */
978
1198
  updateNavLinkOrder(body, opts) {
979
1199
  return this.http.request("PATCH", "/v1/stores/{storeId}/navlinks/sort-orders", {
@@ -1066,6 +1286,7 @@ class PaymentsResource {
1066
1286
  * Get payment by ID
1067
1287
  *
1068
1288
  * Retrieves a payment by an ID.
1289
+ * @param paymentId The ID of the payment.
1069
1290
  */
1070
1291
  getPaymentById(paymentId, opts) {
1071
1292
  return this.http.request("GET", "/v1/stores/{storeId}/payments/{paymentId}", {
@@ -1228,7 +1449,10 @@ class ProductsResource {
1228
1449
  * Updates the sort order of products in the specified store.
1229
1450
  */
1230
1451
  updateProductSortOrder(body, opts) {
1231
- return this.http.request("POST", "/v1/stores/{storeId}/products/sort-order", { body, opts });
1452
+ return this.http.request("POST", "/v1/stores/{storeId}/products/sort-order", {
1453
+ body,
1454
+ opts,
1455
+ });
1232
1456
  }
1233
1457
  }
1234
1458
  exports.ProductsResource = ProductsResource;
@@ -1237,18 +1461,47 @@ class RegionalPricingResource {
1237
1461
  constructor(http) {
1238
1462
  this.http = http;
1239
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
+ */
1240
1470
  getProductPricingRegions(productId, opts) {
1241
1471
  return this.http.request("GET", "/v1/stores/{storeId}/products/{productId}/pricing/regions", { path: { productId }, opts });
1242
1472
  }
1473
+ /**
1474
+ * Get pricing region groups
1475
+ *
1476
+ * Retrieves the pricing region groups available to the specified store.
1477
+ */
1243
1478
  getStorePricingRegionGroups(opts) {
1244
1479
  return this.http.request("GET", "/v1/stores/{storeId}/products/pricing/region-groups", { opts });
1245
1480
  }
1481
+ /**
1482
+ * Get store pricing regions
1483
+ *
1484
+ * Retrieves the regional pricing configuration for the specified store.
1485
+ */
1246
1486
  getStorePricingRegions(opts) {
1247
1487
  return this.http.request("GET", "/v1/stores/{storeId}/products/pricing/regions", { opts });
1248
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
+ */
1249
1496
  setProductPricingRegionOverride(productId, regionId, body, opts) {
1250
1497
  return this.http.request("PATCH", "/v1/stores/{storeId}/products/{productId}/pricing/regions/{regionId}", { path: { productId, regionId }, body, opts });
1251
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
+ */
1252
1505
  setStorePricingRegionOverride(regionId, body, opts) {
1253
1506
  return this.http.request("PATCH", "/v1/stores/{storeId}/products/pricing/regions/{regionId}", { path: { regionId }, body, opts });
1254
1507
  }
@@ -1296,12 +1549,17 @@ class SalesResource {
1296
1549
  }
1297
1550
  /**
1298
1551
  * Create a sale by ID for a store
1552
+ *
1553
+ * Creates a new sale in the specified store.
1299
1554
  */
1300
1555
  createSale(body, opts) {
1301
1556
  return this.http.request("POST", "/v1/stores/{storeId}/sales", { body, opts });
1302
1557
  }
1303
1558
  /**
1304
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.
1305
1563
  */
1306
1564
  deleteSaleById(saleId, opts) {
1307
1565
  return this.http.request("DELETE", "/v1/stores/{storeId}/sales/{saleId}", {
@@ -1311,6 +1569,9 @@ class SalesResource {
1311
1569
  }
1312
1570
  /**
1313
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.
1314
1575
  */
1315
1576
  getSale(saleId, opts) {
1316
1577
  return this.http.request("GET", "/v1/stores/{storeId}/sales/{saleId}", {
@@ -1320,12 +1581,17 @@ class SalesResource {
1320
1581
  }
1321
1582
  /**
1322
1583
  * Get sales associated with a store.
1584
+ *
1585
+ * Retrieves all sales for the specified store.
1323
1586
  */
1324
1587
  getSales(opts) {
1325
1588
  return this.http.request("GET", "/v1/stores/{storeId}/sales", { opts });
1326
1589
  }
1327
1590
  /**
1328
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.
1329
1595
  */
1330
1596
  updateSale(saleId, body, opts) {
1331
1597
  return this.http.request("PATCH", "/v1/stores/{storeId}/sales/{saleId}", {
@@ -1537,12 +1803,17 @@ class TagsResource {
1537
1803
  }
1538
1804
  /**
1539
1805
  * Create a new tag
1806
+ *
1807
+ * Creates a new tag in the specified store.
1540
1808
  */
1541
1809
  createTag(body, opts) {
1542
1810
  return this.http.request("POST", "/v1/stores/{storeId}/tags", { body, opts });
1543
1811
  }
1544
1812
  /**
1545
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.
1546
1817
  */
1547
1818
  deleteTag(tagId, opts) {
1548
1819
  return this.http.request("DELETE", "/v1/stores/{storeId}/tags/{tagId}", {
@@ -1554,6 +1825,7 @@ class TagsResource {
1554
1825
  * Delete tag image
1555
1826
  *
1556
1827
  * Deletes an image for a tag
1828
+ * @param tagId The ID of the tag.
1557
1829
  */
1558
1830
  deleteTagImage(tagId, opts) {
1559
1831
  return this.http.request("DELETE", "/v1/stores/{storeId}/tags/{tagId}/image", {
@@ -1571,6 +1843,9 @@ class TagsResource {
1571
1843
  }
1572
1844
  /**
1573
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.
1574
1849
  */
1575
1850
  getTag(tagId, opts) {
1576
1851
  return this.http.request("GET", "/v1/stores/{storeId}/tags/{tagId}", {
@@ -1588,12 +1863,17 @@ class TagsResource {
1588
1863
  }
1589
1864
  /**
1590
1865
  * Get all tags for a store
1866
+ *
1867
+ * Retrieves all tags for the specified store.
1591
1868
  */
1592
1869
  getTags(opts) {
1593
1870
  return this.http.request("GET", "/v1/stores/{storeId}/tags", { opts });
1594
1871
  }
1595
1872
  /**
1596
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.
1597
1877
  */
1598
1878
  updateTag(tagId, body, opts) {
1599
1879
  return this.http.request("PATCH", "/v1/stores/{storeId}/tags/{tagId}", {
@@ -1611,6 +1891,8 @@ class TierGroupsResource {
1611
1891
  }
1612
1892
  /**
1613
1893
  * Create a new tier group
1894
+ *
1895
+ * Creates a new tier group in the specified store.
1614
1896
  */
1615
1897
  createTierGroup(body, opts) {
1616
1898
  return this.http.request("POST", "/v1/stores/{storeId}/tier-groups", {
@@ -1620,6 +1902,9 @@ class TierGroupsResource {
1620
1902
  }
1621
1903
  /**
1622
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.
1623
1908
  */
1624
1909
  deleteTierGroup(tierGroupId, opts) {
1625
1910
  return this.http.request("DELETE", "/v1/stores/{storeId}/tier-groups/{tierGroupId}", {
@@ -1629,12 +1914,17 @@ class TierGroupsResource {
1629
1914
  }
1630
1915
  /**
1631
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.
1632
1920
  */
1633
1921
  getTierGroup(tierGroupId, opts) {
1634
1922
  return this.http.request("GET", "/v1/stores/{storeId}/tier-groups/{tierGroupId}", { path: { tierGroupId }, opts });
1635
1923
  }
1636
1924
  /**
1637
1925
  * List all tier groups for a store
1926
+ *
1927
+ * Retrieves all tier groups for the specified store.
1638
1928
  */
1639
1929
  listTierGroups(opts) {
1640
1930
  return this.http.request("GET", "/v1/stores/{storeId}/tier-groups", {
@@ -1643,6 +1933,9 @@ class TierGroupsResource {
1643
1933
  }
1644
1934
  /**
1645
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.
1646
1939
  */
1647
1940
  updateTierGroup(tierGroupId, body, opts) {
1648
1941
  return this.http.request("PATCH", "/v1/stores/{storeId}/tier-groups/{tierGroupId}", { path: { tierGroupId }, body, opts });
@@ -1683,6 +1976,9 @@ class TrialsResource {
1683
1976
  }
1684
1977
  /**
1685
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.
1686
1982
  */
1687
1983
  getTrial(trialId, opts) {
1688
1984
  return this.http.request("GET", "/v1/stores/{storeId}/trials/{trialId}", {
@@ -1692,6 +1988,8 @@ class TrialsResource {
1692
1988
  }
1693
1989
  /**
1694
1990
  * Get trials for a store
1991
+ *
1992
+ * Retrieves all trials for the specified store.
1695
1993
  */
1696
1994
  getTrials(query, opts) {
1697
1995
  return this.http.request("GET", "/v1/stores/{storeId}/trials", {
@@ -1729,30 +2027,68 @@ class WebhooksResource {
1729
2027
  constructor(http) {
1730
2028
  this.http = http;
1731
2029
  }
2030
+ /**
2031
+ * Create webhook
2032
+ *
2033
+ * Creates a new webhook subscription in the specified store.
2034
+ */
1732
2035
  createSubscription(body, opts) {
1733
2036
  return this.http.request("POST", "/v1/stores/{storeId}/webhooks", {
1734
2037
  body,
1735
2038
  opts,
1736
2039
  });
1737
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
+ */
1738
2047
  deleteSubscription(webhookId, opts) {
1739
2048
  return this.http.request("DELETE", "/v1/stores/{storeId}/webhooks/{webhookId}", {
1740
2049
  path: { webhookId },
1741
2050
  opts,
1742
2051
  });
1743
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
+ */
1744
2059
  getHistory(webhookId, query, opts) {
1745
2060
  return this.http.request("GET", "/v1/stores/{storeId}/webhooks/{webhookId}/history", { path: { webhookId }, query, opts });
1746
2061
  }
2062
+ /**
2063
+ * Get webhooks
2064
+ *
2065
+ * Retrieves all webhook subscriptions for the specified store.
2066
+ */
1747
2067
  getSubscriptions(opts) {
1748
2068
  return this.http.request("GET", "/v1/stores/{storeId}/webhooks", { opts });
1749
2069
  }
2070
+ /**
2071
+ * Get webhook variables
2072
+ *
2073
+ * Retrieves the variables available to webhook payload templates for the specified store.
2074
+ */
1750
2075
  getVariables(opts) {
1751
2076
  return this.http.request("GET", "/v1/stores/{storeId}/webhooks/variables", { opts });
1752
2077
  }
2078
+ /**
2079
+ * Resend webhook events
2080
+ *
2081
+ * Resends the supplied webhook events for the specified store.
2082
+ */
1753
2083
  resend(body, opts) {
1754
2084
  return this.http.request("POST", "/v1/stores/{storeId}/webhooks/resend", { body, opts });
1755
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
+ */
1756
2092
  updateSubscription(webhookId, body, opts) {
1757
2093
  return this.http.request("PATCH", "/v1/stores/{storeId}/webhooks/{webhookId}", { path: { webhookId }, body, opts });
1758
2094
  }
@@ -1763,23 +2099,45 @@ class WebstoreResource {
1763
2099
  constructor(http) {
1764
2100
  this.http = http;
1765
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
+ */
1766
2107
  createWebstoreModule(body, opts) {
1767
- return this.http.request("PUT", "/v1/webstores/{storeId}/modules", {
2108
+ return this.http.request("PUT", "/v1/stores/{storeId}/webstore/modules", {
1768
2109
  body,
1769
2110
  opts,
1770
2111
  });
1771
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
+ */
1772
2119
  createWebstoreTemplate(body, opts) {
1773
- return this.http.request("PUT", "/v1/webstores/{storeId}/templates", {
1774
- body,
1775
- opts,
1776
- });
2120
+ return this.http.request("PUT", "/v1/stores/{storeId}/webstore/templates", { body, opts });
1777
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
+ */
1778
2129
  createWebstoreTemplateFile(templateId, body, opts) {
1779
- return this.http.request("PUT", "/v1/webstores/{storeId}/templates/{templateId}/files", { path: { templateId }, body, opts });
2130
+ return this.http.request("PUT", "/v1/stores/{storeId}/webstore/templates/{templateId}/files", { path: { templateId }, body, opts });
1780
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
+ */
1781
2139
  createWebstoreTemplateVariable(templateId, body, opts) {
1782
- return this.http.request("PUT", "/v1/webstores/{storeId}/templates/{templateId}/variables", { path: { templateId }, body, opts });
2140
+ return this.http.request("PUT", "/v1/stores/{storeId}/webstore/templates/{templateId}/variables", { path: { templateId }, body, opts });
1783
2141
  }
1784
2142
  /**
1785
2143
  * Delete custom domain
@@ -1788,34 +2146,80 @@ class WebstoreResource {
1788
2146
  * slug.
1789
2147
  */
1790
2148
  deleteWebstoreCustomDomain(opts) {
1791
- return this.http.request("DELETE", "/v1/webstores/{storeId}/custom-domain", { opts });
2149
+ return this.http.request("DELETE", "/v1/stores/{storeId}/webstore/custom-domain", {
2150
+ opts,
2151
+ });
1792
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
+ */
1793
2159
  deleteWebstoreModule(moduleId, opts) {
1794
- return this.http.request("DELETE", "/v1/webstores/{storeId}/modules/{moduleId}", {
2160
+ return this.http.request("DELETE", "/v1/stores/{storeId}/webstore/modules/{moduleId}", {
1795
2161
  path: { moduleId },
1796
2162
  opts,
1797
2163
  });
1798
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
+ */
1799
2172
  deleteWebstoreTemplate(templateId, opts) {
1800
- return this.http.request("DELETE", "/v1/webstores/{storeId}/templates/{templateId}", {
1801
- path: { templateId },
1802
- opts,
1803
- });
2173
+ return this.http.request("DELETE", "/v1/stores/{storeId}/webstore/templates/{templateId}", { path: { templateId }, opts });
1804
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
+ */
1805
2182
  deleteWebstoreTemplateFile(templateId, templateFileId, opts) {
1806
- return this.http.request("DELETE", "/v1/webstores/{storeId}/templates/{templateId}/files/{templateFileId}", { path: { templateId, templateFileId }, opts });
2183
+ return this.http.request("DELETE", "/v1/stores/{storeId}/webstore/templates/{templateId}/files/{templateFileId}", { path: { templateId, templateFileId }, opts });
1807
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
+ */
1808
2192
  deleteWebstoreTemplateVariable(templateId, templateVariableId, opts) {
1809
- return this.http.request("DELETE", "/v1/webstores/{storeId}/templates/{templateId}/variables/{templateVariableId}", { path: { templateId, templateVariableId }, opts });
2193
+ return this.http.request("DELETE", "/v1/stores/{storeId}/webstore/templates/{templateId}/variables/{templateVariableId}", { path: { templateId, templateVariableId }, opts });
1810
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
+ */
1811
2202
  downloadWebstoreTemplateUpdate(templateId, opts) {
1812
- return this.http.request("POST", "/v1/webstores/{storeId}/templates/{templateId}/update", { path: { templateId }, opts });
2203
+ return this.http.request("POST", "/v1/stores/{storeId}/webstore/templates/{templateId}/update", { path: { templateId }, opts });
1813
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
+ */
1814
2211
  duplicateWebstoreTemplate(templateId, opts) {
1815
- return this.http.request("POST", "/v1/webstores/{storeId}/templates/{templateId}/duplicate", { path: { templateId }, opts });
2212
+ return this.http.request("POST", "/v1/stores/{storeId}/webstore/templates/{templateId}/duplicate", { path: { templateId }, opts });
1816
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
+ */
1817
2221
  finishWebstoreTemplateUpload(templateId, opts) {
1818
- return this.http.request("POST", "/v1/webstores/{storeId}/templates/{templateId}/upload_finish", { path: { templateId }, opts });
2222
+ return this.http.request("POST", "/v1/stores/{storeId}/webstore/templates/{templateId}/upload_finish", { path: { templateId }, opts });
1819
2223
  }
1820
2224
  /**
1821
2225
  * Get webstore
@@ -1824,7 +2228,7 @@ class WebstoreResource {
1824
2228
  * state and the template it currently renders.
1825
2229
  */
1826
2230
  getWebstore(opts) {
1827
- return this.http.request("GET", "/v1/webstores/{storeId}", { opts });
2231
+ return this.http.request("GET", "/v1/stores/{storeId}/webstore", { opts });
1828
2232
  }
1829
2233
  /**
1830
2234
  * Get custom domain
@@ -1833,42 +2237,123 @@ class WebstoreResource {
1833
2237
  * outstanding for ownership and SSL verification.
1834
2238
  */
1835
2239
  getWebstoreCustomDomain(opts) {
1836
- return this.http.request("GET", "/v1/webstores/{storeId}/custom-domain", { opts });
2240
+ return this.http.request("GET", "/v1/stores/{storeId}/webstore/custom-domain", { opts });
1837
2241
  }
2242
+ /**
2243
+ * Get webstore modules
2244
+ *
2245
+ * Retrieves all modules on the store's webstore, in sort order.
2246
+ */
1838
2247
  getWebstoreModules(opts) {
1839
- return this.http.request("GET", "/v1/webstores/{storeId}/modules", {
1840
- opts,
1841
- });
2248
+ return this.http.request("GET", "/v1/stores/{storeId}/webstore/modules", { opts });
1842
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
+ */
1843
2257
  getWebstoreTemplate(templateId, query, opts) {
1844
- return this.http.request("GET", "/v1/webstores/{storeId}/templates/{templateId}", { path: { templateId }, query, opts });
2258
+ return this.http.request("GET", "/v1/stores/{storeId}/webstore/templates/{templateId}", { path: { templateId }, query, opts });
1845
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
+ */
1846
2266
  getWebstoreTemplateArchive(templateId, opts) {
1847
- return this.http.request("GET", "/v1/webstores/{storeId}/templates/{templateId}/archive", { path: { templateId }, opts });
2267
+ return this.http.request("GET", "/v1/stores/{storeId}/webstore/templates/{templateId}/archive", { path: { templateId }, opts });
1848
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
+ */
1849
2276
  getWebstoreTemplateFile(templateId, templateFileId, opts) {
1850
- return this.http.request("GET", "/v1/webstores/{storeId}/templates/{templateId}/files/{templateFileId}", { path: { templateId, templateFileId }, opts });
2277
+ return this.http.request("GET", "/v1/stores/{storeId}/webstore/templates/{templateId}/files/{templateFileId}", { path: { templateId, templateFileId }, opts });
1851
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
+ */
1852
2286
  getWebstoreTemplateFiles(templateId, opts) {
1853
- return this.http.request("GET", "/v1/webstores/{storeId}/templates/{templateId}/files", { path: { templateId }, opts });
2287
+ return this.http.request("GET", "/v1/stores/{storeId}/webstore/templates/{templateId}/files", { path: { templateId }, opts });
1854
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
+ */
1855
2297
  getWebstoreTemplateLatestVersion(templateId, opts) {
1856
- return this.http.request("GET", "/v1/webstores/{storeId}/templates/{templateId}/update", { path: { templateId }, opts });
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 });
1857
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
+ */
1858
2316
  getWebstoreTemplates(opts) {
1859
- return this.http.request("GET", "/v1/webstores/{storeId}/templates", { opts });
2317
+ return this.http.request("GET", "/v1/stores/{storeId}/webstore/templates", { opts });
1860
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
+ */
1861
2326
  getWebstoreTemplateSchema(templateId, opts) {
1862
- return this.http.request("GET", "/v1/webstores/{storeId}/templates/{templateId}/schema", { path: { templateId }, opts });
2327
+ return this.http.request("GET", "/v1/stores/{storeId}/webstore/templates/{templateId}/schema", { path: { templateId }, opts });
1863
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
+ */
1864
2336
  getWebstoreTemplateUploadUrl(templateId, query, opts) {
1865
- return this.http.request("GET", "/v1/webstores/{storeId}/templates/{templateId}/upload_url", { path: { templateId }, query, opts });
2337
+ return this.http.request("GET", "/v1/stores/{storeId}/webstore/templates/{templateId}/upload_url", { path: { templateId }, query, opts });
1866
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
+ */
1867
2345
  getWebstoreTemplateVariables(templateId, opts) {
1868
- return this.http.request("GET", "/v1/webstores/{storeId}/templates/{templateId}/variables", { path: { templateId }, opts });
2346
+ return this.http.request("GET", "/v1/stores/{storeId}/webstore/templates/{templateId}/variables", { path: { templateId }, opts });
1869
2347
  }
1870
- previewWebstoreTemplate(templateId, opts) {
1871
- return this.http.request("GET", "/v1/webstores/{storeId}/templates/{templateId}/preview", { path: { templateId }, opts });
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 });
1872
2357
  }
1873
2358
  /**
1874
2359
  * Set custom domain
@@ -1876,7 +2361,7 @@ class WebstoreResource {
1876
2361
  * Attaches a custom domain to the store's webstore and begins verification.
1877
2362
  */
1878
2363
  setWebstoreCustomDomain(body, opts) {
1879
- return this.http.request("POST", "/v1/webstores/{storeId}/custom-domain", { body, opts });
2364
+ return this.http.request("POST", "/v1/stores/{storeId}/webstore/custom-domain", { body, opts });
1880
2365
  }
1881
2366
  /**
1882
2367
  * Set default template
@@ -1884,7 +2369,7 @@ class WebstoreResource {
1884
2369
  * Sets the template the webstore renders for customers.
1885
2370
  */
1886
2371
  setWebstoreDefaultTemplate(body, opts) {
1887
- return this.http.request("POST", "/v1/webstores/{storeId}/set-default-template", {
2372
+ return this.http.request("POST", "/v1/stores/{storeId}/webstore/set-default-template", {
1888
2373
  body,
1889
2374
  opts,
1890
2375
  });
@@ -1896,22 +2381,58 @@ class WebstoreResource {
1896
2381
  * slug already taken by another store is rejected.
1897
2382
  */
1898
2383
  setWebstoreSlug(body, opts) {
1899
- return this.http.request("POST", "/v1/webstores/{storeId}/set-slug", { body, opts });
2384
+ return this.http.request("POST", "/v1/stores/{storeId}/webstore/set-slug", {
2385
+ body,
2386
+ opts,
2387
+ });
1900
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
+ */
1901
2395
  updateWebstoreModule(moduleId, body, opts) {
1902
- return this.http.request("PUT", "/v1/webstores/{storeId}/modules/{moduleId}", { path: { moduleId }, body, opts });
2396
+ return this.http.request("PUT", "/v1/stores/{storeId}/webstore/modules/{moduleId}", { path: { moduleId }, body, opts });
1903
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
+ */
1904
2404
  updateWebstoreTemplate(templateId, body, opts) {
1905
- return this.http.request("PUT", "/v1/webstores/{storeId}/templates/{templateId}", { path: { templateId }, body, opts });
2405
+ return this.http.request("PUT", "/v1/stores/{storeId}/webstore/templates/{templateId}", { path: { templateId }, body, opts });
1906
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
+ */
1907
2415
  updateWebstoreTemplateFile(templateId, templateFileId, body, opts) {
1908
- return this.http.request("PUT", "/v1/webstores/{storeId}/templates/{templateId}/files/{templateFileId}", { path: { templateId, templateFileId }, body, opts });
2416
+ return this.http.request("PUT", "/v1/stores/{storeId}/webstore/templates/{templateId}/files/{templateFileId}", { path: { templateId, templateFileId }, body, opts });
1909
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
+ */
1910
2424
  updateWebstoreTemplateSchemaVariables(templateId, body, opts) {
1911
- return this.http.request("PUT", "/v1/webstores/{storeId}/templates/{templateId}/schema/variables", { path: { templateId }, body, opts });
2425
+ return this.http.request("PUT", "/v1/stores/{storeId}/webstore/templates/{templateId}/schema/variables", { path: { templateId }, body, opts });
1912
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
+ */
1913
2434
  updateWebstoreTemplateVariable(templateId, templateVariableId, body, opts) {
1914
- return this.http.request("PUT", "/v1/webstores/{storeId}/templates/{templateId}/variables/{templateVariableId}", { path: { templateId, templateVariableId }, body, opts });
2435
+ return this.http.request("PUT", "/v1/stores/{storeId}/webstore/templates/{templateId}/variables/{templateVariableId}", { path: { templateId, templateVariableId }, body, opts });
1915
2436
  }
1916
2437
  /**
1917
2438
  * Verify custom domain
@@ -1920,7 +2441,7 @@ class WebstoreResource {
1920
2441
  * records returned when the domain was set have been published.
1921
2442
  */
1922
2443
  verifyWebstoreCustomDomain(opts) {
1923
- return this.http.request("POST", "/v1/webstores/{storeId}/custom-domain/verify", {
2444
+ return this.http.request("POST", "/v1/stores/{storeId}/webstore/custom-domain/verify", {
1924
2445
  opts,
1925
2446
  });
1926
2447
  }
@@ -1932,14 +2453,12 @@ class ManagementClient {
1932
2453
  $http;
1933
2454
  affiliateLinks;
1934
2455
  bans;
1935
- billing;
1936
2456
  checkout;
1937
2457
  checkoutStyle;
1938
2458
  coupons;
1939
- customer_portal_sessions;
2459
+ customerPortalSessions;
1940
2460
  customers;
1941
2461
  customVariables;
1942
- dashboard;
1943
2462
  dataMigrations;
1944
2463
  delivery;
1945
2464
  discord;
@@ -1972,14 +2491,12 @@ class ManagementClient {
1972
2491
  this.$http = http;
1973
2492
  this.affiliateLinks = new AffiliateLinksResource(http);
1974
2493
  this.bans = new BansResource(http);
1975
- this.billing = new BillingResource(http);
1976
2494
  this.checkout = new CheckoutResource(http);
1977
2495
  this.checkoutStyle = new CheckoutStyleResource(http);
1978
2496
  this.coupons = new CouponsResource(http);
1979
- this.customer_portal_sessions = new CustomerPortalSessionsResource(http);
2497
+ this.customerPortalSessions = new CustomerPortalSessionsResource(http);
1980
2498
  this.customers = new CustomersResource(http);
1981
2499
  this.customVariables = new CustomVariablesResource(http);
1982
- this.dashboard = new DashboardResource(http);
1983
2500
  this.dataMigrations = new DataMigrationsResource(http);
1984
2501
  this.delivery = new DeliveryResource(http);
1985
2502
  this.discord = new DiscordResource(http);