class VoucherifySdk::CategoriesApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

create_category(opts = {}) click to toggle source

Create Category Create category with a specific name and hierarchy. @param [Hash] opts the optional parameters @option opts [CategoriesCreateRequestBody] :categories_create_request_body Specify the details of the category that you would like to create. @return [CategoriesCreateResponseBody]

# File lib/VoucherifySdk/api/categories_api.rb, line 27
def create_category(opts = {})
  data, _status_code, _headers = create_category_with_http_info(opts)
  data
end
delete_category(category_id, opts = {}) click to toggle source

Delete Category Delete a category by the category ID. @param category_id [String] Unique category ID assigned by Voucherify. @param [Hash] opts the optional parameters @return [nil]

# File lib/VoucherifySdk/api/categories_api.rb, line 91
def delete_category(category_id, opts = {})
  delete_category_with_http_info(category_id, opts)
  nil
end
get_category(category_id, opts = {}) click to toggle source

Get Category Retrieve a category by the category ID. @param category_id [String] Unique category ID assigned by Voucherify. @param [Hash] opts the optional parameters @return [CategoriesGetResponseBody]

# File lib/VoucherifySdk/api/categories_api.rb, line 148
def get_category(category_id, opts = {})
  data, _status_code, _headers = get_category_with_http_info(category_id, opts)
  data
end
list_categories(opts = {}) click to toggle source

List Categories List all categories. @param [Hash] opts the optional parameters @return [CategoriesListResponseBody]

# File lib/VoucherifySdk/api/categories_api.rb, line 206
def list_categories(opts = {})
  data, _status_code, _headers = list_categories_with_http_info(opts)
  data
end
update_category(category_id, opts = {}) click to toggle source

Update Category Update category using the category ID. @param category_id [String] Unique category ID assigned by Voucherify. @param [Hash] opts the optional parameters @option opts [CategoriesUpdateRequestBody] :categories_update_request_body Specify the details of the category that you would like to update. @return [CategoriesUpdateResponseBody]

# File lib/VoucherifySdk/api/categories_api.rb, line 265
def update_category(category_id, opts = {})
  data, _status_code, _headers = update_category_with_http_info(category_id, opts)
  data
end

Private Instance Methods

create_category_with_http_info(opts = {}) click to toggle source

Create Category Create category with a specific name and hierarchy. @param [Hash] opts the optional parameters @option opts [CategoriesCreateRequestBody] :categories_create_request_body Specify the details of the category that you would like to create. @return [Array<(CategoriesCreateResponseBody, Integer, Hash)>] CategoriesCreateResponseBody data, response status code and response headers

# File lib/VoucherifySdk/api/categories_api.rb, line 37
        def create_category_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CategoriesApi.create_category ...'
  end
  # resource path
  local_var_path = '/v1/categories'

  # 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[:'categories_create_request_body'])

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['X-App-Id', 'X-App-Token']

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

Delete Category Delete a category by the category ID. @param category_id [String] Unique category ID assigned by Voucherify. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/VoucherifySdk/api/categories_api.rb, line 101
        def delete_category_with_http_info(category_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CategoriesApi.delete_category ...'
  end
  # resource path
  local_var_path = '/v1/categories/{categoryId}'.sub('{' + 'categoryId' + '}', CGI.escape(category_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] || ['X-App-Id', 'X-App-Token']

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

Get Category Retrieve a category by the category ID. @param category_id [String] Unique category ID assigned by Voucherify. @param [Hash] opts the optional parameters @return [Array<(CategoriesGetResponseBody, Integer, Hash)>] CategoriesGetResponseBody data, response status code and response headers

# File lib/VoucherifySdk/api/categories_api.rb, line 158
        def get_category_with_http_info(category_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CategoriesApi.get_category ...'
  end
  # resource path
  local_var_path = '/v1/categories/{categoryId}'.sub('{' + 'categoryId' + '}', CGI.escape(category_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] || 'CategoriesGetResponseBody'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['X-App-Id', 'X-App-Token']

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

List Categories List all categories. @param [Hash] opts the optional parameters @return [Array<(CategoriesListResponseBody, Integer, Hash)>] CategoriesListResponseBody data, response status code and response headers

# File lib/VoucherifySdk/api/categories_api.rb, line 215
        def list_categories_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CategoriesApi.list_categories ...'
  end
  # resource path
  local_var_path = '/v1/categories'

  # 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] || 'CategoriesListResponseBody'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['X-App-Id', 'X-App-Token']

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

Update Category Update category using the category ID. @param category_id [String] Unique category ID assigned by Voucherify. @param [Hash] opts the optional parameters @option opts [CategoriesUpdateRequestBody] :categories_update_request_body Specify the details of the category that you would like to update. @return [Array<(CategoriesUpdateResponseBody, Integer, Hash)>] CategoriesUpdateResponseBody data, response status code and response headers

# File lib/VoucherifySdk/api/categories_api.rb, line 276
        def update_category_with_http_info(category_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CategoriesApi.update_category ...'
  end
  # resource path
  local_var_path = '/v1/categories/{categoryId}'.sub('{' + 'categoryId' + '}', CGI.escape(category_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[:'categories_update_request_body'])

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['X-App-Id', 'X-App-Token']

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