merge_ruby_client 0.1.4 → 1.1.0

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

@@ -23,6 +23,10 @@ module Merge
       #  between third-party Remote Fields and user defined Merge fields. [Learn
       #  more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
       #
+      # @param exclude_remote_field_metadata [Boolean] If `true`, remote fields metadata is excluded from each field mapping instance
+      #  (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null).
+      #  This will increase the speed of the request since these fields require some
+      #  calculations.
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Accounting::FieldMappingApiInstanceResponse]
       # @example
@@ -32,7 +36,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.accounting.field_mapping.field_mappings_retrieve
-      def field_mappings_retrieve(request_options: nil)
+      def field_mappings_retrieve(exclude_remote_field_metadata: 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?
@@ -42,9 +46,10 @@ module Merge
         **@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
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "exclude_remote_field_metadata": exclude_remote_field_metadata
+          }.compact
           unless request_options.nil? || request_options&.additional_body_parameters.nil?
             req.body = { **(request_options&.additional_body_parameters || {}) }.compact
           end
@@ -57,6 +62,10 @@ module Merge
       #  This will cause the next sync for this Linked Account to sync **ALL** data from
       #  start.
       #
+      # @param exclude_remote_field_metadata [Boolean] If `true`, remote fields metadata is excluded from each field mapping instance
+      #  (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null).
+      #  This will increase the speed of the request since these fields require some
+      #  calculations.
       # @param target_field_name [String] The name of the target field you want this remote field to map to.
       # @param target_field_description [String] The description of the target field you want this remote field to map to.
       # @param remote_field_traversal_path [Array<Object>] The field traversal path of the remote field listed when you hit the GET
@@ -82,7 +91,7 @@ module Merge
       #    common_model_name: "ExampleCommonModel"
       #  )
       def field_mappings_create(target_field_name:, target_field_description:, remote_field_traversal_path:,
-                                remote_method:, remote_url_path:, common_model_name:, request_options: nil)
+                                remote_method:, remote_url_path:, common_model_name:, exclude_remote_field_metadata: 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?
@@ -92,9 +101,10 @@ module Merge
         **@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
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "exclude_remote_field_metadata": exclude_remote_field_metadata
+          }.compact
           req.body = {
             **(request_options&.additional_body_parameters || {}),
             target_field_name: target_field_name,
@@ -280,6 +290,10 @@ module Merge
       #  between third-party Remote Fields and user defined Merge fields. [Learn
       #  more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
       #
+      # @param exclude_remote_field_metadata [Boolean] If `true`, remote fields metadata is excluded from each field mapping instance
+      #  (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null).
+      #  This will increase the speed of the request since these fields require some
+      #  calculations.
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Accounting::FieldMappingApiInstanceResponse]
       # @example
