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.



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data_management.rb', line 175

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'],
        'configuration' => payload['configuration'],
        'pricing' => payload['pricing'],
    }

    # Context
    @instance_context = nil
    @params = { 'sid' => sid  || @properties['sid']  , }
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.



251
252
253
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data_management.rb', line 251

def configuration
    @properties['configuration']
end

#context ⇒ ModuleDataManagementContext

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

Returns:



200
201
202
203
204
205
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data_management.rb', line 200

def context
    unless @instance_context
        @instance_context = ModuleDataManagementContext.new(@version , @params['sid'])
    end
    @instance_context
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



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

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



245
246
247
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data_management.rb', line 245

def documentation
    @properties['documentation']
end

#fetch ⇒ ModuleDataManagementInstance

Fetch the ModuleDataManagementInstance

Returns:



264
265
266
267
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data_management.rb', line 264

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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



239
240
241
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data_management.rb', line 239

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



233
234
235
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data_management.rb', line 233

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.



257
258
259
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data_management.rb', line 257

def pricing
    @properties['pricing']
end

#sid ⇒ String

Returns ModuleSid that identifies this Listing.

Returns:

  • (String) —

    ModuleSid that identifies this Listing.



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

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.



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

def support
    @properties['support']
end

#to_s ⇒ Object

Provide a user friendly representation



302
303
304
305
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data_management.rb', line 302

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, configuration: :unset, pricing: :unset) ⇒ ModuleDataManagementInstance

Update the ModuleDataManagementInstance

Parameters:

  • module_info (String) (defaults to: :unset) —

    A JSON object containing essential attributes that define a Listing.

  • description (String) (defaults to: :unset) —

    A JSON object describing the Listing. You can define the main body of the description, highlight key features or aspects of the Listing, and provide code samples for developers if applicable.

  • documentation (String) (defaults to: :unset) —

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

  • policies (String) (defaults to: :unset) —

    A JSON object describing the Listing’s privacy and legal policies. The maximum file size for Policies is 5MB.

  • support (String) (defaults to: :unset) —

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

  • configuration (String) (defaults to: :unset) —

    A JSON object for providing Listing-specific configuration. Contains button setup, notification URL, and more.

  • pricing (String) (defaults to: :unset) —

    A JSON object for providing Listing’s purchase options.

Returns:



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data_management.rb', line 279

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

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

#url ⇒ String

Returns URL to query the subresource.

Returns:

  • (String) —

    URL to query the subresource.



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

def url
    @properties['url']
end