merge_ruby_client 0.1.4 → 1.0.0

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

@@ -46,7 +46,9 @@ module Merge
       # @return [DateTime] The day and time the payroll run was checked.
       attr_reader :check_date
       # @return [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  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/).
       attr_reader :remote_was_deleted
       # @return [Hash{String => Object}]
       attr_reader :field_mappings
@@ -80,7 +82,9 @@ module Merge
       # @param end_date [DateTime] The day and time the payroll run ended.
       # @param check_date [DateTime] The day and time the payroll run was checked.
       # @param remote_was_deleted [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  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 field_mappings [Hash{String => Object}]
       # @param remote_data [Array<Merge::Hris::RemoteData>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition

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

@@ -5,8 +5,14 @@ require "json"
 
 module Merge
   module Hris
+    # # The RemoteData Object
+    #  ### Description
+    #  The `RemoteData` object is used to represent the full data pulled from the
+    #  third-party API for an object.
+    #  ### Usage Example
+    #  TODO
     class RemoteData
-      # @return [String]
+      # @return [String] The third-party API path that is being called.
       attr_reader :path
       # @return [Object]
       attr_reader :data
@@ -18,7 +24,7 @@ module Merge
 
       OMIT = Object.new
 
-      # @param path [String]
+      # @param path [String] The third-party API path that is being called.
       # @param data [Object]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Merge::Hris::RemoteData]

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

@@ -31,7 +31,9 @@ module Merge
       # @return [Boolean] Whether or not the employer is responsible for paying the tax.
       attr_reader :employer_tax
       # @return [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  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/).
       attr_reader :remote_was_deleted
       # @return [Hash{String => Object}]
       attr_reader :field_mappings
@@ -54,7 +56,9 @@ module Merge
       # @param amount [Float] The tax amount.
       # @param employer_tax [Boolean] Whether or not the employer is responsible for paying the tax.
       # @param remote_was_deleted [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  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 field_mappings [Hash{String => Object}]
       # @param remote_data [Array<Merge::Hris::RemoteData>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition

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

@@ -30,7 +30,9 @@ module Merge
       # @return [Merge::Hris::TeamParentTeam] The team's parent team.
       attr_reader :parent_team
       # @return [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  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/).
       attr_reader :remote_was_deleted
       # @return [Hash{String => Object}]
       attr_reader :field_mappings
@@ -51,7 +53,9 @@ module Merge
       # @param name [String] The team's name.
       # @param parent_team [Merge::Hris::TeamParentTeam] The team's parent team.
       # @param remote_was_deleted [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  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 field_mappings [Hash{String => Object}]
       # @param remote_data [Array<Merge::Hris::RemoteData>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition

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

@@ -58,7 +58,10 @@ module Merge
       attr_reader :start_time
       # @return [DateTime] The day and time of the end of the time requested off.
       attr_reader :end_time
-      # @return [Boolean]
+      # @return [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/).
       attr_reader :remote_was_deleted
       # @return [Hash{String => Object}]
       attr_reader :field_mappings
@@ -98,7 +101,10 @@ module Merge
       #  - `BEREAVEMENT` - BEREAVEMENT
       # @param start_time [DateTime] The day and time of the start of the time requested off.
       # @param end_time [DateTime] The day and time of the end of the time requested off.
-      # @param remote_was_deleted [Boolean]
+      # @param remote_was_deleted [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 field_mappings [Hash{String => Object}]
       # @param remote_data [Array<Merge::Hris::RemoteData>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition

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

@@ -27,9 +27,11 @@ module Merge
       attr_reader :modified_at
       # @return [Merge::Hris::TimeOffBalanceEmployee] The employee the balance belongs to.
       attr_reader :employee
-      # @return [Float] The current remaining PTO balance, always measured in terms of hours.
+      # @return [Float] The current remaining PTO balance, measured in hours. For integrations that
+      #  return this value in days, Merge multiplies by 8 to calculate hours.
       attr_reader :balance
