didit-sdk 2.16.0 → 2.18.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 +211 -0
- data/lib/didit/resources/reports.rb +114 -0
- data/lib/didit/resources/travel_rule.rb +372 -8
- data/lib/didit/resources/webhooks.rb +29 -0
- data/lib/didit/resources.rb +6 -0
- data/lib/didit/types/components.rb +442 -5
- data/lib/didit/types/reports.rb +8 -0
- data/lib/didit/types/travel_rule.rb +44 -0
- data/lib/didit/types.rb +50 -1
- data/lib/didit/version.rb +1 -1
- data/sig/didit/resources/reports.rbs +11 -0
- data/sig/didit/resources/travel_rule.rbs +20 -3
- data/sig/didit/resources/webhooks.rbs +1 -0
- data/sig/didit/resources.rbs +1 -0
- data/sig/didit/types/components.rbs +398 -1
- data/sig/didit/types/reports.rbs +7 -0
- data/sig/didit/types/travel_rule.rbs +55 -2
- metadata +5 -1
|
@@ -10,6 +10,11 @@ module Didit
|
|
|
10
10
|
@counterparty_contacts ||= CounterpartyContacts.new(@client)
|
|
11
11
|
end
|
|
12
12
|
|
|
13
|
+
# @return [Didit::Resources::TravelRule::Documents]
|
|
14
|
+
def documents
|
|
15
|
+
@documents ||= Documents.new(@client)
|
|
16
|
+
end
|
|
17
|
+
|
|
13
18
|
# @return [Didit::Resources::TravelRule::Networks]
|
|
14
19
|
def networks
|
|
15
20
|
@networks ||= Networks.new(@client)
|
|
@@ -40,6 +45,32 @@ module Didit
|
|
|
40
45
|
@workspace ||= Workspace.new(@client)
|
|
41
46
|
end
|
|
42
47
|
|
|
48
|
+
# Assign a VASP to a member
|
|
49
|
+
#
|
|
50
|
+
# Assigns the counterparty to one application member, or unassigns it with `assignee_email: null`. Repeating the
|
|
51
|
+
# same assignment changes nothing (`changed: false`). The assignment is private to your application. Needs the
|
|
52
|
+
# transactions write privilege.
|
|
53
|
+
#
|
|
54
|
+
# +POST /v3/travel-rule/vasps/{vasp_id}/assign/+
|
|
55
|
+
#
|
|
56
|
+
# @param vasp_id [String] The id of a row of GET /v3/travel-rule/vasps/: a directory entry or a Didit network
|
|
57
|
+
# member.
|
|
58
|
+
# @param assignee_email [String, nil] Email of an application member. null or an empty string unassigns.
|
|
59
|
+
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
60
|
+
# @return [Didit::Types::TravelRuleAssignVaspResponse]
|
|
61
|
+
def assign_vasp(vasp_id, assignee_email:, request_options: nil)
|
|
62
|
+
@client.request(
|
|
63
|
+
:post,
|
|
64
|
+
"/v3/travel-rule/vasps/{vasp_id}/assign/",
|
|
65
|
+
path_params: { "vasp_id" => vasp_id },
|
|
66
|
+
body: {
|
|
67
|
+
"assignee_email" => assignee_email
|
|
68
|
+
},
|
|
69
|
+
response: Types::TravelRuleAssignVaspResponse,
|
|
70
|
+
request_options: request_options
|
|
71
|
+
)
|
|
72
|
+
end
|
|
73
|
+
|
|
43
74
|
# Clear your decision on a VASP
|
|
44
75
|
#
|
|
45
76
|
# Clear your application's own decision on a counterparty. The response shows the decision that applies
|
|
@@ -164,6 +195,33 @@ module Didit
|
|
|
164
195
|
)
|
|
165
196
|
end
|
|
166
197
|
|
|
198
|
+
# List a VASP's decision history
|
|
199
|
+
#
|
|
200
|
+
# Your application's own decision changes for the counterparty, newest first. Only changes made after this
|
|
201
|
+
# history existed are listed. Needs the transactions read privilege.
|
|
202
|
+
#
|
|
203
|
+
# +GET /v3/travel-rule/vasps/{vasp_id}/decision-history/+
|
|
204
|
+
#
|
|
205
|
+
# @param vasp_id [String] The id of a row of GET /v3/travel-rule/vasps/: a directory entry or a Didit network
|
|
206
|
+
# member.
|
|
207
|
+
# @param limit [Integer]
|
|
208
|
+
# @param offset [Integer]
|
|
209
|
+
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
210
|
+
# @return [Didit::Page<Didit::Types::TravelRuleDecisionEvent>]
|
|
211
|
+
def list_vasp_decision_history(vasp_id, limit: OMIT, offset: OMIT, request_options: nil)
|
|
212
|
+
@client.request(
|
|
213
|
+
:get,
|
|
214
|
+
"/v3/travel-rule/vasps/{vasp_id}/decision-history/",
|
|
215
|
+
path_params: { "vasp_id" => vasp_id },
|
|
216
|
+
query: {
|
|
217
|
+
"limit" => limit,
|
|
218
|
+
"offset" => offset
|
|
219
|
+
},
|
|
220
|
+
page: Types::TravelRuleDecisionEvent,
|
|
221
|
+
request_options: request_options
|
|
222
|
+
)
|
|
223
|
+
end
|
|
224
|
+
|
|
167
225
|
# List due-diligence questionnaires with a VASP
|
|
168
226
|
#
|
|
169
227
|
# Every due-diligence questionnaire your application sent the counterparty, newest first, with its status and,
|
|
@@ -185,6 +243,44 @@ module Didit
|
|
|
185
243
|
)
|
|
186
244
|
end
|
|
187
245
|
|
|
246
|
+
# List the members who can be assigned a VASP
|
|
247
|
+
#
|
|
248
|
+
# The application members who can review Travel Rule counterparties. Use one `email` as `assignee_email` of
|
|
249
|
+
# `POST /v3/travel-rule/vasps/{vasp_id}/assign/`. Needs the transactions read privilege.
|
|
250
|
+
#
|
|
251
|
+
# +GET /v3/travel-rule/vasps/reviewers/+
|
|
252
|
+
#
|
|
253
|
+
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
254
|
+
# @return [Didit::Types::TravelRuleListVaspReviewersResponse]
|
|
255
|
+
def list_vasp_reviewers(request_options: nil)
|
|
256
|
+
@client.request(
|
|
257
|
+
:get,
|
|
258
|
+
"/v3/travel-rule/vasps/reviewers/",
|
|
259
|
+
response: Types::TravelRuleListVaspReviewersResponse,
|
|
260
|
+
request_options: request_options
|
|
261
|
+
)
|
|
262
|
+
end
|
|
263
|
+
|
|
264
|
+
# List the documents shared with a VASP
|
|
265
|
+
#
|
|
266
|
+
# The documents currently shared with the counterparty.
|
|
267
|
+
#
|
|
268
|
+
# +GET /v3/travel-rule/vasps/{vasp_id}/shared-documents/+
|
|
269
|
+
#
|
|
270
|
+
# @param vasp_id [String] The id of a row of GET /v3/travel-rule/vasps/: a directory entry or a Didit network
|
|
271
|
+
# member.
|
|
272
|
+
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
273
|
+
# @return [Didit::Types::TravelRuleListVaspSharedDocumentsResponse]
|
|
274
|
+
def list_vasp_shared_documents(vasp_id, request_options: nil)
|
|
275
|
+
@client.request(
|
|
276
|
+
:get,
|
|
277
|
+
"/v3/travel-rule/vasps/{vasp_id}/shared-documents/",
|
|
278
|
+
path_params: { "vasp_id" => vasp_id },
|
|
279
|
+
response: Types::TravelRuleListVaspSharedDocumentsResponse,
|
|
280
|
+
request_options: request_options
|
|
281
|
+
)
|
|
282
|
+
end
|
|
283
|
+
|
|
188
284
|
# Search the VASP directory
|
|
189
285
|
#
|
|
190
286
|
# Paginated, name-sorted search of the VASP directory: the shared directory entries, which Didit builds from the
|
|
@@ -390,6 +486,39 @@ module Didit
|
|
|
390
486
|
)
|
|
391
487
|
end
|
|
392
488
|
|
|
489
|
+
# Review a screening hit
|
|
490
|
+
#
|
|
491
|
+
# Records your review of one possible match of a screening. The screening score and status are recomputed from
|
|
492
|
+
# the reviewed hits, but the counterparty's decision is never changed for you: decide it with `PUT
|
|
493
|
+
# /v3/travel-rule/vasps/{vasp_id}/decision/`. Repeating the same review changes nothing (`changed: false`).
|
|
494
|
+
# Needs the transactions write privilege.
|
|
495
|
+
#
|
|
496
|
+
# +PATCH /v3/travel-rule/vasps/{vasp_id}/screening/+
|
|
497
|
+
#
|
|
498
|
+
# @param vasp_id [String] The id of a row of GET /v3/travel-rule/vasps/: a directory entry or a Didit network
|
|
499
|
+
# member.
|
|
500
|
+
# @param screening_id [String] The screening the hit belongs to, as returned by the screening endpoints.
|
|
501
|
+
# @param hit_id [String] The hit's `id`.
|
|
502
|
+
# @param review_status [String]
|
|
503
|
+
# @param reason [String]
|
|
504
|
+
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
505
|
+
# @return [Didit::Types::TravelRuleReviewVaspScreeningHitResponse]
|
|
506
|
+
def review_vasp_screening_hit(vasp_id, screening_id:, hit_id:, review_status:, reason: OMIT, request_options: nil)
|
|
507
|
+
@client.request(
|
|
508
|
+
:patch,
|
|
509
|
+
"/v3/travel-rule/vasps/{vasp_id}/screening/",
|
|
510
|
+
path_params: { "vasp_id" => vasp_id },
|
|
511
|
+
body: {
|
|
512
|
+
"screening_id" => screening_id,
|
|
513
|
+
"hit_id" => hit_id,
|
|
514
|
+
"review_status" => review_status,
|
|
515
|
+
"reason" => reason
|
|
516
|
+
},
|
|
517
|
+
response: Types::TravelRuleReviewVaspScreeningHitResponse,
|
|
518
|
+
request_options: request_options
|
|
519
|
+
)
|
|
520
|
+
end
|
|
521
|
+
|
|
393
522
|
# Screen a VASP
|
|
394
523
|
#
|
|
395
524
|
# Screen the counterparty entity against sanctions and adverse media for your application. Opt-in:
|
|
@@ -453,21 +582,63 @@ module Didit
|
|
|
453
582
|
# its compliance address or a contact your application sees, for a Didit network member its confirmed compliance
|
|
454
583
|
# email. Default: the address a Travel Rule email to the counterparty goes to (your own contact first, then a
|
|
455
584
|
# platform contact, then the entry's compliance address).
|
|
585
|
+
# @param answer_by_days [Integer] Optional. Days the counterparty has to answer. Default: the standard answer
|
|
586
|
+
# window.
|
|
587
|
+
# @param requested_items [Array<String>] Optional. What the counterparty must provide: the questionnaire answers
|
|
588
|
+
# and/or PDF documents.
|
|
456
589
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
457
590
|
# @return [Didit::Types::TravelRuleCounterpartyQuestionnaire]
|
|
458
|
-
def send_vasp_questionnaire(
|
|
591
|
+
def send_vasp_questionnaire(
|
|
592
|
+
vasp_id,
|
|
593
|
+
sent_to: OMIT,
|
|
594
|
+
answer_by_days: OMIT,
|
|
595
|
+
requested_items: OMIT,
|
|
596
|
+
request_options: nil
|
|
597
|
+
)
|
|
459
598
|
@client.request(
|
|
460
599
|
:post,
|
|
461
600
|
"/v3/travel-rule/vasps/{vasp_id}/questionnaires/",
|
|
462
601
|
path_params: { "vasp_id" => vasp_id },
|
|
463
602
|
body: {
|
|
464
|
-
"sent_to" => sent_to
|
|
603
|
+
"sent_to" => sent_to,
|
|
604
|
+
"answer_by_days" => answer_by_days,
|
|
605
|
+
"requested_items" => requested_items
|
|
465
606
|
},
|
|
466
607
|
response: Types::TravelRuleCounterpartyQuestionnaire,
|
|
467
608
|
request_options: request_options
|
|
468
609
|
)
|
|
469
610
|
end
|
|
470
611
|
|
|
612
|
+
# Share documents with a VASP
|
|
613
|
+
#
|
|
614
|
+
# Emails the counterparty a private link to the selected documents. Sharing again replaces the earlier share:
|
|
615
|
+
# the earlier link stops working for good. Sharing exactly what is already shared with the same address changes
|
|
616
|
+
# nothing and answers `200` with `url: null`. Needs the transactions write privilege.
|
|
617
|
+
#
|
|
618
|
+
# +POST /v3/travel-rule/vasps/{vasp_id}/shared-documents/+
|
|
619
|
+
#
|
|
620
|
+
# @param vasp_id [String] The id of a row of GET /v3/travel-rule/vasps/: a directory entry or a Didit network
|
|
621
|
+
# member.
|
|
622
|
+
# @param document_ids [Array<String>] Documents of your own inventory, each once.
|
|
623
|
+
# @param sent_to [String] Optional. A compliance address on record for the counterparty, chosen the way
|
|
624
|
+
# `sent_to` of the questionnaire request is. Default: the address a Travel Rule email to the counterparty goes
|
|
625
|
+
# to.
|
|
626
|
+
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
627
|
+
# @return [Didit::Types::TravelRuleDocumentShare]
|
|
628
|
+
def share_vasp_documents(vasp_id, document_ids:, sent_to: OMIT, request_options: nil)
|
|
629
|
+
@client.request(
|
|
630
|
+
:post,
|
|
631
|
+
"/v3/travel-rule/vasps/{vasp_id}/shared-documents/",
|
|
632
|
+
path_params: { "vasp_id" => vasp_id },
|
|
633
|
+
body: {
|
|
634
|
+
"document_ids" => document_ids,
|
|
635
|
+
"sent_to" => sent_to
|
|
636
|
+
},
|
|
637
|
+
response: Types::TravelRuleDocumentShare,
|
|
638
|
+
request_options: request_options
|
|
639
|
+
)
|
|
640
|
+
end
|
|
641
|
+
|
|
471
642
|
# Update Travel Rule settings
|
|
472
643
|
#
|
|
473
644
|
# Upsert the application's Travel Rule settings and VASP profile. Partial update - only send the fields you want
|
|
@@ -614,6 +785,47 @@ module Didit
|
|
|
614
785
|
)
|
|
615
786
|
end
|
|
616
787
|
|
|
788
|
+
# Withdraw the documents shared with a VASP
|
|
789
|
+
#
|
|
790
|
+
# Revokes every active link to your documents for this counterparty. Withdrawal is permanent: the links never
|
|
791
|
+
# work again, and sharing again creates a new link.
|
|
792
|
+
#
|
|
793
|
+
# +DELETE /v3/travel-rule/vasps/{vasp_id}/shared-documents/+
|
|
794
|
+
#
|
|
795
|
+
# @param vasp_id [String] The id of a row of GET /v3/travel-rule/vasps/: a directory entry or a Didit network
|
|
796
|
+
# member.
|
|
797
|
+
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
798
|
+
# @return [nil]
|
|
799
|
+
def withdraw_vasp_documents(vasp_id, request_options: nil)
|
|
800
|
+
@client.request(
|
|
801
|
+
:delete,
|
|
802
|
+
"/v3/travel-rule/vasps/{vasp_id}/shared-documents/",
|
|
803
|
+
path_params: { "vasp_id" => vasp_id },
|
|
804
|
+
request_options: request_options
|
|
805
|
+
)
|
|
806
|
+
end
|
|
807
|
+
|
|
808
|
+
# Withdraw a due-diligence request
|
|
809
|
+
#
|
|
810
|
+
# Withdraws the request and erases the documents and answers collected with it. Its answer link stops working.
|
|
811
|
+
# Deletion is irreversible. Needs the transactions write privilege.
|
|
812
|
+
#
|
|
813
|
+
# +DELETE /v3/travel-rule/vasps/{vasp_id}/questionnaires/{questionnaire_id}/+
|
|
814
|
+
#
|
|
815
|
+
# @param vasp_id [String] The id of a row of GET /v3/travel-rule/vasps/: a directory entry or a Didit network
|
|
816
|
+
# member.
|
|
817
|
+
# @param questionnaire_id [String]
|
|
818
|
+
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
819
|
+
# @return [nil]
|
|
820
|
+
def withdraw_vasp_questionnaire(vasp_id, questionnaire_id, request_options: nil)
|
|
821
|
+
@client.request(
|
|
822
|
+
:delete,
|
|
823
|
+
"/v3/travel-rule/vasps/{vasp_id}/questionnaires/{questionnaire_id}/",
|
|
824
|
+
path_params: { "vasp_id" => vasp_id, "questionnaire_id" => questionnaire_id },
|
|
825
|
+
request_options: request_options
|
|
826
|
+
)
|
|
827
|
+
end
|
|
828
|
+
|
|
617
829
|
# The +travel_rule.counterparty_contacts+ resource.
|
|
618
830
|
class CounterpartyContacts < Didit::Resource
|
|
619
831
|
# Add a counterparty contact
|
|
@@ -627,16 +839,30 @@ module Didit
|
|
|
627
839
|
# @param counterparty [String] The directory entry's `id`.
|
|
628
840
|
# @param email [String]
|
|
629
841
|
# @param name [String] Optional label.
|
|
842
|
+
# @param role [String] Optional. The contact's role.
|
|
843
|
+
# @param phone [String] Optional. The contact's phone number.
|
|
844
|
+
# @param receives_requests [Boolean] Whether due-diligence requests and reminders go to this contact.
|
|
630
845
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
631
846
|
# @return [Didit::Types::TravelRuleCounterpartyContact]
|
|
632
|
-
def create(
|
|
847
|
+
def create(
|
|
848
|
+
counterparty:,
|
|
849
|
+
email:,
|
|
850
|
+
name: OMIT,
|
|
851
|
+
role: OMIT,
|
|
852
|
+
phone: OMIT,
|
|
853
|
+
receives_requests: OMIT,
|
|
854
|
+
request_options: nil
|
|
855
|
+
)
|
|
633
856
|
@client.request(
|
|
634
857
|
:post,
|
|
635
858
|
"/v3/travel-rule/counterparty-contacts/",
|
|
636
859
|
body: {
|
|
637
860
|
"counterparty" => counterparty,
|
|
638
861
|
"email" => email,
|
|
639
|
-
"name" => name
|
|
862
|
+
"name" => name,
|
|
863
|
+
"role" => role,
|
|
864
|
+
"phone" => phone,
|
|
865
|
+
"receives_requests" => receives_requests
|
|
640
866
|
},
|
|
641
867
|
response: Types::TravelRuleCounterpartyContact,
|
|
642
868
|
request_options: request_options
|
|
@@ -689,6 +915,143 @@ module Didit
|
|
|
689
915
|
request_options: request_options
|
|
690
916
|
)
|
|
691
917
|
end
|
|
918
|
+
|
|
919
|
+
# Edit a counterparty contact
|
|
920
|
+
#
|
|
921
|
+
# Edits one of your application's own contacts. Changing the email address clears its verification and invalid
|
|
922
|
+
# state. Platform contacts cannot be edited.
|
|
923
|
+
#
|
|
924
|
+
# +PATCH /v3/travel-rule/counterparty-contacts/{contact_uuid}/+
|
|
925
|
+
#
|
|
926
|
+
# @param contact_uuid [String]
|
|
927
|
+
# @param name [String]
|
|
928
|
+
# @param email [String]
|
|
929
|
+
# @param role [String]
|
|
930
|
+
# @param phone [String]
|
|
931
|
+
# @param receives_requests [Boolean]
|
|
932
|
+
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
933
|
+
# @return [Didit::Types::TravelRuleCounterpartyContact]
|
|
934
|
+
def update(
|
|
935
|
+
contact_uuid,
|
|
936
|
+
name: OMIT,
|
|
937
|
+
email: OMIT,
|
|
938
|
+
role: OMIT,
|
|
939
|
+
phone: OMIT,
|
|
940
|
+
receives_requests: OMIT,
|
|
941
|
+
request_options: nil
|
|
942
|
+
)
|
|
943
|
+
@client.request(
|
|
944
|
+
:patch,
|
|
945
|
+
"/v3/travel-rule/counterparty-contacts/{contact_uuid}/",
|
|
946
|
+
path_params: { "contact_uuid" => contact_uuid },
|
|
947
|
+
body: {
|
|
948
|
+
"name" => name,
|
|
949
|
+
"email" => email,
|
|
950
|
+
"role" => role,
|
|
951
|
+
"phone" => phone,
|
|
952
|
+
"receives_requests" => receives_requests
|
|
953
|
+
},
|
|
954
|
+
response: Types::TravelRuleCounterpartyContact,
|
|
955
|
+
request_options: request_options
|
|
956
|
+
)
|
|
957
|
+
end
|
|
958
|
+
end
|
|
959
|
+
|
|
960
|
+
# The +travel_rule.documents+ resource.
|
|
961
|
+
class Documents < Didit::Resource
|
|
962
|
+
# Upload a Travel Rule document
|
|
963
|
+
#
|
|
964
|
+
# Stores a PDF in your inventory so you can share it with counterparties. The file must be a PDF of at most 5
|
|
965
|
+
# MiB. Uploading identical content of the same kind again returns the existing document. Needs the
|
|
966
|
+
# transactions write privilege.
|
|
967
|
+
#
|
|
968
|
+
# +POST /v3/travel-rule/documents/+
|
|
969
|
+
#
|
|
970
|
+
# @param kind [String] `questionnaire`: the due-diligence questionnaire answers. `incorporation`: certificate
|
|
971
|
+
# of incorporation. `licence`: licence or registration. `aml_policy`: AML and CFT policy. `ownership`:
|
|
972
|
+
# ownership structure.
|
|
973
|
+
# @param file [Pathname, IO, String, Didit::FilePart] A PDF of at most 5 MiB.
|
|
974
|
+
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
975
|
+
# @return [Didit::Types::TravelRuleDocument]
|
|
976
|
+
def create(kind:, file:, request_options: nil)
|
|
977
|
+
@client.request(
|
|
978
|
+
:post,
|
|
979
|
+
"/v3/travel-rule/documents/",
|
|
980
|
+
body: {
|
|
981
|
+
"kind" => kind,
|
|
982
|
+
"file" => file
|
|
983
|
+
},
|
|
984
|
+
encoding: :multipart,
|
|
985
|
+
file_fields: %w[file],
|
|
986
|
+
response: Types::TravelRuleDocument,
|
|
987
|
+
request_options: request_options
|
|
988
|
+
)
|
|
989
|
+
end
|
|
990
|
+
|
|
991
|
+
# Delete a Travel Rule document
|
|
992
|
+
#
|
|
993
|
+
# Deletes the document and every link that shared it. Deletion is irreversible and takes effect at once:
|
|
994
|
+
# shared links stop working.
|
|
995
|
+
#
|
|
996
|
+
# +DELETE /v3/travel-rule/documents/{document_id}/+
|
|
997
|
+
#
|
|
998
|
+
# @param document_id [String]
|
|
999
|
+
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
1000
|
+
# @return [nil]
|
|
1001
|
+
def delete(document_id, request_options: nil)
|
|
1002
|
+
@client.request(
|
|
1003
|
+
:delete,
|
|
1004
|
+
"/v3/travel-rule/documents/{document_id}/",
|
|
1005
|
+
path_params: { "document_id" => document_id },
|
|
1006
|
+
request_options: request_options
|
|
1007
|
+
)
|
|
1008
|
+
end
|
|
1009
|
+
|
|
1010
|
+
# Download a Travel Rule document
|
|
1011
|
+
#
|
|
1012
|
+
# Returns the PDF, as an attachment, for a document you uploaded or one a counterparty sent you with a
|
|
1013
|
+
# questionnaire. Needs the transactions read privilege.
|
|
1014
|
+
#
|
|
1015
|
+
# +GET /v3/travel-rule/documents/{document_id}/+
|
|
1016
|
+
#
|
|
1017
|
+
# @param document_id [String]
|
|
1018
|
+
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
1019
|
+
# @return [String, nil] the body bytes, or nil when a block receives the chunks
|
|
1020
|
+
def download(document_id, request_options: nil, &block)
|
|
1021
|
+
@client.request(
|
|
1022
|
+
:get,
|
|
1023
|
+
"/v3/travel-rule/documents/{document_id}/",
|
|
1024
|
+
path_params: { "document_id" => document_id },
|
|
1025
|
+
response: :binary,
|
|
1026
|
+
accept: "application/pdf, application/json",
|
|
1027
|
+
request_options: request_options, &block
|
|
1028
|
+
)
|
|
1029
|
+
end
|
|
1030
|
+
|
|
1031
|
+
# List your Travel Rule documents
|
|
1032
|
+
#
|
|
1033
|
+
# Paginated inventory of the PDF documents you uploaded to share with counterparties, newest first. Documents
|
|
1034
|
+
# counterparties sent you with a questionnaire are not listed here: they appear on the questionnaire. Needs
|
|
1035
|
+
# the transactions read privilege.
|
|
1036
|
+
#
|
|
1037
|
+
# +GET /v3/travel-rule/documents/+
|
|
1038
|
+
#
|
|
1039
|
+
# @param limit [Integer]
|
|
1040
|
+
# @param offset [Integer]
|
|
1041
|
+
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
1042
|
+
# @return [Didit::Page<Didit::Types::TravelRuleDocument>]
|
|
1043
|
+
def list(limit: OMIT, offset: OMIT, request_options: nil)
|
|
1044
|
+
@client.request(
|
|
1045
|
+
:get,
|
|
1046
|
+
"/v3/travel-rule/documents/",
|
|
1047
|
+
query: {
|
|
1048
|
+
"limit" => limit,
|
|
1049
|
+
"offset" => offset
|
|
1050
|
+
},
|
|
1051
|
+
page: Types::TravelRuleDocument,
|
|
1052
|
+
request_options: request_options
|
|
1053
|
+
)
|
|
1054
|
+
end
|
|
692
1055
|
end
|
|
693
1056
|
|
|
694
1057
|
# The +travel_rule.networks+ resource.
|
|
@@ -1191,8 +1554,9 @@ module Didit
|
|
|
1191
1554
|
# Update wallet address holder metadata
|
|
1192
1555
|
#
|
|
1193
1556
|
# Partial update of holder_name, holder_vendor_data, entity_type, and travel_address. Setting travel_address
|
|
1194
|
-
# attaches a TRP routing address to the entry; invalid values are rejected with 400. The response
|
|
1195
|
-
#
|
|
1557
|
+
# attaches a TRP routing address to the entry; invalid values are rejected with 400. The response returns the
|
|
1558
|
+
# updated entry: its label, owner type, receiving travel address and ownership proof summary, with the
|
|
1559
|
+
# writable fields.
|
|
1196
1560
|
#
|
|
1197
1561
|
# +PATCH /v3/travel-rule/wallet-addresses/{entry_uuid}/+
|
|
1198
1562
|
#
|
|
@@ -1202,7 +1566,7 @@ module Didit
|
|
|
1202
1566
|
# @param entity_type [String]
|
|
1203
1567
|
# @param travel_address [String]
|
|
1204
1568
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
1205
|
-
# @return [Didit::Types::
|
|
1569
|
+
# @return [Didit::Types::WalletAddressEntryUpdateResponse]
|
|
1206
1570
|
def update(
|
|
1207
1571
|
entry_uuid,
|
|
1208
1572
|
holder_name: OMIT,
|
|
@@ -1221,7 +1585,7 @@ module Didit
|
|
|
1221
1585
|
"entity_type" => entity_type,
|
|
1222
1586
|
"travel_address" => travel_address
|
|
1223
1587
|
},
|
|
1224
|
-
response: Types::
|
|
1588
|
+
response: Types::WalletAddressEntryUpdateResponse,
|
|
1225
1589
|
request_options: request_options
|
|
1226
1590
|
)
|
|
1227
1591
|
end
|
|
@@ -198,6 +198,35 @@ module Didit
|
|
|
198
198
|
)
|
|
199
199
|
end
|
|
200
200
|
|
|
201
|
+
# List webhook destination activity
|
|
202
|
+
#
|
|
203
|
+
# Lists recorded failure alerts for one destination, newest first. Requires read:webhooks. Application/API-key
|
|
204
|
+
# credentials must belong to the application in the path; member Bearer tokens must have access to that
|
|
205
|
+
# application. These are failure alert events, not individual delivery attempts or outbound webhook event
|
|
206
|
+
# types. See [Webhooks](https://docs.didit.me/integration/webhooks#retry-policy).
|
|
207
|
+
#
|
|
208
|
+
# +GET /v3/organization/{organization_id}/application/{application_id}/webhook/destinations/{destination_uuid}/activity/+
|
|
209
|
+
#
|
|
210
|
+
# @param destination_uuid [String] Destination uuid.
|
|
211
|
+
# @param limit [Integer] Maximum results per page.
|
|
212
|
+
# @param offset [Integer] Number of results to skip.
|
|
213
|
+
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
214
|
+
# @return [Didit::Page<Didit::Types::WebhookDestinationActivity>]
|
|
215
|
+
def list_activity(destination_uuid, limit: OMIT, offset: OMIT, request_options: nil)
|
|
216
|
+
@client.request(
|
|
217
|
+
:get,
|
|
218
|
+
"/v3/organization/{organization_id}/application/{application_id}/webhook/destinations/{destination_uuid}/activity/",
|
|
219
|
+
path_params: { "destination_uuid" => destination_uuid },
|
|
220
|
+
query: {
|
|
221
|
+
"limit" => limit,
|
|
222
|
+
"offset" => offset
|
|
223
|
+
},
|
|
224
|
+
scope: :application,
|
|
225
|
+
page: Types::WebhookDestinationActivity,
|
|
226
|
+
request_options: request_options
|
|
227
|
+
)
|
|
228
|
+
end
|
|
229
|
+
|
|
201
230
|
# List webhook destination deliveries
|
|
202
231
|
#
|
|
203
232
|
# Page through every delivery attempt to one webhook destination, newest first. The first send of each event,
|
data/lib/didit/resources.rb
CHANGED
|
@@ -39,6 +39,7 @@ module Didit
|
|
|
39
39
|
autoload :Questionnaires, "didit/resources/questionnaires"
|
|
40
40
|
autoload :RegulatoryReports, "didit/resources/regulatory_reports"
|
|
41
41
|
autoload :ReportTemplates, "didit/resources/report_templates"
|
|
42
|
+
autoload :Reports, "didit/resources/reports"
|
|
42
43
|
autoload :Sandbox, "didit/resources/sandbox"
|
|
43
44
|
autoload :Sessions, "didit/resources/sessions"
|
|
44
45
|
autoload :Transactions, "didit/resources/transactions"
|
|
@@ -225,6 +226,11 @@ module Didit
|
|
|
225
226
|
@report_templates ||= Resources::ReportTemplates.new(self)
|
|
226
227
|
end
|
|
227
228
|
|
|
229
|
+
# @return [Didit::Resources::Reports]
|
|
230
|
+
def reports
|
|
231
|
+
@reports ||= Resources::Reports.new(self)
|
|
232
|
+
end
|
|
233
|
+
|
|
228
234
|
# @return [Didit::Resources::Sandbox]
|
|
229
235
|
def sandbox
|
|
230
236
|
@sandbox ||= Resources::Sandbox.new(self)
|