didit-sdk 2.28.0 → 2.30.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 +14 -0
- data/README.md +1 -1
- data/lib/didit/resources/bank.rb +781 -0
- data/lib/didit/resources/messages.rb +299 -0
- data/lib/didit/resources/pricing.rb +3 -3
- data/lib/didit/resources/travel_rule.rb +2 -2
- data/lib/didit/resources.rb +6 -0
- data/lib/didit/types/bank.rb +126 -0
- data/lib/didit/types/components.rb +1219 -12
- data/lib/didit/types/messages.rb +38 -0
- data/lib/didit/types.rb +133 -0
- data/lib/didit/version.rb +1 -1
- data/sig/didit/resources/bank.rbs +19 -0
- data/sig/didit/resources/messages.rbs +16 -0
- data/sig/didit/resources.rbs +1 -0
- data/sig/didit/types/bank.rbs +115 -0
- data/sig/didit/types/components.rbs +1093 -23
- data/sig/didit/types/messages.rbs +40 -0
- metadata +5 -1
|
@@ -334,6 +334,534 @@ module Didit
|
|
|
334
334
|
VALUES = [MATCH, CLOSE_MATCH, NO_MATCH, CANNOT_VERIFY].freeze
|
|
335
335
|
end
|
|
336
336
|
|
|
337
|
+
# Known values of an open enum: the API may send others.
|
|
338
|
+
module BankAccountHolderRole
|
|
339
|
+
HOLDER = "holder"
|
|
340
|
+
JOINT_HOLDER = "joint_holder"
|
|
341
|
+
REPRESENTATIVE = "representative"
|
|
342
|
+
UNKNOWN = "unknown"
|
|
343
|
+
|
|
344
|
+
VALUES = [HOLDER, JOINT_HOLDER, REPRESENTATIVE, UNKNOWN].freeze
|
|
345
|
+
end
|
|
346
|
+
|
|
347
|
+
# Known values of an open enum: the API may send others.
|
|
348
|
+
module BankAccountScopesGranted
|
|
349
|
+
ACCOUNTS = "accounts"
|
|
350
|
+
BALANCES = "balances"
|
|
351
|
+
TRANSACTIONS = "transactions"
|
|
352
|
+
|
|
353
|
+
VALUES = [ACCOUNTS, BALANCES, TRANSACTIONS].freeze
|
|
354
|
+
end
|
|
355
|
+
|
|
356
|
+
# `access_removed`: the person removed the account from the consent. It is no longer synced.
|
|
357
|
+
module BankAccountStatus
|
|
358
|
+
OPEN = "open"
|
|
359
|
+
CLOSED = "closed"
|
|
360
|
+
ACCESS_REMOVED = "access_removed"
|
|
361
|
+
|
|
362
|
+
VALUES = [OPEN, CLOSED, ACCESS_REMOVED].freeze
|
|
363
|
+
end
|
|
364
|
+
|
|
365
|
+
# Known values of an open enum: the API may send others.
|
|
366
|
+
module BankAccountSyncStatus
|
|
367
|
+
PENDING = "pending"
|
|
368
|
+
OK = "ok"
|
|
369
|
+
FAILED = "failed"
|
|
370
|
+
|
|
371
|
+
VALUES = [PENDING, OK, FAILED].freeze
|
|
372
|
+
end
|
|
373
|
+
|
|
374
|
+
# Known values of an open enum: the API may send others.
|
|
375
|
+
module BankAccountType
|
|
376
|
+
CURRENT = "current"
|
|
377
|
+
SAVINGS = "savings"
|
|
378
|
+
CARD = "card"
|
|
379
|
+
LOAN = "loan"
|
|
380
|
+
INVESTMENT = "investment"
|
|
381
|
+
OTHER = "other"
|
|
382
|
+
|
|
383
|
+
VALUES = [CURRENT, SAVINGS, CARD, LOAN, INVESTMENT, OTHER].freeze
|
|
384
|
+
end
|
|
385
|
+
|
|
386
|
+
# Known values of an open enum: the API may send others.
|
|
387
|
+
module BankAccountUsage
|
|
388
|
+
PERSONAL = "personal"
|
|
389
|
+
BUSINESS = "business"
|
|
390
|
+
UNKNOWN = "unknown"
|
|
391
|
+
|
|
392
|
+
VALUES = [PERSONAL, BUSINESS, UNKNOWN].freeze
|
|
393
|
+
end
|
|
394
|
+
|
|
395
|
+
# `booked`, `available` or `expected`. `other` is a balance the bank types in a way Didit does not map: it is
|
|
396
|
+
# served, never dropped, and `iso_type` carries the bank's raw code.
|
|
397
|
+
module BankBalanceType
|
|
398
|
+
BOOKED = "booked"
|
|
399
|
+
AVAILABLE = "available"
|
|
400
|
+
EXPECTED = "expected"
|
|
401
|
+
OTHER = "other"
|
|
402
|
+
|
|
403
|
+
VALUES = [BOOKED, AVAILABLE, EXPECTED, OTHER].freeze
|
|
404
|
+
end
|
|
405
|
+
|
|
406
|
+
# Known values of an open enum: the API may send others.
|
|
407
|
+
module BankConnectionAccess
|
|
408
|
+
ONE_TIME = "one_time"
|
|
409
|
+
ONGOING = "ongoing"
|
|
410
|
+
|
|
411
|
+
VALUES = [ONE_TIME, ONGOING].freeze
|
|
412
|
+
end
|
|
413
|
+
|
|
414
|
+
# Known values of an open enum: the API may send others.
|
|
415
|
+
module BankConnectionAccountSummaryStatus
|
|
416
|
+
OPEN = "open"
|
|
417
|
+
CLOSED = "closed"
|
|
418
|
+
ACCESS_REMOVED = "access_removed"
|
|
419
|
+
|
|
420
|
+
VALUES = [OPEN, CLOSED, ACCESS_REMOVED].freeze
|
|
421
|
+
end
|
|
422
|
+
|
|
423
|
+
# Known values of an open enum: the API may send others.
|
|
424
|
+
module BankConnectionAccountSummaryType
|
|
425
|
+
CURRENT = "current"
|
|
426
|
+
SAVINGS = "savings"
|
|
427
|
+
CARD = "card"
|
|
428
|
+
LOAN = "loan"
|
|
429
|
+
INVESTMENT = "investment"
|
|
430
|
+
OTHER = "other"
|
|
431
|
+
|
|
432
|
+
VALUES = [CURRENT, SAVINGS, CARD, LOAN, INVESTMENT, OTHER].freeze
|
|
433
|
+
end
|
|
434
|
+
|
|
435
|
+
# Known values of an open enum: the API may send others.
|
|
436
|
+
module BankConnectionAccountSummaryUsage
|
|
437
|
+
PERSONAL = "personal"
|
|
438
|
+
BUSINESS = "business"
|
|
439
|
+
UNKNOWN = "unknown"
|
|
440
|
+
|
|
441
|
+
VALUES = [PERSONAL, BUSINESS, UNKNOWN].freeze
|
|
442
|
+
end
|
|
443
|
+
|
|
444
|
+
# Billing unit, `connection_month` for ongoing access, `one_time` otherwise.
|
|
445
|
+
module BankConnectionBillingUnit
|
|
446
|
+
CONNECTION_MONTH = "connection_month"
|
|
447
|
+
ONE_TIME = "one_time"
|
|
448
|
+
|
|
449
|
+
VALUES = [CONNECTION_MONTH, ONE_TIME].freeze
|
|
450
|
+
end
|
|
451
|
+
|
|
452
|
+
# Who ended access, set from evidence. `unknown` when neither the bank nor the sync says.
|
|
453
|
+
module BankConnectionConsentEndedBy
|
|
454
|
+
END_USER = "end_user"
|
|
455
|
+
BANK = "bank"
|
|
456
|
+
CUSTOMER = "customer"
|
|
457
|
+
UNKNOWN = "unknown"
|
|
458
|
+
|
|
459
|
+
VALUES = [END_USER, BANK, CUSTOMER, UNKNOWN].freeze
|
|
460
|
+
end
|
|
461
|
+
|
|
462
|
+
# How a renewal works: `reconfirm` is the person confirming on Didit's screen with no bank sign-in, where the bank
|
|
463
|
+
# and the country's rules allow it. `bank_auth` is a bank sign-in.
|
|
464
|
+
module BankConnectionConsentRenewalAction
|
|
465
|
+
RECONFIRM = "reconfirm"
|
|
466
|
+
BANK_AUTH = "bank_auth"
|
|
467
|
+
|
|
468
|
+
VALUES = [RECONFIRM, BANK_AUTH].freeze
|
|
469
|
+
end
|
|
470
|
+
|
|
471
|
+
# Known values of an open enum: the API may send others.
|
|
472
|
+
module BankConnectionConsentScopesGranted
|
|
473
|
+
ACCOUNTS = "accounts"
|
|
474
|
+
BALANCES = "balances"
|
|
475
|
+
TRANSACTIONS = "transactions"
|
|
476
|
+
|
|
477
|
+
VALUES = [ACCOUNTS, BALANCES, TRANSACTIONS].freeze
|
|
478
|
+
end
|
|
479
|
+
|
|
480
|
+
# Known values of an open enum: the API may send others.
|
|
481
|
+
module BankConnectionConsentScopesRequested
|
|
482
|
+
ACCOUNTS = "accounts"
|
|
483
|
+
BALANCES = "balances"
|
|
484
|
+
TRANSACTIONS = "transactions"
|
|
485
|
+
|
|
486
|
+
VALUES = [ACCOUNTS, BALANCES, TRANSACTIONS].freeze
|
|
487
|
+
end
|
|
488
|
+
|
|
489
|
+
# `revocation_pending` until the bank confirms the consent is terminated, then `revoked`. `revocation_failed` is
|
|
490
|
+
# retried automatically. Bank fetches stop the moment a revocation is requested.
|
|
491
|
+
module BankConnectionConsentStatus
|
|
492
|
+
GRANTED = "granted"
|
|
493
|
+
EXPIRED = "expired"
|
|
494
|
+
REVOCATION_PENDING = "revocation_pending"
|
|
495
|
+
REVOKED = "revoked"
|
|
496
|
+
REVOCATION_FAILED = "revocation_failed"
|
|
497
|
+
|
|
498
|
+
VALUES = [GRANTED, EXPIRED, REVOCATION_PENDING, REVOKED, REVOCATION_FAILED].freeze
|
|
499
|
+
end
|
|
500
|
+
|
|
501
|
+
# Known values of an open enum: the API may send others.
|
|
502
|
+
module BankConnectionData
|
|
503
|
+
ACCOUNTS = "accounts"
|
|
504
|
+
BALANCES = "balances"
|
|
505
|
+
TRANSACTIONS = "transactions"
|
|
506
|
+
|
|
507
|
+
VALUES = [ACCOUNTS, BALANCES, TRANSACTIONS].freeze
|
|
508
|
+
end
|
|
509
|
+
|
|
510
|
+
# Known values of an open enum: the API may send others.
|
|
511
|
+
module BankConnectionEnvironment
|
|
512
|
+
LIVE = "live"
|
|
513
|
+
SANDBOX = "sandbox"
|
|
514
|
+
|
|
515
|
+
VALUES = [LIVE, SANDBOX].freeze
|
|
516
|
+
end
|
|
517
|
+
|
|
518
|
+
# `pending` while deletion runs, `erased` when no stored copy and no access at the bank remain, `failed` when it
|
|
519
|
+
# could not be confirmed within 24 hours. A failed deletion keeps the connection's data closed, is retried, and
|
|
520
|
+
# Didit is alerted.
|
|
521
|
+
module BankConnectionErasureStatus
|
|
522
|
+
PENDING = "pending"
|
|
523
|
+
ERASED = "erased"
|
|
524
|
+
FAILED = "failed"
|
|
525
|
+
|
|
526
|
+
VALUES = [PENDING, ERASED, FAILED].freeze
|
|
527
|
+
end
|
|
528
|
+
|
|
529
|
+
# Known values of an open enum: the API may send others.
|
|
530
|
+
module BankConnectionOwnershipCompare
|
|
531
|
+
NONE = "none"
|
|
532
|
+
PERSON = "person"
|
|
533
|
+
BUSINESS = "business"
|
|
534
|
+
|
|
535
|
+
VALUES = [NONE, PERSON, BUSINESS].freeze
|
|
536
|
+
end
|
|
537
|
+
|
|
538
|
+
# Known values of an open enum: the API may send others.
|
|
539
|
+
module BankConnectionOwnershipMatch
|
|
540
|
+
ANY_HOLDER = "any_holder"
|
|
541
|
+
ALL_HOLDERS = "all_holders"
|
|
542
|
+
|
|
543
|
+
VALUES = [ANY_HOLDER, ALL_HOLDERS].freeze
|
|
544
|
+
end
|
|
545
|
+
|
|
546
|
+
# Verdict. `unknown` whenever missing holder evidence could change it, and when the bank shares no holder.
|
|
547
|
+
module BankConnectionOwnershipResult
|
|
548
|
+
MATCH = "match"
|
|
549
|
+
CLOSE_MATCH = "close_match"
|
|
550
|
+
NO_MATCH = "no_match"
|
|
551
|
+
UNKNOWN = "unknown"
|
|
552
|
+
|
|
553
|
+
VALUES = [MATCH, CLOSE_MATCH, NO_MATCH, UNKNOWN].freeze
|
|
554
|
+
end
|
|
555
|
+
|
|
556
|
+
# Known values of an open enum: the API may send others.
|
|
557
|
+
module BankConnectionSegment
|
|
558
|
+
PERSONAL = "personal"
|
|
559
|
+
BUSINESS = "business"
|
|
560
|
+
|
|
561
|
+
VALUES = [PERSONAL, BUSINESS].freeze
|
|
562
|
+
end
|
|
563
|
+
|
|
564
|
+
# `pending`: first sync running. `active`: consent valid. `renewal_required`: the consent ended or the bank wants
|
|
565
|
+
# the person to sign in again, data readable as last synced and nothing charged. `paused`: balance too low for the
|
|
566
|
+
# month. `revoked`: access stopped by the person, the bank or you. `deleted`: only `id`, `status`,
|
|
567
|
+
# `status_reason`, `created_at` and `erasure` remain. `failed`: the first sync never succeeded.
|
|
568
|
+
module BankConnectionStatus
|
|
569
|
+
PENDING = "pending"
|
|
570
|
+
ACTIVE = "active"
|
|
571
|
+
RENEWAL_REQUIRED = "renewal_required"
|
|
572
|
+
PAUSED = "paused"
|
|
573
|
+
REVOKED = "revoked"
|
|
574
|
+
DELETED = "deleted"
|
|
575
|
+
FAILED = "failed"
|
|
576
|
+
|
|
577
|
+
VALUES = [PENDING, ACTIVE, RENEWAL_REQUIRED, PAUSED, REVOKED, DELETED, FAILED].freeze
|
|
578
|
+
end
|
|
579
|
+
|
|
580
|
+
# Why the connection is in this status. `paused_by_customer` is reserved. On a `deleted` connection:
|
|
581
|
+
# `deleted_by_customer`, `consent_lapsed`, `retention_elapsed` or `application_deleted`.
|
|
582
|
+
module BankConnectionStatusReason
|
|
583
|
+
COLLECTION_COMPLETE = "collection_complete"
|
|
584
|
+
CONSENT_EXPIRED = "consent_expired"
|
|
585
|
+
CONSENT_LAPSED = "consent_lapsed"
|
|
586
|
+
BANK_REQUIRES_SIGN_IN = "bank_requires_sign_in"
|
|
587
|
+
REVOKED_BY_END_USER = "revoked_by_end_user"
|
|
588
|
+
REVOKED_BY_BANK = "revoked_by_bank"
|
|
589
|
+
REVOKED_BY_CUSTOMER = "revoked_by_customer"
|
|
590
|
+
INSUFFICIENT_BALANCE = "insufficient_balance"
|
|
591
|
+
PAUSED_BY_CUSTOMER = "paused_by_customer"
|
|
592
|
+
FIRST_SYNC_FAILED = "first_sync_failed"
|
|
593
|
+
DELETED_BY_CUSTOMER = "deleted_by_customer"
|
|
594
|
+
RETENTION_ELAPSED = "retention_elapsed"
|
|
595
|
+
APPLICATION_DELETED = "application_deleted"
|
|
596
|
+
|
|
597
|
+
VALUES = [COLLECTION_COMPLETE, CONSENT_EXPIRED, CONSENT_LAPSED, BANK_REQUIRES_SIGN_IN, REVOKED_BY_END_USER, REVOKED_BY_BANK, REVOKED_BY_CUSTOMER, INSUFFICIENT_BALANCE, PAUSED_BY_CUSTOMER, FIRST_SYNC_FAILED, DELETED_BY_CUSTOMER, RETENTION_ELAPSED, APPLICATION_DELETED].freeze
|
|
598
|
+
end
|
|
599
|
+
|
|
600
|
+
# Result of the first sync. The connection becomes `active` on `succeeded` or `partial`, and `failed` when no
|
|
601
|
+
# account succeeded.
|
|
602
|
+
module BankConnectionSyncInitialStatus
|
|
603
|
+
PENDING = "pending"
|
|
604
|
+
SUCCEEDED = "succeeded"
|
|
605
|
+
PARTIAL = "partial"
|
|
606
|
+
FAILED = "failed"
|
|
607
|
+
|
|
608
|
+
VALUES = [PENDING, SUCCEEDED, PARTIAL, FAILED].freeze
|
|
609
|
+
end
|
|
610
|
+
|
|
611
|
+
# `failing` after 24 hours of failed attempts, which are retried with backoff. A bank that asks the person to sign
|
|
612
|
+
# in again makes the connection `renewal_required` instead.
|
|
613
|
+
module BankConnectionSyncStatus
|
|
614
|
+
PENDING = "pending"
|
|
615
|
+
OK = "ok"
|
|
616
|
+
FAILING = "failing"
|
|
617
|
+
|
|
618
|
+
VALUES = [PENDING, OK, FAILING].freeze
|
|
619
|
+
end
|
|
620
|
+
|
|
621
|
+
# `partial`: the bank delivered less than asked. `empty`: the bank confirmed the whole window and it has no
|
|
622
|
+
# transactions. `unavailable`: the bank gave no history. `unknown`: not known yet.
|
|
623
|
+
module BankHistoryCoverageStatus
|
|
624
|
+
COMPLETE = "complete"
|
|
625
|
+
PARTIAL = "partial"
|
|
626
|
+
EMPTY = "empty"
|
|
627
|
+
UNAVAILABLE = "unavailable"
|
|
628
|
+
UNKNOWN = "unknown"
|
|
629
|
+
|
|
630
|
+
VALUES = [COMPLETE, PARTIAL, EMPTY, UNAVAILABLE, UNKNOWN].freeze
|
|
631
|
+
end
|
|
632
|
+
|
|
633
|
+
# Known values of an open enum: the API may send others.
|
|
634
|
+
module BankInstitutionAccess
|
|
635
|
+
ONE_TIME = "one_time"
|
|
636
|
+
ONGOING = "ongoing"
|
|
637
|
+
|
|
638
|
+
VALUES = [ONE_TIME, ONGOING].freeze
|
|
639
|
+
end
|
|
640
|
+
|
|
641
|
+
# Known values of an open enum: the API may send others.
|
|
642
|
+
module BankInstitutionBalanceTypes
|
|
643
|
+
BOOKED = "booked"
|
|
644
|
+
AVAILABLE = "available"
|
|
645
|
+
EXPECTED = "expected"
|
|
646
|
+
|
|
647
|
+
VALUES = [BOOKED, AVAILABLE, EXPECTED].freeze
|
|
648
|
+
end
|
|
649
|
+
|
|
650
|
+
# Known values of an open enum: the API may send others.
|
|
651
|
+
module BankInstitutionHealth
|
|
652
|
+
OPERATIONAL = "operational"
|
|
653
|
+
DEGRADED = "degraded"
|
|
654
|
+
DOWN = "down"
|
|
655
|
+
|
|
656
|
+
VALUES = [OPERATIONAL, DEGRADED, DOWN].freeze
|
|
657
|
+
end
|
|
658
|
+
|
|
659
|
+
# Known values of an open enum: the API may send others.
|
|
660
|
+
module BankInstitutionSegments
|
|
661
|
+
PERSONAL = "personal"
|
|
662
|
+
BUSINESS = "business"
|
|
663
|
+
|
|
664
|
+
VALUES = [PERSONAL, BUSINESS].freeze
|
|
665
|
+
end
|
|
666
|
+
|
|
667
|
+
# How the person signs in at the bank.
|
|
668
|
+
module BankInstitutionSignIn
|
|
669
|
+
REDIRECT = "redirect"
|
|
670
|
+
APP_APPROVAL = "app_approval"
|
|
671
|
+
CREDENTIALS = "credentials"
|
|
672
|
+
|
|
673
|
+
VALUES = [REDIRECT, APP_APPROVAL, CREDENTIALS].freeze
|
|
674
|
+
end
|
|
675
|
+
|
|
676
|
+
# Known values of an open enum: the API may send others.
|
|
677
|
+
module BankLinkAccess
|
|
678
|
+
ONE_TIME = "one_time"
|
|
679
|
+
ONGOING = "ongoing"
|
|
680
|
+
|
|
681
|
+
VALUES = [ONE_TIME, ONGOING].freeze
|
|
682
|
+
end
|
|
683
|
+
|
|
684
|
+
# Why the link failed. A failed link is not an HTTP error: the link reads with `status: failed` and this object. A
|
|
685
|
+
# renew link whose connection changed meanwhile reads `renewal_not_needed` or `renewal_window_expired`.
|
|
686
|
+
module BankLinkErrorCode
|
|
687
|
+
DUPLICATE_CONFLICT = "duplicate_conflict"
|
|
688
|
+
RENEWAL_LOGIN_MISMATCH = "renewal_login_mismatch"
|
|
689
|
+
REDUCED_GRANT = "reduced_grant"
|
|
690
|
+
CORPORATE_APPROVAL_NOT_SUPPORTED = "corporate_approval_not_supported"
|
|
691
|
+
ONGOING_ACCESS_NOT_AVAILABLE = "ongoing_access_not_available"
|
|
692
|
+
BANK_UNAVAILABLE = "bank_unavailable"
|
|
693
|
+
BANK_CANCELLED = "bank_cancelled"
|
|
694
|
+
CONSENT_DECLINED = "consent_declined"
|
|
695
|
+
READ_LIMIT = "read_limit"
|
|
696
|
+
RENEWAL_NOT_NEEDED = "renewal_not_needed"
|
|
697
|
+
RENEWAL_WINDOW_EXPIRED = "renewal_window_expired"
|
|
698
|
+
FIRST_SYNC_FAILED = "first_sync_failed"
|
|
699
|
+
|
|
700
|
+
VALUES = [DUPLICATE_CONFLICT, RENEWAL_LOGIN_MISMATCH, REDUCED_GRANT, CORPORATE_APPROVAL_NOT_SUPPORTED, ONGOING_ACCESS_NOT_AVAILABLE, BANK_UNAVAILABLE, BANK_CANCELLED, CONSENT_DECLINED, READ_LIMIT, RENEWAL_NOT_NEEDED, RENEWAL_WINDOW_EXPIRED, FIRST_SYNC_FAILED].freeze
|
|
701
|
+
end
|
|
702
|
+
|
|
703
|
+
# Known values of an open enum: the API may send others.
|
|
704
|
+
module BankLinkMode
|
|
705
|
+
CONNECT = "connect"
|
|
706
|
+
RENEW = "renew"
|
|
707
|
+
|
|
708
|
+
VALUES = [CONNECT, RENEW].freeze
|
|
709
|
+
end
|
|
710
|
+
|
|
711
|
+
# What the holder of the account is compared with. `none` (default) gives no verdict and needs no reference.
|
|
712
|
+
# `person` needs `reference_identity` or `session_id`. `business` needs `business` or `business_session_id`. Send
|
|
713
|
+
# exactly one reference of the kind you compare with, and none with `none`.
|
|
714
|
+
module BankLinkOwnershipRequestCompare
|
|
715
|
+
NONE = "none"
|
|
716
|
+
PERSON = "person"
|
|
717
|
+
BUSINESS = "business"
|
|
718
|
+
|
|
719
|
+
VALUES = [NONE, PERSON, BUSINESS].freeze
|
|
720
|
+
end
|
|
721
|
+
|
|
722
|
+
# Whether one legal holder or every legal holder must match. Representatives never count.
|
|
723
|
+
module BankLinkOwnershipRequestMatch
|
|
724
|
+
ANY_HOLDER = "any_holder"
|
|
725
|
+
ALL_HOLDERS = "all_holders"
|
|
726
|
+
|
|
727
|
+
VALUES = [ANY_HOLDER, ALL_HOLDERS].freeze
|
|
728
|
+
end
|
|
729
|
+
|
|
730
|
+
# Known values of an open enum: the API may send others.
|
|
731
|
+
module BankLinkQuoteScopes
|
|
732
|
+
ACCOUNTS = "accounts"
|
|
733
|
+
BALANCES = "balances"
|
|
734
|
+
TRANSACTIONS = "transactions"
|
|
735
|
+
|
|
736
|
+
VALUES = [ACCOUNTS, BALANCES, TRANSACTIONS].freeze
|
|
737
|
+
end
|
|
738
|
+
|
|
739
|
+
# State of the link. `completed`, `cancelled`, `expired` and `failed` are final.
|
|
740
|
+
module BankLinkStatus
|
|
741
|
+
CREATED = "created"
|
|
742
|
+
OPENED = "opened"
|
|
743
|
+
CONNECTING = "connecting"
|
|
744
|
+
COMPLETED = "completed"
|
|
745
|
+
CANCELLED = "cancelled"
|
|
746
|
+
EXPIRED = "expired"
|
|
747
|
+
FAILED = "failed"
|
|
748
|
+
|
|
749
|
+
VALUES = [CREATED, OPENED, CONNECTING, COMPLETED, CANCELLED, EXPIRED, FAILED].freeze
|
|
750
|
+
end
|
|
751
|
+
|
|
752
|
+
# Known values of an open enum: the API may send others.
|
|
753
|
+
module BankRefreshAcceptedStatus
|
|
754
|
+
QUEUED = "queued"
|
|
755
|
+
RUNNING = "running"
|
|
756
|
+
|
|
757
|
+
VALUES = [QUEUED, RUNNING].freeze
|
|
758
|
+
end
|
|
759
|
+
|
|
760
|
+
# `pending_booked`: the bank booked it, and the booked transaction is in `added`. `pending_expired`: a pending
|
|
761
|
+
# transaction the bank stopped reporting. `bank_removed`: the bank removed it. `access_removed`: the account left
|
|
762
|
+
# the consent.
|
|
763
|
+
module BankRemovedTransactionReason
|
|
764
|
+
PENDING_BOOKED = "pending_booked"
|
|
765
|
+
PENDING_EXPIRED = "pending_expired"
|
|
766
|
+
BANK_REMOVED = "bank_removed"
|
|
767
|
+
ACCESS_REMOVED = "access_removed"
|
|
768
|
+
|
|
769
|
+
VALUES = [PENDING_BOOKED, PENDING_EXPIRED, BANK_REMOVED, ACCESS_REMOVED].freeze
|
|
770
|
+
end
|
|
771
|
+
|
|
772
|
+
# Known values of an open enum: the API may send others.
|
|
773
|
+
module BankSyncBudgetResource
|
|
774
|
+
ALL = "all"
|
|
775
|
+
ACCOUNTS = "accounts"
|
|
776
|
+
BALANCES = "balances"
|
|
777
|
+
TRANSACTIONS = "transactions"
|
|
778
|
+
|
|
779
|
+
VALUES = [ALL, ACCOUNTS, BALANCES, TRANSACTIONS].freeze
|
|
780
|
+
end
|
|
781
|
+
|
|
782
|
+
# What the bank counts the budget against.
|
|
783
|
+
module BankSyncBudgetScope
|
|
784
|
+
CONNECTION = "connection"
|
|
785
|
+
ACCOUNT = "account"
|
|
786
|
+
|
|
787
|
+
VALUES = [CONNECTION, ACCOUNT].freeze
|
|
788
|
+
end
|
|
789
|
+
|
|
790
|
+
# How the sync ended.
|
|
791
|
+
module BankSyncCompletedOutcome
|
|
792
|
+
SUCCEEDED = "succeeded"
|
|
793
|
+
PARTIAL = "partial"
|
|
794
|
+
FAILED = "failed"
|
|
795
|
+
|
|
796
|
+
VALUES = [SUCCEEDED, PARTIAL, FAILED].freeze
|
|
797
|
+
end
|
|
798
|
+
|
|
799
|
+
# Known values of an open enum: the API may send others.
|
|
800
|
+
module BankSyncRunResultOutcome
|
|
801
|
+
SUCCEEDED = "succeeded"
|
|
802
|
+
FAILED = "failed"
|
|
803
|
+
SKIPPED = "skipped"
|
|
804
|
+
|
|
805
|
+
VALUES = [SUCCEEDED, FAILED, SKIPPED].freeze
|
|
806
|
+
end
|
|
807
|
+
|
|
808
|
+
# Known values of an open enum: the API may send others.
|
|
809
|
+
module BankSyncRunResultResource
|
|
810
|
+
ACCOUNTS = "accounts"
|
|
811
|
+
BALANCES = "balances"
|
|
812
|
+
TRANSACTIONS = "transactions"
|
|
813
|
+
|
|
814
|
+
VALUES = [ACCOUNTS, BALANCES, TRANSACTIONS].freeze
|
|
815
|
+
end
|
|
816
|
+
|
|
817
|
+
# Known values of an open enum: the API may send others.
|
|
818
|
+
module BankSyncRunStatus
|
|
819
|
+
QUEUED = "queued"
|
|
820
|
+
RUNNING = "running"
|
|
821
|
+
SUCCEEDED = "succeeded"
|
|
822
|
+
PARTIAL = "partial"
|
|
823
|
+
FAILED = "failed"
|
|
824
|
+
|
|
825
|
+
VALUES = [QUEUED, RUNNING, SUCCEEDED, PARTIAL, FAILED].freeze
|
|
826
|
+
end
|
|
827
|
+
|
|
828
|
+
# Known values of an open enum: the API may send others.
|
|
829
|
+
module BankSyncRunTrigger
|
|
830
|
+
INITIAL = "initial"
|
|
831
|
+
SCHEDULED = "scheduled"
|
|
832
|
+
REQUESTED = "requested"
|
|
833
|
+
|
|
834
|
+
VALUES = [INITIAL, SCHEDULED, REQUESTED].freeze
|
|
835
|
+
end
|
|
836
|
+
|
|
837
|
+
# Repeats the sign of `amount`.
|
|
838
|
+
module BankTransactionDirection
|
|
839
|
+
CREDIT = "credit"
|
|
840
|
+
DEBIT = "debit"
|
|
841
|
+
|
|
842
|
+
VALUES = [CREDIT, DEBIT].freeze
|
|
843
|
+
end
|
|
844
|
+
|
|
845
|
+
# How `id` was matched. `bank_reference` and `route_id` are stable. `derived` is matched by content: it is stable
|
|
846
|
+
# while the bank keeps reporting the entry unchanged, and a correction by the bank can then appear as one
|
|
847
|
+
# `removed` and one `added`.
|
|
848
|
+
module BankTransactionIdentityQuality
|
|
849
|
+
BANK_REFERENCE = "bank_reference"
|
|
850
|
+
ROUTE_ID = "route_id"
|
|
851
|
+
DERIVED = "derived"
|
|
852
|
+
|
|
853
|
+
VALUES = [BANK_REFERENCE, ROUTE_ID, DERIVED].freeze
|
|
854
|
+
end
|
|
855
|
+
|
|
856
|
+
# A pending transaction has its own id. When the bank books it, the booked transaction carries `pending_id` where
|
|
857
|
+
# the bank links them, and the pending one appears in `removed` with `reason: pending_booked`.
|
|
858
|
+
module BankTransactionStatus
|
|
859
|
+
BOOKED = "booked"
|
|
860
|
+
PENDING = "pending"
|
|
861
|
+
|
|
862
|
+
VALUES = [BOOKED, PENDING].freeze
|
|
863
|
+
end
|
|
864
|
+
|
|
337
865
|
# Currency of every price in the response.
|
|
338
866
|
module BankVerificationPricingCurrency
|
|
339
867
|
USD = "USD"
|
|
@@ -2354,22 +2882,143 @@ module Didit
|
|
|
2354
2882
|
PROVIDER_UNAVAILABLE = "provider_unavailable"
|
|
2355
2883
|
OTHER = "other"
|
|
2356
2884
|
|
|
2357
|
-
VALUES = [NO_OWNERS_ON_RECORD, NO_NATURAL_PERSON_OWNER, OWNERSHIP_SECTION_UNAVAILABLE, COMPANY_NOT_FOUND, AMBIGUOUS_COMPANY_MATCH, MISSING_REGISTRATION_NUMBER, ENTITY_TYPE_NOT_COVERED, PROVIDER_UNAVAILABLE, OTHER].freeze
|
|
2885
|
+
VALUES = [NO_OWNERS_ON_RECORD, NO_NATURAL_PERSON_OWNER, OWNERSHIP_SECTION_UNAVAILABLE, COMPANY_NOT_FOUND, AMBIGUOUS_COMPANY_MATCH, MISSING_REGISTRATION_NUMBER, ENTITY_TYPE_NOT_COVERED, PROVIDER_UNAVAILABLE, OTHER].freeze
|
|
2886
|
+
end
|
|
2887
|
+
|
|
2888
|
+
# Registry search lifecycle status.
|
|
2889
|
+
module KYBRegistrySearchResultsSearchStatus
|
|
2890
|
+
PENDING = "pending"
|
|
2891
|
+
RESOLVED = "resolved"
|
|
2892
|
+
|
|
2893
|
+
VALUES = [PENDING, RESOLVED].freeze
|
|
2894
|
+
end
|
|
2895
|
+
|
|
2896
|
+
# Always `official`.
|
|
2897
|
+
module KYBRegistrySourceSourceType
|
|
2898
|
+
OFFICIAL = "official"
|
|
2899
|
+
|
|
2900
|
+
VALUES = [OFFICIAL].freeze
|
|
2901
|
+
end
|
|
2902
|
+
|
|
2903
|
+
# Known values of an open enum: the API may send others.
|
|
2904
|
+
module MessageAttemptChannel
|
|
2905
|
+
SMS = "sms"
|
|
2906
|
+
WHATSAPP = "whatsapp"
|
|
2907
|
+
EMAIL = "email"
|
|
2908
|
+
|
|
2909
|
+
VALUES = [SMS, WHATSAPP, EMAIL].freeze
|
|
2910
|
+
end
|
|
2911
|
+
|
|
2912
|
+
# SMS only: the alphabet the text is sent in. `null` once the text is erased.
|
|
2913
|
+
module MessageAttemptEncoding
|
|
2914
|
+
GSM_7 = "GSM-7"
|
|
2915
|
+
UCS_2 = "UCS-2"
|
|
2916
|
+
|
|
2917
|
+
VALUES = [GSM_7, UCS_2].freeze
|
|
2918
|
+
end
|
|
2919
|
+
|
|
2920
|
+
# Known values of an open enum: the API may send others.
|
|
2921
|
+
module MessageAttemptStatus
|
|
2922
|
+
SCHEDULED = "scheduled"
|
|
2923
|
+
QUEUED = "queued"
|
|
2924
|
+
SENDING = "sending"
|
|
2925
|
+
SENT = "sent"
|
|
2926
|
+
DELIVERED = "delivered"
|
|
2927
|
+
READ = "read"
|
|
2928
|
+
FAILED = "failed"
|
|
2929
|
+
CANCELLED = "cancelled"
|
|
2930
|
+
|
|
2931
|
+
VALUES = [SCHEDULED, QUEUED, SENDING, SENT, DELIVERED, READ, FAILED, CANCELLED].freeze
|
|
2932
|
+
end
|
|
2933
|
+
|
|
2934
|
+
# The channel of the latest attempt.
|
|
2935
|
+
module MessageChannel
|
|
2936
|
+
SMS = "sms"
|
|
2937
|
+
WHATSAPP = "whatsapp"
|
|
2938
|
+
EMAIL = "email"
|
|
2939
|
+
|
|
2940
|
+
VALUES = [SMS, WHATSAPP, EMAIL].freeze
|
|
2941
|
+
end
|
|
2942
|
+
|
|
2943
|
+
# Known values of an open enum: the API may send others.
|
|
2944
|
+
module MessageChannelPriceChannel
|
|
2945
|
+
SMS = "sms"
|
|
2946
|
+
WHATSAPP = "whatsapp"
|
|
2947
|
+
EMAIL = "email"
|
|
2948
|
+
|
|
2949
|
+
VALUES = [SMS, WHATSAPP, EMAIL].freeze
|
|
2950
|
+
end
|
|
2951
|
+
|
|
2952
|
+
# Known values of an open enum: the API may send others.
|
|
2953
|
+
module MessageChannelPriceUnit
|
|
2954
|
+
SEGMENT = "segment"
|
|
2955
|
+
MESSAGE = "message"
|
|
2956
|
+
|
|
2957
|
+
VALUES = [SEGMENT, MESSAGE].freeze
|
|
2958
|
+
end
|
|
2959
|
+
|
|
2960
|
+
# Known values of an open enum: the API may send others.
|
|
2961
|
+
module MessageChannels
|
|
2962
|
+
SMS = "sms"
|
|
2963
|
+
WHATSAPP = "whatsapp"
|
|
2964
|
+
EMAIL = "email"
|
|
2965
|
+
|
|
2966
|
+
VALUES = [SMS, WHATSAPP, EMAIL].freeze
|
|
2967
|
+
end
|
|
2968
|
+
|
|
2969
|
+
# Known values of an open enum: the API may send others.
|
|
2970
|
+
module MessageEncoding
|
|
2971
|
+
GSM_7 = "GSM-7"
|
|
2972
|
+
UCS_2 = "UCS-2"
|
|
2973
|
+
|
|
2974
|
+
VALUES = [GSM_7, UCS_2].freeze
|
|
2358
2975
|
end
|
|
2359
2976
|
|
|
2360
|
-
#
|
|
2361
|
-
|
|
2362
|
-
|
|
2363
|
-
|
|
2977
|
+
# `invalid_recipient`: the address is not valid for the channel, or the number has no account on it.
|
|
2978
|
+
# `unreachable`: the carrier could not reach the device. `rejected`: the carrier or platform refused the message.
|
|
2979
|
+
# `opted_out`: the recipient opted out of the channel. `expired`: `expires_at` passed before it could go out.
|
|
2980
|
+
# `template_required`: WhatsApp only delivers an approved WhatsApp template. `channel_unavailable`: the channel is
|
|
2981
|
+
# switched off, not configured, not in your contract or locked until your first top-up. `insufficient_credits`:
|
|
2982
|
+
# the balance does not cover it. `rate_limited`: throttled and retries ran out. `delivery_unconfirmed`: the
|
|
2983
|
+
# outcome is unknown and it is not sent again automatically. `cancelled`: cancelled before its time.
|
|
2984
|
+
# `template_channel_missing`, `template_variable_missing`, `empty_body`, `body_too_long`: the content cannot go
|
|
2985
|
+
# out on this channel. `unknown`: any other failure.
|
|
2986
|
+
module MessageErrorCode
|
|
2987
|
+
INVALID_RECIPIENT = "invalid_recipient"
|
|
2988
|
+
UNREACHABLE = "unreachable"
|
|
2989
|
+
REJECTED = "rejected"
|
|
2990
|
+
OPTED_OUT = "opted_out"
|
|
2991
|
+
EXPIRED = "expired"
|
|
2992
|
+
TEMPLATE_REQUIRED = "template_required"
|
|
2993
|
+
CHANNEL_UNAVAILABLE = "channel_unavailable"
|
|
2994
|
+
INSUFFICIENT_CREDITS = "insufficient_credits"
|
|
2995
|
+
RATE_LIMITED = "rate_limited"
|
|
2996
|
+
DELIVERY_UNCONFIRMED = "delivery_unconfirmed"
|
|
2997
|
+
CANCELLED = "cancelled"
|
|
2998
|
+
TEMPLATE_CHANNEL_MISSING = "template_channel_missing"
|
|
2999
|
+
TEMPLATE_VARIABLE_MISSING = "template_variable_missing"
|
|
3000
|
+
EMPTY_BODY = "empty_body"
|
|
3001
|
+
BODY_TOO_LONG = "body_too_long"
|
|
3002
|
+
UNKNOWN = "unknown"
|
|
2364
3003
|
|
|
2365
|
-
VALUES = [
|
|
3004
|
+
VALUES = [INVALID_RECIPIENT, UNREACHABLE, REJECTED, OPTED_OUT, EXPIRED, TEMPLATE_REQUIRED, CHANNEL_UNAVAILABLE, INSUFFICIENT_CREDITS, RATE_LIMITED, DELIVERY_UNCONFIRMED, CANCELLED, TEMPLATE_CHANNEL_MISSING, TEMPLATE_VARIABLE_MISSING, EMPTY_BODY, BODY_TOO_LONG, UNKNOWN].freeze
|
|
2366
3005
|
end
|
|
2367
3006
|
|
|
2368
|
-
#
|
|
2369
|
-
|
|
2370
|
-
|
|
3007
|
+
# `scheduled`: waiting for `schedule_at`. `queued`: accepted, waiting to go out. `sending`: being handed to the
|
|
3008
|
+
# carrier. `sent`: the carrier or platform accepted it. `delivered`: delivered to the device or inbox. `read`: a
|
|
3009
|
+
# WhatsApp read receipt or an email open. `failed`: not delivered, see `error`. `cancelled`: cancelled before its
|
|
3010
|
+
# time.
|
|
3011
|
+
module MessageStatus
|
|
3012
|
+
SCHEDULED = "scheduled"
|
|
3013
|
+
QUEUED = "queued"
|
|
3014
|
+
SENDING = "sending"
|
|
3015
|
+
SENT = "sent"
|
|
3016
|
+
DELIVERED = "delivered"
|
|
3017
|
+
READ = "read"
|
|
3018
|
+
FAILED = "failed"
|
|
3019
|
+
CANCELLED = "cancelled"
|
|
2371
3020
|
|
|
2372
|
-
VALUES = [
|
|
3021
|
+
VALUES = [SCHEDULED, QUEUED, SENDING, SENT, DELIVERED, READ, FAILED, CANCELLED].freeze
|
|
2373
3022
|
end
|
|
2374
3023
|
|
|
2375
3024
|
# Event category.
|
|
@@ -6966,8 +7615,25 @@ module Didit
|
|
|
6966
7615
|
INVESTIGATOR_SLA_BREACHED = "investigator.sla.breached"
|
|
6967
7616
|
INVESTIGATOR_QA_FAILED = "investigator.qa.failed"
|
|
6968
7617
|
INVESTIGATOR_EXTERNAL_REPORT_READY = "investigator.external.report.ready"
|
|
6969
|
-
|
|
6970
|
-
|
|
7618
|
+
BANK_LINK_COMPLETED = "bank.link.completed"
|
|
7619
|
+
BANK_LINK_CANCELLED = "bank.link.cancelled"
|
|
7620
|
+
BANK_LINK_EXPIRED = "bank.link.expired"
|
|
7621
|
+
BANK_LINK_FAILED = "bank.link.failed"
|
|
7622
|
+
BANK_CONNECTION_CREATED = "bank.connection.created"
|
|
7623
|
+
BANK_CONNECTION_UPDATED = "bank.connection.updated"
|
|
7624
|
+
BANK_CONNECTION_CONSENT_EXPIRING = "bank.connection.consent_expiring"
|
|
7625
|
+
BANK_CONNECTION_RENEWAL_REQUIRED = "bank.connection.renewal_required"
|
|
7626
|
+
BANK_CONNECTION_RENEWED = "bank.connection.renewed"
|
|
7627
|
+
BANK_CONNECTION_REVOKED = "bank.connection.revoked"
|
|
7628
|
+
BANK_CONNECTION_DELETED = "bank.connection.deleted"
|
|
7629
|
+
BANK_CONNECTION_HISTORY_COMPLETE = "bank.connection.history_complete"
|
|
7630
|
+
BANK_DATA_UPDATED = "bank.data.updated"
|
|
7631
|
+
BANK_SYNC_COMPLETED = "bank.sync.completed"
|
|
7632
|
+
BANK_SYNC_FAILED = "bank.sync.failed"
|
|
7633
|
+
BANK_SYNC_RECOVERED = "bank.sync.recovered"
|
|
7634
|
+
MESSAGE_STATUS_UPDATED = "message.status.updated"
|
|
7635
|
+
|
|
7636
|
+
VALUES = [STATUS_UPDATED, DATA_UPDATED, USER_STATUS_UPDATED, USER_DATA_UPDATED, BUSINESS_STATUS_UPDATED, BUSINESS_DATA_UPDATED, ACTIVITY_CREATED, TRANSACTION_CREATED, TRANSACTION_STATUS_UPDATED, TRAVEL_RULE_STATUS_UPDATED, WORKFLOW_COMPLIANCE_CHANGED, TRANSACTION_RULE_SUGGESTIONS_CREATED, AUTH_SIGNUP, AUTH_LOGIN, AUTH_LOGIN_FAILED, AUTH_PASSWORD_RESET_REQUESTED, AUTH_PASSWORD_RESET_COMPLETED, AUTH_MFA_CHANGED, AUTH_NEW_DEVICE, AUTH_ACCOUNT_LOCKED, INVESTIGATOR_REPORT_READY, INVESTIGATOR_DECISION_AUTOMATED, INVESTIGATOR_DECISION_OVERRIDDEN, INVESTIGATOR_DECISION_CONTESTED, INVESTIGATOR_QUESTION_RAISED, INVESTIGATOR_AUTOMATION_PAUSED, INVESTIGATOR_RFI_ANSWERED, INVESTIGATOR_RFI_OVERDUE, INVESTIGATOR_DRIFT_DETECTED, INVESTIGATOR_SLA_BREACHED, INVESTIGATOR_QA_FAILED, INVESTIGATOR_EXTERNAL_REPORT_READY, BANK_LINK_COMPLETED, BANK_LINK_CANCELLED, BANK_LINK_EXPIRED, BANK_LINK_FAILED, BANK_CONNECTION_CREATED, BANK_CONNECTION_UPDATED, BANK_CONNECTION_CONSENT_EXPIRING, BANK_CONNECTION_RENEWAL_REQUIRED, BANK_CONNECTION_RENEWED, BANK_CONNECTION_REVOKED, BANK_CONNECTION_DELETED, BANK_CONNECTION_HISTORY_COMPLETE, BANK_DATA_UPDATED, BANK_SYNC_COMPLETED, BANK_SYNC_FAILED, BANK_SYNC_RECOVERED, MESSAGE_STATUS_UPDATED].freeze
|
|
6971
7637
|
end
|
|
6972
7638
|
|
|
6973
7639
|
# Draft versions are editable; published versions are immutable and used for new sessions.
|
|
@@ -7739,6 +8405,26 @@ module Didit
|
|
|
7739
8405
|
field :status, "status", [:map, :integer]
|
|
7740
8406
|
end
|
|
7741
8407
|
|
|
8408
|
+
# One account inside a connection.
|
|
8409
|
+
class BankAccount < Didit::Model
|
|
8410
|
+
field :id, "id", :string
|
|
8411
|
+
field :connection_id, "connection_id", :string
|
|
8412
|
+
field :name, "name", :string
|
|
8413
|
+
field :product, "product", :string
|
|
8414
|
+
field :type, "type", :string
|
|
8415
|
+
field :usage, "usage", :string
|
|
8416
|
+
field :currency, "currency", :string
|
|
8417
|
+
field :holder_name, "holder_name", :string
|
|
8418
|
+
field :holders, "holders", [:array, "BankAccountHolder"]
|
|
8419
|
+
field :identifiers, "identifiers", "BankAccountIdentifiers"
|
|
8420
|
+
field :account_ref, "account_ref", :string
|
|
8421
|
+
field :account_ref_previous, "account_ref_previous", :string
|
|
8422
|
+
field :status, "status", :string
|
|
8423
|
+
field :scopes_granted, "scopes_granted", [:array, :string]
|
|
8424
|
+
field :sync, "sync", "BankAccountSync"
|
|
8425
|
+
field :history_coverage, "history_coverage", "BankHistoryCoverage"
|
|
8426
|
+
end
|
|
8427
|
+
|
|
7742
8428
|
# Account check: the person types their account number and Didit checks it with the bank. Priced per country.
|
|
7743
8429
|
class BankAccountCheckPricing < Didit::Model
|
|
7744
8430
|
field :available, "available", :boolean
|
|
@@ -7755,12 +8441,300 @@ module Didit
|
|
|
7755
8441
|
field :created_at, "created_at", :datetime
|
|
7756
8442
|
end
|
|
7757
8443
|
|
|
8444
|
+
class BankAccountHolder < Didit::Model
|
|
8445
|
+
field :name, "name", :string
|
|
8446
|
+
field :role, "role", :string
|
|
8447
|
+
end
|
|
8448
|
+
|
|
8449
|
+
# Full identifiers, returned to server-side callers with the bank data permission.
|
|
8450
|
+
class BankAccountIdentifiers < Didit::Model
|
|
8451
|
+
field :iban, "iban", :string
|
|
8452
|
+
field :bic, "bic", :string
|
|
8453
|
+
field :account_number, "account_number", :string
|
|
8454
|
+
field :sort_code, "sort_code", :string
|
|
8455
|
+
field :other, "other", [:array, "BankAccountIdentifiersOther"]
|
|
8456
|
+
end
|
|
8457
|
+
|
|
8458
|
+
class BankAccountIdentifiersOther < Didit::Model
|
|
8459
|
+
field :scheme, "scheme", :string
|
|
8460
|
+
field :value, "value", :string
|
|
8461
|
+
end
|
|
8462
|
+
|
|
8463
|
+
class BankAccountList < Didit::Model
|
|
8464
|
+
field :items, "items", [:array, "BankAccount"]
|
|
8465
|
+
field :next_cursor, "next_cursor", :string
|
|
8466
|
+
end
|
|
8467
|
+
|
|
8468
|
+
class BankAccountSync < Didit::Model
|
|
8469
|
+
field :last_synced_at, "last_synced_at", :datetime
|
|
8470
|
+
field :status, "status", :string
|
|
8471
|
+
field :history_requested_from, "history_requested_from", :date
|
|
8472
|
+
field :history_available_from, "history_available_from", :date
|
|
8473
|
+
field :pending_supported, "pending_supported", :boolean
|
|
8474
|
+
end
|
|
8475
|
+
|
|
8476
|
+
class BankBalance < Didit::Model
|
|
8477
|
+
field :type, "type", :string
|
|
8478
|
+
field :iso_type, "iso_type", :string
|
|
8479
|
+
field :amount, "amount", :string
|
|
8480
|
+
field :currency, "currency", :string
|
|
8481
|
+
field :reference_date, "reference_date", :date
|
|
8482
|
+
field :last_change_at, "last_change_at", :datetime
|
|
8483
|
+
field :credit_limit_included, "credit_limit_included", :boolean
|
|
8484
|
+
end
|
|
8485
|
+
|
|
8486
|
+
# Typed balances of an account.
|
|
8487
|
+
class BankBalances < Didit::Model
|
|
8488
|
+
field :account_id, "account_id", :string
|
|
8489
|
+
field :balances, "balances", [:array, "BankBalance"]
|
|
8490
|
+
field :last_synced_at, "last_synced_at", :datetime
|
|
8491
|
+
end
|
|
8492
|
+
|
|
8493
|
+
# The person's permission for your application to read one bank. A renewal keeps the connection id and every
|
|
8494
|
+
# account id. A deleted connection answers only `id`, `status`, `status_reason`, `created_at` and `erasure`: every
|
|
8495
|
+
# other field is absent, and no bank, person or account data remains in it.
|
|
8496
|
+
class BankConnection < Didit::Model
|
|
8497
|
+
field :id, "id", :string
|
|
8498
|
+
field :environment, "environment", :string
|
|
8499
|
+
field :access, "access", :string
|
|
8500
|
+
field :status, "status", :string
|
|
8501
|
+
field :status_reason, "status_reason", :string
|
|
8502
|
+
field :institution, "institution", "BankInstitutionSummary"
|
|
8503
|
+
field :segment, "segment", :string
|
|
8504
|
+
field :data, "data", [:array, :string]
|
|
8505
|
+
field :consent, "consent", "BankConnectionConsent"
|
|
8506
|
+
field :sync, "sync", "BankConnectionSync"
|
|
8507
|
+
field :accounts, "accounts", [:array, "BankConnectionAccountSummary"]
|
|
8508
|
+
field :ownership, "ownership", "BankConnectionOwnership"
|
|
8509
|
+
field :end_user, "end_user", "BankConnectionEndUser"
|
|
8510
|
+
field :manage_url, "manage_url", :string
|
|
8511
|
+
field :billing, "billing", "BankConnectionBilling"
|
|
8512
|
+
field :possible_duplicate_of, "possible_duplicate_of", :string
|
|
8513
|
+
field :erasure, "erasure", "BankConnectionErasure"
|
|
8514
|
+
field :vendor_data, "vendor_data", :string
|
|
8515
|
+
field :created_at, "created_at", :datetime
|
|
8516
|
+
field :updated_at, "updated_at", :datetime
|
|
8517
|
+
end
|
|
8518
|
+
|
|
8519
|
+
# Short form of an account inside a connection.
|
|
8520
|
+
class BankConnectionAccountSummary < Didit::Model
|
|
8521
|
+
field :id, "id", :string
|
|
8522
|
+
field :name, "name", :string
|
|
8523
|
+
field :type, "type", :string
|
|
8524
|
+
field :usage, "usage", :string
|
|
8525
|
+
field :currency, "currency", :string
|
|
8526
|
+
field :iban_last4, "iban_last4", :string
|
|
8527
|
+
field :status, "status", :string
|
|
8528
|
+
end
|
|
8529
|
+
|
|
8530
|
+
# What this connection costs. Sandbox is never charged.
|
|
8531
|
+
class BankConnectionBilling < Didit::Model
|
|
8532
|
+
field :unit, "unit", :string
|
|
8533
|
+
field :price_usd, "price_usd", :string
|
|
8534
|
+
field :billed_through, "billed_through", :date
|
|
8535
|
+
end
|
|
8536
|
+
|
|
8537
|
+
# The person's consent for this connection.
|
|
8538
|
+
class BankConnectionConsent < Didit::Model
|
|
8539
|
+
field :status, "status", :string
|
|
8540
|
+
field :version, "version", :integer
|
|
8541
|
+
field :granted_at, "granted_at", :datetime
|
|
8542
|
+
field :expires_at, "expires_at", :datetime
|
|
8543
|
+
field :days_granted, "days_granted", :integer
|
|
8544
|
+
field :renewed_count, "renewed_count", :integer
|
|
8545
|
+
field :scopes_requested, "scopes_requested", [:array, :string]
|
|
8546
|
+
field :scopes_granted, "scopes_granted", [:array, :string]
|
|
8547
|
+
field :accounts_granted, "accounts_granted", [:array, :string]
|
|
8548
|
+
field :renewal_action, "renewal_action", :string
|
|
8549
|
+
field :renew_by, "renew_by", :datetime
|
|
8550
|
+
field :reconfirm_by, "reconfirm_by", :datetime
|
|
8551
|
+
field :renewable_until, "renewable_until", :datetime
|
|
8552
|
+
field :retain_until, "retain_until", :datetime
|
|
8553
|
+
field :ended_at, "ended_at", :datetime
|
|
8554
|
+
field :ended_by, "ended_by", :string
|
|
8555
|
+
end
|
|
8556
|
+
|
|
8557
|
+
# Accepted deletion. The connection's bank data is being deleted and its data operations answer `409
|
|
8558
|
+
# connection_not_active`; reading the connection returns a minimal record with this `erasure` status.
|
|
8559
|
+
class BankConnectionDeletion < Didit::Model
|
|
8560
|
+
field :id, "id", :string
|
|
8561
|
+
field :erasure, "erasure", "BankConnectionErasure"
|
|
8562
|
+
end
|
|
8563
|
+
|
|
8564
|
+
class BankConnectionEndUser < Didit::Model
|
|
8565
|
+
field :reference, "reference", :string
|
|
8566
|
+
end
|
|
8567
|
+
|
|
8568
|
+
# Progress of a deletion you asked for.
|
|
8569
|
+
class BankConnectionErasure < Didit::Model
|
|
8570
|
+
field :status, "status", :string
|
|
8571
|
+
field :requested_at, "requested_at", :datetime
|
|
8572
|
+
field :erased_at, "erased_at", :datetime
|
|
8573
|
+
end
|
|
8574
|
+
|
|
8575
|
+
# A page of connections.
|
|
8576
|
+
class BankConnectionList < Didit::Model
|
|
8577
|
+
field :items, "items", [:array, "BankConnection"]
|
|
8578
|
+
field :next_cursor, "next_cursor", :string
|
|
8579
|
+
end
|
|
8580
|
+
|
|
8581
|
+
# The optional comparison of the account holder with a person or company.
|
|
8582
|
+
class BankConnectionOwnership < Didit::Model
|
|
8583
|
+
field :compare, "compare", :string
|
|
8584
|
+
field :match, "match", :string
|
|
8585
|
+
field :check_id, "check_id", :string
|
|
8586
|
+
field :result, "result", :string
|
|
8587
|
+
end
|
|
8588
|
+
|
|
8589
|
+
# Synchronisation state of a connection.
|
|
8590
|
+
class BankConnectionSync < Didit::Model
|
|
8591
|
+
field :status, "status", :string
|
|
8592
|
+
field :initial_status, "initial_status", :string
|
|
8593
|
+
field :initial_complete, "initial_complete", :boolean
|
|
8594
|
+
field :history_complete, "history_complete", :boolean
|
|
8595
|
+
field :last_synced_at, "last_synced_at", :datetime
|
|
8596
|
+
field :next_sync_at, "next_sync_at", :datetime
|
|
8597
|
+
field :budgets, "budgets", [:array, "BankSyncBudget"]
|
|
8598
|
+
field :last_error, "last_error", "BankSyncError"
|
|
8599
|
+
field :frequency_per_day, "frequency_per_day", :integer
|
|
8600
|
+
field :live_syncs_left_today, "live_syncs_left_today", :integer
|
|
8601
|
+
end
|
|
8602
|
+
|
|
8603
|
+
# Bank data coverage per country. Ongoing access is counted only where a bank is switched on for it.
|
|
8604
|
+
class BankCoverage < Didit::Model
|
|
8605
|
+
field :items, "items", [:array, "BankCoverageCountry"]
|
|
8606
|
+
end
|
|
8607
|
+
|
|
8608
|
+
class BankCoverageCountry < Didit::Model
|
|
8609
|
+
field :country, "country", :string
|
|
8610
|
+
field :name, "name", :string
|
|
8611
|
+
field :sign_in_available, "sign_in_available", :boolean
|
|
8612
|
+
field :account_check_available, "account_check_available", :boolean
|
|
8613
|
+
field :ongoing_access, "ongoing_access", :boolean
|
|
8614
|
+
field :institutions, "institutions", :integer
|
|
8615
|
+
field :ongoing_institutions, "ongoing_institutions", :integer
|
|
8616
|
+
field :consent_days_max, "consent_days_max", :integer
|
|
8617
|
+
field :history_days_max, "history_days_max", :integer
|
|
8618
|
+
field :business_accounts, "business_accounts", :boolean
|
|
8619
|
+
end
|
|
8620
|
+
|
|
8621
|
+
class BankDateRange < Didit::Model
|
|
8622
|
+
field :from, "from", :date
|
|
8623
|
+
field :to, "to", :date
|
|
8624
|
+
end
|
|
8625
|
+
|
|
8626
|
+
# What the bank delivered of the history you asked for.
|
|
8627
|
+
class BankHistoryCoverage < Didit::Model
|
|
8628
|
+
field :requested_from, "requested_from", :date
|
|
8629
|
+
field :oldest_booking_date, "oldest_booking_date", :date
|
|
8630
|
+
field :covered_ranges, "covered_ranges", [:array, "BankDateRange"]
|
|
8631
|
+
field :missing_ranges, "missing_ranges", [:array, "BankDateRange"]
|
|
8632
|
+
field :status, "status", :string
|
|
8633
|
+
field :extended_auth_used, "extended_auth_used", :boolean
|
|
8634
|
+
end
|
|
8635
|
+
|
|
8636
|
+
# A bank and what it supports. Values come from observed capability data, refreshed daily; a value never observed
|
|
8637
|
+
# is `null`, not a guess.
|
|
8638
|
+
class BankInstitution < Didit::Model
|
|
8639
|
+
field :id, "id", :string
|
|
8640
|
+
field :name, "name", :string
|
|
8641
|
+
field :country, "country", :string
|
|
8642
|
+
field :logo_url, "logo_url", :string
|
|
8643
|
+
field :timezone, "timezone", :string
|
|
8644
|
+
field :segments, "segments", [:array, :string]
|
|
8645
|
+
field :access, "access", [:array, :string]
|
|
8646
|
+
field :ongoing_access, "ongoing_access", :boolean
|
|
8647
|
+
field :consent_days_max, "consent_days_max", :integer
|
|
8648
|
+
field :history_days_max, "history_days_max", :integer
|
|
8649
|
+
field :pending_transactions, "pending_transactions", :boolean
|
|
8650
|
+
field :pending_linkage, "pending_linkage", :boolean
|
|
8651
|
+
field :balance_types, "balance_types", [:array, :string]
|
|
8652
|
+
field :transaction_fields, "transaction_fields", [:array, :string]
|
|
8653
|
+
field :sign_in, "sign_in", :string
|
|
8654
|
+
field :requires_end_user_email, "requires_end_user_email", :boolean
|
|
8655
|
+
field :corporate_accounts, "corporate_accounts", :boolean
|
|
8656
|
+
field :bank_account_selection, "bank_account_selection", :boolean
|
|
8657
|
+
field :separate_history_consent, "separate_history_consent", :boolean
|
|
8658
|
+
field :reconfirmation, "reconfirmation", :boolean
|
|
8659
|
+
field :sync_frequency_hours, "sync_frequency_hours", :integer
|
|
8660
|
+
field :health, "health", :string
|
|
8661
|
+
end
|
|
8662
|
+
|
|
8663
|
+
class BankInstitutionList < Didit::Model
|
|
8664
|
+
field :items, "items", [:array, "BankInstitution"]
|
|
8665
|
+
field :next_cursor, "next_cursor", :string
|
|
8666
|
+
end
|
|
8667
|
+
|
|
8668
|
+
# The bank a connection or link is for.
|
|
8669
|
+
class BankInstitutionSummary < Didit::Model
|
|
8670
|
+
field :id, "id", :string
|
|
8671
|
+
field :name, "name", :string
|
|
8672
|
+
field :country, "country", :string
|
|
8673
|
+
field :logo_url, "logo_url", :string
|
|
8674
|
+
end
|
|
8675
|
+
|
|
8676
|
+
# One run of Bank Link for one person: connect a bank, or renew a connection. Confirm a link yourself with
|
|
8677
|
+
# `get_link`: never trust an id sent by the browser.
|
|
8678
|
+
class BankLink < Didit::Model
|
|
8679
|
+
field :id, "id", :string
|
|
8680
|
+
field :mode, "mode", :string
|
|
8681
|
+
field :access, "access", :string
|
|
8682
|
+
field :status, "status", :string
|
|
8683
|
+
field :url, "url", :string
|
|
8684
|
+
field :client_token, "client_token", :string
|
|
8685
|
+
field :expires_at, "expires_at", :datetime
|
|
8686
|
+
field :connection_id, "connection_id", :string
|
|
8687
|
+
field :check_id, "check_id", :string
|
|
8688
|
+
field :reused, "reused", :boolean
|
|
8689
|
+
field :error, "error", "BankLinkError"
|
|
8690
|
+
field :quote, "quote", "BankLinkQuote"
|
|
8691
|
+
field :vendor_data, "vendor_data", :string
|
|
8692
|
+
end
|
|
8693
|
+
|
|
8694
|
+
# The reason a link ended `failed`. Nothing was published or charged.
|
|
8695
|
+
class BankLinkError < Didit::Model
|
|
8696
|
+
field :code, "code", :string
|
|
8697
|
+
field :message, "message", :string
|
|
8698
|
+
field :conflicts_with, "conflicts_with", [:array, :string]
|
|
8699
|
+
end
|
|
8700
|
+
|
|
8701
|
+
# The price of a link, pinned when it is created. The price charged is the quote's. Reads never bill.
|
|
8702
|
+
class BankLinkQuote < Didit::Model
|
|
8703
|
+
field :id, "id", :string
|
|
8704
|
+
field :lines, "lines", [:array, "BankLinkQuoteLine"]
|
|
8705
|
+
field :fallback_lines, "fallback_lines", [:array, "BankLinkQuoteLine"]
|
|
8706
|
+
field :total_usd, "total_usd", :string
|
|
8707
|
+
field :valid_until, "valid_until", :datetime
|
|
8708
|
+
field :scopes, "scopes", [:array, :string]
|
|
8709
|
+
end
|
|
8710
|
+
|
|
8711
|
+
# One priced line of a quote.
|
|
8712
|
+
class BankLinkQuoteLine < Didit::Model
|
|
8713
|
+
field :meter, "meter", :string
|
|
8714
|
+
field :unit, "unit", :string
|
|
8715
|
+
field :price_usd, "price_usd", :string
|
|
8716
|
+
end
|
|
8717
|
+
|
|
8718
|
+
# A refresh was accepted. A second call while a sync runs returns the same `sync_id`.
|
|
8719
|
+
class BankRefreshAccepted < Didit::Model
|
|
8720
|
+
field :sync_id, "sync_id", :string
|
|
8721
|
+
field :status, "status", :string
|
|
8722
|
+
field :next_refresh_at, "next_refresh_at", :datetime
|
|
8723
|
+
end
|
|
8724
|
+
|
|
8725
|
+
class BankRemovedTransaction < Didit::Model
|
|
8726
|
+
field :id, "id", :string
|
|
8727
|
+
field :reason, "reason", :string
|
|
8728
|
+
end
|
|
8729
|
+
|
|
7758
8730
|
# Bank sign-in: the person signs in to their bank. Priced by market, the same for every bank in it.
|
|
7759
8731
|
class BankSignInPricing < Didit::Model
|
|
7760
8732
|
field :available, "available", :boolean
|
|
7761
8733
|
field :market, "market", :string
|
|
7762
8734
|
field :price_usd, "price_usd", :string
|
|
7763
8735
|
field :add_ons, "add_ons", "BankSignInPricingAddOns"
|
|
8736
|
+
field :ongoing, "ongoing", "BankSignInPricingOngoing"
|
|
8737
|
+
field :one_time_data, "one_time_data", "BankSignInPricingOneTimeData"
|
|
7764
8738
|
end
|
|
7765
8739
|
|
|
7766
8740
|
# Add-ons priced in this country, each a decimal string with 4 decimals in USD, added to the bank sign-in price.
|
|
@@ -7770,6 +8744,18 @@ module Didit
|
|
|
7770
8744
|
field :transactions, "transactions", :string
|
|
7771
8745
|
end
|
|
7772
8746
|
|
|
8747
|
+
class BankSignInPricingOneTimeData < Didit::Model
|
|
8748
|
+
field :balances_usd, "balances_usd", :string
|
|
8749
|
+
field :transactions_usd, "transactions_usd", :string
|
|
8750
|
+
field :bundle_included, "bundle_included", :boolean
|
|
8751
|
+
end
|
|
8752
|
+
|
|
8753
|
+
# Ongoing access to bank data (Bank Link `access: ongoing`). Present only where Bank data is switched on.
|
|
8754
|
+
class BankSignInPricingOngoing < Didit::Model
|
|
8755
|
+
field :available, "available", :boolean
|
|
8756
|
+
field :price_usd_per_month, "price_usd_per_month", :string
|
|
8757
|
+
end
|
|
8758
|
+
|
|
7773
8759
|
# How the bank statement upload is priced.
|
|
7774
8760
|
class BankStatementUploadPricing < Didit::Model
|
|
7775
8761
|
field :price_usd, "price_usd", :string
|
|
@@ -7777,6 +8763,135 @@ module Didit
|
|
|
7777
8763
|
field :standalone_available, "standalone_available", :boolean
|
|
7778
8764
|
end
|
|
7779
8765
|
|
|
8766
|
+
# One bucket of the bank's limit on fetches without the person present.
|
|
8767
|
+
class BankSyncBudget < Didit::Model
|
|
8768
|
+
field :scope, "scope", :string
|
|
8769
|
+
field :resource, "resource", :string
|
|
8770
|
+
field :account_id, "account_id", :string
|
|
8771
|
+
field :limit, "limit", :integer
|
|
8772
|
+
field :remaining, "remaining", :integer
|
|
8773
|
+
field :resets_at, "resets_at", :datetime
|
|
8774
|
+
end
|
|
8775
|
+
|
|
8776
|
+
# Why a sync failed.
|
|
8777
|
+
class BankSyncError < Didit::Model
|
|
8778
|
+
field :code, "code", :string
|
|
8779
|
+
field :message, "message", :string
|
|
8780
|
+
field :at, "at", :datetime
|
|
8781
|
+
end
|
|
8782
|
+
|
|
8783
|
+
# One synchronisation of a connection. Only initial, scheduled and requested syncs are listed.
|
|
8784
|
+
class BankSyncRun < Didit::Model
|
|
8785
|
+
field :id, "id", :string
|
|
8786
|
+
field :connection_id, "connection_id", :string
|
|
8787
|
+
field :trigger, "trigger", :string
|
|
8788
|
+
field :status, "status", :string
|
|
8789
|
+
field :started_at, "started_at", :datetime
|
|
8790
|
+
field :finished_at, "finished_at", :datetime
|
|
8791
|
+
field :results, "results", [:array, "BankSyncRunResult"]
|
|
8792
|
+
field :error, "error", "BankSyncRunError"
|
|
8793
|
+
end
|
|
8794
|
+
|
|
8795
|
+
# A finished sync returned by a refresh with `wait`: the sync run with its `outcome`, the per-account counts in
|
|
8796
|
+
# `results` and `balances_changed`.
|
|
8797
|
+
class BankSyncCompleted < BankSyncRun
|
|
8798
|
+
field :outcome, "outcome", :string
|
|
8799
|
+
field :balances_changed, "balances_changed", :boolean
|
|
8800
|
+
end
|
|
8801
|
+
|
|
8802
|
+
# Why the run failed as a whole. `null` when it did not. Errors of single accounts and resources are in `results`.
|
|
8803
|
+
class BankSyncRunError < Didit::Model
|
|
8804
|
+
field :code, "code", :string
|
|
8805
|
+
field :message, "message", :string
|
|
8806
|
+
field :at, "at", :datetime
|
|
8807
|
+
end
|
|
8808
|
+
|
|
8809
|
+
class BankSyncRunList < Didit::Model
|
|
8810
|
+
field :items, "items", [:array, "BankSyncRun"]
|
|
8811
|
+
field :next_cursor, "next_cursor", :string
|
|
8812
|
+
end
|
|
8813
|
+
|
|
8814
|
+
class BankSyncRunResult < Didit::Model
|
|
8815
|
+
field :account_id, "account_id", :string
|
|
8816
|
+
field :resource, "resource", :string
|
|
8817
|
+
field :outcome, "outcome", :string
|
|
8818
|
+
field :added, "added", :integer
|
|
8819
|
+
field :modified, "modified", :integer
|
|
8820
|
+
field :removed, "removed", :integer
|
|
8821
|
+
field :error, "error", "BankSyncError"
|
|
8822
|
+
end
|
|
8823
|
+
|
|
8824
|
+
# One movement of an account. Any field the bank does not send is `null`; the institution capabilities list which
|
|
8825
|
+
# fields a bank is known to send.
|
|
8826
|
+
class BankTransaction < Didit::Model
|
|
8827
|
+
field :id, "id", :string
|
|
8828
|
+
field :account_id, "account_id", :string
|
|
8829
|
+
field :status, "status", :string
|
|
8830
|
+
field :pending_id, "pending_id", :string
|
|
8831
|
+
field :reverses_id, "reverses_id", :string
|
|
8832
|
+
field :booking_date, "booking_date", :date
|
|
8833
|
+
field :value_date, "value_date", :date
|
|
8834
|
+
field :transaction_date, "transaction_date", :date
|
|
8835
|
+
field :effective_date, "effective_date", :date
|
|
8836
|
+
field :amount, "amount", :string
|
|
8837
|
+
field :currency, "currency", :string
|
|
8838
|
+
field :direction, "direction", :string
|
|
8839
|
+
field :description, "description", :string
|
|
8840
|
+
field :counterparty, "counterparty", "BankTransactionCounterparty"
|
|
8841
|
+
field :remittance, "remittance", "BankTransactionRemittance"
|
|
8842
|
+
field :bank_transaction_code, "bank_transaction_code", :string
|
|
8843
|
+
field :bank_reference, "bank_reference", :string
|
|
8844
|
+
field :identity_quality, "identity_quality", :string
|
|
8845
|
+
field :end_to_end_id, "end_to_end_id", :string
|
|
8846
|
+
field :mandate_id, "mandate_id", :string
|
|
8847
|
+
field :creditor_id, "creditor_id", :string
|
|
8848
|
+
field :merchant_category_code, "merchant_category_code", :string
|
|
8849
|
+
field :exchange, "exchange", "BankTransactionExchange"
|
|
8850
|
+
field :balance_after, "balance_after", :string
|
|
8851
|
+
field :category, "category", :string
|
|
8852
|
+
field :first_seen_at, "first_seen_at", :datetime
|
|
8853
|
+
field :updated_at, "updated_at", :datetime
|
|
8854
|
+
end
|
|
8855
|
+
|
|
8856
|
+
# Changes of a connection's transactions since a cursor. An empty cursor returns every current transaction as
|
|
8857
|
+
# `added`. All pages of one read reflect the same snapshot; changes that arrive meanwhile come in the next read.
|
|
8858
|
+
class BankTransactionChanges < Didit::Model
|
|
8859
|
+
field :added, "added", [:array, "BankTransaction"]
|
|
8860
|
+
field :modified, "modified", [:array, "BankTransaction"]
|
|
8861
|
+
field :removed, "removed", [:array, "BankRemovedTransaction"]
|
|
8862
|
+
field :has_more, "has_more", :boolean
|
|
8863
|
+
field :next_page_token, "next_page_token", :string
|
|
8864
|
+
field :next_cursor, "next_cursor", :string
|
|
8865
|
+
field :reset, "reset", :boolean
|
|
8866
|
+
end
|
|
8867
|
+
|
|
8868
|
+
class BankTransactionCounterparty < Didit::Model
|
|
8869
|
+
field :name, "name", :string
|
|
8870
|
+
field :iban, "iban", :string
|
|
8871
|
+
field :bic, "bic", :string
|
|
8872
|
+
end
|
|
8873
|
+
|
|
8874
|
+
# Currency exchange details where the bank gives them.
|
|
8875
|
+
class BankTransactionExchange < Didit::Model
|
|
8876
|
+
field :source_amount, "source_amount", :string
|
|
8877
|
+
field :source_currency, "source_currency", :string
|
|
8878
|
+
field :rate, "rate", :string
|
|
8879
|
+
end
|
|
8880
|
+
|
|
8881
|
+
# A page of a date-range read. The first page pins which transactions are included and each is served in its
|
|
8882
|
+
# current state; a transaction removed while you page drops out of later pages and is reported by the change feed.
|
|
8883
|
+
class BankTransactionPage < Didit::Model
|
|
8884
|
+
field :items, "items", [:array, "BankTransaction"]
|
|
8885
|
+
field :next_page_token, "next_page_token", :string
|
|
8886
|
+
field :has_more, "has_more", :boolean
|
|
8887
|
+
end
|
|
8888
|
+
|
|
8889
|
+
class BankTransactionRemittance < Didit::Model
|
|
8890
|
+
field :unstructured, "unstructured", [:array, :string]
|
|
8891
|
+
field :structured, "structured", :string
|
|
8892
|
+
field :reference, "reference", :string
|
|
8893
|
+
end
|
|
8894
|
+
|
|
7780
8895
|
# Public Bank Verification list prices: the statement upload, the own provider key fee and each country's methods.
|
|
7781
8896
|
class BankVerificationPricing < Didit::Model
|
|
7782
8897
|
field :currency, "currency", :string
|
|
@@ -9674,6 +10789,98 @@ module Didit
|
|
|
9674
10789
|
field :section, "section", :string
|
|
9675
10790
|
end
|
|
9676
10791
|
|
|
10792
|
+
# A transactional message: its latest attempt's state, then every attempt in order. `id` is the first attempt's
|
|
10793
|
+
# id; the message is also found by any attempt's id. Statuses never move back within one attempt; a failed attempt
|
|
10794
|
+
# followed by another channel makes the message `queued` again on that channel.
|
|
10795
|
+
class Message < Didit::Model
|
|
10796
|
+
field :id, "id", :string
|
|
10797
|
+
field :status, "status", :string
|
|
10798
|
+
field :to, "to", :string
|
|
10799
|
+
field :channel, "channel", :string
|
|
10800
|
+
field :channels, "channels", [:array, :string]
|
|
10801
|
+
field :body, "body", :string
|
|
10802
|
+
field :subject, "subject", :string
|
|
10803
|
+
field :template_id, "template_id", :string
|
|
10804
|
+
field :locale, "locale", :string
|
|
10805
|
+
field :correlation_id, "correlation_id", :string
|
|
10806
|
+
field :segments, "segments", :integer
|
|
10807
|
+
field :encoding, "encoding", :string
|
|
10808
|
+
field :price, "price", "MessagePrice"
|
|
10809
|
+
field :error, "error", "MessageError"
|
|
10810
|
+
field :schedule_at, "schedule_at", :datetime
|
|
10811
|
+
field :expires_at, "expires_at", :datetime
|
|
10812
|
+
field :created_at, "created_at", :datetime
|
|
10813
|
+
field :sent_at, "sent_at", :datetime
|
|
10814
|
+
field :delivered_at, "delivered_at", :datetime
|
|
10815
|
+
field :read_at, "read_at", :datetime
|
|
10816
|
+
field :failed_at, "failed_at", :datetime
|
|
10817
|
+
field :attempts, "attempts", [:array, "MessageAttempt"]
|
|
10818
|
+
field :is_sandbox, "is_sandbox", :boolean
|
|
10819
|
+
end
|
|
10820
|
+
|
|
10821
|
+
# One channel's attempt. A channel that could not take the message is kept as a `failed` attempt that never left,
|
|
10822
|
+
# with its `error` and no price.
|
|
10823
|
+
class MessageAttempt < Didit::Model
|
|
10824
|
+
field :id, "id", :string
|
|
10825
|
+
field :channel, "channel", :string
|
|
10826
|
+
field :to, "to", :string
|
|
10827
|
+
field :status, "status", :string
|
|
10828
|
+
field :error, "error", "MessageError"
|
|
10829
|
+
field :price, "price", "MessagePrice"
|
|
10830
|
+
field :segments, "segments", :integer
|
|
10831
|
+
field :encoding, "encoding", :string
|
|
10832
|
+
field :created_at, "created_at", :datetime
|
|
10833
|
+
field :sent_at, "sent_at", :datetime
|
|
10834
|
+
field :delivered_at, "delivered_at", :datetime
|
|
10835
|
+
field :read_at, "read_at", :datetime
|
|
10836
|
+
field :failed_at, "failed_at", :datetime
|
|
10837
|
+
end
|
|
10838
|
+
|
|
10839
|
+
class MessageChannelPrice < Didit::Model
|
|
10840
|
+
field :channel, "channel", :string
|
|
10841
|
+
field :unit, "unit", :string
|
|
10842
|
+
field :category, "category", :string
|
|
10843
|
+
field :carrier, "carrier", :string
|
|
10844
|
+
field :fee, "fee", :string
|
|
10845
|
+
field :price, "price", :string
|
|
10846
|
+
end
|
|
10847
|
+
|
|
10848
|
+
# Why an attempt failed or was skipped. `message` is a sentence for people; read `code` in code.
|
|
10849
|
+
class MessageError < Didit::Model
|
|
10850
|
+
field :code, "code", :string
|
|
10851
|
+
field :message, "message", :string
|
|
10852
|
+
end
|
|
10853
|
+
|
|
10854
|
+
class MessageList < Didit::Model
|
|
10855
|
+
field :count, "count", :integer
|
|
10856
|
+
field :next, "next", :string
|
|
10857
|
+
field :previous, "previous", :string
|
|
10858
|
+
field :results, "results", [:array, "Message"]
|
|
10859
|
+
end
|
|
10860
|
+
|
|
10861
|
+
# What the message costs, in `currency`. `carrier` is the carrier's or WhatsApp's part, passed through at cost;
|
|
10862
|
+
# `fee` is Didit's fee with your plan's discount. Both are `null` when one flat amount prices the message (email,
|
|
10863
|
+
# or a contract or negotiated rate). `final` is `false` while the amount is an estimate, before the carrier's
|
|
10864
|
+
# delivery report gives the real price.
|
|
10865
|
+
class MessagePrice < Didit::Model
|
|
10866
|
+
field :amount, "amount", :string
|
|
10867
|
+
field :currency, "currency", :string
|
|
10868
|
+
field :carrier, "carrier", :string
|
|
10869
|
+
field :fee, "fee", :string
|
|
10870
|
+
field :final, "final", :boolean
|
|
10871
|
+
end
|
|
10872
|
+
|
|
10873
|
+
class MessagePrices < Didit::Model
|
|
10874
|
+
field :country, "country", :string
|
|
10875
|
+
field :currency, "currency", :string
|
|
10876
|
+
field :channels, "channels", [:array, "MessageChannelPrice"]
|
|
10877
|
+
end
|
|
10878
|
+
|
|
10879
|
+
# Your application's settings for the Messages API.
|
|
10880
|
+
class MessagesSettings < Didit::Model
|
|
10881
|
+
field :retention_days, "retention_days", :integer
|
|
10882
|
+
end
|
|
10883
|
+
|
|
9677
10884
|
# One stored monitoring event as returned by the list and subject-timeline endpoints. Restricted evidence
|
|
9678
10885
|
# (payload, device context, rule evidence) is only returned by `GET /v3/events/{event_uuid}/`.
|
|
9679
10886
|
class MonitoringEvent < Didit::Model
|