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.
Files changed (79) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +7 -0
  3. data/lib/didit/resources/address_validation.rb +3 -0
  4. data/lib/didit/resources/age_estimation.rb +3 -0
  5. data/lib/didit/resources/bank.rb +14 -3
  6. data/lib/didit/resources/biometric_templates.rb +6 -1
  7. data/lib/didit/resources/blocklist.rb +6 -0
  8. data/lib/didit/resources/businesses.rb +29 -3
  9. data/lib/didit/resources/cases.rb +204 -35
  10. data/lib/didit/resources/customization.rb +3 -0
  11. data/lib/didit/resources/database_validation.rb +3 -0
  12. data/lib/didit/resources/document_ai.rb +3 -0
  13. data/lib/didit/resources/email.rb +17 -1
  14. data/lib/didit/resources/face_match.rb +3 -0
  15. data/lib/didit/resources/face_search.rb +3 -0
  16. data/lib/didit/resources/fraud_checks.rb +6 -0
  17. data/lib/didit/resources/id_verification.rb +3 -0
  18. data/lib/didit/resources/id_wallets.rb +9 -3
  19. data/lib/didit/resources/investigator.rb +12 -2
  20. data/lib/didit/resources/ip.rb +3 -0
  21. data/lib/didit/resources/kyb.rb +26 -2
  22. data/lib/didit/resources/lists.rb +18 -5
  23. data/lib/didit/resources/monitoring_events.rb +12 -2
  24. data/lib/didit/resources/networks.rb +12 -4
  25. data/lib/didit/resources/passive_liveness.rb +3 -0
  26. data/lib/didit/resources/phone.rb +9 -0
  27. data/lib/didit/resources/proof_of_address.rb +3 -0
  28. data/lib/didit/resources/questionnaires.rb +9 -1
  29. data/lib/didit/resources/regulatory_reports.rb +15 -3
  30. data/lib/didit/resources/report_templates.rb +9 -2
  31. data/lib/didit/resources/reports.rb +3 -0
  32. data/lib/didit/resources/sessions.rb +170 -29
  33. data/lib/didit/resources/transactions.rb +51 -8
  34. data/lib/didit/resources/travel_rule.rb +115 -24
  35. data/lib/didit/resources/users.rb +23 -3
  36. data/lib/didit/resources/wallet_screening.rb +3 -1
  37. data/lib/didit/resources/webhooks.rb +23 -3
  38. data/lib/didit/resources/workflows.rb +11 -3
  39. data/lib/didit/types/sessions.rb +22 -0
  40. data/lib/didit/types.rb +1 -0
  41. data/lib/didit/version.rb +1 -1
  42. data/sig/didit/resources/address_validation.rbs +1 -1
  43. data/sig/didit/resources/age_estimation.rbs +1 -1
  44. data/sig/didit/resources/bank.rbs +1 -1
  45. data/sig/didit/resources/biometric_templates.rbs +2 -2
  46. data/sig/didit/resources/blocklist.rbs +2 -2
  47. data/sig/didit/resources/businesses.rbs +7 -7
  48. data/sig/didit/resources/cases.rbs +44 -44
  49. data/sig/didit/resources/customization.rbs +1 -1
  50. data/sig/didit/resources/database_validation.rbs +1 -1
  51. data/sig/didit/resources/document_ai.rbs +1 -1
  52. data/sig/didit/resources/email.rbs +3 -3
  53. data/sig/didit/resources/face_match.rbs +1 -1
  54. data/sig/didit/resources/face_search.rbs +1 -1
  55. data/sig/didit/resources/fraud_checks.rbs +2 -2
  56. data/sig/didit/resources/id_verification.rbs +1 -1
  57. data/sig/didit/resources/id_wallets.rbs +3 -3
  58. data/sig/didit/resources/investigator.rbs +4 -4
  59. data/sig/didit/resources/ip.rbs +1 -1
  60. data/sig/didit/resources/kyb.rbs +4 -4
  61. data/sig/didit/resources/lists.rbs +6 -6
  62. data/sig/didit/resources/monitoring_events.rbs +4 -4
  63. data/sig/didit/resources/networks.rbs +4 -4
  64. data/sig/didit/resources/passive_liveness.rbs +1 -1
  65. data/sig/didit/resources/phone.rbs +3 -3
  66. data/sig/didit/resources/proof_of_address.rbs +1 -1
  67. data/sig/didit/resources/questionnaires.rbs +3 -3
  68. data/sig/didit/resources/regulatory_reports.rbs +5 -5
  69. data/sig/didit/resources/report_templates.rbs +3 -3
  70. data/sig/didit/resources/reports.rbs +1 -1
  71. data/sig/didit/resources/sessions.rbs +39 -39
  72. data/sig/didit/resources/transactions.rbs +15 -15
  73. data/sig/didit/resources/travel_rule.rbs +33 -33
  74. data/sig/didit/resources/users.rbs +7 -7
  75. data/sig/didit/resources/wallet_screening.rbs +1 -1
  76. data/sig/didit/resources/webhooks.rbs +5 -5
  77. data/sig/didit/resources/workflows.rbs +3 -3
  78. data/sig/didit/types/sessions.rbs +21 -0
  79. metadata +1 -1
