Class: Twilio::REST::Events::V1::SchemaContext

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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Defined Under Namespace

Classes: SchemaVersionContext, SchemaVersionInstance, SchemaVersionList, SchemaVersionPage

Instance Method Summary collapse

Constructor Details

#initialize(version, id) ⇒ SchemaContext

Initialize the SchemaContext

Parameters:

  • version (Version)

    Version that contains the resource

  • id (String)

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



50
51
52
53
54
55
56
57
58
59
# File 'lib/twilio-ruby/rest/events/v1/schema.rb', line 50

def initialize(version, id)
    super(version)

    # Path Solution
    @solution = { id: id,  }
    @uri = "/Schemas/#{@solution[:id]}"

    # Dependents
    @versions = nil
end

Instance Method Details

#fetchSchemaInstance

Fetch the SchemaInstance

Returns:



63
64
65
66
67
68
69
70
71
# File 'lib/twilio-ruby/rest/events/v1/schema.rb', line 63

def fetch

    payload = @version.fetch('GET', @uri)
    SchemaInstance.new(
        @version,
        payload,
        id: @solution[:id],
    )
end

#inspectObject

Provide a detailed, user friendly representation



102
103
104
105
# File 'lib/twilio-ruby/rest/events/v1/schema.rb', line 102

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Events.V1.SchemaContext #{context}>"
end

#to_sObject

Provide a user friendly representation



95
96
97
98
# File 'lib/twilio-ruby/rest/events/v1/schema.rb', line 95

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Events.V1.SchemaContext #{context}>"
end

#versions(schema_version = :unset) ⇒ SchemaVersionList, SchemaVersionContext

Access the versions

Returns:

Raises:

  • (ArgumentError)


77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
# File 'lib/twilio-ruby/rest/events/v1/schema.rb', line 77

def versions(schema_version=:unset)

    raise ArgumentError, 'schema_version cannot be nil' if schema_version.nil?

    if schema_version != :unset
        return SchemaVersionContext.new(@version, @solution[:id],schema_version )
    end

    unless @versions
        @versions = SchemaVersionList.new(
            @version, id: @solution[:id], )
    end

 @versions
end