rebilly-js-sdk 62.243.6 → 62.244.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.
package/CHANGELOG.md CHANGED
@@ -1,3 +1,3 @@
1
- ## 62.243.6 (2026-11-03)
1
+ ## 62.244.0 (2026-11-03)
2
2
 
3
3
  This was a version bump only for rebilly-js-sdk to align it with other projects, there were no code changes.
@@ -592,6 +592,11 @@ declare namespace rebilly {
592
592
  type PutKycSettingsResponse = operations['PutKycSettings']['responses']['200']['content']['application/json']
593
593
  type PutKycSettingsResponsePromise = Promise<{fields: PutKycSettingsResponse}>
594
594
 
595
+ type PostResolveScopedKycSettingsRequest = operations['PostResolveScopedKycSettings']['requestBody']['content']['application/json']
596
+ type CreateResolveScopedKycSettingsRequest = { id?: string, data: PostResolveScopedKycSettingsRequest, expand?: string }
597
+ type PostResolveScopedKycSettingsResponse = operations['PostResolveScopedKycSettings']['responses']['200']['content']['application/json']
598
+ type PostResolveScopedKycSettingsResponsePromise = Promise<{fields: PostResolveScopedKycSettingsResponse}>
599
+
595
600
  type GetPasswordTokenCollectionRequest = operations['GetPasswordTokenCollection']['parameters']["query"] & (operations['GetPasswordTokenCollection']['parameters'] extends {path: {}} ? operations['GetPasswordTokenCollection']['parameters']["path"] : {})
596
601
 
597
602
  type GetPasswordTokenCollectionResponse = operations['GetPasswordTokenCollection']['responses']['200']['content']['application/json'][0]
@@ -3561,6 +3566,13 @@ export interface corePaths {
3561
3566
  /** Updates KYC settings. */
3562
3567
  put: operations["PutKycSettings"];
3563
3568
  };
3569
+ "/kyc-settings/resolve-scoped-settings": {
3570
+ /**
3571
+ * Resolves document subtype restrictions for a website.
3572
+ * When `documents` are provided, the response contains restrictions that match the document types, subtypes, and face proof requirements.
3573
+ */
3574
+ post: operations["PostResolveScopedKycSettings"];
3575
+ };
3564
3576
  "/password-tokens": {
3565
3577
  /** Retrieves a list of reset password tokens. */
3566
3578
  get: operations["GetPasswordTokenCollection"];
@@ -10364,6 +10376,20 @@ export interface coreComponents {
10364
10376
  };
10365
10377
  /** Document verification level. */
10366
10378
  KycDocumentMatchLevels: 1 | 2 | 3;
10379
+ /**
10380
+ * Document subtypes that are prohibited for `identityProof`, `addressProof`, `fundsProof`, and `purchaseProof`.
10381
+ * This object does not include `credit-file-proof` because it has no subtypes.
10382
+ */
10383
+ KycSubtypeRestrictions: {
10384
+ /** Prohibited subtypes of proof of identity. */
10385
+ identityProof?: string[];
10386
+ /** Prohibited subtypes of proof of address. */
10387
+ addressProof?: string[];
10388
+ /** Prohibited subtypes of proof of funds. */
10389
+ fundsProof?: string[];
10390
+ /** Prohibited subtypes of proof of purchase. */
10391
+ purchaseProof?: string[];
10392
+ };
10367
10393
  /** KYC request information. */
10368
10394
  KycRequest: {
10369
10395
  /** ID of the KYC request. */
@@ -10406,6 +10432,10 @@ export interface coreComponents {
10406
10432
  * Use this value when analyzing webhook data to determine if a change must take precedence over the current representation.
10407
10433
  */
10408
10434
  revision?: number;
10435
+ /** Document subtypes that are prohibited for this KYC request. */
10436
+ subtypeRestrictions?: coreComponents["schemas"]["KycSubtypeRestrictions"];
10437
+ /** Specifies if the KYC document gatherer displays guidance about prohibited document subtypes. */
10438
+ subtypeRestrictionUiEnabled?: boolean;
10409
10439
  /**
10410
10440
  * Date and time when the request expires.
10411
10441
  * The default value is one hour in the future.
@@ -10433,6 +10463,7 @@ export interface coreComponents {
10433
10463
  | "document-not-matching"
10434
10464
  | "document-duplicate"
10435
10465
  | "document-invalid"
10466
+ | "document-subtype-prohibited"
10436
10467
  | "document-not-open"
10437
10468
  | "underage-person"
10438
10469
  | "third-party-or-mismatch"
@@ -11312,13 +11343,110 @@ export interface coreComponents {
11312
11343
  */
11313
11344
  type: "funds-proof";
11314
11345
  } & coreComponents["schemas"]["FundsMatches"];
11346
+ /** Conditions that determine when a document subtype is prohibited. */
11347
+ KycProhibitedSubtypeCondition: {
11348
+ /**
11349
+ * Specifies if the restriction depends on face proof being required for the KYC request.
11350
+ * Use `true` if face proof is required, or `false` if it is not required.
11351
+ */
11352
+ faceProofRequired: boolean;
11353
+ };
11354
+ /**
11355
+ * Restriction for a prohibited document subtype.
11356
+ * If this object is empty, the document subtype is always prohibited.
11357
+ * If `when` is not specified, the restriction applies unconditionally.
11358
+ */
11359
+ KycProhibitedSubtypeRule: {
11360
+ when?: coreComponents["schemas"]["KycProhibitedSubtypeCondition"];
11361
+ };
11362
+ /**
11363
+ * Map of prohibited document subtypes for a type of KYC document.
11364
+ * Each key must be a subtype of the specified document type.
11365
+ * Use an empty object to accept all document subtypes.
11366
+ */
11367
+ KycProhibitedSubtypes: {
11368
+ [key: string]: coreComponents["schemas"]["KycProhibitedSubtypeRule"];
11369
+ };
11370
+ /** Settings for a type of KYC document. */
11371
+ ScopedKycSettingsProofBlock: {
11372
+ prohibitedSubtypes?: coreComponents["schemas"]["KycProhibitedSubtypes"];
11373
+ };
11374
+ /**
11375
+ * Document subtype restrictions that override the organization-level restrictions for a group of websites.
11376
+ * Website IDs must identify websites associated with the organization.
11377
+ * Each website ID can appear in only one override.
11378
+ * Proof types are `identityProof`, `addressProof`, `fundsProof`, and `purchaseProof`.
11379
+ * This object does not include `credit-file-proof` because it has no subtypes.
11380
+ * For each proof type, `prohibitedSubtypes` overrides the organization value.
11381
+ * If `prohibitedSubtypes` is omitted, the proof type inherits the organization value.
11382
+ * Use an empty `prohibitedSubtypes` object to accept all subtypes for the websites.
11383
+ */
11384
+ ScopedKycSettingsWebsiteOverride: {
11385
+ /** IDs of websites where the override applies. */
11386
+ websiteIds: coreComponents["schemas"]["WebsiteId"][];
11387
+ identityProof?: coreComponents["schemas"]["ScopedKycSettingsProofBlock"];
11388
+ addressProof?: coreComponents["schemas"]["ScopedKycSettingsProofBlock"];
11389
+ fundsProof?: coreComponents["schemas"]["ScopedKycSettingsProofBlock"];
11390
+ purchaseProof?: coreComponents["schemas"]["ScopedKycSettingsProofBlock"];
11391
+ };
11392
+ /**
11393
+ * Document subtype restrictions for an organization and the websites associated with it.
11394
+ * Proof type keys are `identityProof`, `addressProof`, `fundsProof`, and `purchaseProof`.
11395
+ * This object does not include `credit-file-proof` because it has no subtypes.
11396
+ * Restrictions at the organization level apply by default.
11397
+ * A website overrides the organization restrictions for a proof type when `prohibitedSubtypes` is specified.
11398
+ */
11399
+ ScopedKycSettings: {
11400
+ identityProof?: coreComponents["schemas"]["ScopedKycSettingsProofBlock"];
11401
+ addressProof?: coreComponents["schemas"]["ScopedKycSettingsProofBlock"];
11402
+ fundsProof?: coreComponents["schemas"]["ScopedKycSettingsProofBlock"];
11403
+ purchaseProof?: coreComponents["schemas"]["ScopedKycSettingsProofBlock"];
11404
+ /**
11405
+ * Document subtype restrictions that override subtype restrictions for selected websites.
11406
+ * Each website ID can appear in only one override.
11407
+ */
11408
+ websiteOverrides?: coreComponents["schemas"]["ScopedKycSettingsWebsiteOverride"][];
11409
+ };
11315
11410
  /** Settings for KYC score calculation. */
11316
11411
  KycSettings: {
11317
11412
  identityProof?: coreComponents["schemas"]["KycSettingsIdentity"];
11318
11413
  addressProof?: coreComponents["schemas"]["KycSettingsAddress"];
11414
+ /**
11415
+ * Document subtype restrictions for the organization and its websites.
11416
+ * When updating KYC settings, this object replaces the existing scoped KYC settings.
11417
+ * If this field is omitted, the existing scoped KYC settings do not change.
11418
+ * Use `null` to remove all scoped KYC settings.
11419
+ */
11420
+ scopedKycSettings?: coreComponents["schemas"]["ScopedKycSettings"] | null;
11319
11421
  /** Version of the KYC document gatherer UI. */
11320
11422
  uiVersion?: ("1" | "2") | null;
11321
11423
  };
11424
+ /** KYC document settings that are used to evaluate document subtype restrictions. */
11425
+ ResolveScopedKycSettingsDocument: {
11426
+ /** Type of KYC document. */
11427
+ type: coreComponents["schemas"]["KycDocumentTypes"];
11428
+ /**
11429
+ * Document subtypes to evaluate for restrictions.
11430
+ * If omitted, all configured restrictions for the document type are evaluated.
11431
+ */
11432
+ subtypes?: string[];
11433
+ /** Specifies if the customer must provide proof of their face with the KYC document. */
11434
+ faceProofRequired?: boolean;
11435
+ };
11436
+ /** Information that is used to evaluate document subtype restrictions for a website. */
11437
+ ResolveScopedKycSettingsRequest: {
11438
+ websiteId: coreComponents["schemas"]["WebsiteId"];
11439
+ /**
11440
+ * KYC document settings to evaluate for subtype restrictions.
11441
+ * If omitted or empty, the response contains only unconditional restrictions for all configured document types.
11442
+ */
11443
+ documents?: coreComponents["schemas"]["ResolveScopedKycSettingsDocument"][];
11444
+ };
11445
+ /** Result of evaluating document subtype restrictions for a website. */
11446
+ ResolveScopedKycSettingsResponse: {
11447
+ /** Document subtype restrictions that match the request. */
11448
+ subtypeRestrictions: coreComponents["schemas"]["KycSubtypeRestrictions"];
11449
+ };
11322
11450
  ResetPasswordToken: {
11323
11451
  /** ID of the token. */
11324
11452
  token?: string;
@@ -26977,6 +27105,10 @@ export interface coreComponents {
26977
27105
  * Example: `https://example.com?info=success`.
26978
27106
  */
26979
27107
  redirectUrl?: string;
27108
+ /** Document subtypes that are prohibited for this KYC request. */
27109
+ subtypeRestrictions?: coreComponents["schemas"]["KycSubtypeRestrictions"];
27110
+ /** Specifies if the KYC document gatherer displays guidance about prohibited document subtypes. */
27111
+ subtypeRestrictionUiEnabled?: boolean;
26980
27112
  /**
26981
27113
  * Date and time when the request expires.
26982
27114
  * The default value is one hour in the future.
@@ -29229,6 +29361,13 @@ export interface coreComponents {
29229
29361
  invoiceCollectionLimit: number;
29230
29362
  /** Type of response media. */
29231
29363
  mediaTypeJsonPdf: "application/json" | "application/pdf";
29364
+ /**
29365
+ * Maximum number of orders to return.
29366
+ * To return an empty collection with the total number of matching orders in `Pagination-Total`, use `0`.
29367
+ * If `expand` includes `activationInvoice`, `recentInvoice`, or `upcomingInvoice`,
29368
+ * a maximum of `100` orders is returned.
29369
+ */
29370
+ orderCollectionLimit: number;
29232
29371
  /**
29233
29372
  * Expand a response to receive a full related object in the `_embedded` path.
29234
29373
  *
@@ -35771,6 +35910,7 @@ export interface operations {
35771
35910
  401: coreComponents["responses"]["Unauthorized"];
35772
35911
  403: coreComponents["responses"]["Forbidden"];
35773
35912
  404: coreComponents["responses"]["NotFound"];
35913
+ 422: coreComponents["responses"]["ValidationError"];
35774
35914
  429: coreComponents["responses"]["TooManyRequests"];
35775
35915
  };
35776
35916
  /** Settings for KYC analysis. */
@@ -35780,6 +35920,31 @@ export interface operations {
35780
35920
  };
35781
35921
  };
35782
35922
  };
35923
+ /**
35924
+ * Resolves document subtype restrictions for a website.
35925
+ * When `documents` are provided, the response contains restrictions that match the document types, subtypes, and face proof requirements.
35926
+ */
35927
+ PostResolveScopedKycSettings: {
35928
+ responses: {
35929
+ /** Scoped KYC settings resolved. */
35930
+ 200: {
35931
+ headers: {};
35932
+ content: {
35933
+ "application/json": coreComponents["schemas"]["ResolveScopedKycSettingsResponse"];
35934
+ };
35935
+ };
35936
+ 401: coreComponents["responses"]["Unauthorized"];
35937
+ 403: coreComponents["responses"]["Forbidden"];
35938
+ 404: coreComponents["responses"]["NotFound"];
35939
+ 422: coreComponents["responses"]["ValidationError"];
35940
+ 429: coreComponents["responses"]["TooManyRequests"];
35941
+ };
35942
+ requestBody: {
35943
+ content: {
35944
+ "application/json": coreComponents["schemas"]["ResolveScopedKycSettingsRequest"];
35945
+ };
35946
+ };
35947
+ };
35783
35948
  /** Retrieves a list of reset password tokens. */
35784
35949
  GetPasswordTokenCollection: {
35785
35950
  parameters: {
@@ -37008,10 +37173,12 @@ export interface operations {
37008
37173
  */
37009
37174
  sort?: coreComponents["parameters"]["collectionSort"];
37010
37175
  /**
37011
- * Limit the number of collection items to be returned.
37012
- * Use `0` to return an empty collection and still receive the count of matching items in `Pagination-Total`.
37176
+ * Maximum number of orders to return.
37177
+ * To return an empty collection with the total number of matching orders in `Pagination-Total`, use `0`.
37178
+ * If `expand` includes `activationInvoice`, `recentInvoice`, or `upcomingInvoice`,
37179
+ * a maximum of `100` orders is returned.
37013
37180
  */
37014
- limit?: coreComponents["parameters"]["collectionLimit"];
37181
+ limit?: coreComponents["parameters"]["orderCollectionLimit"];
37015
37182
  /** Specifies the starting point within the collection of items to be returned. */
37016
37183
  offset?: coreComponents["parameters"]["collectionOffset"];
37017
37184
  /** Use this field to perform a partial search of text fields. */
@@ -50878,6 +51045,20 @@ export interface storefrontComponents {
50878
51045
  };
50879
51046
  /** Document verification level. */
50880
51047
  KycDocumentMatchLevels: 1 | 2 | 3;
51048
+ /**
51049
+ * Document subtypes that are prohibited for `identityProof`, `addressProof`, `fundsProof`, and `purchaseProof`.
51050
+ * This object does not include `credit-file-proof` because it has no subtypes.
51051
+ */
51052
+ KycSubtypeRestrictions: {
51053
+ /** Prohibited subtypes of proof of identity. */
51054
+ identityProof?: string[];
51055
+ /** Prohibited subtypes of proof of address. */
51056
+ addressProof?: string[];
51057
+ /** Prohibited subtypes of proof of funds. */
51058
+ fundsProof?: string[];
51059
+ /** Prohibited subtypes of proof of purchase. */
51060
+ purchaseProof?: string[];
51061
+ };
50881
51062
  /** KYC request information. */
50882
51063
  KycRequest: {
50883
51064
  /** ID of the KYC request. */
@@ -50920,6 +51101,10 @@ export interface storefrontComponents {
50920
51101
  * Use this value when analyzing webhook data to determine if a change must take precedence over the current representation.
50921
51102
  */
50922
51103
  revision?: number;
51104
+ /** Document subtypes that are prohibited for this KYC request. */
51105
+ subtypeRestrictions?: storefrontComponents["schemas"]["KycSubtypeRestrictions"];
51106
+ /** Specifies if the KYC document gatherer displays guidance about prohibited document subtypes. */
51107
+ subtypeRestrictionUiEnabled?: boolean;
50923
51108
  /**
50924
51109
  * Date and time when the request expires.
50925
51110
  * The default value is one hour in the future.
@@ -50947,6 +51132,7 @@ export interface storefrontComponents {
50947
51132
  | "document-not-matching"
50948
51133
  | "document-duplicate"
50949
51134
  | "document-invalid"
51135
+ | "document-subtype-prohibited"
50950
51136
  | "document-not-open"
50951
51137
  | "underage-person"
50952
51138
  | "third-party-or-mismatch"
@@ -51826,13 +52012,110 @@ export interface storefrontComponents {
51826
52012
  */
51827
52013
  type: "funds-proof";
51828
52014
  } & storefrontComponents["schemas"]["FundsMatches"];
52015
+ /** Conditions that determine when a document subtype is prohibited. */
52016
+ KycProhibitedSubtypeCondition: {
52017
+ /**
52018
+ * Specifies if the restriction depends on face proof being required for the KYC request.
52019
+ * Use `true` if face proof is required, or `false` if it is not required.
52020
+ */
52021
+ faceProofRequired: boolean;
52022
+ };
52023
+ /**
52024
+ * Restriction for a prohibited document subtype.
52025
+ * If this object is empty, the document subtype is always prohibited.
52026
+ * If `when` is not specified, the restriction applies unconditionally.
52027
+ */
52028
+ KycProhibitedSubtypeRule: {
52029
+ when?: storefrontComponents["schemas"]["KycProhibitedSubtypeCondition"];
52030
+ };
52031
+ /**
52032
+ * Map of prohibited document subtypes for a type of KYC document.
52033
+ * Each key must be a subtype of the specified document type.
52034
+ * Use an empty object to accept all document subtypes.
52035
+ */
52036
+ KycProhibitedSubtypes: {
52037
+ [key: string]: storefrontComponents["schemas"]["KycProhibitedSubtypeRule"];
52038
+ };
52039
+ /** Settings for a type of KYC document. */
52040
+ ScopedKycSettingsProofBlock: {
52041
+ prohibitedSubtypes?: storefrontComponents["schemas"]["KycProhibitedSubtypes"];
52042
+ };
52043
+ /**
52044
+ * Document subtype restrictions that override the organization-level restrictions for a group of websites.
52045
+ * Website IDs must identify websites associated with the organization.
52046
+ * Each website ID can appear in only one override.
52047
+ * Proof types are `identityProof`, `addressProof`, `fundsProof`, and `purchaseProof`.
52048
+ * This object does not include `credit-file-proof` because it has no subtypes.
52049
+ * For each proof type, `prohibitedSubtypes` overrides the organization value.
52050
+ * If `prohibitedSubtypes` is omitted, the proof type inherits the organization value.
52051
+ * Use an empty `prohibitedSubtypes` object to accept all subtypes for the websites.
52052
+ */
52053
+ ScopedKycSettingsWebsiteOverride: {
52054
+ /** IDs of websites where the override applies. */
52055
+ websiteIds: storefrontComponents["schemas"]["WebsiteId"][];
52056
+ identityProof?: storefrontComponents["schemas"]["ScopedKycSettingsProofBlock"];
52057
+ addressProof?: storefrontComponents["schemas"]["ScopedKycSettingsProofBlock"];
52058
+ fundsProof?: storefrontComponents["schemas"]["ScopedKycSettingsProofBlock"];
52059
+ purchaseProof?: storefrontComponents["schemas"]["ScopedKycSettingsProofBlock"];
52060
+ };
52061
+ /**
52062
+ * Document subtype restrictions for an organization and the websites associated with it.
52063
+ * Proof type keys are `identityProof`, `addressProof`, `fundsProof`, and `purchaseProof`.
52064
+ * This object does not include `credit-file-proof` because it has no subtypes.
52065
+ * Restrictions at the organization level apply by default.
52066
+ * A website overrides the organization restrictions for a proof type when `prohibitedSubtypes` is specified.
52067
+ */
52068
+ ScopedKycSettings: {
52069
+ identityProof?: storefrontComponents["schemas"]["ScopedKycSettingsProofBlock"];
52070
+ addressProof?: storefrontComponents["schemas"]["ScopedKycSettingsProofBlock"];
52071
+ fundsProof?: storefrontComponents["schemas"]["ScopedKycSettingsProofBlock"];
52072
+ purchaseProof?: storefrontComponents["schemas"]["ScopedKycSettingsProofBlock"];
52073
+ /**
52074
+ * Document subtype restrictions that override subtype restrictions for selected websites.
52075
+ * Each website ID can appear in only one override.
52076
+ */
52077
+ websiteOverrides?: storefrontComponents["schemas"]["ScopedKycSettingsWebsiteOverride"][];
52078
+ };
51829
52079
  /** Settings for KYC score calculation. */
51830
52080
  KycSettings: {
51831
52081
  identityProof?: storefrontComponents["schemas"]["KycSettingsIdentity"];
51832
52082
  addressProof?: storefrontComponents["schemas"]["KycSettingsAddress"];
52083
+ /**
52084
+ * Document subtype restrictions for the organization and its websites.
52085
+ * When updating KYC settings, this object replaces the existing scoped KYC settings.
52086
+ * If this field is omitted, the existing scoped KYC settings do not change.
52087
+ * Use `null` to remove all scoped KYC settings.
52088
+ */
52089
+ scopedKycSettings?: storefrontComponents["schemas"]["ScopedKycSettings"] | null;
51833
52090
  /** Version of the KYC document gatherer UI. */
51834
52091
  uiVersion?: ("1" | "2") | null;
51835
52092
  };
52093
+ /** KYC document settings that are used to evaluate document subtype restrictions. */
52094
+ ResolveScopedKycSettingsDocument: {
52095
+ /** Type of KYC document. */
52096
+ type: storefrontComponents["schemas"]["KycDocumentTypes"];
52097
+ /**
52098
+ * Document subtypes to evaluate for restrictions.
52099
+ * If omitted, all configured restrictions for the document type are evaluated.
52100
+ */
52101
+ subtypes?: string[];
52102
+ /** Specifies if the customer must provide proof of their face with the KYC document. */
52103
+ faceProofRequired?: boolean;
52104
+ };
52105
+ /** Information that is used to evaluate document subtype restrictions for a website. */
52106
+ ResolveScopedKycSettingsRequest: {
52107
+ websiteId: storefrontComponents["schemas"]["WebsiteId"];
52108
+ /**
52109
+ * KYC document settings to evaluate for subtype restrictions.
52110
+ * If omitted or empty, the response contains only unconditional restrictions for all configured document types.
52111
+ */
52112
+ documents?: storefrontComponents["schemas"]["ResolveScopedKycSettingsDocument"][];
52113
+ };
52114
+ /** Result of evaluating document subtype restrictions for a website. */
52115
+ ResolveScopedKycSettingsResponse: {
52116
+ /** Document subtype restrictions that match the request. */
52117
+ subtypeRestrictions: storefrontComponents["schemas"]["KycSubtypeRestrictions"];
52118
+ };
51836
52119
  ResetPasswordToken: {
51837
52120
  /** ID of the token. */
51838
52121
  token?: string;
@@ -67491,6 +67774,10 @@ export interface storefrontComponents {
67491
67774
  * Example: `https://example.com?info=success`.
67492
67775
  */
67493
67776
  redirectUrl?: string;
67777
+ /** Document subtypes that are prohibited for this KYC request. */
67778
+ subtypeRestrictions?: storefrontComponents["schemas"]["KycSubtypeRestrictions"];
67779
+ /** Specifies if the KYC document gatherer displays guidance about prohibited document subtypes. */
67780
+ subtypeRestrictionUiEnabled?: boolean;
67494
67781
  /**
67495
67782
  * Date and time when the request expires.
67496
67783
  * The default value is one hour in the future.
@@ -69743,6 +70030,13 @@ export interface storefrontComponents {
69743
70030
  invoiceCollectionLimit: number;
69744
70031
  /** Type of response media. */
69745
70032
  mediaTypeJsonPdf: "application/json" | "application/pdf";
70033
+ /**
70034
+ * Maximum number of orders to return.
70035
+ * To return an empty collection with the total number of matching orders in `Pagination-Total`, use `0`.
70036
+ * If `expand` includes `activationInvoice`, `recentInvoice`, or `upcomingInvoice`,
70037
+ * a maximum of `100` orders is returned.
70038
+ */
70039
+ orderCollectionLimit: number;
69746
70040
  /**
69747
70041
  * Expand a response to receive a full related object in the `_embedded` path.
69748
70042
  *
@@ -78606,6 +78900,20 @@ export interface reportsComponents {
78606
78900
  };
78607
78901
  /** Document verification level. */
78608
78902
  KycDocumentMatchLevels: 1 | 2 | 3;
78903
+ /**
78904
+ * Document subtypes that are prohibited for `identityProof`, `addressProof`, `fundsProof`, and `purchaseProof`.
78905
+ * This object does not include `credit-file-proof` because it has no subtypes.
78906
+ */
78907
+ KycSubtypeRestrictions: {
78908
+ /** Prohibited subtypes of proof of identity. */
78909
+ identityProof?: string[];
78910
+ /** Prohibited subtypes of proof of address. */
78911
+ addressProof?: string[];
78912
+ /** Prohibited subtypes of proof of funds. */
78913
+ fundsProof?: string[];
78914
+ /** Prohibited subtypes of proof of purchase. */
78915
+ purchaseProof?: string[];
78916
+ };
78609
78917
  /** KYC request information. */
78610
78918
  KycRequest: {
78611
78919
  /** ID of the KYC request. */
@@ -78648,6 +78956,10 @@ export interface reportsComponents {
78648
78956
  * Use this value when analyzing webhook data to determine if a change must take precedence over the current representation.
78649
78957
  */
78650
78958
  revision?: number;
78959
+ /** Document subtypes that are prohibited for this KYC request. */
78960
+ subtypeRestrictions?: reportsComponents["schemas"]["KycSubtypeRestrictions"];
78961
+ /** Specifies if the KYC document gatherer displays guidance about prohibited document subtypes. */
78962
+ subtypeRestrictionUiEnabled?: boolean;
78651
78963
  /**
78652
78964
  * Date and time when the request expires.
78653
78965
  * The default value is one hour in the future.
@@ -78675,6 +78987,7 @@ export interface reportsComponents {
78675
78987
  | "document-not-matching"
78676
78988
  | "document-duplicate"
78677
78989
  | "document-invalid"
78990
+ | "document-subtype-prohibited"
78678
78991
  | "document-not-open"
78679
78992
  | "underage-person"
78680
78993
  | "third-party-or-mismatch"
@@ -79554,13 +79867,110 @@ export interface reportsComponents {
79554
79867
  */
79555
79868
  type: "funds-proof";
79556
79869
  } & reportsComponents["schemas"]["FundsMatches"];
79870
+ /** Conditions that determine when a document subtype is prohibited. */
79871
+ KycProhibitedSubtypeCondition: {
79872
+ /**
79873
+ * Specifies if the restriction depends on face proof being required for the KYC request.
79874
+ * Use `true` if face proof is required, or `false` if it is not required.
79875
+ */
79876
+ faceProofRequired: boolean;
79877
+ };
79878
+ /**
79879
+ * Restriction for a prohibited document subtype.
79880
+ * If this object is empty, the document subtype is always prohibited.
79881
+ * If `when` is not specified, the restriction applies unconditionally.
79882
+ */
79883
+ KycProhibitedSubtypeRule: {
79884
+ when?: reportsComponents["schemas"]["KycProhibitedSubtypeCondition"];
79885
+ };
79886
+ /**
79887
+ * Map of prohibited document subtypes for a type of KYC document.
79888
+ * Each key must be a subtype of the specified document type.
79889
+ * Use an empty object to accept all document subtypes.
79890
+ */
79891
+ KycProhibitedSubtypes: {
79892
+ [key: string]: reportsComponents["schemas"]["KycProhibitedSubtypeRule"];
79893
+ };
79894
+ /** Settings for a type of KYC document. */
79895
+ ScopedKycSettingsProofBlock: {
79896
+ prohibitedSubtypes?: reportsComponents["schemas"]["KycProhibitedSubtypes"];
79897
+ };
79898
+ /**
79899
+ * Document subtype restrictions that override the organization-level restrictions for a group of websites.
79900
+ * Website IDs must identify websites associated with the organization.
79901
+ * Each website ID can appear in only one override.
79902
+ * Proof types are `identityProof`, `addressProof`, `fundsProof`, and `purchaseProof`.
79903
+ * This object does not include `credit-file-proof` because it has no subtypes.
79904
+ * For each proof type, `prohibitedSubtypes` overrides the organization value.
79905
+ * If `prohibitedSubtypes` is omitted, the proof type inherits the organization value.
79906
+ * Use an empty `prohibitedSubtypes` object to accept all subtypes for the websites.
79907
+ */
79908
+ ScopedKycSettingsWebsiteOverride: {
79909
+ /** IDs of websites where the override applies. */
79910
+ websiteIds: reportsComponents["schemas"]["WebsiteId"][];
79911
+ identityProof?: reportsComponents["schemas"]["ScopedKycSettingsProofBlock"];
79912
+ addressProof?: reportsComponents["schemas"]["ScopedKycSettingsProofBlock"];
79913
+ fundsProof?: reportsComponents["schemas"]["ScopedKycSettingsProofBlock"];
79914
+ purchaseProof?: reportsComponents["schemas"]["ScopedKycSettingsProofBlock"];
79915
+ };
79916
+ /**
79917
+ * Document subtype restrictions for an organization and the websites associated with it.
79918
+ * Proof type keys are `identityProof`, `addressProof`, `fundsProof`, and `purchaseProof`.
79919
+ * This object does not include `credit-file-proof` because it has no subtypes.
79920
+ * Restrictions at the organization level apply by default.
79921
+ * A website overrides the organization restrictions for a proof type when `prohibitedSubtypes` is specified.
79922
+ */
79923
+ ScopedKycSettings: {
79924
+ identityProof?: reportsComponents["schemas"]["ScopedKycSettingsProofBlock"];
79925
+ addressProof?: reportsComponents["schemas"]["ScopedKycSettingsProofBlock"];
79926
+ fundsProof?: reportsComponents["schemas"]["ScopedKycSettingsProofBlock"];
79927
+ purchaseProof?: reportsComponents["schemas"]["ScopedKycSettingsProofBlock"];
79928
+ /**
79929
+ * Document subtype restrictions that override subtype restrictions for selected websites.
79930
+ * Each website ID can appear in only one override.
79931
+ */
79932
+ websiteOverrides?: reportsComponents["schemas"]["ScopedKycSettingsWebsiteOverride"][];
79933
+ };
79557
79934
  /** Settings for KYC score calculation. */
79558
79935
  KycSettings: {
79559
79936
  identityProof?: reportsComponents["schemas"]["KycSettingsIdentity"];
79560
79937
  addressProof?: reportsComponents["schemas"]["KycSettingsAddress"];
79938
+ /**
79939
+ * Document subtype restrictions for the organization and its websites.
79940
+ * When updating KYC settings, this object replaces the existing scoped KYC settings.
79941
+ * If this field is omitted, the existing scoped KYC settings do not change.
79942
+ * Use `null` to remove all scoped KYC settings.
79943
+ */
79944
+ scopedKycSettings?: reportsComponents["schemas"]["ScopedKycSettings"] | null;
79561
79945
  /** Version of the KYC document gatherer UI. */
79562
79946
  uiVersion?: ("1" | "2") | null;
79563
79947
  };
79948
+ /** KYC document settings that are used to evaluate document subtype restrictions. */
79949
+ ResolveScopedKycSettingsDocument: {
79950
+ /** Type of KYC document. */
79951
+ type: reportsComponents["schemas"]["KycDocumentTypes"];
79952
+ /**
79953
+ * Document subtypes to evaluate for restrictions.
79954
+ * If omitted, all configured restrictions for the document type are evaluated.
79955
+ */
79956
+ subtypes?: string[];
79957
+ /** Specifies if the customer must provide proof of their face with the KYC document. */
79958
+ faceProofRequired?: boolean;
79959
+ };
79960
+ /** Information that is used to evaluate document subtype restrictions for a website. */
79961
+ ResolveScopedKycSettingsRequest: {
79962
+ websiteId: reportsComponents["schemas"]["WebsiteId"];
79963
+ /**
79964
+ * KYC document settings to evaluate for subtype restrictions.
79965
+ * If omitted or empty, the response contains only unconditional restrictions for all configured document types.
79966
+ */
79967
+ documents?: reportsComponents["schemas"]["ResolveScopedKycSettingsDocument"][];
79968
+ };
79969
+ /** Result of evaluating document subtype restrictions for a website. */
79970
+ ResolveScopedKycSettingsResponse: {
79971
+ /** Document subtype restrictions that match the request. */
79972
+ subtypeRestrictions: reportsComponents["schemas"]["KycSubtypeRestrictions"];
79973
+ };
79564
79974
  ResetPasswordToken: {
79565
79975
  /** ID of the token. */
79566
79976
  token?: string;
@@ -95219,6 +95629,10 @@ export interface reportsComponents {
95219
95629
  * Example: `https://example.com?info=success`.
95220
95630
  */
95221
95631
  redirectUrl?: string;
95632
+ /** Document subtypes that are prohibited for this KYC request. */
95633
+ subtypeRestrictions?: reportsComponents["schemas"]["KycSubtypeRestrictions"];
95634
+ /** Specifies if the KYC document gatherer displays guidance about prohibited document subtypes. */
95635
+ subtypeRestrictionUiEnabled?: boolean;
95222
95636
  /**
95223
95637
  * Date and time when the request expires.
95224
95638
  * The default value is one hour in the future.
@@ -97471,6 +97885,13 @@ export interface reportsComponents {
97471
97885
  invoiceCollectionLimit: number;
97472
97886
  /** Type of response media. */
97473
97887
  mediaTypeJsonPdf: "application/json" | "application/pdf";
97888
+ /**
97889
+ * Maximum number of orders to return.
97890
+ * To return an empty collection with the total number of matching orders in `Pagination-Total`, use `0`.
97891
+ * If `expand` includes `activationInvoice`, `recentInvoice`, or `upcomingInvoice`,
97892
+ * a maximum of `100` orders is returned.
97893
+ */
97894
+ orderCollectionLimit: number;
97474
97895
  /**
97475
97896
  * Expand a response to receive a full related object in the `_embedded` path.
97476
97897
  *
@@ -102105,6 +102526,10 @@ declare module "rebilly-js-sdk" {
102105
102526
  export type PutKycSettingsRequest = rebilly.PutKycSettingsRequest;
102106
102527
  export type PutKycSettingsResponse = rebilly.PutKycSettingsResponse;
102107
102528
  export type PutKycSettingsResponsePromise = rebilly.PutKycSettingsResponsePromise;
102529
+ export type PostResolveScopedKycSettingsRequest = rebilly.PostResolveScopedKycSettingsRequest;
102530
+ export type CreateResolveScopedKycSettingsRequest = rebilly.CreateResolveScopedKycSettingsRequest;
102531
+ export type PostResolveScopedKycSettingsResponse = rebilly.PostResolveScopedKycSettingsResponse;
102532
+ export type PostResolveScopedKycSettingsResponsePromise = rebilly.PostResolveScopedKycSettingsResponsePromise;
102108
102533
  export type GetPasswordTokenCollectionRequest = rebilly.GetPasswordTokenCollectionRequest;
102109
102534
  export type GetPasswordTokenCollectionResponse = rebilly.GetPasswordTokenCollectionResponse;
102110
102535
  export type GetPasswordTokenCollectionResponsePromise = rebilly.GetPasswordTokenCollectionResponsePromise;
@@ -104745,6 +105170,9 @@ declare module "resources/kyc-settings-resource" {
104745
105170
  updateKycSettings({ data }: {
104746
105171
  data: any;
104747
105172
  }): rebilly.PutKycSettingsResponsePromise;
105173
+ resolveScopedSettings({ data }: {
105174
+ data: any;
105175
+ }): any;
104748
105176
  };
104749
105177
  }
104750
105178
  declare module "resources/lists-resource" {
@@ -106608,6 +107036,9 @@ declare module "resources/api-instance" {
106608
107036
  updateKycSettings({ data }: {
106609
107037
  data: any;
106610
107038
  }): rebilly.PutKycSettingsResponsePromise;
107039
+ resolveScopedSettings({ data }: {
107040
+ data: any;
107041
+ }): any;
106611
107042
  };
106612
107043
  lists: {
106613
107044
  getAll({ limit, offset, filter, sort, fields, q, }?: rebilly.GetListCollectionRequest): rebilly.GetListCollectionResponsePromise;