merge_ruby_client 1.0.0 → 2.0.0

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

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 require "date"
-require_relative "sync_status_status_enum"
+require_relative "last_sync_result_enum"
+require_relative "status_fd_5_enum"
 require_relative "selective_sync_configurations_usage_enum"
 require "ostruct"
 require "json"
@@ -22,7 +23,11 @@ module Merge
       attr_reader :last_sync_start
       # @return [DateTime]
       attr_reader :next_sync_start
-      # @return [Merge::Crm::SyncStatusStatusEnum]
+      # @return [Merge::Crm::LastSyncResultEnum]
+      attr_reader :last_sync_result
+      # @return [DateTime]
+      attr_reader :last_sync_finished
+      # @return [Merge::Crm::StatusFd5Enum]
       attr_reader :status
       # @return [Boolean]
       attr_reader :is_initial_sync
@@ -40,17 +45,21 @@ module Merge
       # @param model_id [String]
       # @param last_sync_start [DateTime]
       # @param next_sync_start [DateTime]
-      # @param status [Merge::Crm::SyncStatusStatusEnum]
+      # @param last_sync_result [Merge::Crm::LastSyncResultEnum]
+      # @param last_sync_finished [DateTime]
+      # @param status [Merge::Crm::StatusFd5Enum]
       # @param is_initial_sync [Boolean]
       # @param selective_sync_configurations_usage [Merge::Crm::SelectiveSyncConfigurationsUsageEnum]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Merge::Crm::SyncStatus]
-      def initialize(model_name:, model_id:, status:, is_initial_sync:, last_sync_start: OMIT, next_sync_start: OMIT,
-                     selective_sync_configurations_usage: OMIT, additional_properties: nil)
+      def initialize(model_name:, model_id:, status:, is_initial_sync:, last_sync_start: OMIT, next_sync_start: OMIT, last_sync_result: OMIT,
+                     last_sync_finished: OMIT, selective_sync_configurations_usage: OMIT, additional_properties: nil)
         @model_name = model_name
         @model_id = model_id
         @last_sync_start = last_sync_start if last_sync_start != OMIT
         @next_sync_start = next_sync_start if next_sync_start != OMIT
+        @last_sync_result = last_sync_result if last_sync_result != OMIT
+        @last_sync_finished = last_sync_finished if last_sync_finished != OMIT
         @status = status
         @is_initial_sync = is_initial_sync
         if selective_sync_configurations_usage != OMIT
@@ -62,6 +71,8 @@ module Merge
           "model_id": model_id,
           "last_sync_start": last_sync_start,
           "next_sync_start": next_sync_start,
+          "last_sync_result": last_sync_result,
+          "last_sync_finished": last_sync_finished,
           "status": status,
           "is_initial_sync": is_initial_sync,
           "selective_sync_configurations_usage": selective_sync_configurations_usage
@@ -81,6 +92,10 @@ module Merge
         model_id = parsed_json["model_id"]
         last_sync_start = (DateTime.parse(parsed_json["last_sync_start"]) unless parsed_json["last_sync_start"].nil?)
         next_sync_start = (DateTime.parse(parsed_json["next_sync_start"]) unless parsed_json["next_sync_start"].nil?)
+        last_sync_result = parsed_json["last_sync_result"]
+        last_sync_finished = unless parsed_json["last_sync_finished"].nil?
+                               DateTime.parse(parsed_json["last_sync_finished"])
+                             end
         status = parsed_json["status"]
         is_initial_sync = parsed_json["is_initial_sync"]
         selective_sync_configurations_usage = parsed_json["selective_sync_configurations_usage"]
@@ -89,6 +104,8 @@ module Merge
           model_id: model_id,
           last_sync_start: last_sync_start,
           next_sync_start: next_sync_start,
+          last_sync_result: last_sync_result,
+          last_sync_finished: last_sync_finished,
           status: status,
           is_initial_sync: is_initial_sync,
           selective_sync_configurations_usage: selective_sync_configurations_usage,
@@ -114,7 +131,9 @@ module Merge
         obj.model_id.is_a?(String) != false || raise("Passed value for field obj.model_id is not the expected type, validation failed.")
         obj.last_sync_start&.is_a?(DateTime) != false || raise("Passed value for field obj.last_sync_start is not the expected type, validation failed.")
         obj.next_sync_start&.is_a?(DateTime) != false || raise("Passed value for field obj.next_sync_start is not the expected type, validation failed.")
