merge_ruby_client 0.1.4 → 1.1.0

data/lib/merge_ruby_client/hris/timesheet_entries/client.rb

@@ -28,11 +28,18 @@ module Merge
       # @param created_before [DateTime] If provided, will only return objects created before this datetime.
       # @param cursor [String] The pagination cursor value.
       # @param employee_id [String] If provided, will only return timesheet entries for this employee.
-      # @param ended_after [String] If provided, will only return timesheet entries ended after this datetime.
-      # @param ended_before [String] If provided, will only return timesheet entries ended before this datetime.
-      # @param include_deleted_data [Boolean] Whether to include data that was marked as deleted by third party webhooks.
+      # @param ended_after [DateTime] If provided, will only return timesheet entries ended after this datetime.
+      # @param ended_before [DateTime] If provided, will only return timesheet entries ended before this datetime.
+      # @param expand [String] Which relations should be returned in expanded form. Multiple relation names
+      #  should be comma separated without spaces.
+      # @param include_deleted_data [Boolean] 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](https://docs.merge.dev/integrations/hris/supported-features/).
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param modified_after [DateTime] If provided, only objects synced by Merge after this date time will be returned.
       # @param modified_before [DateTime] If provided, only objects synced by Merge before this date time will be
       #  returned.
@@ -40,8 +47,8 @@ module Merge
       #  start_time, -start_time.
       # @param page_size [Integer] Number of results to return per page.
       # @param remote_id [String] The API provider's ID for the given object.
-      # @param started_after [String] If provided, will only return timesheet entries started after this datetime.
-      # @param started_before [String] If provided, will only return timesheet entries started before this datetime.
+      # @param started_after [DateTime] If provided, will only return timesheet entries started after this datetime.
+      # @param started_before [DateTime] If provided, will only return timesheet entries started before this datetime.
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Hris::PaginatedTimesheetEntryList]
       # @example
@@ -52,7 +59,7 @@ module Merge
       #  )
       #  api.hris.timesheet_entries.list
       def list(created_after: nil, created_before: nil, cursor: nil, employee_id: nil, ended_after: nil,
-               ended_before: nil, include_deleted_data: nil, include_remote_data: nil, modified_after: nil, modified_before: nil, order_by: nil, page_size: nil, remote_id: nil, started_after: nil, started_before: nil, request_options: nil)
+               ended_before: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, order_by: nil, page_size: nil, remote_id: nil, started_after: nil, started_before: 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?
@@ -70,8 +77,10 @@ module Merge
             "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,
             "order_by": order_by,
@@ -93,7 +102,7 @@ module Merge
       # @param is_debug_mode [Boolean] Whether to include debug fields (such as log file links) in the response.
       # @param run_async [Boolean] Whether or not third-party updates should be run asynchronously.
       # @param model [Hash] Request of type Merge::Hris::TimesheetEntryRequest, as a Hash
-      #   * :employee (String)
+      #   * :employee (Hash)
       #   * :hours_worked (Float)
       #   * :start_time (DateTime)
       #   * :end_time (DateTime)
@@ -132,8 +141,12 @@ module Merge
       # Returns a `TimesheetEntry` object with the given `id`.
       #
       # @param id [String]
+      # @param expand [String] Which relations should be returned in expanded form. Multiple relation names
+      #  should be comma separated without spaces.
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Hris::TimesheetEntry]
       # @example
@@ -143,7 +156,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.hris.timesheet_entries.retrieve(id: "id")
-      def retrieve(id:, include_remote_data: nil, request_options: nil)
+      def retrieve(id:, expand: nil, include_remote_data: nil, include_shell_data: 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?
@@ -155,7 +168,9 @@ module Merge
           }.compact
           req.params = {
             **(request_options&.additional_query_parameters || {}),
-            "include_remote_data": include_remote_data
+            "expand": expand,
+            "include_remote_data": include_remote_data,
+            "include_shell_data": include_shell_data
           }.compact
           unless request_options.nil? || request_options&.additional_body_parameters.nil?
             req.body = { **(request_options&.additional_body_parameters || {}) }.compact
@@ -214,11 +229,18 @@ module Merge
       # @param created_before [DateTime] If provided, will only return objects created before this datetime.
       # @param cursor [String] The pagination cursor value.
       # @param employee_id [String] If provided, will only return timesheet entries for this employee.
