Class: Twilio::REST::Marketplace::V1::ModuleDataManagementInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/marketplace/v1/module_data_management.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ ModuleDataManagementInstance

Initialize the ModuleDataManagementInstance

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

  • sid (String) (defaults to: nil)

    The SID of the Call resource to fetch.



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data_management.rb', line 161

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'url' => payload['url'],
        'sid' => payload['sid'],
        'description' => payload['description'],
        'support' => payload['support'],
        'policies' => payload['policies'],
        'module_info' => payload['module_info'],
        'documentation' => payload['documentation'],
    }

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

Instance Method Details

#contextModuleDataManagementContext

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

Returns:



184
185
186
187
188
189
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data_management.rb', line 184

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

#descriptionHash

Returns:

  • (Hash)


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

def description
    @properties['description']
end

#documentationHash

Returns:

  • (Hash)


229
230
231
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data_management.rb', line 229

def documentation
    @properties['documentation']
end

#fetchModuleDataManagementInstance

Fetch the ModuleDataManagementInstance

Returns:



236
237
238
239
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data_management.rb', line 236

def fetch

    context.fetch
end

#inspectObject

Provide a detailed, user friendly representation



275
276
277
278
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data_management.rb', line 275

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

#module_infoHash

Returns:

  • (Hash)


223
224
225
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data_management.rb', line 223

def module_info
    @properties['module_info']
end

#policiesHash

Returns:

  • (Hash)


217
218
219
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data_management.rb', line 217

def policies
    @properties['policies']
end

#sidString

Returns:

  • (String)


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

def sid
    @properties['sid']
end

#supportHash

Returns:

  • (Hash)


211
212
213
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data_management.rb', line 211

def support
    @properties['support']
end

#to_sObject

Provide a user friendly representation



268
269
270
271
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data_management.rb', line 268

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

#update(module_info: :unset, description: :unset, documentation: :unset, policies: :unset, support: :unset) ⇒ ModuleDataManagementInstance

Update the ModuleDataManagementInstance

Parameters:

  • module_info (String) (defaults to: :unset)
  • description (String) (defaults to: :unset)
  • documentation (String) (defaults to: :unset)
  • policies (String) (defaults to: :unset)
  • support (String) (defaults to: :unset)

Returns:



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data_management.rb', line 249

def update(
    module_info: :unset, 
    description: :unset, 
    documentation: :unset, 
    policies: :unset, 
    support: :unset
)

    context.update(
        module_info: module_info, 
        description: description, 
        documentation: documentation, 
        policies: policies, 
        support: support, 
    )
end

#urlString

Returns:

  • (String)


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

def url
    @properties['url']
end