Class: Fastly::EnabledProductsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EnabledProductsApi

Returns a new instance of EnabledProductsApi.



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

def api_client
  @api_client
end

Instance Method Details

#disable_product(opts = {}) ⇒ nil

Disable a product Disable a product on a service. Supported product IDs: ‘brotli_compression`,`domain_inspector`,`fanout`,`image_optimizer`,`origin_inspector`, `websockets`, `bot_management`, and `ngwaf`.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :product_id (String) — default: required
  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

Returns:

  • (nil) 


25
26
27
28
 
# File 'lib/fastly/api/enabled_products_api.rb', line 25

def disable_product(opts = {})
  disable_product_with_http_info(opts)
  nil
end

#disable_product_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Disable a product Disable a product on a service. Supported product IDs: &#x60;brotli_compression&#x60;,&#x60;domain_inspector&#x60;,&#x60;fanout&#x60;,&#x60;image_optimizer&#x60;,&#x60;origin_inspector&#x60;, &#x60;websockets&#x60;, &#x60;bot_management&#x60;, and &#x60;ngwaf&#x60;.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :product_id (String) — default: required
  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

Returns:

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

    nil, response status code and response headers



35
36
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
 
# File 'lib/fastly/api/enabled_products_api.rb', line 35

def disable_product_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EnabledProductsApi.disable_product ...'
  end
  # unbox the parameters from the hash
  product_id = opts[:'product_id']
  service_id = opts[:'service_id']
  # verify the required parameter 'product_id' is set
  if @api_client.config.client_side_validation && product_id.nil?
    fail ArgumentError, "Missing the required parameter 'product_id' when calling EnabledProductsApi.disable_product"
  end
  # 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 EnabledProductsApi.disable_product"
  end
  # resource path
  local_var_path = '/enabled-products/v1/{product_id}/services/{service_id}'.sub('{' + 'product_id' + '}', CGI.escape(product_id.to_s)).sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#enable_product(opts = {}) ⇒ EnabledProductResponse

Enable a product Enable a product on a service. Supported product IDs: ‘brotli_compression`,`domain_inspector`,`fanout`,`image_optimizer`,`origin_inspector`, `websockets`, `bot_management`, and `ngwaf`.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :product_id (String) — default: required
  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :set_workspace_id (SetWorkspaceId)

Returns:



94
95
96
97
 
# File 'lib/fastly/api/enabled_products_api.rb', line 94

def enable_product(opts = {})
  data, _status_code, _headers = enable_product_with_http_info(opts)
  data
end

#enable_product_with_http_info(opts = {}) ⇒ Array<(EnabledProductResponse, Integer, Hash)>

Enable a product Enable a product on a service. Supported product IDs: &#x60;brotli_compression&#x60;,&#x60;domain_inspector&#x60;,&#x60;fanout&#x60;,&#x60;image_optimizer&#x60;,&#x60;origin_inspector&#x60;, &#x60;websockets&#x60;, &#x60;bot_management&#x60;, and &#x60;ngwaf&#x60;.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :product_id (String) — default: required
  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :set_workspace_id (SetWorkspaceId)

Returns:

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

    EnabledProductResponse data, response status code and response headers



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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/fastly/api/enabled_products_api.rb', line 105

