Class: Twilio::REST::Messaging::V1::ExternalCampaignInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/messaging/v1/external_campaign.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload) ⇒ ExternalCampaignInstance

Initialize the ExternalCampaignInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this ExternalCampaign resource.

  • sid (String) —

    The SID of the Call resource to fetch.



101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/twilio-ruby/rest/messaging/v1/external_campaign.rb', line 101

def initialize(version, payload )
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'campaign_id' => payload['campaign_id'],
        'messaging_service_sid' => payload['messaging_service_sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
    }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that the Campaign belongs to.

Returns:



123
124
125
 
# File 'lib/twilio-ruby/rest/messaging/v1/external_campaign.rb', line 123

def 
    @properties['account_sid']
end

#campaign_id ⇒ String

Returns ID of the preregistered campaign.

Returns:

  • (String) —

    ID of the preregistered campaign.



129
130
131
 
# File 'lib/twilio-ruby/rest/messaging/v1/external_campaign.rb', line 129

def campaign_id
    @properties['campaign_id']
end

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



141
142
143
 
# File 'lib/twilio-ruby/rest/messaging/v1/external_campaign.rb', line 141

def date_created
    @properties['date_created']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



153
154
155
 
# File 'lib/twilio-ruby/rest/messaging/v1/external_campaign.rb', line 153

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

#messaging_service_sid ⇒ String

Returns The SID of the [Messaging Service](www.twilio.com/docs/messaging/api/service-resource) that the resource is associated with.

Returns:



135
136
137
 
# File 'lib/twilio-ruby/rest/messaging/v1/external_campaign.rb', line 135

def messaging_service_sid
    @properties['messaging_service_sid']
end

#sid ⇒ String

Returns The unique string that identifies a US A2P Compliance resource ‘QE2c6890da8086d771620e9b13fadeba0b`.

Returns:

  • (String) —

    The unique string that identifies a US A2P Compliance resource ‘QE2c6890da8086d771620e9b13fadeba0b`.



117
118
119
 
# File 'lib/twilio-ruby/rest/messaging/v1/external_campaign.rb', line 117

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



147
148
149
 
# File 'lib/twilio-ruby/rest/messaging/v1/external_campaign.rb', line 147

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