Class: Twilio::REST::Messaging::V2::ChannelsSenderList::MessagingV2ChannelsSenderProfile

Inherits:

Object

Object
Twilio::REST::Messaging::V2::ChannelsSenderList::MessagingV2ChannelsSenderProfile

show all

Defined in:: lib/twilio-ruby/rest/messaging/v2/channels_sender.rb,
lib/twilio-ruby/rest/messaging/v2/channels_sender.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

#initialize(payload) ⇒ MessagingV2ChannelsSenderProfile constructor

A new instance of MessagingV2ChannelsSenderProfile.
#to_json(options = {}) ⇒ Object

Constructor Details

#initialize(payload) ⇒ `MessagingV2ChannelsSenderProfile`

Returns a new instance of MessagingV2ChannelsSenderProfile.

# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 37

def initialize(payload)
        @name = payload["name"]
        @about = payload["about"]
        @address = payload["address"]
        @description = payload["description"]
        @logo_url = payload["logo_url"]
        @banner_url = payload["banner_url"]
        @privacy_url = payload["privacy_url"]
        @terms_of_service_url = payload["terms_of_service_url"]
        @accent_color = payload["accent_color"]
        @vertical = payload["vertical"]
        @websites = payload["websites"]
        @emails = payload["emails"]
        @phone_numbers = payload["phone_numbers"]
end

Instance Attribute Details

#about ⇒ `Object`

Parameters:

: (name) —
String

The name of the sender. Required for WhatsApp senders and must follow [Meta’s display name guidelines](www.facebook.com/business/help/757569725593362).
: (about) —
String

The profile about text for the sender.
: (address) —
String

The address of the sender.
: (description) —
String

The description of the sender.
: (logo_url) —
String

The logo URL of the sender.
: (banner_url) —
String

The banner URL of the sender.
: (privacy_url) —
String

The privacy URL of the sender. Must be a publicly accessible HTTP or HTTPS URI associated with the sender.
: (terms_of_service_url) —
String

The terms of service URL of the sender.
: (accent_color) —
String

The color theme of the sender. Must be in hex format and have at least a 4:5:1 contrast ratio against white.
: (vertical) —
String

The vertical of the sender. Allowed values are: - ‘Automotive` - `Beauty, Spa and Salon` - `Clothing and Apparel` - `Education` - `Entertainment` - `Event Planning and Service` - `Finance and Banking` - `Food and Grocery` - `Public Service` - `Hotel and Lodging` - `Medical and Health` - `Non-profit` - `Professional Services` - `Shopping and Retail` - `Travel and Transportation` - `Restaurant` - `Other`
: (websites) —
Hash

The websites of the sender.
: (emails) —
Hash

The emails of the sender.
: (phone_numbers) —
Hash

The phone numbers of the sender.



36
37
38

# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 36

def about
  @about
end

#accent_color ⇒ `Object`

Parameters:

: (name) —
String

The name of the sender. Required for WhatsApp senders and must follow [Meta’s display name guidelines](www.facebook.com/business/help/757569725593362).
: (about) —
String

The profile about text for the sender.
: (address) —
String

The address of the sender.
: (description) —
String

The description of the sender.
: (logo_url) —
String

The logo URL of the sender.
: (banner_url) —
String

The banner URL of the sender.
: (privacy_url) —
String

The privacy URL of the sender. Must be a publicly accessible HTTP or HTTPS URI associated with the sender.
: (terms_of_service_url) —
String

The terms of service URL of the sender.
: (accent_color) —
String

The color theme of the sender. Must be in hex format and have at least a 4:5:1 contrast ratio against white.
: (vertical) —
String

The vertical of the sender. Allowed values are: - ‘Automotive` - `Beauty, Spa and Salon` - `Clothing and Apparel` - `Education` - `Entertainment` - `Event Planning and Service` - `Finance and Banking` - `Food and Grocery` - `Public Service` - `Hotel and Lodging` - `Medical and Health` - `Non-profit` - `Professional Services` - `Shopping and Retail` - `Travel and Transportation` - `Restaurant` - `Other`
: (websites) —
Hash

The websites of the sender.
: (emails) —
Hash

The emails of the sender.
: (phone_numbers) —
Hash

The phone numbers of the sender.



36
37
38

# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 36

def accent_color
  @accent_color
end

#address ⇒ `Object`

Parameters:

: (name) —
String

The name of the sender. Required for WhatsApp senders and must follow [Meta’s display name guidelines](www.facebook.com/business/help/757569725593362).
: (about) —
String

