merge_ruby_client 0.1.4 → 1.1.0

data/lib/merge_ruby_client/crm/link_token/client.rb

@@ -3,6 +3,7 @@
 require_relative "../../../requests"
 require_relative "../types/categories_enum"
 require_relative "../types/common_model_scopes_body_request"
+require_relative "../types/language_enum"
 require_relative "../types/link_token"
 require "async"
 
@@ -48,7 +49,12 @@ module Merge
       # @param category_common_model_scopes [Hash{String => Array}] When creating a Link Token, you can set permissions for Common Models that will
       #  apply to the account that is going to be linked. Any model or field not
       #  specified in link token payload will default to existing settings.
-      # @param language [String] The language code for the language to localize Merge Link to.
+      # @param language [Merge::Crm::LanguageEnum] The following subset of IETF language tags can be used to configure
+      #  localization.
+      #  * `en` - en
+      #  * `de` - de
+      # @param are_syncs_disabled [Boolean] The boolean that indicates whether initial, periodic, and force syncs will be
+      #  disabled.
       # @param integration_specific_config [Hash{String => Object}] A JSON object containing integration-specific configuration options.
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Crm::LinkToken]
@@ -65,7 +71,7 @@ module Merge
       #    categories: [HRIS, ATS]
       #  )
       def create(end_user_email_address:, end_user_organization_name:, end_user_origin_id:, categories:,
-                 integration: nil, link_expiry_mins: nil, should_create_magic_link_url: nil, hide_admin_magic_link: nil, common_models: nil, category_common_model_scopes: nil, language: nil, integration_specific_config: nil, request_options: nil)
+                 integration: nil, link_expiry_mins: nil, should_create_magic_link_url: nil, hide_admin_magic_link: nil, common_models: nil, category_common_model_scopes: nil, language: nil, are_syncs_disabled: nil, integration_specific_config: 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?
@@ -91,6 +97,7 @@ module Merge
             common_models: common_models,
             category_common_model_scopes: category_common_model_scopes,
             language: language,
+            are_syncs_disabled: are_syncs_disabled,
             integration_specific_config: integration_specific_config
           }.compact
           req.url "#{@request_client.get_url(request_options: request_options)}/crm/v1/link-token"
@@ -139,7 +146,12 @@ module Merge
       # @param category_common_model_scopes [Hash{String => Array}] When creating a Link Token, you can set permissions for Common Models that will
       #  apply to the account that is going to be linked. Any model or field not
       #  specified in link token payload will default to existing settings.
-      # @param language [String] The language code for the language to localize Merge Link to.
+      # @param language [Merge::Crm::LanguageEnum] The following subset of IETF language tags can be used to configure
+      #  localization.
+      #  * `en` - en
+      #  * `de` - de
+      # @param are_syncs_disabled [Boolean] The boolean that indicates whether initial, periodic, and force syncs will be
+      #  disabled.
       # @param integration_specific_config [Hash{String => Object}] A JSON object containing integration-specific configuration options.
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Crm::LinkToken]
@@ -156,7 +168,7 @@ module Merge
       #    categories: [HRIS, ATS]
       #  )
       def create(end_user_email_address:, end_user_organization_name:, end_user_origin_id:, categories:,
-                 integration: nil, link_expiry_mins: nil, should_create_magic_link_url: nil, hide_admin_magic_link: nil, common_models: nil, category_common_model_scopes: nil, language: nil, integration_specific_config: nil, request_options: nil)
+                 integration: nil, link_expiry_mins: nil, should_create_magic_link_url: nil, hide_admin_magic_link: nil, common_models: nil, category_common_model_scopes: nil, language: nil, are_syncs_disabled: nil, integration_specific_config: 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?
@@ -183,6 +195,7 @@ module Merge
               common_models: common_models,
               category_common_model_scopes: category_common_model_scopes,
               language: language,
+              are_syncs_disabled: are_syncs_disabled,
               integration_specific_config: integration_specific_config
             }.compact
             req.url "#{@request_client.get_url(request_options: request_options)}/crm/v1/link-token"