@@ -56,9 +56,10 @@ module Didit
56
56
  # @param vasp_id [String] The id of a row of GET /v3/travel-rule/vasps/: a directory entry or a Didit network
57
57
  # member.
58
58
  # @param assignee_email [String, nil] Email of an application member. null or an empty string unassigns.
59
+ # @param idempotency_key [String] sent as the Idempotency-Key header
59
60
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
60
61
  # @return [Didit::Types::TravelRuleAssignVaspResponse]
61
- def assign_vasp(vasp_id, assignee_email:, request_options: nil)
62
+ def assign_vasp(vasp_id, assignee_email:, idempotency_key: OMIT, request_options: nil)
62
63
  @client.request(
63
64
  :post,
64
65
  "/v3/travel-rule/vasps/{vasp_id}/assign/",
@@ -66,6 +67,7 @@ module Didit
66
67
  body: {
67
68
  "assignee_email" => assignee_email
68
69
  },
70
+ headers: { "Idempotency-Key" => idempotency_key },
69
71
  response: Types::TravelRuleAssignVaspResponse,
70
72
  request_options: request_options
71
73
  )
@@ -80,13 +82,15 @@ module Didit
80
82
  #
81
83
  # @param vasp_id [String] The id of a row of GET /v3/travel-rule/vasps/: a directory entry or a Didit network
82
84
  # member.
85
+ # @param idempotency_key [String] sent as the Idempotency-Key header
83
86
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
84
87
  # @return [Didit::Types::TravelRuleCounterpartyDecisionResponse]
85
- def clear_vasp_decision(vasp_id, request_options: nil)
88
+ def clear_vasp_decision(vasp_id, idempotency_key: OMIT, request_options: nil)
86
89
  @client.request(
87
90
  :delete,
88
91
  "/v3/travel-rule/vasps/{vasp_id}/decision/",
89
92
  path_params: { "vasp_id" => vasp_id },
93
+ headers: { "Idempotency-Key" => idempotency_key },
90
94
  response: Types::TravelRuleCounterpartyDecisionResponse,
91
95
  request_options: request_options
92
96
  )
@@ -106,9 +110,18 @@ module Didit
106
110
  # @param lei [String] Optional LEI, normalized to uppercase.
107
111
  # @param jurisdiction [String] Optional ISO 3166 alpha-2 or alpha-3 country code, normalized to uppercase.
108
112
  # @param invite [Boolean] Send an invitation to the supplied email.
113
+ # @param idempotency_key [String] sent as the Idempotency-Key header
109
114
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
110
115
  # @return [Didit::Types::VaspDirectoryEntry]
111
- def create_vasp(name:, email:, lei: OMIT, jurisdiction: OMIT, invite: OMIT, request_options: nil)
116
+ def create_vasp(
117
+ name:,
118
+ email:,
119
+ lei: OMIT,
120
+ jurisdiction: OMIT,
121
+ invite: OMIT,
122
+ idempotency_key: OMIT,
123
+ request_options: nil
124
+ )
112
125
  @client.request(
113
126
  :post,
114
127
  "/v3/travel-rule/vasps/",
@@ -119,6 +132,7 @@ module Didit
119
132
  "jurisdiction" => jurisdiction,
120
133
  "invite" => invite
121
134
  },
135
+ headers: { "Idempotency-Key" => idempotency_key },
122
136
  response: Types::VaspDirectoryEntry,
123
137
  request_options: request_options
124
138
  )
@@ -158,6 +172,7 @@ module Didit
158
172
  # another; it needs `request_key`.
159
173
  # @param request_key [String] Only with `request_action: new`. An idempotency key: repeating the call with the
160
174
  # same key returns the same link while it is active, and `410` once it has been revoked or has expired.
175
+ # @param idempotency_key [String] sent as the Idempotency-Key header
161
176
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
162
177
  # @return [Didit::Types::TravelRuleWidgetSessionResponse]
163
178
  def create_widget_session(
@@ -172,6 +187,7 @@ module Didit
172
187
  wallet_entry_id: OMIT,
173
188
  request_action: OMIT,
174
189
  request_key: OMIT,
190
+ idempotency_key: OMIT,
175
191
  request_options: nil
176
192
  )
177
193
  @client.request(
@@ -190,6 +206,7 @@ module Didit
190
206
  "request_action" => request_action,
191
207
  "request_key" => request_key
192
208
  },
209
+ headers: { "Idempotency-Key" => idempotency_key },
193
210
  response: Types::TravelRuleWidgetSessionResponse,
194
211
  request_options: request_options
195
212
  )
@@ -369,6 +386,7 @@ module Didit
369
386
  # bytes, a 64-bit id or a 32-byte hash in hex. EOS: up to 256 bytes. ATOM: up to 256 characters....
370
387
  # @param utxo [Hash] Optional, UTXO chains only. The deposit transaction's inputs and outputs: the sender's
