didit-sdk 2.20.1 → 2.21.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +7 -0
- data/lib/didit/resources/address_validation.rb +3 -0
- data/lib/didit/resources/age_estimation.rb +3 -0
- data/lib/didit/resources/bank.rb +14 -3
- data/lib/didit/resources/biometric_templates.rb +6 -1
- data/lib/didit/resources/blocklist.rb +6 -0
- data/lib/didit/resources/businesses.rb +29 -3
- data/lib/didit/resources/cases.rb +204 -35
- data/lib/didit/resources/customization.rb +3 -0
- data/lib/didit/resources/database_validation.rb +3 -0
- data/lib/didit/resources/document_ai.rb +3 -0
- data/lib/didit/resources/email.rb +17 -1
- data/lib/didit/resources/face_match.rb +3 -0
- data/lib/didit/resources/face_search.rb +3 -0
- data/lib/didit/resources/fraud_checks.rb +6 -0
- data/lib/didit/resources/id_verification.rb +3 -0
- data/lib/didit/resources/id_wallets.rb +9 -3
- data/lib/didit/resources/investigator.rb +12 -2
- data/lib/didit/resources/ip.rb +3 -0
- data/lib/didit/resources/kyb.rb +26 -2
- data/lib/didit/resources/lists.rb +18 -5
- data/lib/didit/resources/monitoring_events.rb +12 -2
- data/lib/didit/resources/networks.rb +12 -4
- data/lib/didit/resources/passive_liveness.rb +3 -0
- data/lib/didit/resources/phone.rb +9 -0
- data/lib/didit/resources/proof_of_address.rb +3 -0
- data/lib/didit/resources/questionnaires.rb +9 -1
- data/lib/didit/resources/regulatory_reports.rb +15 -3
- data/lib/didit/resources/report_templates.rb +9 -2
- data/lib/didit/resources/reports.rb +3 -0
- data/lib/didit/resources/sessions.rb +170 -29
- data/lib/didit/resources/transactions.rb +51 -8
- data/lib/didit/resources/travel_rule.rb +115 -24
- data/lib/didit/resources/users.rb +23 -3
- data/lib/didit/resources/wallet_screening.rb +3 -1
- data/lib/didit/resources/webhooks.rb +23 -3
- data/lib/didit/resources/workflows.rb +11 -3
- data/lib/didit/types/sessions.rb +22 -0
- data/lib/didit/types.rb +1 -0
- data/lib/didit/version.rb +1 -1
- data/sig/didit/resources/address_validation.rbs +1 -1
- data/sig/didit/resources/age_estimation.rbs +1 -1
- data/sig/didit/resources/bank.rbs +1 -1
- data/sig/didit/resources/biometric_templates.rbs +2 -2
- data/sig/didit/resources/blocklist.rbs +2 -2
- data/sig/didit/resources/businesses.rbs +7 -7
- data/sig/didit/resources/cases.rbs +44 -44
- data/sig/didit/resources/customization.rbs +1 -1
- data/sig/didit/resources/database_validation.rbs +1 -1
- data/sig/didit/resources/document_ai.rbs +1 -1
- data/sig/didit/resources/email.rbs +3 -3
- data/sig/didit/resources/face_match.rbs +1 -1
- data/sig/didit/resources/face_search.rbs +1 -1
- data/sig/didit/resources/fraud_checks.rbs +2 -2
- data/sig/didit/resources/id_verification.rbs +1 -1
- data/sig/didit/resources/id_wallets.rbs +3 -3
- data/sig/didit/resources/investigator.rbs +4 -4
- data/sig/didit/resources/ip.rbs +1 -1
- data/sig/didit/resources/kyb.rbs +4 -4
- data/sig/didit/resources/lists.rbs +6 -6
- data/sig/didit/resources/monitoring_events.rbs +4 -4
- data/sig/didit/resources/networks.rbs +4 -4
- data/sig/didit/resources/passive_liveness.rbs +1 -1
- data/sig/didit/resources/phone.rbs +3 -3
- data/sig/didit/resources/proof_of_address.rbs +1 -1
- data/sig/didit/resources/questionnaires.rbs +3 -3
- data/sig/didit/resources/regulatory_reports.rbs +5 -5
- data/sig/didit/resources/report_templates.rbs +3 -3
- data/sig/didit/resources/reports.rbs +1 -1
- data/sig/didit/resources/sessions.rbs +39 -39
- data/sig/didit/resources/transactions.rbs +15 -15
- data/sig/didit/resources/travel_rule.rbs +33 -33
- data/sig/didit/resources/users.rbs +7 -7
- data/sig/didit/resources/wallet_screening.rbs +1 -1
- data/sig/didit/resources/webhooks.rbs +5 -5
- data/sig/didit/resources/workflows.rbs +3 -3
- data/sig/didit/types/sessions.rbs +21 -0
- metadata +1 -1
|
@@ -40,6 +40,7 @@ module Didit
|
|
|
40
40
|
# @param face_retention_days [Integer] Number of days the image-free biometric template is kept when
|
|
41
41
|
# `retain_face_embeddings` is `true`. Required with it, and rejected without it with a `400` on
|
|
42
42
|
# `face_retention_days`.
|
|
43
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
43
44
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
44
45
|
# @return [Didit::Types::UsersBatchDeleteResponse]
|
|
45
46
|
def batch_delete(
|
|
@@ -48,6 +49,7 @@ module Didit
|
|
|
48
49
|
delete_all: OMIT,
|
|
49
50
|
retain_face_embeddings: OMIT,
|
|
50
51
|
face_retention_days: OMIT,
|
|
52
|
+
idempotency_key: OMIT,
|
|
51
53
|
request_options: nil
|
|
52
54
|
)
|
|
53
55
|
@client.request(
|
|
@@ -60,6 +62,7 @@ module Didit
|
|
|
60
62
|
"retain_face_embeddings" => retain_face_embeddings,
|
|
61
63
|
"face_retention_days" => face_retention_days
|
|
62
64
|
},
|
|
65
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
63
66
|
response: Types::UsersBatchDeleteResponse,
|
|
64
67
|
request_options: request_options
|
|
65
68
|
)
|
|
@@ -68,7 +71,8 @@ module Didit
|
|
|
68
71
|
# Create user
|
|
69
72
|
#
|
|
70
73
|
# Create a [user](/entities/users) by `vendor_data`, before or without a verification session. `vendor_data`
|
|
71
|
-
# must be unique among the application's users (a duplicate returns `400`). Not idempotent
|
|
74
|
+
# must be unique among the application's users (a duplicate returns `400`). Not idempotent without an
|
|
75
|
+
# `Idempotency-Key`.
|
|
72
76
|
#
|
|
73
77
|
# **Contact details:** `email` and `phone_number` are stored in `metadata.contact`, and `country` in
|
|
74
78
|
# `metadata.address`. When you send `first_name` or `last_name` without `full_name`, Didit joins them into
|
|
@@ -116,6 +120,7 @@ module Didit
|
|
|
116
120
|
# @param language [String] Language of the verification email, as a [supported
|
|
117
121
|
# language](/integration/supported-languages) code. English when omitted. Ignored when `send_verification_link`
|
|
118
122
|
# is not `true`.
|
|
123
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
119
124
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
120
125
|
# @return [Didit::Types::UsersCreateResponse]
|
|
121
126
|
def create(
|
|
@@ -136,6 +141,7 @@ module Didit
|
|
|
136
141
|
send_verification_link: OMIT,
|
|
137
142
|
workflow_id: OMIT,
|
|
138
143
|
language: OMIT,
|
|
144
|
+
idempotency_key: OMIT,
|
|
139
145
|
request_options: nil
|
|
140
146
|
)
|
|
141
147
|
@client.request(
|
|
@@ -160,6 +166,7 @@ module Didit
|
|
|
160
166
|
"workflow_id" => workflow_id,
|
|
161
167
|
"language" => language
|
|
162
168
|
},
|
|
169
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
163
170
|
response: Types::UsersCreateResponse,
|
|
164
171
|
request_options: request_options
|
|
165
172
|
)
|
|
@@ -337,6 +344,7 @@ module Didit
|
|
|
337
344
|
# @param vendor_data_list [Array<String>] Your own identifiers of the users to toggle, matched exactly as sent.
|
|
338
345
|
# @param didit_internal_id_list [Array<String>] Didit internal ids of the users to toggle - the
|
|
339
346
|
# `didit_internal_id` returned by the create, get and list endpoints.
|
|
347
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
340
348
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
341
349
|
# @return [Didit::Types::AMLMonitoringToggleResult, Didit::Types::AMLMonitoringJob]
|
|
342
350
|
def set_aml_monitoring(
|
|
@@ -344,6 +352,7 @@ module Didit
|
|
|
344
352
|
estimate_only: OMIT,
|
|
345
353
|
vendor_data_list: OMIT,
|
|
346
354
|
didit_internal_id_list: OMIT,
|
|
355
|
+
idempotency_key: OMIT,
|
|
347
356
|
request_options: nil
|
|
348
357
|
)
|
|
349
358
|
@client.request(
|
|
@@ -355,6 +364,7 @@ module Didit
|
|
|
355
364
|
"vendor_data_list" => vendor_data_list,
|
|
356
365
|
"didit_internal_id_list" => didit_internal_id_list
|
|
357
366
|
},
|
|
367
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
358
368
|
response: { 200 => Types::AMLMonitoringToggleResult, 202 => Types::AMLMonitoringJob },
|
|
359
369
|
request_options: request_options
|
|
360
370
|
)
|
|
@@ -379,6 +389,7 @@ module Didit
|
|
|
379
389
|
# @param filter_date_from [Date, String]
|
|
380
390
|
# @param filter_date_to [Date, String]
|
|
381
391
|
# @param didit_internal_id_list [Array<String>] Entities to toggle. Required unless update_all is true.
|
|
392
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
382
393
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
383
394
|
# @return [Didit::Types::OngoingMonitoringToggleResult, Didit::Types::OngoingMonitoringJob]
|
|
384
395
|
def set_ongoing_monitoring(
|
|
@@ -391,6 +402,7 @@ module Didit
|
|
|
391
402
|
filter_date_from: OMIT,
|
|
392
403
|
filter_date_to: OMIT,
|
|
393
404
|
didit_internal_id_list: OMIT,
|
|
405
|
+
idempotency_key: OMIT,
|
|
394
406
|
request_options: nil
|
|
395
407
|
)
|
|
396
408
|
@client.request(
|
|
@@ -407,6 +419,7 @@ module Didit
|
|
|
407
419
|
"filter_date_to" => filter_date_to,
|
|
408
420
|
"didit_internal_id_list" => didit_internal_id_list
|
|
409
421
|
},
|
|
422
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
410
423
|
scope: :application,
|
|
411
424
|
response: { 200 => Types::OngoingMonitoringToggleResult, 202 => Types::OngoingMonitoringJob },
|
|
412
425
|
request_options: request_options
|
|
@@ -440,6 +453,7 @@ module Didit
|
|
|
440
453
|
# @param reason [String, nil] Why the status changed. Recorded on the status-change entry of the user's activity
|
|
441
454
|
# (`comments[].comment`, and **Activity** in the Business Console), only when the status actually changes.
|
|
442
455
|
# Webhooks do not carry it.
|
|
456
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
443
457
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
444
458
|
# @return [Didit::Types::UserDetailItem]
|
|
445
459
|
def update(
|
|
@@ -453,6 +467,7 @@ module Didit
|
|
|
453
467
|
approved_phones: OMIT,
|
|
454
468
|
issuing_states: OMIT,
|
|
455
469
|
reason: OMIT,
|
|
470
|
+
idempotency_key: OMIT,
|
|
456
471
|
request_options: nil
|
|
457
472
|
)
|
|
458
473
|
@client.request(
|
|
@@ -470,6 +485,7 @@ module Didit
|
|
|
470
485
|
"issuing_states" => issuing_states,
|
|
471
486
|
"reason" => reason
|
|
472
487
|
},
|
|
488
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
473
489
|
response: Types::UserDetailItem,
|
|
474
490
|
request_options: request_options
|
|
475
491
|
)
|
|
@@ -490,9 +506,10 @@ module Didit
|
|
|
490
506
|
# @param reason [String, nil] Why the status changed. Recorded on the status-change entry of the user's activity
|
|
491
507
|
# (`comments[].comment`, and **Activity** in the Business Console), only when the status actually changes.
|
|
492
508
|
# Webhooks do not carry it.
|
|
509
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
493
510
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
494
511
|
# @return [Didit::Types::UserDetailItem]
|
|
495
|
-
def update_status(vendor_data, status:, reason: OMIT, request_options: nil)
|
|
512
|
+
def update_status(vendor_data, status:, reason: OMIT, idempotency_key: OMIT, request_options: nil)
|
|
496
513
|
@client.request(
|
|
497
514
|
:patch,
|
|
498
515
|
"/v3/users/{vendor_data}/update-status/",
|
|
@@ -501,6 +518,7 @@ module Didit
|
|
|
501
518
|
"status" => status,
|
|
502
519
|
"reason" => reason
|
|
503
520
|
},
|
|
521
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
504
522
|
response: Types::UserDetailItem,
|
|
505
523
|
request_options: request_options
|
|
506
524
|
)
|
|
@@ -519,9 +537,10 @@ module Didit
|
|
|
519
537
|
# @param image [String] Raw base64-encoded JPG or PNG face image. Do not include a `data:image/...;base64,`
|
|
520
538
|
# prefix. Max decoded size: 2 MB.
|
|
521
539
|
# @param comment [String] Optional operator-visible note for the uploaded face.
|
|
540
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
522
541
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
523
542
|
# @return [Didit::Types::UsersUploadFaceResponse]
|
|
524
|
-
def upload_face(didit_internal_id, image:, comment: OMIT, request_options: nil)
|
|
543
|
+
def upload_face(didit_internal_id, image:, comment: OMIT, idempotency_key: OMIT, request_options: nil)
|
|
525
544
|
@client.request(
|
|
526
545
|
:post,
|
|
527
546
|
"/v3/organization/{organization_id}/application/{application_id}/vendor-users/by-id/{didit_internal_id}/faces/upload/",
|
|
@@ -530,6 +549,7 @@ module Didit
|
|
|
530
549
|
"image" => image,
|
|
531
550
|
"comment" => comment
|
|
532
551
|
},
|
|
552
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
533
553
|
scope: :application,
|
|
534
554
|
response: Types::UsersUploadFaceResponse,
|
|
535
555
|
request_options: request_options
|
|
@@ -25,9 +25,10 @@ module Didit
|
|
|
25
25
|
# (withdrawal) counterparty. Accepts `inbound`, `outbound`, `deposit`, or `withdrawal`. Defaults to a neutral
|
|
26
26
|
# pre-transfer screen when omitted. This is passed to the provider as context only; it does not change the
|
|
27
27
|
# returned `risk_score`, `severity`, or the `source_of_funds`/`destination_of_funds` breakdowns, which a...
|
|
28
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
28
29
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
29
30
|
# @return [Didit::Types::WalletScreeningResult]
|
|
30
|
-
def screen(wallet_address:, blockchain: OMIT, direction: OMIT, request_options: nil)
|
|
31
|
+
def screen(wallet_address:, blockchain: OMIT, direction: OMIT, idempotency_key: OMIT, request_options: nil)
|
|
31
32
|
@client.request(
|
|
32
33
|
:post,
|
|
33
34
|
"/v3/wallet-screening/",
|
|
@@ -36,6 +37,7 @@ module Didit
|
|
|
36
37
|
"blockchain" => blockchain,
|
|
37
38
|
"direction" => direction
|
|
38
39
|
},
|
|
40
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
39
41
|
response: Types::WalletScreeningResult,
|
|
40
42
|
request_options: request_options
|
|
41
43
|
)
|
|
@@ -78,6 +78,7 @@ module Didit
|
|
|
78
78
|
# may send the user back to with a session callback. Server-to-server calls are not affected. An empty list
|
|
79
79
|
# means no restriction. Didit stores each origin in lower case without a default port. An invalid entry fails
|
|
80
80
|
# with `400` o...
|
|
81
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
81
82
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
82
83
|
# @return [Didit::Types::WebhookConfig]
|
|
83
84
|
def update_config(
|
|
@@ -91,6 +92,7 @@ module Didit
|
|
|
91
92
|
biometric_consent_mode: OMIT,
|
|
92
93
|
allowed_return_hosts: OMIT,
|
|
93
94
|
allowed_domains: OMIT,
|
|
95
|
+
idempotency_key: OMIT,
|
|
94
96
|
request_options: nil
|
|
95
97
|
)
|
|
96
98
|
@client.request(
|
|
@@ -108,6 +110,7 @@ module Didit
|
|
|
108
110
|
"allowed_return_hosts" => allowed_return_hosts,
|
|
109
111
|
"allowed_domains" => allowed_domains
|
|
110
112
|
},
|
|
113
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
111
114
|
response: Types::WebhookConfig,
|
|
112
115
|
request_options: request_options
|
|
113
116
|
)
|
|
@@ -135,9 +138,18 @@ module Didit
|
|
|
135
138
|
# format; older versions are kept for backward compatibility with legacy integrations.
|
|
136
139
|
# @param subscribed_events [Array<String>] Events to deliver. Effectively required: an explicit `[]` is
|
|
137
140
|
# rejected with 400, and omitting the field creates a destination with no subscriptions that receives nothing.
|
|
141
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
138
142
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
139
143
|
# @return [Didit::Types::WebhooksDestinationsCreateResponse]
|
|
140
|
-
def create(
|
|
144
|
+
def create(
|
|
145
|
+
label:,
|
|
146
|
+
url:,
|
|
147
|
+
enabled: OMIT,
|
|
148
|
+
webhook_version: OMIT,
|
|
149
|
+
subscribed_events: OMIT,
|
|
150
|
+
idempotency_key: OMIT,
|
|
151
|
+
request_options: nil
|
|
152
|
+
)
|
|
141
153
|
@client.request(
|
|
142
154
|
:post,
|
|
143
155
|
"/v3/webhook/destinations/",
|
|
@@ -148,6 +160,7 @@ module Didit
|
|
|
148
160
|
"webhook_version" => webhook_version,
|
|
149
161
|
"subscribed_events" => subscribed_events
|
|
150
162
|
},
|
|
163
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
151
164
|
response: Types::WebhooksDestinationsCreateResponse,
|
|
152
165
|
request_options: request_options
|
|
153
166
|
)
|
|
@@ -166,13 +179,15 @@ module Didit
|
|
|
166
179
|
# +DELETE /v3/webhook/destinations/{destination_uuid}/+
|
|
167
180
|
#
|
|
168
181
|
# @param destination_uuid [String] UUID of the destination to delete.
|
|
182
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
169
183
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
170
184
|
# @return [nil]
|
|
171
|
-
def delete(destination_uuid, request_options: nil)
|
|
185
|
+
def delete(destination_uuid, idempotency_key: OMIT, request_options: nil)
|
|
172
186
|
@client.request(
|
|
173
187
|
:delete,
|
|
174
188
|
"/v3/webhook/destinations/{destination_uuid}/",
|
|
175
189
|
path_params: { "destination_uuid" => destination_uuid },
|
|
190
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
176
191
|
request_options: request_options
|
|
177
192
|
)
|
|
178
193
|
end
|
|
@@ -290,13 +305,15 @@ module Didit
|
|
|
290
305
|
# @param destination_uuid [String] UUID of the destination the delivery was sent to.
|
|
291
306
|
# @param delivery_uuid [String] UUID of the delivery to resend: the `uuid` of an entry returned by `GET
|
|
292
307
|
# /v3/webhook/destinations/{destination_uuid}/deliveries/`.
|
|
308
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
293
309
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
294
310
|
# @return [Didit::Types::WebhookDestinationDeliveryDetail]
|
|
295
|
-
def resend_delivery(destination_uuid, delivery_uuid, request_options: nil)
|
|
311
|
+
def resend_delivery(destination_uuid, delivery_uuid, idempotency_key: OMIT, request_options: nil)
|
|
296
312
|
@client.request(
|
|
297
313
|
:post,
|
|
298
314
|
"/v3/webhook/destinations/{destination_uuid}/deliveries/{delivery_uuid}/resend/",
|
|
299
315
|
path_params: { "destination_uuid" => destination_uuid, "delivery_uuid" => delivery_uuid },
|
|
316
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
300
317
|
response: Types::WebhookDestinationDeliveryDetail,
|
|
301
318
|
request_options: request_options
|
|
302
319
|
)
|
|
@@ -400,6 +417,7 @@ module Didit
|
|
|
400
417
|
# sent, the list must contain at least one valid event (an explicit `[]` is rejected with 400); a destination
|
|
401
418
|
# whose list is empty (field omitted at create) receives nothing. On update the list is replaced wholesale,
|
|
402
419
|
# never merged.
|
|
420
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
403
421
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
404
422
|
# @return [Didit::Types::WebhooksDestinationsUpdateResponse]
|
|
405
423
|
def update(
|
|
@@ -409,6 +427,7 @@ module Didit
|
|
|
409
427
|
enabled: OMIT,
|
|
410
428
|
webhook_version: OMIT,
|
|
411
429
|
subscribed_events: OMIT,
|
|
430
|
+
idempotency_key: OMIT,
|
|
412
431
|
request_options: nil
|
|
413
432
|
)
|
|
414
433
|
@client.request(
|
|
@@ -422,6 +441,7 @@ module Didit
|
|
|
422
441
|
"webhook_version" => webhook_version,
|
|
423
442
|
"subscribed_events" => subscribed_events
|
|
424
443
|
},
|
|
444
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
425
445
|
response: Types::WebhooksDestinationsUpdateResponse,
|
|
426
446
|
request_options: request_options
|
|
427
447
|
)
|
|
@@ -9,8 +9,8 @@ module Didit
|
|
|
9
9
|
#
|
|
10
10
|
# Create a simple workflow. Send `features` in execution order (ordering rules apply); defaults to `published`
|
|
11
11
|
# v1. The body accepts ONLY the fields listed in `SimpleWorkflowRequest` - any other key (including
|
|
12
|
-
# `workflow_type`) is rejected with a 400.
|
|
13
|
-
# workflows per application.
|
|
12
|
+
# `workflow_type`) is rejected with a 400. Without an `Idempotency-Key` each call creates a new workflow.
|
|
13
|
+
# Maximum 50 workflows per application.
|
|
14
14
|
#
|
|
15
15
|
# +POST /v3/workflows/+
|
|
16
16
|
#
|
|
@@ -40,6 +40,7 @@ module Didit
|
|
|
40
40
|
# feature-level config overrides it.
|
|
41
41
|
# @param session_expiration_time [Integer] Seconds before an unfinished session expires. Minimum 1 hour (3600),
|
|
42
42
|
# maximum 4 weeks (2419200).
|
|
43
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
43
44
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
44
45
|
# @return [Didit::Types::WorkflowDetail]
|
|
45
46
|
def create(
|
|
@@ -55,6 +56,7 @@ module Didit
|
|
|
55
56
|
face_liveness_max_attempts: OMIT,
|
|
56
57
|
face_match_max_attempts: OMIT,
|
|
57
58
|
session_expiration_time: OMIT,
|
|
59
|
+
idempotency_key: OMIT,
|
|
58
60
|
request_options: nil
|
|
59
61
|
)
|
|
60
62
|
@client.request(
|
|
@@ -74,6 +76,7 @@ module Didit
|
|
|
74
76
|
"face_match_max_attempts" => face_match_max_attempts,
|
|
75
77
|
"session_expiration_time" => session_expiration_time
|
|
76
78
|
},
|
|
79
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
77
80
|
response: Types::WorkflowDetail,
|
|
78
81
|
request_options: request_options
|
|
79
82
|
)
|
|
@@ -87,13 +90,15 @@ module Didit
|
|
|
87
90
|
# +DELETE /v3/workflows/{settings_uuid}/+
|
|
88
91
|
#
|
|
89
92
|
# @param settings_uuid [String] Per-version UUID of the workflow to delete.
|
|
93
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
90
94
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
91
95
|
# @return [nil]
|
|
92
|
-
def delete(settings_uuid, request_options: nil)
|
|
96
|
+
def delete(settings_uuid, idempotency_key: OMIT, request_options: nil)
|
|
93
97
|
@client.request(
|
|
94
98
|
:delete,
|
|
95
99
|
"/v3/workflows/{settings_uuid}/",
|
|
96
100
|
path_params: { "settings_uuid" => settings_uuid },
|
|
101
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
97
102
|
request_options: request_options
|
|
98
103
|
)
|
|
99
104
|
end
|
|
@@ -181,6 +186,7 @@ module Didit
|
|
|
181
186
|
# into generated face-match workflow nodes unless the feature-level config overrides it.
|
|
182
187
|
# @param session_expiration_time [Integer] Seconds before an unfinished session expires. Minimum 1 hour (3600),
|
|
183
188
|
# maximum 4 weeks (2419200).
|
|
189
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
184
190
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
185
191
|
# @return [Didit::Types::WorkflowDetail]
|
|
186
192
|
def update(
|
|
@@ -197,6 +203,7 @@ module Didit
|
|
|
197
203
|
face_liveness_max_attempts: OMIT,
|
|
198
204
|
face_match_max_attempts: OMIT,
|
|
199
205
|
session_expiration_time: OMIT,
|
|
206
|
+
idempotency_key: OMIT,
|
|
200
207
|
request_options: nil
|
|
201
208
|
)
|
|
202
209
|
@client.request(
|
|
@@ -217,6 +224,7 @@ module Didit
|
|
|
217
224
|
"face_match_max_attempts" => face_match_max_attempts,
|
|
218
225
|
"session_expiration_time" => session_expiration_time
|
|
219
226
|
},
|
|
227
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
220
228
|
response: Types::WorkflowDetail,
|
|
221
229
|
request_options: request_options
|
|
222
230
|
)
|
data/lib/didit/types/sessions.rb
CHANGED
|
@@ -361,6 +361,28 @@ module Didit
|
|
|
361
361
|
VALUES = [RETAINED_WITH_USER, DELETED, NONE, INELIGIBLE_NO_VENDOR_USER].freeze
|
|
362
362
|
end
|
|
363
363
|
|
|
364
|
+
# Known values of an open enum: the API may send others.
|
|
365
|
+
module SessionsGeneratePdfParamsLanguage
|
|
366
|
+
EN = "en"
|
|
367
|
+
ES = "es"
|
|
368
|
+
AR = "ar"
|
|
369
|
+
CA = "ca"
|
|
370
|
+
DE = "de"
|
|
371
|
+
FR = "fr"
|
|
372
|
+
HI = "hi"
|
|
373
|
+
ID = "id"
|
|
374
|
+
IT = "it"
|
|
375
|
+
JA = "ja"
|
|
376
|
+
KO = "ko"
|
|
377
|
+
PT_BR = "pt-BR"
|
|
378
|
+
PT_PT = "pt-PT"
|
|
379
|
+
RU = "ru"
|
|
380
|
+
SW = "sw"
|
|
381
|
+
ZH = "zh"
|
|
382
|
+
|
|
383
|
+
VALUES = [EN, ES, AR, CA, DE, FR, HI, ID, IT, JA, KO, PT_BR, PT_PT, RU, SW, ZH].freeze
|
|
384
|
+
end
|
|
385
|
+
|
|
364
386
|
# Migration source, from `GET /v3/session/imports/providers/`. Required when `source` is `provider`.
|
|
365
387
|
module SessionsImportsCheckProviderParamsProvider
|
|
366
388
|
SUMSUB = "sumsub"
|
data/lib/didit/types.rb
CHANGED
|
@@ -1298,6 +1298,7 @@ module Didit
|
|
|
1298
1298
|
autoload :SessionsDeleteParamsDeletionInstruction, "didit/types/sessions"
|
|
1299
1299
|
autoload :SessionsDeleteResponse, "didit/types/sessions"
|
|
1300
1300
|
autoload :SessionsDeleteResponseFaceRetentionOutcome, "didit/types/sessions"
|
|
1301
|
+
autoload :SessionsGeneratePdfParamsLanguage, "didit/types/sessions"
|
|
1301
1302
|
autoload :SessionsImportsCheckProviderParamsProvider, "didit/types/sessions"
|
|
1302
1303
|
autoload :SessionsImportsCheckProviderResponse, "didit/types/sessions"
|
|
1303
1304
|
autoload :SessionsImportsCreateParamsImportType, "didit/types/sessions"
|
data/lib/didit/version.rb
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
module Didit
|
|
4
4
|
module Resources
|
|
5
5
|
class AddressValidation < Didit::Resource
|
|
6
|
-
def validate: (country: String, ?address: String, ?address_line_1: String, ?address_line_2: String, ?city: String, ?region: String, ?postal_code: String, ?request_options: Didit::request_options?) -> Didit::Types::AddressValidationResponse
|
|
6
|
+
def validate: (country: String, ?address: String, ?address_line_1: String, ?address_line_2: String, ?city: String, ?region: String, ?postal_code: String, ?idempotency_key: String, ?request_options: Didit::request_options?) -> Didit::Types::AddressValidationResponse
|
|
7
7
|
end
|
|
8
8
|
end
|
|
9
9
|
end
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
module Didit
|
|
4
4
|
module Resources
|
|
5
5
|
class AgeEstimation < Didit::Resource
|
|
6
|
-
def estimate: (user_image: Didit::upload, ?face_liveness_score_decline_threshold: Float | Integer, ?age_estimation_decline_threshold: Integer, ?rotate_image: bool, ?save_api_request: bool, ?vendor_data: String, ?metadata: Hash[String | Symbol, untyped], ?request_options: Didit::request_options?) -> Didit::Types::AgeEstimationEstimateResponse
|
|
6
|
+
def estimate: (user_image: Didit::upload, ?face_liveness_score_decline_threshold: Float | Integer, ?age_estimation_decline_threshold: Integer, ?rotate_image: bool, ?save_api_request: bool, ?vendor_data: String, ?metadata: Hash[String | Symbol, untyped], ?idempotency_key: String, ?request_options: Didit::request_options?) -> Didit::Types::AgeEstimationEstimateResponse
|
|
7
7
|
end
|
|
8
8
|
end
|
|
9
9
|
end
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
module Didit
|
|
4
4
|
module Resources
|
|
5
5
|
class Bank < Didit::Resource
|
|
6
|
-
def account_check: (country: String, account: Didit::Types::bank_account_check_params_account, holder: (Didit::Types::bank_account_check_person_holder | Didit::Types::bank_account_check_business_holder), ?vendor_data: String?, ?consent: bool, ?request_options: Didit::request_options?) -> Didit::Types::BankAccountCheckResponse
|
|
6
|
+
def account_check: (country: String, account: Didit::Types::bank_account_check_params_account, holder: (Didit::Types::bank_account_check_person_holder | Didit::Types::bank_account_check_business_holder), ?vendor_data: String?, ?consent: bool, ?idempotency_key: String, ?request_options: Didit::request_options?) -> Didit::Types::BankAccountCheckResponse
|
|
7
7
|
end
|
|
8
8
|
end
|
|
9
9
|
end
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
module Didit
|
|
4
4
|
module Resources
|
|
5
5
|
class BiometricTemplates < Didit::Resource
|
|
6
|
-
def batch_delete: (?template_uuids: Array[String], ?delete_all: bool, ?vendor_data: String, ?vendor_user_uuid: String, ?status: String, ?source_type: String, ?retained_from: Time | String, ?retained_to: Time | String, ?request_options: Didit::request_options?) -> Didit::Types::BiometricTemplatesBatchDeleteResponse
|
|
6
|
+
def batch_delete: (?template_uuids: Array[String], ?delete_all: bool, ?vendor_data: String, ?vendor_user_uuid: String, ?status: String, ?source_type: String, ?retained_from: Time | String, ?retained_to: Time | String, ?idempotency_key: String, ?request_options: Didit::request_options?) -> Didit::Types::BiometricTemplatesBatchDeleteResponse
|
|
7
7
|
def count: (?vendor_data: String, ?vendor_user_uuid: String, ?status: String, ?source_type: String, ?retained_from: Time | String, ?retained_to: Time | String, ?request_options: Didit::request_options?) -> Didit::Types::BiometricTemplatesCountResponse
|
|
8
|
-
def delete: (String template_uuid, ?request_options: Didit::request_options?) -> Didit::Types::BiometricTemplatesDeleteResponse
|
|
8
|
+
def delete: (String template_uuid, ?idempotency_key: String, ?request_options: Didit::request_options?) -> Didit::Types::BiometricTemplatesDeleteResponse
|
|
9
9
|
def list: (?vendor_data: String, ?vendor_user_uuid: String, ?status: String, ?source_type: String, ?retained_from: Time | String, ?retained_to: Time | String, ?ordering: String, ?limit: Integer, ?offset: Integer, ?request_options: Didit::request_options?) -> Didit::Page[Didit::Types::BiometricTemplatesListResponseResults]
|
|
10
10
|
def retrieve: (String template_uuid, ?request_options: Didit::request_options?) -> Didit::Types::BiometricTemplatesRetrieveResponse
|
|
11
11
|
end
|
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
module Didit
|
|
4
4
|
module Resources
|
|
5
5
|
class Blocklist < Didit::Resource
|
|
6
|
-
def add: (session_id: String, ?blocklist_face: bool, ?blocklist_document: bool, ?blocklist_phone: bool, ?blocklist_email: bool, ?request_options: Didit::request_options?) -> Didit::Types::BlocklistAddResponse
|
|
6
|
+
def add: (session_id: String, ?blocklist_face: bool, ?blocklist_document: bool, ?blocklist_phone: bool, ?blocklist_email: bool, ?idempotency_key: String, ?request_options: Didit::request_options?) -> Didit::Types::BlocklistAddResponse
|
|
7
7
|
def list: (?item_type: String, ?limit: Integer, ?offset: Integer, ?request_options: Didit::request_options?) -> Didit::Page[Didit::Types::BlocklistedItem]
|
|
8
|
-
def remove: (session_id: String, ?unblock_face: bool, ?unblock_document: bool, ?unblock_phone: bool, ?unblock_email: bool, ?request_options: Didit::request_options?) -> Didit::Types::BlocklistRemoveResponse
|
|
8
|
+
def remove: (session_id: String, ?unblock_face: bool, ?unblock_document: bool, ?unblock_phone: bool, ?unblock_email: bool, ?idempotency_key: String, ?request_options: Didit::request_options?) -> Didit::Types::BlocklistRemoveResponse
|
|
9
9
|
end
|
|
10
10
|
end
|
|
11
11
|
end
|
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
module Didit
|
|
4
4
|
module Resources
|
|
5
5
|
class Businesses < Didit::Resource
|
|
6
|
-
def batch_delete: (?vendor_data_list: Array[String], ?didit_internal_id_list: Array[String], ?delete_all: bool, ?request_options: Didit::request_options?) -> Didit::Types::BusinessesBatchDeleteResponse
|
|
7
|
-
def create: (?vendor_data: String?, ?display_name: String?, ?legal_name: String?, ?registration_number: String?, ?country_code: String?, ?status: String, ?metadata: (Hash[String | Symbol, untyped])?, ?request_options: Didit::request_options?) -> Didit::Types::BusinessDetailItem
|
|
6
|
+
def batch_delete: (?vendor_data_list: Array[String], ?didit_internal_id_list: Array[String], ?delete_all: bool, ?idempotency_key: String, ?request_options: Didit::request_options?) -> Didit::Types::BusinessesBatchDeleteResponse
|
|
7
|
+
def create: (?vendor_data: String?, ?display_name: String?, ?legal_name: String?, ?registration_number: String?, ?country_code: String?, ?status: String, ?metadata: (Hash[String | Symbol, untyped])?, ?idempotency_key: String, ?request_options: Didit::request_options?) -> Didit::Types::BusinessDetailItem
|
|
8
8
|
def generate_session_pdf: (String business_session_id, ?request_options: Didit::request_options?) -> String
|
|
9
9
|
| (String business_session_id, ?request_options: Didit::request_options?) { (String chunk) -> void } -> nil
|
|
10
10
|
def list: (?limit: Integer, ?offset: Integer, ?request_options: Didit::request_options?) -> Didit::Page[Didit::Types::BusinessListItem]
|
|
@@ -12,11 +12,11 @@ module Didit
|
|
|
12
12
|
def retrieve: (String vendor_data, ?request_options: Didit::request_options?) -> Didit::Types::BusinessDetailItem
|
|
13
13
|
def retrieve_ongoing_monitoring_job: (String job_id, ?request_options: Didit::request_options?) -> Didit::Types::OngoingMonitoringJob
|
|
14
14
|
def retrieve_session_ongoing_monitoring_job: (String job_id, ?request_options: Didit::request_options?) -> Didit::Types::OngoingMonitoringJob
|
|
15
|
-
def set_aml_monitoring: (is_enabled: bool, ?estimate_only: bool, ?vendor_data_list: Array[String], ?didit_internal_id_list: Array[String], ?request_options: Didit::request_options?) -> (Didit::Types::AMLMonitoringToggleResult | Didit::Types::AMLMonitoringJob)
|
|
16
|
-
def set_ongoing_monitoring: (is_enabled: bool, ?estimate_only: bool, ?update_all: bool, ?filter_search: String, ?filter_status: Array[String], ?filter_country: String, ?filter_date_from: Date | String, ?filter_date_to: Date | String, ?didit_internal_id_list: Array[String], ?request_options: Didit::request_options?) -> (Didit::Types::OngoingMonitoringToggleResult | Didit::Types::OngoingMonitoringJob)
|
|
17
|
-
def set_session_ongoing_monitoring: (is_enabled: bool, ?estimate_only: bool, ?update_all: bool, ?filter_search: String, ?filter_status: Array[String], ?filter_country: String, ?filter_date_from: Date | String, ?filter_date_to: Date | String, ?session_numbers: Array[String], ?toggle_all: bool, ?filter_workflow_id: String, ?request_options: Didit::request_options?) -> (Didit::Types::OngoingMonitoringToggleResult | Didit::Types::OngoingMonitoringJob)
|
|
18
|
-
def update: (String vendor_data, ?display_name: String?, ?legal_name: String?, ?registration_number: String?, ?country_code: String?, ?status: String, ?metadata: (Hash[String | Symbol, untyped])?, ?reason: String?, ?request_options: Didit::request_options?) -> Didit::Types::BusinessDetailItem
|
|
19
|
-
def update_status: (String vendor_data, status: String, ?reason: String?, ?request_options: Didit::request_options?) -> Didit::Types::BusinessDetailItem
|
|
15
|
+
def set_aml_monitoring: (is_enabled: bool, ?estimate_only: bool, ?vendor_data_list: Array[String], ?didit_internal_id_list: Array[String], ?idempotency_key: String, ?request_options: Didit::request_options?) -> (Didit::Types::AMLMonitoringToggleResult | Didit::Types::AMLMonitoringJob)
|
|
16
|
+
def set_ongoing_monitoring: (is_enabled: bool, ?estimate_only: bool, ?update_all: bool, ?filter_search: String, ?filter_status: Array[String], ?filter_country: String, ?filter_date_from: Date | String, ?filter_date_to: Date | String, ?didit_internal_id_list: Array[String], ?idempotency_key: String, ?request_options: Didit::request_options?) -> (Didit::Types::OngoingMonitoringToggleResult | Didit::Types::OngoingMonitoringJob)
|
|
17
|
+
def set_session_ongoing_monitoring: (is_enabled: bool, ?estimate_only: bool, ?update_all: bool, ?filter_search: String, ?filter_status: Array[String], ?filter_country: String, ?filter_date_from: Date | String, ?filter_date_to: Date | String, ?session_numbers: Array[String], ?toggle_all: bool, ?filter_workflow_id: String, ?idempotency_key: String, ?request_options: Didit::request_options?) -> (Didit::Types::OngoingMonitoringToggleResult | Didit::Types::OngoingMonitoringJob)
|
|
18
|
+
def update: (String vendor_data, ?display_name: String?, ?legal_name: String?, ?registration_number: String?, ?country_code: String?, ?status: String, ?metadata: (Hash[String | Symbol, untyped])?, ?reason: String?, ?idempotency_key: String, ?request_options: Didit::request_options?) -> Didit::Types::BusinessDetailItem
|
|
19
|
+
def update_status: (String vendor_data, status: String, ?reason: String?, ?idempotency_key: String, ?request_options: Didit::request_options?) -> Didit::Types::BusinessDetailItem
|
|
20
20
|
end
|
|
21
21
|
end
|
|
22
22
|
end
|