data/lib/merge_ruby_client/crm/linked_accounts/client.rb

@@ -20,13 +20,13 @@ module Merge
       # List linked accounts for your organization.
       #
       # @param category [Merge::Crm::LinkedAccounts::LinkedAccountsListRequestCategory] Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-      #  - `hris` - hris
-      #  - `ats` - ats
-      #  - `accounting` - accounting
-      #  - `ticketing` - ticketing
-      #  - `crm` - crm
-      #  - `mktg` - mktg
-      #  - `filestorage` - filestorage
+      #  * `hris` - hris
+      #  * `ats` - ats
+      #  * `accounting` - accounting
+      #  * `ticketing` - ticketing
+      #  * `crm` - crm
+      #  * `mktg` - mktg
+      #  * `filestorage` - filestorage
       # @param cursor [String] The pagination cursor value.
       # @param end_user_email_address [String] If provided, will only return linked accounts associated with the given email
       #  address.
@@ -47,7 +47,7 @@ module Merge
       # @param is_test_account [String] If included, will only include test linked accounts. If not included, will only
       #  include non-test linked accounts.
       # @param page_size [Integer] Number of results to return per page.
-      # @param status [String] Filter by status. Options: `COMPLETE`, `INCOMPLETE`, `RELINK_NEEDED`
+      # @param status [String] Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Crm::PaginatedAccountDetailsAndActionsList]
       # @example
@@ -106,13 +106,13 @@ module Merge
       # List linked accounts for your organization.
       #
       # @param category [Merge::Crm::LinkedAccounts::LinkedAccountsListRequestCategory] Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-      #  - `hris` - hris
-      #  - `ats` - ats
-      #  - `accounting` - accounting
-      #  - `ticketing` - ticketing
-      #  - `crm` - crm
-      #  - `mktg` - mktg
-      #  - `filestorage` - filestorage
+      #  * `hris` - hris
+      #  * `ats` - ats
+      #  * `accounting` - accounting
+      #  * `ticketing` - ticketing
+      #  * `crm` - crm
+      #  * `mktg` - mktg
+      #  * `filestorage` - filestorage
       # @param cursor [String] The pagination cursor value.
       # @param end_user_email_address [String] If provided, will only return linked accounts associated with the given email
       #  address.
@@ -133,7 +133,7 @@ module Merge
       # @param is_test_account [String] If included, will only include test linked accounts. If not included, will only
       #  include non-test linked accounts.
       # @param page_size [Integer] Number of results to return per page.
-      # @param status [String] Filter by status. Options: `COMPLETE`, `INCOMPLETE`, `RELINK_NEEDED`
+      # @param status [String] Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Crm::PaginatedAccountDetailsAndActionsList]
       # @example

data/lib/merge_ruby_client/crm/notes/client.rb

@@ -33,11 +33,16 @@ module Merge
       # @param cursor [String] The pagination cursor value.
       # @param expand [Merge::Crm::Notes::NotesListRequestExpand] 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 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.crm.notes.list
       def list(account_id: nil, contact_id: nil, created_after: nil, created_before: nil, cursor: nil, expand: nil,
-               include_deleted_data: nil, include_remote_data: nil, include_remote_fields: nil, modified_after: nil, modified_before: nil, opportunity_id: nil, owner_id: nil, page_size: nil, remote_id: nil, request_options: nil)
+               include_deleted_data: nil, include_remote_data: nil, include_remote_fields: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, opportunity_id: nil, owner_id: 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?
@@ -76,6 +81,7 @@ module Merge
             "include_deleted_data": include_deleted_data,
             "include_remote_data": include_remote_data,
             "include_remote_fields": include_remote_fields,
+            "include_shell_data": include_shell_data,
             "modified_after": modified_after,
             "modified_before": modified_before,
             "opportunity_id": opportunity_id,
