RubyGems - merge_ruby_client - Versions diffs - 1.0.0 → 2.0.0 - Mend

merge_ruby_client 1.0.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (519) hide show

data/lib/merge_ruby_client/crm/accounts/client.rb CHANGED Viewed

@@ -147,6 +147,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::Account]
       # @example
@@ -156,7 +158,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.crm.accounts.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?
@@ -170,7 +173,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
@@ -307,6 +311,7 @@ module Merge
       #  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 is_custom [Boolean] If provided, will only return remote fields classes with this is_custom value
       # @param page_size [Integer] Number of results to return per page.
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Crm::PaginatedRemoteFieldClassList]
@@ -318,7 +323,7 @@ module Merge
       #  )
       #  api.crm.accounts.remote_field_classes_list
       def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
-                                    include_remote_fields: nil, include_shell_data: 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, is_custom: 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?
@@ -336,6 +341,7 @@ module Merge
             "include_remote_fields": include_remote_fields,
             "include_shell_data": include_shell_data,
             "is_common_model_field": is_common_model_field,
+            "is_custom": is_custom,
             "page_size": page_size
           }.compact
           unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -485,6 +491,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::Account]
       # @example
@@ -494,7 +502,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.crm.accounts.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?
@@ -509,7 +518,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
@@ -653,6 +663,7 @@ module Merge
       #  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 is_custom [Boolean] If provided, will only return remote fields classes with this is_custom value
       # @param page_size [Integer] Number of results to return per page.
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Crm::PaginatedRemoteFieldClassList]
@@ -664,7 +675,7 @@ module Merge
       #  )
       #  api.crm.accounts.remote_field_classes_list
       def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
-                                    include_remote_fields: nil, include_shell_data: 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, is_custom: 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?
@@ -683,6 +694,7 @@ module Merge
               "include_remote_fields": include_remote_fields,
               "include_shell_data": include_shell_data,
               "is_common_model_field": is_common_model_field,
+              "is_custom": is_custom,
               "page_size": page_size
             }.compact
             unless request_options.nil? || request_options&.additional_body_parameters.nil?

data/lib/merge_ruby_client/crm/association_types/client.rb CHANGED Viewed

@@ -137,6 +137,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::Crm::AssociationType]
       # @example
@@ -147,7 +149,7 @@ module Merge
       #  )
       #  api.crm.association_types.custom_object_classes_association_types_retrieve(custom_object_class_id: "custom_object_class_id", id: "id")
       def custom_object_classes_association_types_retrieve(custom_object_class_id:, id:, expand: nil,
-                                                           include_remote_data: nil, request_options: 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?
@@ -160,7 +162,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
@@ -334,6 +337,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::Crm::AssociationType]
       # @example
@@ -344,7 +349,7 @@ module Merge
       #  )
       #  api.crm.association_types.custom_object_classes_association_types_retrieve(custom_object_class_id: "custom_object_class_id", id: "id")
       def custom_object_classes_association_types_retrieve(custom_object_class_id:, id:, expand: nil,
-                                                           include_remote_data: nil, request_options: 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?
@@ -358,7 +363,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

data/lib/merge_ruby_client/crm/audit_trail/client.rb CHANGED Viewed

@@ -23,12 +23,14 @@ module Merge
       # @param event_type [String] If included, will only include events with the given event type. Possible values
       #  include: `CREATED_REMOTE_PRODUCTION_API_KEY`,
       #  `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`,
-      #  `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `INVITED_USER`,
-      #  `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`,
-      #  `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`,
-      #  `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`,
-      #  `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`,
-      #  `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`,
+      #  `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`,
+      #  `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`,
+      #  `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`,
+      #  `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`,
+      #  `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`,
+      #  `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`,
+      #  `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`,
+      #  `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`,
       #  `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`,
       #  `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`,
       #  `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`,
@@ -105,12 +107,14 @@ module Merge
       # @param event_type [String] If included, will only include events with the given event type. Possible values
       #  include: `CREATED_REMOTE_PRODUCTION_API_KEY`,
       #  `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`,
-      #  `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `INVITED_USER`,
-      #  `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`,
-      #  `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`,
-      #  `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`,
-      #  `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`,
-      #  `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`,
+      #  `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`,
+      #  `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`,
+      #  `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`,
+      #  `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`,
+      #  `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`,
+      #  `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`,
+      #  `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`,
+      #  `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`,
       #  `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`,
       #  `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`,
       #  `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`,

data/lib/merge_ruby_client/crm/contacts/client.rb CHANGED Viewed

@@ -154,6 +154,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::Contact]
       # @example
