Class: PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event
- Inherits:
-
Internal::Type::BaseModel
- Object
- Internal::Type::BaseModel
- PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event
- Defined in:
- lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb,
sig/prelude_sdk/models/verification/phone/history_retrieve_response.rbs
Defined Under Namespace
Modules: Type Classes: Attempt, Check, Create, Signals
Instance Attribute Summary collapse
-
#attempt ⇒ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt?
One message sent for this verification.
-
#check ⇒ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check?
One code submission for this verification.
- #create ⇒ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Create?
- #signals ⇒ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Signals?
- #type ⇒ Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Type
Class Method Summary collapse
Instance Method Summary collapse
Methods inherited from Internal::Type::BaseModel
==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml
Methods included from Internal::Type::Converter
#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info
Methods included from Internal::Util::SorbetRuntimeSupport
#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type
Constructor Details
#initialize(created_at:, cost: nil) ⇒ Object
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 |
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 343 class Event < PreludeSDK::Internal::Type::BaseModel # @!attribute type # # @return [Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Type] required :type, enum: -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Type } # @!attribute attempt # One message sent for this verification. # # @return [PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt, nil] optional :attempt, -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt } # @!attribute check # One code submission for this verification. # # @return [PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check, nil] optional :check, -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check } # @!attribute create # # @return [PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Create, nil] optional :create, -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Create } # @!attribute signals # # @return [PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Signals, nil] optional :signals, -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Signals } # @!method initialize(type:, attempt: nil, check: nil, create: nil, signals: nil) # One timeline entry. `type` names the single payload field that is set. # # @param type [Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Type] # # @param attempt [PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt] One message sent for this verification. # # @param check [PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check] One code submission for this verification. # # @param create [PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Create] # # @param signals [PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Signals] # @see PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event#type module Type extend PreludeSDK::Internal::Type::Enum CREATE = :create ATTEMPT = :attempt CHECK = :check SIGNALS = :signals # @!method self.values # @return [Array<Symbol>] end # @see PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event#attempt class Attempt < PreludeSDK::Internal::Type::BaseModel # @!attribute id # # @return [String] required :id, String # @!attribute created_at # # @return [Time] required :created_at, Time # @!attribute carrier # The end user's mobile network. # # @return [PreludeSDK::Models::Verification::Phone::PhoneVerificationCarrier, nil] optional :carrier, -> { PreludeSDK::Verification::Phone::PhoneVerificationCarrier } # @!attribute channel # # @return [Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Channel, nil] optional :channel, enum: -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Channel } # @!attribute content # Message body. While the verification can still be completed, the code inside it # is masked rather than removed. # # @return [String, nil] optional :content, String # @!attribute cost # # @return [PreludeSDK::Models::Verification::Phone::PhoneVerificationMoney, nil] optional :cost, -> { PreludeSDK::Verification::Phone::PhoneVerificationMoney } # @!attribute delivery_events # # @return [Array<PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent>, nil] optional :delivery_events, -> { PreludeSDK::Internal::Type::ArrayOf[PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent] } # @!attribute delivery_status # # @return [Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryStatus, nil] optional :delivery_status, enum: -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryStatus } # @!attribute preferred_channel # Channel you asked for, when it differs from the one used. # # @return [Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::PreferredChannel, nil] optional :preferred_channel, enum: -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::PreferredChannel } # @!attribute status # # @return [Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Status, nil] optional :status, enum: -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Status } # @!attribute trigger # What caused the attempt. # # @return [Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Trigger, nil] optional :trigger, enum: -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Trigger } # @!method initialize(id:, created_at:, carrier: nil, channel: nil, content: nil, cost: nil, delivery_events: nil, delivery_status: nil, preferred_channel: nil, status: nil, trigger: nil) # Some parameter documentations has been truncated, see # {PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt} # for more details. # # One message sent for this verification. # # @param id [String] # # @param created_at [Time] # # @param carrier [PreludeSDK::Models::Verification::Phone::PhoneVerificationCarrier] The end user's mobile network. # # @param channel [Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Channel] # # @param content [String] Message body. While the verification can still be completed, the code inside it # # @param cost [PreludeSDK::Models::Verification::Phone::PhoneVerificationMoney] # # @param delivery_events [Array<PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent>] # # @param delivery_status [Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryStatus] # # @param preferred_channel [Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::PreferredChannel] Channel you asked for, when it differs from the one used. # # @param status [Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Status] # # @param trigger [Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::Trigger] What caused the attempt. # @see PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt#channel module Channel extend PreludeSDK::Internal::Type::Enum SMS = :sms RCS = :rcs WHATSAPP = :whatsapp VIBER = :viber ZALO = :zalo TELEGRAM = :telegram VOICE = :voice SILENT = :silent # @!method self.values # @return [Array<Symbol>] end class DeliveryEvent < PreludeSDK::Internal::Type::BaseModel # @!attribute received_at # # @return [Time] required :received_at, Time # @!attribute status # The state this event reported. It is finer-grained than the attempt's # `delivery_status` and includes the states a silent verification goes through. # # @return [Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent::Status] required :status, enum: -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent::Status } # @!method initialize(received_at:, status:) # Some parameter documentations has been truncated, see # {PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent} # for more details. # # @param received_at [Time] # # @param status [Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent::Status] The state this event reported. It is finer-grained than the attempt's # `delivery\_ # The state this event reported. It is finer-grained than the attempt's # `delivery_status` and includes the states a silent verification goes through. # # @see PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt::DeliveryEvent#status module Status extend PreludeSDK::Internal::Type::Enum UNKNOWN = :unknown SUBMITTED = :submitted IN_TRANSIT = :in_transit DELIVERED = :delivered UNDELIVERABLE = :undeliverable EXPIRED = :expired READ = :read SILENT_STARTED = :silent_started SILENT_VERIFIED = :silent_verified SILENT_MISMATCH = :silent_mismatch # @!method self.values # @return [Array<Symbol>] end end # @see PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt#delivery_status module DeliveryStatus extend PreludeSDK::Internal::Type::Enum UNKNOWN = :unknown IN_TRANSIT = :in_transit DELIVERED = :delivered UNDELIVERABLE = :undeliverable READ = :read # @!method self.values # @return [Array<Symbol>] end # Channel you asked for, when it differs from the one used. # # @see PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt#preferred_channel module PreferredChannel extend PreludeSDK::Internal::Type::Enum SMS = :sms RCS = :rcs WHATSAPP = :whatsapp VIBER = :viber ZALO = :zalo TELEGRAM = :telegram VOICE = :voice SILENT = :silent # @!method self.values # @return [Array<Symbol>] end # @see PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt#status module Status extend PreludeSDK::Internal::Type::Enum SUCCEEDED = :succeeded FAILED = :failed # @!method self.values # @return [Array<Symbol>] end # What caused the attempt. # # @see PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt#trigger module Trigger extend PreludeSDK::Internal::Type::Enum INITIAL = :initial AUTO_RETRY = :auto_retry USER_RETRY = :user_retry # @!method self.values # @return [Array<Symbol>] end end # @see PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event#check class Check < PreludeSDK::Internal::Type::BaseModel # @!attribute created_at # # @return [Time] required :created_at, Time # @!attribute is_valid # # @return [Boolean] required :is_valid, PreludeSDK::Internal::Type::Boolean # @!attribute channel # # @return [Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::Channel, nil] optional :channel, enum: -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::Channel } # @!attribute psd2_info # Present on checks against a `prelude:psd2` code. # # @return [PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::Psd2Info, nil] optional :psd2_info, -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::Psd2Info } # @!attribute status_detail # Why an invalid check failed, when known. # # @return [Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::StatusDetail, nil] optional :status_detail, enum: -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::StatusDetail } # @!attribute value # The submitted code. Absent while the verification can still be completed, so # that a check in flight cannot be read back through this endpoint, and absent on # silent verification checks, which carry no code. # # @return [String, nil] optional :value, String # @!method initialize(created_at:, is_valid:, channel: nil, psd2_info: nil, status_detail: nil, value: nil) # Some parameter documentations has been truncated, see # {PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check} # for more details. # # One code submission for this verification. # # @param created_at [Time] # # @param is_valid [Boolean] # # @param channel [Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::Channel] # # @param psd2_info [PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::Psd2Info] Present on checks against a `prelude:psd2` code. # # @param status_detail [Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::StatusDetail] Why an invalid check failed, when known. # # @param value [String] The submitted code. Absent while the verification can still be completed, so tha # @see PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check#channel module Channel extend PreludeSDK::Internal::Type::Enum SMS = :sms RCS = :rcs WHATSAPP = :whatsapp VIBER = :viber ZALO = :zalo TELEGRAM = :telegram VOICE = :voice SILENT = :silent # @!method self.values # @return [Array<Symbol>] end # @see PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check#psd2_info class Psd2Info < PreludeSDK::Internal::Type::BaseModel # @!attribute expected_transaction # The transaction submitted when the code was issued. # # @return [PreludeSDK::Models::Verification::Phone::PhoneVerificationPsd2Transaction, nil] optional :expected_transaction, -> { PreludeSDK::Verification::Phone::PhoneVerificationPsd2Transaction } # @!attribute received_transaction # The transaction submitted with this check. Differs from `expected_transaction` # when `status_detail` is `transaction_mismatch`. # # @return [PreludeSDK::Models::Verification::Phone::PhoneVerificationPsd2Transaction, nil] optional :received_transaction, -> { PreludeSDK::Verification::Phone::PhoneVerificationPsd2Transaction } # @!method initialize(expected_transaction: nil, received_transaction: nil) # Some parameter documentations has been truncated, see # {PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check::Psd2Info} # for more details. # # Present on checks against a `prelude:psd2` code. # # @param expected_transaction [PreludeSDK::Models::Verification::Phone::PhoneVerificationPsd2Transaction] The transaction submitted when the code was issued. # # @param received_transaction [PreludeSDK::Models::Verification::Phone::PhoneVerificationPsd2Transaction] The transaction submitted with this check. Differs from `expected_transaction` w end # Why an invalid check failed, when known. # # @see PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check#status_detail module StatusDetail extend PreludeSDK::Internal::Type::Enum EXPIRED_ATTEMPT = :expired_attempt EXPIRED_AUTH = :expired_auth RATE_LIMITED = :rate_limited TRANSACTION_MISSING = :transaction_missing TRANSACTION_MISMATCH = :transaction_mismatch # @!method self.values # @return [Array<Symbol>] end end # @see PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event#create class Create < PreludeSDK::Internal::Type::BaseModel # @!attribute created_at # # @return [Time] required :created_at, Time # @!attribute cost # # @return [PreludeSDK::Models::Verification::Phone::PhoneVerificationMoney, nil] optional :cost, -> { PreludeSDK::Verification::Phone::PhoneVerificationMoney } # @!method initialize(created_at:, cost: nil) # @param created_at [Time] # @param cost [PreludeSDK::Models::Verification::Phone::PhoneVerificationMoney] end # @see PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event#signals class Signals < PreludeSDK::Internal::Type::BaseModel # @!attribute received_at # # @return [Time] required :received_at, Time # @!attribute expired_at # # @return [Time, nil] optional :expired_at, Time # @!attribute status # # @return [Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Signals::Status, nil] optional :status, enum: -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Signals::Status } # @!method initialize(received_at:, expired_at: nil, status: nil) # @param received_at [Time] # @param expired_at [Time] # @param status [Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Signals::Status] # @see PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Signals#status module Status extend PreludeSDK::Internal::Type::Enum VALID = :valid INVALID = :invalid # @!method self.values # @return [Array<Symbol>] end end end |
Instance Attribute Details
#attempt ⇒ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt?
One message sent for this verification.
354 355 |
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 354 optional :attempt, -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Attempt } |
#check ⇒ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check?
One code submission for this verification.
361 362 |
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 361 optional :check, -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Check } |
#create ⇒ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Create?
367 368 |
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 367 optional :create, -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Create } |
#signals ⇒ PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Signals?
373 374 |
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 373 optional :signals, -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Signals } |
#type ⇒ Symbol, PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Type
347 348 |
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 347 required :type, enum: -> { PreludeSDK::Models::Verification::Phone::HistoryRetrieveResponse::Lifecycle::Event::Type } |
Class Method Details
.values ⇒ Array<Symbol>
|
|
# File 'lib/prelude_sdk/models/verification/phone/history_retrieve_response.rb', line 398
|
Instance Method Details
#to_hash ⇒ {
325 |
# File 'sig/prelude_sdk/models/verification/phone/history_retrieve_response.rbs', line 325
def to_hash: -> {
|