didit-sdk 2.26.0 → 2.27.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +7 -0
- data/lib/didit/resources/aml.rb +5 -4
- data/lib/didit/resources/authentication_setup.rb +721 -0
- data/lib/didit/resources/investigator.rb +20 -0
- data/lib/didit/resources/sessions.rb +8 -7
- data/lib/didit/resources.rb +6 -0
- data/lib/didit/types/account_components.rb +566 -0
- data/lib/didit/types/authentication_setup.rb +114 -0
- data/lib/didit/types/components.rb +8 -3
- data/lib/didit/types/investigator.rb +26 -0
- data/lib/didit/types.rb +78 -0
- data/lib/didit/version.rb +1 -1
- data/sig/didit/resources/authentication_setup.rbs +30 -0
- data/sig/didit/resources/investigator.rbs +1 -0
- data/sig/didit/resources.rbs +1 -0
- data/sig/didit/types/account_components.rbs +538 -0
- data/sig/didit/types/authentication_setup.rbs +121 -0
- data/sig/didit/types/components.rbs +3 -0
- data/sig/didit/types/investigator.rbs +24 -0
- metadata +5 -1
|
@@ -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
|
|
@@ -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
|
|
1176
|
-
#
|
|
1177
|
-
#
|
|
1178
|
-
#
|
|
1179
|
-
#
|
|
1180
|
-
# time. A scoped API key needs
|
|
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
|
|
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
|
data/lib/didit/resources.rb
CHANGED
|
@@ -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)
|
|
@@ -59,6 +59,237 @@ module Didit
|
|
|
59
59
|
VALUES = [ENABLED, EARLY_ACCESS, DISABLED].freeze
|
|
60
60
|
end
|
|
61
61
|
|
|
62
|
+
# Known values of an open enum: the API may send others.
|
|
63
|
+
module SetupBrandTheme
|
|
64
|
+
DEVICE = "device"
|
|
65
|
+
|
|
66
|
+
VALUES = [DEVICE].freeze
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
# Known values of an open enum: the API may send others.
|
|
70
|
+
module SetupConfigurationSignupPolicy
|
|
71
|
+
ANYONE = "anyone"
|
|
72
|
+
INVITED = "invited"
|
|
73
|
+
ALLOWED_DOMAINS = "allowed_domains"
|
|
74
|
+
|
|
75
|
+
VALUES = [ANYONE, INVITED, ALLOWED_DOMAINS].freeze
|
|
76
|
+
end
|
|
77
|
+
|
|
78
|
+
# Known values of an open enum: the API may send others.
|
|
79
|
+
module SetupCustomDomainDnsRecordType
|
|
80
|
+
CNAME = "CNAME"
|
|
81
|
+
|
|
82
|
+
VALUES = [CNAME].freeze
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
# Known values of an open enum: the API may send others.
|
|
86
|
+
module SetupCustomDomainStatus
|
|
87
|
+
PENDING = "pending"
|
|
88
|
+
ISSUING = "issuing"
|
|
89
|
+
VERIFIED = "verified"
|
|
90
|
+
ACTIVE = "active"
|
|
91
|
+
FAILED = "failed"
|
|
92
|
+
|
|
93
|
+
VALUES = [PENDING, ISSUING, VERIFIED, ACTIVE, FAILED].freeze
|
|
94
|
+
end
|
|
95
|
+
|
|
96
|
+
# Known values of an open enum: the API may send others.
|
|
97
|
+
module SetupEmailSummaryKey
|
|
98
|
+
CODE = "code"
|
|
99
|
+
MAGIC = "magic"
|
|
100
|
+
RESET = "reset"
|
|
101
|
+
DEVICE = "device"
|
|
102
|
+
INVITE = "invite"
|
|
103
|
+
ORG = "org"
|
|
104
|
+
AGENT = "agent"
|
|
105
|
+
AGENTOFF = "agentoff"
|
|
106
|
+
|
|
107
|
+
VALUES = [CODE, MAGIC, RESET, DEVICE, INVITE, ORG, AGENT, AGENTOFF].freeze
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
# Returned only for social methods.
|
|
111
|
+
module SetupMethodResultCredentialSource
|
|
112
|
+
OWN = "own"
|
|
113
|
+
DIDIT_TEST = "didit_test"
|
|
114
|
+
|
|
115
|
+
VALUES = [OWN, DIDIT_TEST].freeze
|
|
116
|
+
end
|
|
117
|
+
|
|
118
|
+
# `own` for the application's credentials, `didit_test` for Didit's sandbox app, `null` for a method that takes no
|
|
119
|
+
# social credentials.
|
|
120
|
+
module SetupMethodSummaryCredentialSource
|
|
121
|
+
OWN = "own"
|
|
122
|
+
DIDIT_TEST = "didit_test"
|
|
123
|
+
|
|
124
|
+
VALUES = [OWN, DIDIT_TEST].freeze
|
|
125
|
+
end
|
|
126
|
+
|
|
127
|
+
# Known values of an open enum: the API may send others.
|
|
128
|
+
module SetupMethodSummaryName
|
|
129
|
+
PASSWORD = "password"
|
|
130
|
+
CODE = "code"
|
|
131
|
+
MAGIC = "magic"
|
|
132
|
+
PHONE = "phone"
|
|
133
|
+
PASSKEY = "passkey"
|
|
134
|
+
GOOGLE = "google"
|
|
135
|
+
MICROSOFT = "microsoft"
|
|
136
|
+
APPLE = "apple"
|
|
137
|
+
GITHUB = "github"
|
|
138
|
+
SSO = "sso"
|
|
139
|
+
WALLET = "wallet"
|
|
140
|
+
|
|
141
|
+
VALUES = [PASSWORD, CODE, MAGIC, PHONE, PASSKEY, GOOGLE, MICROSOFT, APPLE, GITHUB, SSO, WALLET].freeze
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
# Known values of an open enum: the API may send others.
|
|
145
|
+
module SetupOnboardingCompleted
|
|
146
|
+
METHODS = "methods"
|
|
147
|
+
REDIRECTS = "redirects"
|
|
148
|
+
IMPORT = "import"
|
|
149
|
+
TEST = "test"
|
|
150
|
+
|
|
151
|
+
VALUES = [METHODS, REDIRECTS, IMPORT, TEST].freeze
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
# Known values of an open enum: the API may send others.
|
|
155
|
+
module SetupOnboardingSignInUi
|
|
156
|
+
HOSTED = "hosted"
|
|
157
|
+
OWN = "own"
|
|
158
|
+
|
|
159
|
+
VALUES = [HOSTED, OWN].freeze
|
|
160
|
+
end
|
|
161
|
+
|
|
162
|
+
# Known values of an open enum: the API may send others.
|
|
163
|
+
module SetupOnboardingTestStatus
|
|
164
|
+
VERIFIED = "verified"
|
|
165
|
+
SKIPPED = "skipped"
|
|
166
|
+
NOT_STARTED = "not_started"
|
|
167
|
+
|
|
168
|
+
VALUES = [VERIFIED, SKIPPED, NOT_STARTED].freeze
|
|
169
|
+
end
|
|
170
|
+
|
|
171
|
+
# Known values of an open enum: the API may send others.
|
|
172
|
+
module SetupProtectionPolicyKey
|
|
173
|
+
BOTS = "bots"
|
|
174
|
+
STUFFING = "stuffing"
|
|
175
|
+
BRUTE = "brute"
|
|
176
|
+
DISPOSABLE = "disposable"
|
|
177
|
+
VPN = "vpn"
|
|
178
|
+
TRAVEL = "travel"
|
|
179
|
+
|
|
180
|
+
VALUES = [BOTS, STUFFING, BRUTE, DISPOSABLE, VPN, TRAVEL].freeze
|
|
181
|
+
end
|
|
182
|
+
|
|
183
|
+
# Known values of an open enum: the API may send others.
|
|
184
|
+
module SetupProtectionPolicyMode
|
|
185
|
+
OFF = "off"
|
|
186
|
+
LOG = "log"
|
|
187
|
+
CHALLENGE = "challenge"
|
|
188
|
+
BLOCK = "block"
|
|
189
|
+
|
|
190
|
+
VALUES = [OFF, LOG, CHALLENGE, BLOCK].freeze
|
|
191
|
+
end
|
|
192
|
+
|
|
193
|
+
# Known values of an open enum: the API may send others.
|
|
194
|
+
module SetupSettingsAgentApproval
|
|
195
|
+
PASSKEY = "passkey"
|
|
196
|
+
SIGN_IN = "sign_in"
|
|
197
|
+
|
|
198
|
+
VALUES = [PASSKEY, SIGN_IN].freeze
|
|
199
|
+
end
|
|
200
|
+
|
|
201
|
+
# Known values of an open enum: the API may send others.
|
|
202
|
+
module SetupSettingsAgentScopes
|
|
203
|
+
READ = "read"
|
|
204
|
+
ACT = "act"
|
|
205
|
+
|
|
206
|
+
VALUES = [READ, ACT].freeze
|
|
207
|
+
end
|
|
208
|
+
|
|
209
|
+
# Known values of an open enum: the API may send others.
|
|
210
|
+
module SetupSettingsDefaultMemberRole
|
|
211
|
+
ADMIN = "admin"
|
|
212
|
+
MEMBER = "member"
|
|
213
|
+
BILLING = "billing"
|
|
214
|
+
|
|
215
|
+
VALUES = [ADMIN, MEMBER, BILLING].freeze
|
|
216
|
+
end
|
|
217
|
+
|
|
218
|
+
# Known values of an open enum: the API may send others.
|
|
219
|
+
module SetupSettingsMfaPolicy
|
|
220
|
+
OPTIONAL = "optional"
|
|
221
|
+
EVERYONE = "everyone"
|
|
222
|
+
ORGANIZATION_ADMINS = "organization_admins"
|
|
223
|
+
|
|
224
|
+
VALUES = [OPTIONAL, EVERYONE, ORGANIZATION_ADMINS].freeze
|
|
225
|
+
end
|
|
226
|
+
|
|
227
|
+
# Known values of an open enum: the API may send others.
|
|
228
|
+
module SetupSettingsSignInUi
|
|
229
|
+
HOSTED = "hosted"
|
|
230
|
+
OWN = "own"
|
|
231
|
+
|
|
232
|
+
VALUES = [HOSTED, OWN].freeze
|
|
233
|
+
end
|
|
234
|
+
|
|
235
|
+
# Known values of an open enum: the API may send others.
|
|
236
|
+
module SetupSettingsWebhookEventsDisabled
|
|
237
|
+
AUTH_SIGN_IN = "auth.sign_in"
|
|
238
|
+
AUTH_SIGN_IN_FAILED = "auth.sign_in_failed"
|
|
239
|
+
AUTH_NEW_DEVICE = "auth.new_device"
|
|
240
|
+
AUTH_ACCOUNT_LOCKED = "auth.account_locked"
|
|
241
|
+
AUTH_TWO_FACTOR_CHANGED = "auth.two_factor_changed"
|
|
242
|
+
AUTH_SESSION_REVOKED = "auth.session_revoked"
|
|
243
|
+
AUTH_AGENT_ACCESS_APPROVED = "auth.agent_access_approved"
|
|
244
|
+
AUTH_AGENT_ACCESS_REVOKED = "auth.agent_access_revoked"
|
|
245
|
+
|
|
246
|
+
VALUES = [AUTH_SIGN_IN, AUTH_SIGN_IN_FAILED, AUTH_NEW_DEVICE, AUTH_ACCOUNT_LOCKED, AUTH_TWO_FACTOR_CHANGED, AUTH_SESSION_REVOKED, AUTH_AGENT_ACCESS_APPROVED, AUTH_AGENT_ACCESS_REVOKED].freeze
|
|
247
|
+
end
|
|
248
|
+
|
|
249
|
+
# Known values of an open enum: the API may send others.
|
|
250
|
+
module SetupVerifiedClaims
|
|
251
|
+
OVER_18 = "over_18"
|
|
252
|
+
OVER_21 = "over_21"
|
|
253
|
+
GIVEN_NAME = "given_name"
|
|
254
|
+
FAMILY_NAME = "family_name"
|
|
255
|
+
BIRTHDATE = "birthdate"
|
|
256
|
+
NATIONALITY = "nationality"
|
|
257
|
+
COUNTRY = "country"
|
|
258
|
+
DOCUMENT_VERIFIED = "document_verified"
|
|
259
|
+
LIVENESS = "liveness"
|
|
260
|
+
|
|
261
|
+
VALUES = [OVER_18, OVER_21, GIVEN_NAME, FAMILY_NAME, BIRTHDATE, NATIONALITY, COUNTRY, DOCUMENT_VERIFIED, LIVENESS].freeze
|
|
262
|
+
end
|
|
263
|
+
|
|
264
|
+
# Known values of an open enum: the API may send others.
|
|
265
|
+
module SetupVerifiedRuleMethod
|
|
266
|
+
LIVENESS = "liveness"
|
|
267
|
+
SELFIE = "selfie"
|
|
268
|
+
FULL_ID = "full_id"
|
|
269
|
+
|
|
270
|
+
VALUES = [LIVENESS, SELFIE, FULL_ID].freeze
|
|
271
|
+
end
|
|
272
|
+
|
|
273
|
+
# Known values of an open enum: the API may send others.
|
|
274
|
+
module SetupVerifiedRuleRule
|
|
275
|
+
PAYOUT = "payout"
|
|
276
|
+
BANK = "bank"
|
|
277
|
+
CONTACT = "contact"
|
|
278
|
+
DEVICE = "device"
|
|
279
|
+
SIGN_IN = "sign_in"
|
|
280
|
+
|
|
281
|
+
VALUES = [PAYOUT, BANK, CONTACT, DEVICE, SIGN_IN].freeze
|
|
282
|
+
end
|
|
283
|
+
|
|
284
|
+
# Known values of an open enum: the API may send others.
|
|
285
|
+
module SetupVerifiedSignupLevel
|
|
286
|
+
NONE = "none"
|
|
287
|
+
LIVENESS = "liveness"
|
|
288
|
+
FULL_ID = "full_id"
|
|
289
|
+
|
|
290
|
+
VALUES = [NONE, LIVENESS, FULL_ID].freeze
|
|
291
|
+
end
|
|
292
|
+
|
|
62
293
|
# Full application record. `uuid`, `client_id`, and `api_key` never change after creation. `data_location` doesn't
|
|
63
294
|
# either, except once on the live application created with your organization, before it is used (see the update
|
|
64
295
|
# request).
|
|
@@ -137,6 +368,341 @@ module Didit
|
|
|
137
368
|
field :email, "email", :string
|
|
138
369
|
end
|
|
139
370
|
|
|
371
|
+
class SetupAndroidApp < Didit::Model
|
|
372
|
+
field :package_name, "package_name", :string
|
|
373
|
+
field :sha256_cert_fingerprints, "sha256_cert_fingerprints", [:array, :string]
|
|
374
|
+
end
|
|
375
|
+
|
|
376
|
+
# The brand as Customization sets it. Read-only here.
|
|
377
|
+
class SetupBrand < Didit::Model
|
|
378
|
+
field :source, "source", :string
|
|
379
|
+
field :name, "name", :string
|
|
380
|
+
field :logo, "logo", :string
|
|
381
|
+
field :logo_dark, "logo_dark", :string
|
|
382
|
+
field :brand_colour, "brand_colour", :string
|
|
383
|
+
field :brand_colour_dark, "brand_colour_dark", :string
|
|
384
|
+
field :button_text_colour, "button_text_colour", :string
|
|
385
|
+
field :background, "background", :string
|
|
386
|
+
field :background_dark, "background_dark", :string
|
|
387
|
+
field :corner_radius, "corner_radius", :integer
|
|
388
|
+
field :font, "font", :string
|
|
389
|
+
field :theme, "theme", :string
|
|
390
|
+
end
|
|
391
|
+
|
|
392
|
+
class SetupBranding < Didit::Model
|
|
393
|
+
field :brand, "brand", "SetupBrand"
|
|
394
|
+
field :texts, "texts", [:map, "SetupBrandingTexts"]
|
|
395
|
+
field :defaults, "defaults", "SetupBrandingDefaults"
|
|
396
|
+
field :terms_url, "terms_url", :string
|
|
397
|
+
field :privacy_url, "privacy_url", :string
|
|
398
|
+
field :languages, "languages", [:array, :string]
|
|
399
|
+
field :badge, "badge", "SetupBrandingBadge"
|
|
400
|
+
field :hosted_url, "hosted_url", :string
|
|
401
|
+
end
|
|
402
|
+
|
|
403
|
+
class SetupBrandingBadge < Didit::Model
|
|
404
|
+
field :visible, "visible", :boolean
|
|
405
|
+
field :plan, "plan", :string
|
|
406
|
+
field :early_access, "early_access", :boolean
|
|
407
|
+
end
|
|
408
|
+
|
|
409
|
+
# Didit's own copy for the language you asked for.
|
|
410
|
+
class SetupBrandingDefaults < Didit::Model
|
|
411
|
+
field :sign_in_title, "sign_in_title", :string
|
|
412
|
+
field :subtitle, "subtitle", :string
|
|
413
|
+
field :sign_up_title, "sign_up_title", :string
|
|
414
|
+
end
|
|
415
|
+
|
|
416
|
+
# The texts of the hosted sign-in, sign-up and subtitle lines. A field left empty falls back to Didit's copy.
|
|
417
|
+
class SetupBrandingTexts < Didit::Model
|
|
418
|
+
field :sign_in_title, "sign_in_title", :string
|
|
419
|
+
field :subtitle, "subtitle", :string
|
|
420
|
+
field :sign_up_title, "sign_up_title", :string
|
|
421
|
+
end
|
|
422
|
+
|
|
423
|
+
class SetupConfiguration < Didit::Model
|
|
424
|
+
field :application_id, "application_id", :string
|
|
425
|
+
field :publishable_key, "publishable_key", :string
|
|
426
|
+
field :enabled, "enabled", :boolean
|
|
427
|
+
field :methods_, "methods", [:array, "SetupMethodSummary"]
|
|
428
|
+
field :didit_test_credentials, "didit_test_credentials", "SetupDiditTestCredentials"
|
|
429
|
+
field :redirect_uris, "redirect_uris", [:array, :string]
|
|
430
|
+
field :allowed_origins, "allowed_origins", [:array, :string]
|
|
431
|
+
field :post_logout_redirect_uri, "post_logout_redirect_uri", :string
|
|
432
|
+
field :session_lifetime, "session_lifetime", :integer
|
|
433
|
+
field :idle_timeout, "idle_timeout", :integer
|
|
434
|
+
field :multiple_sessions, "multiple_sessions", :boolean
|
|
435
|
+
field :password_min_length, "password_min_length", :integer
|
|
436
|
+
field :revoke_on_password_change, "revoke_on_password_change", :boolean
|
|
437
|
+
field :allow_subaddresses, "allow_subaddresses", :boolean
|
|
438
|
+
field :signup_policy, "signup_policy", :string
|
|
439
|
+
field :allowed_email_domains, "allowed_email_domains", [:array, :string]
|
|
440
|
+
end
|
|
441
|
+
|
|
442
|
+
class SetupCustomDomain < Didit::Model
|
|
443
|
+
field :domain, "domain", :string
|
|
444
|
+
field :status, "status", :string
|
|
445
|
+
field :failure_reason, "failure_reason", :string
|
|
446
|
+
field :dns_record, "dns_record", "SetupCustomDomainDnsRecord"
|
|
447
|
+
field :certificate, "certificate", "SetupCustomDomainCertificate"
|
|
448
|
+
field :dns_checked_at, "dns_checked_at", :datetime
|
|
449
|
+
field :verified_at, "verified_at", :datetime
|
|
450
|
+
field :activated_at, "activated_at", :datetime
|
|
451
|
+
end
|
|
452
|
+
|
|
453
|
+
class SetupCustomDomainCertificate < Didit::Model
|
|
454
|
+
field :status, "status", :string
|
|
455
|
+
field :expires_at, "expires_at", :datetime
|
|
456
|
+
end
|
|
457
|
+
|
|
458
|
+
class SetupCustomDomainDnsRecord < Didit::Model
|
|
459
|
+
field :type, "type", :string
|
|
460
|
+
field :name, "name", :string
|
|
461
|
+
field :value, "value", :string
|
|
462
|
+
end
|
|
463
|
+
|
|
464
|
+
# Which social providers Didit's own sandbox apps can serve for this application. Every value is `false` on a live
|
|
465
|
+
# application.
|
|
466
|
+
class SetupDiditTestCredentials < Didit::Model
|
|
467
|
+
field :google, "google", :boolean
|
|
468
|
+
field :microsoft, "microsoft", :boolean
|
|
469
|
+
field :apple, "apple", :boolean
|
|
470
|
+
field :github, "github", :boolean
|
|
471
|
+
end
|
|
472
|
+
|
|
473
|
+
class SetupDomain < Didit::Model
|
|
474
|
+
field :host, "host", :string
|
|
475
|
+
field :default_origin, "default_origin", :string
|
|
476
|
+
field :origin, "origin", :string
|
|
477
|
+
field :hosted_url, "hosted_url", :string
|
|
478
|
+
field :issuer, "issuer", :string
|
|
479
|
+
field :passkey_rp_id, "passkey_rp_id", :string
|
|
480
|
+
field :sandbox, "sandbox", :boolean
|
|
481
|
+
field :sandbox_origin, "sandbox_origin", :string
|
|
482
|
+
field :custom_domains_available, "custom_domains_available", :boolean
|
|
483
|
+
field :custom_domain, "custom_domain", "SetupCustomDomain"
|
|
484
|
+
end
|
|
485
|
+
|
|
486
|
+
class SetupEmail < Didit::Model
|
|
487
|
+
field :key, "key", :string
|
|
488
|
+
field :from, "from", :string
|
|
489
|
+
field :to, "to", :string
|
|
490
|
+
field :subject, "subject", :string
|
|
491
|
+
field :html, "html", :string
|
|
492
|
+
field :enabled, "enabled", :boolean
|
|
493
|
+
end
|
|
494
|
+
|
|
495
|
+
class SetupEmailSummary < Didit::Model
|
|
496
|
+
field :key, "key", :string
|
|
497
|
+
field :icon, "icon", :string
|
|
498
|
+
field :sent, "sent", :boolean
|
|
499
|
+
field :enabled, "enabled", :boolean
|
|
500
|
+
field :subject, "subject", :string
|
|
501
|
+
end
|
|
502
|
+
|
|
503
|
+
class SetupEmails < Didit::Model
|
|
504
|
+
field :senders, "senders", "SetupEmailsSenders"
|
|
505
|
+
field :emails, "emails", [:array, "SetupEmailSummary"]
|
|
506
|
+
field :language, "language", :string
|
|
507
|
+
end
|
|
508
|
+
|
|
509
|
+
# Read-only: they come from Customization.
|
|
510
|
+
class SetupEmailsSenders < Didit::Model
|
|
511
|
+
field :email, "email", "SetupEmailsSendersEmail"
|
|
512
|
+
field :sms, "sms", "SetupEmailsSendersSms"
|
|
513
|
+
end
|
|
514
|
+
|
|
515
|
+
class SetupEmailsSendersEmail < Didit::Model
|
|
516
|
+
field :name, "name", :string
|
|
517
|
+
field :email, "email", :string
|
|
518
|
+
field :header, "header", :string
|
|
519
|
+
field :own, "own", :boolean
|
|
520
|
+
end
|
|
521
|
+
|
|
522
|
+
class SetupEmailsSendersSms < Didit::Model
|
|
523
|
+
field :name, "name", :string
|
|
524
|
+
end
|
|
525
|
+
|
|
526
|
+
class SetupMethodResult < Didit::Model
|
|
527
|
+
field :name, "name", :string
|
|
528
|
+
field :enabled, "enabled", :boolean
|
|
529
|
+
field :credential_source, "credential_source", :string
|
|
530
|
+
field :configured, "configured", :boolean
|
|
531
|
+
field :client_id, "client_id", :string
|
|
532
|
+
field :callback_uri, "callback_uri", :string
|
|
533
|
+
end
|
|
534
|
+
|
|
535
|
+
# One sign-in method. `credential_source` is `null` for a method that holds no social credentials, and `always_on`
|
|
536
|
+
# appears on the methods that are on for every application.
|
|
537
|
+
class SetupMethodSummary < Didit::Model
|
|
538
|
+
field :name, "name", :string
|
|
539
|
+
field :enabled, "enabled", :boolean
|
|
540
|
+
field :credential_source, "credential_source", :string
|
|
541
|
+
field :always_on, "always_on", :boolean
|
|
542
|
+
field :available, "available", :boolean
|
|
543
|
+
field :configured, "configured", :boolean
|
|
544
|
+
field :client_id, "client_id", :string
|
|
545
|
+
field :callback_uri, "callback_uri", :string
|
|
546
|
+
end
|
|
547
|
+
|
|
548
|
+
class SetupNativeApps < Didit::Model
|
|
549
|
+
field :ios_app_ids, "ios_app_ids", [:array, :string]
|
|
550
|
+
field :android_apps, "android_apps", [:array, "SetupAndroidApp"]
|
|
551
|
+
end
|
|
552
|
+
|
|
553
|
+
class SetupOnboarding < Didit::Model
|
|
554
|
+
field :completed, "completed", [:array, :string]
|
|
555
|
+
field :ready, "ready", :boolean
|
|
556
|
+
field :sign_in_ui, "sign_in_ui", :string
|
|
557
|
+
field :test_sign_in, "test_sign_in", :any
|
|
558
|
+
field :test_status, "test_status", :string
|
|
559
|
+
end
|
|
560
|
+
|
|
561
|
+
class SetupProtection < Didit::Model
|
|
562
|
+
field :enabled, "enabled", :boolean
|
|
563
|
+
field :breached_password_check, "breached_password_check", :boolean
|
|
564
|
+
field :protections, "protections", [:array, "SetupProtectionPolicy"]
|
|
565
|
+
field :daily, "daily", [:array, "SetupProtectionDaily"]
|
|
566
|
+
field :challenges_daily, "challenges_daily", [:array, "SetupProtectionChallengesDaily"]
|
|
567
|
+
field :period_days, "period_days", :integer
|
|
568
|
+
field :calendar_month, "calendar_month", "SetupProtectionCalendarMonth"
|
|
569
|
+
field :attack_mode, "attack_mode", "SetupProtectionAttackMode"
|
|
570
|
+
field :selfie_available, "selfie_available", :boolean
|
|
571
|
+
end
|
|
572
|
+
|
|
573
|
+
class SetupProtectionAttackMode < Didit::Model
|
|
574
|
+
field :active, "active", :boolean
|
|
575
|
+
field :started_at, "started_at", :datetime
|
|
576
|
+
field :expires_at, "expires_at", :datetime
|
|
577
|
+
end
|
|
578
|
+
|
|
579
|
+
# This calendar month against the previous one.
|
|
580
|
+
class SetupProtectionCalendarMonth < Didit::Model
|
|
581
|
+
field :start, "start", :datetime
|
|
582
|
+
field :as_of, "as_of", :datetime
|
|
583
|
+
field :previous_start, "previous_start", :datetime
|
|
584
|
+
field :previous_end, "previous_end", :datetime
|
|
585
|
+
field :protections, "protections", [:array, "SetupProtectionCalendarMonthProtections"]
|
|
586
|
+
field :challenges, "challenges", "SetupProtectionCalendarMonthChallenges"
|
|
587
|
+
end
|
|
588
|
+
|
|
589
|
+
class SetupProtectionCalendarMonthChallenges < Didit::Model
|
|
590
|
+
field :passed, "passed", :integer
|
|
591
|
+
field :failed, "failed", :integer
|
|
592
|
+
field :previous_passed, "previous_passed", :integer
|
|
593
|
+
field :previous_failed, "previous_failed", :integer
|
|
594
|
+
end
|
|
595
|
+
|
|
596
|
+
class SetupProtectionCalendarMonthProtections < Didit::Model
|
|
597
|
+
field :key, "key", :string
|
|
598
|
+
field :counts, "counts", "SetupProtectionCalendarMonthProtectionsCounts"
|
|
599
|
+
field :previous_counts, "previous_counts", "SetupProtectionCalendarMonthProtectionsPreviousCounts"
|
|
600
|
+
field :counts_delta, "counts_delta", "SetupProtectionCalendarMonthProtectionsCountsDelta"
|
|
601
|
+
field :accounts, "accounts", :integer
|
|
602
|
+
field :previous_accounts, "previous_accounts", :integer
|
|
603
|
+
field :accounts_delta, "accounts_delta", :integer
|
|
604
|
+
end
|
|
605
|
+
|
|
606
|
+
class SetupProtectionCalendarMonthProtectionsCounts < Didit::Model
|
|
607
|
+
field :log, "log", :integer
|
|
608
|
+
field :challenge, "challenge", :integer
|
|
609
|
+
field :block, "block", :integer
|
|
610
|
+
end
|
|
611
|
+
|
|
612
|
+
class SetupProtectionCalendarMonthProtectionsCountsDelta < Didit::Model
|
|
613
|
+
field :log, "log", :integer
|
|
614
|
+
field :challenge, "challenge", :integer
|
|
615
|
+
field :block, "block", :integer
|
|
616
|
+
end
|
|
617
|
+
|
|
618
|
+
class SetupProtectionCalendarMonthProtectionsPreviousCounts < Didit::Model
|
|
619
|
+
field :log, "log", :integer
|
|
620
|
+
field :challenge, "challenge", :integer
|
|
621
|
+
field :block, "block", :integer
|
|
622
|
+
end
|
|
623
|
+
|
|
624
|
+
class SetupProtectionChallengesDaily < Didit::Model
|
|
625
|
+
field :date, "date", :date
|
|
626
|
+
field :passed, "passed", :integer
|
|
627
|
+
field :failed, "failed", :integer
|
|
628
|
+
end
|
|
629
|
+
|
|
630
|
+
class SetupProtectionDaily < Didit::Model
|
|
631
|
+
field :date, "date", :date
|
|
632
|
+
field :protection, "protection", :string
|
|
633
|
+
field :action, "action", :string
|
|
634
|
+
field :count, "count", :integer
|
|
635
|
+
end
|
|
636
|
+
|
|
637
|
+
class SetupProtectionPolicy < Didit::Model
|
|
638
|
+
field :key, "key", :string
|
|
639
|
+
field :mode, "mode", :string
|
|
640
|
+
field :available, "available", :boolean
|
|
641
|
+
field :counts, "counts", "SetupProtectionPolicyCounts"
|
|
642
|
+
field :accounts, "accounts", :integer
|
|
643
|
+
end
|
|
644
|
+
|
|
645
|
+
class SetupProtectionPolicyCounts < Didit::Model
|
|
646
|
+
field :log, "log", :integer
|
|
647
|
+
field :challenge, "challenge", :integer
|
|
648
|
+
field :block, "block", :integer
|
|
649
|
+
end
|
|
650
|
+
|
|
651
|
+
class SetupSettings < Didit::Model
|
|
652
|
+
field :sign_in_ui, "sign_in_ui", :string
|
|
653
|
+
field :agent_humans_only, "agent_humans_only", :boolean
|
|
654
|
+
field :agents_enabled, "agents_enabled", :boolean
|
|
655
|
+
field :agent_scopes, "agent_scopes", [:array, :string]
|
|
656
|
+
field :agent_lifetime, "agent_lifetime", :integer
|
|
657
|
+
field :agent_idle_timeout, "agent_idle_timeout", :integer
|
|
658
|
+
field :agent_approval, "agent_approval", :string
|
|
659
|
+
field :organizations_enabled, "organizations_enabled", :boolean
|
|
660
|
+
field :mfa_policy, "mfa_policy", :string
|
|
661
|
+
field :default_member_role, "default_member_role", :string
|
|
662
|
+
field :webhook_events_disabled, "webhook_events_disabled", [:array, :string]
|
|
663
|
+
end
|
|
664
|
+
|
|
665
|
+
class SetupVerified < Didit::Model
|
|
666
|
+
field :signup_level, "signup_level", :string
|
|
667
|
+
field :signup, "signup", "SetupVerifiedSignup"
|
|
668
|
+
field :rules, "rules", [:array, "SetupVerifiedRule"]
|
|
669
|
+
field :claims, "claims", [:array, :string]
|
|
670
|
+
field :available_claims, "available_claims", [:array, :string]
|
|
671
|
+
field :workflows, "workflows", "SetupVerifiedWorkflows"
|
|
672
|
+
field :wallet, "wallet", "SetupVerifiedWallet"
|
|
673
|
+
field :since, "since", :datetime
|
|
674
|
+
end
|
|
675
|
+
|
|
676
|
+
class SetupVerifiedRule < Didit::Model
|
|
677
|
+
field :rule, "rule", :string
|
|
678
|
+
field :enabled, "enabled", :boolean
|
|
679
|
+
field :method_, "method", :string
|
|
680
|
+
field :threshold, "threshold", :string
|
|
681
|
+
field :currency, "currency", :string
|
|
682
|
+
field :checks, "checks", :integer
|
|
683
|
+
field :passed, "passed", :integer
|
|
684
|
+
field :failed, "failed", :integer
|
|
685
|
+
end
|
|
686
|
+
|
|
687
|
+
class SetupVerifiedSignup < Didit::Model
|
|
688
|
+
field :checks, "checks", :integer
|
|
689
|
+
field :passed, "passed", :integer
|
|
690
|
+
field :failed, "failed", :integer
|
|
691
|
+
end
|
|
692
|
+
|
|
693
|
+
class SetupVerifiedWallet < Didit::Model
|
|
694
|
+
field :enabled, "enabled", :boolean
|
|
695
|
+
field :sign_ins, "sign_ins", :integer
|
|
696
|
+
field :people, "people", :integer
|
|
697
|
+
end
|
|
698
|
+
|
|
699
|
+
# The verification workflow behind each method; `null` until one is created.
|
|
700
|
+
class SetupVerifiedWorkflows < Didit::Model
|
|
701
|
+
field :liveness, "liveness", :string
|
|
702
|
+
field :selfie, "selfie", :string
|
|
703
|
+
field :full_id, "full_id", :string
|
|
704
|
+
end
|
|
705
|
+
|
|
140
706
|
class VerifyEmailResponse < Didit::Model
|
|
141
707
|
field :access_token, "access_token", :string
|
|
142
708
|
field :refresh_token, "refresh_token", :string
|