371
388
  # wallet is the declared `originator_data.wallet_address`, else the largest input.
389
+ # @param idempotency_key [String] sent as the Idempotency-Key header
372
390
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
373
391
  # @return [Didit::Types::TravelRuleInboundResponse]
374
392
  def register_inbound(
@@ -382,6 +400,7 @@ module Didit
382
400
  originating_vasp: OMIT,
383
401
  memo: OMIT,
384
402
  utxo: OMIT,
403
+ idempotency_key: OMIT,
385
404
  request_options: nil
386
405
  )
387
406
  @client.request(
@@ -399,6 +418,7 @@ module Didit
399
418
  "memo" => memo,
400
419
  "utxo" => utxo
401
420
  },
421
+ headers: { "Idempotency-Key" => idempotency_key },
402
422
  response: Types::TravelRuleInboundResponse,
403
423
  request_options: request_options
404
424
  )
@@ -501,9 +521,18 @@ module Didit
501
521
  # @param hit_id [String] The hit's `id`.
502
522
  # @param review_status [String]
503
523
  # @param reason [String]
524
+ # @param idempotency_key [String] sent as the Idempotency-Key header
504
525
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
505
526
  # @return [Didit::Types::TravelRuleReviewVaspScreeningHitResponse]
506
- def review_vasp_screening_hit(vasp_id, screening_id:, hit_id:, review_status:, reason: OMIT, request_options: nil)
527
+ def review_vasp_screening_hit(
528
+ vasp_id,
529
+ screening_id:,
530
+ hit_id:,
531
+ review_status:,
532
+ reason: OMIT,
533
+ idempotency_key: OMIT,
534
+ request_options: nil
535
+ )
507
536
  @client.request(
508
537
  :patch,
509
538
  "/v3/travel-rule/vasps/{vasp_id}/screening/",
@@ -514,6 +543,7 @@ module Didit
514
543
  "review_status" => review_status,
515
544
  "reason" => reason
516
545
  },
546
+ headers: { "Idempotency-Key" => idempotency_key },
517
547
  response: Types::TravelRuleReviewVaspScreeningHitResponse,
518
548
  request_options: request_options
519
549
  )
@@ -532,9 +562,10 @@ module Didit
532
562
  # @param vasp_id [String] The id of a row of GET /v3/travel-rule/vasps/: a directory entry or a Didit network
533
563
  # member.
534
564
  # @param refresh [Boolean] true screens again (and bills again) even when a fresh screening exists.
565
+ # @param idempotency_key [String] sent as the Idempotency-Key header
535
566
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
536
567
  # @return [Didit::Types::TravelRuleCounterpartyScreeningResult]
537
- def screen_vasp(vasp_id, refresh: OMIT, request_options: nil)
568
+ def screen_vasp(vasp_id, refresh: OMIT, idempotency_key: OMIT, request_options: nil)
538
569
  @client.request(
539
570
  :post,
540
571
  "/v3/travel-rule/vasps/{vasp_id}/screening/",
@@ -542,6 +573,7 @@ module Didit
542
573
  body: {
543
574
  "refresh" => refresh
544
575
  },
576
+ headers: { "Idempotency-Key" => idempotency_key },
545
577
  response: Types::TravelRuleCounterpartyScreeningResult,
546
578
  request_options: request_options
547
579
  )
@@ -556,12 +588,14 @@ module Didit
556
588
  #
557
589
  # +POST /v3/travel-rule/settings/compliance-email/confirmation/+
558
590
  #
591
+ # @param idempotency_key [String] sent as the Idempotency-Key header
559
592
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
560
593
  # @return [Didit::Types::TravelRuleSendComplianceEmailConfirmationResponse]
561
- def send_compliance_email_confirmation(request_options: nil)
594
+ def send_compliance_email_confirmation(idempotency_key: OMIT, request_options: nil)
562
595
  @client.request(
563
596
  :post,
564
597
  "/v3/travel-rule/settings/compliance-email/confirmation/",
598
+ headers: { "Idempotency-Key" => idempotency_key },
565
599
  response: Types::TravelRuleSendComplianceEmailConfirmationResponse,
566
600
  request_options: request_options
567
601
  )
@@ -586,6 +620,7 @@ module Didit
586
620
  # window.
587
621
  # @param requested_items [Array<String>] Optional. What the counterparty must provide: the questionnaire answers
588
622
  # and/or PDF documents.
623
+ # @param idempotency_key [String] sent as the Idempotency-Key header
589
624
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
590
625
  # @return [Didit::Types::TravelRuleCounterpartyQuestionnaire]
591
626
  def send_vasp_questionnaire(
@@ -593,6 +628,7 @@ module Didit
593
628
  sent_to: OMIT,
594
629
  answer_by_days: OMIT,
595
630
  requested_items: OMIT,
631
+ idempotency_key: OMIT,
596
632
  request_options: nil
597
633
  )
