didit-sdk 2.26.0 → 2.28.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.
@@ -290,6 +290,26 @@ module Didit
290
290
  )
291
291
  end
292
292
 
293
+ # Investigator agent offer
294
+ #
295
+ # Whether to offer the Investigator agent to this application: its decisions taken by hand in the last 30 days,
296
+ # the average handling time, the people who stopped halfway and whether follow-ups are on. Read from the daily
297
+ # analytics, never from a scan of sessions. `show` is true when 20 or more decisions were taken by hand and the
298
+ # agent is not set up, or when follow-ups are off and 50 or more people stopped halfway.
299
+ #
300
+ # +GET /v3/investigator/offer/+
301
+ #
302
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
303
+ # @return [Didit::Types::InvestigatorRetrieveOfferResponse]
304
+ def retrieve_offer(request_options: nil)
305
+ @client.request(
306
+ :get,
307
+ "/v3/investigator/offer/",
308
+ response: Types::InvestigatorRetrieveOfferResponse,
309
+ request_options: request_options
310
+ )
311
+ end
312
+
293
313
  # Investigator performance
294
314
  #
295
315
  # Agreement with your team, volume, time saved, confidence calibration, per-queue results, override reasons and
@@ -36,6 +36,41 @@ module Didit
36
36
  request_options: request_options
37
37
  )
38
38
  end
39
+
40
+ # Get the price book (public, unauthenticated)
41
+ #
42
+ # Returns Didit's public list prices: every plan with its monthly and yearly price and its discount, the white
43
+ # label price, Didit's fee on each Messages channel, and every flat usage price. Use it to quote Didit's prices
44
+ # in your own product or to check a price before you build a workflow.
45
+ #
46
+ # Public: send no auth header. The response contains no organization data and is the same for every caller. It
47
+ # carries an `ETag`, so send `If-None-Match` to get a `304 Not Modified` when nothing changed.
48
+ #
49
+ # **Messages fees.** An SMS costs the carrier's price per segment plus Didit's fee per segment
50
+ # (`message_fee_usd_by_channel.sms`, also `messages_fee_usd`). A WhatsApp message sent from Didit's number costs
51
+ # WhatsApp's rate plus Didit's own WhatsApp fee (`message_fee_usd_by_channel.whatsapp`); sent from your own
52
+ # WhatsApp Business account, WhatsApp bills you directly and Didit charges only its fee. The carrier's and
53
+ # WhatsApp's parts are passed on at cost.
54
+ #
55
+ # These are list prices before your plan discount, which applies to Didit's fee only on carrier-priced items and
56
+ # to the whole price everywhere else. A negotiated or contract price replaces the list price for your
57
+ # organization. Per-item prices are on their own feeds, such as [phone verification
58
+ # prices](/getting-started/phone-verification-pricing) and [bank verification
59
+ # prices](/getting-started/bank-verification-pricing).
60
+ #
61
+ # +GET /v3/organization/price-book/+
62
+ #
63
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
64
+ # @return [Didit::Types::PublicPriceBook]
65
+ def price_book(request_options: nil)
66
+ @client.request(
67
+ :get,
68
+ "/v3/organization/price-book/",
69
+ auth: :none,
70
+ response: Types::PublicPriceBook,
71
+ request_options: request_options
72
+ )
73
+ end
39
74
  end
40
75
  end
41
76
  end
@@ -1172,12 +1172,13 @@ module Didit
1172
1172
  #
1173
1173
  # List every completed ongoing-monitoring re-screen of a session's AML check, newest first by `completed_at`,
1174
1174
  # including the runs where nothing changed: alerts, activity entries and webhooks fire only when a result moves,
1175
- # so this history is the evidence that a clean subject was still being screened. Works for KYC and KYB session
1176
- # IDs; pass `node_id` when the session ran more than one AML step. Only ongoing-monitoring re-screens are listed
1177
- # (the first screening is part of the session decision) and runs from before this history existed are not
1178
- # reconstructed, so a session without ongoing monitoring returns an empty list. `count` is exact up to 100 and
1179
- # capped at 100 above that, so follow `next` until it is `null`. Pass `month` to read one calendar month at a
1180
- # time. A scoped API key needs `decisions: read`; see [Continuous AML
1175
+ # so this history is the record of the re-screens a clean subject had. The daily monitoring date is
1176
+ # `last_ongoing_screening_at` on the AML report. Works for KYC and KYB session IDs; pass `node_id` when the
1177
+ # session ran more than one AML step. Only ongoing-monitoring re-screens are listed (the first screening is part
1178
+ # of the session decision) and runs from before this history existed are not reconstructed, so a session without
1179
+ # ongoing monitoring returns an empty list. `count` is exact up to 100 and capped at 100 above that, so follow
1180
+ # `next` until it is `null`. Pass `month` to read one calendar month at a time. A scoped API key needs
1181
+ # `decisions: read`; see [Continuous AML
1181
1182
  # monitoring](https://docs.didit.me/core-technology/aml-screening/continuous-monitoring-aml-screening).
1182
1183
  #
1183
1184
  # +GET /v3/session/{sessionId}/aml-screening-history/+
@@ -1770,7 +1771,7 @@ module Didit
1770
1771
  #
1771
1772
  # `review_status` is one of `Unreviewed`, `Confirmed Match`, `False Positive`, or `Inconclusive`. Reviewer
1772
1773
  # decisions are preserved across ongoing-monitoring updates, so a hit you mark `False Positive` stays that way
1773
- # when the provider re-screens.
1774
+ # when the provider sends an update.
1774
1775
  #
1775
1776
  # A successful call fires a `data.updated` webhook and appends an activity entry (with actor attribution) to the
1776
1777
  # session's review trail. For graph workflows with multiple AML checks, pass `node_id` to target a specific
@@ -10,6 +10,7 @@ module Didit
10
10
  autoload :Aml, "didit/resources/aml"
11
11
  autoload :AmlMonitoring, "didit/resources/aml_monitoring"
12
12
  autoload :Analytics, "didit/resources/analytics"
13
+ autoload :AuthenticationSetup, "didit/resources/authentication_setup"
13
14
  autoload :Bank, "didit/resources/bank"
14
15
  autoload :Billing, "didit/resources/billing"
15
16
  autoload :BiometricTemplates, "didit/resources/biometric_templates"
@@ -81,6 +82,11 @@ module Didit
81
82
  @analytics ||= Resources::Analytics.new(self)
82
83
  end
83
84
 
85
+ # @return [Didit::Resources::AuthenticationSetup]
86
+ def authentication_setup
87
+ @authentication_setup ||= Resources::AuthenticationSetup.new(self)
88
+ end
89
+
84
90
  # @return [Didit::Resources::Bank]
85
91
  def bank
86
92
  @bank ||= Resources::Bank.new(self)