class Fastly::GzipApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/fastly/api/gzip_api.rb, line 17
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

create_gzip_config(opts = {}) click to toggle source

Create a gzip configuration Create a named gzip configuration on a particular service and version. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @option opts [String] :cache_condition Name of the cache condition controlling when this configuration applies. @option opts [String] :content_types Space-separated list of content types to compress. If you omit this field a default list will be used. @option opts [String] :extensions Space-separated list of file extensions to compress. If you omit this field a default list will be used. @option opts [String] :name Name of the gzip configuration. @return [GzipResponse]

# File lib/fastly/api/gzip_api.rb, line 29
def create_gzip_config(opts = {})
  data, _status_code, _headers = create_gzip_config_with_http_info(opts)
  data
end
create_gzip_config_with_http_info(opts = {}) click to toggle source

Create a gzip configuration Create a named gzip configuration on a particular service and version. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @option opts [String] :cache_condition Name of the cache condition controlling when this configuration applies. @option opts [String] :content_types Space-separated list of content types to compress. If you omit this field a default list will be used. @option opts [String] :extensions Space-separated list of file extensions to compress. If you omit this field a default list will be used. @option opts [String] :name Name of the gzip configuration. @return [Array<(GzipResponse, Integer, Hash)>] GzipResponse data, response status code and response headers

