merge_ruby_client 0.1.4 → 1.0.0

data/lib/merge_ruby_client/accounting/types/vendor_credit_request_accounting_period.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "accounting_period"
+
+module Merge
+  module Accounting
+    # The accounting period that the VendorCredit was generated in.
+    class VendorCreditRequestAccountingPeriod
+      # Deserialize a JSON object to an instance of VendorCreditRequestAccountingPeriod
+      #
+      # @param json_object [String]
+      # @return [Merge::Accounting::VendorCreditRequestAccountingPeriod]
+      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::Accounting::AccountingPeriod.validate_raw(obj: struct)
+          return Merge::Accounting::AccountingPeriod.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::Accounting::AccountingPeriod.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/accounting/types/vendor_credit_request_company.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "company_info"
+
+module Merge
+  module Accounting
+    # The company the vendor credit belongs to.
+    class VendorCreditRequestCompany
+      # Deserialize a JSON object to an instance of VendorCreditRequestCompany
+      #
+      # @param json_object [String]
+      # @return [Merge::Accounting::VendorCreditRequestCompany]
+      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::Accounting::CompanyInfo.validate_raw(obj: struct)
+          return Merge::Accounting::CompanyInfo.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::Accounting::CompanyInfo.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/accounting/types/vendor_credit_request_tracking_categories_item.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "tracking_category"
+
+module Merge
+  module Accounting
+    class VendorCreditRequestTrackingCategoriesItem
+      # Deserialize a JSON object to an instance of
+      #  VendorCreditRequestTrackingCategoriesItem
+      #
+      # @param json_object [String]
+      # @return [Merge::Accounting::VendorCreditRequestTrackingCategoriesItem]
+      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::Accounting::TrackingCategory.validate_raw(obj: struct)
+          return Merge::Accounting::TrackingCategory.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::Accounting::TrackingCategory.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/accounting/types/vendor_credit_request_vendor.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "contact"
+
+module Merge
+  module Accounting
+    # The vendor that owes the gift or refund.
+    class VendorCreditRequestVendor
+      # Deserialize a JSON object to an instance of VendorCreditRequestVendor
+      #
+      # @param json_object [String]
+      # @return [Merge::Accounting::VendorCreditRequestVendor]
+      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::Accounting::Contact.validate_raw(obj: struct)
+          return Merge::Accounting::Contact.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::Accounting::Contact.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/accounting/types/vendor_credit_response.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require_relative "vendor_credit"
+require_relative "warning_validation_problem"
+require_relative "error_validation_problem"
+require_relative "debug_mode_log"
+require "ostruct"
+require "json"
+
+module Merge
+  module Accounting
+    class VendorCreditResponse
+      # @return [Merge::Accounting::VendorCredit]
+      attr_reader :model
+      # @return [Array<Merge::Accounting::WarningValidationProblem>]
+      attr_reader :warnings
+      # @return [Array<Merge::Accounting::ErrorValidationProblem>]
+      attr_reader :errors
+      # @return [Array<Merge::Accounting::DebugModeLog>]
+      attr_reader :logs
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param model [Merge::Accounting::VendorCredit]
+      # @param warnings [Array<Merge::Accounting::WarningValidationProblem>]
+      # @param errors [Array<Merge::Accounting::ErrorValidationProblem>]
+      # @param logs [Array<Merge::Accounting::DebugModeLog>]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Merge::Accounting::VendorCreditResponse]
+      def initialize(model:, warnings:, errors:, logs: OMIT, additional_properties: nil)
+        @model = model
+        @warnings = warnings
+        @errors = errors
+        @logs = logs if logs != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "model": model, "warnings": warnings, "errors": errors, "logs": logs }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of VendorCreditResponse
+      #
+      # @param json_object [String]
+      # @return [Merge::Accounting::VendorCreditResponse]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        if parsed_json["model"].nil?
+          model = nil
+        else
+          model = parsed_json["model"].to_json
+          model = Merge::Accounting::VendorCredit.from_json(json_object: model)
+        end
+        warnings = parsed_json["warnings"]&.map do |item|
+          item = item.to_json
+          Merge::Accounting::WarningValidationProblem.from_json(json_object: item)
+        end
+        errors = parsed_json["errors"]&.map do |item|
+          item = item.to_json
+          Merge::Accounting::ErrorValidationProblem.from_json(json_object: item)
+        end
+        logs = parsed_json["logs"]&.map do |item|
+          item = item.to_json
+          Merge::Accounting::DebugModeLog.from_json(json_object: item)
+        end
+        new(
+          model: model,
+          warnings: warnings,
+          errors: errors,
+          logs: logs,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of VendorCreditResponse to a JSON object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_field_set&.to_json
+      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:)
+        Merge::Accounting::VendorCredit.validate_raw(obj: obj.model)
+        obj.warnings.is_a?(Array) != false || raise("Passed value for field obj.warnings is not the expected type, validation failed.")
+        obj.errors.is_a?(Array) != false || raise("Passed value for field obj.errors is not the expected type, validation failed.")
+        obj.logs&.is_a?(Array) != false || raise("Passed value for field obj.logs is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/merge_ruby_client/accounting/vendor_credits/client.rb

@@ -4,8 +4,11 @@ require_relative "../../../requests"
 require "date"
 require_relative "types/vendor_credits_list_request_expand"
 require_relative "../types/paginated_vendor_credit_list"
+require_relative "../types/vendor_credit_request"
+require_relative "../types/vendor_credit_response"
 require_relative "types/vendor_credits_retrieve_request_expand"
 require_relative "../types/vendor_credit"
+require_relative "../types/meta_response"
 require "async"
 
 module Merge
@@ -28,9 +31,14 @@ module Merge
       # @param cursor [String] The pagination cursor value.
       # @param expand [Merge::Accounting::VendorCredits::VendorCreditsListRequestExpand] 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.
@@ -48,7 +56,7 @@ module Merge
       #  )
       #  api.accounting.vendor_credits.list
       def list(company_id: nil, 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_id: nil, transaction_date_after: nil, transaction_date_before: nil, request_options: nil)
+               include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: nil, transaction_date_after: nil, transaction_date_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?
@@ -67,6 +75,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,
@@ -82,6 +91,54 @@ module Merge
         Merge::Accounting::PaginatedVendorCreditList.from_json(json_object: response.body)
       end
 
+      # Creates a `VendorCredit` object with the given values.
+      #
+      # @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::Accounting::VendorCreditRequest, as a Hash
+      #   * :number (String)
+      #   * :transaction_date (DateTime)
+      #   * :vendor (Hash)
+      #   * :total_amount (Float)
+      #   * :currency (Merge::Accounting::TransactionCurrencyEnum)
+      #   * :exchange_rate (String)
+      #   * :inclusive_of_tax (Boolean)
+      #   * :company (Hash)
+      #   * :tracking_categories (Array<Merge::Accounting::VendorCreditRequestTrackingCategoriesItem>)
+      #   * :applied_to_lines (Array<Merge::Accounting::VendorCreditApplyLineForVendorCreditRequest>)
+      #   * :accounting_period (Hash)
+      #   * :integration_params (Hash{String => Object})
+      #   * :linked_account_params (Hash{String => Object})
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Accounting::VendorCreditResponse]
+      # @example
+      #  api = Merge::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Merge::Environment::PRODUCTION,
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.vendor_credits.create(model: {  })
+      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.account_token unless request_options&.account_token.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)}/accounting/v1/vendor-credits"
+        end
+        Merge::Accounting::VendorCreditResponse.from_json(json_object: response.body)
+      end
+
       # Returns a `VendorCredit` object with the given `id`.
       #
       # @param id [String]
