Class: Twilio::REST::Marketplace::V1::ModuleDataInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload) ⇒ ModuleDataInstance

Initialize the ModuleDataInstance

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

  • sid (String) —

    The SID of the Call resource to fetch.



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

def initialize(version, payload )
    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'],
        'configuration' => payload['configuration'],
        'pricing' => payload['pricing'],
        'listings' => payload['listings'],
    }
end

Instance Method Details

#configuration ⇒ Hash

Returns A JSON object for providing listing specific configuration. Contains button setup, notification url, among others.

Returns:

  • (Hash) —

    A JSON object for providing listing specific configuration. Contains button setup, notification url, among others.



310
311
312
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 310

def configuration
    @properties['configuration']
end

#description ⇒ Hash

Returns A JSON object describing the module and is displayed under the Description tab of the Module detail page. You can define the main body of the description, highlight key features or aspects of the module and if applicable, provide code samples for developers.

Returns:

  • (Hash) —

    A JSON object describing the module and is displayed under the Description tab of the Module detail page. You can define the main body of the description, highlight key features or aspects of the module and if applicable, provide code samples for developers



280
281
282
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 280

def description
    @properties['description']
end

#documentation ⇒ Hash

Returns A JSON object for providing comprehensive information, instructions, and resources related to the module.

Returns:

  • (Hash) —

    A JSON object for providing comprehensive information, instructions, and resources related to the module



304
305
306
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 304

def documentation
    @properties['documentation']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



334
335
336
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 334

def inspect
    "<Twilio.Marketplace.V1.ModuleDataInstance>"
end

#listings ⇒ Array<Hash>

Returns:

  • (Array<Hash>) 


322
323
324
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 322

def listings
    @properties['listings']
end

#module_info ⇒ Hash

Returns A JSON object containing essential attributes that define a module. This information is presented on the Module detail page in the Twilio Marketplace Catalog. You can pass the following attributes in the JSON object.

Returns:

  • (Hash) —

    A JSON object containing essential attributes that define a module. This information is presented on the Module detail page in the Twilio Marketplace Catalog. You can pass the following attributes in the JSON object



298
299
300
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 298

def module_info
    @properties['module_info']
end

#policies ⇒ Hash

Returns A JSON object describing the module’s privacy and legal policies and is displayed under the Policies tab of the Module detail page. The maximum file size for Policies is 5MB.

Returns:

  • (Hash) —

    A JSON object describing the module’s privacy and legal policies and is displayed under the Policies tab of the Module detail page. The maximum file size for Policies is 5MB



292
293
294
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 292

def policies
    @properties['policies']
end

#pricing ⇒ Hash

Returns A JSON object for providing Listing specific pricing information.

Returns:

  • (Hash) —

    A JSON object for providing Listing specific pricing information.



316
317
318
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 316

def pricing
    @properties['pricing']
end

#sid ⇒ String

Returns ModuleSid that identifies this Listing.

Returns:

  • (String) —

    ModuleSid that identifies this Listing.



274
275
276
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 274

def sid
    @properties['sid']
end

#support ⇒ Hash

Returns A JSON object containing information on how customers can obtain support for the module. Use this parameter to provide details such as contact information and support description.

Returns:

  • (Hash) —

    A JSON object containing information on how customers can obtain support for the module. Use this parameter to provide details such as contact information and support description.



286
287
288
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 286

def support
    @properties['support']
end

#to_s ⇒ Object

Provide a user friendly representation



328
329
330
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 328

def to_s
    "<Twilio.Marketplace.V1.ModuleDataInstance>"
end

#url ⇒ String

Returns URL to query the subresource.

Returns:

  • (String) —

    URL to query the subresource.



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

def url
    @properties['url']
end