rebilly-js-sdk 48.2.0 → 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]
@@ -1677,23 +1696,6 @@ declare module rebilly {
1677
1696
  type DeleteProfileMfaResponse = operations['DeleteProfileMfa']['responses']['204']
1678
1697
  type DeleteProfileMfaResponsePromise = Promise<{fields: DeleteProfileMfaResponse}>
1679
1698
 
1680
- type PostProfilePasswordChangeRequest = operations['PostProfilePasswordChange']['requestBody']['content']['application/json']
1681
- type CreateProfilePasswordChangeRequest = { id: String, data: PostProfilePasswordChangeRequest, expand?: String }
1682
- type PostProfilePasswordChangeResponse = operations['PostProfilePasswordChange']['responses']['201']['content']['application/json']
1683
- type PostProfilePasswordChangeResponsePromise = Promise<{fields: PostProfilePasswordChangeResponse}>
1684
-
1685
- type PostProfileTotpResetResponse = operations['PostProfileTotpReset']['responses']['201']['content']['application/json']
1686
- type PostProfileTotpResetResponsePromise = Promise<{fields: PostProfileTotpResetResponse}>
1687
-
1688
- type GetPasswordResetTokenRequest = { token : String }
1689
-
1690
- type GetPasswordResetTokenResponse = operations['GetPasswordResetToken']['responses']['200']['content']['application/json']
1691
- type GetPasswordResetTokenResponsePromise = Promise<{fields: GetPasswordResetTokenResponse}>
1692
- type PostPasswordResetRequest = operations['PostPasswordReset']['requestBody']['content']['application/json']
1693
- type CreatePasswordResetRequest = { id: String, data: PostPasswordResetRequest, expand?: String }
1694
- type PostPasswordResetResponse = operations['PostPasswordReset']['responses']['201']['content']['application/json']
1695
- type PostPasswordResetResponsePromise = Promise<{fields: PostPasswordResetResponse}>
1696
-
1697
1699
  type GetRoleCollectionRequest = operations['GetRoleCollection']['parameters']["query"] & (operations['GetRoleCollection']['parameters'] extends {path: {}} ? operations['GetRoleCollection']['parameters']["path"] : {})
1698
1700
 
1699
1701
  type GetRoleCollectionResponse = operations['GetRoleCollection']['responses']['200']['content']['application/json'][0]
@@ -1782,14 +1784,6 @@ declare module rebilly {
1782
1784
  type GetUserMfaResponse = operations['GetUserMfa']['responses']['200']['content']['application/json']
1783
1785
  type GetUserMfaResponsePromise = Promise<{fields: GetUserMfaResponse}>
1784
1786
 
1785
- type PostUserPasswordChangeRequest = operations['PostUserPasswordChange']['requestBody']['content']['application/json']
1786
- type CreateUserPasswordChangeRequest = { id: String, data: PostUserPasswordChangeRequest, expand?: String }
1787
- type PostUserPasswordChangeResponse = operations['PostUserPasswordChange']['responses']['201']['content']['application/json']
1788
- type PostUserPasswordChangeResponsePromise = Promise<{fields: PostUserPasswordChangeResponse}>
1789
-
1790
- type PostUserTotpResetResponse = operations['PostUserTotpReset']['responses']['201']['content']['application/json']
1791
- type PostUserTotpResetResponsePromise = Promise<{fields: PostUserTotpResetResponse}>
1792
-
1793
1787
  type GetWebhookCollectionRequest = operations['GetWebhookCollection']['parameters']["query"] & (operations['GetWebhookCollection']['parameters'] extends {path: {}} ? operations['GetWebhookCollection']['parameters']["path"] : {})
1794
1788
 
1795
1789
  type GetWebhookCollectionResponse = operations['GetWebhookCollection']['responses']['200']['content']['application/json'][0]
@@ -3738,6 +3732,30 @@ export interface corePaths {
3738
3732
  };
3739
3733
  };
3740
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
+ };
3741
3759
  "/payout-requests": {
3742
3760
  /** Retrieves a list of payout requests. */
3743
3761
  get: operations["GetPayoutRequestCollection"];
@@ -4922,36 +4940,36 @@ export interface coreComponents {
4922
4940
  * Category of the lead source traffic.
4923
4941
  * For example, the medium could be organic search, Google ads, Display ads, and so on.
4924
4942
  */
4925
- medium?: string;
4943
+ medium?: string | null;
4926
4944
  /** Domain, platform, or channel from which the lead source originates. */
4927
- source?: string;
4945
+ source?: string | null;
4928
4946
  /** Campaign name of the lead source. */
4929
- campaign?: string;
4947
+ campaign?: string | null;
4930
4948
  /** Term associated with a lead source. */
4931
- term?: string;
4949
+ term?: string | null;
4932
4950
  /**
4933
4951
  * Content contained in the lead source content.
4934
4952
  * For example, content could be graphics, video, and so on.
4935
4953
  */
4936
- content?: string;
4954
+ content?: string | null;
4937
4955
  /** Individual or entity that is affilated with the lead source. */
4938
- affiliate?: string;
4956
+ affiliate?: string | null;
4939
4957
  /**
4940
4958
  * Individual or entity that is associated with a lead source affiliate.
4941
4959
  * In other products, this field may also be referred to as sub ID or click ID in some.
4942
4960
  */
4943
- subAffiliate?: string;
4961
+ subAffiliate?: string | null;
4944
4962
  /** Name of the sales agent associated with the lead source. */
4945
- salesAgent?: string;
4963
+ salesAgent?: string | null;
4946
4964
  /**
4947
4965
  * ID of the lead source click.
4948
4966
  * This value is passed in the ad click URL for tracking and campaign attribution.
4949
4967
  */
4950
- clickId?: string;
4968
+ clickId?: string | null;
4951
4969
  /** URL from which the lead source originates. */
4952
- path?: string;
4970
+ path?: string | null;
4953
4971
  /** Lead source [`referrer` URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer). */
4954
- referrer?: string;
4972
+ referrer?: string | null;
4955
4973
  createdTime?: coreComponents["schemas"]["CreatedTime"];
4956
4974
  updatedTime?: coreComponents["schemas"]["UpdatedTime"];
4957
4975
  /** Related links. */
@@ -10130,6 +10148,18 @@ export interface coreComponents {
10130
10148
  redirectUrl?: string;
10131
10149
  /** Date and time at which the cashier request expires. The default expiration time is one hour from the time the request is created. */
10132
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 };
10133
10163
  createdTime?: coreComponents["schemas"]["CreatedTime"];
10134
10164
  updatedTime?: coreComponents["schemas"]["UpdatedTime"];
10135
10165
  /** Related links. */
@@ -10190,6 +10220,18 @@ export interface coreComponents {
10190
10220
  createdTime?: coreComponents["schemas"]["CreatedTime"];
10191
10221
  updatedTime?: coreComponents["schemas"]["UpdatedTime"];
10192
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
+ };
10193
10235
  PayoutRequest: {
10194
10236
  id?: coreComponents["schemas"]["ResourceId"];
10195
10237
  websiteId: coreComponents["schemas"]["WebsiteId"];
@@ -17396,6 +17438,136 @@ export interface operations {
17396
17438
  404: coreComponents["responses"]["NotFound"];
17397
17439
  };
17398
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
+ };
17399
17571
  /** Retrieves a list of payout requests. */
17400
17572
  GetPayoutRequestCollection: {
17401
17573
  parameters: {
@@ -18995,29 +19167,6 @@ export interface usersPaths {
18995
19167
  */
18996
19168
  delete: operations["DeleteProfileMfa"];
18997
19169
  };
18998
- "/profile/password": {
18999
- /**
19000
- * Updates a user's password with a specified new password.
19001
- * This operation also ensures that the current password is correct.
19002
- */
19003
- post: operations["PostProfilePasswordChange"];
19004
- };
19005
- "/profile/totp-reset": {
19006
- /** Resets and renews a Time-Based One-Time Password or (TOTP) secret key. */
19007
- post: operations["PostProfileTotpReset"];
19008
- };
19009
- "/reset-password/{token}": {
19010
- /** Retrieves information for a specified token. */
19011
- get: operations["GetPasswordResetToken"];
19012
- /** Resets a user's account password. */
19013
- post: operations["PostPasswordReset"];
19014
- parameters: {
19015
- path: {
19016
- /** Token string. */
19017
- token: string;
19018
- };
19019
- };
19020
- };
19021
19170
  "/roles": {
19022
19171
  /** Retrieves a list of user roles. */
19023
19172
  get: operations["GetRoleCollection"];
@@ -19133,29 +19282,6 @@ export interface usersPaths {
19133
19282
  };
19134
19283
  };
19135
19284
  };
19136
- "/users/{id}/password": {
19137
- /**
19138
- * Updates a user's password with a specified new password.
19139
- * This operation also ensures that the current password is correct.
19140
- */
19141
- post: operations["PostUserPasswordChange"];
19142
- parameters: {
19143
- path: {
19144
- /** ID of the resource. */
19145
- id: usersComponents["parameters"]["resourceId"];
19146
- };
19147
- };
19148
- };
19149
- "/users/{id}/totp-reset": {
19150
- /** Resets and renews a TOTP secret with a specified user ID. */
19151
- post: operations["PostUserTotpReset"];
19152
- parameters: {
19153
- path: {
19154
- /** ID of the resource. */
19155
- id: usersComponents["parameters"]["resourceId"];
19156
- };
19157
- };
19158
- };
19159
19285
  "/webhooks": {
19160
19286
  /** Retrieves a list of webhooks. */
19161
19287
  get: operations["GetWebhookCollection"];
@@ -24493,6 +24619,11 @@ export interface usersComponents {
24493
24619
  * This option is only applicable when `useHostedCheckoutForm` is enabled.
24494
24620
  */
24495
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;
24496
24627
  };
24497
24628
  };
24498
24629
  /** Payeezy gateway configuration. */
@@ -26374,11 +26505,11 @@ export interface usersComponents {
26374
26505
  * This value is used for reports.
26375
26506
  */
26376
26507
  reportingCurrency?: string;
26377
- /** Specifies if two-factor authentification is enabled for the user. */
26508
+ /** Specifies if two-factor authentication is enabled for the user. */
26378
26509
  totpRequired?: boolean;
26379
- /** 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. */
26380
26511
  totpSecret?: string;
26381
- /** 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. */
26382
26513
  totpUrl?: string;
26383
26514
  /**
26384
26515
  * One-time password generated by Google Authenticator.
@@ -26426,88 +26557,6 @@ export interface usersComponents {
26426
26557
  rel?: "self" | "enrollment";
26427
26558
  }[];
26428
26559
  };
26429
- UpdatePassword: {
26430
- /** User's current password. This value is used to request a password change. */
26431
- currentPassword: string;
26432
- /** User's new password. This value replaces the existing password. */
26433
- newPassword: string;
26434
- };
26435
- ResetPasswordTokenInfo: {
26436
- /** ID of the token. */
26437
- id?: string;
26438
- /** Token string. */
26439
- token?: string;
26440
- /** Date and time when the token is created and sent. */
26441
- sentTime?: usersComponents["schemas"]["ServerTimestamp"];
26442
- _links?: usersComponents["schemas"]["SelfLink"];
26443
- };
26444
- ResetPassword: {
26445
- /** New account password. */
26446
- newPassword: string;
26447
- };
26448
- User: {
26449
- /** ID of the user. */
26450
- id?: usersComponents["schemas"]["ResourceId"];
26451
- /** Email address of the user. */
26452
- email: string;
26453
- /** User's first name. */
26454
- firstName: string;
26455
- /** User's last name. */
26456
- lastName: string;
26457
- /** User's business phone number. */
26458
- businessPhone?: string;
26459
- /** User's mobile phone number. */
26460
- mobilePhone?: string;
26461
- /**
26462
- * User's password.
26463
- * If this value is not provided, a password reset email is sent.
26464
- */
26465
- password?: string;
26466
- /**
26467
- * Permissions that the user has within organizations.
26468
- * Use the wildcard character `*` for full access.
26469
- */
26470
- permissions?: usersComponents["schemas"]["AclPermissions"];
26471
- /** All user permissions and roles. Use these permissions to emulate the user. */
26472
- computedPermissions?: usersComponents["schemas"]["AclPermissions"];
26473
- createdTime?: usersComponents["schemas"]["CreatedTime"];
26474
- updatedTime?: usersComponents["schemas"]["UpdatedTime"];
26475
- /** Date and time when the user last logged in. */
26476
- loginTime?: usersComponents["schemas"]["ServerTimestamp"];
26477
- /**
26478
- * User's currency code in ISO 4217 format.
26479
- * This value is used for reports.
26480
- */
26481
- reportingCurrency?: string;
26482
- /** Array of reporting currencies that are enabled for the merchant. */
26483
- availableCurrencies?: string[];
26484
- /** Specifies if two-factor authentification is enabled for the user. */
26485
- totpRequired?: boolean;
26486
- /** User's Time-based One-Time Password (TOTP) key for the authentification application, if TOTP is enabled.. */
26487
- totpSecret?: string;
26488
- /** QR-code link that redirects the user to the authentification application, if TOTP is enabled. */
26489
- totpUrl?: string;
26490
- /** Status of the user's account. */
26491
- status?: "active" | "inactive" | "pending-confirmation";
26492
- /**
26493
- * User's country of residence in ISO 3166 alpha-2 country code.
26494
- * For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/).
26495
- */
26496
- country?: string;
26497
- /**
26498
- * User preferences, such as: timezone, language, and more.
26499
- * This is an object with custom properties.
26500
- */
26501
- preferences?: { [key: string]: any };
26502
- /**
26503
- * Role IDs associated with the user.
26504
- * Role IDs specify the roles that the user performs within the organization.
26505
- * For example, the user may be an organization admin.
26506
- */
26507
- roleIds?: string[];
26508
- allowedIps?: usersComponents["schemas"]["AllowedIps"];
26509
- _links?: usersComponents["schemas"]["SelfLink"];
26510
- };
26511
26560
  Role: {
26512
26561
  id?: usersComponents["schemas"]["ResourceId"];
26513
26562
  /** Name of the user role. */
@@ -26585,6 +26634,69 @@ export interface usersComponents {
26585
26634
  reportingCurrency: string;
26586
26635
  questionnaire?: usersComponents["schemas"]["OrganizationQuestionnaire"];
26587
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
+ };
26588
26700
  Status: {
26589
26701
  /**
26590
26702
  * Status of the Rebilly API.
@@ -26692,11 +26804,11 @@ export interface usersComponents {
26692
26804
  /** Various theme settings used in the cashier form. */
26693
26805
  theme?: {
26694
26806
  /** Primary color for the cashier form in hexadecimal format. */
26695
- colorPrimary: string;
26807
+ colorPrimary?: string | null;
26696
26808
  /** Secondary color for the cashier form in hexadecimal format. */
26697
- colorSecondary: string;
26809
+ colorSecondary?: string | null;
26698
26810
  /** Submit button template. `{{amount}}` can be used as a placeholder for amount and currency. */
26699
- buttonTemplate?: string;
26811
+ buttonTemplate?: string | null;
26700
26812
  } | null;
26701
26813
  };
26702
26814
  /** Payment form settings. */
@@ -26947,11 +27059,6 @@ export interface usersComponents {
26947
27059
  "application/json": usersComponents["schemas"]["GlobalWebhook"];
26948
27060
  };
26949
27061
  };
26950
- UpdatePassword: {
26951
- content: {
26952
- "application/json": usersComponents["schemas"]["UpdatePassword"];
26953
- };
26954
- };
26955
27062
  /** User resource. */
26956
27063
  User: {
26957
27064
  content: {
@@ -31298,81 +31405,6 @@ export interface operations {
31298
31405
  404: usersComponents["responses"]["NotFound"];
31299
31406
  };
31300
31407
  };
31301
- /**
31302
- * Updates a user's password with a specified new password.
31303
- * This operation also ensures that the current password is correct.
31304
- */
31305
- PostProfilePasswordChange: {
31306
- responses: {
31307
- /** Password updated. */
31308
- 201: {
31309
- headers: {};
31310
- content: {
31311
- "application/json": usersComponents["schemas"]["Profile"];
31312
- };
31313
- };
31314
- 401: usersComponents["responses"]["Unauthorized"];
31315
- 403: usersComponents["responses"]["Forbidden"];
31316
- 404: usersComponents["responses"]["NotFound"];
31317
- 422: usersComponents["responses"]["ValidationError"];
31318
- };
31319
- requestBody: usersComponents["requestBodies"]["UpdatePassword"];
31320
- };
31321
- /** Resets and renews a Time-Based One-Time Password or (TOTP) secret key. */
31322
- PostProfileTotpReset: {
31323
- responses: {
31324
- /** TOTP secret reset and renewed. */
31325
- 201: {
31326
- headers: {};
31327
- content: {
31328
- "application/json": usersComponents["schemas"]["Profile"];
31329
- };
31330
- };
31331
- 404: usersComponents["responses"]["NotFound"];
31332
- };
31333
- };
31334
- /** Retrieves information for a specified token. */
31335
- GetPasswordResetToken: {
31336
- parameters: {
31337
- path: {
31338
- /** Token string. */
31339
- token: string;
31340
- };
31341
- };
31342
- responses: {
31343
- /** Token retrieved. */
31344
- 200: {
31345
- content: {
31346
- "application/json": usersComponents["schemas"]["ResetPasswordTokenInfo"];
31347
- };
31348
- };
31349
- 404: usersComponents["responses"]["NotFound"];
31350
- };
31351
- };
31352
- /** Resets a user's account password. */
31353
- PostPasswordReset: {
31354
- parameters: {
31355
- path: {
31356
- /** Token string. */
31357
- token: string;
31358
- };
31359
- };
31360
- responses: {
31361
- /** Password reset. */
31362
- 201: {
31363
- headers: {};
31364
- content: {
31365
- "application/json": usersComponents["schemas"]["User"];
31366
- };
31367
- };
31368
- 422: usersComponents["responses"]["ValidationError"];
31369
- };
31370
- requestBody: {
31371
- content: {
31372
- "application/json": usersComponents["schemas"]["ResetPassword"];
31373
- };
31374
- };
31375
- };
31376
31408
  /** Retrieves a list of user roles. */
31377
31409
  GetRoleCollection: {
31378
31410
  parameters: {
@@ -31885,51 +31917,6 @@ export interface operations {
31885
31917
  404: usersComponents["responses"]["NotFound"];
31886
31918
  };
31887
31919
  };
31888
- /**
31889
- * Updates a user's password with a specified new password.
31890
- * This operation also ensures that the current password is correct.
31891
- */
31892
- PostUserPasswordChange: {
31893
- parameters: {
31894
- path: {
31895
- /** ID of the resource. */
31896
- id: usersComponents["parameters"]["resourceId"];
31897
- };
31898
- };
31899
- responses: {
31900
- /** Password updated. */
31901
- 201: {
31902
- headers: {};
31903
- content: {
31904
- "application/json": usersComponents["schemas"]["User"];
31905
- };
31906
- };
31907
- 401: usersComponents["responses"]["Unauthorized"];
31908
- 403: usersComponents["responses"]["Forbidden"];
31909
- 404: usersComponents["responses"]["NotFound"];
31910
- 422: usersComponents["responses"]["ValidationError"];
31911
- };
31912
- requestBody: usersComponents["requestBodies"]["UpdatePassword"];
31913
- };
31914
- /** Resets and renews a TOTP secret with a specified user ID. */
31915
- PostUserTotpReset: {
31916
- parameters: {
31917
- path: {
31918
- /** ID of the resource. */
31919
- id: usersComponents["parameters"]["resourceId"];
31920
- };
31921
- };
31922
- responses: {
31923
- /** TOTP secret reset and renewed. */
31924
- 201: {
31925
- headers: {};
31926
- content: {
31927
- "application/json": usersComponents["schemas"]["User"];
31928
- };
31929
- };
31930
- 404: usersComponents["responses"]["NotFound"];
31931
- };
31932
- };
31933
31920
  /** Retrieves a list of webhooks. */
31934
31921
  GetWebhookCollection: {
31935
31922
  parameters: {
@@ -32944,36 +32931,36 @@ export interface storefrontComponents {
32944
32931
  * Category of the lead source traffic.
32945
32932
  * For example, the medium could be organic search, Google ads, Display ads, and so on.
32946
32933
  */
32947
- medium?: string;
32934
+ medium?: string | null;
32948
32935
  /** Domain, platform, or channel from which the lead source originates. */
32949
- source?: string;
32936
+ source?: string | null;
32950
32937
  /** Campaign name of the lead source. */
32951
- campaign?: string;
32938
+ campaign?: string | null;
32952
32939
  /** Term associated with a lead source. */
32953
- term?: string;
32940
+ term?: string | null;
32954
32941
  /**
32955
32942
  * Content contained in the lead source content.
32956
32943
  * For example, content could be graphics, video, and so on.
32957
32944
  */
32958
- content?: string;
32945
+ content?: string | null;
32959
32946
  /** Individual or entity that is affilated with the lead source. */
32960
- affiliate?: string;
32947
+ affiliate?: string | null;
32961
32948
  /**
32962
32949
  * Individual or entity that is associated with a lead source affiliate.
32963
32950
  * In other products, this field may also be referred to as sub ID or click ID in some.
32964
32951
  */
32965
- subAffiliate?: string;
32952
+ subAffiliate?: string | null;
32966
32953
  /** Name of the sales agent associated with the lead source. */
32967
- salesAgent?: string;
32954
+ salesAgent?: string | null;
32968
32955
  /**
32969
32956
  * ID of the lead source click.
32970
32957
  * This value is passed in the ad click URL for tracking and campaign attribution.
32971
32958
  */
32972
- clickId?: string;
32959
+ clickId?: string | null;
32973
32960
  /** URL from which the lead source originates. */
32974
- path?: string;
32961
+ path?: string | null;
32975
32962
  /** Lead source [`referrer` URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer). */
32976
- referrer?: string;
32963
+ referrer?: string | null;
32977
32964
  createdTime?: storefrontComponents["schemas"]["CreatedTime"];
32978
32965
  updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
32979
32966
  /** Related links. */
@@ -34875,6 +34862,18 @@ export interface storefrontComponents {
34875
34862
  redirectUrl?: string;
34876
34863
  /** Date and time at which the cashier request expires. The default expiration time is one hour from the time the request is created. */
34877
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 };
34878
34877
  createdTime?: storefrontComponents["schemas"]["CreatedTime"];
34879
34878
  updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
34880
34879
  /** Related links. */
@@ -35093,11 +35092,11 @@ export interface storefrontComponents {
35093
35092
  /** Various theme settings used in the cashier form. */
35094
35093
  theme?: {
35095
35094
  /** Primary color for the cashier form in hexadecimal format. */
35096
- colorPrimary: string;
35095
+ colorPrimary?: string | null;
35097
35096
  /** Secondary color for the cashier form in hexadecimal format. */
35098
- colorSecondary: string;
35097
+ colorSecondary?: string | null;
35099
35098
  /** Submit button template. `{{amount}}` can be used as a placeholder for amount and currency. */
35100
- buttonTemplate?: string;
35099
+ buttonTemplate?: string | null;
35101
35100
  } | null;
35102
35101
  };
35103
35102
  /** Payment form settings. */
@@ -35983,6 +35982,8 @@ export interface storefrontComponents {
35983
35982
  cashierRequestId: string;
35984
35983
  /** Deposit amount. */
35985
35984
  amount: number;
35985
+ /** Properties completed by the user in the deposit form. */
35986
+ properties?: { [key: string]: string };
35986
35987
  };
35987
35988
  };
35988
35989
  };
@@ -39596,6 +39597,10 @@ export interface operations {
39596
39597
  periodStart: string;
39597
39598
  /** Date and time when the report ends. */
39598
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"];
39599
39604
  };
39600
39605
  };
39601
39606
  responses: {
@@ -40096,6 +40101,24 @@ declare module "resources/broadcast-messages-resource" {
40096
40101
  }): any;
40097
40102
  };
40098
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
+ }
40099
40122
  declare module "resources/cashier-requests-resource" {
40100
40123
  export default function CashierRequestsResource({ apiHandler }: {
40101
40124
  apiHandler: any;
@@ -41284,10 +41307,6 @@ declare module "resources/profile-resource" {
41284
41307
  getMfa(): rebilly.GetProfileMfaResponsePromise;
41285
41308
  updateMfa(): any;
41286
41309
  deleteMfa(): any;
41287
- updatePassword({ data }: {
41288
- data: any;
41289
- }): any;
41290
- resetTotp(): any;
41291
41310
  };
41292
41311
  }
41293
41312
  declare module "resources/purchase-resource" {
@@ -41675,13 +41694,6 @@ declare module "resources/users-resource" {
41675
41694
  export default function UsersResource({ apiHandler }: {
41676
41695
  apiHandler: any;
41677
41696
  }): {
41678
- getResetPasswordToken({ token }: {
41679
- token: any;
41680
- }): rebilly.GetPasswordResetTokenResponsePromise;
41681
- resetPassword({ token, data }: {
41682
- token: any;
41683
- data: any;
41684
- }): any;
41685
41697
  getAll({ limit, offset, sort, filter, q, }?: rebilly.GetUserCollectionRequest): rebilly.GetUserCollectionResponsePromise;
41686
41698
  create({ id, data }: rebilly.CreateUserRequest): rebilly.PostUserResponsePromise;
41687
41699
  get({ id }: {
@@ -41694,13 +41706,6 @@ declare module "resources/users-resource" {
41694
41706
  getMfa({ id }: {
41695
41707
  id: any;
41696
41708
  }): rebilly.GetUserMfaResponsePromise;
41697
- updatePassword({ id, data }: {
41698
- id: any;
41699
- data: any;
41700
- }): any;
41701
- resetTotp({ id }: {
41702
- id: any;
41703
- }): any;
41704
41709
  };
41705
41710
  }
41706
41711
  declare module "resources/webhooks-resource" {
@@ -41906,6 +41911,25 @@ declare module "resources/api-instance" {
41906
41911
  data: any;
41907
41912
  }): any;
41908
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
+ };
41909
41933
  cashierRequests: {
41910
41934
  getAll({ limit, offset, filter, sort }?: {
41911
41935
  limit?: number;
@@ -43156,10 +43180,6 @@ declare module "resources/api-instance" {
43156
43180
  getMfa(): rebilly.GetProfileMfaResponsePromise;
43157
43181
  updateMfa(): any;
43158
43182
  deleteMfa(): any;
43159
- updatePassword({ data }: {
43160
- data: any;
43161
- }): any;
43162
- resetTotp(): any;
43163
43183
  };
43164
43184
  purchase: {
43165
43185
  readyToPay({ data }: {
@@ -43559,13 +43579,6 @@ declare module "resources/api-instance" {
43559
43579
  }): any;
43560
43580
  };
43561
43581
  users: {
43562
- getResetPasswordToken({ token }: {
43563
- token: any;
43564
- }): rebilly.GetPasswordResetTokenResponsePromise;
43565
- resetPassword({ token, data }: {
43566
- token: any;
43567
- data: any;
43568
- }): any;
43569
43582
  getAll({ limit, offset, sort, filter, q, }?: {
43570
43583
  limit?: number;
43571
43584
  offset?: number;
@@ -43584,13 +43597,6 @@ declare module "resources/api-instance" {
43584
43597
  getMfa({ id }: {
43585
43598
  id: any;
43586
43599
  }): rebilly.GetUserMfaResponsePromise;
43587
- updatePassword({ id, data }: {
43588
- id: any;
43589
- data: any;
43590
- }): any;
43591
- resetTotp({ id }: {
43592
- id: any;
43593
- }): any;
43594
43600
  };
43595
43601
  webhooks: {
43596
43602
  getAll({ limit, offset, filter }?: {
@@ -43833,11 +43839,13 @@ declare module "resources/experimental/reports-resource" {
43833
43839
  limit?: any;
43834
43840
  offset?: any;
43835
43841
  }): rebilly.GetSubscriptionRenewalReportResponsePromise;
43836
- getTimeSeriesTransaction({ type, subaggregate, periodStart, periodEnd }: {
43842
+ getTimeSeriesTransaction({ type, subaggregate, periodStart, periodEnd, limit, offset, }: {
43837
43843
  type: any;
43838
43844
  subaggregate: any;
43839
43845
  periodStart: any;
43840
43846
  periodEnd: any;
43847
+ limit?: any;
43848
+ offset?: any;
43841
43849
  }): rebilly.GetTimeSeriesTransactionReportResponsePromise;
43842
43850
  getTransactionsTimeDispute({ aggregationField, periodStart, periodEnd, limit, offset, filter, }: {
43843
43851
  aggregationField: any;
@@ -44079,11 +44087,13 @@ declare module "resources/experimental/experimental-resources" {
44079
44087
  limit?: any;
44080
44088
  offset?: any;
44081
44089
  }): rebilly.GetSubscriptionRenewalReportResponsePromise;
44082
- getTimeSeriesTransaction({ type, subaggregate, periodStart, periodEnd }: {
44090
+ getTimeSeriesTransaction({ type, subaggregate, periodStart, periodEnd, limit, offset, }: {
44083
44091
  type: any;
44084
44092
  subaggregate: any;
44085
44093
  periodStart: any;
44086
44094
  periodEnd: any;
44095
+ limit?: any;
44096
+ offset?: any;
44087
44097
  }): rebilly.GetTimeSeriesTransactionReportResponsePromise;
44088
44098
  getTransactionsTimeDispute({ aggregationField, periodStart, periodEnd, limit, offset, filter, }: {
44089
44099
  aggregationField: any;