598
634
  @client.request(
@@ -604,6 +640,7 @@ module Didit
604
640
  "answer_by_days" => answer_by_days,
605
641
  "requested_items" => requested_items
606
642
  },
643
+ headers: { "Idempotency-Key" => idempotency_key },
607
644
  response: Types::TravelRuleCounterpartyQuestionnaire,
608
645
  request_options: request_options
609
646
  )
@@ -623,9 +660,10 @@ module Didit
623
660
  # @param sent_to [String] Optional. A compliance address on record for the counterparty, chosen the way
624
661
  # `sent_to` of the questionnaire request is. Default: the address a Travel Rule email to the counterparty goes
625
662
  # to.
663
+ # @param idempotency_key [String] sent as the Idempotency-Key header
626
664
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
627
665
  # @return [Didit::Types::TravelRuleDocumentShare]
628
- def share_vasp_documents(vasp_id, document_ids:, sent_to: OMIT, request_options: nil)
666
+ def share_vasp_documents(vasp_id, document_ids:, sent_to: OMIT, idempotency_key: OMIT, request_options: nil)
629
667
  @client.request(
630
668
  :post,
631
669
  "/v3/travel-rule/vasps/{vasp_id}/shared-documents/",
@@ -634,6 +672,7 @@ module Didit
634
672
  "document_ids" => document_ids,
635
673
  "sent_to" => sent_to
636
674
  },
675
+ headers: { "Idempotency-Key" => idempotency_key },
637
676
  response: Types::TravelRuleDocumentShare,
638
677
  request_options: request_options
639
678
  )
@@ -691,6 +730,7 @@ module Didit
691
730
  # @param disabled_networks [Array<String>] Networks opted out of platform membership. Does not disable your
692
731
  # connected own memberships or provision unavailable networks.
693
732
  # @param licence [String] VASP licence or registration reference. Empty when not supplied.
733
+ # @param idempotency_key [String] sent as the Idempotency-Key header
694
734
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
695
735
  # @return [Didit::Types::TravelRuleSettingsDetail]
696
736
  def update_settings(
@@ -719,6 +759,7 @@ module Didit
719
759
  non_responsive_policy: OMIT,
720
760
  disabled_networks: OMIT,
721
761
  licence: OMIT,
762
+ idempotency_key: OMIT,
722
763
  request_options: nil
723
764
  )
724
765
  @client.request(
@@ -751,6 +792,7 @@ module Didit
751
792
  "disabled_networks" => disabled_networks,
752
793
  "licence" => licence
753
794
  },
795
+ headers: { "Idempotency-Key" => idempotency_key },
754
796
  response: Types::TravelRuleSettingsDetail,
755
797
  request_options: request_options
756
798
  )
@@ -769,9 +811,10 @@ module Didit
769
811
  # member.
770
812
  # @param decision [String]
771
813
  # @param reason [String] Optional. Replaces the previous reason; omit it to clear it.
814
+ # @param idempotency_key [String] sent as the Idempotency-Key header
772
815
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
773
816
  # @return [Didit::Types::TravelRuleCounterpartyDecisionResponse]
774
- def update_vasp_decision(vasp_id, decision:, reason: OMIT, request_options: nil)
817
+ def update_vasp_decision(vasp_id, decision:, reason: OMIT, idempotency_key: OMIT, request_options: nil)
775
818
  @client.request(
776
819
  :put,
777
820
  "/v3/travel-rule/vasps/{vasp_id}/decision/",
@@ -780,6 +823,7 @@ module Didit
780
823
  "decision" => decision,
781
824
  "reason" => reason
782
825
  },
826
+ headers: { "Idempotency-Key" => idempotency_key },
783
827
  response: Types::TravelRuleCounterpartyDecisionResponse,
784
828
  request_options: request_options
785
829
  )
@@ -794,13 +838,15 @@ module Didit
794
838
  #
795
839
  # @param vasp_id [String] The id of a row of GET /v3/travel-rule/vasps/: a directory entry or a Didit network
796
840
  # member.
841
+ # @param idempotency_key [String] sent as the Idempotency-Key header
797
842
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
798
843
  # @return [nil]
799
- def withdraw_vasp_documents(vasp_id, request_options: nil)
844
+ def withdraw_vasp_documents(vasp_id, idempotency_key: OMIT, request_options: nil)
800
845
  @client.request(
801
846
  :delete,
802
847
  "/v3/travel-rule/vasps/{vasp_id}/shared-documents/",
803
848
  path_params: { "vasp_id" => vasp_id },
849
+ headers: { "Idempotency-Key" => idempotency_key },
804
850
  request_options: request_options
805
851
  )
806
852
  end
@@ -815,13 +861,15 @@ module Didit
815
861
  # @param vasp_id [String] The id of a row of GET /v3/travel-rule/vasps/: a directory entry or a Didit network
816
862
  # member.
817
863
  # @param questionnaire_id [String]
864
+ # @param idempotency_key [String] sent as the Idempotency-Key header
818
865
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
819
866
  # @return [nil]
