Class: Fastly::ApexRedirectApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ApexRedirectApi

Returns a new instance of ApexRedirectApi.



17
18
19
 
# File 'lib/fastly/api/apex_redirect_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/apex_redirect_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#create_apex_redirect(opts = {}) ⇒ ApexRedirect

Create an apex redirect Create an apex redirect for a particular 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)

  • :service_id (String)
  • :version (Integer)
  • :created_at (Time) —

    Date and time in ISO 8601 format.

  • :deleted_at (Time) —

    Date and time in ISO 8601 format.

  • :updated_at (Time) —

    Date and time in ISO 8601 format.

  • :status_code (Integer) —

    HTTP status code used to redirect the client.

  • :domains (Array<String>) —

    Array of apex domains that should redirect to their WWW subdomain.

  • :feature_revision (Integer) —

    Revision number of the apex redirect feature implementation. Defaults to the most recent revision.

Returns:



33
34
35
36
 
# File 'lib/fastly/api/apex_redirect_api.rb', line 33

def create_apex_redirect(opts = {})
  data, _status_code, _headers = create_apex_redirect_with_http_info(opts)
  data
end

#create_apex_redirect_with_http_info(opts = {}) ⇒ Array<(ApexRedirect, Integer, Hash)>

Create an apex redirect Create an apex redirect for a particular 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)

  • :service_id (String)
  • :version (Integer)
  • :created_at (Time) —

    Date and time in ISO 8601 format.

  • :deleted_at (Time) —

    Date and time in ISO 8601 format.

  • :updated_at (Time) —

    Date and time in ISO 8601 format.

  • :status_code (Integer) —

    HTTP status code used to redirect the client.

  • :domains (Array<String>) —

    Array of apex domains that should redirect to their WWW subdomain.

  • :feature_revision (Integer) —

    Revision number of the apex redirect feature implementation. Defaults to the most recent revision.

Returns:

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

    ApexRedirect data, response status code and response headers



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
96
97
98
99
100
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
 
# File 'lib/fastly/api/apex_redirect_api.rb', line 51