@@ -143,6 +149,8 @@ module Merge
       #  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 request_options [Merge::RequestOptions]
       # @return [Merge::Crm::Note]
       # @example
@@ -152,7 +160,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.crm.notes.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, include_remote_fields: nil, request_options: nil)
+      def retrieve(id:, expand: nil, include_remote_data: nil, include_remote_fields: 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?
@@ -166,7 +175,8 @@ module Merge
             **(request_options&.additional_query_parameters || {}),
             "expand": expand,
             "include_remote_data": include_remote_data,
-            "include_remote_fields": include_remote_fields
+            "include_remote_fields": include_remote_fields,
+            "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
@@ -211,11 +221,16 @@ module Merge
       # Returns a list of `RemoteFieldClass` objects.
       #
       # @param cursor [String] The pagination cursor value.
-      # @param include_deleted_data [Boolean] Whether to include data that was marked as deleted by third party webhooks.
+      # @param include_deleted_data [Boolean] Indicates whether or not this object has been deleted in the third party
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
       # @param include_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 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.
@@ -229,7 +244,7 @@ module Merge
       #  )
       #  api.crm.notes.remote_field_classes_list
       def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
-                                    include_remote_fields: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
+                                    include_remote_fields: 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?
@@ -245,6 +260,7 @@ module Merge
             "include_deleted_data": include_deleted_data,
             "include_remote_data": include_remote_data,
             "include_remote_fields": include_remote_fields,
+            "include_shell_data": include_shell_data,
             "is_common_model_field": is_common_model_field,
             "page_size": page_size
           }.compact
@@ -276,11 +292,16 @@ module Merge
       # @param cursor [String] The pagination cursor value.
       # @param expand [Merge::Crm::Notes::NotesListRequestExpand] 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 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.
@@ -298,7 +319,7 @@ module Merge
       #  )
       #  api.crm.notes.list
       def list(account_id: nil, contact_id: nil, created_after: nil, created_before: nil, cursor: nil, expand: nil,
-               include_deleted_data: nil, include_remote_data: nil, include_remote_fields: nil, modified_after: nil, modified_before: nil, opportunity_id: nil, owner_id: nil, page_size: nil, remote_id: nil, request_options: nil)
+               include_deleted_data: nil, include_remote_data: nil, include_remote_fields: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, opportunity_id: nil, owner_id: 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?
@@ -320,6 +341,7 @@ module Merge
               "include_deleted_data": include_deleted_data,
               "include_remote_data": include_remote_data,
               "include_remote_fields": include_remote_fields,
+              "include_shell_data": include_shell_data,
               "modified_after": modified_after,
               "modified_before": modified_before,
               "opportunity_id": opportunity_id,
@@ -390,6 +412,8 @@ module Merge
       #  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 request_options [Merge::RequestOptions]
       # @return [Merge::Crm::Note]
       # @example
@@ -399,7 +423,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.crm.notes.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, include_remote_fields: nil, request_options: nil)
+      def retrieve(id:, expand: nil, include_remote_data: nil, include_remote_fields: 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?
@@ -414,7 +439,8 @@ module Merge
               **(request_options&.additional_query_parameters || {}),
               "expand": expand,
               "include_remote_data": include_remote_data,
-              "include_remote_fields": include_remote_fields
+              "include_remote_fields": include_remote_fields,
+              "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
@@ -462,11 +488,16 @@ module Merge
       # Returns a list of `RemoteFieldClass` objects.
       #
       # @param cursor [String] The pagination cursor value.
-      # @param include_deleted_data [Boolean] Whether to include data that was marked as deleted by third party webhooks.
+      # @param include_deleted_data [Boolean] Indicates whether or not this object has been deleted in the third party
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
       # @param include_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 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.
@@ -480,7 +511,7 @@ module Merge
       #  )
       #  api.crm.notes.remote_field_classes_list
       def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
-                                    include_remote_fields: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
+                                    include_remote_fields: 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?
@@ -497,6 +528,7 @@ module Merge
               "include_deleted_data": include_deleted_data,
               "include_remote_data": include_remote_data,
               "include_remote_fields": include_remote_fields,
+              "include_shell_data": include_shell_data,
               "is_common_model_field": is_common_model_field,
               "page_size": page_size
             }.compact

