Class: Twilio::REST::Preview::BulkExports::ExportConfigurationInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/bulk_exports/export_configuration.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected]

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, resource_type: nil) ⇒ ExportConfigurationInstance

Initialize the ExportConfigurationInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • resource_type (String) (defaults to: nil) —

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


138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export_configuration.rb', line 138

def initialize(version, payload, resource_type: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'enabled' => payload['enabled'],
      'webhook_url' => payload['webhook_url'],
      'webhook_method' => payload['webhook_method'],
      'resource_type' => payload['resource_type'],
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {'resource_type' => resource_type || @properties['resource_type'], }
end

Instance Method Details

#context ⇒ ExportConfigurationContext

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

Returns:


159
160
161
162
163
164
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export_configuration.rb', line 159

def context
  unless @instance_context
    @instance_context = ExportConfigurationContext.new(@version, @params['resource_type'], )
  end
  @instance_context
end

#enabled ⇒ Boolean

Returns Whether files are automatically generated.

Returns:

  • (Boolean) —

    Whether files are automatically generated


168
169
170
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export_configuration.rb', line 168

def enabled
  @properties['enabled']
end

#fetch ⇒ ExportConfigurationInstance

Fetch the ExportConfigurationInstance

Returns:


199
200
201
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export_configuration.rb', line 199

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


226
227
228
229
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export_configuration.rb', line 226

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Preview.BulkExports.ExportConfigurationInstance #{values}>"
end

#resource_type ⇒ String

Returns The type of communication – Messages, Calls, Conferences, and Participants.

Returns:

  • (String) —

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


186
187
188
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export_configuration.rb', line 186

def resource_type
  @properties['resource_type']
end

#to_s ⇒ Object

Provide a user friendly representation


219
220
221
222
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export_configuration.rb', line 219

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Preview.BulkExports.ExportConfigurationInstance #{values}>"
end

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

Update the ExportConfigurationInstance

Parameters:

  • enabled (Boolean) (defaults to: :unset) —

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

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

    Stores the URL destination for the method specified in webhook_method.

  • webhook_method (String) (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:


213
214
215
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export_configuration.rb', line 213

def update(enabled: :unset, webhook_url: :unset, webhook_method: :unset)
  context.update(enabled: enabled, webhook_url: webhook_url, webhook_method: webhook_method, )
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.


192
193
194
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export_configuration.rb', line 192

def url
  @properties['url']
end

#webhook_method ⇒ String

Returns Whether to GET or POST to the webhook url.

Returns:

  • (String) —

    Whether to GET or POST to the webhook url


180
181
182
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export_configuration.rb', line 180

def webhook_method
  @properties['webhook_method']
end

#webhook_url ⇒ String

Returns URL targeted at export.

Returns:

  • (String) —

    URL targeted at export


174
175
176
 
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export_configuration.rb', line 174

def webhook_url
  @properties['webhook_url']
end