Class: CtdDocumentation::CustomAttributesCategoriesController

Inherits:
BaseController
  • Object
show all
Defined in:
lib/ctd_documentation/controllers/custom_attributes_categories_controller.rb

Overview

CustomAttributesCategoriesController

Constant Summary

Constants inherited from BaseController

BaseController::GLOBAL_ERRORS

Instance Attribute Summary

Attributes inherited from BaseController

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseController

#initialize, #new_api_call_builder, #new_parameter, #new_request_builder, #new_response_handler, user_agent

Constructor Details

This class inherits a constructor from CtdDocumentation::BaseController

Instance Method Details

#get_custom_attribute_categories(page: nil, per_page: nil, id__exact: nil, site_id__exact: nil, name__contains: nil, name__icontains: nil, description__icontains: nil, description__contains: nil, sort: nil) ⇒ GetCustomAttributeCategoriesResponse

Get Custom Attribute Categories

Parameters:

  • page (Integer) (defaults to: nil) —

    Optional parameter: Example:

  • per_page (Integer) (defaults to: nil) —

    Optional parameter: Example:

  • id__exact (Integer) (defaults to: nil) —

    Optional parameter: Example:

  • site_id__exact (Integer) (defaults to: nil) —

    Optional parameter: Example:

  • name__contains (String) (defaults to: nil) —

    Optional parameter: Example:

  • name__icontains (String) (defaults to: nil) —

    Optional parameter: Example:

  • description__icontains (String) (defaults to: nil) —

    Optional parameter: Example:

  • description__contains (String) (defaults to: nil) —

    Optional parameter: Example:

  • sort (Sort5Enum) (defaults to: nil) —

    Optional parameter: Example:

Returns:



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/ctd_documentation/controllers/custom_attributes_categories_controller.rb', line 20

def get_custom_attribute_categories(page: nil,
                                    per_page: nil,
                                    id__exact: nil,
                                    site_id__exact: nil,
                                    name__contains: nil,
                                    name__icontains: nil,
                                    description__icontains: nil,
                                    description__contains: nil,
                                    sort: nil)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/ranger/custom_attribute_categories',
                                 Server::DEFAULT)
               .query_param(new_parameter(page, key: 'page'))
               .query_param(new_parameter(per_page, key: 'per_page'))
               .query_param(new_parameter(id__exact, key: 'id__exact'))
               .query_param(new_parameter(site_id__exact, key: 'site_id__exact'))
               .query_param(new_parameter(name__contains, key: 'name__contains'))
               .query_param(new_parameter(name__icontains, key: 'name__icontains'))
               .query_param(new_parameter(description__icontains, key: 'description__icontains'))
               .query_param(new_parameter(description__contains, key: 'description__contains'))
               .query_param(new_parameter(sort, key: 'sort'))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('global')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(GetCustomAttributeCategoriesResponse.method(:from_hash)))
    .execute
end