Method: UltracartClient::StorefrontApi#archive_email_segment_with_http_info

Defined in:

lib/ultracart_api/api/storefront_api.rb

#archive_email_segment_with_http_info(storefront_oid, email_segment_uuid, opts = {}) ⇒ Array<(EmailSegmentArchiveResponse, Integer, Hash)>

Archive email segment

Parameters:

• storefront_oid (Integer)
• email_segment_uuid (String)
• opts (Hash) (defaults to: {}) —

  the optional parameters

Returns:

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

  EmailSegmentArchiveResponse data, response status code and response headers

# File 'lib/ultracart_api/api/storefront_api.rb', line 252

def archive_email_segment_with_http_info(storefront_oid, email_segment_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.archive_email_segment ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.archive_email_segment"
  end
  # verify the required parameter 'email_segment_uuid' is set
  if @api_client.config.client_side_validation && email_segment_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_segment_uuid' when calling StorefrontApi.archive_email_segment"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/archive'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_segment_uuid' + '}', CGI.escape(email_segment_uuid.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # 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] || 'EmailSegmentArchiveResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

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