@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.
@@ -1,85 +1,85 @@
1
1
  import { HttpClient } from "../../runtime/http.js";
2
2
  import type { ClientOptions, RequestOptions } from "../../runtime/options.js";
3
- import type { AbandonedCheckoutStoreConfigurationDto, AbandonedCheckoutStoreConfigurationUpdateDto, AffiliateLinkDto, AvailablePermissionDto, BanDto, BansGetBansQuery, BillingGetStoreInvoicesQuery, CancelSubscriptionRequestDto, ChangeSubscriptionPlanDto, CheckForBanIDByIdentitiesRequestDto, CheckForBanIDByIdentitiesResponseDto, CheckoutSessionDto, CheckoutStyleDto, CommandAttemptDto, CouponDto, CouponsGetCouponsForStoreQuery, CreateAffiliateLinkDto, CreateCheckoutSessionManagementDto, CreateCheckoutSessionResponseDto, CreateCouponDto, CreateCustomerPortalSessionRequestDto, CreateDownloadableFileDownloadUrlResponseDto, CreateEmailTemplateDto, CreateGameServerConsoleDto, CreateGameServerDto, CreateGiftCardDto, CreateInviteDto, CreateNavLinkDto, CreateProductDependentMigrationRequestDto, CreateRefundRequestDto, CreateRoleDto, CreateSaleDto, CreateTierGroupRequestDto, CreateTrialEligibilityOverrideDto, CreateWebhookDto, CreateWebstoreModuleDto, CreateWebstoreTemplateDto, CreateWebstoreTemplateFileDto, CreateWebstoreTemplateVariableDto, CustomerDto, CustomerPortalSessionDto, CustomersGetCustomersQuery, CustomersLookupCustomerQuery, CustomerTokenResponseDto, CustomVariableDto, DashboardSearchDashboardQuery, DashboardSearchHintDto, DataMigrationsGetDataMigrationsQuery, DataMigrationTaskDto, DeactivateEmailTemplateRequestDto, DeliveryGetCommandAttemptsForCustomerQuery, DeliveryGetCustomerDeliveryItemsQuery, DeliveryGetGameServerDeliveryItemsQuery, DeliveryGetOrderDeliveryItemsQuery, DeliveryGetStoreDeliveryItemsQuery, DeliveryItemAssignmentBulkDto, DeliveryItemAssignmentDto, DeliveryItemDto, DiscordActionDto, DiscordProfileDto, DiscordServerChannelDto, DiscordServerLinkDto, DiscordServerRoleDto, DiscordSetUserToDeliveryItemLinkQuery, EmailBrandingDto, EmailDeliveryDto, EmailTemplateDefinitionDto, EmailTemplateDto, FinishCheckoutStyleBackgroundImageUploadRequestDto, FinishEmailBrandingImageUploadRequestDto, FinishProductImageUploadRequestDto, FinishStoreLogoUploadRequestDto, FinishTagImageUploadUrlRequestDto, FinishWebstoreTemplateUploadResponseDto, FlakeId, GameServerConsoleDto, GameServerConsoleMessageDto, GameServerDto, GetCheckoutStyleBackgroundImageUploadUrlResponseDto, GetEmailBrandingImageUploadUrlResponseDto, GetProductImageUploadUrlResponseDto, GetStoreLogoUploadUrlResponseDto, GetTagImageUploadUrlResponseDto, GetWebstoreTemplateArchiveResponseDto, GetWebstoreTemplateUploadUrlResponseDto, GiftCardDto, GiftcardsGetGiftCardsQuery, GlobalCommandDto, InviteDto, InvoiceDownloadUrlResponseDto, InvoiceDto, InvoicesListInvoicesQuery, InvoiceUrlDto, MarketingGetEmailBrandingImageUploadUrlQuery, MarketingGetEmailDeliveriesQuery, MarketingGetEmailTemplatesQuery, NavLinkDto, OrderDto, OrdersGetOrdersQuery, PaymentDto, PaymentMethodTypeDto, PaymentsGetPaymentsQuery, PlanPreviewDto, ProductDependentMigrationDto, ProductDependentMigrationEstimateVersionDto, ProductDependentMigrationsGetProductDependentMigrationsQuery, ProductDownloadableFileDto, ProductDto, ProductPricingRegionDto, ProductPricingRegionGroupDto, ProductPricingRegionOverrideDto, ProductsGetProductsQuery, PurchaseFollowUpStoreConfigurationDto, PurchaseFollowUpStoreConfigurationUpdateDto, QueuedDiscordActionDto, RefundDto, ResendCommandsForGameServerRequestDto, ResendCommandsForGameServerResponseDto, ResendWebhookDto, RoleDto, SaleDto, SearchDashboardResponseDto, SetDiscordActionDto, SetWebstoreCustomDomainRequestDto, SetWebstoreDefaultTemplateRequestDto, SetWebstoreSlugRequestDto, StartDataMigrationFromTebexRequestDto, StartDownloadableFileUploadRequestDto, StoreBillingDetailsDto, StoreBillingStatusDto, StoreDeleteStoreLogoQuery, StoreDto, StoreInvoiceDto, StoreMemberDto, StorePaymentSettingsDto, StorePricingRegionOverrideDto, StoreUpsellSettingsDto, SubscriptionDto, SubscriptionsGetSubscriptionsQuery, TagDto, TierGroupDto, ToggleStorePaymentMethodTypeRequestDto, TrialDto, TrialEligibilityOverrideDto, TrialsGetEligibilityOverridesForCustomerQuery, TrialsGetTrialsQuery, UnqueueCommandsRequestDto, UnqueueCommandsResponseDto, UpdateAffiliateLinkDto, UpdateCheckoutStyleDto, UpdateCouponDto, UpdateEmailBrandingDto, UpdateEmailTemplateDto, UpdateGameServerConsoleDto, UpdateGameServerDto, UpdateGiftCardDto, UpdateNavLinkDto, UpdateNavLinkOrderChangeDto, UpdateProductSortOrderRequestDto, UpdateRoleDto, UpdateSaleDto, UpdateStoreDto, UpdateStoreMemberDto, UpdateStorePaymentSettingsDto, UpdateStoreUpsellSettingsDto, UpdateSubscriptionRequestDto, UpdateSubscriptionResponseDto, UpdateTierGroupRequestDto, UpdateWebhookDto, UpdateWebstoreTemplateFileRequestDto, UpsertBanRequestDto, UpsertCustomerRequestDto, UpsertCustomVariableRequestDto, UpsertGlobalCommandDto, UpsertProductRequestDto, UpsertTagRequestDto, WebhookHistoryDto, WebhookSubscriptionDto, WebhooksGetHistoryQuery, WebhookVariablesDto, WebstoreCustomDomainDto, WebstoreDto, WebstoreGetWebstoreTemplateQuery, WebstoreGetWebstoreTemplateUploadUrlQuery, WebstoreModuleDto, WebstoreTemplateDto, WebstoreTemplateFileDto, WebstoreTemplateLatestVersionDto, WebstoreTemplatePreviewResponseDto, WebstoreTemplateSchemaDto, WebstoreTemplateVariableDto } from "./types.js";
3
+ import type { AbandonedCheckoutStoreConfigurationDto, AbandonedCheckoutStoreConfigurationUpdateDto, AffiliateLinkDto, AvailablePermissionDto, BanDto, BansGetBansQuery, CancelSubscriptionRequestDto, CheckForBanIDByIdentitiesRequestDto, CheckForBanIDByIdentitiesResponseDto, CheckoutStyleDto, CommandAttemptDto, CouponDto, CouponsGetCouponsQuery, CreateAffiliateLinkDto, CreateCheckoutSessionManagementDto, CreateCheckoutSessionResponseDto, CreateCouponDto, CreateCustomerPortalSessionRequestDto, CreateDownloadableFileDownloadUrlResponseDto, CreateEmailTemplateDto, CreateGameServerConsoleDto, CreateGameServerDto, CreateGiftCardDto, CreateInviteDto, CreateNavLinkDto, CreateProductDependentMigrationRequestDto, CreateRefundRequestDto, CreateRoleDto, CreateSaleDto, CreateTierGroupRequestDto, CreateTrialEligibilityOverrideDto, CreateWebhookDto, CreateWebstoreModuleDto, CreateWebstoreTemplateDto, CreateWebstoreTemplateFileDto, CreateWebstoreTemplateVariableDto, CustomerDto, CustomerPortalSessionDto, CustomersGetCustomersQuery, CustomersLookupCustomerQuery, CustomerTokenResponseDto, CustomVariableDto, DataMigrationsGetDataMigrationsQuery, DataMigrationTaskDto, DeactivateEmailTemplateRequestDto, DeliveryGetCommandAttemptsForCustomerQuery, DeliveryGetCustomerDeliveryItemsQuery, DeliveryGetGameServerDeliveryItemsQuery, DeliveryGetOrderDeliveryItemsQuery, DeliveryGetStoreDeliveryItemsQuery, DeliveryItemAssignmentBulkDto, DeliveryItemAssignmentDto, DeliveryItemDto, DiscordActionDto, DiscordProfileDto, DiscordServerChannelDto, DiscordServerLinkDto, DiscordServerRoleDto, DiscordSetUserToDeliveryItemLinkQuery, EmailBrandingDto, EmailDeliveryDto, EmailTemplateDefinitionDto, EmailTemplateDto, FinishCheckoutStyleBackgroundImageUploadRequestDto, FinishEmailBrandingImageUploadRequestDto, FinishProductImageUploadRequestDto, FinishStoreLogoUploadRequestDto, FinishTagImageUploadUrlRequestDto, FinishWebstoreTemplateUploadResponseDto, FlakeId, GameServerConsoleDto, GameServerConsoleMessageDto, GameServerDto, GetCheckoutStyleBackgroundImageUploadUrlResponseDto, GetEmailBrandingImageUploadUrlResponseDto, GetProductImageUploadUrlResponseDto, GetStoreLogoUploadUrlResponseDto, GetTagImageUploadUrlResponseDto, GetWebstoreTemplateArchiveResponseDto, GetWebstoreTemplatePreviewUrlResponseDto, GetWebstoreTemplateUploadUrlResponseDto, GiftCardDto, GiftcardsGetGiftCardsQuery, GlobalCommandDto, InstallMarketplaceTemplateResponseDto, InviteDto, InvoiceDownloadUrlResponseDto, InvoiceDto, InvoicesListInvoicesQuery, MarketingGetEmailBrandingImageUploadUrlQuery, MarketingGetEmailDeliveriesQuery, MarketingGetEmailTemplatesQuery, NavLinkDto, OrderDto, OrdersGetOrdersQuery, PaymentDto, PaymentMethodTypeDto, PaymentsGetPaymentsQuery, ProductDependentMigrationDto, ProductDependentMigrationEstimateVersionDto, ProductDependentMigrationsGetProductDependentMigrationsQuery, ProductDownloadableFileDto, ProductDto, ProductPricingRegionDto, ProductPricingRegionGroupDto, ProductPricingRegionOverrideDto, ProductsGetProductsQuery, PurchaseFollowUpStoreConfigurationDto, PurchaseFollowUpStoreConfigurationUpdateDto, QueuedDiscordActionDto, RefundDto, ResendCommandsForGameServerRequestDto, ResendCommandsForGameServerResponseDto, ResendWebhookDto, RoleDto, SaleDto, SetDiscordActionDto, SetWebstoreCustomDomainRequestDto, SetWebstoreDefaultTemplateRequestDto, SetWebstoreSlugRequestDto, StartDataMigrationFromTebexRequestDto, StartDownloadableFileUploadRequestDto, StoreDeleteStoreLogoQuery, StoreDto, StoreMemberDto, StorePaymentSettingsDto, StorePricingRegionOverrideDto, StoreUpsellSettingsDto, SubscriptionDto, SubscriptionsGetSubscriptionsQuery, TagDto, TierGroupDto, ToggleStorePaymentMethodTypeRequestDto, TrialDto, TrialEligibilityOverrideDto, TrialsGetEligibilityOverridesForCustomerQuery, TrialsGetTrialsQuery, UnqueueCommandsRequestDto, UnqueueCommandsResponseDto, UpdateAffiliateLinkDto, UpdateCheckoutStyleDto, UpdateCouponDto, UpdateEmailBrandingDto, UpdateEmailTemplateDto, UpdateGameServerConsoleDto, UpdateGameServerDto, UpdateGiftCardDto, UpdateNavLinkDto, UpdateNavLinkOrderChangeDto, UpdateProductSortOrderRequestDto, UpdateRoleDto, UpdateSaleDto, UpdateStoreDto, UpdateStoreMemberDto, UpdateStorePaymentSettingsDto, UpdateStoreUpsellSettingsDto, UpdateSubscriptionRequestDto, UpdateSubscriptionResponseDto, UpdateTierGroupRequestDto, UpdateWebhookDto, UpdateWebstoreTemplateFileRequestDto, UpsertBanRequestDto, UpsertCustomerRequestDto, UpsertCustomVariableRequestDto, UpsertGlobalCommandDto, UpsertProductRequestDto, UpsertTagRequestDto, WebhookHistoryDto, WebhookSubscriptionDto, WebhooksGetHistoryQuery, WebhookVariablesDto, WebstoreCustomDomainDto, WebstoreDto, WebstoreGetWebstoreTemplateQuery, WebstoreGetWebstoreTemplateUploadUrlQuery, WebstoreModuleDto, WebstoreTemplateDto, WebstoreTemplateFileDto, WebstoreTemplateLatestVersionDto, WebstoreTemplateSchemaDto, WebstoreTemplateVariableDto } from "./types.js";
4
4
  export declare class AffiliateLinksResource {
5
5
  private readonly http;
6
6
  constructor(http: HttpClient);
7
+ /**
8
+ * Create affiliate link
9
+ *
10
+ * Creates a new affiliate link in the specified store.
11
+ */
7
12
  createAffiliateLink(body: CreateAffiliateLinkDto, opts?: RequestOptions): Promise<AffiliateLinkDto>;
13
+ /**
14
+ * Delete affiliate link by ID
15
+ *
16
+ * Deletes an affiliate link by the ID for the specified store.
17
+ * @param affiliateLinkId The ID of the affiliate link.
18
+ */
8
19
  deleteAffiliateLink(affiliateLinkId: FlakeId, opts?: RequestOptions): Promise<void>;
9
- getAffiliateLink(affiliateLinkId: FlakeId, opts?: RequestOptions): Promise<AffiliateLinkDto>;
10
- getAffiliateLinks(opts?: RequestOptions): Promise<Array<AffiliateLinkDto>>;
11
- updateAffiliateLink(affiliateLinkId: FlakeId, body?: UpdateAffiliateLinkDto, opts?: RequestOptions): Promise<AffiliateLinkDto>;
12
- }
13
- export declare class BansResource {
14
- private readonly http;
15
- constructor(http: HttpClient);
16
- checkForBanByIdentities(body: CheckForBanIDByIdentitiesRequestDto, opts?: RequestOptions): Promise<CheckForBanIDByIdentitiesResponseDto>;
17
- createBan(body?: UpsertBanRequestDto, opts?: RequestOptions): Promise<BanDto>;
18
- deleteBan(banId: FlakeId, opts?: RequestOptions): Promise<void>;
19
- getBan(banId: FlakeId, opts?: RequestOptions): Promise<BanDto>;
20
- getBans(query?: BansGetBansQuery, opts?: RequestOptions): Promise<Array<BanDto>>;
21
- updateBan(banId: FlakeId, body?: UpsertBanRequestDto, opts?: RequestOptions): Promise<BanDto>;
22
- }
23
- export declare class BillingResource {
24
- private readonly http;
25
- constructor(http: HttpClient);
26
20
  /**
27
- * Change subscription payment method
21
+ * Get affiliate link by ID
28
22
  *
29
- * Starts a session for the store owner to replace the card the subscription is billed to.
23
+ * Retrieves an affiliate link by the ID for the specified store.
24
+ * @param affiliateLinkId The ID of the affiliate link.
30
25
  */
31
- changeSubscriptionPaymentMethod(opts?: RequestOptions): Promise<CheckoutSessionDto>;
26
+ getAffiliateLink(affiliateLinkId: FlakeId, opts?: RequestOptions): Promise<AffiliateLinkDto>;
32
27
  /**
33
- * Change subscription plan
28
+ * Get affiliate links
34
29
  *
35
- * Moves the store onto a different plan. When the change needs paying for, the response
36
- * carries a 'session_url' the store owner must complete.
30
+ * Retrieves all affiliate links for the specified store.
37
31
  */
38
- changeSubscriptionPlan(body: ChangeSubscriptionPlanDto, opts?: RequestOptions): Promise<CheckoutSessionDto>;
32
+ getAffiliateLinks(opts?: RequestOptions): Promise<Array<AffiliateLinkDto>>;
39
33
  /**
40
- * Continue current subscription
34
+ * Update affiliate link by ID
41
35
  *
42
- * Cancels a pending downgrade or cancellation, keeping the store on its current plan.
36
+ * Performs a delta update of an affiliate link by the ID for the specified store.
37
+ * @param affiliateLinkId The ID of the affiliate link.
43
38
  */
44
- continueCurrentSubscription(opts?: RequestOptions): Promise<void>;
39
+ updateAffiliateLink(affiliateLinkId: FlakeId, body?: UpdateAffiliateLinkDto, opts?: RequestOptions): Promise<AffiliateLinkDto>;
40
+ }
41
+ export declare class BansResource {
42
+ private readonly http;
43
+ constructor(http: HttpClient);
45
44
  /**
46
- * Get available plans
45
+ * Check for ban by identities
47
46
  *
48
- * Retrieves the plans a store can subscribe to.
47
+ * Checks whether any of the supplied identities are banned in the specified store.
49
48
  */
50
- getPublicPlans(opts?: RequestOptions): Promise<Array<PlanPreviewDto>>;
49
+ checkForBanByIdentities(body: CheckForBanIDByIdentitiesRequestDto, opts?: RequestOptions): Promise<CheckForBanIDByIdentitiesResponseDto>;
51
50
  /**
52
- * Get billing details
51
+ * Create ban
53
52
  *
54
- * Retrieves the billing address and tax details the store is invoiced under.
53
+ * Creates a new ban in the specified store.
55
54
  */
56
- getStoreBillingDetails(opts?: RequestOptions): Promise<StoreBillingDetailsDto>;
55
+ createBan(body?: UpsertBanRequestDto, opts?: RequestOptions): Promise<BanDto>;
57
56
  /**
58
- * Get billing status
57
+ * Delete ban by ID
59
58
  *
60
- * Retrieves the store's plan, limits, feature flags and subscription state.
59
+ * Deletes a ban by the ID for the specified store.
60
+ * @param banId The ID of the ban.
61
61
  */
62
- getStoreBillingStatus(opts?: RequestOptions): Promise<StoreBillingStatusDto>;
62
+ deleteBan(banId: FlakeId, opts?: RequestOptions): Promise<void>;
63
63
  /**
64
- * Get subscription invoices
64
+ * Get ban by ID
65
65
  *
66
- * Retrieves the invoices raised against the store's own subscription.
66
+ * Retrieves a ban by the ID for the specified store.
67
+ * @param banId The ID of the ban.
67
68
  */
68
- getStoreInvoices(query?: BillingGetStoreInvoicesQuery, opts?: RequestOptions): Promise<Array<StoreInvoiceDto>>;
69
+ getBan(banId: FlakeId, opts?: RequestOptions): Promise<BanDto>;
69
70
  /**
70
- * Get invoice URL
71
+ * Get bans
71
72
  *
72
- * Issues a fresh link to the hosted invoice. Prefer this over the 'invoice_url' carried by
73
- * the invoice list, which is recorded once and may have expired.
74
- * @param invoiceId The ID of the invoice to link to.
73
+ * Retrieves all bans for the specified store.
75
74
  */
76
- getStoreInvoiceUrl(invoiceId: FlakeId, opts?: RequestOptions): Promise<InvoiceUrlDto>;
75
+ getBans(query?: BansGetBansQuery, opts?: RequestOptions): Promise<Array<BanDto>>;
77
76
  /**
78
- * Update billing details
77
+ * Update ban by ID
79
78
  *
80
- * Replaces the billing address and tax details the store is invoiced under.
79
+ * Updates a ban by the ID for the specified store.
80
+ * @param banId The ID of the ban.
81
81
  */
82
- updateStoreBillingDetails(body?: StoreBillingDetailsDto, opts?: RequestOptions): Promise<void>;
82
+ updateBan(banId: FlakeId, body?: UpsertBanRequestDto, opts?: RequestOptions): Promise<BanDto>;
83
83
  }
