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
@@ -38,13 +38,15 @@ module Didit
38
38
  # +DELETE /v3/organization/{organization_id}/application/{application_id}/transactions/delete/+
39
39
  #
40
40
  # @param body [Hash]
41
+ # @param idempotency_key [String] sent as the Idempotency-Key header
41
42
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
42
43
  # @return [nil]
43
- def batch_delete(body:, request_options: nil)
44
+ def batch_delete(body:, idempotency_key: OMIT, request_options: nil)
44
45
  @client.request(
45
46
  :delete,
46
47
  "/v3/organization/{organization_id}/application/{application_id}/transactions/delete/",
47
48
  body: body,
49
+ headers: { "Idempotency-Key" => idempotency_key },
48
50
  scope: :application,
49
51
  request_options: request_options
50
52
  )
@@ -88,6 +90,7 @@ module Didit
88
90
  # crypto screening is skipped even if enabled in the application settings. When omitted or `null`, the
89
91
  # application-level default configured in the Console is used. Crypto screening requires
90
92
  # `transaction_details.direction`, `currency_kind...
93
+ # @param idempotency_key [String] sent as the Idempotency-Key header
91
94
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
92
95
  # @return [Didit::Types::TransactionDetail]
93
96
  def create(
@@ -102,6 +105,7 @@ module Didit
102
105
  travel_rule_details: OMIT,
103
106
  network_snapshot: OMIT,
104
107
  include_crypto_screening: OMIT,
108
+ idempotency_key: OMIT,
105
109
  request_options: nil
106
110
  )
107
111
  @client.request(
@@ -120,6 +124,7 @@ module Didit
120
124
  "network_snapshot" => network_snapshot,
121
125
  "include_crypto_screening" => include_crypto_screening
122
126
  },
127
+ headers: { "Idempotency-Key" => idempotency_key },
123
128
  response: Types::TransactionDetail,
124
129
  request_options: request_options
125
130
  )
@@ -141,9 +146,10 @@ module Didit
141
146
  # hours).
142
147
  # @param max_uses [Integer, nil] Maximum number of successful submissions allowed with this token. Omit or null
143
148
  # for unlimited uses within the TTL.
149
+ # @param idempotency_key [String] sent as the Idempotency-Key header
144
150
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
145
151
  # @return [Didit::Types::TransactionsCreateSdkTokenResponse]
146
- def create_sdk_token(vendor_data:, ttl_seconds: OMIT, max_uses: OMIT, request_options: nil)
152
+ def create_sdk_token(vendor_data:, ttl_seconds: OMIT, max_uses: OMIT, idempotency_key: OMIT, request_options: nil)
147
153
  @client.request(
148
154
  :post,
149
155
  "/v3/transactions/sdk-token/",
@@ -152,6 +158,7 @@ module Didit
152
158
  "ttl_seconds" => ttl_seconds,
153
159
  "max_uses" => max_uses
154
160
  },
161
+ headers: { "Idempotency-Key" => idempotency_key },
155
162
  response: Types::TransactionsCreateSdkTokenResponse,
156
163
  request_options: request_options
157
164
  )
@@ -356,9 +363,10 @@ module Didit
356
363
  # rejected. No length limit.
357
364
  # @param mentioned_emails [Array<String>] Emails of members of your organization to mention. Each must be a
358
365
  # valid email of an organization member.
366
+ # @param idempotency_key [String] sent as the Idempotency-Key header
359
367
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
360
368
  # @return [Didit::Types::TransactionNote]
361
- def create(transaction_id, note:, mentioned_emails: OMIT, request_options: nil)
369
+ def create(transaction_id, note:, mentioned_emails: OMIT, idempotency_key: OMIT, request_options: nil)
362
370
  @client.request(
363
371
  :post,
364
372
  "/v3/transactions/{transaction_id}/notes/",
@@ -367,6 +375,7 @@ module Didit
367
375
  "note" => note,
368
376
  "mentioned_emails" => mentioned_emails
369
377
  },