@@ -289,7 +303,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.accounting.field_mapping.field_mappings_retrieve
-      def field_mappings_retrieve(request_options: nil)
+      def field_mappings_retrieve(exclude_remote_field_metadata: 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?
@@ -300,9 +314,10 @@ module Merge
           **@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
+            req.params = {
+              **(request_options&.additional_query_parameters || {}),
+              "exclude_remote_field_metadata": exclude_remote_field_metadata
+            }.compact
             unless request_options.nil? || request_options&.additional_body_parameters.nil?
               req.body = { **(request_options&.additional_body_parameters || {}) }.compact
             end
@@ -316,6 +331,10 @@ module Merge
       #  This will cause the next sync for this Linked Account to sync **ALL** data from
       #  start.
       #
+      # @param exclude_remote_field_metadata [Boolean] If `true`, remote fields metadata is excluded from each field mapping instance
+      #  (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null).
+      #  This will increase the speed of the request since these fields require some
+      #  calculations.
       # @param target_field_name [String] The name of the target field you want this remote field to map to.
       # @param target_field_description [String] The description of the target field you want this remote field to map to.
       # @param remote_field_traversal_path [Array<Object>] The field traversal path of the remote field listed when you hit the GET
@@ -341,7 +360,7 @@ module Merge
       #    common_model_name: "ExampleCommonModel"
       #  )
       def field_mappings_create(target_field_name:, target_field_description:, remote_field_traversal_path:,
-                                remote_method:, remote_url_path:, common_model_name:, request_options: nil)
+                                remote_method:, remote_url_path:, common_model_name:, exclude_remote_field_metadata: 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?
@@ -352,9 +371,10 @@ module Merge
           **@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
+            req.params = {
+              **(request_options&.additional_query_parameters || {}),
+              "exclude_remote_field_metadata": exclude_remote_field_metadata
+            }.compact
             req.body = {
               **(request_options&.additional_body_parameters || {}),
               target_field_name: target_field_name,

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

@@ -17,11 +17,11 @@ module Merge
         @request_client = request_client
       end
 
-      # Force re-sync of all models. This is available for all organizations via the
-      #  dashboard. Force re-sync is also available programmatically via API for monthly,
-      #  quarterly, and highest sync frequency customers on the Launch, Professional, or
-      #  Enterprise plans. Doing so will consume a sync credit for the relevant linked
-      #  account.
+      # Force re-sync of all models. This endpoint is available for monthly, quarterly,
+      #  and highest sync frequency customers on the Professional or Enterprise plans.
+      #  Doing so will consume a sync credit for the relevant linked account. Force
+      #  re-syncs can also be triggered manually in the Merge Dashboard and is available
+      #  for all customers.
       #
       # @param request_options [Merge::RequestOptions]
       # @return [Array<Merge::Accounting::SyncStatus>]
@@ -68,11 +68,11 @@ module Merge
         @request_client = request_client
       end
 
-      # Force re-sync of all models. This is available for all organizations via the
-      #  dashboard. Force re-sync is also available programmatically via API for monthly,
-      #  quarterly, and highest sync frequency customers on the Launch, Professional, or
-      #  Enterprise plans. Doing so will consume a sync credit for the relevant linked
-      #  account.
+      # Force re-sync of all models. This endpoint is available for monthly, quarterly,
+      #  and highest sync frequency customers on the Professional or Enterprise plans.
+      #  Doing so will consume a sync credit for the relevant linked account. Force
+      #  re-syncs can also be triggered manually in the Merge Dashboard and is available
+      #  for all customers.
       #
       # @param request_options [Merge::RequestOptions]
       # @return [Array<Merge::Accounting::SyncStatus>]

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

@@ -0,0 +1,259 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require "date"
+require_relative "types/general_ledger_transactions_list_request_expand"
+require_relative "../types/paginated_general_ledger_transaction_list"
+require_relative "types/general_ledger_transactions_retrieve_request_expand"
+require_relative "../types/general_ledger_transaction"
+require "async"
+
+module Merge
+  module Accounting
+    class GeneralLedgerTransactionsClient
+      # @return [Merge::RequestClient]
+      attr_reader :request_client
+
+      # @param request_client [Merge::RequestClient]
+      # @return [Merge::Accounting::GeneralLedgerTransactionsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # Returns a list of `GeneralLedgerTransaction` objects.
+      #
+      # @param company_id [String] If provided, will only return general ledger transactions for this company.
+      # @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 expand [Merge::Accounting::GeneralLedgerTransactions::GeneralLedgerTransactionsListRequestExpand] 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.
+      # @param page_size [Integer] Number of results to return per page.
+      # @param posted_date_after [DateTime] If provided, will only return objects posted after this datetime.
+      # @param posted_date_before [DateTime] If provided, will only return objects posted before this datetime.
+      # @param remote_id [String] The API provider's ID for the given object.
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Accounting::PaginatedGeneralLedgerTransactionList]
+      # @example
+      #  api = Merge::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Merge::Environment::PRODUCTION,
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.general_ledger_transactions.list
+      def list(company_id: nil, created_after: nil, created_before: nil, cursor: nil, expand: nil,
+               include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, posted_date_after: nil, posted_date_before: 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?
+          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 || {}),
+            "company_id": company_id,
+            "created_after": created_after,
+            "created_before": created_before,
+            "cursor": cursor,
+            "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,
+            "posted_date_after": posted_date_after,
+            "posted_date_before": posted_date_before,
+            "remote_id": remote_id
+          }.compact
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/general-ledger-transactions"
+        end
+        Merge::Accounting::PaginatedGeneralLedgerTransactionList.from_json(json_object: response.body)
+      end
+
+      # Returns a `GeneralLedgerTransaction` object with the given `id`.
+      #
+      # @param id [String]
+      # @param expand [Merge::Accounting::GeneralLedgerTransactions::GeneralLedgerTransactionsRetrieveRequestExpand] 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::Accounting::GeneralLedgerTransaction]
+      # @example
+      #  api = Merge::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Merge::Environment::PRODUCTION,
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.general_ledger_transactions.retrieve(id: "id")
+      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?
+          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 || {}),
+            "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
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/general-ledger-transactions/#{id}"
+        end
+        Merge::Accounting::GeneralLedgerTransaction.from_json(json_object: response.body)
+      end
+    end
+
+    class AsyncGeneralLedgerTransactionsClient
+      # @return [Merge::AsyncRequestClient]
+      attr_reader :request_client
+
+      # @param request_client [Merge::AsyncRequestClient]
+      # @return [Merge::Accounting::AsyncGeneralLedgerTransactionsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # Returns a list of `GeneralLedgerTransaction` objects.
+      #
+      # @param company_id [String] If provided, will only return general ledger transactions for this company.
+      # @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 expand [Merge::Accounting::GeneralLedgerTransactions::GeneralLedgerTransactionsListRequestExpand] 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.
+      # @param page_size [Integer] Number of results to return per page.
+      # @param posted_date_after [DateTime] If provided, will only return objects posted after this datetime.
+      # @param posted_date_before [DateTime] If provided, will only return objects posted before this datetime.
+      # @param remote_id [String] The API provider's ID for the given object.
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Accounting::PaginatedGeneralLedgerTransactionList]
+      # @example
+      #  api = Merge::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Merge::Environment::PRODUCTION,
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.general_ledger_transactions.list
+      def list(company_id: nil, created_after: nil, created_before: nil, cursor: nil, expand: nil,
+               include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, posted_date_after: nil, posted_date_before: 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?
+            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 || {}),
+              "company_id": company_id,
+              "created_after": created_after,
+              "created_before": created_before,
+              "cursor": cursor,
+              "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,
+              "posted_date_after": posted_date_after,
+              "posted_date_before": posted_date_before,
+              "remote_id": remote_id
+            }.compact
+            unless request_options.nil? || request_options&.additional_body_parameters.nil?
+              req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+            end
+            req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/general-ledger-transactions"
+          end
+          Merge::Accounting::PaginatedGeneralLedgerTransactionList.from_json(json_object: response.body)
+        end
+      end
+
+      # Returns a `GeneralLedgerTransaction` object with the given `id`.
+      #
+      # @param id [String]
+      # @param expand [Merge::Accounting::GeneralLedgerTransactions::GeneralLedgerTransactionsRetrieveRequestExpand] 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::Accounting::GeneralLedgerTransaction]
+      # @example
+      #  api = Merge::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Merge::Environment::PRODUCTION,
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.general_ledger_transactions.retrieve(id: "id")
+      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?
+            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 || {}),
+              "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
+            end
+            req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/general-ledger-transactions/#{id}"
+          end
+          Merge::Accounting::GeneralLedgerTransaction.from_json(json_object: response.body)
+        end
+      end
+    end
+  end
+end