-      # @param ended_after [String] If provided, will only return timesheet entries ended after this datetime.
-      # @param ended_before [String] If provided, will only return timesheet entries ended before this datetime.
-      # @param include_deleted_data [Boolean] Whether to include data that was marked as deleted by third party webhooks.
+      # @param ended_after [DateTime] If provided, will only return timesheet entries ended after this datetime.
+      # @param ended_before [DateTime] If provided, will only return timesheet entries ended before this datetime.
+      # @param expand [String] Which relations should be returned in expanded form. Multiple relation names
+      #  should be comma separated without spaces.
+      # @param include_deleted_data [Boolean] 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](https://docs.merge.dev/integrations/hris/supported-features/).
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param modified_after [DateTime] If provided, only objects synced by Merge after this date time will be returned.
       # @param modified_before [DateTime] If provided, only objects synced by Merge before this date time will be
       #  returned.
@@ -226,8 +248,8 @@ module Merge
       #  start_time, -start_time.
       # @param page_size [Integer] Number of results to return per page.
       # @param remote_id [String] The API provider's ID for the given object.
-      # @param started_after [String] If provided, will only return timesheet entries started after this datetime.
-      # @param started_before [String] If provided, will only return timesheet entries started before this datetime.
+      # @param started_after [DateTime] If provided, will only return timesheet entries started after this datetime.
+      # @param started_before [DateTime] If provided, will only return timesheet entries started before this datetime.
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Hris::PaginatedTimesheetEntryList]
       # @example
@@ -238,7 +260,7 @@ module Merge
       #  )
       #  api.hris.timesheet_entries.list
       def list(created_after: nil, created_before: nil, cursor: nil, employee_id: nil, ended_after: nil,
-               ended_before: nil, include_deleted_data: nil, include_remote_data: nil, modified_after: nil, modified_before: nil, order_by: nil, page_size: nil, remote_id: nil, started_after: nil, started_before: nil, request_options: nil)
+               ended_before: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, order_by: nil, page_size: nil, remote_id: nil, started_after: nil, started_before: 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?
@@ -257,8 +279,10 @@ module Merge
               "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,
               "order_by": order_by,
@@ -281,7 +305,7 @@ module Merge
       # @param is_debug_mode [Boolean] Whether to include debug fields (such as log file links) in the response.
       # @param run_async [Boolean] Whether or not third-party updates should be run asynchronously.
       # @param model [Hash] Request of type Merge::Hris::TimesheetEntryRequest, as a Hash
-      #   * :employee (String)
+      #   * :employee (Hash)
       #   * :hours_worked (Float)
       #   * :start_time (DateTime)
       #   * :end_time (DateTime)
@@ -322,8 +346,12 @@ module Merge
       # Returns a `TimesheetEntry` object with the given `id`.
       #
       # @param id [String]
+      # @param expand [String] Which relations should be returned in expanded form. Multiple relation names
+      #  should be comma separated without spaces.
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Hris::TimesheetEntry]
       # @example
@@ -333,7 +361,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.hris.timesheet_entries.retrieve(id: "id")
-      def retrieve(id:, include_remote_data: nil, request_options: nil)
+      def retrieve(id:, expand: nil, include_remote_data: nil, include_shell_data: 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?
@@ -346,7 +374,9 @@ module Merge
             }.compact
             req.params = {
               **(request_options&.additional_query_parameters || {}),
-              "include_remote_data": include_remote_data
+              "expand": expand,
+              "include_remote_data": include_remote_data,
+              "include_shell_data": include_shell_data
             }.compact
             unless request_options.nil? || request_options&.additional_body_parameters.nil?
               req.body = { **(request_options&.additional_body_parameters || {}) }.compact

data/lib/merge_ruby_client/hris/types/account_details.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "category_enum"
+require "date"
 require "ostruct"
 require "json"
 
@@ -32,6 +33,8 @@ module Merge
       attr_reader :is_duplicate
       # @return [String]
       attr_reader :account_type
+      # @return [DateTime] The time at which account completes the linking flow.
+      attr_reader :completed_at
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
       # @return [Object]
@@ -54,10 +57,11 @@ module Merge
       #  incomplete Production Linked Accounts, and ignored duplicate Production Linked
       #  Account sets.
       # @param account_type [String]
+      # @param completed_at [DateTime] The time at which account completes the linking flow.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Merge::Hris::AccountDetails]
       def initialize(id: OMIT, integration: OMIT, integration_slug: OMIT, category: OMIT, end_user_origin_id: OMIT,
-                     end_user_organization_name: OMIT, end_user_email_address: OMIT, status: OMIT, webhook_listener_url: OMIT, is_duplicate: OMIT, account_type: OMIT, additional_properties: nil)
+                     end_user_organization_name: OMIT, end_user_email_address: OMIT, status: OMIT, webhook_listener_url: OMIT, is_duplicate: OMIT, account_type: OMIT, completed_at: OMIT, additional_properties: nil)
         @id = id if id != OMIT
         @integration = integration if integration != OMIT
         @integration_slug = integration_slug if integration_slug != OMIT