820
- def withdraw_vasp_questionnaire(vasp_id, questionnaire_id, request_options: nil)
867
+ def withdraw_vasp_questionnaire(vasp_id, questionnaire_id, idempotency_key: OMIT, request_options: nil)
821
868
  @client.request(
822
869
  :delete,
823
870
  "/v3/travel-rule/vasps/{vasp_id}/questionnaires/{questionnaire_id}/",
824
871
  path_params: { "vasp_id" => vasp_id, "questionnaire_id" => questionnaire_id },
872
+ headers: { "Idempotency-Key" => idempotency_key },
825
873
  request_options: request_options
826
874
  )
827
875
  end
@@ -842,6 +890,7 @@ module Didit
842
890
  # @param role [String] Optional. The contact's role.
843
891
  # @param phone [String] Optional. The contact's phone number.
844
892
  # @param receives_requests [Boolean] Whether due-diligence requests and reminders go to this contact.
893
+ # @param idempotency_key [String] sent as the Idempotency-Key header
845
894
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
846
895
  # @return [Didit::Types::TravelRuleCounterpartyContact]
847
896
  def create(
@@ -851,6 +900,7 @@ module Didit
851
900
  role: OMIT,
852
901
  phone: OMIT,
853
902
  receives_requests: OMIT,
903
+ idempotency_key: OMIT,
854
904
  request_options: nil
855
905
  )
856
906
  @client.request(
@@ -864,6 +914,7 @@ module Didit
864
914
  "phone" => phone,
865
915
  "receives_requests" => receives_requests
866
916
  },
917
+ headers: { "Idempotency-Key" => idempotency_key },
867
918
  response: Types::TravelRuleCounterpartyContact,
868
919
  request_options: request_options
869
920
  )
@@ -877,13 +928,15 @@ module Didit
877
928
  # +DELETE /v3/travel-rule/counterparty-contacts/{contact_uuid}/+
878
929
  #
879
930
  # @param contact_uuid [String]
931
+ # @param idempotency_key [String] sent as the Idempotency-Key header
880
932
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
881
933
  # @return [nil]
882
- def delete(contact_uuid, request_options: nil)
934
+ def delete(contact_uuid, idempotency_key: OMIT, request_options: nil)
883
935
  @client.request(
884
936
  :delete,
885
937
  "/v3/travel-rule/counterparty-contacts/{contact_uuid}/",
886
938
  path_params: { "contact_uuid" => contact_uuid },
939
+ headers: { "Idempotency-Key" => idempotency_key },
887
940
  request_options: request_options
888
941
  )
889
942
  end
@@ -929,6 +982,7 @@ module Didit
929
982
  # @param role [String]
930
983
  # @param phone [String]
931
984
  # @param receives_requests [Boolean]
985
+ # @param idempotency_key [String] sent as the Idempotency-Key header
932
986
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
933
987
  # @return [Didit::Types::TravelRuleCounterpartyContact]
934
988
  def update(
@@ -938,6 +992,7 @@ module Didit
938
992
  role: OMIT,
939
993
  phone: OMIT,
940
994
  receives_requests: OMIT,
995
+ idempotency_key: OMIT,
941
996
  request_options: nil
942
997
  )
943
998
  @client.request(
@@ -951,6 +1006,7 @@ module Didit
951
1006
  "phone" => phone,
952
1007
  "receives_requests" => receives_requests
953
1008
  },
1009
+ headers: { "Idempotency-Key" => idempotency_key },
954
1010
  response: Types::TravelRuleCounterpartyContact,
955
1011
  request_options: request_options
956
1012
  )
@@ -971,9 +1027,10 @@ module Didit
971
1027
  # of incorporation. `licence`: licence or registration. `aml_policy`: AML and CFT policy. `ownership`:
972
1028
  # ownership structure.
973
1029
  # @param file [Pathname, IO, String, Didit::FilePart] A PDF of at most 5 MiB.
1030
+ # @param idempotency_key [String] sent as the Idempotency-Key header
974
1031
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
975
1032
  # @return [Didit::Types::TravelRuleDocument]
976
- def create(kind:, file:, request_options: nil)
1033
+ def create(kind:, file:, idempotency_key: OMIT, request_options: nil)
977
1034
  @client.request(
978
1035
  :post,
979
1036
  "/v3/travel-rule/documents/",
@@ -983,6 +1040,7 @@ module Didit
983
1040
  },
984
1041
  encoding: :multipart,
985
1042
  file_fields: %w[file],
1043
+ headers: { "Idempotency-Key" => idempotency_key },
986
1044
  response: Types::TravelRuleDocument,
987
1045
  request_options: request_options
988
1046
  )
@@ -996,13 +1054,15 @@ module Didit
996
1054
  # +DELETE /v3/travel-rule/documents/{document_id}/+
997
1055
  #
998
1056
  # @param document_id [String]
1057
+ # @param idempotency_key [String] sent as the Idempotency-Key header
999
1058
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
1000
1059
  # @return [nil]
