@paynow-gg/typescript-sdk 2.0.2 → 2.0.4

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.
@@ -263,6 +263,11 @@ export interface AlipayDetailsDto {
263
263
  */
264
264
  fingerprint?: string | null;
265
265
  }
266
+ export interface AvailablePermissionDto {
267
+ id: string;
268
+ name: string;
269
+ description: string;
270
+ }
266
271
  /**
267
272
  * Bancontact payment method details
268
273
  */
@@ -355,6 +360,34 @@ export type BansGetBansQuery = {
355
360
  asc?: boolean;
356
361
  };
357
362
  export type BanType = "unknown" | "steam" | "ip" | "customer" | "customer_name" | "email";
363
+ /**
364
+ * Query parameters
365
+ */
366
+ export type BillingGetStoreInvoicesQuery = {
367
+ /**
368
+ * The maximum number of items to return in a single request.
369
+ * @format int32
370
+ * @minimum 1
371
+ * @maximum 100
372
+ */
373
+ limit?: number;
374
+ /**
375
+ * Returns items after the specified ID.
376
+ * Used for forward pagination through results.
377
+ */
378
+ after?: FlakeId;
379
+ /**
380
+ * Returns items before the specified ID.
381
+ * Used for backward pagination through results.
382
+ */
383
+ before?: FlakeId;
384
+ /**
385
+ * Determines the sort order of returned items.
386
+ * When true, items are returned in ascending order.
387
+ * When false, items are returned in descending order.
388
+ */
389
+ asc?: boolean;
390
+ };
358
391
  export interface CancelSubscriptionRequestDto {
359
392
  /**
360
393
  * Should the subscription be cancelled immediately (false) or on the next billing period (true)?
@@ -453,6 +486,16 @@ export interface CashAppDetailsDto {
453
486
  */
454
487
  cashtag: string;
455
488
  }
489
+ /**
490
+ * Represents a request to move a store onto a different plan.
491
+ */
492
+ export interface ChangeSubscriptionPlanDto {
493
+ /**
494
+ * The identifier of the plan to move the store onto.
495
+ */
496
+ plan_id: string;
497
+ renewal_period: SubscriptionRenewalPeriodDto;
498
+ }
456
499
  /**
457
500
  * Defines the type of chargeback coverage provided.
458
501
  * - `unspecified`: Chargeback coverage type is not specified.
@@ -507,6 +550,35 @@ export interface CheckoutPaymentInfoDto {
507
550
  */
508
551
  checkout_url?: string | null;
509
552
  }