@@ -69,6 +73,7 @@ module Merge
         @webhook_listener_url = webhook_listener_url if webhook_listener_url != OMIT
         @is_duplicate = is_duplicate if is_duplicate != OMIT
         @account_type = account_type if account_type != OMIT
+        @completed_at = completed_at if completed_at != OMIT
         @additional_properties = additional_properties
         @_field_set = {
           "id": id,
@@ -81,7 +86,8 @@ module Merge
           "status": status,
           "webhook_listener_url": webhook_listener_url,
           "is_duplicate": is_duplicate,
-          "account_type": account_type
+          "account_type": account_type,
+          "completed_at": completed_at
         }.reject do |_k, v|
           v == OMIT
         end
@@ -105,6 +111,7 @@ module Merge
         webhook_listener_url = parsed_json["webhook_listener_url"]
         is_duplicate = parsed_json["is_duplicate"]
         account_type = parsed_json["account_type"]
+        completed_at = (DateTime.parse(parsed_json["completed_at"]) unless parsed_json["completed_at"].nil?)
         new(
           id: id,
           integration: integration,
@@ -117,6 +124,7 @@ module Merge
           webhook_listener_url: webhook_listener_url,
           is_duplicate: is_duplicate,
           account_type: account_type,
+          completed_at: completed_at,
           additional_properties: struct
         )
       end
@@ -146,6 +154,7 @@ module Merge
         obj.webhook_listener_url&.is_a?(String) != false || raise("Passed value for field obj.webhook_listener_url is not the expected type, validation failed.")
         obj.is_duplicate&.is_a?(Boolean) != false || raise("Passed value for field obj.is_duplicate is not the expected type, validation failed.")
         obj.account_type&.is_a?(String) != false || raise("Passed value for field obj.account_type is not the expected type, validation failed.")
+        obj.completed_at&.is_a?(DateTime) != false || raise("Passed value for field obj.completed_at is not the expected type, validation failed.")
       end
     end
   end

data/lib/merge_ruby_client/hris/types/account_details_and_actions.rb

@@ -3,6 +3,7 @@
 require_relative "category_enum"
 require_relative "account_details_and_actions_status_enum"
 require_relative "account_details_and_actions_integration"
+require "date"
 require "ostruct"
 require "json"
 
@@ -42,6 +43,8 @@ module Merge
       attr_reader :integration
       # @return [String]
       attr_reader :account_type
+      # @return [DateTime]
+      attr_reader :completed_at
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
       # @return [Object]
@@ -65,10 +68,11 @@ module Merge
       #  Account sets.
       # @param integration [Merge::Hris::AccountDetailsAndActionsIntegration]
       # @param account_type [String]
+      # @param completed_at [DateTime]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Merge::Hris::AccountDetailsAndActions]
       def initialize(id:, status:, end_user_organization_name:, end_user_email_address:, webhook_listener_url:,
-                     account_type:, category: OMIT, status_detail: OMIT, end_user_origin_id: OMIT, subdomain: OMIT, is_duplicate: OMIT, integration: OMIT, additional_properties: nil)
+                     account_type:, completed_at:, category: OMIT, status_detail: OMIT, end_user_origin_id: OMIT, subdomain: OMIT, is_duplicate: OMIT, integration: OMIT, additional_properties: nil)
         @id = id
         @category = category if category != OMIT
         @status = status
@@ -81,6 +85,7 @@ module Merge
         @is_duplicate = is_duplicate if is_duplicate != OMIT
         @integration = integration if integration != OMIT
         @account_type = account_type
+        @completed_at = completed_at
         @additional_properties = additional_properties
         @_field_set = {
           "id": id,
@@ -94,7 +99,8 @@ module Merge
           "webhook_listener_url": webhook_listener_url,
           "is_duplicate": is_duplicate,
           "integration": integration,
-          "account_type": account_type
+          "account_type": account_type,
+          "completed_at": completed_at
         }.reject do |_k, v|
           v == OMIT
         end
@@ -124,6 +130,7 @@ module Merge
           integration = Merge::Hris::AccountDetailsAndActionsIntegration.from_json(json_object: integration)
         end
         account_type = parsed_json["account_type"]
+        completed_at = (DateTime.parse(parsed_json["completed_at"]) unless parsed_json["completed_at"].nil?)
         new(
           id: id,
           category: category,
@@ -137,6 +144,7 @@ module Merge
           is_duplicate: is_duplicate,
           integration: integration,
           account_type: account_type,
+          completed_at: completed_at,
           additional_properties: struct
         )
       end
@@ -167,6 +175,7 @@ module Merge
         obj.is_duplicate&.is_a?(Boolean) != false || raise("Passed value for field obj.is_duplicate is not the expected type, validation failed.")
         obj.integration.nil? || Merge::Hris::AccountDetailsAndActionsIntegration.validate_raw(obj: obj.integration)
         obj.account_type.is_a?(String) != false || raise("Passed value for field obj.account_type is not the expected type, validation failed.")