@@ -163,7 +165,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.crm.contacts.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?
@@ -177,7 +180,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
@@ -350,6 +354,7 @@ module Merge
       #  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 is_custom [Boolean] If provided, will only return remote fields classes with this is_custom value
       # @param page_size [Integer] Number of results to return per page.
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Crm::PaginatedRemoteFieldClassList]
@@ -361,7 +366,7 @@ module Merge
       #  )
       #  api.crm.contacts.remote_field_classes_list
       def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
-                                    include_remote_fields: nil, include_shell_data: 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, is_custom: 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?
@@ -379,6 +384,7 @@ module Merge
             "include_remote_fields": include_remote_fields,
             "include_shell_data": include_shell_data,
             "is_common_model_field": is_common_model_field,
+            "is_custom": is_custom,
             "page_size": page_size
           }.compact
           unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -532,6 +538,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::Contact]
       # @example
@@ -541,7 +549,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.crm.contacts.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?
@@ -556,7 +565,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
@@ -738,6 +748,7 @@ module Merge
       #  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 is_custom [Boolean] If provided, will only return remote fields classes with this is_custom value
       # @param page_size [Integer] Number of results to return per page.
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Crm::PaginatedRemoteFieldClassList]
@@ -749,7 +760,7 @@ module Merge
       #  )
       #  api.crm.contacts.remote_field_classes_list
       def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
-                                    include_remote_fields: nil, include_shell_data: 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, is_custom: 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?
@@ -768,6 +779,7 @@ module Merge
               "include_remote_fields": include_remote_fields,
               "include_shell_data": include_shell_data,
               "is_common_model_field": is_common_model_field,
+              "is_custom": is_custom,
               "page_size": page_size
             }.compact
             unless request_options.nil? || request_options&.additional_body_parameters.nil?

data/lib/merge_ruby_client/crm/custom_object_classes/client.rb CHANGED Viewed

@@ -87,6 +87,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::Crm::CustomObjectClass]
       # @example
@@ -96,7 +98,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.crm.custom_object_classes.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?
@@ -109,7 +111,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
@@ -201,6 +204,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::Crm::CustomObjectClass]
       # @example
@@ -210,7 +215,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.crm.custom_object_classes.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?
@@ -224,7 +229,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

data/lib/merge_ruby_client/crm/custom_objects/client.rb CHANGED Viewed

@@ -92,6 +92,8 @@ module Merge
       # @param run_async [Boolean] Whether or not third-party updates should be run asynchronously.
       # @param model [Hash] Request of type Merge::Crm::CustomObjectRequest, as a Hash
       #   * :fields (Hash{String => Object})
+      #   * :integration_params (Hash{String => Object})
+      #   * :linked_account_params (Hash{String => Object})
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Crm::CrmCustomObjectResponse]
       # @example
@@ -131,6 +133,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::CustomObject]
       # @example
@@ -141,7 +145,7 @@ module Merge
       #  )
       #  api.crm.custom_objects.custom_object_classes_custom_objects_retrieve(custom_object_class_id: "custom_object_class_id", id: "id")
       def custom_object_classes_custom_objects_retrieve(custom_object_class_id:, id:, include_remote_data: nil,
-                                                        include_remote_fields: nil, request_options: 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?
@@ -154,7 +158,8 @@ module Merge
           req.params = {
             **(request_options&.additional_query_parameters || {}),
             "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
@@ -212,6 +217,7 @@ module Merge
       #  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 is_custom [Boolean] If provided, will only return remote fields classes with this is_custom value
       # @param page_size [Integer] Number of results to return per page.
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Crm::PaginatedRemoteFieldClassList]
@@ -223,7 +229,7 @@ module Merge
       #  )
       #  api.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list
       def custom_object_classes_custom_objects_remote_field_classes_list(cursor: nil, include_deleted_data: nil,
-                                                                         include_remote_data: nil, include_remote_fields: nil, include_shell_data: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
+                                                                         include_remote_data: nil, include_remote_fields: nil, include_shell_data: nil, is_common_model_field: nil, is_custom: 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?
@@ -241,6 +247,7 @@ module Merge
             "include_remote_fields": include_remote_fields,
             "include_shell_data": include_shell_data,
             "is_common_model_field": is_common_model_field,
+            "is_custom": is_custom,
             "page_size": page_size
           }.compact
           unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -334,6 +341,8 @@ module Merge
       # @param run_async [Boolean] Whether or not third-party updates should be run asynchronously.
       # @param model [Hash] Request of type Merge::Crm::CustomObjectRequest, as a Hash
       #   * :fields (Hash{String => Object})
+      #   * :integration_params (Hash{String => Object})
+      #   * :linked_account_params (Hash{String => Object})
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Crm::CrmCustomObjectResponse]
       # @example
