Class: Zavudev::Models::Invitation

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/zavudev/models/invitation.rb,
sig/zavudev/models/invitation.rbs

Overview

See Also:

  • Zavudev::Resources::Invitations#list

Defined Under Namespace

Modules: ConnectionType, Status Classes: ConnectedAccount

Instance Attribute Summary collapse

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(id:, token:, created_at:, expires_at:, status:, updated_at:, url:, client_email: nil, client_name: nil, client_phone: nil, completed_at: nil, connected_account: nil, connection_type: nil, failed_at: nil, failure_reason: nil, phone_number_id: nil, sender_id: nil, started_at: nil, viewed_at: nil) ⇒ Object

Some parameter documentations has been truncated, see Zavudev::Models::Invitation for more details.

Parameters:

  • id (String)
  • token (String) —

    Unique invitation token.

  • created_at (Time)
  • expires_at (Time)
  • status (Symbol, Zavudev::Models::Invitation::Status) —

    Current status of the partner invitation.

  • updated_at (Time)
  • url (String) —

    Full URL to share with the client.

  • client_email (String, nil) (defaults to: nil)
  • client_name (String, nil) (defaults to: nil)
  • client_phone (String, nil) (defaults to: nil)
  • completed_at (Time, nil) (defaults to: nil)
  • connected_account (Zavudev::Models::Invitation::ConnectedAccount, nil) (defaults to: nil) —

    The account the client linked, populated once the invitation is completed. Nul

  • connection_type (Symbol, Zavudev::Models::Invitation::ConnectionType) (defaults to: nil) —

    Which Meta channel the client connects: whatsapp_waba (official WhatsApp Cloud

  • failed_at (Time, nil) (defaults to: nil)
  • failure_reason (String, nil) (defaults to: nil) —

    Stable code for why the last attempt failed, present when status is failed.

  • phone_number_id (String, nil) (defaults to: nil) —

    ID of a pre-assigned Zavu phone number for WhatsApp registration. Always null fo

  • sender_id (String, nil) (defaults to: nil) —

    ID of the sender created when invitation is completed.

  • started_at (Time, nil) (defaults to: nil)
  • viewed_at (Time, nil) (defaults to: nil) 



# File 'lib/zavudev/models/invitation.rb', line 127

Instance Attribute Details

#client_email ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


53
 
# File 'lib/zavudev/models/invitation.rb', line 53

optional :client_email, String, api_name: :clientEmail, nil?: true

#client_name ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


58
 
# File 'lib/zavudev/models/invitation.rb', line 58

optional :client_name, String, api_name: :clientName, nil?: true

#client_phone ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


63
 
# File 'lib/zavudev/models/invitation.rb', line 63

optional :client_phone, String, api_name: :clientPhone, nil?: true

#completed_at ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


68
 
# File 'lib/zavudev/models/invitation.rb', line 68

optional :completed_at, Time, api_name: :completedAt, nil?: true

#connected_account ⇒ Zavudev::Models::Invitation::ConnectedAccount?

The account the client linked, populated once the invitation is completed. Null before that. Use it to show the partner what was connected without fetching the sender.

Parameters:

  • value (Zavudev::Invitation::ConnectedAccount, nil)

Returns:



76
77
78
79
 
# File 'lib/zavudev/models/invitation.rb', line 76

optional :connected_account,
-> { Zavudev::Invitation::ConnectedAccount },
api_name: :connectedAccount,
nil?: true

#connection_type ⇒ Symbol, ...

Which Meta channel the client connects: whatsapp_waba (official WhatsApp Cloud API via embedded signup) or messenger (a Facebook Page's Messenger inbox, including Marketplace chats).

Returns:



87
 
# File 'lib/zavudev/models/invitation.rb', line 87

optional :connection_type, enum: -> { Zavudev::Invitation::ConnectionType }, api_name: :connectionType

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


21
 
# File 'lib/zavudev/models/invitation.rb', line 21

required :created_at, Time, api_name: :createdAt

#expires_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


26
 
# File 'lib/zavudev/models/invitation.rb', line 26

required :expires_at, Time, api_name: :expiresAt

#failed_at ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


92
 
# File 'lib/zavudev/models/invitation.rb', line 92

optional :failed_at, Time, api_name: :failedAt, nil?: true

#failure_reason ⇒ String?

Stable code for why the last attempt failed, present when status is failed. Values include fb_cancelled (client closed Meta's dialog), fb_not_authorized (permission denied), signup_abandoned (started but never finished), meta_no_pages (the client administers no Facebook Page), and internal_error. Treat unknown codes as a generic failure.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


102
 
# File 'lib/zavudev/models/invitation.rb', line 102

optional :failure_reason, String, api_name: :failureReason, nil?: true

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


10
 
# File 'lib/zavudev/models/invitation.rb', line 10

required :id, String

#phone_number_id ⇒ String?

ID of a pre-assigned Zavu phone number for WhatsApp registration. Always null for messenger invitations.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


109
 
# File 'lib/zavudev/models/invitation.rb', line 109

optional :phone_number_id, String, api_name: :phoneNumberId, nil?: true

#sender_id ⇒ String?

ID of the sender created when invitation is completed.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


115
 
# File 'lib/zavudev/models/invitation.rb', line 115

optional :sender_id, String, api_name: :senderId, nil?: true

#started_at ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


120
 
# File 'lib/zavudev/models/invitation.rb', line 120

optional :started_at, Time, api_name: :startedAt, nil?: true

#status ⇒ Symbol, Zavudev::Models::Invitation::Status

Current status of the partner invitation.

failed means the client started the connection and it did not finish (they cancelled Meta's dialog, denied a permission, or abandoned the tab). A failed invitation is still usable: the same link can be retried, and it moves back to in_progress when the client tries again.

Parameters:

  • value (Zavudev::Models::Invitation::status)

Returns:



37
 
# File 'lib/zavudev/models/invitation.rb', line 37

required :status, enum: -> { Zavudev::Invitation::Status }

#token ⇒ String

Unique invitation token.

Parameters:

  • value (String)

Returns:

  • (String) 


16
 
# File 'lib/zavudev/models/invitation.rb', line 16

required :token, String

#updated_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


42
 
# File 'lib/zavudev/models/invitation.rb', line 42

required :updated_at, Time, api_name: :updatedAt

#url ⇒ String

Full URL to share with the client.

Parameters:

  • value (String)

Returns:

  • (String) 


48
 
# File 'lib/zavudev/models/invitation.rb', line 48

required :url, String

#viewed_at ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


125
 
# File 'lib/zavudev/models/invitation.rb', line 125

optional :viewed_at, Time, api_name: :viewedAt, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/zavudev/models/invitation.rb', line 187

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


91
 
# File 'sig/zavudev/models/invitation.rbs', line 91

def to_hash: -> {