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.
@@ -125,8 +125,10 @@ module Didit
125
125
  VALUES = [ACCUSATION, ARREST, BRIBERY, CRIMINAL, FRAUD, ILLEGAL_FUNDRAISING, NON_CONVICTION_TERROR, PROCLAIMED_OFFENDER, REGULATORY_ENFORCEMENT, TERRORISM, TERRORISM_RELATED, TERRORISM_RELATED_LISTING].freeze
126
126
  end
127
127
 
128
- # `NO_CHANGE`: completed and the result did not move. `CHANGED`: completed and the score, status, hit count or
129
- # hits changed. `FAILED`: no usable answer for this subject, so the check was left as it was.
128
+ # `NO_CHANGE`: completed and the result did not move. `CHANGED`: completed and the score, the status or a match at
129
+ # or above your Match Score Threshold changed (added, removed or updated). Matches below that threshold start as
130
+ # False Positive and can come and go between runs without making a run `CHANGED`. `FAILED`: no usable answer for
131
+ # this subject, so the check was left as it was.
130
132
  module AMLScreeningRunOutcome
131
133
  NO_CHANGE = "NO_CHANGE"
132
134
  CHANGED = "CHANGED"
@@ -2181,10 +2183,11 @@ module Didit
2181
2183
 
2182
2184
  # Known values of an open enum: the API may send others.
2183
2185
  module InvestigatorQueueRowStage
2186
+ NONE = "none"
2184
2187
  SHADOW = "shadow"
2185
2188
  LIVE = "live"
2186
2189
 
2187
- VALUES = [SHADOW, LIVE].freeze
2190
+ VALUES = [NONE, SHADOW, LIVE].freeze
2188
2191
  end
2189
2192
 
2190
2193
  # Known values of an open enum: the API may send others.
@@ -2817,6 +2820,23 @@ module Didit
2817
2820
  VALUES = [SUCCESS, RETRY, BLOCKED].freeze
2818
2821
  end
2819
2822
 
2823
+ # Known values of an open enum: the API may send others.
2824
+ module PublicPriceBookCurrency
2825
+ USD = "USD"
2826
+
2827
+ VALUES = [USD].freeze
2828
+ end
2829
+
2830
+ # The plan.
2831
+ module PublicPriceBookPlanKey
2832
+ FREE = "free"
2833
+ GROWTH = "growth"
2834
+ SCALE = "scale"
2835
+ ENTERPRISE = "enterprise"
2836
+
2837
+ VALUES = [FREE, GROWTH, SCALE, ENTERPRISE].freeze
2838
+ end
2839
+
2820
2840
  # Known values of an open enum: the API may send others.
2821
2841
  module QuestionnaireDetailStatus
2822
2842
  DRAFT = "draft"
@@ -9390,6 +9410,8 @@ module Didit
9390
9410
  field :waiting_since, "waiting_since", :datetime
9391
9411
  field :due_at, "due_at", :datetime
9392
9412
  field :prepared_at, "prepared_at", :datetime
9413
+ field :free_report, "free_report", :boolean
9414
+ field :example, "example", :boolean
9393
9415
  end
9394
9416
 
9395
9417
  class InvestigatorRunDetail < InvestigatorQueueRow
@@ -10430,6 +10452,38 @@ module Didit
10430
10452
  field :metadata, "metadata", :any
10431
10453
  end
10432
10454
 
