@paynow-gg/typescript-sdk 1.0.1 → 1.0.6
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/README.md +4 -4
- package/dist/client.d.ts +71 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/client.js +51 -0
- package/dist/client.js.map +1 -0
- package/dist/errors.d.ts +7 -0
- package/dist/errors.d.ts.map +1 -0
- package/dist/errors.js +14 -0
- package/dist/errors.js.map +1 -0
- package/dist/generate.d.ts +2 -0
- package/dist/generate.d.ts.map +1 -0
- package/dist/generate.js +97 -0
- package/dist/generate.js.map +1 -0
- package/dist/generated/management.d.ts +9173 -0
- package/dist/generated/management.d.ts.map +1 -0
- package/dist/generated/management.js +510 -0
- package/dist/generated/management.js.map +1 -0
- package/dist/generated/storefront.d.ts +1660 -0
- package/dist/generated/storefront.d.ts.map +1 -0
- package/dist/generated/storefront.js +62 -0
- package/dist/generated/storefront.js.map +1 -0
- package/dist/index.d.ts +4 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +7 -5
- package/dist/index.js.map +1 -1
- package/dist/management.d.ts +6 -21
- package/dist/management.d.ts.map +1 -1
- package/dist/management.js +8 -58
- package/dist/management.js.map +1 -1
- package/dist/storefront.d.ts +6 -20
- package/dist/storefront.d.ts.map +1 -1
- package/dist/storefront.js +9 -59
- package/dist/storefront.js.map +1 -1
- package/package.json +5 -4
- package/dist/base-api.d.ts +0 -58
- package/dist/base-api.d.ts.map +0 -1
- package/dist/base-api.js +0 -103
- package/dist/base-api.js.map +0 -1
- package/dist/management-client/client/client.d.ts +0 -3
- package/dist/management-client/client/client.d.ts.map +0 -1
- package/dist/management-client/client/client.js +0 -100
- package/dist/management-client/client/client.js.map +0 -1
- package/dist/management-client/client/index.d.ts +0 -8
- package/dist/management-client/client/index.d.ts.map +0 -1
- package/dist/management-client/client/index.js +0 -14
- package/dist/management-client/client/index.js.map +0 -1
- package/dist/management-client/client/types.d.ts +0 -94
- package/dist/management-client/client/types.d.ts.map +0 -1
- package/dist/management-client/client/types.js +0 -3
- package/dist/management-client/client/types.js.map +0 -1
- package/dist/management-client/client/utils.d.ts +0 -21
- package/dist/management-client/client/utils.d.ts.map +0 -1
- package/dist/management-client/client/utils.js +0 -226
- package/dist/management-client/client/utils.js.map +0 -1
- package/dist/management-client/client.gen.d.ts +0 -13
- package/dist/management-client/client.gen.d.ts.map +0 -1
- package/dist/management-client/client.gen.js +0 -9
- package/dist/management-client/client.gen.js.map +0 -1
- package/dist/management-client/core/auth.d.ts +0 -19
- package/dist/management-client/core/auth.d.ts.map +0 -1
- package/dist/management-client/core/auth.js +0 -18
- package/dist/management-client/core/auth.js.map +0 -1
- package/dist/management-client/core/bodySerializer.d.ts +0 -18
- package/dist/management-client/core/bodySerializer.d.ts.map +0 -1
- package/dist/management-client/core/bodySerializer.js +0 -57
- package/dist/management-client/core/bodySerializer.js.map +0 -1
- package/dist/management-client/core/params.d.ts +0 -24
- package/dist/management-client/core/params.d.ts.map +0 -1
- package/dist/management-client/core/params.js +0 -92
- package/dist/management-client/core/params.js.map +0 -1
- package/dist/management-client/core/pathSerializer.d.ts +0 -34
- package/dist/management-client/core/pathSerializer.d.ts.map +0 -1
- package/dist/management-client/core/pathSerializer.js +0 -123
- package/dist/management-client/core/pathSerializer.js.map +0 -1
- package/dist/management-client/core/types.d.ts +0 -74
- package/dist/management-client/core/types.d.ts.map +0 -1
- package/dist/management-client/core/types.js +0 -3
- package/dist/management-client/core/types.js.map +0 -1
- package/dist/management-client/index.d.ts +0 -3
- package/dist/management-client/index.d.ts.map +0 -1
- package/dist/management-client/index.js +0 -20
- package/dist/management-client/index.js.map +0 -1
- package/dist/management-client/sdk.gen.d.ts +0 -482
- package/dist/management-client/sdk.gen.d.ts.map +0 -1
- package/dist/management-client/sdk.gen.js +0 -2169
- package/dist/management-client/sdk.gen.js.map +0 -1
- package/dist/management-client/types.gen.d.ts +0 -6676
- package/dist/management-client/types.gen.d.ts.map +0 -1
- package/dist/management-client/types.gen.js +0 -380
- package/dist/management-client/types.gen.js.map +0 -1
- package/dist/storefront-client/client/client.d.ts +0 -3
- package/dist/storefront-client/client/client.d.ts.map +0 -1
- package/dist/storefront-client/client/client.js +0 -100
- package/dist/storefront-client/client/client.js.map +0 -1
- package/dist/storefront-client/client/index.d.ts +0 -8
- package/dist/storefront-client/client/index.d.ts.map +0 -1
- package/dist/storefront-client/client/index.js +0 -14
- package/dist/storefront-client/client/index.js.map +0 -1
- package/dist/storefront-client/client/types.d.ts +0 -94
- package/dist/storefront-client/client/types.d.ts.map +0 -1
- package/dist/storefront-client/client/types.js +0 -3
- package/dist/storefront-client/client/types.js.map +0 -1
- package/dist/storefront-client/client/utils.d.ts +0 -21
- package/dist/storefront-client/client/utils.d.ts.map +0 -1
- package/dist/storefront-client/client/utils.js +0 -226
- package/dist/storefront-client/client/utils.js.map +0 -1
- package/dist/storefront-client/client.gen.d.ts +0 -13
- package/dist/storefront-client/client.gen.d.ts.map +0 -1
- package/dist/storefront-client/client.gen.js +0 -9
- package/dist/storefront-client/client.gen.js.map +0 -1
- package/dist/storefront-client/core/auth.d.ts +0 -19
- package/dist/storefront-client/core/auth.d.ts.map +0 -1
- package/dist/storefront-client/core/auth.js +0 -18
- package/dist/storefront-client/core/auth.js.map +0 -1
- package/dist/storefront-client/core/bodySerializer.d.ts +0 -18
- package/dist/storefront-client/core/bodySerializer.d.ts.map +0 -1
- package/dist/storefront-client/core/bodySerializer.js +0 -57
- package/dist/storefront-client/core/bodySerializer.js.map +0 -1
- package/dist/storefront-client/core/params.d.ts +0 -24
- package/dist/storefront-client/core/params.d.ts.map +0 -1
- package/dist/storefront-client/core/params.js +0 -92
- package/dist/storefront-client/core/params.js.map +0 -1
- package/dist/storefront-client/core/pathSerializer.d.ts +0 -34
- package/dist/storefront-client/core/pathSerializer.d.ts.map +0 -1
- package/dist/storefront-client/core/pathSerializer.js +0 -123
- package/dist/storefront-client/core/pathSerializer.js.map +0 -1
- package/dist/storefront-client/core/types.d.ts +0 -74
- package/dist/storefront-client/core/types.d.ts.map +0 -1
- package/dist/storefront-client/core/types.js +0 -3
- package/dist/storefront-client/core/types.js.map +0 -1
- package/dist/storefront-client/index.d.ts +0 -3
- package/dist/storefront-client/index.d.ts.map +0 -1
- package/dist/storefront-client/index.js +0 -20
- package/dist/storefront-client/index.js.map +0 -1
- package/dist/storefront-client/sdk.gen.d.ts +0 -100
- package/dist/storefront-client/sdk.gen.d.ts.map +0 -1
- package/dist/storefront-client/sdk.gen.js +0 -296
- package/dist/storefront-client/sdk.gen.js.map +0 -1
- package/dist/storefront-client/types.gen.d.ts +0 -1410
- package/dist/storefront-client/types.gen.d.ts.map +0 -1
- package/dist/storefront-client/types.gen.js +0 -58
- package/dist/storefront-client/types.gen.js.map +0 -1
- package/dist/types.d.ts +0 -49
- package/dist/types.d.ts.map +0 -1
- package/dist/types.js +0 -9
- package/dist/types.js.map +0 -1
|
@@ -0,0 +1,1660 @@
|
|
|
1
|
+
export interface paths {
|
|
2
|
+
"/v1/store/cart": {
|
|
3
|
+
parameters: {
|
|
4
|
+
query?: never;
|
|
5
|
+
header?: never;
|
|
6
|
+
path?: never;
|
|
7
|
+
cookie?: never;
|
|
8
|
+
};
|
|
9
|
+
/**
|
|
10
|
+
* Get cart
|
|
11
|
+
* @description Retrieves the current customer's shopping cart.
|
|
12
|
+
*/
|
|
13
|
+
get: operations["Cart_GetCart"];
|
|
14
|
+
put?: never;
|
|
15
|
+
post?: never;
|
|
16
|
+
/**
|
|
17
|
+
* Clear cart
|
|
18
|
+
* @description Clears all items from the customer's shopping cart.
|
|
19
|
+
*/
|
|
20
|
+
delete: operations["Cart_ClearCart"];
|
|
21
|
+
options?: never;
|
|
22
|
+
head?: never;
|
|
23
|
+
patch?: never;
|
|
24
|
+
trace?: never;
|
|
25
|
+
};
|
|
26
|
+
"/v1/store/cart/lines": {
|
|
27
|
+
parameters: {
|
|
28
|
+
query?: never;
|
|
29
|
+
header?: never;
|
|
30
|
+
path?: never;
|
|
31
|
+
cookie?: never;
|
|
32
|
+
};
|
|
33
|
+
get?: never;
|
|
34
|
+
/**
|
|
35
|
+
* Add product to cart
|
|
36
|
+
* @description Adds a product to the cart or updates the quantity of an existing product.
|
|
37
|
+
* When increment parameter is "true" or "1", the specified quantity will be added to any existing quantity.
|
|
38
|
+
* Otherwise, the quantity will be set to the specified value, replacing any existing quantity.
|
|
39
|
+
*/
|
|
40
|
+
put: operations["Cart_AddLine"];
|
|
41
|
+
post?: never;
|
|
42
|
+
delete?: never;
|
|
43
|
+
options?: never;
|
|
44
|
+
head?: never;
|
|
45
|
+
patch?: never;
|
|
46
|
+
trace?: never;
|
|
47
|
+
};
|
|
48
|
+
"/v1/store/cart/checkout": {
|
|
49
|
+
parameters: {
|
|
50
|
+
query?: never;
|
|
51
|
+
header?: never;
|
|
52
|
+
path?: never;
|
|
53
|
+
cookie?: never;
|
|
54
|
+
};
|
|
55
|
+
get?: never;
|
|
56
|
+
put?: never;
|
|
57
|
+
/**
|
|
58
|
+
* Create a cart checkout session
|
|
59
|
+
* @description Creates a checkout session from the contents of the cart.
|
|
60
|
+
* After creating the checkout session, redirect the customer to the `url` returned.
|
|
61
|
+
*/
|
|
62
|
+
post: operations["Cart_CreateCartCheckout"];
|
|
63
|
+
delete?: never;
|
|
64
|
+
options?: never;
|
|
65
|
+
head?: never;
|
|
66
|
+
patch?: never;
|
|
67
|
+
trace?: never;
|
|
68
|
+
};
|
|
69
|
+
"/v1/checkouts": {
|
|
70
|
+
parameters: {
|
|
71
|
+
query?: never;
|
|
72
|
+
header?: never;
|
|
73
|
+
path?: never;
|
|
74
|
+
cookie?: never;
|
|
75
|
+
};
|
|
76
|
+
get?: never;
|
|
77
|
+
put?: never;
|
|
78
|
+
/**
|
|
79
|
+
* Create a checkout session
|
|
80
|
+
* @description Creates a checkout session using a Customer token.
|
|
81
|
+
* After creating the checkout session, redirect the customer to the `url` returned.
|
|
82
|
+
*/
|
|
83
|
+
post: operations["Checkout_CreateCheckoutSession"];
|
|
84
|
+
delete?: never;
|
|
85
|
+
options?: never;
|
|
86
|
+
head?: never;
|
|
87
|
+
patch?: never;
|
|
88
|
+
trace?: never;
|
|
89
|
+
};
|
|
90
|
+
"/v1/store/customer": {
|
|
91
|
+
parameters: {
|
|
92
|
+
query?: never;
|
|
93
|
+
header?: never;
|
|
94
|
+
path?: never;
|
|
95
|
+
cookie?: never;
|
|
96
|
+
};
|
|
97
|
+
/**
|
|
98
|
+
* Get current customer
|
|
99
|
+
* @description Retrieves the current customer from the passed Customer token.
|
|
100
|
+
*/
|
|
101
|
+
get: operations["Customer_GetStorefrontCustomer"];
|
|
102
|
+
put?: never;
|
|
103
|
+
post?: never;
|
|
104
|
+
delete?: never;
|
|
105
|
+
options?: never;
|
|
106
|
+
head?: never;
|
|
107
|
+
patch?: never;
|
|
108
|
+
trace?: never;
|
|
109
|
+
};
|
|
110
|
+
"/v1/store/customer/giftcards/lookup/{code}": {
|
|
111
|
+
parameters: {
|
|
112
|
+
query?: never;
|
|
113
|
+
header?: never;
|
|
114
|
+
path?: never;
|
|
115
|
+
cookie?: never;
|
|
116
|
+
};
|
|
117
|
+
/** Lookup a gift card by the code */
|
|
118
|
+
get: operations["Customer_GetStorefrontGiftCard"];
|
|
119
|
+
put?: never;
|
|
120
|
+
post?: never;
|
|
121
|
+
delete?: never;
|
|
122
|
+
options?: never;
|
|
123
|
+
head?: never;
|
|
124
|
+
patch?: never;
|
|
125
|
+
trace?: never;
|
|
126
|
+
};
|
|
127
|
+
"/v1/store/customer/command-delivery": {
|
|
128
|
+
parameters: {
|
|
129
|
+
query?: never;
|
|
130
|
+
header?: never;
|
|
131
|
+
path?: never;
|
|
132
|
+
cookie?: never;
|
|
133
|
+
};
|
|
134
|
+
/** Get storefront customer delivery items */
|
|
135
|
+
get: operations["Customer_RootGetStorefrontCustomerDeliveryItems"];
|
|
136
|
+
put?: never;
|
|
137
|
+
post?: never;
|
|
138
|
+
delete?: never;
|
|
139
|
+
options?: never;
|
|
140
|
+
head?: never;
|
|
141
|
+
patch?: never;
|
|
142
|
+
trace?: never;
|
|
143
|
+
};
|
|
144
|
+
"/v1/stores/{storeId}/product_versions/discord_actions": {
|
|
145
|
+
parameters: {
|
|
146
|
+
query?: never;
|
|
147
|
+
header?: never;
|
|
148
|
+
path?: never;
|
|
149
|
+
cookie?: never;
|
|
150
|
+
};
|
|
151
|
+
get: operations["Discord_DoProductsHaveDiscordActions"];
|
|
152
|
+
put?: never;
|
|
153
|
+
post?: never;
|
|
154
|
+
delete?: never;
|
|
155
|
+
options?: never;
|
|
156
|
+
head?: never;
|
|
157
|
+
patch?: never;
|
|
158
|
+
trace?: never;
|
|
159
|
+
};
|
|
160
|
+
"/v1/store/navlinks": {
|
|
161
|
+
parameters: {
|
|
162
|
+
query?: never;
|
|
163
|
+
header?: never;
|
|
164
|
+
path?: never;
|
|
165
|
+
cookie?: never;
|
|
166
|
+
};
|
|
167
|
+
/**
|
|
168
|
+
* Get navlinks
|
|
169
|
+
* @description Retrieves the store's navlink structure used for navigation.
|
|
170
|
+
*/
|
|
171
|
+
get: operations["Navlinks_GetStorefrontNavLinks"];
|
|
172
|
+
put?: never;
|
|
173
|
+
post?: never;
|
|
174
|
+
delete?: never;
|
|
175
|
+
options?: never;
|
|
176
|
+
head?: never;
|
|
177
|
+
patch?: never;
|
|
178
|
+
trace?: never;
|
|
179
|
+
};
|
|
180
|
+
"/v1/store/products": {
|
|
181
|
+
parameters: {
|
|
182
|
+
query?: never;
|
|
183
|
+
header?: never;
|
|
184
|
+
path?: never;
|
|
185
|
+
cookie?: never;
|
|
186
|
+
};
|
|
187
|
+
/**
|
|
188
|
+
* Get products
|
|
189
|
+
* @description Retrieves the available products. To make sure all VAT rates are properly displayed, pass in the IP headers as instructed.
|
|
190
|
+
*/
|
|
191
|
+
get: operations["Products_GetStorefrontProducts"];
|
|
192
|
+
put?: never;
|
|
193
|
+
post?: never;
|
|
194
|
+
delete?: never;
|
|
195
|
+
options?: never;
|
|
196
|
+
head?: never;
|
|
197
|
+
patch?: never;
|
|
198
|
+
trace?: never;
|
|
199
|
+
};
|
|
200
|
+
"/v1/store/products/{idOrSlug}": {
|
|
201
|
+
parameters: {
|
|
202
|
+
query?: never;
|
|
203
|
+
header?: never;
|
|
204
|
+
path?: never;
|
|
205
|
+
cookie?: never;
|
|
206
|
+
};
|
|
207
|
+
/**
|
|
208
|
+
* Get product by ID or slug
|
|
209
|
+
* @description Retrieves a product by an ID or a slug. To make sure all VAT rates are properly displayed, pass in the IP headers as instructed.
|
|
210
|
+
*/
|
|
211
|
+
get: operations["Products_GetStorefrontProductByIdOrSlug"];
|
|
212
|
+
put?: never;
|
|
213
|
+
post?: never;
|
|
214
|
+
delete?: never;
|
|
215
|
+
options?: never;
|
|
216
|
+
head?: never;
|
|
217
|
+
patch?: never;
|
|
218
|
+
trace?: never;
|
|
219
|
+
};
|
|
220
|
+
"/v1/store": {
|
|
221
|
+
parameters: {
|
|
222
|
+
query?: never;
|
|
223
|
+
header?: never;
|
|
224
|
+
path?: never;
|
|
225
|
+
cookie?: never;
|
|
226
|
+
};
|
|
227
|
+
/**
|
|
228
|
+
* Get current store
|
|
229
|
+
* @description Retrieves a store by the passed in x-paynow-store-id or Customer token.
|
|
230
|
+
*/
|
|
231
|
+
get: operations["Store_GetStorefrontStore"];
|
|
232
|
+
put?: never;
|
|
233
|
+
post?: never;
|
|
234
|
+
delete?: never;
|
|
235
|
+
options?: never;
|
|
236
|
+
head?: never;
|
|
237
|
+
patch?: never;
|
|
238
|
+
trace?: never;
|
|
239
|
+
};
|
|
240
|
+
"/v1/store/tags": {
|
|
241
|
+
parameters: {
|
|
242
|
+
query?: never;
|
|
243
|
+
header?: never;
|
|
244
|
+
path?: never;
|
|
245
|
+
cookie?: never;
|
|
246
|
+
};
|
|
247
|
+
/**
|
|
248
|
+
* Get tags
|
|
249
|
+
* @description Retrieves the store's tags.
|
|
250
|
+
*/
|
|
251
|
+
get: operations["Tags_GetStorefrontTags"];
|
|
252
|
+
put?: never;
|
|
253
|
+
post?: never;
|
|
254
|
+
delete?: never;
|
|
255
|
+
options?: never;
|
|
256
|
+
head?: never;
|
|
257
|
+
patch?: never;
|
|
258
|
+
trace?: never;
|
|
259
|
+
};
|
|
260
|
+
}
|
|
261
|
+
export type webhooks = Record<string, never>;
|
|
262
|
+
export interface components {
|
|
263
|
+
schemas: {
|
|
264
|
+
/** @description Represents a customer's shopping cart */
|
|
265
|
+
CartDto: {
|
|
266
|
+
store_id: components["schemas"]["FlakeId"];
|
|
267
|
+
customer_id: components["schemas"]["FlakeId"];
|
|
268
|
+
/** @description The line items in the cart */
|
|
269
|
+
lines: components["schemas"]["CartLineDto"][];
|
|
270
|
+
/**
|
|
271
|
+
* Format: int64
|
|
272
|
+
* @description The total price of all items in the cart in the smallest currency unit (e.g., cents)
|
|
273
|
+
*/
|
|
274
|
+
total: number;
|
|
275
|
+
/** @description The currency code (e.g., usd, eur, gbp) */
|
|
276
|
+
currency: string;
|
|
277
|
+
};
|
|
278
|
+
CartLineCustomVariableDto: {
|
|
279
|
+
id: components["schemas"]["FlakeId"];
|
|
280
|
+
/** @description The display name of the custom variable */
|
|
281
|
+
name: string;
|
|
282
|
+
/** @description The unique identifier string for the custom variable */
|
|
283
|
+
identifier: string;
|
|
284
|
+
/** @description The description of the custom variable */
|
|
285
|
+
description: string;
|
|
286
|
+
type: components["schemas"]["CustomVariableType"];
|
|
287
|
+
/** @description The selected value of the custom variable */
|
|
288
|
+
value: string;
|
|
289
|
+
/** @description The collection of available options for this custom variable. Only present for dropdown type */
|
|
290
|
+
options: components["schemas"]["StorefrontCustomVariableOptionDto"][];
|
|
291
|
+
selected_option?: components["schemas"]["StorefrontCustomVariableOptionDto"];
|
|
292
|
+
};
|
|
293
|
+
/** @description Represents a line item in a cart */
|
|
294
|
+
CartLineDto: {
|
|
295
|
+
/** @description The unique key for this line item */
|
|
296
|
+
line_key: string;
|
|
297
|
+
product_id: components["schemas"]["FlakeId"];
|
|
298
|
+
/** @description The name of the product */
|
|
299
|
+
name: string;
|
|
300
|
+
/** @description The slug of the product */
|
|
301
|
+
slug: string;
|
|
302
|
+
/**
|
|
303
|
+
* Format: int64
|
|
304
|
+
* @description The price of the product in the smallest currency unit (e.g., cents)
|
|
305
|
+
*/
|
|
306
|
+
price: number;
|
|
307
|
+
/**
|
|
308
|
+
* Format: int32
|
|
309
|
+
* @description The quantity of this product in the cart
|
|
310
|
+
*/
|
|
311
|
+
quantity: number;
|
|
312
|
+
/** @description Indicates whether this line item should be a subscription */
|
|
313
|
+
subscription: boolean;
|
|
314
|
+
/** @description Indicates whether this line will be trialied by the customer. */
|
|
315
|
+
trial: boolean;
|
|
316
|
+
/** @description The URL to the product image */
|
|
317
|
+
image_url?: string | null;
|
|
318
|
+
selected_gameserver_id?: components["schemas"]["FlakeId"];
|
|
319
|
+
selected_gameserver?: components["schemas"]["StorefrontGameServerDto"];
|
|
320
|
+
pricing: components["schemas"]["StorefrontProductPricingDetailsDto"];
|
|
321
|
+
/** @description Selected custom variables for this cart line. */
|
|
322
|
+
custom_variables: components["schemas"]["CartLineCustomVariableDto"][];
|
|
323
|
+
};
|
|
324
|
+
/** @description Request to create a new checkout session from a cart */
|
|
325
|
+
CreateCartCheckoutSessionDto: {
|
|
326
|
+
coupon_id?: components["schemas"]["FlakeId"];
|
|
327
|
+
/** @description Optional affiliate code to track referrals */
|
|
328
|
+
affiliate_code?: string | null;
|
|
329
|
+
/** @description Optional URL to redirect to after successful checkout */
|
|
330
|
+
return_url?: string | null;
|
|
331
|
+
/** @description Optional URL to redirect to if checkout is canceled */
|
|
332
|
+
cancel_url?: string | null;
|
|
333
|
+
/** @description Whether to automatically redirect the customer (return_url must be set) */
|
|
334
|
+
auto_redirect: boolean;
|
|
335
|
+
/** @description Optional metadata to associate with the checkout session.
|
|
336
|
+
* Do not store any sensitive information here. */
|
|
337
|
+
metadata?: {
|
|
338
|
+
[key: string]: string;
|
|
339
|
+
} | null;
|
|
340
|
+
};
|
|
341
|
+
/** @description Represents a line item in a checkout session request */
|
|
342
|
+
CreateCheckoutSessionLineDto: {
|
|
343
|
+
product_id: components["schemas"]["FlakeId"];
|
|
344
|
+
/** @description Determines whether this line should create a subscription */
|
|
345
|
+
subscription: boolean;
|
|
346
|
+
/** @description Indicates whether the product should be trialed */
|
|
347
|
+
trial?: boolean | null;
|
|
348
|
+
gift_to?: components["schemas"]["CustomerPlatformAccountDto"];
|
|
349
|
+
gift_to_customer_id?: components["schemas"]["FlakeId"];
|
|
350
|
+
/**
|
|
351
|
+
* Format: int32
|
|
352
|
+
* @description The quantity of this product to purchase
|
|
353
|
+
*/
|
|
354
|
+
quantity: number;
|
|
355
|
+
selected_gameserver_id?: components["schemas"]["FlakeId"];
|
|
356
|
+
/** @description Optional metadata to associate with the checkout session line.
|
|
357
|
+
* Do not store any sensitive information here. */
|
|
358
|
+
metadata?: {
|
|
359
|
+
[key: string]: string;
|
|
360
|
+
} | null;
|
|
361
|
+
/** @description Key-value pair mapping custom variable identifiers to their selected values.
|
|
362
|
+
* Required only when the product includes custom variables. */
|
|
363
|
+
custom_variables?: {
|
|
364
|
+
[key: string]: string;
|
|
365
|
+
} | null;
|
|
366
|
+
};
|
|
367
|
+
/** @description Request to create a new checkout session */
|
|
368
|
+
CreateCheckoutSessionRequestDto: {
|
|
369
|
+
/** @description The line items to include in the checkout. */
|
|
370
|
+
lines: components["schemas"]["CreateCheckoutSessionLineDto"][];
|
|
371
|
+
/**
|
|
372
|
+
* @deprecated
|
|
373
|
+
* @description Whether this checkout creates a subscription.
|
|
374
|
+
* DEPRECATED: Use 'subscription' field in 'lines' array objects instead.
|
|
375
|
+
*/
|
|
376
|
+
subscription: boolean;
|
|
377
|
+
coupon_id?: components["schemas"]["FlakeId"];
|
|
378
|
+
/** @description Optional affiliate code to track referrals */
|
|
379
|
+
affiliate_code?: string | null;
|
|
380
|
+
/** @description Optional URL to redirect to after successful checkout */
|
|
381
|
+
return_url?: string | null;
|
|
382
|
+
/** @description Optional URL to redirect to if checkout is canceled */
|
|
383
|
+
cancel_url?: string | null;
|
|
384
|
+
/** @description Whether to automatically redirect the customer (return_url must be set) */
|
|
385
|
+
auto_redirect: boolean;
|
|
386
|
+
/** @description Optional metadata to associate with the checkout session.
|
|
387
|
+
* Do not store any sensitive information here. */
|
|
388
|
+
metadata?: {
|
|
389
|
+
[key: string]: string;
|
|
390
|
+
} | null;
|
|
391
|
+
};
|
|
392
|
+
/** @description Response after creating a checkout session */
|
|
393
|
+
CreateCheckoutSessionResponseDto: {
|
|
394
|
+
id: components["schemas"]["FlakeId"];
|
|
395
|
+
/** @description The token for the checkout session */
|
|
396
|
+
token: string;
|
|
397
|
+
/** @description The URL to redirect the customer to complete checkout */
|
|
398
|
+
url: string;
|
|
399
|
+
};
|
|
400
|
+
/**
|
|
401
|
+
* @description Defines the type of input method for a custom variable.
|
|
402
|
+
* @enum {string}
|
|
403
|
+
*/
|
|
404
|
+
CustomVariableType: "dropdown" | "text" | "number";
|
|
405
|
+
/** @description Represents a customer in the PayNow system with their associated profiles and metadata. */
|
|
406
|
+
CustomerDto: {
|
|
407
|
+
id: components["schemas"]["FlakeId"];
|
|
408
|
+
store_id: components["schemas"]["FlakeId"];
|
|
409
|
+
profile?: components["schemas"]["GenericProfileDto"];
|
|
410
|
+
steam_id?: components["schemas"]["SteamId"];
|
|
411
|
+
steam?: components["schemas"]["SteamProfileDto"];
|
|
412
|
+
/**
|
|
413
|
+
* @description The customer's Minecraft UUID, if they have linked their Minecraft account.
|
|
414
|
+
* Not set for offline Minecraft stores. If the platform type is Minecraft - Geyser,
|
|
415
|
+
* and the profile is a bedrock account, this will be a UUID generated from the Xbox XUID.
|
|
416
|
+
* @example f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2
|
|
417
|
+
*/
|
|
418
|
+
minecraft_uuid?: string | null;
|
|
419
|
+
minecraft?: components["schemas"]["MinecraftProfileDto"];
|
|
420
|
+
/** @description The customer's Xbox XUID, if available. */
|
|
421
|
+
xbox_xuid?: string | null;
|
|
422
|
+
minecraft_platform?: components["schemas"]["CustomerMinecraftPlatform"];
|
|
423
|
+
/**
|
|
424
|
+
* @description The display name for the customer.
|
|
425
|
+
* @example m0uka
|
|
426
|
+
*/
|
|
427
|
+
name?: string | null;
|
|
428
|
+
/**
|
|
429
|
+
* Format: date-time
|
|
430
|
+
* @description The date and time when the customer was created in the system.
|
|
431
|
+
*/
|
|
432
|
+
created_at: string;
|
|
433
|
+
/**
|
|
434
|
+
* Format: date-time
|
|
435
|
+
* @description The date and time when the customer was last updated, if applicable.
|
|
436
|
+
*/
|
|
437
|
+
updated_at?: string | null;
|
|
438
|
+
/** @description Additional custom data associated with the customer. */
|
|
439
|
+
metadata: {
|
|
440
|
+
[key: string]: string;
|
|
441
|
+
};
|
|
442
|
+
};
|
|
443
|
+
/** @enum {string} */
|
|
444
|
+
CustomerMinecraftPlatform: "unknown" | "java" | "bedrock";
|
|
445
|
+
/** @description Represents a customer platform association, used for gifting */
|
|
446
|
+
CustomerPlatformAccountDto: {
|
|
447
|
+
platform: components["schemas"]["CustomerProfilePlatform"];
|
|
448
|
+
/**
|
|
449
|
+
* @description The account ID on the platform
|
|
450
|
+
* @example 76561198152492642
|
|
451
|
+
*/
|
|
452
|
+
id: string;
|
|
453
|
+
};
|
|
454
|
+
/**
|
|
455
|
+
* @description A customer platform type used while gifting
|
|
456
|
+
* @enum {string}
|
|
457
|
+
*/
|
|
458
|
+
CustomerProfilePlatform: "invalid" | "steam" | "minecraft" | "paynow_name";
|
|
459
|
+
/** @description Represents the product information for a delivery item */
|
|
460
|
+
DeliveryItemProductDto: {
|
|
461
|
+
id: components["schemas"]["FlakeId"];
|
|
462
|
+
/**
|
|
463
|
+
* @description The name of the product
|
|
464
|
+
* @example Premium Membership
|
|
465
|
+
*/
|
|
466
|
+
name: string;
|
|
467
|
+
/**
|
|
468
|
+
* @description The URL-friendly slug of the product
|
|
469
|
+
* @example premium-membership
|
|
470
|
+
*/
|
|
471
|
+
slug: string;
|
|
472
|
+
/**
|
|
473
|
+
* @description The version identifier of the product
|
|
474
|
+
* @example v2.1.0
|
|
475
|
+
*/
|
|
476
|
+
version_id: string;
|
|
477
|
+
};
|
|
478
|
+
/** @enum {string} */
|
|
479
|
+
DeliveryItemStateDto: "usable" | "active" | "used" | "revoked" | "renewed";
|
|
480
|
+
/**
|
|
481
|
+
* Format: flake-id
|
|
482
|
+
* @example 411486491630370816
|
|
483
|
+
*/
|
|
484
|
+
FlakeId: string;
|
|
485
|
+
/** @description Represents a generic platform profile for a customer. */
|
|
486
|
+
GenericProfileDto: {
|
|
487
|
+
/** @description The platform-specific identifier for the profile. */
|
|
488
|
+
id: string;
|
|
489
|
+
/**
|
|
490
|
+
* @description The name of the platform this profile belongs to.
|
|
491
|
+
* @example steam
|
|
492
|
+
*/
|
|
493
|
+
platform: string;
|
|
494
|
+
/** @description The display name of the user on this platform. */
|
|
495
|
+
name: string;
|
|
496
|
+
/** @description The URL to the user's avatar image on this platform. */
|
|
497
|
+
avatar_url?: string | null;
|
|
498
|
+
};
|
|
499
|
+
/** @description Represents a Minecraft profile for a customer. */
|
|
500
|
+
MinecraftProfileDto: {
|
|
501
|
+
/**
|
|
502
|
+
* @description The UUID of the Minecraft player.
|
|
503
|
+
* If the platform is Minecraft Offline, this will be the name itself.
|
|
504
|
+
* If the platform is Minecraft Geyser, and this is a Bedrock account, this ID will be an Xbox XUID.
|
|
505
|
+
* @example f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2
|
|
506
|
+
*/
|
|
507
|
+
id: string;
|
|
508
|
+
/**
|
|
509
|
+
* @description The username of the Minecraft player.
|
|
510
|
+
* @example notch
|
|
511
|
+
*/
|
|
512
|
+
name: string;
|
|
513
|
+
/** @description The URL to the player's Minecraft skin rendered as an avatar. */
|
|
514
|
+
avatar_url: string;
|
|
515
|
+
};
|
|
516
|
+
/** @description Represents a PayNow error */
|
|
517
|
+
PayNowError: {
|
|
518
|
+
/**
|
|
519
|
+
* Format: int32
|
|
520
|
+
* @description The HTTP status code.
|
|
521
|
+
* @example 400
|
|
522
|
+
*/
|
|
523
|
+
status: number;
|
|
524
|
+
/**
|
|
525
|
+
* @description The PayNow parseable error code.
|
|
526
|
+
* @example bad-request
|
|
527
|
+
*/
|
|
528
|
+
code: string;
|
|
529
|
+
/**
|
|
530
|
+
* @description The human-readable error message.
|
|
531
|
+
* @example Bad Request Example
|
|
532
|
+
*/
|
|
533
|
+
message: string;
|
|
534
|
+
/**
|
|
535
|
+
* @description A distributed trace ID used for debugging.
|
|
536
|
+
* @example 234a5bcd543ef3fa53ce929d0e0e4736
|
|
537
|
+
*/
|
|
538
|
+
trace_id?: string | null;
|
|
539
|
+
/** @description An array of multiple errors. Only used by some API services. */
|
|
540
|
+
errors?: components["schemas"]["ValidationError"][] | null;
|
|
541
|
+
};
|
|
542
|
+
ProductDeliverableActionsDto: {
|
|
543
|
+
/** @description Value indicating whether to grant a giftcard with the product with the subtotal amount. */
|
|
544
|
+
grant_giftcard: boolean;
|
|
545
|
+
};
|
|
546
|
+
ProductGameServerDto: {
|
|
547
|
+
id: components["schemas"]["FlakeId"];
|
|
548
|
+
/**
|
|
549
|
+
* @description The name of the game server.
|
|
550
|
+
* @example US 2x TRIO
|
|
551
|
+
*/
|
|
552
|
+
name: string;
|
|
553
|
+
/** @description Indicates whether this game server is enabled. */
|
|
554
|
+
enabled: boolean;
|
|
555
|
+
};
|
|
556
|
+
/** @enum {string} */
|
|
557
|
+
ProductRemoveAfterIntervalScale: "invalid" | "day" | "week" | "month";
|
|
558
|
+
/** @enum {string} */
|
|
559
|
+
ProductSubscriptionIntervalScale: "invalid" | "day" | "week" | "month" | "year";
|
|
560
|
+
ProductTagDto: {
|
|
561
|
+
id: components["schemas"]["FlakeId"];
|
|
562
|
+
/**
|
|
563
|
+
* @description The unique slug for the tag.
|
|
564
|
+
* @example packages
|
|
565
|
+
*/
|
|
566
|
+
slug: string;
|
|
567
|
+
/**
|
|
568
|
+
* @description The display name of the tag.
|
|
569
|
+
* @example Packages
|
|
570
|
+
*/
|
|
571
|
+
name: string;
|
|
572
|
+
};
|
|
573
|
+
/** @enum {string} */
|
|
574
|
+
SaleDiscountType: "percent" | "amount";
|
|
575
|
+
/**
|
|
576
|
+
* Format: steam-id
|
|
577
|
+
* @description A 64-bit Steam account identifier. Accepts string or numeric format.
|
|
578
|
+
* @example 76561197960287930
|
|
579
|
+
*/
|
|
580
|
+
SteamId: string;
|
|
581
|
+
/** @description Represents a Steam profile for a customer. */
|
|
582
|
+
SteamProfileDto: {
|
|
583
|
+
id: components["schemas"]["SteamId"];
|
|
584
|
+
/** @description The display name of the user on Steam. */
|
|
585
|
+
name: string;
|
|
586
|
+
/** @description The URL to the user's Steam avatar image. */
|
|
587
|
+
avatar_url: string;
|
|
588
|
+
};
|
|
589
|
+
StorefrontCustomVariableDto: {
|
|
590
|
+
/** @description Unique identifier string used to reference this custom variable programmatically.
|
|
591
|
+
* Must contain only letters, numbers, underscores, and hyphens. */
|
|
592
|
+
identifier: string;
|
|
593
|
+
/** @description Display name for the custom variable shown to customers. */
|
|
594
|
+
name: string;
|
|
595
|
+
/** @description Description explaining what this custom variable is for. Can be shown to customers. */
|
|
596
|
+
description: string;
|
|
597
|
+
type: components["schemas"]["CustomVariableType"];
|
|
598
|
+
/** @description Optional regex pattern to validate text/number input values.
|
|
599
|
+
* Only applies to text and number types.
|
|
600
|
+
* Uses RE2 syntax - does not support negative lookarounds, backreferences, or other advanced regex features. */
|
|
601
|
+
value_regex?: string | null;
|
|
602
|
+
/** @description Available options for dropdown type custom variables.
|
|
603
|
+
* Empty for text and number types. */
|
|
604
|
+
options: components["schemas"]["StorefrontCustomVariableOptionDto"][];
|
|
605
|
+
};
|
|
606
|
+
StorefrontCustomVariableOptionDto: {
|
|
607
|
+
/** @description Display name shown to customers for this option. */
|
|
608
|
+
name: string;
|
|
609
|
+
/** @description Internal value used for product command variable replacement, without brackets. */
|
|
610
|
+
value: string;
|
|
611
|
+
/**
|
|
612
|
+
* Format: int64
|
|
613
|
+
* @description Additional price in the lowest denominator (e.g. cents) when this option is selected.
|
|
614
|
+
*/
|
|
615
|
+
price: number;
|
|
616
|
+
/** @description Whether this option is selected by default when the custom variable is presented.
|
|
617
|
+
* Only one option per custom variable should be marked as default. */
|
|
618
|
+
is_default: boolean;
|
|
619
|
+
/**
|
|
620
|
+
* Format: int32
|
|
621
|
+
* @description Sort order for displaying options to customers.
|
|
622
|
+
* Lower numbers appear first.
|
|
623
|
+
*/
|
|
624
|
+
sort_order: number;
|
|
625
|
+
};
|
|
626
|
+
/** @description Represents a delivery item assigned to a customer */
|
|
627
|
+
StorefrontDeliveryItemDto: {
|
|
628
|
+
id: components["schemas"]["FlakeId"];
|
|
629
|
+
store_id: components["schemas"]["FlakeId"];
|
|
630
|
+
customer_id: components["schemas"]["FlakeId"];
|
|
631
|
+
order_id?: components["schemas"]["FlakeId"];
|
|
632
|
+
order_line_id?: components["schemas"]["FlakeId"];
|
|
633
|
+
subscription_id?: components["schemas"]["FlakeId"];
|
|
634
|
+
execute_on_gameserver_id?: components["schemas"]["FlakeId"];
|
|
635
|
+
/**
|
|
636
|
+
* Format: int32
|
|
637
|
+
* @description The index of the item when multiple quantities were assigned
|
|
638
|
+
*/
|
|
639
|
+
quantity_index?: number | null;
|
|
640
|
+
product: components["schemas"]["DeliveryItemProductDto"];
|
|
641
|
+
state: components["schemas"]["DeliveryItemStateDto"];
|
|
642
|
+
/** @description Indicates whether the delivery item can expire */
|
|
643
|
+
expirable: boolean;
|
|
644
|
+
/** @description Indicates whether the item was given as a gift */
|
|
645
|
+
gift: boolean;
|
|
646
|
+
/**
|
|
647
|
+
* Format: date-time
|
|
648
|
+
* @description The date and time when the item was added
|
|
649
|
+
*/
|
|
650
|
+
added_at: string;
|
|
651
|
+
/**
|
|
652
|
+
* Format: date-time
|
|
653
|
+
* @description The date and time when the item became active
|
|
654
|
+
*/
|
|
655
|
+
active_at?: string | null;
|
|
656
|
+
/**
|
|
657
|
+
* Format: date-time
|
|
658
|
+
* @description The date and time when the item expires naturally
|
|
659
|
+
*/
|
|
660
|
+
expires_at?: string | null;
|
|
661
|
+
/**
|
|
662
|
+
* Format: date-time
|
|
663
|
+
* @description The override expiry date for the delivery item
|
|
664
|
+
*/
|
|
665
|
+
override_expires_at?: string | null;
|
|
666
|
+
/**
|
|
667
|
+
* Format: date-time
|
|
668
|
+
* @description The date and time when the item was removed
|
|
669
|
+
*/
|
|
670
|
+
removed_at?: string | null;
|
|
671
|
+
/**
|
|
672
|
+
* Format: date-time
|
|
673
|
+
* @description The date and time when the item was revoked
|
|
674
|
+
*/
|
|
675
|
+
revoked_at?: string | null;
|
|
676
|
+
/** @description The reason for revoking the delivery item */
|
|
677
|
+
revoke_reason?: string | null;
|
|
678
|
+
};
|
|
679
|
+
/** @description Represents a simplified view of a game server for storefront display purposes. */
|
|
680
|
+
StorefrontGameServerDto: {
|
|
681
|
+
id: components["schemas"]["FlakeId"];
|
|
682
|
+
store_id: components["schemas"]["FlakeId"];
|
|
683
|
+
/** @description The display name of the game server. */
|
|
684
|
+
name: string;
|
|
685
|
+
/** @description Indicates whether the game server is currently enabled. */
|
|
686
|
+
enabled: boolean;
|
|
687
|
+
};
|
|
688
|
+
StorefrontGiftCardDto: {
|
|
689
|
+
code: string;
|
|
690
|
+
/** Format: int32 */
|
|
691
|
+
balance: number;
|
|
692
|
+
/** Format: int32 */
|
|
693
|
+
starting_balance: number;
|
|
694
|
+
/** Format: date-time */
|
|
695
|
+
expires_at?: string | null;
|
|
696
|
+
};
|
|
697
|
+
/** @description Represents a navigation link in the storefront's hierarchical navigation structure. */
|
|
698
|
+
StorefrontNavLinkDto: {
|
|
699
|
+
/** @description The unique identifier for this navigation node in the navigation tree. */
|
|
700
|
+
node_id: string;
|
|
701
|
+
/** @description The identifier of the parent navigation node, if this is a child node. */
|
|
702
|
+
parent_node_id?: string | null;
|
|
703
|
+
tag_id: components["schemas"]["FlakeId"];
|
|
704
|
+
/**
|
|
705
|
+
* @description The URL-friendly slug for the tag associated with this navigation link.
|
|
706
|
+
* @example perks
|
|
707
|
+
*/
|
|
708
|
+
tag_slug: string;
|
|
709
|
+
/**
|
|
710
|
+
* @description A list containing all parent tags and this node's tag, representing the complete path in the tag hierarchy.
|
|
711
|
+
* @example [
|
|
712
|
+
* "perks",
|
|
713
|
+
* "vip"
|
|
714
|
+
* ]
|
|
715
|
+
*/
|
|
716
|
+
tag_query: string[];
|
|
717
|
+
/**
|
|
718
|
+
* @description The display name of the associated tag shown to users in the UI.
|
|
719
|
+
* @example Perks
|
|
720
|
+
*/
|
|
721
|
+
name: string;
|
|
722
|
+
/**
|
|
723
|
+
* Format: int32
|
|
724
|
+
* @description The display order of this navigation link relative to its siblings.
|
|
725
|
+
*/
|
|
726
|
+
order: number;
|
|
727
|
+
/** @description The collection of child navigation links that appear beneath this link in the hierarchy. */
|
|
728
|
+
children: components["schemas"]["StorefrontNavLinkDto"][];
|
|
729
|
+
};
|
|
730
|
+
StorefrontProductDto: {
|
|
731
|
+
id: components["schemas"]["FlakeId"];
|
|
732
|
+
store_id: components["schemas"]["FlakeId"];
|
|
733
|
+
version_id: components["schemas"]["FlakeId"];
|
|
734
|
+
/**
|
|
735
|
+
* @description The URL to the product image.
|
|
736
|
+
* @example https://cdn.paynow.gg/logo/full/logotype-color.svg
|
|
737
|
+
*/
|
|
738
|
+
image_url?: string | null;
|
|
739
|
+
/**
|
|
740
|
+
* @description The unique slug for the product.
|
|
741
|
+
* @example premium-game-package
|
|
742
|
+
*/
|
|
743
|
+
slug: string;
|
|
744
|
+
/**
|
|
745
|
+
* @description The display name of the product.
|
|
746
|
+
* @example Premium Game Package
|
|
747
|
+
*/
|
|
748
|
+
name: string;
|
|
749
|
+
/**
|
|
750
|
+
* @description The detailed description of the product.
|
|
751
|
+
* @example This premium package includes exclusive in-game items, bonus currency, and early access to new content.
|
|
752
|
+
*/
|
|
753
|
+
description: string;
|
|
754
|
+
/**
|
|
755
|
+
* Format: date-time
|
|
756
|
+
* @description The date and time when the product becomes enabled.
|
|
757
|
+
*/
|
|
758
|
+
enabled_at?: string | null;
|
|
759
|
+
/**
|
|
760
|
+
* Format: date-time
|
|
761
|
+
* @description The date and time until which the product remains enabled.
|
|
762
|
+
*/
|
|
763
|
+
enabled_until?: string | null;
|
|
764
|
+
/**
|
|
765
|
+
* @description The display label for the product.
|
|
766
|
+
* @example Premium Items
|
|
767
|
+
*/
|
|
768
|
+
label?: string | null;
|
|
769
|
+
/**
|
|
770
|
+
* Format: int32
|
|
771
|
+
* @description The sort order for displaying the product.
|
|
772
|
+
*/
|
|
773
|
+
sort_order: number;
|
|
774
|
+
/**
|
|
775
|
+
* Format: int64
|
|
776
|
+
* @description The price of the product, in the lowest denominator (e.g. cents).
|
|
777
|
+
* @example 1999
|
|
778
|
+
*/
|
|
779
|
+
price: number;
|
|
780
|
+
/** @description The ISO three-letter lowercase currency code (e.g., usd, eur, gbp) the product is denominated in. */
|
|
781
|
+
currency: string;
|
|
782
|
+
/** @description Indicates whether the product is limited to a single game server. */
|
|
783
|
+
single_game_server_only: boolean;
|
|
784
|
+
/**
|
|
785
|
+
* @description Indicates whether one-time purchases are allowed.
|
|
786
|
+
* @example true
|
|
787
|
+
*/
|
|
788
|
+
allow_one_time_purchase: boolean;
|
|
789
|
+
/**
|
|
790
|
+
* @description Indicates whether subscription purchases are allowed.
|
|
791
|
+
* @example true
|
|
792
|
+
*/
|
|
793
|
+
allow_subscription: boolean;
|
|
794
|
+
/** @description Indicates whether gifting is disabled for this product. */
|
|
795
|
+
is_gifting_disabled: boolean;
|
|
796
|
+
/**
|
|
797
|
+
* Format: int32
|
|
798
|
+
* @description The subscription interval value.
|
|
799
|
+
* @example 1
|
|
800
|
+
*/
|
|
801
|
+
subscription_interval_value: number;
|
|
802
|
+
subscription_interval_scale: components["schemas"]["ProductSubscriptionIntervalScale"];
|
|
803
|
+
/**
|
|
804
|
+
* @description Indicates whether automatic removal is enabled.
|
|
805
|
+
* @example true
|
|
806
|
+
*/
|
|
807
|
+
remove_after_enabled: boolean;
|
|
808
|
+
/**
|
|
809
|
+
* Format: int32
|
|
810
|
+
* @description The time value for automatic removal.
|
|
811
|
+
* @example 1
|
|
812
|
+
*/
|
|
813
|
+
remove_after_time_value: number;
|
|
814
|
+
remove_after_time_scale: components["schemas"]["ProductRemoveAfterIntervalScale"];
|
|
815
|
+
pricing?: components["schemas"]["StorefrontProductPricingDetailsDto"];
|
|
816
|
+
stock?: components["schemas"]["StorefrontProductStockStatusDto"];
|
|
817
|
+
trial: components["schemas"]["StorefrontProductTrialDto"];
|
|
818
|
+
/** @description The tags associated with the product. */
|
|
819
|
+
tags: components["schemas"]["ProductTagDto"][];
|
|
820
|
+
/** @description The game servers associated with the product. */
|
|
821
|
+
gameservers: components["schemas"]["ProductGameServerDto"][];
|
|
822
|
+
/** @description Custom Variables associated with the product. */
|
|
823
|
+
custom_variables: components["schemas"]["StorefrontCustomVariableDto"][];
|
|
824
|
+
deliverable_actions?: components["schemas"]["ProductDeliverableActionsDto"];
|
|
825
|
+
/** @description Additional metadata for the product. */
|
|
826
|
+
metadata?: {
|
|
827
|
+
[key: string]: string;
|
|
828
|
+
} | null;
|
|
829
|
+
/**
|
|
830
|
+
* Format: date-time
|
|
831
|
+
* @description The date and time when the product was created.
|
|
832
|
+
*/
|
|
833
|
+
created_at?: string | null;
|
|
834
|
+
/**
|
|
835
|
+
* Format: date-time
|
|
836
|
+
* @description The date and time when the product was last updated.
|
|
837
|
+
*/
|
|
838
|
+
updated_at?: string | null;
|
|
839
|
+
};
|
|
840
|
+
/** @description The pricing details for the product in the storefront. */
|
|
841
|
+
StorefrontProductPricingDetailsDto: {
|
|
842
|
+
active_sale?: components["schemas"]["StorefrontSaleDto"];
|
|
843
|
+
/**
|
|
844
|
+
* Format: int64
|
|
845
|
+
* @description The amount of the sale discount in the lowest denominator (e.g. cents).
|
|
846
|
+
* @example 500
|
|
847
|
+
*/
|
|
848
|
+
sale_value?: number | null;
|
|
849
|
+
vat_rate?: components["schemas"]["VatRateDto"];
|
|
850
|
+
regional_pricing?: components["schemas"]["StorefrontProductPricingDetailsRegionalPricingDto"];
|
|
851
|
+
/**
|
|
852
|
+
* Format: int64
|
|
853
|
+
* @description The original price of the product before any discounts, in the lowest denominator (e.g. cents).
|
|
854
|
+
* @example 1999
|
|
855
|
+
*/
|
|
856
|
+
price_original: number;
|
|
857
|
+
/**
|
|
858
|
+
* Format: int64
|
|
859
|
+
* @description The final price of the product after all discounts, in the lowest denominator (e.g. cents).
|
|
860
|
+
* @example 1499
|
|
861
|
+
*/
|
|
862
|
+
price_final: number;
|
|
863
|
+
};
|
|
864
|
+
/** @description Regional pricing information for this product.
|
|
865
|
+
* Only present if there is a regional pricing configured. */
|
|
866
|
+
StorefrontProductPricingDetailsRegionalPricingDto: {
|
|
867
|
+
/**
|
|
868
|
+
* @description The identifier for the region.
|
|
869
|
+
* @example eu
|
|
870
|
+
*/
|
|
871
|
+
region_id: string;
|
|
872
|
+
/**
|
|
873
|
+
* @description The currency code used in the region.
|
|
874
|
+
* @example eur
|
|
875
|
+
*/
|
|
876
|
+
currency: string;
|
|
877
|
+
/**
|
|
878
|
+
* @description Indicates whether the base price includes tax.
|
|
879
|
+
* @example true
|
|
880
|
+
*/
|
|
881
|
+
tax_inclusive: boolean;
|
|
882
|
+
/**
|
|
883
|
+
* Format: int64
|
|
884
|
+
* @description The base price in the regional currency, in the lowest denominator (e.g. cents).
|
|
885
|
+
* @example 1799
|
|
886
|
+
*/
|
|
887
|
+
base_price: number;
|
|
888
|
+
};
|
|
889
|
+
/** @description The stock status information for the product in the storefront. */
|
|
890
|
+
StorefrontProductStockStatusDto: {
|
|
891
|
+
/**
|
|
892
|
+
* @description Indicates whether the product is currently available for purchase (there is available stock).
|
|
893
|
+
* @example true
|
|
894
|
+
*/
|
|
895
|
+
available_to_purchase: boolean;
|
|
896
|
+
/**
|
|
897
|
+
* Format: int32
|
|
898
|
+
* @description The number of items available for the customer to purchase (customer stock limit remaining).
|
|
899
|
+
* @example 5
|
|
900
|
+
*/
|
|
901
|
+
customer_available: number;
|
|
902
|
+
};
|
|
903
|
+
StorefrontProductTrialDto: {
|
|
904
|
+
/** @description Indicates whether the trial period is enabled for this product. */
|
|
905
|
+
enabled: boolean;
|
|
906
|
+
/** @description Indicates whether the customer is eligible for the trial period. */
|
|
907
|
+
eligible: boolean;
|
|
908
|
+
/**
|
|
909
|
+
* Format: int32
|
|
910
|
+
* @description The duration value of the trial period.
|
|
911
|
+
*/
|
|
912
|
+
period_value: number;
|
|
913
|
+
period_scale: components["schemas"]["ProductSubscriptionIntervalScale"];
|
|
914
|
+
};
|
|
915
|
+
StorefrontSaleDto: {
|
|
916
|
+
id: components["schemas"]["FlakeId"];
|
|
917
|
+
/**
|
|
918
|
+
* @description The name of the sale.
|
|
919
|
+
* @example Summer Sale
|
|
920
|
+
*/
|
|
921
|
+
name: string;
|
|
922
|
+
discount_type: components["schemas"]["SaleDiscountType"];
|
|
923
|
+
/**
|
|
924
|
+
* Format: int64
|
|
925
|
+
* @description The amount of the discount, either as a percentage in permille or as an absolute value in cents.
|
|
926
|
+
* @example 2000
|
|
927
|
+
*/
|
|
928
|
+
discount_amount: number;
|
|
929
|
+
/**
|
|
930
|
+
* Format: int64
|
|
931
|
+
* @description The minimum order value required to apply the discount, in the lowest denominator (e.g. cents).
|
|
932
|
+
* @example 0
|
|
933
|
+
*/
|
|
934
|
+
minimum_order_value: number;
|
|
935
|
+
/**
|
|
936
|
+
* Format: date-time
|
|
937
|
+
* @description The date and time when the sale begins.
|
|
938
|
+
* @example 2025-06-01T00:00:00Z
|
|
939
|
+
*/
|
|
940
|
+
begins_at: string;
|
|
941
|
+
/**
|
|
942
|
+
* Format: date-time
|
|
943
|
+
* @description The date and time when the sale ends, if applicable.
|
|
944
|
+
* @example 2025-06-30T23:59:59Z
|
|
945
|
+
*/
|
|
946
|
+
ends_at?: string | null;
|
|
947
|
+
};
|
|
948
|
+
/** @description Represents a store entity within the storefront system. */
|
|
949
|
+
StorefrontStoreDto: {
|
|
950
|
+
id: components["schemas"]["FlakeId"];
|
|
951
|
+
/**
|
|
952
|
+
* @description The URL-friendly identifier for the store, used in store URLs.
|
|
953
|
+
* @example m0ukas-awesome-store
|
|
954
|
+
*/
|
|
955
|
+
slug: string;
|
|
956
|
+
/**
|
|
957
|
+
* @description The display name of the store shown to customers.
|
|
958
|
+
* @example m0uka's awesome store
|
|
959
|
+
*/
|
|
960
|
+
name: string;
|
|
961
|
+
/**
|
|
962
|
+
* @description The platform or the game of the store.
|
|
963
|
+
* @example rust
|
|
964
|
+
*/
|
|
965
|
+
platform: string;
|
|
966
|
+
/** @description The game of the store. Equivalent to the `platform` for backwards compatibility. */
|
|
967
|
+
readonly game: string;
|
|
968
|
+
/**
|
|
969
|
+
* @description The three-letter ISO currency code used for pricing in this store.
|
|
970
|
+
* @example usd
|
|
971
|
+
*/
|
|
972
|
+
currency: string;
|
|
973
|
+
/** @description A detailed description of the store. Only present for some platform types. */
|
|
974
|
+
description?: string | null;
|
|
975
|
+
/** @description The URL of the store's main website, if not using Hosted Webstores. */
|
|
976
|
+
website_url?: string | null;
|
|
977
|
+
/**
|
|
978
|
+
* @description The email address customers can use to contact store support.
|
|
979
|
+
* @example support@example.com
|
|
980
|
+
*/
|
|
981
|
+
support_email?: string | null;
|
|
982
|
+
/** @description The type of integration this store uses with external systems. */
|
|
983
|
+
integration_type?: string | null;
|
|
984
|
+
/** @description Indicates whether the store is in live mode (true) or test mode (false). */
|
|
985
|
+
live_mode: boolean;
|
|
986
|
+
/** @description The URL to the store's main logo image. */
|
|
987
|
+
logo_url?: string | null;
|
|
988
|
+
/** @description The URL to the store's square logo image. */
|
|
989
|
+
logo_square_url?: string | null;
|
|
990
|
+
/**
|
|
991
|
+
* Format: date-time
|
|
992
|
+
* @description The date and time when the store was created.
|
|
993
|
+
*/
|
|
994
|
+
created_at?: string | null;
|
|
995
|
+
/**
|
|
996
|
+
* Format: date-time
|
|
997
|
+
* @description The date and time when the store was last updated.
|
|
998
|
+
*/
|
|
999
|
+
updated_at?: string | null;
|
|
1000
|
+
};
|
|
1001
|
+
/** @description Represents a tag entity used for categorizing and filtering products within a store. */
|
|
1002
|
+
StorefrontTagDto: {
|
|
1003
|
+
id: components["schemas"]["FlakeId"];
|
|
1004
|
+
store_id: components["schemas"]["FlakeId"];
|
|
1005
|
+
/** @description The URL-friendly identifier for the tag, used in category URLs. */
|
|
1006
|
+
slug: string;
|
|
1007
|
+
/** @description The display name of the tag shown to customers. */
|
|
1008
|
+
name: string;
|
|
1009
|
+
/** @description A detailed description of the tag's purpose or the category it represents. */
|
|
1010
|
+
description?: string | null;
|
|
1011
|
+
/**
|
|
1012
|
+
* @description The URL to the tag image.
|
|
1013
|
+
* @example https://cdn.paynow.gg/logo/full/logotype-color.svg
|
|
1014
|
+
*/
|
|
1015
|
+
image_url?: string | null;
|
|
1016
|
+
/** @description Indicates whether the tag is active and should be included in navigation and filtering. */
|
|
1017
|
+
enabled: boolean;
|
|
1018
|
+
/**
|
|
1019
|
+
* Format: date-time
|
|
1020
|
+
* @description The date and time when the tag was created.
|
|
1021
|
+
*/
|
|
1022
|
+
created_at: string;
|
|
1023
|
+
/**
|
|
1024
|
+
* Format: date-time
|
|
1025
|
+
* @description The date and time when the tag was last updated, if applicable.
|
|
1026
|
+
*/
|
|
1027
|
+
updated_at?: string | null;
|
|
1028
|
+
};
|
|
1029
|
+
/** @description A validation error. */
|
|
1030
|
+
ValidationError: {
|
|
1031
|
+
/** @description The parseable error code. */
|
|
1032
|
+
code: string;
|
|
1033
|
+
/** @description The human-readable error message. */
|
|
1034
|
+
message: string;
|
|
1035
|
+
/** @description The path leading to the validation error. */
|
|
1036
|
+
path: string;
|
|
1037
|
+
/** @description Type of the validation that failed. */
|
|
1038
|
+
validation: string;
|
|
1039
|
+
};
|
|
1040
|
+
/** @description The VAT rate estimation for the passed in customer country / IP.
|
|
1041
|
+
* Include the VAT percentage + abbreviation in your product view to inform your customers about the tax. */
|
|
1042
|
+
VatRateDto: {
|
|
1043
|
+
/**
|
|
1044
|
+
* @description The ISO country code.
|
|
1045
|
+
* @example CZ
|
|
1046
|
+
*/
|
|
1047
|
+
country_code: string;
|
|
1048
|
+
/**
|
|
1049
|
+
* @description The full name of the country.
|
|
1050
|
+
* @example Czech Republic
|
|
1051
|
+
*/
|
|
1052
|
+
country_name: string;
|
|
1053
|
+
/**
|
|
1054
|
+
* @description The local currency used in the country.
|
|
1055
|
+
* @example CZK
|
|
1056
|
+
*/
|
|
1057
|
+
currency: string;
|
|
1058
|
+
/**
|
|
1059
|
+
* @description The abbreviation of the VAT term in the local language.
|
|
1060
|
+
* @example DPH
|
|
1061
|
+
*/
|
|
1062
|
+
vat_abbreviation: string;
|
|
1063
|
+
/**
|
|
1064
|
+
* @description The full name of the VAT term in the local language.
|
|
1065
|
+
* @example Daň z přidané hodnoty
|
|
1066
|
+
*/
|
|
1067
|
+
vat_local_name: string;
|
|
1068
|
+
/**
|
|
1069
|
+
* @description Indicates whether the country is a member of the European Union.
|
|
1070
|
+
* @example true
|
|
1071
|
+
*/
|
|
1072
|
+
eu_member_state: boolean;
|
|
1073
|
+
/**
|
|
1074
|
+
* Format: double
|
|
1075
|
+
* @description The VAT rate applicable for electronic services, as a percentage.
|
|
1076
|
+
* @example 21
|
|
1077
|
+
*/
|
|
1078
|
+
eservice_rate: number;
|
|
1079
|
+
/**
|
|
1080
|
+
* Format: double
|
|
1081
|
+
* @description The VAT rate (synonym for EServiceRate).
|
|
1082
|
+
* @example 21
|
|
1083
|
+
*/
|
|
1084
|
+
readonly percentage: number;
|
|
1085
|
+
};
|
|
1086
|
+
};
|
|
1087
|
+
responses: never;
|
|
1088
|
+
parameters: never;
|
|
1089
|
+
requestBodies: never;
|
|
1090
|
+
headers: never;
|
|
1091
|
+
pathItems: never;
|
|
1092
|
+
}
|
|
1093
|
+
export type $defs = Record<string, never>;
|
|
1094
|
+
export interface operations {
|
|
1095
|
+
Cart_GetCart: {
|
|
1096
|
+
parameters: {
|
|
1097
|
+
query?: {
|
|
1098
|
+
/** @description The ISO three-letter lowercase currency code (e.g., usd, eur, gbp) to display prices in. If not provided, the store's default currency will be used. */
|
|
1099
|
+
currency?: string;
|
|
1100
|
+
};
|
|
1101
|
+
header?: {
|
|
1102
|
+
/** @description The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser. */
|
|
1103
|
+
"x-paynow-customer-ip"?: string;
|
|
1104
|
+
/** @description The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available. */
|
|
1105
|
+
"x-paynow-customer-countrycode"?: string;
|
|
1106
|
+
};
|
|
1107
|
+
path?: never;
|
|
1108
|
+
cookie?: never;
|
|
1109
|
+
};
|
|
1110
|
+
requestBody?: never;
|
|
1111
|
+
responses: {
|
|
1112
|
+
/** @description OK */
|
|
1113
|
+
200: {
|
|
1114
|
+
headers: {
|
|
1115
|
+
[name: string]: unknown;
|
|
1116
|
+
};
|
|
1117
|
+
content: {
|
|
1118
|
+
"application/json": components["schemas"]["CartDto"];
|
|
1119
|
+
};
|
|
1120
|
+
};
|
|
1121
|
+
/** @description Error response */
|
|
1122
|
+
default: {
|
|
1123
|
+
headers: {
|
|
1124
|
+
[name: string]: unknown;
|
|
1125
|
+
};
|
|
1126
|
+
content: {
|
|
1127
|
+
"application/json": components["schemas"]["PayNowError"];
|
|
1128
|
+
};
|
|
1129
|
+
};
|
|
1130
|
+
};
|
|
1131
|
+
};
|
|
1132
|
+
Cart_ClearCart: {
|
|
1133
|
+
parameters: {
|
|
1134
|
+
query?: never;
|
|
1135
|
+
header?: {
|
|
1136
|
+
/** @description The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser. */
|
|
1137
|
+
"x-paynow-customer-ip"?: string;
|
|
1138
|
+
/** @description The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available. */
|
|
1139
|
+
"x-paynow-customer-countrycode"?: string;
|
|
1140
|
+
};
|
|
1141
|
+
path?: never;
|
|
1142
|
+
cookie?: never;
|
|
1143
|
+
};
|
|
1144
|
+
requestBody?: never;
|
|
1145
|
+
responses: {
|
|
1146
|
+
/** @description No Content */
|
|
1147
|
+
204: {
|
|
1148
|
+
headers: {
|
|
1149
|
+
[name: string]: unknown;
|
|
1150
|
+
};
|
|
1151
|
+
content?: never;
|
|
1152
|
+
};
|
|
1153
|
+
/** @description Error response */
|
|
1154
|
+
default: {
|
|
1155
|
+
headers: {
|
|
1156
|
+
[name: string]: unknown;
|
|
1157
|
+
};
|
|
1158
|
+
content: {
|
|
1159
|
+
"application/json": components["schemas"]["PayNowError"];
|
|
1160
|
+
};
|
|
1161
|
+
};
|
|
1162
|
+
};
|
|
1163
|
+
};
|
|
1164
|
+
Cart_AddLine: {
|
|
1165
|
+
parameters: {
|
|
1166
|
+
query: {
|
|
1167
|
+
/** @description The ID of the product that should be added to the cart. */
|
|
1168
|
+
product_id: components["schemas"]["FlakeId"];
|
|
1169
|
+
/** @description The quantity to set or increment. */
|
|
1170
|
+
quantity?: number;
|
|
1171
|
+
/** @description Set to either '1' or 'true' to store as a subscription line item. */
|
|
1172
|
+
subscription?: string;
|
|
1173
|
+
/** @description Set to either '1' or 'true' to indicate if the line should be trialed. */
|
|
1174
|
+
trial?: string;
|
|
1175
|
+
/** @description A game server ID, required if single_game_server_only is enabled for the product. */
|
|
1176
|
+
gameserver_id?: components["schemas"]["FlakeId"];
|
|
1177
|
+
/** @description Set to either '1' or 'true' to increment (add quantity instead of setting). */
|
|
1178
|
+
increment?: string;
|
|
1179
|
+
/** @description Dictionary of product custom variables where each entry consists of a string key (identifier)
|
|
1180
|
+
* and its corresponding selected value. Use the following URL parameter format:
|
|
1181
|
+
* ?custom_variables[IDENTIFIER]=VALUE */
|
|
1182
|
+
custom_variables?: {
|
|
1183
|
+
[key: string]: string;
|
|
1184
|
+
};
|
|
1185
|
+
};
|
|
1186
|
+
header?: {
|
|
1187
|
+
/** @description The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser. */
|
|
1188
|
+
"x-paynow-customer-ip"?: string;
|
|
1189
|
+
/** @description The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available. */
|
|
1190
|
+
"x-paynow-customer-countrycode"?: string;
|
|
1191
|
+
};
|
|
1192
|
+
path?: never;
|
|
1193
|
+
cookie?: never;
|
|
1194
|
+
};
|
|
1195
|
+
requestBody?: never;
|
|
1196
|
+
responses: {
|
|
1197
|
+
/** @description No Content */
|
|
1198
|
+
204: {
|
|
1199
|
+
headers: {
|
|
1200
|
+
[name: string]: unknown;
|
|
1201
|
+
};
|
|
1202
|
+
content?: never;
|
|
1203
|
+
};
|
|
1204
|
+
/** @description Error response */
|
|
1205
|
+
default: {
|
|
1206
|
+
headers: {
|
|
1207
|
+
[name: string]: unknown;
|
|
1208
|
+
};
|
|
1209
|
+
content: {
|
|
1210
|
+
"application/json": components["schemas"]["PayNowError"];
|
|
1211
|
+
};
|
|
1212
|
+
};
|
|
1213
|
+
};
|
|
1214
|
+
};
|
|
1215
|
+
Cart_CreateCartCheckout: {
|
|
1216
|
+
parameters: {
|
|
1217
|
+
query?: never;
|
|
1218
|
+
header?: {
|
|
1219
|
+
/** @description The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser. */
|
|
1220
|
+
"x-paynow-customer-ip"?: string;
|
|
1221
|
+
/** @description The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available. */
|
|
1222
|
+
"x-paynow-customer-countrycode"?: string;
|
|
1223
|
+
};
|
|
1224
|
+
path?: never;
|
|
1225
|
+
cookie?: never;
|
|
1226
|
+
};
|
|
1227
|
+
requestBody?: {
|
|
1228
|
+
content: {
|
|
1229
|
+
"application/json": components["schemas"]["CreateCartCheckoutSessionDto"];
|
|
1230
|
+
"text/json": components["schemas"]["CreateCartCheckoutSessionDto"];
|
|
1231
|
+
"application/*+json": components["schemas"]["CreateCartCheckoutSessionDto"];
|
|
1232
|
+
};
|
|
1233
|
+
};
|
|
1234
|
+
responses: {
|
|
1235
|
+
/** @description OK */
|
|
1236
|
+
200: {
|
|
1237
|
+
headers: {
|
|
1238
|
+
[name: string]: unknown;
|
|
1239
|
+
};
|
|
1240
|
+
content: {
|
|
1241
|
+
"application/json": components["schemas"]["CreateCheckoutSessionResponseDto"];
|
|
1242
|
+
};
|
|
1243
|
+
};
|
|
1244
|
+
/** @description Error response */
|
|
1245
|
+
default: {
|
|
1246
|
+
headers: {
|
|
1247
|
+
[name: string]: unknown;
|
|
1248
|
+
};
|
|
1249
|
+
content: {
|
|
1250
|
+
"application/json": components["schemas"]["PayNowError"];
|
|
1251
|
+
};
|
|
1252
|
+
};
|
|
1253
|
+
};
|
|
1254
|
+
};
|
|
1255
|
+
Checkout_CreateCheckoutSession: {
|
|
1256
|
+
parameters: {
|
|
1257
|
+
query?: never;
|
|
1258
|
+
header?: {
|
|
1259
|
+
/** @description The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser. */
|
|
1260
|
+
"x-paynow-customer-ip"?: string;
|
|
1261
|
+
/** @description The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available. */
|
|
1262
|
+
"x-paynow-customer-countrycode"?: string;
|
|
1263
|
+
};
|
|
1264
|
+
path?: never;
|
|
1265
|
+
cookie?: never;
|
|
1266
|
+
};
|
|
1267
|
+
requestBody?: {
|
|
1268
|
+
content: {
|
|
1269
|
+
"application/json": components["schemas"]["CreateCheckoutSessionRequestDto"];
|
|
1270
|
+
"text/json": components["schemas"]["CreateCheckoutSessionRequestDto"];
|
|
1271
|
+
"application/*+json": components["schemas"]["CreateCheckoutSessionRequestDto"];
|
|
1272
|
+
};
|
|
1273
|
+
};
|
|
1274
|
+
responses: {
|
|
1275
|
+
/** @description OK */
|
|
1276
|
+
200: {
|
|
1277
|
+
headers: {
|
|
1278
|
+
[name: string]: unknown;
|
|
1279
|
+
};
|
|
1280
|
+
content: {
|
|
1281
|
+
"application/json": components["schemas"]["CreateCheckoutSessionResponseDto"];
|
|
1282
|
+
};
|
|
1283
|
+
};
|
|
1284
|
+
/** @description Error response */
|
|
1285
|
+
default: {
|
|
1286
|
+
headers: {
|
|
1287
|
+
[name: string]: unknown;
|
|
1288
|
+
};
|
|
1289
|
+
content: {
|
|
1290
|
+
"application/json": components["schemas"]["PayNowError"];
|
|
1291
|
+
};
|
|
1292
|
+
};
|
|
1293
|
+
};
|
|
1294
|
+
};
|
|
1295
|
+
Customer_GetStorefrontCustomer: {
|
|
1296
|
+
parameters: {
|
|
1297
|
+
query?: never;
|
|
1298
|
+
header?: never;
|
|
1299
|
+
path?: never;
|
|
1300
|
+
cookie?: never;
|
|
1301
|
+
};
|
|
1302
|
+
requestBody?: never;
|
|
1303
|
+
responses: {
|
|
1304
|
+
/** @description OK */
|
|
1305
|
+
200: {
|
|
1306
|
+
headers: {
|
|
1307
|
+
[name: string]: unknown;
|
|
1308
|
+
};
|
|
1309
|
+
content: {
|
|
1310
|
+
"application/json": components["schemas"]["CustomerDto"];
|
|
1311
|
+
};
|
|
1312
|
+
};
|
|
1313
|
+
/** @description Error response */
|
|
1314
|
+
default: {
|
|
1315
|
+
headers: {
|
|
1316
|
+
[name: string]: unknown;
|
|
1317
|
+
};
|
|
1318
|
+
content: {
|
|
1319
|
+
"application/json": components["schemas"]["PayNowError"];
|
|
1320
|
+
};
|
|
1321
|
+
};
|
|
1322
|
+
};
|
|
1323
|
+
};
|
|
1324
|
+
Customer_GetStorefrontGiftCard: {
|
|
1325
|
+
parameters: {
|
|
1326
|
+
query?: never;
|
|
1327
|
+
header?: never;
|
|
1328
|
+
path: {
|
|
1329
|
+
code: string;
|
|
1330
|
+
};
|
|
1331
|
+
cookie?: never;
|
|
1332
|
+
};
|
|
1333
|
+
requestBody?: never;
|
|
1334
|
+
responses: {
|
|
1335
|
+
/** @description OK */
|
|
1336
|
+
200: {
|
|
1337
|
+
headers: {
|
|
1338
|
+
[name: string]: unknown;
|
|
1339
|
+
};
|
|
1340
|
+
content: {
|
|
1341
|
+
"application/json": components["schemas"]["StorefrontGiftCardDto"];
|
|
1342
|
+
};
|
|
1343
|
+
};
|
|
1344
|
+
/** @description Error response */
|
|
1345
|
+
default: {
|
|
1346
|
+
headers: {
|
|
1347
|
+
[name: string]: unknown;
|
|
1348
|
+
};
|
|
1349
|
+
content: {
|
|
1350
|
+
"application/json": components["schemas"]["PayNowError"];
|
|
1351
|
+
};
|
|
1352
|
+
};
|
|
1353
|
+
};
|
|
1354
|
+
};
|
|
1355
|
+
Customer_RootGetStorefrontCustomerDeliveryItems: {
|
|
1356
|
+
parameters: {
|
|
1357
|
+
query?: {
|
|
1358
|
+
/** @description The maximum number of items to return in a single request. */
|
|
1359
|
+
limit?: number;
|
|
1360
|
+
/**
|
|
1361
|
+
* @description Returns items after the specified ID.
|
|
1362
|
+
* Used for forward pagination through results.
|
|
1363
|
+
* @example null
|
|
1364
|
+
*/
|
|
1365
|
+
after?: components["schemas"]["FlakeId"];
|
|
1366
|
+
/**
|
|
1367
|
+
* @description Returns items before the specified ID.
|
|
1368
|
+
* Used for backward pagination through results.
|
|
1369
|
+
* @example null
|
|
1370
|
+
*/
|
|
1371
|
+
before?: components["schemas"]["FlakeId"];
|
|
1372
|
+
/** @description Determines the sort order of returned items.
|
|
1373
|
+
* When true, items are returned in ascending order.
|
|
1374
|
+
* When false, items are returned in descending order. */
|
|
1375
|
+
asc?: boolean;
|
|
1376
|
+
};
|
|
1377
|
+
header?: never;
|
|
1378
|
+
path?: never;
|
|
1379
|
+
cookie?: never;
|
|
1380
|
+
};
|
|
1381
|
+
requestBody?: never;
|
|
1382
|
+
responses: {
|
|
1383
|
+
/** @description OK */
|
|
1384
|
+
200: {
|
|
1385
|
+
headers: {
|
|
1386
|
+
[name: string]: unknown;
|
|
1387
|
+
};
|
|
1388
|
+
content: {
|
|
1389
|
+
"application/json": components["schemas"]["StorefrontDeliveryItemDto"][];
|
|
1390
|
+
};
|
|
1391
|
+
};
|
|
1392
|
+
/** @description Error response */
|
|
1393
|
+
default: {
|
|
1394
|
+
headers: {
|
|
1395
|
+
[name: string]: unknown;
|
|
1396
|
+
};
|
|
1397
|
+
content: {
|
|
1398
|
+
"application/json": components["schemas"]["PayNowError"];
|
|
1399
|
+
};
|
|
1400
|
+
};
|
|
1401
|
+
};
|
|
1402
|
+
};
|
|
1403
|
+
Discord_DoProductsHaveDiscordActions: {
|
|
1404
|
+
parameters: {
|
|
1405
|
+
query?: {
|
|
1406
|
+
product_version_id?: components["schemas"]["FlakeId"][];
|
|
1407
|
+
};
|
|
1408
|
+
header?: never;
|
|
1409
|
+
path?: never;
|
|
1410
|
+
cookie?: never;
|
|
1411
|
+
};
|
|
1412
|
+
requestBody?: never;
|
|
1413
|
+
responses: {
|
|
1414
|
+
/** @description OK */
|
|
1415
|
+
200: {
|
|
1416
|
+
headers: {
|
|
1417
|
+
[name: string]: unknown;
|
|
1418
|
+
};
|
|
1419
|
+
content: {
|
|
1420
|
+
"application/json": {
|
|
1421
|
+
[key: string]: boolean;
|
|
1422
|
+
};
|
|
1423
|
+
};
|
|
1424
|
+
};
|
|
1425
|
+
/** @description Error response */
|
|
1426
|
+
default: {
|
|
1427
|
+
headers: {
|
|
1428
|
+
[name: string]: unknown;
|
|
1429
|
+
};
|
|
1430
|
+
content: {
|
|
1431
|
+
"application/json": components["schemas"]["PayNowError"];
|
|
1432
|
+
};
|
|
1433
|
+
};
|
|
1434
|
+
};
|
|
1435
|
+
};
|
|
1436
|
+
Navlinks_GetStorefrontNavLinks: {
|
|
1437
|
+
parameters: {
|
|
1438
|
+
query?: never;
|
|
1439
|
+
header?: never;
|
|
1440
|
+
path?: never;
|
|
1441
|
+
cookie?: never;
|
|
1442
|
+
};
|
|
1443
|
+
requestBody?: never;
|
|
1444
|
+
responses: {
|
|
1445
|
+
/** @description OK */
|
|
1446
|
+
200: {
|
|
1447
|
+
headers: {
|
|
1448
|
+
[name: string]: unknown;
|
|
1449
|
+
};
|
|
1450
|
+
content: {
|
|
1451
|
+
"application/json": components["schemas"]["StorefrontNavLinkDto"][];
|
|
1452
|
+
};
|
|
1453
|
+
};
|
|
1454
|
+
/** @description Error response */
|
|
1455
|
+
default: {
|
|
1456
|
+
headers: {
|
|
1457
|
+
[name: string]: unknown;
|
|
1458
|
+
};
|
|
1459
|
+
content: {
|
|
1460
|
+
"application/json": components["schemas"]["PayNowError"];
|
|
1461
|
+
};
|
|
1462
|
+
};
|
|
1463
|
+
};
|
|
1464
|
+
};
|
|
1465
|
+
Products_GetStorefrontProducts: {
|
|
1466
|
+
parameters: {
|
|
1467
|
+
query?: {
|
|
1468
|
+
/** @description Tag slugs to filter by. Each tag slug is a separate query parameter. */
|
|
1469
|
+
tag?: string[];
|
|
1470
|
+
/** @description The ISO three-letter lowercase currency code (e.g., usd, eur, gbp) to display prices in. If not provided, the store's default currency will be used. */
|
|
1471
|
+
currency?: string;
|
|
1472
|
+
};
|
|
1473
|
+
header?: {
|
|
1474
|
+
/** @description The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser. */
|
|
1475
|
+
"x-paynow-customer-ip"?: string;
|
|
1476
|
+
/** @description The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available. */
|
|
1477
|
+
"x-paynow-customer-countrycode"?: string;
|
|
1478
|
+
};
|
|
1479
|
+
path?: never;
|
|
1480
|
+
cookie?: never;
|
|
1481
|
+
};
|
|
1482
|
+
requestBody?: never;
|
|
1483
|
+
responses: {
|
|
1484
|
+
/** @description OK */
|
|
1485
|
+
200: {
|
|
1486
|
+
headers: {
|
|
1487
|
+
[name: string]: unknown;
|
|
1488
|
+
};
|
|
1489
|
+
content: {
|
|
1490
|
+
"application/json": components["schemas"]["StorefrontProductDto"][];
|
|
1491
|
+
};
|
|
1492
|
+
};
|
|
1493
|
+
/** @description Error response */
|
|
1494
|
+
default: {
|
|
1495
|
+
headers: {
|
|
1496
|
+
[name: string]: unknown;
|
|
1497
|
+
};
|
|
1498
|
+
content: {
|
|
1499
|
+
"application/json": components["schemas"]["PayNowError"];
|
|
1500
|
+
};
|
|
1501
|
+
};
|
|
1502
|
+
};
|
|
1503
|
+
};
|
|
1504
|
+
Products_GetStorefrontProductByIdOrSlug: {
|
|
1505
|
+
parameters: {
|
|
1506
|
+
query?: {
|
|
1507
|
+
/** @description The ISO three-letter lowercase currency code (e.g., usd, eur, gbp) to display prices in. If not provided, the store's default currency will be used. */
|
|
1508
|
+
currency?: string;
|
|
1509
|
+
};
|
|
1510
|
+
header?: {
|
|
1511
|
+
/** @description The IP address (IPv4 or IPv6) of the customer. Required if the request is not being made from the customer's browser. */
|
|
1512
|
+
"x-paynow-customer-ip"?: string;
|
|
1513
|
+
/** @description The customer's country code in ISO 3166-1 alpha-2 format. Optional, but recommended if you have this available. */
|
|
1514
|
+
"x-paynow-customer-countrycode"?: string;
|
|
1515
|
+
};
|
|
1516
|
+
path: {
|
|
1517
|
+
idOrSlug: string;
|
|
1518
|
+
};
|
|
1519
|
+
cookie?: never;
|
|
1520
|
+
};
|
|
1521
|
+
requestBody?: never;
|
|
1522
|
+
responses: {
|
|
1523
|
+
/** @description OK */
|
|
1524
|
+
200: {
|
|
1525
|
+
headers: {
|
|
1526
|
+
[name: string]: unknown;
|
|
1527
|
+
};
|
|
1528
|
+
content: {
|
|
1529
|
+
"application/json": components["schemas"]["StorefrontProductDto"];
|
|
1530
|
+
};
|
|
1531
|
+
};
|
|
1532
|
+
/** @description Error response */
|
|
1533
|
+
default: {
|
|
1534
|
+
headers: {
|
|
1535
|
+
[name: string]: unknown;
|
|
1536
|
+
};
|
|
1537
|
+
content: {
|
|
1538
|
+
"application/json": components["schemas"]["PayNowError"];
|
|
1539
|
+
};
|
|
1540
|
+
};
|
|
1541
|
+
};
|
|
1542
|
+
};
|
|
1543
|
+
Store_GetStorefrontStore: {
|
|
1544
|
+
parameters: {
|
|
1545
|
+
query?: never;
|
|
1546
|
+
header?: never;
|
|
1547
|
+
path?: never;
|
|
1548
|
+
cookie?: never;
|
|
1549
|
+
};
|
|
1550
|
+
requestBody?: never;
|
|
1551
|
+
responses: {
|
|
1552
|
+
/** @description OK */
|
|
1553
|
+
200: {
|
|
1554
|
+
headers: {
|
|
1555
|
+
[name: string]: unknown;
|
|
1556
|
+
};
|
|
1557
|
+
content: {
|
|
1558
|
+
"application/json": components["schemas"]["StorefrontStoreDto"];
|
|
1559
|
+
};
|
|
1560
|
+
};
|
|
1561
|
+
/** @description Error response */
|
|
1562
|
+
default: {
|
|
1563
|
+
headers: {
|
|
1564
|
+
[name: string]: unknown;
|
|
1565
|
+
};
|
|
1566
|
+
content: {
|
|
1567
|
+
"application/json": components["schemas"]["PayNowError"];
|
|
1568
|
+
};
|
|
1569
|
+
};
|
|
1570
|
+
};
|
|
1571
|
+
};
|
|
1572
|
+
Tags_GetStorefrontTags: {
|
|
1573
|
+
parameters: {
|
|
1574
|
+
query?: never;
|
|
1575
|
+
header?: never;
|
|
1576
|
+
path?: never;
|
|
1577
|
+
cookie?: never;
|
|
1578
|
+
};
|
|
1579
|
+
requestBody?: never;
|
|
1580
|
+
responses: {
|
|
1581
|
+
/** @description OK */
|
|
1582
|
+
200: {
|
|
1583
|
+
headers: {
|
|
1584
|
+
[name: string]: unknown;
|
|
1585
|
+
};
|
|
1586
|
+
content: {
|
|
1587
|
+
"application/json": components["schemas"]["StorefrontTagDto"][];
|
|
1588
|
+
};
|
|
1589
|
+
};
|
|
1590
|
+
/** @description Error response */
|
|
1591
|
+
default: {
|
|
1592
|
+
headers: {
|
|
1593
|
+
[name: string]: unknown;
|
|
1594
|
+
};
|
|
1595
|
+
content: {
|
|
1596
|
+
"application/json": components["schemas"]["PayNowError"];
|
|
1597
|
+
};
|
|
1598
|
+
};
|
|
1599
|
+
};
|
|
1600
|
+
};
|
|
1601
|
+
}
|
|
1602
|
+
export declare const operationMappings: {
|
|
1603
|
+
readonly Cart_GetCart: {
|
|
1604
|
+
readonly method: "GET";
|
|
1605
|
+
readonly path: "/v1/store/cart";
|
|
1606
|
+
};
|
|
1607
|
+
readonly Cart_ClearCart: {
|
|
1608
|
+
readonly method: "DELETE";
|
|
1609
|
+
readonly path: "/v1/store/cart";
|
|
1610
|
+
};
|
|
1611
|
+
readonly Cart_AddLine: {
|
|
1612
|
+
readonly method: "PUT";
|
|
1613
|
+
readonly path: "/v1/store/cart/lines";
|
|
1614
|
+
};
|
|
1615
|
+
readonly Cart_CreateCartCheckout: {
|
|
1616
|
+
readonly method: "POST";
|
|
1617
|
+
readonly path: "/v1/store/cart/checkout";
|
|
1618
|
+
};
|
|
1619
|
+
readonly Checkout_CreateCheckoutSession: {
|
|
1620
|
+
readonly method: "POST";
|
|
1621
|
+
readonly path: "/v1/checkouts";
|
|
1622
|
+
};
|
|
1623
|
+
readonly Customer_GetStorefrontCustomer: {
|
|
1624
|
+
readonly method: "GET";
|
|
1625
|
+
readonly path: "/v1/store/customer";
|
|
1626
|
+
};
|
|
1627
|
+
readonly Customer_GetStorefrontGiftCard: {
|
|
1628
|
+
readonly method: "GET";
|
|
1629
|
+
readonly path: "/v1/store/customer/giftcards/lookup/{code}";
|
|
1630
|
+
};
|
|
1631
|
+
readonly Customer_RootGetStorefrontCustomerDeliveryItems: {
|
|
1632
|
+
readonly method: "GET";
|
|
1633
|
+
readonly path: "/v1/store/customer/command-delivery";
|
|
1634
|
+
};
|
|
1635
|
+
readonly Discord_DoProductsHaveDiscordActions: {
|
|
1636
|
+
readonly method: "GET";
|
|
1637
|
+
readonly path: "/v1/stores/{storeId}/product_versions/discord_actions";
|
|
1638
|
+
};
|
|
1639
|
+
readonly Navlinks_GetStorefrontNavLinks: {
|
|
1640
|
+
readonly method: "GET";
|
|
1641
|
+
readonly path: "/v1/store/navlinks";
|
|
1642
|
+
};
|
|
1643
|
+
readonly Products_GetStorefrontProducts: {
|
|
1644
|
+
readonly method: "GET";
|
|
1645
|
+
readonly path: "/v1/store/products";
|
|
1646
|
+
};
|
|
1647
|
+
readonly Products_GetStorefrontProductByIdOrSlug: {
|
|
1648
|
+
readonly method: "GET";
|
|
1649
|
+
readonly path: "/v1/store/products/{idOrSlug}";
|
|
1650
|
+
};
|
|
1651
|
+
readonly Store_GetStorefrontStore: {
|
|
1652
|
+
readonly method: "GET";
|
|
1653
|
+
readonly path: "/v1/store";
|
|
1654
|
+
};
|
|
1655
|
+
readonly Tags_GetStorefrontTags: {
|
|
1656
|
+
readonly method: "GET";
|
|
1657
|
+
readonly path: "/v1/store/tags";
|
|
1658
|
+
};
|
|
1659
|
+
};
|
|
1660
|
+
//# sourceMappingURL=storefront.d.ts.map
|