Class: Twilio::REST::Preview::BulkExports::ExportConfigurationContext

Inherits:
InstanceContext
  • 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, resource_type) ⇒ ExportConfigurationContext

Initialize the ExportConfigurationContext

Parameters:

  • version (Version)

    Version that contains the resource

  • resource_type (String)

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


74
75
76
77
78
79
80
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export_configuration.rb', line 74

def initialize(version, resource_type)
  super(version)

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

Instance Method Details

#fetchExportConfigurationInstance

Fetch the ExportConfigurationInstance

Returns:


85
86
87
88
89
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export_configuration.rb', line 85

def fetch
  payload = @version.fetch('GET', @uri)

  ExportConfigurationInstance.new(@version, payload, resource_type: @solution[:resource_type], )
end

#inspectObject

Provide a detailed, user friendly representation


122
123
124
125
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export_configuration.rb', line 122

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

#to_sObject

Provide a user friendly representation


115
116
117
118
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export_configuration.rb', line 115

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


101
102
103
104
105
106
107
108
109
110
111
# File 'lib/twilio-ruby/rest/preview/bulk_exports/export_configuration.rb', line 101

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

  payload = @version.update('POST', @uri, data: data)

  ExportConfigurationInstance.new(@version, payload, resource_type: @solution[:resource_type], )
end