Class: Twilio::REST::Messaging::V1::ServiceContext::UsAppToPersonInstance

Inherits:
InstanceResource
  • 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, payload, messaging_service_sid: nil) ⇒ UsAppToPersonInstance

Initialize the UsAppToPersonInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

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



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 137

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

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'brand_registration_sid' => payload['brand_registration_sid'],
      'messaging_service_sid' => payload['messaging_service_sid'],
      'description' => payload['description'],
      'message_samples' => payload['message_samples'],
      'us_app_to_person_usecase' => payload['us_app_to_person_usecase'],
      'has_embedded_links' => payload['has_embedded_links'],
      'has_embedded_phone' => payload['has_embedded_phone'],
      'status' => payload['status'],
      'campaign_id' => payload['campaign_id'],
      'is_externally_registered' => payload['is_externally_registered'],
      'rate_limits' => payload['rate_limits'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'url' => payload['url'],
  }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



162
163
164
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 162

def 
  @properties['account_sid']
end

#brand_registration_sid ⇒ String

Returns A2P Brand Registration SID.

Returns:

  • (String) —

    A2P Brand Registration SID



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

def brand_registration_sid
  @properties['brand_registration_sid']
end

#campaign_id ⇒ String

Returns The Campaign Registry (TCR) Campaign ID.

Returns:

  • (String) —

    The Campaign Registry (TCR) Campaign ID.



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

def campaign_id
  @properties['campaign_id']
end

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created



234
235
236
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 234

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated



240
241
242
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 240

def date_updated
  @properties['date_updated']
end

#description ⇒ String

Returns A short description of what this SMS campaign does.

Returns:

  • (String) —

    A short description of what this SMS campaign does



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

def description
  @properties['description']
end

#has_embedded_links ⇒ Boolean

Returns Indicate that this SMS campaign will send messages that contain links.

Returns:

  • (Boolean) —

    Indicate that this SMS campaign will send messages that contain links



198
199
200
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 198

def has_embedded_links
  @properties['has_embedded_links']
end

#has_embedded_phone ⇒ Boolean

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

Returns:

  • (Boolean) —

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



204
205
206
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 204

def has_embedded_phone
  @properties['has_embedded_phone']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



258
259
260
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 258

def inspect
  "<Twilio.Messaging.V1.UsAppToPersonInstance>"
end

#is_externally_registered ⇒ Boolean

Returns Indicates whether the campaign was registered externally or not.

Returns:

  • (Boolean) —

    Indicates whether the campaign was registered externally or not



222
223
224
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 222

def is_externally_registered
  @properties['is_externally_registered']
end

#message_samples ⇒ Array[String]

Returns Message samples.

Returns:

  • (Array[String]) —

    Message samples



186
187
188
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 186

def message_samples
  @properties['message_samples']
end

#messaging_service_sid ⇒ String

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

Returns:

  • (String) —

    The SID of the Messaging Service the resource is associated with



174
175
176
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 174

def messaging_service_sid
  @properties['messaging_service_sid']
end

#rate_limits ⇒ Hash

Returns Rate limit and/or classification set by each carrier.

Returns:

  • (Hash) —

    Rate limit and/or classification set by each carrier



228
229
230
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 228

def rate_limits
  @properties['rate_limits']
end

#status ⇒ String

Returns Campaign status.

Returns:

  • (String) —

    Campaign status



210
211
212
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 210

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



252
253
254
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 252

def to_s
  "<Twilio.Messaging.V1.UsAppToPersonInstance>"
end

#url ⇒ String

Returns The absolute URL of the US App to Person resource.

Returns:

  • (String) —

    The absolute URL of the US App to Person resource



246
247
248
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 246

def url
  @properties['url']
end

#us_app_to_person_usecase ⇒ String

Returns A2P Campaign Use Case.

Returns:

  • (String) —

    A2P Campaign Use Case.



192
193
194
 
# File 'lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb', line 192

def us_app_to_person_usecase
  @properties['us_app_to_person_usecase']
end