378
+ headers: { "Idempotency-Key" => idempotency_key },
370
379
  response: Types::TransactionNote,
371
380
  request_options: request_options
372
381
  )
@@ -428,6 +437,7 @@ module Didit
428
437
  # @param period_days [Integer]
429
438
  # @param rule_id [String] Optional ID of the rule being edited. Excludes that rule from overlap comparisons;
430
439
  # does not change the candidate configuration.
440
+ # @param idempotency_key [String] sent as the Idempotency-Key header
431
441
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
432
442
  # @return [Didit::Types::TransactionRuleBacktestResult]
433
443
  def backtest(
@@ -437,6 +447,7 @@ module Didit
437
447
  scope: OMIT,
438
448
  period_days: OMIT,
439
449
  rule_id: OMIT,
450
+ idempotency_key: OMIT,
440
451
  request_options: nil
441
452
  )
442
453
  @client.request(
@@ -450,6 +461,7 @@ module Didit
450
461
  "period_days" => period_days,
451
462
  "rule_id" => rule_id
452
463
  },
464
+ headers: { "Idempotency-Key" => idempotency_key },
453
465
  response: Types::TransactionRuleBacktestResult,
454
466
  request_options: request_options
455
467
  )
@@ -479,6 +491,7 @@ module Didit
479
491
  # @param aggregation [Array<Hash>]
480
492
  # @param actions [Array<Hash>]
481
493
  # @param metadata [Hash] Free-form metadata stored on the rule.
494
+ # @param idempotency_key [String] sent as the Idempotency-Key header
482
495
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
483
496
  # @return [Didit::Types::TransactionRuleDetail]
484
497
  def create(
@@ -492,6 +505,7 @@ module Didit
492
505
  aggregation: OMIT,
493
506
  actions: OMIT,
494
507
  metadata: OMIT,
508
+ idempotency_key: OMIT,
495
509
  request_options: nil
496
510
  )
497
511
  @client.request(
@@ -509,6 +523,7 @@ module Didit
509
523
  "actions" => actions,
510
524
  "metadata" => metadata
511
525
  },
526
+ headers: { "Idempotency-Key" => idempotency_key },
512
527
  response: Types::TransactionRuleDetail,
513
528
  request_options: request_options
514
529
  )
@@ -524,13 +539,15 @@ module Didit
524
539
  # +DELETE /v3/transactions/rules/{rule_uuid}/+
525
540
  #
526
541
  # @param rule_uuid [String] The rule's uuid from list or create.
542
+ # @param idempotency_key [String] sent as the Idempotency-Key header
527
543
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
528
544
  # @return [nil]
529
- def delete(rule_uuid, request_options: nil)
545
+ def delete(rule_uuid, idempotency_key: OMIT, request_options: nil)
530
546
  @client.request(
531
547
  :delete,
532
548
  "/v3/transactions/rules/{rule_uuid}/",
533
549
  path_params: { "rule_uuid" => rule_uuid },
550
+ headers: { "Idempotency-Key" => idempotency_key },
534
551
  request_options: request_options
535
552
  )
536
553
  end
@@ -549,9 +566,10 @@ module Didit
549
566
  #
550
567
  # @param library_keys [Array<String>] Specific presets to install or uninstall.
551
568
  # @param bundle [String] Install or uninstall every preset in this bundle instead.
569
+ # @param idempotency_key [String] sent as the Idempotency-Key header
552
570
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
553
571
  # @return [Didit::Types::TransactionRuleInstallResult]
554
- def install_library(library_keys: OMIT, bundle: OMIT, request_options: nil)
572
+ def install_library(library_keys: OMIT, bundle: OMIT, idempotency_key: OMIT, request_options: nil)
555
573
  @client.request(
556
574
  :post,
557
575
  "/v3/transactions/rules/install/",
@@ -559,6 +577,7 @@ module Didit
559
577
  "library_keys" => library_keys,
560
578
  "bundle" => bundle
561
579
  },
