@dynamic-labs/sdk-api 0.81.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 +1 -1
- package/src/apis/CheckoutApi.cjs +5 -12
- package/src/apis/CheckoutApi.d.ts +5 -6
- package/src/apis/CheckoutApi.js +6 -13
- package/src/apis/ScreeningPoliciesApi.cjs +8 -8
- package/src/apis/ScreeningPoliciesApi.d.ts +8 -8
- package/src/apis/ScreeningPoliciesApi.js +8 -8
- package/src/index.cjs +4 -0
- package/src/index.js +1 -0
- package/src/models/InlineResponse410.cjs +33 -0
- package/src/models/InlineResponse410.d.ts +27 -0
- package/src/models/InlineResponse410.js +27 -0
- package/src/models/SanctionsWalletBlockedEventPayload.d.ts +2 -2
- package/src/models/ScreeningCoreField.cjs +1 -1
- package/src/models/ScreeningCoreField.d.ts +1 -1
- package/src/models/ScreeningCoreField.js +1 -1
- package/src/models/ScreeningPolicy.d.ts +5 -5
- package/src/models/ScreeningPolicyAddress.d.ts +3 -2
- package/src/models/ScreeningPolicyAddressCreateRequest.d.ts +1 -1
- package/src/models/ScreeningPolicyAddressesResponse.d.ts +1 -1
- package/src/models/ScreeningPolicyProviderEnum.cjs +2 -2
- package/src/models/ScreeningPolicyProviderEnum.d.ts +2 -2
- package/src/models/ScreeningPolicyProviderEnum.js +2 -2
- package/src/models/ScreeningPolicyScopeEnum.cjs +4 -4
- package/src/models/ScreeningPolicyScopeEnum.d.ts +4 -4
- package/src/models/ScreeningPolicyScopeEnum.js +4 -4
- package/src/models/ScreeningPolicyUpdateRequest.d.ts +4 -4
- package/src/models/ScreeningPreScreenAction.cjs +1 -1
- package/src/models/ScreeningPreScreenAction.d.ts +1 -1
- package/src/models/ScreeningPreScreenAction.js +1 -1
- package/src/models/ScreeningPreScreenNode.d.ts +3 -3
- package/src/models/ScreeningPreScreenRule.d.ts +1 -1
- package/src/models/ScreeningReason.d.ts +6 -6
- package/src/models/WalletAddressScreeningAlertedEventPayload.d.ts +2 -2
- package/src/models/WalletAddressScreeningBlockedEventPayload.d.ts +2 -2
- package/src/models/index.d.ts +1 -0
package/package.json
CHANGED
package/src/apis/CheckoutApi.cjs
CHANGED
|
@@ -70,8 +70,8 @@ require('../models/ScreeningPreScreenAction.cjs');
|
|
|
70
70
|
require('../models/ScreeningCoreField.cjs');
|
|
71
71
|
require('../models/ChainalysisRiskLevel.cjs');
|
|
72
72
|
var Checkout = require('../models/Checkout.cjs');
|
|
73
|
-
var CheckoutCreateRequest = require('../models/CheckoutCreateRequest.cjs');
|
|
74
73
|
require('../models/CheckoutModeEnum.cjs');
|
|
74
|
+
require('../models/SettlementStrategyEnum.cjs');
|
|
75
75
|
require('../models/FlowExecutionStateEnum.cjs');
|
|
76
76
|
require('../models/FlowRiskStateEnum.cjs');
|
|
77
77
|
require('../models/FlowSettlementStateEnum.cjs');
|
|
@@ -117,7 +117,6 @@ require('../models/ExportModelEnum.cjs');
|
|
|
117
117
|
require('../models/ExportStatusEnum.cjs');
|
|
118
118
|
require('../models/ExternalWalletFundingDefaultChain.cjs');
|
|
119
119
|
require('../models/FlowModeEnum.cjs');
|
|
120
|
-
require('../models/SettlementStrategyEnum.cjs');
|
|
121
120
|
require('../models/FlowAnalyticsSummaryResponse.cjs');
|
|
122
121
|
require('../models/FlowCurrencyEnum.cjs');
|
|
123
122
|
require('../models/FlowListItem.cjs');
|
|
@@ -205,35 +204,29 @@ require('../models/YieldVaultSummary.cjs');
|
|
|
205
204
|
*/
|
|
206
205
|
class CheckoutApi extends runtime.BaseAPI {
|
|
207
206
|
/**
|
|
208
|
-
*
|
|
207
|
+
* Permanently removed. Use new /flow api instead.
|
|
209
208
|
* Create a checkout
|
|
210
209
|
*/
|
|
211
210
|
async createCheckoutRaw(requestParameters, initOverrides) {
|
|
212
211
|
if (requestParameters.environmentId === null || requestParameters.environmentId === undefined) {
|
|
213
212
|
throw new runtime.RequiredError('environmentId', 'Required parameter requestParameters.environmentId was null or undefined when calling createCheckout.');
|
|
214
213
|
}
|
|
215
|
-
if (requestParameters.checkoutCreateRequest === null || requestParameters.checkoutCreateRequest === undefined) {
|
|
216
|
-
throw new runtime.RequiredError('checkoutCreateRequest', 'Required parameter requestParameters.checkoutCreateRequest was null or undefined when calling createCheckout.');
|
|
217
|
-
}
|
|
218
214
|
const queryParameters = {};
|
|
219
215
|
const headerParameters = {};
|
|
220
|
-
headerParameters['Content-Type'] = 'application/json';
|
|
221
216
|
const response = await this.request({
|
|
222
217
|
path: `/environments/{environmentId}/checkouts`.replace(`{${"environmentId"}}`, encodeURIComponent(String(requestParameters.environmentId))),
|
|
223
218
|
method: 'POST',
|
|
224
219
|
headers: headerParameters,
|
|
225
220
|
query: queryParameters,
|
|
226
|
-
body: CheckoutCreateRequest.CheckoutCreateRequestToJSON(requestParameters.checkoutCreateRequest),
|
|
227
221
|
}, initOverrides);
|
|
228
|
-
return new runtime.
|
|
222
|
+
return new runtime.VoidApiResponse(response);
|
|
229
223
|
}
|
|
230
224
|
/**
|
|
231
|
-
*
|
|
225
|
+
* Permanently removed. Use new /flow api instead.
|
|
232
226
|
* Create a checkout
|
|
233
227
|
*/
|
|
234
228
|
async createCheckout(requestParameters, initOverrides) {
|
|
235
|
-
|
|
236
|
-
return await response.value();
|
|
229
|
+
await this.createCheckoutRaw(requestParameters, initOverrides);
|
|
237
230
|
}
|
|
238
231
|
/**
|
|
239
232
|
* Deprecated: use new /flow api instead. Soft-deletes a checkout, preventing it from accepting new transactions.
|
|
@@ -10,10 +10,9 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { Checkout,
|
|
13
|
+
import { Checkout, CheckoutUpdateRequest } from '../models';
|
|
14
14
|
export interface CreateCheckoutRequest {
|
|
15
15
|
environmentId: string;
|
|
16
|
-
checkoutCreateRequest: CheckoutCreateRequest;
|
|
17
16
|
}
|
|
18
17
|
export interface DeleteCheckoutRequest {
|
|
19
18
|
environmentId: string;
|
|
@@ -33,15 +32,15 @@ export interface UpdateCheckoutRequest {
|
|
|
33
32
|
*/
|
|
34
33
|
export declare class CheckoutApi extends runtime.BaseAPI {
|
|
35
34
|
/**
|
|
36
|
-
*
|
|
35
|
+
* Permanently removed. Use new /flow api instead.
|
|
37
36
|
* Create a checkout
|
|
38
37
|
*/
|
|
39
|
-
createCheckoutRaw(requestParameters: CreateCheckoutRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<
|
|
38
|
+
createCheckoutRaw(requestParameters: CreateCheckoutRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
|
|
40
39
|
/**
|
|
41
|
-
*
|
|
40
|
+
* Permanently removed. Use new /flow api instead.
|
|
42
41
|
* Create a checkout
|
|
43
42
|
*/
|
|
44
|
-
createCheckout(requestParameters: CreateCheckoutRequest, initOverrides?: RequestInit): Promise<
|
|
43
|
+
createCheckout(requestParameters: CreateCheckoutRequest, initOverrides?: RequestInit): Promise<void>;
|
|
45
44
|
/**
|
|
46
45
|
* Deprecated: use new /flow api instead. Soft-deletes a checkout, preventing it from accepting new transactions.
|
|
47
46
|
* Delete a checkout
|
package/src/apis/CheckoutApi.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { BaseAPI, RequiredError, JSONApiResponse } from '../runtime.js';
|
|
1
|
+
import { BaseAPI, RequiredError, VoidApiResponse, JSONApiResponse } from '../runtime.js';
|
|
2
2
|
import '../models/AccessOutcomeEnum.js';
|
|
3
3
|
import '../models/ExchangeKeyEnum.js';
|
|
4
4
|
import '../models/ProviderEnum.js';
|
|
@@ -66,8 +66,8 @@ import '../models/ScreeningPreScreenAction.js';
|
|
|
66
66
|
import '../models/ScreeningCoreField.js';
|
|
67
67
|
import '../models/ChainalysisRiskLevel.js';
|
|
68
68
|
import { CheckoutFromJSON } from '../models/Checkout.js';
|
|
69
|
-
import { CheckoutCreateRequestToJSON } from '../models/CheckoutCreateRequest.js';
|
|
70
69
|
import '../models/CheckoutModeEnum.js';
|
|
70
|
+
import '../models/SettlementStrategyEnum.js';
|
|
71
71
|
import '../models/FlowExecutionStateEnum.js';
|
|
72
72
|
import '../models/FlowRiskStateEnum.js';
|
|
73
73
|
import '../models/FlowSettlementStateEnum.js';
|
|
@@ -113,7 +113,6 @@ import '../models/ExportModelEnum.js';
|
|
|
113
113
|
import '../models/ExportStatusEnum.js';
|
|
114
114
|
import '../models/ExternalWalletFundingDefaultChain.js';
|
|
115
115
|
import '../models/FlowModeEnum.js';
|
|
116
|
-
import '../models/SettlementStrategyEnum.js';
|
|
117
116
|
import '../models/FlowAnalyticsSummaryResponse.js';
|
|
118
117
|
import '../models/FlowCurrencyEnum.js';
|
|
119
118
|
import '../models/FlowListItem.js';
|
|
@@ -201,35 +200,29 @@ import '../models/YieldVaultSummary.js';
|
|
|
201
200
|
*/
|
|
202
201
|
class CheckoutApi extends BaseAPI {
|
|
203
202
|
/**
|
|
204
|
-
*
|
|
203
|
+
* Permanently removed. Use new /flow api instead.
|
|
205
204
|
* Create a checkout
|
|
206
205
|
*/
|
|
207
206
|
async createCheckoutRaw(requestParameters, initOverrides) {
|
|
208
207
|
if (requestParameters.environmentId === null || requestParameters.environmentId === undefined) {
|
|
209
208
|
throw new RequiredError('environmentId', 'Required parameter requestParameters.environmentId was null or undefined when calling createCheckout.');
|
|
210
209
|
}
|
|
211
|
-
if (requestParameters.checkoutCreateRequest === null || requestParameters.checkoutCreateRequest === undefined) {
|
|
212
|
-
throw new RequiredError('checkoutCreateRequest', 'Required parameter requestParameters.checkoutCreateRequest was null or undefined when calling createCheckout.');
|
|
213
|
-
}
|
|
214
210
|
const queryParameters = {};
|
|
215
211
|
const headerParameters = {};
|
|
216
|
-
headerParameters['Content-Type'] = 'application/json';
|
|
217
212
|
const response = await this.request({
|
|
218
213
|
path: `/environments/{environmentId}/checkouts`.replace(`{${"environmentId"}}`, encodeURIComponent(String(requestParameters.environmentId))),
|
|
219
214
|
method: 'POST',
|
|
220
215
|
headers: headerParameters,
|
|
221
216
|
query: queryParameters,
|
|
222
|
-
body: CheckoutCreateRequestToJSON(requestParameters.checkoutCreateRequest),
|
|
223
217
|
}, initOverrides);
|
|
224
|
-
return new
|
|
218
|
+
return new VoidApiResponse(response);
|
|
225
219
|
}
|
|
226
220
|
/**
|
|
227
|
-
*
|
|
221
|
+
* Permanently removed. Use new /flow api instead.
|
|
228
222
|
* Create a checkout
|
|
229
223
|
*/
|
|
230
224
|
async createCheckout(requestParameters, initOverrides) {
|
|
231
|
-
|
|
232
|
-
return await response.value();
|
|
225
|
+
await this.createCheckoutRaw(requestParameters, initOverrides);
|
|
233
226
|
}
|
|
234
227
|
/**
|
|
235
228
|
* Deprecated: use new /flow api instead. Soft-deletes a checkout, preventing it from accepting new transactions.
|
|
@@ -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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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) {
|
package/src/index.cjs
CHANGED
|
@@ -481,6 +481,7 @@ var InlineResponse2008 = require('./models/InlineResponse2008.cjs');
|
|
|
481
481
|
var InlineResponse2009 = require('./models/InlineResponse2009.cjs');
|
|
482
482
|
var InlineResponse201 = require('./models/InlineResponse201.cjs');
|
|
483
483
|
var InlineResponse400 = require('./models/InlineResponse400.cjs');
|
|
484
|
+
var InlineResponse410 = require('./models/InlineResponse410.cjs');
|
|
484
485
|
var IntegrationSetting = require('./models/IntegrationSetting.cjs');
|
|
485
486
|
var InternalBulkUpdateUserFields = require('./models/InternalBulkUpdateUserFields.cjs');
|
|
486
487
|
var InternalBulkUpdateUserFieldsAllOf = require('./models/InternalBulkUpdateUserFieldsAllOf.cjs');
|
|
@@ -2771,6 +2772,9 @@ exports.InlineResponse201ToJSON = InlineResponse201.InlineResponse201ToJSON;
|
|
|
2771
2772
|
exports.InlineResponse400FromJSON = InlineResponse400.InlineResponse400FromJSON;
|
|
2772
2773
|
exports.InlineResponse400FromJSONTyped = InlineResponse400.InlineResponse400FromJSONTyped;
|
|
2773
2774
|
exports.InlineResponse400ToJSON = InlineResponse400.InlineResponse400ToJSON;
|
|
2775
|
+
exports.InlineResponse410FromJSON = InlineResponse410.InlineResponse410FromJSON;
|
|
2776
|
+
exports.InlineResponse410FromJSONTyped = InlineResponse410.InlineResponse410FromJSONTyped;
|
|
2777
|
+
exports.InlineResponse410ToJSON = InlineResponse410.InlineResponse410ToJSON;
|
|
2774
2778
|
exports.IntegrationSettingFromJSON = IntegrationSetting.IntegrationSettingFromJSON;
|
|
2775
2779
|
exports.IntegrationSettingFromJSONTyped = IntegrationSetting.IntegrationSettingFromJSONTyped;
|
|
2776
2780
|
exports.IntegrationSettingToJSON = IntegrationSetting.IntegrationSettingToJSON;
|
package/src/index.js
CHANGED
|
@@ -477,6 +477,7 @@ export { InlineResponse2008FromJSON, InlineResponse2008FromJSONTyped, InlineResp
|
|
|
477
477
|
export { InlineResponse2009FromJSON, InlineResponse2009FromJSONTyped, InlineResponse2009ToJSON } from './models/InlineResponse2009.js';
|
|
478
478
|
export { InlineResponse201FromJSON, InlineResponse201FromJSONTyped, InlineResponse201ToJSON } from './models/InlineResponse201.js';
|
|
479
479
|
export { InlineResponse400FromJSON, InlineResponse400FromJSONTyped, InlineResponse400ToJSON } from './models/InlineResponse400.js';
|
|
480
|
+
export { InlineResponse410FromJSON, InlineResponse410FromJSONTyped, InlineResponse410ToJSON } from './models/InlineResponse410.js';
|
|
480
481
|
export { IntegrationSettingFromJSON, IntegrationSettingFromJSONTyped, IntegrationSettingToJSON } from './models/IntegrationSetting.js';
|
|
481
482
|
export { InternalBulkUpdateUserFieldsFromJSON, InternalBulkUpdateUserFieldsFromJSONTyped, InternalBulkUpdateUserFieldsToJSON } from './models/InternalBulkUpdateUserFields.js';
|
|
482
483
|
export { InternalBulkUpdateUserFieldsAllOfFromJSON, InternalBulkUpdateUserFieldsAllOfFromJSONTyped, InternalBulkUpdateUserFieldsAllOfToJSON } from './models/InternalBulkUpdateUserFieldsAllOf.js';
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
|
+
|
|
5
|
+
var runtime = require('../runtime.cjs');
|
|
6
|
+
|
|
7
|
+
/* tslint:disable */
|
|
8
|
+
function InlineResponse410FromJSON(json) {
|
|
9
|
+
return InlineResponse410FromJSONTyped(json);
|
|
10
|
+
}
|
|
11
|
+
function InlineResponse410FromJSONTyped(json, ignoreDiscriminator) {
|
|
12
|
+
if ((json === undefined) || (json === null)) {
|
|
13
|
+
return json;
|
|
14
|
+
}
|
|
15
|
+
return {
|
|
16
|
+
'error': !runtime.exists(json, 'error') ? undefined : json['error'],
|
|
17
|
+
};
|
|
18
|
+
}
|
|
19
|
+
function InlineResponse410ToJSON(value) {
|
|
20
|
+
if (value === undefined) {
|
|
21
|
+
return undefined;
|
|
22
|
+
}
|
|
23
|
+
if (value === null) {
|
|
24
|
+
return null;
|
|
25
|
+
}
|
|
26
|
+
return {
|
|
27
|
+
'error': value.error,
|
|
28
|
+
};
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
exports.InlineResponse410FromJSON = InlineResponse410FromJSON;
|
|
32
|
+
exports.InlineResponse410FromJSONTyped = InlineResponse410FromJSONTyped;
|
|
33
|
+
exports.InlineResponse410ToJSON = InlineResponse410ToJSON;
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Dashboard API
|
|
3
|
+
* Dashboard API documentation
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface InlineResponse410
|
|
16
|
+
*/
|
|
17
|
+
export interface InlineResponse410 {
|
|
18
|
+
/**
|
|
19
|
+
* Human-readable error message
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof InlineResponse410
|
|
22
|
+
*/
|
|
23
|
+
error?: string;
|
|
24
|
+
}
|
|
25
|
+
export declare function InlineResponse410FromJSON(json: any): InlineResponse410;
|
|
26
|
+
export declare function InlineResponse410FromJSONTyped(json: any, ignoreDiscriminator: boolean): InlineResponse410;
|
|
27
|
+
export declare function InlineResponse410ToJSON(value?: InlineResponse410 | null): any;
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { exists } from '../runtime.js';
|
|
2
|
+
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
function InlineResponse410FromJSON(json) {
|
|
5
|
+
return InlineResponse410FromJSONTyped(json);
|
|
6
|
+
}
|
|
7
|
+
function InlineResponse410FromJSONTyped(json, ignoreDiscriminator) {
|
|
8
|
+
if ((json === undefined) || (json === null)) {
|
|
9
|
+
return json;
|
|
10
|
+
}
|
|
11
|
+
return {
|
|
12
|
+
'error': !exists(json, 'error') ? undefined : json['error'],
|
|
13
|
+
};
|
|
14
|
+
}
|
|
15
|
+
function InlineResponse410ToJSON(value) {
|
|
16
|
+
if (value === undefined) {
|
|
17
|
+
return undefined;
|
|
18
|
+
}
|
|
19
|
+
if (value === null) {
|
|
20
|
+
return null;
|
|
21
|
+
}
|
|
22
|
+
return {
|
|
23
|
+
'error': value.error,
|
|
24
|
+
};
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
export { InlineResponse410FromJSON, InlineResponse410FromJSONTyped, InlineResponse410ToJSON };
|
|
@@ -66,9 +66,9 @@ export interface SanctionsWalletBlockedEventPayload {
|
|
|
66
66
|
*/
|
|
67
67
|
sanctionCheckRequestId: string;
|
|
68
68
|
/**
|
|
69
|
-
*
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
-
*
|
|
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,
|
|
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,
|
|
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?"
|
|
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,
|
|
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,
|
|
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
|
|
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
|
-
*
|
|
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
|
|
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
|
-
*
|
|
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
|
|
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
|
-
*
|
|
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
|
-
*
|
|
20
|
-
*
|
|
21
|
-
* and block on transactions, or skip the paid
|
|
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
|
-
*
|
|
14
|
-
*
|
|
15
|
-
* and block on transactions, or skip the paid
|
|
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
|
-
*
|
|
16
|
-
*
|
|
17
|
-
* and block on transactions, or skip the paid
|
|
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
|
|
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
|
|
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
|
|
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
|
-
*
|
|
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
|
|
19
|
+
* Whether the paid provider call happens. SCREEN when no rule matches.
|
|
20
20
|
* @export
|
|
21
21
|
* @enum {string}
|
|
22
22
|
*/
|
|
@@ -12,14 +12,14 @@
|
|
|
12
12
|
import { ScreeningCoreField } from './ScreeningCoreField';
|
|
13
13
|
import { ScreeningOperator } from './ScreeningOperator';
|
|
14
14
|
/**
|
|
15
|
-
* Boolean expression over the
|
|
16
|
-
* decides whether the
|
|
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
|
-
*
|
|
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
|
|
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
|
|
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
|
-
*
|
|
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
|
|
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
|
-
*
|
|
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
|
|
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
|
-
*
|
|
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
|
|
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
|
-
*
|
|
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
|
|
57
|
+
* rows do not retain provider categories).
|
|
58
58
|
* @type {Array<string>}
|
|
59
59
|
* @memberof WalletAddressScreeningBlockedEventPayload
|
|
60
60
|
*/
|
package/src/models/index.d.ts
CHANGED
|
@@ -424,6 +424,7 @@ export * from './InlineResponse2008';
|
|
|
424
424
|
export * from './InlineResponse2009';
|
|
425
425
|
export * from './InlineResponse201';
|
|
426
426
|
export * from './InlineResponse400';
|
|
427
|
+
export * from './InlineResponse410';
|
|
427
428
|
export * from './IntegrationSetting';
|
|
428
429
|
export * from './InternalBulkUpdateUserFields';
|
|
429
430
|
export * from './InternalBulkUpdateUserFieldsAllOf';
|