@paynow-gg/typescript-sdk 1.0.61 → 2.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +1 -1
- package/README.md +44 -5
- package/dist/cjs/generated/management/client.d.ts +902 -0
- package/dist/cjs/generated/management/client.d.ts.map +1 -0
- package/dist/cjs/generated/management/client.js +1583 -0
- package/dist/cjs/generated/management/client.js.map +1 -0
- package/dist/cjs/generated/management/types.d.ts +7771 -0
- package/dist/cjs/generated/management/types.d.ts.map +1 -0
- package/dist/cjs/generated/management/types.js +4 -0
- package/dist/cjs/generated/management/types.js.map +1 -0
- package/dist/cjs/generated/storefront/client.d.ts +229 -0
- package/dist/cjs/generated/storefront/client.d.ts.map +1 -0
- package/dist/cjs/generated/storefront/client.js +357 -0
- package/dist/cjs/generated/storefront/client.js.map +1 -0
- package/dist/cjs/generated/storefront/types.d.ts +3076 -0
- package/dist/cjs/generated/storefront/types.d.ts.map +1 -0
- package/dist/cjs/generated/storefront/types.js +4 -0
- package/dist/cjs/generated/storefront/types.js.map +1 -0
- package/dist/cjs/generated/webhooks/types.d.ts +3113 -0
- package/dist/cjs/generated/webhooks/types.d.ts.map +1 -0
- package/dist/cjs/generated/webhooks/types.js +4 -0
- package/dist/cjs/generated/webhooks/types.js.map +1 -0
- package/dist/cjs/index.d.ts +9 -0
- package/dist/cjs/index.d.ts.map +1 -0
- package/dist/cjs/index.js +16 -0
- package/dist/cjs/index.js.map +1 -0
- package/dist/cjs/management.d.ts +3 -0
- package/dist/cjs/management.d.ts.map +1 -0
- package/dist/cjs/management.js +22 -0
- package/dist/cjs/management.js.map +1 -0
- package/dist/cjs/package.json +3 -0
- package/dist/cjs/runtime/errors.d.ts +18 -0
- package/dist/cjs/runtime/errors.d.ts.map +1 -0
- package/dist/cjs/runtime/errors.js +41 -0
- package/dist/cjs/runtime/errors.js.map +1 -0
- package/dist/cjs/runtime/http.d.ts +20 -0
- package/dist/cjs/runtime/http.d.ts.map +1 -0
- package/dist/cjs/runtime/http.js +121 -0
- package/dist/cjs/runtime/http.js.map +1 -0
- package/dist/cjs/runtime/options.d.ts +12 -0
- package/dist/cjs/runtime/options.d.ts.map +1 -0
- package/dist/{types.js → cjs/runtime/options.js} +1 -1
- package/dist/cjs/runtime/options.js.map +1 -0
- package/dist/cjs/storefront.d.ts +3 -0
- package/dist/cjs/storefront.d.ts.map +1 -0
- package/dist/cjs/storefront.js +22 -0
- package/dist/cjs/storefront.js.map +1 -0
- package/dist/cjs/webhooks.d.ts +2 -0
- package/dist/cjs/webhooks.d.ts.map +1 -0
- package/dist/cjs/webhooks.js +18 -0
- package/dist/cjs/webhooks.js.map +1 -0
- package/dist/esm/generated/management/client.d.ts +902 -0
- package/dist/esm/generated/management/client.d.ts.map +1 -0
- package/dist/esm/generated/management/client.js +1545 -0
- package/dist/esm/generated/management/client.js.map +1 -0
- package/dist/esm/generated/management/types.d.ts +7771 -0
- package/dist/esm/generated/management/types.d.ts.map +1 -0
- package/dist/esm/generated/management/types.js +3 -0
- package/dist/esm/generated/management/types.js.map +1 -0
- package/dist/esm/generated/storefront/client.d.ts +229 -0
- package/dist/esm/generated/storefront/client.d.ts.map +1 -0
- package/dist/esm/generated/storefront/client.js +340 -0
- package/dist/esm/generated/storefront/client.js.map +1 -0
- package/dist/esm/generated/storefront/types.d.ts +3076 -0
- package/dist/esm/generated/storefront/types.d.ts.map +1 -0
- package/dist/esm/generated/storefront/types.js +3 -0
- package/dist/esm/generated/storefront/types.js.map +1 -0
- package/dist/esm/generated/webhooks/types.d.ts +3113 -0
- package/dist/esm/generated/webhooks/types.d.ts.map +1 -0
- package/dist/esm/generated/webhooks/types.js +3 -0
- package/dist/esm/generated/webhooks/types.js.map +1 -0
- package/dist/esm/index.d.ts +9 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +5 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/management.d.ts +3 -0
- package/dist/esm/management.d.ts.map +1 -0
- package/dist/esm/management.js +3 -0
- package/dist/esm/management.js.map +1 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/runtime/errors.d.ts +18 -0
- package/dist/esm/runtime/errors.d.ts.map +1 -0
- package/dist/esm/runtime/errors.js +36 -0
- package/dist/esm/runtime/errors.js.map +1 -0
- package/dist/esm/runtime/http.d.ts +20 -0
- package/dist/esm/runtime/http.d.ts.map +1 -0
- package/dist/esm/runtime/http.js +117 -0
- package/dist/esm/runtime/http.js.map +1 -0
- package/dist/esm/runtime/options.d.ts +12 -0
- package/dist/esm/runtime/options.d.ts.map +1 -0
- package/dist/esm/runtime/options.js +2 -0
- package/dist/esm/runtime/options.js.map +1 -0
- package/dist/esm/storefront.d.ts +3 -0
- package/dist/esm/storefront.d.ts.map +1 -0
- package/dist/esm/storefront.js +3 -0
- package/dist/esm/storefront.js.map +1 -0
- package/dist/esm/webhooks.d.ts +2 -0
- package/dist/esm/webhooks.d.ts.map +1 -0
- package/dist/esm/webhooks.js +2 -0
- package/dist/esm/webhooks.js.map +1 -0
- package/package.json +74 -15
- package/dist/client.d.ts +0 -73
- package/dist/client.d.ts.map +0 -1
- package/dist/client.js +0 -55
- package/dist/client.js.map +0 -1
- package/dist/errors.d.ts +0 -7
- package/dist/errors.d.ts.map +0 -1
- package/dist/errors.js +0 -14
- package/dist/errors.js.map +0 -1
- package/dist/generate.d.ts +0 -2
- package/dist/generate.d.ts.map +0 -1
- package/dist/generate.js +0 -102
- package/dist/generate.js.map +0 -1
- package/dist/generated/management.d.ts +0 -12767
- package/dist/generated/management.d.ts.map +0 -1
- package/dist/generated/management.js +0 -638
- package/dist/generated/management.js.map +0 -1
- package/dist/generated/storefront.d.ts +0 -3464
- package/dist/generated/storefront.d.ts.map +0 -1
- package/dist/generated/storefront.js +0 -90
- package/dist/generated/storefront.js.map +0 -1
- package/dist/generated/webhooks.d.ts +0 -3659
- package/dist/generated/webhooks.d.ts.map +0 -1
- package/dist/generated/webhooks.js +0 -5
- package/dist/generated/webhooks.js.map +0 -1
- package/dist/index.d.ts +0 -12
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js +0 -10
- package/dist/index.js.map +0 -1
- package/dist/management.d.ts +0 -7
- package/dist/management.d.ts.map +0 -1
- package/dist/management.js +0 -12
- package/dist/management.js.map +0 -1
- package/dist/storefront.d.ts +0 -7
- package/dist/storefront.d.ts.map +0 -1
- package/dist/storefront.js +0 -13
- package/dist/storefront.js.map +0 -1
- package/dist/types.d.ts +0 -12
- package/dist/types.d.ts.map +0 -1
- package/dist/types.js.map +0 -1
|
@@ -0,0 +1,902 @@
|
|
|
1
|
+
import { HttpClient } from "../../runtime/http.js";
|
|
2
|
+
import type { ClientOptions, RequestOptions } from "../../runtime/options.js";
|
|
3
|
+
import type { AbandonedCheckoutStoreConfigurationDto, AbandonedCheckoutStoreConfigurationUpdateDto, AffiliateLinkDto, BanDto, BansGetBansQuery, CancelSubscriptionRequestDto, CheckForBanIDByIdentitiesRequestDto, CheckForBanIDByIdentitiesResponseDto, CommandAttemptDto, CouponDto, CouponsGetCouponsForStoreQuery, CreateAffiliateLinkDto, CreateCheckoutSessionManagementDto, CreateCheckoutSessionResponseDto, CreateCouponDto, CreateCustomerPortalSessionRequestDto, CreateDownloadableFileDownloadUrlResponseDto, CreateEmailTemplateDto, CreateGameServerConsoleDto, CreateGameServerDto, CreateGiftCardDto, CreateNavLinkDto, CreateProductDependentMigrationRequestDto, CreateRefundRequestDto, CreateSaleDto, CreateTierGroupRequestDto, CreateTrialEligibilityOverrideDto, CreateWebhookDto, 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, FinishEmailBrandingImageUploadRequestDto, FinishTagImageUploadUrlRequestDto, FlakeId, GameServerConsoleDto, GameServerConsoleMessageDto, GameServerDto, GetEmailBrandingImageUploadUrlResponseDto, GetTagImageUploadUrlResponseDto, GiftCardDto, GiftcardsGetGiftCardsQuery, GlobalCommandDto, 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, SaleDto, SearchDashboardResponseDto, SetDiscordActionDto, StartDataMigrationFromTebexRequestDto, StartDownloadableFileUploadRequestDto, StoreDto, StoreMemberDto, StorePaymentSettingsDto, StorePricingRegionOverrideDto, StoreUpsellSettingsDto, SubscriptionDto, SubscriptionsGetSubscriptionsQuery, TagDto, TierGroupDto, ToggleStorePaymentMethodTypeRequestDto, TrialDto, TrialEligibilityOverrideDto, TrialsGetEligibilityOverridesForCustomerQuery, TrialsGetTrialsQuery, UnqueueCommandsRequestDto, UnqueueCommandsResponseDto, UpdateAffiliateLinkDto, UpdateCouponDto, UpdateEmailBrandingDto, UpdateEmailTemplateDto, UpdateGameServerConsoleDto, UpdateGameServerDto, UpdateGiftCardDto, UpdateNavLinkDto, UpdateNavLinkOrderChangeDto, UpdateProductSortOrderRequestDto, UpdateSaleDto, UpdateStoreDto, UpdateStoreMemberDto, UpdateStorePaymentSettingsDto, UpdateStoreUpsellSettingsDto, UpdateSubscriptionRequestDto, UpdateSubscriptionResponseDto, UpdateTierGroupRequestDto, UpdateWebhookDto, UpsertBanRequestDto, UpsertCustomerRequestDto, UpsertCustomVariableRequestDto, UpsertGlobalCommandDto, UpsertProductRequestDto, UpsertTagRequestDto, WebhookHistoryDto, WebhookSubscriptionDto, WebhooksGetHistoryQuery, WebhookVariablesDto } from "./types.js";
|
|
4
|
+
export declare class AffiliateLinksResource {
|
|
5
|
+
private readonly http;
|
|
6
|
+
constructor(http: HttpClient);
|
|
7
|
+
createAffiliateLink(body: CreateAffiliateLinkDto, opts?: RequestOptions): Promise<AffiliateLinkDto>;
|
|
8
|
+
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 CheckoutResource {
|
|
24
|
+
private readonly http;
|
|
25
|
+
constructor(http: HttpClient);
|
|
26
|
+
/**
|
|
27
|
+
* Create a checkout session
|
|
28
|
+
*
|
|
29
|
+
* Creates a checkout session from a secure server using an API Key.
|
|
30
|
+
* If you have a Customer token, see the Storefront API Create Checkout endpoint.
|
|
31
|
+
*/
|
|
32
|
+
createCheckoutSession(body: CreateCheckoutSessionManagementDto, opts?: RequestOptions): Promise<CreateCheckoutSessionResponseDto>;
|
|
33
|
+
}
|
|
34
|
+
export declare class CouponsResource {
|
|
35
|
+
private readonly http;
|
|
36
|
+
constructor(http: HttpClient);
|
|
37
|
+
createCouponForStore(body: CreateCouponDto, opts?: RequestOptions): Promise<CouponDto>;
|
|
38
|
+
/**
|
|
39
|
+
* Deletes a coupon
|
|
40
|
+
*/
|
|
41
|
+
deleteCouponForStore(couponId: FlakeId, opts?: RequestOptions): Promise<void>;
|
|
42
|
+
/**
|
|
43
|
+
* Retrieves a coupon by ID
|
|
44
|
+
*/
|
|
45
|
+
getCouponByIdForStore(couponId: FlakeId, opts?: RequestOptions): Promise<CouponDto>;
|
|
46
|
+
/**
|
|
47
|
+
* Fetches all coupons for a store id
|
|
48
|
+
*/
|
|
49
|
+
getCouponsForStore(query?: CouponsGetCouponsForStoreQuery, opts?: RequestOptions): Promise<Array<CouponDto>>;
|
|
50
|
+
/**
|
|
51
|
+
* Performs a Delta Update of a Coupon
|
|
52
|
+
*/
|
|
53
|
+
updateCouponForStore(couponId: FlakeId, body?: UpdateCouponDto, opts?: RequestOptions): Promise<CouponDto>;
|
|
54
|
+
}
|
|
55
|
+
export declare class CustomerPortalSessionsResource {
|
|
56
|
+
private readonly http;
|
|
57
|
+
constructor(http: HttpClient);
|
|
58
|
+
/**
|
|
59
|
+
* Create a customer portal session
|
|
60
|
+
*
|
|
61
|
+
* Creates a customer portal session from a secure server using an API Key.
|
|
62
|
+
* The returned session contains the token and URL to hand to the customer.
|
|
63
|
+
* @param customerId The ID of the customer to create the portal session for.
|
|
64
|
+
*/
|
|
65
|
+
createCustomerPortalSession(customerId: FlakeId, body: CreateCustomerPortalSessionRequestDto, opts?: RequestOptions): Promise<CustomerPortalSessionDto>;
|
|
66
|
+
}
|
|
67
|
+
export declare class CustomersResource {
|
|
68
|
+
private readonly http;
|
|
69
|
+
constructor(http: HttpClient);
|
|
70
|
+
/**
|
|
71
|
+
* Bulk create customers
|
|
72
|
+
*
|
|
73
|
+
* Creates up to 200 customers at once.
|
|
74
|
+
*/
|
|
75
|
+
bulkCreateCustomers(body?: Array<UpsertCustomerRequestDto>, opts?: RequestOptions): Promise<Array<CustomerDto>>;
|
|
76
|
+
/**
|
|
77
|
+
* Create customer
|
|
78
|
+
*
|
|
79
|
+
* Creates a new customer based on the fields passed.
|
|
80
|
+
*/
|
|
81
|
+
createCustomer(body?: UpsertCustomerRequestDto, opts?: RequestOptions): Promise<CustomerDto>;
|
|
82
|
+
/**
|
|
83
|
+
* Create customer token
|
|
84
|
+
*
|
|
85
|
+
* Generates a customer token that can be used by the Storefront (Headless) API.
|
|
86
|
+
* @param customerId The ID of the customer to generate the customer token for.
|
|
87
|
+
*/
|
|
88
|
+
createCustomerToken(customerId: FlakeId, opts?: RequestOptions): Promise<CustomerTokenResponseDto>;
|
|
89
|
+
/**
|
|
90
|
+
* Get customer by ID
|
|
91
|
+
*
|
|
92
|
+
* Retrieves a customer by the ID for the specified store.
|
|
93
|
+
* @param customerId The ID of the customer.
|
|
94
|
+
*/
|
|
95
|
+
getCustomerById(customerId: FlakeId, opts?: RequestOptions): Promise<CustomerDto>;
|
|
96
|
+
/**
|
|
97
|
+
* Get customers
|
|
98
|
+
*
|
|
99
|
+
* Retrieves all customers for the specified store.
|
|
100
|
+
*/
|
|
101
|
+
getCustomers(query?: CustomersGetCustomersQuery, opts?: RequestOptions): Promise<Array<CustomerDto>>;
|
|
102
|
+
/**
|
|
103
|
+
* Invalidate customer tokens
|
|
104
|
+
*
|
|
105
|
+
* Invalidates all generated customer tokens.
|
|
106
|
+
* @param customerId The ID of the customer to invalidate the customer tokens for.
|
|
107
|
+
*/
|
|
108
|
+
invalidateCustomerTokens(customerId: FlakeId, opts?: RequestOptions): Promise<void>;
|
|
109
|
+
/**
|
|
110
|
+
* Lookup customer
|
|
111
|
+
*
|
|
112
|
+
* Looks up a customer by an external platform ID.
|
|
113
|
+
*/
|
|
114
|
+
lookupCustomer(query?: CustomersLookupCustomerQuery, opts?: RequestOptions): Promise<CustomerDto>;
|
|
115
|
+
/**
|
|
116
|
+
* Update customer
|
|
117
|
+
*
|
|
118
|
+
* Updates an existing customer based on the fields passed.
|
|
119
|
+
*/
|
|
120
|
+
updateCustomer(customerId: FlakeId, body?: UpsertCustomerRequestDto, opts?: RequestOptions): Promise<CustomerDto>;
|
|
121
|
+
}
|
|
122
|
+
export declare class CustomVariablesResource {
|
|
123
|
+
private readonly http;
|
|
124
|
+
constructor(http: HttpClient);
|
|
125
|
+
/**
|
|
126
|
+
* Create custom variable
|
|
127
|
+
*
|
|
128
|
+
* Creates a new custom variable for the specified store.
|
|
129
|
+
* Custom variables allow customers to provide additional input when purchasing products.
|
|
130
|
+
*/
|
|
131
|
+
createCustomVariableForStore(body: UpsertCustomVariableRequestDto, opts?: RequestOptions): Promise<CustomVariableDto>;
|
|
132
|
+
/**
|
|
133
|
+
* Delete custom variable
|
|
134
|
+
*
|
|
135
|
+
* Deletes a custom variable from the specified store.
|
|
136
|
+
* This will also delete all associated options and cannot be undone.
|
|
137
|
+
* @param customVariableId The ID of the custom variable to delete.
|
|
138
|
+
*/
|
|
139
|
+
deleteCustomVariableForStore(customVariableId: FlakeId, opts?: RequestOptions): Promise<void>;
|
|
140
|
+
/**
|
|
141
|
+
* Get custom variable
|
|
142
|
+
*
|
|
143
|
+
* Retrieves a specific custom variable by ID from the specified store.
|
|
144
|
+
* @param customVariableId The ID of the custom variable to retrieve.
|
|
145
|
+
*/
|
|
146
|
+
getCustomVariableByIdForStore(customVariableId: FlakeId, opts?: RequestOptions): Promise<CustomVariableDto>;
|
|
147
|
+
/**
|
|
148
|
+
* Get custom variables
|
|
149
|
+
*
|
|
150
|
+
* Retrieves all custom variables for the specified store.
|
|
151
|
+
*/
|
|
152
|
+
getCustomVariablesForStore(opts?: RequestOptions): Promise<Array<CustomVariableDto>>;
|
|
153
|
+
/**
|
|
154
|
+
* Update custom variable
|
|
155
|
+
*
|
|
156
|
+
* Performs a partial update of a custom variable using field mask.
|
|
157
|
+
* Only the fields specified in the request will be updated.
|
|
158
|
+
* @param customVariableId The ID of the custom variable to update.
|
|
159
|
+
*/
|
|
160
|
+
updateCustomVariableForStore(customVariableId: FlakeId, body: UpsertCustomVariableRequestDto, opts?: RequestOptions): Promise<CustomVariableDto>;
|
|
161
|
+
}
|
|
162
|
+
export declare class DashboardResource {
|
|
163
|
+
private readonly http;
|
|
164
|
+
constructor(http: HttpClient);
|
|
165
|
+
getDashboardSearchHints(opts?: RequestOptions): Promise<Array<DashboardSearchHintDto>>;
|
|
166
|
+
searchDashboard(query?: DashboardSearchDashboardQuery, opts?: RequestOptions): Promise<SearchDashboardResponseDto>;
|
|
167
|
+
}
|
|
168
|
+
export declare class DataMigrationsResource {
|
|
169
|
+
private readonly http;
|
|
170
|
+
constructor(http: HttpClient);
|
|
171
|
+
getDataMigrations(query?: DataMigrationsGetDataMigrationsQuery, opts?: RequestOptions): Promise<Array<DataMigrationTaskDto>>;
|
|
172
|
+
startDataMigrationFromTebex(body: StartDataMigrationFromTebexRequestDto, opts?: RequestOptions): Promise<Array<DataMigrationTaskDto>>;
|
|
173
|
+
}
|
|
174
|
+
export declare class DeliveryResource {
|
|
175
|
+
private readonly http;
|
|
176
|
+
constructor(http: HttpClient);
|
|
177
|
+
/**
|
|
178
|
+
* Assign a delivery item to a customer
|
|
179
|
+
*
|
|
180
|
+
* Allows you to assign a delivery item to a customer
|
|
181
|
+
*/
|
|
182
|
+
assignDeliveryItem(customerId: FlakeId, body?: DeliveryItemAssignmentDto, opts?: RequestOptions): Promise<Array<DeliveryItemDto>>;
|
|
183
|
+
/**
|
|
184
|
+
* Assign delivery items in bulk
|
|
185
|
+
*
|
|
186
|
+
* Allows you to assign multiple delivery items for multiple customers in bulk
|
|
187
|
+
*/
|
|
188
|
+
assignDeliveryItemsBulk(body?: Array<DeliveryItemAssignmentBulkDto>, opts?: RequestOptions): Promise<Array<DeliveryItemDto>>;
|
|
189
|
+
/**
|
|
190
|
+
* Get command attempts associated with a customer
|
|
191
|
+
*
|
|
192
|
+
* Retrieves command attempts associated with a customer
|
|
193
|
+
*/
|
|
194
|
+
getCommandAttemptsForCustomer(customerId: FlakeId, query?: DeliveryGetCommandAttemptsForCustomerQuery, opts?: RequestOptions): Promise<Array<CommandAttemptDto>>;
|
|
195
|
+
/**
|
|
196
|
+
* Get delivery items associated with a customer
|
|
197
|
+
*
|
|
198
|
+
* Retrieves delivery items associated with a customer
|
|
199
|
+
*/
|
|
200
|
+
getCustomerDeliveryItems(customerId: FlakeId, query?: DeliveryGetCustomerDeliveryItemsQuery, opts?: RequestOptions): Promise<Array<DeliveryItemDto>>;
|
|
201
|
+
/**
|
|
202
|
+
* Returns delivery items in which an associated command attempt is for the gameserver
|
|
203
|
+
*/
|
|
204
|
+
getGameServerDeliveryItems(gameServerId: FlakeId, query?: DeliveryGetGameServerDeliveryItemsQuery, opts?: RequestOptions): Promise<Array<DeliveryItemDto>>;
|
|
205
|
+
/**
|
|
206
|
+
* Get delivery items associated with an order
|
|
207
|
+
*
|
|
208
|
+
* Retrieves all delivery items associated with a specific order.
|
|
209
|
+
* @param orderId The ID of the order to retrieve delivery items from.
|
|
210
|
+
*/
|
|
211
|
+
getOrderDeliveryItems(orderId: FlakeId, query?: DeliveryGetOrderDeliveryItemsQuery, opts?: RequestOptions): Promise<Array<DeliveryItemDto>>;
|
|
212
|
+
/**
|
|
213
|
+
* Get all delivery items
|
|
214
|
+
*
|
|
215
|
+
* Retrieves all delivery items associated with this store (paginated)
|
|
216
|
+
*/
|
|
217
|
+
getStoreDeliveryItems(query?: DeliveryGetStoreDeliveryItemsQuery, opts?: RequestOptions): Promise<Array<DeliveryItemDto>>;
|
|
218
|
+
/**
|
|
219
|
+
* Resend commands for a given Gameserver
|
|
220
|
+
*/
|
|
221
|
+
resendDeliveryCommandsForGameServer(gameServerId: FlakeId, body?: ResendCommandsForGameServerRequestDto, opts?: RequestOptions): Promise<ResendCommandsForGameServerResponseDto>;
|
|
222
|
+
/**
|
|
223
|
+
* Revoke a delivery item from a customer
|
|
224
|
+
*
|
|
225
|
+
* Allows you to revoke a delivery item associated with a customer
|
|
226
|
+
*/
|
|
227
|
+
revokeDeliveryItem(customerId: FlakeId, deliveryItemId: FlakeId, opts?: RequestOptions): Promise<void>;
|
|
228
|
+
/**
|
|
229
|
+
* Unqueue commands by Attempt IDs
|
|
230
|
+
*/
|
|
231
|
+
unqueueDeliveryCommandAttemptByAttemptIDs(body: UnqueueCommandsRequestDto, opts?: RequestOptions): Promise<UnqueueCommandsResponseDto>;
|
|
232
|
+
}
|
|
233
|
+
export declare class DiscordResource {
|
|
234
|
+
private readonly http;
|
|
235
|
+
constructor(http: HttpClient);
|
|
236
|
+
createAction(productVersionId: FlakeId, body?: Array<SetDiscordActionDto>, opts?: RequestOptions): Promise<DiscordActionDto>;
|
|
237
|
+
createDiscordServerLink(opts?: RequestOptions): Promise<DiscordServerLinkDto>;
|
|
238
|
+
deleteDiscordServerLinks(token: string, opts?: RequestOptions): Promise<Array<DiscordServerLinkDto>>;
|
|
239
|
+
deleteUserToDeliveryItemLink(inventoryItemId: FlakeId, opts?: RequestOptions): Promise<void>;
|
|
240
|
+
getActions(productVersionId: FlakeId, opts?: RequestOptions): Promise<Array<DiscordActionDto>>;
|
|
241
|
+
getDiscordActionExecutionHistory(orderId: FlakeId, opts?: RequestOptions): Promise<Array<QueuedDiscordActionDto>>;
|
|
242
|
+
getDiscordServerLinks(opts?: RequestOptions): Promise<Array<DiscordServerLinkDto>>;
|
|
243
|
+
getDiscordServerRoles(discordServerId: number, opts?: RequestOptions): Promise<Array<DiscordServerRoleDto>>;
|
|
244
|
+
getDiscordServerTextChannels(discordServerId: number, opts?: RequestOptions): Promise<Array<DiscordServerChannelDto>>;
|
|
245
|
+
getLinkedDiscordAccounts(orderId: FlakeId, opts?: RequestOptions): Promise<Record<string, DiscordProfileDto>>;
|
|
246
|
+
getQueuedDiscordActionForDeliveryItem(inventoryItemId: FlakeId, opts?: RequestOptions): Promise<Array<QueuedDiscordActionDto>>;
|
|
247
|
+
getUserToDeliveryItemLinks(inventoryItemId: FlakeId, opts?: RequestOptions): Promise<DiscordProfileDto>;
|
|
248
|
+
setUserToDeliveryItemLink(inventoryItemId: FlakeId, query?: DiscordSetUserToDeliveryItemLinkQuery, opts?: RequestOptions): Promise<void>;
|
|
249
|
+
}
|
|
250
|
+
export declare class DownloadableFilesResource {
|
|
251
|
+
private readonly http;
|
|
252
|
+
constructor(http: HttpClient);
|
|
253
|
+
createDownloadUrl(productId: FlakeId, downloadableFileId: FlakeId, opts?: RequestOptions): Promise<CreateDownloadableFileDownloadUrlResponseDto>;
|
|
254
|
+
deleteDownloadableFile(productId: FlakeId, downloadableFileId: FlakeId, opts?: RequestOptions): Promise<void>;
|
|
255
|
+
finishDownloadableFileUpload(productId: FlakeId, downloadableFileId: FlakeId, opts?: RequestOptions): Promise<void>;
|
|
256
|
+
getDownloadableFiles(productId: FlakeId, opts?: RequestOptions): Promise<Array<ProductDownloadableFileDto>>;
|
|
257
|
+
startDownloadableFileUpload(productId: FlakeId, body: StartDownloadableFileUploadRequestDto, opts?: RequestOptions): Promise<void>;
|
|
258
|
+
}
|
|
259
|
+
export declare class GameServersResource {
|
|
260
|
+
private readonly http;
|
|
261
|
+
constructor(http: HttpClient);
|
|
262
|
+
/**
|
|
263
|
+
* Create a new Game Server for a store
|
|
264
|
+
*/
|
|
265
|
+
createGameServer(body: CreateGameServerDto, opts?: RequestOptions): Promise<GameServerDto>;
|
|
266
|
+
/**
|
|
267
|
+
* Create a console for a game server.
|
|
268
|
+
*/
|
|
269
|
+
createGameServerConsole(gameServerId: FlakeId, body: CreateGameServerConsoleDto, opts?: RequestOptions): Promise<GameServerConsoleDto>;
|
|
270
|
+
/**
|
|
271
|
+
* Delete a Game Server by ID for a store
|
|
272
|
+
*/
|
|
273
|
+
deleteGameServer(gameServerId: FlakeId, opts?: RequestOptions): Promise<void>;
|
|
274
|
+
/**
|
|
275
|
+
* Delete an associated game server console.
|
|
276
|
+
*/
|
|
277
|
+
deleteGameServerConsole(gameServerId: FlakeId, opts?: RequestOptions): Promise<void>;
|
|
278
|
+
/**
|
|
279
|
+
* Get a Game Server by ID for a store
|
|
280
|
+
*/
|
|
281
|
+
getGameServer(gameServerId: FlakeId, opts?: RequestOptions): Promise<Array<GameServerDto>>;
|
|
282
|
+
/**
|
|
283
|
+
* Get the associated console for a game server.
|
|
284
|
+
*/
|
|
285
|
+
getGameServerConsole(gameServerId: FlakeId, opts?: RequestOptions): Promise<GameServerConsoleDto>;
|
|
286
|
+
/**
|
|
287
|
+
* Get console messages for a game server.
|
|
288
|
+
*/
|
|
289
|
+
getGameServerConsoleMessages(gameServerId: FlakeId, opts?: RequestOptions): Promise<Array<GameServerConsoleMessageDto>>;
|
|
290
|
+
/**
|
|
291
|
+
* Get Game Servers for a store
|
|
292
|
+
*/
|
|
293
|
+
getGameServers(opts?: RequestOptions): Promise<Array<GameServerDto>>;
|
|
294
|
+
/**
|
|
295
|
+
* Reset the API Key Token for a Game Server for a store
|
|
296
|
+
*/
|
|
297
|
+
resetGameServerToken(gameServerId: FlakeId, opts?: RequestOptions): Promise<GameServerDto>;
|
|
298
|
+
/**
|
|
299
|
+
* Update a Game Server By ID for a store
|
|
300
|
+
*/
|
|
301
|
+
updateGameServer(gameServerId: FlakeId, body?: UpdateGameServerDto, opts?: RequestOptions): Promise<GameServerDto>;
|
|
302
|
+
/**
|
|
303
|
+
* Update a console for a game server.
|
|
304
|
+
*/
|
|
305
|
+
updateGameServerConsole(gameServerId: FlakeId, body?: UpdateGameServerConsoleDto, opts?: RequestOptions): Promise<GameServerConsoleDto>;
|
|
306
|
+
}
|
|
307
|
+
export declare class GiftcardsResource {
|
|
308
|
+
private readonly http;
|
|
309
|
+
constructor(http: HttpClient);
|
|
310
|
+
/**
|
|
311
|
+
* Create a Gift Card for a store
|
|
312
|
+
*/
|
|
313
|
+
createGiftCard(body: CreateGiftCardDto, opts?: RequestOptions): Promise<GiftCardDto>;
|
|
314
|
+
/**
|
|
315
|
+
* Delete a Gift Card By ID for a store
|
|
316
|
+
*/
|
|
317
|
+
deleteGiftCard(giftCardId: FlakeId, opts?: RequestOptions): Promise<GiftCardDto>;
|
|
318
|
+
/**
|
|
319
|
+
* Get a Gift Card By ID for a store
|
|
320
|
+
*/
|
|
321
|
+
getGiftCard(giftCardId: FlakeId, opts?: RequestOptions): Promise<GiftCardDto>;
|
|
322
|
+
/**
|
|
323
|
+
* Get Gift Cards for a store
|
|
324
|
+
*/
|
|
325
|
+
getGiftCards(query?: GiftcardsGetGiftCardsQuery, opts?: RequestOptions): Promise<Array<GiftCardDto>>;
|
|
326
|
+
/**
|
|
327
|
+
* Update a Gift Card By ID for a store
|
|
328
|
+
*/
|
|
329
|
+
updateGiftCard(giftCardId: FlakeId, body?: UpdateGiftCardDto, opts?: RequestOptions): Promise<GiftCardDto>;
|
|
330
|
+
}
|
|
331
|
+
export declare class GlobalCommandsResource {
|
|
332
|
+
private readonly http;
|
|
333
|
+
constructor(http: HttpClient);
|
|
334
|
+
/**
|
|
335
|
+
* Create global command
|
|
336
|
+
*
|
|
337
|
+
* Creates a global command for a store.
|
|
338
|
+
*/
|
|
339
|
+
createGlobalCommand(body: UpsertGlobalCommandDto, opts?: RequestOptions): Promise<GlobalCommandDto>;
|
|
340
|
+
/**
|
|
341
|
+
* Delete global command
|
|
342
|
+
*
|
|
343
|
+
* Deletes a global command for a store.
|
|
344
|
+
* @param globalCommandId The ID of the command to delete.
|
|
345
|
+
*/
|
|
346
|
+
deleteGlobalCommand(globalCommandId: FlakeId, opts?: RequestOptions): Promise<void>;
|
|
347
|
+
/**
|
|
348
|
+
* Get global commands
|
|
349
|
+
*
|
|
350
|
+
* Retrieves all global commands for the specified store.
|
|
351
|
+
*/
|
|
352
|
+
getGlobalCommands(opts?: RequestOptions): Promise<Array<GlobalCommandDto>>;
|
|
353
|
+
/**
|
|
354
|
+
* Update global command
|
|
355
|
+
*
|
|
356
|
+
* Updates a global command for a store.
|
|
357
|
+
*/
|
|
358
|
+
updateGlobalCommand(globalCommandId: FlakeId, body: UpsertGlobalCommandDto, opts?: RequestOptions): Promise<GlobalCommandDto>;
|
|
359
|
+
}
|
|
360
|
+
export declare class InvoicesResource {
|
|
361
|
+
private readonly http;
|
|
362
|
+
constructor(http: HttpClient);
|
|
363
|
+
/**
|
|
364
|
+
* Download invoice
|
|
365
|
+
*
|
|
366
|
+
* Retrieves a temporary download URL for the invoice PDF.
|
|
367
|
+
* @param invoiceId The ID of the invoice to download.
|
|
368
|
+
*/
|
|
369
|
+
downloadInvoice(invoiceId: FlakeId, opts?: RequestOptions): Promise<InvoiceDownloadUrlResponseDto>;
|
|
370
|
+
/**
|
|
371
|
+
* Get invoices
|
|
372
|
+
*
|
|
373
|
+
* Retrieves all invoices for the specified store.
|
|
374
|
+
*/
|
|
375
|
+
listInvoices(query?: InvoicesListInvoicesQuery, opts?: RequestOptions): Promise<Array<InvoiceDto>>;
|
|
376
|
+
}
|
|
377
|
+
export declare class MarketingResource {
|
|
378
|
+
private readonly http;
|
|
379
|
+
constructor(http: HttpClient);
|
|
380
|
+
activateEmailTemplate(templateId: FlakeId, opts?: RequestOptions): Promise<void>;
|
|
381
|
+
createEmailTemplate(body: CreateEmailTemplateDto, opts?: RequestOptions): Promise<EmailTemplateDto>;
|
|
382
|
+
deactivateEmailTemplate(templateId: FlakeId, opts?: RequestOptions): Promise<void>;
|
|
383
|
+
deactivateEmailTemplateByType(body: DeactivateEmailTemplateRequestDto, opts?: RequestOptions): Promise<void>;
|
|
384
|
+
deleteEmailTemplate(templateId: FlakeId, opts?: RequestOptions): Promise<void>;
|
|
385
|
+
finishEmailBrandingImageUpload(body: FinishEmailBrandingImageUploadRequestDto, opts?: RequestOptions): Promise<void>;
|
|
386
|
+
getEmailBranding(opts?: RequestOptions): Promise<EmailBrandingDto>;
|
|
387
|
+
getEmailBrandingImageUploadUrl(query?: MarketingGetEmailBrandingImageUploadUrlQuery, opts?: RequestOptions): Promise<GetEmailBrandingImageUploadUrlResponseDto>;
|
|
388
|
+
getEmailDeliveries(query?: MarketingGetEmailDeliveriesQuery, opts?: RequestOptions): Promise<Array<EmailDeliveryDto>>;
|
|
389
|
+
getEmailDelivery(emailDeliveryId: FlakeId, opts?: RequestOptions): Promise<EmailDeliveryDto>;
|
|
390
|
+
getEmailTemplate(templateId: FlakeId, opts?: RequestOptions): Promise<EmailTemplateDto>;
|
|
391
|
+
getEmailTemplateDefinitions(opts?: RequestOptions): Promise<Array<EmailTemplateDefinitionDto> | undefined>;
|
|
392
|
+
getEmailTemplates(query?: MarketingGetEmailTemplatesQuery, opts?: RequestOptions): Promise<Array<EmailTemplateDto>>;
|
|
393
|
+
/**
|
|
394
|
+
* Gets the abandoned checkout behaviour for a store
|
|
395
|
+
*/
|
|
396
|
+
getStoreAbandonedCheckoutConfigurationOptions(opts?: RequestOptions): Promise<AbandonedCheckoutStoreConfigurationDto>;
|
|
397
|
+
/**
|
|
398
|
+
* Gets the purchase follow up behaviour for a store
|
|
399
|
+
*/
|
|
400
|
+
getStorePurchaseFollowUpConfigurationOptions(opts?: RequestOptions): Promise<PurchaseFollowUpStoreConfigurationDto>;
|
|
401
|
+
/**
|
|
402
|
+
* Sets the abandoned checkout behaviour for a store
|
|
403
|
+
*/
|
|
404
|
+
setStoreAbandonedCheckoutConfigurationOptions(body: AbandonedCheckoutStoreConfigurationUpdateDto, opts?: RequestOptions): Promise<AbandonedCheckoutStoreConfigurationDto | undefined>;
|
|
405
|
+
/**
|
|
406
|
+
* Sets the purchase follow up behaviour for a store
|
|
407
|
+
*/
|
|
408
|
+
setStorePurchaseFollowUpConfigurationOptions(body: PurchaseFollowUpStoreConfigurationUpdateDto, opts?: RequestOptions): Promise<PurchaseFollowUpStoreConfigurationDto | undefined>;
|
|
409
|
+
updateEmailBranding(body?: UpdateEmailBrandingDto, opts?: RequestOptions): Promise<EmailBrandingDto>;
|
|
410
|
+
updateEmailTemplate(templateId: FlakeId, body?: UpdateEmailTemplateDto, opts?: RequestOptions): Promise<EmailTemplateDto>;
|
|
411
|
+
}
|
|
412
|
+
export declare class NavlinksResource {
|
|
413
|
+
private readonly http;
|
|
414
|
+
constructor(http: HttpClient);
|
|
415
|
+
/**
|
|
416
|
+
* Create a new NavLink for a store
|
|
417
|
+
*/
|
|
418
|
+
createNavLink(body: CreateNavLinkDto, opts?: RequestOptions): Promise<NavLinkDto>;
|
|
419
|
+
/**
|
|
420
|
+
* Delete a NavLink for a store
|
|
421
|
+
*/
|
|
422
|
+
deleteNavLink(navLinkId: FlakeId, opts?: RequestOptions): Promise<void>;
|
|
423
|
+
/**
|
|
424
|
+
* Get a NavLink by ID for a store
|
|
425
|
+
*/
|
|
426
|
+
getNavLink(navLinkId: FlakeId, opts?: RequestOptions): Promise<NavLinkDto>;
|
|
427
|
+
/**
|
|
428
|
+
* Get all NavLinks for a store
|
|
429
|
+
*/
|
|
430
|
+
getNavLinks(opts?: RequestOptions): Promise<Array<NavLinkDto>>;
|
|
431
|
+
/**
|
|
432
|
+
* Update a NavLink By ID for a store
|
|
433
|
+
*/
|
|
434
|
+
updateNavLink(navLinkId: FlakeId, body?: UpdateNavLinkDto, opts?: RequestOptions): Promise<NavLinkDto>;
|
|
435
|
+
/**
|
|
436
|
+
* Update the sort orders of NavLinks for a Store
|
|
437
|
+
*/
|
|
438
|
+
updateNavLinkOrder(body?: Array<UpdateNavLinkOrderChangeDto>, opts?: RequestOptions): Promise<void>;
|
|
439
|
+
}
|
|
440
|
+
export declare class OrdersResource {
|
|
441
|
+
private readonly http;
|
|
442
|
+
constructor(http: HttpClient);
|
|
443
|
+
/**
|
|
444
|
+
* Get order by ID
|
|
445
|
+
*
|
|
446
|
+
* Retrieves an order by the ID for the specified store.
|
|
447
|
+
* @param orderId The ID of the order.
|
|
448
|
+
*/
|
|
449
|
+
getOrderById(orderId: FlakeId, opts?: RequestOptions): Promise<OrderDto>;
|
|
450
|
+
/**
|
|
451
|
+
* Get orders
|
|
452
|
+
*
|
|
453
|
+
* Retrieves all orders for the specified store.
|
|
454
|
+
*/
|
|
455
|
+
getOrders(query?: OrdersGetOrdersQuery, opts?: RequestOptions): Promise<Array<OrderDto>>;
|
|
456
|
+
/**
|
|
457
|
+
* Refund order by ID
|
|
458
|
+
*
|
|
459
|
+
* Creates a refund for an order by the ID for the specified store.
|
|
460
|
+
* @param orderId The ID of the order.
|
|
461
|
+
*/
|
|
462
|
+
refundOrder(orderId: FlakeId, body?: CreateRefundRequestDto, opts?: RequestOptions): Promise<RefundDto>;
|
|
463
|
+
}
|
|
464
|
+
export declare class PaymentMethodTypesResource {
|
|
465
|
+
private readonly http;
|
|
466
|
+
constructor(http: HttpClient);
|
|
467
|
+
/**
|
|
468
|
+
* Get store payment method types
|
|
469
|
+
*
|
|
470
|
+
* Retrieves all payment method types associated with a store
|
|
471
|
+
*/
|
|
472
|
+
getStorePaymentMethodTypes(opts?: RequestOptions): Promise<Array<PaymentMethodTypeDto>>;
|
|
473
|
+
/**
|
|
474
|
+
* Request approval for a store payment method type
|
|
475
|
+
*
|
|
476
|
+
* Requests approval to use a payment method type that requires manual review
|
|
477
|
+
*/
|
|
478
|
+
requestStorePaymentMethodTypeApproval(paymentMethodTypeId: string, opts?: RequestOptions): Promise<void>;
|
|
479
|
+
/**
|
|
480
|
+
* Toggle a store payment method type
|
|
481
|
+
*
|
|
482
|
+
* Enables or disabled a payment method type for a store
|
|
483
|
+
*/
|
|
484
|
+
toggleStorePaymentMethodType(paymentMethodTypeId: string, body: ToggleStorePaymentMethodTypeRequestDto, opts?: RequestOptions): Promise<void>;
|
|
485
|
+
}
|
|
486
|
+
export declare class PaymentsResource {
|
|
487
|
+
private readonly http;
|
|
488
|
+
constructor(http: HttpClient);
|
|
489
|
+
/**
|
|
490
|
+
* Get payment by ID
|
|
491
|
+
*
|
|
492
|
+
* Retrieves a payment by an ID.
|
|
493
|
+
*/
|
|
494
|
+
getPaymentById(paymentId: FlakeId, opts?: RequestOptions): Promise<PaymentDto>;
|
|
495
|
+
/**
|
|
496
|
+
* Get payments
|
|
497
|
+
*
|
|
498
|
+
* Retrieves all payments for the specified store using the filter specified.
|
|
499
|
+
*/
|
|
500
|
+
getPayments(query?: PaymentsGetPaymentsQuery, opts?: RequestOptions): Promise<Array<PaymentDto>>;
|
|
501
|
+
}
|
|
502
|
+
export declare class PaymentSettingsResource {
|
|
503
|
+
private readonly http;
|
|
504
|
+
constructor(http: HttpClient);
|
|
505
|
+
/**
|
|
506
|
+
* Get store payment settings
|
|
507
|
+
*
|
|
508
|
+
* Retrieves payment settings for a store.
|
|
509
|
+
*/
|
|
510
|
+
getStorePaymentSettings(opts?: RequestOptions): Promise<StorePaymentSettingsDto>;
|
|
511
|
+
/**
|
|
512
|
+
* Updates store payment settings
|
|
513
|
+
*
|
|
514
|
+
* Updates payment settings for a store.
|
|
515
|
+
*/
|
|
516
|
+
updateStorePaymentSettings(body?: UpdateStorePaymentSettingsDto, opts?: RequestOptions): Promise<void>;
|
|
517
|
+
}
|
|
518
|
+
export declare class ProductDependentMigrationsResource {
|
|
519
|
+
private readonly http;
|
|
520
|
+
constructor(http: HttpClient);
|
|
521
|
+
createProductDependentMigration(productId: FlakeId, body: CreateProductDependentMigrationRequestDto, opts?: RequestOptions): Promise<ProductDependentMigrationDto>;
|
|
522
|
+
getProductDependentMigrationById(productDependentMigrationId: FlakeId, opts?: RequestOptions): Promise<ProductDependentMigrationDto>;
|
|
523
|
+
getProductDependentMigrationEstimate(productId: FlakeId, opts?: RequestOptions): Promise<Array<ProductDependentMigrationEstimateVersionDto>>;
|
|
524
|
+
getProductDependentMigrations(productId: FlakeId, query?: ProductDependentMigrationsGetProductDependentMigrationsQuery, opts?: RequestOptions): Promise<Array<ProductDependentMigrationDto>>;
|
|
525
|
+
}
|
|
526
|
+
export declare class ProductsResource {
|
|
527
|
+
private readonly http;
|
|
528
|
+
constructor(http: HttpClient);
|
|
529
|
+
/**
|
|
530
|
+
* Create product
|
|
531
|
+
*
|
|
532
|
+
* Creates a new product in the specified store.
|
|
533
|
+
* Creating dynamic products while creating a checkout session via this endpoint without prior approval is prohibited and will result in store deactivation per our User Agreement.
|
|
534
|
+
*/
|
|
535
|
+
createProduct(body?: UpsertProductRequestDto, opts?: RequestOptions): Promise<ProductDto>;
|
|
536
|
+
/**
|
|
537
|
+
* Delete product
|
|
538
|
+
*
|
|
539
|
+
* Deletes a product from the specified store.
|
|
540
|
+
* @param productId The ID of the product to delete.
|
|
541
|
+
*/
|
|
542
|
+
deleteProduct(productId: FlakeId, opts?: RequestOptions): Promise<void>;
|
|
543
|
+
/**
|
|
544
|
+
* Get product
|
|
545
|
+
*
|
|
546
|
+
* Retrieves a specific product by ID from the specified store.
|
|
547
|
+
* DO NOT USE THIS ROUTE FOR DISPLAYING PRODUCTS ON YOUR STOREFRONT, use the storefront API instead.
|
|
548
|
+
* @param productId The ID of the product to retrieve.
|
|
549
|
+
*/
|
|
550
|
+
getProduct(productId: FlakeId, opts?: RequestOptions): Promise<ProductDto>;
|
|
551
|
+
/**
|
|
552
|
+
* Get products
|
|
553
|
+
*
|
|
554
|
+
* Retrieves all products for the specified store.
|
|
555
|
+
* DO NOT USE THIS ROUTE FOR DISPLAYING PRODUCTS ON YOUR STOREFRONT, use the storefront API instead!
|
|
556
|
+
*/
|
|
557
|
+
getProducts(query?: ProductsGetProductsQuery, opts?: RequestOptions): Promise<Array<ProductDto>>;
|
|
558
|
+
/**
|
|
559
|
+
* Update product
|
|
560
|
+
*
|
|
561
|
+
* Updates an existing product in the specified store.
|
|
562
|
+
* @param productId The ID of the product to update.
|
|
563
|
+
*/
|
|
564
|
+
updateProduct(productId: FlakeId, body?: UpsertProductRequestDto, opts?: RequestOptions): Promise<ProductDto>;
|
|
565
|
+
/**
|
|
566
|
+
* Update product sort order
|
|
567
|
+
*
|
|
568
|
+
* Updates the sort order of products in the specified store.
|
|
569
|
+
*/
|
|
570
|
+
updateProductSortOrder(body: UpdateProductSortOrderRequestDto, opts?: RequestOptions): Promise<ProductDto | undefined>;
|
|
571
|
+
}
|
|
572
|
+
export declare class RegionalPricingResource {
|
|
573
|
+
private readonly http;
|
|
574
|
+
constructor(http: HttpClient);
|
|
575
|
+
getProductPricingRegions(productId: FlakeId, opts?: RequestOptions): Promise<Array<ProductPricingRegionDto>>;
|
|
576
|
+
getStorePricingRegionGroups(opts?: RequestOptions): Promise<Array<ProductPricingRegionGroupDto>>;
|
|
577
|
+
getStorePricingRegions(opts?: RequestOptions): Promise<Array<ProductPricingRegionDto>>;
|
|
578
|
+
setProductPricingRegionOverride(productId: FlakeId, regionId: string, body?: ProductPricingRegionOverrideDto, opts?: RequestOptions): Promise<void>;
|
|
579
|
+
setStorePricingRegionOverride(regionId: string, body?: StorePricingRegionOverrideDto, opts?: RequestOptions): Promise<void>;
|
|
580
|
+
}
|
|
581
|
+
export declare class SalesResource {
|
|
582
|
+
private readonly http;
|
|
583
|
+
constructor(http: HttpClient);
|
|
584
|
+
/**
|
|
585
|
+
* Create a sale by ID for a store
|
|
586
|
+
*/
|
|
587
|
+
createSale(body: CreateSaleDto, opts?: RequestOptions): Promise<SaleDto>;
|
|
588
|
+
/**
|
|
589
|
+
* Delete a sale by ID for a store
|
|
590
|
+
*/
|
|
591
|
+
deleteSaleById(saleId: FlakeId, opts?: RequestOptions): Promise<void>;
|
|
592
|
+
/**
|
|
593
|
+
* Get a sale by ID for a store
|
|
594
|
+
*/
|
|
595
|
+
getSale(saleId: FlakeId, opts?: RequestOptions): Promise<SaleDto>;
|
|
596
|
+
/**
|
|
597
|
+
* Get sales associated with a store.
|
|
598
|
+
*/
|
|
599
|
+
getSales(opts?: RequestOptions): Promise<Array<SaleDto>>;
|
|
600
|
+
/**
|
|
601
|
+
* Update a sale by ID for a store
|
|
602
|
+
*/
|
|
603
|
+
updateSale(saleId: FlakeId, body?: UpdateSaleDto, opts?: RequestOptions): Promise<SaleDto>;
|
|
604
|
+
}
|
|
605
|
+
export declare class StoreResource {
|
|
606
|
+
private readonly http;
|
|
607
|
+
constructor(http: HttpClient);
|
|
608
|
+
/**
|
|
609
|
+
* Get a store
|
|
610
|
+
*
|
|
611
|
+
* Retrieves a single store by its ID.
|
|
612
|
+
*/
|
|
613
|
+
getStore(opts?: RequestOptions): Promise<StoreDto>;
|
|
614
|
+
/**
|
|
615
|
+
* Get store member permissions
|
|
616
|
+
*
|
|
617
|
+
* Retrieves the resolved permissions map for a specific member of a store.
|
|
618
|
+
*/
|
|
619
|
+
getStoreMemberPermissions(memberId: FlakeId, opts?: RequestOptions): Promise<Record<string, boolean>>;
|
|
620
|
+
/**
|
|
621
|
+
* List store members
|
|
622
|
+
*
|
|
623
|
+
* Retrieves all members who have access to the specified store.
|
|
624
|
+
*/
|
|
625
|
+
getStoreMembers(opts?: RequestOptions): Promise<Array<StoreMemberDto>>;
|
|
626
|
+
/**
|
|
627
|
+
* Get stores
|
|
628
|
+
*
|
|
629
|
+
* Retrieves all stores accessible to the authenticated user or API key.
|
|
630
|
+
*/
|
|
631
|
+
getStores(opts?: RequestOptions): Promise<Array<StoreDto>>;
|
|
632
|
+
/**
|
|
633
|
+
* Remove a store member
|
|
634
|
+
*
|
|
635
|
+
* Removes the specified member from the store, revoking their access.
|
|
636
|
+
*/
|
|
637
|
+
kickStoreMember(memberId: FlakeId, opts?: RequestOptions): Promise<void>;
|
|
638
|
+
/**
|
|
639
|
+
* Update a store
|
|
640
|
+
*
|
|
641
|
+
* Partially updates a store's configuration using the provided fields.
|
|
642
|
+
*/
|
|
643
|
+
updateStore(body?: UpdateStoreDto, opts?: RequestOptions): Promise<StoreDto>;
|
|
644
|
+
/**
|
|
645
|
+
* Update a store member
|
|
646
|
+
*
|
|
647
|
+
* Updates the role assigned to a specific member of the store.
|
|
648
|
+
*/
|
|
649
|
+
updateStoreMember(memberId: FlakeId, body: UpdateStoreMemberDto, opts?: RequestOptions): Promise<void>;
|
|
650
|
+
}
|
|
651
|
+
export declare class SubscriptionsResource {
|
|
652
|
+
private readonly http;
|
|
653
|
+
constructor(http: HttpClient);
|
|
654
|
+
/**
|
|
655
|
+
* Cancel subscription by ID
|
|
656
|
+
*
|
|
657
|
+
* Cancels a subscription for the specified store by the supplied ID.
|
|
658
|
+
* @param subscriptionId The ID of the subscription.
|
|
659
|
+
*/
|
|
660
|
+
cancelSubscription(subscriptionId: FlakeId, body?: CancelSubscriptionRequestDto, opts?: RequestOptions): Promise<void>;
|
|
661
|
+
/**
|
|
662
|
+
* Get subscription by ID
|
|
663
|
+
*
|
|
664
|
+
* Retrieves a subscription for the specified store by the supplied ID.
|
|
665
|
+
* @param subscriptionId The ID of the subscription.
|
|
666
|
+
*/
|
|
667
|
+
getSubscriptionById(subscriptionId: FlakeId, opts?: RequestOptions): Promise<SubscriptionDto>;
|
|
668
|
+
/**
|
|
669
|
+
* Get subscriptions
|
|
670
|
+
*
|
|
671
|
+
* Retrieves all subscriptions for the specified store.
|
|
672
|
+
*/
|
|
673
|
+
getSubscriptions(query?: SubscriptionsGetSubscriptionsQuery, opts?: RequestOptions): Promise<Array<SubscriptionDto>>;
|
|
674
|
+
/**
|
|
675
|
+
* Preview a subscription change
|
|
676
|
+
*
|
|
677
|
+
* Simulates a subscription change and returns the pricing breakdown without creating any records or
|
|
678
|
+
* initiating a payment. Accepts the same request body as `POST change` — see that endpoint for
|
|
679
|
+
* full parameter documentation. Does not return the `pending_payment` field.
|
|
680
|
+
*/
|
|
681
|
+
previewSubscriptionChange(subscriptionId: FlakeId, body: UpdateSubscriptionRequestDto, opts?: RequestOptions): Promise<UpdateSubscriptionResponseDto>;
|
|
682
|
+
/**
|
|
683
|
+
* Stop pending subscription cancellation
|
|
684
|
+
*
|
|
685
|
+
* Stops a pending subscription cancellation for the specified store by the supplied ID.
|
|
686
|
+
* @param subscriptionId The ID of the subscription.
|
|
687
|
+
*/
|
|
688
|
+
stopPendingSubscriptionCancellation(subscriptionId: FlakeId, opts?: RequestOptions): Promise<void>;
|
|
689
|
+
/**
|
|
690
|
+
* Update items on a subscription
|
|
691
|
+
*
|
|
692
|
+
* Updates the subscription lines, including the pricing, on an active subscription. The subscription must not be within 1 hour of its
|
|
693
|
+
* next renewal, and only one change can be pending at a time.
|
|
694
|
+
*
|
|
695
|
+
* **Access**
|
|
696
|
+
*
|
|
697
|
+
* This endpoint requires the Subscription Updates API feature flag to be enabled on your store. Contact
|
|
698
|
+
* PayNow to request access.
|
|
699
|
+
*
|
|
700
|
+
* **Proration behavior**
|
|
701
|
+
*
|
|
702
|
+
* Controlled by the `proration_behavior` field on the request:
|
|
703
|
+
*
|
|
704
|
+
* - `immediate` - the change is applied as soon as possible.
|
|
705
|
+
* Proration is calculated for the remaining period. If the prorated amount is ≥ $0.50 (or equivalent in other currencies), an order is
|
|
706
|
+
* initiated against the subscription's payment method; the change is applied once the payment succeeds.
|
|
707
|
+
* If the prorated amount is below $0.50, no order is created and the change is
|
|
708
|
+
* applied instantly.
|
|
709
|
+
* Only one proration order is allowed per billing cycle - a second immediate change in the same
|
|
710
|
+
* period will be rejected if a proration was already charged.
|
|
711
|
+
* When a payment is triggered, the response will include a `pending_payment` object. The payment result
|
|
712
|
+
* is synchronous - check `pending_payment.declined` to determine whether the charge succeeded. If
|
|
713
|
+
* declined, `pending_payment.decline_code` contains the reason.
|
|
714
|
+
*
|
|
715
|
+
* - `next_billing_period` - no payment is created. The change is queued and will be applied automatically
|
|
716
|
+
* at the start of the next renewal cycle. Ideal for downgrades.
|
|
717
|
+
*
|
|
718
|
+
* - `none` - the change is applied instantly with no proration calculated or charged.
|
|
719
|
+
*
|
|
720
|
+
* **Reverting a pending change**
|
|
721
|
+
*
|
|
722
|
+
* If a `next_billing_period` change is pending and the new request specifies the same product versions
|
|
723
|
+
* that are already on the subscription (i.e. reverting back to the current state), the pending change
|
|
724
|
+
* is canceled rather than rejected. The canceled change record is returned in the response.
|
|
725
|
+
*/
|
|
726
|
+
updateSubscription(subscriptionId: FlakeId, body: UpdateSubscriptionRequestDto, opts?: RequestOptions): Promise<UpdateSubscriptionResponseDto>;
|
|
727
|
+
}
|
|
728
|
+
export declare class TagsResource {
|
|
729
|
+
private readonly http;
|
|
730
|
+
constructor(http: HttpClient);
|
|
731
|
+
/**
|
|
732
|
+
* Create a new tag
|
|
733
|
+
*/
|
|
734
|
+
createTag(body?: UpsertTagRequestDto, opts?: RequestOptions): Promise<TagDto>;
|
|
735
|
+
/**
|
|
736
|
+
* Delete a tag by ID
|
|
737
|
+
*/
|
|
738
|
+
deleteTag(tagId: FlakeId, opts?: RequestOptions): Promise<void>;
|
|
739
|
+
/**
|
|
740
|
+
* Delete tag image
|
|
741
|
+
*
|
|
742
|
+
* Deletes an image for a tag
|
|
743
|
+
*/
|
|
744
|
+
deleteTagImage(tagId: FlakeId, opts?: RequestOptions): Promise<void>;
|
|
745
|
+
/**
|
|
746
|
+
* Finish tag image upload
|
|
747
|
+
*
|
|
748
|
+
* Finishes an image upload for a tag
|
|
749
|
+
*/
|
|
750
|
+
finishTagImageUpload(tagId: FlakeId, body: FinishTagImageUploadUrlRequestDto, opts?: RequestOptions): Promise<void>;
|
|
751
|
+
/**
|
|
752
|
+
* Get a tag by an ID
|
|
753
|
+
*/
|
|
754
|
+
getTag(tagId: FlakeId, opts?: RequestOptions): Promise<TagDto>;
|
|
755
|
+
/**
|
|
756
|
+
* Get upload URL for tag image
|
|
757
|
+
*
|
|
758
|
+
* Gets a pre-signed upload URL for uploading an image to a tag
|
|
759
|
+
*/
|
|
760
|
+
getTagImageUploadUrl(tagId: FlakeId, opts?: RequestOptions): Promise<GetTagImageUploadUrlResponseDto>;
|
|
761
|
+
/**
|
|
762
|
+
* Get all tags for a store
|
|
763
|
+
*/
|
|
764
|
+
getTags(opts?: RequestOptions): Promise<Array<TagDto>>;
|
|
765
|
+
/**
|
|
766
|
+
* Update a tag by ID
|
|
767
|
+
*/
|
|
768
|
+
updateTag(tagId: FlakeId, body?: UpsertTagRequestDto, opts?: RequestOptions): Promise<TagDto>;
|
|
769
|
+
}
|
|
770
|
+
export declare class TierGroupsResource {
|
|
771
|
+
private readonly http;
|
|
772
|
+
constructor(http: HttpClient);
|
|
773
|
+
/**
|
|
774
|
+
* Create a new tier group
|
|
775
|
+
*/
|
|
776
|
+
createTierGroup(body: CreateTierGroupRequestDto, opts?: RequestOptions): Promise<TierGroupDto>;
|
|
777
|
+
/**
|
|
778
|
+
* Delete a tier group by ID
|
|
779
|
+
*/
|
|
780
|
+
deleteTierGroup(tierGroupId: FlakeId, opts?: RequestOptions): Promise<void>;
|
|
781
|
+
/**
|
|
782
|
+
* Get a tier group by ID
|
|
783
|
+
*/
|
|
784
|
+
getTierGroup(tierGroupId: FlakeId, opts?: RequestOptions): Promise<TierGroupDto>;
|
|
785
|
+
/**
|
|
786
|
+
* List all tier groups for a store
|
|
787
|
+
*/
|
|
788
|
+
listTierGroups(opts?: RequestOptions): Promise<Array<TierGroupDto>>;
|
|
789
|
+
/**
|
|
790
|
+
* Update a tier group by ID
|
|
791
|
+
*/
|
|
792
|
+
updateTierGroup(tierGroupId: FlakeId, body: UpdateTierGroupRequestDto, opts?: RequestOptions): Promise<TierGroupDto>;
|
|
793
|
+
}
|
|
794
|
+
export declare class TrialsResource {
|
|
795
|
+
private readonly http;
|
|
796
|
+
constructor(http: HttpClient);
|
|
797
|
+
/**
|
|
798
|
+
* Create trial eligibility override for a customer
|
|
799
|
+
*
|
|
800
|
+
* Creates a new trial eligibility override for the specified customer.
|
|
801
|
+
* @param customerId The ID of the customer to create the trial eligibility override for.
|
|
802
|
+
*/
|
|
803
|
+
createEligibilityOverrideForCustomer(customerId: FlakeId, body: CreateTrialEligibilityOverrideDto, opts?: RequestOptions): Promise<TrialEligibilityOverrideDto>;
|
|
804
|
+
/**
|
|
805
|
+
* Delete trial eligibility override for a customer
|
|
806
|
+
*
|
|
807
|
+
* Deletes an existing trial eligibility override.
|
|
808
|
+
* @param trialEligibilityOverrideId The ID of the trial eligibility override to delete.
|
|
809
|
+
*/
|
|
810
|
+
deleteEligibilityOverrideForCustomer(customerId: string, trialEligibilityOverrideId: FlakeId, opts?: RequestOptions): Promise<void>;
|
|
811
|
+
/**
|
|
812
|
+
* Get trial eligibility overrides for a specific customer
|
|
813
|
+
*
|
|
814
|
+
* Retrieves all trial eligibility overrides for the specified customer.
|
|
815
|
+
* @param customerId The ID of the customer to retrieve trial eligibility overrides for.
|
|
816
|
+
*/
|
|
817
|
+
getEligibilityOverridesForCustomer(customerId: FlakeId, query?: TrialsGetEligibilityOverridesForCustomerQuery, opts?: RequestOptions): Promise<Array<TrialEligibilityOverrideDto>>;
|
|
818
|
+
/**
|
|
819
|
+
* Get a trial by ID for a store
|
|
820
|
+
*/
|
|
821
|
+
getTrial(trialId: FlakeId, opts?: RequestOptions): Promise<TrialDto>;
|
|
822
|
+
/**
|
|
823
|
+
* Get trials for a store
|
|
824
|
+
*/
|
|
825
|
+
getTrials(query?: TrialsGetTrialsQuery, opts?: RequestOptions): Promise<Array<TrialDto>>;
|
|
826
|
+
}
|
|
827
|
+
export declare class UpsellSettingsResource {
|
|
828
|
+
private readonly http;
|
|
829
|
+
constructor(http: HttpClient);
|
|
830
|
+
/**
|
|
831
|
+
* Get store upselling settings
|
|
832
|
+
*
|
|
833
|
+
* Retrieves upselling settings for the store.
|
|
834
|
+
*/
|
|
835
|
+
getStoreUpsellSettings(opts?: RequestOptions): Promise<StoreUpsellSettingsDto>;
|
|
836
|
+
/**
|
|
837
|
+
* Updates store upselling settings
|
|
838
|
+
*
|
|
839
|
+
* Updates upselling settings for a store.
|
|
840
|
+
*/
|
|
841
|
+
updateStoreUpsellSettings(body?: UpdateStoreUpsellSettingsDto, opts?: RequestOptions): Promise<void>;
|
|
842
|
+
}
|
|
843
|
+
export declare class WebhooksResource {
|
|
844
|
+
private readonly http;
|
|
845
|
+
constructor(http: HttpClient);
|
|
846
|
+
createSubscription(body: CreateWebhookDto, opts?: RequestOptions): Promise<WebhookSubscriptionDto>;
|
|
847
|
+
deleteSubscription(webhookId: FlakeId, opts?: RequestOptions): Promise<void>;
|
|
848
|
+
getHistory(webhookId: FlakeId, query?: WebhooksGetHistoryQuery, opts?: RequestOptions): Promise<WebhookHistoryDto>;
|
|
849
|
+
getSubscriptions(opts?: RequestOptions): Promise<Array<WebhookSubscriptionDto>>;
|
|
850
|
+
getVariables(opts?: RequestOptions): Promise<Array<WebhookVariablesDto>>;
|
|
851
|
+
resend(body: ResendWebhookDto, opts?: RequestOptions): Promise<void>;
|
|
852
|
+
updateSubscription(webhookId: FlakeId, body: UpdateWebhookDto, opts?: RequestOptions): Promise<WebhookSubscriptionDto>;
|
|
853
|
+
}
|
|
854
|
+
/** Typed client for the PayNow management API. */
|
|
855
|
+
export declare class ManagementClient {
|
|
856
|
+
/** Escape hatch for endpoints this SDK does not model. */
|
|
857
|
+
readonly $http: HttpClient;
|
|
858
|
+
readonly affiliateLinks: AffiliateLinksResource;
|
|
859
|
+
readonly bans: BansResource;
|
|
860
|
+
readonly checkout: CheckoutResource;
|
|
861
|
+
readonly coupons: CouponsResource;
|
|
862
|
+
readonly customer_portal_sessions: CustomerPortalSessionsResource;
|
|
863
|
+
readonly customers: CustomersResource;
|
|
864
|
+
readonly customVariables: CustomVariablesResource;
|
|
865
|
+
readonly dashboard: DashboardResource;
|
|
866
|
+
readonly dataMigrations: DataMigrationsResource;
|
|
867
|
+
readonly delivery: DeliveryResource;
|
|
868
|
+
readonly discord: DiscordResource;
|
|
869
|
+
readonly downloadableFiles: DownloadableFilesResource;
|
|
870
|
+
readonly gameServers: GameServersResource;
|
|
871
|
+
readonly giftcards: GiftcardsResource;
|
|
872
|
+
readonly globalCommands: GlobalCommandsResource;
|
|
873
|
+
readonly invoices: InvoicesResource;
|
|
874
|
+
readonly marketing: MarketingResource;
|
|
875
|
+
readonly navlinks: NavlinksResource;
|
|
876
|
+
readonly orders: OrdersResource;
|
|
877
|
+
readonly paymentMethodTypes: PaymentMethodTypesResource;
|
|
878
|
+
readonly payments: PaymentsResource;
|
|
879
|
+
readonly paymentSettings: PaymentSettingsResource;
|
|
880
|
+
readonly productDependentMigrations: ProductDependentMigrationsResource;
|
|
881
|
+
readonly products: ProductsResource;
|
|
882
|
+
readonly regionalPricing: RegionalPricingResource;
|
|
883
|
+
readonly sales: SalesResource;
|
|
884
|
+
readonly store: StoreResource;
|
|
885
|
+
readonly subscriptions: SubscriptionsResource;
|
|
886
|
+
readonly tags: TagsResource;
|
|
887
|
+
readonly tierGroups: TierGroupsResource;
|
|
888
|
+
readonly trials: TrialsResource;
|
|
889
|
+
readonly upsellSettings: UpsellSettingsResource;
|
|
890
|
+
readonly webhooks: WebhooksResource;
|
|
891
|
+
constructor(http: HttpClient);
|
|
892
|
+
}
|
|
893
|
+
/** Options accepted by {@link createManagementClient}. */
|
|
894
|
+
export interface ManagementClientOptions extends ClientOptions {
|
|
895
|
+
/** An API key generated in the PayNow dashboard. */
|
|
896
|
+
apiKey: string;
|
|
897
|
+
/** The Flake ID of the store every request is scoped to. */
|
|
898
|
+
storeId: string;
|
|
899
|
+
}
|
|
900
|
+
/** Creates a ManagementClient that authenticates and scopes every request. */
|
|
901
|
+
export declare function createManagementClient(options: ManagementClientOptions): ManagementClient;
|
|
902
|
+
//# sourceMappingURL=client.d.ts.map
|