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.



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 126

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.



189
190
191
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 189

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



159
160
161
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 159

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



183
184
185
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 183

def documentation
    @properties['documentation']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



213
214
215
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 213

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

#listings ⇒ Array<Hash>

Returns:

  • (Array<Hash>) 


201
202
203
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 201

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



177
178
179
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 177

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



171
172
173
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 171

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.



195
196
197
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 195

def pricing
    @properties['pricing']
end

#sid ⇒ String

Returns ModuleSid that identifies this Listing.

Returns:

  • (String) —

    ModuleSid that identifies this Listing.



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

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.



165
166
167
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 165

def support
    @properties['support']
end

#to_s ⇒ Object

Provide a user friendly representation



207
208
209
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 207

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

#url ⇒ String

Returns URL to query the subresource.

Returns:

  • (String) —

    URL to query the subresource.



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

def url
    @properties['url']
end