84
84
  export declare class CheckoutResource {
85
85
  private readonly http;
@@ -129,23 +129,39 @@ export declare class CheckoutStyleResource {
129
129
  export declare class CouponsResource {
130
130
  private readonly http;
131
131
  constructor(http: HttpClient);
132
- createCouponForStore(body: CreateCouponDto, opts?: RequestOptions): Promise<CouponDto>;
133
132
  /**
134
- * Deletes a coupon
133
+ * Create coupon
134
+ *
135
+ * Creates a new coupon in the specified store.
135
136
  */
136
- deleteCouponForStore(couponId: FlakeId, opts?: RequestOptions): Promise<void>;
137
+ createCoupon(body: CreateCouponDto, opts?: RequestOptions): Promise<CouponDto>;
137
138
  /**
138
- * Retrieves a coupon by ID
139
+ * Delete coupon by ID
140
+ *
141
+ * Deletes a coupon by the ID for the specified store.
142
+ * @param couponId The ID of the coupon.
139
143
  */
140
- getCouponByIdForStore(couponId: FlakeId, opts?: RequestOptions): Promise<CouponDto>;
144
+ deleteCoupon(couponId: FlakeId, opts?: RequestOptions): Promise<void>;
141
145
  /**
142
- * Fetches all coupons for a store id
146
+ * Get coupon by ID
147
+ *
148
+ * Retrieves a coupon by the ID for the specified store.
149
+ * @param couponId The ID of the coupon.
143
150
  */
144
- getCouponsForStore(query?: CouponsGetCouponsForStoreQuery, opts?: RequestOptions): Promise<Array<CouponDto>>;
151
+ getCouponById(couponId: FlakeId, opts?: RequestOptions): Promise<CouponDto>;
145
152
  /**
146
- * Performs a Delta Update of a Coupon
153
+ * Get coupons
154
+ *
155
+ * Retrieves all coupons for the specified store.
147
156
  */
148
- updateCouponForStore(couponId: FlakeId, body?: UpdateCouponDto, opts?: RequestOptions): Promise<CouponDto>;
157
+ getCoupons(query?: CouponsGetCouponsQuery, opts?: RequestOptions): Promise<Array<CouponDto>>;
158
+ /**
159
+ * Update coupon by ID
160
+ *
161
+ * Performs a delta update of a coupon by the ID for the specified store.
162
+ * @param couponId The ID of the coupon.
163
+ */
164
+ updateCoupon(couponId: FlakeId, body?: UpdateCouponDto, opts?: RequestOptions): Promise<CouponDto>;
149
165
  }
150
166
  export declare class CustomerPortalSessionsResource {
151
167
  private readonly http;
@@ -211,6 +227,7 @@ export declare class CustomersResource {
211
227
  * Update customer
212
228
  *
213
229
  * Updates an existing customer based on the fields passed.
230
+ * @param customerId The ID of the customer.
214
231
  */
215
232
  updateCustomer(customerId: FlakeId, body?: UpsertCustomerRequestDto, opts?: RequestOptions): Promise<CustomerDto>;
216
233
  }
@@ -223,7 +240,7 @@ export declare class CustomVariablesResource {
223
240
  * Creates a new custom variable for the specified store.
224
241
  * Custom variables allow customers to provide additional input when purchasing products.
225
242
  */
226
- createCustomVariableForStore(body: UpsertCustomVariableRequestDto, opts?: RequestOptions): Promise<CustomVariableDto>;
243
+ createCustomVariable(body: UpsertCustomVariableRequestDto, opts?: RequestOptions): Promise<CustomVariableDto>;
227
244
  /**
228
245
  * Delete custom variable
229
246
  *
@@ -231,20 +248,20 @@ export declare class CustomVariablesResource {
231
248
  * This will also delete all associated options and cannot be undone.
232
249
  * @param customVariableId The ID of the custom variable to delete.
233
250
  */
234
- deleteCustomVariableForStore(customVariableId: FlakeId, opts?: RequestOptions): Promise<void>;
251
+ deleteCustomVariable(customVariableId: FlakeId, opts?: RequestOptions): Promise<void>;
235
252
  /**
236
253
  * Get custom variable
237
254
  *
238
255
  * Retrieves a specific custom variable by ID from the specified store.
239
256
  * @param customVariableId The ID of the custom variable to retrieve.
240
257
  */
241
- getCustomVariableByIdForStore(customVariableId: FlakeId, opts?: RequestOptions): Promise<CustomVariableDto>;
258
+ getCustomVariableById(customVariableId: FlakeId, opts?: RequestOptions): Promise<CustomVariableDto>;
242
259
  /**
243
260
  * Get custom variables
244
261
  *
245
262
  * Retrieves all custom variables for the specified store.
246
263
  */
247
- getCustomVariablesForStore(opts?: RequestOptions): Promise<Array<CustomVariableDto>>;
264
+ getCustomVariables(opts?: RequestOptions): Promise<Array<CustomVariableDto>>;
248
265
  /**
249
266
  * Update custom variable
250
267
  *
@@ -252,17 +269,16 @@ export declare class CustomVariablesResource {
252
269
  * Only the fields specified in the request will be updated.
253
270
  * @param customVariableId The ID of the custom variable to update.
254
271
  */
255
- updateCustomVariableForStore(customVariableId: FlakeId, body: UpsertCustomVariableRequestDto, opts?: RequestOptions): Promise<CustomVariableDto>;
256
- }
257
- export declare class DashboardResource {
258
- private readonly http;
259
- constructor(http: HttpClient);
260
- getDashboardSearchHints(opts?: RequestOptions): Promise<Array<DashboardSearchHintDto>>;
261
- searchDashboard(query?: DashboardSearchDashboardQuery, opts?: RequestOptions): Promise<SearchDashboardResponseDto>;
272
+ updateCustomVariable(customVariableId: FlakeId, body: UpsertCustomVariableRequestDto, opts?: RequestOptions): Promise<CustomVariableDto>;
262
273
  }
263
274
  export declare class DataMigrationsResource {
264
275
  private readonly http;
265
276
  constructor(http: HttpClient);
277
+ /**
278
+ * Get data migrations
279
+ *
280
+ * Retrieves all data migration tasks for the specified store.
281
+ */
266
282
  getDataMigrations(query?: DataMigrationsGetDataMigrationsQuery, opts?: RequestOptions): Promise<Array<DataMigrationTaskDto>>;
267
283
  startDataMigrationFromTebex(body: StartDataMigrationFromTebexRequestDto, opts?: RequestOptions): Promise<Array<DataMigrationTaskDto>>;
268
284
  }
@@ -273,6 +289,7 @@ export declare class DeliveryResource {
273
289
  * Assign a delivery item to a customer
274
290
  *
275
291
  * Allows you to assign a delivery item to a customer
292
+ * @param customerId The ID of the customer to assign the delivery item to.
276
293
  */
277
294
  assignDeliveryItem(customerId: FlakeId, body?: DeliveryItemAssignmentDto, opts?: RequestOptions): Promise<Array<DeliveryItemDto>>;
278
295
  /**
@@ -285,16 +302,21 @@ export declare class DeliveryResource {
285
302
  * Get command attempts associated with a customer
286
303
  *
287
304
  * Retrieves command attempts associated with a customer
305
+ * @param customerId The ID of the customer.
288
306
  */
289
307
  getCommandAttemptsForCustomer(customerId: FlakeId, query?: DeliveryGetCommandAttemptsForCustomerQuery, opts?: RequestOptions): Promise<Array<CommandAttemptDto>>;
290
308
  /**
291
309
  * Get delivery items associated with a customer
292
310
  *
293
311
  * Retrieves delivery items associated with a customer
312
+ * @param customerId The ID of the customer.
294
313
  */
295
314
  getCustomerDeliveryItems(customerId: FlakeId, query?: DeliveryGetCustomerDeliveryItemsQuery, opts?: RequestOptions): Promise<Array<DeliveryItemDto>>;
296
315
  /**
297
316
  * Returns delivery items in which an associated command attempt is for the gameserver
317
+ *
318
+ * Retrieves all delivery items that have a command attempt targeting the game server.
319
+ * @param gameServerId The ID of the game server.
298
320
  */
299
321
  getGameServerDeliveryItems(gameServerId: FlakeId, query?: DeliveryGetGameServerDeliveryItemsQuery, opts?: RequestOptions): Promise<Array<DeliveryItemDto>>;
300
322
  /**
@@ -312,6 +334,9 @@ export declare class DeliveryResource {
312
334
  getStoreDeliveryItems(query?: DeliveryGetStoreDeliveryItemsQuery, opts?: RequestOptions): Promise<Array<DeliveryItemDto>>;
313
335
  /**
314
336
  * Resend commands for a given Gameserver
337
+ *
338
+ * Re-enqueues delivery commands for a game server, narrowed by the filters in the request body.
339
+ * @param gameServerId The ID of the game server.
315
340
  */
316
341
  resendDeliveryCommandsForGameServer(gameServerId: FlakeId, body?: ResendCommandsForGameServerRequestDto, opts?: RequestOptions): Promise<ResendCommandsForGameServerResponseDto>;
317
342
  /**
@@ -328,18 +353,94 @@ export declare class DeliveryResource {
328
353
  export declare class DiscordResource {
329
354
  private readonly http;
330
355
  constructor(http: HttpClient);
356
+ /**
357
+ * Set product version Discord actions
358
+ *
359
+ * Replaces the Discord actions configured for a product version in the specified store.
360
+ * @param productVersionId The ID of the product version.
361
+ */
331
362
  createAction(productVersionId: FlakeId, body?: Array<SetDiscordActionDto>, opts?: RequestOptions): Promise<DiscordActionDto>;
363
+ /**
364
+ * Create Discord server link
365
+ *
366
+ * Creates a new link token that can be used to connect a Discord server to the specified store.
367
+ */
332
368
  createDiscordServerLink(opts?: RequestOptions): Promise<DiscordServerLinkDto>;
333
- deleteDiscordServerLinks(token: string, opts?: RequestOptions): Promise<Array<DiscordServerLinkDto>>;
369
+ /**
370
+ * Delete Discord server link
371
+ *
372
+ * Deletes a Discord server link by the token for the specified store.
373
+ * @param token The token of the Discord server link.
374
+ */
375
+ deleteDiscordServerLinks(token: string, opts?: RequestOptions): Promise<void>;
376
+ /**
377
+ * Unlink Discord user from delivery item
378
+ *
379
+ * Removes the Discord user link from a delivery item in the specified store.
380
+ * @param inventoryItemId The ID of the delivery item.
381
+ */
334
382
  deleteUserToDeliveryItemLink(inventoryItemId: FlakeId, opts?: RequestOptions): Promise<void>;
383
+ /**
384
+ * Get product version Discord actions
385
+ *
386
+ * Retrieves all Discord actions configured for a product version in the specified store.
387
+ * @param productVersionId The ID of the product version.
388
+ */
335
389
  getActions(productVersionId: FlakeId, opts?: RequestOptions): Promise<Array<DiscordActionDto>>;
390
+ /**
391
+ * Get Discord action execution history
392
+ *
393
+ * Retrieves the history of Discord actions executed for an order in the specified store.
394
+ * @param orderId The ID of the order.
395
+ */
336
396
  getDiscordActionExecutionHistory(orderId: FlakeId, opts?: RequestOptions): Promise<Array<QueuedDiscordActionDto>>;
397
+ /**
398
+ * Get Discord server links
399
+ *
400
+ * Retrieves all Discord server links for the specified store.
401
+ */
337
402
  getDiscordServerLinks(opts?: RequestOptions): Promise<Array<DiscordServerLinkDto>>;
403
+ /**
404
+ * Get Discord server roles
405
+ *
406
+ * Retrieves all roles for a Discord server linked to the specified store.
407
+ * @param discordServerId The ID of the Discord server.
408
+ */
338
409
  getDiscordServerRoles(discordServerId: number, opts?: RequestOptions): Promise<Array<DiscordServerRoleDto>>;
410
+ /**
411
+ * Get Discord server text channels
412
+ *
413
+ * Retrieves all text channels for a Discord server linked to the specified store.
414
+ * @param discordServerId The ID of the Discord server.
415
+ */
339
416
  getDiscordServerTextChannels(discordServerId: number, opts?: RequestOptions): Promise<Array<DiscordServerChannelDto>>;
417
+ /**
418
+ * Get linked Discord accounts
419
+ *
420
+ * Retrieves the Discord accounts linked to an order for the specified store.
421
+ * @param orderId The ID of the order.
422
+ */
340
423
  getLinkedDiscordAccounts(orderId: FlakeId, opts?: RequestOptions): Promise<Record<string, DiscordProfileDto>>;
424
+ /**
425
+ * Get queued Discord actions for delivery item
426
+ *
427
+ * Retrieves all queued Discord actions for a delivery item in the specified store.
428
+ * @param inventoryItemId The ID of the delivery item.
429
+ */
341
430
  getQueuedDiscordActionForDeliveryItem(inventoryItemId: FlakeId, opts?: RequestOptions): Promise<Array<QueuedDiscordActionDto>>;
431
+ /**
432
+ * Get Discord user linked to delivery item
433
+ *
434
+ * Retrieves the Discord profile linked to a delivery item in the specified store.
435
+ * @param inventoryItemId The ID of the delivery item.
436
+ */
342
437
  getUserToDeliveryItemLinks(inventoryItemId: FlakeId, opts?: RequestOptions): Promise<DiscordProfileDto>;
438
+ /**
439
+ * Link Discord user to delivery item
440
+ *
441
+ * Links a Discord user to a delivery item in the specified store.
442
+ * @param inventoryItemId The ID of the delivery item.
443
+ */
343
444
  setUserToDeliveryItemLink(inventoryItemId: FlakeId, query?: DiscordSetUserToDeliveryItemLinkQuery, opts?: RequestOptions): Promise<void>;
344
445
  }
345
446
  export declare class DownloadableFilesResource {
@@ -348,6 +449,12 @@ export declare class DownloadableFilesResource {
348
449
  createDownloadUrl(productId: FlakeId, downloadableFileId: FlakeId, opts?: RequestOptions): Promise<CreateDownloadableFileDownloadUrlResponseDto>;
349
450
  deleteDownloadableFile(productId: FlakeId, downloadableFileId: FlakeId, opts?: RequestOptions): Promise<void>;
350
451
  finishDownloadableFileUpload(productId: FlakeId, downloadableFileId: FlakeId, opts?: RequestOptions): Promise<void>;
452
+ /**
453
+ * Get downloadable files
454
+ *
455
+ * Retrieves all downloadable files for a product in the specified store.
456
+ * @param productId The ID of the product.
457
+ */
351
458
  getDownloadableFiles(productId: FlakeId, opts?: RequestOptions): Promise<Array<ProductDownloadableFileDto>>;
352
459
  startDownloadableFileUpload(productId: FlakeId, body: StartDownloadableFileUploadRequestDto, opts?: RequestOptions): Promise<void>;
353
460
  }
@@ -356,10 +463,15 @@ export declare class GameServersResource {
356
463
  constructor(http: HttpClient);
357
464
  /**
358
465
  * Create a new Game Server for a store
466
+ *
467
+ * Creates a new game server in the specified store.
359
468
  */
360
469
  createGameServer(body: CreateGameServerDto, opts?: RequestOptions): Promise<GameServerDto>;
361
470
  /**
362
471
  * Create a console for a game server.
472
+ *
473
+ * Creates a new console for a game server in the specified store.
474
+ * @param gameServerId The ID of the game server.
363
475
  */
364
476
  createGameServerConsole(gameServerId: FlakeId, body: CreateGameServerConsoleDto, opts?: RequestOptions): Promise<GameServerConsoleDto>;
365
477
  /**
@@ -368,22 +480,36 @@ export declare class GameServersResource {
368
480
  deleteGameServer(gameServerId: FlakeId, opts?: RequestOptions): Promise<void>;
369
481
  /**
370
482
  * Delete an associated game server console.
483
+ *
484
+ * Deletes the console associated with a game server in the specified store.
485
+ * @param gameServerId The ID of the game server.
371
486
  */
372
487
  deleteGameServerConsole(gameServerId: FlakeId, opts?: RequestOptions): Promise<void>;
373
488
  /**
374
489
  * Get a Game Server by ID for a store
490
+ *
491
+ * Retrieves a game server by the ID for the specified store.
492
+ * @param gameServerId The ID of the game server.
375
493
  */
376
- getGameServer(gameServerId: FlakeId, opts?: RequestOptions): Promise<Array<GameServerDto>>;
494
+ getGameServer(gameServerId: FlakeId, opts?: RequestOptions): Promise<GameServerDto>;
377
495
  /**
378
496
  * Get the associated console for a game server.
497
+ *
498
+ * Retrieves the console associated with a game server in the specified store.
499
+ * @param gameServerId The ID of the game server.
379
500
  */
380
501
  getGameServerConsole(gameServerId: FlakeId, opts?: RequestOptions): Promise<GameServerConsoleDto>;
381
502
  /**
382
503
  * Get console messages for a game server.
504
+ *
505
+ * Retrieves recent console messages for a game server in the specified store.
506
+ * @param gameServerId The ID of the game server.
383
507
  */
384
508
  getGameServerConsoleMessages(gameServerId: FlakeId, opts?: RequestOptions): Promise<Array<GameServerConsoleMessageDto>>;
385
509
  /**
386
510
  * Get Game Servers for a store
511
+ *
512
+ * Retrieves all game servers for the specified store.
387
513
  */
388
514
  getGameServers(opts?: RequestOptions): Promise<Array<GameServerDto>>;
389
515
  /**
@@ -392,10 +518,16 @@ export declare class GameServersResource {
392
518
  resetGameServerToken(gameServerId: FlakeId, opts?: RequestOptions): Promise<GameServerDto>;
393
519
  /**
394
520
  * Update a Game Server By ID for a store
521
+ *
522
+ * Performs a delta update of a game server by the ID for the specified store.
523
+ * @param gameServerId The ID of the game server.
395
524
  */
396
525
  updateGameServer(gameServerId: FlakeId, body?: UpdateGameServerDto, opts?: RequestOptions): Promise<GameServerDto>;
397
526
  /**
398
527
  * Update a console for a game server.
528
+ *
529
+ * Performs a delta update of the console for a game server in the specified store.
530
+ * @param gameServerId The ID of the game server.
399
531
  */
400
532
  updateGameServerConsole(gameServerId: FlakeId, body?: UpdateGameServerConsoleDto, opts?: RequestOptions): Promise<GameServerConsoleDto>;
401
533
  }
@@ -404,22 +536,35 @@ export declare class GiftcardsResource {
404
536
  constructor(http: HttpClient);
405
537
  /**
406
538
  * Create a Gift Card for a store
539
+ *
540
+ * Creates a new gift card in the specified store.
407
541
  */
408
542
  createGiftCard(body: CreateGiftCardDto, opts?: RequestOptions): Promise<GiftCardDto>;
409
543
  /**
410
544
  * Delete a Gift Card By ID for a store
545
+ *
546
+ * Deletes a gift card by the ID for the specified store.
547
+ * @param giftCardId The ID of the gift card.
411
548
  */
412
549
  deleteGiftCard(giftCardId: FlakeId, opts?: RequestOptions): Promise<GiftCardDto>;
413
550
  /**
414
551
  * Get a Gift Card By ID for a store
552
+ *
553
+ * Retrieves a gift card by the ID for the specified store.
554
+ * @param giftCardId The ID of the gift card.
415
555
  */
416
556
  getGiftCard(giftCardId: FlakeId, opts?: RequestOptions): Promise<GiftCardDto>;
417
557
  /**
418
558
  * Get Gift Cards for a store
559
+ *
560
+ * Retrieves all gift cards for the specified store.
419
561
  */
420
562
  getGiftCards(query?: GiftcardsGetGiftCardsQuery, opts?: RequestOptions): Promise<Array<GiftCardDto>>;
421
563
  /**
422
564
  * Update a Gift Card By ID for a store
565
+ *
566
+ * Performs a delta update of a gift card by the ID for the specified store.
567
+ * @param giftCardId The ID of the gift card.
423
568
  */
424
569
  updateGiftCard(giftCardId: FlakeId, body?: UpdateGiftCardDto, opts?: RequestOptions): Promise<GiftCardDto>;
425
570
  }
@@ -449,6 +594,7 @@ export declare class GlobalCommandsResource {
449
594
  * Update global command
450
595
  *
451
596
  * Updates a global command for a store.
597
+ * @param globalCommandId The ID of the global command.
452
598
  */
453
599
  updateGlobalCommand(globalCommandId: FlakeId, body: UpsertGlobalCommandDto, opts?: RequestOptions): Promise<GlobalCommandDto>;
454
600
  }
@@ -500,36 +646,117 @@ export declare class InvoicesResource {
500
646
  export declare class MarketingResource {
501
647
  private readonly http;
502
648
  constructor(http: HttpClient);
649
+ /**
650
+ * Activate email template by ID
651
+ *
652
+ * Activates an email template by the ID for the specified store, so it is sent in place of the
653
+ * default template for its type.
654
+ * @param templateId The ID of the email template.
655
+ */
503
656
  activateEmailTemplate(templateId: FlakeId, opts?: RequestOptions): Promise<void>;
657
+ /**
658
+ * Create email template
659
+ *
660
+ * Creates a new email template in the specified store.
661
+ */
504
662
  createEmailTemplate(body: CreateEmailTemplateDto, opts?: RequestOptions): Promise<EmailTemplateDto>;
663
+ /**
664
+ * Deactivate email template by ID
665
+ *
666
+ * Deactivates an email template by the ID for the specified store, so the default template for
667
+ * its type is sent instead.
668
+ * @param templateId The ID of the email template.
669
+ */
505
670
  deactivateEmailTemplate(templateId: FlakeId, opts?: RequestOptions): Promise<void>;
671
+ /**
672
+ * Deactivate email template by type
673
+ *
674
+ * Deactivates the active email template of the supplied type for the specified store.
675
+ */
506
676
  deactivateEmailTemplateByType(body: DeactivateEmailTemplateRequestDto, opts?: RequestOptions): Promise<void>;
677
+ /**
678
+ * Delete email template by ID
679
+ *
680
+ * Deletes an email template by the ID for the specified store.
681
+ * @param templateId The ID of the email template.
682
+ */
507
683
  deleteEmailTemplate(templateId: FlakeId, opts?: RequestOptions): Promise<void>;
508
684
  finishEmailBrandingImageUpload(body: FinishEmailBrandingImageUploadRequestDto, opts?: RequestOptions): Promise<void>;
685
+ /**
686
+ * Get email branding
687
+ *
688
+ * Retrieves the email branding for the specified store.
689
+ */
509
690
  getEmailBranding(opts?: RequestOptions): Promise<EmailBrandingDto>;
510
691
  getEmailBrandingImageUploadUrl(query?: MarketingGetEmailBrandingImageUploadUrlQuery, opts?: RequestOptions): Promise<GetEmailBrandingImageUploadUrlResponseDto>;
692
+ /**
693
+ * Get email deliveries
694
+ *
695
+ * Retrieves all email deliveries for the specified store.
696
+ */
511
697
  getEmailDeliveries(query?: MarketingGetEmailDeliveriesQuery, opts?: RequestOptions): Promise<Array<EmailDeliveryDto>>;
698
+ /**
699
+ * Get email delivery by ID
700
+ *
701
+ * Retrieves an email delivery by the ID for the specified store.
702
+ * @param emailDeliveryId The ID of the email delivery.
703
+ */
512
704
  getEmailDelivery(emailDeliveryId: FlakeId, opts?: RequestOptions): Promise<EmailDeliveryDto>;
705
+ /**
706
+ * Get email template by ID
707
+ *
708
+ * Retrieves an email template by the ID for the specified store.
709
+ * @param templateId The ID of the email template.
710
+ */
513
711
  getEmailTemplate(templateId: FlakeId, opts?: RequestOptions): Promise<EmailTemplateDto>;
712
+ /**
713
+ * Get email template definitions
714
+ *
715
+ * Retrieves the email template definitions available to the specified store.
716
+ */
514
717
  getEmailTemplateDefinitions(opts?: RequestOptions): Promise<Array<EmailTemplateDefinitionDto> | undefined>;
718
+ /**
719
+ * Get email templates
720
+ *
721
+ * Retrieves all email templates for the specified store.
722
+ */
515
723
  getEmailTemplates(query?: MarketingGetEmailTemplatesQuery, opts?: RequestOptions): Promise<Array<EmailTemplateDto>>;
516
724
  /**
517
725
  * Gets the abandoned checkout behaviour for a store
726
+ *
727
+ * Retrieves the abandoned checkout configuration for the specified store.
518
728
  */
519
729
  getStoreAbandonedCheckoutConfigurationOptions(opts?: RequestOptions): Promise<AbandonedCheckoutStoreConfigurationDto>;
520
730
  /**
521
731
  * Gets the purchase follow up behaviour for a store
732
+ *
733
+ * Retrieves the purchase follow up configuration for the specified store.
522
734
  */
523
735
  getStorePurchaseFollowUpConfigurationOptions(opts?: RequestOptions): Promise<PurchaseFollowUpStoreConfigurationDto>;
524
736
  /**
525
737
  * Sets the abandoned checkout behaviour for a store
738
+ *
739
+ * Updates the abandoned checkout configuration for the specified store.
526
740
  */
527
741
  setStoreAbandonedCheckoutConfigurationOptions(body: AbandonedCheckoutStoreConfigurationUpdateDto, opts?: RequestOptions): Promise<AbandonedCheckoutStoreConfigurationDto | undefined>;
528
742
  /**
529
743
  * Sets the purchase follow up behaviour for a store
744
+ *
745
+ * Updates the purchase follow up configuration for the specified store.
530
746
  */
531
747
  setStorePurchaseFollowUpConfigurationOptions(body: PurchaseFollowUpStoreConfigurationUpdateDto, opts?: RequestOptions): Promise<PurchaseFollowUpStoreConfigurationDto | undefined>;
748
+ /**
749
+ * Update email branding
750
+ *
751
+ * Performs a delta update of the email branding for the specified store.
752
+ */
532
753
  updateEmailBranding(body?: UpdateEmailBrandingDto, opts?: RequestOptions): Promise<EmailBrandingDto>;
754
+ /**
755
+ * Update email template by ID
756
+ *
757
+ * Performs a delta update of an email template by the ID for the specified store.
758
+ * @param templateId The ID of the email template.
759
+ */
533
760
  updateEmailTemplate(templateId: FlakeId, body?: UpdateEmailTemplateDto, opts?: RequestOptions): Promise<EmailTemplateDto>;
534
761
  }
535
762
  export declare class NavlinksResource {
@@ -537,26 +764,41 @@ export declare class NavlinksResource {
537
764
  constructor(http: HttpClient);
538
765
  /**
539
766
  * Create a new NavLink for a store
767
+ *
768
+ * Creates a new navigation link in the specified store.
540
769
  */
541
770
  createNavLink(body: CreateNavLinkDto, opts?: RequestOptions): Promise<NavLinkDto>;
542
771
  /**
543
772
  * Delete a NavLink for a store
773
+ *
774
+ * Deletes a navigation link by the ID for the specified store.
775
+ * @param navLinkId The ID of the navigation link.
544
776
  */
545
777
  deleteNavLink(navLinkId: FlakeId, opts?: RequestOptions): Promise<void>;
546
778
  /**
547
779
  * Get a NavLink by ID for a store
780
+ *
781
+ * Retrieves a navigation link by the ID for the specified store.
782
+ * @param navLinkId The ID of the navigation link.
548
783
  */
549
784
  getNavLink(navLinkId: FlakeId, opts?: RequestOptions): Promise<NavLinkDto>;
550
785
  /**
551
786
  * Get all NavLinks for a store
787
+ *
788
+ * Retrieves all navigation links for the specified store.
552
789
  */
553
790
  getNavLinks(opts?: RequestOptions): Promise<Array<NavLinkDto>>;
554
791
  /**
555
792
  * Update a NavLink By ID for a store
793
+ *
794
+ * Performs a delta update of a navigation link by the ID for the specified store.
795
+ * @param navLinkId The ID of the navigation link.
556
796
  */
557
797
  updateNavLink(navLinkId: FlakeId, body?: UpdateNavLinkDto, opts?: RequestOptions): Promise<NavLinkDto>;
558
798
  /**
559
799
  * Update the sort orders of NavLinks for a Store
800
+ *
801
+ * Updates the sort order of navigation links in the specified store.
560
802
  */
561
803
  updateNavLinkOrder(body?: Array<UpdateNavLinkOrderChangeDto>, opts?: RequestOptions): Promise<void>;
562
804
  }
@@ -613,6 +855,7 @@ export declare class PaymentsResource {
613
855
  * Get payment by ID
614
856
  *
615
857
  * Retrieves a payment by an ID.
858
+ * @param paymentId The ID of the payment.
616
859
  */
617
860
  getPaymentById(paymentId: FlakeId, opts?: RequestOptions): Promise<PaymentDto>;
618
861
  /**
@@ -708,15 +951,44 @@ export declare class ProductsResource {
708
951
  *
709
952
  * Updates the sort order of products in the specified store.
710
953
  */
711
- updateProductSortOrder(body: UpdateProductSortOrderRequestDto, opts?: RequestOptions): Promise<ProductDto | undefined>;
954
+ updateProductSortOrder(body: UpdateProductSortOrderRequestDto, opts?: RequestOptions): Promise<void>;
712
955
  }
713
956
  export declare class RegionalPricingResource {
714
957
  private readonly http;
715
958
  constructor(http: HttpClient);
959
+ /**
960
+ * Get product pricing regions
961
+ *
962
+ * Retrieves the regional pricing for a product in the specified store.
963
+ * @param productId The ID of the product.
964
+ */
716
965
  getProductPricingRegions(productId: FlakeId, opts?: RequestOptions): Promise<Array<ProductPricingRegionDto>>;
966
+ /**
967
+ * Get pricing region groups
968
+ *
969
+ * Retrieves the pricing region groups available to the specified store.
970
+ */
717
971
  getStorePricingRegionGroups(opts?: RequestOptions): Promise<Array<ProductPricingRegionGroupDto>>;
972
+ /**
973
+ * Get store pricing regions
974
+ *
975
+ * Retrieves the regional pricing configuration for the specified store.
976
+ */
718
977
  getStorePricingRegions(opts?: RequestOptions): Promise<Array<ProductPricingRegionDto>>;
978
+ /**
979
+ * Update product pricing region
980
+ *
981
+ * Performs a delta update of the regional pricing override for a product in the specified store.
982
+ * @param productId The ID of the product.
983
+ * @param regionId The ID of the pricing region.
984
+ */
719
985
  setProductPricingRegionOverride(productId: FlakeId, regionId: string, body?: ProductPricingRegionOverrideDto, opts?: RequestOptions): Promise<void>;
986
+ /**
987
+ * Update store pricing region
988
+ *
989
+ * Performs a delta update of the regional pricing override for the specified store.
990
+ * @param regionId The ID of the pricing region.
991
+ */
720
992
  setStorePricingRegionOverride(regionId: string, body?: StorePricingRegionOverrideDto, opts?: RequestOptions): Promise<void>;
721
993
  }
722
994
  export declare class RolesResource {
@@ -734,22 +1006,35 @@ export declare class SalesResource {
734
1006
  constructor(http: HttpClient);
735
1007
  /**
736
1008
  * Create a sale by ID for a store
1009
+ *
1010
+ * Creates a new sale in the specified store.
737
1011
  */
738
1012
  createSale(body: CreateSaleDto, opts?: RequestOptions): Promise<SaleDto>;
739
1013
  /**
740
1014
  * Delete a sale by ID for a store
1015
+ *
1016
+ * Deletes a sale by the ID for the specified store.
1017
+ * @param saleId The ID of the sale.
741
1018
  */
742
1019
  deleteSaleById(saleId: FlakeId, opts?: RequestOptions): Promise<void>;
743
1020
  /**
744
1021
  * Get a sale by ID for a store
1022
+ *
1023
+ * Retrieves a sale by the ID for the specified store.
1024
+ * @param saleId The ID of the sale.
745
1025
  */
746
1026
  getSale(saleId: FlakeId, opts?: RequestOptions): Promise<SaleDto>;
747
1027
  /**
748
1028
  * Get sales associated with a store.
1029
+ *
1030
+ * Retrieves all sales for the specified store.
749
1031
  */
750
1032
  getSales(opts?: RequestOptions): Promise<Array<SaleDto>>;
751
1033
  /**
752
1034
  * Update a sale by ID for a store
1035
+ *
1036
+ * Performs a delta update of a sale by the ID for the specified store.
1037
+ * @param saleId The ID of the sale.
753
1038
  */
754
1039
  updateSale(saleId: FlakeId, body?: UpdateSaleDto, opts?: RequestOptions): Promise<SaleDto>;
755
1040
  }
@@ -899,16 +1184,22 @@ export declare class TagsResource {
899
1184
  constructor(http: HttpClient);
900
1185
  /**
901
1186
  * Create a new tag
1187
+ *
1188
+ * Creates a new tag in the specified store.
902
1189
  */
903
1190
  createTag(body?: UpsertTagRequestDto, opts?: RequestOptions): Promise<TagDto>;
904
1191
  /**
905
1192
  * Delete a tag by ID
1193
+ *
1194
+ * Deletes a tag by the ID for the specified store.
1195
+ * @param tagId The ID of the tag.
906
1196
  */
907
1197
  deleteTag(tagId: FlakeId, opts?: RequestOptions): Promise<void>;
908
1198
  /**
909
1199
  * Delete tag image
910
1200
  *
911
1201
  * Deletes an image for a tag
1202
+ * @param tagId The ID of the tag.
912
1203
  */
913
1204
  deleteTagImage(tagId: FlakeId, opts?: RequestOptions): Promise<void>;
914
1205
  /**
@@ -919,6 +1210,9 @@ export declare class TagsResource {
919
1210
  finishTagImageUpload(tagId: FlakeId, body: FinishTagImageUploadUrlRequestDto, opts?: RequestOptions): Promise<void>;
920
1211
  /**
921
1212
  * Get a tag by an ID
1213
+ *
1214
+ * Retrieves a tag by the ID for the specified store.
1215
+ * @param tagId The ID of the tag.
922
1216
  */
923
1217
  getTag(tagId: FlakeId, opts?: RequestOptions): Promise<TagDto>;
924
1218
  /**
@@ -929,10 +1223,15 @@ export declare class TagsResource {
929
1223
  getTagImageUploadUrl(tagId: FlakeId, opts?: RequestOptions): Promise<GetTagImageUploadUrlResponseDto>;
930
1224
  /**
931
1225
  * Get all tags for a store
1226
+ *
1227
+ * Retrieves all tags for the specified store.
932
1228
  */
933
1229
  getTags(opts?: RequestOptions): Promise<Array<TagDto>>;
934
1230
  /**
935
1231
  * Update a tag by ID
1232
+ *
1233
+ * Performs a delta update of a tag by the ID for the specified store.
1234
+ * @param tagId The ID of the tag.
936
1235
  */
937
1236
  updateTag(tagId: FlakeId, body?: UpsertTagRequestDto, opts?: RequestOptions): Promise<TagDto>;
938
1237
  }
@@ -941,22 +1240,35 @@ export declare class TierGroupsResource {
941
1240
  constructor(http: HttpClient);
942
1241
  /**
943
1242
  * Create a new tier group
1243
+ *
1244
+ * Creates a new tier group in the specified store.
944
1245
  */
945
1246
  createTierGroup(body: CreateTierGroupRequestDto, opts?: RequestOptions): Promise<TierGroupDto>;
946
1247
  /**
947
1248
  * Delete a tier group by ID
1249
+ *
1250
+ * Deletes a tier group by the ID for the specified store.
1251
+ * @param tierGroupId The ID of the tier group.
948
1252
  */
949
1253
  deleteTierGroup(tierGroupId: FlakeId, opts?: RequestOptions): Promise<void>;
950
1254
  /**
951
1255
  * Get a tier group by ID
1256
+ *
1257
+ * Retrieves a tier group by the ID for the specified store.
1258
+ * @param tierGroupId The ID of the tier group.
952
1259
  */
953
1260
  getTierGroup(tierGroupId: FlakeId, opts?: RequestOptions): Promise<TierGroupDto>;
954
1261
  /**
955
1262
  * List all tier groups for a store
1263
+ *
1264
+ * Retrieves all tier groups for the specified store.
956
1265
  */
957
1266
  listTierGroups(opts?: RequestOptions): Promise<Array<TierGroupDto>>;
958
1267
  /**
959
1268
  * Update a tier group by ID
1269
+ *
1270
+ * Performs a delta update of a tier group by the ID for the specified store.
1271
+ * @param tierGroupId The ID of the tier group.
960
1272
  */
961
1273
  updateTierGroup(tierGroupId: FlakeId, body: UpdateTierGroupRequestDto, opts?: RequestOptions): Promise<TierGroupDto>;
962
1274
  }
@@ -986,10 +1298,15 @@ export declare class TrialsResource {
986
1298
  getEligibilityOverridesForCustomer(customerId: FlakeId, query?: TrialsGetEligibilityOverridesForCustomerQuery, opts?: RequestOptions): Promise<Array<TrialEligibilityOverrideDto>>;
987
1299
  /**
988
1300
  * Get a trial by ID for a store
1301
+ *
1302
+ * Retrieves a trial by the ID for the specified store.
1303
+ * @param trialId The ID of the trial.
989
1304
  */
990
1305
  getTrial(trialId: FlakeId, opts?: RequestOptions): Promise<TrialDto>;
991
1306
  /**
992
1307
  * Get trials for a store
1308
+ *
1309
+ * Retrieves all trials for the specified store.
993
1310
  */
994
1311
  getTrials(query?: TrialsGetTrialsQuery, opts?: RequestOptions): Promise<Array<TrialDto>>;
995
1312
  }
@@ -1012,20 +1329,83 @@ export declare class UpsellSettingsResource {
1012
1329
  export declare class WebhooksResource {
1013
1330
  private readonly http;
1014
1331
  constructor(http: HttpClient);
1332
+ /**
1333
+ * Create webhook
1334
+ *
1335
+ * Creates a new webhook subscription in the specified store.
1336
+ */
1015
1337
  createSubscription(body: CreateWebhookDto, opts?: RequestOptions): Promise<WebhookSubscriptionDto>;
1338
+ /**
1339
+ * Delete webhook by ID
1340
+ *
1341
+ * Deletes a webhook subscription by the ID for the specified store.
1342
+ * @param webhookId The ID of the webhook.
1343
+ */
1016
1344
  deleteSubscription(webhookId: FlakeId, opts?: RequestOptions): Promise<void>;
1345
+ /**
1346
+ * Get webhook history
1347
+ *
1348
+ * Retrieves the delivery history of a webhook subscription by the ID for the specified store.
1349
+ * @param webhookId The ID of the webhook.
1350
+ */
1017
1351
  getHistory(webhookId: FlakeId, query?: WebhooksGetHistoryQuery, opts?: RequestOptions): Promise<WebhookHistoryDto>;
1352
+ /**
1353
+ * Get webhooks
1354
+ *
1355
+ * Retrieves all webhook subscriptions for the specified store.
1356
+ */
1018
1357
  getSubscriptions(opts?: RequestOptions): Promise<Array<WebhookSubscriptionDto>>;
1358
+ /**
1359
+ * Get webhook variables
1360
+ *
1361
+ * Retrieves the variables available to webhook payload templates for the specified store.
1362
+ */
1019
1363
  getVariables(opts?: RequestOptions): Promise<Array<WebhookVariablesDto>>;
1364
+ /**
1365
+ * Resend webhook events
1366
+ *
1367
+ * Resends the supplied webhook events for the specified store.
1368
+ */
1020
1369
  resend(body: ResendWebhookDto, opts?: RequestOptions): Promise<void>;
1370
+ /**
1371
+ * Update webhook by ID
1372
+ *
1373
+ * Performs a delta update of a webhook subscription by the ID for the specified store.
1374
+ * @param webhookId The ID of the webhook.
1375
+ */
1021
1376
  updateSubscription(webhookId: FlakeId, body: UpdateWebhookDto, opts?: RequestOptions): Promise<WebhookSubscriptionDto>;
1022
1377
  }
1023
1378
  export declare class WebstoreResource {
1024
1379
  private readonly http;
1025
1380
  constructor(http: HttpClient);
1381
+ /**
1382
+ * Create webstore module
1383
+ *
1384
+ * Adds a module to the store's webstore. The module's 'type' decides which 'settings' it accepts.
1385
+ */
1026
1386
  createWebstoreModule(body: CreateWebstoreModuleDto, opts?: RequestOptions): Promise<WebstoreModuleDto>;
1387
+ /**
1388
+ * Create template
1389
+ *
1390
+ * Creates an empty template on the store's webstore. Add files to it, then set it as the
1391
+ * webstore's default template to serve it to customers.
1392
+ */
1027
1393
  createWebstoreTemplate(body: CreateWebstoreTemplateDto, opts?: RequestOptions): Promise<WebstoreTemplateDto>;
1394
+ /**
1395
+ * Create template file
1396
+ *
1397
+ * Adds a file to a template. Its 'file_name' and 'content_type' decide where the file is served
1398
+ * from and whether it is public.
1399
+ * @param templateId The ID of the template to add the file to.
1400
+ */
1028
1401
  createWebstoreTemplateFile(templateId: FlakeId, body: CreateWebstoreTemplateFileDto, opts?: RequestOptions): Promise<WebstoreTemplateFileDto>;
1402
+ /**
1403
+ * Create template variable
1404
+ *
1405
+ * Adds a variable to a template. Its 'variable' is the name the template's files reference it
1406
+ * by, and 'type' decides how 'value' is parsed when the template renders.
1407
+ * @param templateId The ID of the template to add the variable to.
1408
+ */
1029
1409
  createWebstoreTemplateVariable(templateId: FlakeId, body: CreateWebstoreTemplateVariableDto, opts?: RequestOptions): Promise<WebstoreTemplateVariableDto>;
1030
1410
  /**
1031
1411
  * Delete custom domain
@@ -1034,12 +1414,59 @@ export declare class WebstoreResource {
1034
1414
  * slug.
1035
1415
  */
1036
1416
  deleteWebstoreCustomDomain(opts?: RequestOptions): Promise<void>;
1417
+ /**
1418
+ * Delete webstore module
1419
+ *
1420
+ * Permanently removes a module from the store's webstore.
1421
+ * @param moduleId The ID of the module.
1422
+ */
1037
1423
  deleteWebstoreModule(moduleId: FlakeId, opts?: RequestOptions): Promise<void>;
1424
+ /**
1425
+ * Delete template
1426
+ *
1427
+ * Permanently deletes a template and all of its files. Switch the webstore to another template
1428
+ * first if this one is its current template.
1429
+ * @param templateId The ID of the template.
1430
+ */
1038
1431
  deleteWebstoreTemplate(templateId: FlakeId, opts?: RequestOptions): Promise<void>;
1432
+ /**
1433
+ * Delete template file
1434
+ *
1435
+ * Permanently deletes a template file. Files whose 'is_deletable' is false cannot be removed.
1436
+ * @param templateId The ID of the template.
1437
+ * @param templateFileId The ID of the template file.
1438
+ */
1039
1439
  deleteWebstoreTemplateFile(templateId: FlakeId, templateFileId: FlakeId, opts?: RequestOptions): Promise<void>;
1440
+ /**
1441
+ * Delete template variable
1442
+ *
1443
+ * Permanently deletes a template variable.
1444
+ * @param templateId The ID of the template.
1445
+ * @param templateVariableId The ID of the template variable.
1446
+ */
1040
1447
  deleteWebstoreTemplateVariable(templateId: FlakeId, templateVariableId: FlakeId, opts?: RequestOptions): Promise<void>;
1448
+ /**
1449
+ * Update template to latest version
1450
+ *
1451
+ * Downloads the newest published version of a marketplace template over the installed copy,
1452
+ * replacing its files.
1453
+ * @param templateId The ID of the template to update.
1454
+ */
1041
1455
  downloadWebstoreTemplateUpdate(templateId: FlakeId, opts?: RequestOptions): Promise<void>;
1456
+ /**
1457
+ * Duplicate template
1458
+ *
1459
+ * Copies a template and its files into a new template on the same webstore and returns it.
1460
+ * @param templateId The ID of the template to copy.
1461
+ */
1042
1462
  duplicateWebstoreTemplate(templateId: FlakeId, opts?: RequestOptions): Promise<WebstoreTemplateDto>;
1463
+ /**
1464
+ * Finish template upload
1465
+ *
1466
+ * Imports the files from an archive uploaded to the URL returned by the upload URL endpoint
1467
+ * into the template, and reports any files that could not be imported.
1468
+ * @param templateId The ID of the template the files are imported into.
1469
+ */
1043
1470
  finishWebstoreTemplateUpload(templateId: FlakeId, opts?: RequestOptions): Promise<FinishWebstoreTemplateUploadResponseDto>;
1044
1471
  /**
1045
1472
  * Get webstore
@@ -1055,17 +1482,98 @@ export declare class WebstoreResource {
1055
1482
  * outstanding for ownership and SSL verification.
1056
1483
  */
1057
1484
  getWebstoreCustomDomain(opts?: RequestOptions): Promise<WebstoreCustomDomainDto>;
1485
+ /**
1486
+ * Get webstore modules
1487
+ *
1488
+ * Retrieves all modules on the store's webstore, in sort order.
1489
+ */
1058
1490
  getWebstoreModules(opts?: RequestOptions): Promise<Array<WebstoreModuleDto>>;
1491
+ /**
1492
+ * Get template
1493
+ *
1494
+ * Retrieves a template. Pass 'include' as 'files' to embed its files, content included, in
1495
+ * 'template_files'.
1496
+ * @param templateId The ID of the template.
1497
+ */
1059
1498
  getWebstoreTemplate(templateId: FlakeId, query?: WebstoreGetWebstoreTemplateQuery, opts?: RequestOptions): Promise<WebstoreTemplateDto>;
1499
+ /**
1500
+ * Get template archive
1501
+ *
1502
+ * Creates a temporary URL to download the template's files as an archive.
1503
+ * @param templateId The ID of the template.
1504
+ */
1060
1505
  getWebstoreTemplateArchive(templateId: FlakeId, opts?: RequestOptions): Promise<GetWebstoreTemplateArchiveResponseDto>;
1506
+ /**
1507
+ * Get template file
1508
+ *
1509
+ * Retrieves a single template file, content included.
1510
+ * @param templateId The ID of the template.
1511
+ * @param templateFileId The ID of the template file.
1512
+ */
1061
1513
  getWebstoreTemplateFile(templateId: FlakeId, templateFileId: FlakeId, opts?: RequestOptions): Promise<WebstoreTemplateFileDto>;
1514
+ /**
1515
+ * Get template files
1516
+ *
1517
+ * Retrieves the files of a template without their content. Fetch a single file to read its
1518
+ * content.
1519
+ * @param templateId The ID of the template.
1520
+ */
1062
1521
  getWebstoreTemplateFiles(templateId: FlakeId, opts?: RequestOptions): Promise<Array<WebstoreTemplateFileDto>>;
1522
+ /**
1523
+ * Get latest template version
1524
+ *
1525
+ * Retrieves the newest published version available for a template installed from the
1526
+ * marketplace. 'version' is null when there is no update or the template is not
1527
+ * marketplace-based.
1528
+ * @param templateId The ID of the template.
1529
+ */
1063
1530
  getWebstoreTemplateLatestVersion(templateId: FlakeId, opts?: RequestOptions): Promise<WebstoreTemplateLatestVersionDto>;
1531
+ /**
1532
+ * Create template preview URL
1533
+ *
1534
+ * Creates a short-lived link that renders the template without caching. The link expires
1535
+ * after 15 minutes.
1536
+ * @param templateId The ID of the template to preview.
1537
+ */
1538
+ getWebstoreTemplatePreviewUrl(templateId: FlakeId, opts?: RequestOptions): Promise<GetWebstoreTemplatePreviewUrlResponseDto>;
1539
+ /**
1540
+ * Get templates
1541
+ *
1542
+ * Retrieves the templates of the store's webstore, without their files. The one customers see
1543
+ * is the webstore's 'current_template_id'.
1544
+ */
1064
1545
  getWebstoreTemplates(opts?: RequestOptions): Promise<Array<WebstoreTemplateDto>>;
1546
+ /**
1547
+ * Get template schema
1548
+ *
1549
+ * Retrieves the schema a template declares: its author, support contacts, update source and
1550
+ * the settings a store can configure.
1551
+ * @param templateId The ID of the template.
1552
+ */
1065
1553
  getWebstoreTemplateSchema(templateId: FlakeId, opts?: RequestOptions): Promise<WebstoreTemplateSchemaDto>;
1554
+ /**
1555
+ * Get template upload URL
1556
+ *
1557
+ * Creates a pre-signed URL for uploading an archive of template files. Upload the archive to
1558
+ * it, then finish the upload to import the files into the template.
1559
+ * @param templateId The ID of the template the files are imported into.
1560
+ */
1066
1561
  getWebstoreTemplateUploadUrl(templateId: FlakeId, query?: WebstoreGetWebstoreTemplateUploadUrlQuery, opts?: RequestOptions): Promise<GetWebstoreTemplateUploadUrlResponseDto>;
1562
+ /**
1563
+ * Get template variables
1564
+ *
1565
+ * Retrieves the variables of a template with their current values.
1566
+ * @param templateId The ID of the template.
1567
+ */
1067
1568
  getWebstoreTemplateVariables(templateId: FlakeId, opts?: RequestOptions): Promise<Array<WebstoreTemplateVariableDto>>;
1068
- previewWebstoreTemplate(templateId: FlakeId, opts?: RequestOptions): Promise<WebstoreTemplatePreviewResponseDto>;
1569
+ /**
1570
+ * Install marketplace template
1571
+ *
1572
+ * Installs a template from the marketplace into the store's webstore and returns the ID of the
1573
+ * installed copy.
1574
+ * @param marketplaceTemplateId The ID of the marketplace template to install.
1575
+ */
1576
+ installMarketplaceTemplate(marketplaceTemplateId: FlakeId, opts?: RequestOptions): Promise<InstallMarketplaceTemplateResponseDto>;
1069
1577
  /**
1070
1578
  * Set custom domain
1071
1579
  *
@@ -1085,10 +1593,43 @@ export declare class WebstoreResource {
1085
1593
  * slug already taken by another store is rejected.
1086
1594
  */
1087
1595
  setWebstoreSlug(body: SetWebstoreSlugRequestDto, opts?: RequestOptions): Promise<void>;
1596
+ /**
1597
+ * Update webstore module
1598
+ *
1599
+ * Performs a delta update of a module on the store's webstore.
1600
+ * @param moduleId The ID of the module.
1601
+ */
1088
1602
  updateWebstoreModule(moduleId: FlakeId, body: CreateWebstoreModuleDto, opts?: RequestOptions): Promise<WebstoreModuleDto>;
1603
+ /**
1604
+ * Update template
1605
+ *
1606
+ * Performs a delta update of a template's name and compatibility mode.
1607
+ * @param templateId The ID of the template.
1608
+ */
1089
1609
  updateWebstoreTemplate(templateId: FlakeId, body: CreateWebstoreTemplateDto, opts?: RequestOptions): Promise<WebstoreTemplateDto>;
1610
+ /**
1611
+ * Update template file content
1612
+ *
1613
+ * Replaces the content of a template file. If the template is the webstore's current template,
1614
+ * customers see the change immediately.
1615
+ * @param templateId The ID of the template.
1616
+ * @param templateFileId The ID of the template file.
1617
+ */
1090
1618
  updateWebstoreTemplateFile(templateId: FlakeId, templateFileId: FlakeId, body: UpdateWebstoreTemplateFileRequestDto, opts?: RequestOptions): Promise<void>;
1619
+ /**
1620
+ * Update template schema variables
1621
+ *
1622
+ * Sets values for the settings the template's schema defines.
1623
+ * @param templateId The ID of the template.
1624
+ */
1091
1625
  updateWebstoreTemplateSchemaVariables(templateId: FlakeId, body?: Record<string, unknown>, opts?: RequestOptions): Promise<void>;
1626
+ /**
1627
+ * Update template variable
1628
+ *
1629
+ * Performs a delta update of a template variable.
1630
+ * @param templateId The ID of the template.
1631
+ * @param templateVariableId The ID of the template variable.
1632
+ */
1092
1633
  updateWebstoreTemplateVariable(templateId: FlakeId, templateVariableId: FlakeId, body: CreateWebstoreTemplateVariableDto, opts?: RequestOptions): Promise<WebstoreTemplateVariableDto>;
1093
1634
  /**
1094
1635
  * Verify custom domain
@@ -1104,14 +1645,12 @@ export declare class ManagementClient {
1104
1645
  readonly $http: HttpClient;
1105
1646
  readonly affiliateLinks: AffiliateLinksResource;
1106
1647
  readonly bans: BansResource;
1107
- readonly billing: BillingResource;
1108
1648
  readonly checkout: CheckoutResource;
1109
1649
  readonly checkoutStyle: CheckoutStyleResource;
1110
1650
  readonly coupons: CouponsResource;
1111
- readonly customer_portal_sessions: CustomerPortalSessionsResource;
1651
+ readonly customerPortalSessions: CustomerPortalSessionsResource;
1112
1652
  readonly customers: CustomersResource;
1113
1653
  readonly customVariables: CustomVariablesResource;
1114
- readonly dashboard: DashboardResource;
1115
1654
  readonly dataMigrations: DataMigrationsResource;
1116
1655
  readonly delivery: DeliveryResource;
1117
1656
  readonly discord: DiscordResource;