@paynow-gg/typescript-sdk 1.0.25 → 1.0.26
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.
|
@@ -1684,18 +1684,18 @@ export interface components {
|
|
|
1684
1684
|
* Format: int64
|
|
1685
1685
|
* @description The optional maximum order value beyond which an abandoned checkout email will not be sent.
|
|
1686
1686
|
*/
|
|
1687
|
-
maximum_order_value?:
|
|
1687
|
+
maximum_order_value?: null | number;
|
|
1688
1688
|
/**
|
|
1689
1689
|
* Format: int32
|
|
1690
1690
|
* @description The optional maximum coupons limit per customer beyond which an abandoned checkout email will not be sent.
|
|
1691
1691
|
*/
|
|
1692
|
-
max_coupons_per_customer_amount?:
|
|
1692
|
+
max_coupons_per_customer_amount?: null | number;
|
|
1693
1693
|
max_coupons_per_customer_period?: components["schemas"]["Period"];
|
|
1694
1694
|
/**
|
|
1695
1695
|
* Format: int32
|
|
1696
1696
|
* @description The optional maximum coupons limit store wide beyond which an abandoned checkout email will not be sent.
|
|
1697
1697
|
*/
|
|
1698
|
-
max_coupons_global_amount?:
|
|
1698
|
+
max_coupons_global_amount?: null | number;
|
|
1699
1699
|
max_coupons_global_period?: components["schemas"]["Period"];
|
|
1700
1700
|
coupon_configuration: components["schemas"]["MarketingCouponConfigurationDto"];
|
|
1701
1701
|
/** @description The commands you want to execute when the email is sent. */
|
|
@@ -1728,18 +1728,18 @@ export interface components {
|
|
|
1728
1728
|
* Format: int64
|
|
1729
1729
|
* @description The optional maximum order value beyond which an abandoned checkout email will not be sent.
|
|
1730
1730
|
*/
|
|
1731
|
-
maximum_order_value?:
|
|
1731
|
+
maximum_order_value?: null | number;
|
|
1732
1732
|
/**
|
|
1733
1733
|
* Format: int32
|
|
1734
1734
|
* @description The optional maximum coupons limit per customer beyond which an abandoned checkout email will not be sent.
|
|
1735
1735
|
*/
|
|
1736
|
-
max_coupons_per_customer_amount?:
|
|
1736
|
+
max_coupons_per_customer_amount?: null | number;
|
|
1737
1737
|
max_coupons_per_customer_period?: components["schemas"]["Period"];
|
|
1738
1738
|
/**
|
|
1739
1739
|
* Format: int32
|
|
1740
1740
|
* @description The optional maximum coupons limit store wide beyond which an abandoned checkout email will not be sent.
|
|
1741
1741
|
*/
|
|
1742
|
-
max_coupons_global_amount?:
|
|
1742
|
+
max_coupons_global_amount?: null | number;
|
|
1743
1743
|
max_coupons_global_period?: components["schemas"]["Period"];
|
|
1744
1744
|
commands: components["schemas"]["AbandonedCheckoutStoreConfigurationUpdateCommandDto"][];
|
|
1745
1745
|
coupon_configuration: components["schemas"]["MarketingCouponConfigurationDto"];
|
|
@@ -1773,7 +1773,7 @@ export interface components {
|
|
|
1773
1773
|
created_at: string;
|
|
1774
1774
|
updated_by?: components["schemas"]["ActorDto"];
|
|
1775
1775
|
/** Format: date-time */
|
|
1776
|
-
updated_at?:
|
|
1776
|
+
updated_at?: null | string;
|
|
1777
1777
|
};
|
|
1778
1778
|
/** @enum {string} */
|
|
1779
1779
|
AffiliateLinkRefererType: "invalid" | "first_referer" | "last_referer";
|
|
@@ -1783,12 +1783,12 @@ export interface components {
|
|
|
1783
1783
|
* @description The Alipay buyer identifier
|
|
1784
1784
|
* @example buyer_abc123
|
|
1785
1785
|
*/
|
|
1786
|
-
buyer_id?:
|
|
1786
|
+
buyer_id?: null | string;
|
|
1787
1787
|
/**
|
|
1788
1788
|
* @description A unique fingerprint for this Alipay account
|
|
1789
1789
|
* @example fingerprint_xyz789
|
|
1790
1790
|
*/
|
|
1791
|
-
fingerprint?:
|
|
1791
|
+
fingerprint?: null | string;
|
|
1792
1792
|
};
|
|
1793
1793
|
BanDto: {
|
|
1794
1794
|
id: components["schemas"]["FlakeId"];
|
|
@@ -1800,10 +1800,10 @@ export interface components {
|
|
|
1800
1800
|
/** Format: date-time */
|
|
1801
1801
|
created_at: string;
|
|
1802
1802
|
/** Format: date-time */
|
|
1803
|
-
updated_at?:
|
|
1803
|
+
updated_at?: null | string;
|
|
1804
1804
|
updated_by?: components["schemas"]["ActorDto"];
|
|
1805
1805
|
/** Format: date-time */
|
|
1806
|
-
expires_at?:
|
|
1806
|
+
expires_at?: null | string;
|
|
1807
1807
|
};
|
|
1808
1808
|
BanIdentityDto: {
|
|
1809
1809
|
ban_type: components["schemas"]["BanType"];
|
|
@@ -1817,27 +1817,27 @@ export interface components {
|
|
|
1817
1817
|
* @description The bank identifier
|
|
1818
1818
|
* @example bnp_paribas
|
|
1819
1819
|
*/
|
|
1820
|
-
bank?:
|
|
1820
|
+
bank?: null | string;
|
|
1821
1821
|
/**
|
|
1822
1822
|
* @description The bank name
|
|
1823
1823
|
* @example BNP Paribas
|
|
1824
1824
|
*/
|
|
1825
|
-
bank_name?:
|
|
1825
|
+
bank_name?: null | string;
|
|
1826
1826
|
/**
|
|
1827
1827
|
* @description The Bank Identifier Code
|
|
1828
1828
|
* @example GEBABEBB
|
|
1829
1829
|
*/
|
|
1830
|
-
bic?:
|
|
1830
|
+
bic?: null | string;
|
|
1831
1831
|
/**
|
|
1832
1832
|
* @description The last 4 digits of the IBAN
|
|
1833
1833
|
* @example 3456
|
|
1834
1834
|
*/
|
|
1835
|
-
iban_last4?:
|
|
1835
|
+
iban_last4?: null | string;
|
|
1836
1836
|
/**
|
|
1837
1837
|
* @description The payer name
|
|
1838
1838
|
* @example Jean Dupont
|
|
1839
1839
|
*/
|
|
1840
|
-
payer_name?:
|
|
1840
|
+
payer_name?: null | string;
|
|
1841
1841
|
};
|
|
1842
1842
|
/** @description Card payment method details */
|
|
1843
1843
|
CardDetailsDto: {
|
|
@@ -1883,19 +1883,19 @@ export interface components {
|
|
|
1883
1883
|
* Only available internally.
|
|
1884
1884
|
* @example 424242
|
|
1885
1885
|
*/
|
|
1886
|
-
bin?:
|
|
1886
|
+
bin?: null | string;
|
|
1887
1887
|
/**
|
|
1888
1888
|
* @description The card issuer/bank name.
|
|
1889
1889
|
* Only available internally.
|
|
1890
1890
|
* @example Chase Bank
|
|
1891
1891
|
*/
|
|
1892
|
-
issuer?:
|
|
1892
|
+
issuer?: null | string;
|
|
1893
1893
|
/**
|
|
1894
1894
|
* @description The card description.
|
|
1895
1895
|
* Only available internally.
|
|
1896
1896
|
* @example Visa Signature
|
|
1897
1897
|
*/
|
|
1898
|
-
description?:
|
|
1898
|
+
description?: null | string;
|
|
1899
1899
|
wallet?: components["schemas"]["CardWalletDto"];
|
|
1900
1900
|
};
|
|
1901
1901
|
/** @description Digital wallet details for a card */
|
|
@@ -1933,19 +1933,19 @@ export interface components {
|
|
|
1933
1933
|
inventory_item_id?: components["schemas"]["FlakeId"];
|
|
1934
1934
|
gameserver_id: components["schemas"]["FlakeId"];
|
|
1935
1935
|
steam_id?: components["schemas"]["SteamId"];
|
|
1936
|
-
minecraft_uuid?:
|
|
1937
|
-
customer_name?:
|
|
1936
|
+
minecraft_uuid?: null | string;
|
|
1937
|
+
customer_name?: null | string;
|
|
1938
1938
|
customer_id?: components["schemas"]["FlakeId"];
|
|
1939
|
-
command_stage?:
|
|
1939
|
+
command_stage?: null | string;
|
|
1940
1940
|
command: string;
|
|
1941
1941
|
online_only: boolean;
|
|
1942
1942
|
rerun: boolean;
|
|
1943
1943
|
/** Format: date-time */
|
|
1944
1944
|
queued_at: string;
|
|
1945
1945
|
/** Format: date-time */
|
|
1946
|
-
executed_at?:
|
|
1946
|
+
executed_at?: null | string;
|
|
1947
1947
|
/** Format: date-time */
|
|
1948
|
-
unqueued_at?:
|
|
1948
|
+
unqueued_at?: null | string;
|
|
1949
1949
|
};
|
|
1950
1950
|
/**
|
|
1951
1951
|
* @description Specifies the type of discount applied by a coupon.
|
|
@@ -1961,13 +1961,13 @@ export interface components {
|
|
|
1961
1961
|
/** @description The unique code associated with the coupon. */
|
|
1962
1962
|
code: string;
|
|
1963
1963
|
/** @description A note or internal description of the coupon. */
|
|
1964
|
-
note?:
|
|
1964
|
+
note?: null | string;
|
|
1965
1965
|
duration: components["schemas"]["CouponDurationEnum"];
|
|
1966
1966
|
/**
|
|
1967
1967
|
* Format: int32
|
|
1968
1968
|
* @description The number of months the coupon is valid, used if the duration is repeating.
|
|
1969
1969
|
*/
|
|
1970
|
-
duration_in_months?:
|
|
1970
|
+
duration_in_months?: null | number;
|
|
1971
1971
|
discount_type: components["schemas"]["CouponDiscountTypeEnum"];
|
|
1972
1972
|
/**
|
|
1973
1973
|
* Format: int64
|
|
@@ -1979,9 +1979,9 @@ export interface components {
|
|
|
1979
1979
|
/** @description Indicates whether the discount is applied before existing sales. */
|
|
1980
1980
|
discount_apply_before_sales: boolean;
|
|
1981
1981
|
/** @description A list of product IDs the coupon applies to. */
|
|
1982
|
-
apply_to_products?: components["schemas"]["FlakeId"][]
|
|
1982
|
+
apply_to_products?: null | components["schemas"]["FlakeId"][];
|
|
1983
1983
|
/** @description A list of tag IDs the coupon applies to. */
|
|
1984
|
-
apply_to_tags?: components["schemas"]["FlakeId"][]
|
|
1984
|
+
apply_to_tags?: null | components["schemas"]["FlakeId"][];
|
|
1985
1985
|
usable_by_customer_id?: components["schemas"]["FlakeId"];
|
|
1986
1986
|
/**
|
|
1987
1987
|
* Format: int64
|
|
@@ -2010,12 +2010,12 @@ export interface components {
|
|
|
2010
2010
|
* Format: date-time
|
|
2011
2011
|
* @description The date and time when the coupon becomes valid.
|
|
2012
2012
|
*/
|
|
2013
|
-
usable_at?:
|
|
2013
|
+
usable_at?: null | string;
|
|
2014
2014
|
/**
|
|
2015
2015
|
* Format: date-time
|
|
2016
2016
|
* @description The date and time when the coupon expires.
|
|
2017
2017
|
*/
|
|
2018
|
-
expires_at?:
|
|
2018
|
+
expires_at?: null | string;
|
|
2019
2019
|
created_by?: components["schemas"]["ActorDto"];
|
|
2020
2020
|
/**
|
|
2021
2021
|
* Format: date-time
|
|
@@ -2027,7 +2027,7 @@ export interface components {
|
|
|
2027
2027
|
* Format: date-time
|
|
2028
2028
|
* @description The date and time when the coupon was last updated.
|
|
2029
2029
|
*/
|
|
2030
|
-
updated_at?:
|
|
2030
|
+
updated_at?: null | string;
|
|
2031
2031
|
};
|
|
2032
2032
|
/**
|
|
2033
2033
|
* @description Defines the duration for which a coupon remains valid.
|
|
@@ -2063,9 +2063,9 @@ export interface components {
|
|
|
2063
2063
|
CreateCheckoutSessionLineDto: {
|
|
2064
2064
|
product_id: components["schemas"]["FlakeId"];
|
|
2065
2065
|
/** @description Determines whether this line should create a subscription */
|
|
2066
|
-
subscription?:
|
|
2066
|
+
subscription?: null | boolean;
|
|
2067
2067
|
/** @description Indicates whether the product should be trialed */
|
|
2068
|
-
trial?:
|
|
2068
|
+
trial?: null | boolean;
|
|
2069
2069
|
gift_to?: components["schemas"]["CustomerPlatformAccountDto"];
|
|
2070
2070
|
gift_to_customer_id?: components["schemas"]["FlakeId"];
|
|
2071
2071
|
/**
|
|
@@ -2076,23 +2076,23 @@ export interface components {
|
|
|
2076
2076
|
selected_gameserver_id?: components["schemas"]["FlakeId"];
|
|
2077
2077
|
/** @description Optional metadata to associate with the checkout session line.
|
|
2078
2078
|
* Do not store any sensitive information here. */
|
|
2079
|
-
metadata?: {
|
|
2079
|
+
metadata?: null | {
|
|
2080
2080
|
[key: string]: string;
|
|
2081
|
-
}
|
|
2081
|
+
};
|
|
2082
2082
|
/** @description Key-value pair mapping custom variable identifiers to their selected values.
|
|
2083
2083
|
* Required only when the product includes custom variables. */
|
|
2084
|
-
custom_variables?: {
|
|
2084
|
+
custom_variables?: null | {
|
|
2085
2085
|
[key: string]: string;
|
|
2086
|
-
}
|
|
2086
|
+
};
|
|
2087
2087
|
};
|
|
2088
2088
|
/** @description Represents a line item in a checkout session request.
|
|
2089
2089
|
* Opposed to CreateCheckoutSessionLineDto, this is used while creating a checkout session using the Management API,
|
|
2090
2090
|
* and allows for creating inline products (which is subject to special approval) */
|
|
2091
2091
|
CreateCheckoutSessionLineManagementDto: {
|
|
2092
2092
|
/** @description Determines whether this line should create a subscription */
|
|
2093
|
-
subscription?:
|
|
2093
|
+
subscription?: null | boolean;
|
|
2094
2094
|
/** @description Indicates whether the product should be trialed */
|
|
2095
|
-
trial?:
|
|
2095
|
+
trial?: null | boolean;
|
|
2096
2096
|
gift_to?: components["schemas"]["CustomerPlatformAccountDto"];
|
|
2097
2097
|
gift_to_customer_id?: components["schemas"]["FlakeId"];
|
|
2098
2098
|
/**
|
|
@@ -2103,14 +2103,14 @@ export interface components {
|
|
|
2103
2103
|
selected_gameserver_id?: components["schemas"]["FlakeId"];
|
|
2104
2104
|
/** @description Optional metadata to associate with the checkout session line.
|
|
2105
2105
|
* Do not store any sensitive information here. */
|
|
2106
|
-
metadata?: {
|
|
2106
|
+
metadata?: null | {
|
|
2107
2107
|
[key: string]: string;
|
|
2108
|
-
}
|
|
2108
|
+
};
|
|
2109
2109
|
/** @description Key-value pair mapping custom variable identifiers to their selected values.
|
|
2110
2110
|
* Required only when the product includes custom variables. */
|
|
2111
|
-
custom_variables?: {
|
|
2111
|
+
custom_variables?: null | {
|
|
2112
2112
|
[key: string]: string;
|
|
2113
|
-
}
|
|
2113
|
+
};
|
|
2114
2114
|
product_id?: components["schemas"]["FlakeId"];
|
|
2115
2115
|
inline_product?: components["schemas"]["InlineProductCreateDto"];
|
|
2116
2116
|
};
|
|
@@ -2124,21 +2124,21 @@ export interface components {
|
|
|
2124
2124
|
* @description Whether this checkout creates a subscription.
|
|
2125
2125
|
* DEPRECATED: Use 'subscription' field in 'lines' array objects instead.
|
|
2126
2126
|
*/
|
|
2127
|
-
subscription?:
|
|
2127
|
+
subscription?: null | boolean;
|
|
2128
2128
|
coupon_id?: components["schemas"]["FlakeId"];
|
|
2129
2129
|
/** @description Optional affiliate code to track referrals */
|
|
2130
|
-
affiliate_code?:
|
|
2130
|
+
affiliate_code?: null | string;
|
|
2131
2131
|
/** @description Optional URL to redirect to after successful checkout */
|
|
2132
|
-
return_url?:
|
|
2132
|
+
return_url?: null | string;
|
|
2133
2133
|
/** @description Optional URL to redirect to if checkout is canceled */
|
|
2134
|
-
cancel_url?:
|
|
2134
|
+
cancel_url?: null | string;
|
|
2135
2135
|
/** @description Whether to automatically redirect the customer (return_url must be set) */
|
|
2136
|
-
auto_redirect?:
|
|
2136
|
+
auto_redirect?: null | boolean;
|
|
2137
2137
|
/** @description Optional metadata to associate with the checkout session.
|
|
2138
2138
|
* Do not store any sensitive information here. */
|
|
2139
|
-
metadata?: {
|
|
2139
|
+
metadata?: null | {
|
|
2140
2140
|
[key: string]: string;
|
|
2141
|
-
}
|
|
2141
|
+
};
|
|
2142
2142
|
customer_id: components["schemas"]["FlakeId"];
|
|
2143
2143
|
};
|
|
2144
2144
|
/** @description Response after creating a checkout session */
|
|
@@ -2155,7 +2155,7 @@ export interface components {
|
|
|
2155
2155
|
note?: string;
|
|
2156
2156
|
duration: components["schemas"]["CouponDurationEnum"];
|
|
2157
2157
|
/** Format: int32 */
|
|
2158
|
-
duration_in_months?: number;
|
|
2158
|
+
duration_in_months?: null | number;
|
|
2159
2159
|
discount_type: components["schemas"]["CouponDiscountTypeEnum"];
|
|
2160
2160
|
/** Format: int64 */
|
|
2161
2161
|
discount_amount: number;
|
|
@@ -2175,9 +2175,9 @@ export interface components {
|
|
|
2175
2175
|
usable_on_one_time_purchase: boolean;
|
|
2176
2176
|
usable_on_subscription: boolean;
|
|
2177
2177
|
/** Format: date-time */
|
|
2178
|
-
usable_at?: string;
|
|
2178
|
+
usable_at?: null | string;
|
|
2179
2179
|
/** Format: date-time */
|
|
2180
|
-
expires_at?: string;
|
|
2180
|
+
expires_at?: null | string;
|
|
2181
2181
|
};
|
|
2182
2182
|
CreateDownloadableFileDownloadUrlResponseDto: {
|
|
2183
2183
|
download_signed_url: string;
|
|
@@ -2195,19 +2195,19 @@ export interface components {
|
|
|
2195
2195
|
/** Format: date-time */
|
|
2196
2196
|
usable_at: string;
|
|
2197
2197
|
/** Format: date-time */
|
|
2198
|
-
expires_at?: string;
|
|
2198
|
+
expires_at?: null | string;
|
|
2199
2199
|
};
|
|
2200
2200
|
CreateNavLinkDto: {
|
|
2201
2201
|
tag_id: components["schemas"]["FlakeId"];
|
|
2202
2202
|
parent_node_id?: string;
|
|
2203
2203
|
/** Format: int32 */
|
|
2204
|
-
order?: number;
|
|
2204
|
+
order?: null | number;
|
|
2205
2205
|
};
|
|
2206
2206
|
CreateRefundRequestDto: {
|
|
2207
2207
|
order_line_id?: components["schemas"]["FlakeId"];
|
|
2208
2208
|
/** @description Determines if the refund should be taken from the connected user's balance.
|
|
2209
2209
|
* Only relevant for connected platforms. */
|
|
2210
|
-
refund_from_connected_user_balance?:
|
|
2210
|
+
refund_from_connected_user_balance?: null | boolean;
|
|
2211
2211
|
};
|
|
2212
2212
|
CreateSaleDto: {
|
|
2213
2213
|
enabled: boolean;
|
|
@@ -2222,7 +2222,7 @@ export interface components {
|
|
|
2222
2222
|
/** Format: date-time */
|
|
2223
2223
|
begins_at: string;
|
|
2224
2224
|
/** Format: date-time */
|
|
2225
|
-
ends_at?: string;
|
|
2225
|
+
ends_at?: null | string;
|
|
2226
2226
|
};
|
|
2227
2227
|
CreateStorePaymentSettingsDto: {
|
|
2228
2228
|
show_all_payment_methods_for_subscriptions: boolean;
|
|
@@ -2239,9 +2239,9 @@ export interface components {
|
|
|
2239
2239
|
url: string;
|
|
2240
2240
|
subscribed_to: components["schemas"]["WebhookEventType"];
|
|
2241
2241
|
type: components["schemas"]["WebhookType"];
|
|
2242
|
-
discord_description_template?:
|
|
2243
|
-
discord_title?:
|
|
2244
|
-
discord_color?:
|
|
2242
|
+
discord_description_template?: null | string;
|
|
2243
|
+
discord_title?: null | string;
|
|
2244
|
+
discord_color?: null | string;
|
|
2245
2245
|
};
|
|
2246
2246
|
/** @description Cryptocurrency payment method details */
|
|
2247
2247
|
CryptoDetailsDto: {
|
|
@@ -2281,7 +2281,7 @@ export interface components {
|
|
|
2281
2281
|
/** @description Optional regex pattern to validate text/number input values.
|
|
2282
2282
|
* Only applies to text and number types.
|
|
2283
2283
|
* Uses RE2 syntax - does not support negative lookarounds, backreferences, or other advanced regex features. */
|
|
2284
|
-
value_regex?:
|
|
2284
|
+
value_regex?: null | string;
|
|
2285
2285
|
/** @description Available options for dropdown type custom variables.
|
|
2286
2286
|
* Empty for text and number types. */
|
|
2287
2287
|
options: components["schemas"]["CustomVariableOptionDto"][];
|
|
@@ -2297,7 +2297,7 @@ export interface components {
|
|
|
2297
2297
|
* @description When this custom variable was last updated.
|
|
2298
2298
|
* Null if never updated.
|
|
2299
2299
|
*/
|
|
2300
|
-
updated_at?:
|
|
2300
|
+
updated_at?: null | string;
|
|
2301
2301
|
};
|
|
2302
2302
|
CustomVariableLineItemDto: {
|
|
2303
2303
|
id: components["schemas"]["FlakeId"];
|
|
@@ -2383,16 +2383,16 @@ export interface components {
|
|
|
2383
2383
|
* and the profile is a bedrock account, this will be a UUID generated from the Xbox XUID.
|
|
2384
2384
|
* @example f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2
|
|
2385
2385
|
*/
|
|
2386
|
-
minecraft_uuid?:
|
|
2386
|
+
minecraft_uuid?: null | string;
|
|
2387
2387
|
minecraft?: components["schemas"]["MinecraftProfileDto"];
|
|
2388
2388
|
/** @description The customer's Xbox XUID, if available. */
|
|
2389
|
-
xbox_xuid?:
|
|
2389
|
+
xbox_xuid?: null | string;
|
|
2390
2390
|
minecraft_platform?: components["schemas"]["CustomerMinecraftPlatform"];
|
|
2391
2391
|
/**
|
|
2392
2392
|
* @description The display name for the customer.
|
|
2393
2393
|
* @example m0uka
|
|
2394
2394
|
*/
|
|
2395
|
-
name?:
|
|
2395
|
+
name?: null | string;
|
|
2396
2396
|
/**
|
|
2397
2397
|
* Format: date-time
|
|
2398
2398
|
* @description The date and time when the customer was created in the system.
|
|
@@ -2402,7 +2402,7 @@ export interface components {
|
|
|
2402
2402
|
* Format: date-time
|
|
2403
2403
|
* @description The date and time when the customer was last updated, if applicable.
|
|
2404
2404
|
*/
|
|
2405
|
-
updated_at?:
|
|
2405
|
+
updated_at?: null | string;
|
|
2406
2406
|
/** @description Additional custom data associated with the customer. */
|
|
2407
2407
|
metadata: {
|
|
2408
2408
|
[key: string]: string;
|
|
@@ -2433,7 +2433,7 @@ export interface components {
|
|
|
2433
2433
|
/** @description Masked authentication token used for accessing the source platform API. */
|
|
2434
2434
|
token: string;
|
|
2435
2435
|
/** @description Error message if the migration encountered any errors, otherwise null. */
|
|
2436
|
-
error?:
|
|
2436
|
+
error?: null | string;
|
|
2437
2437
|
/**
|
|
2438
2438
|
* Format: date-time
|
|
2439
2439
|
* @description Timestamp when the migration was initiated.
|
|
@@ -2443,17 +2443,17 @@ export interface components {
|
|
|
2443
2443
|
* Format: date-time
|
|
2444
2444
|
* @description Timestamp when the migration failed, or null if it didn't fail.
|
|
2445
2445
|
*/
|
|
2446
|
-
failed_at?:
|
|
2446
|
+
failed_at?: null | string;
|
|
2447
2447
|
/**
|
|
2448
2448
|
* Format: date-time
|
|
2449
2449
|
* @description Timestamp when the migration was successfully completed, or null if not completed.
|
|
2450
2450
|
*/
|
|
2451
|
-
completed_at?:
|
|
2451
|
+
completed_at?: null | string;
|
|
2452
2452
|
/**
|
|
2453
2453
|
* Format: int64
|
|
2454
2454
|
* @description Total number of entities that need to be migrated, or null if unknown.
|
|
2455
2455
|
*/
|
|
2456
|
-
total_entities_to_migrate?:
|
|
2456
|
+
total_entities_to_migrate?: null | number;
|
|
2457
2457
|
/**
|
|
2458
2458
|
* Format: int32
|
|
2459
2459
|
* @description Number of entities that have been successfully migrated.
|
|
@@ -2469,18 +2469,18 @@ export interface components {
|
|
|
2469
2469
|
* Format: int32
|
|
2470
2470
|
* @description Quantity of products to assign.
|
|
2471
2471
|
*/
|
|
2472
|
-
quantity?:
|
|
2472
|
+
quantity?: null | number;
|
|
2473
2473
|
/**
|
|
2474
2474
|
* Format: date-time
|
|
2475
2475
|
* @description Override expiry date for the delivery item.
|
|
2476
2476
|
*/
|
|
2477
|
-
override_expires_at?:
|
|
2477
|
+
override_expires_at?: null | string;
|
|
2478
2478
|
/** @description Skip command execution when assigning the item. */
|
|
2479
|
-
skip_commands?:
|
|
2479
|
+
skip_commands?: null | boolean;
|
|
2480
2480
|
/** @description Custom variables for the assignment. */
|
|
2481
|
-
custom_variables?: {
|
|
2481
|
+
custom_variables?: null | {
|
|
2482
2482
|
[key: string]: string;
|
|
2483
|
-
}
|
|
2483
|
+
};
|
|
2484
2484
|
};
|
|
2485
2485
|
DeliveryItemAssignmentDto: {
|
|
2486
2486
|
product_id?: components["schemas"]["FlakeId"];
|
|
@@ -2490,18 +2490,18 @@ export interface components {
|
|
|
2490
2490
|
* Format: int32
|
|
2491
2491
|
* @description Quantity of products to assign.
|
|
2492
2492
|
*/
|
|
2493
|
-
quantity?:
|
|
2493
|
+
quantity?: null | number;
|
|
2494
2494
|
/**
|
|
2495
2495
|
* Format: date-time
|
|
2496
2496
|
* @description Override expiry date for the delivery item.
|
|
2497
2497
|
*/
|
|
2498
|
-
override_expires_at?:
|
|
2498
|
+
override_expires_at?: null | string;
|
|
2499
2499
|
/** @description Skip command execution when assigning the item. */
|
|
2500
|
-
skip_commands?:
|
|
2500
|
+
skip_commands?: null | boolean;
|
|
2501
2501
|
/** @description Custom variables for the assignment. */
|
|
2502
|
-
custom_variables?: {
|
|
2502
|
+
custom_variables?: null | {
|
|
2503
2503
|
[key: string]: string;
|
|
2504
|
-
}
|
|
2504
|
+
};
|
|
2505
2505
|
};
|
|
2506
2506
|
/** @description Represents a delivery item assigned to a customer */
|
|
2507
2507
|
DeliveryItemDto: {
|
|
@@ -2522,7 +2522,7 @@ export interface components {
|
|
|
2522
2522
|
* Format: int32
|
|
2523
2523
|
* @description The index of the item when multiple quantities were assigned
|
|
2524
2524
|
*/
|
|
2525
|
-
quantity_index?:
|
|
2525
|
+
quantity_index?: null | number;
|
|
2526
2526
|
product: components["schemas"]["DeliveryItemProductDto"];
|
|
2527
2527
|
state: components["schemas"]["DeliveryItemStateDto"];
|
|
2528
2528
|
/**
|
|
@@ -2535,31 +2535,31 @@ export interface components {
|
|
|
2535
2535
|
* Format: date-time
|
|
2536
2536
|
* @description The date and time when the item became active
|
|
2537
2537
|
*/
|
|
2538
|
-
active_at?:
|
|
2538
|
+
active_at?: null | string;
|
|
2539
2539
|
/** @description Indicates whether the delivery item can expire */
|
|
2540
2540
|
expirable: boolean;
|
|
2541
2541
|
/**
|
|
2542
2542
|
* Format: date-time
|
|
2543
2543
|
* @description The date and time when the item expires naturally
|
|
2544
2544
|
*/
|
|
2545
|
-
expires_at?:
|
|
2545
|
+
expires_at?: null | string;
|
|
2546
2546
|
/**
|
|
2547
2547
|
* Format: date-time
|
|
2548
2548
|
* @description The override expiry date for the delivery item
|
|
2549
2549
|
*/
|
|
2550
|
-
override_expires_at?:
|
|
2550
|
+
override_expires_at?: null | string;
|
|
2551
2551
|
/**
|
|
2552
2552
|
* Format: date-time
|
|
2553
2553
|
* @description The date and time when the item was removed
|
|
2554
2554
|
*/
|
|
2555
|
-
removed_at?:
|
|
2555
|
+
removed_at?: null | string;
|
|
2556
2556
|
/**
|
|
2557
2557
|
* Format: date-time
|
|
2558
2558
|
* @description The date and time when the item was revoked
|
|
2559
2559
|
*/
|
|
2560
|
-
revoked_at?:
|
|
2560
|
+
revoked_at?: null | string;
|
|
2561
2561
|
/** @description The reason for revoking the delivery item */
|
|
2562
|
-
revoke_reason?:
|
|
2562
|
+
revoke_reason?: null | string;
|
|
2563
2563
|
revoked_by?: components["schemas"]["ActorDto"];
|
|
2564
2564
|
/** @description The command execution attempts for this delivery item */
|
|
2565
2565
|
command_attempts: components["schemas"]["CommandAttemptDto"][];
|
|
@@ -2604,7 +2604,7 @@ export interface components {
|
|
|
2604
2604
|
action_type: components["schemas"]["DiscordActionType"];
|
|
2605
2605
|
channel_id?: components["schemas"]["FlakeId"];
|
|
2606
2606
|
role_id?: components["schemas"]["FlakeId"];
|
|
2607
|
-
message?:
|
|
2607
|
+
message?: null | string;
|
|
2608
2608
|
};
|
|
2609
2609
|
/** @enum {string} */
|
|
2610
2610
|
DiscordActionExecutionStage: "on_purchase" | "on_expire" | "on_refund" | "on_chargeback";
|
|
@@ -2626,12 +2626,12 @@ export interface components {
|
|
|
2626
2626
|
token: string;
|
|
2627
2627
|
store_id: components["schemas"]["FlakeId"];
|
|
2628
2628
|
server_id?: components["schemas"]["FlakeId"];
|
|
2629
|
-
server_name?:
|
|
2630
|
-
server_icon_url?:
|
|
2629
|
+
server_name?: null | string;
|
|
2630
|
+
server_icon_url?: null | string;
|
|
2631
2631
|
/** Format: date-time */
|
|
2632
2632
|
created_at: string;
|
|
2633
2633
|
/** Format: date-time */
|
|
2634
|
-
linked_at?:
|
|
2634
|
+
linked_at?: null | string;
|
|
2635
2635
|
};
|
|
2636
2636
|
DiscordServerRoleDto: {
|
|
2637
2637
|
id: components["schemas"]["FlakeId"];
|
|
@@ -2642,10 +2642,10 @@ export interface components {
|
|
|
2642
2642
|
/** Format: date-time */
|
|
2643
2643
|
started_at: string;
|
|
2644
2644
|
/** Format: date-time */
|
|
2645
|
-
finished_at?:
|
|
2645
|
+
finished_at?: null | string;
|
|
2646
2646
|
/** Format: int32 */
|
|
2647
2647
|
status_code: number;
|
|
2648
|
-
response?:
|
|
2648
|
+
response?: null | string;
|
|
2649
2649
|
};
|
|
2650
2650
|
FinishTagImageUploadUrlRequestDto: {
|
|
2651
2651
|
/** @description The ID of the uploaded image returned by the server. */
|
|
@@ -2665,12 +2665,12 @@ export interface components {
|
|
|
2665
2665
|
/** @description Indicates whether the game server is currently enabled. */
|
|
2666
2666
|
enabled: boolean;
|
|
2667
2667
|
/** @description The authentication token used by the game server to access the PayNow API. */
|
|
2668
|
-
token?:
|
|
2668
|
+
token?: null | string;
|
|
2669
2669
|
/**
|
|
2670
2670
|
* Format: date-time
|
|
2671
2671
|
* @description The date and time when the authentication token was last reset, if applicable.
|
|
2672
2672
|
*/
|
|
2673
|
-
token_reset_at?:
|
|
2673
|
+
token_reset_at?: null | string;
|
|
2674
2674
|
linked_to: components["schemas"]["GameServerLinkDto"];
|
|
2675
2675
|
/**
|
|
2676
2676
|
* Format: date-time
|
|
@@ -2682,7 +2682,7 @@ export interface components {
|
|
|
2682
2682
|
* Format: date-time
|
|
2683
2683
|
* @description The date and time when the game server was last updated, if applicable.
|
|
2684
2684
|
*/
|
|
2685
|
-
updated_at?:
|
|
2685
|
+
updated_at?: null | string;
|
|
2686
2686
|
updated_by: components["schemas"]["ActorDto"];
|
|
2687
2687
|
};
|
|
2688
2688
|
GameServerLinkDto: {
|
|
@@ -2693,7 +2693,7 @@ export interface components {
|
|
|
2693
2693
|
/** Format: date-time */
|
|
2694
2694
|
saved_at: string;
|
|
2695
2695
|
/** Format: date-time */
|
|
2696
|
-
last_fetched_commands_at?:
|
|
2696
|
+
last_fetched_commands_at?: null | string;
|
|
2697
2697
|
};
|
|
2698
2698
|
/** @description Represents a generic platform profile for a customer. */
|
|
2699
2699
|
GenericProfileDto: {
|
|
@@ -2707,7 +2707,7 @@ export interface components {
|
|
|
2707
2707
|
/** @description The display name of the user on this platform. */
|
|
2708
2708
|
name: string;
|
|
2709
2709
|
/** @description The URL to the user's avatar image on this platform. */
|
|
2710
|
-
avatar_url?:
|
|
2710
|
+
avatar_url?: null | string;
|
|
2711
2711
|
};
|
|
2712
2712
|
GetTagImageUploadUrlResponseDto: {
|
|
2713
2713
|
/** @description The ID of the direct image upload URL. */
|
|
@@ -2727,7 +2727,7 @@ export interface components {
|
|
|
2727
2727
|
*/
|
|
2728
2728
|
code: string;
|
|
2729
2729
|
/** @description Optional note or description associated with the gift card. */
|
|
2730
|
-
note?:
|
|
2730
|
+
note?: null | string;
|
|
2731
2731
|
/**
|
|
2732
2732
|
* Format: int64
|
|
2733
2733
|
* @description The current balance remaining on the gift card in cents.
|
|
@@ -2749,24 +2749,24 @@ export interface components {
|
|
|
2749
2749
|
* Format: date-time
|
|
2750
2750
|
* @description The date and time when the gift card expires, if applicable.
|
|
2751
2751
|
*/
|
|
2752
|
-
expires_at?:
|
|
2752
|
+
expires_at?: null | string;
|
|
2753
2753
|
/**
|
|
2754
2754
|
* Format: date-time
|
|
2755
2755
|
* @description The date and time when the gift card was created.
|
|
2756
2756
|
*/
|
|
2757
|
-
created_at?:
|
|
2757
|
+
created_at?: null | string;
|
|
2758
2758
|
created_by?: components["schemas"]["ActorDto"];
|
|
2759
2759
|
/**
|
|
2760
2760
|
* Format: date-time
|
|
2761
2761
|
* @description The date and time when the gift card was last updated, if applicable.
|
|
2762
2762
|
*/
|
|
2763
|
-
updated_at?:
|
|
2763
|
+
updated_at?: null | string;
|
|
2764
2764
|
updated_by?: components["schemas"]["ActorDto"];
|
|
2765
2765
|
/**
|
|
2766
2766
|
* Format: date-time
|
|
2767
2767
|
* @description The date and time when the gift card was canceled, if applicable.
|
|
2768
2768
|
*/
|
|
2769
|
-
canceled_at?:
|
|
2769
|
+
canceled_at?: null | string;
|
|
2770
2770
|
canceled_by?: components["schemas"]["ActorDto"];
|
|
2771
2771
|
};
|
|
2772
2772
|
/** @description Represents a global command in the system.
|
|
@@ -2792,7 +2792,7 @@ export interface components {
|
|
|
2792
2792
|
* @description Optional timestamp indicating when the command was last updated.
|
|
2793
2793
|
* Null if the command has never been updated.
|
|
2794
2794
|
*/
|
|
2795
|
-
updated_at?:
|
|
2795
|
+
updated_at?: null | string;
|
|
2796
2796
|
updated_by?: components["schemas"]["ActorDto"];
|
|
2797
2797
|
};
|
|
2798
2798
|
/** @description iDEAL payment method details */
|
|
@@ -2811,95 +2811,95 @@ export interface components {
|
|
|
2811
2811
|
* @description The last 4 digits of the IBAN
|
|
2812
2812
|
* @example 1234
|
|
2813
2813
|
*/
|
|
2814
|
-
iban_last4?:
|
|
2814
|
+
iban_last4?: null | string;
|
|
2815
2815
|
/**
|
|
2816
2816
|
* @description The payer name
|
|
2817
2817
|
* @example John Doe
|
|
2818
2818
|
*/
|
|
2819
|
-
payer_name?:
|
|
2819
|
+
payer_name?: null | string;
|
|
2820
2820
|
};
|
|
2821
2821
|
/** @description Optional inline product definition for dynamic products.
|
|
2822
2822
|
* Requires special approval, use `product_id` instead. */
|
|
2823
2823
|
InlineProductCreateDto: {
|
|
2824
2824
|
/** @description The unique URL-safe identifier (slug) for the product. */
|
|
2825
|
-
slug?:
|
|
2825
|
+
slug?: null | string;
|
|
2826
2826
|
/** @description The display name of the product. */
|
|
2827
|
-
name?:
|
|
2827
|
+
name?: null | string;
|
|
2828
2828
|
/** @description The detailed description of the product. */
|
|
2829
|
-
description?:
|
|
2829
|
+
description?: null | string;
|
|
2830
2830
|
/** @description The display label for the product. */
|
|
2831
|
-
label?:
|
|
2831
|
+
label?: null | string;
|
|
2832
2832
|
/**
|
|
2833
2833
|
* Format: int64
|
|
2834
2834
|
* @description The price of the product in the lowest denominator (e.g. cents).
|
|
2835
2835
|
*/
|
|
2836
|
-
price?:
|
|
2836
|
+
price?: null | number;
|
|
2837
2837
|
/** @description Indicates whether the customer is prompted to select a game server before purchasing. */
|
|
2838
|
-
single_game_server_only?:
|
|
2838
|
+
single_game_server_only?: null | boolean;
|
|
2839
2839
|
/** @description Indicates whether one-time purchases are allowed. */
|
|
2840
|
-
allow_one_time_purchase?:
|
|
2840
|
+
allow_one_time_purchase?: null | boolean;
|
|
2841
2841
|
/** @description Indicates whether subscription purchases are allowed. */
|
|
2842
|
-
allow_subscription?:
|
|
2842
|
+
allow_subscription?: null | boolean;
|
|
2843
2843
|
/**
|
|
2844
2844
|
* Format: int32
|
|
2845
2845
|
* @description The subscription interval value.
|
|
2846
2846
|
*/
|
|
2847
|
-
subscription_interval_value?:
|
|
2847
|
+
subscription_interval_value?: null | number;
|
|
2848
2848
|
subscription_interval_scale?: components["schemas"]["ProductSubscriptionIntervalScale"];
|
|
2849
2849
|
trial?: components["schemas"]["UpsertProductTrialConfigurationDto"];
|
|
2850
2850
|
/** @description Indicates whether automatic removal is enabled. */
|
|
2851
|
-
remove_after_enabled?:
|
|
2851
|
+
remove_after_enabled?: null | boolean;
|
|
2852
2852
|
/**
|
|
2853
2853
|
* Format: int32
|
|
2854
2854
|
* @description The time value for automatic removal.
|
|
2855
2855
|
*/
|
|
2856
|
-
remove_after_time_value?:
|
|
2856
|
+
remove_after_time_value?: null | number;
|
|
2857
2857
|
remove_after_time_scale?: components["schemas"]["ProductRemoveAfterIntervalScale"];
|
|
2858
2858
|
store_stock_limit?: components["schemas"]["ProductStockLimitDto"];
|
|
2859
2859
|
customer_stock_limit?: components["schemas"]["ProductStockLimitDto"];
|
|
2860
2860
|
/** @description Indicates whether removed items should be excluded from stock limits. */
|
|
2861
|
-
stock_limit_do_not_include_removed?:
|
|
2861
|
+
stock_limit_do_not_include_removed?: null | boolean;
|
|
2862
2862
|
/** @description The tag IDs associated with the product. */
|
|
2863
|
-
tags?: components["schemas"]["FlakeId"][]
|
|
2863
|
+
tags?: null | components["schemas"]["FlakeId"][];
|
|
2864
2864
|
/** @description The gameserver IDs associated with the product. */
|
|
2865
|
-
gameservers?: components["schemas"]["FlakeId"][]
|
|
2865
|
+
gameservers?: null | components["schemas"]["FlakeId"][];
|
|
2866
2866
|
/** @description The commands to be executed at different stages. */
|
|
2867
|
-
commands?: components["schemas"]["ProductCommandDto"][]
|
|
2867
|
+
commands?: null | components["schemas"]["ProductCommandDto"][];
|
|
2868
2868
|
deliverable_actions?: components["schemas"]["ProductDeliverableActionsDto"];
|
|
2869
2869
|
/** @description Additional metadata for the product. */
|
|
2870
|
-
metadata?: {
|
|
2870
|
+
metadata?: null | {
|
|
2871
2871
|
[key: string]: string;
|
|
2872
|
-
}
|
|
2872
|
+
};
|
|
2873
2873
|
/** @description The payout splits for revenue distribution.
|
|
2874
2874
|
* Requires special approval. */
|
|
2875
|
-
payout_splits?: components["schemas"]["ProductPayoutSplitDto"][]
|
|
2875
|
+
payout_splits?: null | components["schemas"]["ProductPayoutSplitDto"][];
|
|
2876
2876
|
tax_code?: components["schemas"]["ProductTaxCode"];
|
|
2877
2877
|
/** @description Indicates whether concurrent active items are allowed. */
|
|
2878
|
-
allow_concurrent_active_items?:
|
|
2878
|
+
allow_concurrent_active_items?: null | boolean;
|
|
2879
2879
|
/** @description Indicates whether using coupons and gift cards on this product is allowed. */
|
|
2880
|
-
disable_promo_codes?:
|
|
2880
|
+
disable_promo_codes?: null | boolean;
|
|
2881
2881
|
/** @description Indicates whether the product is hidden. */
|
|
2882
|
-
is_hidden?:
|
|
2882
|
+
is_hidden?: null | boolean;
|
|
2883
2883
|
/** @description Indicates whether gifting is disabled. */
|
|
2884
|
-
is_gifting_disabled?:
|
|
2884
|
+
is_gifting_disabled?: null | boolean;
|
|
2885
2885
|
/**
|
|
2886
2886
|
* Format: date-time
|
|
2887
2887
|
* @description The date and time when the product becomes enabled.
|
|
2888
2888
|
* Set to `null` to keep enabled.
|
|
2889
2889
|
*/
|
|
2890
|
-
enabled_at?:
|
|
2890
|
+
enabled_at?: null | string;
|
|
2891
2891
|
/**
|
|
2892
2892
|
* Format: date-time
|
|
2893
2893
|
* @description The date and time until which the product remains enabled.
|
|
2894
2894
|
* Set to `null` to keep enabled.
|
|
2895
2895
|
*/
|
|
2896
|
-
enabled_until?:
|
|
2896
|
+
enabled_until?: null | string;
|
|
2897
2897
|
/** @description The IDs of products required for purchasing this product. */
|
|
2898
|
-
required_product_ids?: components["schemas"]["FlakeId"][]
|
|
2898
|
+
required_product_ids?: null | components["schemas"]["FlakeId"][];
|
|
2899
2899
|
/** @description Indicates whether all required products are needed. */
|
|
2900
|
-
required_product_all?:
|
|
2900
|
+
required_product_all?: null | boolean;
|
|
2901
2901
|
/** @description The IDs of associated custom variables. */
|
|
2902
|
-
custom_variable_ids?: components["schemas"]["FlakeId"][]
|
|
2902
|
+
custom_variable_ids?: null | components["schemas"]["FlakeId"][];
|
|
2903
2903
|
};
|
|
2904
2904
|
/** @description Klarna payment method details */
|
|
2905
2905
|
KlarnaDetailsDto: {
|
|
@@ -2907,12 +2907,12 @@ export interface components {
|
|
|
2907
2907
|
* @description The country code
|
|
2908
2908
|
* @example SE
|
|
2909
2909
|
*/
|
|
2910
|
-
country?:
|
|
2910
|
+
country?: null | string;
|
|
2911
2911
|
/**
|
|
2912
2912
|
* @description The Klarna payment method category
|
|
2913
2913
|
* @example pay_later
|
|
2914
2914
|
*/
|
|
2915
|
-
method_category?:
|
|
2915
|
+
method_category?: null | string;
|
|
2916
2916
|
};
|
|
2917
2917
|
/** @description The last payment decline object. */
|
|
2918
2918
|
LastPaymentErrorDto: {
|
|
@@ -2935,7 +2935,7 @@ export interface components {
|
|
|
2935
2935
|
* Format: int32
|
|
2936
2936
|
* @description Gets or sets the duration of the coupon in months, applicable only for repeating coupons.
|
|
2937
2937
|
*/
|
|
2938
|
-
duration_in_months?:
|
|
2938
|
+
duration_in_months?: null | number;
|
|
2939
2939
|
discount_type: components["schemas"]["CouponDiscountTypeEnum"];
|
|
2940
2940
|
/**
|
|
2941
2941
|
* Format: int64
|
|
@@ -2988,11 +2988,11 @@ export interface components {
|
|
|
2988
2988
|
NavLinkDto: {
|
|
2989
2989
|
node_id: string;
|
|
2990
2990
|
tag_id: components["schemas"]["FlakeId"];
|
|
2991
|
-
parent_node_id?:
|
|
2991
|
+
parent_node_id?: null | string;
|
|
2992
2992
|
tag_slug: string;
|
|
2993
2993
|
name: string;
|
|
2994
2994
|
/** Format: int32 */
|
|
2995
|
-
order?:
|
|
2995
|
+
order?: null | number;
|
|
2996
2996
|
};
|
|
2997
2997
|
/** @description Represents a customer order */
|
|
2998
2998
|
OrderDto: {
|
|
@@ -3012,7 +3012,7 @@ export interface components {
|
|
|
3012
3012
|
* @description The checkout token for this order
|
|
3013
3013
|
* @example c4qqilpphugeqf2gndnkk5ad8fdq
|
|
3014
3014
|
*/
|
|
3015
|
-
checkout_token?:
|
|
3015
|
+
checkout_token?: null | string;
|
|
3016
3016
|
subscription_id?: components["schemas"]["FlakeId"];
|
|
3017
3017
|
/** @description Signifies if the order is a subscription order */
|
|
3018
3018
|
readonly is_subscription: boolean;
|
|
@@ -3109,17 +3109,17 @@ export interface components {
|
|
|
3109
3109
|
* @description The date and time when this order was created
|
|
3110
3110
|
* @example 2025-04-01T15:30:45Z
|
|
3111
3111
|
*/
|
|
3112
|
-
created_at?:
|
|
3112
|
+
created_at?: null | string;
|
|
3113
3113
|
/**
|
|
3114
3114
|
* Format: date-time
|
|
3115
3115
|
* @description The date and time when this order was completed, if applicable
|
|
3116
3116
|
* @example 2025-04-01T15:35:22Z
|
|
3117
3117
|
*/
|
|
3118
|
-
completed_at?:
|
|
3118
|
+
completed_at?: null | string;
|
|
3119
3119
|
/** @description The line items in this order */
|
|
3120
3120
|
lines: components["schemas"]["OrderLineDto"][];
|
|
3121
3121
|
/** @description A list of all tax jurisdictions that were involved in the taxation of this order. */
|
|
3122
|
-
tax_jurisdictions?: components["schemas"]["SalesTaxJurisdictionDto"][]
|
|
3122
|
+
tax_jurisdictions?: null | components["schemas"]["SalesTaxJurisdictionDto"][];
|
|
3123
3123
|
last_payment_error?: components["schemas"]["LastPaymentErrorDto"];
|
|
3124
3124
|
};
|
|
3125
3125
|
/** @description Represents an order line item in a customer's order */
|
|
@@ -3137,9 +3137,9 @@ export interface components {
|
|
|
3137
3137
|
* @description The URL of the product image
|
|
3138
3138
|
* @example https://cdn.example.com/images/premium-game-pass.jpg
|
|
3139
3139
|
*/
|
|
3140
|
-
product_image_url?:
|
|
3140
|
+
product_image_url?: null | string;
|
|
3141
3141
|
/** @description The Gift Card ID of that product in this order line */
|
|
3142
|
-
created_giftcard_id?:
|
|
3142
|
+
created_giftcard_id?: null | string;
|
|
3143
3143
|
subscription_id?: components["schemas"]["FlakeId"];
|
|
3144
3144
|
trial_id?: components["schemas"]["FlakeId"];
|
|
3145
3145
|
/**
|
|
@@ -3147,7 +3147,7 @@ export interface components {
|
|
|
3147
3147
|
* @description The interval value for subscription products
|
|
3148
3148
|
* @example 1
|
|
3149
3149
|
*/
|
|
3150
|
-
subscription_interval_value?:
|
|
3150
|
+
subscription_interval_value?: null | number;
|
|
3151
3151
|
subscription_interval_scale?: components["schemas"]["ProductSubscriptionIntervalScale"];
|
|
3152
3152
|
/**
|
|
3153
3153
|
* @description Indicates whether this order line is a gift
|
|
@@ -3236,16 +3236,16 @@ export interface components {
|
|
|
3236
3236
|
*/
|
|
3237
3237
|
tax_inclusive: boolean;
|
|
3238
3238
|
/** @description The payout splits for this order line */
|
|
3239
|
-
payout_splits?: components["schemas"]["OrderLinePayoutSplitDto"][]
|
|
3239
|
+
payout_splits?: null | components["schemas"]["OrderLinePayoutSplitDto"][];
|
|
3240
3240
|
/**
|
|
3241
3241
|
* @description The regional pricing region ID for this order line, null if no regional pricing set
|
|
3242
3242
|
* @example eu
|
|
3243
3243
|
*/
|
|
3244
|
-
pricing_region_id?:
|
|
3244
|
+
pricing_region_id?: null | string;
|
|
3245
3245
|
/** @description Key-value pair of selected custom variables for this order. */
|
|
3246
|
-
custom_variables?: {
|
|
3246
|
+
custom_variables?: null | {
|
|
3247
3247
|
[key: string]: components["schemas"]["CustomVariableLineItemDto"];
|
|
3248
|
-
}
|
|
3248
|
+
};
|
|
3249
3249
|
};
|
|
3250
3250
|
/** @description Represents an order line-level payout split. */
|
|
3251
3251
|
OrderLinePayoutSplitDto: {
|
|
@@ -3254,7 +3254,7 @@ export interface components {
|
|
|
3254
3254
|
* Format: int64
|
|
3255
3255
|
* @description The percentage in basis points.
|
|
3256
3256
|
*/
|
|
3257
|
-
percentage?:
|
|
3257
|
+
percentage?: null | number;
|
|
3258
3258
|
/**
|
|
3259
3259
|
* Format: int64
|
|
3260
3260
|
* @description The platform fee percentage in basis points.
|
|
@@ -3280,7 +3280,7 @@ export interface components {
|
|
|
3280
3280
|
* @description The payer name
|
|
3281
3281
|
* @example Jan Kowalski
|
|
3282
3282
|
*/
|
|
3283
|
-
payer_name?:
|
|
3283
|
+
payer_name?: null | string;
|
|
3284
3284
|
};
|
|
3285
3285
|
/** @description Pay by Bank payment method details */
|
|
3286
3286
|
PayByBankDetailsDto: {
|
|
@@ -3288,22 +3288,22 @@ export interface components {
|
|
|
3288
3288
|
* @description The bank name
|
|
3289
3289
|
* @example Chase Bank
|
|
3290
3290
|
*/
|
|
3291
|
-
bank_name?:
|
|
3291
|
+
bank_name?: null | string;
|
|
3292
3292
|
/**
|
|
3293
3293
|
* @description The Bank Identifier Code
|
|
3294
3294
|
* @example CHASUS33
|
|
3295
3295
|
*/
|
|
3296
|
-
bic?:
|
|
3296
|
+
bic?: null | string;
|
|
3297
3297
|
/**
|
|
3298
3298
|
* @description The country code
|
|
3299
3299
|
* @example US
|
|
3300
3300
|
*/
|
|
3301
|
-
country?:
|
|
3301
|
+
country?: null | string;
|
|
3302
3302
|
/**
|
|
3303
3303
|
* @description The payer name
|
|
3304
3304
|
* @example John Smith
|
|
3305
3305
|
*/
|
|
3306
|
-
payer_name?:
|
|
3306
|
+
payer_name?: null | string;
|
|
3307
3307
|
};
|
|
3308
3308
|
/** @enum {string} */
|
|
3309
3309
|
PayNowActorType: "anonymous" | "user" | "customer" | "api_key" | "game_server" | "admin" | "internal" | "platform" | "global_customer";
|
|
@@ -3329,9 +3329,9 @@ export interface components {
|
|
|
3329
3329
|
* @description A distributed trace ID used for debugging.
|
|
3330
3330
|
* @example 234a5bcd543ef3fa53ce929d0e0e4736
|
|
3331
3331
|
*/
|
|
3332
|
-
trace_id?:
|
|
3332
|
+
trace_id?: null | string;
|
|
3333
3333
|
/** @description An array of multiple errors. Only used by some API services. */
|
|
3334
|
-
errors?: components["schemas"]["ValidationError"][]
|
|
3334
|
+
errors?: null | components["schemas"]["ValidationError"][];
|
|
3335
3335
|
};
|
|
3336
3336
|
/** @description PayPal payment method details */
|
|
3337
3337
|
PayPalDetailsDto: {
|
|
@@ -3364,12 +3364,12 @@ export interface components {
|
|
|
3364
3364
|
* @description Indicates if vault approval is pending
|
|
3365
3365
|
* @example false
|
|
3366
3366
|
*/
|
|
3367
|
-
pending_vault_approval?:
|
|
3367
|
+
pending_vault_approval?: null | boolean;
|
|
3368
3368
|
/**
|
|
3369
3369
|
* @description Indicates if this is a standalone setup
|
|
3370
3370
|
* @example false
|
|
3371
3371
|
*/
|
|
3372
|
-
standalone_setup?:
|
|
3372
|
+
standalone_setup?: null | boolean;
|
|
3373
3373
|
};
|
|
3374
3374
|
/**
|
|
3375
3375
|
* @description Represents chargeback status of a payment
|
|
@@ -3389,7 +3389,7 @@ export interface components {
|
|
|
3389
3389
|
customer_id: components["schemas"]["FlakeId"];
|
|
3390
3390
|
customer: components["schemas"]["CustomerDto"];
|
|
3391
3391
|
/** @description The list of refunds associated with this payment */
|
|
3392
|
-
refunds?: components["schemas"]["RefundDto"][]
|
|
3392
|
+
refunds?: null | components["schemas"]["RefundDto"][];
|
|
3393
3393
|
/**
|
|
3394
3394
|
* @description The payment gateway provider
|
|
3395
3395
|
* @example stripe
|
|
@@ -3453,7 +3453,7 @@ export interface components {
|
|
|
3453
3453
|
* @description The foreign exchange rate used for currency conversion
|
|
3454
3454
|
* @example 1.085
|
|
3455
3455
|
*/
|
|
3456
|
-
fx_rate?:
|
|
3456
|
+
fx_rate?: null | number;
|
|
3457
3457
|
/**
|
|
3458
3458
|
* Format: int32
|
|
3459
3459
|
* @description The platform fee rate applied to this payment (in basis points)
|
|
@@ -3464,13 +3464,12 @@ export interface components {
|
|
|
3464
3464
|
/**
|
|
3465
3465
|
* Format: date-time
|
|
3466
3466
|
* @description The date and time when the chargeback status was last updated
|
|
3467
|
-
* @example null
|
|
3468
3467
|
*/
|
|
3469
|
-
chargeback_status_updated_at?:
|
|
3468
|
+
chargeback_status_updated_at?: null | string;
|
|
3470
3469
|
/** @description The payout split rules for multi-party payments */
|
|
3471
|
-
payout_split_rules?: components["schemas"]["PaymentPayoutSplitRuleDto"][]
|
|
3470
|
+
payout_split_rules?: null | components["schemas"]["PaymentPayoutSplitRuleDto"][];
|
|
3472
3471
|
/** @description The payout split results for multi-party payments */
|
|
3473
|
-
payout_split_results?: components["schemas"]["PaymentPayoutSplitResultDto"][]
|
|
3472
|
+
payout_split_results?: null | components["schemas"]["PaymentPayoutSplitResultDto"][];
|
|
3474
3473
|
/**
|
|
3475
3474
|
* Format: date-time
|
|
3476
3475
|
* @description The date and time when this payment was created
|
|
@@ -3482,37 +3481,33 @@ export interface components {
|
|
|
3482
3481
|
* @description The date and time when this payment entered pending status
|
|
3483
3482
|
* @example 2025-04-01T15:30:46Z
|
|
3484
3483
|
*/
|
|
3485
|
-
pending_at?:
|
|
3484
|
+
pending_at?: null | string;
|
|
3486
3485
|
/**
|
|
3487
3486
|
* Format: date-time
|
|
3488
3487
|
* @description The date and time when this payment was completed
|
|
3489
3488
|
* @example 2025-04-01T15:31:12Z
|
|
3490
3489
|
*/
|
|
3491
|
-
completed_at?:
|
|
3490
|
+
completed_at?: null | string;
|
|
3492
3491
|
/**
|
|
3493
3492
|
* Format: date-time
|
|
3494
3493
|
* @description The date and time when this payment was canceled
|
|
3495
|
-
* @example null
|
|
3496
3494
|
*/
|
|
3497
|
-
canceled_at?:
|
|
3495
|
+
canceled_at?: null | string;
|
|
3498
3496
|
/**
|
|
3499
3497
|
* Format: date-time
|
|
3500
3498
|
* @description The date and time when this payment failed
|
|
3501
|
-
* @example null
|
|
3502
3499
|
*/
|
|
3503
|
-
failed_at?:
|
|
3500
|
+
failed_at?: null | string;
|
|
3504
3501
|
/**
|
|
3505
3502
|
* Format: date-time
|
|
3506
3503
|
* @description The date and time when this payment was last refunded
|
|
3507
|
-
* @example null
|
|
3508
3504
|
*/
|
|
3509
|
-
refunded_at?:
|
|
3505
|
+
refunded_at?: null | string;
|
|
3510
3506
|
/**
|
|
3511
3507
|
* Format: date-time
|
|
3512
3508
|
* @description The date and time when a chargeback was initiated on this payment
|
|
3513
|
-
* @example null
|
|
3514
3509
|
*/
|
|
3515
|
-
chargeback_at?:
|
|
3510
|
+
chargeback_at?: null | string;
|
|
3516
3511
|
last_payment_error?: components["schemas"]["LastPaymentErrorDto"];
|
|
3517
3512
|
};
|
|
3518
3513
|
/** @description Contains detailed information about a payment method.
|
|
@@ -3566,7 +3561,7 @@ export interface components {
|
|
|
3566
3561
|
* @description The date and time when this payment method was last updated
|
|
3567
3562
|
* @example 2025-03-20T14:30:00Z
|
|
3568
3563
|
*/
|
|
3569
|
-
updated_at?:
|
|
3564
|
+
updated_at?: null | string;
|
|
3570
3565
|
};
|
|
3571
3566
|
/** @description Represents payout split results for multi-party payments */
|
|
3572
3567
|
PaymentPayoutSplitResultDto: {
|
|
@@ -3635,7 +3630,7 @@ export interface components {
|
|
|
3635
3630
|
* @description The percentage of the line amount this user receives (in basis points, e.g., 5000 = 50%)
|
|
3636
3631
|
* @example 5000
|
|
3637
3632
|
*/
|
|
3638
|
-
percentage?:
|
|
3633
|
+
percentage?: null | number;
|
|
3639
3634
|
/**
|
|
3640
3635
|
* Format: int32
|
|
3641
3636
|
* @description The platform fee percentage applied to this split (in basis points)
|
|
@@ -3660,17 +3655,17 @@ export interface components {
|
|
|
3660
3655
|
* @description The bank name
|
|
3661
3656
|
* @example Banco do Brasil
|
|
3662
3657
|
*/
|
|
3663
|
-
bank_name?:
|
|
3658
|
+
bank_name?: null | string;
|
|
3664
3659
|
/**
|
|
3665
3660
|
* @description The bank account number
|
|
3666
3661
|
* @example 12345-6
|
|
3667
3662
|
*/
|
|
3668
|
-
bank_account_number?:
|
|
3663
|
+
bank_account_number?: null | string;
|
|
3669
3664
|
/**
|
|
3670
3665
|
* @description The payer name
|
|
3671
3666
|
* @example João Silva
|
|
3672
3667
|
*/
|
|
3673
|
-
payer_name?:
|
|
3668
|
+
payer_name?: null | string;
|
|
3674
3669
|
};
|
|
3675
3670
|
/**
|
|
3676
3671
|
* @description Defines when prepaid cards should be blocked from use.
|
|
@@ -3686,7 +3681,7 @@ export interface components {
|
|
|
3686
3681
|
/** @description Value indicating on which game servers should the command be executed.
|
|
3687
3682
|
* If left empty or null, then the default behavior applies
|
|
3688
3683
|
* (executing on all game servers or on the selected game server is selection is enabled) */
|
|
3689
|
-
override_execute_on_gameserver_ids?: components["schemas"]["FlakeId"][]
|
|
3684
|
+
override_execute_on_gameserver_ids?: null | components["schemas"]["FlakeId"][];
|
|
3690
3685
|
};
|
|
3691
3686
|
/**
|
|
3692
3687
|
* @description Defines the stages at which product commands can be executed.
|
|
@@ -3702,17 +3697,17 @@ export interface components {
|
|
|
3702
3697
|
store_id: components["schemas"]["FlakeId"];
|
|
3703
3698
|
product_id: components["schemas"]["FlakeId"];
|
|
3704
3699
|
is_uploaded: boolean;
|
|
3705
|
-
file_name?:
|
|
3706
|
-
file_content_type?:
|
|
3700
|
+
file_name?: null | string;
|
|
3701
|
+
file_content_type?: null | string;
|
|
3707
3702
|
/** Format: int64 */
|
|
3708
|
-
file_size?:
|
|
3709
|
-
file_hash?:
|
|
3710
|
-
description?:
|
|
3703
|
+
file_size?: null | number;
|
|
3704
|
+
file_hash?: null | string;
|
|
3705
|
+
description?: null | string;
|
|
3711
3706
|
/** Format: date-time */
|
|
3712
3707
|
created_at: string;
|
|
3713
3708
|
created_by: components["schemas"]["ActorDto"];
|
|
3714
3709
|
/** Format: date-time */
|
|
3715
|
-
updated_at?:
|
|
3710
|
+
updated_at?: null | string;
|
|
3716
3711
|
updated_by?: components["schemas"]["ActorDto"];
|
|
3717
3712
|
};
|
|
3718
3713
|
ProductDto: {
|
|
@@ -3720,7 +3715,7 @@ export interface components {
|
|
|
3720
3715
|
store_id: components["schemas"]["FlakeId"];
|
|
3721
3716
|
version_id: components["schemas"]["FlakeId"];
|
|
3722
3717
|
/** @description The URL to the product image. */
|
|
3723
|
-
image_url?:
|
|
3718
|
+
image_url?: null | string;
|
|
3724
3719
|
/** @description The unique slug for the product. */
|
|
3725
3720
|
slug: string;
|
|
3726
3721
|
/** @description The display name of the product. */
|
|
@@ -3728,7 +3723,7 @@ export interface components {
|
|
|
3728
3723
|
/** @description The detailed description of the product. */
|
|
3729
3724
|
description: string;
|
|
3730
3725
|
/** @description The display label for the product. */
|
|
3731
|
-
label?:
|
|
3726
|
+
label?: null | string;
|
|
3732
3727
|
/**
|
|
3733
3728
|
* Format: int32
|
|
3734
3729
|
* @description The sort order for displaying the product.
|
|
@@ -3764,7 +3759,7 @@ export interface components {
|
|
|
3764
3759
|
store_stock_limit: components["schemas"]["ProductStockLimitDto"];
|
|
3765
3760
|
customer_stock_limit: components["schemas"]["ProductStockLimitDto"];
|
|
3766
3761
|
/** @description Indicates whether removed items should be excluded from stock limits. */
|
|
3767
|
-
stock_limit_do_not_include_removed?:
|
|
3762
|
+
stock_limit_do_not_include_removed?: null | boolean;
|
|
3768
3763
|
/** @description The tags associated with the product. */
|
|
3769
3764
|
tags: components["schemas"]["ProductTagDto"][];
|
|
3770
3765
|
/** @description The game servers associated with the product. */
|
|
@@ -3776,45 +3771,45 @@ export interface components {
|
|
|
3776
3771
|
* Format: date-time
|
|
3777
3772
|
* @description The date and time when the product was created.
|
|
3778
3773
|
*/
|
|
3779
|
-
created_at?:
|
|
3774
|
+
created_at?: null | string;
|
|
3780
3775
|
updated_by?: components["schemas"]["ActorDto"];
|
|
3781
3776
|
/**
|
|
3782
3777
|
* Format: date-time
|
|
3783
3778
|
* @description The date and time when the product was last updated.
|
|
3784
3779
|
*/
|
|
3785
|
-
updated_at?:
|
|
3780
|
+
updated_at?: null | string;
|
|
3786
3781
|
deliverable_actions?: components["schemas"]["ProductDeliverableActionsDto"];
|
|
3787
3782
|
/** @description Additional metadata for the product. */
|
|
3788
|
-
metadata?: {
|
|
3783
|
+
metadata?: null | {
|
|
3789
3784
|
[key: string]: string;
|
|
3790
|
-
}
|
|
3785
|
+
};
|
|
3791
3786
|
/** @description The payout splits for revenue distribution. */
|
|
3792
|
-
payout_splits?: components["schemas"]["ProductPayoutSplitDto"][]
|
|
3787
|
+
payout_splits?: null | components["schemas"]["ProductPayoutSplitDto"][];
|
|
3793
3788
|
tax_code?: components["schemas"]["ProductTaxCode"];
|
|
3794
3789
|
/** @description Indicates whether concurrent active items are allowed. */
|
|
3795
|
-
allow_concurrent_active_items?:
|
|
3790
|
+
allow_concurrent_active_items?: null | boolean;
|
|
3796
3791
|
/** @description Indicates whether using coupons and gift cards on this product is allowed. */
|
|
3797
|
-
disable_promo_codes?:
|
|
3792
|
+
disable_promo_codes?: null | boolean;
|
|
3798
3793
|
/** @description Indicates whether the product is hidden. */
|
|
3799
|
-
is_hidden?:
|
|
3794
|
+
is_hidden?: null | boolean;
|
|
3800
3795
|
/** @description Indicates whether gifting is disabled. */
|
|
3801
|
-
is_gifting_disabled?:
|
|
3796
|
+
is_gifting_disabled?: null | boolean;
|
|
3802
3797
|
/**
|
|
3803
3798
|
* Format: date-time
|
|
3804
3799
|
* @description The date and time when the product becomes enabled.
|
|
3805
3800
|
*/
|
|
3806
|
-
enabled_at?:
|
|
3801
|
+
enabled_at?: null | string;
|
|
3807
3802
|
/**
|
|
3808
3803
|
* Format: date-time
|
|
3809
3804
|
* @description The date and time until which the product remains enabled.
|
|
3810
3805
|
*/
|
|
3811
|
-
enabled_until?:
|
|
3806
|
+
enabled_until?: null | string;
|
|
3812
3807
|
/** @description The IDs of products required for purchasing this product. */
|
|
3813
|
-
required_product_ids?: components["schemas"]["FlakeId"][]
|
|
3808
|
+
required_product_ids?: null | components["schemas"]["FlakeId"][];
|
|
3814
3809
|
/** @description Indicates whether all required products are needed. */
|
|
3815
|
-
required_product_all?:
|
|
3810
|
+
required_product_all?: null | boolean;
|
|
3816
3811
|
/** @description The IDs of associated custom variables. */
|
|
3817
|
-
custom_variable_ids?: components["schemas"]["FlakeId"][]
|
|
3812
|
+
custom_variable_ids?: null | components["schemas"]["FlakeId"][];
|
|
3818
3813
|
};
|
|
3819
3814
|
ProductGameServerDto: {
|
|
3820
3815
|
id: components["schemas"]["FlakeId"];
|
|
@@ -3833,7 +3828,7 @@ export interface components {
|
|
|
3833
3828
|
* @description The percentage of the payment allocated to the user, in basis points (500 = 5%).
|
|
3834
3829
|
* The last payout split must have this field set to `null` to receive the remaining portion.
|
|
3835
3830
|
*/
|
|
3836
|
-
percentage?:
|
|
3831
|
+
percentage?: null | number;
|
|
3837
3832
|
/**
|
|
3838
3833
|
* Format: int64
|
|
3839
3834
|
* @description The platform fee percentage your platform receives, in basis points (500 = 5%).
|
|
@@ -3852,13 +3847,13 @@ export interface components {
|
|
|
3852
3847
|
country_codes: string[];
|
|
3853
3848
|
enabled: boolean;
|
|
3854
3849
|
/** Format: int64 */
|
|
3855
|
-
price?:
|
|
3850
|
+
price?: null | number;
|
|
3856
3851
|
/** Format: int64 */
|
|
3857
|
-
default_price_multiplier?:
|
|
3858
|
-
currency?:
|
|
3859
|
-
tax_inclusive?:
|
|
3852
|
+
default_price_multiplier?: null | number;
|
|
3853
|
+
currency?: null | string;
|
|
3854
|
+
tax_inclusive?: null | boolean;
|
|
3860
3855
|
/** Format: date-time */
|
|
3861
|
-
updated_at?:
|
|
3856
|
+
updated_at?: null | string;
|
|
3862
3857
|
};
|
|
3863
3858
|
ProductPricingRegionGroupDto: {
|
|
3864
3859
|
id: string;
|
|
@@ -3869,10 +3864,10 @@ export interface components {
|
|
|
3869
3864
|
};
|
|
3870
3865
|
ProductPricingRegionOverrideDto: {
|
|
3871
3866
|
/** Format: int64 */
|
|
3872
|
-
price?:
|
|
3873
|
-
enabled?:
|
|
3874
|
-
currency?:
|
|
3875
|
-
tax_inclusive?:
|
|
3867
|
+
price?: null | number;
|
|
3868
|
+
enabled?: null | boolean;
|
|
3869
|
+
currency?: null | string;
|
|
3870
|
+
tax_inclusive?: null | boolean;
|
|
3876
3871
|
};
|
|
3877
3872
|
/** @enum {string} */
|
|
3878
3873
|
ProductRemoveAfterIntervalScale: "invalid" | "day" | "week" | "month";
|
|
@@ -3892,12 +3887,12 @@ export interface components {
|
|
|
3892
3887
|
* Format: int32
|
|
3893
3888
|
* @description The quantity limit.
|
|
3894
3889
|
*/
|
|
3895
|
-
quantity?:
|
|
3890
|
+
quantity?: null | number;
|
|
3896
3891
|
/**
|
|
3897
3892
|
* Format: int32
|
|
3898
3893
|
* @description The time value for stock limit period.
|
|
3899
3894
|
*/
|
|
3900
|
-
time_value?:
|
|
3895
|
+
time_value?: null | number;
|
|
3901
3896
|
time_scale: components["schemas"]["ProductStockTimeScale"];
|
|
3902
3897
|
/** @description Indicates if trials should be included in the active stock limit calculation. */
|
|
3903
3898
|
include_trials: boolean;
|
|
@@ -3984,18 +3979,18 @@ export interface components {
|
|
|
3984
3979
|
* Format: int64
|
|
3985
3980
|
* @description The optional maximum order value beyond which an abandoned checkout email will not be sent.
|
|
3986
3981
|
*/
|
|
3987
|
-
maximum_order_value?:
|
|
3982
|
+
maximum_order_value?: null | number;
|
|
3988
3983
|
/**
|
|
3989
3984
|
* Format: int32
|
|
3990
3985
|
* @description The optional maximum coupons limit per customer beyond which an abandoned checkout email will not be sent.
|
|
3991
3986
|
*/
|
|
3992
|
-
max_coupons_per_customer_amount?:
|
|
3987
|
+
max_coupons_per_customer_amount?: null | number;
|
|
3993
3988
|
max_coupons_per_customer_period?: components["schemas"]["Period"];
|
|
3994
3989
|
/**
|
|
3995
3990
|
* Format: int32
|
|
3996
3991
|
* @description The optional maximum coupons limit store wide beyond which an abandoned checkout email will not be sent.
|
|
3997
3992
|
*/
|
|
3998
|
-
max_coupons_global_amount?:
|
|
3993
|
+
max_coupons_global_amount?: null | number;
|
|
3999
3994
|
max_coupons_global_period?: components["schemas"]["Period"];
|
|
4000
3995
|
coupon_configuration: components["schemas"]["MarketingCouponConfigurationDto"];
|
|
4001
3996
|
/** @description The commands you want to execute when the email is sent. */
|
|
@@ -4028,18 +4023,18 @@ export interface components {
|
|
|
4028
4023
|
* Format: int64
|
|
4029
4024
|
* @description The optional maximum order value beyond which an abandoned checkout email will not be sent.
|
|
4030
4025
|
*/
|
|
4031
|
-
maximum_order_value?:
|
|
4026
|
+
maximum_order_value?: null | number;
|
|
4032
4027
|
/**
|
|
4033
4028
|
* Format: int32
|
|
4034
4029
|
* @description The optional maximum coupons limit per customer beyond which an abandoned checkout email will not be sent.
|
|
4035
4030
|
*/
|
|
4036
|
-
max_coupons_per_customer_amount?:
|
|
4031
|
+
max_coupons_per_customer_amount?: null | number;
|
|
4037
4032
|
max_coupons_per_customer_period?: components["schemas"]["Period"];
|
|
4038
4033
|
/**
|
|
4039
4034
|
* Format: int32
|
|
4040
4035
|
* @description The optional maximum coupons limit store wide beyond which an abandoned checkout email will not be sent.
|
|
4041
4036
|
*/
|
|
4042
|
-
max_coupons_global_amount?:
|
|
4037
|
+
max_coupons_global_amount?: null | number;
|
|
4043
4038
|
max_coupons_global_period?: components["schemas"]["Period"];
|
|
4044
4039
|
commands: components["schemas"]["PurchaseFollowUpStoreConfigurationUpdateCommandDto"][];
|
|
4045
4040
|
coupon_configuration: components["schemas"]["MarketingCouponConfigurationDto"];
|
|
@@ -4061,12 +4056,12 @@ export interface components {
|
|
|
4061
4056
|
discord_user_id?: components["schemas"]["FlakeId"];
|
|
4062
4057
|
channel_id?: components["schemas"]["FlakeId"];
|
|
4063
4058
|
role_id?: components["schemas"]["FlakeId"];
|
|
4064
|
-
message?:
|
|
4059
|
+
message?: null | string;
|
|
4065
4060
|
revocation_stages: components["schemas"]["DiscordActionRevocationStage"][];
|
|
4066
4061
|
/** Format: date-time */
|
|
4067
4062
|
enqueued_at: string;
|
|
4068
4063
|
/** Format: date-time */
|
|
4069
|
-
finalised_at?:
|
|
4064
|
+
finalised_at?: null | string;
|
|
4070
4065
|
executions: components["schemas"]["QueuedDiscordActionExecutionDto"][];
|
|
4071
4066
|
};
|
|
4072
4067
|
QueuedDiscordActionExecutionDto: {
|
|
@@ -4077,8 +4072,8 @@ export interface components {
|
|
|
4077
4072
|
/** Format: date-time */
|
|
4078
4073
|
executed_at: string;
|
|
4079
4074
|
execution_status: components["schemas"]["QueuedDiscordActionExecutionStatus"];
|
|
4080
|
-
message?:
|
|
4081
|
-
trace_id?:
|
|
4075
|
+
message?: null | string;
|
|
4076
|
+
trace_id?: null | string;
|
|
4082
4077
|
};
|
|
4083
4078
|
/** @enum {string} */
|
|
4084
4079
|
QueuedDiscordActionExecutionStatus: "success" | "failure";
|
|
@@ -4091,7 +4086,7 @@ export interface components {
|
|
|
4091
4086
|
created_at: string;
|
|
4092
4087
|
state: components["schemas"]["WebhookState"];
|
|
4093
4088
|
/** Format: date-time */
|
|
4094
|
-
next_retry?:
|
|
4089
|
+
next_retry?: null | string;
|
|
4095
4090
|
event: components["schemas"]["WebhookEventType"];
|
|
4096
4091
|
payload: unknown;
|
|
4097
4092
|
executions: components["schemas"]["ExecutedWebhookDto"][];
|
|
@@ -4104,7 +4099,7 @@ export interface components {
|
|
|
4104
4099
|
order_line_id?: components["schemas"]["FlakeId"];
|
|
4105
4100
|
status: components["schemas"]["RefundStatus"];
|
|
4106
4101
|
/** @description Reason for failure if the refund has failed */
|
|
4107
|
-
failure_reason?:
|
|
4102
|
+
failure_reason?: null | string;
|
|
4108
4103
|
/** @description Three-letter currency code of the refund */
|
|
4109
4104
|
currency: string;
|
|
4110
4105
|
/**
|
|
@@ -4150,14 +4145,14 @@ export interface components {
|
|
|
4150
4145
|
/** @description String representation of store refund amount, formatted for display */
|
|
4151
4146
|
store_refund_amount_str: string;
|
|
4152
4147
|
/** @description Optional currency code used for presentment to the customer if different from the base currency */
|
|
4153
|
-
presentment_currency?:
|
|
4148
|
+
presentment_currency?: null | string;
|
|
4154
4149
|
/**
|
|
4155
4150
|
* Format: int64
|
|
4156
4151
|
* @description Optional amount in presentment currency in smallest currency unit
|
|
4157
4152
|
*/
|
|
4158
|
-
presentment_amount?:
|
|
4153
|
+
presentment_amount?: null | number;
|
|
4159
4154
|
/** @description Exchange rate used while refunding. Only present for payments made in non-settlement currency. */
|
|
4160
|
-
fx_rate?:
|
|
4155
|
+
fx_rate?: null | string;
|
|
4161
4156
|
/** @description Indicates whether the refund should be taken from the connected user's balance.
|
|
4162
4157
|
* Only relevant for platforms. */
|
|
4163
4158
|
refund_from_connected_user_balance: boolean;
|
|
@@ -4170,27 +4165,27 @@ export interface components {
|
|
|
4170
4165
|
* Format: date-time
|
|
4171
4166
|
* @description Optional date and time when the refund was approved
|
|
4172
4167
|
*/
|
|
4173
|
-
approved_at?:
|
|
4168
|
+
approved_at?: null | string;
|
|
4174
4169
|
/**
|
|
4175
4170
|
* Format: date-time
|
|
4176
4171
|
* @description Optional date and time when the refund entered pending status
|
|
4177
4172
|
*/
|
|
4178
|
-
pending_at?:
|
|
4173
|
+
pending_at?: null | string;
|
|
4179
4174
|
/**
|
|
4180
4175
|
* Format: date-time
|
|
4181
4176
|
* @description Optional date and time when the refund was completed
|
|
4182
4177
|
*/
|
|
4183
|
-
completed_at?:
|
|
4178
|
+
completed_at?: null | string;
|
|
4184
4179
|
/**
|
|
4185
4180
|
* Format: date-time
|
|
4186
4181
|
* @description Optional date and time when the refund was canceled
|
|
4187
4182
|
*/
|
|
4188
|
-
canceled_at?:
|
|
4183
|
+
canceled_at?: null | string;
|
|
4189
4184
|
/**
|
|
4190
4185
|
* Format: date-time
|
|
4191
4186
|
* @description Optional date and time when the refund failed
|
|
4192
4187
|
*/
|
|
4193
|
-
failed_at?:
|
|
4188
|
+
failed_at?: null | string;
|
|
4194
4189
|
};
|
|
4195
4190
|
/**
|
|
4196
4191
|
* @description Represents the current status of a refund in the system
|
|
@@ -4199,9 +4194,9 @@ export interface components {
|
|
|
4199
4194
|
RefundStatus: "created" | "approved" | "processing" | "completed" | "canceled" | "failed";
|
|
4200
4195
|
ResendCommandsForGameServerRequestDto: {
|
|
4201
4196
|
/** Format: date-time */
|
|
4202
|
-
starts_at?:
|
|
4197
|
+
starts_at?: null | string;
|
|
4203
4198
|
/** Format: date-time */
|
|
4204
|
-
ends_at?:
|
|
4199
|
+
ends_at?: null | string;
|
|
4205
4200
|
inventory_item_id?: components["schemas"]["FlakeId"];
|
|
4206
4201
|
customer_id?: components["schemas"]["FlakeId"];
|
|
4207
4202
|
order_id?: components["schemas"]["FlakeId"];
|
|
@@ -4248,7 +4243,7 @@ export interface components {
|
|
|
4248
4243
|
* Format: date-time
|
|
4249
4244
|
* @description The date and time when the sale ends.
|
|
4250
4245
|
*/
|
|
4251
|
-
ends_at?:
|
|
4246
|
+
ends_at?: null | string;
|
|
4252
4247
|
created_by: components["schemas"]["ActorDto"];
|
|
4253
4248
|
/**
|
|
4254
4249
|
* Format: date-time
|
|
@@ -4260,7 +4255,7 @@ export interface components {
|
|
|
4260
4255
|
* Format: date-time
|
|
4261
4256
|
* @description The date and time when the sale was last updated.
|
|
4262
4257
|
*/
|
|
4263
|
-
updated_at?:
|
|
4258
|
+
updated_at?: null | string;
|
|
4264
4259
|
};
|
|
4265
4260
|
/** @description Object representing a sales tax jurisdiction and its associated taxes. */
|
|
4266
4261
|
SalesTaxJurisdictionDto: {
|
|
@@ -4273,7 +4268,7 @@ export interface components {
|
|
|
4273
4268
|
taxes: components["schemas"]["SalesTaxJurisdictionTaxDto"][];
|
|
4274
4269
|
/** @description Explanation for why taxes are not applied, if applicable.
|
|
4275
4270
|
* This property is null when taxes are applied. */
|
|
4276
|
-
not_taxed_reason?:
|
|
4271
|
+
not_taxed_reason?: null | string;
|
|
4277
4272
|
};
|
|
4278
4273
|
/** @description Object representing a specific tax within a sales tax jurisdiction. */
|
|
4279
4274
|
SalesTaxJurisdictionTaxDto: {
|
|
@@ -4290,10 +4285,10 @@ export interface components {
|
|
|
4290
4285
|
discord_server_id: components["schemas"]["FlakeId"];
|
|
4291
4286
|
action_type: components["schemas"]["DiscordActionType"];
|
|
4292
4287
|
execution_stage: components["schemas"]["DiscordActionExecutionStage"];
|
|
4293
|
-
revocation_stages?: components["schemas"]["DiscordActionRevocationStage"][]
|
|
4288
|
+
revocation_stages?: null | components["schemas"]["DiscordActionRevocationStage"][];
|
|
4294
4289
|
channel_id?: components["schemas"]["FlakeId"];
|
|
4295
4290
|
role_id?: components["schemas"]["FlakeId"];
|
|
4296
|
-
message?:
|
|
4291
|
+
message?: null | string;
|
|
4297
4292
|
};
|
|
4298
4293
|
StartDataMigrationFromTebexRequestDto: {
|
|
4299
4294
|
/** @description The public-facing Headless API token. */
|
|
@@ -4304,7 +4299,7 @@ export interface components {
|
|
|
4304
4299
|
StartDownloadableFileUploadRequestDto: {
|
|
4305
4300
|
file_name: string;
|
|
4306
4301
|
file_content_type: string;
|
|
4307
|
-
description?:
|
|
4302
|
+
description?: null | string;
|
|
4308
4303
|
};
|
|
4309
4304
|
/**
|
|
4310
4305
|
* Format: steam-id
|
|
@@ -4365,14 +4360,14 @@ export interface components {
|
|
|
4365
4360
|
* Format: int64
|
|
4366
4361
|
* @description Maximum per-transaction chargeback coverage amount in cents.
|
|
4367
4362
|
*/
|
|
4368
|
-
chargeback_coverage_max_amount?:
|
|
4363
|
+
chargeback_coverage_max_amount?: null | number;
|
|
4369
4364
|
};
|
|
4370
4365
|
StorePricingRegionOverrideDto: {
|
|
4371
4366
|
/** Format: int64 */
|
|
4372
|
-
default_price_multiplier?:
|
|
4373
|
-
enabled?:
|
|
4374
|
-
currency?:
|
|
4375
|
-
tax_inclusive?:
|
|
4367
|
+
default_price_multiplier?: null | number;
|
|
4368
|
+
enabled?: null | boolean;
|
|
4369
|
+
currency?: null | string;
|
|
4370
|
+
tax_inclusive?: null | boolean;
|
|
4376
4371
|
};
|
|
4377
4372
|
/**
|
|
4378
4373
|
* @description Determines the party that needs to perform or requests a verification
|
|
@@ -4401,20 +4396,20 @@ export interface components {
|
|
|
4401
4396
|
* Format: date-time
|
|
4402
4397
|
* @description Date when a repeating coupon ends for this subscription.
|
|
4403
4398
|
*/
|
|
4404
|
-
coupon_repeating_ends_at?:
|
|
4399
|
+
coupon_repeating_ends_at?: null | string;
|
|
4405
4400
|
affiliate_id?: components["schemas"]["FlakeId"];
|
|
4406
4401
|
checkout_id?: components["schemas"]["FlakeId"];
|
|
4407
4402
|
checkout_line_id?: components["schemas"]["FlakeId"];
|
|
4408
4403
|
/** @description Name used for billing purposes. */
|
|
4409
|
-
billing_name?:
|
|
4404
|
+
billing_name?: null | string;
|
|
4410
4405
|
/** @description Email used for billing purposes. */
|
|
4411
|
-
billing_email?:
|
|
4406
|
+
billing_email?: null | string;
|
|
4412
4407
|
/** @description Country code used for billing purposes. */
|
|
4413
|
-
billing_country?:
|
|
4408
|
+
billing_country?: null | string;
|
|
4414
4409
|
/** @description List of tax jurisdictions applicable to this subscription. */
|
|
4415
4410
|
tax_jurisdictions: components["schemas"]["SalesTaxJurisdictionDto"][];
|
|
4416
4411
|
/** @description IP address of the customer at the time of subscription. */
|
|
4417
|
-
customer_ip?:
|
|
4412
|
+
customer_ip?: null | string;
|
|
4418
4413
|
/** @description Indicates whether this subscription is a gift. */
|
|
4419
4414
|
gift: boolean;
|
|
4420
4415
|
gift_to_customer?: components["schemas"]["CustomerDto"];
|
|
@@ -4423,7 +4418,7 @@ export interface components {
|
|
|
4423
4418
|
/** @description Name of the product associated with this subscription. */
|
|
4424
4419
|
product_name: string;
|
|
4425
4420
|
/** @description URL for the product image. */
|
|
4426
|
-
product_image_url?:
|
|
4421
|
+
product_image_url?: null | string;
|
|
4427
4422
|
/**
|
|
4428
4423
|
* Format: int32
|
|
4429
4424
|
* @description Numeric value of the billing interval.
|
|
@@ -4505,32 +4500,32 @@ export interface components {
|
|
|
4505
4500
|
/** @description Formatted string representation of the initial total amount. */
|
|
4506
4501
|
initial_total_amount_str: string;
|
|
4507
4502
|
/** @description Identifier for the pricing region associated with this subscription. */
|
|
4508
|
-
pricing_region_id?:
|
|
4503
|
+
pricing_region_id?: null | string;
|
|
4509
4504
|
/**
|
|
4510
4505
|
* Format: date-time
|
|
4511
4506
|
* @description Start date of the current billing period.
|
|
4512
4507
|
*/
|
|
4513
|
-
current_period_start?:
|
|
4508
|
+
current_period_start?: null | string;
|
|
4514
4509
|
/**
|
|
4515
4510
|
* Format: date-time
|
|
4516
4511
|
* @description End date of the current billing period.
|
|
4517
4512
|
*/
|
|
4518
|
-
current_period_end?:
|
|
4513
|
+
current_period_end?: null | string;
|
|
4519
4514
|
/**
|
|
4520
4515
|
* Format: int32
|
|
4521
4516
|
* @description Sequence number of the current billing cycle.
|
|
4522
4517
|
*/
|
|
4523
|
-
billing_cycle_sequence?:
|
|
4518
|
+
billing_cycle_sequence?: null | number;
|
|
4524
4519
|
/**
|
|
4525
4520
|
* Format: date-time
|
|
4526
4521
|
* @description Date and time when the next payment attempt will occur.
|
|
4527
4522
|
*/
|
|
4528
|
-
next_attempt_at?:
|
|
4523
|
+
next_attempt_at?: null | string;
|
|
4529
4524
|
/**
|
|
4530
4525
|
* Format: int32
|
|
4531
4526
|
* @description Number of payment attempts made for the current billing cycle.
|
|
4532
4527
|
*/
|
|
4533
|
-
attempt_count?:
|
|
4528
|
+
attempt_count?: null | number;
|
|
4534
4529
|
/**
|
|
4535
4530
|
* Format: date-time
|
|
4536
4531
|
* @description Date and time when the subscription was created.
|
|
@@ -4540,19 +4535,19 @@ export interface components {
|
|
|
4540
4535
|
* Format: date-time
|
|
4541
4536
|
* @description Date and time when the subscription was last updated.
|
|
4542
4537
|
*/
|
|
4543
|
-
updated_at?:
|
|
4538
|
+
updated_at?: null | string;
|
|
4544
4539
|
/**
|
|
4545
4540
|
* Format: date-time
|
|
4546
4541
|
* @description Date and time when the subscription became active.
|
|
4547
4542
|
*/
|
|
4548
|
-
active_at?:
|
|
4543
|
+
active_at?: null | string;
|
|
4549
4544
|
/**
|
|
4550
4545
|
* Format: date-time
|
|
4551
4546
|
* @description Date and time when the subscription was canceled.
|
|
4552
4547
|
*/
|
|
4553
|
-
canceled_at?:
|
|
4548
|
+
canceled_at?: null | string;
|
|
4554
4549
|
/** @description Reason provided for cancellation. */
|
|
4555
|
-
cancel_reason?:
|
|
4550
|
+
cancel_reason?: null | string;
|
|
4556
4551
|
};
|
|
4557
4552
|
/**
|
|
4558
4553
|
* @description Represents the current state of a subscription.
|
|
@@ -4573,16 +4568,16 @@ export interface components {
|
|
|
4573
4568
|
/** @description The unique slug for the tag. */
|
|
4574
4569
|
slug: string;
|
|
4575
4570
|
/** @description The description of the tag. */
|
|
4576
|
-
description?:
|
|
4571
|
+
description?: null | string;
|
|
4577
4572
|
/** @description The Image URL associated with the tag. */
|
|
4578
|
-
image_url?:
|
|
4573
|
+
image_url?: null | string;
|
|
4579
4574
|
/** @description Indicates whether this tag is enabled. */
|
|
4580
4575
|
enabled: boolean;
|
|
4581
4576
|
/**
|
|
4582
4577
|
* Format: date-time
|
|
4583
4578
|
* @description When the tag was last updated.
|
|
4584
4579
|
*/
|
|
4585
|
-
updated_at?:
|
|
4580
|
+
updated_at?: null | string;
|
|
4586
4581
|
updated_by?: components["schemas"]["ActorDto"];
|
|
4587
4582
|
};
|
|
4588
4583
|
TrialDto: {
|
|
@@ -4599,7 +4594,7 @@ export interface components {
|
|
|
4599
4594
|
/** @description The name of the product being trialed. */
|
|
4600
4595
|
product_name: string;
|
|
4601
4596
|
/** @description The URL of the product image, if available. */
|
|
4602
|
-
product_image_url?:
|
|
4597
|
+
product_image_url?: null | string;
|
|
4603
4598
|
/**
|
|
4604
4599
|
* Format: int32
|
|
4605
4600
|
* @description The duration value of the trial period.
|
|
@@ -4611,12 +4606,12 @@ export interface components {
|
|
|
4611
4606
|
* Format: date-time
|
|
4612
4607
|
* @description The date and time when the trial period starts, if applicable.
|
|
4613
4608
|
*/
|
|
4614
|
-
starts_at?:
|
|
4609
|
+
starts_at?: null | string;
|
|
4615
4610
|
/**
|
|
4616
4611
|
* Format: date-time
|
|
4617
4612
|
* @description The date and time when the trial period ends, if applicable.
|
|
4618
4613
|
*/
|
|
4619
|
-
ends_at?:
|
|
4614
|
+
ends_at?: null | string;
|
|
4620
4615
|
status: components["schemas"]["TrialStatusDto"];
|
|
4621
4616
|
/**
|
|
4622
4617
|
* Format: date-time
|
|
@@ -4627,7 +4622,7 @@ export interface components {
|
|
|
4627
4622
|
* Format: date-time
|
|
4628
4623
|
* @description The date and time when the trial was canceled, if applicable.
|
|
4629
4624
|
*/
|
|
4630
|
-
canceled_at?:
|
|
4625
|
+
canceled_at?: null | string;
|
|
4631
4626
|
canceled_by?: components["schemas"]["ActorDto"];
|
|
4632
4627
|
};
|
|
4633
4628
|
TrialEligibilityOverrideDto: {
|
|
@@ -4640,7 +4635,7 @@ export interface components {
|
|
|
4640
4635
|
/** @description The name of the product associated with this override. */
|
|
4641
4636
|
product_name: string;
|
|
4642
4637
|
/** @description The URL of the product image, if available. */
|
|
4643
|
-
product_image_url?:
|
|
4638
|
+
product_image_url?: null | string;
|
|
4644
4639
|
/**
|
|
4645
4640
|
* Format: date-time
|
|
4646
4641
|
* @description The date and time when this override was created.
|
|
@@ -4656,15 +4651,15 @@ export interface components {
|
|
|
4656
4651
|
* Format: date-time
|
|
4657
4652
|
* @description The date and time when this override was used to start a trial, if applicable.
|
|
4658
4653
|
*/
|
|
4659
|
-
used_at?:
|
|
4654
|
+
used_at?: null | string;
|
|
4660
4655
|
used_on_trial_id?: components["schemas"]["FlakeId"];
|
|
4661
4656
|
/** @description An optional note or comment about this override. */
|
|
4662
|
-
note?:
|
|
4657
|
+
note?: null | string;
|
|
4663
4658
|
/**
|
|
4664
4659
|
* Format: date-time
|
|
4665
4660
|
* @description The date and time when this override was deleted, if applicable.
|
|
4666
4661
|
*/
|
|
4667
|
-
deleted_at?:
|
|
4662
|
+
deleted_at?: null | string;
|
|
4668
4663
|
deleted_by?: components["schemas"]["ActorDto"];
|
|
4669
4664
|
};
|
|
4670
4665
|
/** @enum {string} */
|
|
@@ -4677,8 +4672,8 @@ export interface components {
|
|
|
4677
4672
|
kyc_completed: boolean;
|
|
4678
4673
|
requires_approval: boolean;
|
|
4679
4674
|
manually_approved: boolean;
|
|
4680
|
-
decline_reason?:
|
|
4681
|
-
requires_action_text?:
|
|
4675
|
+
decline_reason?: null | string;
|
|
4676
|
+
requires_action_text?: null | string;
|
|
4682
4677
|
products_created: boolean;
|
|
4683
4678
|
kyc_required: boolean;
|
|
4684
4679
|
gameserver_linked: boolean;
|
|
@@ -4691,7 +4686,7 @@ export interface components {
|
|
|
4691
4686
|
id: components["schemas"]["FlakeId"];
|
|
4692
4687
|
store_id: components["schemas"]["FlakeId"];
|
|
4693
4688
|
/** @description Template ID if this requirement was created from a template. Null for ad-hoc requirements. */
|
|
4694
|
-
template_id?:
|
|
4689
|
+
template_id?: null | string;
|
|
4695
4690
|
originating_flag_id?: components["schemas"]["FlakeId"];
|
|
4696
4691
|
category: components["schemas"]["StoreRequirementCategory"];
|
|
4697
4692
|
/** @description Unique code identifying the type of requirement. Copied from template or custom for ad-hoc requirements. */
|
|
@@ -4699,9 +4694,9 @@ export interface components {
|
|
|
4699
4694
|
/** @description Human-readable name of the requirement. Copied from template or custom for ad-hoc requirements. */
|
|
4700
4695
|
name: string;
|
|
4701
4696
|
/** @description Detailed description explaining what the store needs to provide. Copied from template or custom for ad-hoc requirements. */
|
|
4702
|
-
description?:
|
|
4697
|
+
description?: null | string;
|
|
4703
4698
|
/** @description JSON schema defining the form fields, validation rules, and document requirements */
|
|
4704
|
-
schema?:
|
|
4699
|
+
schema?: null;
|
|
4705
4700
|
/** @description Additional metadata for this requirement (stored as JSON) */
|
|
4706
4701
|
metadata: {
|
|
4707
4702
|
[key: string]: string;
|
|
@@ -4710,7 +4705,7 @@ export interface components {
|
|
|
4710
4705
|
requested_by: components["schemas"]["StoreRequirementActionParty"];
|
|
4711
4706
|
/** @description Specifies the specific requester entity (e.g., "stripe", "trolley", or admin user ID)
|
|
4712
4707
|
* Free-form string for internal records */
|
|
4713
|
-
requested_by_detail?:
|
|
4708
|
+
requested_by_detail?: null | string;
|
|
4714
4709
|
/**
|
|
4715
4710
|
* Format: date-time
|
|
4716
4711
|
* @description When this requirement was created
|
|
@@ -4720,27 +4715,27 @@ export interface components {
|
|
|
4720
4715
|
* Format: date-time
|
|
4721
4716
|
* @description When this requirement was last updated
|
|
4722
4717
|
*/
|
|
4723
|
-
updated_at?:
|
|
4718
|
+
updated_at?: null | string;
|
|
4724
4719
|
/**
|
|
4725
4720
|
* Format: date-time
|
|
4726
4721
|
* @description When this requirement must be completed by (optional)
|
|
4727
4722
|
*/
|
|
4728
|
-
deadline_at?:
|
|
4723
|
+
deadline_at?: null | string;
|
|
4729
4724
|
/**
|
|
4730
4725
|
* Format: date-time
|
|
4731
4726
|
* @description When the store submitted their response to this requirement
|
|
4732
4727
|
*/
|
|
4733
|
-
submitted_at?:
|
|
4728
|
+
submitted_at?: null | string;
|
|
4734
4729
|
/**
|
|
4735
4730
|
* Format: date-time
|
|
4736
4731
|
* @description When this requirement was verified and approved
|
|
4737
4732
|
*/
|
|
4738
|
-
verified_at?:
|
|
4733
|
+
verified_at?: null | string;
|
|
4739
4734
|
/**
|
|
4740
4735
|
* Format: date-time
|
|
4741
4736
|
* @description When this requirement was rejected for not meeting standards
|
|
4742
4737
|
*/
|
|
4743
|
-
rejected_at?:
|
|
4738
|
+
rejected_at?: null | string;
|
|
4744
4739
|
/** @description Store capabilities that are restricted until this requirement is satisfied */
|
|
4745
4740
|
restricts_capabilities: string[];
|
|
4746
4741
|
/** @description Associated submissions for this requriement. */
|
|
@@ -4753,18 +4748,18 @@ export interface components {
|
|
|
4753
4748
|
/** @description The identifier of the specific field within the store requirement. */
|
|
4754
4749
|
store_requirement_field_id: string;
|
|
4755
4750
|
/** @description The text value submitted for this field, if applicable. */
|
|
4756
|
-
text_value?:
|
|
4751
|
+
text_value?: null | string;
|
|
4757
4752
|
/** @description The identifier of the uploaded file, if a file was submitted. */
|
|
4758
|
-
file_id?:
|
|
4753
|
+
file_id?: null | string;
|
|
4759
4754
|
/** @description The original name of the uploaded file. */
|
|
4760
|
-
file_name?:
|
|
4755
|
+
file_name?: null | string;
|
|
4761
4756
|
/** @description The MIME content type of the uploaded file. */
|
|
4762
|
-
file_content_type?:
|
|
4757
|
+
file_content_type?: null | string;
|
|
4763
4758
|
/**
|
|
4764
4759
|
* Format: int64
|
|
4765
4760
|
* @description The size of the uploaded file in bytes.
|
|
4766
4761
|
*/
|
|
4767
|
-
file_size_bytes?:
|
|
4762
|
+
file_size_bytes?: null | number;
|
|
4768
4763
|
/**
|
|
4769
4764
|
* Format: date-time
|
|
4770
4765
|
* @description The timestamp when this submission was made.
|
|
@@ -4772,9 +4767,9 @@ export interface components {
|
|
|
4772
4767
|
submitted_at: string;
|
|
4773
4768
|
submitted_by: components["schemas"]["ActorDto"];
|
|
4774
4769
|
/** @description The IP address from which the submission was made. */
|
|
4775
|
-
submitted_by_ip_address?:
|
|
4770
|
+
submitted_by_ip_address?: null | string;
|
|
4776
4771
|
/** @description The user agent string of the client that made the submission. */
|
|
4777
|
-
submitted_by_user_agent?:
|
|
4772
|
+
submitted_by_user_agent?: null | string;
|
|
4778
4773
|
};
|
|
4779
4774
|
UnqueueCommandsRequestDto: {
|
|
4780
4775
|
attempt_ids: components["schemas"]["FlakeId"][];
|
|
@@ -4784,18 +4779,18 @@ export interface components {
|
|
|
4784
4779
|
unqueued_count: number;
|
|
4785
4780
|
};
|
|
4786
4781
|
UpdateAffiliateLinkDto: {
|
|
4787
|
-
enabled?:
|
|
4788
|
-
code?:
|
|
4782
|
+
enabled?: null | boolean;
|
|
4783
|
+
code?: null | string;
|
|
4789
4784
|
referer_type?: components["schemas"]["AffiliateLinkRefererType"];
|
|
4790
4785
|
/** Format: int32 */
|
|
4791
|
-
tracking_length_days?:
|
|
4792
|
-
apply_for_subscriptions?:
|
|
4786
|
+
tracking_length_days?: null | number;
|
|
4787
|
+
apply_for_subscriptions?: null | boolean;
|
|
4793
4788
|
discount_type?: components["schemas"]["AffiliateLinkDiscountType"];
|
|
4794
4789
|
/** Format: int64 */
|
|
4795
|
-
discount_amount?:
|
|
4790
|
+
discount_amount?: null | number;
|
|
4796
4791
|
commission_type?: components["schemas"]["AffiliateLinkCommissionType"];
|
|
4797
4792
|
/** Format: int64 */
|
|
4798
|
-
commission_amount?:
|
|
4793
|
+
commission_amount?: null | number;
|
|
4799
4794
|
};
|
|
4800
4795
|
UpdateCouponDto: {
|
|
4801
4796
|
enabled?: boolean;
|
|
@@ -4803,7 +4798,7 @@ export interface components {
|
|
|
4803
4798
|
note?: string;
|
|
4804
4799
|
duration?: components["schemas"]["CouponDurationEnum"];
|
|
4805
4800
|
/** Format: int32 */
|
|
4806
|
-
duration_in_months?: number;
|
|
4801
|
+
duration_in_months?: null | number;
|
|
4807
4802
|
discount_type?: components["schemas"]["CouponDiscountTypeEnum"];
|
|
4808
4803
|
/** Format: int64 */
|
|
4809
4804
|
discount_amount?: number;
|
|
@@ -4823,9 +4818,9 @@ export interface components {
|
|
|
4823
4818
|
usable_on_one_time_purchase?: boolean;
|
|
4824
4819
|
usable_on_subscription?: boolean;
|
|
4825
4820
|
/** Format: date-time */
|
|
4826
|
-
usable_at?: string;
|
|
4821
|
+
usable_at?: null | string;
|
|
4827
4822
|
/** Format: date-time */
|
|
4828
|
-
expires_at?: string;
|
|
4823
|
+
expires_at?: null | string;
|
|
4829
4824
|
};
|
|
4830
4825
|
UpdateDeliveryItemProductVersionRequestDto: {
|
|
4831
4826
|
product_version_id: components["schemas"]["FlakeId"];
|
|
@@ -4844,13 +4839,13 @@ export interface components {
|
|
|
4844
4839
|
/** Format: date-time */
|
|
4845
4840
|
usable_at?: string;
|
|
4846
4841
|
/** Format: date-time */
|
|
4847
|
-
expires_at?: string;
|
|
4842
|
+
expires_at?: null | string;
|
|
4848
4843
|
};
|
|
4849
4844
|
UpdateNavLinkDto: {
|
|
4850
4845
|
tag_id?: components["schemas"]["FlakeId"];
|
|
4851
4846
|
parent_node_id?: string;
|
|
4852
4847
|
/** Format: int32 */
|
|
4853
|
-
order?: number;
|
|
4848
|
+
order?: null | number;
|
|
4854
4849
|
};
|
|
4855
4850
|
UpdateNavLinkOrderChangeDto: {
|
|
4856
4851
|
node_id: components["schemas"]["FlakeId"];
|
|
@@ -4874,7 +4869,7 @@ export interface components {
|
|
|
4874
4869
|
/** Format: date-time */
|
|
4875
4870
|
begins_at?: string;
|
|
4876
4871
|
/** Format: date-time */
|
|
4877
|
-
ends_at?: string;
|
|
4872
|
+
ends_at?: null | string;
|
|
4878
4873
|
};
|
|
4879
4874
|
UpdateStorePaymentSettingsDto: {
|
|
4880
4875
|
show_all_payment_methods_for_subscriptions?: boolean;
|
|
@@ -4891,15 +4886,15 @@ export interface components {
|
|
|
4891
4886
|
url: string;
|
|
4892
4887
|
reset_secret: boolean;
|
|
4893
4888
|
subscribed_to: components["schemas"]["WebhookEventType"];
|
|
4894
|
-
discord_description_template?:
|
|
4895
|
-
discord_title?:
|
|
4896
|
-
discord_color?:
|
|
4889
|
+
discord_description_template?: null | string;
|
|
4890
|
+
discord_title?: null | string;
|
|
4891
|
+
discord_color?: null | string;
|
|
4897
4892
|
};
|
|
4898
4893
|
UpsertBanRequestDto: {
|
|
4899
|
-
reason?:
|
|
4900
|
-
identities?: components["schemas"]["BanIdentityDto"][]
|
|
4894
|
+
reason?: null | string;
|
|
4895
|
+
identities?: null | components["schemas"]["BanIdentityDto"][];
|
|
4901
4896
|
/** Format: date-time */
|
|
4902
|
-
expires_at?:
|
|
4897
|
+
expires_at?: null | string;
|
|
4903
4898
|
};
|
|
4904
4899
|
/** @description Unified request model for creating or updating custom variables.
|
|
4905
4900
|
* Contains all the configurable properties of a custom variable. */
|
|
@@ -4910,11 +4905,11 @@ export interface components {
|
|
|
4910
4905
|
/** @description Display name shown to customers. */
|
|
4911
4906
|
name: string;
|
|
4912
4907
|
/** @description Description explaining the purpose of this custom variable. */
|
|
4913
|
-
description?:
|
|
4908
|
+
description?: null | string;
|
|
4914
4909
|
type: components["schemas"]["CustomVariableType"];
|
|
4915
4910
|
/** @description Optional regex pattern for validating customer input.
|
|
4916
4911
|
* Only applies to text and number types. Ignored for dropdown types. */
|
|
4917
|
-
value_regex?:
|
|
4912
|
+
value_regex?: null | string;
|
|
4918
4913
|
/** @description Predefined options for dropdown-type custom variables.
|
|
4919
4914
|
* Required for dropdown types, ignored for text and number types.
|
|
4920
4915
|
* When updating, this completely replaces all existing options. */
|
|
@@ -4923,16 +4918,16 @@ export interface components {
|
|
|
4923
4918
|
UpsertCustomerRequestDto: {
|
|
4924
4919
|
steam_id?: components["schemas"]["SteamId"];
|
|
4925
4920
|
/** @description The Minecraft UUID for the customer. */
|
|
4926
|
-
minecraft_uuid?:
|
|
4921
|
+
minecraft_uuid?: null | string;
|
|
4927
4922
|
minecraft_platform?: components["schemas"]["CustomerMinecraftPlatform"];
|
|
4928
4923
|
/** @description The Xbox XUID (Xbox User ID) for the customer. */
|
|
4929
|
-
xbox_xuid?:
|
|
4924
|
+
xbox_xuid?: null | string;
|
|
4930
4925
|
/** @description The name of the customer. */
|
|
4931
|
-
name?:
|
|
4926
|
+
name?: null | string;
|
|
4932
4927
|
/** @description Additional customer information stored as key-value pairs. */
|
|
4933
|
-
metadata?: {
|
|
4928
|
+
metadata?: null | {
|
|
4934
4929
|
[key: string]: string;
|
|
4935
|
-
}
|
|
4930
|
+
};
|
|
4936
4931
|
};
|
|
4937
4932
|
/** @description Data transfer object used for creating new global commands or updating existing ones.
|
|
4938
4933
|
* Supports partial updates following PATCH semantics. */
|
|
@@ -4943,127 +4938,127 @@ export interface components {
|
|
|
4943
4938
|
/** @description Indicates whether the command should only be executed when the player is online. */
|
|
4944
4939
|
online_only: boolean;
|
|
4945
4940
|
/** @description List of specific game server IDs where this command should be executed. */
|
|
4946
|
-
override_execute_on_gameserver_ids?: components["schemas"]["FlakeId"][]
|
|
4941
|
+
override_execute_on_gameserver_ids?: null | components["schemas"]["FlakeId"][];
|
|
4947
4942
|
};
|
|
4948
4943
|
UpsertProductRequestDto: {
|
|
4949
4944
|
/** @description The unique URL-safe identifier (slug) for the product. */
|
|
4950
|
-
slug?:
|
|
4945
|
+
slug?: null | string;
|
|
4951
4946
|
/** @description The display name of the product. */
|
|
4952
|
-
name?:
|
|
4947
|
+
name?: null | string;
|
|
4953
4948
|
/** @description The detailed description of the product. */
|
|
4954
|
-
description?:
|
|
4949
|
+
description?: null | string;
|
|
4955
4950
|
/** @description The display label for the product. */
|
|
4956
|
-
label?:
|
|
4951
|
+
label?: null | string;
|
|
4957
4952
|
/**
|
|
4958
4953
|
* Format: int64
|
|
4959
4954
|
* @description The price of the product in the lowest denominator (e.g. cents).
|
|
4960
4955
|
*/
|
|
4961
|
-
price?:
|
|
4956
|
+
price?: null | number;
|
|
4962
4957
|
/** @description Indicates whether the customer is prompted to select a game server before purchasing. */
|
|
4963
|
-
single_game_server_only?:
|
|
4958
|
+
single_game_server_only?: null | boolean;
|
|
4964
4959
|
/** @description Indicates whether one-time purchases are allowed. */
|
|
4965
|
-
allow_one_time_purchase?:
|
|
4960
|
+
allow_one_time_purchase?: null | boolean;
|
|
4966
4961
|
/** @description Indicates whether subscription purchases are allowed. */
|
|
4967
|
-
allow_subscription?:
|
|
4962
|
+
allow_subscription?: null | boolean;
|
|
4968
4963
|
/**
|
|
4969
4964
|
* Format: int32
|
|
4970
4965
|
* @description The subscription interval value.
|
|
4971
4966
|
*/
|
|
4972
|
-
subscription_interval_value?:
|
|
4967
|
+
subscription_interval_value?: null | number;
|
|
4973
4968
|
subscription_interval_scale?: components["schemas"]["ProductSubscriptionIntervalScale"];
|
|
4974
4969
|
trial?: components["schemas"]["UpsertProductTrialConfigurationDto"];
|
|
4975
4970
|
/** @description Indicates whether automatic removal is enabled. */
|
|
4976
|
-
remove_after_enabled?:
|
|
4971
|
+
remove_after_enabled?: null | boolean;
|
|
4977
4972
|
/**
|
|
4978
4973
|
* Format: int32
|
|
4979
4974
|
* @description The time value for automatic removal.
|
|
4980
4975
|
*/
|
|
4981
|
-
remove_after_time_value?:
|
|
4976
|
+
remove_after_time_value?: null | number;
|
|
4982
4977
|
remove_after_time_scale?: components["schemas"]["ProductRemoveAfterIntervalScale"];
|
|
4983
4978
|
store_stock_limit?: components["schemas"]["ProductStockLimitDto"];
|
|
4984
4979
|
customer_stock_limit?: components["schemas"]["ProductStockLimitDto"];
|
|
4985
4980
|
/** @description Indicates whether removed items should be excluded from stock limits. */
|
|
4986
|
-
stock_limit_do_not_include_removed?:
|
|
4981
|
+
stock_limit_do_not_include_removed?: null | boolean;
|
|
4987
4982
|
/** @description The tag IDs associated with the product. */
|
|
4988
|
-
tags?: components["schemas"]["FlakeId"][]
|
|
4983
|
+
tags?: null | components["schemas"]["FlakeId"][];
|
|
4989
4984
|
/** @description The gameserver IDs associated with the product. */
|
|
4990
|
-
gameservers?: components["schemas"]["FlakeId"][]
|
|
4985
|
+
gameservers?: null | components["schemas"]["FlakeId"][];
|
|
4991
4986
|
/** @description The commands to be executed at different stages. */
|
|
4992
|
-
commands?: components["schemas"]["ProductCommandDto"][]
|
|
4987
|
+
commands?: null | components["schemas"]["ProductCommandDto"][];
|
|
4993
4988
|
deliverable_actions?: components["schemas"]["ProductDeliverableActionsDto"];
|
|
4994
4989
|
/** @description Additional metadata for the product. */
|
|
4995
|
-
metadata?: {
|
|
4990
|
+
metadata?: null | {
|
|
4996
4991
|
[key: string]: string;
|
|
4997
|
-
}
|
|
4992
|
+
};
|
|
4998
4993
|
/** @description The payout splits for revenue distribution.
|
|
4999
4994
|
* Requires special approval. */
|
|
5000
|
-
payout_splits?: components["schemas"]["ProductPayoutSplitDto"][]
|
|
4995
|
+
payout_splits?: null | components["schemas"]["ProductPayoutSplitDto"][];
|
|
5001
4996
|
tax_code?: components["schemas"]["ProductTaxCode"];
|
|
5002
4997
|
/** @description Indicates whether concurrent active items are allowed. */
|
|
5003
|
-
allow_concurrent_active_items?:
|
|
4998
|
+
allow_concurrent_active_items?: null | boolean;
|
|
5004
4999
|
/** @description Indicates whether using coupons and gift cards on this product is allowed. */
|
|
5005
|
-
disable_promo_codes?:
|
|
5000
|
+
disable_promo_codes?: null | boolean;
|
|
5006
5001
|
/** @description Indicates whether the product is hidden. */
|
|
5007
|
-
is_hidden?:
|
|
5002
|
+
is_hidden?: null | boolean;
|
|
5008
5003
|
/** @description Indicates whether gifting is disabled. */
|
|
5009
|
-
is_gifting_disabled?:
|
|
5004
|
+
is_gifting_disabled?: null | boolean;
|
|
5010
5005
|
/**
|
|
5011
5006
|
* Format: date-time
|
|
5012
5007
|
* @description The date and time when the product becomes enabled.
|
|
5013
5008
|
* Set to `null` to keep enabled.
|
|
5014
5009
|
*/
|
|
5015
|
-
enabled_at?:
|
|
5010
|
+
enabled_at?: null | string;
|
|
5016
5011
|
/**
|
|
5017
5012
|
* Format: date-time
|
|
5018
5013
|
* @description The date and time until which the product remains enabled.
|
|
5019
5014
|
* Set to `null` to keep enabled.
|
|
5020
5015
|
*/
|
|
5021
|
-
enabled_until?:
|
|
5016
|
+
enabled_until?: null | string;
|
|
5022
5017
|
/** @description The IDs of products required for purchasing this product. */
|
|
5023
|
-
required_product_ids?: components["schemas"]["FlakeId"][]
|
|
5018
|
+
required_product_ids?: null | components["schemas"]["FlakeId"][];
|
|
5024
5019
|
/** @description Indicates whether all required products are needed. */
|
|
5025
|
-
required_product_all?:
|
|
5020
|
+
required_product_all?: null | boolean;
|
|
5026
5021
|
/** @description The IDs of associated custom variables. */
|
|
5027
|
-
custom_variable_ids?: components["schemas"]["FlakeId"][]
|
|
5022
|
+
custom_variable_ids?: null | components["schemas"]["FlakeId"][];
|
|
5028
5023
|
};
|
|
5029
5024
|
/** @description Represents the configuration for trials of a product */
|
|
5030
5025
|
UpsertProductTrialConfigurationDto: {
|
|
5031
5026
|
/** @description Indicates if trials should be enabled for the product. */
|
|
5032
|
-
enabled?:
|
|
5027
|
+
enabled?: null | boolean;
|
|
5033
5028
|
/**
|
|
5034
5029
|
* Format: int32
|
|
5035
5030
|
* @description The trial period value.
|
|
5036
5031
|
*/
|
|
5037
|
-
period_value?:
|
|
5032
|
+
period_value?: null | number;
|
|
5038
5033
|
period_scale?: components["schemas"]["ProductSubscriptionIntervalScale"];
|
|
5039
5034
|
/** @description Indicates if the trial should be revoked immediately when canceled or at the end of the trial. */
|
|
5040
|
-
revoke_immediately_when_canceled?:
|
|
5035
|
+
revoke_immediately_when_canceled?: null | boolean;
|
|
5041
5036
|
/** @description Restricts trials to customers who have no orders within the lookback period.
|
|
5042
5037
|
* When enabled, customers with recent orders will be ineligible for trials. */
|
|
5043
|
-
new_customers_only?:
|
|
5038
|
+
new_customers_only?: null | boolean;
|
|
5044
5039
|
/**
|
|
5045
5040
|
* Format: int32
|
|
5046
5041
|
* @description The lookback period value for determining if a customer is "new".
|
|
5047
5042
|
* Only used when new_customers_only is enabled.
|
|
5048
5043
|
*/
|
|
5049
|
-
new_customer_order_lookback_value?:
|
|
5044
|
+
new_customer_order_lookback_value?: null | number;
|
|
5050
5045
|
new_customer_order_lookback_scale?: components["schemas"]["ProductSubscriptionIntervalScale"];
|
|
5051
5046
|
/** @description Allows customers to trial again after a cooldown period following their previous trial.
|
|
5052
5047
|
* When disabled, customers can only trial once and never become eligible again. */
|
|
5053
|
-
allow_repeat_trials?:
|
|
5048
|
+
allow_repeat_trials?: null | boolean;
|
|
5054
5049
|
/**
|
|
5055
5050
|
* Format: int32
|
|
5056
5051
|
* @description The cooldown period value before a customer becomes eligible for another trial.
|
|
5057
5052
|
* Only used when allow_repeat_trials is enabled.
|
|
5058
5053
|
*/
|
|
5059
|
-
repeat_trial_cooldown_value?:
|
|
5054
|
+
repeat_trial_cooldown_value?: null | number;
|
|
5060
5055
|
repeat_trial_cooldown_scale?: components["schemas"]["ProductSubscriptionIntervalScale"];
|
|
5061
5056
|
};
|
|
5062
5057
|
UpsertTagRequestDto: {
|
|
5063
|
-
name?:
|
|
5064
|
-
slug?:
|
|
5065
|
-
description?:
|
|
5066
|
-
enabled?:
|
|
5058
|
+
name?: null | string;
|
|
5059
|
+
slug?: null | string;
|
|
5060
|
+
description?: null | string;
|
|
5061
|
+
enabled?: null | boolean;
|
|
5067
5062
|
};
|
|
5068
5063
|
/** @description A validation error. */
|
|
5069
5064
|
ValidationError: {
|
|
@@ -5091,9 +5086,9 @@ export interface components {
|
|
|
5091
5086
|
secret: string;
|
|
5092
5087
|
subscribed_to: components["schemas"]["WebhookEventType"];
|
|
5093
5088
|
type: components["schemas"]["WebhookType"];
|
|
5094
|
-
discord_description_template?:
|
|
5095
|
-
discord_title?:
|
|
5096
|
-
discord_color?:
|
|
5089
|
+
discord_description_template?: null | string;
|
|
5090
|
+
discord_title?: null | string;
|
|
5091
|
+
discord_color?: null | string;
|
|
5097
5092
|
};
|
|
5098
5093
|
/** @enum {string} */
|
|
5099
5094
|
WebhookType: "json_v1" | "discord_v1";
|