merge_ruby_client 0.1.4 → 1.0.0

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

@@ -8,6 +8,7 @@ require_relative "../types/purchase_order_request"
 require_relative "../types/purchase_order_response"
 require_relative "types/purchase_orders_retrieve_request_expand"
 require_relative "../types/purchase_order"
+require_relative "../types/paginated_remote_field_class_list"
 require_relative "../types/meta_response"
 require "async"
 
@@ -31,9 +32,16 @@ module Merge
       # @param cursor [String] The pagination cursor value.
       # @param expand [Merge::Accounting::PurchaseOrders::PurchaseOrdersListRequestExpand] 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_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
+      #  common models, in a normalized format.
+      # @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 issue_date_after [DateTime] If provided, will only return objects created after this datetime.
       # @param issue_date_before [DateTime] If provided, will only return objects created before this datetime.
       # @param modified_after [DateTime] If provided, only objects synced by Merge after this date time will be returned.
@@ -55,7 +63,7 @@ module Merge
       #  )
       #  api.accounting.purchase_orders.list
       def list(company_id: nil, created_after: nil, created_before: nil, cursor: nil, expand: nil,
-               include_deleted_data: nil, include_remote_data: nil, issue_date_after: nil, issue_date_before: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, request_options: nil)
+               include_deleted_data: nil, include_remote_data: nil, include_remote_fields: nil, include_shell_data: nil, issue_date_after: nil, issue_date_before: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, request_options: nil)
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -74,6 +82,8 @@ module Merge
             "expand": expand,
             "include_deleted_data": include_deleted_data,
             "include_remote_data": include_remote_data,
+            "include_remote_fields": include_remote_fields,
+            "include_shell_data": include_shell_data,
             "issue_date_after": issue_date_after,
             "issue_date_before": issue_date_before,
             "modified_after": modified_after,
@@ -105,12 +115,14 @@ module Merge
       #   * :memo (String)
       #   * :company (Hash)
       #   * :total_amount (Float)
-      #   * :currency (Merge::Accounting::CurrencyEnum)
+      #   * :currency (Merge::Accounting::TransactionCurrencyEnum)
+      #   * :inclusive_of_tax (Boolean)
       #   * :exchange_rate (String)
       #   * :tracking_categories (Array<Merge::Accounting::PurchaseOrderRequestTrackingCategoriesItem>)
       #   * :line_items (Array<Merge::Accounting::PurchaseOrderLineItemRequest>)
       #   * :integration_params (Hash{String => Object})
       #   * :linked_account_params (Hash{String => Object})
+      #   * :remote_fields (Array<Merge::Accounting::RemoteFieldRequest>)
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Accounting::PurchaseOrderResponse]
       # @example
@@ -148,6 +160,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_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
+      #  common models, in a normalized format.
       # @param remote_fields [String] Deprecated. Use show_enum_origins.
       # @param show_enum_origins [String] A comma separated list of enum field names for which you'd like the original
       #  values to be returned, instead of Merge's normalized enum values. [Learn
@@ -161,8 +175,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.accounting.purchase_orders.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, remote_fields: nil, show_enum_origins: nil,
-                   request_options: nil)
+      def retrieve(id:, expand: nil, include_remote_data: nil, include_remote_fields: nil, remote_fields: nil,
+                   show_enum_origins: nil, request_options: nil)
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -176,6 +190,7 @@ module Merge
             **(request_options&.additional_query_parameters || {}),
             "expand": expand,
             "include_remote_data": include_remote_data,
+            "include_remote_fields": include_remote_fields,
             "remote_fields": remote_fields,
             "show_enum_origins": show_enum_origins
           }.compact
@@ -187,6 +202,57 @@ module Merge
         Merge::Accounting::PurchaseOrder.from_json(json_object: response.body)
       end
 
