class Fastly::ProductWebsocketsApi
Attributes
Public Class Methods
Source
# File lib/fastly/api/product_websockets_api.rb, line 17 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Source
# File lib/fastly/api/product_websockets_api.rb, line 24 def disable_product_websockets(opts = {}) disable_product_websockets_with_http_info(opts) nil end
Disable product Disable the Websockets product on a service. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @return [nil]
Source
# File lib/fastly/api/product_websockets_api.rb, line 33 def disable_product_websockets_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProductWebsocketsApi.disable_product_websockets ...' end # unbox the parameters from the hash service_id = opts[:'service_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 ProductWebsocketsApi.disable_product_websockets" end # resource path local_var_path = '/enabled-products/v1/websockets/services/{service_id}'.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 => :"ProductWebsocketsApi.disable_product_websockets", :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: ProductWebsocketsApi#disable_product_websockets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Disable product Disable the Websockets product on a service. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
Source
# File lib/fastly/api/product_websockets_api.rb, line 85 def enable_product_websockets(opts = {}) data, _status_code, _headers = enable_product_websockets_with_http_info(opts) data end
Enable product Enable the WebSockets product on a service. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @return [WebsocketsResponseBodyEnable]
Source
# File lib/fastly/api/product_websockets_api.rb, line 94 def enable_product_websockets_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProductWebsocketsApi.enable_product_websockets ...' end # unbox the parameters from the hash service_id = opts[:'service_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 ProductWebsocketsApi.enable_product_websockets" end # resource path local_var_path = '/enabled-products/v1/websockets/services/{service_id}'.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] || 'WebsocketsResponseBodyEnable' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"ProductWebsocketsApi.enable_product_websockets", :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: ProductWebsocketsApi#enable_product_websockets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Enable product Enable the WebSockets product on a service. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @return [Array<(WebsocketsResponseBodyEnable
, Integer, Hash)>] WebsocketsResponseBodyEnable
data, response status code and response headers
Source
# File lib/fastly/api/product_websockets_api.rb, line 148 def get_product_websockets(opts = {}) data, _status_code, _headers = get_product_websockets_with_http_info(opts) data end
Get product enablement status Get the enablement status of the WebSockets product on a service. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @return [WebsocketsResponseBodyEnable]
Source
# File lib/fastly/api/product_websockets_api.rb, line 157 def get_product_websockets_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProductWebsocketsApi.get_product_websockets ...' end # unbox the parameters from the hash service_id = opts[:'service_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 ProductWebsocketsApi.get_product_websockets" end # resource path local_var_path = '/enabled-products/v1/websockets/services/{service_id}'.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] || 'WebsocketsResponseBodyEnable' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"ProductWebsocketsApi.get_product_websockets", :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: ProductWebsocketsApi#get_product_websockets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get product enablement status Get the enablement status of the WebSockets product on a service. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @return [Array<(WebsocketsResponseBodyEnable
, Integer, Hash)>] WebsocketsResponseBodyEnable
data, response status code and response headers
Source
# File lib/fastly/api/product_websockets_api.rb, line 210 def get_services_product_websockets(opts = {}) data, _status_code, _headers = get_services_product_websockets_with_http_info(opts) data end
Get services with product enabled Get all the services which have the Websockets product enabled. @return [WebsocketsResponseBodyGetAllServices]
Source
# File lib/fastly/api/product_websockets_api.rb, line 218 def get_services_product_websockets_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProductWebsocketsApi.get_services_product_websockets ...' end # unbox the parameters from the hash # resource path local_var_path = '/enabled-products/v1/websockets/services' # 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] || 'WebsocketsResponseBodyGetAllServices' # auth_names auth_names = opts[:debug_auth_names] || ['token'] new_options = opts.merge( :operation => :"ProductWebsocketsApi.get_services_product_websockets", :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: ProductWebsocketsApi#get_services_product_websockets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get services with product enabled Get all the services which have the Websockets product enabled. @return [Array<(WebsocketsResponseBodyGetAllServices
, Integer, Hash)>] WebsocketsResponseBodyGetAllServices
data, response status code and response headers