data/lib/merge_ruby_client/crm/opportunities/client.rb

@@ -34,11 +34,16 @@ module Merge
       # @param cursor [String] The pagination cursor value.
       # @param expand [Merge::Crm::Opportunities::OpportunitiesListRequestExpand] 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 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.
@@ -54,9 +59,9 @@ module Merge
       # @param stage_id [String] If provided, will only return opportunities with this stage.
       # @param status [Merge::Crm::Opportunities::OpportunitiesListRequestStatus] If provided, will only return opportunities with this status. Options: ('OPEN',
       #  'WON', 'LOST')
-      #  - `OPEN` - OPEN
-      #  - `WON` - WON
-      #  - `LOST` - LOST
+      #  * `OPEN` - OPEN
+      #  * `WON` - WON
+      #  * `LOST` - LOST
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Crm::PaginatedOpportunityList]
       # @example
@@ -67,7 +72,7 @@ module Merge
       #  )
       #  api.crm.opportunities.list
       def list(account_id: nil, created_after: nil, created_before: nil, cursor: nil, expand: nil,
-               include_deleted_data: nil, include_remote_data: nil, include_remote_fields: nil, modified_after: nil, modified_before: nil, owner_id: nil, page_size: nil, remote_created_after: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, stage_id: nil, status: nil, request_options: nil)
+               include_deleted_data: nil, include_remote_data: nil, include_remote_fields: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, owner_id: nil, page_size: nil, remote_created_after: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, stage_id: nil, status: 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?
@@ -87,6 +92,7 @@ module Merge
             "include_deleted_data": include_deleted_data,
             "include_remote_data": include_remote_data,
             "include_remote_fields": include_remote_fields,
+            "include_shell_data": include_shell_data,
             "modified_after": modified_after,
             "modified_before": modified_before,
             "owner_id": owner_id,
@@ -162,6 +168,8 @@ module Merge
       #  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 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
@@ -175,8 +183,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.crm.opportunities.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, include_remote_fields: nil, remote_fields: nil,
-                   show_enum_origins: nil, request_options: nil)
+      def retrieve(id:, expand: nil, include_remote_data: nil, include_remote_fields: nil, include_shell_data: 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?
@@ -191,6 +199,7 @@ module Merge
             "expand": expand,
             "include_remote_data": include_remote_data,
             "include_remote_fields": include_remote_fields,
+            "include_shell_data": include_shell_data,
             "remote_fields": remote_fields,
             "show_enum_origins": show_enum_origins
           }.compact
@@ -318,11 +327,16 @@ module Merge
       # Returns a list of `RemoteFieldClass` objects.
       #
       # @param cursor [String] The pagination cursor value.
-      # @param include_deleted_data [Boolean] Whether to include data that was marked as deleted by third party webhooks.
+      # @param include_deleted_data [Boolean] Indicates whether or not this object has been deleted in the third party
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
       # @param include_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 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.
@@ -336,7 +350,7 @@ module Merge
       #  )
       #  api.crm.opportunities.remote_field_classes_list
       def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
-                                    include_remote_fields: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
+                                    include_remote_fields: 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?
@@ -352,6 +366,7 @@ module Merge
             "include_deleted_data": include_deleted_data,
             "include_remote_data": include_remote_data,
             "include_remote_fields": include_remote_fields,
+            "include_shell_data": include_shell_data,
             "is_common_model_field": is_common_model_field,
             "page_size": page_size
           }.compact
@@ -382,11 +397,16 @@ module Merge
       # @param cursor [String] The pagination cursor value.
       # @param expand [Merge::Crm::Opportunities::OpportunitiesListRequestExpand] 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 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.