1001
- def delete(document_id, request_options: nil)
1060
+ def delete(document_id, idempotency_key: OMIT, request_options: nil)
1002
1061
  @client.request(
1003
1062
  :delete,
1004
1063
  "/v3/travel-rule/documents/{document_id}/",
1005
1064
  path_params: { "document_id" => document_id },
1065
+ headers: { "Idempotency-Key" => idempotency_key },
1006
1066
  request_options: request_options
1007
1067
  )
1008
1068
  end
@@ -1068,13 +1128,15 @@ module Didit
1068
1128
  # +POST /v3/travel-rule/networks/{network}/request/+
1069
1129
  #
1070
1130
  # @param network [String] The network to join through Didit's membership.
1131
+ # @param idempotency_key [String] sent as the Idempotency-Key header
1071
1132
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
1072
1133
  # @return [Didit::Types::TravelRuleNetworkParticipant]
1073
- def request_access(network, request_options: nil)
1134
+ def request_access(network, idempotency_key: OMIT, request_options: nil)
1074
1135
  @client.request(
1075
1136
  :post,
1076
1137
  "/v3/travel-rule/networks/{network}/request/",
1077
1138
  path_params: { "network" => network },
1139
+ headers: { "Idempotency-Key" => idempotency_key },
1078
1140
  response: Types::TravelRuleNetworkParticipant,
1079
1141
  request_options: request_options
1080
1142
  )
@@ -1126,12 +1188,14 @@ module Didit
1126
1188
  #
1127
1189
  # +POST /v3/travel-rule/networks/questionnaire/submit/+
1128
1190
  #
1191
+ # @param idempotency_key [String] sent as the Idempotency-Key header
1129
1192
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
1130
1193
  # @return [Didit::Types::TravelRuleNetworkQuestionnaire]
1131
- def submit_questionnaire(request_options: nil)
1194
+ def submit_questionnaire(idempotency_key: OMIT, request_options: nil)
1132
1195
  @client.request(
1133
1196
  :post,
1134
1197
  "/v3/travel-rule/networks/questionnaire/submit/",
1198
+ headers: { "Idempotency-Key" => idempotency_key },
1135
1199
  response: Types::TravelRuleNetworkQuestionnaire,
1136
1200
  request_options: request_options
1137
1201
  )
@@ -1162,6 +1226,7 @@ module Didit
1162
1226
  # @param expected_monthly_volume_usd [String] Expected monthly volume in USD, up to 2 decimal places. Returned
1163
1227
  # as a string.
1164
1228
  # @param assets [Array<String>] Asset tickers, stored upper-case, sorted and de-duplicated.
1229
+ # @param idempotency_key [String] sent as the Idempotency-Key header
1165
1230
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
1166
1231
  # @return [Didit::Types::TravelRuleNetworkQuestionnaire]
1167
1232
  def update_questionnaire(
@@ -1182,6 +1247,7 @@ module Didit
1182
1247
  expected_monthly_transfers: OMIT,
1183
1248
  expected_monthly_volume_usd: OMIT,
1184
1249
  assets: OMIT,
1250
+ idempotency_key: OMIT,
1185
1251
  request_options: nil
1186
1252
  )
1187
1253
  @client.request(
@@ -1206,6 +1272,7 @@ module Didit
1206
1272
  "expected_monthly_volume_usd" => expected_monthly_volume_usd,
1207
1273
  "assets" => assets
1208
1274
  },
1275
+ headers: { "Idempotency-Key" => idempotency_key },
1209
1276
  response: Types::TravelRuleNetworkQuestionnaire,
1210
1277
  request_options: request_options
1211
1278
  )
@@ -1352,9 +1419,10 @@ module Didit
1352
1419
  # @param transaction_uuid [String] The `transaction_id` of the unmatched deposit.
1353
1420
  # @param transaction_id [String] The `transaction_id` of the received Travel Rule message (a row with `kind:
1354
1421
  # message`).
1422
+ # @param idempotency_key [String] sent as the Idempotency-Key header
1355
1423
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
1356
1424
  # @return [Didit::Types::TravelRuleManualMatchResponse]
1357
- def match(transaction_uuid, transaction_id:, request_options: nil)
1425
+ def match(transaction_uuid, transaction_id:, idempotency_key: OMIT, request_options: nil)
1358
1426
  @client.request(
1359
1427
  :post,
1360
1428
  "/v3/travel-rule/unmatched/{transaction_uuid}/match/",
@@ -1362,6 +1430,7 @@ module Didit
1362
1430
  body: {
1363
1431
  "transaction_id" => transaction_id
1364
1432
  },
1433
+ headers: { "Idempotency-Key" => idempotency_key },
1365
1434
  response: Types::TravelRuleManualMatchResponse,
1366
1435
  request_options: request_options
1367
1436
  )
@@ -1382,15 +1451,17 @@ module Didit
1382
1451
  # +POST /v3/travel-rule/wallet-addresses/import/+
1383
1452
  #
1384
1453
  # @param body [Hash, Array<Hash>]
1454
+ # @param idempotency_key [String] sent as the Idempotency-Key header
1385
1455
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
1386
1456
  # @return [Didit::Types::WalletAddressImportReport]