@@ -120,6 +177,38 @@ module Merge
         end
         Merge::Accounting::VendorCredit.from_json(json_object: response.body)
       end
+
+      # Returns metadata for `VendorCredit` POSTs.
+      #
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Accounting::MetaResponse]
+      # @example
+      #  api = Merge::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Merge::Environment::PRODUCTION,
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.vendor_credits.meta_post_retrieve
+      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.account_token unless request_options&.account_token.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)}/accounting/v1/vendor-credits/meta/post"
+        end
+        Merge::Accounting::MetaResponse.from_json(json_object: response.body)
+      end
     end
 
     class AsyncVendorCreditsClient
@@ -140,9 +229,14 @@ module Merge
       # @param cursor [String] The pagination cursor value.
       # @param expand [Merge::Accounting::VendorCredits::VendorCreditsListRequestExpand] 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.
@@ -160,7 +254,7 @@ module Merge
       #  )
       #  api.accounting.vendor_credits.list
       def list(company_id: nil, 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_id: nil, transaction_date_after: nil, transaction_date_before: nil, request_options: nil)
+               include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: nil, transaction_date_after: nil, transaction_date_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?
@@ -180,6 +274,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,
@@ -196,6 +291,56 @@ module Merge
         end
       end
 
+      # Creates a `VendorCredit` object with the given values.
+      #
+      # @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::Accounting::VendorCreditRequest, as a Hash
+      #   * :number (String)
+      #   * :transaction_date (DateTime)
+      #   * :vendor (Hash)
+      #   * :total_amount (Float)
+      #   * :currency (Merge::Accounting::TransactionCurrencyEnum)
+      #   * :exchange_rate (String)
+      #   * :inclusive_of_tax (Boolean)
+      #   * :company (Hash)
+      #   * :tracking_categories (Array<Merge::Accounting::VendorCreditRequestTrackingCategoriesItem>)
+      #   * :applied_to_lines (Array<Merge::Accounting::VendorCreditApplyLineForVendorCreditRequest>)
+      #   * :accounting_period (Hash)
+      #   * :integration_params (Hash{String => Object})
+      #   * :linked_account_params (Hash{String => Object})
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Accounting::VendorCreditResponse]
+      # @example
+      #  api = Merge::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Merge::Environment::PRODUCTION,
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.vendor_credits.create(model: {  })
+      def create(model:, is_debug_mode: nil, run_async: nil, request_options: nil)
+        Async do
+          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.account_token unless request_options&.account_token.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)}/accounting/v1/vendor-credits"
+          end
+          Merge::Accounting::VendorCreditResponse.from_json(json_object: response.body)
+        end
+      end
+
       # Returns a `VendorCredit` object with the given `id`.
       #
       # @param id [String]