10455
+ class PublicPriceBook < Didit::Model
10456
+ field :currency, "currency", :string
10457
+ field :plans, "plans", [:array, "PublicPriceBookPlan"]
10458
+ field :white_label_usd, "white_label_usd", :string
10459
+ field :messages_fee_usd, "messages_fee_usd", :string
10460
+ field :message_fee_usd_by_channel, "message_fee_usd_by_channel", "PublicPriceBookMessageFees"
10461
+ field :lines, "lines", [:array, "PublicPriceBookLine"]
10462
+ end
10463
+
10464
+ class PublicPriceBookLine < Didit::Model
10465
+ field :key, "key", :string
10466
+ field :product, "product", :string
10467
+ field :feature, "feature", :string
10468
+ field :unit, "unit", :string
10469
+ field :list_price_usd, "list_price_usd", :string
10470
+ end
10471
+
10472
+ # Didit's fee on each carrier-priced Messages channel, excluding the carrier's or WhatsApp's price, which is
10473
+ # passed on at cost. Null where the fee is not published.
10474
+ class PublicPriceBookMessageFees < Didit::Model
10475
+ field :sms, "sms", :string
10476
+ field :whatsapp, "whatsapp", :string
10477
+ end
10478
+
10479
+ class PublicPriceBookPlan < Didit::Model
10480
+ field :key, "key", :string
10481
+ field :price_usd_month, "price_usd_month", :string
10482
+ field :price_usd_year, "price_usd_year", :string
10483
+ field :discount_percent, "discount_percent", :integer
10484
+ field :transactions_included_per_month, "transactions_included_per_month", :integer
10485
+ end
10486
+
10433
10487
  # Full questionnaire detail returned from GET, POST (create) and PATCH (update) endpoints.
10434
10488
  class QuestionnaireDetail < Didit::Model
10435
10489
  field :questionnaire_id, "questionnaire_id", :string
@@ -121,6 +121,15 @@ module Didit
121
121
  VALUES = [ALL, IDENTITY, TRANSACTIONS].freeze
122
122
  end
123
123
 
124
+ # Known values of an open enum: the API may send others.
125
+ module InvestigatorRetrieveOfferResponseStage
126
+ NONE = "none"
127
+ SHADOW = "shadow"
128
+ LIVE = "live"
129
+
130
+ VALUES = [NONE, SHADOW, LIVE].freeze
131
+ end
132
+
124
133
  # Known values of an open enum: the API may send others.
125
134
  module InvestigatorRetrievePerformanceParamsPeriod
126
135
  V_7 = "7"
@@ -195,6 +204,15 @@ module Didit
195
204
  field :hours_saved, "hours_saved", :float
196
205
  end
197
206
 
207
+ class InvestigatorRetrieveOfferResponse < Didit::Model
208
+ field :show, "show", :boolean
209
+ field :manual_decisions_30d, "manual_decisions_30d", :integer
210
+ field :avg_handling_seconds, "avg_handling_seconds", :integer
211
+ field :stopped_halfway_30d, "stopped_halfway_30d", :integer
212
+ field :stage, "stage", :string
213
+ field :followups_on, "followups_on", :boolean
214
+ end
215
+
198
216
  class InvestigatorRetrievePerformanceResponse < Didit::Model
199
217
  field :period, "period", :integer
200
218
  field :start, "start", :date
@@ -211,6 +229,14 @@ module Didit
211
229
  field :decided_today, "decided_today", :integer
212
230
  field :automation_rate_month, "automation_rate_month", :float
213
231
  field :preparing, "preparing", :integer
232
+ field :free_reports, "free_reports", "InvestigatorRetrieveSummaryResponseFreeReports"
233
+ end
234
+
235
+ # The organization's free reports: the first reports run with no setup, on any plan, and are never charged.
236
+ class InvestigatorRetrieveSummaryResponseFreeReports < Didit::Model
237
+ field :limit, "limit", :integer
238
+ field :used, "used", :integer
239
+ field :remaining, "remaining", :integer
214
240
  end
215
241
 
216
242
  class InvestigatorRetrieveTransactionResponse < Didit::Model
data/lib/didit/types.rb CHANGED
@@ -148,6 +148,18 @@ module Didit
148
148
  autoload :AsyncReportListCounts, "didit/types/components"
149
149
  autoload :AsyncReportReportType, "didit/types/components"
150
150
  autoload :AsyncReportStatus, "didit/types/components"
