rebilly-js-sdk 61.6.0 → 61.7.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,6 +1,6 @@
1
- ## [61.6.0](https://github.com/Rebilly/rebilly/compare/rebilly-js-sdk-v61.5.0...rebilly-js-sdk-v61.6.0) (2025-09-10)
1
+ ## [61.7.0](https://github.com/Rebilly/rebilly/compare/rebilly-js-sdk-v61.6.0...rebilly-js-sdk-v61.7.0) (2025-09-12)
2
2
 
3
3
 
4
4
  ### Features
5
5
 
6
- * **api-metadata, rebilly-js-sdk:** Update resources based on latest api definitions ([#14757](https://github.com/Rebilly/rebilly/issues/14757)) ([a64f312](https://github.com/Rebilly/rebilly/commit/a64f312fd51e42dc9a514d5b99cb338474618172))
6
+ * **api-metadata, rebilly-js-sdk:** Update resources based on latest api definitions ([#14845](https://github.com/Rebilly/rebilly/issues/14845)) ([530dd44](https://github.com/Rebilly/rebilly/commit/530dd44a192412839d5b25e9cc50fec0eea45586))
@@ -1745,25 +1745,16 @@ declare namespace rebilly {
1745
1745
 
1746
1746
  type GetCustomerEddScoreResponse = operations['GetCustomerEddScore']['responses']['200']['content']['application/json']
1747
1747
  type GetCustomerEddScoreResponsePromise = Promise<{fields: GetCustomerEddScoreResponse}>
1748
- type PatchCustomerEddScoreRequest = operations['PatchCustomerEddScore']['requestBody']['content']['application/json']
1749
- type PatchCustomerEddScoreResponse = operations['PatchCustomerEddScore']['responses']['200']['content']['application/json']
1750
- type PatchCustomerEddScoreResponsePromise = Promise<{fields: PatchCustomerEddScoreResponse}>
1751
1748
 
1752
1749
  type GetCustomerEddTimelineCollectionRequest = operations['GetCustomerEddTimelineCollection']['parameters']["query"] & (operations['GetCustomerEddTimelineCollection']['parameters'] extends {path: {}} ? operations['GetCustomerEddTimelineCollection']['parameters']["path"] : {}) & { id: string }
1753
1750
 
1754
1751
  type GetCustomerEddTimelineCollectionResponse = operations['GetCustomerEddTimelineCollection']['responses']['200']['content']['application/json'][0]
1755
1752
  type GetCustomerEddTimelineCollectionResponsePromise = Promise<{ items: {fields: GetCustomerEddTimelineCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
1756
- type PostCustomerEddTimelineRequest = operations['PostCustomerEddTimeline']['requestBody']['content']['application/json']
1757
- type CreateCustomerEddTimelineRequest = { id?: string, data: PostCustomerEddTimelineRequest, expand?: string }
1758
- type PostCustomerEddTimelineResponse = operations['PostCustomerEddTimeline']['responses']['201']['content']['application/json']
1759
- type PostCustomerEddTimelineResponsePromise = Promise<{fields: PostCustomerEddTimelineResponse}>
1760
1753
 
1761
1754
  type GetCustomerEddTimelineRequest = { id: string,messageId: string }
1762
1755
 
1763
1756
  type GetCustomerEddTimelineResponse = operations['GetCustomerEddTimeline']['responses']['200']['content']['application/json']
1764
1757
  type GetCustomerEddTimelineResponsePromise = Promise<{fields: GetCustomerEddTimelineResponse}>
1765
- type DeleteCustomerEddTimelineResponse = operations['DeleteCustomerEddTimeline']['responses']['204']
1766
- type DeleteCustomerEddTimelineResponsePromise = Promise<{fields: DeleteCustomerEddTimelineResponse}>
1767
1758
 
1768
1759
  type GetCustomerEddSearchResultCollectionRequest = operations['GetCustomerEddSearchResultCollection']['parameters']["query"] & (operations['GetCustomerEddSearchResultCollection']['parameters'] extends {path: {}} ? operations['GetCustomerEddSearchResultCollection']['parameters']["path"] : {}) & { id: string }
1769
1760
 
@@ -2348,7 +2339,7 @@ export interface corePaths {
2348
2339
  "/aml-checks/{id}/review": {
2349
2340
  /**
2350
2341
  * Reviews an AML check.
2351
- * The AML check can be either confirmed or marked as a false positive with a customer tag.
2342
+ * The AML check can be either confirmed or marked as a false positive.
2352
2343
  */
2353
2344
  post: operations["PostAmlCheckReview"];
2354
2345
  parameters: {
@@ -5160,8 +5151,6 @@ export interface corePaths {
5160
5151
  "/customers/{id}/edd-score": {
5161
5152
  /** Retrieves an EDD score for a customer with a specified ID. */
5162
5153
  get: operations["GetCustomerEddScore"];
5163
- /** Updates an EDD score for a customer with a specified ID. */
5164
- patch: operations["PatchCustomerEddScore"];
5165
5154
  parameters: {
5166
5155
  path: {
5167
5156
  /** ID of the resource. */
@@ -5172,8 +5161,6 @@ export interface corePaths {
5172
5161
  "/customers/{id}/edd-timeline": {
5173
5162
  /** Retrieves a list of EDD timeline messages. */
5174
5163
  get: operations["GetCustomerEddTimelineCollection"];
5175
- /** Creates an EDD timeline comment. */
5176
- post: operations["PostCustomerEddTimeline"];
5177
5164
  parameters: {
5178
5165
  path: {
5179
5166
  /** ID of the resource. */
@@ -5184,8 +5171,6 @@ export interface corePaths {
5184
5171
  "/customers/{id}/edd-timeline/{messageId}": {
5185
5172
  /** Retrieves an EDD message with a specified ID. */
5186
5173
  get: operations["GetCustomerEddTimeline"];
5187
- /** Deletes an EDD timeline message with a specified ID. */
5188
- delete: operations["DeleteCustomerEddTimeline"];
5189
5174
  parameters: {
5190
5175
  path: {
5191
5176
  /** ID of the resource. */
@@ -5284,28 +5269,6 @@ export interface coreComponents {
5284
5269
  /** Type of link. */
5285
5270
  rel?: "self";
5286
5271
  }[];
5287
- /**
5288
- * Use tags to organize and categorize customers or KYC documents based on keywords.
5289
- * For more information, see [Tags](https://www.rebilly.com/docs/dev-docs/api/tags/).
5290
- */
5291
- Tag: {
5292
- /** ID of the tag. */
5293
- id?: coreComponents["schemas"]["ResourceId"];
5294
- /**
5295
- * Unique name for the tag.
5296
- * Tag names are not case-sensitive.
5297
- */
5298
- name: string;
5299
- /**
5300
- * Type of tag.
5301
- * Tags of a specific type can only be assigned to corresponding entity types.
5302
- * For example, you can only use customer tags on customers.
5303
- */
5304
- type: "customer" | "kyc-document" | "aml-check";
5305
- createdTime?: coreComponents["schemas"]["CreatedTime"];
5306
- updatedTime?: coreComponents["schemas"]["UpdatedTime"];
5307
- _links?: coreComponents["schemas"]["SelfLink"];
5308
- };
5309
5272
  AML: {
5310
5273
  /** First name of the individual, or name of entity. */
5311
5274
  firstName?: string;
@@ -5372,6 +5335,28 @@ export interface coreComponents {
5372
5335
  comments?: string | null;
5373
5336
  _links?: coreComponents["schemas"]["SelfLink"];
5374
5337
  };
5338
+ /**
5339
+ * Use tags to organize and categorize customers or KYC documents based on keywords.
5340
+ * For more information, see [Tags](https://www.rebilly.com/docs/dev-docs/api/tags/).
5341
+ */
5342
+ Tag: {
5343
+ /** ID of the tag. */
5344
+ id?: coreComponents["schemas"]["ResourceId"];
5345
+ /**
5346
+ * Unique name for the tag.
5347
+ * Tag names are not case-sensitive.
5348
+ */
5349
+ name: string;
5350
+ /**
5351
+ * Type of tag.
5352
+ * Tags of a specific type can only be assigned to corresponding entity types.
5353
+ * For example, you can only use customer tags on customers.
5354
+ */
5355
+ type: "customer" | "kyc-document" | "aml-check";
5356
+ createdTime?: coreComponents["schemas"]["CreatedTime"];
5357
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
5358
+ _links?: coreComponents["schemas"]["SelfLink"];
5359
+ };
5375
5360
  /** AML check result. */
5376
5361
  AmlCheck: {
5377
5362
  /** Unique resource ID. */
@@ -5423,8 +5408,6 @@ export interface coreComponents {
5423
5408
  /** Customer's postal code at the time of the AML check. */
5424
5409
  postalCode?: string | null;
5425
5410
  };
5426
- /** List of tags that have been assigned to the customer. */
5427
- tags?: coreComponents["schemas"]["Tag"][];
5428
5411
  /** ID of the customer's organization. */
5429
5412
  organizationId?: string;
5430
5413
  };
@@ -5515,6 +5498,8 @@ export interface coreComponents {
5515
5498
  AmlCheckReview: {
5516
5499
  /** AML-related customer tag. */
5517
5500
  tag?: "aml-match-confirmed" | "aml-match-false-positive";
5501
+ /** Status of the AML check. */
5502
+ status?: "confirmed-match" | "false-positive";
5518
5503
  };
5519
5504
  /** Degree of confidence to assign. */
5520
5505
  AmlConfidence: ("weak" | "medium" | "strong" | "very-strong") | null;
@@ -12360,8 +12345,9 @@ export interface coreComponents {
12360
12345
  * When the delinquency time of an invoice is reached, the order is automatically canceled.
12361
12346
  *
12362
12347
  * {% admonition type="warning" %}
12363
- * If the `delinquencyPeriod` value is `null`, the order does not change state and remains active.
12348
+ * - If the `delinquencyPeriod` value is `null`, the order does not change state and remains active.
12364
12349
  * You must explicitly configure the delinquency period to enable automatic cancellation of unpaid orders.
12350
+ * - If you add a delinquency period to an active order, it is applied to all new invoices created for the order. It is not applied to the unpaid and past-due invoices. To apply a delinquency period to unpaid and past-due invoices, set the `delinquencyTime` parameter using the [upsert an invoice API operation](https://www.rebilly.com/catalog/all/invoices/putinvoice#invoices/putinvoice/t=request&path=delinquencytime).
12365
12351
  * {% /admonition %}
12366
12352
  *
12367
12353
  * If this value is not passed during order creation,
@@ -15882,6 +15868,8 @@ export interface coreComponents {
15882
15868
  transactionType: "01" | "03" | "10" | "11" | "28";
15883
15869
  /** Specifies whether to decline transactions if a payment card is not enrolled. */
15884
15870
  declineNotEnrolled?: boolean;
15871
+ /** Specifies whether to force the 3D Secure authentication into challenge flow. */
15872
+ forceChallenge?: boolean;
15885
15873
  };
15886
15874
  /** ACI gateway configuration. */
15887
15875
  ACI: coreComponents["schemas"]["GatewayAccount"] & {
@@ -19521,6 +19509,16 @@ export interface coreComponents {
19521
19509
  * {% /admonition %}
19522
19510
  */
19523
19511
  orderDelinquencyPeriod?: string | null;
19512
+ /**
19513
+ * Specifies whether recurring discounts should be subtracted from MRR in metrics calculation.
19514
+ * If this value is `true`, recurring discounts are excluded from MRR.
19515
+ */
19516
+ subtractRecurringDiscountsFromMrr?: boolean;
19517
+ /**
19518
+ * Specifies whether one-time discounts should be subtracted from MRR in metrics calculation.
19519
+ * If this value is `true`, one-time discounts are excluded from MRR.
19520
+ */
19521
+ subtractOneTimeDiscountsFromMrr?: boolean;
19524
19522
  } | null;
19525
19523
  /**
19526
19524
  * Additional organization addresses where a merchant may want to collect taxes using the `taxjar` tax calculator.
@@ -24044,17 +24042,6 @@ export interface coreComponents {
24044
24042
  rel?: "self";
24045
24043
  }[];
24046
24044
  };
24047
- PatchEddScore: {
24048
- /** Customer's EDD score. */
24049
- score?: {
24050
- occupation: coreComponents["schemas"]["EddScore"];
24051
- arrest: coreComponents["schemas"]["EddScore"];
24052
- bankruptcy: coreComponents["schemas"]["EddScore"];
24053
- fraud: coreComponents["schemas"]["EddScore"];
24054
- } | null;
24055
- /** Date and time in ISO 8601 format when the EDD score is updated. */
24056
- nextUpdateTime?: string | null;
24057
- };
24058
24045
  EddTimeline: {
24059
24046
  /** ID of the timeline message. */
24060
24047
  id?: string;
@@ -26369,7 +26356,7 @@ export interface operations {
26369
26356
  };
26370
26357
  /**
26371
26358
  * Reviews an AML check.
26372
- * The AML check can be either confirmed or marked as a false positive with a customer tag.
26359
+ * The AML check can be either confirmed or marked as a false positive.
26373
26360
  */
26374
26361
  PostAmlCheckReview: {
26375
26362
  parameters: {
@@ -38103,33 +38090,6 @@ export interface operations {
38103
38090
  404: coreComponents["responses"]["NotFound"];
38104
38091
  };
38105
38092
  };
38106
- /** Updates an EDD score for a customer with a specified ID. */
38107
- PatchCustomerEddScore: {
38108
- parameters: {
38109
- path: {
38110
- /** ID of the resource. */
38111
- id: coreComponents["parameters"]["resourceId"];
38112
- };
38113
- };
38114
- responses: {
38115
- /** EDD score updated. */
38116
- 200: {
38117
- headers: {};
38118
- content: {
38119
- "application/json": coreComponents["schemas"]["Edd"];
38120
- };
38121
- };
38122
- 401: coreComponents["responses"]["Unauthorized"];
38123
- 403: coreComponents["responses"]["Forbidden"];
38124
- 422: coreComponents["responses"]["ValidationError"];
38125
- 429: coreComponents["responses"]["TooManyRequests"];
38126
- };
38127
- requestBody: {
38128
- content: {
38129
- "application/json": coreComponents["schemas"]["PatchEddScore"];
38130
- };
38131
- };
38132
- };
38133
38093
  /** Retrieves a list of EDD timeline messages. */
38134
38094
  GetCustomerEddTimelineCollection: {
38135
38095
  parameters: {
@@ -38171,34 +38131,6 @@ export interface operations {
38171
38131
  403: coreComponents["responses"]["Forbidden"];
38172
38132
  };
38173
38133
  };
38174
- /** Creates an EDD timeline comment. */
38175
- PostCustomerEddTimeline: {
38176
- parameters: {
38177
- path: {
38178
- /** ID of the resource. */
38179
- id: coreComponents["parameters"]["resourceId"];
38180
- };
38181
- };
38182
- responses: {
38183
- /** EDD timeline comment created. */
38184
- 201: {
38185
- headers: {};
38186
- content: {
38187
- "application/json": coreComponents["schemas"]["EddTimeline"];
38188
- };
38189
- };
38190
- 401: coreComponents["responses"]["Unauthorized"];
38191
- 403: coreComponents["responses"]["Forbidden"];
38192
- 422: coreComponents["responses"]["ValidationError"];
38193
- 429: coreComponents["responses"]["TooManyRequests"];
38194
- };
38195
- /** EDD timeline resource. */
38196
- requestBody: {
38197
- content: {
38198
- "application/json": coreComponents["schemas"]["EddTimeline"];
38199
- };
38200
- };
38201
- };
38202
38134
  /** Retrieves an EDD message with a specified ID. */
38203
38135
  GetCustomerEddTimeline: {
38204
38136
  parameters: {
@@ -38221,26 +38153,6 @@ export interface operations {
38221
38153
  404: coreComponents["responses"]["NotFound"];
38222
38154
  };
38223
38155
  };
38224
- /** Deletes an EDD timeline message with a specified ID. */
38225
- DeleteCustomerEddTimeline: {
38226
- parameters: {
38227
- path: {
38228
- /** ID of the resource. */
38229
- id: coreComponents["parameters"]["resourceId"];
38230
- /** ID of the EDD timeline message. */
38231
- messageId: string;
38232
- };
38233
- };
38234
- responses: {
38235
- /** EDD timeline message deleted. */
38236
- 204: never;
38237
- 401: coreComponents["responses"]["Unauthorized"];
38238
- 403: coreComponents["responses"]["Forbidden"];
38239
- 404: coreComponents["responses"]["NotFound"];
38240
- 409: coreComponents["responses"]["Conflict"];
38241
- 429: coreComponents["responses"]["TooManyRequests"];
38242
- };
38243
- };
38244
38156
  /** Retrieve EDD search results for a customer with a specified ID. */
38245
38157
  GetCustomerEddSearchResultCollection: {
38246
38158
  parameters: {
@@ -39140,28 +39052,6 @@ export interface storefrontComponents {
39140
39052
  /** Type of link. */
39141
39053
  rel?: "self";
39142
39054
  }[];
39143
- /**
39144
- * Use tags to organize and categorize customers or KYC documents based on keywords.
39145
- * For more information, see [Tags](https://www.rebilly.com/docs/dev-docs/api/tags/).
39146
- */
39147
- Tag: {
39148
- /** ID of the tag. */
39149
- id?: storefrontComponents["schemas"]["ResourceId"];
39150
- /**
39151
- * Unique name for the tag.
39152
- * Tag names are not case-sensitive.
39153
- */
39154
- name: string;
39155
- /**
39156
- * Type of tag.
39157
- * Tags of a specific type can only be assigned to corresponding entity types.
39158
- * For example, you can only use customer tags on customers.
39159
- */
39160
- type: "customer" | "kyc-document" | "aml-check";
39161
- createdTime?: storefrontComponents["schemas"]["CreatedTime"];
39162
- updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
39163
- _links?: storefrontComponents["schemas"]["SelfLink"];
39164
- };
39165
39055
  AML: {
39166
39056
  /** First name of the individual, or name of entity. */
39167
39057
  firstName?: string;
@@ -39228,6 +39118,28 @@ export interface storefrontComponents {
39228
39118
  comments?: string | null;
39229
39119
  _links?: storefrontComponents["schemas"]["SelfLink"];
39230
39120
  };
39121
+ /**
39122
+ * Use tags to organize and categorize customers or KYC documents based on keywords.
39123
+ * For more information, see [Tags](https://www.rebilly.com/docs/dev-docs/api/tags/).
39124
+ */
39125
+ Tag: {
39126
+ /** ID of the tag. */
39127
+ id?: storefrontComponents["schemas"]["ResourceId"];
39128
+ /**
39129
+ * Unique name for the tag.
39130
+ * Tag names are not case-sensitive.
39131
+ */
39132
+ name: string;
39133
+ /**
39134
+ * Type of tag.
39135
+ * Tags of a specific type can only be assigned to corresponding entity types.
39136
+ * For example, you can only use customer tags on customers.
39137
+ */
39138
+ type: "customer" | "kyc-document" | "aml-check";
39139
+ createdTime?: storefrontComponents["schemas"]["CreatedTime"];
39140
+ updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
39141
+ _links?: storefrontComponents["schemas"]["SelfLink"];
39142
+ };
39231
39143
  /** AML check result. */
39232
39144
  AmlCheck: {
39233
39145
  /** Unique resource ID. */
@@ -39279,8 +39191,6 @@ export interface storefrontComponents {
39279
39191
  /** Customer's postal code at the time of the AML check. */
39280
39192
  postalCode?: string | null;
39281
39193
  };
39282
- /** List of tags that have been assigned to the customer. */
39283
- tags?: storefrontComponents["schemas"]["Tag"][];
39284
39194
  /** ID of the customer's organization. */
39285
39195
  organizationId?: string;
39286
39196
  };
@@ -39371,6 +39281,8 @@ export interface storefrontComponents {
39371
39281
  AmlCheckReview: {
39372
39282
  /** AML-related customer tag. */
39373
39283
  tag?: "aml-match-confirmed" | "aml-match-false-positive";
39284
+ /** Status of the AML check. */
39285
+ status?: "confirmed-match" | "false-positive";
39374
39286
  };
39375
39287
  /** Degree of confidence to assign. */
39376
39288
  AmlConfidence: ("weak" | "medium" | "strong" | "very-strong") | null;
@@ -46216,8 +46128,9 @@ export interface storefrontComponents {
46216
46128
  * When the delinquency time of an invoice is reached, the order is automatically canceled.
46217
46129
  *
46218
46130
  * {% admonition type="warning" %}
46219
- * If the `delinquencyPeriod` value is `null`, the order does not change state and remains active.
46131
+ * - If the `delinquencyPeriod` value is `null`, the order does not change state and remains active.
46220
46132
  * You must explicitly configure the delinquency period to enable automatic cancellation of unpaid orders.
46133
+ * - If you add a delinquency period to an active order, it is applied to all new invoices created for the order. It is not applied to the unpaid and past-due invoices. To apply a delinquency period to unpaid and past-due invoices, set the `delinquencyTime` parameter using the [upsert an invoice API operation](https://www.rebilly.com/catalog/all/invoices/putinvoice#invoices/putinvoice/t=request&path=delinquencytime).
46221
46134
  * {% /admonition %}
46222
46135
  *
46223
46136
  * If this value is not passed during order creation,
@@ -49738,6 +49651,8 @@ export interface storefrontComponents {
49738
49651
  transactionType: "01" | "03" | "10" | "11" | "28";
49739
49652
  /** Specifies whether to decline transactions if a payment card is not enrolled. */
49740
49653
  declineNotEnrolled?: boolean;
49654
+ /** Specifies whether to force the 3D Secure authentication into challenge flow. */
49655
+ forceChallenge?: boolean;
49741
49656
  };
49742
49657
  /** ACI gateway configuration. */
49743
49658
  ACI: storefrontComponents["schemas"]["GatewayAccount"] & {
@@ -53377,6 +53292,16 @@ export interface storefrontComponents {
53377
53292
  * {% /admonition %}
53378
53293
  */
53379
53294
  orderDelinquencyPeriod?: string | null;
53295
+ /**
53296
+ * Specifies whether recurring discounts should be subtracted from MRR in metrics calculation.
53297
+ * If this value is `true`, recurring discounts are excluded from MRR.
53298
+ */
53299
+ subtractRecurringDiscountsFromMrr?: boolean;
53300
+ /**
53301
+ * Specifies whether one-time discounts should be subtracted from MRR in metrics calculation.
53302
+ * If this value is `true`, one-time discounts are excluded from MRR.
53303
+ */
53304
+ subtractOneTimeDiscountsFromMrr?: boolean;
53380
53305
  } | null;
53381
53306
  /**
53382
53307
  * Additional organization addresses where a merchant may want to collect taxes using the `taxjar` tax calculator.
@@ -57900,17 +57825,6 @@ export interface storefrontComponents {
57900
57825
  rel?: "self";
57901
57826
  }[];
57902
57827
  };
57903
- PatchEddScore: {
57904
- /** Customer's EDD score. */
57905
- score?: {
57906
- occupation: storefrontComponents["schemas"]["EddScore"];
57907
- arrest: storefrontComponents["schemas"]["EddScore"];
57908
- bankruptcy: storefrontComponents["schemas"]["EddScore"];
57909
- fraud: storefrontComponents["schemas"]["EddScore"];
57910
- } | null;
57911
- /** Date and time in ISO 8601 format when the EDD score is updated. */
57912
- nextUpdateTime?: string | null;
57913
- };
57914
57828
  EddTimeline: {
57915
57829
  /** ID of the timeline message. */
57916
57830
  id?: string;
@@ -62028,28 +61942,6 @@ export interface reportsComponents {
62028
61942
  /** Type of link. */
62029
61943
  rel?: "self";
62030
61944
  }[];
62031
- /**
62032
- * Use tags to organize and categorize customers or KYC documents based on keywords.
62033
- * For more information, see [Tags](https://www.rebilly.com/docs/dev-docs/api/tags/).
62034
- */
62035
- Tag: {
62036
- /** ID of the tag. */
62037
- id?: reportsComponents["schemas"]["ResourceId"];
62038
- /**
62039
- * Unique name for the tag.
62040
- * Tag names are not case-sensitive.
62041
- */
62042
- name: string;
62043
- /**
62044
- * Type of tag.
62045
- * Tags of a specific type can only be assigned to corresponding entity types.
62046
- * For example, you can only use customer tags on customers.
62047
- */
62048
- type: "customer" | "kyc-document" | "aml-check";
62049
- createdTime?: reportsComponents["schemas"]["CreatedTime"];
62050
- updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
62051
- _links?: reportsComponents["schemas"]["SelfLink"];
62052
- };
62053
61945
  AML: {
62054
61946
  /** First name of the individual, or name of entity. */
62055
61947
  firstName?: string;
@@ -62116,6 +62008,28 @@ export interface reportsComponents {
62116
62008
  comments?: string | null;
62117
62009
  _links?: reportsComponents["schemas"]["SelfLink"];
62118
62010
  };
62011
+ /**
62012
+ * Use tags to organize and categorize customers or KYC documents based on keywords.
62013
+ * For more information, see [Tags](https://www.rebilly.com/docs/dev-docs/api/tags/).
62014
+ */
62015
+ Tag: {
62016
+ /** ID of the tag. */
62017
+ id?: reportsComponents["schemas"]["ResourceId"];
62018
+ /**
62019
+ * Unique name for the tag.
62020
+ * Tag names are not case-sensitive.
62021
+ */
62022
+ name: string;
62023
+ /**
62024
+ * Type of tag.
62025
+ * Tags of a specific type can only be assigned to corresponding entity types.
62026
+ * For example, you can only use customer tags on customers.
62027
+ */
62028
+ type: "customer" | "kyc-document" | "aml-check";
62029
+ createdTime?: reportsComponents["schemas"]["CreatedTime"];
62030
+ updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
62031
+ _links?: reportsComponents["schemas"]["SelfLink"];
62032
+ };
62119
62033
  /** AML check result. */
62120
62034
  AmlCheck: {
62121
62035
  /** Unique resource ID. */
@@ -62167,8 +62081,6 @@ export interface reportsComponents {
62167
62081
  /** Customer's postal code at the time of the AML check. */
62168
62082
  postalCode?: string | null;
62169
62083
  };
62170
- /** List of tags that have been assigned to the customer. */
62171
- tags?: reportsComponents["schemas"]["Tag"][];
62172
62084
  /** ID of the customer's organization. */
62173
62085
  organizationId?: string;
62174
62086
  };
@@ -62259,6 +62171,8 @@ export interface reportsComponents {
62259
62171
  AmlCheckReview: {
62260
62172
  /** AML-related customer tag. */
62261
62173
  tag?: "aml-match-confirmed" | "aml-match-false-positive";
62174
+ /** Status of the AML check. */
62175
+ status?: "confirmed-match" | "false-positive";
62262
62176
  };
62263
62177
  /** Degree of confidence to assign. */
62264
62178
  AmlConfidence: ("weak" | "medium" | "strong" | "very-strong") | null;
@@ -69104,8 +69018,9 @@ export interface reportsComponents {
69104
69018
  * When the delinquency time of an invoice is reached, the order is automatically canceled.
69105
69019
  *
69106
69020
  * {% admonition type="warning" %}
69107
- * If the `delinquencyPeriod` value is `null`, the order does not change state and remains active.
69021
+ * - If the `delinquencyPeriod` value is `null`, the order does not change state and remains active.
69108
69022
  * You must explicitly configure the delinquency period to enable automatic cancellation of unpaid orders.
69023
+ * - If you add a delinquency period to an active order, it is applied to all new invoices created for the order. It is not applied to the unpaid and past-due invoices. To apply a delinquency period to unpaid and past-due invoices, set the `delinquencyTime` parameter using the [upsert an invoice API operation](https://www.rebilly.com/catalog/all/invoices/putinvoice#invoices/putinvoice/t=request&path=delinquencytime).
69109
69024
  * {% /admonition %}
69110
69025
  *
69111
69026
  * If this value is not passed during order creation,
@@ -72626,6 +72541,8 @@ export interface reportsComponents {
72626
72541
  transactionType: "01" | "03" | "10" | "11" | "28";
72627
72542
  /** Specifies whether to decline transactions if a payment card is not enrolled. */
72628
72543
  declineNotEnrolled?: boolean;
72544
+ /** Specifies whether to force the 3D Secure authentication into challenge flow. */
72545
+ forceChallenge?: boolean;
72629
72546
  };
72630
72547
  /** ACI gateway configuration. */
72631
72548
  ACI: reportsComponents["schemas"]["GatewayAccount"] & {
@@ -76265,6 +76182,16 @@ export interface reportsComponents {
76265
76182
  * {% /admonition %}
76266
76183
  */
76267
76184
  orderDelinquencyPeriod?: string | null;
76185
+ /**
76186
+ * Specifies whether recurring discounts should be subtracted from MRR in metrics calculation.
76187
+ * If this value is `true`, recurring discounts are excluded from MRR.
76188
+ */
76189
+ subtractRecurringDiscountsFromMrr?: boolean;
76190
+ /**
76191
+ * Specifies whether one-time discounts should be subtracted from MRR in metrics calculation.
76192
+ * If this value is `true`, one-time discounts are excluded from MRR.
76193
+ */
76194
+ subtractOneTimeDiscountsFromMrr?: boolean;
76268
76195
  } | null;
76269
76196
  /**
76270
76197
  * Additional organization addresses where a merchant may want to collect taxes using the `taxjar` tax calculator.
@@ -80788,17 +80715,6 @@ export interface reportsComponents {
80788
80715
  rel?: "self";
80789
80716
  }[];
80790
80717
  };
80791
- PatchEddScore: {
80792
- /** Customer's EDD score. */
80793
- score?: {
80794
- occupation: reportsComponents["schemas"]["EddScore"];
80795
- arrest: reportsComponents["schemas"]["EddScore"];
80796
- bankruptcy: reportsComponents["schemas"]["EddScore"];
80797
- fraud: reportsComponents["schemas"]["EddScore"];
80798
- } | null;
80799
- /** Date and time in ISO 8601 format when the EDD score is updated. */
80800
- nextUpdateTime?: string | null;
80801
- };
80802
80718
  EddTimeline: {
80803
80719
  /** ID of the timeline message. */
80804
80720
  id?: string;
@@ -83743,11 +83659,11 @@ export interface operations {
83743
83659
  GetMonthlyRecurringRevenueReport: {
83744
83660
  parameters: {
83745
83661
  query: {
83746
- /** Revenue currency. */
83662
+ /** Revenue currency. If not provided, the organization reporting currency is used. */
83747
83663
  currency: reportsComponents["schemas"]["CurrencyCode"];
83748
- /** Date and time when the report starts. */
83664
+ /** Date and time when the report starts. If not provided or null, the report starts from the previous month. */
83749
83665
  periodStart: string;
83750
- /** Date and time when the report ends. */
83666
+ /** Date and time when the report ends. If not provided or null, the report ends at the current month. */
83751
83667
  periodEnd: string;
83752
83668
  /** Limits the number of collection items to be returned. */
83753
83669
  limit?: reportsComponents["parameters"]["collectionLimit"];
@@ -83776,11 +83692,11 @@ export interface operations {
83776
83692
  GetAnnualRecurringRevenueReport: {
83777
83693
  parameters: {
83778
83694
  query: {
83779
- /** Revenue currency. */
83695
+ /** Revenue currency. If not provided, the organization reporting currency is used. */
83780
83696
  currency: reportsComponents["schemas"]["CurrencyCode"];
83781
- /** Date and time when the report starts. */
83697
+ /** Date and time when the report starts. If not provided or null, the report starts from the previous month. */
83782
83698
  periodStart: string;
83783
- /** Date and time when the report ends. */
83699
+ /** Date and time when the report ends. If not provided or null, the report ends at the current month. */
83784
83700
  periodEnd: string;
83785
83701
  /** Limits the number of collection items to be returned. */
83786
83702
  limit?: reportsComponents["parameters"]["collectionLimit"];
@@ -84894,23 +84810,11 @@ declare module "resources/customers-resource" {
84894
84810
  getCustomerEddScore({ id }: {
84895
84811
  id: any;
84896
84812
  }): rebilly.GetCustomerEddScoreResponsePromise;
84897
- patchCustomerEddScore({ id, data }: {
84898
- id: any;
84899
- data: any;
84900
- }): any;
84901
84813
  getEddTimelineCollection({ id, limit, offset, filter, sort, q, }: rebilly.GetCustomerEddTimelineCollectionRequest): rebilly.GetCustomerEddTimelineCollectionResponsePromise;
84902
- createEddTimelineComment({ id, data }: {
84903
- id: any;
84904
- data: any;
84905
- }): any;
84906
84814
  getEddTimelineMessage({ id, messageId }: {
84907
84815
  id: any;
84908
84816
  messageId: any;
84909
84817
  }): rebilly.GetCustomerEddTimelineResponsePromise;
84910
- deleteEddTimelineMessage({ id, messageId }: {
84911
- id: any;
84912
- messageId: any;
84913
- }): any;
84914
84818
  getAllEddSearchResults({ id, limit, offset }: rebilly.GetCustomerEddSearchResultCollectionRequest): rebilly.GetCustomerEddSearchResultCollectionResponsePromise;
84915
84819
  getEddSearchResult({ id, searchResultId }: {
84916
84820
  id: any;
@@ -86640,23 +86544,11 @@ declare module "resources/api-instance" {
86640
86544
  getCustomerEddScore({ id }: {
86641
86545
  id: any;
86642
86546
  }): rebilly.GetCustomerEddScoreResponsePromise;
86643
- patchCustomerEddScore({ id, data }: {
86644
- id: any;
86645
- data: any;
86646
- }): any;
86647
86547
  getEddTimelineCollection({ id, limit, offset, filter, sort, q, }: rebilly.GetCustomerEddTimelineCollectionRequest): rebilly.GetCustomerEddTimelineCollectionResponsePromise;
86648
- createEddTimelineComment({ id, data }: {
86649
- id: any;
86650
- data: any;
86651
- }): any;
86652
86548
  getEddTimelineMessage({ id, messageId }: {
86653
86549
  id: any;
86654
86550
  messageId: any;
86655
86551
  }): rebilly.GetCustomerEddTimelineResponsePromise;
86656
- deleteEddTimelineMessage({ id, messageId }: {
86657
- id: any;
86658
- messageId: any;
86659
- }): any;
86660
86552
  getAllEddSearchResults({ id, limit, offset }: rebilly.GetCustomerEddSearchResultCollectionRequest): rebilly.GetCustomerEddSearchResultCollectionResponsePromise;
86661
86553
  getEddSearchResult({ id, searchResultId }: {
86662
86554
  id: any;