580
+ headers: { "Idempotency-Key" => idempotency_key },
562
581
  response: Types::TransactionRuleInstallResult,
563
582
  request_options: request_options
564
583
  )
@@ -672,9 +691,10 @@ module Didit
672
691
  #
673
692
  # @param library_keys [Array<String>] Specific presets to install or uninstall.
674
693
  # @param bundle [String] Install or uninstall every preset in this bundle instead.
694
+ # @param idempotency_key [String] sent as the Idempotency-Key header
675
695
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
676
696
  # @return [Didit::Types::TransactionRuleInstallResult]
677
- def uninstall_library(library_keys: OMIT, bundle: OMIT, request_options: nil)
697
+ def uninstall_library(library_keys: OMIT, bundle: OMIT, idempotency_key: OMIT, request_options: nil)
678
698
  @client.request(
679
699
  :delete,
680
700
  "/v3/transactions/rules/install/",
@@ -682,6 +702,7 @@ module Didit
682
702
  "library_keys" => library_keys,
683
703
  "bundle" => bundle
684
704
  },
705
+ headers: { "Idempotency-Key" => idempotency_key },
685
706
  response: Types::TransactionRuleInstallResult,
686
707
  request_options: request_options
687
708
  )
@@ -715,6 +736,7 @@ module Didit
715
736
  # @param aggregation [Array<Hash>]
716
737
  # @param actions [Array<Hash>]
717
738
  # @param metadata [Hash] Free-form metadata stored on the rule.
739
+ # @param idempotency_key [String] sent as the Idempotency-Key header
718
740
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
719
741
  # @return [Didit::Types::TransactionRuleDetail]
720
742
  def update(
@@ -729,6 +751,7 @@ module Didit
729
751
  aggregation: OMIT,
730
752
  actions: OMIT,
731
753
  metadata: OMIT,
754
+ idempotency_key: OMIT,
732
755
  request_options: nil
733
756
  )
734
757
  @client.request(
@@ -747,6 +770,7 @@ module Didit
747
770
  "actions" => actions,
748
771
  "metadata" => metadata
749
772
  },
773
+ headers: { "Idempotency-Key" => idempotency_key },
750
774
  response: Types::TransactionRuleDetail,
751
775
  request_options: request_options
752
776
  )
@@ -789,9 +813,16 @@ module Didit
789
813
  # beneficiary_data.wallet_address. On a declared self-hosted wallet transfer that names no counterparty
790
814
  # wallet, the wallet whose ownership you verified; without it the request is rejected with 400. Ignored for
791
815
  # other transfers.
816
+ # @param idempotency_key [String] sent as the Idempotency-Key header
792
817
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
793
818
  # @return [Didit::Types::TravelRuleTransferDetail]
794
- def confirm_ownership(transaction_id, confirmed:, wallet_address: OMIT, request_options: nil)
819
+ def confirm_ownership(
820
+ transaction_id,
821
+ confirmed:,
822
+ wallet_address: OMIT,
823
+ idempotency_key: OMIT,
824
+ request_options: nil
825
+ )
795
826
  @client.request(
796
827
  :post,
797
828
  "/v3/transactions/{transaction_id}/travel-rule/ownership/",
@@ -800,6 +831,7 @@ module Didit
800
831
  "confirmed" => confirmed,
801
832
  "wallet_address" => wallet_address
802
833
  },
834
+ headers: { "Idempotency-Key" => idempotency_key },
803
835
  response: Types::TravelRuleTransferDetail,
804
836
  request_options: request_options
805
837
  )
@@ -823,6 +855,7 @@ module Didit
823
855
  # @param reply_to [String, nil] A message of the same transfer. A reply that carries a document fulfils the
824
856
  # document request it answers.
825
857
  # @param files [Array<Pathname, IO, String, Didit::FilePart>] Multipart only. Up to 5 files of 10 MB each.
858
+ # @param idempotency_key [String] sent as the Idempotency-Key header
826
859
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
827
860
  # @return [Didit::Types::TravelRuleMessage]