# File lib/fastly/api/gzip_api.rb, line 43
def create_gzip_config_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GzipApi.create_gzip_config ...'
  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 GzipApi.create_gzip_config"
  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 GzipApi.create_gzip_config"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/gzip'.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['cache_condition'] = opts[:'cache_condition'] if !opts[:'cache_condition'].nil?
  form_params['content_types'] = opts[:'content_types'] if !opts[:'content_types'].nil?
  form_params['extensions'] = opts[:'extensions'] if !opts[:'extensions'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

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

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

  new_options = opts.merge(
    :operation => :"GzipApi.create_gzip_config",
    :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: GzipApi#create_gzip_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_gzip_config(opts = {}) click to toggle source

Delete a gzip configuration Delete a named gzip configuration on a particular service and version. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @option opts [String] :gzip_name Name of the gzip configuration. (required) @return [InlineResponse200]

# File lib/fastly/api/gzip_api.rb, line 113
def delete_gzip_config(opts = {})
  data, _status_code, _headers = delete_gzip_config_with_http_info(opts)
  data
end
delete_gzip_config_with_http_info(opts = {}) click to toggle source

Delete a gzip configuration Delete a named gzip configuration on a particular service and version. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @option opts [String] :gzip_name Name of the gzip configuration. (required) @return [Array<(InlineResponse200, Integer, Hash)>] InlineResponse200 data, response status code and response headers

# File lib/fastly/api/gzip_api.rb, line 124
def delete_gzip_config_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GzipApi.delete_gzip_config ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  gzip_name = opts[:'gzip_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 GzipApi.delete_gzip_config"
  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 GzipApi.delete_gzip_config"
  end
  # verify the required parameter 'gzip_name' is set
  if @api_client.config.client_side_validation && gzip_name.nil?
    fail ArgumentError, "Missing the required parameter 'gzip_name' when calling GzipApi.delete_gzip_config"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/gzip/{gzip_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'gzip_name' + '}', CGI.escape(gzip_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 => :"GzipApi.delete_gzip_config",
    :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: GzipApi#delete_gzip_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_gzip_configs(opts = {}) click to toggle source

Get a gzip configuration Get the gzip configuration for a particular service, version, and name. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @option opts [String] :gzip_name Name of the gzip configuration. (required) @return [GzipResponse]

# File lib/fastly/api/gzip_api.rb, line 190
def get_gzip_configs(opts = {})
  data, _status_code, _headers = get_gzip_configs_with_http_info(opts)
  data
end
get_gzip_configs_with_http_info(opts = {}) click to toggle source

Get a gzip configuration Get the gzip configuration for a particular service, version, and name. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @option opts [String] :gzip_name Name of the gzip configuration. (required) @return [Array<(GzipResponse, Integer, Hash)>] GzipResponse data, response status code and response headers

# File lib/fastly/api/gzip_api.rb, line 201
def get_gzip_configs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GzipApi.get_gzip_configs ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  gzip_name = opts[:'gzip_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 GzipApi.get_gzip_configs"
  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 GzipApi.get_gzip_configs"
  end
  # verify the required parameter 'gzip_name' is set
  if @api_client.config.client_side_validation && gzip_name.nil?
    fail ArgumentError, "Missing the required parameter 'gzip_name' when calling GzipApi.get_gzip_configs"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/gzip/{gzip_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'gzip_name' + '}', CGI.escape(gzip_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] || 'GzipResponse'

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

  new_options = opts.merge(
    :operation => :"GzipApi.get_gzip_configs",
    :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: GzipApi#get_gzip_configs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_gzip_configs(opts = {}) click to toggle source

List gzip configurations List all gzip configurations for a particular service and version. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @return [Array<GzipResponse>]

# File lib/fastly/api/gzip_api.rb, line 266
def list_gzip_configs(opts = {})
  data, _status_code, _headers = list_gzip_configs_with_http_info(opts)
  data
end
list_gzip_configs_with_http_info(opts = {}) click to toggle source

List gzip configurations List all gzip configurations for a particular service and version. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @return [Array<(Array<GzipResponse>, Integer, Hash)>] Array<GzipResponse> data, response status code and response headers

# File lib/fastly/api/gzip_api.rb, line 276
def list_gzip_configs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GzipApi.list_gzip_configs ...'
  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 GzipApi.list_gzip_configs"
  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 GzipApi.list_gzip_configs"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/gzip'.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<GzipResponse>'

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

  new_options = opts.merge(
    :operation => :"GzipApi.list_gzip_configs",
    :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: GzipApi#list_gzip_configs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_gzip_config(opts = {}) click to toggle source

Update a gzip configuration Update a named gzip configuration on a particular service and version. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @option opts [String] :gzip_name Name of the gzip configuration. (required) @option opts [String] :cache_condition Name of the cache condition controlling when this configuration applies. @option opts [String] :content_types Space-separated list of content types to compress. If you omit this field a default list will be used. @option opts [String] :extensions Space-separated list of file extensions to compress. If you omit this field a default list will be used. @option opts [String] :name Name of the gzip configuration. @return [GzipResponse]

# File lib/fastly/api/gzip_api.rb, line 341
def update_gzip_config(opts = {})
  data, _status_code, _headers = update_gzip_config_with_http_info(opts)
  data
end
update_gzip_config_with_http_info(opts = {}) click to toggle source

Update a gzip configuration Update a named gzip configuration on a particular service and version. @option opts [String] :service_id Alphanumeric string identifying the service. (required) @option opts [Integer] :version_id Integer identifying a service version. (required) @option opts [String] :gzip_name Name of the gzip configuration. (required) @option opts [String] :cache_condition Name of the cache condition controlling when this configuration applies. @option opts [String] :content_types Space-separated list of content types to compress. If you omit this field a default list will be used. @option opts [String] :extensions Space-separated list of file extensions to compress. If you omit this field a default list will be used. @option opts [String] :name Name of the gzip configuration. @return [Array<(GzipResponse, Integer, Hash)>] GzipResponse data, response status code and response headers

# File lib/fastly/api/gzip_api.rb, line 356
def update_gzip_config_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GzipApi.update_gzip_config ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  gzip_name = opts[:'gzip_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 GzipApi.update_gzip_config"
  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 GzipApi.update_gzip_config"
  end
  # verify the required parameter 'gzip_name' is set
  if @api_client.config.client_side_validation && gzip_name.nil?
    fail ArgumentError, "Missing the required parameter 'gzip_name' when calling GzipApi.update_gzip_config"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/gzip/{gzip_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'gzip_name' + '}', CGI.escape(gzip_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/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['cache_condition'] = opts[:'cache_condition'] if !opts[:'cache_condition'].nil?
  form_params['content_types'] = opts[:'content_types'] if !opts[:'content_types'].nil?
  form_params['extensions'] = opts[:'extensions'] if !opts[:'extensions'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?

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

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

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

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