Class: Twilio::REST::Marketplace::V1::ModuleDataList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ ModuleDataList

Initialize the ModuleDataList

Parameters:

  • version (Version) —

    Version that contains the resource



26
27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 26

def initialize(version)
    super(version)
    
    # Path Solution
    @solution = {  }
    @uri = "/Listings"
    
end

Instance Method Details

#create(module_info: :unset, configuration: :unset) ⇒ ModuleDataInstance

Create the ModuleDataInstance

Parameters:

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

    A JSON object containing essential attributes that define a Listing.

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

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

Returns:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 39

def create(
    module_info: :unset, 
    configuration: :unset
)

    data = Twilio::Values.of({
        'ModuleInfo' => module_info,
        'Configuration' => configuration,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    ModuleDataInstance.new(
        @version,
        payload,
    )
end

#create_with_metadata(module_info: :unset, configuration: :unset) ⇒ ModuleDataInstance

Create the ModuleDataInstanceMetadata

Parameters:

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

    A JSON object containing essential attributes that define a Listing.

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

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

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 67

def create_with_metadata(
  module_info: :unset, 
  configuration: :unset
)

    data = Twilio::Values.of({
        'ModuleInfo' => module_info,
        'Configuration' => configuration,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    module_data_instance = ModuleDataInstance.new(
        @version,
        response.body,
    )
    ModuleDataInstanceMetadata.new(
        @version,
        module_data_instance,
        response.headers,
        response.status_code
    )
end

#fetch ⇒ ModuleDataInstance

Fetch the ModuleDataInstance

Returns:



99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 99

def fetch

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

#fetch_with_metadata ⇒ ModuleDataInstance

Fetch the ModuleDataInstanceMetadata

Returns:



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 117

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    module_data_instance = ModuleDataInstance.new(
        @version,
        response.body,
    )
    ModuleDataInstanceMetadata.new(
        @version,
        module_data_instance,
        response.headers,
        response.status_code
    )
end

#to_s ⇒ Object

Provide a user friendly representation



142
143
144
 
# File 'lib/twilio-ruby/rest/marketplace/v1/module_data.rb', line 142

def to_s
    '#<Twilio.Marketplace.V1.ModuleDataList>'
end