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



28
29
30
31
32
33
34
 
# 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) ⇒ UsAppToPersonInstance

Create the UsAppToPersonInstance



54
55
56
57
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
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 54

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
)

    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,
    })

    
    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.



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

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.



178
179
180
181
182
183
184
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 178

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.



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

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.



161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 161

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 Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



131
132
133
134
135
136
137
138
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 131

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



189
190
191
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 189

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