-      # @return [Float] The amount of PTO used in terms of hours.
+      # @return [Float] The amount of PTO used in terms of hours. For integrations that return this
+      #  value in days, Merge multiplies by 8 to calculate hours.
       attr_reader :used
       # @return [Merge::Hris::PolicyTypeEnum] The policy type of this time off balance.
       #  - `VACATION` - VACATION
@@ -40,7 +42,9 @@ module Merge
       #  - `BEREAVEMENT` - BEREAVEMENT
       attr_reader :policy_type
       # @return [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  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/).
       attr_reader :remote_was_deleted
       # @return [Hash{String => Object}]
       attr_reader :field_mappings
@@ -59,8 +63,10 @@ module Merge
       # @param created_at [DateTime] The datetime that this object was created by Merge.
       # @param modified_at [DateTime] The datetime that this object was modified by Merge.
       # @param employee [Merge::Hris::TimeOffBalanceEmployee] The employee the balance belongs to.
-      # @param balance [Float] The current remaining PTO balance, always measured in terms of hours.
-      # @param used [Float] The amount of PTO used in terms of hours.
+      # @param balance [Float] The current remaining PTO balance, measured in hours. For integrations that
+      #  return this value in days, Merge multiplies by 8 to calculate hours.
+      # @param used [Float] The amount of PTO used in terms of hours. For integrations that return this
+      #  value in days, Merge multiplies by 8 to calculate hours.
       # @param policy_type [Merge::Hris::PolicyTypeEnum] The policy type of this time off balance.
       #  - `VACATION` - VACATION
       #  - `SICK` - SICK
@@ -69,7 +75,9 @@ module Merge
       #  - `VOLUNTEER` - VOLUNTEER
       #  - `BEREAVEMENT` - BEREAVEMENT
       # @param remote_was_deleted [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  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 field_mappings [Hash{String => Object}]
       # @param remote_data [Array<Merge::Hris::RemoteData>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition

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

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "date"
+require_relative "timesheet_entry_employee"
+require_relative "remote_data"
 require "ostruct"
 require "json"
 
@@ -21,7 +23,7 @@ module Merge
       attr_reader :created_at
       # @return [DateTime] The datetime that this object was modified by Merge.
       attr_reader :modified_at
-      # @return [String] The employee the timesheet entry is for.
+      # @return [Merge::Hris::TimesheetEntryEmployee] The employee the timesheet entry is for.
       attr_reader :employee
       # @return [Float] The number of hours logged by the employee.
       attr_reader :hours_worked
@@ -30,11 +32,13 @@ module Merge
       # @return [DateTime] The time at which the employee ended work.
       attr_reader :end_time
       # @return [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  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/).
       attr_reader :remote_was_deleted
       # @return [Hash{String => Object}]
       attr_reader :field_mappings
-      # @return [Array<Hash{String => Object}>]
+      # @return [Array<Merge::Hris::RemoteData>]
       attr_reader :remote_data
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
@@ -48,14 +52,16 @@ module Merge
       # @param remote_id [String] The third-party API ID of the matching object.
       # @param created_at [DateTime] The datetime that this object was created by Merge.
       # @param modified_at [DateTime] The datetime that this object was modified by Merge.
-      # @param employee [String] The employee the timesheet entry is for.
+      # @param employee [Merge::Hris::TimesheetEntryEmployee] The employee the timesheet entry is for.
       # @param hours_worked [Float] The number of hours logged by the employee.
       # @param start_time [DateTime] The time at which the employee started work.
       # @param end_time [DateTime] The time at which the employee ended work.
       # @param remote_was_deleted [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  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 field_mappings [Hash{String => Object}]
-      # @param remote_data [Array<Hash{String => Object}>]
+      # @param remote_data [Array<Merge::Hris::RemoteData>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Merge::Hris::TimesheetEntry]
       def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, employee: OMIT,
@@ -100,13 +106,21 @@ module Merge
         remote_id = parsed_json["remote_id"]
         created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
         modified_at = (DateTime.parse(parsed_json["modified_at"]) unless parsed_json["modified_at"].nil?)