def create_apex_redirect_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApexRedirectApi.create_apex_redirect ...'
  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 ApexRedirectApi.create_apex_redirect"
  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 ApexRedirectApi.create_apex_redirect"
  end
  allowable_values = [301, 302, 307, 308]
  if @api_client.config.client_side_validation && opts[:'status_code'] && !allowable_values.include?(opts[:'status_code'])
    fail ArgumentError, "invalid value for \"status_code\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'domains'].nil? && opts[:'domains'].length < 1
    fail ArgumentError, 'invalid value for "opts[:"domains"]" when calling ApexRedirectApi.create_apex_redirect, number of items must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'feature_revision'].nil? && opts[:'feature_revision'] < 1
    fail ArgumentError, 'invalid value for "opts[:"feature_revision"]" when calling ApexRedirectApi.create_apex_redirect, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/apex-redirects'.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/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['service_id'] = opts[:'service_id'] if !opts[:'service_id'].nil?
  form_params['version'] = opts[:'version'] if !opts[:'version'].nil?
  form_params['created_at'] = opts[:'created_at'] if !opts[:'created_at'].nil?
  form_params['deleted_at'] = opts[:'deleted_at'] if !opts[:'deleted_at'].nil?
  form_params['updated_at'] = opts[:'updated_at'] if !opts[:'updated_at'].nil?
  form_params['status_code'] = opts[:'status_code'] if !opts[:'status_code'].nil?
  form_params['domains'] = @api_client.build_collection_param(opts[:'domains'], :csv) if !opts[:'domains'].nil?
  form_params['feature_revision'] = opts[:'feature_revision'] if !opts[:'feature_revision'].nil?

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

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

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

  new_options = opts.merge(
    :operation => :"ApexRedirectApi.create_apex_redirect",
    :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: ApexRedirectApi#create_apex_redirect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_apex_redirect(opts = {}) ⇒ InlineResponse200

Delete an apex redirect Delete an apex redirect by its ID.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :apex_redirect_id (String) — default: required

Returns:



135
136
137
138
 
# File 'lib/fastly/api/apex_redirect_api.rb', line 135

def delete_apex_redirect(opts = {})
  data, _status_code, _headers = delete_apex_redirect_with_http_info(opts)
  data
end

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

Delete an apex redirect Delete an apex redirect by its ID.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :apex_redirect_id (String) — default: required

Returns:

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

    InlineResponse200 data, response status code and response headers



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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/fastly/api/apex_redirect_api.rb', line 144

def delete_apex_redirect_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApexRedirectApi.delete_apex_redirect ...'
  end
  # unbox the parameters from the hash
  apex_redirect_id = opts[:'apex_redirect_id']
  # verify the required parameter 'apex_redirect_id' is set
  if @api_client.config.client_side_validation && apex_redirect_id.nil?
    fail ArgumentError, "Missing the required parameter 'apex_redirect_id' when calling ApexRedirectApi.delete_apex_redirect"
  end
  # resource path
  local_var_path = '/apex-redirects/{apex_redirect_id}'.sub('{' + 'apex_redirect_id' + '}', CGI.escape(apex_redirect_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] || 'InlineResponse200'

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

  new_options = opts.merge(
    :operation => :"ApexRedirectApi.delete_apex_redirect",
    :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: ApexRedirectApi#delete_apex_redirect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_apex_redirect(opts = {}) ⇒ ApexRedirect

Get an apex redirect Get an apex redirect by its ID.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :apex_redirect_id (String) — default: required

Returns:



198
199
200
201
 
# File 'lib/fastly/api/apex_redirect_api.rb', line 198

def get_apex_redirect(opts = {})
  data, _status_code, _headers = get_apex_redirect_with_http_info(opts)
  data
end

#get_apex_redirect_with_http_info(opts = {}) ⇒ Array<(ApexRedirect, Integer, Hash)>

Get an apex redirect Get an apex redirect by its ID.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :apex_redirect_id (String) — default: required

Returns:

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

    ApexRedirect data, response status code and response headers



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
250
251
252
253
254
255
 
# File 'lib/fastly/api/apex_redirect_api.rb', line 207

def get_apex_redirect_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApexRedirectApi.get_apex_redirect ...'
  end
  # unbox the parameters from the hash
  apex_redirect_id = opts[:'apex_redirect_id']
  # verify the required parameter 'apex_redirect_id' is set
  if @api_client.config.client_side_validation && apex_redirect_id.nil?
    fail ArgumentError, "Missing the required parameter 'apex_redirect_id' when calling ApexRedirectApi.get_apex_redirect"
  end
  # resource path
  local_var_path = '/apex-redirects/{apex_redirect_id}'.sub('{' + 'apex_redirect_id' + '}', CGI.escape(apex_redirect_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] || 'ApexRedirect'

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

  new_options = opts.merge(
    :operation => :"ApexRedirectApi.get_apex_redirect",
    :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: ApexRedirectApi#get_apex_redirect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_apex_redirects(opts = {}) ⇒ Array<ApexRedirect>

List apex redirects List all apex redirects for a particular 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:



262
263
264
265
 
# File 'lib/fastly/api/apex_redirect_api.rb', line 262

def list_apex_redirects(opts = {})
  data, _status_code, _headers = list_apex_redirects_with_http_info(opts)
  data
end

#list_apex_redirects_with_http_info(opts = {}) ⇒ Array<(Array<ApexRedirect>, Integer, Hash)>

List apex redirects List all apex redirects for a particular 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<ApexRedirect>, Integer, Hash)>) —

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



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
320
321
322
323
324
325
 
# File 'lib/fastly/api/apex_redirect_api.rb', line 272

def list_apex_redirects_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApexRedirectApi.list_apex_redirects ...'
  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 ApexRedirectApi.list_apex_redirects"
  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 ApexRedirectApi.list_apex_redirects"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/apex-redirects'.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<ApexRedirect>'

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

  new_options = opts.merge(
    :operation => :"ApexRedirectApi.list_apex_redirects",
    :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: ApexRedirectApi#list_apex_redirects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_apex_redirect(opts = {}) ⇒ ApexRedirect

Update an apex redirect Update an apex redirect by its ID.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :apex_redirect_id (String) — default: required
  • :service_id (String)
  • :version (Integer)
  • :created_at (Time) —

    Date and time in ISO 8601 format.

  • :deleted_at (Time) —

    Date and time in ISO 8601 format.

  • :updated_at (Time) —

    Date and time in ISO 8601 format.

  • :status_code (Integer) —

    HTTP status code used to redirect the client.

  • :domains (Array<String>) —

    Array of apex domains that should redirect to their WWW subdomain.

  • :feature_revision (Integer) —

    Revision number of the apex redirect feature implementation. Defaults to the most recent revision.

Returns:



339
340
341
342
 
# File 'lib/fastly/api/apex_redirect_api.rb', line 339

def update_apex_redirect(opts = {})
  data, _status_code, _headers = update_apex_redirect_with_http_info(opts)
  data
end

#update_apex_redirect_with_http_info(opts = {}) ⇒ Array<(ApexRedirect, Integer, Hash)>

Update an apex redirect Update an apex redirect by its ID.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :apex_redirect_id (String) — default: required
  • :service_id (String)
  • :version (Integer)
  • :created_at (Time) —

    Date and time in ISO 8601 format.

  • :deleted_at (Time) —

    Date and time in ISO 8601 format.

  • :updated_at (Time) —

    Date and time in ISO 8601 format.

  • :status_code (Integer) —

    HTTP status code used to redirect the client.

  • :domains (Array<String>) —

    Array of apex domains that should redirect to their WWW subdomain.

  • :feature_revision (Integer) —

    Revision number of the apex redirect feature implementation. Defaults to the most recent revision.

Returns:

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

    ApexRedirect data, response status code and response headers



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
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/fastly/api/apex_redirect_api.rb', line 356

def update_apex_redirect_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApexRedirectApi.update_apex_redirect ...'
  end
  # unbox the parameters from the hash
  apex_redirect_id = opts[:'apex_redirect_id']
  # verify the required parameter 'apex_redirect_id' is set
  if @api_client.config.client_side_validation && apex_redirect_id.nil?
    fail ArgumentError, "Missing the required parameter 'apex_redirect_id' when calling ApexRedirectApi.update_apex_redirect"
  end
  allowable_values = [301, 302, 307, 308]
  if @api_client.config.client_side_validation && opts[:'status_code'] && !allowable_values.include?(opts[:'status_code'])
    fail ArgumentError, "invalid value for \"status_code\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'domains'].nil? && opts[:'domains'].length < 1
    fail ArgumentError, 'invalid value for "opts[:"domains"]" when calling ApexRedirectApi.update_apex_redirect, number of items must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'feature_revision'].nil? && opts[:'feature_revision'] < 1
    fail ArgumentError, 'invalid value for "opts[:"feature_revision"]" when calling ApexRedirectApi.update_apex_redirect, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/apex-redirects/{apex_redirect_id}'.sub('{' + 'apex_redirect_id' + '}', CGI.escape(apex_redirect_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/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['service_id'] = opts[:'service_id'] if !opts[:'service_id'].nil?
  form_params['version'] = opts[:'version'] if !opts[:'version'].nil?
  form_params['created_at'] = opts[:'created_at'] if !opts[:'created_at'].nil?
  form_params['deleted_at'] = opts[:'deleted_at'] if !opts[:'deleted_at'].nil?
  form_params['updated_at'] = opts[:'updated_at'] if !opts[:'updated_at'].nil?
  form_params['status_code'] = opts[:'status_code'] if !opts[:'status_code'].nil?
  form_params['domains'] = @api_client.build_collection_param(opts[:'domains'], :csv) if !opts[:'domains'].nil?
  form_params['feature_revision'] = opts[:'feature_revision'] if !opts[:'feature_revision'].nil?

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

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

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

  new_options = opts.merge(
    :operation => :"ApexRedirectApi.update_apex_redirect",
    :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: ApexRedirectApi#update_apex_redirect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end