The profile about text for the sender.
: (address) —
String

The address of the sender.
: (description) —
String

The description of the sender.
: (logo_url) —
String

The logo URL of the sender.
: (banner_url) —
String

The banner URL of the sender.
: (privacy_url) —
String

The privacy URL of the sender. Must be a publicly accessible HTTP or HTTPS URI associated with the sender.
: (terms_of_service_url) —
String

The terms of service URL of the sender.
: (accent_color) —
String

The color theme of the sender. Must be in hex format and have at least a 4:5:1 contrast ratio against white.
: (vertical) —
String

The vertical of the sender. Allowed values are: - ‘Automotive` - `Beauty, Spa and Salon` - `Clothing and Apparel` - `Education` - `Entertainment` - `Event Planning and Service` - `Finance and Banking` - `Food and Grocery` - `Public Service` - `Hotel and Lodging` - `Medical and Health` - `Non-profit` - `Professional Services` - `Shopping and Retail` - `Travel and Transportation` - `Restaurant` - `Other`
: (websites) —
Hash

The websites of the sender.
: (emails) —
Hash

The emails of the sender.
: (phone_numbers) —
Hash

The phone numbers of the sender.



36
37
38

# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 36

def address
  @address
end

#banner_url ⇒ `Object`

Parameters:

: (name) —
String

The name of the sender. Required for WhatsApp senders and must follow [Meta’s display name guidelines](www.facebook.com/business/help/757569725593362).
: (about) —
String

The profile about text for the sender.
: (address) —
String

The address of the sender.
: (description) —
String

The description of the sender.
: (logo_url) —
String

The logo URL of the sender.
: (banner_url) —
String

The banner URL of the sender.
: (privacy_url) —
String

The privacy URL of the sender. Must be a publicly accessible HTTP or HTTPS URI associated with the sender.
: (terms_of_service_url) —
String

The terms of service URL of the sender.
: (accent_color) —
String

The color theme of the sender. Must be in hex format and have at least a 4:5:1 contrast ratio against white.
: (vertical) —
String

The vertical of the sender. Allowed values are: - ‘Automotive` - `Beauty, Spa and Salon` - `Clothing and Apparel` - `Education` - `Entertainment` - `Event Planning and Service` - `Finance and Banking` - `Food and Grocery` - `Public Service` - `Hotel and Lodging` - `Medical and Health` - `Non-profit` - `Professional Services` - `Shopping and Retail` - `Travel and Transportation` - `Restaurant` - `Other`
: (websites) —
Hash

The websites of the sender.
: (emails) —
Hash

The emails of the sender.
: (phone_numbers) —
Hash

The phone numbers of the sender.



36
37
38

# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 36

def banner_url
  @banner_url
end

#description ⇒ `Object`

Parameters:

: (name) —
String

The name of the sender. Required for WhatsApp senders and must follow [Meta’s display name guidelines](www.facebook.com/business/help/757569725593362).
: (about) —
String

The profile about text for the sender.
: (address) —
String

The address of the sender.
: (description) —
String

The description of the sender.
: (logo_url) —
String

The logo URL of the sender.
: (banner_url) —
String

The banner URL of the sender.
: (privacy_url) —
String

The privacy URL of the sender. Must be a publicly accessible HTTP or HTTPS URI associated with the sender.
: (terms_of_service_url) —
String

The terms of service URL of the sender.
: (accent_color) —
String

The color theme of the sender. Must be in hex format and have at least a 4:5:1 contrast ratio against white.
: (vertical) —
String

