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
|
@@ -52,6 +52,7 @@ module Didit
|
|
|
52
52
|
# @param custom_values [Hash{String => String, Numeric, Boolean, nil}] Up to 100 keys of your own, addressable
|
|
53
53
|
# from rules as `custom_values.<key>`. Values must be scalars (string, number, boolean or null); nested objects
|
|
54
54
|
# and arrays are rejected.
|
|
55
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
55
56
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
56
57
|
# @return [Didit::Types::MonitoringEventIngestResult]
|
|
57
58
|
def create(
|
|
@@ -67,6 +68,7 @@ module Didit
|
|
|
67
68
|
transaction_context: OMIT,
|
|
68
69
|
payload: OMIT,
|
|
69
70
|
custom_values: OMIT,
|
|
71
|
+
idempotency_key: OMIT,
|
|
70
72
|
request_options: nil
|
|
71
73
|
)
|
|
72
74
|
@client.request(
|
|
@@ -86,6 +88,7 @@ module Didit
|
|
|
86
88
|
"payload" => payload,
|
|
87
89
|
"custom_values" => custom_values
|
|
88
90
|
},
|
|
91
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
89
92
|
response: Types::MonitoringEventIngestResult,
|
|
90
93
|
request_options: request_options
|
|
91
94
|
)
|
|
@@ -105,15 +108,17 @@ module Didit
|
|
|
105
108
|
#
|
|
106
109
|
# @param events [Array<Hash>] 1 to 500 events. Each item follows `MonitoringEventCreateRequest`, including the
|
|
107
110
|
# 7-day past and 5-minute future window on `occurred_at`.
|
|
111
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
108
112
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
109
113
|
# @return [Didit::Types::MonitoringEventsCreateBatchResponse]
|
|
110
|
-
def create_batch(events:, request_options: nil)
|
|
114
|
+
def create_batch(events:, idempotency_key: OMIT, request_options: nil)
|
|
111
115
|
@client.request(
|
|
112
116
|
:post,
|
|
113
117
|
"/v3/events/batch/",
|
|
114
118
|
body: {
|
|
115
119
|
"events" => events
|
|
116
120
|
},
|
|
121
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
117
122
|
response: Types::MonitoringEventsCreateBatchResponse,
|
|
118
123
|
request_options: request_options
|
|
119
124
|
)
|
|
@@ -144,6 +149,7 @@ module Didit
|
|
|
144
149
|
# Send `null` for no cap within the lifetime.
|
|
145
150
|
# @param bind_to_origin [String, nil] When set, the browser `Origin` header of every device request must equal
|
|
146
151
|
# this value exactly; a request without `Origin` is refused.
|
|
152
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
147
153
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
148
154
|
# @return [Didit::Types::MonitoringEventsCreateSdkTokenResponse]
|
|
149
155
|
def create_sdk_token(
|
|
@@ -153,6 +159,7 @@ module Didit
|
|
|
153
159
|
ttl_seconds: OMIT,
|
|
154
160
|
max_uses: OMIT,
|
|
155
161
|
bind_to_origin: OMIT,
|
|
162
|
+
idempotency_key: OMIT,
|
|
156
163
|
request_options: nil
|
|
157
164
|
)
|
|
158
165
|
@client.request(
|
|
@@ -166,6 +173,7 @@ module Didit
|
|
|
166
173
|
"max_uses" => max_uses,
|
|
167
174
|
"bind_to_origin" => bind_to_origin
|
|
168
175
|
},
|
|
176
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
169
177
|
response: Types::MonitoringEventsCreateSdkTokenResponse,
|
|
170
178
|
request_options: request_options
|
|
171
179
|
)
|
|
@@ -185,13 +193,15 @@ module Didit
|
|
|
185
193
|
#
|
|
186
194
|
# @param event_uuid [String] Didit identifier of the event (`event_uuid` from the create, batch, list or
|
|
187
195
|
# timeline response), not your own `event_id`.
|
|
196
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
188
197
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
189
198
|
# @return [nil]
|
|
190
|
-
def delete(event_uuid, request_options: nil)
|
|
199
|
+
def delete(event_uuid, idempotency_key: OMIT, request_options: nil)
|
|
191
200
|
@client.request(
|
|
192
201
|
:delete,
|
|
193
202
|
"/v3/events/{event_uuid}/delete/",
|
|
194
203
|
path_params: { "event_uuid" => event_uuid },
|
|
204
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
195
205
|
request_options: request_options
|
|
196
206
|
)
|
|
197
207
|
end
|
|
@@ -21,9 +21,10 @@ module Didit
|
|
|
21
21
|
#
|
|
22
22
|
# @param network_uuid [String] Network UUID.
|
|
23
23
|
# @param tag_uuid [String] UUID of one of your application's tags.
|
|
24
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
24
25
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
25
26
|
# @return [Didit::Types::NetworkDetailResponse]
|
|
26
|
-
def add_tag(network_uuid, tag_uuid:, request_options: nil)
|
|
27
|
+
def add_tag(network_uuid, tag_uuid:, idempotency_key: OMIT, request_options: nil)
|
|
27
28
|
@client.request(
|
|
28
29
|
:post,
|
|
29
30
|
"/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/tags/add/",
|
|
@@ -31,6 +32,7 @@ module Didit
|
|
|
31
32
|
body: {
|
|
32
33
|
"tag_uuid" => tag_uuid
|
|
33
34
|
},
|
|
35
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
34
36
|
scope: :application,
|
|
35
37
|
response: Types::NetworkDetailResponse,
|
|
36
38
|
request_options: request_options
|
|
@@ -207,9 +209,10 @@ module Didit
|
|
|
207
209
|
#
|
|
208
210
|
# @param network_uuid [String] Network UUID.
|
|
209
211
|
# @param tag_uuid [String] UUID of one of your application's tags.
|
|
212
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
210
213
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
211
214
|
# @return [Didit::Types::NetworkDetailResponse]
|
|
212
|
-
def remove_tag(network_uuid, tag_uuid:, request_options: nil)
|
|
215
|
+
def remove_tag(network_uuid, tag_uuid:, idempotency_key: OMIT, request_options: nil)
|
|
213
216
|
@client.request(
|
|
214
217
|
:post,
|
|
215
218
|
"/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/tags/remove/",
|
|
@@ -217,6 +220,7 @@ module Didit
|
|
|
217
220
|
body: {
|
|
218
221
|
"tag_uuid" => tag_uuid
|
|
219
222
|
},
|
|
223
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
220
224
|
scope: :application,
|
|
221
225
|
response: Types::NetworkDetailResponse,
|
|
222
226
|
request_options: request_options
|
|
@@ -357,9 +361,10 @@ module Didit
|
|
|
357
361
|
# @param network_uuid [String] Network UUID.
|
|
358
362
|
# @param comment [String]
|
|
359
363
|
# @param client_reference [String]
|
|
364
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
360
365
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
361
366
|
# @return [Didit::Types::NetworkNote]
|
|
362
|
-
def create(network_uuid, comment:, client_reference:, request_options: nil)
|
|
367
|
+
def create(network_uuid, comment:, client_reference:, idempotency_key: OMIT, request_options: nil)
|
|
363
368
|
@client.request(
|
|
364
369
|
:post,
|
|
365
370
|
"/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/notes/",
|
|
@@ -368,6 +373,7 @@ module Didit
|
|
|
368
373
|
"comment" => comment,
|
|
369
374
|
"client_reference" => client_reference
|
|
370
375
|
},
|
|
376
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
371
377
|
scope: :application,
|
|
372
378
|
response: Types::NetworkNote,
|
|
373
379
|
request_options: request_options
|
|
@@ -383,13 +389,15 @@ module Didit
|
|
|
383
389
|
#
|
|
384
390
|
# @param network_uuid [String] Network UUID.
|
|
385
391
|
# @param note_uuid [String]
|
|
392
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
386
393
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
387
394
|
# @return [nil]
|
|
388
|
-
def delete(network_uuid, note_uuid, request_options: nil)
|
|
395
|
+
def delete(network_uuid, note_uuid, idempotency_key: OMIT, request_options: nil)
|
|
389
396
|
@client.request(
|
|
390
397
|
:delete,
|
|
391
398
|
"/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/notes/{note_uuid}/",
|
|
392
399
|
path_params: { "network_uuid" => network_uuid, "note_uuid" => note_uuid },
|
|
400
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
393
401
|
scope: :application,
|
|
394
402
|
request_options: request_options
|
|
395
403
|
)
|
|
@@ -70,6 +70,7 @@ module Didit
|
|
|
70
70
|
# duplicate-face check, so re-verifying the same user does not raise `DUPLICATED_FACE`.
|
|
71
71
|
# @param metadata [Hash] Optional JSON object stored with the session (when `save_api_request=true`) and echoed
|
|
72
72
|
# back. In multipart requests, send it as a JSON-encoded string field - it is parsed into an object.
|
|
73
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
73
74
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
74
75
|
# @return [Didit::Types::PassiveLivenessCheckResponse]
|
|
75
76
|
def check(
|
|
@@ -79,6 +80,7 @@ module Didit
|
|
|
79
80
|
save_api_request: OMIT,
|
|
80
81
|
vendor_data: OMIT,
|
|
81
82
|
metadata: OMIT,
|
|
83
|
+
idempotency_key: OMIT,
|
|
82
84
|
request_options: nil
|
|
83
85
|
)
|
|
84
86
|
@client.request(
|
|
@@ -94,6 +96,7 @@ module Didit
|
|
|
94
96
|
},
|
|
95
97
|
encoding: :multipart,
|
|
96
98
|
file_fields: %w[user_image],
|
|
99
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
97
100
|
response: Types::PassiveLivenessCheckResponse,
|
|
98
101
|
request_options: request_options
|
|
99
102
|
)
|
|
@@ -49,6 +49,7 @@ module Didit
|
|
|
49
49
|
# @param enable_social [Boolean] When true, also look up the social footprint of the number - the messaging,
|
|
50
50
|
# social, e-commerce and professional platforms it is registered on. Billed as one `phone_social` unit per
|
|
51
51
|
# request in addition to this endpoint's own price.
|
|
52
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
52
53
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
53
54
|
# @return [Didit::Types::PhoneRiskResponse]
|
|
54
55
|
def assess_risk(
|
|
@@ -58,6 +59,7 @@ module Didit
|
|
|
58
59
|
vendor_data: OMIT,
|
|
59
60
|
metadata: OMIT,
|
|
60
61
|
enable_social: OMIT,
|
|
62
|
+
idempotency_key: OMIT,
|
|
61
63
|
request_options: nil
|
|
62
64
|
)
|
|
63
65
|
@client.request(
|
|
@@ -71,6 +73,7 @@ module Didit
|
|
|
71
73
|
"metadata" => metadata,
|
|
72
74
|
"enable_social" => enable_social
|
|
73
75
|
},
|
|
76
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
74
77
|
response: Types::PhoneRiskResponse,
|
|
75
78
|
request_options: request_options
|
|
76
79
|
)
|
|
@@ -165,6 +168,7 @@ module Didit
|
|
|
165
168
|
# @param phone_no_social_presence_action [String] Action when the social footprint check finds the number
|
|
166
169
|
# registered on none of the platforms it covers. Only NO_ACTION and DECLINE are accepted on this endpoint;
|
|
167
170
|
# REVIEW is available on the workflow configuration key of the same name.
|
|
171
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
168
172
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
169
173
|
# @return [Didit::Types::PhoneVerificationCheckResponse]
|
|
170
174
|
def check_code(
|
|
@@ -180,6 +184,7 @@ module Didit
|
|
|
180
184
|
low_phone_trust_action: OMIT,
|
|
181
185
|
enable_social: OMIT,
|
|
182
186
|
phone_no_social_presence_action: OMIT,
|
|
187
|
+
idempotency_key: OMIT,
|
|
183
188
|
request_options: nil
|
|
184
189
|
)
|
|
185
190
|
@client.request(
|
|
@@ -199,6 +204,7 @@ module Didit
|
|
|
199
204
|
"enable_social" => enable_social,
|
|
200
205
|
"phone_no_social_presence_action" => phone_no_social_presence_action
|
|
201
206
|
},
|
|
207
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
202
208
|
response: Types::PhoneVerificationCheckResponse,
|
|
203
209
|
request_options: request_options
|
|
204
210
|
)
|
|
@@ -268,6 +274,7 @@ module Didit
|
|
|
268
274
|
# and the Business Console. Use it to correlate Didit's `request_id` with your user record.
|
|
269
275
|
# @param metadata [Hash, nil] Optional free-form JSON object persisted on the session and echoed back in the
|
|
270
276
|
# send response, the matching check response, webhooks, and the Business Console.
|
|
277
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
271
278
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
272
279
|
# @return [Didit::Types::PhoneVerificationSendResponse]
|
|
273
280
|
def send_code(
|
|
@@ -276,6 +283,7 @@ module Didit
|
|
|
276
283
|
signals: OMIT,
|
|
277
284
|
vendor_data: OMIT,
|
|
278
285
|
metadata: OMIT,
|
|
286
|
+
idempotency_key: OMIT,
|
|
279
287
|
request_options: nil
|
|
280
288
|
)
|
|
281
289
|
@client.request(
|
|
@@ -288,6 +296,7 @@ module Didit
|
|
|
288
296
|
"vendor_data" => vendor_data,
|
|
289
297
|
"metadata" => metadata
|
|
290
298
|
},
|
|
299
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
291
300
|
response: Types::PhoneVerificationSendResponse,
|
|
292
301
|
request_options: request_options
|
|
293
302
|
)
|
|
@@ -116,6 +116,7 @@ module Didit
|
|
|
116
116
|
# @param metadata [Hash] Optional JSON object stored with the session (when `save_api_request=true`) and echoed
|
|
117
117
|
# back in the response. In multipart requests, send it as a JSON-encoded string field (e.g.
|
|
118
118
|
# `metadata={"flow":"onboarding"}`) - it is parsed into an object.
|
|
119
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
119
120
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
120
121
|
# @return [Didit::Types::ProofOfAddressVerifyResponse]
|
|
121
122
|
def verify(
|
|
@@ -136,6 +137,7 @@ module Didit
|
|
|
136
137
|
save_api_request: OMIT,
|
|
137
138
|
vendor_data: OMIT,
|
|
138
139
|
metadata: OMIT,
|
|
140
|
+
idempotency_key: OMIT,
|
|
139
141
|
request_options: nil
|
|
140
142
|
)
|
|
141
143
|
@client.request(
|
|
@@ -162,6 +164,7 @@ module Didit
|
|
|
162
164
|
},
|
|
163
165
|
encoding: :multipart,
|
|
164
166
|
file_fields: %w[document],
|
|
167
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
165
168
|
response: Types::ProofOfAddressVerifyResponse,
|
|
166
169
|
request_options: request_options
|
|
167
170
|
)
|
|
@@ -20,6 +20,7 @@ module Didit
|
|
|
20
20
|
# @param default_language [String] Default language. Must be included in `languages`.
|
|
21
21
|
# @param is_active [Boolean]
|
|
22
22
|
# @param status [String] Omit this field to create a published questionnaire ready for workflows.
|
|
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::QuestionnaireDetail]
|
|
25
26
|
def create(
|
|
@@ -30,6 +31,7 @@ module Didit
|
|
|
30
31
|
default_language: OMIT,
|
|
31
32
|
is_active: OMIT,
|
|
32
33
|
status: OMIT,
|
|
34
|
+
idempotency_key: OMIT,
|
|
33
35
|
request_options: nil
|
|
34
36
|
)
|
|
35
37
|
@client.request(
|
|
@@ -44,6 +46,7 @@ module Didit
|
|
|
44
46
|
"is_active" => is_active,
|
|
45
47
|
"status" => status
|
|
46
48
|
},
|
|
49
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
47
50
|
response: Types::QuestionnaireDetail,
|
|
48
51
|
request_options: request_options
|
|
49
52
|
)
|
|
@@ -58,13 +61,15 @@ module Didit
|
|
|
58
61
|
# +DELETE /v3/questionnaires/{questionnaire_uuid}/+
|
|
59
62
|
#
|
|
60
63
|
# @param questionnaire_uuid [String] Per-version UUID of the questionnaire to delete.
|
|
64
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
61
65
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
62
66
|
# @return [nil]
|
|
63
|
-
def delete(questionnaire_uuid, request_options: nil)
|
|
67
|
+
def delete(questionnaire_uuid, idempotency_key: OMIT, request_options: nil)
|
|
64
68
|
@client.request(
|
|
65
69
|
:delete,
|
|
66
70
|
"/v3/questionnaires/{questionnaire_uuid}/",
|
|
67
71
|
path_params: { "questionnaire_uuid" => questionnaire_uuid },
|
|
72
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
68
73
|
request_options: request_options
|
|
69
74
|
)
|
|
70
75
|
end
|
|
@@ -135,6 +140,7 @@ module Didit
|
|
|
135
140
|
# @param is_active [Boolean]
|
|
136
141
|
# @param status [String]
|
|
137
142
|
# @param form_elements [Array<Hash>] If provided, this replaces the full linear question list.
|
|
143
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
138
144
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
139
145
|
# @return [Didit::Types::QuestionnaireDetail]
|
|
140
146
|
def update(
|
|
@@ -146,6 +152,7 @@ module Didit
|
|
|
146
152
|
is_active: OMIT,
|
|
147
153
|
status: OMIT,
|
|
148
154
|
form_elements: OMIT,
|
|
155
|
+
idempotency_key: OMIT,
|
|
149
156
|
request_options: nil
|
|
150
157
|
)
|
|
151
158
|
@client.request(
|
|
@@ -161,6 +168,7 @@ module Didit
|
|
|
161
168
|
"status" => status,
|
|
162
169
|
"form_elements" => form_elements
|
|
163
170
|
},
|
|
171
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
164
172
|
response: Types::QuestionnaireDetail,
|
|
165
173
|
request_options: request_options
|
|
166
174
|
)
|
|
@@ -33,6 +33,7 @@ module Didit
|
|
|
33
33
|
# @param narrative [Hash]
|
|
34
34
|
# @param report_indicators [Array<String>]
|
|
35
35
|
# @param included_fields [Array<String>]
|
|
36
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
36
37
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
37
38
|
# @return [Didit::Types::RegulatoryReportDetail]
|
|
38
39
|
def create(
|
|
@@ -56,6 +57,7 @@ module Didit
|
|
|
56
57
|
narrative: OMIT,
|
|
57
58
|
report_indicators: OMIT,
|
|
58
59
|
included_fields: OMIT,
|
|
60
|
+
idempotency_key: OMIT,
|
|
59
61
|
request_options: nil
|
|
60
62
|
)
|
|
61
63
|
@client.request(
|
|
@@ -83,6 +85,7 @@ module Didit
|
|
|
83
85
|
"report_indicators" => report_indicators,
|
|
84
86
|
"included_fields" => included_fields
|
|
85
87
|
},
|
|
88
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
86
89
|
scope: :application,
|
|
87
90
|
response: Types::RegulatoryReportDetail,
|
|
88
91
|
request_options: request_options
|
|
@@ -105,9 +108,10 @@ module Didit
|
|
|
105
108
|
# @param report_uuid [String] Report UUID.
|
|
106
109
|
# @param confirm_delete [Boolean] Set to true to confirm that a finalized report and its generated files are
|
|
107
110
|
# deleted permanently.
|
|
111
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
108
112
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
109
113
|
# @return [nil]
|
|
110
|
-
def delete(report_uuid, confirm_delete: OMIT, request_options: nil)
|
|
114
|
+
def delete(report_uuid, confirm_delete: OMIT, idempotency_key: OMIT, request_options: nil)
|
|
111
115
|
@client.request(
|
|
112
116
|
:delete,
|
|
113
117
|
"/v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/",
|
|
@@ -115,6 +119,7 @@ module Didit
|
|
|
115
119
|
body: {
|
|
116
120
|
"confirm_delete" => confirm_delete
|
|
117
121
|
},
|
|
122
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
118
123
|
scope: :application,
|
|
119
124
|
request_options: request_options
|
|
120
125
|
)
|
|
@@ -128,13 +133,15 @@ module Didit
|
|
|
128
133
|
# +POST /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/finalize/+
|
|
129
134
|
#
|
|
130
135
|
# @param report_uuid [String] Report UUID.
|
|
136
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
131
137
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
132
138
|
# @return [Didit::Types::RegulatoryReportDetail]
|
|
133
|
-
def finalize(report_uuid, request_options: nil)
|
|
139
|
+
def finalize(report_uuid, idempotency_key: OMIT, request_options: nil)
|
|
134
140
|
@client.request(
|
|
135
141
|
:post,
|
|
136
142
|
"/v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/finalize/",
|
|
137
143
|
path_params: { "report_uuid" => report_uuid },
|
|
144
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
138
145
|
scope: :application,
|
|
139
146
|
response: Types::RegulatoryReportDetail,
|
|
140
147
|
request_options: request_options
|
|
@@ -238,6 +245,7 @@ module Didit
|
|
|
238
245
|
# @param narrative [Hash]
|
|
239
246
|
# @param report_indicators [Array<String>]
|
|
240
247
|
# @param included_fields [Array<String>]
|
|
248
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
241
249
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
242
250
|
# @return [Didit::Types::RegulatoryReportDetail]
|
|
243
251
|
def update(
|
|
@@ -258,6 +266,7 @@ module Didit
|
|
|
258
266
|
narrative: OMIT,
|
|
259
267
|
report_indicators: OMIT,
|
|
260
268
|
included_fields: OMIT,
|
|
269
|
+
idempotency_key: OMIT,
|
|
261
270
|
request_options: nil
|
|
262
271
|
)
|
|
263
272
|
@client.request(
|
|
@@ -282,6 +291,7 @@ module Didit
|
|
|
282
291
|
"report_indicators" => report_indicators,
|
|
283
292
|
"included_fields" => included_fields
|
|
284
293
|
},
|
|
294
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
285
295
|
scope: :application,
|
|
286
296
|
response: Types::RegulatoryReportDetail,
|
|
287
297
|
request_options: request_options
|
|
@@ -302,13 +312,15 @@ module Didit
|
|
|
302
312
|
# +POST /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/validate/+
|
|
303
313
|
#
|
|
304
314
|
# @param report_uuid [String] Report UUID.
|
|
315
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
305
316
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
306
317
|
# @return [Didit::Types::RegulatoryReportsValidateResponse]
|
|
307
|
-
def validate(report_uuid, request_options: nil)
|
|
318
|
+
def validate(report_uuid, idempotency_key: OMIT, request_options: nil)
|
|
308
319
|
@client.request(
|
|
309
320
|
:post,
|
|
310
321
|
"/v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/validate/",
|
|
311
322
|
path_params: { "report_uuid" => report_uuid },
|
|
323
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
312
324
|
scope: :application,
|
|
313
325
|
response: Types::RegulatoryReportsValidateResponse,
|
|
314
326
|
request_options: request_options
|
|
@@ -21,9 +21,10 @@ module Didit
|
|
|
21
21
|
# submission_code, and currency_code_local (3-letter). Optional: enabled_fields (which optional report blocks to
|
|
22
22
|
# include) plus reporting_person, location, reason, and action defaults. Per-filing header fields (action,
|
|
23
23
|
# submission_date, transactions, jurisdiction) are enforced when the report is validated or finalized, not...
|
|
24
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
24
25
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
25
26
|
# @return [Didit::Types::ReportTemplateDetail]
|
|
26
|
-
def create(name:, jurisdiction:, report_type:, field_config: OMIT, request_options: nil)
|
|
27
|
+
def create(name:, jurisdiction:, report_type:, field_config: OMIT, idempotency_key: OMIT, request_options: nil)
|
|
27
28
|
@client.request(
|
|
28
29
|
:post,
|
|
29
30
|
"/v3/organization/{organization_id}/application/{application_id}/report-templates/",
|
|
@@ -33,6 +34,7 @@ module Didit
|
|
|
33
34
|
"report_type" => report_type,
|
|
34
35
|
"field_config" => field_config
|
|
35
36
|
},
|
|
37
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
36
38
|
scope: :application,
|
|
37
39
|
response: Types::ReportTemplateDetail,
|
|
38
40
|
request_options: request_options
|
|
@@ -46,13 +48,15 @@ module Didit
|
|
|
46
48
|
# +DELETE /v3/organization/{organization_id}/application/{application_id}/report-templates/{template_uuid}/+
|
|
47
49
|
#
|
|
48
50
|
# @param template_uuid [String] Report template UUID.
|
|
51
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
49
52
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
50
53
|
# @return [nil]
|
|
51
|
-
def delete(template_uuid, request_options: nil)
|
|
54
|
+
def delete(template_uuid, idempotency_key: OMIT, request_options: nil)
|
|
52
55
|
@client.request(
|
|
53
56
|
:delete,
|
|
54
57
|
"/v3/organization/{organization_id}/application/{application_id}/report-templates/{template_uuid}/",
|
|
55
58
|
path_params: { "template_uuid" => template_uuid },
|
|
59
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
56
60
|
scope: :application,
|
|
57
61
|
request_options: request_options
|
|
58
62
|
)
|
|
@@ -116,6 +120,7 @@ module Didit
|
|
|
116
120
|
# submission_code, and currency_code_local (3-letter). Optional: enabled_fields (which optional report blocks to
|
|
117
121
|
# include) plus reporting_person, location, reason, and action defaults. Per-filing header fields (action,
|
|
118
122
|
# submission_date, transactions, jurisdiction) are enforced when the report is validated or finalized, not...
|
|
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::ReportTemplateDetail]
|
|
121
126
|
def update(
|
|
@@ -124,6 +129,7 @@ module Didit
|
|
|
124
129
|
jurisdiction: OMIT,
|
|
125
130
|
report_type: OMIT,
|
|
126
131
|
field_config: OMIT,
|
|
132
|
+
idempotency_key: OMIT,
|
|
127
133
|
request_options: nil
|
|
128
134
|
)
|
|
129
135
|
@client.request(
|
|
@@ -136,6 +142,7 @@ module Didit
|
|
|
136
142
|
"report_type" => report_type,
|
|
137
143
|
"field_config" => field_config
|
|
138
144
|
},
|
|
145
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
139
146
|
scope: :application,
|
|
140
147
|
response: Types::ReportTemplateDetail,
|
|
141
148
|
request_options: request_options
|
|
@@ -84,6 +84,7 @@ module Didit
|
|
|
84
84
|
# failed-item retry.
|
|
85
85
|
# @param date_to [Date, String] Optional replacement period end, on or after date_from.
|
|
86
86
|
# @param notify_on_ready [Boolean] Email the requester when ready, if a requester email is available.
|
|
87
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
87
88
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
88
89
|
# @return [Didit::Types::AsyncReport]
|
|
89
90
|
def retry(
|
|
@@ -92,6 +93,7 @@ module Didit
|
|
|
92
93
|
date_from: OMIT,
|
|
93
94
|
date_to: OMIT,
|
|
94
95
|
notify_on_ready: OMIT,
|
|
96
|
+
idempotency_key: OMIT,
|
|
95
97
|
request_options: nil
|
|
96
98
|
)
|
|
97
99
|
@client.request(
|
|
@@ -104,6 +106,7 @@ module Didit
|
|
|
104
106
|
"date_to" => date_to,
|
|
105
107
|
"notify_on_ready" => notify_on_ready
|
|
106
108
|
},
|
|
109
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
107
110
|
scope: :application,
|
|
108
111
|
response: Types::AsyncReport,
|
|
109
112
|
request_options: request_options
|