1387
- def bulk_import(body:, request_options: nil)
1457
+ def bulk_import(body:, idempotency_key: OMIT, request_options: nil)
1388
1458
  @client.request(
1389
1459
  :post,
1390
1460
  "/v3/travel-rule/wallet-addresses/import/",
1391
1461
  body: body,
1392
1462
  encoding: :auto,
1393
1463
  file_fields: %w[file],
1464
+ headers: { "Idempotency-Key" => idempotency_key },
1394
1465
  response: Types::WalletAddressImportReport,
1395
1466
  request_options: request_options
1396
1467
  )
@@ -1422,6 +1493,7 @@ module Didit
1422
1493
  # tag, a whole number from 0 to 4294967295 (a JSON number is accepted). XLM: a text memo of up to 28 bytes, a
1423
1494
  # 64-bit id or a 32-byte hash in hex. EOS: up to 256 bytes. ATOM: up to 256 characters. HBAR: up to 100 bytes.
1424
1495
  # Bitcoin, EVM, Solana, Tron, Litecoin, Bitcoin Cash, Dogecoin and Lightning wallets take no memo:...
1496
+ # @param idempotency_key [String] sent as the Idempotency-Key header
1425
1497
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
1426
1498
  # @return [Didit::Types::WalletAddressEntry]
1427
1499
  def create(
@@ -1433,6 +1505,7 @@ module Didit
1433
1505
  self_declared: OMIT,
1434
1506
  travel_address: OMIT,
1435
1507
  memo: OMIT,
1508
+ idempotency_key: OMIT,
1436
1509
  request_options: nil
1437
1510
  )
1438
1511
  @client.request(
@@ -1448,6 +1521,7 @@ module Didit
1448
1521
  "travel_address" => travel_address,
1449
1522
  "memo" => memo
1450
1523
  },
1524
+ headers: { "Idempotency-Key" => idempotency_key },
1451
1525
  response: Types::WalletAddressEntry,
1452
1526
  request_options: request_options
1453
1527
  )
@@ -1462,13 +1536,15 @@ module Didit
1462
1536
  # +DELETE /v3/travel-rule/wallet-addresses/{entry_uuid}/+
1463
1537
  #
1464
1538
  # @param entry_uuid [String]
1539
+ # @param idempotency_key [String] sent as the Idempotency-Key header
1465
1540
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
1466
1541
  # @return [nil]
1467
- def delete(entry_uuid, request_options: nil)
1542
+ def delete(entry_uuid, idempotency_key: OMIT, request_options: nil)
1468
1543
  @client.request(
1469
1544
  :delete,
1470
1545
  "/v3/travel-rule/wallet-addresses/{entry_uuid}/",
1471
1546
  path_params: { "entry_uuid" => entry_uuid },
1547
+ headers: { "Idempotency-Key" => idempotency_key },
1472
1548
  request_options: request_options
1473
1549
  )
1474
1550
  end
@@ -1565,6 +1641,7 @@ module Didit
1565
1641
  # @param holder_vendor_data [String]
1566
1642
  # @param entity_type [String]
1567
1643
  # @param travel_address [String]
1644
+ # @param idempotency_key [String] sent as the Idempotency-Key header
1568
1645
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
1569
1646
  # @return [Didit::Types::WalletAddressEntryUpdateResponse]
1570
1647
  def update(
@@ -1573,6 +1650,7 @@ module Didit
1573
1650
  holder_vendor_data: OMIT,
1574
1651
  entity_type: OMIT,
1575
1652
  travel_address: OMIT,
1653
+ idempotency_key: OMIT,
1576
1654
  request_options: nil
1577
1655
  )
1578
1656
  @client.request(
@@ -1585,6 +1663,7 @@ module Didit
1585
1663
  "entity_type" => entity_type,
1586
1664
  "travel_address" => travel_address
1587
1665
  },
1666
+ headers: { "Idempotency-Key" => idempotency_key },
1588
1667
  response: Types::WalletAddressEntryUpdateResponse,
1589
1668
  request_options: request_options
1590
1669
  )
@@ -1606,9 +1685,10 @@ module Didit
1606
1685
  # @param proof_uuid [String] proof_id from the review queue.
1607
1686
  # @param decision [String]
1608
1687
  # @param note [String] Optional. Kept with the proof and returned as review_note.
1688
+ # @param idempotency_key [String] sent as the Idempotency-Key header
1609
1689
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
1610
1690
  # @return [Didit::Types::TravelRuleWalletProofReview]
1611
- def decide(proof_uuid, decision:, note: OMIT, request_options: nil)
1691
+ def decide(proof_uuid, decision:, note: OMIT, idempotency_key: OMIT, request_options: nil)
1612
1692
  @client.request(
1613
1693
  :post,
1614
1694
  "/v3/travel-rule/wallet-proofs/{proof_uuid}/decision/",
@@ -1617,6 +1697,7 @@ module Didit
1617
1697
  "decision" => decision,
1618
1698
  "note" => note
1619
1699
  },
