Class: Merge::Hris::TimeOffClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Parameters:



28
29
30
 
# File 'lib/merge_ruby_client/hris/time_off/client.rb', line 28

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Merge::RequestClient (readonly)

Returns:



24
25
26
 
# File 'lib/merge_ruby_client/hris/time_off/client.rb', line 24

def request_client
  @request_client
end

Instance Method Details

#create(model:, is_debug_mode: nil, run_async: nil, request_options: nil) ⇒ Merge::Hris::TimeOffResponse

Creates a TimeOff object with the given values.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.hris.time_off.create(model: {  })

Parameters:

  • is_debug_mode (Boolean) (defaults to: nil) —

    Whether to include debug fields (such as log file links) in the response.

  • run_async (Boolean) (defaults to: nil) —

    Whether or not third-party updates should be run asynchronously.

  • model (Hash) —

    Request of type Merge::Hris::TimeOffRequest, as a Hash

    • :employee (Hash)

    • :approver (Hash)

    • :status (Merge::Hris::TimeOffStatusEnum)

    • :employee_note (String)

    • :units (Merge::Hris::UnitsEnum)

    • :amount (Float)

    • :request_type (Merge::Hris::RequestTypeEnum)

    • :start_time (DateTime)

    • :end_time (DateTime)

    • :integration_params (Hash=> Object)

    • :linked_account_params (Hash=> Object)

  • request_options (Merge::RequestOptions) (defaults to: nil)

Returns:



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/merge_ruby_client/hris/time_off/client.rb', line 154

def create(model:, is_debug_mode: nil, run_async: nil, request_options: nil)
  response = @request_client.conn.post 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 || {}),
      "is_debug_mode": is_debug_mode,
      "run_async": run_async
    }.compact
    req.body = { **(request_options&.additional_body_parameters || {}), model: model }.compact
    req.url "#{@request_client.get_url(request_options: request_options)}/hris/v1/time-off"
  end
  Merge::Hris::TimeOffResponse.from_json(json_object: response.body)
end

#list(approver_id: nil, created_after: nil, created_before: nil, cursor: nil, employee_id: nil, ended_after: nil, ended_before: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_fields: nil, remote_id: nil, request_type: nil, show_enum_origins: nil, started_after: nil, started_before: nil, status: nil, request_options: nil) ⇒ Merge::Hris::PaginatedTimeOffList

Returns a list of TimeOff objects.

Examples:

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

Parameters:

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

    If provided, will only return time off for this approver.

  • created_after (DateTime) (defaults to: nil) —

    If provided, will only return objects created after this datetime.

  • created_before (DateTime) (defaults to: nil) —

    If provided, will only return objects created before this datetime.

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

    The pagination cursor value.

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

    If provided, will only return time off for this employee.

  • ended_after (DateTime) (defaults to: nil) —

    If provided, will only return employees that ended after this datetime.

  • ended_before (DateTime) (defaults to: nil) —

    If provided, will only return time-offs that ended before this datetime.

  • expand (Merge::Hris::TimeOff::TimeOffListRequestExpand) (defaults to: nil) —

    Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

  • include_deleted_data (Boolean) (defaults to: nil) —

    Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).

  • include_remote_data (Boolean) (defaults to: nil) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • include_shell_data (Boolean) (defaults to: nil) —

    Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

  • modified_after (DateTime) (defaults to: nil) —

    If provided, only objects synced by Merge after this date time will be returned.

  • modified_before (DateTime) (defaults to: nil) —

    If provided, only objects synced by Merge before this date time will be returned.

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

    Number of results to return per page.

  • remote_fields (Merge::Hris::TimeOff::TimeOffListRequestRemoteFields) (defaults to: nil) —

    Deprecated. Use show_enum_origins.

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

    The API provider’s ID for the given object.

  • request_type (Merge::Hris::TimeOff::TimeOffListRequestRequestType) (defaults to: nil) —

    If provided, will only return TimeOff with this request type. Options: (‘VACATION’, ‘SICK’, ‘PERSONAL’, ‘JURY_DUTY’, ‘VOLUNTEER’, ‘BEREAVEMENT’)

    • VACATION - VACATION

    • SICK - SICK

    • PERSONAL - PERSONAL

    • JURY_DUTY - JURY_DUTY

    • VOLUNTEER - VOLUNTEER

    • BEREAVEMENT - BEREAVEMENT

  • show_enum_origins (Merge::Hris::TimeOff::TimeOffListRequestShowEnumOrigins) (defaults to: nil) —

    A comma separated list of enum field names for which you’d like the original values to be returned, instead of Merge’s normalized enum values. [Learn e](help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)

  • started_after (DateTime) (defaults to: nil) —

    If provided, will only return time-offs that started after this datetime.

  • started_before (DateTime) (defaults to: nil) —

    If provided, will only return time-offs that started before this datetime.

  • status (Merge::Hris::TimeOff::TimeOffListRequestStatus) (defaults to: nil) —

    If provided, will only return TimeOff with this status. Options: (‘REQUESTED’, ‘APPROVED’, ‘DECLINED’, ‘CANCELLED’, ‘DELETED’)

    • REQUESTED - REQUESTED

    • APPROVED - APPROVED

    • DECLINED - DECLINED

    • CANCELLED - CANCELLED

    • DELETED - DELETED

  • request_options (Merge::RequestOptions) (defaults to: nil)

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/merge_ruby_client/hris/time_off/client.rb', line 86

def list(approver_id: nil, created_after: nil, created_before: nil, cursor: nil, employee_id: nil,
         ended_after: nil, ended_before: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_fields: nil, remote_id: nil, request_type: nil, show_enum_origins: nil, started_after: nil, started_before: nil, status: nil, request_options: nil)
  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 || {}),
      "approver_id": approver_id,
      "created_after": created_after,
      "created_before": created_before,
      "cursor": cursor,
      "employee_id": employee_id,
      "ended_after": ended_after,
      "ended_before": ended_before,
      "expand": expand,
      "include_deleted_data": include_deleted_data,
      "include_remote_data": include_remote_data,
      "include_shell_data": include_shell_data,
      "modified_after": modified_after,
      "modified_before": modified_before,
      "page_size": page_size,
      "remote_fields": remote_fields,
      "remote_id": remote_id,
      "request_type": request_type,
      "show_enum_origins": show_enum_origins,
      "started_after": started_after,
      "started_before": started_before,
      "status": status
    }.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/time-off"
  end
  Merge::Hris::PaginatedTimeOffList.from_json(json_object: response.body)
end

#meta_post_retrieve(request_options: nil) ⇒ Merge::Hris::MetaResponse

Returns metadata for TimeOff POSTs.

Examples:

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

Parameters:

Returns:



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/merge_ruby_client/hris/time_off/client.rb', line 235

def meta_post_retrieve(request_options: nil)
  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
    unless request_options.nil? || request_options&.additional_query_parameters.nil?
      req.params = { **(request_options&.additional_query_parameters || {}) }.compact
    end
    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/time-off/meta/post"
  end
  Merge::Hris::MetaResponse.from_json(json_object: response.body)
end

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

Returns a TimeOff 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.time_off.retrieve(id: "id")

Parameters:

Returns:



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
222
 
# File 'lib/merge_ruby_client/hris/time_off/client.rb', line 197

def retrieve(id:, expand: nil, include_remote_data: nil, include_shell_data: nil, remote_fields: nil,
             show_enum_origins: nil, request_options: nil)
  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 || {}),
      "expand": expand,
      "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/time-off/#{id}"
  end
  Merge::Hris::TimeOff.from_json(json_object: response.body)
end