151
+ autoload :AuthenticationSetupSetMethodParamsCredentialSource, "didit/types/authentication_setup"
152
+ autoload :AuthenticationSetupUpdateConfigurationParamsSignupPolicy, "didit/types/authentication_setup"
153
+ autoload :AuthenticationSetupUpdateOnboardingParamsSignInUi, "didit/types/authentication_setup"
154
+ autoload :AuthenticationSetupUpdateProtectionParamsPoliciesValue, "didit/types/authentication_setup"
155
+ autoload :AuthenticationSetupUpdateSettingsParamsAgentApproval, "didit/types/authentication_setup"
156
+ autoload :AuthenticationSetupUpdateSettingsParamsAgentScopes, "didit/types/authentication_setup"
157
+ autoload :AuthenticationSetupUpdateSettingsParamsDefaultMemberRole, "didit/types/authentication_setup"
158
+ autoload :AuthenticationSetupUpdateSettingsParamsMfaPolicy, "didit/types/authentication_setup"
159
+ autoload :AuthenticationSetupUpdateSettingsParamsSignInUi, "didit/types/authentication_setup"
160
+ autoload :AuthenticationSetupUpdateVerifiedParamsRulesMethod, "didit/types/authentication_setup"
161
+ autoload :AuthenticationSetupUpdateVerifiedParamsRulesRule, "didit/types/authentication_setup"
162
+ autoload :AuthenticationSetupUpdateVerifiedParamsSignupLevel, "didit/types/authentication_setup"
151
163
  autoload :BankAccountCheckPricing, "didit/types/components"
152
164
  autoload :BankAccountCheckResponse, "didit/types/components"
153
165
  autoload :BankAccountCheckResponseResult, "didit/types/components"
@@ -641,11 +653,14 @@ module Didit
641
653
  autoload :InvestigatorQueueRowStage, "didit/types/components"
642
654
  autoload :InvestigatorRetrieveDashboardParamsScope, "didit/types/investigator"
643
655
  autoload :InvestigatorRetrieveDashboardResponse, "didit/types/investigator"
656
+ autoload :InvestigatorRetrieveOfferResponse, "didit/types/investigator"
657
+ autoload :InvestigatorRetrieveOfferResponseStage, "didit/types/investigator"
644
658
  autoload :InvestigatorRetrievePerformanceParamsPeriod, "didit/types/investigator"
645
659
  autoload :InvestigatorRetrievePerformanceParamsScope, "didit/types/investigator"
646
660
  autoload :InvestigatorRetrievePerformanceResponse, "didit/types/investigator"
647
661
  autoload :InvestigatorRetrieveSummaryParamsScope, "didit/types/investigator"
648
662
  autoload :InvestigatorRetrieveSummaryResponse, "didit/types/investigator"
663
+ autoload :InvestigatorRetrieveSummaryResponseFreeReports, "didit/types/investigator"
649
664
  autoload :InvestigatorRetrieveTransactionResponse, "didit/types/investigator"
650
665
  autoload :InvestigatorRunDetail, "didit/types/components"
651
666
  autoload :InvestigatorSettings, "didit/types/components"
@@ -979,6 +994,12 @@ module Didit
979
994
  autoload :ProofOfAddressVerifyResponsePoaWarnings, "didit/types/proof_of_address"
980
995
  autoload :ProofOfAddressVerifyResponsePoaWarningsFeature, "didit/types/proof_of_address"
981
996
  autoload :ProofOfAddressVerifyResponsePoaWarningsLogType, "didit/types/proof_of_address"
997
+ autoload :PublicPriceBook, "didit/types/components"
998
+ autoload :PublicPriceBookCurrency, "didit/types/components"
999
+ autoload :PublicPriceBookLine, "didit/types/components"
1000
+ autoload :PublicPriceBookMessageFees, "didit/types/components"
1001
+ autoload :PublicPriceBookPlan, "didit/types/components"
1002
+ autoload :PublicPriceBookPlanKey, "didit/types/components"
982
1003
  autoload :QuestionnaireDetail, "didit/types/components"
983
1004
  autoload :QuestionnaireDetailStatus, "didit/types/components"
984
1005
  autoload :QuestionnaireListItem, "didit/types/components"
@@ -1450,6 +1471,69 @@ module Didit
1450
1471
  autoload :SessionsUpdateStatusResponse, "didit/types/sessions"
1451
1472
  autoload :SessionsUploadKybDocumentsParamsDocumentGroup, "didit/types/sessions"
1452
1473
  autoload :SessionsUploadKybDocumentsResponse, "didit/types/sessions"