@@ -375,6 +384,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::CustomObject]
       # @example
@@ -385,7 +396,7 @@ module Merge
       #  )
       #  api.crm.custom_objects.custom_object_classes_custom_objects_retrieve(custom_object_class_id: "custom_object_class_id", id: "id")
       def custom_object_classes_custom_objects_retrieve(custom_object_class_id:, id:, include_remote_data: nil,
-                                                        include_remote_fields: nil, request_options: 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?
@@ -399,7 +410,8 @@ module Merge
             req.params = {
               **(request_options&.additional_query_parameters || {}),
               "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
@@ -460,6 +472,7 @@ module Merge
       #  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 is_custom [Boolean] If provided, will only return remote fields classes with this is_custom value
       # @param page_size [Integer] Number of results to return per page.
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Crm::PaginatedRemoteFieldClassList]
@@ -471,7 +484,7 @@ module Merge
       #  )
       #  api.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list
       def custom_object_classes_custom_objects_remote_field_classes_list(cursor: nil, include_deleted_data: nil,
-                                                                         include_remote_data: nil, include_remote_fields: nil, include_shell_data: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
+                                                                         include_remote_data: nil, include_remote_fields: nil, include_shell_data: nil, is_common_model_field: nil, is_custom: 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?
@@ -490,6 +503,7 @@ module Merge
               "include_remote_fields": include_remote_fields,
               "include_shell_data": include_shell_data,
               "is_common_model_field": is_common_model_field,
+              "is_custom": is_custom,
               "page_size": page_size
             }.compact
             unless request_options.nil? || request_options&.additional_body_parameters.nil?

data/lib/merge_ruby_client/crm/engagement_types/client.rb CHANGED Viewed

@@ -88,6 +88,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::EngagementType]
       # @example
@@ -97,7 +99,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.crm.engagement_types.retrieve(id: "id")
-      def retrieve(id:, include_remote_data: nil, include_remote_fields: nil, request_options: nil)
+      def retrieve(id:, 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?
@@ -110,7 +113,8 @@ module Merge
           req.params = {
             **(request_options&.additional_query_parameters || {}),
             "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
@@ -135,6 +139,7 @@ module Merge
       #  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 is_custom [Boolean] If provided, will only return remote fields classes with this is_custom value
       # @param page_size [Integer] Number of results to return per page.
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Crm::PaginatedRemoteFieldClassList]
@@ -146,7 +151,7 @@ module Merge
       #  )
       #  api.crm.engagement_types.remote_field_classes_list
       def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
-                                    include_remote_fields: nil, include_shell_data: 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, is_custom: 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?
@@ -164,6 +169,7 @@ module Merge
             "include_remote_fields": include_remote_fields,
             "include_shell_data": include_shell_data,
             "is_common_model_field": is_common_model_field,
+            "is_custom": is_custom,
             "page_size": page_size
           }.compact
           unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -256,6 +262,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::EngagementType]
       # @example
@@ -265,7 +273,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.crm.engagement_types.retrieve(id: "id")
-      def retrieve(id:, include_remote_data: nil, include_remote_fields: nil, request_options: nil)
+      def retrieve(id:, 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?
@@ -279,7 +288,8 @@ module Merge
             req.params = {
               **(request_options&.additional_query_parameters || {}),
               "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
@@ -305,6 +315,7 @@ module Merge
       #  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 is_custom [Boolean] If provided, will only return remote fields classes with this is_custom value
       # @param page_size [Integer] Number of results to return per page.
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Crm::PaginatedRemoteFieldClassList]
@@ -316,7 +327,7 @@ module Merge
       #  )
       #  api.crm.engagement_types.remote_field_classes_list
       def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
-                                    include_remote_fields: nil, include_shell_data: 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, is_custom: 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?
@@ -335,6 +346,7 @@ module Merge
               "include_remote_fields": include_remote_fields,
               "include_shell_data": include_shell_data,
               "is_common_model_field": is_common_model_field,
+              "is_custom": is_custom,
               "page_size": page_size
             }.compact
             unless request_options.nil? || request_options&.additional_body_parameters.nil?