didit-sdk 2.20.0 → 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 +14 -0
- data/lib/didit/internal/request.rb +6 -4
- 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/internal.rbs +1 -0
- 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
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: ac331e3d46bbe5b7bb01754f6ee9bd8f12dc69e5c410d0aa54700a36097ba17b
|
|
4
|
+
data.tar.gz: '0301258d0c89f4bc698c9b06f5795a5599554437125f9351fb377653b8f2b064'
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 982d1e6ccad67b658c5659a405b58689a827669e54a40f4c9965e8279a26e4bdcf0b31395e4cb0d4772477181f87740810fce4b1ee87c568525311b5c380f1e6
|
|
7
|
+
data.tar.gz: 851a02e97d1111a42fffad3bed9767770746f9a744a1be8de8a8a10f2de797f403928dbb50002bfeb5d340386d74a8f962331e26f1f8ddf36a48fa267ec7083a
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [2.21.0](https://github.com/didit-protocol/sdk-ruby/compare/v2.20.1...v2.21.0) (2026-11-16)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* **spec:** sync API spec 2026-11-16 ([9707b1a](https://github.com/didit-protocol/sdk-ruby/commit/9707b1a28fa5956410780210a0849ba7ba051a1a))
|
|
9
|
+
|
|
10
|
+
## [2.20.1](https://github.com/didit-protocol/sdk-ruby/compare/v2.20.0...v2.20.1) (2026-11-14)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Bug Fixes
|
|
14
|
+
|
|
15
|
+
* refuse an idempotency key that is not printable ASCII before any request ([#81](https://github.com/didit-protocol/sdk-ruby/issues/81)) ([dd351a8](https://github.com/didit-protocol/sdk-ruby/commit/dd351a8e93803fcec2bf70c341291025296c0255))
|
|
16
|
+
|
|
3
17
|
## [2.20.0](https://github.com/didit-protocol/sdk-ruby/compare/v2.19.0...v2.20.0) (2026-11-14)
|
|
4
18
|
|
|
5
19
|
|
|
@@ -23,6 +23,7 @@ module Didit
|
|
|
23
23
|
OPTION_KEYS = %i[timeout max_retries extra_headers extra_query extra_body idempotency_key].freeze
|
|
24
24
|
IDEMPOTENCY_HEADER = "Idempotency-Key"
|
|
25
25
|
IDEMPOTENCY_KEY_MAX = 255
|
|
26
|
+
PRINTABLE_ASCII = /\A(?:[!-~]|[!-~][ -~]*[!-~])\z/
|
|
26
27
|
KEY_METHODS = %i[post put patch delete].freeze
|
|
27
28
|
RETRYABLE_WITH_KEY = %i[post patch].freeze
|
|
28
29
|
UNRESERVED = /[^A-Za-z0-9\-._~]/
|
|
@@ -50,12 +51,13 @@ module Didit
|
|
|
50
51
|
}
|
|
51
52
|
end
|
|
52
53
|
|
|
53
|
-
# The key must be a String of 1 to 255 characters
|
|
54
|
+
# The key must be a String of 1 to 255 printable ASCII characters (space to "~") that neither start nor
|
|
55
|
+
# end with a space: it travels as an HTTP header value that the server trims.
|
|
54
56
|
def check_idempotency_key(value)
|
|
55
|
-
unless value.is_a?(String) && value.length.between?(1, IDEMPOTENCY_KEY_MAX)
|
|
57
|
+
unless value.is_a?(String) && value.length.between?(1, IDEMPOTENCY_KEY_MAX) && value.match?(PRINTABLE_ASCII)
|
|
56
58
|
shown = value.is_a?(String) ? "a String of #{value.length} characters" : value.inspect
|
|
57
|
-
raise ConfigurationError, "idempotency_key must be a String of 1 to #{IDEMPOTENCY_KEY_MAX}
|
|
58
|
-
"got #{shown}."
|
|
59
|
+
raise ConfigurationError, "idempotency_key must be a String of 1 to #{IDEMPOTENCY_KEY_MAX} printable ASCII " \
|
|
60
|
+
"characters that neither start nor end with a space, got #{shown}."
|
|
59
61
|
end
|
|
60
62
|
|
|
61
63
|
value
|
|
@@ -41,6 +41,7 @@ module Didit
|
|
|
41
41
|
# @param city [String] City or locality.
|
|
42
42
|
# @param region [String] State, province or region.
|
|
43
43
|
# @param postal_code [String]
|
|
44
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
44
45
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
45
46
|
# @return [Didit::Types::AddressValidationResponse]
|
|
46
47
|
def validate(
|
|
@@ -51,6 +52,7 @@ module Didit
|
|
|
51
52
|
city: OMIT,
|
|
52
53
|
region: OMIT,
|
|
53
54
|
postal_code: OMIT,
|
|
55
|
+
idempotency_key: OMIT,
|
|
54
56
|
request_options: nil
|
|
55
57
|
)
|
|
56
58
|
@client.request(
|
|
@@ -65,6 +67,7 @@ module Didit
|
|
|
65
67
|
"region" => region,
|
|
66
68
|
"postal_code" => postal_code
|
|
67
69
|
},
|
|
70
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
68
71
|
response: Types::AddressValidationResponse,
|
|
69
72
|
request_options: request_options
|
|
70
73
|
)
|
|
@@ -75,6 +75,7 @@ module Didit
|
|
|
75
75
|
# @param metadata [Hash] Optional JSON object stored with the session (when `save_api_request=true`) and echoed
|
|
76
76
|
# back in the response. In multipart requests, send it as a JSON-encoded string field (e.g.
|
|
77
77
|
# `metadata={"flow":"age-gate"}`) - it is parsed into an object.
|
|
78
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
78
79
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
79
80
|
# @return [Didit::Types::AgeEstimationEstimateResponse]
|
|
80
81
|
def estimate(
|
|
@@ -85,6 +86,7 @@ module Didit
|
|
|
85
86
|
save_api_request: OMIT,
|
|
86
87
|
vendor_data: OMIT,
|
|
87
88
|
metadata: OMIT,
|
|
89
|
+
idempotency_key: OMIT,
|
|
88
90
|
request_options: nil
|
|
89
91
|
)
|
|
90
92
|
@client.request(
|
|
@@ -101,6 +103,7 @@ module Didit
|
|
|
101
103
|
},
|
|
102
104
|
encoding: :multipart,
|
|
103
105
|
file_fields: %w[user_image],
|
|
106
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
104
107
|
response: Types::AgeEstimationEstimateResponse,
|
|
105
108
|
request_options: request_options
|
|
106
109
|
)
|
data/lib/didit/resources/bank.rb
CHANGED
|
@@ -26,8 +26,9 @@ module Didit
|
|
|
26
26
|
# whatever the result: a `no_match`, an account that does not exist and a `cannot_verify` are billed too. A
|
|
27
27
|
# request answered with an error is never billed.
|
|
28
28
|
#
|
|
29
|
-
# **
|
|
30
|
-
#
|
|
29
|
+
# **Retries.** Send an `Idempotency-Key` header: the same key and body return the first response, with the same
|
|
30
|
+
# `request_id`, and the check runs and is billed once. Without a key, every request is a new check and no
|
|
31
|
+
# endpoint to read a check back, so a retried request runs, and is billed, again. Store the response.
|
|
31
32
|
#
|
|
32
33
|
# **Sandbox.** Use a sandbox API key with the sample account details. A sandbox key calls no bank and is charged
|
|
33
34
|
# nothing. The last 4 characters of the IBAN, else of the account number, choose the answer: `0001` a
|
|
@@ -53,9 +54,18 @@ module Didit
|
|
|
53
54
|
# Required in the countries whose account check needs that consent: without it the check is refused with a `400`
|
|
54
55
|
# whose `field` is `consent` and whose `reason` is `required`, and nothing is billed. Elsewhere it is optional,
|
|
55
56
|
# and Didit records it with the check's charge when you send it.
|
|
57
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
56
58
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
57
59
|
# @return [Didit::Types::BankAccountCheckResponse]
|
|
58
|
-
def account_check(
|
|
60
|
+
def account_check(
|
|
61
|
+
country:,
|
|
62
|
+
account:,
|
|
63
|
+
holder:,
|
|
64
|
+
vendor_data: OMIT,
|
|
65
|
+
consent: OMIT,
|
|
66
|
+
idempotency_key: OMIT,
|
|
67
|
+
request_options: nil
|
|
68
|
+
)
|
|
59
69
|
@client.request(
|
|
60
70
|
:post,
|
|
61
71
|
"/v3/bank/account-check/",
|
|
@@ -66,6 +76,7 @@ module Didit
|
|
|
66
76
|
"vendor_data" => vendor_data,
|
|
67
77
|
"consent" => consent
|
|
68
78
|
},
|
|
79
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
69
80
|
response: Types::BankAccountCheckResponse,
|
|
70
81
|
request_options: request_options
|
|
71
82
|
)
|
|
@@ -35,6 +35,7 @@ module Didit
|
|
|
35
35
|
# @param source_type [String] Only with `delete_all`.
|
|
36
36
|
# @param retained_from [Time, String] Only with `delete_all`.
|
|
37
37
|
# @param retained_to [Time, String] Only with `delete_all`. Must not be earlier than `retained_from`.
|
|
38
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
38
39
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
39
40
|
# @return [Didit::Types::BiometricTemplatesBatchDeleteResponse]
|
|
40
41
|
def batch_delete(
|
|
@@ -46,6 +47,7 @@ module Didit
|
|
|
46
47
|
source_type: OMIT,
|
|
47
48
|
retained_from: OMIT,
|
|
48
49
|
retained_to: OMIT,
|
|
50
|
+
idempotency_key: OMIT,
|
|
49
51
|
request_options: nil
|
|
50
52
|
)
|
|
51
53
|
@client.request(
|
|
@@ -61,6 +63,7 @@ module Didit
|
|
|
61
63
|
"retained_from" => retained_from,
|
|
62
64
|
"retained_to" => retained_to
|
|
63
65
|
},
|
|
66
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
64
67
|
response: Types::BiometricTemplatesBatchDeleteResponse,
|
|
65
68
|
request_options: request_options
|
|
66
69
|
)
|
|
@@ -136,13 +139,15 @@ module Didit
|
|
|
136
139
|
#
|
|
137
140
|
# @param template_uuid [String] Template id, as returned in `biometric_template_uuid` by the session deletion
|
|
138
141
|
# endpoints, `biometric_template_id` on a Face Search match, or the list endpoint.
|
|
142
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
139
143
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
140
144
|
# @return [Didit::Types::BiometricTemplatesDeleteResponse]
|
|
141
|
-
def delete(template_uuid, request_options: nil)
|
|
145
|
+
def delete(template_uuid, idempotency_key: OMIT, request_options: nil)
|
|
142
146
|
@client.request(
|
|
143
147
|
:delete,
|
|
144
148
|
"/v3/biometric-templates/{template_uuid}/",
|
|
145
149
|
path_params: { "template_uuid" => template_uuid },
|
|
150
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
146
151
|
response: Types::BiometricTemplatesDeleteResponse,
|
|
147
152
|
request_options: request_options
|
|
148
153
|
)
|
|
@@ -23,6 +23,7 @@ module Didit
|
|
|
23
23
|
# state, document type, document number and full name.
|
|
24
24
|
# @param blocklist_phone [Boolean] Blocklist the session's phone number.
|
|
25
25
|
# @param blocklist_email [Boolean] Blocklist the session's email address.
|
|
26
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
26
27
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
27
28
|
# @return [Didit::Types::BlocklistAddResponse]
|
|
28
29
|
def add(
|
|
@@ -31,6 +32,7 @@ module Didit
|
|
|
31
32
|
blocklist_document: OMIT,
|
|
32
33
|
blocklist_phone: OMIT,
|
|
33
34
|
blocklist_email: OMIT,
|
|
35
|
+
idempotency_key: OMIT,
|
|
34
36
|
request_options: nil
|
|
35
37
|
)
|
|
36
38
|
@client.request(
|
|
@@ -43,6 +45,7 @@ module Didit
|
|
|
43
45
|
"blocklist_phone" => blocklist_phone,
|
|
44
46
|
"blocklist_email" => blocklist_email
|
|
45
47
|
},
|
|
48
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
46
49
|
response: Types::BlocklistAddResponse,
|
|
47
50
|
request_options: request_options
|
|
48
51
|
)
|
|
@@ -101,6 +104,7 @@ module Didit
|
|
|
101
104
|
# @param unblock_document [Boolean] Lift the block on the session's identity document.
|
|
102
105
|
# @param unblock_phone [Boolean] Lift the block on the session's phone number.
|
|
103
106
|
# @param unblock_email [Boolean] Lift the block on the session's email address.
|
|
107
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
104
108
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
105
109
|
# @return [Didit::Types::BlocklistRemoveResponse]
|
|
106
110
|
def remove(
|
|
@@ -109,6 +113,7 @@ module Didit
|
|
|
109
113
|
unblock_document: OMIT,
|
|
110
114
|
unblock_phone: OMIT,
|
|
111
115
|
unblock_email: OMIT,
|
|
116
|
+
idempotency_key: OMIT,
|
|
112
117
|
request_options: nil
|
|
113
118
|
)
|
|
114
119
|
@client.request(
|
|
@@ -121,6 +126,7 @@ module Didit
|
|
|
121
126
|
"unblock_phone" => unblock_phone,
|
|
122
127
|
"unblock_email" => unblock_email
|
|
123
128
|
},
|
|
129
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
124
130
|
response: Types::BlocklistRemoveResponse,
|
|
125
131
|
request_options: request_options
|
|
126
132
|
)
|
|
@@ -20,9 +20,16 @@ module Didit
|
|
|
20
20
|
# @param didit_internal_id_list [Array<String>] Didit's internal UUIDs (`didit_internal_id`) to delete.
|
|
21
21
|
# @param delete_all [Boolean] If `true`, deletes every business in the application. Cannot be combined with the
|
|
22
22
|
# list selectors.
|
|
23
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
23
24
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
24
25
|
# @return [Didit::Types::BusinessesBatchDeleteResponse]
|
|
25
|
-
def batch_delete(
|
|
26
|
+
def batch_delete(
|
|
27
|
+
vendor_data_list: OMIT,
|
|
28
|
+
didit_internal_id_list: OMIT,
|
|
29
|
+
delete_all: OMIT,
|
|
30
|
+
idempotency_key: OMIT,
|
|
31
|
+
request_options: nil
|
|
32
|
+
)
|
|
26
33
|
@client.request(
|
|
27
34
|
:post,
|
|
28
35
|
"/v3/businesses/delete/",
|
|
@@ -31,6 +38,7 @@ module Didit
|
|
|
31
38
|
"didit_internal_id_list" => didit_internal_id_list,
|
|
32
39
|
"delete_all" => delete_all
|
|
33
40
|
},
|
|
41
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
34
42
|
response: Types::BusinessesBatchDeleteResponse,
|
|
35
43
|
request_options: request_options
|
|
36
44
|
)
|
|
@@ -40,7 +48,8 @@ module Didit
|
|
|
40
48
|
#
|
|
41
49
|
# Pre-create a [business](/entities/businesses) *without* a KYB session. All fields are optional, but you should
|
|
42
50
|
# always send `vendor_data` - without it the record cannot be linked to sessions or transactions. When provided,
|
|
43
|
-
# `vendor_data` must be unique among non-deleted businesses (exact match; conflicts return 400). Not idempotent
|
|
51
|
+
# `vendor_data` must be unique among non-deleted businesses (exact match; conflicts return 400). Not idempotent
|
|
52
|
+
# without an `Idempotency-Key`.
|
|
44
53
|
#
|
|
45
54
|
# +POST /v3/businesses/create/+
|
|
46
55
|
#
|
|
@@ -54,6 +63,7 @@ module Didit
|
|
|
54
63
|
# @param country_code [String, nil] Country of incorporation (ISO 3166-1 alpha-2, e.g. `GB`, `US`).
|
|
55
64
|
# @param status [String] Initial lifecycle status. Defaults to `ACTIVE`.
|
|
56
65
|
# @param metadata [Hash, nil] Arbitrary JSON object you attach to the business. Defaults to `{}`.
|
|
66
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
57
67
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
58
68
|
# @return [Didit::Types::BusinessDetailItem]
|
|
59
69
|
def create(
|
|
@@ -64,6 +74,7 @@ module Didit
|
|
|
64
74
|
country_code: OMIT,
|
|
65
75
|
status: OMIT,
|
|
66
76
|
metadata: OMIT,
|
|
77
|
+
idempotency_key: OMIT,
|
|
67
78
|
request_options: nil
|
|
68
79
|
)
|
|
69
80
|
@client.request(
|
|
@@ -78,6 +89,7 @@ module Didit
|
|
|
78
89
|
"status" => status,
|
|
79
90
|
"metadata" => metadata
|
|
80
91
|
},
|
|
92
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
81
93
|
response: Types::BusinessDetailItem,
|
|
82
94
|
request_options: request_options
|
|
83
95
|
)
|
|
@@ -250,6 +262,7 @@ module Didit
|
|
|
250
262
|
# sent.
|
|
251
263
|
# @param didit_internal_id_list [Array<String>] Didit internal ids of the businesses to toggle - the
|
|
252
264
|
# `didit_internal_id` returned by the create, get and list endpoints.
|
|
265
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
253
266
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
254
267
|
# @return [Didit::Types::AMLMonitoringToggleResult, Didit::Types::AMLMonitoringJob]
|
|
255
268
|
def set_aml_monitoring(
|
|
@@ -257,6 +270,7 @@ module Didit
|
|
|
257
270
|
estimate_only: OMIT,
|
|
258
271
|
vendor_data_list: OMIT,
|
|
259
272
|
didit_internal_id_list: OMIT,
|
|
273
|
+
idempotency_key: OMIT,
|
|
260
274
|
request_options: nil
|
|
261
275
|
)
|
|
262
276
|
@client.request(
|
|
@@ -268,6 +282,7 @@ module Didit
|
|
|
268
282
|
"vendor_data_list" => vendor_data_list,
|
|
269
283
|
"didit_internal_id_list" => didit_internal_id_list
|
|
270
284
|
},
|
|
285
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
271
286
|
response: { 200 => Types::AMLMonitoringToggleResult, 202 => Types::AMLMonitoringJob },
|
|
272
287
|
request_options: request_options
|
|
273
288
|
)
|
|
@@ -291,6 +306,7 @@ module Didit
|
|
|
291
306
|
# @param filter_date_from [Date, String]
|
|
292
307
|
# @param filter_date_to [Date, String]
|
|
293
308
|
# @param didit_internal_id_list [Array<String>] Entities to toggle. Required unless update_all is true.
|
|
309
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
294
310
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
295
311
|
# @return [Didit::Types::OngoingMonitoringToggleResult, Didit::Types::OngoingMonitoringJob]
|
|
296
312
|
def set_ongoing_monitoring(
|
|
@@ -303,6 +319,7 @@ module Didit
|
|
|
303
319
|
filter_date_from: OMIT,
|
|
304
320
|
filter_date_to: OMIT,
|
|
305
321
|
didit_internal_id_list: OMIT,
|
|
322
|
+
idempotency_key: OMIT,
|
|
306
323
|
request_options: nil
|
|
307
324
|
)
|
|
308
325
|
@client.request(
|
|
@@ -319,6 +336,7 @@ module Didit
|
|
|
319
336
|
"filter_date_to" => filter_date_to,
|
|
320
337
|
"didit_internal_id_list" => didit_internal_id_list
|
|
321
338
|
},
|
|
339
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
322
340
|
scope: :application,
|
|
323
341
|
response: { 200 => Types::OngoingMonitoringToggleResult, 202 => Types::OngoingMonitoringJob },
|
|
324
342
|
request_options: request_options
|
|
@@ -347,6 +365,7 @@ module Didit
|
|
|
347
365
|
# legacy toggle_all alias) is true.
|
|
348
366
|
# @param toggle_all [Boolean] Legacy alias of update_all.
|
|
349
367
|
# @param filter_workflow_id [String]
|
|
368
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
350
369
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
351
370
|
# @return [Didit::Types::OngoingMonitoringToggleResult, Didit::Types::OngoingMonitoringJob]
|
|
352
371
|
def set_session_ongoing_monitoring(
|
|
@@ -361,6 +380,7 @@ module Didit
|
|
|
361
380
|
session_numbers: OMIT,
|
|
362
381
|
toggle_all: OMIT,
|
|
363
382
|
filter_workflow_id: OMIT,
|
|
383
|
+
idempotency_key: OMIT,
|
|
364
384
|
request_options: nil
|
|
365
385
|
)
|
|
366
386
|
@client.request(
|
|
@@ -379,6 +399,7 @@ module Didit
|
|
|
379
399
|
"toggle_all" => toggle_all,
|
|
380
400
|
"filter_workflow_id" => filter_workflow_id
|
|
381
401
|
},
|
|
402
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
382
403
|
scope: :application,
|
|
383
404
|
response: { 200 => Types::OngoingMonitoringToggleResult, 202 => Types::OngoingMonitoringJob },
|
|
384
405
|
request_options: request_options
|
|
@@ -407,6 +428,7 @@ module Didit
|
|
|
407
428
|
# metadata on update - merge client-side if you only want to add keys.
|
|
408
429
|
# @param reason [String, nil] Why the status changed. Recorded on the status-change entry of the company's
|
|
409
430
|
# **Activity** in the Business Console, only when the status actually changes. Webhooks do not carry it.
|
|
431
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
410
432
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
411
433
|
# @return [Didit::Types::BusinessDetailItem]
|
|
412
434
|
def update(
|
|
@@ -418,6 +440,7 @@ module Didit
|
|
|
418
440
|
status: OMIT,
|
|
419
441
|
metadata: OMIT,
|
|
420
442
|
reason: OMIT,
|
|
443
|
+
idempotency_key: OMIT,
|
|
421
444
|
request_options: nil
|
|
422
445
|
)
|
|
423
446
|
@client.request(
|
|
@@ -433,6 +456,7 @@ module Didit
|
|
|
433
456
|
"metadata" => metadata,
|
|
434
457
|
"reason" => reason
|
|
435
458
|
},
|
|
459
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
436
460
|
response: Types::BusinessDetailItem,
|
|
437
461
|
request_options: request_options
|
|
438
462
|
)
|
|
@@ -451,9 +475,10 @@ module Didit
|
|
|
451
475
|
# @param status [String] New lifecycle status. `BLOCKED` also adds the `vendor_data` to the system blocklist.
|
|
452
476
|
# @param reason [String, nil] Why the status changed. Recorded on the status-change entry of the company's
|
|
453
477
|
# **Activity** in the Business Console, only when the status actually changes. Webhooks do not carry it.
|
|
478
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
454
479
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
455
480
|
# @return [Didit::Types::BusinessDetailItem]
|
|
456
|
-
def update_status(vendor_data, status:, reason: OMIT, request_options: nil)
|
|
481
|
+
def update_status(vendor_data, status:, reason: OMIT, idempotency_key: OMIT, request_options: nil)
|
|
457
482
|
@client.request(
|
|
458
483
|
:patch,
|
|
459
484
|
"/v3/businesses/{vendor_data}/update-status/",
|
|
@@ -462,6 +487,7 @@ module Didit
|
|
|
462
487
|
"status" => status,
|
|
463
488
|
"reason" => reason
|
|
464
489
|
},
|
|
490
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
465
491
|
response: Types::BusinessDetailItem,
|
|
466
492
|
request_options: request_options
|
|
467
493
|
)
|