@paynow-gg/typescript-sdk 2.0.2 → 2.0.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.
@@ -58,6 +58,91 @@ export class BansResource {
58
58
  });
59
59
  }
60
60
  }
61
+ export class BillingResource {
62
+ http;
63
+ constructor(http) {
64
+ this.http = http;
65
+ }
66
+ /**
67
+ * Change subscription payment method
68
+ *
69
+ * Starts a session for the store owner to replace the card the subscription is billed to.
70
+ */
71
+ changeSubscriptionPaymentMethod(opts) {
72
+ return this.http.request("POST", "/v1/stores/{storeId}/billing/payment-method/change", { opts });
73
+ }
74
+ /**
75
+ * Change subscription plan
76
+ *
77
+ * Moves the store onto a different plan. When the change needs paying for, the response
78
+ * carries a 'session_url' the store owner must complete.
79
+ */
80
+ changeSubscriptionPlan(body, opts) {
81
+ return this.http.request("POST", "/v1/stores/{storeId}/billing/plans/change", { body, opts });
82
+ }
83
+ /**
84
+ * Continue current subscription
85
+ *
86
+ * Cancels a pending downgrade or cancellation, keeping the store on its current plan.
87
+ */
88
+ continueCurrentSubscription(opts) {
89
+ return this.http.request("POST", "/v1/stores/{storeId}/billing/plans/continue", { opts });
90
+ }
91
+ /**
92
+ * Get available plans
93
+ *
94
+ * Retrieves the plans a store can subscribe to.
95
+ */
96
+ getPublicPlans(opts) {
97
+ return this.http.request("GET", "/v1/stores/{storeId}/billing/plans", {
98
+ opts,
99
+ });
100
+ }
101
+ /**
102
+ * Get billing details
103
+ *
104
+ * Retrieves the billing address and tax details the store is invoiced under.
105
+ */
106
+ getStoreBillingDetails(opts) {
107
+ return this.http.request("GET", "/v1/stores/{storeId}/billing/details", { opts });
108
+ }
109
+ /**
110
+ * Get billing status
111
+ *
112
+ * Retrieves the store's plan, limits, feature flags and subscription state.
113
+ */
114
+ getStoreBillingStatus(opts) {
115
+ return this.http.request("GET", "/v1/stores/{storeId}/billing/status", {
116
+ opts,
117
+ });
118
+ }
119
+ /**
120
+ * Get subscription invoices
121
+ *
122
+ * Retrieves the invoices raised against the store's own subscription.
123
+ */
124
+ getStoreInvoices(query, opts) {
125
+ return this.http.request("GET", "/v1/stores/{storeId}/billing/invoices", { query, opts });
126
+ }
127
+ /**
128
+ * Get invoice URL
129
+ *
130
+ * Issues a fresh link to the hosted invoice. Prefer this over the 'invoice_url' carried by
131
+ * the invoice list, which is recorded once and may have expired.
132
+ * @param invoiceId The ID of the invoice to link to.
133
+ */
134
+ getStoreInvoiceUrl(invoiceId, opts) {
135
+ return this.http.request("GET", "/v1/stores/{storeId}/billing/invoices/{invoiceId}/url", { path: { invoiceId }, opts });
136
+ }
137
+ /**
138
+ * Update billing details
139
+ *
140
+ * Replaces the billing address and tax details the store is invoiced under.
141
+ */
142
+ updateStoreBillingDetails(body, opts) {
143
+ return this.http.request("PUT", "/v1/stores/{storeId}/billing/details", { body, opts });
144
+ }
145
+ }
61
146
  export class CheckoutResource {
62
147
  http;
63
148
  constructor(http) {
@@ -73,6 +158,57 @@ export class CheckoutResource {
73
158
  return this.http.request("POST", "/v1/stores/{storeId}/checkouts", { body, opts });
74
159
  }
75
160
  }
161
+ export class CheckoutStyleResource {
162
+ http;
163
+ constructor(http) {
164
+ this.http = http;
165
+ }
166
+ /**
167
+ * Delete checkout background image
168
+ *
169
+ * Removes the hosted checkout background image for the store.
170
+ */
171
+ deleteStoreCheckoutStyleBackgroundImage(opts) {
172
+ return this.http.request("DELETE", "/v1/stores/{storeId}/checkout-style/background-image", { opts });
173
+ }
174
+ /**
175
+ * Finish checkout background image upload
176
+ *
177
+ * Finishes an upload of the hosted checkout background image.
178
+ */
179
+ finishStoreCheckoutStyleBackgroundImageUpload(body, opts) {
180
+ return this.http.request("POST", "/v1/stores/{storeId}/checkout-style/background-image/upload_finish", { body, opts });
181
+ }
182
+ /**
183
+ * Get store checkout style
184
+ *
185
+ * Retrieves the checkout styling for the store.
186
+ */
187
+ getStoreCheckoutStyle(opts) {
188
+ return this.http.request("GET", "/v1/stores/{storeId}/checkout-style", {
189
+ opts,
190
+ });
191
+ }
192
+ /**
193
+ * Get upload URL for checkout background image
194
+ *
195
+ * Gets a pre-signed upload URL for uploading the hosted checkout background image.
196
+ */
197
+ getStoreCheckoutStyleBackgroundImageUploadUrl(opts) {
198
+ return this.http.request("GET", "/v1/stores/{storeId}/checkout-style/background-image/upload_url", { opts });
199
+ }
200
+ /**
201
+ * Update store checkout style
202
+ *
203
+ * Updates the stores checkout style.
204
+ */
205
+ updateStoreCheckoutStyle(body, opts) {
206
+ return this.http.request("PATCH", "/v1/stores/{storeId}/checkout-style", {
207
+ body,
208
+ opts,
209
+ });
210
+ }
211
+ }
76
212
  export class CouponsResource {
77
213
  http;
78
214
  constructor(http) {
@@ -629,6 +765,50 @@ export class GlobalCommandsResource {
629
765
  return this.http.request("PATCH", "/v1/stores/{storeId}/global-commands/{globalCommandId}", { path: { globalCommandId }, body, opts });
630
766
  }
631
767
  }
768
+ export class InvitesResource {
769
+ http;
770
+ constructor(http) {
771
+ this.http = http;
772
+ }
773
+ /**
774
+ * Cancel an invite
775
+ *
776
+ * Cancels a pending store member invite.
777
+ */
778
+ cancelInvite(inviteId, opts) {
779
+ return this.http.request("DELETE", "/v1/stores/{storeId}/invites/{inviteId}", {
780
+ path: { inviteId },
781
+ opts,
782
+ });
783
+ }
784
+ /**
785
+ * Create an invite
786
+ *
787
+ * Invites a user to join the store with the specified role.
788
+ */
789
+ createInvite(body, opts) {
790
+ return this.http.request("POST", "/v1/stores/{storeId}/invites", { body, opts });
791
+ }
792
+ /**
793
+ * Get an invite
794
+ *
795
+ * Retrieves a single store member invite.
796
+ */
797
+ getInvite(inviteId, opts) {
798
+ return this.http.request("GET", "/v1/stores/{storeId}/invites/{inviteId}", {
799
+ path: { inviteId },
800
+ opts,
801
+ });
802
+ }
803
+ /**
804
+ * Get invites
805
+ *
806
+ * Retrieves all store member invites for the specified store.
807
+ */
808
+ getInvites(opts) {
809
+ return this.http.request("GET", "/v1/stores/{storeId}/invites", { opts });
810
+ }
811
+ }
632
812
  export class InvoicesResource {
633
813
  http;
634
814
  constructor(http) {
@@ -954,6 +1134,25 @@ export class ProductsResource {
954
1134
  opts,
955
1135
  });
956
1136
  }
1137
+ /**
1138
+ * Delete product image
1139
+ *
1140
+ * Deletes the image for a product.
1141
+ */
1142
+ deleteProductImage(productId, opts) {
1143
+ return this.http.request("DELETE", "/v1/stores/{storeId}/products/{productId}/image", {
1144
+ path: { productId },
1145
+ opts,
1146
+ });
1147
+ }
1148
+ /**
1149
+ * Finish product image upload
1150
+ *
1151
+ * Finishes an image upload for a product, attaching the uploaded image to the product.
1152
+ */
1153
+ finishProductImageUpload(productId, body, opts) {
1154
+ return this.http.request("POST", "/v1/stores/{storeId}/products/{productId}/image-upload-finish", { path: { productId }, body, opts });
1155
+ }
957
1156
  /**
958
1157
  * Get product
959
1158
  *
@@ -967,6 +1166,14 @@ export class ProductsResource {
967
1166
  opts,
968
1167
  });
969
1168
  }
1169
+ /**
1170
+ * Get upload URL for product image
1171
+ *
1172
+ * Gets a pre-signed upload URL for uploading an image to a product.
1173
+ */
1174
+ getProductImageUploadUrl(productId, opts) {
1175
+ return this.http.request("GET", "/v1/stores/{storeId}/products/{productId}/image-upload-url", { path: { productId }, opts });
1176
+ }
970
1177
  /**
971
1178
  * Get products
972
1179
  *
@@ -1022,6 +1229,40 @@ export class RegionalPricingResource {
1022
1229
  return this.http.request("PATCH", "/v1/stores/{storeId}/products/pricing/regions/{regionId}", { path: { regionId }, body, opts });
1023
1230
  }
1024
1231
  }
1232
+ export class RolesResource {
1233
+ http;
1234
+ constructor(http) {
1235
+ this.http = http;
1236
+ }
1237
+ createRole(body, opts) {
1238
+ return this.http.request("POST", "/v1/stores/{storeId}/roles", { body, opts });
1239
+ }
1240
+ deleteRole(roleId, opts) {
1241
+ return this.http.request("DELETE", "/v1/stores/{storeId}/roles/{roleId}", {
1242
+ path: { roleId },
1243
+ opts,
1244
+ });
1245
+ }
1246
+ getAvailablePermissions(opts) {
1247
+ return this.http.request("GET", "/v1/stores/{storeId}/roles/permissions", { opts });
1248
+ }
1249
+ getRole(roleId, opts) {
1250
+ return this.http.request("GET", "/v1/stores/{storeId}/roles/{roleId}", {
1251
+ path: { roleId },
1252
+ opts,
1253
+ });
1254
+ }
1255
+ getRoles(opts) {
1256
+ return this.http.request("GET", "/v1/stores/{storeId}/roles", { opts });
1257
+ }
1258
+ updateRole(roleId, body, opts) {
1259
+ return this.http.request("PATCH", "/v1/stores/{storeId}/roles/{roleId}", {
1260
+ path: { roleId },
1261
+ body,
1262
+ opts,
1263
+ });
1264
+ }
1265
+ }
1025
1266
  export class SalesResource {
1026
1267
  http;
1027
1268
  constructor(http) {
@@ -1073,6 +1314,25 @@ export class StoreResource {
1073
1314
  constructor(http) {
1074
1315
  this.http = http;
1075
1316
  }
1317
+ /**
1318
+ * Delete store logo
1319
+ *
1320
+ * Deletes a logo for a store.
1321
+ */
1322
+ deleteStoreLogo(query, opts) {
1323
+ return this.http.request("DELETE", "/v1/stores/{storeId}/logo", { query, opts });
1324
+ }
1325
+ /**
1326
+ * Finish store logo upload
1327
+ *
1328
+ * Finishes a logo upload for a store, attaching the uploaded image to the store.
1329
+ */
1330
+ finishStoreLogoUpload(body, opts) {
1331
+ return this.http.request("POST", "/v1/stores/{storeId}/logo-upload-finish", {
1332
+ body,
1333
+ opts,
1334
+ });
1335
+ }
1076
1336
  /**
1077
1337
  * Get a store
1078
1338
  *
@@ -1081,6 +1341,14 @@ export class StoreResource {
1081
1341
  getStore(opts) {
1082
1342
  return this.http.request("GET", "/v1/stores/{storeId}", { opts });
1083
1343
  }
1344
+ /**
1345
+ * Get upload URL for store logo
1346
+ *
1347
+ * Gets a pre-signed upload URL for uploading a logo to a store.
1348
+ */
1349
+ getStoreLogoUploadUrl(opts) {
1350
+ return this.http.request("GET", "/v1/stores/{storeId}/logo-upload-url", { opts });
1351
+ }
1084
1352
  /**
1085
1353
  * Get store member permissions
1086
1354
  *
@@ -1456,13 +1724,142 @@ export class WebhooksResource {
1456
1724
  return this.http.request("PATCH", "/v1/stores/{storeId}/webhooks/{webhookId}", { path: { webhookId }, body, opts });
1457
1725
  }
1458
1726
  }
1727
+ export class WebstoreResource {
1728
+ http;
1729
+ constructor(http) {
1730
+ this.http = http;
1731
+ }
1732
+ createWebstoreModule(body, opts) {
1733
+ return this.http.request("PUT", "/v1/webstores/{storeId}/modules", {
1734
+ body,
1735
+ opts,
1736
+ });
1737
+ }
1738
+ createWebstoreTemplate(body, opts) {
1739
+ return this.http.request("PUT", "/v1/webstores/{storeId}/templates", {
1740
+ body,
1741
+ opts,
1742
+ });
1743
+ }
1744
+ createWebstoreTemplateFile(templateId, body, opts) {
1745
+ return this.http.request("PUT", "/v1/webstores/{storeId}/templates/{templateId}/files", { path: { templateId }, body, opts });
1746
+ }
1747
+ createWebstoreTemplateVariable(templateId, body, opts) {
1748
+ return this.http.request("PUT", "/v1/webstores/{storeId}/templates/{templateId}/variables", { path: { templateId }, body, opts });
1749
+ }
1750
+ deleteWebstoreCustomDomain(opts) {
1751
+ return this.http.request("DELETE", "/v1/webstores/{storeId}/custom-domain", { opts });
1752
+ }
1753
+ deleteWebstoreModule(moduleId, opts) {
1754
+ return this.http.request("DELETE", "/v1/webstores/{storeId}/modules/{moduleId}", {
1755
+ path: { moduleId },
1756
+ opts,
1757
+ });
1758
+ }
1759
+ deleteWebstoreTemplate(templateId, opts) {
1760
+ return this.http.request("DELETE", "/v1/webstores/{storeId}/templates/{templateId}", {
1761
+ path: { templateId },
1762
+ opts,
1763
+ });
1764
+ }
1765
+ deleteWebstoreTemplateFile(templateId, templateFileId, opts) {
1766
+ return this.http.request("DELETE", "/v1/webstores/{storeId}/templates/{templateId}/files/{templateFileId}", { path: { templateId, templateFileId }, opts });
1767
+ }
1768
+ deleteWebstoreTemplateVariable(templateId, templateVariableId, opts) {
1769
+ return this.http.request("DELETE", "/v1/webstores/{storeId}/templates/{templateId}/variables/{templateVariableId}", { path: { templateId, templateVariableId }, opts });
1770
+ }
1771
+ downloadWebstoreTemplateUpdate(templateId, opts) {
1772
+ return this.http.request("POST", "/v1/webstores/{storeId}/templates/{templateId}/update", { path: { templateId }, opts });
1773
+ }
1774
+ duplicateWebstoreTemplate(templateId, opts) {
1775
+ return this.http.request("POST", "/v1/webstores/{storeId}/templates/{templateId}/duplicate", { path: { templateId }, opts });
1776
+ }
1777
+ finishWebstoreTemplateUpload(templateId, opts) {
1778
+ return this.http.request("POST", "/v1/webstores/{storeId}/templates/{templateId}/upload_finish", { path: { templateId }, opts });
1779
+ }
1780
+ getWebstore(opts) {
1781
+ return this.http.request("GET", "/v1/webstores/{storeId}", { opts });
1782
+ }
1783
+ getWebstoreCustomDomain(opts) {
1784
+ return this.http.request("GET", "/v1/webstores/{storeId}/custom-domain", { opts });
1785
+ }
1786
+ getWebstoreModules(opts) {
1787
+ return this.http.request("GET", "/v1/webstores/{storeId}/modules", {
1788
+ opts,
1789
+ });
1790
+ }
1791
+ getWebstoreTemplate(templateId, query, opts) {
1792
+ return this.http.request("GET", "/v1/webstores/{storeId}/templates/{templateId}", { path: { templateId }, query, opts });
1793
+ }
1794
+ getWebstoreTemplateArchive(templateId, opts) {
1795
+ return this.http.request("GET", "/v1/webstores/{storeId}/templates/{templateId}/archive", { path: { templateId }, opts });
1796
+ }
1797
+ getWebstoreTemplateFile(templateId, templateFileId, opts) {
1798
+ return this.http.request("GET", "/v1/webstores/{storeId}/templates/{templateId}/files/{templateFileId}", { path: { templateId, templateFileId }, opts });
1799
+ }
1800
+ getWebstoreTemplateFiles(templateId, opts) {
1801
+ return this.http.request("GET", "/v1/webstores/{storeId}/templates/{templateId}/files", { path: { templateId }, opts });
1802
+ }
1803
+ getWebstoreTemplateLatestVersion(templateId, opts) {
1804
+ return this.http.request("GET", "/v1/webstores/{storeId}/templates/{templateId}/update", { path: { templateId }, opts });
1805
+ }
1806
+ getWebstoreTemplates(opts) {
1807
+ return this.http.request("GET", "/v1/webstores/{storeId}/templates", { opts });
1808
+ }
1809
+ getWebstoreTemplateSchema(templateId, opts) {
1810
+ return this.http.request("GET", "/v1/webstores/{storeId}/templates/{templateId}/schema", { path: { templateId }, opts });
1811
+ }
1812
+ getWebstoreTemplateUploadUrl(templateId, query, opts) {
1813
+ return this.http.request("GET", "/v1/webstores/{storeId}/templates/{templateId}/upload_url", { path: { templateId }, query, opts });
1814
+ }
1815
+ getWebstoreTemplateVariables(templateId, opts) {
1816
+ return this.http.request("GET", "/v1/webstores/{storeId}/templates/{templateId}/variables", { path: { templateId }, opts });
1817
+ }
1818
+ previewWebstoreTemplate(templateId, opts) {
1819
+ return this.http.request("GET", "/v1/webstores/{storeId}/templates/{templateId}/preview", { path: { templateId }, opts });
1820
+ }
1821
+ setWebstoreCustomDomain(body, opts) {
1822
+ return this.http.request("POST", "/v1/webstores/{storeId}/custom-domain", { body, opts });
1823
+ }
1824
+ setWebstoreDefaultTemplate(body, opts) {
1825
+ return this.http.request("POST", "/v1/webstores/{storeId}/set-default-template", {
1826
+ body,
1827
+ opts,
1828
+ });
1829
+ }
1830
+ setWebstoreSlug(body, opts) {
1831
+ return this.http.request("POST", "/v1/webstores/{storeId}/set-slug", { body, opts });
1832
+ }
1833
+ updateWebstoreModule(moduleId, body, opts) {
1834
+ return this.http.request("PUT", "/v1/webstores/{storeId}/modules/{moduleId}", { path: { moduleId }, body, opts });
1835
+ }
1836
+ updateWebstoreTemplate(templateId, body, opts) {
1837
+ return this.http.request("PUT", "/v1/webstores/{storeId}/templates/{templateId}", { path: { templateId }, body, opts });
1838
+ }
1839
+ updateWebstoreTemplateFile(templateId, templateFileId, body, opts) {
1840
+ return this.http.request("PUT", "/v1/webstores/{storeId}/templates/{templateId}/files/{templateFileId}", { path: { templateId, templateFileId }, body, opts });
1841
+ }
1842
+ updateWebstoreTemplateSchemaVariables(templateId, body, opts) {
1843
+ return this.http.request("PUT", "/v1/webstores/{storeId}/templates/{templateId}/schema/variables", { path: { templateId }, body, opts });
1844
+ }
1845
+ updateWebstoreTemplateVariable(templateId, templateVariableId, body, opts) {
1846
+ return this.http.request("PUT", "/v1/webstores/{storeId}/templates/{templateId}/variables/{templateVariableId}", { path: { templateId, templateVariableId }, body, opts });
1847
+ }
1848
+ verifyWebstoreCustomDomain(opts) {
1849
+ return this.http.request("POST", "/v1/webstores/{storeId}/custom-domain/verify", {
1850
+ opts,
1851
+ });
1852
+ }
1853
+ }
1459
1854
  /** Typed client for the PayNow management API. */
1460
1855
  export class ManagementClient {
1461
1856
  /** Escape hatch for endpoints this SDK does not model. */
1462
1857
  $http;
1463
1858
  affiliateLinks;
1464
1859
  bans;
1860
+ billing;
1465
1861
  checkout;
1862
+ checkoutStyle;
1466
1863
  coupons;
1467
1864
  customer_portal_sessions;
1468
1865
  customers;
@@ -1475,6 +1872,7 @@ export class ManagementClient {
1475
1872
  gameServers;
1476
1873
  giftcards;
1477
1874
  globalCommands;
1875
+ invites;
1478
1876
  invoices;
1479
1877
  marketing;
1480
1878
  navlinks;
@@ -1485,6 +1883,7 @@ export class ManagementClient {
1485
1883
  productDependentMigrations;
1486
1884
  products;
1487
1885
  regionalPricing;
1886
+ roles;
1488
1887
  sales;
1489
1888
  store;
1490
1889
  subscriptions;
@@ -1493,11 +1892,14 @@ export class ManagementClient {
1493
1892
  trials;
1494
1893
  upsellSettings;
1495
1894
  webhooks;
1895
+ webstore;
1496
1896
  constructor(http) {
1497
1897
  this.$http = http;
1498
1898
  this.affiliateLinks = new AffiliateLinksResource(http);
1499
1899
  this.bans = new BansResource(http);
1900
+ this.billing = new BillingResource(http);
1500
1901
  this.checkout = new CheckoutResource(http);
1902
+ this.checkoutStyle = new CheckoutStyleResource(http);
1501
1903
  this.coupons = new CouponsResource(http);
1502
1904
  this.customer_portal_sessions = new CustomerPortalSessionsResource(http);
1503
1905
  this.customers = new CustomersResource(http);
@@ -1510,6 +1912,7 @@ export class ManagementClient {
1510
1912
  this.gameServers = new GameServersResource(http);
1511
1913
  this.giftcards = new GiftcardsResource(http);
1512
1914
  this.globalCommands = new GlobalCommandsResource(http);
1915
+ this.invites = new InvitesResource(http);
1513
1916
  this.invoices = new InvoicesResource(http);
1514
1917
  this.marketing = new MarketingResource(http);
1515
1918
  this.navlinks = new NavlinksResource(http);
@@ -1520,6 +1923,7 @@ export class ManagementClient {
1520
1923
  this.productDependentMigrations = new ProductDependentMigrationsResource(http);
1521
1924
  this.products = new ProductsResource(http);
1522
1925
  this.regionalPricing = new RegionalPricingResource(http);
1926
+ this.roles = new RolesResource(http);
1523
1927
  this.sales = new SalesResource(http);
1524
1928
  this.store = new StoreResource(http);
1525
1929
  this.subscriptions = new SubscriptionsResource(http);
@@ -1528,6 +1932,7 @@ export class ManagementClient {
1528
1932
  this.trials = new TrialsResource(http);
1529
1933
  this.upsellSettings = new UpsellSettingsResource(http);
1530
1934
  this.webhooks = new WebhooksResource(http);
1935
+ this.webstore = new WebstoreResource(http);
1531
1936
  }
1532
1937
  }
1533
1938
  /** Creates a ManagementClient that authenticates and scopes every request. */