-        obj.status.is_a?(Merge::Crm::SyncStatusStatusEnum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+        obj.last_sync_result&.is_a?(Merge::Crm::LastSyncResultEnum) != false || raise("Passed value for field obj.last_sync_result is not the expected type, validation failed.")
+        obj.last_sync_finished&.is_a?(DateTime) != false || raise("Passed value for field obj.last_sync_finished is not the expected type, validation failed.")
+        obj.status.is_a?(Merge::Crm::StatusFd5Enum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
         obj.is_initial_sync.is_a?(Boolean) != false || raise("Passed value for field obj.is_initial_sync is not the expected type, validation failed.")
         obj.selective_sync_configurations_usage&.is_a?(Merge::Crm::SelectiveSyncConfigurationsUsageEnum) != false || raise("Passed value for field obj.selective_sync_configurations_usage is not the expected type, validation failed.")
       end

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

@@ -41,8 +41,8 @@ module Merge
       # @return [DateTime] When the task is due.
       attr_reader :due_date
       # @return [Merge::Crm::TaskStatusEnum] The task's status.
-      #  - `OPEN` - OPEN
-      #  - `CLOSED` - CLOSED
+      #  * `OPEN` - OPEN
+      #  * `CLOSED` - CLOSED
       attr_reader :status
       # @return [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
@@ -75,8 +75,8 @@ module Merge
       # @param completed_date [DateTime] When the task is completed.
       # @param due_date [DateTime] When the task is due.
       # @param status [Merge::Crm::TaskStatusEnum] The task's status.
-      #  - `OPEN` - OPEN
-      #  - `CLOSED` - CLOSED
+      #  * `OPEN` - OPEN
+      #  * `CLOSED` - CLOSED
       # @param remote_was_deleted [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

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

@@ -32,8 +32,8 @@ module Merge
       # @return [DateTime] When the task is due.
       attr_reader :due_date
       # @return [Merge::Crm::TaskStatusEnum] The task's status.
-      #  - `OPEN` - OPEN
-      #  - `CLOSED` - CLOSED
+      #  * `OPEN` - OPEN
+      #  * `CLOSED` - CLOSED
       attr_reader :status
       # @return [Hash{String => Object}]
       attr_reader :integration_params
@@ -57,8 +57,8 @@ module Merge
       # @param completed_date [DateTime] When the task is completed.
       # @param due_date [DateTime] When the task is due.
       # @param status [Merge::Crm::TaskStatusEnum] The task's status.
-      #  - `OPEN` - OPEN
-      #  - `CLOSED` - CLOSED
+      #  * `OPEN` - OPEN
+      #  * `CLOSED` - CLOSED
       # @param integration_params [Hash{String => Object}]
       # @param linked_account_params [Hash{String => Object}]
       # @param remote_fields [Array<Merge::Crm::RemoteFieldRequest>]

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

@@ -2,8 +2,8 @@
 
 module Merge
   module Crm
-    # - `OPEN` - OPEN
-    #  - `CLOSED` - CLOSED
+    # * `OPEN` - OPEN
+    #  * `CLOSED` - CLOSED
     class TaskStatusEnum
       OPEN = "OPEN"
       CLOSED = "CLOSED"

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

@@ -91,6 +91,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::User]
       # @example
@@ -100,7 +102,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.crm.users.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?
@@ -113,7 +116,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
@@ -174,6 +178,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]
@@ -185,7 +190,7 @@ module Merge
       #  )
       #  api.crm.users.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?
@@ -203,6 +208,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?
@@ -297,6 +303,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::User]
       # @example
@@ -306,7 +314,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.crm.users.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?
@@ -320,7 +329,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
@@ -384,6 +394,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]
@@ -395,7 +406,7 @@ module Merge
       #  )
       #  api.crm.users.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?
@@ -414,6 +425,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/filestorage/audit_trail/client.rb

@@ -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/filestorage/drives/client.rb

@@ -85,6 +85,8 @@ module Merge
       # @param id [String]
       # @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::Filestorage::Drive]
       # @example
@@ -94,7 +96,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.filestorage.drives.retrieve(id: "id")
-      def retrieve(id:, include_remote_data: nil, request_options: nil)
+      def retrieve(id:, 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?
@@ -106,7 +108,8 @@ module Merge
           }.compact
           req.params = {
             **(request_options&.additional_query_parameters || {}),
-            "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
@@ -196,6 +199,8 @@ module Merge
       # @param id [String]
       # @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::Filestorage::Drive]
       # @example
@@ -205,7 +210,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.filestorage.drives.retrieve(id: "id")
-      def retrieve(id:, include_remote_data: nil, request_options: nil)
+      def retrieve(id:, 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?
@@ -218,7 +223,8 @@ module Merge
             }.compact
             req.params = {
               **(request_options&.additional_query_parameters || {}),
-              "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