Class: Twilio::REST::Bulkexports::V1::ExportConfigurationContext

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

Instance Method Summary collapse

Constructor Details

#initialize(version, resource_type) ⇒ ExportConfigurationContext

Initialize the ExportConfigurationContext

Parameters:

  • Version that contains the resource

  • The type of communication – Messages, Calls, Conferences, and Participants



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export_configuration.rb', line 50

def initialize(version, resource_type)
    super(version)
    

    # Path Solution
    @solution = { resource_type: resource_type,  }
    @uri = "/Exports/#{@solution[:resource_type]}/Configuration"

    
end

Instance Method Details

#fetch ⇒ ExportConfigurationInstance

Fetch the ExportConfigurationInstance

Returns:

  • Fetched ExportConfigurationInstance



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export_configuration.rb', line 63

def fetch

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

#fetch_with_metadata ⇒ ExportConfigurationInstance

Fetch the ExportConfigurationInstanceMetadata

Returns:

  • Fetched ExportConfigurationInstance



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export_configuration.rb', line 82

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    export_configuration_instance = ExportConfigurationInstance.new(
        @version,
        response.body,
        resource_type: @solution[:resource_type],
    )
    ExportConfigurationInstanceMetadata.new(
        @version,
        export_configuration_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



184
185
186
187
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export_configuration.rb', line 184

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

#to_s ⇒ Object

Provide a user friendly representation



177
178
179
180
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export_configuration.rb', line 177

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

#update(enabled: :unset, webhook_url: :unset, webhook_method: :unset) ⇒ ExportConfigurationInstance

Update the ExportConfigurationInstance

Parameters:

  • (defaults to: :unset)

    If true, Twilio will automatically generate every day’s file when the day is over.

  • (defaults to: :unset)

    Stores the URL destination for the method specified in webhook_method.

  • (defaults to: :unset)

    Sets whether Twilio should call a webhook URL when the automatic generation is complete, using GET or POST. The actual destination is set in the webhook_url

Returns:

  • Updated ExportConfigurationInstance



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export_configuration.rb', line 110

def update(
    enabled: :unset, 
    webhook_url: :unset, 
    webhook_method: :unset
)

    data = Twilio::Values.of({
        'Enabled' => enabled,
        'WebhookUrl' => webhook_url,
        'WebhookMethod' => webhook_method,
    })

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

#update_with_metadata(enabled: :unset, webhook_url: :unset, webhook_method: :unset) ⇒ ExportConfigurationInstance

Update the ExportConfigurationInstanceMetadata

Parameters:

  • (defaults to: :unset)

    If true, Twilio will automatically generate every day’s file when the day is over.

  • (defaults to: :unset)

    Stores the URL destination for the method specified in webhook_method.

  • (defaults to: :unset)

    Sets whether Twilio should call a webhook URL when the automatic generation is complete, using GET or POST. The actual destination is set in the webhook_url

Returns:

  • Updated ExportConfigurationInstance



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export_configuration.rb', line 142

def update_with_metadata(
  enabled: :unset, 
  webhook_url: :unset, 
  webhook_method: :unset
)

    data = Twilio::Values.of({
        'Enabled' => enabled,
        'WebhookUrl' => webhook_url,
        'WebhookMethod' => webhook_method,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
    export_configuration_instance = ExportConfigurationInstance.new(
        @version,
        response.body,
        resource_type: @solution[:resource_type],
    )
    ExportConfigurationInstanceMetadata.new(
        @version,
        export_configuration_instance,
        response.headers,
        response.status_code
    )
end