lockstep_sdk 2022.37.24.0 → 2023.1.3.0

data/lib/lockstep_sdk/models/email_model.rb

@@ -1,242 +0,0 @@
-#
-# Lockstep Platform SDK for Ruby
-#
-# (c) 2021-2022 Lockstep, Inc.
-#
-# For the full copyright and license information, please view the LICENSE
-# file that was distributed with this source code.
-#
-# @author     Lockstep Network <support@lockstep.io>
-# @copyright  2021-2022 Lockstep, Inc.
-# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
-#
-
-
-require 'json'
-
-module LockstepSdk
-
-    ##
-    # An Email represents a communication sent from one company to another.  The creator of the email is identified
-    # by the `CompanyId` field, recipient(s) by the `EmailTo` field, and cc recipient(s) by the 'EmailCC' field.
-    # The Email Model represents an email and a number of different metadata attributes related to the creation,
-    # storage, and ownership of the email.
-    class EmailModel
-
-        ##
-        # Initialize the EmailModel using the provided prototype
-        def initialize(params = {})
-            @email_id = params.dig(:email_id)
-            @thread_id = params.dig(:thread_id)
-            @group_key = params.dig(:group_key)
-            @company_id = params.dig(:company_id)
-            @email_from = params.dig(:email_from)
-            @email_to = params.dig(:email_to)
-            @email_cc = params.dig(:email_cc)
-            @email_subject = params.dig(:email_subject)
-            @email_body = params.dig(:email_body)
-            @sent_date = params.dig(:sent_date)
-            @is_unread = params.dig(:is_unread)
-            @is_priority = params.dig(:is_priority)
-            @is_spam = params.dig(:is_spam)
-            @created = params.dig(:created)
-            @created_user_id = params.dig(:created_user_id)
-            @to_be_sent = params.dig(:to_be_sent)
-            @customer_id = params.dig(:customer_id)
-            @received_time_stamp = params.dig(:received_time_stamp)
-            @opened_timestamp = params.dig(:opened_timestamp)
-            @view_count = params.dig(:view_count)
-            @app_enrollment_id = params.dig(:app_enrollment_id)
-            @external_email_id = params.dig(:external_email_id)
-            @external_thread_id = params.dig(:external_thread_id)
-            @email_bcc = params.dig(:email_bcc)
-            @send_type = params.dig(:send_type)
-            @modified = params.dig(:modified)
-            @modified_user_id = params.dig(:modified_user_id)
-            @response_origin_id = params.dig(:response_origin_id)
-            @response_origin = params.dig(:response_origin)
-            @notes = params.dig(:notes)
-            @attachments = params.dig(:attachments)
-            @custom_field_definitions = params.dig(:custom_field_definitions)
-            @custom_field_values = params.dig(:custom_field_values)
-        end
-
-        ##
-        # @return [Uuid] The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.
-        attr_accessor :email_id
-
-        ##
-        # @return [Uuid] The unique ID number of this email's conversation thread.
-        attr_accessor :thread_id
-
-        ##
-        # @return [Uuid] The GroupKey uniquely identifies a single Lockstep Platform account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created. For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
-        attr_accessor :group_key
-
-        ##
-        # @return [Uuid] The ID number of the company that created this email.
-        attr_accessor :company_id
-
-        ##
-        # @return [String] The email address for the sender of this email.
-        attr_accessor :email_from
-
-        ##
-        # @return [String] The email address for the recipient(s) of this email.
-        attr_accessor :email_to
-
-        ##
-        # @return [String] The email address for the CC recipient(s) of this email
-        attr_accessor :email_cc
-
-        ##
-        # @return [String] The subject line of this email.
-        attr_accessor :email_subject
-
-        ##
-        # @return [String] The body content of this email.
-        attr_accessor :email_body
-
-        ##
-        # @return [Date-time] The date on which this email was sent.
-        attr_accessor :sent_date
-
-        ##
-        # @return [Boolean] A status flag indicating if this email is unread.
-        attr_accessor :is_unread
-
-        ##
-        # @return [Boolean] A status flag indicating if this email is priority status.
-        attr_accessor :is_priority
-
-        ##
-        # @return [Boolean] A status flag indicating if this email is marked as spam.
-        attr_accessor :is_spam
-
-        ##
-        # @return [Date-time] The date on which this email was created.
-        attr_accessor :created
-
-        ##
-        # @return [Uuid] The ID number of the user who created this email.
-        attr_accessor :created_user_id
-
-        ##
-        # @return [Boolean] A status flag indicating if this email is to be sent.
-        attr_accessor :to_be_sent
-
-        ##
-        # @return [Uuid] The ID number of the customer that sent this email.
-        attr_accessor :customer_id
-
-        ##
-        # @return [Date-time] The date on which this email was received.
-        attr_accessor :received_time_stamp
-
-        ##
-        # @return [Date-time] The date on which this email was opened.
-        attr_accessor :opened_timestamp
-
-        ##
-        # @return [Int32] The number of times this email was viewed.
-        attr_accessor :view_count
-
-        ##
-        # @return [Uuid] The AppEnrollmentId of the application that imported this record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record. This value is null if this record was not loaded from an external ERP or financial system.
-        attr_accessor :app_enrollment_id
-
-        ##
-        # @return [String] The id of the email in an external system if imported.
-        attr_accessor :external_email_id
-
-        ##
-        # @return [String] The id of the email thread in an external system if imported.
-        attr_accessor :external_thread_id
-
-        ##
-        # @return [String] The email address(es) for the BCC recipient(s) of this email
-        attr_accessor :email_bcc
-
-        ##
-        # @return [String] The type message being sent (New, Reply, Forward) or null for messages not being sent.
-        attr_accessor :send_type
-
-        ##
-        # @return [Date-time] The date on which this email was modified. Email modification should only be done by internal services.
-        attr_accessor :modified
-
-        ##
-        # @return [Uuid] The ID of the user who modified this email. Email modification should only be done by internal services.
-        attr_accessor :modified_user_id
-
-        ##
-        # @return [Uuid] If the message being sent is a reply or a forward, the id of the the email being replied to or forwarded. Otherwise null.
-        attr_accessor :response_origin_id
-
-        ##
-        # @return [EmailModel] The email object associated with the response origin id.
-        attr_accessor :response_origin
-
-        ##
-        # @return [NoteModel] A collection of notes linked to this record. To retrieve this collection, specify `Notes` in the `include` parameter when retrieving data. To create a note, use the [Create Note](https://developer.lockstep.io/reference/post_api-v1-notes) endpoint with the `TableKey` to `Email` and the `ObjectKey` set to the `EmailId` for this record. For more information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
-        attr_accessor :notes
-
-        ##
-        # @return [AttachmentModel] A collection of attachments linked to this record. To retrieve this collection, specify `Attachments` in the `include` parameter when retrieving data. To create an attachment, use the [Upload Attachment](https://developer.lockstep.io/reference/post_api-v1-attachments) endpoint with the `TableKey` to `Email` and the `ObjectKey` set to the `EmailId` for this record. For more information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
-        attr_accessor :attachments
-
-        ##
-        # @return [CustomFieldDefinitionModel] A collection of custom fields linked to this record. To retrieve this collection, specify `CustomFieldDefinitions` in the `include` parameter when retrieving data. To create a custom field, use the [Create Custom Field](https://developer.lockstep.io/reference/post_api-v1-customfieldvalues) endpoint with the `TableKey` to `Email` and the `ObjectKey` set to the `EmailId` for this record. For more information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
-        attr_accessor :custom_field_definitions
-
-        ##
-        # @return [CustomFieldValueModel] A collection of custom fields linked to this record. To retrieve this collection, specify `CustomFieldValues` in the `include` parameter when retrieving data. To create a custom field, use the [Create Custom Field](https://developer.lockstep.io/reference/post_api-v1-customfieldvalues) endpoint with the `TableKey` to `Email` and the `ObjectKey` set to the `EmailId` for this record. For more information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
-        attr_accessor :custom_field_values
-
-        ##
-        # @return [object] This object as a JSON key-value structure
-        def as_json(options={})
-            {
-                'emailId' => @email_id,
-                'threadId' => @thread_id,
-                'groupKey' => @group_key,
-                'companyId' => @company_id,
-                'emailFrom' => @email_from,
-                'emailTo' => @email_to,
-                'emailCC' => @email_cc,
-                'emailSubject' => @email_subject,
-                'emailBody' => @email_body,
-                'sentDate' => @sent_date,
-                'isUnread' => @is_unread,
-                'isPriority' => @is_priority,
-                'isSpam' => @is_spam,
-                'created' => @created,
-                'createdUserId' => @created_user_id,
-                'toBeSent' => @to_be_sent,
-                'customerId' => @customer_id,
-                'receivedTimeStamp' => @received_time_stamp,
-                'openedTimestamp' => @opened_timestamp,
-                'viewCount' => @view_count,
-                'appEnrollmentId' => @app_enrollment_id,
-                'externalEmailId' => @external_email_id,
-                'externalThreadId' => @external_thread_id,
-                'emailBcc' => @email_bcc,
-                'sendType' => @send_type,
-                'modified' => @modified,
-                'modifiedUserId' => @modified_user_id,
-                'responseOriginId' => @response_origin_id,
-                'responseOrigin' => @response_origin,
-                'notes' => @notes,
-                'attachments' => @attachments,
-                'customFieldDefinitions' => @custom_field_definitions,
-                'customFieldValues' => @custom_field_values,
-            }
-        end
-
-        ##
-        # @return [String] This object converted to a JSON string
-        def to_json(*options)
-            "[#{as_json(*options).to_json(*options)}]"
-        end
-    end
-end