1474
+ autoload :SetupAndroidApp, "didit/types/account_components"
1475
+ autoload :SetupBrand, "didit/types/account_components"
1476
+ autoload :SetupBrandTheme, "didit/types/account_components"
1477
+ autoload :SetupBranding, "didit/types/account_components"
1478
+ autoload :SetupBrandingBadge, "didit/types/account_components"
1479
+ autoload :SetupBrandingDefaults, "didit/types/account_components"
1480
+ autoload :SetupBrandingTexts, "didit/types/account_components"
1481
+ autoload :SetupConfiguration, "didit/types/account_components"
1482
+ autoload :SetupConfigurationSignupPolicy, "didit/types/account_components"
1483
+ autoload :SetupCustomDomain, "didit/types/account_components"
1484
+ autoload :SetupCustomDomainCertificate, "didit/types/account_components"
1485
+ autoload :SetupCustomDomainDnsRecord, "didit/types/account_components"
1486
+ autoload :SetupCustomDomainDnsRecordType, "didit/types/account_components"
1487
+ autoload :SetupCustomDomainStatus, "didit/types/account_components"
1488
+ autoload :SetupDiditTestCredentials, "didit/types/account_components"
1489
+ autoload :SetupDomain, "didit/types/account_components"
1490
+ autoload :SetupEmail, "didit/types/account_components"
1491
+ autoload :SetupEmailSummary, "didit/types/account_components"
1492
+ autoload :SetupEmailSummaryKey, "didit/types/account_components"
1493
+ autoload :SetupEmails, "didit/types/account_components"
1494
+ autoload :SetupEmailsSenders, "didit/types/account_components"
1495
+ autoload :SetupEmailsSendersEmail, "didit/types/account_components"
1496
+ autoload :SetupEmailsSendersSms, "didit/types/account_components"
1497
+ autoload :SetupMethodResult, "didit/types/account_components"
1498
+ autoload :SetupMethodResultCredentialSource, "didit/types/account_components"
1499
+ autoload :SetupMethodSummary, "didit/types/account_components"
1500
+ autoload :SetupMethodSummaryCredentialSource, "didit/types/account_components"
1501
+ autoload :SetupMethodSummaryName, "didit/types/account_components"
1502
+ autoload :SetupNativeApps, "didit/types/account_components"
1503
+ autoload :SetupOnboarding, "didit/types/account_components"
1504
+ autoload :SetupOnboardingCompleted, "didit/types/account_components"
1505
+ autoload :SetupOnboardingSignInUi, "didit/types/account_components"
1506
+ autoload :SetupOnboardingTestStatus, "didit/types/account_components"
1507
+ autoload :SetupProtection, "didit/types/account_components"
1508
+ autoload :SetupProtectionAttackMode, "didit/types/account_components"
1509
+ autoload :SetupProtectionCalendarMonth, "didit/types/account_components"
1510
+ autoload :SetupProtectionCalendarMonthChallenges, "didit/types/account_components"
1511
+ autoload :SetupProtectionCalendarMonthProtections, "didit/types/account_components"
1512
+ autoload :SetupProtectionCalendarMonthProtectionsCounts, "didit/types/account_components"
1513
+ autoload :SetupProtectionCalendarMonthProtectionsCountsDelta, "didit/types/account_components"
1514
+ autoload :SetupProtectionCalendarMonthProtectionsPreviousCounts, "didit/types/account_components"
1515
+ autoload :SetupProtectionChallengesDaily, "didit/types/account_components"
1516
+ autoload :SetupProtectionDaily, "didit/types/account_components"
1517
+ autoload :SetupProtectionPolicy, "didit/types/account_components"
1518
+ autoload :SetupProtectionPolicyCounts, "didit/types/account_components"
1519
+ autoload :SetupProtectionPolicyKey, "didit/types/account_components"
1520
+ autoload :SetupProtectionPolicyMode, "didit/types/account_components"
1521
+ autoload :SetupSettings, "didit/types/account_components"
1522
+ autoload :SetupSettingsAgentApproval, "didit/types/account_components"
1523
+ autoload :SetupSettingsAgentScopes, "didit/types/account_components"
1524
+ autoload :SetupSettingsDefaultMemberRole, "didit/types/account_components"
1525
+ autoload :SetupSettingsMfaPolicy, "didit/types/account_components"
1526
+ autoload :SetupSettingsSignInUi, "didit/types/account_components"
1527
+ autoload :SetupSettingsWebhookEventsDisabled, "didit/types/account_components"
1528
+ autoload :SetupVerified, "didit/types/account_components"
1529
+ autoload :SetupVerifiedClaims, "didit/types/account_components"
1530
+ autoload :SetupVerifiedRule, "didit/types/account_components"
1531
+ autoload :SetupVerifiedRuleMethod, "didit/types/account_components"
1532
+ autoload :SetupVerifiedRuleRule, "didit/types/account_components"
1533
+ autoload :SetupVerifiedSignup, "didit/types/account_components"
1534
+ autoload :SetupVerifiedSignupLevel, "didit/types/account_components"
1535
+ autoload :SetupVerifiedWallet, "didit/types/account_components"
1536
+ autoload :SetupVerifiedWorkflows, "didit/types/account_components"
1453
1537
  autoload :SignatureFieldAnchorOccurrence, "didit/types/components"
