Class: MergeATSClient::DepartmentsApi
- Inherits:
-
Object
- Object
- MergeATSClient::DepartmentsApi
- Defined in:
- lib/merge_ats_client/api/departments_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#departments_list(x_account_token, opts = {}) ⇒ PaginatedDepartmentList
Returns a list of ‘Department` objects.
-
#departments_list_with_http_info(x_account_token, opts = {}) ⇒ Array<(PaginatedDepartmentList, Integer, Hash)>
Returns a list of `Department` objects.
-
#departments_retrieve(x_account_token, id, opts = {}) ⇒ Department
Returns a ‘Department` object with the given `id`.
-
#departments_retrieve_with_http_info(x_account_token, id, opts = {}) ⇒ Array<(Department, Integer, Hash)>
Returns a `Department` object with the given `id`.
-
#initialize(api_client = ApiClient.default) ⇒ DepartmentsApi
constructor
A new instance of DepartmentsApi.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ DepartmentsApi
Returns a new instance of DepartmentsApi.
19 20 21 |
# File 'lib/merge_ats_client/api/departments_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/merge_ats_client/api/departments_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#departments_list(x_account_token, opts = {}) ⇒ PaginatedDepartmentList
Returns a list of ‘Department` objects.
35 36 37 38 |
# File 'lib/merge_ats_client/api/departments_api.rb', line 35 def departments_list(x_account_token, opts = {}) data, _status_code, _headers = departments_list_with_http_info(x_account_token, opts) data end |
#departments_list_with_http_info(x_account_token, opts = {}) ⇒ Array<(PaginatedDepartmentList, Integer, Hash)>
Returns a list of `Department` objects.
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 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 |
# File 'lib/merge_ats_client/api/departments_api.rb', line 53 def departments_list_with_http_info(x_account_token, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DepartmentsApi.departments_list ...' end # verify the required parameter 'x_account_token' is set if @api_client.config.client_side_validation && x_account_token.nil? fail ArgumentError, "Missing the required parameter 'x_account_token' when calling DepartmentsApi.departments_list" end # resource path local_var_path = '/departments' # query parameters query_params = opts[:query_params] || {} query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil? query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil? query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil? query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil? query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil? query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil? query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil? query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-Account-Token'] = x_account_token # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'PaginatedDepartmentList' # auth_names auth_names = opts[:debug_auth_names] || ['tokenAuth'] = opts.merge( :operation => :"DepartmentsApi.departments_list", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DepartmentsApi#departments_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#departments_retrieve(x_account_token, id, opts = {}) ⇒ Department
Returns a ‘Department` object with the given `id`.
117 118 119 120 |
# File 'lib/merge_ats_client/api/departments_api.rb', line 117 def departments_retrieve(x_account_token, id, opts = {}) data, _status_code, _headers = departments_retrieve_with_http_info(x_account_token, id, opts) data end |
#departments_retrieve_with_http_info(x_account_token, id, opts = {}) ⇒ Array<(Department, Integer, Hash)>
Returns a `Department` object with the given `id`.
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 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 |
# File 'lib/merge_ats_client/api/departments_api.rb', line 128 def departments_retrieve_with_http_info(x_account_token, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DepartmentsApi.departments_retrieve ...' end # verify the required parameter 'x_account_token' is set if @api_client.config.client_side_validation && x_account_token.nil? fail ArgumentError, "Missing the required parameter 'x_account_token' when calling DepartmentsApi.departments_retrieve" end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling DepartmentsApi.departments_retrieve" end # resource path local_var_path = '/departments/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-Account-Token'] = x_account_token # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Department' # auth_names auth_names = opts[:debug_auth_names] || ['tokenAuth'] = opts.merge( :operation => :"DepartmentsApi.departments_retrieve", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DepartmentsApi#departments_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |