Class: Fn::RoutesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RoutesApi

Returns a new instance of RoutesApi.



19
20
21
 
# File 'lib/fn_ruby/api/routes_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/routes_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#apps_app_routes_get(app, opts = {}) ⇒ RoutesWrapper

Get route list by app name. This will list routes for a particular app, returned in alphabetical order.

Parameters:

  • app —

    Name of app for this set of routes.

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

    the optional parameters

Options Hash (opts):

  • :image (String) —

    Route image 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.

Returns:



31
32
33
34
 
# File 'lib/fn_ruby/api/routes_api.rb', line 31

def apps_app_routes_get(app, opts = {})
  data, _status_code, _headers = apps_app_routes_get_with_http_info(app, opts)
  return data
end

#apps_app_routes_get_with_http_info(app, opts = {}) ⇒ Array<(RoutesWrapper, Fixnum, Hash)>

Get route list by app name. This will list routes for a particular app, returned in alphabetical order.

Parameters:

  • app —

    Name of app for this set of routes.

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

    the optional parameters

Options Hash (opts):

  • :image (String) —

    Route image 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.

Returns:

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

    RoutesWrapper data, response status code and response headers



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
83
84
85
 
# File 'lib/fn_ruby/api/routes_api.rb', line 44

def apps_app_routes_get_with_http_info(app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutesApi.apps_app_routes_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 RoutesApi.apps_app_routes_get"
  end
  # resource path
  local_var_path = "/apps/{app}/routes".sub('{' + 'app' + '}', app.to_s)

  # query parameters
  query_params = {}
  query_params[:'image'] = opts[:'image'] if !opts[:'image'].nil?
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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 => 'RoutesWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutesApi#apps_app_routes_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#apps_app_routes_post(app, body, opts = {}) ⇒ RouteWrapper

Create new Route Create a new route in an app, if app doesn’t exists, it creates the app. Post does not skip validation of zero values.

Parameters:

  • app —

    name of the app.

  • body —

    One route to post.

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

    the optional parameters

Returns:



93
94
95
96
 
# File 'lib/fn_ruby/api/routes_api.rb', line 93

def apps_app_routes_post(app, body, opts = {})
  data, _status_code, _headers = apps_app_routes_post_with_http_info(app, body, opts)
  return data
end

#apps_app_routes_post_with_http_info(app, body, opts = {}) ⇒ Array<(RouteWrapper, Fixnum, Hash)>

Create new Route Create a new route in an app, if app doesn&#39;t exists, it creates the app. Post does not skip validation of zero values.

Parameters:

  • app —

    name of the app.

  • body —

    One route to post.

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

    the optional parameters

Returns:

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

    RouteWrapper data, response status code and response headers



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
143
144
145
146
 
# File 'lib/fn_ruby/api/routes_api.rb', line 104

def apps_app_routes_post_with_http_info(app, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutesApi.apps_app_routes_post ..."
  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 RoutesApi.apps_app_routes_post"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling RoutesApi.apps_app_routes_post"
  end
  # resource path
  local_var_path = "/apps/{app}/routes".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 = @api_client.object_to_http_body(body)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RouteWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutesApi#apps_app_routes_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#apps_app_routes_route_delete(app, route, opts = {}) ⇒ nil

Deletes the route Deletes the route.

Parameters:

  • app —

    Name of app for this set of routes.

  • route —

    Route name

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

    the optional parameters

Returns:

  • (nil) 


154
155
156
157
 
# File 'lib/fn_ruby/api/routes_api.rb', line 154

def apps_app_routes_route_delete(app, route, opts = {})
  apps_app_routes_route_delete_with_http_info(app, route, opts)
  return nil
end

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

Deletes the route Deletes the route.

Parameters:

  • app —

    Name of app for this set of routes.

  • route —

    Route name

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
204
205
206
 
# File 'lib/fn_ruby/api/routes_api.rb', line 165

def apps_app_routes_route_delete_with_http_info(app, route, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutesApi.apps_app_routes_route_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 RoutesApi.apps_app_routes_route_delete"
  end
  # verify the required parameter 'route' is set
  if @api_client.config.client_side_validation && route.nil?
    fail ArgumentError, "Missing the required parameter 'route' when calling RoutesApi.apps_app_routes_route_delete"
  end
  # resource path
  local_var_path = "/apps/{app}/routes/{route}".sub('{' + 'app' + '}', app.to_s).sub('{' + 'route' + '}', route.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: RoutesApi#apps_app_routes_route_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#apps_app_routes_route_get(app, route, opts = {}) ⇒ RouteWrapper

Gets route by name Gets a route by name.

Parameters:

  • app —

    Name of app for this set of routes.

  • route —

    Route name

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

    the optional parameters

Returns:



214
215
216
217
 
# File 'lib/fn_ruby/api/routes_api.rb', line 214

def apps_app_routes_route_get(app, route, opts = {})
  data, _status_code, _headers = apps_app_routes_route_get_with_http_info(app, route, opts)
  return data
end

#apps_app_routes_route_get_with_http_info(app, route, opts = {}) ⇒ Array<(RouteWrapper, Fixnum, Hash)>

Gets route by name Gets a route by name.

Parameters:

  • app —

    Name of app for this set of routes.

  • route —

    Route name

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

    the optional parameters

Returns:

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

    RouteWrapper data, response status code and response headers



225
226
227
228
229
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
 
# File 'lib/fn_ruby/api/routes_api.rb', line 225

def apps_app_routes_route_get_with_http_info(app, route, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutesApi.apps_app_routes_route_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 RoutesApi.apps_app_routes_route_get"
  end
  # verify the required parameter 'route' is set
  if @api_client.config.client_side_validation && route.nil?
    fail ArgumentError, "Missing the required parameter 'route' when calling RoutesApi.apps_app_routes_route_get"
  end
  # resource path
  local_var_path = "/apps/{app}/routes/{route}".sub('{' + 'app' + '}', app.to_s).sub('{' + 'route' + '}', route.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 => 'RouteWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutesApi#apps_app_routes_route_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#apps_app_routes_route_patch(app, route, body, opts = {}) ⇒ RouteWrapper

Update a Route, Fails if the route or app does not exist. Accepts partial updates / skips validation of zero values. Update a route

Parameters:

  • app —

    name of the app.

  • route —

    route path.

  • body —

    One route to post.

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

    the optional parameters

Returns:



276
277
278
279
 
# File 'lib/fn_ruby/api/routes_api.rb', line 276

def apps_app_routes_route_patch(app, route, body, opts = {})
  data, _status_code, _headers = apps_app_routes_route_patch_with_http_info(app, route, body, opts)
  return data
end

#apps_app_routes_route_patch_with_http_info(app, route, body, opts = {}) ⇒ Array<(RouteWrapper, Fixnum, Hash)>

Update a Route, Fails if the route or app does not exist. Accepts partial updates / skips validation of zero values. Update a route

Parameters:

  • app —

    name of the app.

  • route —

    route path.

  • body —

    One route to post.

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

    the optional parameters

Returns:

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

    RouteWrapper data, response status code and response headers



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/fn_ruby/api/routes_api.rb', line 288

def apps_app_routes_route_patch_with_http_info(app, route, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutesApi.apps_app_routes_route_patch ..."
  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 RoutesApi.apps_app_routes_route_patch"
  end
  # verify the required parameter 'route' is set
  if @api_client.config.client_side_validation && route.nil?
    fail ArgumentError, "Missing the required parameter 'route' when calling RoutesApi.apps_app_routes_route_patch"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling RoutesApi.apps_app_routes_route_patch"
  end
  # resource path
  local_var_path = "/apps/{app}/routes/{route}".sub('{' + 'app' + '}', app.to_s).sub('{' + 'route' + '}', route.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 = @api_client.object_to_http_body(body)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RouteWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutesApi#apps_app_routes_route_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#apps_app_routes_route_put(app, route, body, opts = {}) ⇒ RouteWrapper

Create a Route if it does not exist. Update if it does. Will also create app if it does not exist. Put does not skip validation of zero values Update or Create a route

Parameters:

  • app —

    name of the app.

  • route —

    route path.

  • body —

    One route to post.

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

    the optional parameters

Returns:



343
344
345
346
 
# File 'lib/fn_ruby/api/routes_api.rb', line 343

def apps_app_routes_route_put(app, route, body, opts = {})
  data, _status_code, _headers = apps_app_routes_route_put_with_http_info(app, route, body, opts)
  return data
end

#apps_app_routes_route_put_with_http_info(app, route, body, opts = {}) ⇒ Array<(RouteWrapper, Fixnum, Hash)>

Create a Route if it does not exist. Update if it does. Will also create app if it does not exist. Put does not skip validation of zero values Update or Create a route

Parameters:

  • app —

    name of the app.

  • route —

    route path.

  • body —

    One route to post.

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

    the optional parameters

Returns:

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

    RouteWrapper data, response status code and response headers



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/fn_ruby/api/routes_api.rb', line 355

def apps_app_routes_route_put_with_http_info(app, route, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutesApi.apps_app_routes_route_put ..."
  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 RoutesApi.apps_app_routes_route_put"
  end
  # verify the required parameter 'route' is set
  if @api_client.config.client_side_validation && route.nil?
    fail ArgumentError, "Missing the required parameter 'route' when calling RoutesApi.apps_app_routes_route_put"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling RoutesApi.apps_app_routes_route_put"
  end
  # resource path
  local_var_path = "/apps/{app}/routes/{route}".sub('{' + 'app' + '}', app.to_s).sub('{' + 'route' + '}', route.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 = @api_client.object_to_http_body(body)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RouteWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutesApi#apps_app_routes_route_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end