+        obj.completed_at.is_a?(DateTime) != false || raise("Passed value for field obj.completed_at is not the expected type, validation failed.")
       end
     end
   end

data/lib/merge_ruby_client/hris/types/account_details_and_actions_status_enum.rb

@@ -2,13 +2,15 @@
 
 module Merge
   module Hris
-    # - `COMPLETE` - COMPLETE
-    #  - `INCOMPLETE` - INCOMPLETE
-    #  - `RELINK_NEEDED` - RELINK_NEEDED
+    # * `COMPLETE` - COMPLETE
+    #  * `INCOMPLETE` - INCOMPLETE
+    #  * `RELINK_NEEDED` - RELINK_NEEDED
+    #  * `IDLE` - IDLE
     class AccountDetailsAndActionsStatusEnum
       COMPLETE = "COMPLETE"
       INCOMPLETE = "INCOMPLETE"
       RELINK_NEEDED = "RELINK_NEEDED"
+      IDLE = "IDLE"
     end
   end
 end

data/lib/merge_ruby_client/hris/types/account_integration.rb

@@ -17,10 +17,9 @@ module Merge
       # @return [Array<Merge::Hris::CategoriesEnum>] Category or categories this integration belongs to. Multiple categories should
       #  be comma separated, i.e. [ats, hris].
       attr_reader :categories
-      # @return [String] Company logo in rectangular shape. <b>Upload an image with a clear
-      #  background.</b>
+      # @return [String] Company logo in rectangular shape.
       attr_reader :image
-      # @return [String] Company logo in square shape. <b>Upload an image with a white background.</b>
+      # @return [String] Company logo in square shape.
       attr_reader :square_image
       # @return [String] The color of this integration used for buttons and text throughout the app and
       #  landing pages. <b>Choose a darker, saturated color.</b>
@@ -52,9 +51,8 @@ module Merge
       #  SuccessFactors)</i>
       # @param categories [Array<Merge::Hris::CategoriesEnum>] Category or categories this integration belongs to. Multiple categories should
       #  be comma separated, i.e. [ats, hris].
-      # @param image [String] Company logo in rectangular shape. <b>Upload an image with a clear
-      #  background.</b>
-      # @param square_image [String] Company logo in square shape. <b>Upload an image with a white background.</b>
+      # @param image [String] Company logo in rectangular shape.
+      # @param square_image [String] Company logo in square shape.
       # @param color [String] The color of this integration used for buttons and text throughout the app and
       #  landing pages. <b>Choose a darker, saturated color.</b>
       # @param slug [String]

data/lib/merge_ruby_client/hris/types/account_token.rb

@@ -11,6 +11,8 @@ module Merge
       attr_reader :account_token
       # @return [Merge::Hris::AccountIntegration]
       attr_reader :integration
+      # @return [String]
+      attr_reader :id
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
       # @return [Object]
@@ -21,13 +23,15 @@ module Merge
 
       # @param account_token [String]
       # @param integration [Merge::Hris::AccountIntegration]
+      # @param id [String]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Merge::Hris::AccountToken]
-      def initialize(account_token:, integration:, additional_properties: nil)
+      def initialize(account_token:, integration:, id:, additional_properties: nil)
         @account_token = account_token
         @integration = integration
+        @id = id
         @additional_properties = additional_properties
-        @_field_set = { "account_token": account_token, "integration": integration }
+        @_field_set = { "account_token": account_token, "integration": integration, "id": id }
       end
 
       # Deserialize a JSON object to an instance of AccountToken
@@ -44,9 +48,11 @@ module Merge
           integration = parsed_json["integration"].to_json
           integration = Merge::Hris::AccountIntegration.from_json(json_object: integration)
         end
+        id = parsed_json["id"]
         new(
           account_token: account_token,
           integration: integration,
+          id: id,
           additional_properties: struct
         )
       end
@@ -67,6 +73,7 @@ module Merge
       def self.validate_raw(obj:)
         obj.account_token.is_a?(String) != false || raise("Passed value for field obj.account_token is not the expected type, validation failed.")
         Merge::Hris::AccountIntegration.validate_raw(obj: obj.integration)
+        obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
       end
     end
   end

data/lib/merge_ruby_client/hris/types/account_type_enum.rb

@@ -2,8 +2,8 @@
 
 module Merge
   module Hris
-    # - `SAVINGS` - SAVINGS
-    #  - `CHECKING` - CHECKING
+    # * `SAVINGS` - SAVINGS
+    #  * `CHECKING` - CHECKING
     class AccountTypeEnum
       SAVINGS = "SAVINGS"
       CHECKING = "CHECKING"