The vertical of the sender. Allowed values are: - ‘Automotive` - `Beauty, Spa and Salon` - `Clothing and Apparel` - `Education` - `Entertainment` - `Event Planning and Service` - `Finance and Banking` - `Food and Grocery` - `Public Service` - `Hotel and Lodging` - `Medical and Health` - `Non-profit` - `Professional Services` - `Shopping and Retail` - `Travel and Transportation` - `Restaurant` - `Other`
: (websites) —
Hash

The websites of the sender.
: (emails) —
Hash

The emails of the sender.
: (phone_numbers) —
Hash

The phone numbers of the sender.



36
37
38

# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 36

def description
  @description
end

#emails ⇒ `Object`

Parameters:

: (name) —
String

The name of the sender. Required for WhatsApp senders and must follow [Meta’s display name guidelines](www.facebook.com/business/help/757569725593362).
: (about) —
String

The profile about text for the sender.
: (address) —
String

The address of the sender.
: (description) —
String

The description of the sender.
: (logo_url) —
String

The logo URL of the sender.
: (banner_url) —
String

The banner URL of the sender.
: (privacy_url) —
String

The privacy URL of the sender. Must be a publicly accessible HTTP or HTTPS URI associated with the sender.
: (terms_of_service_url) —
String

The terms of service URL of the sender.
: (accent_color) —
String

The color theme of the sender. Must be in hex format and have at least a 4:5:1 contrast ratio against white.
: (vertical) —
String

The vertical of the sender. Allowed values are: - ‘Automotive` - `Beauty, Spa and Salon` - `Clothing and Apparel` - `Education` - `Entertainment` - `Event Planning and Service` - `Finance and Banking` - `Food and Grocery` - `Public Service` - `Hotel and Lodging` - `Medical and Health` - `Non-profit` - `Professional Services` - `Shopping and Retail` - `Travel and Transportation` - `Restaurant` - `Other`
: (websites) —
Hash

The websites of the sender.
: (emails) —
Hash

The emails of the sender.
: (phone_numbers) —
Hash

The phone numbers of the sender.



36
37
38

# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 36

def emails
  @emails
end

#logo_url ⇒ `Object`

Parameters:

: (name) —
String

The name of the sender. Required for WhatsApp senders and must follow [Meta’s display name guidelines](www.facebook.com/business/help/757569725593362).
: (about) —
String

The profile about text for the sender.
: (address) —
String

The address of the sender.
: (description) —
String

The description of the sender.
: (logo_url) —
String

The logo URL of the sender.
: (banner_url) —
String

The banner URL of the sender.
: (privacy_url) —
String

The privacy URL of the sender. Must be a publicly accessible HTTP or HTTPS URI associated with the sender.
: (terms_of_service_url) —
String

The terms of service URL of the sender.
: (accent_color) —
String

The color theme of the sender. Must be in hex format and have at least a 4:5:1 contrast ratio against white.
: (vertical) —
String

The vertical of the sender. Allowed values are: - ‘Automotive` - `Beauty, Spa and Salon` - `Clothing and Apparel` - `Education` - `Entertainment` - `Event Planning and Service` - `Finance and Banking` - `Food and Grocery` - `Public Service` - `Hotel and Lodging` - `Medical and Health` - `Non-profit` - `Professional Services` - `Shopping and Retail` - `Travel and Transportation` - `Restaurant` - `Other`
: (websites) —
Hash

The websites of the sender.
: (emails) —
Hash

The emails of the sender.
: (phone_numbers) —
Hash

The phone numbers of the sender.



36
37
38

# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 36

def logo_url
  @logo_url
end

#name ⇒ `Object`

Parameters:

: (name) —
String

The name of the sender. Required for WhatsApp senders and must follow [Meta’s display name guidelines](www.facebook.com/business/help/757569725593362).
: (about) —
String

The profile about text for the sender.
: (address) —
String

The address of the sender.
: (description) —
String

The description of the sender.
: (logo_url) —
String

The logo URL of the sender.
: (banner_url) —
String

The banner URL of the sender.
: (privacy_url) —
String

The privacy URL of the sender. Must be a publicly accessible HTTP or HTTPS URI associated with the sender.
: (terms_of_service_url) —
String

The terms of service URL of the sender.
: (accent_color) —
String

The color theme of the sender. Must be in hex format and have at least a 4:5:1 contrast ratio against white.
: (vertical) —
String

The vertical of the sender. Allowed values are: - ‘Automotive` - `Beauty, Spa and Salon` - `Clothing and Apparel` - `Education` - `Entertainment` - `Event Planning and Service` - `Finance and Banking` - `Food and Grocery` - `Public Service` - `Hotel and Lodging` - `Medical and Health` - `Non-profit` - `Professional Services` - `Shopping and Retail` - `Travel and Transportation` - `Restaurant` - `Other`
: (websites) —
Hash

The websites of the sender.
: (emails) —
Hash

The emails of the sender.
: (phone_numbers) —
Hash

The phone numbers of the sender.



36
37
38

# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 36

def name
  @name
end

#phone_numbers ⇒ `Object`

Parameters:

: (name) —
String

The name of the sender. Required for WhatsApp senders and must follow [Meta’s display name guidelines](www.facebook.com/business/help/757569725593362).
: (about) —
String

The profile about text for the sender.
: (address) —
String

The address of the sender.
: (description) —
String

The description of the sender.
: (logo_url) —
String

