merge_ruby_client 0.0.1

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

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require_relative "activity_type_enum"
+require "date"
+require_relative "remote_field"
+require "json"
+
+module Merge
+  module Crm
+    # # The Engagement Type Object
+    #
+    # ### Description
+    #
+    # The `Engagement Type` object is used to represent an interaction activity. A given `Engagement` typically has an `Engagement Type` object represented in the engagement_type field.
+    #
+    # ### Usage Example
+    #
+    # TODO
+    class EngagementType
+      attr_reader :activity_type, :name, :id, :remote_id, :created_at, :modified_at, :remote_fields,
+                  :additional_properties
+
+      # @param activity_type [ACTIVITY_TYPE_ENUM] The engagement type's activity type.
+      #   - `CALL` - CALL
+      #   - `MEETING` - MEETING
+      #   - `EMAIL` - EMAIL
+      # @param name [String] The engagement type's name.
+      # @param id [String]
+      # @param remote_id [String] The third-party API ID of the matching object.
+      # @param created_at [DateTime]
+      # @param modified_at [DateTime] This is the datetime that this object was last updated by Merge
+      # @param remote_fields [Array<Crm::RemoteField>]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Crm::EngagementType]
+      def initialize(activity_type: nil, name: nil, id: nil, remote_id: nil, created_at: nil, modified_at: nil,
+                     remote_fields: nil, additional_properties: nil)
+        # @type [ACTIVITY_TYPE_ENUM] The engagement type's activity type.
+        #   - `CALL` - CALL
+        #   - `MEETING` - MEETING
+        #   - `EMAIL` - EMAIL
+        @activity_type = activity_type
+        # @type [String] The engagement type's name.
+        @name = name
+        # @type [String]
+        @id = id
+        # @type [String] The third-party API ID of the matching object.
+        @remote_id = remote_id
+        # @type [DateTime]
+        @created_at = created_at
+        # @type [DateTime] This is the datetime that this object was last updated by Merge
+        @modified_at = modified_at
+        # @type [Array<Crm::RemoteField>]
+        @remote_fields = remote_fields
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of EngagementType
+      #
+      # @param json_object [JSON]
+      # @return [Crm::EngagementType]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        activity_type = Crm::ACTIVITY_TYPE_ENUM.key(parsed_json["activity_type"]) || parsed_json["activity_type"]
+        name = struct.name
+        id = struct.id
+        remote_id = struct.remote_id
+        created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
+        modified_at = (DateTime.parse(parsed_json["modified_at"]) unless parsed_json["modified_at"].nil?)
+        remote_fields = parsed_json["remote_fields"]&.map do |v|
+          v = v.to_json
+          Crm::RemoteField.from_json(json_object: v)
+        end
+        new(activity_type: activity_type, name: name, id: id, remote_id: remote_id, created_at: created_at,
+            modified_at: modified_at, remote_fields: remote_fields, additional_properties: struct)
+      end
+
+      # Serialize an instance of EngagementType to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        {
+          "activity_type": Crm::ACTIVITY_TYPE_ENUM[@activity_type] || @activity_type,
+          "name": @name,
+          "id": @id,
+          "remote_id": @remote_id,
+          "created_at": @created_at,
+          "modified_at": @modified_at,
+          "remote_fields": @remote_fields
+        }.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.activity_type&.is_a?(Crm::ACTIVITY_TYPE_ENUM) != false || raise("Passed value for field obj.activity_type is not the expected type, validation failed.")
+        obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+        obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        obj.remote_id&.is_a?(String) != false || raise("Passed value for field obj.remote_id is not the expected type, validation failed.")
+        obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
+        obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.")
+        obj.remote_fields&.is_a?(Array) != false || raise("Passed value for field obj.remote_fields is not the expected type, validation failed.")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require_relative "validation_problem_source"
+require "json"
+
+module Merge
+  module Crm
+    class ErrorValidationProblem
+      attr_reader :source, :title, :detail, :problem_type, :additional_properties
+
+      # @param source [Crm::ValidationProblemSource]
+      # @param title [String]
+      # @param detail [String]
+      # @param problem_type [String]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Crm::ErrorValidationProblem]
+      def initialize(title:, detail:, problem_type:, source: nil, additional_properties: nil)
+        # @type [Crm::ValidationProblemSource]
+        @source = source
+        # @type [String]
+        @title = title
+        # @type [String]
+        @detail = detail
+        # @type [String]
+        @problem_type = problem_type
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of ErrorValidationProblem
+      #
+      # @param json_object [JSON]
+      # @return [Crm::ErrorValidationProblem]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        if parsed_json["source"].nil?
+          source = nil
+        else
+          source = parsed_json["source"].to_json
+          source = Crm::ValidationProblemSource.from_json(json_object: source)
+        end
+        title = struct.title
+        detail = struct.detail
+        problem_type = struct.problem_type
+        new(source: source, title: title, detail: detail, problem_type: problem_type, additional_properties: struct)
+      end
+
+      # Serialize an instance of ErrorValidationProblem to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "source": @source, "title": @title, "detail": @detail, "problem_type": @problem_type }.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.source.nil? || Crm::ValidationProblemSource.validate_raw(obj: obj.source)
+        obj.title.is_a?(String) != false || raise("Passed value for field obj.title is not the expected type, validation failed.")
+        obj.detail.is_a?(String) != false || raise("Passed value for field obj.detail is not the expected type, validation failed.")
+        obj.problem_type.is_a?(String) != false || raise("Passed value for field obj.problem_type is not the expected type, validation failed.")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Merge
+  module Crm
+    # @type [EVENT_TYPE_ENUM]
+    EVENT_TYPE_ENUM = {
+      created_remote_production_api_key: "CREATED_REMOTE_PRODUCTION_API_KEY",
+      deleted_remote_production_api_key: "DELETED_REMOTE_PRODUCTION_API_KEY",
+      created_test_api_key: "CREATED_TEST_API_KEY",
+      deleted_test_api_key: "DELETED_TEST_API_KEY",
+      regenerated_production_api_key: "REGENERATED_PRODUCTION_API_KEY",
+      invited_user: "INVITED_USER",
+      two_factor_auth_enabled: "TWO_FACTOR_AUTH_ENABLED",
+      two_factor_auth_disabled: "TWO_FACTOR_AUTH_DISABLED",
+      deleted_linked_account: "DELETED_LINKED_ACCOUNT",
+      created_destination: "CREATED_DESTINATION",
+      deleted_destination: "DELETED_DESTINATION",
+      changed_scopes: "CHANGED_SCOPES",
+      changed_personal_information: "CHANGED_PERSONAL_INFORMATION",
+      changed_organization_settings: "CHANGED_ORGANIZATION_SETTINGS",
+      enabled_integration: "ENABLED_INTEGRATION",
+      disabled_integration: "DISABLED_INTEGRATION",
+      enabled_category: "ENABLED_CATEGORY",
+      disabled_category: "DISABLED_CATEGORY",
+      changed_password: "CHANGED_PASSWORD",
+      reset_password: "RESET_PASSWORD",
+      enabled_redact_unmapped_data_for_organization: "ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION",
+      enabled_redact_unmapped_data_for_linked_account: "ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT",
+      disabled_redact_unmapped_data_for_organization: "DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION",
+      disabled_redact_unmapped_data_for_linked_account: "DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT",
+      created_integration_wide_field_mapping: "CREATED_INTEGRATION_WIDE_FIELD_MAPPING",
+      created_linked_account_field_mapping: "CREATED_LINKED_ACCOUNT_FIELD_MAPPING",
+      changed_integration_wide_field_mapping: "CHANGED_INTEGRATION_WIDE_FIELD_MAPPING",
+      changed_linked_account_field_mapping: "CHANGED_LINKED_ACCOUNT_FIELD_MAPPING",
+      deleted_integration_wide_field_mapping: "DELETED_INTEGRATION_WIDE_FIELD_MAPPING",
+      deleted_linked_account_field_mapping: "DELETED_LINKED_ACCOUNT_FIELD_MAPPING"
+    }.freeze
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Merge
+  module Crm
+    # @type [FIELD_FORMAT_ENUM]
+    FIELD_FORMAT_ENUM = {
+      string: "string",
+      number: "number",
+      date: "date",
+      datetime: "datetime",
+      bool: "bool",
+      list: "list"
+    }.freeze
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Merge
+  module Crm
+    # @type [FIELD_TYPE_ENUM]
+    FIELD_TYPE_ENUM = {
+      string: "string",
+      number: "number",
+      date: "date",
+      datetime: "datetime",
+      bool: "bool",
+      list: "list"
+    }.freeze
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative "reason_enum"
+require "json"
+
+module Merge
+  module Crm
+    class IgnoreCommonModelRequest
+      attr_reader :reason, :message, :additional_properties
+
+      # @param reason [REASON_ENUM]
+      # @param message [String]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Crm::IgnoreCommonModelRequest]
+      def initialize(reason:, message: nil, additional_properties: nil)
+        # @type [REASON_ENUM]
+        @reason = reason
+        # @type [String]
+        @message = message
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of IgnoreCommonModelRequest
+      #
+      # @param json_object [JSON]
+      # @return [Crm::IgnoreCommonModelRequest]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        reason = Crm::REASON_ENUM.key(parsed_json["reason"]) || parsed_json["reason"]
+        message = struct.message
+        new(reason: reason, message: message, additional_properties: struct)
+      end
+
+      # Serialize an instance of IgnoreCommonModelRequest to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "reason": Crm::REASON_ENUM[@reason] || @reason, "message": @message }.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.reason.is_a?(Crm::REASON_ENUM) != false || raise("Passed value for field obj.reason is not the expected type, validation failed.")
+        obj.message&.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require_relative "issue_status_enum"
+require "date"
+require "json"
+
+module Merge
+  module Crm
+    class Issue
+      attr_reader :id, :status, :error_description, :end_user, :first_incident_time, :last_incident_time, :is_muted,
+                  :error_details, :additional_properties
+
+      # @param id [String]
+      # @param status [ISSUE_STATUS_ENUM] Status of the issue. Options: ('ONGOING', 'RESOLVED')
+      #   - `ONGOING` - ONGOING
+      #   - `RESOLVED` - RESOLVED
+      # @param error_description [String]
+      # @param end_user [Hash{String => String}]
+      # @param first_incident_time [DateTime]
+      # @param last_incident_time [DateTime]
+      # @param is_muted [Boolean]
+      # @param error_details [Array<String>]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Crm::Issue]
+      def initialize(error_description:, id: nil, status: nil, end_user: nil, first_incident_time: nil,
+                     last_incident_time: nil, is_muted: nil, error_details: nil, additional_properties: nil)
+        # @type [String]
+        @id = id
+        # @type [ISSUE_STATUS_ENUM] Status of the issue. Options: ('ONGOING', 'RESOLVED')
+        #   - `ONGOING` - ONGOING
+        #   - `RESOLVED` - RESOLVED
+        @status = status
+        # @type [String]
+        @error_description = error_description
+        # @type [Hash{String => String}]
+        @end_user = end_user
+        # @type [DateTime]
+        @first_incident_time = first_incident_time
+        # @type [DateTime]
+        @last_incident_time = last_incident_time
+        # @type [Boolean]
+        @is_muted = is_muted
+        # @type [Array<String>]
+        @error_details = error_details
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of Issue
+      #
+      # @param json_object [JSON]
+      # @return [Crm::Issue]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        id = struct.id
+        status = Crm::ISSUE_STATUS_ENUM.key(parsed_json["status"]) || parsed_json["status"]
+        error_description = struct.error_description
+        end_user = struct.end_user
+        first_incident_time = unless parsed_json["first_incident_time"].nil?
+                                DateTime.parse(parsed_json["first_incident_time"])
+                              end
+        last_incident_time = unless parsed_json["last_incident_time"].nil?
+                               DateTime.parse(parsed_json["last_incident_time"])
+                             end
+        is_muted = struct.is_muted
+        error_details = struct.error_details
+        new(id: id, status: status, error_description: error_description, end_user: end_user,
+            first_incident_time: first_incident_time, last_incident_time: last_incident_time, is_muted: is_muted, error_details: error_details, additional_properties: struct)
+      end
+
+      # Serialize an instance of Issue to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        {
+          "id": @id,
+          "status": Crm::ISSUE_STATUS_ENUM[@status] || @status,
+          "error_description": @error_description,
+          "end_user": @end_user,
+          "first_incident_time": @first_incident_time,
+          "last_incident_time": @last_incident_time,
+          "is_muted": @is_muted,
+          "error_details": @error_details
+        }.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        obj.status&.is_a?(Crm::ISSUE_STATUS_ENUM) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+        obj.error_description.is_a?(String) != false || raise("Passed value for field obj.error_description is not the expected type, validation failed.")
+        obj.end_user&.is_a?(Hash) != false || raise("Passed value for field obj.end_user is not the expected type, validation failed.")
+        obj.first_incident_time&.is_a?(DateTime) != false || raise("Passed value for field obj.first_incident_time is not the expected type, validation failed.")
+        obj.last_incident_time&.is_a?(DateTime) != false || raise("Passed value for field obj.last_incident_time is not the expected type, validation failed.")
+        obj.is_muted&.is_a?(Boolean) != false || raise("Passed value for field obj.is_muted is not the expected type, validation failed.")
+        obj.error_details&.is_a?(Array) != false || raise("Passed value for field obj.error_details is not the expected type, validation failed.")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Merge
+  module Crm
+    # @type [ISSUE_STATUS_ENUM]
+    ISSUE_STATUS_ENUM = { ongoing: "ONGOING", resolved: "RESOLVED" }.freeze
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Merge
+  module Crm
+    # @type [ITEM_FORMAT_ENUM]
+    ITEM_FORMAT_ENUM = {
+      string: "string",
+      number: "number",
+      date: "date",
+      datetime: "datetime",
+      bool: "bool",
+      list: "list"
+    }.freeze
+  end
+end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative "item_type_enum"
+require_relative "item_format_enum"
+require "json"
+
+module Merge
+  module Crm
+    class ItemSchema
+      attr_reader :item_type, :item_format, :item_choices, :additional_properties
+
+      # @param item_type [ITEM_TYPE_ENUM]
+      # @param item_format [ITEM_FORMAT_ENUM]
+      # @param item_choices [Array<String>]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Crm::ItemSchema]
+      def initialize(item_type: nil, item_format: nil, item_choices: nil, additional_properties: nil)
+        # @type [ITEM_TYPE_ENUM]
+        @item_type = item_type
+        # @type [ITEM_FORMAT_ENUM]
+        @item_format = item_format
+        # @type [Array<String>]
+        @item_choices = item_choices
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of ItemSchema
+      #
+      # @param json_object [JSON]
+      # @return [Crm::ItemSchema]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        item_type = Crm::ITEM_TYPE_ENUM.key(parsed_json["item_type"]) || parsed_json["item_type"]
+        item_format = Crm::ITEM_FORMAT_ENUM.key(parsed_json["item_format"]) || parsed_json["item_format"]
+        item_choices = struct.item_choices
+        new(item_type: item_type, item_format: item_format, item_choices: item_choices, additional_properties: struct)
+      end
+
+      # Serialize an instance of ItemSchema to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        {
+          "item_type": Crm::ITEM_TYPE_ENUM[@item_type] || @item_type,
+          "item_format": Crm::ITEM_FORMAT_ENUM[@item_format] || @item_format,
+          "item_choices": @item_choices
+        }.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.item_type&.is_a?(Crm::ITEM_TYPE_ENUM) != false || raise("Passed value for field obj.item_type is not the expected type, validation failed.")
+        obj.item_format&.is_a?(Crm::ITEM_FORMAT_ENUM) != false || raise("Passed value for field obj.item_format is not the expected type, validation failed.")
+        obj.item_choices&.is_a?(Array) != false || raise("Passed value for field obj.item_choices is not the expected type, validation failed.")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Merge
+  module Crm
+    # @type [ITEM_TYPE_ENUM]
+    ITEM_TYPE_ENUM = {
+      string: "string",
+      number: "number",
+      date: "date",
+      datetime: "datetime",
+      bool: "bool",
+      list: "list"
+    }.freeze
+  end
+end