Class: Zavudev::Models::SenderCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/zavudev/models/sender_create_params.rb

Overview

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(name:, phone_number:, set_as_default: nil, webhook_events: nil, webhook_url: nil, request_options: {}) ⇒ Object

Parameters:

  • name (String)
  • phone_number (String)
  • set_as_default (Boolean) (defaults to: nil)
  • webhook_events (Array<Symbol, Zavudev::Models::WebhookEvent>) (defaults to: nil)

    Events to subscribe to.

  • webhook_url (String) (defaults to: nil)

    HTTPS URL for webhook events.

  • request_options (Zavudev::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})


# File 'lib/zavudev/models/sender_create_params.rb', line 39

Instance Attribute Details

#nameString

Returns:

  • (String)


13
# File 'lib/zavudev/models/sender_create_params.rb', line 13

required :name, String

#phone_numberString

Returns:

  • (String)


18
# File 'lib/zavudev/models/sender_create_params.rb', line 18

required :phone_number, String, api_name: :phoneNumber

#set_as_defaultBoolean?

Returns:

  • (Boolean, nil)


23
# File 'lib/zavudev/models/sender_create_params.rb', line 23

optional :set_as_default, Zavudev::Internal::Type::Boolean, api_name: :setAsDefault

#webhook_eventsArray<Symbol, Zavudev::Models::WebhookEvent>?

Events to subscribe to.

Returns:



29
30
31
# File 'lib/zavudev/models/sender_create_params.rb', line 29

optional :webhook_events,
-> { Zavudev::Internal::Type::ArrayOf[enum: Zavudev::WebhookEvent] },
api_name: :webhookEvents

#webhook_urlString?

HTTPS URL for webhook events.

Returns:

  • (String, nil)


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

optional :webhook_url, String, api_name: :webhookUrl