Class: IronFunctions::RoutesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/iron_functions/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.



30
31
32
 
# File 'lib/iron_functions/api/routes_api.rb', line 30

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



28
29
30
 
# File 'lib/iron_functions/api/routes_api.rb', line 28

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.

Parameters:

  • app —

    Name of app for this set of routes.

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

    the optional parameters

Returns:



39
40
41
42
 
# File 'lib/iron_functions/api/routes_api.rb', line 39

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.

Parameters:

  • app —

    Name of app for this set of routes.

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

    the optional parameters

Returns:

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

    RoutesWrapper data, response status code and response headers



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
86
87
88
89
 
# File 'lib/iron_functions/api/routes_api.rb', line 49

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
  fail ArgumentError, "Missing the required parameter 'app' when calling RoutesApi.apps_app_routes_get" if app.nil?
  # resource path
  local_var_path = "/apps/{app}/routes".sub('{format}','json').sub('{' + 'app' + '}', app.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # 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

Parameters:

  • app —

    name of the app.

  • body —

    One route to post.

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

    the optional parameters

Returns:



97
98
99
100
 
# File 'lib/iron_functions/api/routes_api.rb', line 97

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

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



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
147
148
149
150
 
# File 'lib/iron_functions/api/routes_api.rb', line 108

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
  fail ArgumentError, "Missing the required parameter 'app' when calling RoutesApi.apps_app_routes_post" if app.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutesApi.apps_app_routes_post" if body.nil?
  # resource path
  local_var_path = "/apps/{app}/routes".sub('{format}','json').sub('{' + 'app' + '}', app.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # 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) 


158
159
160
161
 
# File 'lib/iron_functions/api/routes_api.rb', line 158

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



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
207
208
209
210
 
# File 'lib/iron_functions/api/routes_api.rb', line 169

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
  fail ArgumentError, "Missing the required parameter 'app' when calling RoutesApi.apps_app_routes_route_delete" if app.nil?
  # verify the required parameter 'route' is set
  fail ArgumentError, "Missing the required parameter 'route' when calling RoutesApi.apps_app_routes_route_delete" if route.nil?
  # resource path
  local_var_path = "/apps/{app}/routes/{route}".sub('{format}','json').sub('{' + 'app' + '}', app.to_s).sub('{' + 'route' + '}', route.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # 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:



218
219
220
221
 
# File 'lib/iron_functions/api/routes_api.rb', line 218

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



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
268
269
270
271
 
# File 'lib/iron_functions/api/routes_api.rb', line 229

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
  fail ArgumentError, "Missing the required parameter 'app' when calling RoutesApi.apps_app_routes_route_get" if app.nil?
  # verify the required parameter 'route' is set
  fail ArgumentError, "Missing the required parameter 'route' when calling RoutesApi.apps_app_routes_route_get" if route.nil?
  # resource path
  local_var_path = "/apps/{app}/routes/{route}".sub('{format}','json').sub('{' + 'app' + '}', app.to_s).sub('{' + 'route' + '}', route.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # 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