@@ -402,9 +422,9 @@ module Merge
       # @param stage_id [String] If provided, will only return opportunities with this stage.
       # @param status [Merge::Crm::Opportunities::OpportunitiesListRequestStatus] If provided, will only return opportunities with this status. Options: ('OPEN',
       #  'WON', 'LOST')
-      #  - `OPEN` - OPEN
-      #  - `WON` - WON
-      #  - `LOST` - LOST
+      #  * `OPEN` - OPEN
+      #  * `WON` - WON
+      #  * `LOST` - LOST
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Crm::PaginatedOpportunityList]
       # @example
@@ -415,7 +435,7 @@ module Merge
       #  )
       #  api.crm.opportunities.list
       def list(account_id: nil, created_after: nil, created_before: nil, cursor: nil, expand: nil,
-               include_deleted_data: nil, include_remote_data: nil, include_remote_fields: nil, modified_after: nil, modified_before: nil, owner_id: nil, page_size: nil, remote_created_after: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, stage_id: nil, status: nil, request_options: nil)
+               include_deleted_data: nil, include_remote_data: nil, include_remote_fields: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, owner_id: nil, page_size: nil, remote_created_after: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, stage_id: nil, status: 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?
@@ -436,6 +456,7 @@ module Merge
               "include_deleted_data": include_deleted_data,
               "include_remote_data": include_remote_data,
               "include_remote_fields": include_remote_fields,
+              "include_shell_data": include_shell_data,
               "modified_after": modified_after,
               "modified_before": modified_before,
               "owner_id": owner_id,
@@ -514,6 +535,8 @@ module Merge
       #  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 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
@@ -527,8 +550,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.crm.opportunities.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, include_remote_fields: nil, remote_fields: nil,
-                   show_enum_origins: nil, request_options: nil)
+      def retrieve(id:, expand: nil, include_remote_data: nil, include_remote_fields: nil, include_shell_data: 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?
@@ -544,6 +567,7 @@ module Merge
               "expand": expand,
               "include_remote_data": include_remote_data,
               "include_remote_fields": include_remote_fields,
+              "include_shell_data": include_shell_data,
               "remote_fields": remote_fields,
               "show_enum_origins": show_enum_origins
             }.compact
@@ -678,11 +702,16 @@ module Merge
       # Returns a list of `RemoteFieldClass` objects.
       #
       # @param cursor [String] The pagination cursor value.
-      # @param include_deleted_data [Boolean] Whether to include data that was marked as deleted by third party webhooks.
+      # @param include_deleted_data [Boolean] Indicates whether or not this object has been deleted in the third party
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
       # @param include_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 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.
@@ -696,7 +725,7 @@ module Merge
       #  )
       #  api.crm.opportunities.remote_field_classes_list
       def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
-                                    include_remote_fields: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
+                                    include_remote_fields: 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?
@@ -713,6 +742,7 @@ module Merge
               "include_deleted_data": include_deleted_data,
               "include_remote_data": include_remote_data,
               "include_remote_fields": include_remote_fields,
+              "include_shell_data": include_shell_data,
               "is_common_model_field": is_common_model_field,
               "page_size": page_size
             }.compact

data/lib/merge_ruby_client/crm/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::Crm::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::Crm::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::Crm::IndividualCommonModelScopeDeserializerRequest>, as a Hash
       #   * :model_name (String)
       #   * :model_permissions (Hash{String => Merge::Crm::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::Crm::CommonModelScopeApi]
       # @example
@@ -103,7 +103,7 @@ module Merge
       #    environment: Merge::Environment::PRODUCTION,
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
-      #  api.crm.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.crm.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::Crm::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::Crm::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::Crm::IndividualCommonModelScopeDeserializerRequest>, as a Hash
       #   * :model_name (String)
       #   * :model_permissions (Hash{String => Merge::Crm::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::Crm::CommonModelScopeApi]
       # @example
@@ -224,7 +224,7 @@ module Merge
       #    environment: Merge::Environment::PRODUCTION,
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
-      #  api.crm.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.crm.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|