@paynow-gg/typescript-sdk 1.0.45 → 1.0.47
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 +213 -40
- 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/dist/generated/webhooks.d.ts +340 -1
- package/dist/generated/webhooks.d.ts.map +1 -1
- package/dist/generated/webhooks.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;
|
|
@@ -2389,6 +2389,7 @@ export interface components {
|
|
|
2389
2389
|
automatic_recommendations_enabled: boolean;
|
|
2390
2390
|
recommendation_overrides_enabled: boolean;
|
|
2391
2391
|
recommendation_overrides: components["schemas"]["StoreUpsellRecommendationDto"][];
|
|
2392
|
+
checkout_style: components["schemas"]["StoreUpsellCheckoutStyleDto"];
|
|
2392
2393
|
};
|
|
2393
2394
|
CreateTrialEligibilityOverrideDto: {
|
|
2394
2395
|
product_id: components["schemas"]["FlakeId"];
|
|
@@ -2535,6 +2536,7 @@ export interface components {
|
|
|
2535
2536
|
CustomerDto: {
|
|
2536
2537
|
id: components["schemas"]["FlakeId"];
|
|
2537
2538
|
store_id: components["schemas"]["FlakeId"];
|
|
2539
|
+
store?: components["schemas"]["StoreDto"];
|
|
2538
2540
|
profile?: components["schemas"]["GenericProfileDto"];
|
|
2539
2541
|
steam_id?: components["schemas"]["SteamId"];
|
|
2540
2542
|
steam?: components["schemas"]["SteamProfileDto"];
|
|
@@ -3989,6 +3991,39 @@ export interface components {
|
|
|
3989
3991
|
*/
|
|
3990
3992
|
payer_name?: null | string;
|
|
3991
3993
|
};
|
|
3994
|
+
/** @enum {string} */
|
|
3995
|
+
PlatformCapability: "invalid" | "connected_users";
|
|
3996
|
+
PlatformStoreTypeAssociationDetailsDto: {
|
|
3997
|
+
platform_id: components["schemas"]["FlakeId"];
|
|
3998
|
+
associated_platform?: components["schemas"]["PublicPlatformDto"];
|
|
3999
|
+
/** @description The store platform identifier string (e.g. "rust", "minecraft"). */
|
|
4000
|
+
store_platform: string;
|
|
4001
|
+
/**
|
|
4002
|
+
* Format: int64
|
|
4003
|
+
* @description Overrides the default PayNow platform fee percentage for this association.
|
|
4004
|
+
* Expressed in basis points (e.g. 250 = 2.50%).
|
|
4005
|
+
*/
|
|
4006
|
+
paynow_platform_fee_percentage_override?: null | number;
|
|
4007
|
+
/**
|
|
4008
|
+
* Format: int64
|
|
4009
|
+
* @description The fee percentage charged by the connected platform.
|
|
4010
|
+
* Expressed in basis points (e.g. 250 = 2.50%).
|
|
4011
|
+
*/
|
|
4012
|
+
connected_platform_fee_percentage?: null | number;
|
|
4013
|
+
/**
|
|
4014
|
+
* Format: int64
|
|
4015
|
+
* @description The payout ID associated with the connected platform.
|
|
4016
|
+
*/
|
|
4017
|
+
connected_platform_wallet_id?: null | number;
|
|
4018
|
+
/** @description When true, billing plans are disabled for this platform/store type combination. */
|
|
4019
|
+
disable_billing_plans: boolean;
|
|
4020
|
+
/** @description When true, legal or compliance disclaimers should be displayed to the end user. */
|
|
4021
|
+
display_disclaimers: boolean;
|
|
4022
|
+
/** @description Whether the management hides some PayNow UI */
|
|
4023
|
+
full_external_management: boolean;
|
|
4024
|
+
};
|
|
4025
|
+
/** @enum {string} */
|
|
4026
|
+
PlatformType: "invalid" | "marketplace" | "store_platform" | "other";
|
|
3992
4027
|
/**
|
|
3993
4028
|
* @description Defines when prepaid cards should be blocked from use.
|
|
3994
4029
|
* @enum {string}
|
|
@@ -4334,8 +4369,6 @@ export interface components {
|
|
|
4334
4369
|
ProductUpsellRecommendationDto: {
|
|
4335
4370
|
recommended_product_id: components["schemas"]["FlakeId"];
|
|
4336
4371
|
type: components["schemas"]["UpsellTypeDto"];
|
|
4337
|
-
/** Format: int32 */
|
|
4338
|
-
priority: number;
|
|
4339
4372
|
discount_type: components["schemas"]["UpsellDiscountTypeDto"];
|
|
4340
4373
|
/** Format: int64 */
|
|
4341
4374
|
discount_amount: number;
|
|
@@ -4347,6 +4380,25 @@ export interface components {
|
|
|
4347
4380
|
quantity_to_add?: null | number;
|
|
4348
4381
|
prefer_as_subscription: boolean;
|
|
4349
4382
|
};
|
|
4383
|
+
PublicPlatformDto: {
|
|
4384
|
+
id: components["schemas"]["FlakeId"];
|
|
4385
|
+
slug: string;
|
|
4386
|
+
type: components["schemas"]["PlatformType"];
|
|
4387
|
+
country_code: string;
|
|
4388
|
+
business_name: string;
|
|
4389
|
+
name: string;
|
|
4390
|
+
description: string;
|
|
4391
|
+
website_url: string;
|
|
4392
|
+
logo_url: string;
|
|
4393
|
+
accent_color: string;
|
|
4394
|
+
capabilities: components["schemas"]["PlatformCapability"][];
|
|
4395
|
+
/** Format: date-time */
|
|
4396
|
+
created_at: string;
|
|
4397
|
+
/** Format: date-time */
|
|
4398
|
+
updated_at: string;
|
|
4399
|
+
/** Format: date-time */
|
|
4400
|
+
disabled_at?: null | string;
|
|
4401
|
+
};
|
|
4350
4402
|
/** @description Represents a command associated with the store-level purchase follow uo configuration. */
|
|
4351
4403
|
PurchaseFollowUpStoreConfigurationCommandDto: {
|
|
4352
4404
|
id: components["schemas"]["FlakeId"];
|
|
@@ -4738,6 +4790,74 @@ export interface components {
|
|
|
4738
4790
|
*/
|
|
4739
4791
|
price: number;
|
|
4740
4792
|
};
|
|
4793
|
+
/** @description Represents a PayNow store and its associated configuration. */
|
|
4794
|
+
StoreDto: {
|
|
4795
|
+
id: components["schemas"]["FlakeId"];
|
|
4796
|
+
trust?: components["schemas"]["StoreTrustDto"];
|
|
4797
|
+
owner_id: components["schemas"]["FlakeId"];
|
|
4798
|
+
/** @description The URL-safe slug used to identify the store (e.g. "my-rust-server"). */
|
|
4799
|
+
slug: string;
|
|
4800
|
+
/** @description The display name of the store. */
|
|
4801
|
+
name: string;
|
|
4802
|
+
/** @description The platform this store is associated with (e.g. "rust", "minecraft"). */
|
|
4803
|
+
platform: string;
|
|
4804
|
+
/** @description Alias for PayNow.Services.HttpGateway.DataTransferObjects.V1.Stores.StoreDto.Platform. Returns the platform identifier as a game name. */
|
|
4805
|
+
readonly game: string;
|
|
4806
|
+
/** @description The ISO 4217 currency code used by this store for pricing (e.g. "usd", "eur") */
|
|
4807
|
+
currency: string;
|
|
4808
|
+
/** @description A human-readable description of the store shown to customers and PayNow. */
|
|
4809
|
+
description: string;
|
|
4810
|
+
/** @description The store's public website URL. */
|
|
4811
|
+
website_url?: null | string;
|
|
4812
|
+
/** @description General contact email address for the store. */
|
|
4813
|
+
contact_email?: null | string;
|
|
4814
|
+
/** @description Dedicated support email address for customer inquiries. */
|
|
4815
|
+
support_email?: null | string;
|
|
4816
|
+
/** @description URL to the store's support portal or help page. */
|
|
4817
|
+
support_url?: null | string;
|
|
4818
|
+
/** @description The integration type used by the store. */
|
|
4819
|
+
integration_type?: null | string;
|
|
4820
|
+
/** @description When set to true, the store is processing real transactions in live mode. */
|
|
4821
|
+
live_mode: boolean;
|
|
4822
|
+
/** @description URL of the store's full-size logo image. */
|
|
4823
|
+
logo_url?: null | string;
|
|
4824
|
+
/** @description URL of the store's square/icon logo image. */
|
|
4825
|
+
logo_square_url?: null | string;
|
|
4826
|
+
/** @description Username prefix used to identify Minecraft Bedrock players (e.g. "."). */
|
|
4827
|
+
minecraft_bedrock_username_prefix?: null | string;
|
|
4828
|
+
/**
|
|
4829
|
+
* Format: date-time
|
|
4830
|
+
* @description The UTC timestamp when the store was created.
|
|
4831
|
+
*/
|
|
4832
|
+
created_at?: null | string;
|
|
4833
|
+
/**
|
|
4834
|
+
* Format: date-time
|
|
4835
|
+
* @description The UTC timestamp when the store was last updated.
|
|
4836
|
+
*/
|
|
4837
|
+
updated_at?: null | string;
|
|
4838
|
+
/**
|
|
4839
|
+
* Format: date-time
|
|
4840
|
+
* @description The UTC timestamp when the store completed onboarding.
|
|
4841
|
+
*/
|
|
4842
|
+
onboarding_completed_at?: null | string;
|
|
4843
|
+
platform_store_type_association?: components["schemas"]["PlatformStoreTypeAssociationDetailsDto"];
|
|
4844
|
+
/** @description The list of members who have access to manage this store. */
|
|
4845
|
+
members?: null | components["schemas"]["StoreMemberDto"][];
|
|
4846
|
+
};
|
|
4847
|
+
StoreMemberDto: {
|
|
4848
|
+
user: components["schemas"]["StoreMemberUserDto"];
|
|
4849
|
+
/** Format: date-time */
|
|
4850
|
+
added_at?: null | string;
|
|
4851
|
+
added_by?: components["schemas"]["ActorDto"];
|
|
4852
|
+
role_id?: components["schemas"]["FlakeId"];
|
|
4853
|
+
};
|
|
4854
|
+
StoreMemberUserDto: {
|
|
4855
|
+
type: components["schemas"]["PayNowActorType"];
|
|
4856
|
+
id: components["schemas"]["FlakeId"];
|
|
4857
|
+
email: string;
|
|
4858
|
+
first_name: string;
|
|
4859
|
+
last_name: string;
|
|
4860
|
+
};
|
|
4741
4861
|
/** @description Store payment configuration settings. */
|
|
4742
4862
|
StorePaymentSettingsDto: {
|
|
4743
4863
|
/** @description Whether to show all available payment methods for subscription purchases. */
|
|
@@ -4782,6 +4902,8 @@ export interface components {
|
|
|
4782
4902
|
StoreRequirementCategory: "invalid" | "business" | "kyc" | "compliance" | "risk" | "technical" | "financial" | "legal" | "other";
|
|
4783
4903
|
/** @enum {string} */
|
|
4784
4904
|
StoreRequirementStatus: "invalid" | "pending" | "under_review" | "requires_revision" | "approved" | "expired" | "waived" | "rejected_final";
|
|
4905
|
+
/** @enum {string} */
|
|
4906
|
+
StoreRestrictionFlagDto: "none" | "payments_disabled" | "payouts_disabled";
|
|
4785
4907
|
/** @description Data transfer object representing a store subscription. */
|
|
4786
4908
|
StoreSubscriptionDto: {
|
|
4787
4909
|
id: components["schemas"]["FlakeId"];
|
|
@@ -5017,11 +5139,49 @@ export interface components {
|
|
|
5017
5139
|
/** @description Reason provided for cancellation. */
|
|
5018
5140
|
cancel_reason?: null | string;
|
|
5019
5141
|
};
|
|
5142
|
+
StoreTrustDto: {
|
|
5143
|
+
store_id: components["schemas"]["FlakeId"];
|
|
5144
|
+
status: components["schemas"]["StoreTrustStatusDto"];
|
|
5145
|
+
status_reason?: null | string;
|
|
5146
|
+
restrictions: components["schemas"]["StoreRestrictionFlagDto"];
|
|
5147
|
+
/** Format: date-time */
|
|
5148
|
+
created_at: string;
|
|
5149
|
+
/** Format: date-time */
|
|
5150
|
+
updated_at?: null | string;
|
|
5151
|
+
onboarding_steps?: components["schemas"]["StoreTrustOnboardingStepsDto"];
|
|
5152
|
+
events: components["schemas"]["StoreTrustEventDto"][];
|
|
5153
|
+
pending_requirements: components["schemas"]["TrustStoreRequirementDto"][];
|
|
5154
|
+
};
|
|
5155
|
+
StoreTrustEventDto: {
|
|
5156
|
+
id: components["schemas"]["FlakeId"];
|
|
5157
|
+
store_id: components["schemas"]["FlakeId"];
|
|
5158
|
+
type: components["schemas"]["StoreTrustEventTypeDto"];
|
|
5159
|
+
description?: null | string;
|
|
5160
|
+
store_requirement_id?: components["schemas"]["FlakeId"];
|
|
5161
|
+
store_review_id?: components["schemas"]["FlakeId"];
|
|
5162
|
+
actor: components["schemas"]["ActorDto"];
|
|
5163
|
+
/** Format: date-time */
|
|
5164
|
+
created_at: string;
|
|
5165
|
+
};
|
|
5166
|
+
/** @enum {string} */
|
|
5167
|
+
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";
|
|
5168
|
+
StoreTrustOnboardingStepsDto: {
|
|
5169
|
+
store_id: components["schemas"]["FlakeId"];
|
|
5170
|
+
store_owner_id: components["schemas"]["FlakeId"];
|
|
5171
|
+
payout_onboarding_completed: boolean;
|
|
5172
|
+
kyc_completed: boolean;
|
|
5173
|
+
products_created: boolean;
|
|
5174
|
+
gameserver_linked: boolean;
|
|
5175
|
+
webhooks_active: boolean;
|
|
5176
|
+
downloadable_files_added: boolean;
|
|
5177
|
+
};
|
|
5178
|
+
/** @enum {string} */
|
|
5179
|
+
StoreTrustStatusDto: "invalid" | "pending_review" | "requires_action" | "under_review" | "active" | "restricted" | "offboarded";
|
|
5180
|
+
/** @enum {string} */
|
|
5181
|
+
StoreUpsellCheckoutStyleDto: "unknown" | "inline" | "inline_and_prepayment_dialog" | "dedicated_step";
|
|
5020
5182
|
StoreUpsellRecommendationDto: {
|
|
5021
5183
|
recommended_product_id: components["schemas"]["FlakeId"];
|
|
5022
5184
|
type: components["schemas"]["UpsellTypeDto"];
|
|
5023
|
-
/** Format: int32 */
|
|
5024
|
-
priority: number;
|
|
5025
5185
|
discount_type: components["schemas"]["UpsellDiscountTypeDto"];
|
|
5026
5186
|
/** Format: int64 */
|
|
5027
5187
|
discount_amount: number;
|
|
@@ -5036,6 +5196,7 @@ export interface components {
|
|
|
5036
5196
|
automatic_recommendations_enabled: boolean;
|
|
5037
5197
|
recommendation_overrides_enabled: boolean;
|
|
5038
5198
|
recommendation_overrides: components["schemas"]["StoreUpsellRecommendationDto"][];
|
|
5199
|
+
checkout_style: components["schemas"]["StoreUpsellCheckoutStyleDto"];
|
|
5039
5200
|
/** Format: date-time */
|
|
5040
5201
|
updated_at: string;
|
|
5041
5202
|
updated_by: components["schemas"]["ActorDto"];
|
|
@@ -5158,24 +5319,6 @@ export interface components {
|
|
|
5158
5319
|
};
|
|
5159
5320
|
/** @enum {string} */
|
|
5160
5321
|
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
5322
|
TrustStoreRequirementDto: {
|
|
5180
5323
|
id: components["schemas"]["FlakeId"];
|
|
5181
5324
|
store_id: components["schemas"]["FlakeId"];
|
|
@@ -5373,6 +5516,7 @@ export interface components {
|
|
|
5373
5516
|
automatic_recommendations_enabled?: boolean;
|
|
5374
5517
|
recommendation_overrides_enabled?: boolean;
|
|
5375
5518
|
recommendation_overrides?: components["schemas"]["StoreUpsellRecommendationDto"][];
|
|
5519
|
+
checkout_style?: components["schemas"]["StoreUpsellCheckoutStyleDto"];
|
|
5376
5520
|
};
|
|
5377
5521
|
UpdateTrialEligibilityOverrideDto: {
|
|
5378
5522
|
product_id?: components["schemas"]["FlakeId"];
|
|
@@ -5569,8 +5713,6 @@ export interface components {
|
|
|
5569
5713
|
UpsertProductUpsellRecommendationDto: {
|
|
5570
5714
|
recommended_product_id: components["schemas"]["FlakeId"];
|
|
5571
5715
|
type: components["schemas"]["UpsellTypeDto"];
|
|
5572
|
-
/** Format: int32 */
|
|
5573
|
-
priority: number;
|
|
5574
5716
|
discount_type: components["schemas"]["UpsellDiscountTypeDto"];
|
|
5575
5717
|
/** Format: int64 */
|
|
5576
5718
|
discount_amount: number;
|
|
@@ -9585,6 +9727,33 @@ export interface operations {
|
|
|
9585
9727
|
};
|
|
9586
9728
|
};
|
|
9587
9729
|
};
|
|
9730
|
+
Store_GetStore: {
|
|
9731
|
+
parameters: {
|
|
9732
|
+
query?: never;
|
|
9733
|
+
header?: never;
|
|
9734
|
+
path?: never;
|
|
9735
|
+
cookie?: never;
|
|
9736
|
+
};
|
|
9737
|
+
requestBody?: never;
|
|
9738
|
+
responses: {
|
|
9739
|
+
/** @description OK */
|
|
9740
|
+
200: {
|
|
9741
|
+
headers: {
|
|
9742
|
+
[name: string]: unknown;
|
|
9743
|
+
};
|
|
9744
|
+
content?: never;
|
|
9745
|
+
};
|
|
9746
|
+
/** @description Error response */
|
|
9747
|
+
default: {
|
|
9748
|
+
headers: {
|
|
9749
|
+
[name: string]: unknown;
|
|
9750
|
+
};
|
|
9751
|
+
content: {
|
|
9752
|
+
"application/json": components["schemas"]["PayNowError"];
|
|
9753
|
+
};
|
|
9754
|
+
};
|
|
9755
|
+
};
|
|
9756
|
+
};
|
|
9588
9757
|
Subscriptions_GetSubscriptions: {
|
|
9589
9758
|
parameters: {
|
|
9590
9759
|
query?: {
|
|
@@ -10910,6 +11079,10 @@ export declare const operationMappings: {
|
|
|
10910
11079
|
readonly method: "PATCH";
|
|
10911
11080
|
readonly path: "/v1/stores/{storeId}/sales/{saleId}";
|
|
10912
11081
|
};
|
|
11082
|
+
readonly Store_GetStore: {
|
|
11083
|
+
readonly method: "GET";
|
|
11084
|
+
readonly path: "/v1/stores/{storeId}";
|
|
11085
|
+
};
|
|
10913
11086
|
readonly Subscriptions_GetSubscriptions: {
|
|
10914
11087
|
readonly method: "GET";
|
|
10915
11088
|
readonly path: "/v1/stores/{storeId}/subscriptions";
|