The logo URL of the sender.
: (banner_url) —
String

The banner URL of the sender.
: (privacy_url) —
String

The privacy URL of the sender. Must be a publicly accessible HTTP or HTTPS URI associated with the sender.
: (terms_of_service_url) —
String

The terms of service URL of the sender.
: (accent_color) —
String

The color theme of the sender. Must be in hex format and have at least a 4:5:1 contrast ratio against white.
: (vertical) —
String

The vertical of the sender. Allowed values are: - ‘Automotive` - `Beauty, Spa and Salon` - `Clothing and Apparel` - `Education` - `Entertainment` - `Event Planning and Service` - `Finance and Banking` - `Food and Grocery` - `Public Service` - `Hotel and Lodging` - `Medical and Health` - `Non-profit` - `Professional Services` - `Shopping and Retail` - `Travel and Transportation` - `Restaurant` - `Other`
: (websites) —
Hash

The websites of the sender.
: (emails) —
Hash

The emails of the sender.
: (phone_numbers) —
Hash

The phone numbers of the sender.



36
37
38

# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 36

def phone_numbers
  @phone_numbers
end

#privacy_url ⇒ `Object`

Parameters:

: (name) —
String

The name of the sender. Required for WhatsApp senders and must follow [Meta’s display name guidelines](www.facebook.com/business/help/757569725593362).
: (about) —
String

The profile about text for the sender.
: (address) —
String

The address of the sender.
: (description) —
String

The description of the sender.
: (logo_url) —
String

The logo URL of the sender.
: (banner_url) —
String

The banner URL of the sender.
: (privacy_url) —
String

The privacy URL of the sender. Must be a publicly accessible HTTP or HTTPS URI associated with the sender.
: (terms_of_service_url) —
String

The terms of service URL of the sender.
: (accent_color) —
String

The color theme of the sender. Must be in hex format and have at least a 4:5:1 contrast ratio against white.
: (vertical) —
String

The vertical of the sender. Allowed values are: - ‘Automotive` - `Beauty, Spa and Salon` - `Clothing and Apparel` - `Education` - `Entertainment` - `Event Planning and Service` - `Finance and Banking` - `Food and Grocery` - `Public Service` - `Hotel and Lodging` - `Medical and Health` - `Non-profit` - `Professional Services` - `Shopping and Retail` - `Travel and Transportation` - `Restaurant` - `Other`
: (websites) —
Hash

The websites of the sender.
: (emails) —
Hash

The emails of the sender.
: (phone_numbers) —
Hash

The phone numbers of the sender.



36
37
38

# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 36

def privacy_url
  @privacy_url
end

#terms_of_service_url ⇒ `Object`

Parameters:

: (name) —
String

The name of the sender. Required for WhatsApp senders and must follow [Meta’s display name guidelines](www.facebook.com/business/help/757569725593362).
: (about) —
String

The profile about text for the sender.
: (address) —
String

The address of the sender.
: (description) —
String

The description of the sender.
: (logo_url) —
String

The logo URL of the sender.
: (banner_url) —
String

The banner URL of the sender.
: (privacy_url) —
String

The privacy URL of the sender. Must be a publicly accessible HTTP or HTTPS URI associated with the sender.
: (terms_of_service_url) —
String

The terms of service URL of the sender.
: (accent_color) —
String

The color theme of the sender. Must be in hex format and have at least a 4:5:1 contrast ratio against white.
: (vertical) —
String

The vertical of the sender. Allowed values are: - ‘Automotive` - `Beauty, Spa and Salon` - `Clothing and Apparel` - `Education` - `Entertainment` - `Event Planning and Service` - `Finance and Banking` - `Food and Grocery` - `Public Service` - `Hotel and Lodging` - `Medical and Health` - `Non-profit` - `Professional Services` - `Shopping and Retail` - `Travel and Transportation` - `Restaurant` - `Other`
: (websites) —
Hash

The websites of the sender.
: (emails) —
Hash

The emails of the sender.
: (phone_numbers) —
Hash

The phone numbers of the sender.



36
37
38

# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 36

def terms_of_service_url
  @terms_of_service_url
end

#vertical ⇒ `Object`

Parameters:

: (name) —
String

The name of the sender. Required for WhatsApp senders and must follow [Meta’s display name guidelines](www.facebook.com/business/help/757569725593362).
: (about) —
String

The profile about text for the sender.
: (address) —
String

The address of the sender.
: (description) —
String

The description of the sender.
: (logo_url) —
String

The logo URL of the sender.
: (banner_url) —
String

The banner URL of the sender.
: (privacy_url) —
String

The privacy URL of the sender. Must be a publicly accessible HTTP or HTTPS URI associated with the sender.
: (terms_of_service_url) —
String

The terms of service URL of the sender.
: (accent_color) —
String

The color theme of the sender. Must be in hex format and have at least a 4:5:1 contrast ratio against white.
: (vertical) —
String

The vertical of the sender. Allowed values are: - ‘Automotive` - `Beauty, Spa and Salon` - `Clothing and Apparel` - `Education` - `Entertainment` - `Event Planning and Service` - `Finance and Banking` - `Food and Grocery` - `Public Service` - `Hotel and Lodging` - `Medical and Health` - `Non-profit` - `Professional Services` - `Shopping and Retail` - `Travel and Transportation` - `Restaurant` - `Other`
: (websites) —
Hash

