Class: Twilio::REST::Events::V1::SchemaInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, id: nil) ⇒ SchemaInstance

Initialize the SchemaInstance

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 Schema resource.

  • sid (String) —

    The SID of the Call resource to fetch.



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/twilio-ruby/rest/events/v1/schema.rb', line 151

def initialize(version, payload , id: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'id' => payload['id'],
        'url' => payload['url'],
        'links' => payload['links'],
        'latest_version_date_created' => Twilio.deserialize_iso8601_datetime(payload['latest_version_date_created']),
        'latest_version' => payload['latest_version'] == nil ? payload['latest_version'] : payload['latest_version'].to_i,
    }

    # Context
    @instance_context = nil
    @params = { 'id' => id  || @properties['id']  , }
end

Instance Method Details

#context ⇒ SchemaContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



172
173
174
175
176
177
 
# File 'lib/twilio-ruby/rest/events/v1/schema.rb', line 172

def context
    unless @instance_context
        @instance_context = SchemaContext.new(@version , @params['id'])
    end
    @instance_context
end

#fetch ⇒ SchemaInstance

Fetch the SchemaInstance

Returns:



212
213
214
215
 
# File 'lib/twilio-ruby/rest/events/v1/schema.rb', line 212

def fetch

    context.fetch
end

#id ⇒ String

Returns The unique identifier of the schema. Each schema can have multiple versions, that share the same id.

Returns:

  • (String) —

    The unique identifier of the schema. Each schema can have multiple versions, that share the same id.



181
182
183
 
# File 'lib/twilio-ruby/rest/events/v1/schema.rb', line 181

def id
    @properties['id']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



233
234
235
236
 
# File 'lib/twilio-ruby/rest/events/v1/schema.rb', line 233

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Events.V1.SchemaInstance #{values}>"
end

#latest_version ⇒ String

Returns The latest version published of this schema.

Returns:

  • (String) —

    The latest version published of this schema.



205
206
207
 
# File 'lib/twilio-ruby/rest/events/v1/schema.rb', line 205

def latest_version
    @properties['latest_version']
end

#latest_version_date_created ⇒ Time

Returns The date that the latest schema version was created, given in ISO 8601 format.

Returns:

  • (Time) —

    The date that the latest schema version was created, given in ISO 8601 format.



199
200
201
 
# File 'lib/twilio-ruby/rest/events/v1/schema.rb', line 199

def latest_version_date_created
    @properties['latest_version_date_created']
end

#links ⇒ Hash

Returns Contains a dictionary of URL links to nested resources of this schema.

Returns:

  • (Hash) —

    Contains a dictionary of URL links to nested resources of this schema.



193
194
195
 
# File 'lib/twilio-ruby/rest/events/v1/schema.rb', line 193

def links
    @properties['links']
end

#to_s ⇒ Object

Provide a user friendly representation



226
227
228
229
 
# File 'lib/twilio-ruby/rest/events/v1/schema.rb', line 226

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Events.V1.SchemaInstance #{values}>"
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



187
188
189
 
# File 'lib/twilio-ruby/rest/events/v1/schema.rb', line 187

def url
    @properties['url']
end

#versions ⇒ versions

Access the versions

Returns:



220
221
222
 
# File 'lib/twilio-ruby/rest/events/v1/schema.rb', line 220

def versions
    context.versions
end