828
861
  def create_message(
@@ -832,6 +865,7 @@ module Didit
832
865
  requested_documents: OMIT,
833
866
  reply_to: OMIT,
834
867
  files: OMIT,
868
+ idempotency_key: OMIT,
835
869
  request_options: nil
836
870
  )
837
871
  @client.request(
@@ -845,6 +879,7 @@ module Didit
845
879
  "reply_to" => reply_to,
846
880
  "files" => files
847
881
  },
882
+ headers: { "Idempotency-Key" => idempotency_key },
848
883
  response: Types::TravelRuleMessage,
849
884
  request_options: request_options
850
885
  )
@@ -864,9 +899,10 @@ module Didit
864
899
  # @param transaction_id [String] Didit-stable transaction UUID that owns the transfer.
865
900
  # @param channel [String] link returns a new link; email also attempts to send it to the end user's
866
901
  # Didit-record email.
902
+ # @param idempotency_key [String] sent as the Idempotency-Key header
867
903
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
868
904
  # @return [Didit::Types::TravelRuleUserLinkResponse]
869
- def create_user_link(transaction_id, channel: OMIT, request_options: nil)
905
+ def create_user_link(transaction_id, channel: OMIT, idempotency_key: OMIT, request_options: nil)
870
906
  @client.request(
871
907
  :post,
872
908
  "/v3/transactions/{transaction_id}/travel-rule/user-link/",
@@ -874,6 +910,7 @@ module Didit
874
910
  body: {
875
911
  "channel" => channel
876
912
  },
913
+ headers: { "Idempotency-Key" => idempotency_key },
877
914
  response: Types::TravelRuleUserLinkResponse,
878
915
  request_options: request_options
879
916
  )
@@ -948,6 +985,7 @@ module Didit
948
985
  # @param currency [String] Asset code.
949
986
  # @param reference [String] Optional idempotency key. A repeat with the same value returns the transfer the
950
987
  # first call booked.
988
+ # @param idempotency_key [String] sent as the Idempotency-Key header
951
989
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
952
990
  # @return [Didit::Types::TravelRuleTestVaspInboundResponse]
953
991
  def trigger_test_vasp_inbound(
@@ -957,6 +995,7 @@ module Didit
957
995
  amount: OMIT,
958
996
  currency: OMIT,
959
997
  reference: OMIT,
998
+ idempotency_key: OMIT,
960
999
  request_options: nil
961
1000
  )
962
1001
  @client.request(
@@ -970,6 +1009,7 @@ module Didit
970
1009
  "currency" => currency,
971
1010
  "reference" => reference
972
1011
  },
1012
+ headers: { "Idempotency-Key" => idempotency_key },
973
1013
  response: Types::TravelRuleTestVaspInboundResponse,
974
1014
  request_options: request_options
975
1015
  )
@@ -1033,6 +1073,7 @@ module Didit
1033
1073
  # clears the previous country hint.
1034
1074
  # @param vasp_name [String] With action=update_compliance_email: optional counterparty name saved with the
1035
1075
  # address when nonempty.
1076
+ # @param idempotency_key [String] sent as the Idempotency-Key header
1036
1077
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
1037
1078
  # @return [Didit::Types::TravelRuleTransferDetail]
1038
1079
  def update_transfer(
@@ -1049,6 +1090,7 @@ module Didit
1049
1090
  lei: OMIT,
1050
1091
  country: OMIT,
1051
1092
  vasp_name: OMIT,
1093
+ idempotency_key: OMIT,
1052
1094
  request_options: nil
1053
1095
  )
1054
1096
  @client.request(
@@ -1069,6 +1111,7 @@ module Didit
1069
1111
  "country" => country,
1070
1112
  "vasp_name" => vasp_name
1071
1113
  },
1114
+ headers: { "Idempotency-Key" => idempotency_key },
1072
1115
  response: Types::TravelRuleTransferDetail,
1073
1116
  request_options: request_options
1074
1117
  )