Class: StickyIoRestfulApiV2025731::UsersController

Inherits:
BaseController show all
Defined in:
lib/sticky_io_restful_api_v2025731/controllers/users_controller.rb

Overview

UsersController

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_parameter, #new_request_builder, #new_response_handler, user_agent, user_agent_parameters

Constructor Details

This class inherits a constructor from StickyIoRestfulApiV2025731::BaseController

Instance Method Details

#get_call_center_providers(domain, v2_ext) ⇒ ApiResponse

Fetch a list of call center provider objects. **Response Data** Response parameters expected in each call center provider objects contained within the ‘data` field array: | Field | Data Type | Description | | — | — | — | | id | Integer | The call center provider’s ID. | | name | String | The call center provider’s name. |

Parameters:

  • domain (String) —

    Required parameter: TODO: type description here

  • v2_ext (String) —

    Required parameter: TODO: type description here

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/sticky_io_restful_api_v2025731/controllers/users_controller.rb', line 61

def get_call_center_providers(domain,
                              v2_ext)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/.{domain}{v2_ext}users/call_center_providers',
                                 Server::SERVER_1)
               .template_param(new_parameter(domain, key: 'domain')
                                .is_required(true)
                                .should_encode(true))
               .template_param(new_parameter(v2_ext, key: 'v2_ext')
                                .is_required(true)
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('basic')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(GetCallCenterProviders.method(:from_hash))
                .is_api_response(true))
    .execute
end

#get_user_departments(domain, v2_ext) ⇒ ApiResponse

Fetch a list of department objects. **Response Data** Response parameters expected in each department objects contained within the ‘data` field array: | Field | Data Type | Description | | — | — | — | | id | Integer | The department’s ID. | | name | String | The department’s name. |

Parameters:

  • domain (String) —

    Required parameter: TODO: type description here

  • v2_ext (String) —

    Required parameter: TODO: type description here

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/sticky_io_restful_api_v2025731/controllers/users_controller.rb', line 93

def get_user_departments(domain,
                         v2_ext)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/.{domain}{v2_ext}users/departments',
                                 Server::SERVER_1)
               .template_param(new_parameter(domain, key: 'domain')
                                .is_required(true)
                                .should_encode(true))
               .template_param(new_parameter(v2_ext, key: 'v2_ext')
                                .is_required(true)
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('basic')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(GetUserDepartments.method(:from_hash))
                .is_api_response(true))
    .execute
end

#get_users(domain, v2_ext) ⇒ ApiResponse

Fetch a list of user objects. **Response Data** Response parameters expected in each user objects contained within the ‘data` field array: | Field | Data Type | Description | | — | — | — | | id | Integer | The user ID. | | name | String | The user first and last name. | | email | String | The user’s email. | | timezone | String | The user’s timezone. | | is_active | Integer Flag | The user’s active flag | | call_center_provider_id | Integer | The user’s call center provider ID that is determining wether the user is allowed to use SSO | | created_at | String | A timestamp that represents when the user was created. | | updated_at | String | A timestamp that represents when the user was last updated. |

Parameters:

  • domain (String) —

    Required parameter: TODO: type description here

  • v2_ext (String) —

    Required parameter: TODO: type description here

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/sticky_io_restful_api_v2025731/controllers/users_controller.rb', line 29

def get_users(domain,
              v2_ext)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/.{domain}{v2_ext}users',
                                 Server::SERVER_1)
               .template_param(new_parameter(domain, key: 'domain')
                                .is_required(true)
                                .should_encode(true))
               .template_param(new_parameter(v2_ext, key: 'v2_ext')
                                .is_required(true)
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('basic')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(GetUsers.method(:from_hash))
                .is_api_response(true))
    .execute
end