+      # Returns a list of `RemoteFieldClass` objects.
+      #
+      # @param cursor [String] The pagination cursor value.
+      # @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 is_common_model_field [Boolean] If provided, will only return remote field classes with this
+      #  is_common_model_field value
+      # @param page_size [Integer] Number of results to return per page.
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Accounting::PaginatedRemoteFieldClassList]
+      # @example
+      #  api = Merge::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Merge::Environment::PRODUCTION,
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.purchase_orders.line_items_remote_field_classes_list
+      def line_items_remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
+                                               include_shell_data: nil, is_common_model_field: nil, page_size: 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 || {}),
+            "cursor": cursor,
+            "include_deleted_data": include_deleted_data,
+            "include_remote_data": include_remote_data,
+            "include_shell_data": include_shell_data,
+            "is_common_model_field": is_common_model_field,
+            "page_size": page_size
+          }.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/purchase-orders/line-items/remote-field-classes"
+        end
+        Merge::Accounting::PaginatedRemoteFieldClassList.from_json(json_object: response.body)
+      end
+
       # Returns metadata for `PurchaseOrder` POSTs.
       #
       # @param request_options [Merge::RequestOptions]
@@ -218,6 +284,57 @@ module Merge
         end
         Merge::Accounting::MetaResponse.from_json(json_object: response.body)
       end
+
+      # Returns a list of `RemoteFieldClass` objects.
+      #
+      # @param cursor [String] The pagination cursor value.
+      # @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 is_common_model_field [Boolean] If provided, will only return remote field classes with this
+      #  is_common_model_field value
+      # @param page_size [Integer] Number of results to return per page.
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Accounting::PaginatedRemoteFieldClassList]
+      # @example
+      #  api = Merge::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Merge::Environment::PRODUCTION,
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.purchase_orders.remote_field_classes_list
+      def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
+                                    include_shell_data: nil, is_common_model_field: nil, page_size: 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 || {}),
+            "cursor": cursor,
+            "include_deleted_data": include_deleted_data,
+            "include_remote_data": include_remote_data,
+            "include_shell_data": include_shell_data,
+            "is_common_model_field": is_common_model_field,
+            "page_size": page_size
+          }.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/purchase-orders/remote-field-classes"
+        end
+        Merge::Accounting::PaginatedRemoteFieldClassList.from_json(json_object: response.body)
+      end
     end
 
     class AsyncPurchaseOrdersClient
@@ -238,9 +355,16 @@ module Merge
       # @param cursor [String] The pagination cursor value.
       # @param expand [Merge::Accounting::PurchaseOrders::PurchaseOrdersListRequestExpand] 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_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
+      #  common models, in a normalized format.
+      # @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 issue_date_after [DateTime] If provided, will only return objects created after this datetime.
       # @param issue_date_before [DateTime] If provided, will only return objects created before this datetime.
       # @param modified_after [DateTime] If provided, only objects synced by Merge after this date time will be returned.
@@ -262,7 +386,7 @@ module Merge
       #  )
       #  api.accounting.purchase_orders.list
       def list(company_id: nil, created_after: nil, created_before: nil, cursor: nil, expand: nil,
-               include_deleted_data: nil, include_remote_data: nil, issue_date_after: nil, issue_date_before: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, request_options: nil)
+               include_deleted_data: nil, include_remote_data: nil, include_remote_fields: nil, include_shell_data: nil, issue_date_after: nil, issue_date_before: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_fields: nil, remote_id: nil, show_enum_origins: 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?
@@ -282,6 +406,8 @@ module Merge
               "expand": expand,
               "include_deleted_data": include_deleted_data,
               "include_remote_data": include_remote_data,
+              "include_remote_fields": include_remote_fields,
+              "include_shell_data": include_shell_data,
               "issue_date_after": issue_date_after,
               "issue_date_before": issue_date_before,
               "modified_after": modified_after,
@@ -314,12 +440,14 @@ module Merge
       #   * :memo (String)
       #   * :company (Hash)
       #   * :total_amount (Float)
-      #   * :currency (Merge::Accounting::CurrencyEnum)
+      #   * :currency (Merge::Accounting::TransactionCurrencyEnum)
+      #   * :inclusive_of_tax (Boolean)
       #   * :exchange_rate (String)
       #   * :tracking_categories (Array<Merge::Accounting::PurchaseOrderRequestTrackingCategoriesItem>)
       #   * :line_items (Array<Merge::Accounting::PurchaseOrderLineItemRequest>)
       #   * :integration_params (Hash{String => Object})
       #   * :linked_account_params (Hash{String => Object})
+      #   * :remote_fields (Array<Merge::Accounting::RemoteFieldRequest>)
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Accounting::PurchaseOrderResponse]
       # @example