553
+ /**
554
+ * Represents the outcome of a subscription change that may require the store owner to pay.
555
+ */
556
+ export interface CheckoutSessionDto {
557
+ /**
558
+ * The URL the store owner is sent to in order to complete payment. Null when
559
+ * 'requires_payment' is false.
560
+ */
561
+ session_url?: string | null;
562
+ /**
563
+ * Whether the change needs a payment before it takes effect.
564
+ */
565
+ requires_payment: boolean;
566
+ }
567
+ export interface CheckoutStyleDto {
568
+ store_id: FlakeId;
569
+ font_family?: string | null;
570
+ /**
571
+ * @format int32
572
+ */
573
+ border_radius?: number | null;
574
+ color_primary?: string | null;
575
+ color_elements?: string | null;
576
+ color_input?: string | null;
577
+ color_background?: string | null;
578
+ color_text?: string | null;
579
+ color_outline?: string | null;
580
+ url_background?: string | null;
581
+ }
510
582
  export interface CommandAttemptDto {
511
583
  id: FlakeId;
512
584
  store_id: FlakeId;
@@ -878,6 +950,19 @@ export interface CreateCheckoutSessionResponseDto {
878
950
  */
879
951
  url: string;
880
952
  }
953
+ export interface CreateCheckoutStyleDto {
954
+ font_family?: string;
955
+ /**
956
+ * @format int32
957
+ */
958
+ border_radius?: number | null;
959
+ color_primary?: string;
960
+ color_elements?: string;
961
+ color_input?: string;
962
+ color_background?: string;
963
+ color_text?: string;
964
+ color_outline?: string;
965
+ }
881
966
  export interface CreateCouponDto {
882
967
  enabled: boolean;
883
968
  code: string;
@@ -931,11 +1016,7 @@ export interface CreateCouponDto {
931
1016
  */
932
1017
  export interface CreateCustomerPortalSessionRequestDto {
933
1018
  flow: CustomerPortalSessionFlowDto;
934
- /**
935
- * How long the portal session stays valid, in seconds. When unset, a default expiry is used.
936
- * @format int64
937
- */
938
- expires_in_seconds?: number | null;
1019
+ expires_in?: Period;
939
1020
  /**
940
1021
  * URL to redirect the customer back to after completing the portal flow
941
1022
  */
@@ -986,6 +1067,10 @@ export interface CreateGiftCardDto {
986
1067
  */
987
1068
  expires_at?: string | null;
988
1069
  }
1070
+ export interface CreateInviteDto {
1071
+ role_id: FlakeId;
1072
+ user_email: string;
1073
+ }
989
1074
  export interface CreateNavLinkDto {
990
1075
  tag_id: FlakeId;
991
1076
  parent_node_id?: string;
@@ -1007,6 +1092,11 @@ export interface CreateRefundRequestDto {
1007
1092
  */
1008
1093
  refund_from_connected_user_balance?: boolean | null;
1009
1094
  }
1095
+ export interface CreateRoleDto {
1096
+ name: string;
1097
+ description: string;
1098
+ permissions?: Record<string, boolean>;
1099
+ }
1010
1100
  export interface CreateSaleDto {
1011
1101
  enabled: boolean;
1012
1102
  name: string;
@@ -1092,6 +1182,34 @@ export interface CreateWebhookDto {
1092
1182
  discord_color?: string | null;
1093
1183
  discord_format?: WebhookDiscordFormatDto;
1094
1184
  }
1185
+ export interface CreateWebstoreModuleDto {
1186
+ enabled: boolean;
1187
+ type: string;
1188
+ settings?: null;
1189
+ /**
1190
+ * @format date-time
1191
+ */
1192
+ starts_at?: string | null;
1193
+ /**
1194
+ * @format date-time
1195
+ */
1196
+ ends_at?: string | null;
1197
+ }
1198
+ export interface CreateWebstoreTemplateDto {
1199
+ name: string;
1200
+ compatibility_mode: WebstoreTemplateCompatibilityModeDto;
1201
+ }
1202
+ export interface CreateWebstoreTemplateFileDto {
1203
+ file_name: string;
1204
+ content_type: string;
1205
+ content?: string;
1206
+ }
1207
+ export interface CreateWebstoreTemplateVariableDto {
1208
+ name: string;
1209
+ variable: string;
1210
+ type: WebstoreTemplateVariableTypeDto;
1211
+ value: string;
1212
+ }
1095
1213
  /**
1096
1214
  * Cryptocurrency payment method details
1097
1215
  */
@@ -2182,16 +2300,39 @@ export interface ExecutedWebhookDto {
2182
2300
  status_code: number;
2183
2301
  response?: string | null;
2184
2302
  }
2303
+ export interface FinishCheckoutStyleBackgroundImageUploadRequestDto {
2304
+ image_id: string;
2305
+ }
2185
2306
  export interface FinishEmailBrandingImageUploadRequestDto {
2186
2307
  image_id: string;
2187
2308
  dark_mode: boolean;
2188
2309
  }
2310
+ export interface FinishProductImageUploadRequestDto {
2311
+ /**
2312
+ * The ID of the uploaded image returned by the server.
2313
+ */
2314
+ image_id: string;
2315
+ }
2316
+ export interface FinishStoreLogoUploadRequestDto {
2317
+ /**
2318
+ * The ID of the uploaded image returned by the server.
2319
+ */
2320
+ image_id: string;
2321
+ /**
2322
+ * Which logo the upload replaces. 1 is the default logo, 2 the square logo.
2323
+ * @format int32
2324
+ */
2325
+ logo_type: number;
2326
+ }
2189
2327
  export interface FinishTagImageUploadUrlRequestDto {
2190
2328
  /**
2191
2329
  * The ID of the uploaded image returned by the server.
2192
2330
  */
2193
2331
  image_id: string;
2194
2332
  }
2333
+ export interface FinishWebstoreTemplateUploadResponseDto {
2334
+ failed_files: Array<string>;
2335
+ }
2195
2336
  /**
2196
2337
  * @format flake-id
2197
2338
  * @example "411486491630370816"
@@ -2294,6 +2435,10 @@ export interface GameserverResult {
2294
2435
  store_id?: FlakeId;
2295
2436
  gameserver?: GameServerDto;
2296
2437
  }
2438
+ export interface GetCheckoutStyleBackgroundImageUploadUrlResponseDto {
2439
+ id: string;
2440
+ upload_url: string;
2441
+ }
2297
2442
  export interface GetDimensionStatsResponseDto_V2 {
2298
2443
  dimension_type: StatsDimensionTypeDto_V2;
2299
2444
  revenue_basis: RevenueBasisDto_V2;
@@ -2307,6 +2452,26 @@ export interface GetEmailBrandingImageUploadUrlResponseDto {
2307
2452
  upload_url: string;
2308
2453
  image_id: string;
2309
2454
  }
2455
+ export interface GetProductImageUploadUrlResponseDto {
2456
+ /**
2457
+ * The ID of the direct image upload URL.
2458
+ */
2459
+ id: string;
2460
+ /**
2461
+ * The URL to upload the image to.
2462
+ */
2463
+ upload_url: string;
2464
+ }
2465
+ export interface GetStoreLogoUploadUrlResponseDto {
2466
+ /**
2467
+ * The ID of the direct image upload URL.
2468
+ */
2469
+ id: string;
2470
+ /**
2471
+ * The URL to upload the logo to.
2472
+ */
2473
+ upload_url: string;
2474
+ }
2310
2475
  export interface GetTagImageUploadUrlResponseDto {
2311
2476
  /**
2312
2477
  * The ID of the direct image upload URL.
@@ -2317,6 +2482,12 @@ export interface GetTagImageUploadUrlResponseDto {
2317
2482
  */
2318
2483
  upload_url: string;
2319
2484
  }
2485
+ export interface GetWebstoreTemplateArchiveResponseDto {
2486
+ download_url: string;
2487
+ }
2488
+ export interface GetWebstoreTemplateUploadUrlResponseDto {
2489
+ upload_url: string;
2490
+ }
2320
2491
  /**
2321
2492
  * Represents a gift card in the PayNow system.
2322
2493
  */
@@ -2661,6 +2832,37 @@ export interface IntervalTagStatsDto {
2661
2832
  */
2662
2833
  total_earnings: number;
2663
2834
  }
2835
+ export interface InviteDto {
2836
+ id: FlakeId;
2837
+ store_id: FlakeId;
2838
+ /**
2839
+ * The token the invited user redeems to accept the invite.
2840
+ */
2841
+ token: string;
2842
+ role_id: FlakeId;
2843
+ /**
2844
+ * The email address the invite was sent to.
2845
+ */
2846
+ user_email: string;
2847
+ created_by: ActorDto;
2848
+ /**
2849
+ * When the invite was created.
2850
+ * @format date-time
2851
+ */
2852
+ created_at: string;
2853
+ updated_by?: ActorDto;
2854
+ /**
2855
+ * When the invite was last updated.
2856
+ * @format date-time
2857
+ */
2858
+ updated_at?: string | null;
2859
+ /**
2860
+ * When the invite was accepted. Unset while the invite is still pending.
2861
+ * @format date-time
2862
+ */
2863
+ accepted_at?: string | null;
2864
+ accepted_by_user?: ActorDto;
2865
+ }
2664
2866
  export interface InvoiceDownloadUrlResponseDto {
2665
2867
  /**
2666
2868
  * Temporary URL the invoice document can be downloaded from
@@ -2769,6 +2971,15 @@ export type InvoicesListInvoicesQuery = {
2769
2971
  };
2770
2972
  export type InvoiceStatusDto = "invalid" | "pending" | "generated" | "failed";
2771
2973
  export type InvoiceTypeDto = "invalid" | "invoice" | "credit_note";
2974
+ /**
2975
+ * Represents a freshly issued link to a hosted invoice.
2976
+ */
2977
+ export interface InvoiceUrlDto {
2978
+ /**
2979
+ * The hosted invoice URL.
2980
+ */
2981
+ url: string;
2982
+ }
2772
2983
  /**
2773
2984
  * Klarna payment method details
2774
2985
  */
@@ -4208,6 +4419,76 @@ export interface PixDetailsDto {
4208
4419
  */
4209
4420
  payer_name?: string | null;
4210
4421
  }
4422
+ export interface PlanDto {
4423
+ id: string;
4424
+ name: string;
4425
+ description?: string | null;
4426
+ is_custom: boolean;
4427
+ }
4428
+ /**
4429
+ * Represents a publicly listed plan a store can subscribe to.
4430
+ */
4431
+ export interface PlanPreviewDto {
4432
+ /**
4433
+ * The unique identifier of the plan.
4434
+ */
4435
+ id: string;
4436
+ /**
4437
+ * The display name of the plan.
4438
+ */
4439
+ name: string;
4440
+ /**
4441
+ * The description of the plan.
4442
+ */
4443
+ description?: string | null;
4444
+ /**
4445
+ * Whether the plan is negotiated for a specific store rather than publicly offered.
4446
+ */
4447
+ is_custom: boolean;
4448
+ /**
4449
+ * The identifier of the plan this one inherits its limits and feature flags from, if any.
4450
+ */
4451
+ inherits_from_plan_id?: string | null;
4452
+ /**
4453
+ * The platform fee charged on the store's revenue, in basis points.
4454
+ * @format int64
4455
+ */
4456
+ platform_fee_rate: number;
4457
+ /**
4458
+ * The monthly subscription price, in the smallest currency unit.
4459
+ * @format int64
4460
+ */
4461
+ subscription_price_monthly: number;
4462
+ /**
4463
+ * The annual subscription price, in the smallest currency unit, when the plan is billed annually.
4464
+ * @format int64
4465
+ */
4466
+ subscription_price_annually?: number | null;
4467
+ }
4468
+ export interface PlanPricingDto {
4469
+ id: FlakeId;
4470
+ plan_id: string;
4471
+ /**
4472
+ * @format int64
4473
+ */
4474
+ platform_fee_rate: number;
4475
+ /**
4476
+ * @format int64
4477
+ */
4478
+ subscription_price_monthly: number;
4479
+ /**
4480
+ * @format int64
4481
+ */
4482
+ subscription_price_annually?: number | null;
4483
+ /**
4484
+ * @format date-time
4485
+ */
4486
+ begins_at: string;
4487
+ /**
4488
+ * @format date-time
4489
+ */
4490
+ ends_at?: string | null;
4491
+ }
4211
4492
  export type PlatformCapability = "invalid" | "connected_users";
4212
4493
  export interface PlatformStoreTypeAssociationDetailsDto {
4213
4494
  platform_id: FlakeId;
@@ -5164,6 +5445,23 @@ export interface ResendWebhookDto {
5164
5445
  webhook_id: FlakeId;
5165
5446
  }
5166
5447
  export type RevenueBasisDto_V2 = "unspecified" | "gross" | "gross_excluding_taxes" | "net";
5448
+ export interface RoleDto {
5449
+ id: FlakeId;
5450
+ store_id: FlakeId;
5451
+ name: string;
5452
+ description: string;
5453
+ permissions?: Record<string, boolean> | null;
5454
+ created_by: ActorDto;
5455
+ /**
5456
+ * @format date-time
5457
+ */
5458
+ created_at: string;
5459
+ updated_by?: ActorDto;
5460
+ /**
5461
+ * @format date-time
5462
+ */
5463
+ updated_at?: string | null;
5464
+ }
5167
5465
  export type SaleDiscountTypeDto = "percent" | "amount";
5168
5466
  /**
5169
5467
  * Represents a detailed view of a Sale, including configuration and audit information.
@@ -5370,6 +5668,16 @@ export interface SetDiscordActionDto {
5370
5668
  role_id?: FlakeId;
5371
5669
  message?: string | null;
5372
5670
  }
5671
+ export interface SetWebstoreCustomDomainRequestDto {
5672
+ domain: string;
5673
+ verification_type: WebstoreCustomDomainVerificationTypeDto;
5674
+ }
5675
+ export interface SetWebstoreDefaultTemplateRequestDto {
5676
+ template_id: FlakeId;
5677
+ }
5678
+ export interface SetWebstoreSlugRequestDto {
5679
+ slug: string;
5680
+ }
5373
5681
  export interface StartDataMigrationFromTebexRequestDto {
5374
5682
  /**
5375
5683
  * The public-facing Headless API token.
@@ -5425,6 +5733,101 @@ export interface SteamSkinsInventoryItemDetailsDto {
5425
5733
  */
5426
5734
  price: number;
5427
5735
  }
5736
+ export interface StoreAlertDto {
5737
+ id: FlakeId;
5738
+ store_id: FlakeId;
5739
+ entity_id?: FlakeId;
5740
+ status: StoreAlertStatus;
5741
+ type: StoreAlertType;
5742
+ custom_title?: string | null;
5743
+ custom_message?: string | null;
5744
+ /**
5745
+ * @format date-time
5746
+ */
5747
+ action_required_at?: string | null;
5748
+ action_link?: string | null;
5749
+ store_visible: boolean;
5750
+ admin_visible: boolean;
5751
+ resolved_by?: FlakeId;
5752
+ /**
5753
+ * @format date-time
5754
+ */
5755
+ created_at: string;
5756
+ /**
5757
+ * @format date-time
5758
+ */
5759
+ updated_at?: string | null;
5760
+ /**
5761
+ * @format date-time
5762
+ */
5763
+ expires_at?: string | null;
5764
+ /**
5765
+ * @format date-time
5766
+ */
5767
+ resolved_at?: string | null;
5768
+ metadata: Record<string, string>;
5769
+ }
5770
+ export type StoreAlertStatus = "info" | "warning" | "action_required" | "resolved";
5771
+ export type StoreAlertType = "other" | "excessive_chargeback_rate" | "kyc_required" | "business_details_required" | "increased_fraud_rate" | "unsupported_product" | "product_compliance_check" | "integration_issue" | "storefront_compliance" | "support_inquiry" | "feature_eligibility" | "feature_enrolled";
5772
+ /**
5773
+ * Represents the billing address and tax details a store is invoiced under.
5774
+ */
5775
+ export interface StoreBillingDetailsDto {
5776
+ /**
5777
+ * The country of the billing address.
5778
+ */
5779
+ country?: string | null;
5780
+ /**
5781
+ * The state or province of the billing address.
5782
+ */
5783
+ state?: string | null;
5784
+ /**
5785
+ * The city of the billing address.
5786
+ */
5787
+ city?: string | null;
5788
+ /**
5789
+ * The postal code or zip code of the billing address.
5790
+ */
5791
+ postal_code?: string | null;
5792
+ /**
5793
+ * The first line of the billing street address.
5794
+ */
5795
+ line_1?: string | null;
5796
+ /**
5797
+ * The second line of the billing street address, if any (apartment, suite, etc.).
5798
+ */
5799
+ line_2?: string | null;
5800
+ /**
5801
+ * The tax identifier the store is invoiced under, if any.
5802
+ */
5803
+ tax_id?: string | null;
5804
+ }
5805
+ export interface StoreBillingStatusDto {
5806
+ store_id: FlakeId;
5807
+ is_locked: boolean;
5808
+ lock_reason?: string | null;
5809
+ no_billing_details: boolean;
5810
+ /**
5811
+ * @format int64
5812
+ */
5813
+ revenue_usage: number;
5814
+ plan_limits: Record<string, number>;
5815
+ feature_flags: Array<string>;
5816
+ plan: PlanDto;
5817
+ plan_pricing: PlanPricingDto;
5818
+ subscription?: StoreSubscriptionDto;
5819
+ alerts: Array<StoreAlertDto>;
5820
+ payment_method?: SubscriptionPaymentMethodDto;
5821
+ }
5822
+ /**
5823
+ * Query parameters
5824
+ */
5825
+ export type StoreDeleteStoreLogoQuery = {
5826
+ /**
5827
+ * @format int32
5828
+ */
5829
+ type?: number;
5830
+ };
5428
5831
  /**
5429
5832
  * Represents a PayNow store and its associated configuration.
5430
5833
  */
@@ -5590,6 +5993,54 @@ export interface StorefrontStoreDto {
5590
5993
  */
5591
5994
  updated_at?: string | null;
5592
5995
  }
5996
+ /**
5997
+ * Represents an invoice raised against a store's own subscription.
5998
+ */
5999
+ export interface StoreInvoiceDto {
6000
+ id: FlakeId;
6001
+ subscription_id: FlakeId;
6002
+ plan_pricing_id: FlakeId;
6003
+ /**
6004
+ * The payment gateway that issued the invoice.
6005
+ */
6006
+ gateway: string;
6007
+ /**
6008
+ * The identifier of the invoice within the payment gateway.
6009
+ */
6010
+ gateway_invoice_id: string;
6011
+ /**
6012
+ * The hosted invoice URL recorded when the invoice was raised. May expire; request
6013
+ * 'invoices/{invoice_id}/url' for a freshly issued link.
6014
+ */
6015
+ invoice_url: string;
6016
+ /**
6017
+ * The description of what was billed.
6018
+ */
6019
+ description: string;
6020
+ /**
6021
+ * The currency the invoice was issued in.
6022
+ */
6023
+ currency: string;
6024
+ /**
6025
+ * The invoiced total, in the smallest currency unit.
6026
+ * @format int64
6027
+ */
6028
+ total: number;
6029
+ /**
6030
+ * Whether the invoice has been paid.
6031
+ */
6032
+ is_paid: boolean;
6033
+ /**
6034
+ * When the invoice was raised.
6035
+ * @format date-time
6036
+ */
6037
+ created_at: string;
6038
+ /**
6039
+ * When the invoice was last updated.
6040
+ * @format date-time
6041
+ */
6042
+ updated_at?: string | null;
6043
+ }
5593
6044
  /**
5594
6045
  * Represents a member of a PayNow store.
5595
6046
  */
@@ -5741,6 +6192,44 @@ export interface StoreResult {
5741
6192
  store_id?: FlakeId;
5742
6193
  store: StoreDto;
5743
6194
  }
6195
+ export interface StoreSubscriptionDto {
6196
+ id: FlakeId;
6197
+ store_id: FlakeId;
6198
+ plan_id: string;
6199
+ gateway: string;
6200
+ gateway_subscription_id: string;
6201
+ gateway_checkout_id: string;
6202
+ gateway_payment_method_id: string;
6203
+ currency: string;
6204
+ status: StoreSubscriptionStatus;
6205
+ downgrade_period_end_plan_id?: string | null;
6206
+ cancel_at_period_end: boolean;
6207
+ /**
6208
+ * @format date-time
6209
+ */
6210
+ created_at: string;
6211
+ /**
6212
+ * @format date-time
6213
+ */
6214
+ updated_at?: string | null;
6215
+ /**
6216
+ * @format date-time
6217
+ */
6218
+ ended_at?: string | null;
6219
+ /**
6220
+ * @format date-time
6221
+ */
6222
+ cancel_at?: string | null;
6223
+ /**
6224
+ * @format date-time
6225
+ */
6226
+ current_period_start: string;
6227
+ /**
6228
+ * @format date-time
6229
+ */
6230
+ current_period_end: string;
6231
+ }
6232
+ export type StoreSubscriptionStatus = "incomplete" | "trialing" | "active" | "requires_action" | "canceled";
5744
6233
  export interface StoreTrustDto {
5745
6234
  store_id: FlakeId;
5746
6235
  status: StoreTrustStatusDto;
@@ -6631,12 +7120,49 @@ export interface SubscriptionLineDto {
6631
7120
  */
6632
7121
  initial_presentment_total_amount_str?: string | null;
6633
7122
  }
7123
+ /**
7124
+ * Represents the payment method a store's subscription is billed to.
7125
+ */
7126
+ export interface SubscriptionPaymentMethodDto {
7127
+ /**
7128
+ * The identifier of the payment method within the payment gateway.
7129
+ */
7130
+ id: string;
7131
+ /**
7132
+ * The kind of payment method, such as a card.
7133
+ */
7134
+ type: string;
7135
+ /**
7136
+ * The card network, when the payment method is a card.
7137
+ */
7138
+ card_brand?: string | null;
7139
+ /**
7140
+ * The month the card expires, when the payment method is a card.
7141
+ * @format int64
7142
+ */
7143
+ card_exp_month?: number | null;
7144
+ /**
7145
+ * The year the card expires, when the payment method is a card.
7146
+ * @format int64
7147
+ */
7148
+ card_exp_year?: number | null;
7149
+ /**
7150
+ * The last four digits of the card, when the payment method is a card.
7151
+ */
7152
+ card_last4?: string | null;
7153
+ }
6634
7154
  /**
6635
7155
  * Portal flow for updating the payment method of a specific subscription
6636
7156
  */
6637
7157
  export interface SubscriptionPaymentMethodUpdateFlowDto {
6638
7158
  subscription_id: FlakeId;
6639
7159
  }
7160
+ /**
7161
+ * Specifies how often a subscription renews.
7162
+ * - `monthly`: The subscription renews every month.
7163
+ * - `annually`: The subscription renews every year.
7164
+ */
7165
+ export type SubscriptionRenewalPeriodDto = "monthly" | "annually";
6640
7166
  export interface SubscriptionResult {
6641
7167
  id: FlakeId;
6642
7168
  store_id?: FlakeId;
@@ -7198,6 +7724,19 @@ export interface UpdateAffiliateLinkDto {
7198
7724
  commission_amount_steps?: Array<AffiliateLinkCommissionAmountStepDto>;
7199
7725
  last_commission_amount_step_repeats?: boolean;
7200
7726
  }
7727
+ export interface UpdateCheckoutStyleDto {
7728
+ font_family?: string;
7729
+ /**
7730
+ * @format int32
7731
+ */
7732
+ border_radius?: number | null;
7733
+ color_primary?: string;
7734
+ color_elements?: string;
7735
+ color_input?: string;
7736
+ color_background?: string;
7737
+ color_text?: string;
7738
+ color_outline?: string;
7739
+ }
7201
7740
  export interface UpdateCouponDto {
7202
7741
  enabled?: boolean;
7203
7742
  code?: string;
@@ -7286,6 +7825,10 @@ export interface UpdateGiftCardDto {
7286
7825
  */
7287
7826
  expires_at?: string | null;
7288
7827
  }
7828
+ export interface UpdateInviteDto {
7829
+ role_id?: FlakeId;
7830
+ user_email?: string;
7831
+ }
7289
7832
  export interface UpdateNavLinkDto {
7290
7833
  tag_id?: FlakeId;
7291
7834
  parent_node_id?: string;
@@ -7307,6 +7850,11 @@ export interface UpdateProductSortOrderRequestDto {
7307
7850
  */
7308
7851
  product_ids: Array<FlakeId>;
7309
7852
  }
7853
+ export interface UpdateRoleDto {
7854
+ name?: string;
7855
+ description?: string;
7856
+ permissions?: Record<string, boolean>;
7857
+ }
7310
7858
  export interface UpdateSaleDto {
7311
7859
  enabled?: boolean;
7312
7860
  name?: string;
@@ -7418,6 +7966,37 @@ export interface UpdateWebhookDto {
7418
7966
  discord_color?: string | null;
7419
7967
  discord_format?: WebhookDiscordFormatDto;
7420
7968
  }
7969
+ export interface UpdateWebstoreModuleDto {
7970
+ enabled?: boolean;
7971
+ type?: string;
7972
+ settings?: null;
7973
+ /**
7974
+ * @format date-time
7975
+ */
7976
+ starts_at?: string | null;
7977
+ /**
7978
+ * @format date-time
7979
+ */
7980
+ ends_at?: string | null;
7981
+ }
7982
+ export interface UpdateWebstoreTemplateDto {
7983
+ name?: string;
7984
+ compatibility_mode?: WebstoreTemplateCompatibilityModeDto;
7985
+ }
7986
+ export interface UpdateWebstoreTemplateFileDto {
7987
+ file_name?: string;
7988
+ content_type?: string;
7989
+ content?: string;
7990
+ }
7991
+ export interface UpdateWebstoreTemplateFileRequestDto {
7992
+ content: string;
7993
+ }
7994
+ export interface UpdateWebstoreTemplateVariableDto {
7995
+ name?: string;
7996
+ variable?: string;
7997
+ type?: WebstoreTemplateVariableTypeDto;
7998
+ value?: string;
7999
+ }
7421
8000
  export type UpsellDiscountTypeDto = "unknown" | "none" | "fixed" | "percentage";
7422
8001
  /**
7423
8002
  * - `unknown`: Unknown upsell type.
@@ -7768,4 +8347,211 @@ export interface WebhookVariablesDto {
7768
8347
  event_type: WebhookEventType;
7769
8348
  variables: Array<string>;
7770
8349
  }
8350
+ export interface WebstoreCustomDomainDto {
8351
+ id: string;
8352
+ hostname: string;
8353
+ status: string;
8354
+ ssl?: WebstoreCustomDomainSslDto;
8355
+ ownership_verification?: WebstoreCustomDomainOwnershipVerificationDto;
8356
+ ownership_verification_http?: WebstoreCustomDomainOwnershipVerificationHttpDto;
8357
+ verification_errors: Array<string>;
8358
+ /**
8359
+ * @format date-time
8360
+ */
8361
+ created_at?: string | null;
8362
+ }
8363
+ export interface WebstoreCustomDomainOwnershipVerificationDto {
8364
+ type: string;
8365
+ name: string;
8366
+ value: string;
8367
+ }
8368
+ export interface WebstoreCustomDomainOwnershipVerificationHttpDto {
8369
+ http_url: string;
8370
+ http_body: string;
8371
+ }
8372
+ export interface WebstoreCustomDomainSslDto {
8373
+ id: string;
8374
+ method: string;
8375
+ status: string;
8376
+ certificate_authority?: string | null;
8377
+ validation_records: Array<WebstoreCustomDomainSslValidationRecordDto>;
8378
+ validation_errors: Array<string>;
8379
+ }
8380
+ export interface WebstoreCustomDomainSslValidationRecordDto {
8381
+ txt_name?: string | null;
8382
+ txt_value?: string | null;
8383
+ http_url?: string | null;
8384
+ http_body?: string | null;
8385
+ emails: Array<string>;
8386
+ }
8387
+ export type WebstoreCustomDomainVerificationTypeDto = "invalid" | "http" | "txt" | "email" | "cname";
8388
+ export interface WebstoreDto {
8389
+ id: FlakeId;
8390
+ slug: string;
8391
+ is_active: boolean;
8392
+ custom_domain?: string | null;
8393
+ custom_domain_verified: boolean;
8394
+ current_template_id?: FlakeId;
8395
+ }
8396
+ /**
8397
+ * Query parameters
8398
+ */
8399
+ export type WebstoreGetWebstoreTemplateQuery = {
8400
+ include?: string;
8401
+ };
8402
+ /**
8403
+ * Query parameters
8404
+ */
8405
+ export type WebstoreGetWebstoreTemplateUploadUrlQuery = {
8406
+ /**
8407
+ * @format int64
8408
+ */
8409
+ content_length?: number;
8410
+ };
8411
+ export interface WebstoreModuleDto {
8412
+ id: FlakeId;
8413
+ webstore_id: FlakeId;
8414
+ enabled: boolean;
8415
+ type: string;
8416
+ /**
8417
+ * @format int32
8418
+ */
8419
+ sort_order: number;
8420
+ settings?: null;
8421
+ /**
8422
+ * @format date-time
8423
+ */
8424
+ starts_at?: string | null;
8425
+ /**
8426
+ * @format date-time
8427
+ */
8428
+ ends_at?: string | null;
8429
+ /**
8430
+ * @format date-time
8431
+ */
8432
+ created_at: string;
8433
+ /**
8434
+ * @format date-time
8435
+ */
8436
+ updated_at: string;
8437
+ }
8438
+ export type WebstoreTemplateCompatibilityModeDto = "invalid" | "paynow" | "tebex";
8439
+ export interface WebstoreTemplateCompiledFileDto {
8440
+ file_name: string;
8441
+ content_type: string;
8442
+ compiled?: string | null;
8443
+ error?: string | null;
8444
+ }
8445
+ export interface WebstoreTemplateDto {
8446
+ id: FlakeId;
8447
+ webstore_id: FlakeId;
8448
+ name: string;
8449
+ is_public: boolean;
8450
+ compatibility_mode: WebstoreTemplateCompatibilityModeDto;
8451
+ /**
8452
+ * @format date-time
8453
+ */
8454
+ created_at: string;
8455
+ /**
8456
+ * @format date-time
8457
+ */
8458
+ updated_at: string;
8459
+ template_files?: Array<WebstoreTemplateFileDto> | null;
8460
+ }
8461
+ export interface WebstoreTemplateFileDto {
8462
+ id: FlakeId;
8463
+ template_id: FlakeId;
8464
+ file_name: string;
8465
+ content_type: string;
8466
+ is_public: boolean;
8467
+ is_deletable: boolean;
8468
+ content?: string | null;
8469
+ /**
8470
+ * @format date-time
8471
+ */
8472
+ created_at: string;
8473
+ /**
8474
+ * @format date-time
8475
+ */
8476
+ updated_at: string;
8477
+ }
8478
+ export interface WebstoreTemplateLatestVersionDto {
8479
+ version?: string | null;
8480
+ }
8481
+ export interface WebstoreTemplatePreviewDto {
8482
+ compiled: Array<WebstoreTemplateCompiledFileDto>;
8483
+ schema?: WebstoreTemplateSchemaDto;
8484
+ compatibilityMode: WebstoreTemplateCompatibilityModeDto;
8485
+ /**
8486
+ * @format date-time
8487
+ */
8488
+ compiled_at: string;
8489
+ }
8490
+ export interface WebstoreTemplatePreviewResponseDto {
8491
+ template: WebstoreTemplatePreviewDto;
8492
+ variables: WebstoreTemplatePreviewVariablesDto;
8493
+ }
8494
+ export interface WebstoreTemplatePreviewVariablesDto {
8495
+ variables: Array<WebstoreTemplateVariableDto>;
8496
+ /**
8497
+ * @format date-time
8498
+ */
8499
+ saved_at: string;
8500
+ }
8501
+ export interface WebstoreTemplateSchemaDto {
8502
+ author: string;
8503
+ support_email?: string | null;
8504
+ support_url?: string | null;
8505
+ updates?: WebstoreTemplateSchemaUpdatesDto;
8506
+ config: Array<WebstoreTemplateSchemaSectionDto>;
8507
+ }
8508
+ export interface WebstoreTemplateSchemaOptionDto {
8509
+ id: string;
8510
+ name: string;
8511
+ description?: string | null;
8512
+ type: string;
8513
+ default?: null;
8514
+ values: Array<string>;
8515
+ numeric?: boolean | null;
8516
+ multiline?: boolean | null;
8517
+ /**
8518
+ * @format double
8519
+ */
8520
+ min?: number | null;
8521
+ /**
8522
+ * @format double
8523
+ */
8524
+ max?: number | null;
8525
+ nested_options: Array<WebstoreTemplateSchemaOptionDto>;
8526
+ }
8527
+ export interface WebstoreTemplateSchemaSectionDto {
8528
+ header: string;
8529
+ options: Array<WebstoreTemplateSchemaOptionDto>;
8530
+ }
8531
+ export interface WebstoreTemplateSchemaUpdatesDto {
8532
+ supported: boolean;
8533
+ version_check_supported: boolean;
8534
+ version?: string | null;
8535
+ github_url?: string | null;
8536
+ github_branch: string;
8537
+ github_token?: string | null;
8538
+ }
8539
+ export interface WebstoreTemplateVariableDto {
8540
+ id: FlakeId;
8541
+ template_id: FlakeId;
8542
+ webstore_id: FlakeId;
8543
+ name: string;
8544
+ variable: string;
8545
+ type: WebstoreTemplateVariableTypeDto;
8546
+ value: string;
8547
+ /**
8548
+ * @format date-time
8549
+ */
8550
+ created_at: string;
8551
+ /**
8552
+ * @format date-time
8553
+ */
8554
+ updated_at: string;
8555
+ }
8556
+ export type WebstoreTemplateVariableTypeDto = "invalid" | "string" | "html" | "number" | "boolean" | "json";
7771
8557
  //# sourceMappingURL=types.d.ts.map