didit-sdk 2.12.0 → 2.13.1

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d237908b8d26f01a2c1b1f240404560f0840a60580942d4541504485c5e89d80
4
- data.tar.gz: 6ec80811d16ada1ca9e3dea375c23d30424bbf133cc56c195d241304b49031b5
3
+ metadata.gz: fdd7206643757259988718350d8738ab3fc1e407a502ef263a3fb1fb7cd2b95e
4
+ data.tar.gz: 7958618527442627b4e9420afbc37f467689e848134d0b5c114730adb015e2d1
5
5
  SHA512:
6
- metadata.gz: d446e8d8b357ace21eec7c8787ae8e779209a221bd568ac06afdb5963e112fcf915b5c59940ae96fe3ff289662af30fda2934a00b961f3e148faeefcc0dbd017
7
- data.tar.gz: '0905abc26c9270edae21957afd9eb9854c976e070894c072148159e8cfbd66760177c85f395233ddf3436bbcecfb0a0aab42eb5f78ba6f022bc77bd158002288'
6
+ metadata.gz: ef3b873d60dc67cbe542d85427c0abeddbca437238c32c6495a7b32d144006f095a0792e1b668ffbc79d4fc8e10441553096630a7a110e25b07f225b7144c332
7
+ data.tar.gz: e15b2941758352a511710b652108ddd7502e056975ed6c1f9bda01e3a7a1f3bd07f192669017be1fa3a68b3cdcc2a7c3e51ff3964e4fd4affb85076ff9ab90d0
data/CHANGELOG.md CHANGED
@@ -1,5 +1,31 @@
1
1
  # Changelog
2
2
 