The websites of the sender.
: (emails) —
Hash

The emails of the sender.
: (phone_numbers) —
Hash

The phone numbers of the sender.



36
37
38

# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 36

def vertical
  @vertical
end

#websites ⇒ `Object`

Parameters:

: (name) —
String

The name of the sender. Required for WhatsApp senders and must follow [Meta’s display name guidelines](www.facebook.com/business/help/757569725593362).
: (about) —
String

The profile about text for the sender.
: (address) —
String

The address of the sender.
: (description) —
String

The description of the sender.
: (logo_url) —
String

The logo URL of the sender.
: (banner_url) —
String

The banner URL of the sender.
: (privacy_url) —
String

The privacy URL of the sender. Must be a publicly accessible HTTP or HTTPS URI associated with the sender.
: (terms_of_service_url) —
String

The terms of service URL of the sender.
: (accent_color) —
String

The color theme of the sender. Must be in hex format and have at least a 4:5:1 contrast ratio against white.
: (vertical) —
String

The vertical of the sender. Allowed values are: - ‘Automotive` - `Beauty, Spa and Salon` - `Clothing and Apparel` - `Education` - `Entertainment` - `Event Planning and Service` - `Finance and Banking` - `Food and Grocery` - `Public Service` - `Hotel and Lodging` - `Medical and Health` - `Non-profit` - `Professional Services` - `Shopping and Retail` - `Travel and Transportation` - `Restaurant` - `Other`
: (websites) —
Hash

The websites of the sender.
: (emails) —
Hash

The emails of the sender.
: (phone_numbers) —
Hash

The phone numbers of the sender.



36
37
38

# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 36

def websites
  @websites
end

Instance Method Details

#to_json(options = {}) ⇒ `Object`

# File 'lib/twilio-ruby/rest/messaging/v2/channels_sender.rb', line 52

def to_json(options = {})
{
        "name": @name,
        "about": @about,
        "address": @address,
        "description": @description,
        "logo_url": @logo_url,
        "banner_url": @banner_url,
        "privacy_url": @privacy_url,
        "terms_of_service_url": @terms_of_service_url,
        "accent_color": @accent_color,
        "vertical": @vertical,
        "websites": @websites,
        "emails": @emails,
        "phone_numbers": @phone_numbers,
}.to_json(options)
end

Class: Twilio::REST::Messaging::V2::ChannelsSenderList::MessagingV2ChannelsSenderProfile

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(payload) ⇒ MessagingV2ChannelsSenderProfile

Instance Attribute Details

#about ⇒ Object

#accent_color ⇒ Object

#address ⇒ Object

#banner_url ⇒ Object

#description ⇒ Object

#emails ⇒ Object

#logo_url ⇒ Object

#name ⇒ Object

#phone_numbers ⇒ Object

#privacy_url ⇒ Object

#terms_of_service_url ⇒ Object

#vertical ⇒ Object

#websites ⇒ Object

Instance Method Details

#to_json(options = {}) ⇒ Object

#initialize(payload) ⇒ `MessagingV2ChannelsSenderProfile`

#about ⇒ `Object`

#accent_color ⇒ `Object`

#address ⇒ `Object`

#banner_url ⇒ `Object`

#description ⇒ `Object`

#emails ⇒ `Object`

#logo_url ⇒ `Object`

#name ⇒ `Object`

#phone_numbers ⇒ `Object`

#privacy_url ⇒ `Object`

#terms_of_service_url ⇒ `Object`

#vertical ⇒ `Object`

#websites ⇒ `Object`

#to_json(options = {}) ⇒ `Object`