def enable_product_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EnabledProductsApi.enable_product ...'
  end
  # unbox the parameters from the hash
  product_id = opts[:'product_id']
  service_id = opts[:'service_id']
  # verify the required parameter 'product_id' is set
  if @api_client.config.client_side_validation && product_id.nil?
    fail ArgumentError, "Missing the required parameter 'product_id' when calling EnabledProductsApi.enable_product"
  end
  # 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 EnabledProductsApi.enable_product"
  end
  # resource path
  local_var_path = '/enabled-products/v1/{product_id}/services/{service_id}'.sub('{' + 'product_id' + '}', CGI.escape(product_id.to_s)).sub('{' + 'service_id' + '}', CGI.escape(service_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[:'set_workspace_id'])

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

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

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

#get_enabled_product(opts = {}) ⇒ EnabledProductResponse

Get enabled product Get enabled product on a service. Supported product IDs: ‘brotli_compression`,`domain_inspector`,`fanout`,`image_optimizer`,`origin_inspector`, `websockets`, `bot_management`, and `ngwaf`.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :product_id (String) — default: required
  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

Returns:



170
171
172
173
 
# File 'lib/fastly/api/enabled_products_api.rb', line 170

def get_enabled_product(opts = {})
  data, _status_code, _headers = get_enabled_product_with_http_info(opts)
  data
end

#get_enabled_product_with_http_info(opts = {}) ⇒ Array<(EnabledProductResponse, Integer, Hash)>

Get enabled product Get enabled product on a service. Supported product IDs: &#x60;brotli_compression&#x60;,&#x60;domain_inspector&#x60;,&#x60;fanout&#x60;,&#x60;image_optimizer&#x60;,&#x60;origin_inspector&#x60;, &#x60;websockets&#x60;, &#x60;bot_management&#x60;, and &#x60;ngwaf&#x60;.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :product_id (String) — default: required
  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

Returns:

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

    EnabledProductResponse data, response status code and response headers



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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/fastly/api/enabled_products_api.rb', line 180

def get_enabled_product_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EnabledProductsApi.get_enabled_product ...'
  end
  # unbox the parameters from the hash
  product_id = opts[:'product_id']
  service_id = opts[:'service_id']
  # verify the required parameter 'product_id' is set
  if @api_client.config.client_side_validation && product_id.nil?
    fail ArgumentError, "Missing the required parameter 'product_id' when calling EnabledProductsApi.get_enabled_product"
  end
  # 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 EnabledProductsApi.get_enabled_product"
  end
  # resource path
  local_var_path = '/enabled-products/v1/{product_id}/services/{service_id}'.sub('{' + 'product_id' + '}', CGI.escape(product_id.to_s)).sub('{' + 'service_id' + '}', CGI.escape(service_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] || 'EnabledProductResponse'

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

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

#get_product_configuration(opts = {}) ⇒ ConfiguredProductResponse

Get configuration for a product Get configuration for an enabled product on a service. Supported product IDs: ‘ngwaf`.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :product_id (String) — default: required
  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

Returns:



240
241
242
243
 
# File 'lib/fastly/api/enabled_products_api.rb', line 240

def get_product_configuration(opts = {})
  data, _status_code, _headers = get_product_configuration_with_http_info(opts)
  data
end

#get_product_configuration_with_http_info(opts = {}) ⇒ Array<(ConfiguredProductResponse, Integer, Hash)>

Get configuration for a product Get configuration for an enabled product on a service. Supported product IDs: &#x60;ngwaf&#x60;.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :product_id (String) — default: required
  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

Returns:

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

    ConfiguredProductResponse data, response status code and response headers



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
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
 
# File 'lib/fastly/api/enabled_products_api.rb', line 250

def get_product_configuration_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EnabledProductsApi.get_product_configuration ...'
  end
  # unbox the parameters from the hash
  product_id = opts[:'product_id']
  service_id = opts[:'service_id']
  # verify the required parameter 'product_id' is set
  if @api_client.config.client_side_validation && product_id.nil?
    fail ArgumentError, "Missing the required parameter 'product_id' when calling EnabledProductsApi.get_product_configuration"
  end
  # 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 EnabledProductsApi.get_product_configuration"
  end
  # resource path
  local_var_path = '/enabled-products/v1/{product_id}/services/{service_id}/configuration'.sub('{' + 'product_id' + '}', CGI.escape(product_id.to_s)).sub('{' + 'service_id' + '}', CGI.escape(service_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] || 'ConfiguredProductResponse'

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

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

#set_product_configuration(opts = {}) ⇒ ConfiguredProductResponse

Update configuration for a product Update configuration for an enabled product on a service. Supported product IDs: ‘ngwaf`.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :product_id (String) — default: required
  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :set_configuration (SetConfiguration)

Returns:



311
312
313
314
 
# File 'lib/fastly/api/enabled_products_api.rb', line 311

def set_product_configuration(opts = {})
  data, _status_code, _headers = set_product_configuration_with_http_info(opts)
  data
end

#set_product_configuration_with_http_info(opts = {}) ⇒ Array<(ConfiguredProductResponse, Integer, Hash)>

Update configuration for a product Update configuration for an enabled product on a service. Supported product IDs: &#x60;ngwaf&#x60;.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :product_id (String) — default: required
  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :set_configuration (SetConfiguration)

Returns:

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

    ConfiguredProductResponse data, response status code and response headers



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
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
 
# File 'lib/fastly/api/enabled_products_api.rb', line 322

def set_product_configuration_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EnabledProductsApi.set_product_configuration ...'
  end
  # unbox the parameters from the hash
  product_id = opts[:'product_id']
  service_id = opts[:'service_id']
  # verify the required parameter 'product_id' is set
  if @api_client.config.client_side_validation && product_id.nil?
    fail ArgumentError, "Missing the required parameter 'product_id' when calling EnabledProductsApi.set_product_configuration"
  end
  # 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 EnabledProductsApi.set_product_configuration"
  end
  # resource path
  local_var_path = '/enabled-products/v1/{product_id}/services/{service_id}/configuration'.sub('{' + 'product_id' + '}', CGI.escape(product_id.to_s)).sub('{' + 'service_id' + '}', CGI.escape(service_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[:'set_configuration'])

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

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

  new_options = opts.merge(
    :operation => :"EnabledProductsApi.set_product_configuration",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EnabledProductsApi#set_product_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end