3
+ ## [2.13.1](https://github.com/didit-protocol/sdk-ruby/compare/v2.13.0...v2.13.1) (2026-11-12)
4
+
5
+
6
+ ### Bug Fixes
7
+
8
+ * **authentication:** a body nested past the depth limit is not JSON ([c0cb38e](https://github.com/didit-protocol/sdk-ruby/commit/c0cb38edf6f8302c640bfac2bac2e8191b3c123f))
9
+ * **authentication:** a failure to encode a consent request has a fixed message ([2f2bdb7](https://github.com/didit-protocol/sdk-ruby/commit/2f2bdb7302fb6b56db5b1b29cd90cf447ef588a5))
10
+ * **authentication:** a malformed 2xx consent error keeps no parser exception as its cause ([e9cad91](https://github.com/didit-protocol/sdk-ruby/commit/e9cad918b725708f14ee37f5f07922ab78d074be))
11
+ * **authentication:** a malformed 2xx consent message reads the content type from the sanitized response ([fa0e897](https://github.com/didit-protocol/sdk-ruby/commit/fa0e897c76d810f473b2f4c69cd6025883ba1ce5))
12
+ * **authentication:** collect consent secrets from the JSON the request carries ([ada5949](https://github.com/didit-protocol/sdk-ruby/commit/ada5949ad9afd041cbf8f2766e5889f66600dae7))
13
+ * **authentication:** read consent secrets from the bytes that were sent ([02a0be4](https://github.com/didit-protocol/sdk-ruby/commit/02a0be4ef2688595a66aeda5f03e512f20109b94))
14
+ * **authentication:** redact every string of the consent assertion from errors ([c1ed630](https://github.com/didit-protocol/sdk-ruby/commit/c1ed63076c21fd9a66939045b026bb68592ad580))
15
+ * **authentication:** redact the parsed agent-consent response, not its raw text ([9d8dfef](https://github.com/didit-protocol/sdk-ruby/commit/9d8dfef87e9c2d2f5433551b75de28a98608cd1b))
16
+ * **authentication:** sanitize the whole consent response once on receipt ([d7f875d](https://github.com/didit-protocol/sdk-ruby/commit/d7f875deabe3cb4a0311ced9d6bf416a4c7ef19d))
17
+ * **authentication:** successful consent responses reach the caller unchanged; fold header-name case ([9becd6d](https://github.com/didit-protocol/sdk-ruby/commit/9becd6d166d122deeec244248890a0a4f5c8b847))
18
+ * **authentication:** the approval-options call encodes through the same fixed-message wrapper ([570043e](https://github.com/didit-protocol/sdk-ruby/commit/570043e36c63e494708c2f7cc8ab0ae412633c1f))
19
+ * **authentication:** treat only assertion strings of 16+ characters as secrets ([e072900](https://github.com/didit-protocol/sdk-ruby/commit/e072900a01bb52e865159ef88811c2398bd442e2))
20
+ * **authentication:** withhold transport causes, redact empty bodies, headers and request id, keep safe key names ([d966dc2](https://github.com/didit-protocol/sdk-ruby/commit/d966dc27fe9dcc0909446272961258cdb22178fb))
21
+
22
+ ## [2.13.0](https://github.com/didit-protocol/sdk-ruby/compare/v2.12.0...v2.13.0) (2026-11-11)
23
+
24
+
25
+ ### Features
26
+
27
+ * **spec:** sync API spec 2026-11-11 ([918c23f](https://github.com/didit-protocol/sdk-ruby/commit/918c23f87009d9d61c568fc270fd97a17b0aa2b0))
28
+
3
29
  ## [2.12.0](https://github.com/didit-protocol/sdk-ruby/compare/v2.11.0...v2.12.0) (2026-11-11)
4
30
 
5
31
 
@@ -3,7 +3,7 @@
3
3
  module Didit
4
4
  class Authentication
5
5
  # Builds and checks the body of +POST agents/consent/+, and names the strings of it that
6
- # must never reach an error message: the challenge and the assertion's response members.
6
+ # must never reach an error: the challenge and every string of the assertion.
7
7
  #
8
8
  # @api private
9
9
  module AgentConsentRequest
@@ -12,9 +12,6 @@ module Didit
12
12
  UUID = /\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/i
13
13
  LIFETIMES = [86_400, 604_800, 2_592_000].freeze
14
14
  DECISIONS = %w[approve deny].freeze
15
- # The assertion members that are secrets.
16
- ASSERTION_SECRETS = %w[clientDataJSON authenticatorData signature userHandle].freeze
17
-
18
15
  # @return [Array(Hash, Array<String>)] the JSON body and its secret strings
19
16
  # @raise [Didit::ConfigurationError]
20
17
  def self.build(challenge, decision, assertion, scopes, extras = {})
@@ -25,17 +22,30 @@ module Didit
25
22
 
26
23
  # @type var body: Hash[String, untyped]
27
24
  body = { "challenge" => challenge, "decision" => decision }
28
- secrets = [challenge]
29
- unless assertion.nil?
30
- body["assertion"] = checked_assertion(assertion)
31
- secrets.concat(assertion_secrets(assertion))
32
- end
25
+ body["assertion"] = checked_assertion(assertion) unless assertion.nil?
33
26
  body["scopes"] = checked_scopes(scopes) unless scopes.nil?
34
27
  organization_ids = extras[:organization_ids]
35
28
  lifetime = extras[:lifetime]
36
29
  body["organization_ids"] = checked_organization_ids(organization_ids) unless organization_ids.nil?
37
30
  body["lifetime"] = checked_lifetime(lifetime) unless lifetime.nil?
38
- [body, secrets]
31
+ # Encoded exactly once: the plain body decoded from these bytes is what is sent, and the secrets are
32
+ # read from it, so a caller's object is never serialized a second time.
33
+ body = encode_once(body)
34
+ [body, [challenge, *assertion_secrets(body["assertion"])]]
35
+ end
36
+
37
+ # A nested object's serializer may put the challenge or a credential in its error message: any failure
38
+ # is a fixed-message error with no cause.
39
+ def self.encode_once(body)
40
+ encoded = nil
41
+ begin
42
+ encoded = JSON.parse(JSON.generate(body))
43
+ rescue StandardError, SystemStackError
44
+ encoded = nil
45
+ end
46
+ raise ConfigurationError, "could not encode the agent consent request." if encoded.nil?
47
+
48
+ encoded
39
49
  end
40
50
 
41
51
  def self.checked_organization_ids(ids)
@@ -63,12 +73,19 @@ module Didit
63
73
  raise ConfigurationError, "scopes must be a non-empty array of strings such as [\"read\", \"act\"]."
64
74
  end
65
75
 
66
- def self.assertion_secrets(assertion)
67
- response = assertion["response"] || assertion[:response]
68
- return [] unless response.is_a?(Hash)
76
+ # Strings shorter than this are not secrets: field names such as "id" and values such as "public-key"
77
+ # would otherwise erase error codes like "invalid_grant" (docs/DESIGN.md section 10).
78
+ # Sensitive values are 16+ chars: user handles are 16-byte ids (22 base64url), credential ids 16+ bytes.
79
+ MIN_SECRET_LENGTH = 16
69
80
 
70
- response.filter_map do |key, value|
71
- value if ASSERTION_SECRETS.include?(key.to_s) && value.is_a?(String) && !value.empty?
81
+ # Every string of at least 16 characters inside the assertion, at any depth: object keys and values,
82
+ # array items.
83
+ def self.assertion_secrets(value)
84
+ case value
85
+ when String then value.length >= MIN_SECRET_LENGTH ? [value] : []
86
+ when Hash then value.flat_map { |key, item| assertion_secrets(key.to_s) + assertion_secrets(item) }
87
+ when Array then value.flat_map { |item| assertion_secrets(item) }
88
+ else []
72
89
  end
73
90
  end
74
91
  end
@@ -24,13 +24,17 @@ module Didit
24
24
  # @return [Array<String>] tokens, codes and verifiers redacted from errors
25
25
  attr_reader :secrets
26
26
 
27
- def initialize(http_method, uri, bearer: nil, form: nil, json: nil, secrets: [])
27
+ # @return [Boolean] redact errors from the parsed body, never from its raw text
28
+ attr_reader :structured
29
+
30
+ def initialize(http_method, uri, bearer: nil, form: nil, json: nil, secrets: [], structured: false)
28
31
  @http_method = http_method
29
32
  @uri = uri
30
33
  @bearer = bearer
31
34
  @form = form
32
35
  @json = json
33
36
  @secrets = secrets
37
+ @structured = structured
34
38
  freeze
35
39
  end
36
40
 
@@ -61,9 +65,21 @@ module Didit
61
65
  # @return [Didit::Internal::Transport::Response]
62
66
  # @raise [Didit::APIConnectionError, Didit::APITimeoutError] when no response arrives
63
67
  def perform(call)
64
- @transport.execute(VERBS.fetch(call.http_method), call.uri, headers_for(call), body_for(call), @timeout)
65
- rescue Internal::Transport::Failure => e
66
- error_class = e.timeout? ? APITimeoutError : APIConnectionError
68
+ error_class = APIConnectionError
69
+ begin
70
+ verb = VERBS.fetch(call.http_method)
71
+ response = @transport.execute(verb, call.uri, headers_for(call), body_for(call), @timeout)
72
+ # A successful response reaches the caller unchanged; errors are built from a sanitized copy only.
73
+ return response
74
+ rescue Internal::Transport::Failure => e
75
+ error_class = e.timeout? ? APITimeoutError : APIConnectionError
76
+ rescue StandardError
77
+ # A request that carries secrets reports a fixed error for anything a transport raises.
78
+ raise unless call.structured
79
+
80
+ error_class = APIConnectionError
81
+ end
82
+ # Raised outside the handlers, so no cause carries the transport's text, which may quote the request.
67
83
  raise error_class.new(http_method: call.http_method, url: call.display_url)
68
84
  end
69
85
 
@@ -82,18 +98,26 @@ module Didit
82
98
  def read(call, response)
83
99
  body = response.body.to_s
84
100
  unless (200..299).cover?(response.status)
101
+ response = error_response(call, response)
102
+ body = response.body.to_s
85
103
  raise Internal::Errors.status_error(
86
- status: response.status, headers: response.headers, raw_body: body, redact: call.secrets
104
+ status: response.status, headers: response.headers, raw_body: body, redact: redactions(call)
87
105
  )
88
106
  end
89
107
  return nil if response.status == 204 || body.empty?
90
108
 
109
+ parsed = nil
110
+ failed = false
91
111
  begin
92
- JSON.parse(text_of(body))
112
+ parsed = JSON.parse(text_of(body))
93
113
  rescue JSON::ParserError
94
- content_type = response.headers.fetch("content-type", "no content type")
95
- raise validation_error(call, response, "Expected a JSON response from #{call.describe}, got #{content_type}.")
114
+ failed = true
96
115
  end
116
+ return parsed unless failed
117
+
118
+ # Raised outside the rescue: the parser's error quotes the raw input, so it is never the cause.
119
+ content_type = error_response(call, response).headers.fetch("content-type", "no content type")
120
+ raise validation_error(call, response, "Expected a JSON response from #{call.describe}, got #{content_type}.")
97
121
  end
98
122
 
99
123
  # The JSON object of a 2xx response.
@@ -108,16 +132,27 @@ module Didit
108
132
 
109
133
  # @return [Didit::APIResponseValidationError]
110
134
  def validation_error(call, response, message)
135
+ response = error_response(call, response)
111
136
  body = response.body.to_s
137
+ shown = body.empty? ? nil : Internal::Util.redact(text_of(body), redactions(call))
112
138
  APIResponseValidationError.new(
113
- message, status: response.status, headers: response.headers,
114
- body: body.empty? ? nil : Internal::Util.redact(text_of(body), call.secrets),
139
+ message, status: response.status, headers: response.headers, body: shown,
115
140
  request_id: Internal::Util.request_id(response.headers)
116
141
  )
117
142
  end
118
143
 
119
144
  private
120
145
 
146
+ # The response an error is built from: a sanitized copy for a consent call, else the response.
147
+ def error_response(call, response)
148
+ call.structured ? Internal::Errors.sanitized_response(response, call.secrets) : response
149
+ end
150
+
151
+ # A structured call's response is already sanitized, so nothing is replaced again.
152
+ def redactions(call)
153
+ call.structured ? [] : call.secrets
154
+ end
155
+
121
156
  def headers_for(call)
122
157
  headers = {
123
158
  "Accept" => "application/json",
@@ -296,7 +296,8 @@ module Didit
296
296
  def create_agent_approval_options(access_token, challenge:)
297
297
  challenge = required_text(challenge, "challenge")
298
298
  AgentApprovalOptions.new(
299
- agent_request(AgentConsentRequest::OPTIONS_PATH, access_token, { "challenge" => challenge }, [challenge])
299
+ agent_request(AgentConsentRequest::OPTIONS_PATH, access_token,
300
+ AgentConsentRequest.encode_once({ "challenge" => challenge }), [challenge])
300
301
  )
301
302
  end
302
303
 
@@ -488,16 +489,18 @@ module Didit
488
489
  TokenResponse.new(send_object(call))
489
490
  end
490
491
 
491
- def bearer_call(http_method, uri, access_token, json: nil, secrets: [])
492
+ def bearer_call(http_method, uri, access_token, json: nil, secrets: [], structured: false)
492
493
  token = required_text(access_token, "access_token")
493
494
  # Sent in a header: printable ASCII only, so it can never split or extend the request.
494
495
  raise ConfigurationError, "access_token contains invalid characters." if token.b.match?(/[^\x21-\x7e]/n)
495
496
 
496
- Http::Call.new(http_method, uri, bearer: token, json: json, secrets: [token, *secrets])
497
+ Http::Call.new(http_method, uri, bearer: token, json: json, secrets: [token, *secrets],
498
+ structured: structured)
497
499
  end
498
500
 
499
501
  def agent_request(path, access_token, body, secrets)
500
- send_object(bearer_call("POST", issuer_uri(path), access_token, json: body, secrets: secrets))
502
+ send_object(bearer_call("POST", issuer_uri(path), access_token, json: body, secrets: secrets,
503
+ structured: true))
501
504
  end
502
505
 
503
506
  def send_object(call)
@@ -32,6 +32,38 @@ module Didit
32
32
  klass.new(message, status: status, headers: headers, body: body, request_id: Util.request_id(headers))
33
33
  end
34
34
 
35
+ # The response of a call whose answer may echo secrets (the agent consent calls), sanitized once on
36
+ # receipt: status kept; each header whose name contains a secret dropped and the other values redacted;
37
+ # the body redacted structurally, never from its raw text (the parsed JSON with every string that
38
+ # contains a secret replaced whole, "[redacted]" when it is not JSON, cut at the size limit or empty).
39
+ # Every error of these calls is built from this response only.
40
+ #
41
+ # @return [Didit::Internal::Transport::Response]
42
+ def sanitized_response(response, secrets)
43
+ # @type var headers: Hash[String, String]
44
+ headers = {}
45
+ response.headers.each do |name, value|
46
+ # Header names are case-insensitive: compare case-folded.
47
+ next if secrets.any? { |secret| secret && !secret.empty? && name.downcase.include?(secret.downcase) }
48
+
49
+ headers[name] = Util.redact_structured(value, secrets)
50
+ end
51
+ Transport::Response.new(status: response.status, headers: headers,
52
+ body: sanitized_body(response.body.to_s, secrets))
53
+ end
54
+
55
+ # @return [String] the redacted JSON text, or "[redacted]"
56
+ def sanitized_body(raw_body, secrets)
57
+ return Util::REDACTED if raw_body.empty?
58
+
59
+ text = raw_body.dup.force_encoding(Encoding::UTF_8)
60
+ text = text.scrub unless text.valid_encoding?
61
+ JSON.generate(Util.redact_structured(JSON.parse(text), secrets))
62
+ rescue JSON::ParserError, SystemStackError
63
+ # Not JSON, or nested past the parser's or the walk's depth limit: not JSON.
64
+ Util::REDACTED
65
+ end
66
+
35
67
  # The parsed JSON body, else the text, else nil.
36
68
  def parse_body(raw_body)
37
69
  return nil if raw_body.nil? || raw_body.empty?
@@ -39,6 +39,40 @@ module Didit
39
39
  redact_value(value, secrets)
40
40
  end
41
41
 
42
+ # Redacts a parsed JSON value structurally: every string (object key or value) that contains a secret
43
+ # anywhere in it becomes "[redacted]" as a whole. Strings are compared as decoded, so the spelling
44
+ # of the raw JSON text does not matter. A redacted key that collides with another key is numbered.
45
+ def redact_structured(value, secrets)
46
+ secrets = secrets.compact.reject(&:empty?)
47
+ case value
48
+ when String then secrets.any? { |secret| value.include?(secret) } ? REDACTED : value
49
+ when Array then value.map { |item| redact_structured(item, secrets) }
50
+ when Hash then redact_structured_hash(value, secrets)
51
+ else value
52
+ end
53
+ end
54
+
55
+ def redact_structured_hash(value, secrets)
56
+ # Reserve every safe key name first, so a placeholder never takes one.
57
+ taken = value.keys.select { |key| redact_structured(key, secrets) == key }
58
+ number = 1
59
+ # @type var result: Hash[untyped, untyped]
60
+ result = {}
61
+ value.each do |key, item|
62
+ name = key
63
+ if redact_structured(key, secrets) != key
64
+ loop do
65
+ name = number == 1 ? REDACTED : "#{REDACTED}#{number}"
66
+ number += 1
67
+ break unless taken.include?(name)
68
+ end
69
+ taken << name
70
+ end
71
+ result[name] = redact_structured(item, secrets)
72
+ end
73
+ result
74
+ end
75
+
42
76
  def redact_value(value, secrets)
43
77
  case value
44
78
  when String then secrets.reduce(value) { |text, secret| text.gsub(secret, REDACTED) }
@@ -142,7 +142,9 @@ module Didit
142
142
  # Set initiate_login_uri to your HTTPS sign-in page on the exact website_url hostname, or an empty string to
143
143
  # disable admin-sent sign-in links. Changing website_url also revalidates the saved sign-in URI. Invalid
144
144
  # values return 400 with an initiate_login_uri field error; hostname and URI policy failures use
145
- # https_url_on_registered_website_required.
145
+ # https_url_on_registered_website_required. An MCP token (a "Log in with Didit" grant, `token_use` `mcp`) also
146
+ # needs the `didit:management` scope, which carries the `applications` resource; a grant limited to
147
+ # `didit:verification` is refused with 403 before anything is created.
146
148
  #
147
149
  # +POST /organizations/me/{org_id}/applications/+
148
150
  #
@@ -201,7 +203,9 @@ module Didit
201
203
  #
202
204
  # List the organization's applications, 50 per page by default. Use this to discover `app_id` values when
203
205
  # recovering credentials from a new machine, then call `GET /organizations/me/{org_id}/applications/{app_id}/`
204
- # for the API key. Requires an owner or admin Bearer token.
206
+ # for the API key. Requires an owner or admin Bearer token. An MCP token (a "Log in with Didit" grant,
207
+ # `token_use` `mcp`) also needs the `didit:management` scope, which carries the `applications` resource; a
208
+ # grant limited to `didit:verification` is refused with 403 before any application is listed.
205
209
  #
206
210
  # +GET /organizations/me/{org_id}/applications/+
207
211
  #
@@ -229,7 +233,9 @@ module Didit
229
233
  # Get Application Credentials
230
234
  #
231
235
  # Read one application's full record including `client_id` and `api_key`. Use this to recover a lost
232
- # `api_key`.
236
+ # `api_key`. An MCP token (a "Log in with Didit" grant, `token_use` `mcp`) also needs the `didit:management`
237
+ # scope, which carries the `applications` resource; a grant limited to `didit:verification` is refused with
238
+ # 403 before the application is read.
233
239
  #
234
240
  # +GET /organizations/me/{org_id}/applications/{app_id}/+
235
241
  #
@@ -259,7 +265,9 @@ module Didit
259
265
  # Set initiate_login_uri to your HTTPS sign-in page on the exact website_url hostname, or an empty string to
260
266
  # disable admin-sent sign-in links. Changing website_url also revalidates the saved sign-in URI. Invalid
261
267
  # values return 400 with an initiate_login_uri field error; hostname and URI policy failures use
262
- # https_url_on_registered_website_required.
268
+ # https_url_on_registered_website_required. An MCP token (a "Log in with Didit" grant, `token_use` `mcp`) also
269
+ # needs the `didit:management` scope, which carries the `applications` resource; a grant limited to
270
+ # `didit:verification` is refused with 403 before anything is changed.
263
271
  #
264
272
  # +PATCH /organizations/me/{org_id}/applications/{app_id}/+
265
273
  #
@@ -1569,9 +1569,13 @@ module Didit
1569
1569
  # @param contact_id [String]
1570
1570
  # @param purpose [String] * `identity_document` - identity_document * `proof_of_address` - proof_of_address *
1571
1571
  # `business_document` - business_document * `confirm_details` - confirm_details * `review_in_progress` -
1572
- # review_in_progress
1572
+ # review_in_progress * `source_of_funds` - Request a document showing the source of payment funds. *
1573
+ # `purpose_of_payment` - Request a document explaining the payment purpose. Both are available for person and
1574
+ # busin...
1573
1575
  # @param request_id [String]
1574
- # @param expires_at [Time, String]
1576
+ # @param expires_at [Time, String] Use the expiry covered by the preview token. Source-of-funds and
1577
+ # purpose-of-payment requests allow up to 14 days; other purposes allow up to seven days. The default remains
1578
+ # seven days. Changing the expiry without a matching preview is rejected.
1575
1579
  # @param preview_token [String]
1576
1580
  # @param language [String]
1577
1581
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
@@ -1638,7 +1642,9 @@ module Didit
1638
1642
  # @param contact_id [String]
1639
1643
  # @param purpose [String] * `identity_document` - identity_document * `proof_of_address` - proof_of_address *
1640
1644
  # `business_document` - business_document * `confirm_details` - confirm_details * `review_in_progress` -
1641
- # review_in_progress
1645
+ # review_in_progress * `source_of_funds` - Request a document showing the source of payment funds. *
1646
+ # `purpose_of_payment` - Request a document explaining the payment purpose. Both are available for person and
1647
+ # busin...
1642
1648
  # @param language [String]
1643
1649
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
1644
1650
  # @return [Didit::Types::CustomerMessagingCaseRequestPreviewResponse]
@@ -215,7 +215,10 @@ module Didit
215
215
  #
216
216
  # Takes another action with a category and a reason. Also overrides a decision the Investigator took on its own
217
217
  # while it still stands. Restricted keys need the `decisions` scope (write); transaction alerts also need
218
- # `transactions` (write). Escalating a verification or transaction opens a case.
218
+ # `transactions` (write). Escalating a verification or transaction opens a case. Automated transaction decisions
219
+ # can be overridden only while the original decision still stands. The original decision remains unchanged, the
220
+ # override is recorded separately, and an immediate policy question is raised for its recorded situations with
221
+ # the original policy action. The override does not charge for another automated decision.
219
222
  #
220
223
  # +POST /v3/investigator/runs/{run_id}/override/+
221
224
  #
@@ -426,6 +426,8 @@ module Didit
426
426
  # @param evaluation_mode [String]
427
427
  # @param scope [Hash] Which transactions the rule applies to. Only these three keys are accepted.
428
428
  # @param period_days [Integer]
429
+ # @param rule_id [String] Optional ID of the rule being edited. Excludes that rule from overlap comparisons;
430
+ # does not change the candidate configuration.
429
431
  # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
430
432
  # @return [Didit::Types::TransactionRuleBacktestResult]
431
433
  def backtest(
@@ -434,6 +436,7 @@ module Didit
434
436
  evaluation_mode: OMIT,
435
437
  scope: OMIT,
436
438
  period_days: OMIT,
439
+ rule_id: OMIT,
437
440
  request_options: nil
438
441
  )
439
442
  @client.request(
@@ -444,7 +447,8 @@ module Didit
444
447
  "aggregation" => aggregation,
445
448
  "evaluation_mode" => evaluation_mode,
446
449
  "scope" => scope,
447
- "period_days" => period_days
450
+ "period_days" => period_days,
451
+ "rule_id" => rule_id
448
452
  },
449
453
  response: Types::TransactionRuleBacktestResult,
450
454
  request_options: request_options
@@ -846,6 +850,34 @@ module Didit
846
850
  )
847
851
  end
848
852
 
853
+ # List Travel Rule delivery history
854
+ #
855
+ # Read the complete delivery history for a transaction, oldest first. Requires transaction read permission.
856
+ # Unlike the newest 100 entries embedded in detail, this endpoint paginates the full history. See [delivery
857
+ # history](/management-api/travel-rule/list-deliveries).
858
+ #
859
+ # +GET /v3/transactions/{transaction_id}/travel-rule/deliveries/+
860
+ #
861
+ # @param transaction_id [String] Didit-stable transaction UUID that owns the transfer.
862
+ # @param limit [Integer] Entries per page. Defaults to 100 and larger values are capped at 100; a value above
863
+ # 1,000,000 returns `400`.
864
+ # @param offset [Integer] Number of entries to skip, up to 1,000,000. A larger value returns `400`.
865
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
866
+ # @return [Didit::Page<Didit::Types::TravelRuleDeliveryLogEntry>]
867
+ def list_deliveries(transaction_id, limit: OMIT, offset: OMIT, request_options: nil)
868
+ @client.request(
869
+ :get,
870
+ "/v3/transactions/{transaction_id}/travel-rule/deliveries/",
871
+ path_params: { "transaction_id" => transaction_id },
872
+ query: {
873
+ "limit" => limit,
874
+ "offset" => offset
875
+ },
876
+ page: Types::TravelRuleDeliveryLogEntry,
877
+ request_options: request_options
878
+ )
879
+ end
880
+
849
881
  # List Travel Rule messages
850
882
  #
851
883
  # Messages and document requests exchanged with the counterparty VASP about this transfer.
@@ -881,14 +881,19 @@ module Didit
881
881
  # * `business_document` - business_document
882
882
  # * `confirm_details` - confirm_details
883
883
  # * `review_in_progress` - review_in_progress
884
+ # * `source_of_funds` - Request a document showing the source of payment funds.
885
+ # * `purpose_of_payment` - Request a document explaining the payment purpose. Both are available for person and
886
+ # business cases.
884
887
  module CustomerMessagingPurposeEnum
885
888
  IDENTITY_DOCUMENT = "identity_document"
886
889
  PROOF_OF_ADDRESS = "proof_of_address"
887
890
  BUSINESS_DOCUMENT = "business_document"
888
891
  CONFIRM_DETAILS = "confirm_details"
889
892
  REVIEW_IN_PROGRESS = "review_in_progress"
893
+ SOURCE_OF_FUNDS = "source_of_funds"
894
+ PURPOSE_OF_PAYMENT = "purpose_of_payment"
890
895
 
891
- VALUES = [IDENTITY_DOCUMENT, PROOF_OF_ADDRESS, BUSINESS_DOCUMENT, CONFIRM_DETAILS, REVIEW_IN_PROGRESS].freeze
896
+ VALUES = [IDENTITY_DOCUMENT, PROOF_OF_ADDRESS, BUSINESS_DOCUMENT, CONFIRM_DETAILS, REVIEW_IN_PROGRESS, SOURCE_OF_FUNDS, PURPOSE_OF_PAYMENT].freeze
892
897
  end
893
898
 
894
899
  # * `identity_document` - identity_document
@@ -896,14 +901,19 @@ module Didit
896
901
  # * `business_document` - business_document
897
902
  # * `confirm_details` - confirm_details
898
903
  # * `review_in_progress` - review_in_progress
904
+ # * `source_of_funds` - Request a document showing the source of payment funds.
905
+ # * `purpose_of_payment` - Request a document explaining the payment purpose. Both are available for person and
906
+ # business cases.
899
907
  module CustomerMessagingPurposesEnum
900
908
  IDENTITY_DOCUMENT = "identity_document"
901
909
  PROOF_OF_ADDRESS = "proof_of_address"
902
910
  BUSINESS_DOCUMENT = "business_document"
903
911
  CONFIRM_DETAILS = "confirm_details"
904
912
  REVIEW_IN_PROGRESS = "review_in_progress"
913
+ SOURCE_OF_FUNDS = "source_of_funds"
914
+ PURPOSE_OF_PAYMENT = "purpose_of_payment"
905
915
 
906
- VALUES = [IDENTITY_DOCUMENT, PROOF_OF_ADDRESS, BUSINESS_DOCUMENT, CONFIRM_DETAILS, REVIEW_IN_PROGRESS].freeze
916
+ VALUES = [IDENTITY_DOCUMENT, PROOF_OF_ADDRESS, BUSINESS_DOCUMENT, CONFIRM_DETAILS, REVIEW_IN_PROGRESS, SOURCE_OF_FUNDS, PURPOSE_OF_PAYMENT].freeze
907
917
  end
908
918
 
909
919
  # * `ISL` - ISL
@@ -4741,6 +4751,27 @@ module Didit
4741
4751
  VALUES = [DIDIT, CUSTOM].freeze
4742
4752
  end
4743
4753
 
4754
+ # Which side of the exchange this transfer is.
4755
+ module TransactionListTravelRuleDirection
4756
+ INBOUND = "INBOUND"
4757
+ OUTBOUND = "OUTBOUND"
4758
+
4759
+ VALUES = [INBOUND, OUTBOUND].freeze
4760
+ end
4761
+
4762
+ # not_required when the transfer is not required; otherwise confirmed or not_confirmed follows
4763
+ # ownership_confirmed. With no verdict, requested means an active outbound ownership widget matches this transfer
4764
+ # and subject; otherwise not_requested. A request is not completed proof.
4765
+ module TransactionListTravelRuleProofState
4766
+ NOT_REQUIRED = "not_required"
4767
+ CONFIRMED = "confirmed"
4768
+ NOT_CONFIRMED = "not_confirmed"
4769
+ REQUESTED = "requested"
4770
+ NOT_REQUESTED = "not_requested"
4771
+
4772
+ VALUES = [NOT_REQUIRED, CONFIRMED, NOT_CONFIRMED, REQUESTED, NOT_REQUESTED].freeze
4773
+ end
4774
+
4744
4775
  # Status after the change.
4745
4776
  module TransactionNoteMetadataNewStatus
4746
4777
  APPROVED = "APPROVED"
@@ -5261,6 +5292,42 @@ module Didit
5261
5292
  VALUES = [SEND, ANSWER, TXID, CANCEL, POLL].freeze
5262
5293
  end
5263
5294
 
5295
+ # What the message carries. `SEND`: the transfer's first message to the counterparty (outbound; the rail is chosen
5296
+ # when it is sent). `ANSWER`: your accept or decline, owed to the network that asked (inbound). `TXID`: the
5297
+ # on-chain transaction hash, after you finish the transfer. `CANCEL`: the cancellation, after you cancel it.
5298
+ # `POLL`: a status query to a network that offers one, repeated every 5 minutes while the transfer waits on the
5299
+ # counterparty.
5300
+ module TravelRuleDeliveryLogEntryKind
5301
+ SEND = "SEND"
5302
+ ANSWER = "ANSWER"
5303
+ TXID = "TXID"
5304
+ CANCEL = "CANCEL"
5305
+ POLL = "POLL"
5306
+
5307
+ VALUES = [SEND, ANSWER, TXID, CANCEL, POLL].freeze
5308
+ end
5309
+
5310
+ # Supplier-neutral transport type; null until selected.
5311
+ module TravelRuleDeliveryLogEntryRail
5312
+ EMAIL = "EMAIL"
5313
+ TRP = "TRP"
5314
+ INTERNAL = "INTERNAL"
5315
+ NETWORK = "NETWORK"
5316
+
5317
+ VALUES = [EMAIL, TRP, INTERNAL, NETWORK].freeze
5318
+ end
5319
+
5320
+ # Current delivery status.
5321
+ module TravelRuleDeliveryLogEntryStatus
5322
+ QUEUED = "QUEUED"
5323
+ SENDING = "SENDING"
5324
+ RETRYING = "RETRYING"
5325
+ DELIVERED = "DELIVERED"
5326
+ FAILED = "FAILED"
5327
+
5328
+ VALUES = [QUEUED, SENDING, RETRYING, DELIVERED, FAILED].freeze
5329
+ end
5330
+
5264
5331
  # The rail that carries the message. Empty until Didit has chosen one for a first message.
5265
5332
  module TravelRuleDeliveryRail
5266
5333
  INTERNAL = "INTERNAL"
@@ -11804,6 +11871,9 @@ module Didit
11804
11871
  field :id, "id", :string
11805
11872
  field :uuid, "uuid", :string
11806
11873
  field :title, "title", :string
11874
+ field :language, "language", :string
11875
+ field :source_revision, "source_revision", :string
11876
+ field :translation_id, "translation_id", :string
11807
11877
  field :file_name, "file_name", :string
11808
11878
  field :pages, "pages", :integer
11809
11879
  field :size_bytes, "size_bytes", :integer
@@ -12139,6 +12209,50 @@ module Didit
12139
12209
  field :source, "source", :string
12140
12210
  end
12141
12211
 
12212
+ # Travel Rule summary on a transaction list item. Includes latest delivery but omits deliveries and
12213
+ # deliveries_truncated.
12214
+ class TransactionListTravelRule < Didit::Model
12215
+ field :uuid, "uuid", :string
12216
+ field :status, "status", :string
12217
+ field :protocol, "protocol", :string
12218
+ field :required, "required", :boolean
12219
+ field :obligations_count, "obligations_count", :integer
12220
+ field :originator_data, "originator_data", :any
12221
+ field :beneficiary_data, "beneficiary_data", :any
12222
+ field :name_match, "name_match", :any
12223
+ field :data_match, "data_match", "TravelRuleDataMatch"
12224
+ field :mismatched_fields, "mismatched_fields", [:array, :string]
12225
+ field :data_unmasked, "data_unmasked", "TravelRuleDataUnmasked"
12226
+ field :data_masked, "data_masked", :boolean
12227
+ field :metadata, "metadata", :any
12228
+ field :direction, "direction", :string
12229
+ field :rail, "rail", :string
12230
+ field :counterparty_vasp, "counterparty_vasp", "TransactionListTravelRuleCounterpartyVasp"
12231
+ field :delivery, "delivery", "TravelRuleDelivery"
12232
+ field :discovery, "discovery", [:array, "TravelRuleDiscoveryStep"]
12233
+ field :reason, "reason", :string
12234
+ field :next_actions, "next_actions", [:array, "TravelRuleNextAction"]
12235
+ field :chain_details, "chain_details", "TravelRuleChainDetails"
12236
+ field :not_required_reason, "not_required_reason", :string
12237
+ field :proof_state, "proof_state", :string
12238
+ end
12239
+
12240
+ # The counterparty's directory entry, or `null` when the transfer links none.
12241
+ class TransactionListTravelRuleCounterpartyVasp < Didit::Model
12242
+ field :name, "name", :string
12243
+ field :lei, "lei", :string
12244
+ field :dd_score, "dd_score", :integer
12245
+ field :dd_score_breakdown, "dd_score_breakdown", [:map, "TransactionListTravelRuleCounterpartyVaspDdScoreBreakdownValue"]
12246
+ field :dd_assessed_at, "dd_assessed_at", :datetime
12247
+ end
12248
+
12249
+ class TransactionListTravelRuleCounterpartyVaspDdScoreBreakdownValue < Didit::Model
12250
+ field :points, "points", :float
12251
+ field :max, "max", :integer
12252
+ field :reason, "reason", :string
12253
+ field :detail, "detail", :string
12254
+ end
12255
+
12142
12256
  # One note on a monitored transaction's review timeline.
12143
12257
  class TransactionNote < Didit::Model
12144
12258
  field :uuid, "uuid", :string
@@ -12198,6 +12312,9 @@ module Didit
12198
12312
  field :matched, "matched", :integer
12199
12313
  field :affected_entities, "affected_entities", :integer
12200
12314
  field :period_days, "period_days", :integer
12315
+ field :truncated, "truncated", :boolean
12316
+ field :overlapping_rules, "overlapping_rules", [:array, "TransactionRuleOverlap"]
12317
+ field :overlapping_rules_truncated, "overlapping_rules_truncated", :boolean
12201
12318
  end
12202
12319
 
12203
12320
  # A condition reads only the transaction being evaluated - it never filters the aggregation window.
@@ -12264,6 +12381,13 @@ module Didit
12264
12381
  field :is_installed, "is_installed", :boolean
12265
12382
  end
12266
12383
 
12384
+ class TransactionRuleOverlap < Didit::Model
12385
+ field :rule_id, "rule_id", :string
12386
+ field :name, "name", :string
12387
+ field :actions, "actions", [:array, "TransactionRuleAction"]
12388
+ field :overlap_count, "overlap_count", :integer
12389
+ end
12390
+
12267
12391
  # Which transactions the rule applies to. Only these three keys are accepted.
12268
12392
  class TransactionRuleScope < Didit::Model
12269
12393
  field :transaction_types, "transaction_types", [:array, :string]
@@ -12319,11 +12443,8 @@ module Didit
12319
12443
  field :source, "source", :string
12320
12444
  end
12321
12445
 
12322
- # A transaction's Travel Rule transfer, as `GET /v3/transactions/{transaction_id}/`, the `201` of `POST
12323
- # /v3/transactions/` and each row of `GET /v3/transactions/` return it. `direction`, `rail`, `counterparty_vasp`,
12324
- # `delivery`, `discovery`, `reason` and `next_actions` have the same shape as on `PATCH
12325
- # /v3/transactions/{transaction_id}/travel-rule/`, so one read of a transaction says why its transfer is stuck and
12326
- # what moves it on.
12446
+ # Travel Rule transfer on transaction detail and creation responses. Includes latest delivery and bounded delivery
12447
+ # history. Transaction lists omit the history fields.
12327
12448
  class TransactionTravelRule < Didit::Model
12328
12449
  field :uuid, "uuid", :string
12329
12450
  field :status, "status", :string
@@ -12346,6 +12467,8 @@ module Didit
12346
12467
  field :reason, "reason", :string
12347
12468
  field :next_actions, "next_actions", [:array, "TravelRuleNextAction"]
12348
12469
  field :chain_details, "chain_details", "TravelRuleChainDetails"
12470
+ field :deliveries, "deliveries", [:array, "TravelRuleDeliveryLogEntry"]
12471
+ field :deliveries_truncated, "deliveries_truncated", :boolean
12349
12472
  field :not_required_reason, "not_required_reason", :string
12350
12473
  field :proof_state, "proof_state", :string
12351
12474
  end
@@ -12528,6 +12651,24 @@ module Didit
12528
12651
  field :delivered_at, "delivered_at", :datetime
12529
12652
  end
12530
12653
 
12654
+ # One supplier-neutral entry in the delivery history.
12655
+ class TravelRuleDeliveryLogEntry < Didit::Model
12656
+ field :uuid, "uuid", :string
12657
+ field :kind, "kind", :string
12658
+ field :status, "status", :string
12659
+ field :rail, "rail", :string
12660
+ field :created_at, "created_at", :datetime
12661
+ field :delivered_at, "delivered_at", :datetime
12662
+ field :detail_lines, "detail_lines", [:array, :string]
12663
+ end
12664
+
12665
+ class TravelRuleDeliveryLogPage < Didit::Model
12666
+ field :count, "count", :integer
12667
+ field :next, "next", :string
12668
+ field :previous, "previous", :string
12669
+ field :results, "results", [:array, "TravelRuleDeliveryLogEntry"]
12670
+ end
12671
+
12531
12672
  # One step of the counterparty discovery Didit ran for an outbound transfer, in the order it ran them. The first
12532
12673
  # step that names a VASP with a route ends the chain.
12533
12674
  class TravelRuleDiscoveryStep < Didit::Model
@@ -12828,6 +12969,8 @@ module Didit
12828
12969
  field :reason, "reason", :string
12829
12970
  field :next_actions, "next_actions", [:array, "TravelRuleNextAction"]
12830
12971
  field :chain_details, "chain_details", "TravelRuleChainDetails"
12972
+ field :deliveries, "deliveries", [:array, "TravelRuleDeliveryLogEntry"]
12973
+ field :deliveries_truncated, "deliveries_truncated", :boolean
12831
12974
  field :not_required_reason, "not_required_reason", :string
12832
12975
  field :proof_state, "proof_state", :string
12833
12976
  end
@@ -210,7 +210,7 @@ module Didit
210
210
  field :decision_reason_label, "decision_reason_label", :string
211
211
  field :assigned_to_name, "assigned_to_name", :string
212
212
  field :travel_rule_status, "travel_rule_status", :string
213
- field :travel_rule, "travel_rule", "TransactionTravelRule"
213
+ field :travel_rule, "travel_rule", "TransactionListTravelRule"
214
214
  end
215
215
 
216
216
  class TransactionsListResponseResultsTags < Didit::Model
data/lib/didit/types.rb CHANGED
@@ -1491,6 +1491,11 @@ module Didit
1491
1491
  autoload :TransactionDetailStatus, "didit/types/components"
1492
1492
  autoload :TransactionDetailTags, "didit/types/components"
1493
1493
  autoload :TransactionDetailTagsSource, "didit/types/components"
1494
+ autoload :TransactionListTravelRule, "didit/types/components"
1495
+ autoload :TransactionListTravelRuleCounterpartyVasp, "didit/types/components"
1496
+ autoload :TransactionListTravelRuleCounterpartyVaspDdScoreBreakdownValue, "didit/types/components"
1497
+ autoload :TransactionListTravelRuleDirection, "didit/types/components"
1498
+ autoload :TransactionListTravelRuleProofState, "didit/types/components"
1494
1499
  autoload :TransactionNote, "didit/types/components"
1495
1500
  autoload :TransactionNoteMetadata, "didit/types/components"
1496
1501
  autoload :TransactionNoteMetadataNewStatus, "didit/types/components"
@@ -1525,6 +1530,7 @@ module Didit
1525
1530
  autoload :TransactionRuleInstallResult, "didit/types/components"
1526
1531
  autoload :TransactionRuleLibraryEntry, "didit/types/components"
1527
1532
  autoload :TransactionRuleLibraryEntryEvaluationMode, "didit/types/components"
1533
+ autoload :TransactionRuleOverlap, "didit/types/components"
1528
1534
  autoload :TransactionRuleScope, "didit/types/components"
1529
1535
  autoload :TransactionRuleScopeDirections, "didit/types/components"
1530
1536
  autoload :TransactionSummary, "didit/types/components"
@@ -1600,6 +1606,11 @@ module Didit
1600
1606
  autoload :TravelRuleDataUnmaskedReason, "didit/types/components"
1601
1607
  autoload :TravelRuleDelivery, "didit/types/components"
1602
1608
  autoload :TravelRuleDeliveryKind, "didit/types/components"
1609
+ autoload :TravelRuleDeliveryLogEntry, "didit/types/components"
1610
+ autoload :TravelRuleDeliveryLogEntryKind, "didit/types/components"
1611
+ autoload :TravelRuleDeliveryLogEntryRail, "didit/types/components"
1612
+ autoload :TravelRuleDeliveryLogEntryStatus, "didit/types/components"
1613
+ autoload :TravelRuleDeliveryLogPage, "didit/types/components"
1603
1614
  autoload :TravelRuleDeliveryRail, "didit/types/components"
1604
1615
  autoload :TravelRuleDeliveryStatus, "didit/types/components"
1605
1616
  autoload :TravelRuleDiscoveryStep, "didit/types/components"
data/lib/didit/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Didit
4
- VERSION = "2.12.0" # x-release-please-version
4
+ VERSION = "2.13.1" # x-release-please-version
5
5
  end
@@ -6,14 +6,15 @@ module Didit
6
6
  UUID: Regexp
7
7
  LIFETIMES: Array[Integer]
8
8
  DECISIONS: Array[String]
9
- ASSERTION_SECRETS: Array[String]
9
+ MIN_SECRET_LENGTH: Integer
10
10
 
11
11
  def self.build: (String challenge, untyped decision, untyped assertion, untyped scopes, ?Hash[Symbol, untyped] extras) -> [Hash[String, untyped], Array[String]]
12
+ def self.encode_once: (Hash[String, untyped] body) -> Hash[String, untyped]
12
13
  def self.checked_assertion: (untyped assertion) -> Hash[untyped, untyped]
13
14
  def self.checked_organization_ids: (untyped ids) -> Array[String]
14
15
  def self.checked_lifetime: (untyped lifetime) -> Integer
15
16
  def self.checked_scopes: (untyped scopes) -> Array[String]
16
- def self.assertion_secrets: (Hash[untyped, untyped] assertion) -> Array[String]
17
+ def self.assertion_secrets: (untyped value) -> Array[String]
17
18
  end
18
19
  end
19
20
  end
@@ -8,9 +8,10 @@ module Didit
8
8
  attr_reader form: Hash[String, String]?
9
9
  attr_reader json: Hash[String, untyped]?
10
10
  attr_reader secrets: Array[String]
11
+ attr_reader structured: bool
11
12
 
12
13
  def initialize: (String http_method, URI::Generic uri, ?bearer: String?, ?form: Hash[String, String]?,
13
- ?json: Hash[String, untyped]?, ?secrets: Array[String]) -> void
14
+ ?json: Hash[String, untyped]?, ?secrets: Array[String], ?structured: bool) -> void
14
15
  def display_url: () -> String
15
16
  def describe: () -> String
16
17
  end
@@ -31,6 +32,8 @@ module Didit
31
32
 
32
33
  def headers_for: (Call call) -> Hash[String, String]
33
34
  def body_for: (Call call) -> String?
35
+ def error_response: (Call call, Internal::Transport::Response response) -> Internal::Transport::Response
36
+ def redactions: (Call call) -> Array[String]
34
37
  def text_of: (String body) -> String
35
38
  end
36
39
  end
@@ -72,7 +72,7 @@ module Didit
72
72
  def token_request: (Hash[String, String] form, Array[String] secrets) -> TokenResponse
73
73
  def bearer_call: (String http_method, URI::Generic uri, untyped access_token,
74
74
  ?json: Hash[String, untyped]?,
75
- ?secrets: Array[String]) -> Http::Call
75
+ ?secrets: Array[String], ?structured: bool) -> Http::Call
76
76
  def agent_request: (String path, String access_token, Hash[String, untyped] body, Array[String] secrets) -> Hash[String, untyped]
77
77
  def send_object: (Http::Call call) -> Hash[String, untyped]
78
78
  def issuer_uri: (String path) -> URI::Generic
@@ -11,6 +11,8 @@ module Didit
11
11
  def self?.client_header: () -> String
12
12
  def self?.request_id: (Hash[String, String] headers) -> String?
13
13
  def self?.redact: [T] (T value, Array[String?] secrets) -> T
14
+ def self?.redact_structured: (untyped value, Array[String?] secrets) -> untyped
15
+ def self?.redact_structured_hash: (Hash[untyped, untyped] value, Array[String] secrets) -> Hash[untyped, untyped]
14
16
  def self?.redact_value: (untyped value, Array[String] secrets) -> untyped
15
17
  def self?.origin: (URI::Generic | String uri) -> String
16
18
  def self?.display_url: (URI::Generic | String uri) -> String
@@ -23,6 +25,8 @@ module Didit
23
25
  DETAIL_KEYS: Array[String]
24
26
 
25
27
  def self?.status_error: (status: Integer, headers: Hash[String, String], raw_body: String?, ?redact: Array[String?]) -> APIStatusError
28
+ def self?.sanitized_response: (Transport::Response response, Array[String?] secrets) -> Transport::Response
29
+ def self?.sanitized_body: (String raw_body, Array[String?] secrets) -> String
26
30
  def self?.parse_body: (String? raw_body) -> untyped
27
31
  def self?.message_for: (Integer status, untyped body) -> String
28
32
  def self?.detail_of: (untyped body) -> String?
@@ -21,7 +21,7 @@ module Didit
21
21
  def list: (String transaction_id, ?limit: Integer, ?offset: Integer, ?request_options: Didit::request_options?) -> Didit::Page[Didit::Types::TransactionNote]
22
22
  end
23
23
  class Rules < Didit::Resource
24
- def backtest: (?conditions: Array[Didit::Types::transaction_rule_condition], ?aggregation: Array[Didit::Types::transaction_rule_aggregation], ?evaluation_mode: String, ?scope: Didit::Types::transaction_rule_scope, ?period_days: Integer, ?request_options: Didit::request_options?) -> Didit::Types::TransactionRuleBacktestResult
24
+ def backtest: (?conditions: Array[Didit::Types::transaction_rule_condition], ?aggregation: Array[Didit::Types::transaction_rule_aggregation], ?evaluation_mode: String, ?scope: Didit::Types::transaction_rule_scope, ?period_days: Integer, ?rule_id: String, ?request_options: Didit::request_options?) -> Didit::Types::TransactionRuleBacktestResult
25
25
  def create: (title: String, category: String, mode: String, ?description: String?, ?evaluation_mode: String, ?scope: Didit::Types::transaction_rule_scope, ?conditions: Array[Didit::Types::transaction_rule_condition], ?aggregation: Array[Didit::Types::transaction_rule_aggregation], ?actions: Array[(Didit::Types::transaction_rule_action_add_score | Didit::Types::transaction_rule_action_change_status | Didit::Types::transaction_rule_action_add_tags | Didit::Types::transaction_rule_action_add_note | Didit::Types::transaction_rule_action_add_to_list | Didit::Types::transaction_rule_action_open_case)], ?metadata: Hash[String | Symbol, untyped], ?request_options: Didit::request_options?) -> Didit::Types::TransactionRuleDetail
26
26
  def delete: (String rule_uuid, ?request_options: Didit::request_options?) -> nil
27
27
  def install_library: (?library_keys: Array[String], ?bundle: String, ?request_options: Didit::request_options?) -> Didit::Types::TransactionRuleInstallResult
@@ -34,6 +34,7 @@ module Didit
34
34
  class TravelRule < Didit::Resource
35
35
  def confirm_ownership: (String transaction_id, confirmed: bool, ?wallet_address: String, ?request_options: Didit::request_options?) -> Didit::Types::TravelRuleTransferDetail
36
36
  def create_message: (String transaction_id, ?kind: String, ?body: String, ?requested_documents: Array[String], ?reply_to: String?, ?files: Array[Didit::upload], ?request_options: Didit::request_options?) -> Didit::Types::TravelRuleMessage
37
+ def list_deliveries: (String transaction_id, ?limit: Integer, ?offset: Integer, ?request_options: Didit::request_options?) -> Didit::Page[Didit::Types::TravelRuleDeliveryLogEntry]
37
38
  def list_messages: (String transaction_id, ?request_options: Didit::request_options?) -> Array[Didit::Types::TravelRuleMessage]
38
39
  def trigger_test_vasp_inbound: (beneficiary_wallet_address: String, ?scenario: String, ?chain: String, ?amount: String, ?currency: String, ?reference: String, ?request_options: Didit::request_options?) -> Didit::Types::TravelRuleTestVaspInboundResponse
39
40
  def update_transfer: (String transaction_id, ?payment_txn_id: String, ?action: String, ?compliance_email: String, ?wallet_address: String, ?memo: String, ?beneficiary_vasp: String, ?request_options: Didit::request_options?) -> Didit::Types::TravelRuleTransferDetail
@@ -753,6 +753,8 @@ module Didit
753
753
  BUSINESS_DOCUMENT: String
754
754
  CONFIRM_DETAILS: String
755
755
  REVIEW_IN_PROGRESS: String
756
+ SOURCE_OF_FUNDS: String
757
+ PURPOSE_OF_PAYMENT: String
756
758
 
757
759
  VALUES: Array[String]
758
760
  end
@@ -763,6 +765,8 @@ module Didit
763
765
  BUSINESS_DOCUMENT: String
764
766
  CONFIRM_DETAILS: String
765
767
  REVIEW_IN_PROGRESS: String
768
+ SOURCE_OF_FUNDS: String
769
+ PURPOSE_OF_PAYMENT: String
766
770
 
767
771
  VALUES: Array[String]
768
772
  end
@@ -3977,6 +3981,23 @@ module Didit
3977
3981
  VALUES: Array[String]
3978
3982
  end
3979
3983
 
3984
+ module TransactionListTravelRuleDirection
3985
+ INBOUND: String
3986
+ OUTBOUND: String
3987
+
3988
+ VALUES: Array[String]
3989
+ end
3990
+
3991
+ module TransactionListTravelRuleProofState
3992
+ NOT_REQUIRED: String
3993
+ CONFIRMED: String
3994
+ NOT_CONFIRMED: String
3995
+ REQUESTED: String
3996
+ NOT_REQUESTED: String
3997
+
3998
+ VALUES: Array[String]
3999
+ end
4000
+
3980
4001
  module TransactionNoteMetadataNewStatus
3981
4002
  APPROVED: String
3982
4003
  IN_REVIEW: String
@@ -4415,6 +4436,35 @@ module Didit
4415
4436
  VALUES: Array[String]
4416
4437
  end
4417
4438
 
4439
+ module TravelRuleDeliveryLogEntryKind
4440
+ SEND: String
4441
+ ANSWER: String
4442
+ TXID: String
4443
+ CANCEL: String
4444
+ POLL: String
4445
+
4446
+ VALUES: Array[String]
4447
+ end
4448
+
4449
+ module TravelRuleDeliveryLogEntryRail
4450
+ EMAIL: String
4451
+ TRP: String
4452
+ INTERNAL: String
4453
+ NETWORK: String
4454
+
4455
+ VALUES: Array[String]
4456
+ end
4457
+
4458
+ module TravelRuleDeliveryLogEntryStatus
4459
+ QUEUED: String
4460
+ SENDING: String
4461
+ RETRYING: String
4462
+ DELIVERED: String
4463
+ FAILED: String
4464
+
4465
+ VALUES: Array[String]
4466
+ end
4467
+
4418
4468
  module TravelRuleDeliveryRail
4419
4469
  INTERNAL: String
4420
4470
  TRP: String
@@ -10429,6 +10479,9 @@ module Didit
10429
10479
  def id: () -> String?
10430
10480
  def uuid: () -> String?
10431
10481
  def title: () -> String?
10482
+ def language: () -> String?
10483
+ def source_revision: () -> String?
10484
+ def translation_id: () -> String?
10432
10485
  def file_name: () -> String?
10433
10486
  def pages: () -> Integer?
10434
10487
  def size_bytes: () -> Integer?
@@ -10737,6 +10790,47 @@ module Didit
10737
10790
  def source: () -> String?
10738
10791
  end
10739
10792
 
10793
+ class TransactionListTravelRule < Didit::Model
10794
+ def uuid: () -> String?
10795
+ def status: () -> String?
10796
+ def protocol: () -> String?
10797
+ def required: () -> bool?
10798
+ def obligations_count: () -> Integer?
10799
+ def originator_data: () -> Hash[String, untyped]?
10800
+ def beneficiary_data: () -> Hash[String, untyped]?
10801
+ def name_match: () -> Hash[String, untyped]?
10802
+ def data_match: () -> Didit::Types::TravelRuleDataMatch?
10803
+ def mismatched_fields: () -> Array[String]?
10804
+ def data_unmasked: () -> Didit::Types::TravelRuleDataUnmasked?
10805
+ def data_masked: () -> bool?
10806
+ def metadata: () -> Hash[String, untyped]?
10807
+ def direction: () -> String?
10808
+ def rail: () -> String?
10809
+ def counterparty_vasp: () -> Didit::Types::TransactionListTravelRuleCounterpartyVasp?
10810
+ def delivery: () -> Didit::Types::TravelRuleDelivery?
10811
+ def discovery: () -> Array[Didit::Types::TravelRuleDiscoveryStep]?
10812
+ def reason: () -> String?
10813
+ def next_actions: () -> Array[Didit::Types::TravelRuleNextAction]?
10814
+ def chain_details: () -> Didit::Types::TravelRuleChainDetails?
10815
+ def not_required_reason: () -> String?
10816
+ def proof_state: () -> String?
10817
+ end
10818
+
10819
+ class TransactionListTravelRuleCounterpartyVasp < Didit::Model
10820
+ def name: () -> String?
10821
+ def lei: () -> String?
10822
+ def dd_score: () -> Integer?
10823
+ def dd_score_breakdown: () -> Hash[String, Didit::Types::TransactionListTravelRuleCounterpartyVaspDdScoreBreakdownValue]?
10824
+ def dd_assessed_at: () -> Time?
10825
+ end
10826
+
10827
+ class TransactionListTravelRuleCounterpartyVaspDdScoreBreakdownValue < Didit::Model
10828
+ def points: () -> Float?
10829
+ def max: () -> Integer?
10830
+ def reason: () -> String?
10831
+ def detail: () -> String?
10832
+ end
10833
+
10740
10834
  class TransactionNote < Didit::Model
10741
10835
  def uuid: () -> String
10742
10836
  def note: () -> String
@@ -10781,10 +10875,13 @@ module Didit
10781
10875
  end
10782
10876
 
10783
10877
  class TransactionRuleBacktestResult < Didit::Model
10784
- def evaluated: () -> Integer?
10785
- def matched: () -> Integer?
10786
- def affected_entities: () -> Integer?
10787
- def period_days: () -> Integer?
10878
+ def evaluated: () -> Integer
10879
+ def matched: () -> Integer
10880
+ def affected_entities: () -> Integer
10881
+ def period_days: () -> Integer
10882
+ def truncated: () -> bool
10883
+ def overlapping_rules: () -> Array[Didit::Types::TransactionRuleOverlap]
10884
+ def overlapping_rules_truncated: () -> bool
10788
10885
  end
10789
10886
 
10790
10887
  class TransactionRuleCondition < Didit::Model
@@ -10850,6 +10947,13 @@ module Didit
10850
10947
  def is_installed: () -> bool?
10851
10948
  end
10852
10949
 
10950
+ class TransactionRuleOverlap < Didit::Model
10951
+ def rule_id: () -> String
10952
+ def name: () -> String
10953
+ def actions: () -> Array[Didit::Types::TransactionRuleAction]
10954
+ def overlap_count: () -> Integer
10955
+ end
10956
+
10853
10957
  class TransactionRuleScope < Didit::Model
10854
10958
  def transaction_types: () -> Array[String]?
10855
10959
  def directions: () -> Array[String]?
@@ -10924,6 +11028,8 @@ module Didit
10924
11028
  def reason: () -> String?
10925
11029
  def next_actions: () -> Array[Didit::Types::TravelRuleNextAction]?
10926
11030
  def chain_details: () -> Didit::Types::TravelRuleChainDetails?
11031
+ def deliveries: () -> Array[Didit::Types::TravelRuleDeliveryLogEntry]?
11032
+ def deliveries_truncated: () -> bool?
10927
11033
  def not_required_reason: () -> String?
10928
11034
  def proof_state: () -> String?
10929
11035
  end
@@ -11072,6 +11178,23 @@ module Didit
11072
11178
  def delivered_at: () -> Time?
11073
11179
  end
11074
11180
 
11181
+ class TravelRuleDeliveryLogEntry < Didit::Model
11182
+ def uuid: () -> String
11183
+ def kind: () -> String
11184
+ def status: () -> String
11185
+ def rail: () -> String?
11186
+ def created_at: () -> Time
11187
+ def delivered_at: () -> Time?
11188
+ def detail_lines: () -> Array[String]
11189
+ end
11190
+
11191
+ class TravelRuleDeliveryLogPage < Didit::Model
11192
+ def count: () -> Integer
11193
+ def `next`: () -> String?
11194
+ def previous: () -> String?
11195
+ def results: () -> Array[Didit::Types::TravelRuleDeliveryLogEntry]
11196
+ end
11197
+
11075
11198
  class TravelRuleDiscoveryStep < Didit::Model
11076
11199
  def step: () -> String?
11077
11200
  def outcome: () -> String?
@@ -11337,6 +11460,8 @@ module Didit
11337
11460
  def reason: () -> String?
11338
11461
  def next_actions: () -> Array[Didit::Types::TravelRuleNextAction]?
11339
11462
  def chain_details: () -> Didit::Types::TravelRuleChainDetails?
11463
+ def deliveries: () -> Array[Didit::Types::TravelRuleDeliveryLogEntry]?
11464
+ def deliveries_truncated: () -> bool?
11340
11465
  def not_required_reason: () -> String?
11341
11466
  def proof_state: () -> String?
11342
11467
  end
@@ -182,7 +182,7 @@ module Didit
182
182
  def decision_reason_label: () -> String?
183
183
  def assigned_to_name: () -> String?
184
184
  def travel_rule_status: () -> String?
185
- def travel_rule: () -> Didit::Types::TransactionTravelRule?
185
+ def travel_rule: () -> Didit::Types::TransactionListTravelRule?
186
186
  end
187
187
 
188
188
  class TransactionsListResponseResultsTags < Didit::Model
@@ -252,7 +252,7 @@ module Didit
252
252
 
253
253
  type transactions_notes_create_params = { note: String, ?mentioned_emails: Array[String] }
254
254
 
255
- type transactions_rules_backtest_params = { ?conditions: Array[Didit::Types::transaction_rule_condition], ?aggregation: Array[Didit::Types::transaction_rule_aggregation], ?evaluation_mode: String, ?scope: Didit::Types::transaction_rule_scope, ?period_days: Integer }
255
+ type transactions_rules_backtest_params = { ?conditions: Array[Didit::Types::transaction_rule_condition], ?aggregation: Array[Didit::Types::transaction_rule_aggregation], ?evaluation_mode: String, ?scope: Didit::Types::transaction_rule_scope, ?period_days: Integer, ?rule_id: String }
256
256
 
257
257
  type transactions_rules_create_params = { title: String, ?description: String?, category: String, mode: String, ?evaluation_mode: String, ?scope: Didit::Types::transaction_rule_scope, ?conditions: Array[Didit::Types::transaction_rule_condition], ?aggregation: Array[Didit::Types::transaction_rule_aggregation], ?actions: Array[(Didit::Types::transaction_rule_action_add_score | Didit::Types::transaction_rule_action_change_status | Didit::Types::transaction_rule_action_add_tags | Didit::Types::transaction_rule_action_add_note | Didit::Types::transaction_rule_action_add_to_list | Didit::Types::transaction_rule_action_open_case)], ?metadata: Hash[String | Symbol, untyped] }
258
258
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: didit-sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.12.0
4
+ version: 2.13.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Didit