@@ -359,6 +487,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_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
+      #  common models, in a normalized format.
       # @param remote_fields [String] Deprecated. Use show_enum_origins.
       # @param show_enum_origins [String] A comma separated list of enum field names for which you'd like the original
       #  values to be returned, instead of Merge's normalized enum values. [Learn
@@ -372,8 +502,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.accounting.purchase_orders.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, remote_fields: nil, show_enum_origins: nil,
-                   request_options: nil)
+      def retrieve(id:, expand: nil, include_remote_data: nil, include_remote_fields: nil, remote_fields: nil,
+                   show_enum_origins: 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?
@@ -388,6 +518,7 @@ module Merge
               **(request_options&.additional_query_parameters || {}),
               "expand": expand,
               "include_remote_data": include_remote_data,
+              "include_remote_fields": include_remote_fields,
               "remote_fields": remote_fields,
               "show_enum_origins": show_enum_origins
             }.compact
@@ -400,6 +531,59 @@ module Merge
         end
       end
 
+      # Returns a list of `RemoteFieldClass` objects.
+      #
+      # @param cursor [String] The pagination cursor value.
+      # @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 is_common_model_field [Boolean] If provided, will only return remote field classes with this
+      #  is_common_model_field value
+      # @param page_size [Integer] Number of results to return per page.
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Accounting::PaginatedRemoteFieldClassList]
+      # @example
+      #  api = Merge::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Merge::Environment::PRODUCTION,
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.purchase_orders.line_items_remote_field_classes_list
+      def line_items_remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
+                                               include_shell_data: nil, is_common_model_field: nil, page_size: 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 || {}),
+              "cursor": cursor,
+              "include_deleted_data": include_deleted_data,
+              "include_remote_data": include_remote_data,
+              "include_shell_data": include_shell_data,
+              "is_common_model_field": is_common_model_field,
+              "page_size": page_size
+            }.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/purchase-orders/line-items/remote-field-classes"
+          end
+          Merge::Accounting::PaginatedRemoteFieldClassList.from_json(json_object: response.body)
+        end
+      end
+
       # Returns metadata for `PurchaseOrder` POSTs.
       #
       # @param request_options [Merge::RequestOptions]
@@ -433,6 +617,59 @@ module Merge
           Merge::Accounting::MetaResponse.from_json(json_object: response.body)
         end
       end
+
+      # Returns a list of `RemoteFieldClass` objects.
+      #
+      # @param cursor [String] The pagination cursor value.
+      # @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 is_common_model_field [Boolean] If provided, will only return remote field classes with this
+      #  is_common_model_field value
+      # @param page_size [Integer] Number of results to return per page.
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Accounting::PaginatedRemoteFieldClassList]
+      # @example
+      #  api = Merge::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Merge::Environment::PRODUCTION,
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.purchase_orders.remote_field_classes_list
+      def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
+                                    include_shell_data: nil, is_common_model_field: nil, page_size: 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 || {}),
+              "cursor": cursor,
+              "include_deleted_data": include_deleted_data,
+              "include_remote_data": include_remote_data,
+              "include_shell_data": include_shell_data,
+              "is_common_model_field": is_common_model_field,
+              "page_size": page_size
+            }.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/purchase-orders/remote-field-classes"
+          end
+          Merge::Accounting::PaginatedRemoteFieldClassList.from_json(json_object: response.body)
+        end
+      end
     end
   end
 end

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

@@ -19,7 +19,7 @@ module Merge
 
       # Get the default permissions for Merge Common Models and fields across all Linked
       #  Accounts of a given category. [Learn
-      #  more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
+      #  more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
       #
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Accounting::CommonModelScopeApi]
@@ -53,7 +53,7 @@ module Merge
 
       # Get all available permissions for Merge Common Models and fields for a single
       #  Linked Account. [Learn
-      #  more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
+      #  more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
       #
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Accounting::CommonModelScopeApi]
@@ -87,14 +87,14 @@ module Merge
 
       # Update permissions for any Common Model or field for a single Linked Account.
       #  Any Scopes not set in this POST request will inherit the default Scopes. [Learn
-      #  more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes)
+      #  more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
       #
       # @param common_models [Array<Hash>] The common models you want to update the scopes forRequest of type Array<Merge::Accounting::IndividualCommonModelScopeDeserializerRequest>, as a Hash
       #   * :model_name (String)
       #   * :model_permissions (Hash{String => Merge::Accounting::ModelPermissionDeserializerRequest})
       #   * :field_permissions (Hash)
