merge_ruby_client 1.0.0 → 2.0.0

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

@@ -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::Stage]
       # @example
@@ -97,7 +99,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.crm.stages.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.stages.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::Stage]
       # @example
@@ -265,7 +273,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.crm.stages.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.stages.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?

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

@@ -16,9 +16,16 @@ module Merge
         @request_client = request_client
       end
 
-      # Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`,
-      #  `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our
-      #  [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+      # Get sync status for the current sync and the most recently finished sync.
+      #  `last_sync_start` represents the most recent time any sync began.
+      #  `last_sync_finished` represents the most recent time any sync completed. These
+      #  timestamps may correspond to different sync instances which may result in a sync
+      #  start time being later than a separate sync completed time. To ensure you are
+      #  retrieving the latest available data reference the `last_sync_finished`
+      #  timestamp where `last_sync_result` is `DONE`. Possible values for `status` and
+      #  `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`,
+      #  `PAUSED`, `SYNCING`. Learn more about sync status in our [Help
+      #  Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
       #
       # @param cursor [String] The pagination cursor value.
       # @param page_size [Integer] Number of results to return per page.
@@ -65,9 +72,16 @@ module Merge
         @request_client = request_client
       end
 
-      # Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`,
-      #  `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our
-      #  [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+      # Get sync status for the current sync and the most recently finished sync.
+      #  `last_sync_start` represents the most recent time any sync began.
+      #  `last_sync_finished` represents the most recent time any sync completed. These
+      #  timestamps may correspond to different sync instances which may result in a sync
+      #  start time being later than a separate sync completed time. To ensure you are
+      #  retrieving the latest available data reference the `last_sync_finished`
+      #  timestamp where `last_sync_result` is `DONE`. Possible values for `status` and
+      #  `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`,
+      #  `PAUSED`, `SYNCING`. Learn more about sync status in our [Help
+      #  Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
       #
       # @param cursor [String] The pagination cursor value.
       # @param page_size [Integer] Number of results to return per page.

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

@@ -145,6 +145,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::Task]
       # @example
@@ -154,7 +156,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.crm.tasks.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?
@@ -168,7 +171,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
@@ -305,6 +309,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 +321,7 @@ module Merge
       #  )
       #  api.crm.tasks.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?
@@ -334,6 +339,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?
@@ -479,6 +485,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::Task]
       # @example
@@ -488,7 +496,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.crm.tasks.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?
@@ -503,7 +512,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
@@ -647,6 +657,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]
@@ -658,7 +669,7 @@ module Merge
       #  )
       #  api.crm.tasks.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?
@@ -677,6 +688,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/types/account_details_and_actions_status_enum.rb

@@ -2,10 +2,10 @@
 
 module Merge
   module Crm
-    # - `COMPLETE` - COMPLETE
-    #  - `INCOMPLETE` - INCOMPLETE
-    #  - `RELINK_NEEDED` - RELINK_NEEDED
-    #  - `IDLE` - IDLE
+    # * `COMPLETE` - COMPLETE
+    #  * `INCOMPLETE` - INCOMPLETE
+    #  * `RELINK_NEEDED` - RELINK_NEEDED
+    #  * `IDLE` - IDLE
     class AccountDetailsAndActionsStatusEnum
       COMPLETE = "COMPLETE"
       INCOMPLETE = "INCOMPLETE"

data/lib/merge_ruby_client/crm/types/account_token.rb

@@ -11,6 +11,8 @@ module Merge
       attr_reader :account_token
       # @return [Merge::Crm::AccountIntegration]
       attr_reader :integration
+      # @return [String]
+      attr_reader :id
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
       # @return [Object]
@@ -21,13 +23,15 @@ module Merge
 
       # @param account_token [String]
       # @param integration [Merge::Crm::AccountIntegration]
+      # @param id [String]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Merge::Crm::AccountToken]
-      def initialize(account_token:, integration:, additional_properties: nil)
+      def initialize(account_token:, integration:, id:, additional_properties: nil)
         @account_token = account_token
         @integration = integration
+        @id = id
         @additional_properties = additional_properties
-        @_field_set = { "account_token": account_token, "integration": integration }
+        @_field_set = { "account_token": account_token, "integration": integration, "id": id }
       end
 
       # Deserialize a JSON object to an instance of AccountToken
@@ -44,9 +48,11 @@ module Merge
           integration = parsed_json["integration"].to_json
           integration = Merge::Crm::AccountIntegration.from_json(json_object: integration)
         end
+        id = parsed_json["id"]
         new(
           account_token: account_token,
           integration: integration,
+          id: id,
           additional_properties: struct
         )
       end
@@ -67,6 +73,7 @@ module Merge
       def self.validate_raw(obj:)
         obj.account_token.is_a?(String) != false || raise("Passed value for field obj.account_token is not the expected type, validation failed.")
         Merge::Crm::AccountIntegration.validate_raw(obj: obj.integration)
+        obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
       end
     end
   end

data/lib/merge_ruby_client/crm/types/activity_type_enum.rb

@@ -2,9 +2,9 @@
 
 module Merge
   module Crm
-    # - `CALL` - CALL
-    #  - `MEETING` - MEETING
-    #  - `EMAIL` - EMAIL
+    # * `CALL` - CALL
+    #  * `MEETING` - MEETING
+    #  * `EMAIL` - EMAIL
     class ActivityTypeEnum
       CALL = "CALL"
       MEETING = "MEETING"