@@ -236,6 +381,40 @@ module Merge
           Merge::Accounting::VendorCredit.from_json(json_object: response.body)
         end
       end
+
+      # Returns metadata for `VendorCredit` POSTs.
+      #
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Accounting::MetaResponse]
+      # @example
+      #  api = Merge::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Merge::Environment::PRODUCTION,
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.vendor_credits.meta_post_retrieve
+      def meta_post_retrieve(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.account_token unless request_options&.account_token.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)}/accounting/v1/vendor-credits/meta/post"
+          end
+          Merge::Accounting::MetaResponse.from_json(json_object: response.body)
+        end
+      end
     end
   end
 end

data/lib/merge_ruby_client/ats/activities/client.rb

@@ -32,9 +32,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.
@@ -55,7 +60,7 @@ module Merge
       #  )
       #  api.ats.activities.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_fields: nil, remote_id: nil, show_enum_origins: nil, user_id: nil, request_options: nil)
+               include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, user_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?
@@ -73,6 +78,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,
@@ -233,9 +239,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.
@@ -256,7 +267,7 @@ module Merge
       #  )
       #  api.ats.activities.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_fields: nil, remote_id: nil, show_enum_origins: nil, user_id: nil, request_options: nil)
+               include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, user_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?
@@ -275,6 +286,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,