Class: Twilio::REST::Messaging::V1::ServiceContext::UsAppToPersonList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, messaging_service_sid: nil) ⇒ UsAppToPersonList

Initialize the UsAppToPersonList

Parameters:

  • version (Version) —

    Version that contains the resource

  • messaging_service_sid (String) (defaults to: nil) —

    The SID of the Messaging Service that the resource is associated with.



24
25
26
27
28
29
30
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 24

def initialize(version, messaging_service_sid: nil)
  super(version)

  # Path Solution
  @solution = {messaging_service_sid: messaging_service_sid}
  @uri = "/Services/#{@solution[:messaging_service_sid]}/Compliance/Usa2p"
end

Instance Method Details

#create(brand_registration_sid: nil, description: nil, message_samples: nil, us_app_to_person_usecase: nil, has_embedded_links: nil, has_embedded_phone: nil, message_flow: :unset, opt_in_message: :unset, opt_out_message: :unset, help_message: :unset, opt_in_keywords: :unset, opt_out_keywords: :unset, help_keywords: :unset) ⇒ UsAppToPersonInstance

Create the UsAppToPersonInstance

Parameters:

  • brand_registration_sid (String) (defaults to: nil) —

    A2P Brand Registration SID

  • description (String) (defaults to: nil) —

    A short description of what this SMS campaign does.

  • message_samples (Array[String]) (defaults to: nil) —

    Message samples, at least 2 and up to 5 sample messages, <=1024 chars each.

  • us_app_to_person_usecase (String) (defaults to: nil) —

    A2P Campaign Use Case. Examples: [ 2FA, EMERGENCY, MARKETING..]

  • has_embedded_links (Boolean) (defaults to: nil) —

    Indicates that this SMS campaign will send messages that contain links.

  • has_embedded_phone (Boolean) (defaults to: nil) —

    Indicates that this SMS campaign will send messages that contain phone numbers.

  • message_flow (String) (defaults to: :unset) —

    Description of how end users opt-in to the SMS campaign, therefore giving consent to receive messages.

  • opt_in_message (String) (defaults to: :unset) —

    The message that will be sent to the user when they opt in to the SMS campaign.

  • opt_out_message (String) (defaults to: :unset) —

    The message that will be sent to the user when they opt out of the SMS campaign.

  • help_message (String) (defaults to: :unset) —

    The message that will be sent to the user when they request help for the SMS campaign.

  • opt_in_keywords (Array[String]) (defaults to: :unset) —

    The keywords that will be used to opt in to the SMS campaign.

  • opt_out_keywords (Array[String]) (defaults to: :unset) —

    The keywords that will be used to opt out of the SMS campaign.

  • help_keywords (Array[String]) (defaults to: :unset) —

    The keywords that will be used to request help for the SMS campaign.

Returns:



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 59

def create(brand_registration_sid: nil, description: nil, message_samples: nil, us_app_to_person_usecase: nil, has_embedded_links: nil, has_embedded_phone: nil, message_flow: :unset, opt_in_message: :unset, opt_out_message: :unset, help_message: :unset, opt_in_keywords: :unset, opt_out_keywords: :unset, help_keywords: :unset)
  data = Twilio::Values.of({
      'BrandRegistrationSid' => brand_registration_sid,
      'Description' => description,
      'MessageSamples' => Twilio.serialize_list(message_samples) { |e| e },
      'UsAppToPersonUsecase' => us_app_to_person_usecase,
      'HasEmbeddedLinks' => has_embedded_links,
      'HasEmbeddedPhone' => has_embedded_phone,
      'MessageFlow' => message_flow,
      'OptInMessage' => opt_in_message,
      'OptOutMessage' => opt_out_message,
      'HelpMessage' => help_message,
      'OptInKeywords' => Twilio.serialize_list(opt_in_keywords) { |e| e },
      'OptOutKeywords' => Twilio.serialize_list(opt_out_keywords) { |e| e },
      'HelpKeywords' => Twilio.serialize_list(help_keywords) { |e| e },
  })

  payload = @version.create('POST', @uri, data: data)

  UsAppToPersonInstance.new(
      @version,
      payload,
      messaging_service_sid: @solution[:messaging_service_sid],
  )
end

#each ⇒ Object

When passed a block, yields UsAppToPersonInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



123
124
125
126
127
128
129
130
131
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 123

def each
  limits = @version.read_limits

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page,
                  limit: limits[:limit],
                  page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of UsAppToPersonInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of UsAppToPersonInstance



157
158
159
160
161
162
163
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 157

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  UsAppToPersonPage.new(@version, response, @solution)
end

#list(limit: nil, page_size: nil) ⇒ Array

Lists UsAppToPersonInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



96
97
98
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 96

def list(limit: nil, page_size: nil)
  self.stream(limit: limit, page_size: page_size).entries
end

#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of UsAppToPersonInstance records from the API. Request is executed immediately.

Parameters:

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of UsAppToPersonInstance



140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 140

def page(page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  UsAppToPersonPage.new(@version, response, @solution)
end

#stream(limit: nil, page_size: nil) ⇒ Enumerable

Streams UsAppToPersonInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



111
112
113
114
115
116
117
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 111

def stream(limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



167
168
169
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 167

def to_s
  '#<Twilio.Messaging.V1.UsAppToPersonList>'
end