Class: Fn::CallApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fn_ruby/api/call_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CallApi

Returns a new instance of CallApi.



19
20
21
 
# File 'lib/fn_ruby/api/call_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/fn_ruby/api/call_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#apps_app_calls_call_get(app, call, opts = {}) ⇒ CallWrapper

Get call information Get call information

Parameters:

  • app —

    app name

  • call —

    Call ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/fn_ruby/api/call_api.rb', line 29

def apps_app_calls_call_get(app, call, opts = {})
  data, _status_code, _headers = apps_app_calls_call_get_with_http_info(app, call, opts)
  return data
end

#apps_app_calls_call_get_with_http_info(app, call, opts = {}) ⇒ Array<(CallWrapper, Fixnum, Hash)>

Get call information Get call information

Parameters:

  • app —

    app name

  • call —

    Call ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CallWrapper, Fixnum, Hash)>) —

    CallWrapper data, response status code and response headers



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/fn_ruby/api/call_api.rb', line 40

def apps_app_calls_call_get_with_http_info(app, call, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CallApi.apps_app_calls_call_get ..."
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling CallApi.apps_app_calls_call_get"
  end
  # verify the required parameter 'call' is set
  if @api_client.config.client_side_validation && call.nil?
    fail ArgumentError, "Missing the required parameter 'call' when calling CallApi.apps_app_calls_call_get"
  end
  # resource path
  local_var_path = "/apps/{app}/calls/{call}".sub('{' + 'app' + '}', app.to_s).sub('{' + 'call' + '}', call.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CallWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CallApi#apps_app_calls_call_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#apps_app_calls_call_log_delete(call, app, opts = {}) ⇒ nil

Delete call log entry Delete call log entry

Parameters:

  • call —

    Call ID.

  • app —

    App name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


90
91
92
93
 
# File 'lib/fn_ruby/api/call_api.rb', line 90

def apps_app_calls_call_log_delete(call, app, opts = {})
  apps_app_calls_call_log_delete_with_http_info(call, app, opts)
  return nil
end

#apps_app_calls_call_log_delete_with_http_info(call, app, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete call log entry Delete call log entry

Parameters:

  • call —

    Call ID.

  • app —

    App name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



101
102
103
104
105
106
107
108
109
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
135
136
137
138
139
140
141
142
 
# File 'lib/fn_ruby/api/call_api.rb', line 101

def apps_app_calls_call_log_delete_with_http_info(call, app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CallApi.apps_app_calls_call_log_delete ..."
  end
  # verify the required parameter 'call' is set
  if @api_client.config.client_side_validation && call.nil?
    fail ArgumentError, "Missing the required parameter 'call' when calling CallApi.apps_app_calls_call_log_delete"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling CallApi.apps_app_calls_call_log_delete"
  end
  # resource path
  local_var_path = "/apps/{app}/calls/{call}/log".sub('{' + 'call' + '}', call.to_s).sub('{' + 'app' + '}', app.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CallApi#apps_app_calls_call_log_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#apps_app_calls_call_log_get(app, call, opts = {}) ⇒ LogWrapper

Get call logs Get call logs

Parameters:

  • app —

    App Name

  • call —

    Call ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



150
151
152
153
 
# File 'lib/fn_ruby/api/call_api.rb', line 150

def apps_app_calls_call_log_get(app, call, opts = {})
  data, _status_code, _headers = apps_app_calls_call_log_get_with_http_info(app, call, opts)
  return data
end

#apps_app_calls_call_log_get_with_http_info(app, call, opts = {}) ⇒ Array<(LogWrapper, Fixnum, Hash)>

Get call logs Get call logs

Parameters:

  • app —

    App Name

  • call —

    Call ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LogWrapper, Fixnum, Hash)>) —

    LogWrapper data, response status code and response headers



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/fn_ruby/api/call_api.rb', line 161

def apps_app_calls_call_log_get_with_http_info(app, call, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CallApi.apps_app_calls_call_log_get ..."
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling CallApi.apps_app_calls_call_log_get"
  end
  # verify the required parameter 'call' is set
  if @api_client.config.client_side_validation && call.nil?
    fail ArgumentError, "Missing the required parameter 'call' when calling CallApi.apps_app_calls_call_log_get"
  end
  # resource path
  local_var_path = "/apps/{app}/calls/{call}/log".sub('{' + 'app' + '}', app.to_s).sub('{' + 'call' + '}', call.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LogWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CallApi#apps_app_calls_call_log_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#apps_app_calls_get(app, opts = {}) ⇒ CallsWrapper

Get app-bound calls. Get app-bound calls can filter to route-bound calls, results returned in created_at, descending order (newest first).

Parameters:

  • app —

    App name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :path (String) —

    Route path to match, exact.

  • :cursor (String) —

    Cursor from previous response.next_cursor to begin results after, if any.

  • :per_page (Integer) —

    Number of results to return, defaults to 30. Max of 100.

  • :from_time (Integer) —

    Unix timestamp in seconds, of call.created_at to begin the results at, default 0.

  • :to_time (Integer) —

    Unix timestamp in seconds, of call.created_at to end the results at, defaults to latest.

Returns:



215
216
217
218
 
# File 'lib/fn_ruby/api/call_api.rb', line 215

def apps_app_calls_get(app, opts = {})
  data, _status_code, _headers = apps_app_calls_get_with_http_info(app, opts)
  return data
end

#apps_app_calls_get_with_http_info(app, opts = {}) ⇒ Array<(CallsWrapper, Fixnum, Hash)>

Get app-bound calls. Get app-bound calls can filter to route-bound calls, results returned in created_at, descending order (newest first).

Parameters:

  • app —

    App name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :path (String) —

    Route path to match, exact.

  • :cursor (String) —

    Cursor from previous response.next_cursor to begin results after, if any.

  • :per_page (Integer) —

    Number of results to return, defaults to 30. Max of 100.

  • :from_time (Integer) —

    Unix timestamp in seconds, of call.created_at to begin the results at, default 0.

  • :to_time (Integer) —

    Unix timestamp in seconds, of call.created_at to end the results at, defaults to latest.

Returns:

  • (Array<(CallsWrapper, Fixnum, Hash)>) —

    CallsWrapper data, response status code and response headers



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/fn_ruby/api/call_api.rb', line 230

def apps_app_calls_get_with_http_info(app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CallApi.apps_app_calls_get ..."
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling CallApi.apps_app_calls_get"
  end
  # resource path
  local_var_path = "/apps/{app}/calls".sub('{' + 'app' + '}', app.to_s)

  # query parameters
  query_params = {}
  query_params[:'path'] = opts[:'path'] if !opts[:'path'].nil?
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'from_time'] = opts[:'from_time'] if !opts[:'from_time'].nil?
  query_params[:'to_time'] = opts[:'to_time'] if !opts[:'to_time'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CallsWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CallApi#apps_app_calls_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end