Class: Twilio::REST::Bulkexports::V1::ExportContext

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/bulkexports/v1/export.rb,
lib/twilio-ruby/rest/bulkexports/v1/export/day.rb,
lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb

Defined Under Namespace

Classes: DayContext, DayInstance, DayInstanceMetadata, DayList, DayListResponse, DayPage, DayPageMetadata, ExportCustomJobInstance, ExportCustomJobList, ExportCustomJobListResponse, ExportCustomJobPage, ExportCustomJobPageMetadata

Instance Method Summary collapse

Constructor Details

#initialize(version, resource_type) ⇒ ExportContext

Initialize the ExportContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • resource_type (String) —

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



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

def initialize(version, resource_type)
    super(version)
    

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

    # Dependents
    @export_custom_jobs = nil
    @days = nil
end

Instance Method Details

#days(day = :unset) ⇒ DayList, DayContext

Access the days

Returns:

Raises:

  • (ArgumentError) 


135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export.rb', line 135

def days(day=:unset)

    raise ArgumentError, 'day cannot be nil' if day.nil?

    if day != :unset
        return DayContext.new(@version, @solution[:resource_type],day )
    end

    unless @days
        @days = DayList.new(
            @version, resource_type: @solution[:resource_type], )
    end

 @days
end

#export_custom_jobs ⇒ ExportCustomJobList, ExportCustomJobContext

Access the export_custom_jobs

Returns:



124
125
126
127
128
129
130
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export.rb', line 124

def export_custom_jobs
  unless @export_custom_jobs
    @export_custom_jobs = ExportCustomJobList.new(
            @version, resource_type: @solution[:resource_type], )
  end
  @export_custom_jobs
end

#fetch ⇒ ExportInstance

Fetch the ExportInstance

Returns:



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export.rb', line 79

def fetch

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

#fetch_with_metadata ⇒ ExportInstance

Fetch the ExportInstanceMetadata

Returns:



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export.rb', line 98

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_instance = ExportInstance.new(
        @version,
        response.body,
        resource_type: @solution[:resource_type],
    )
    ExportInstanceMetadata.new(
        @version,
        export_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



160
161
162
163
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export.rb', line 160

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

#to_s ⇒ Object

Provide a user friendly representation



153
154
155
156
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export.rb', line 153

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