1454
1538
  autoload :SignatureFieldDateFormat, "didit/types/components"
1455
1539
  autoload :SignatureFieldResult, "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.26.0" # x-release-please-version
4
+ VERSION = "2.28.0" # x-release-please-version
5
5
  end
@@ -0,0 +1,30 @@
1
+ # Code generated by codegen from openapi/*.json. DO NOT EDIT.
2
+
3
+ module Didit
4
+ module Resources
5
+ class AuthenticationSetup < Didit::Resource
6
+ def activate_domain: (String organization_id, String application_id, ?request_options: Didit::request_options?) -> Didit::Types::SetupDomain
7
+ def get_branding: (String organization_id, String application_id, ?language: String, ?request_options: Didit::request_options?) -> Didit::Types::SetupBranding
8
+ def get_configuration: (String organization_id, String application_id, ?request_options: Didit::request_options?) -> Didit::Types::SetupConfiguration
9
+ def get_domain: (String organization_id, String application_id, ?request_options: Didit::request_options?) -> Didit::Types::SetupDomain
10
+ def get_email: (String organization_id, String application_id, String key, ?request_options: Didit::request_options?) -> Didit::Types::SetupEmail
11
+ def get_emails: (String organization_id, String application_id, ?language: String, ?request_options: Didit::request_options?) -> Didit::Types::SetupEmails
12
+ def get_native_apps: (String organization_id, String application_id, ?request_options: Didit::request_options?) -> Didit::Types::SetupNativeApps
13
+ def get_onboarding: (String organization_id, String application_id, ?request_options: Didit::request_options?) -> Didit::Types::SetupOnboarding
14
+ def get_protection: (String organization_id, String application_id, ?request_options: Didit::request_options?) -> Didit::Types::SetupProtection
15
+ def get_settings: (String organization_id, String application_id, ?request_options: Didit::request_options?) -> Didit::Types::SetupSettings
16
+ def get_verified: (String organization_id, String application_id, ?request_options: Didit::request_options?) -> Didit::Types::SetupVerified
17
+ def remove_domain: (String organization_id, String application_id, ?request_options: Didit::request_options?) -> Didit::Types::SetupDomain
18
+ def set_domain: (String organization_id, String application_id, domain: String, ?request_options: Didit::request_options?) -> Didit::Types::SetupDomain
19
+ def set_method: (String organization_id, String application_id, String name, enabled: bool, ?credentials: Didit::Types::setup_provider_credentials, ?credential_source: String, ?workflow_id: String, ?request_options: Didit::request_options?) -> Didit::Types::SetupMethodResult
20
+ def update_branding: (String organization_id, String application_id, ?texts: Hash[String | Symbol, Didit::Types::setup_branding_texts], ?terms_url: String, ?privacy_url: String, ?request_options: Didit::request_options?) -> Didit::Types::SetupBranding
21
+ def update_configuration: (String organization_id, String application_id, ?redirect_uris: Array[String], ?allowed_origins: Array[String], ?post_logout_redirect_uri: String, ?session_lifetime: Integer, ?idle_timeout: Integer, ?multiple_sessions: bool, ?password_min_length: Integer, ?revoke_on_password_change: bool, ?allow_subaddresses: bool, ?signup_policy: String, ?allowed_email_domains: Array[String], ?request_options: Didit::request_options?) -> Didit::Types::SetupConfiguration
22
+ def update_native_apps: (String organization_id, String application_id, ios_app_ids: Array[String], android_apps: Array[Didit::Types::setup_android_app], ?request_options: Didit::request_options?) -> Didit::Types::SetupNativeApps
23
+ def update_onboarding: (String organization_id, String application_id, ?test_skipped: bool, ?import_skipped: bool, ?sign_in_ui: String, ?request_options: Didit::request_options?) -> Didit::Types::SetupOnboarding
24
+ def update_protection: (String organization_id, String application_id, ?enabled: bool, ?breached_password_check: bool, ?policies: Hash[String | Symbol, String], ?request_options: Didit::request_options?) -> Didit::Types::SetupProtection
25
+ def update_settings: (String organization_id, String application_id, ?sign_in_ui: String, ?agent_humans_only: bool, ?agents_enabled: bool, ?agent_scopes: Array[String], ?agent_lifetime: Integer, ?agent_idle_timeout: Integer, ?agent_approval: String, ?organizations_enabled: bool, ?mfa_policy: String, ?default_member_role: String, ?webhook_events_disabled: Array[String], ?request_options: Didit::request_options?) -> Didit::Types::SetupSettings
26
+ def update_verified: (String organization_id, String application_id, ?signup_level: String, ?rules: Array[Didit::Types::authentication_setup_update_verified_params_rules], ?claims: Array[String], ?workflows: Didit::Types::authentication_setup_update_verified_params_workflows, ?request_options: Didit::request_options?) -> Didit::Types::SetupVerified
27
+ def verify_domain: (String organization_id, String application_id, ?request_options: Didit::request_options?) -> Didit::Types::SetupDomain
28
+ end
29
+ end
30
+ end
@@ -12,6 +12,7 @@ module Didit
12
12
  def list_queue: (?scope: String, ?kind: String, ?queue: String, ?recommendation: String, ?confidence: String, ?ready: bool, ?search: String, ?limit: Integer, ?offset: Integer, ?request_options: Didit::request_options?) -> Didit::Page[Didit::Types::InvestigatorQueueRow]
