Class: Fastly::ImageOptimizerDefaultSettingsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ImageOptimizerDefaultSettingsApi

Returns a new instance of ImageOptimizerDefaultSettingsApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_default_settings(opts = {}) ⇒ DefaultSettingsResponse

Get current Image Optimizer Default Settings Retrieve the current Image Optimizer default settings. All properties in the response will be populated.

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:



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

def get_default_settings(opts = {})
  data, _status_code, _headers = get_default_settings_with_http_info(opts)
  data
end

#get_default_settings_with_http_info(opts = {}) ⇒ Array<(DefaultSettingsResponse, Integer, Hash)>

Get current Image Optimizer Default Settings Retrieve the current Image Optimizer default settings. All properties in the response will be populated.

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<(DefaultSettingsResponse, Integer, Hash)>) —

    DefaultSettingsResponse data, 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
87
88
 
# File 'lib/fastly/api/image_optimizer_default_settings_api.rb', line 35

def get_default_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ImageOptimizerDefaultSettingsApi.get_default_settings ...'
  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 ImageOptimizerDefaultSettingsApi.get_default_settings"
  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 ImageOptimizerDefaultSettingsApi.get_default_settings"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/image_optimizer_default_settings'.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', 'application/problem+json'])

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

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

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

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

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

#update_default_settings(opts = {}) ⇒ DefaultSettingsResponse

Update Image Optimizer Default Settings Update one or more default settings. A minimum of one property is required. The endpoint will respond with the new Image Optimizer default settings, with all properties populated.

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)

  • :default_settings (DefaultSettings)

Returns:



96
97
98
99
 
# File 'lib/fastly/api/image_optimizer_default_settings_api.rb', line 96

def update_default_settings(opts = {})
  data, _status_code, _headers = update_default_settings_with_http_info(opts)
  data
end

#update_default_settings_with_http_info(opts = {}) ⇒ Array<(DefaultSettingsResponse, Integer, Hash)>

Update Image Optimizer Default Settings Update one or more default settings. A minimum of one property is required. The endpoint will respond with the new Image Optimizer default settings, with all properties populated.

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)

  • :default_settings (DefaultSettings)

Returns:

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

    DefaultSettingsResponse data, response status code and response headers



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
164
165
 
# File 'lib/fastly/api/image_optimizer_default_settings_api.rb', line 107

def update_default_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ImageOptimizerDefaultSettingsApi.update_default_settings ...'
  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 ImageOptimizerDefaultSettingsApi.update_default_settings"
  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 ImageOptimizerDefaultSettingsApi.update_default_settings"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/image_optimizer_default_settings'.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', 'application/problem+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[:'default_settings'])

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

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

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