-      #     * :enabled (Array<Object>)
-      #     * :disabled (Array<Object>)
+      #     * :enabled_fields (Array<Object>)
+      #     * :disabled_fields (Array<Object>)
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Accounting::CommonModelScopeApi]
       # @example
@@ -103,7 +103,7 @@ module Merge
       #    environment: Merge::Environment::PRODUCTION,
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
-      #  api.accounting.scopes.linked_account_scopes_create(common_models: [{ model_name: "Employee", model_permissions: { "READ": { is_enabled: true }, "WRITE": { is_enabled: false } } }, { model_name: "Benefit", model_permissions: { "WRITE": { is_enabled: false } } }])
+      #  api.accounting.scopes.linked_account_scopes_create(common_models: [{ model_name: "Employee", model_permissions: { "READ": { is_enabled: true }, "WRITE": { is_enabled: false } }, field_permissions: { enabled_fields: ["avatar", "home_location"], disabled_fields: ["work_location"] } }, { model_name: "Benefit", model_permissions: { "WRITE": { is_enabled: false } } }])
       def linked_account_scopes_create(common_models:, 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?
@@ -136,7 +136,7 @@ module Merge
 
       # Get the default permissions for Merge Common Models and fields across all Linked
       #  Accounts of a given category. [Learn
-      #  more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
+      #  more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
       #
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Accounting::CommonModelScopeApi]
@@ -172,7 +172,7 @@ module Merge
 
       # Get all available permissions for Merge Common Models and fields for a single
       #  Linked Account. [Learn
-      #  more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
+      #  more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
       #
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Accounting::CommonModelScopeApi]
@@ -208,14 +208,14 @@ module Merge
 
       # Update permissions for any Common Model or field for a single Linked Account.
       #  Any Scopes not set in this POST request will inherit the default Scopes. [Learn
-      #  more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes)
+      #  more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
       #
       # @param common_models [Array<Hash>] The common models you want to update the scopes forRequest of type Array<Merge::Accounting::IndividualCommonModelScopeDeserializerRequest>, as a Hash
       #   * :model_name (String)
       #   * :model_permissions (Hash{String => Merge::Accounting::ModelPermissionDeserializerRequest})
       #   * :field_permissions (Hash)
-      #     * :enabled (Array<Object>)
-      #     * :disabled (Array<Object>)
+      #     * :enabled_fields (Array<Object>)
+      #     * :disabled_fields (Array<Object>)
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Accounting::CommonModelScopeApi]
       # @example
@@ -224,7 +224,7 @@ module Merge
       #    environment: Merge::Environment::PRODUCTION,
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
-      #  api.accounting.scopes.linked_account_scopes_create(common_models: [{ model_name: "Employee", model_permissions: { "READ": { is_enabled: true }, "WRITE": { is_enabled: false } } }, { model_name: "Benefit", model_permissions: { "WRITE": { is_enabled: false } } }])
+      #  api.accounting.scopes.linked_account_scopes_create(common_models: [{ model_name: "Employee", model_permissions: { "READ": { is_enabled: true }, "WRITE": { is_enabled: false } }, field_permissions: { enabled_fields: ["avatar", "home_location"], disabled_fields: ["work_location"] } }, { model_name: "Benefit", model_permissions: { "WRITE": { is_enabled: false } } }])
       def linked_account_scopes_create(common_models:, request_options: nil)
         Async do
           response = @request_client.conn.post do |req|

data/lib/merge_ruby_client/accounting/tax_rates/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.tax_rates.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,
@@ -134,9 +140,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 +163,7 @@ module Merge
       #  )
       #  api.accounting.tax_rates.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 +183,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,

data/lib/merge_ruby_client/accounting/tracking_categories/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.
@@ -48,7 +53,7 @@ module Merge
       #  )
       #  api.accounting.tracking_categories.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_fields: nil, remote_id: nil, show_enum_origins: 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_fields: nil, remote_id: nil, show_enum_origins: nil, request_options: nil)
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -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,
@@ -147,9 +153,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.
@@ -169,7 +180,7 @@ module Merge
       #  )
       #  api.accounting.tracking_categories.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_fields: nil, remote_id: nil, show_enum_origins: 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_fields: nil, remote_id: nil, show_enum_origins: 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?
@@ -189,6 +200,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,