@paynow-gg/typescript-sdk 1.0.46 → 1.0.48
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generated/management.d.ts +219 -34
- package/dist/generated/management.d.ts.map +1 -1
- package/dist/generated/management.js +4 -0
- package/dist/generated/management.js.map +1 -1
- package/dist/generated/storefront.d.ts +268 -0
- package/dist/generated/storefront.d.ts.map +1 -1
- package/dist/generated/storefront.js.map +1 -1
- package/package.json +1 -1
|
@@ -1411,6 +1411,22 @@ export interface paths {
|
|
|
1411
1411
|
patch: operations["Sales_UpdateSale"];
|
|
1412
1412
|
trace?: never;
|
|
1413
1413
|
};
|
|
1414
|
+
"/v1/stores/{storeId}": {
|
|
1415
|
+
parameters: {
|
|
1416
|
+
query?: never;
|
|
1417
|
+
header?: never;
|
|
1418
|
+
path?: never;
|
|
1419
|
+
cookie?: never;
|
|
1420
|
+
};
|
|
1421
|
+
get: operations["Store_GetStore"];
|
|
1422
|
+
put?: never;
|
|
1423
|
+
post?: never;
|
|
1424
|
+
delete?: never;
|
|
1425
|
+
options?: never;
|
|
1426
|
+
head?: never;
|
|
1427
|
+
patch?: never;
|
|
1428
|
+
trace?: never;
|
|
1429
|
+
};
|
|
1414
1430
|
"/v1/stores/{storeId}/subscriptions": {
|
|
1415
1431
|
parameters: {
|
|
1416
1432
|
query?: never;
|
|
@@ -1646,22 +1662,6 @@ export interface paths {
|
|
|
1646
1662
|
patch?: never;
|
|
1647
1663
|
trace?: never;
|
|
1648
1664
|
};
|
|
1649
|
-
"/v1/stores/{storeId}/trust/onboarding/status": {
|
|
1650
|
-
parameters: {
|
|
1651
|
-
query?: never;
|
|
1652
|
-
header?: never;
|
|
1653
|
-
path?: never;
|
|
1654
|
-
cookie?: never;
|
|
1655
|
-
};
|
|
1656
|
-
get?: never;
|
|
1657
|
-
put?: never;
|
|
1658
|
-
post?: never;
|
|
1659
|
-
delete?: never;
|
|
1660
|
-
options?: never;
|
|
1661
|
-
head?: never;
|
|
1662
|
-
patch?: never;
|
|
1663
|
-
trace?: never;
|
|
1664
|
-
};
|
|
1665
1665
|
"/v1/stores/{storeId}/trust/requirements": {
|
|
1666
1666
|
parameters: {
|
|
1667
1667
|
query?: never;
|
|
@@ -2387,6 +2387,9 @@ export interface components {
|
|
|
2387
2387
|
CreateStoreUpsellSettingsDto: {
|
|
2388
2388
|
enabled: boolean;
|
|
2389
2389
|
automatic_recommendations_enabled: boolean;
|
|
2390
|
+
automatic_recommendations_discount_type: components["schemas"]["UpsellDiscountType"];
|
|
2391
|
+
/** Format: int64 */
|
|
2392
|
+
automatic_recommendations_discount_amount: number;
|
|
2390
2393
|
recommendation_overrides_enabled: boolean;
|
|
2391
2394
|
recommendation_overrides: components["schemas"]["StoreUpsellRecommendationDto"][];
|
|
2392
2395
|
checkout_style: components["schemas"]["StoreUpsellCheckoutStyleDto"];
|
|
@@ -2536,6 +2539,7 @@ export interface components {
|
|
|
2536
2539
|
CustomerDto: {
|
|
2537
2540
|
id: components["schemas"]["FlakeId"];
|
|
2538
2541
|
store_id: components["schemas"]["FlakeId"];
|
|
2542
|
+
store?: components["schemas"]["StoreDto"];
|
|
2539
2543
|
profile?: components["schemas"]["GenericProfileDto"];
|
|
2540
2544
|
steam_id?: components["schemas"]["SteamId"];
|
|
2541
2545
|
steam?: components["schemas"]["SteamProfileDto"];
|
|
@@ -3990,6 +3994,39 @@ export interface components {
|
|
|
3990
3994
|
*/
|
|
3991
3995
|
payer_name?: null | string;
|
|
3992
3996
|
};
|
|
3997
|
+
/** @enum {string} */
|
|
3998
|
+
PlatformCapability: "invalid" | "connected_users";
|
|
3999
|
+
PlatformStoreTypeAssociationDetailsDto: {
|
|
4000
|
+
platform_id: components["schemas"]["FlakeId"];
|
|
4001
|
+
associated_platform?: components["schemas"]["PublicPlatformDto"];
|
|
4002
|
+
/** @description The store platform identifier string (e.g. "rust", "minecraft"). */
|
|
4003
|
+
store_platform: string;
|
|
4004
|
+
/**
|
|
4005
|
+
* Format: int64
|
|
4006
|
+
* @description Overrides the default PayNow platform fee percentage for this association.
|
|
4007
|
+
* Expressed in basis points (e.g. 250 = 2.50%).
|
|
4008
|
+
*/
|
|
4009
|
+
paynow_platform_fee_percentage_override?: null | number;
|
|
4010
|
+
/**
|
|
4011
|
+
* Format: int64
|
|
4012
|
+
* @description The fee percentage charged by the connected platform.
|
|
4013
|
+
* Expressed in basis points (e.g. 250 = 2.50%).
|
|
4014
|
+
*/
|
|
4015
|
+
connected_platform_fee_percentage?: null | number;
|
|
4016
|
+
/**
|
|
4017
|
+
* Format: int64
|
|
4018
|
+
* @description The payout ID associated with the connected platform.
|
|
4019
|
+
*/
|
|
4020
|
+
connected_platform_wallet_id?: null | number;
|
|
4021
|
+
/** @description When true, billing plans are disabled for this platform/store type combination. */
|
|
4022
|
+
disable_billing_plans: boolean;
|
|
4023
|
+
/** @description When true, legal or compliance disclaimers should be displayed to the end user. */
|
|
4024
|
+
display_disclaimers: boolean;
|
|
4025
|
+
/** @description Whether the management hides some PayNow UI */
|
|
4026
|
+
full_external_management: boolean;
|
|
4027
|
+
};
|
|
4028
|
+
/** @enum {string} */
|
|
4029
|
+
PlatformType: "invalid" | "marketplace" | "store_platform" | "other";
|
|
3993
4030
|
/**
|
|
3994
4031
|
* @description Defines when prepaid cards should be blocked from use.
|
|
3995
4032
|
* @enum {string}
|
|
@@ -4346,6 +4383,25 @@ export interface components {
|
|
|
4346
4383
|
quantity_to_add?: null | number;
|
|
4347
4384
|
prefer_as_subscription: boolean;
|
|
4348
4385
|
};
|
|
4386
|
+
PublicPlatformDto: {
|
|
4387
|
+
id: components["schemas"]["FlakeId"];
|
|
4388
|
+
slug: string;
|
|
4389
|
+
type: components["schemas"]["PlatformType"];
|
|
4390
|
+
country_code: string;
|
|
4391
|
+
business_name: string;
|
|
4392
|
+
name: string;
|
|
4393
|
+
description: string;
|
|
4394
|
+
website_url: string;
|
|
4395
|
+
logo_url: string;
|
|
4396
|
+
accent_color: string;
|
|
4397
|
+
capabilities: components["schemas"]["PlatformCapability"][];
|
|
4398
|
+
/** Format: date-time */
|
|
4399
|
+
created_at: string;
|
|
4400
|
+
/** Format: date-time */
|
|
4401
|
+
updated_at: string;
|
|
4402
|
+
/** Format: date-time */
|
|
4403
|
+
disabled_at?: null | string;
|
|
4404
|
+
};
|
|
4349
4405
|
/** @description Represents a command associated with the store-level purchase follow uo configuration. */
|
|
4350
4406
|
PurchaseFollowUpStoreConfigurationCommandDto: {
|
|
4351
4407
|
id: components["schemas"]["FlakeId"];
|
|
@@ -4737,6 +4793,74 @@ export interface components {
|
|
|
4737
4793
|
*/
|
|
4738
4794
|
price: number;
|
|
4739
4795
|
};
|
|
4796
|
+
/** @description Represents a PayNow store and its associated configuration. */
|
|
4797
|
+
StoreDto: {
|
|
4798
|
+
id: components["schemas"]["FlakeId"];
|
|
4799
|
+
trust?: components["schemas"]["StoreTrustDto"];
|
|
4800
|
+
owner_id: components["schemas"]["FlakeId"];
|
|
4801
|
+
/** @description The URL-safe slug used to identify the store (e.g. "my-rust-server"). */
|
|
4802
|
+
slug: string;
|
|
4803
|
+
/** @description The display name of the store. */
|
|
4804
|
+
name: string;
|
|
4805
|
+
/** @description The platform this store is associated with (e.g. "rust", "minecraft"). */
|
|
4806
|
+
platform: string;
|
|
4807
|
+
/** @description Alias for PayNow.Services.HttpGateway.DataTransferObjects.V1.Stores.StoreDto.Platform. Returns the platform identifier as a game name. */
|
|
4808
|
+
readonly game: string;
|
|
4809
|
+
/** @description The ISO 4217 currency code used by this store for pricing (e.g. "usd", "eur") */
|
|
4810
|
+
currency: string;
|
|
4811
|
+
/** @description A human-readable description of the store shown to customers and PayNow. */
|
|
4812
|
+
description: string;
|
|
4813
|
+
/** @description The store's public website URL. */
|
|
4814
|
+
website_url?: null | string;
|
|
4815
|
+
/** @description General contact email address for the store. */
|
|
4816
|
+
contact_email?: null | string;
|
|
4817
|
+
/** @description Dedicated support email address for customer inquiries. */
|
|
4818
|
+
support_email?: null | string;
|
|
4819
|
+
/** @description URL to the store's support portal or help page. */
|
|
4820
|
+
support_url?: null | string;
|
|
4821
|
+
/** @description The integration type used by the store. */
|
|
4822
|
+
integration_type?: null | string;
|
|
4823
|
+
/** @description When set to true, the store is processing real transactions in live mode. */
|
|
4824
|
+
live_mode: boolean;
|
|
4825
|
+
/** @description URL of the store's full-size logo image. */
|
|
4826
|
+
logo_url?: null | string;
|
|
4827
|
+
/** @description URL of the store's square/icon logo image. */
|
|
4828
|
+
logo_square_url?: null | string;
|
|
4829
|
+
/** @description Username prefix used to identify Minecraft Bedrock players (e.g. "."). */
|
|
4830
|
+
minecraft_bedrock_username_prefix?: null | string;
|
|
4831
|
+
/**
|
|
4832
|
+
* Format: date-time
|
|
4833
|
+
* @description The UTC timestamp when the store was created.
|
|
4834
|
+
*/
|
|
4835
|
+
created_at?: null | string;
|
|
4836
|
+
/**
|
|
4837
|
+
* Format: date-time
|
|
4838
|
+
* @description The UTC timestamp when the store was last updated.
|
|
4839
|
+
*/
|
|
4840
|
+
updated_at?: null | string;
|
|
4841
|
+
/**
|
|
4842
|
+
* Format: date-time
|
|
4843
|
+
* @description The UTC timestamp when the store completed onboarding.
|
|
4844
|
+
*/
|
|
4845
|
+
onboarding_completed_at?: null | string;
|
|
4846
|
+
platform_store_type_association?: components["schemas"]["PlatformStoreTypeAssociationDetailsDto"];
|
|
4847
|
+
/** @description The list of members who have access to manage this store. */
|
|
4848
|
+
members?: null | components["schemas"]["StoreMemberDto"][];
|
|
4849
|
+
};
|
|
4850
|
+
StoreMemberDto: {
|
|
4851
|
+
user: components["schemas"]["StoreMemberUserDto"];
|
|
4852
|
+
/** Format: date-time */
|
|
4853
|
+
added_at?: null | string;
|
|
4854
|
+
added_by?: components["schemas"]["ActorDto"];
|
|
4855
|
+
role_id?: components["schemas"]["FlakeId"];
|
|
4856
|
+
};
|
|
4857
|
+
StoreMemberUserDto: {
|
|
4858
|
+
type: components["schemas"]["PayNowActorType"];
|
|
4859
|
+
id: components["schemas"]["FlakeId"];
|
|
4860
|
+
email: string;
|
|
4861
|
+
first_name: string;
|
|
4862
|
+
last_name: string;
|
|
4863
|
+
};
|
|
4740
4864
|
/** @description Store payment configuration settings. */
|
|
4741
4865
|
StorePaymentSettingsDto: {
|
|
4742
4866
|
/** @description Whether to show all available payment methods for subscription purchases. */
|
|
@@ -4781,6 +4905,8 @@ export interface components {
|
|
|
4781
4905
|
StoreRequirementCategory: "invalid" | "business" | "kyc" | "compliance" | "risk" | "technical" | "financial" | "legal" | "other";
|
|
4782
4906
|
/** @enum {string} */
|
|
4783
4907
|
StoreRequirementStatus: "invalid" | "pending" | "under_review" | "requires_revision" | "approved" | "expired" | "waived" | "rejected_final";
|
|
4908
|
+
/** @enum {string} */
|
|
4909
|
+
StoreRestrictionFlagDto: "none" | "payments_disabled" | "payouts_disabled";
|
|
4784
4910
|
/** @description Data transfer object representing a store subscription. */
|
|
4785
4911
|
StoreSubscriptionDto: {
|
|
4786
4912
|
id: components["schemas"]["FlakeId"];
|
|
@@ -5016,6 +5142,44 @@ export interface components {
|
|
|
5016
5142
|
/** @description Reason provided for cancellation. */
|
|
5017
5143
|
cancel_reason?: null | string;
|
|
5018
5144
|
};
|
|
5145
|
+
StoreTrustDto: {
|
|
5146
|
+
store_id: components["schemas"]["FlakeId"];
|
|
5147
|
+
status: components["schemas"]["StoreTrustStatusDto"];
|
|
5148
|
+
status_reason?: null | string;
|
|
5149
|
+
restrictions: components["schemas"]["StoreRestrictionFlagDto"];
|
|
5150
|
+
/** Format: date-time */
|
|
5151
|
+
created_at: string;
|
|
5152
|
+
/** Format: date-time */
|
|
5153
|
+
updated_at?: null | string;
|
|
5154
|
+
onboarding_steps?: components["schemas"]["StoreTrustOnboardingStepsDto"];
|
|
5155
|
+
events: components["schemas"]["StoreTrustEventDto"][];
|
|
5156
|
+
pending_requirements: components["schemas"]["TrustStoreRequirementDto"][];
|
|
5157
|
+
};
|
|
5158
|
+
StoreTrustEventDto: {
|
|
5159
|
+
id: components["schemas"]["FlakeId"];
|
|
5160
|
+
store_id: components["schemas"]["FlakeId"];
|
|
5161
|
+
type: components["schemas"]["StoreTrustEventTypeDto"];
|
|
5162
|
+
description?: null | string;
|
|
5163
|
+
store_requirement_id?: components["schemas"]["FlakeId"];
|
|
5164
|
+
store_review_id?: components["schemas"]["FlakeId"];
|
|
5165
|
+
actor: components["schemas"]["ActorDto"];
|
|
5166
|
+
/** Format: date-time */
|
|
5167
|
+
created_at: string;
|
|
5168
|
+
};
|
|
5169
|
+
/** @enum {string} */
|
|
5170
|
+
StoreTrustEventTypeDto: "invalid" | "onboarded" | "escalated_to_review" | "action_required" | "restricted" | "offboarded" | "reactivated" | "requirement_added" | "requirement_submitted" | "requirement_verified" | "requirement_rejected" | "requirement_deadline_missed" | "requirement_waived" | "requirement_requires_revision" | "restriction_added" | "restriction_lifted" | "review_scheduled" | "review_completed";
|
|
5171
|
+
StoreTrustOnboardingStepsDto: {
|
|
5172
|
+
store_id: components["schemas"]["FlakeId"];
|
|
5173
|
+
store_owner_id: components["schemas"]["FlakeId"];
|
|
5174
|
+
payout_onboarding_completed: boolean;
|
|
5175
|
+
kyc_completed: boolean;
|
|
5176
|
+
products_created: boolean;
|
|
5177
|
+
gameserver_linked: boolean;
|
|
5178
|
+
webhooks_active: boolean;
|
|
5179
|
+
downloadable_files_added: boolean;
|
|
5180
|
+
};
|
|
5181
|
+
/** @enum {string} */
|
|
5182
|
+
StoreTrustStatusDto: "invalid" | "pending_review" | "requires_action" | "under_review" | "active" | "restricted" | "offboarded";
|
|
5019
5183
|
/** @enum {string} */
|
|
5020
5184
|
StoreUpsellCheckoutStyleDto: "unknown" | "inline" | "inline_and_prepayment_dialog" | "dedicated_step";
|
|
5021
5185
|
StoreUpsellRecommendationDto: {
|
|
@@ -5033,6 +5197,9 @@ export interface components {
|
|
|
5033
5197
|
StoreUpsellSettingsDto: {
|
|
5034
5198
|
enabled: boolean;
|
|
5035
5199
|
automatic_recommendations_enabled: boolean;
|
|
5200
|
+
automatic_recommendations_discount_type: components["schemas"]["UpsellDiscountType"];
|
|
5201
|
+
/** Format: int64 */
|
|
5202
|
+
automatic_recommendations_discount_amount: number;
|
|
5036
5203
|
recommendation_overrides_enabled: boolean;
|
|
5037
5204
|
recommendation_overrides: components["schemas"]["StoreUpsellRecommendationDto"][];
|
|
5038
5205
|
checkout_style: components["schemas"]["StoreUpsellCheckoutStyleDto"];
|
|
@@ -5158,24 +5325,6 @@ export interface components {
|
|
|
5158
5325
|
};
|
|
5159
5326
|
/** @enum {string} */
|
|
5160
5327
|
TrialStatusDto: "created" | "active" | "canceled" | "completed";
|
|
5161
|
-
TrustStoreOnboardingDto: {
|
|
5162
|
-
store_id: components["schemas"]["FlakeId"];
|
|
5163
|
-
user_id: components["schemas"]["FlakeId"];
|
|
5164
|
-
status: components["schemas"]["TrustStoreOnboardingStatus"];
|
|
5165
|
-
payout_onboarding_completed: boolean;
|
|
5166
|
-
kyc_completed: boolean;
|
|
5167
|
-
requires_approval: boolean;
|
|
5168
|
-
manually_approved: boolean;
|
|
5169
|
-
decline_reason?: null | string;
|
|
5170
|
-
requires_action_text?: null | string;
|
|
5171
|
-
products_created: boolean;
|
|
5172
|
-
kyc_required: boolean;
|
|
5173
|
-
gameserver_linked: boolean;
|
|
5174
|
-
webhooks_active: boolean;
|
|
5175
|
-
downloadable_files_added: boolean;
|
|
5176
|
-
};
|
|
5177
|
-
/** @enum {string} */
|
|
5178
|
-
TrustStoreOnboardingStatus: "invalid" | "pending" | "approved" | "declined" | "requires_action" | "under_review";
|
|
5179
5328
|
TrustStoreRequirementDto: {
|
|
5180
5329
|
id: components["schemas"]["FlakeId"];
|
|
5181
5330
|
store_id: components["schemas"]["FlakeId"];
|
|
@@ -5371,6 +5520,9 @@ export interface components {
|
|
|
5371
5520
|
UpdateStoreUpsellSettingsDto: {
|
|
5372
5521
|
enabled?: boolean;
|
|
5373
5522
|
automatic_recommendations_enabled?: boolean;
|
|
5523
|
+
automatic_recommendations_discount_type?: components["schemas"]["UpsellDiscountType"];
|
|
5524
|
+
/** Format: int64 */
|
|
5525
|
+
automatic_recommendations_discount_amount?: number;
|
|
5374
5526
|
recommendation_overrides_enabled?: boolean;
|
|
5375
5527
|
recommendation_overrides?: components["schemas"]["StoreUpsellRecommendationDto"][];
|
|
5376
5528
|
checkout_style?: components["schemas"]["StoreUpsellCheckoutStyleDto"];
|
|
@@ -5390,6 +5542,8 @@ export interface components {
|
|
|
5390
5542
|
discord_color?: null | string;
|
|
5391
5543
|
};
|
|
5392
5544
|
/** @enum {string} */
|
|
5545
|
+
UpsellDiscountType: "unknown" | "none" | "fixed" | "percentage";
|
|
5546
|
+
/** @enum {string} */
|
|
5393
5547
|
UpsellDiscountTypeDto: "unknown" | "none" | "fixed" | "percentage";
|
|
5394
5548
|
/** @enum {string} */
|
|
5395
5549
|
UpsellTypeDto: "unknown" | "additional" | "alternative" | "increase_quantity";
|
|
@@ -9584,6 +9738,33 @@ export interface operations {
|
|
|
9584
9738
|
};
|
|
9585
9739
|
};
|
|
9586
9740
|
};
|
|
9741
|
+
Store_GetStore: {
|
|
9742
|
+
parameters: {
|
|
9743
|
+
query?: never;
|
|
9744
|
+
header?: never;
|
|
9745
|
+
path?: never;
|
|
9746
|
+
cookie?: never;
|
|
9747
|
+
};
|
|
9748
|
+
requestBody?: never;
|
|
9749
|
+
responses: {
|
|
9750
|
+
/** @description OK */
|
|
9751
|
+
200: {
|
|
9752
|
+
headers: {
|
|
9753
|
+
[name: string]: unknown;
|
|
9754
|
+
};
|
|
9755
|
+
content?: never;
|
|
9756
|
+
};
|
|
9757
|
+
/** @description Error response */
|
|
9758
|
+
default: {
|
|
9759
|
+
headers: {
|
|
9760
|
+
[name: string]: unknown;
|
|
9761
|
+
};
|
|
9762
|
+
content: {
|
|
9763
|
+
"application/json": components["schemas"]["PayNowError"];
|
|
9764
|
+
};
|
|
9765
|
+
};
|
|
9766
|
+
};
|
|
9767
|
+
};
|
|
9587
9768
|
Subscriptions_GetSubscriptions: {
|
|
9588
9769
|
parameters: {
|
|
9589
9770
|
query?: {
|
|
@@ -10909,6 +11090,10 @@ export declare const operationMappings: {
|
|
|
10909
11090
|
readonly method: "PATCH";
|
|
10910
11091
|
readonly path: "/v1/stores/{storeId}/sales/{saleId}";
|
|
10911
11092
|
};
|
|
11093
|
+
readonly Store_GetStore: {
|
|
11094
|
+
readonly method: "GET";
|
|
11095
|
+
readonly path: "/v1/stores/{storeId}";
|
|
11096
|
+
};
|
|
10912
11097
|
readonly Subscriptions_GetSubscriptions: {
|
|
10913
11098
|
readonly method: "GET";
|
|
10914
11099
|
readonly path: "/v1/stores/{storeId}/subscriptions";
|