1700
+ headers: { "Idempotency-Key" => idempotency_key },
1620
1701
  response: Types::TravelRuleWalletProofReview,
1621
1702
  request_options: request_options
1622
1703
  )
@@ -1668,9 +1749,10 @@ module Didit
1668
1749
  # @param licence [String] Optional licence or registration reference, up to 255 characters; empty clears it.
1669
1750
  # Omission preserves it for the same directory entry and clears it when claiming a different entry. Applied to
1670
1751
  # the VASP profile only when the claim is granted.
1752
+ # @param idempotency_key [String] sent as the Idempotency-Key header
1671
1753
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
1672
1754
  # @return [Didit::Types::TravelRuleWorkspace]
1673
- def claim(vasp_id:, licence: OMIT, request_options: nil)
1755
+ def claim(vasp_id:, licence: OMIT, idempotency_key: OMIT, request_options: nil)
1674
1756
  @client.request(
1675
1757
  :post,
1676
1758
  "/v3/travel-rule/workspace/claim/",
@@ -1678,6 +1760,7 @@ module Didit
1678
1760
  "vasp_id" => vasp_id,
1679
1761
  "licence" => licence
1680
1762
  },
1763
+ headers: { "Idempotency-Key" => idempotency_key },
1681
1764
  response: Types::TravelRuleWorkspace,
1682
1765
  request_options: request_options
1683
1766
  )
@@ -1690,15 +1773,17 @@ module Didit
1690
1773
  # +POST /v3/travel-rule/workspace/domain/confirm/+
1691
1774
  #
1692
1775
  # @param code [String]
1776
+ # @param idempotency_key [String] sent as the Idempotency-Key header
1693
1777
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
1694
1778
  # @return [Didit::Types::TravelRuleWorkspace]
1695
- def confirm_domain(code:, request_options: nil)
1779
+ def confirm_domain(code:, idempotency_key: OMIT, request_options: nil)
1696
1780
  @client.request(
1697
1781
  :post,
1698
1782
  "/v3/travel-rule/workspace/domain/confirm/",
1699
1783
  body: {
1700
1784
  "code" => code
1701
1785
  },
1786
+ headers: { "Idempotency-Key" => idempotency_key },
1702
1787
  response: Types::TravelRuleWorkspace,
1703
1788
  request_options: request_options
1704
1789
  )
@@ -1713,15 +1798,17 @@ module Didit
1713
1798
  #
1714
1799
  # @param enabled [Boolean] Only `true` is accepted: outbound billing cannot be turned back off through the
1715
1800
  # API.
1801
+ # @param idempotency_key [String] sent as the Idempotency-Key header
1716
1802
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
1717
1803
  # @return [Didit::Types::TravelRuleWorkspace]
1718
- def enable_billing(enabled: OMIT, request_options: nil)
1804
+ def enable_billing(enabled: OMIT, idempotency_key: OMIT, request_options: nil)
1719
1805
  @client.request(
1720
1806
  :post,
1721
1807
  "/v3/travel-rule/workspace/billing/",
1722
1808
  body: {
1723
1809
  "enabled" => enabled
1724
1810
  },
1811
+ headers: { "Idempotency-Key" => idempotency_key },
1725
1812
  response: Types::TravelRuleWorkspace,
1726
1813
  request_options: request_options
1727
1814
  )
@@ -1753,12 +1840,14 @@ module Didit
1753
1840
  #
1754
1841
  # +POST /v3/travel-rule/workspace/domain/code/+
1755
1842
  #
1843
+ # @param idempotency_key [String] sent as the Idempotency-Key header
1756
1844
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
1757
1845
  # @return [Didit::Types::TravelRuleWorkspaceDomainCodeResponse]
1758
- def send_domain_code(request_options: nil)
1846
+ def send_domain_code(idempotency_key: OMIT, request_options: nil)
1759
1847
  @client.request(
1760
1848
  :post,
1761
1849
  "/v3/travel-rule/workspace/domain/code/",
1850
+ headers: { "Idempotency-Key" => idempotency_key },
1762
1851
  response: Types::TravelRuleWorkspaceDomainCodeResponse,
1763
1852
  request_options: request_options
1764
1853
  )
@@ -1771,12 +1860,14 @@ module Didit
1771
1860
  #
1772
1861
  # +POST /v3/travel-rule/workspace/domain/dns/+
1773
1862
  #
1863
+ # @param idempotency_key [String] sent as the Idempotency-Key header
1774
1864
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
1775
1865
  # @return [Didit::Types::TravelRuleWorkspace]
1776
- def verify_domain_dns(request_options: nil)
1866
+ def verify_domain_dns(idempotency_key: OMIT, request_options: nil)
1777
1867
  @client.request(
1778
1868
  :post,
1779
1869
  "/v3/travel-rule/workspace/domain/dns/",
1870
+ headers: { "Idempotency-Key" => idempotency_key },
1780
1871
  response: Types::TravelRuleWorkspace,
1781
1872
  request_options: request_options
1782
1873
  )