rebilly-js-sdk 48.1.1 → 48.3.0

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.
@@ -909,6 +909,25 @@ declare module rebilly {
909
909
  type DeleteCashierStrategyResponse = operations['DeleteCashierStrategy']['responses']['204']
910
910
  type DeleteCashierStrategyResponsePromise = Promise<{fields: DeleteCashierStrategyResponse}>
911
911
 
912
+ type GetCashierCustomPropertySetCollectionRequest = operations['GetCashierCustomPropertySetCollection']['parameters']["query"] & (operations['GetCashierCustomPropertySetCollection']['parameters'] extends {path: {}} ? operations['GetCashierCustomPropertySetCollection']['parameters']["path"] : {})
913
+
914
+ type GetCashierCustomPropertySetCollectionResponse = operations['GetCashierCustomPropertySetCollection']['responses']['200']['content']['application/json'][0]
915
+ type GetCashierCustomPropertySetCollectionResponsePromise = Promise<{ items: {fields: GetCashierCustomPropertySetCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
916
+ type PostCashierCustomPropertySetRequest = operations['PostCashierCustomPropertySet']['requestBody']['content']['application/json']
917
+ type CreateCashierCustomPropertySetRequest = { id: String, data: PostCashierCustomPropertySetRequest, expand?: String }
918
+ type PostCashierCustomPropertySetResponse = operations['PostCashierCustomPropertySet']['responses']['201']['content']['application/json']
919
+ type PostCashierCustomPropertySetResponsePromise = Promise<{fields: PostCashierCustomPropertySetResponse}>
920
+
921
+ type GetCashierCustomPropertySetRequest = { id : String }
922
+
923
+ type GetCashierCustomPropertySetResponse = operations['GetCashierCustomPropertySet']['responses']['200']['content']['application/json']
924
+ type GetCashierCustomPropertySetResponsePromise = Promise<{fields: GetCashierCustomPropertySetResponse}>
925
+ type PutCashierCustomPropertySetRequest = operations['PutCashierCustomPropertySet']['requestBody']['content']['application/json']
926
+ type PutCashierCustomPropertySetResponse = operations['PutCashierCustomPropertySet']['responses']['201']['content']['application/json']
927
+ type PutCashierCustomPropertySetResponsePromise = Promise<{fields: PutCashierCustomPropertySetResponse}>
928
+ type DeleteCashierCustomPropertySetResponse = operations['DeleteCashierCustomPropertySet']['responses']['204']
929
+ type DeleteCashierCustomPropertySetResponsePromise = Promise<{fields: DeleteCashierCustomPropertySetResponse}>
930
+
912
931
  type GetPayoutRequestCollectionRequest = operations['GetPayoutRequestCollection']['parameters']["query"] & (operations['GetPayoutRequestCollection']['parameters'] extends {path: {}} ? operations['GetPayoutRequestCollection']['parameters']["path"] : {})
913
932
 
914
933
  type GetPayoutRequestCollectionResponse = operations['GetPayoutRequestCollection']['responses']['200']['content']['application/json'][0]
@@ -984,6 +1003,25 @@ declare module rebilly {
984
1003
  type PutRiskScoreBlocklistRulesResponse = operations['PutRiskScoreBlocklistRules']['responses']['201']['content']['application/json']
985
1004
  type PutRiskScoreBlocklistRulesResponsePromise = Promise<{fields: PutRiskScoreBlocklistRulesResponse}>
986
1005
 
1006
+ type GetTagsRulesCollectionRequest = operations['GetTagsRulesCollection']['parameters']["query"] & (operations['GetTagsRulesCollection']['parameters'] extends {path: {}} ? operations['GetTagsRulesCollection']['parameters']["path"] : {})
1007
+
1008
+ type GetTagsRulesCollectionResponse = operations['GetTagsRulesCollection']['responses']['200']['content']['application/json'][0]
1009
+ type GetTagsRulesCollectionResponsePromise = Promise<{ items: {fields: GetTagsRulesCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
1010
+ type PostTagRulesRequest = operations['PostTagRules']['requestBody']['content']['application/json']
1011
+ type CreateTagRulesRequest = { id: String, data: PostTagRulesRequest, expand?: String }
1012
+ type PostTagRulesResponse = operations['PostTagRules']['responses']['201']['content']['application/json']
1013
+ type PostTagRulesResponsePromise = Promise<{fields: PostTagRulesResponse}>
1014
+
1015
+ type GetTagsRuleRequest = { id : String }
1016
+
1017
+ type GetTagsRuleResponse = operations['GetTagsRule']['responses']['200']['content']['application/json']
1018
+ type GetTagsRuleResponsePromise = Promise<{fields: GetTagsRuleResponse}>
1019
+ type PutTagsRuleRequest = operations['PutTagsRule']['requestBody']['content']['application/json']
1020
+ type PutTagsRuleResponse = operations['PutTagsRule']['responses']['201']['content']['application/json']
1021
+ type PutTagsRuleResponsePromise = Promise<{fields: PutTagsRuleResponse}>
1022
+ type DeleteTagsRuleResponse = operations['DeleteTagsRule']['responses']['204']
1023
+ type DeleteTagsRuleResponsePromise = Promise<{fields: DeleteTagsRuleResponse}>
1024
+
987
1025
  type GetApplicationInstanceRequest = { applicationId : String }
988
1026
 
989
1027
  type GetApplicationInstanceResponse = operations['GetApplicationInstance']['responses']['200']['content']['application/json']
@@ -1658,23 +1696,6 @@ declare module rebilly {
1658
1696
  type DeleteProfileMfaResponse = operations['DeleteProfileMfa']['responses']['204']
1659
1697
  type DeleteProfileMfaResponsePromise = Promise<{fields: DeleteProfileMfaResponse}>
1660
1698
 
1661
- type PostProfilePasswordChangeRequest = operations['PostProfilePasswordChange']['requestBody']['content']['application/json']
1662
- type CreateProfilePasswordChangeRequest = { id: String, data: PostProfilePasswordChangeRequest, expand?: String }
1663
- type PostProfilePasswordChangeResponse = operations['PostProfilePasswordChange']['responses']['201']['content']['application/json']
1664
- type PostProfilePasswordChangeResponsePromise = Promise<{fields: PostProfilePasswordChangeResponse}>
1665
-
1666
- type PostProfileTotpResetResponse = operations['PostProfileTotpReset']['responses']['201']['content']['application/json']
1667
- type PostProfileTotpResetResponsePromise = Promise<{fields: PostProfileTotpResetResponse}>
1668
-
1669
- type GetPasswordResetTokenRequest = { token : String }
1670
-
1671
- type GetPasswordResetTokenResponse = operations['GetPasswordResetToken']['responses']['200']['content']['application/json']
1672
- type GetPasswordResetTokenResponsePromise = Promise<{fields: GetPasswordResetTokenResponse}>
1673
- type PostPasswordResetRequest = operations['PostPasswordReset']['requestBody']['content']['application/json']
1674
- type CreatePasswordResetRequest = { id: String, data: PostPasswordResetRequest, expand?: String }
1675
- type PostPasswordResetResponse = operations['PostPasswordReset']['responses']['201']['content']['application/json']
1676
- type PostPasswordResetResponsePromise = Promise<{fields: PostPasswordResetResponse}>
1677
-
1678
1699
  type GetRoleCollectionRequest = operations['GetRoleCollection']['parameters']["query"] & (operations['GetRoleCollection']['parameters'] extends {path: {}} ? operations['GetRoleCollection']['parameters']["path"] : {})
1679
1700
 
1680
1701
  type GetRoleCollectionResponse = operations['GetRoleCollection']['responses']['200']['content']['application/json'][0]
@@ -1763,14 +1784,6 @@ declare module rebilly {
1763
1784
  type GetUserMfaResponse = operations['GetUserMfa']['responses']['200']['content']['application/json']
1764
1785
  type GetUserMfaResponsePromise = Promise<{fields: GetUserMfaResponse}>
1765
1786
 
1766
- type PostUserPasswordChangeRequest = operations['PostUserPasswordChange']['requestBody']['content']['application/json']
1767
- type CreateUserPasswordChangeRequest = { id: String, data: PostUserPasswordChangeRequest, expand?: String }
1768
- type PostUserPasswordChangeResponse = operations['PostUserPasswordChange']['responses']['201']['content']['application/json']
1769
- type PostUserPasswordChangeResponsePromise = Promise<{fields: PostUserPasswordChangeResponse}>
1770
-
1771
- type PostUserTotpResetResponse = operations['PostUserTotpReset']['responses']['201']['content']['application/json']
1772
- type PostUserTotpResetResponsePromise = Promise<{fields: PostUserTotpResetResponse}>
1773
-
1774
1787
  type GetWebhookCollectionRequest = operations['GetWebhookCollection']['parameters']["query"] & (operations['GetWebhookCollection']['parameters'] extends {path: {}} ? operations['GetWebhookCollection']['parameters']["path"] : {})
1775
1788
 
1776
1789
  type GetWebhookCollectionResponse = operations['GetWebhookCollection']['responses']['200']['content']['application/json'][0]
@@ -3719,6 +3732,30 @@ export interface corePaths {
3719
3732
  };
3720
3733
  };
3721
3734
  };
3735
+ "/cashier-custom-property-sets": {
3736
+ /** Retrieves a list of custom cashier property sets. */
3737
+ get: operations["GetCashierCustomPropertySetCollection"];
3738
+ /**
3739
+ * Creates a custom cashier property set.
3740
+ * A custom property set is a JSON-schema to extend the hosted cashier deposit request form with extra form fields.
3741
+ * The collected information is stored at the cashier deposit request.
3742
+ */
3743
+ post: operations["PostCashierCustomPropertySet"];
3744
+ };
3745
+ "/cashier-custom-property-sets/{id}": {
3746
+ /** Retrieves a custom cashier property set with a specified ID. */
3747
+ get: operations["GetCashierCustomPropertySet"];
3748
+ /** Creates or updates (upserts) a custom cashier property set with a specified ID. */
3749
+ put: operations["PutCashierCustomPropertySet"];
3750
+ /** Deletes a custom cashier property set with a specified ID. */
3751
+ delete: operations["DeleteCashierCustomPropertySet"];
3752
+ parameters: {
3753
+ path: {
3754
+ /** ID of the resource. */
3755
+ id: coreComponents["parameters"]["resourceId"];
3756
+ };
3757
+ };
3758
+ };
3722
3759
  "/payout-requests": {
3723
3760
  /** Retrieves a list of payout requests. */
3724
3761
  get: operations["GetPayoutRequestCollection"];
@@ -3830,6 +3867,26 @@ export interface corePaths {
3830
3867
  /** Modifies risk score blocklist rules. */
3831
3868
  put: operations["PutRiskScoreBlocklistRules"];
3832
3869
  };
3870
+ "/tags-rules": {
3871
+ /** Retrieves a list of tags rules. */
3872
+ get: operations["GetTagsRulesCollection"];
3873
+ /** Creates a tags rule. */
3874
+ post: operations["PostTagRules"];
3875
+ };
3876
+ "/tags-rules/{id}": {
3877
+ /** Retrieves a tags rule with a specified ID. */
3878
+ get: operations["GetTagsRule"];
3879
+ /** Creates a tags rule with a specified ID. */
3880
+ put: operations["PutTagsRule"];
3881
+ /** Deletes a tags rule with a specified ID. */
3882
+ delete: operations["DeleteTagsRule"];
3883
+ parameters: {
3884
+ path: {
3885
+ /** ID of the resource. */
3886
+ id: coreComponents["parameters"]["resourceId"];
3887
+ };
3888
+ };
3889
+ };
3833
3890
  }
3834
3891
 
3835
3892
  export interface coreComponents {
@@ -4883,36 +4940,36 @@ export interface coreComponents {
4883
4940
  * Category of the lead source traffic.
4884
4941
  * For example, the medium could be organic search, Google ads, Display ads, and so on.
4885
4942
  */
4886
- medium?: string;
4943
+ medium?: string | null;
4887
4944
  /** Domain, platform, or channel from which the lead source originates. */
4888
- source?: string;
4945
+ source?: string | null;
4889
4946
  /** Campaign name of the lead source. */
4890
- campaign?: string;
4947
+ campaign?: string | null;
4891
4948
  /** Term associated with a lead source. */
4892
- term?: string;
4949
+ term?: string | null;
4893
4950
  /**
4894
4951
  * Content contained in the lead source content.
4895
4952
  * For example, content could be graphics, video, and so on.
4896
4953
  */
4897
- content?: string;
4954
+ content?: string | null;
4898
4955
  /** Individual or entity that is affilated with the lead source. */
4899
- affiliate?: string;
4956
+ affiliate?: string | null;
4900
4957
  /**
4901
4958
  * Individual or entity that is associated with a lead source affiliate.
4902
4959
  * In other products, this field may also be referred to as sub ID or click ID in some.
4903
4960
  */
4904
- subAffiliate?: string;
4961
+ subAffiliate?: string | null;
4905
4962
  /** Name of the sales agent associated with the lead source. */
4906
- salesAgent?: string;
4963
+ salesAgent?: string | null;
4907
4964
  /**
4908
4965
  * ID of the lead source click.
4909
4966
  * This value is passed in the ad click URL for tracking and campaign attribution.
4910
4967
  */
4911
- clickId?: string;
4968
+ clickId?: string | null;
4912
4969
  /** URL from which the lead source originates. */
4913
- path?: string;
4970
+ path?: string | null;
4914
4971
  /** Lead source [`referrer` URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer). */
4915
- referrer?: string;
4972
+ referrer?: string | null;
4916
4973
  createdTime?: coreComponents["schemas"]["CreatedTime"];
4917
4974
  updatedTime?: coreComponents["schemas"]["UpdatedTime"];
4918
4975
  /** Related links. */
@@ -10091,6 +10148,18 @@ export interface coreComponents {
10091
10148
  redirectUrl?: string;
10092
10149
  /** Date and time at which the cashier request expires. The default expiration time is one hour from the time the request is created. */
10093
10150
  expirationTime?: string;
10151
+ /** ID of a custom property set to apply to the request `propertiesSchema`. */
10152
+ customPropertySetId?: string;
10153
+ /**
10154
+ * Defines properties the user can complete when they use the hosted cashier form.
10155
+ * This field accepts [JSON-schema](https://json-schema.org/) drafts 4, 6, and 7.
10156
+ */
10157
+ propertiesSchema?: { [key: string]: any };
10158
+ /**
10159
+ * Properties that are available for the user to complete when they use the hosted cashier form.
10160
+ * Use this object to describe fields that are rendered and completed during the deposit process, in the cashier deposit form.
10161
+ */
10162
+ properties?: { [key: string]: string };
10094
10163
  createdTime?: coreComponents["schemas"]["CreatedTime"];
10095
10164
  updatedTime?: coreComponents["schemas"]["UpdatedTime"];
10096
10165
  /** Related links. */
@@ -10151,6 +10220,18 @@ export interface coreComponents {
10151
10220
  createdTime?: coreComponents["schemas"]["CreatedTime"];
10152
10221
  updatedTime?: coreComponents["schemas"]["UpdatedTime"];
10153
10222
  };
10223
+ CashierCustomPropertySet: {
10224
+ id?: coreComponents["schemas"]["ResourceId"];
10225
+ /** Name of the custom property set. */
10226
+ name: string;
10227
+ /**
10228
+ * Defines properties the user can complete when they use the hosted cashier form.
10229
+ * This field accepts [JSON-schema](https://json-schema.org/) drafts 4, 6, and 7.
10230
+ * Accepted properties types are: `string`, `number`, `integer`, `array`, and `enum`.
10231
+ * For more information, see [Cashier strategies](https://www.rebilly.com/docs/settings/cashier-strategies/).
10232
+ */
10233
+ properties: { [key: string]: any };
10234
+ };
10154
10235
  PayoutRequest: {
10155
10236
  id?: coreComponents["schemas"]["ResourceId"];
10156
10237
  websiteId: coreComponents["schemas"]["WebsiteId"];
@@ -10269,6 +10350,95 @@ export interface coreComponents {
10269
10350
  OrderPreview: coreComponents["schemas"]["CommonOrderPreview"] & {
10270
10351
  shipping?: coreComponents["schemas"]["Shipping"];
10271
10352
  };
10353
+ /** Type of event. */
10354
+ GlobalEventType:
10355
+ | "aml-list-possibly-matched"
10356
+ | "application-instance-disabled"
10357
+ | "application-instance-enabled"
10358
+ | "balance-transaction-settled"
10359
+ | "credit-memo-applied"
10360
+ | "credit-memo-created"
10361
+ | "credit-memo-modified"
10362
+ | "credit-memo-partially-applied"
10363
+ | "credit-memo-voided"
10364
+ | "customer-created"
10365
+ | "customer-merged"
10366
+ | "customer-one-time-password-requested"
10367
+ | "customer-redirected-offsite"
10368
+ | "customer-returned"
10369
+ | "customer-updated"
10370
+ | "dispute-created"
10371
+ | "dispute-modified"
10372
+ | "experian-check-performed"
10373
+ | "gateway-account-downtime-ended"
10374
+ | "gateway-account-downtime-started"
10375
+ | "gateway-account-limit-reached"
10376
+ | "gateway-account-onboarding-completed"
10377
+ | "gateway-account-onboarding-failed"
10378
+ | "gateway-account-requested"
10379
+ | "invoice-abandoned"
10380
+ | "invoice-created"
10381
+ | "invoice-issued"
10382
+ | "invoice-modified"
10383
+ | "invoice-paid"
10384
+ | "invoice-partially-paid"
10385
+ | "invoice-partially-refunded"
10386
+ | "invoice-past-due"
10387
+ | "invoice-past-due-reminder"
10388
+ | "invoice-refunded"
10389
+ | "invoice-reissued"
10390
+ | "invoice-tax-calculation-failed"
10391
+ | "invoice-voided"
10392
+ | "kyc-document-accepted"
10393
+ | "kyc-document-created"
10394
+ | "kyc-document-modified"
10395
+ | "kyc-document-rejected"
10396
+ | "kyc-document-reviewed"
10397
+ | "kyc-document-archived"
10398
+ | "kyc-request-attempted"
10399
+ | "kyc-request-failed"
10400
+ | "kyc-request-fulfilled"
10401
+ | "kyc-request-partially-fulfilled"
10402
+ | "lead-source-changed"
10403
+ | "nsf-response-received"
10404
+ | "offsite-payment-completed"
10405
+ | "order-abandoned"
10406
+ | "order-completed"
10407
+ | "payment-card-created"
10408
+ | "payment-card-expiration-reminder"
10409
+ | "payment-card-expired"
10410
+ | "payment-instrument-modified"
10411
+ | "renewal-invoice-issued"
10412
+ | "renewal-invoice-payment-canceled"
10413
+ | "renewal-invoice-payment-declined"
10414
+ | "risk-score-changed"
10415
+ | "subscription-activated"
10416
+ | "subscription-canceled"
10417
+ | "subscription-downgraded"
10418
+ | "subscription-modified"
10419
+ | "subscription-paused"
10420
+ | "subscription-pause-created"
10421
+ | "subscription-pause-modified"
10422
+ | "subscription-pause-revoked"
10423
+ | "subscription-reactivated"
10424
+ | "subscription-renewal-reminder"
10425
+ | "subscription-renewed"
10426
+ | "subscription-resumed"
10427
+ | "subscription-trial-converted"
10428
+ | "subscription-trial-end-changed"
10429
+ | "subscription-trial-end-reminder"
10430
+ | "subscription-trial-ended"
10431
+ | "subscription-upgraded"
10432
+ | "subscription-churned"
10433
+ | "transaction-amount-discrepancy-found"
10434
+ | "transaction-declined"
10435
+ | "transaction-discrepancy-found"
10436
+ | "transaction-process-requested"
10437
+ | "transaction-processed"
10438
+ | "transaction-reconciled"
10439
+ | "transaction-timeout-resolved"
10440
+ | "waiting-gateway-transaction-completed"
10441
+ | "data-export-completed";
10272
10442
  EddScore: "not-found" | "unlikely" | "unclear" | "probable" | "confirmed";
10273
10443
  EddData: {
10274
10444
  occupation?: coreComponents["schemas"]["EddScore"];
@@ -10413,6 +10583,39 @@ export interface coreComponents {
10413
10583
  /** Payment card number being charged. */
10414
10584
  "payment-card"?: coreComponents["schemas"]["RiskScoreBlocklistType"];
10415
10585
  };
10586
+ /** Tag or untag rule. */
10587
+ TagUntagRule: {
10588
+ /** ID of the rule. */
10589
+ id?: coreComponents["schemas"]["ResourceId"];
10590
+ /** Name of the rule. */
10591
+ name: string;
10592
+ eventType: coreComponents["schemas"]["GlobalEventType"] & {
10593
+ [key: string]: any;
10594
+ };
10595
+ /**
10596
+ * Filter that determines whether to tag or untag.
10597
+ * This field requires a special format.
10598
+ * Use `,` for multiple allowed values.
10599
+ * Use `;` for multiple fields.
10600
+ *
10601
+ * For more information,
10602
+ * see [Using filters](https://api-reference.rebilly.com/#section/Using-filter-with-collections).
10603
+ */
10604
+ filter?: string | null;
10605
+ /** List of tags to add to the customer. */
10606
+ addTags: string[];
10607
+ /** List of tags to remove for the customer. */
10608
+ removeTags: string[];
10609
+ /** Status of the rule. */
10610
+ status: "active" | "inactive";
10611
+ /** Related resource links. */
10612
+ _links?: {
10613
+ /** Link URL. */
10614
+ href?: string;
10615
+ /** Type of link. */
10616
+ rel?: "self";
10617
+ }[];
10618
+ };
10416
10619
  };
10417
10620
  responses: {
10418
10621
  /** Unauthorized access. Invalid credentials used. */
@@ -17235,6 +17438,136 @@ export interface operations {
17235
17438
  404: coreComponents["responses"]["NotFound"];
17236
17439
  };
17237
17440
  };
17441
+ /** Retrieves a list of custom cashier property sets. */
17442
+ GetCashierCustomPropertySetCollection: {
17443
+ parameters: {
17444
+ query: {
17445
+ /** Limits the number of collection items to be returned. */
17446
+ limit?: coreComponents["parameters"]["collectionLimit"];
17447
+ /** Specifies the starting point within the collection of items to be returned. */
17448
+ offset?: coreComponents["parameters"]["collectionOffset"];
17449
+ /**
17450
+ * Filters the collection items. This field requires
17451
+ * a special format. Use `,` for multiple allowed values. Use `;` for multiple fields.
17452
+ *
17453
+ * For more information, see
17454
+ * [Using filter with collections](https://all-rebilly.redoc.ly/#section/Using-filter-with-collections).
17455
+ */
17456
+ filter?: coreComponents["parameters"]["collectionFilter"];
17457
+ /**
17458
+ * Sorts and orders the collection of items. To sort in descending
17459
+ * order, prefix with `-`.
17460
+ */
17461
+ sort?: coreComponents["parameters"]["collectionSort"];
17462
+ };
17463
+ };
17464
+ responses: {
17465
+ /** List of custom cashier property sets retrieved. */
17466
+ 200: {
17467
+ headers: {};
17468
+ content: {
17469
+ "application/json": coreComponents["schemas"]["CashierCustomPropertySet"][];
17470
+ };
17471
+ };
17472
+ 401: coreComponents["responses"]["Unauthorized"];
17473
+ 403: coreComponents["responses"]["Forbidden"];
17474
+ };
17475
+ };
17476
+ /**
17477
+ * Creates a custom cashier property set.
17478
+ * A custom property set is a JSON-schema to extend the hosted cashier deposit request form with extra form fields.
17479
+ * The collected information is stored at the cashier deposit request.
17480
+ */
17481
+ PostCashierCustomPropertySet: {
17482
+ responses: {
17483
+ /** Custom cashier property set created. */
17484
+ 201: {
17485
+ headers: {};
17486
+ content: {
17487
+ "application/json": coreComponents["schemas"]["CashierCustomPropertySet"];
17488
+ };
17489
+ };
17490
+ 401: coreComponents["responses"]["Unauthorized"];
17491
+ 403: coreComponents["responses"]["Forbidden"];
17492
+ 422: coreComponents["responses"]["ValidationError"];
17493
+ };
17494
+ /** Custom cashier property set resource. */
17495
+ requestBody: {
17496
+ content: {
17497
+ "application/json": coreComponents["schemas"]["CashierCustomPropertySet"];
17498
+ };
17499
+ };
17500
+ };
17501
+ /** Retrieves a custom cashier property set with a specified ID. */
17502
+ GetCashierCustomPropertySet: {
17503
+ parameters: {
17504
+ path: {
17505
+ /** ID of the resource. */
17506
+ id: coreComponents["parameters"]["resourceId"];
17507
+ };
17508
+ };
17509
+ responses: {
17510
+ /** Custom cashier property set retrieved. */
17511
+ 200: {
17512
+ content: {
17513
+ "application/json": coreComponents["schemas"]["CashierCustomPropertySet"];
17514
+ };
17515
+ };
17516
+ 401: coreComponents["responses"]["Unauthorized"];
17517
+ 403: coreComponents["responses"]["Forbidden"];
17518
+ 404: coreComponents["responses"]["NotFound"];
17519
+ };
17520
+ };
17521
+ /** Creates or updates (upserts) a custom cashier property set with a specified ID. */
17522
+ PutCashierCustomPropertySet: {
17523
+ parameters: {
17524
+ path: {
17525
+ /** ID of the resource. */
17526
+ id: coreComponents["parameters"]["resourceId"];
17527
+ };
17528
+ };
17529
+ responses: {
17530
+ /** Custom cashier property updated. */
17531
+ 200: {
17532
+ content: {
17533
+ "application/json": coreComponents["schemas"]["CashierCustomPropertySet"];
17534
+ };
17535
+ };
17536
+ /** Custom cashier property set created. */
17537
+ 201: {
17538
+ headers: {};
17539
+ content: {
17540
+ "application/json": coreComponents["schemas"]["CashierCustomPropertySet"];
17541
+ };
17542
+ };
17543
+ 401: coreComponents["responses"]["Unauthorized"];
17544
+ 403: coreComponents["responses"]["Forbidden"];
17545
+ 409: coreComponents["responses"]["Conflict"];
17546
+ 422: coreComponents["responses"]["ValidationError"];
17547
+ };
17548
+ /** Custom cashier property set resource. */
17549
+ requestBody: {
17550
+ content: {
17551
+ "application/json": coreComponents["schemas"]["CashierCustomPropertySet"];
17552
+ };
17553
+ };
17554
+ };
17555
+ /** Deletes a custom cashier property set with a specified ID. */
17556
+ DeleteCashierCustomPropertySet: {
17557
+ parameters: {
17558
+ path: {
17559
+ /** ID of the resource. */
17560
+ id: coreComponents["parameters"]["resourceId"];
17561
+ };
17562
+ };
17563
+ responses: {
17564
+ /** Custom cashier property set deleted. */
17565
+ 204: never;
17566
+ 401: coreComponents["responses"]["Unauthorized"];
17567
+ 403: coreComponents["responses"]["Forbidden"];
17568
+ 404: coreComponents["responses"]["NotFound"];
17569
+ };
17570
+ };
17238
17571
  /** Retrieves a list of payout requests. */
17239
17572
  GetPayoutRequestCollection: {
17240
17573
  parameters: {
@@ -17691,6 +18024,133 @@ export interface operations {
17691
18024
  };
17692
18025
  };
17693
18026
  };
18027
+ /** Retrieves a list of tags rules. */
18028
+ GetTagsRulesCollection: {
18029
+ parameters: {
18030
+ query: {
18031
+ /** Limits the number of collection items to be returned. */
18032
+ limit?: coreComponents["parameters"]["collectionLimit"];
18033
+ /** Specifies the starting point within the collection of items to be returned. */
18034
+ offset?: coreComponents["parameters"]["collectionOffset"];
18035
+ /**
18036
+ * Sorts and orders the collection of items. To sort in descending
18037
+ * order, prefix with `-`.
18038
+ */
18039
+ sort?: coreComponents["parameters"]["collectionSort"];
18040
+ /**
18041
+ * Filters the collection items. This field requires
18042
+ * a special format. Use `,` for multiple allowed values. Use `;` for multiple fields.
18043
+ *
18044
+ * For more information, see
18045
+ * [Using filter with collections](https://all-rebilly.redoc.ly/#section/Using-filter-with-collections).
18046
+ */
18047
+ filter?: coreComponents["parameters"]["collectionFilter"];
18048
+ /** Use this field to perform a partial search of text fields. */
18049
+ q?: coreComponents["parameters"]["collectionQuery"];
18050
+ };
18051
+ };
18052
+ responses: {
18053
+ /** List of tags rules retrieved. */
18054
+ 200: {
18055
+ headers: {};
18056
+ content: {
18057
+ "application/json": coreComponents["schemas"]["TagUntagRule"][];
18058
+ };
18059
+ };
18060
+ 401: coreComponents["responses"]["Unauthorized"];
18061
+ 403: coreComponents["responses"]["Forbidden"];
18062
+ };
18063
+ };
18064
+ /** Creates a tags rule. */
18065
+ PostTagRules: {
18066
+ responses: {
18067
+ /** Tags rule created. */
18068
+ 201: {
18069
+ headers: {};
18070
+ content: {
18071
+ "application/json": coreComponents["schemas"]["TagUntagRule"];
18072
+ };
18073
+ };
18074
+ 401: coreComponents["responses"]["Unauthorized"];
18075
+ 403: coreComponents["responses"]["Forbidden"];
18076
+ 422: coreComponents["responses"]["ValidationError"];
18077
+ };
18078
+ /** Tags rule resource. */
18079
+ requestBody: {
18080
+ content: {
18081
+ "application/json": coreComponents["schemas"]["TagUntagRule"];
18082
+ };
18083
+ };
18084
+ };
18085
+ /** Retrieves a tags rule with a specified ID. */
18086
+ GetTagsRule: {
18087
+ parameters: {
18088
+ path: {
18089
+ /** ID of the resource. */
18090
+ id: coreComponents["parameters"]["resourceId"];
18091
+ };
18092
+ };
18093
+ responses: {
18094
+ /** Tags rule retrieved. */
18095
+ 200: {
18096
+ content: {
18097
+ "application/json": coreComponents["schemas"]["TagUntagRule"];
18098
+ };
18099
+ };
18100
+ 401: coreComponents["responses"]["Unauthorized"];
18101
+ 403: coreComponents["responses"]["Forbidden"];
18102
+ 404: coreComponents["responses"]["NotFound"];
18103
+ };
18104
+ };
18105
+ /** Creates a tags rule with a specified ID. */
18106
+ PutTagsRule: {
18107
+ parameters: {
18108
+ path: {
18109
+ /** ID of the resource. */
18110
+ id: coreComponents["parameters"]["resourceId"];
18111
+ };
18112
+ };
18113
+ responses: {
18114
+ /** Tags rule updated. */
18115
+ 200: {
18116
+ content: {
18117
+ "application/json": coreComponents["schemas"]["TagUntagRule"];
18118
+ };
18119
+ };
18120
+ /** Tags rule created. */
18121
+ 201: {
18122
+ headers: {};
18123
+ content: {
18124
+ "application/json": coreComponents["schemas"]["TagUntagRule"];
18125
+ };
18126
+ };
18127
+ 401: coreComponents["responses"]["Unauthorized"];
18128
+ 403: coreComponents["responses"]["Forbidden"];
18129
+ 422: coreComponents["responses"]["ValidationError"];
18130
+ };
18131
+ /** Tags rule resource. */
18132
+ requestBody: {
18133
+ content: {
18134
+ "application/json": coreComponents["schemas"]["TagUntagRule"];
18135
+ };
18136
+ };
18137
+ };
18138
+ /** Deletes a tags rule with a specified ID. */
18139
+ DeleteTagsRule: {
18140
+ parameters: {
18141
+ path: {
18142
+ /** ID of the resource. */
18143
+ id: coreComponents["parameters"]["resourceId"];
18144
+ };
18145
+ };
18146
+ responses: {
18147
+ /** Tags rule deleted. */
18148
+ 204: never;
18149
+ 401: coreComponents["responses"]["Unauthorized"];
18150
+ 403: coreComponents["responses"]["Forbidden"];
18151
+ 404: coreComponents["responses"]["NotFound"];
18152
+ };
18153
+ };
17694
18154
  }
17695
18155
  /**
17696
18156
  * This file was auto-generated by openapi-typescript.
@@ -18707,29 +19167,6 @@ export interface usersPaths {
18707
19167
  */
18708
19168
  delete: operations["DeleteProfileMfa"];
18709
19169
  };
18710
- "/profile/password": {
18711
- /**
18712
- * Updates a user's password with a specified new password.
18713
- * This operation also ensures that the current password is correct.
18714
- */
18715
- post: operations["PostProfilePasswordChange"];
18716
- };
18717
- "/profile/totp-reset": {
18718
- /** Resets and renews a Time-Based One-Time Password or (TOTP) secret key. */
18719
- post: operations["PostProfileTotpReset"];
18720
- };
18721
- "/reset-password/{token}": {
18722
- /** Retrieves information for a specified token. */
18723
- get: operations["GetPasswordResetToken"];
18724
- /** Resets a user's account password. */
18725
- post: operations["PostPasswordReset"];
18726
- parameters: {
18727
- path: {
18728
- /** Token string. */
18729
- token: string;
18730
- };
18731
- };
18732
- };
18733
19170
  "/roles": {
18734
19171
  /** Retrieves a list of user roles. */
18735
19172
  get: operations["GetRoleCollection"];
@@ -18845,29 +19282,6 @@ export interface usersPaths {
18845
19282
  };
18846
19283
  };
18847
19284
  };
18848
- "/users/{id}/password": {
18849
- /**
18850
- * Updates a user's password with a specified new password.
18851
- * This operation also ensures that the current password is correct.
18852
- */
18853
- post: operations["PostUserPasswordChange"];
18854
- parameters: {
18855
- path: {
18856
- /** ID of the resource. */
18857
- id: usersComponents["parameters"]["resourceId"];
18858
- };
18859
- };
18860
- };
18861
- "/users/{id}/totp-reset": {
18862
- /** Resets and renews a TOTP secret with a specified user ID. */
18863
- post: operations["PostUserTotpReset"];
18864
- parameters: {
18865
- path: {
18866
- /** ID of the resource. */
18867
- id: usersComponents["parameters"]["resourceId"];
18868
- };
18869
- };
18870
- };
18871
19285
  "/webhooks": {
18872
19286
  /** Retrieves a list of webhooks. */
18873
19287
  get: operations["GetWebhookCollection"];
@@ -24205,6 +24619,11 @@ export interface usersComponents {
24205
24619
  * This option is only applicable when `useHostedCheckoutForm` is enabled.
24206
24620
  */
24207
24621
  forceGuestCheckout: boolean;
24622
+ /**
24623
+ * Specifies whether to allow customers to pay using the alternative payment options supported by PayPal.
24624
+ * When enabled, customers must manually approve all payments.
24625
+ */
24626
+ enableAlternativePaymentMethods: boolean;
24208
24627
  };
24209
24628
  };
24210
24629
  /** Payeezy gateway configuration. */
@@ -25935,8 +26354,8 @@ export interface usersComponents {
25935
26354
  SendTestEmail: usersComponents["schemas"]["RulesEmailNotification"];
25936
26355
  /** Trigger a test webhook. */
25937
26356
  SendPreviewWebhook: usersComponents["schemas"]["Webhook"];
25938
- /** Type of webhook event. */
25939
- GlobalWebhookEventType:
26357
+ /** Type of event. */
26358
+ GlobalEventType:
25940
26359
  | "aml-list-possibly-matched"
25941
26360
  | "application-instance-disabled"
25942
26361
  | "application-instance-enabled"
@@ -26028,7 +26447,7 @@ export interface usersComponents {
26028
26447
  /** ID of the webhook. */
26029
26448
  id?: usersComponents["schemas"]["ResourceId"];
26030
26449
  /** Array of system event types. */
26031
- eventsFilter: usersComponents["schemas"]["GlobalWebhookEventType"][];
26450
+ eventsFilter: usersComponents["schemas"]["GlobalEventType"][];
26032
26451
  status?: usersComponents["schemas"]["OnOff"];
26033
26452
  method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
26034
26453
  /** URL that triggers when a specified event occurs. */
@@ -26086,11 +26505,11 @@ export interface usersComponents {
26086
26505
  * This value is used for reports.
26087
26506
  */
26088
26507
  reportingCurrency?: string;
26089
- /** Specifies if two-factor authentification is enabled for the user. */
26508
+ /** Specifies if two-factor authentication is enabled for the user. */
26090
26509
  totpRequired?: boolean;
26091
- /** User's Time-based One-Time Password (TOTP) key for the authentification application, if TOTP is enabled. */
26510
+ /** User's Time-based One-Time Password (TOTP) key for the authentication application, if TOTP is enabled. */
26092
26511
  totpSecret?: string;
26093
- /** QR-code link that redirects the user to the authentification application, if TOTP is enabled. */
26512
+ /** QR-code link that redirects the user to the authentication application, if TOTP is enabled. */
26094
26513
  totpUrl?: string;
26095
26514
  /**
26096
26515
  * One-time password generated by Google Authenticator.
@@ -26138,88 +26557,6 @@ export interface usersComponents {
26138
26557
  rel?: "self" | "enrollment";
26139
26558
  }[];
26140
26559
  };
26141
- UpdatePassword: {
26142
- /** User's current password. This value is used to request a password change. */
26143
- currentPassword: string;
26144
- /** User's new password. This value replaces the existing password. */
26145
- newPassword: string;
26146
- };
26147
- ResetPasswordTokenInfo: {
26148
- /** ID of the token. */
26149
- id?: string;
26150
- /** Token string. */
26151
- token?: string;
26152
- /** Date and time when the token is created and sent. */
26153
- sentTime?: usersComponents["schemas"]["ServerTimestamp"];
26154
- _links?: usersComponents["schemas"]["SelfLink"];
26155
- };
26156
- ResetPassword: {
26157
- /** New account password. */
26158
- newPassword: string;
26159
- };
26160
- User: {
26161
- /** ID of the user. */
26162
- id?: usersComponents["schemas"]["ResourceId"];
26163
- /** Email address of the user. */
26164
- email: string;
26165
- /** User's first name. */
26166
- firstName: string;
26167
- /** User's last name. */
26168
- lastName: string;
26169
- /** User's business phone number. */
26170
- businessPhone?: string;
26171
- /** User's mobile phone number. */
26172
- mobilePhone?: string;
26173
- /**
26174
- * User's password.
26175
- * If this value is not provided, a password reset email is sent.
26176
- */
26177
- password?: string;
26178
- /**
26179
- * Permissions that the user has within organizations.
26180
- * Use the wildcard character `*` for full access.
26181
- */
26182
- permissions?: usersComponents["schemas"]["AclPermissions"];
26183
- /** All user permissions and roles. Use these permissions to emulate the user. */
26184
- computedPermissions?: usersComponents["schemas"]["AclPermissions"];
26185
- createdTime?: usersComponents["schemas"]["CreatedTime"];
26186
- updatedTime?: usersComponents["schemas"]["UpdatedTime"];
26187
- /** Date and time when the user last logged in. */
26188
- loginTime?: usersComponents["schemas"]["ServerTimestamp"];
26189
- /**
26190
- * User's currency code in ISO 4217 format.
26191
- * This value is used for reports.
26192
- */
26193
- reportingCurrency?: string;
26194
- /** Array of reporting currencies that are enabled for the merchant. */
26195
- availableCurrencies?: string[];
26196
- /** Specifies if two-factor authentification is enabled for the user. */
26197
- totpRequired?: boolean;
26198
- /** User's Time-based One-Time Password (TOTP) key for the authentification application, if TOTP is enabled.. */
26199
- totpSecret?: string;
26200
- /** QR-code link that redirects the user to the authentification application, if TOTP is enabled. */
26201
- totpUrl?: string;
26202
- /** Status of the user's account. */
26203
- status?: "active" | "inactive" | "pending-confirmation";
26204
- /**
26205
- * User's country of residence in ISO 3166 alpha-2 country code.
26206
- * For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/).
26207
- */
26208
- country?: string;
26209
- /**
26210
- * User preferences, such as: timezone, language, and more.
26211
- * This is an object with custom properties.
26212
- */
26213
- preferences?: { [key: string]: any };
26214
- /**
26215
- * Role IDs associated with the user.
26216
- * Role IDs specify the roles that the user performs within the organization.
26217
- * For example, the user may be an organization admin.
26218
- */
26219
- roleIds?: string[];
26220
- allowedIps?: usersComponents["schemas"]["AllowedIps"];
26221
- _links?: usersComponents["schemas"]["SelfLink"];
26222
- };
26223
26560
  Role: {
26224
26561
  id?: usersComponents["schemas"]["ResourceId"];
26225
26562
  /** Name of the user role. */
@@ -26297,6 +26634,69 @@ export interface usersComponents {
26297
26634
  reportingCurrency: string;
26298
26635
  questionnaire?: usersComponents["schemas"]["OrganizationQuestionnaire"];
26299
26636
  };
26637
+ User: {
26638
+ /** ID of the user. */
26639
+ id?: usersComponents["schemas"]["ResourceId"];
26640
+ /** Email address of the user. */
26641
+ email: string;
26642
+ /** User's first name. */
26643
+ firstName: string;
26644
+ /** User's last name. */
26645
+ lastName: string;
26646
+ /** User's business phone number. */
26647
+ businessPhone?: string;
26648
+ /** User's mobile phone number. */
26649
+ mobilePhone?: string;
26650
+ /**
26651
+ * User's password.
26652
+ * If this value is not provided, a password reset email is sent.
26653
+ */
26654
+ password?: string;
26655
+ /**
26656
+ * Permissions that the user has within organizations.
26657
+ * Use the wildcard character `*` for full access.
26658
+ */
26659
+ permissions?: usersComponents["schemas"]["AclPermissions"];
26660
+ /** All user permissions and roles. Use these permissions to emulate the user. */
26661
+ computedPermissions?: usersComponents["schemas"]["AclPermissions"];
26662
+ createdTime?: usersComponents["schemas"]["CreatedTime"];
26663
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
26664
+ /** Date and time when the user last logged in. */
26665
+ loginTime?: usersComponents["schemas"]["ServerTimestamp"];
26666
+ /**
26667
+ * User's currency code in ISO 4217 format.
26668
+ * This value is used for reports.
26669
+ */
26670
+ reportingCurrency?: string;
26671
+ /** Array of reporting currencies that are enabled for the merchant. */
26672
+ availableCurrencies?: string[];
26673
+ /** Specifies if two-factor authentication is enabled for the user. */
26674
+ totpRequired?: boolean;
26675
+ /** User's Time-based One-Time Password (TOTP) key for the authentication application, if TOTP is enabled.. */
26676
+ totpSecret?: string;
26677
+ /** QR-code link that redirects the user to the authentication application, if TOTP is enabled. */
26678
+ totpUrl?: string;
26679
+ /** Status of the user's account. */
26680
+ status?: "active" | "inactive" | "pending-confirmation";
26681
+ /**
26682
+ * User's country of residence in ISO 3166 alpha-2 country code.
26683
+ * For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/).
26684
+ */
26685
+ country?: string;
26686
+ /**
26687
+ * User preferences, such as: timezone, language, and more.
26688
+ * This is an object with custom properties.
26689
+ */
26690
+ preferences?: { [key: string]: any };
26691
+ /**
26692
+ * Role IDs associated with the user.
26693
+ * Role IDs specify the roles that the user performs within the organization.
26694
+ * For example, the user may be an organization admin.
26695
+ */
26696
+ roleIds?: string[];
26697
+ allowedIps?: usersComponents["schemas"]["AllowedIps"];
26698
+ _links?: usersComponents["schemas"]["SelfLink"];
26699
+ };
26300
26700
  Status: {
26301
26701
  /**
26302
26702
  * Status of the Rebilly API.
@@ -26404,11 +26804,11 @@ export interface usersComponents {
26404
26804
  /** Various theme settings used in the cashier form. */
26405
26805
  theme?: {
26406
26806
  /** Primary color for the cashier form in hexadecimal format. */
26407
- colorPrimary: string;
26807
+ colorPrimary?: string | null;
26408
26808
  /** Secondary color for the cashier form in hexadecimal format. */
26409
- colorSecondary: string;
26809
+ colorSecondary?: string | null;
26410
26810
  /** Submit button template. `{{amount}}` can be used as a placeholder for amount and currency. */
26411
- buttonTemplate?: string;
26811
+ buttonTemplate?: string | null;
26412
26812
  } | null;
26413
26813
  };
26414
26814
  /** Payment form settings. */
@@ -26659,11 +27059,6 @@ export interface usersComponents {
26659
27059
  "application/json": usersComponents["schemas"]["GlobalWebhook"];
26660
27060
  };
26661
27061
  };
26662
- UpdatePassword: {
26663
- content: {
26664
- "application/json": usersComponents["schemas"]["UpdatePassword"];
26665
- };
26666
- };
26667
27062
  /** User resource. */
26668
27063
  User: {
26669
27064
  content: {
@@ -26915,6 +27310,14 @@ export interface operations {
26915
27310
  filter?: usersComponents["parameters"]["collectionFilter"];
26916
27311
  /** Use this field to perform a partial search of text fields. */
26917
27312
  q?: usersComponents["parameters"]["collectionQuery"];
27313
+ /**
27314
+ * Expands a request to include embedded objects within the `_embedded`
27315
+ * property of the response. This field accepts a comma-separated list of objects.
27316
+ *
27317
+ * For more information, see
27318
+ * [Expand to include embedded objects](https://all-rebilly.redoc.ly/#section/Expand-to-include-embedded-objects).
27319
+ */
27320
+ expand?: usersComponents["parameters"]["collectionExpand"];
26918
27321
  /**
26919
27322
  * Limits the returned fields to the specified list, each field separated by a comma.
26920
27323
  * The ID value is always returned.
@@ -31002,81 +31405,6 @@ export interface operations {
31002
31405
  404: usersComponents["responses"]["NotFound"];
31003
31406
  };
31004
31407
  };
31005
- /**
31006
- * Updates a user's password with a specified new password.
31007
- * This operation also ensures that the current password is correct.
31008
- */
31009
- PostProfilePasswordChange: {
31010
- responses: {
31011
- /** Password updated. */
31012
- 201: {
31013
- headers: {};
31014
- content: {
31015
- "application/json": usersComponents["schemas"]["Profile"];
31016
- };
31017
- };
31018
- 401: usersComponents["responses"]["Unauthorized"];
31019
- 403: usersComponents["responses"]["Forbidden"];
31020
- 404: usersComponents["responses"]["NotFound"];
31021
- 422: usersComponents["responses"]["ValidationError"];
31022
- };
31023
- requestBody: usersComponents["requestBodies"]["UpdatePassword"];
31024
- };
31025
- /** Resets and renews a Time-Based One-Time Password or (TOTP) secret key. */
31026
- PostProfileTotpReset: {
31027
- responses: {
31028
- /** TOTP secret reset and renewed. */
31029
- 201: {
31030
- headers: {};
31031
- content: {
31032
- "application/json": usersComponents["schemas"]["Profile"];
31033
- };
31034
- };
31035
- 404: usersComponents["responses"]["NotFound"];
31036
- };
31037
- };
31038
- /** Retrieves information for a specified token. */
31039
- GetPasswordResetToken: {
31040
- parameters: {
31041
- path: {
31042
- /** Token string. */
31043
- token: string;
31044
- };
31045
- };
31046
- responses: {
31047
- /** Token retrieved. */
31048
- 200: {
31049
- content: {
31050
- "application/json": usersComponents["schemas"]["ResetPasswordTokenInfo"];
31051
- };
31052
- };
31053
- 404: usersComponents["responses"]["NotFound"];
31054
- };
31055
- };
31056
- /** Resets a user's account password. */
31057
- PostPasswordReset: {
31058
- parameters: {
31059
- path: {
31060
- /** Token string. */
31061
- token: string;
31062
- };
31063
- };
31064
- responses: {
31065
- /** Password reset. */
31066
- 201: {
31067
- headers: {};
31068
- content: {
31069
- "application/json": usersComponents["schemas"]["User"];
31070
- };
31071
- };
31072
- 422: usersComponents["responses"]["ValidationError"];
31073
- };
31074
- requestBody: {
31075
- content: {
31076
- "application/json": usersComponents["schemas"]["ResetPassword"];
31077
- };
31078
- };
31079
- };
31080
31408
  /** Retrieves a list of user roles. */
31081
31409
  GetRoleCollection: {
31082
31410
  parameters: {
@@ -31589,51 +31917,6 @@ export interface operations {
31589
31917
  404: usersComponents["responses"]["NotFound"];
31590
31918
  };
31591
31919
  };
31592
- /**
31593
- * Updates a user's password with a specified new password.
31594
- * This operation also ensures that the current password is correct.
31595
- */
31596
- PostUserPasswordChange: {
31597
- parameters: {
31598
- path: {
31599
- /** ID of the resource. */
31600
- id: usersComponents["parameters"]["resourceId"];
31601
- };
31602
- };
31603
- responses: {
31604
- /** Password updated. */
31605
- 201: {
31606
- headers: {};
31607
- content: {
31608
- "application/json": usersComponents["schemas"]["User"];
31609
- };
31610
- };
31611
- 401: usersComponents["responses"]["Unauthorized"];
31612
- 403: usersComponents["responses"]["Forbidden"];
31613
- 404: usersComponents["responses"]["NotFound"];
31614
- 422: usersComponents["responses"]["ValidationError"];
31615
- };
31616
- requestBody: usersComponents["requestBodies"]["UpdatePassword"];
31617
- };
31618
- /** Resets and renews a TOTP secret with a specified user ID. */
31619
- PostUserTotpReset: {
31620
- parameters: {
31621
- path: {
31622
- /** ID of the resource. */
31623
- id: usersComponents["parameters"]["resourceId"];
31624
- };
31625
- };
31626
- responses: {
31627
- /** TOTP secret reset and renewed. */
31628
- 201: {
31629
- headers: {};
31630
- content: {
31631
- "application/json": usersComponents["schemas"]["User"];
31632
- };
31633
- };
31634
- 404: usersComponents["responses"]["NotFound"];
31635
- };
31636
- };
31637
31920
  /** Retrieves a list of webhooks. */
31638
31921
  GetWebhookCollection: {
31639
31922
  parameters: {
@@ -32648,36 +32931,36 @@ export interface storefrontComponents {
32648
32931
  * Category of the lead source traffic.
32649
32932
  * For example, the medium could be organic search, Google ads, Display ads, and so on.
32650
32933
  */
32651
- medium?: string;
32934
+ medium?: string | null;
32652
32935
  /** Domain, platform, or channel from which the lead source originates. */
32653
- source?: string;
32936
+ source?: string | null;
32654
32937
  /** Campaign name of the lead source. */
32655
- campaign?: string;
32938
+ campaign?: string | null;
32656
32939
  /** Term associated with a lead source. */
32657
- term?: string;
32940
+ term?: string | null;
32658
32941
  /**
32659
32942
  * Content contained in the lead source content.
32660
32943
  * For example, content could be graphics, video, and so on.
32661
32944
  */
32662
- content?: string;
32945
+ content?: string | null;
32663
32946
  /** Individual or entity that is affilated with the lead source. */
32664
- affiliate?: string;
32947
+ affiliate?: string | null;
32665
32948
  /**
32666
32949
  * Individual or entity that is associated with a lead source affiliate.
32667
32950
  * In other products, this field may also be referred to as sub ID or click ID in some.
32668
32951
  */
32669
- subAffiliate?: string;
32952
+ subAffiliate?: string | null;
32670
32953
  /** Name of the sales agent associated with the lead source. */
32671
- salesAgent?: string;
32954
+ salesAgent?: string | null;
32672
32955
  /**
32673
32956
  * ID of the lead source click.
32674
32957
  * This value is passed in the ad click URL for tracking and campaign attribution.
32675
32958
  */
32676
- clickId?: string;
32959
+ clickId?: string | null;
32677
32960
  /** URL from which the lead source originates. */
32678
- path?: string;
32961
+ path?: string | null;
32679
32962
  /** Lead source [`referrer` URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer). */
32680
- referrer?: string;
32963
+ referrer?: string | null;
32681
32964
  createdTime?: storefrontComponents["schemas"]["CreatedTime"];
32682
32965
  updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
32683
32966
  /** Related links. */
@@ -34579,6 +34862,18 @@ export interface storefrontComponents {
34579
34862
  redirectUrl?: string;
34580
34863
  /** Date and time at which the cashier request expires. The default expiration time is one hour from the time the request is created. */
34581
34864
  expirationTime?: string;
34865
+ /** ID of a custom property set to apply to the request `propertiesSchema`. */
34866
+ customPropertySetId?: string;
34867
+ /**
34868
+ * Defines properties the user can complete when they use the hosted cashier form.
34869
+ * This field accepts [JSON-schema](https://json-schema.org/) drafts 4, 6, and 7.
34870
+ */
34871
+ propertiesSchema?: { [key: string]: any };
34872
+ /**
34873
+ * Properties that are available for the user to complete when they use the hosted cashier form.
34874
+ * Use this object to describe fields that are rendered and completed during the deposit process, in the cashier deposit form.
34875
+ */
34876
+ properties?: { [key: string]: string };
34582
34877
  createdTime?: storefrontComponents["schemas"]["CreatedTime"];
34583
34878
  updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
34584
34879
  /** Related links. */
@@ -34797,11 +35092,11 @@ export interface storefrontComponents {
34797
35092
  /** Various theme settings used in the cashier form. */
34798
35093
  theme?: {
34799
35094
  /** Primary color for the cashier form in hexadecimal format. */
34800
- colorPrimary: string;
35095
+ colorPrimary?: string | null;
34801
35096
  /** Secondary color for the cashier form in hexadecimal format. */
34802
- colorSecondary: string;
35097
+ colorSecondary?: string | null;
34803
35098
  /** Submit button template. `{{amount}}` can be used as a placeholder for amount and currency. */
34804
- buttonTemplate?: string;
35099
+ buttonTemplate?: string | null;
34805
35100
  } | null;
34806
35101
  };
34807
35102
  /** Payment form settings. */
@@ -35687,6 +35982,8 @@ export interface storefrontComponents {
35687
35982
  cashierRequestId: string;
35688
35983
  /** Deposit amount. */
35689
35984
  amount: number;
35985
+ /** Properties completed by the user in the deposit form. */
35986
+ properties?: { [key: string]: string };
35690
35987
  };
35691
35988
  };
35692
35989
  };
@@ -39300,6 +39597,10 @@ export interface operations {
39300
39597
  periodStart: string;
39301
39598
  /** Date and time when the report ends. */
39302
39599
  periodEnd: string;
39600
+ /** Limits the number of collection items to be returned. */
39601
+ limit?: reportsComponents["parameters"]["collectionLimit"];
39602
+ /** Specifies the starting point within the collection of items to be returned. */
39603
+ offset?: reportsComponents["parameters"]["collectionOffset"];
39303
39604
  };
39304
39605
  };
39305
39606
  responses: {
@@ -39724,7 +40025,7 @@ declare module "resources/applications-resource" {
39724
40025
  export default function ApplicationsResource({ apiHandler }: {
39725
40026
  apiHandler: any;
39726
40027
  }): {
39727
- getAll({ limit, offset, filter, q, fields, sort, }?: rebilly.GetApplicationCollectionRequest): rebilly.GetApplicationCollectionResponsePromise;
40028
+ getAll({ limit, offset, filter, q, expand, fields, sort, }?: rebilly.GetApplicationCollectionRequest): rebilly.GetApplicationCollectionResponsePromise;
39728
40029
  create({ data }: {
39729
40030
  data: any;
39730
40031
  }): any;
@@ -39800,6 +40101,24 @@ declare module "resources/broadcast-messages-resource" {
39800
40101
  }): any;
39801
40102
  };
39802
40103
  }
40104
+ declare module "resources/cashier-custom-property-sets-resource" {
40105
+ export default function CashierCustomPropertySetsResource({ apiHandler }: {
40106
+ apiHandler: any;
40107
+ }): {
40108
+ getAll({ limit, offset, filter, sort }?: rebilly.GetCashierCustomPropertySetCollectionRequest): rebilly.GetCashierCustomPropertySetCollectionResponsePromise;
40109
+ create({ id, data }: rebilly.CreateCashierCustomPropertySetRequest): rebilly.PostCashierCustomPropertySetResponsePromise;
40110
+ get({ id }: {
40111
+ id: any;
40112
+ }): rebilly.GetCashierCustomPropertySetResponsePromise;
40113
+ update({ id, data }: {
40114
+ id: any;
40115
+ data: any;
40116
+ }): rebilly.PutCashierCustomPropertySetResponsePromise;
40117
+ delete({ id }: {
40118
+ id: any;
40119
+ }): any;
40120
+ };
40121
+ }
39803
40122
  declare module "resources/cashier-requests-resource" {
39804
40123
  export default function CashierRequestsResource({ apiHandler }: {
39805
40124
  apiHandler: any;
@@ -40988,10 +41307,6 @@ declare module "resources/profile-resource" {
40988
41307
  getMfa(): rebilly.GetProfileMfaResponsePromise;
40989
41308
  updateMfa(): any;
40990
41309
  deleteMfa(): any;
40991
- updatePassword({ data }: {
40992
- data: any;
40993
- }): any;
40994
- resetTotp(): any;
40995
41310
  };
40996
41311
  }
40997
41312
  declare module "resources/purchase-resource" {
@@ -41263,6 +41578,24 @@ declare module "resources/tags-resource" {
41263
41578
  }): any;
41264
41579
  };
41265
41580
  }
41581
+ declare module "resources/tags-rules-resource" {
41582
+ export default function TagsRulesResource({ apiHandler }: {
41583
+ apiHandler: any;
41584
+ }): {
41585
+ getAllTagsRules({ limit, offset, sort, filter, q, }?: rebilly.GetTagsRulesCollectionRequest): rebilly.GetTagsRulesCollectionResponsePromise;
41586
+ createTagsRule({ id, data }: rebilly.CreateTagRulesRequest): rebilly.PostTagRulesResponsePromise;
41587
+ getTagsRule({ id }: {
41588
+ id: any;
41589
+ }): rebilly.GetTagsRuleResponsePromise;
41590
+ updateTagsRule({ id, data }: {
41591
+ id: any;
41592
+ data: any;
41593
+ }): rebilly.PutTagsRuleResponsePromise;
41594
+ deleteTagsRule({ id }: {
41595
+ id: any;
41596
+ }): any;
41597
+ };
41598
+ }
41266
41599
  declare module "resources/tracking-resource" {
41267
41600
  export default function TrackingResource({ apiHandler }: {
41268
41601
  apiHandler: any;
@@ -41361,13 +41694,6 @@ declare module "resources/users-resource" {
41361
41694
  export default function UsersResource({ apiHandler }: {
41362
41695
  apiHandler: any;
41363
41696
  }): {
41364
- getResetPasswordToken({ token }: {
41365
- token: any;
41366
- }): rebilly.GetPasswordResetTokenResponsePromise;
41367
- resetPassword({ token, data }: {
41368
- token: any;
41369
- data: any;
41370
- }): any;
41371
41697
  getAll({ limit, offset, sort, filter, q, }?: rebilly.GetUserCollectionRequest): rebilly.GetUserCollectionResponsePromise;
41372
41698
  create({ id, data }: rebilly.CreateUserRequest): rebilly.PostUserResponsePromise;
41373
41699
  get({ id }: {
@@ -41380,13 +41706,6 @@ declare module "resources/users-resource" {
41380
41706
  getMfa({ id }: {
41381
41707
  id: any;
41382
41708
  }): rebilly.GetUserMfaResponsePromise;
41383
- updatePassword({ id, data }: {
41384
- id: any;
41385
- data: any;
41386
- }): any;
41387
- resetTotp({ id }: {
41388
- id: any;
41389
- }): any;
41390
41709
  };
41391
41710
  }
41392
41711
  declare module "resources/webhooks-resource" {
@@ -41505,11 +41824,12 @@ declare module "resources/api-instance" {
41505
41824
  }): any;
41506
41825
  };
41507
41826
  applications: {
41508
- getAll({ limit, offset, filter, q, fields, sort, }?: {
41827
+ getAll({ limit, offset, filter, q, expand, fields, sort, }?: {
41509
41828
  limit?: number;
41510
41829
  offset?: number;
41511
41830
  filter?: string;
41512
41831
  q?: string;
41832
+ expand?: string;
41513
41833
  fields?: string;
41514
41834
  sort?: string[];
41515
41835
  }): rebilly.GetApplicationCollectionResponsePromise;
@@ -41591,6 +41911,25 @@ declare module "resources/api-instance" {
41591
41911
  data: any;
41592
41912
  }): any;
41593
41913
  };
41914
+ cashierCustomPropertySets: {
41915
+ getAll({ limit, offset, filter, sort }?: {
41916
+ limit?: number;
41917
+ offset?: number;
41918
+ filter?: string;
41919
+ sort?: string[];
41920
+ }): rebilly.GetCashierCustomPropertySetCollectionResponsePromise;
41921
+ create({ id, data }: rebilly.CreateCashierCustomPropertySetRequest): rebilly.PostCashierCustomPropertySetResponsePromise;
41922
+ get({ id }: {
41923
+ id: any;
41924
+ }): rebilly.GetCashierCustomPropertySetResponsePromise;
41925
+ update({ id, data }: {
41926
+ id: any;
41927
+ data: any;
41928
+ }): rebilly.PutCashierCustomPropertySetResponsePromise;
41929
+ delete({ id }: {
41930
+ id: any;
41931
+ }): any;
41932
+ };
41594
41933
  cashierRequests: {
41595
41934
  getAll({ limit, offset, filter, sort }?: {
41596
41935
  limit?: number;
@@ -42841,10 +43180,6 @@ declare module "resources/api-instance" {
42841
43180
  getMfa(): rebilly.GetProfileMfaResponsePromise;
42842
43181
  updateMfa(): any;
42843
43182
  deleteMfa(): any;
42844
- updatePassword({ data }: {
42845
- data: any;
42846
- }): any;
42847
- resetTotp(): any;
42848
43183
  };
42849
43184
  purchase: {
42850
43185
  readyToPay({ data }: {
@@ -43110,6 +43445,26 @@ declare module "resources/api-instance" {
43110
43445
  kycDocumentId: any;
43111
43446
  }): any;
43112
43447
  };
43448
+ tagsRules: {
43449
+ getAllTagsRules({ limit, offset, sort, filter, q, }?: {
43450
+ limit?: number;
43451
+ offset?: number;
43452
+ sort?: string[];
43453
+ filter?: string;
43454
+ q?: string;
43455
+ }): rebilly.GetTagsRulesCollectionResponsePromise;
43456
+ createTagsRule({ id, data }: rebilly.CreateTagRulesRequest): rebilly.PostTagRulesResponsePromise;
43457
+ getTagsRule({ id }: {
43458
+ id: any;
43459
+ }): rebilly.GetTagsRuleResponsePromise;
43460
+ updateTagsRule({ id, data }: {
43461
+ id: any;
43462
+ data: any;
43463
+ }): rebilly.PutTagsRuleResponsePromise;
43464
+ deleteTagsRule({ id }: {
43465
+ id: any;
43466
+ }): any;
43467
+ };
43113
43468
  tracking: {
43114
43469
  getAllApiLogs({ limit, offset, sort, filter, q, }?: {
43115
43470
  limit?: number;
@@ -43224,13 +43579,6 @@ declare module "resources/api-instance" {
43224
43579
  }): any;
43225
43580
  };
43226
43581
  users: {
43227
- getResetPasswordToken({ token }: {
43228
- token: any;
43229
- }): rebilly.GetPasswordResetTokenResponsePromise;
43230
- resetPassword({ token, data }: {
43231
- token: any;
43232
- data: any;
43233
- }): any;
43234
43582
  getAll({ limit, offset, sort, filter, q, }?: {
43235
43583
  limit?: number;
43236
43584
  offset?: number;
@@ -43249,13 +43597,6 @@ declare module "resources/api-instance" {
43249
43597
  getMfa({ id }: {
43250
43598
  id: any;
43251
43599
  }): rebilly.GetUserMfaResponsePromise;
43252
- updatePassword({ id, data }: {
43253
- id: any;
43254
- data: any;
43255
- }): any;
43256
- resetTotp({ id }: {
43257
- id: any;
43258
- }): any;
43259
43600
  };
43260
43601
  webhooks: {
43261
43602
  getAll({ limit, offset, filter }?: {
@@ -43498,11 +43839,13 @@ declare module "resources/experimental/reports-resource" {
43498
43839
  limit?: any;
43499
43840
  offset?: any;
43500
43841
  }): rebilly.GetSubscriptionRenewalReportResponsePromise;
43501
- getTimeSeriesTransaction({ type, subaggregate, periodStart, periodEnd }: {
43842
+ getTimeSeriesTransaction({ type, subaggregate, periodStart, periodEnd, limit, offset, }: {
43502
43843
  type: any;
43503
43844
  subaggregate: any;
43504
43845
  periodStart: any;
43505
43846
  periodEnd: any;
43847
+ limit?: any;
43848
+ offset?: any;
43506
43849
  }): rebilly.GetTimeSeriesTransactionReportResponsePromise;
43507
43850
  getTransactionsTimeDispute({ aggregationField, periodStart, periodEnd, limit, offset, filter, }: {
43508
43851
  aggregationField: any;
@@ -43744,11 +44087,13 @@ declare module "resources/experimental/experimental-resources" {
43744
44087
  limit?: any;
43745
44088
  offset?: any;
43746
44089
  }): rebilly.GetSubscriptionRenewalReportResponsePromise;
43747
- getTimeSeriesTransaction({ type, subaggregate, periodStart, periodEnd }: {
44090
+ getTimeSeriesTransaction({ type, subaggregate, periodStart, periodEnd, limit, offset, }: {
43748
44091
  type: any;
43749
44092
  subaggregate: any;
43750
44093
  periodStart: any;
43751
44094
  periodEnd: any;
44095
+ limit?: any;
44096
+ offset?: any;
43752
44097
  }): rebilly.GetTimeSeriesTransactionReportResponsePromise;
43753
44098
  getTransactionsTimeDispute({ aggregationField, periodStart, periodEnd, limit, offset, filter, }: {
43754
44099
  aggregationField: any;