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

Instance Method Summary collapse

Constructor Details

#initialize(version, messaging_service_sid: nil) ⇒ UsAppToPersonList

Initialize the UsAppToPersonList

Parameters:

  • version (Version) —

    Version that contains the resource



28
29
30
31
32
33
34
35
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 28

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_flow: nil, message_samples: nil, us_app_to_person_usecase: nil, has_embedded_links: nil, has_embedded_phone: nil, opt_in_message: :unset, opt_out_message: :unset, help_message: :unset, opt_in_keywords: :unset, opt_out_keywords: :unset, help_keywords: :unset, subscriber_opt_in: :unset, age_gated: :unset, direct_lending: :unset, privacy_policy_url: :unset, terms_and_conditions_url: :unset, x_twilio_api_version: :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. Min length: 40 characters. Max length: 4096 characters.

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

    Required for all Campaigns. Details around how a consumer opts-in to their campaign, therefore giving consent to receive their messages. If multiple opt-in methods can be used for the same campaign, they must all be listed. 40 character minimum. 2048 character maximum.

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

    An array of sample message strings, min two and max five. Min length for each sample: 20 chars. Max length for each sample: 1024 chars.

  • 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.

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

    If end users can text in a keyword to start receiving messages from this campaign, the auto-reply messages sent to the end users must be provided. The opt-in response should include the Brand name, confirmation of opt-in enrollment to a recurring message campaign, how to get help, and clear description of how to opt-out. This field is required if end users can text in a keyword to start receiving messages from this campaign. 20 character minimum. 320 character maximum.

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

    Upon receiving the opt-out keywords from the end users, Twilio customers are expected to send back an auto-generated response, which must provide acknowledgment of the opt-out request and confirmation that no further messages will be sent. It is also recommended that these opt-out messages include the brand name. This field is required if managing opt out keywords yourself (i.e. not using Twilio’s Default or Advanced Opt Out features). 20 character minimum. 320 character maximum.

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

    When customers receive the help keywords from their end users, Twilio customers are expected to send back an auto-generated response; this may include the brand name and additional support contact information. This field is required if managing help keywords yourself (i.e. not using Twilio’s Default or Advanced Opt Out features). 20 character minimum. 320 character maximum.

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

    If end users can text in a keyword to start receiving messages from this campaign, those keywords must be provided. This field is required if end users can text in a keyword to start receiving messages from this campaign. Values must be alphanumeric. 255 character maximum.

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

    End users should be able to text in a keyword to stop receiving messages from this campaign. Those keywords must be provided. This field is required if managing opt out keywords yourself (i.e. not using Twilio’s Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum.

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

    End users should be able to text in a keyword to receive help. Those keywords must be provided as part of the campaign registration request. This field is required if managing help keywords yourself (i.e. not using Twilio’s Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum.

  • subscriber_opt_in (Boolean) (defaults to: :unset) —

    A boolean that specifies whether campaign has Subscriber Optin or not.

  • age_gated (Boolean) (defaults to: :unset) —

    A boolean that specifies whether campaign is age gated or not.

  • direct_lending (Boolean) (defaults to: :unset) —

    A boolean that specifies whether campaign allows direct lending or not.

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

    The URL of the privacy policy for the campaign.

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

    The URL of the terms and conditions for the campaign.

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

    The version of the Messaging API to use for this request

Returns:



58
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 58

def create(
    brand_registration_sid: nil, 
    description: nil, 
    message_flow: nil, 
    message_samples: nil, 
    us_app_to_person_usecase: nil, 
    has_embedded_links: nil, 
    has_embedded_phone: nil, 
    opt_in_message: :unset, 
    opt_out_message: :unset, 
    help_message: :unset, 
    opt_in_keywords: :unset, 
    opt_out_keywords: :unset, 
    help_keywords: :unset, 
    subscriber_opt_in: :unset, 
    age_gated: :unset, 
    direct_lending: :unset, 
    privacy_policy_url: :unset, 
    terms_and_conditions_url: :unset, 
    x_twilio_api_version: :unset
)

    data = Twilio::Values.of({
        'BrandRegistrationSid' => brand_registration_sid,
        'Description' => description,
        'MessageFlow' => message_flow,
        'MessageSamples' => Twilio.serialize_list(message_samples) { |e| e },
        'UsAppToPersonUsecase' => us_app_to_person_usecase,
        'HasEmbeddedLinks' => has_embedded_links,
        'HasEmbeddedPhone' => has_embedded_phone,
        '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 },
        'SubscriberOptIn' => subscriber_opt_in,
        'AgeGated' => age_gated,
        'DirectLending' => direct_lending,
        'PrivacyPolicyUrl' => privacy_policy_url,
        'TermsAndConditionsUrl' => terms_and_conditions_url,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Api-Version' => x_twilio_api_version, })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    UsAppToPersonInstance.new(
        @version,
        payload,
        messaging_service_sid: @solution[:messaging_service_sid],
    )
end

#create_with_metadata(brand_registration_sid: nil, description: nil, message_flow: nil, message_samples: nil, us_app_to_person_usecase: nil, has_embedded_links: nil, has_embedded_phone: nil, opt_in_message: :unset, opt_out_message: :unset, help_message: :unset, opt_in_keywords: :unset, opt_out_keywords: :unset, help_keywords: :unset, subscriber_opt_in: :unset, age_gated: :unset, direct_lending: :unset, privacy_policy_url: :unset, terms_and_conditions_url: :unset, x_twilio_api_version: :unset) ⇒ UsAppToPersonInstance

Create the UsAppToPersonInstanceMetadata

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. Min length: 40 characters. Max length: 4096 characters.

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

    Required for all Campaigns. Details around how a consumer opts-in to their campaign, therefore giving consent to receive their messages. If multiple opt-in methods can be used for the same campaign, they must all be listed. 40 character minimum. 2048 character maximum.

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

    An array of sample message strings, min two and max five. Min length for each sample: 20 chars. Max length for each sample: 1024 chars.

  • 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.

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

    If end users can text in a keyword to start receiving messages from this campaign, the auto-reply messages sent to the end users must be provided. The opt-in response should include the Brand name, confirmation of opt-in enrollment to a recurring message campaign, how to get help, and clear description of how to opt-out. This field is required if end users can text in a keyword to start receiving messages from this campaign. 20 character minimum. 320 character maximum.

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

    Upon receiving the opt-out keywords from the end users, Twilio customers are expected to send back an auto-generated response, which must provide acknowledgment of the opt-out request and confirmation that no further messages will be sent. It is also recommended that these opt-out messages include the brand name. This field is required if managing opt out keywords yourself (i.e. not using Twilio’s Default or Advanced Opt Out features). 20 character minimum. 320 character maximum.

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

    When customers receive the help keywords from their end users, Twilio customers are expected to send back an auto-generated response; this may include the brand name and additional support contact information. This field is required if managing help keywords yourself (i.e. not using Twilio’s Default or Advanced Opt Out features). 20 character minimum. 320 character maximum.

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

    If end users can text in a keyword to start receiving messages from this campaign, those keywords must be provided. This field is required if end users can text in a keyword to start receiving messages from this campaign. Values must be alphanumeric. 255 character maximum.

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

    End users should be able to text in a keyword to stop receiving messages from this campaign. Those keywords must be provided. This field is required if managing opt out keywords yourself (i.e. not using Twilio’s Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum.

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

    End users should be able to text in a keyword to receive help. Those keywords must be provided as part of the campaign registration request. This field is required if managing help keywords yourself (i.e. not using Twilio’s Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum.

  • subscriber_opt_in (Boolean) (defaults to: :unset) —

    A boolean that specifies whether campaign has Subscriber Optin or not.

  • age_gated (Boolean) (defaults to: :unset) —

    A boolean that specifies whether campaign is age gated or not.

  • direct_lending (Boolean) (defaults to: :unset) —

    A boolean that specifies whether campaign allows direct lending or not.

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

    The URL of the privacy policy for the campaign.

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

    The URL of the terms and conditions for the campaign.

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

    The version of the Messaging API to use for this request

Returns:



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 137

def create_with_metadata(
  brand_registration_sid: nil, 
  description: nil, 
  message_flow: nil, 
  message_samples: nil, 
  us_app_to_person_usecase: nil, 
  has_embedded_links: nil, 
  has_embedded_phone: nil, 
  opt_in_message: :unset, 
  opt_out_message: :unset, 
  help_message: :unset, 
  opt_in_keywords: :unset, 
  opt_out_keywords: :unset, 
  help_keywords: :unset, 
  subscriber_opt_in: :unset, 
  age_gated: :unset, 
  direct_lending: :unset, 
  privacy_policy_url: :unset, 
  terms_and_conditions_url: :unset, 
  x_twilio_api_version: :unset
)

    data = Twilio::Values.of({
        'BrandRegistrationSid' => brand_registration_sid,
        'Description' => description,
        'MessageFlow' => message_flow,
        'MessageSamples' => Twilio.serialize_list(message_samples) { |e| e },
        'UsAppToPersonUsecase' => us_app_to_person_usecase,
        'HasEmbeddedLinks' => has_embedded_links,
        'HasEmbeddedPhone' => has_embedded_phone,
        '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 },
        'SubscriberOptIn' => subscriber_opt_in,
        'AgeGated' => age_gated,
        'DirectLending' => direct_lending,
        'PrivacyPolicyUrl' => privacy_policy_url,
        'TermsAndConditionsUrl' => terms_and_conditions_url,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Api-Version' => x_twilio_api_version, })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    us_app_to_person_instance = UsAppToPersonInstance.new(
        @version,
        response.body,
        messaging_service_sid: @solution[:messaging_service_sid],
    )
    UsAppToPersonInstanceMetadata.new(
        @version,
        us_app_to_person_instance,
        response.headers,
        response.status_code
    )
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.



271
272
273
274
275
276
277
278
279
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 271

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



310
311
312
313
314
315
316
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 310

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

#list(x_twilio_api_version: :unset, 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:

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

    The version of the Messaging API to use for this request

  • 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



213
214
215
216
217
218
219
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 213

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

#list_with_metadata(x_twilio_api_version: :unset, limit: nil, page_size: nil) ⇒ Array

Returns Array of up to limit results.

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



253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 253

def list_with_metadata(x_twilio_api_version: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'X-Twilio-Api-Version' => x_twilio_api_version,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

    UsAppToPersonPageMetadata.new(@version, response, @solution, limits[:limit])
end

#page(x_twilio_api_version: :unset, 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:

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

    The version of the Messaging API to use for this request

  • 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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 289

def page(x_twilio_api_version: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
    params = Twilio::Values.of({
        'X-Twilio-Api-Version' => x_twilio_api_version,
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

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

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

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

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

Parameters:

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

    The version of the Messaging API to use for this request

  • 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



233
234
235
236
237
238
239
240
241
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 233

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

    page = self.page(
        x_twilio_api_version: x_twilio_api_version,
        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



321
322
323
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 321

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