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