Class: Twilio::REST::Marketplace::V1::ModuleDataManagementContext

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

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ ModuleDataManagementContext

Initialize the ModuleDataManagementContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    SID that uniquely identifies the Listing.



49
50
51
52
53
54
55
56
57
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data_management.rb', line 49

def initialize(version, sid)
    super(version)

    # Path Solution
    @solution = { sid: sid,  }
    @uri = "/Listing/#{@solution[:sid]}"

    
end

Instance Method Details

#fetch ⇒ ModuleDataManagementInstance

Fetch the ModuleDataManagementInstance

Returns:



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data_management.rb', line 61

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    payload = @version.fetch('GET', @uri, headers: headers)
    ModuleDataManagementInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



123
124
125
126
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data_management.rb', line 123

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

#to_s ⇒ Object

Provide a user friendly representation



116
117
118
119
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data_management.rb', line 116

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Marketplace.V1.ModuleDataManagementContext #{context}>"
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:



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data_management.rb', line 83

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

    data = Twilio::Values.of({
        'ModuleInfo' => module_info,
        'Description' => description,
        'Documentation' => documentation,
        'Policies' => policies,
        'Support' => support,
        'Configuration' => configuration,
        'Pricing' => pricing,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    ModuleDataManagementInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end