Class: Merge::Hris::AsyncLocationsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/hris/locations/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Merge::Hris::AsyncLocationsClient 



148
149
150
 
# File 'lib/merge_ruby_client/hris/locations/client.rb', line 148

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Merge::AsyncRequestClient (readonly) 



144
145
146
 
# File 'lib/merge_ruby_client/hris/locations/client.rb', line 144

def request_client
  @request_client
end

Instance Method Details

#list(created_after: nil, created_before: nil, cursor: nil, include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, location_type: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, request_options: nil) ⇒ Merge::Hris::PaginatedLocationList

Returns a list of Location objects.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.hris.locations.list(cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw")



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/merge_ruby_client/hris/locations/client.rb', line 186

def list(created_after: nil, created_before: nil, cursor: nil, include_deleted_data: nil,
         include_remote_data: nil, include_shell_data: nil, location_type: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, request_options: nil)
  Async do
    response = @request_client.conn.get do |req|
      req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
      req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
      req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      req.params = {
        **(request_options&.additional_query_parameters || {}),
        "created_after": created_after,
        "created_before": created_before,
        "cursor": cursor,
        "include_deleted_data": include_deleted_data,
        "include_remote_data": include_remote_data,
        "include_shell_data": include_shell_data,
        "location_type": location_type,
        "modified_after": modified_after,
        "modified_before": modified_before,
        "page_size": page_size,
        "remote_fields": remote_fields,
        "remote_id": remote_id,
        "show_enum_origins": show_enum_origins
      }.compact
      unless request_options.nil? || request_options&.additional_body_parameters.nil?
        req.body = { **(request_options&.additional_body_parameters || {}) }.compact
      end
      req.url "#{@request_client.get_url(request_options: request_options)}/hris/v1/locations"
    end
    Merge::Hris::PaginatedLocationList.from_json(json_object: response.body)
  end
end

#retrieve(id:, include_remote_data: nil, include_shell_data: nil, remote_fields: nil, show_enum_origins: nil, request_options: nil) ⇒ Merge::Hris::Location

Returns a Location object with the given id.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.hris.locations.retrieve(id: "id")



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/merge_ruby_client/hris/locations/client.rb', line 243

def retrieve(id:, include_remote_data: nil, include_shell_data: nil, remote_fields: nil, show_enum_origins: nil,
             request_options: nil)
  Async do
    response = @request_client.conn.get do |req|
      req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
      req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
      req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      req.params = {
        **(request_options&.additional_query_parameters || {}),
        "include_remote_data": include_remote_data,
        "include_shell_data": include_shell_data,
        "remote_fields": remote_fields,
        "show_enum_origins": show_enum_origins
      }.compact
      unless request_options.nil? || request_options&.additional_body_parameters.nil?
        req.body = { **(request_options&.additional_body_parameters || {}) }.compact
      end
      req.url "#{@request_client.get_url(request_options: request_options)}/hris/v1/locations/#{id}"
    end
    Merge::Hris::Location.from_json(json_object: response.body)
  end
end