-        employee = parsed_json["employee"]
+        if parsed_json["employee"].nil?
+          employee = nil
+        else
+          employee = parsed_json["employee"].to_json
+          employee = Merge::Hris::TimesheetEntryEmployee.from_json(json_object: employee)
+        end
         hours_worked = parsed_json["hours_worked"]
         start_time = (DateTime.parse(parsed_json["start_time"]) unless parsed_json["start_time"].nil?)
         end_time = (DateTime.parse(parsed_json["end_time"]) unless parsed_json["end_time"].nil?)
         remote_was_deleted = parsed_json["remote_was_deleted"]
         field_mappings = parsed_json["field_mappings"]
-        remote_data = parsed_json["remote_data"]
+        remote_data = parsed_json["remote_data"]&.map do |item|
+          item = item.to_json
+          Merge::Hris::RemoteData.from_json(json_object: item)
+        end
         new(
           id: id,
           remote_id: remote_id,
@@ -141,7 +155,7 @@ module Merge
         obj.remote_id&.is_a?(String) != false || raise("Passed value for field obj.remote_id is not the expected type, validation failed.")
         obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
         obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.")
-        obj.employee&.is_a?(String) != false || raise("Passed value for field obj.employee is not the expected type, validation failed.")
+        obj.employee.nil? || Merge::Hris::TimesheetEntryEmployee.validate_raw(obj: obj.employee)
         obj.hours_worked&.is_a?(Float) != false || raise("Passed value for field obj.hours_worked is not the expected type, validation failed.")
         obj.start_time&.is_a?(DateTime) != false || raise("Passed value for field obj.start_time is not the expected type, validation failed.")
         obj.end_time&.is_a?(DateTime) != false || raise("Passed value for field obj.end_time is not the expected type, validation failed.")

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "employee"
+
+module Merge
+  module Hris
+    # The employee the timesheet entry is for.
+    class TimesheetEntryEmployee
+      # Deserialize a JSON object to an instance of TimesheetEntryEmployee
+      #
+      # @param json_object [String]
+      # @return [Merge::Hris::TimesheetEntryEmployee]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        begin
+          struct.is_a?(String) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+          return struct unless struct.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          Merge::Hris::Employee.validate_raw(obj: struct)
+          return Merge::Hris::Employee.from_json(json_object: struct) unless struct.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        struct
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        begin
+          return obj.is_a?(String) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+        rescue StandardError
+          # noop
+        end
+        begin
+          return Merge::Hris::Employee.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+  end
+end

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "timesheet_entry_request_employee"
 require "date"
 require "ostruct"
 require "json"
@@ -13,7 +14,7 @@ module Merge
     #  ### Usage Example
     #  GET and POST Timesheet Entries
     class TimesheetEntryRequest
-      # @return [String] The employee the timesheet entry is for.
+      # @return [Merge::Hris::TimesheetEntryRequestEmployee] The employee the timesheet entry is for.
       attr_reader :employee
       # @return [Float] The number of hours logged by the employee.
       attr_reader :hours_worked
@@ -33,7 +34,7 @@ module Merge
 
       OMIT = Object.new
 
-      # @param employee [String] The employee the timesheet entry is for.
+      # @param employee [Merge::Hris::TimesheetEntryRequestEmployee] The employee the timesheet entry is for.
       # @param hours_worked [Float] The number of hours logged by the employee.
       # @param start_time [DateTime] The time at which the employee started work.
       # @param end_time [DateTime] The time at which the employee ended work.
@@ -69,7 +70,12 @@ module Merge
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        employee = parsed_json["employee"]
+        if parsed_json["employee"].nil?
+          employee = nil
+        else
+          employee = parsed_json["employee"].to_json
+          employee = Merge::Hris::TimesheetEntryRequestEmployee.from_json(json_object: employee)
+        end
         hours_worked = parsed_json["hours_worked"]
         start_time = (DateTime.parse(parsed_json["start_time"]) unless parsed_json["start_time"].nil?)
         end_time = (DateTime.parse(parsed_json["end_time"]) unless parsed_json["end_time"].nil?)
@@ -100,7 +106,7 @@ module Merge
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.employee&.is_a?(String) != false || raise("Passed value for field obj.employee is not the expected type, validation failed.")
+        obj.employee.nil? || Merge::Hris::TimesheetEntryRequestEmployee.validate_raw(obj: obj.employee)
         obj.hours_worked&.is_a?(Float) != false || raise("Passed value for field obj.hours_worked is not the expected type, validation failed.")
         obj.start_time&.is_a?(DateTime) != false || raise("Passed value for field obj.start_time is not the expected type, validation failed.")
         obj.end_time&.is_a?(DateTime) != false || raise("Passed value for field obj.end_time is not the expected type, validation failed.")

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "employee"
+
+module Merge
+  module Hris
+    # The employee the timesheet entry is for.
+    class TimesheetEntryRequestEmployee
+      # Deserialize a JSON object to an instance of TimesheetEntryRequestEmployee
+      #
+      # @param json_object [String]
+      # @return [Merge::Hris::TimesheetEntryRequestEmployee]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        begin
+          struct.is_a?(String) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+          return struct unless struct.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          Merge::Hris::Employee.validate_raw(obj: struct)
+          return Merge::Hris::Employee.from_json(json_object: struct) unless struct.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        struct
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        begin
+          return obj.is_a?(String) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+        rescue StandardError
+          # noop
+        end
+        begin
+          return Merge::Hris::Employee.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+  end
+end

data/lib/merge_ruby_client/ticketing/accounts/client.rb

@@ -23,9 +23,14 @@ module Merge
       # @param created_after [DateTime] If provided, will only return objects created after this datetime.
       # @param created_before [DateTime] If provided, will only return objects created before this datetime.
       # @param cursor [String] The pagination cursor value.
-      # @param include_deleted_data [Boolean] Whether to include data that was marked as deleted by third party webhooks.
+      # @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.
@@ -41,7 +46,7 @@ module Merge
       #  )
       #  api.ticketing.accounts.list
       def list(created_after: nil, created_before: nil, cursor: nil, include_deleted_data: nil,
-               include_remote_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: nil, request_options: nil)
+               include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: 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?
@@ -58,6 +63,7 @@ module Merge
             "cursor": cursor,
             "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,
@@ -123,9 +129,14 @@ module Merge
       # @param created_after [DateTime] If provided, will only return objects created after this datetime.
       # @param created_before [DateTime] If provided, will only return objects created before this datetime.
       # @param cursor [String] The pagination cursor value.
-      # @param include_deleted_data [Boolean] Whether to include data that was marked as deleted by third party webhooks.
+      # @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.
@@ -141,7 +152,7 @@ module Merge
       #  )
       #  api.ticketing.accounts.list
       def list(created_after: nil, created_before: nil, cursor: nil, include_deleted_data: nil,
-               include_remote_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: nil, request_options: nil)
+               include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: 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?
@@ -159,6 +170,7 @@ module Merge
               "cursor": cursor,
               "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,

data/lib/merge_ruby_client/ticketing/async_passthrough/client.rb

@@ -3,7 +3,7 @@
 require_relative "../../../requests"
 require_relative "../types/data_passthrough_request"
 require_relative "../types/async_passthrough_reciept"
-require_relative "../types/remote_response"
+require_relative "types/async_passthrough_retrieve_response"
 require "async"
 
 module Merge
@@ -61,7 +61,7 @@ module Merge
       #
       # @param async_passthrough_receipt_id [String]
       # @param request_options [Merge::RequestOptions]
-      # @return [Merge::Ticketing::RemoteResponse]
+      # @return [Merge::Ticketing::RemoteResponse, String]
       # @example
       #  api = Merge::Client.new(
       #    base_url: "https://api.example.com",
@@ -87,7 +87,7 @@ module Merge
           end
           req.url "#{@request_client.get_url(request_options: request_options)}/ticketing/v1/async-passthrough/#{async_passthrough_receipt_id}"
         end
-        Merge::Ticketing::RemoteResponse.from_json(json_object: response.body)
+        Merge::Ticketing::AsyncPassthrough::AsyncPassthroughRetrieveResponse.from_json(json_object: response.body)
       end
     end
 
@@ -146,7 +146,7 @@ module Merge
       #
       # @param async_passthrough_receipt_id [String]
       # @param request_options [Merge::RequestOptions]
-      # @return [Merge::Ticketing::RemoteResponse]
+      # @return [Merge::Ticketing::RemoteResponse, String]
       # @example
       #  api = Merge::Client.new(
       #    base_url: "https://api.example.com",
@@ -173,7 +173,7 @@ module Merge
             end
             req.url "#{@request_client.get_url(request_options: request_options)}/ticketing/v1/async-passthrough/#{async_passthrough_receipt_id}"
           end
-          Merge::Ticketing::RemoteResponse.from_json(json_object: response.body)
+          Merge::Ticketing::AsyncPassthrough::AsyncPassthroughRetrieveResponse.from_json(json_object: response.body)
         end
       end
     end

data/lib/merge_ruby_client/ticketing/async_passthrough/types/async_passthrough_retrieve_response.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "../../types/remote_response"
+
+module Merge
+  module Ticketing
+    class AsyncPassthrough
+      class AsyncPassthroughRetrieveResponse
+        # Deserialize a JSON object to an instance of AsyncPassthroughRetrieveResponse
+        #
+        # @param json_object [String]
+        # @return [Merge::Ticketing::AsyncPassthrough::AsyncPassthroughRetrieveResponse]
+        def self.from_json(json_object:)
+          struct = JSON.parse(json_object, object_class: OpenStruct)
+          begin
+            Merge::Ticketing::RemoteResponse.validate_raw(obj: struct)
+            return Merge::Ticketing::RemoteResponse.from_json(json_object: struct) unless struct.nil?
+
+            return nil
+          rescue StandardError
+            # noop
+          end
+          begin
+            struct.is_a?(String) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+            return struct unless struct.nil?
+
+            return nil
+          rescue StandardError
+            # noop
+          end
+          struct
+        end
+
+        # Leveraged for Union-type generation, validate_raw attempts to parse the given
+        #  hash and check each fields type against the current object's property
+        #  definitions.
+        #
+        # @param obj [Object]
+        # @return [Void]
+        def self.validate_raw(obj:)
+          begin
+            return Merge::Ticketing::RemoteResponse.validate_raw(obj: obj)
+          rescue StandardError
+            # noop
+          end
+          begin
+            return obj.is_a?(String) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+          rescue StandardError
+            # noop
+          end
+          raise("Passed value matched no type within the union, validation failed.")
+        end
+      end
+    end
+  end
+end

data/lib/merge_ruby_client/ticketing/attachments/client.rb

@@ -28,9 +28,14 @@ module Merge
       # @param cursor [String] The pagination cursor value.
       # @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] Whether to include data that was marked as deleted by third party webhooks.
+      # @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.
@@ -49,7 +54,7 @@ module Merge
       #  )
       #  api.ticketing.attachments.list
       def list(created_after: nil, created_before: nil, cursor: nil, expand: nil, include_deleted_data: nil,
-               include_remote_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_created_after: nil, remote_id: nil, ticket_id: nil, request_options: nil)
+               include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_created_after: nil, remote_id: nil, ticket_id: 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?
@@ -67,6 +72,7 @@ module Merge
             "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,
@@ -252,9 +258,14 @@ module Merge
       # @param cursor [String] The pagination cursor value.
       # @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] Whether to include data that was marked as deleted by third party webhooks.
+      # @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.
@@ -273,7 +284,7 @@ module Merge
       #  )
       #  api.ticketing.attachments.list
       def list(created_after: nil, created_before: nil, cursor: nil, expand: nil, include_deleted_data: nil,
-               include_remote_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_created_after: nil, remote_id: nil, ticket_id: nil, request_options: nil)
+               include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_created_after: nil, remote_id: nil, ticket_id: 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?
@@ -292,6 +303,7 @@ module Merge
               "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,