13
13
  def override_run: (String run_id, action: String, category: String, reason: String, ?send_email: bool, ?email_address: String, ?email_language: String, ?idempotency_key: String, ?request_options: Didit::request_options?) -> Didit::Types::InvestigatorDecision
14
14
  def retrieve_dashboard: (?scope: String, ?request_options: Didit::request_options?) -> Didit::Types::InvestigatorRetrieveDashboardResponse
15
+ def retrieve_offer: (?request_options: Didit::request_options?) -> Didit::Types::InvestigatorRetrieveOfferResponse
15
16
  def retrieve_performance: (?scope: String, ?period: String, ?request_options: Didit::request_options?) -> Didit::Types::InvestigatorRetrievePerformanceResponse
16
17
  def retrieve_run: (String run_id, ?request_options: Didit::request_options?) -> Didit::Types::InvestigatorRunDetail
17
18
  def retrieve_settings: (?request_options: Didit::request_options?) -> Didit::Types::InvestigatorSettings
@@ -4,6 +4,7 @@ module Didit
4
4
  module Resources
5
5
  class Pricing < Didit::Resource
6
6
  def bank_verification: (?request_options: Didit::request_options?) -> Didit::Types::BankVerificationPricing
7
+ def price_book: (?request_options: Didit::request_options?) -> Didit::Types::PublicPriceBook
7
8
  end
8
9
  end
9
10
  end
@@ -9,6 +9,7 @@ module Didit
9
9
  def aml: () -> Didit::Resources::Aml
10
10
  def aml_monitoring: () -> Didit::Resources::AmlMonitoring
11
11
  def analytics: () -> Didit::Resources::Analytics
12
+ def authentication_setup: () -> Didit::Resources::AuthenticationSetup
12
13
  def bank: () -> Didit::Resources::Bank
13
14
  def billing: () -> Didit::Resources::Billing
14
15
  def biometric_templates: () -> Didit::Resources::BiometricTemplates