Class: Fastly::ResponseObjectApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/api/response_object_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ResponseObjectApi

Returns a new instance of ResponseObjectApi.



17
18
19
 
# File 'lib/fastly/api/response_object_api.rb', line 17

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/fastly/api/response_object_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#create_response_object(opts = {}) ⇒ ResponseObjectResponse

Create a Response object Creates a new Response Object.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :create_response_object_request (CreateResponseObjectRequest)

Returns:



26
27
28
29
 
# File 'lib/fastly/api/response_object_api.rb', line 26

def create_response_object(opts = {})
  data, _status_code, _headers = create_response_object_with_http_info(opts)
  data
end

#create_response_object_with_http_info(opts = {}) ⇒ Array<(ResponseObjectResponse, Integer, Hash)>

Create a Response object Creates a new Response Object.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :create_response_object_request (CreateResponseObjectRequest)

Returns:

  • (Array<(ResponseObjectResponse, Integer, Hash)>) —

    ResponseObjectResponse data, response status code and response headers



37
38
39
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
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/fastly/api/response_object_api.rb', line 37

def create_response_object_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResponseObjectApi.create_response_object ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling ResponseObjectApi.create_response_object"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling ResponseObjectApi.create_response_object"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/response_object'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_response_object_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'ResponseObjectResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"ResponseObjectApi.create_response_object",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResponseObjectApi#create_response_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_response_object(opts = {}) ⇒ InlineResponse200

Delete a Response Object Deletes the specified Response Object.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :response_object_name (String) —

    Name for the request settings. (required)

Returns:



103
104
105
106
 
# File 'lib/fastly/api/response_object_api.rb', line 103

def delete_response_object(opts = {})
  data, _status_code, _headers = delete_response_object_with_http_info(opts)
  data
end

#delete_response_object_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>

Delete a Response Object Deletes the specified Response Object.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :response_object_name (String) —

    Name for the request settings. (required)

Returns:

  • (Array<(InlineResponse200, Integer, Hash)>) —

    InlineResponse200 data, response status code and response headers



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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/fastly/api/response_object_api.rb', line 114

def delete_response_object_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResponseObjectApi.delete_response_object ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  response_object_name = opts[:'response_object_name']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling ResponseObjectApi.delete_response_object"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling ResponseObjectApi.delete_response_object"
  end
  # verify the required parameter 'response_object_name' is set
  if @api_client.config.client_side_validation && response_object_name.nil?
    fail ArgumentError, "Missing the required parameter 'response_object_name' when calling ResponseObjectApi.delete_response_object"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/response_object/{response_object_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'response_object_name' + '}', CGI.escape(response_object_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'InlineResponse200'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"ResponseObjectApi.delete_response_object",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResponseObjectApi#delete_response_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_response_object(opts = {}) ⇒ ResponseObjectResponse

Get a Response object Gets the specified Response Object.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :response_object_name (String) —

    Name for the request settings. (required)

Returns:



180
181
182
183
 
# File 'lib/fastly/api/response_object_api.rb', line 180

def get_response_object(opts = {})
  data, _status_code, _headers = get_response_object_with_http_info(opts)
  data
end

#get_response_object_with_http_info(opts = {}) ⇒ Array<(ResponseObjectResponse, Integer, Hash)>

Get a Response object Gets the specified Response Object.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :response_object_name (String) —

    Name for the request settings. (required)

Returns:

  • (Array<(ResponseObjectResponse, Integer, Hash)>) —

    ResponseObjectResponse data, response status code and response headers



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
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
 
# File 'lib/fastly/api/response_object_api.rb', line 191

def get_response_object_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResponseObjectApi.get_response_object ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  response_object_name = opts[:'response_object_name']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling ResponseObjectApi.get_response_object"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling ResponseObjectApi.get_response_object"
  end
  # verify the required parameter 'response_object_name' is set
  if @api_client.config.client_side_validation && response_object_name.nil?
    fail ArgumentError, "Missing the required parameter 'response_object_name' when calling ResponseObjectApi.get_response_object"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/response_object/{response_object_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'response_object_name' + '}', CGI.escape(response_object_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ResponseObjectResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"ResponseObjectApi.get_response_object",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResponseObjectApi#get_response_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_response_objects(opts = {}) ⇒ Array<ResponseObjectResponse>

List Response objects Returns all Response Objects for the specified service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

Returns:



256
257
258
259
 
# File 'lib/fastly/api/response_object_api.rb', line 256

def list_response_objects(opts = {})
  data, _status_code, _headers = list_response_objects_with_http_info(opts)
  data
end

#list_response_objects_with_http_info(opts = {}) ⇒ Array<(Array<ResponseObjectResponse>, Integer, Hash)>

List Response objects Returns all Response Objects for the specified service and version.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

Returns:

  • (Array<(Array<ResponseObjectResponse>, Integer, Hash)>) —

    Array<ResponseObjectResponse> data, response status code and response headers



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
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
 
# File 'lib/fastly/api/response_object_api.rb', line 266

def list_response_objects_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResponseObjectApi.list_response_objects ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling ResponseObjectApi.list_response_objects"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling ResponseObjectApi.list_response_objects"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/response_object'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<ResponseObjectResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"ResponseObjectApi.list_response_objects",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResponseObjectApi#list_response_objects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_response_object(opts = {}) ⇒ ResponseObjectResponse

Update a Response object Updates the specified Response Object.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :response_object_name (String) —

    Name for the request settings. (required)

  • :create_response_object_request (CreateResponseObjectRequest)

Returns:



328
329
330
331
 
# File 'lib/fastly/api/response_object_api.rb', line 328

def update_response_object(opts = {})
  data, _status_code, _headers = update_response_object_with_http_info(opts)
  data
end

#update_response_object_with_http_info(opts = {}) ⇒ Array<(ResponseObjectResponse, Integer, Hash)>

Update a Response object Updates the specified Response Object.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :response_object_name (String) —

    Name for the request settings. (required)

  • :create_response_object_request (CreateResponseObjectRequest)

Returns:

  • (Array<(ResponseObjectResponse, Integer, Hash)>) —

    ResponseObjectResponse data, response status code and response headers



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
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
402
403
 
# File 'lib/fastly/api/response_object_api.rb', line 340

def update_response_object_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResponseObjectApi.update_response_object ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  response_object_name = opts[:'response_object_name']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling ResponseObjectApi.update_response_object"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling ResponseObjectApi.update_response_object"
  end
  # verify the required parameter 'response_object_name' is set
  if @api_client.config.client_side_validation && response_object_name.nil?
    fail ArgumentError, "Missing the required parameter 'response_object_name' when calling ResponseObjectApi.update_response_object"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/response_object/{response_object_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'response_object_name' + '}', CGI.escape(response_object_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_response_object_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'ResponseObjectResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"ResponseObjectApi.update_response_object",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ResponseObjectApi#update_response_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end