data/lib/merge_ruby_client/accounting/general_ledger_transactions/types/general_ledger_transactions_list_request_expand.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Merge
+  module Accounting
+    class GeneralLedgerTransactions
+      class GeneralLedgerTransactionsListRequestExpand
+        ACCOUNTING_PERIOD = "accounting_period"
+        COMPANY = "company"
+        COMPANY_ACCOUNTING_PERIOD = "company,accounting_period"
+        GENERAL_LEDGER_TRANSACTION_LINES = "general_ledger_transaction_lines"
+        GENERAL_LEDGER_TRANSACTION_LINES_ACCOUNTING_PERIOD = "general_ledger_transaction_lines,accounting_period"
+        GENERAL_LEDGER_TRANSACTION_LINES_COMPANY = "general_ledger_transaction_lines,company"
+        GENERAL_LEDGER_TRANSACTION_LINES_COMPANY_ACCOUNTING_PERIOD = "general_ledger_transaction_lines,company,accounting_period"
+        TRACKING_CATEGORIES = "tracking_categories"
+        TRACKING_CATEGORIES_ACCOUNTING_PERIOD = "tracking_categories,accounting_period"
+        TRACKING_CATEGORIES_COMPANY = "tracking_categories,company"
+        TRACKING_CATEGORIES_COMPANY_ACCOUNTING_PERIOD = "tracking_categories,company,accounting_period"
+        TRACKING_CATEGORIES_GENERAL_LEDGER_TRANSACTION_LINES = "tracking_categories,general_ledger_transaction_lines"
+        TRACKING_CATEGORIES_GENERAL_LEDGER_TRANSACTION_LINES_ACCOUNTING_PERIOD = "tracking_categories,general_ledger_transaction_lines,accounting_period"
+        TRACKING_CATEGORIES_GENERAL_LEDGER_TRANSACTION_LINES_COMPANY = "tracking_categories,general_ledger_transaction_lines,company"
+        TRACKING_CATEGORIES_GENERAL_LEDGER_TRANSACTION_LINES_COMPANY_ACCOUNTING_PERIOD = "tracking_categories,general_ledger_transaction_lines,company,accounting_period"
+      end
+    end
+  end
+end

