@dynamic-labs/sdk-api 0.82.0 → 0.83.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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dynamic-labs/sdk-api",
3
- "version": "0.82.0",
3
+ "version": "0.83.0",
4
4
  "author": "Dynamic Labs",
5
5
  "license": "Apache-2.0",
6
6
  "publishConfig": {
@@ -248,7 +248,7 @@ class ScreeningPoliciesApi extends runtime.BaseAPI {
248
248
  return await response.value();
249
249
  }
250
250
  /**
251
- * Removes the environment\'s policy for this vendor. Screening reverts to the sanctions floor alone, which is what an environment with no policy has always done.
251
+ * Removes the environment\'s policy for this provider. Screening reverts to the sanctions floor alone, which is what an environment with no policy has always done.
252
252
  * Delete the screening policy for a vendor
253
253
  */
254
254
  async deleteScreeningPolicyRaw(requestParameters, initOverrides) {
@@ -279,7 +279,7 @@ class ScreeningPoliciesApi extends runtime.BaseAPI {
279
279
  return new runtime.VoidApiResponse(response);
280
280
  }
281
281
  /**
282
- * Removes the environment\'s policy for this vendor. Screening reverts to the sanctions floor alone, which is what an environment with no policy has always done.
282
+ * Removes the environment\'s policy for this provider. Screening reverts to the sanctions floor alone, which is what an environment with no policy has always done.
283
283
  * Delete the screening policy for a vendor
284
284
  */
285
285
  async deleteScreeningPolicy(requestParameters, initOverrides) {
@@ -324,7 +324,7 @@ class ScreeningPoliciesApi extends runtime.BaseAPI {
324
324
  await this.deleteScreeningPolicyAddressRaw(requestParameters, initOverrides);
325
325
  }
326
326
  /**
327
- * Returns the environment\'s stored screening policy for the specified vendor, including the `revision` an edit must echo back. The sanctions floor is not part of the response: it is generated from code on every screen.
327
+ * Returns the environment\'s stored screening policy for the specified provider, including the `revision` an edit must echo back. The sanctions floor is not part of the response: it is generated from code on every screen.
328
328
  * Get the screening policy for a vendor
329
329
  */
330
330
  async getScreeningPolicyRaw(requestParameters, initOverrides) {
@@ -355,7 +355,7 @@ class ScreeningPoliciesApi extends runtime.BaseAPI {
355
355
  return new runtime.JSONApiResponse(response, (jsonValue) => ScreeningPolicy.ScreeningPolicyFromJSON(jsonValue));
356
356
  }
357
357
  /**
358
- * Returns the environment\'s stored screening policy for the specified vendor, including the `revision` an edit must echo back. The sanctions floor is not part of the response: it is generated from code on every screen.
358
+ * Returns the environment\'s stored screening policy for the specified provider, including the `revision` an edit must echo back. The sanctions floor is not part of the response: it is generated from code on every screen.
359
359
  * Get the screening policy for a vendor
360
360
  */
361
361
  async getScreeningPolicy(requestParameters, initOverrides) {
@@ -363,7 +363,7 @@ class ScreeningPoliciesApi extends runtime.BaseAPI {
363
363
  return await response.value();
364
364
  }
365
365
  /**
366
- * Returns the environment\'s address allow and deny entries for this vendor. The list is shared by both of the vendor\'s policies; each entry states which scopes it applies to.
366
+ * Returns the environment\'s address allow and deny entries for this provider. The list is shared by both of the provider\'s policies; each entry states which scopes it applies to.
367
367
  * List the address exceptions for a screening vendor
368
368
  */
369
369
  async getScreeningPolicyAddressesRaw(requestParameters, initOverrides) {
@@ -397,7 +397,7 @@ class ScreeningPoliciesApi extends runtime.BaseAPI {
397
397
  return new runtime.JSONApiResponse(response, (jsonValue) => ScreeningPolicyAddressesResponse.ScreeningPolicyAddressesResponseFromJSON(jsonValue));
398
398
  }
399
399
  /**
400
- * Returns the environment\'s address allow and deny entries for this vendor. The list is shared by both of the vendor\'s policies; each entry states which scopes it applies to.
400
+ * Returns the environment\'s address allow and deny entries for this provider. The list is shared by both of the provider\'s policies; each entry states which scopes it applies to.
401
401
  * List the address exceptions for a screening vendor
402
402
  */
403
403
  async getScreeningPolicyAddresses(requestParameters, initOverrides) {
@@ -405,7 +405,7 @@ class ScreeningPoliciesApi extends runtime.BaseAPI {
405
405
  return await response.value();
406
406
  }
407
407
  /**
408
- * Replaces the whole rule blob, storing it exactly as sent. Send the `revision` returned by the GET; a stale one is rejected with a 409 rather than overwriting an edit made elsewhere. Omit `revision` only to create the first policy for this vendor. Edits take effect within the policy cache TTL.
408
+ * Replaces the whole rule blob, storing it exactly as sent. Send the `revision` returned by the GET; a stale one is rejected with a 409 rather than overwriting an edit made elsewhere. Omit `revision` only to create the first policy for this provider. Edits take effect within the policy cache TTL.
409
409
  * Create or replace the screening policy for a vendor
410
410
  */
411
411
  async replaceScreeningPolicyRaw(requestParameters, initOverrides) {
@@ -441,7 +441,7 @@ class ScreeningPoliciesApi extends runtime.BaseAPI {
441
441
  return new runtime.JSONApiResponse(response, (jsonValue) => ScreeningPolicy.ScreeningPolicyFromJSON(jsonValue));
442
442
  }
443
443
  /**
444
- * Replaces the whole rule blob, storing it exactly as sent. Send the `revision` returned by the GET; a stale one is rejected with a 409 rather than overwriting an edit made elsewhere. Omit `revision` only to create the first policy for this vendor. Edits take effect within the policy cache TTL.
444
+ * Replaces the whole rule blob, storing it exactly as sent. Send the `revision` returned by the GET; a stale one is rejected with a 409 rather than overwriting an edit made elsewhere. Omit `revision` only to create the first policy for this provider. Edits take effect within the policy cache TTL.
445
445
  * Create or replace the screening policy for a vendor
446
446
  */
447
447
  async replaceScreeningPolicy(requestParameters, initOverrides) {
@@ -58,12 +58,12 @@ export declare class ScreeningPoliciesApi extends runtime.BaseAPI {
58
58
  */
59
59
  createScreeningPolicyAddress(requestParameters: CreateScreeningPolicyAddressRequest, initOverrides?: RequestInit): Promise<ScreeningPolicyAddress>;
60
60
  /**
61
- * Removes the environment\'s policy for this vendor. Screening reverts to the sanctions floor alone, which is what an environment with no policy has always done.
61
+ * Removes the environment\'s policy for this provider. Screening reverts to the sanctions floor alone, which is what an environment with no policy has always done.
62
62
  * Delete the screening policy for a vendor
63
63
  */
64
64
  deleteScreeningPolicyRaw(requestParameters: DeleteScreeningPolicyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
65
65
  /**
66
- * Removes the environment\'s policy for this vendor. Screening reverts to the sanctions floor alone, which is what an environment with no policy has always done.
66
+ * Removes the environment\'s policy for this provider. Screening reverts to the sanctions floor alone, which is what an environment with no policy has always done.
67
67
  * Delete the screening policy for a vendor
68
68
  */
69
69
  deleteScreeningPolicy(requestParameters: DeleteScreeningPolicyRequest, initOverrides?: RequestInit): Promise<void>;
@@ -78,32 +78,32 @@ export declare class ScreeningPoliciesApi extends runtime.BaseAPI {
78
78
  */
79
79
  deleteScreeningPolicyAddress(requestParameters: DeleteScreeningPolicyAddressRequest, initOverrides?: RequestInit): Promise<void>;
80
80
  /**
81
- * Returns the environment\'s stored screening policy for the specified vendor, including the `revision` an edit must echo back. The sanctions floor is not part of the response: it is generated from code on every screen.
81
+ * Returns the environment\'s stored screening policy for the specified provider, including the `revision` an edit must echo back. The sanctions floor is not part of the response: it is generated from code on every screen.
82
82
  * Get the screening policy for a vendor
83
83
  */
84
84
  getScreeningPolicyRaw(requestParameters: GetScreeningPolicyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ScreeningPolicy>>;
85
85
  /**
86
- * Returns the environment\'s stored screening policy for the specified vendor, including the `revision` an edit must echo back. The sanctions floor is not part of the response: it is generated from code on every screen.
86
+ * Returns the environment\'s stored screening policy for the specified provider, including the `revision` an edit must echo back. The sanctions floor is not part of the response: it is generated from code on every screen.
87
87
  * Get the screening policy for a vendor
88
88
  */
89
89
  getScreeningPolicy(requestParameters: GetScreeningPolicyRequest, initOverrides?: RequestInit): Promise<ScreeningPolicy>;
90
90
  /**
91
- * Returns the environment\'s address allow and deny entries for this vendor. The list is shared by both of the vendor\'s policies; each entry states which scopes it applies to.
91
+ * Returns the environment\'s address allow and deny entries for this provider. The list is shared by both of the provider\'s policies; each entry states which scopes it applies to.
92
92
  * List the address exceptions for a screening vendor
93
93
  */
94
94
  getScreeningPolicyAddressesRaw(requestParameters: GetScreeningPolicyAddressesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ScreeningPolicyAddressesResponse>>;
95
95
  /**
96
- * Returns the environment\'s address allow and deny entries for this vendor. The list is shared by both of the vendor\'s policies; each entry states which scopes it applies to.
96
+ * Returns the environment\'s address allow and deny entries for this provider. The list is shared by both of the provider\'s policies; each entry states which scopes it applies to.
97
97
  * List the address exceptions for a screening vendor
98
98
  */
99
99
  getScreeningPolicyAddresses(requestParameters: GetScreeningPolicyAddressesRequest, initOverrides?: RequestInit): Promise<ScreeningPolicyAddressesResponse>;
100
100
  /**
101
- * Replaces the whole rule blob, storing it exactly as sent. Send the `revision` returned by the GET; a stale one is rejected with a 409 rather than overwriting an edit made elsewhere. Omit `revision` only to create the first policy for this vendor. Edits take effect within the policy cache TTL.
101
+ * Replaces the whole rule blob, storing it exactly as sent. Send the `revision` returned by the GET; a stale one is rejected with a 409 rather than overwriting an edit made elsewhere. Omit `revision` only to create the first policy for this provider. Edits take effect within the policy cache TTL.
102
102
  * Create or replace the screening policy for a vendor
103
103
  */
104
104
  replaceScreeningPolicyRaw(requestParameters: ReplaceScreeningPolicyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ScreeningPolicy>>;
105
105
  /**
106
- * Replaces the whole rule blob, storing it exactly as sent. Send the `revision` returned by the GET; a stale one is rejected with a 409 rather than overwriting an edit made elsewhere. Omit `revision` only to create the first policy for this vendor. Edits take effect within the policy cache TTL.
106
+ * Replaces the whole rule blob, storing it exactly as sent. Send the `revision` returned by the GET; a stale one is rejected with a 409 rather than overwriting an edit made elsewhere. Omit `revision` only to create the first policy for this provider. Edits take effect within the policy cache TTL.
107
107
  * Create or replace the screening policy for a vendor
108
108
  */
109
109
  replaceScreeningPolicy(requestParameters: ReplaceScreeningPolicyRequest, initOverrides?: RequestInit): Promise<ScreeningPolicy>;
@@ -244,7 +244,7 @@ class ScreeningPoliciesApi extends BaseAPI {
244
244
  return await response.value();
245
245
  }
246
246
  /**
247
- * Removes the environment\'s policy for this vendor. Screening reverts to the sanctions floor alone, which is what an environment with no policy has always done.
247
+ * Removes the environment\'s policy for this provider. Screening reverts to the sanctions floor alone, which is what an environment with no policy has always done.
248
248
  * Delete the screening policy for a vendor
249
249
  */
250
250
  async deleteScreeningPolicyRaw(requestParameters, initOverrides) {
@@ -275,7 +275,7 @@ class ScreeningPoliciesApi extends BaseAPI {
275
275
  return new VoidApiResponse(response);
276
276
  }
277
277
  /**
278
- * Removes the environment\'s policy for this vendor. Screening reverts to the sanctions floor alone, which is what an environment with no policy has always done.
278
+ * Removes the environment\'s policy for this provider. Screening reverts to the sanctions floor alone, which is what an environment with no policy has always done.
279
279
  * Delete the screening policy for a vendor
280
280
  */
281
281
  async deleteScreeningPolicy(requestParameters, initOverrides) {
@@ -320,7 +320,7 @@ class ScreeningPoliciesApi extends BaseAPI {
320
320
  await this.deleteScreeningPolicyAddressRaw(requestParameters, initOverrides);
321
321
  }
322
322
  /**
323
- * Returns the environment\'s stored screening policy for the specified vendor, including the `revision` an edit must echo back. The sanctions floor is not part of the response: it is generated from code on every screen.
323
+ * Returns the environment\'s stored screening policy for the specified provider, including the `revision` an edit must echo back. The sanctions floor is not part of the response: it is generated from code on every screen.
324
324
  * Get the screening policy for a vendor
325
325
  */
326
326
  async getScreeningPolicyRaw(requestParameters, initOverrides) {
@@ -351,7 +351,7 @@ class ScreeningPoliciesApi extends BaseAPI {
351
351
  return new JSONApiResponse(response, (jsonValue) => ScreeningPolicyFromJSON(jsonValue));
352
352
  }
353
353
  /**
354
- * Returns the environment\'s stored screening policy for the specified vendor, including the `revision` an edit must echo back. The sanctions floor is not part of the response: it is generated from code on every screen.
354
+ * Returns the environment\'s stored screening policy for the specified provider, including the `revision` an edit must echo back. The sanctions floor is not part of the response: it is generated from code on every screen.
355
355
  * Get the screening policy for a vendor
356
356
  */
357
357
  async getScreeningPolicy(requestParameters, initOverrides) {
@@ -359,7 +359,7 @@ class ScreeningPoliciesApi extends BaseAPI {
359
359
  return await response.value();
360
360
  }
361
361
  /**
362
- * Returns the environment\'s address allow and deny entries for this vendor. The list is shared by both of the vendor\'s policies; each entry states which scopes it applies to.
362
+ * Returns the environment\'s address allow and deny entries for this provider. The list is shared by both of the provider\'s policies; each entry states which scopes it applies to.
363
363
  * List the address exceptions for a screening vendor
364
364
  */
365
365
  async getScreeningPolicyAddressesRaw(requestParameters, initOverrides) {
@@ -393,7 +393,7 @@ class ScreeningPoliciesApi extends BaseAPI {
393
393
  return new JSONApiResponse(response, (jsonValue) => ScreeningPolicyAddressesResponseFromJSON(jsonValue));
394
394
  }
395
395
  /**
396
- * Returns the environment\'s address allow and deny entries for this vendor. The list is shared by both of the vendor\'s policies; each entry states which scopes it applies to.
396
+ * Returns the environment\'s address allow and deny entries for this provider. The list is shared by both of the provider\'s policies; each entry states which scopes it applies to.
397
397
  * List the address exceptions for a screening vendor
398
398
  */
399
399
  async getScreeningPolicyAddresses(requestParameters, initOverrides) {
@@ -401,7 +401,7 @@ class ScreeningPoliciesApi extends BaseAPI {
401
401
  return await response.value();
402
402
  }
403
403
  /**
404
- * Replaces the whole rule blob, storing it exactly as sent. Send the `revision` returned by the GET; a stale one is rejected with a 409 rather than overwriting an edit made elsewhere. Omit `revision` only to create the first policy for this vendor. Edits take effect within the policy cache TTL.
404
+ * Replaces the whole rule blob, storing it exactly as sent. Send the `revision` returned by the GET; a stale one is rejected with a 409 rather than overwriting an edit made elsewhere. Omit `revision` only to create the first policy for this provider. Edits take effect within the policy cache TTL.
405
405
  * Create or replace the screening policy for a vendor
406
406
  */
407
407
  async replaceScreeningPolicyRaw(requestParameters, initOverrides) {
@@ -437,7 +437,7 @@ class ScreeningPoliciesApi extends BaseAPI {
437
437
  return new JSONApiResponse(response, (jsonValue) => ScreeningPolicyFromJSON(jsonValue));
438
438
  }
439
439
  /**
440
- * Replaces the whole rule blob, storing it exactly as sent. Send the `revision` returned by the GET; a stale one is rejected with a 409 rather than overwriting an edit made elsewhere. Omit `revision` only to create the first policy for this vendor. Edits take effect within the policy cache TTL.
440
+ * Replaces the whole rule blob, storing it exactly as sent. Send the `revision` returned by the GET; a stale one is rejected with a 409 rather than overwriting an edit made elsewhere. Omit `revision` only to create the first policy for this provider. Edits take effect within the policy cache TTL.
441
441
  * Create or replace the screening policy for a vendor
442
442
  */
443
443
  async replaceScreeningPolicy(requestParameters, initOverrides) {
@@ -66,9 +66,9 @@ export interface SanctionsWalletBlockedEventPayload {
66
66
  */
67
67
  sanctionCheckRequestId: string;
68
68
  /**
69
- * Vendor-returned categories that triggered the block. May be empty
69
+ * Provider-returned categories that triggered the block. May be empty
70
70
  * when the decision was served from the screening cache (cached
71
- * rows do not retain vendor categories).
71
+ * rows do not retain provider categories).
72
72
  * @type {Array<string>}
73
73
  * @memberof SanctionsWalletBlockedEventPayload
74
74
  */
@@ -16,7 +16,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
16
16
  * Do not edit the class manually.
17
17
  */
18
18
  /**
19
- * Fields needing no vendor response, so they work in both phases, and the only
19
+ * Fields needing no provider response, so they work in both phases, and the only
20
20
  * fields a pre-screen rule may use. `tx.amountUsd` and `tx.asset` are present
21
21
  * only where the request establishes them; neither is available on the signing
22
22
  * path. `address` compares case-sensitively, since base58 chains are
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Fields needing no vendor response, so they work in both phases, and the only
13
+ * Fields needing no provider response, so they work in both phases, and the only
14
14
  * fields a pre-screen rule may use. `tx.amountUsd` and `tx.asset` are present
15
15
  * only where the request establishes them; neither is available on the signing
16
16
  * path. `address` compares case-sensitively, since base58 chains are
@@ -12,7 +12,7 @@
12
12
  * Do not edit the class manually.
13
13
  */
14
14
  /**
15
- * Fields needing no vendor response, so they work in both phases, and the only
15
+ * Fields needing no provider response, so they work in both phases, and the only
16
16
  * fields a pre-screen rule may use. `tx.amountUsd` and `tx.asset` are present
17
17
  * only where the request establishes them; neither is available on the signing
18
18
  * path. `address` compares case-sensitively, since base58 chains are
@@ -12,7 +12,7 @@
12
12
  import { ScreeningPolicyProviderEnum } from './ScreeningPolicyProviderEnum';
13
13
  import { ScreeningPolicyScopeEnum } from './ScreeningPolicyScopeEnum';
14
14
  /**
15
- * One vendor's screening policy in one environment, for one scope.
15
+ * One provider's screening policy in one environment, for one scope.
16
16
  * @export
17
17
  * @interface ScreeningPolicy
18
18
  */
@@ -42,12 +42,12 @@ export interface ScreeningPolicy {
42
42
  */
43
43
  schemaVersion: number;
44
44
  /**
45
- * Customer rules, `{ preScreen, postScreen }`, per the vendor's own rule schema
45
+ * Customer rules, `{ preScreen, postScreen }`, per the provider's own rule schema
46
46
  * (`TrmPolicyRules` or `ChainalysisPolicyRules`). Typed as a free-form object
47
- * rather than a `oneOf` over the two: the vendor is a path parameter, no
47
+ * rather than a `oneOf` over the two: the provider is a path parameter, no
48
48
  * OpenAPI construct selects a body schema from one, and `oneOf` generates SDK
49
49
  * models that do not compile. The server validates the blob against the
50
- * vendor's schema before writing, so a TRM policy naming a `chainalysis.*`
50
+ * provider's schema before writing, so a TRM policy naming a `chainalysis.*`
51
51
  * field is a 400. Clients should validate against those two schemas before
52
52
  * submitting.
53
53
  *
@@ -59,7 +59,7 @@ export interface ScreeningPolicy {
59
59
  */
60
60
  rules: object;
61
61
  /**
62
- * Number of live address entries applying to THIS scope — those marked `ALL` plus those narrowed to it. Entries themselves belong to the (environment, vendor) pair, not to this policy.
62
+ * Number of live address entries applying to THIS scope — those marked `ALL` plus those narrowed to it. Entries themselves belong to the (environment, provider) pair, not to this policy.
63
63
  * @type {number}
64
64
  * @memberof ScreeningPolicy
65
65
  */
@@ -13,9 +13,10 @@ import { ChainEnum } from './ChainEnum';
13
13
  import { ScreeningAddressDisposition } from './ScreeningAddressDisposition';
14
14
  import { ScreeningAddressScopeEnum } from './ScreeningAddressScopeEnum';
15
15
  /**
16
- * A customer address exception, belonging to the (environment, vendor) pair
16
+ * A customer address exception, belonging to the (environment, provider) pair
17
17
  * rather than to one policy — a denylist should have one answer to "is this
18
- * actor blocked?" whichever screening moment is being resolved. Matched by a
18
+ * actor blocked?" whether the sign-in policy or the transaction policy is
19
+ * being resolved. Matched by a
19
20
  * chain-aware fold of the address, not a plain lowercase, because base58 and
20
21
  * base32 chains are case-significant. An absent `chain` applies the entry to
21
22
  * every chain.
@@ -13,7 +13,7 @@ import { ChainEnum } from './ChainEnum';
13
13
  import { ScreeningAddressDisposition } from './ScreeningAddressDisposition';
14
14
  import { ScreeningAddressScopeEnum } from './ScreeningAddressScopeEnum';
15
15
  /**
16
- * Adds one address exception to the (environment, vendor) list. Omit `chain` to apply it to every chain, and `appliesToScope` to apply it at every screening moment.
16
+ * Adds one address exception to the (environment, provider) list. Omit `chain` to apply it to every chain, and `appliesToScope` to apply it to both the sign-in policy and the transaction policy.
17
17
  * @export
18
18
  * @interface ScreeningPolicyAddressCreateRequest
19
19
  */
@@ -17,7 +17,7 @@ import { ScreeningPolicyAddress } from './ScreeningPolicyAddress';
17
17
  */
18
18
  export interface ScreeningPolicyAddressesResponse {
19
19
  /**
20
- * Total number of live address entries for this (environment, vendor) pair, across every `appliesToScope`.
20
+ * Total number of live address entries for this (environment, provider) pair, across every `appliesToScope`.
21
21
  * @type {number}
22
22
  * @memberof ScreeningPolicyAddressesResponse
23
23
  */
@@ -16,9 +16,9 @@ Object.defineProperty(exports, '__esModule', { value: true });
16
16
  * Do not edit the class manually.
17
17
  */
18
18
  /**
19
- * Screening vendor a policy belongs to. Deliberately not `ProviderEnum`, which
19
+ * Screening provider a policy belongs to. Deliberately not `ProviderEnum`, which
20
20
  * is a 44-value auth/social/onramp list of which only these two are screening
21
- * vendors. The Dynamic sanctions provider is absent because the sanctions floor
21
+ * providers. The Dynamic sanctions provider is absent because the sanctions floor
22
22
  * is generated from code and is not configurable.
23
23
  * @export
24
24
  * @enum {string}
@@ -10,9 +10,9 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Screening vendor a policy belongs to. Deliberately not `ProviderEnum`, which
13
+ * Screening provider a policy belongs to. Deliberately not `ProviderEnum`, which
14
14
  * is a 44-value auth/social/onramp list of which only these two are screening
15
- * vendors. The Dynamic sanctions provider is absent because the sanctions floor
15
+ * providers. The Dynamic sanctions provider is absent because the sanctions floor
16
16
  * is generated from code and is not configurable.
17
17
  * @export
18
18
  * @enum {string}
@@ -12,9 +12,9 @@
12
12
  * Do not edit the class manually.
13
13
  */
14
14
  /**
15
- * Screening vendor a policy belongs to. Deliberately not `ProviderEnum`, which
15
+ * Screening provider a policy belongs to. Deliberately not `ProviderEnum`, which
16
16
  * is a 44-value auth/social/onramp list of which only these two are screening
17
- * vendors. The Dynamic sanctions provider is absent because the sanctions floor
17
+ * providers. The Dynamic sanctions provider is absent because the sanctions floor
18
18
  * is generated from code and is not configurable.
19
19
  * @export
20
20
  * @enum {string}
@@ -16,10 +16,10 @@ Object.defineProperty(exports, '__esModule', { value: true });
16
16
  * Do not edit the class manually.
17
17
  */
18
18
  /**
19
- * Which screening moment a policy governs. An environment holds one policy per
20
- * vendor per scope, authored independently — a customer may alert at sign-in
21
- * and block on transactions, or skip the paid vendor call at one and not the
22
- * other. Two values, not three: an "applies to both" policy would make the
19
+ * Whether a policy is the sign-in policy or the transaction policy. An
20
+ * environment holds one policy per provider per scope, authored independently —
21
+ * a customer may alert at sign-in and block on transactions, or skip the paid
22
+ * provider call at one and not the other. Two values, not three: an "applies to both" policy would make the
23
23
  * overlap with a single-scope row unrepresentable as a unique constraint.
24
24
  * @export
25
25
  * @enum {string}
@@ -10,10 +10,10 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Which screening moment a policy governs. An environment holds one policy per
14
- * vendor per scope, authored independently — a customer may alert at sign-in
15
- * and block on transactions, or skip the paid vendor call at one and not the
16
- * other. Two values, not three: an "applies to both" policy would make the
13
+ * Whether a policy is the sign-in policy or the transaction policy. An
14
+ * environment holds one policy per provider per scope, authored independently —
15
+ * a customer may alert at sign-in and block on transactions, or skip the paid
16
+ * provider call at one and not the other. Two values, not three: an "applies to both" policy would make the
17
17
  * overlap with a single-scope row unrepresentable as a unique constraint.
18
18
  * @export
19
19
  * @enum {string}
@@ -12,10 +12,10 @@
12
12
  * Do not edit the class manually.
13
13
  */
14
14
  /**
15
- * Which screening moment a policy governs. An environment holds one policy per
16
- * vendor per scope, authored independently — a customer may alert at sign-in
17
- * and block on transactions, or skip the paid vendor call at one and not the
18
- * other. Two values, not three: an "applies to both" policy would make the
15
+ * Whether a policy is the sign-in policy or the transaction policy. An
16
+ * environment holds one policy per provider per scope, authored independently —
17
+ * a customer may alert at sign-in and block on transactions, or skip the paid
18
+ * provider call at one and not the other. Two values, not three: an "applies to both" policy would make the
19
19
  * overlap with a single-scope row unrepresentable as a unique constraint.
20
20
  * @export
21
21
  * @enum {string}
@@ -20,18 +20,18 @@ export interface ScreeningPolicyUpdateRequest {
20
20
  /**
21
21
  * The `revision` this edit was based on. Required to replace an existing
22
22
  * policy, and a stale value is rejected with a 409 rather than silently
23
- * applied. Omit it only when creating the first policy for this vendor.
23
+ * applied. Omit it only when creating the first policy for this provider.
24
24
  * @type {number}
25
25
  * @memberof ScreeningPolicyUpdateRequest
26
26
  */
27
27
  revision?: number;
28
28
  /**
29
- * Customer rules, `{ preScreen, postScreen }`, per the vendor's own rule schema
29
+ * Customer rules, `{ preScreen, postScreen }`, per the provider's own rule schema
30
30
  * (`TrmPolicyRules` or `ChainalysisPolicyRules`). Typed as a free-form object
31
- * rather than a `oneOf` over the two: the vendor is a path parameter, no
31
+ * rather than a `oneOf` over the two: the provider is a path parameter, no
32
32
  * OpenAPI construct selects a body schema from one, and `oneOf` generates SDK
33
33
  * models that do not compile. The server validates the blob against the
34
- * vendor's schema before writing, so a TRM policy naming a `chainalysis.*`
34
+ * provider's schema before writing, so a TRM policy naming a `chainalysis.*`
35
35
  * field is a 400. Clients should validate against those two schemas before
36
36
  * submitting.
37
37
  *
@@ -16,7 +16,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
16
16
  * Do not edit the class manually.
17
17
  */
18
18
  /**
19
- * Whether the paid vendor call happens. SCREEN when no rule matches.
19
+ * Whether the paid provider call happens. SCREEN when no rule matches.
20
20
  * @export
21
21
  * @enum {string}
22
22
  */
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Whether the paid vendor call happens. SCREEN when no rule matches.
13
+ * Whether the paid provider call happens. SCREEN when no rule matches.
14
14
  * @export
15
15
  * @enum {string}
16
16
  */
@@ -12,7 +12,7 @@
12
12
  * Do not edit the class manually.
13
13
  */
14
14
  /**
15
- * Whether the paid vendor call happens. SCREEN when no rule matches.
15
+ * Whether the paid provider call happens. SCREEN when no rule matches.
16
16
  * @export
17
17
  * @enum {string}
18
18
  */
@@ -12,14 +12,14 @@
12
12
  import { ScreeningCoreField } from './ScreeningCoreField';
13
13
  import { ScreeningOperator } from './ScreeningOperator';
14
14
  /**
15
- * Boolean expression over the vendor-independent fields only. Pre-screen
16
- * decides whether the vendor is called at all, so it cannot read a vendor
15
+ * Boolean expression over the provider-independent fields only. Pre-screen
16
+ * decides whether the provider is called at all, so it cannot read a provider
17
17
  * response. Exactly one of `always`, `all`, `any`, `not`, or a
18
18
  * `field`/`op`/`value` comparison.
19
19
  *
20
20
  * `always` is accepted only as a rule's whole condition, never nested, and
21
21
  * only in `preScreen` — which is why it is declared here and not on the
22
- * vendor rule nodes. Anywhere else is a 400.
22
+ * provider rule nodes. Anywhere else is a 400.
23
23
  * @export
24
24
  * @interface ScreeningPreScreenNode
25
25
  */
@@ -12,7 +12,7 @@
12
12
  import { ScreeningPreScreenAction } from './ScreeningPreScreenAction';
13
13
  import { ScreeningPreScreenNode } from './ScreeningPreScreenNode';
14
14
  /**
15
- * Shared across vendors, since pre-screen reads no vendor signal. `when` may
15
+ * Shared across providers, since pre-screen reads no provider signal. `when` may
16
16
  * be `{ always: true }`, which matches every screen; the post-screen rules
17
17
  * have no such form, so an unconditional rule is unrepresentable there rather
18
18
  * than merely rejected.
@@ -11,17 +11,17 @@
11
11
  */
12
12
  /**
13
13
  * Why a screening policy reached its verdict: which layer matched, and what
14
- * it matched on in the vendor's own vocabulary.
14
+ * it matched on in the provider's own vocabulary.
15
15
  *
16
16
  * Only `provider` and `matched` are always present. The rest depend on the
17
- * vendor and on which leaf actually fired — a floor match on a Chainalysis
17
+ * provider and on which leaf actually fired — a floor match on a Chainalysis
18
18
  * cluster carries a `category` and no `riskType`.
19
19
  * @export
20
20
  * @interface ScreeningReason
21
21
  */
22
22
  export interface ScreeningReason {
23
23
  /**
24
- * The vendor whose response produced this verdict.
24
+ * The provider whose response produced this verdict.
25
25
  * @type {string}
26
26
  * @memberof ScreeningReason
27
27
  */
@@ -38,8 +38,8 @@ export interface ScreeningReason {
38
38
  matched: ScreeningReasonMatchedEnum;
39
39
  /**
40
40
  * The policy generation that produced this verdict. Scoped to one
41
- * screening moment, so two verdicts in the same environment can
42
- * legitimately carry different revisions.
41
+ * policy, so a sign-in verdict and a transaction verdict in the same
42
+ * environment can legitimately carry different revisions.
43
43
  * @type {number}
44
44
  * @memberof ScreeningReason
45
45
  */
@@ -55,7 +55,7 @@ export interface ScreeningReason {
55
55
  */
56
56
  rule?: object;
57
57
  /**
58
- * The vendor's category string, verbatim, in the vendor's own casing.
58
+ * The provider's category string, verbatim, in the provider's own casing.
59
59
  * @type {string}
60
60
  * @memberof ScreeningReason
61
61
  */
@@ -52,9 +52,9 @@ export interface WalletAddressScreeningAlertedEventPayload {
52
52
  */
53
53
  sanctionCheckRequestId: string;
54
54
  /**
55
- * Vendor-returned categories that triggered the alert. May be empty
55
+ * Provider-returned categories that triggered the alert. May be empty
56
56
  * when the decision was served from the screening cache (cached
57
- * rows do not retain vendor categories).
57
+ * rows do not retain provider categories).
58
58
  * @type {Array<string>}
59
59
  * @memberof WalletAddressScreeningAlertedEventPayload
60
60
  */
@@ -52,9 +52,9 @@ export interface WalletAddressScreeningBlockedEventPayload {
52
52
  */
53
53
  sanctionCheckRequestId: string;
54
54
  /**
55
- * Vendor-returned categories that triggered the block. May be empty
55
+ * Provider-returned categories that triggered the block. May be empty
56
56
  * when the decision was served from the screening cache (cached
57
- * rows do not retain vendor categories).
57
+ * rows do not retain provider categories).
58
58
  * @type {Array<string>}
59
59
  * @memberof WalletAddressScreeningBlockedEventPayload
60
60
  */