data/lib/merge_ruby_client/accounting/general_ledger_transactions/types/general_ledger_transactions_retrieve_request_expand.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Merge
+  module Accounting
+    class GeneralLedgerTransactions
+      class GeneralLedgerTransactionsRetrieveRequestExpand
+        ACCOUNTING_PERIOD = "accounting_period"
+        COMPANY = "company"
+        COMPANY_ACCOUNTING_PERIOD = "company,accounting_period"
+        GENERAL_LEDGER_TRANSACTION_LINES = "general_ledger_transaction_lines"
+        GENERAL_LEDGER_TRANSACTION_LINES_ACCOUNTING_PERIOD = "general_ledger_transaction_lines,accounting_period"
+        GENERAL_LEDGER_TRANSACTION_LINES_COMPANY = "general_ledger_transaction_lines,company"
+        GENERAL_LEDGER_TRANSACTION_LINES_COMPANY_ACCOUNTING_PERIOD = "general_ledger_transaction_lines,company,accounting_period"
+        TRACKING_CATEGORIES = "tracking_categories"
+        TRACKING_CATEGORIES_ACCOUNTING_PERIOD = "tracking_categories,accounting_period"
+        TRACKING_CATEGORIES_COMPANY = "tracking_categories,company"
+        TRACKING_CATEGORIES_COMPANY_ACCOUNTING_PERIOD = "tracking_categories,company,accounting_period"
+        TRACKING_CATEGORIES_GENERAL_LEDGER_TRANSACTION_LINES = "tracking_categories,general_ledger_transaction_lines"
+        TRACKING_CATEGORIES_GENERAL_LEDGER_TRANSACTION_LINES_ACCOUNTING_PERIOD = "tracking_categories,general_ledger_transaction_lines,accounting_period"
+        TRACKING_CATEGORIES_GENERAL_LEDGER_TRANSACTION_LINES_COMPANY = "tracking_categories,general_ledger_transaction_lines,company"
+        TRACKING_CATEGORIES_GENERAL_LEDGER_TRANSACTION_LINES_COMPANY_ACCOUNTING_PERIOD = "tracking_categories,general_ledger_transaction_lines,company,accounting_period"
+      end
+    end
+  end
+end

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

@@ -26,9 +26,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.
@@ -44,7 +49,7 @@ module Merge
       #  )
       #  api.accounting.income_statements.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, 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, 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?
@@ -63,6 +68,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,
@@ -83,6 +89,8 @@ module Merge
       #  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::Accounting::IncomeStatement]
       # @example
@@ -92,7 +100,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.accounting.income_statements.retrieve(id: "id")
-      def retrieve(id:, expand: nil, 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?
@@ -105,7 +113,8 @@ module Merge
           req.params = {
             **(request_options&.additional_query_parameters || {}),
             "expand": expand,
-            "include_remote_data": include_remote_data
+            "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
@@ -134,9 +143,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.
@@ -152,7 +166,7 @@ module Merge
       #  )
       #  api.accounting.income_statements.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, 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, 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?
@@ -172,6 +186,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,
@@ -193,6 +208,8 @@ module Merge
       #  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::Accounting::IncomeStatement]
       # @example
@@ -202,7 +219,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.accounting.income_statements.retrieve(id: "id")
-      def retrieve(id:, expand: nil, 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?
@@ -216,7 +233,8 @@ module Merge
             req.params = {
               **(request_options&.additional_query_parameters || {}),
               "expand": expand,
-              "include_remote_data": include_remote_data
+              "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