lockstep_sdk 2022.4.32.0

data/lib/lockstep_sdk/models/customer_summary_model.rb

@@ -0,0 +1,134 @@
+#
+# Lockstep Software Development Kit 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     Ted Spence <tspence@lockstep.io>
+# @author     Manish Narayan B S <manish.n@lockstep.io>
+# @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @version    2022.4
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # Contains summarized data for a customer
+    class CustomerSummaryModel
+
+        ##
+        # Initialize the CustomerSummaryModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @company_id = params.dig(:company_id)
+            @company_name = params.dig(:company_name)
+            @primary_contact = params.dig(:primary_contact)
+            @outstanding_invoices = params.dig(:outstanding_invoices)
+            @total_invoices_open = params.dig(:total_invoices_open)
+            @total_invoices_past_due = params.dig(:total_invoices_past_due)
+            @closed_invoices = params.dig(:closed_invoices)
+            @amount_collected = params.dig(:amount_collected)
+            @outstanding_amount = params.dig(:outstanding_amount)
+            @amount_past_due = params.dig(:amount_past_due)
+            @unapplied_payments = params.dig(:unapplied_payments)
+            @percent_of_total_ar = params.dig(:percent_of_total_ar)
+            @dso = params.dig(:dso)
+            @newest_activity = params.dig(:newest_activity)
+        end
+
+        ##
+        # @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 unique ID of this company.
+        attr_accessor :company_id
+
+        ##
+        # @return [String] The name of the company.
+        attr_accessor :company_name
+
+        ##
+        # @return [String] The name of the primary contact.
+        attr_accessor :primary_contact
+
+        ##
+        # @return [Int32] The number of outstanding invoices for this customer.
+        attr_accessor :outstanding_invoices
+
+        ##
+        # @return [Int32] The number of open invoices.
+        attr_accessor :total_invoices_open
+
+        ##
+        # @return [Int32] The number of past due invoices.
+        attr_accessor :total_invoices_past_due
+
+        ##
+        # @return [Int32] The number of closed invoices for this customer.
+        attr_accessor :closed_invoices
+
+        ##
+        # @return [Double] The total from collected payments.
+        attr_accessor :amount_collected
+
+        ##
+        # @return [Double] The total balance of outstanding invoices.
+        attr_accessor :outstanding_amount
+
+        ##
+        # @return [Double] The total amount past due for this customer.
+        attr_accessor :amount_past_due
+
+        ##
+        # @return [Double] The total value of unapplied Payments for this Customer.
+        attr_accessor :unapplied_payments
+
+        ##
+        # @return [Double] Portion of Total AR for this Customer that is Past due. (TotalPastDue / Total AR).
+        attr_accessor :percent_of_total_ar
+
+        ##
+        # @return [Double] Daily sales outstanding value for this Customer.
+        attr_accessor :dso
+
+        ##
+        # @return [Date] The date stamp for the newest Activity on this Customer.
+        attr_accessor :newest_activity
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'companyId' => @company_id,
+                'companyName' => @company_name,
+                'primaryContact' => @primary_contact,
+                'outstandingInvoices' => @outstanding_invoices,
+                'totalInvoicesOpen' => @total_invoices_open,
+                'totalInvoicesPastDue' => @total_invoices_past_due,
+                'closedInvoices' => @closed_invoices,
+                'amountCollected' => @amount_collected,
+                'outstandingAmount' => @outstanding_amount,
+                'amountPastDue' => @amount_past_due,
+                'unappliedPayments' => @unapplied_payments,
+                'percentOfTotalAr' => @percent_of_total_ar,
+                'dso' => @dso,
+                'newestActivity' => @newest_activity,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end

data/lib/lockstep_sdk/models/daily_sales_outstanding_report_model.rb

@@ -0,0 +1,62 @@
+#
+# Lockstep Software Development Kit 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     Ted Spence <tspence@lockstep.io>
+# @author     Manish Narayan B S <manish.n@lockstep.io>
+# @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @version    2022.4
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # Represents the daily sales outstanding report
+    class DailySalesOutstandingReportModel
+
+        ##
+        # Initialize the DailySalesOutstandingReportModel using the provided prototype
+        def initialize(params = {})
+            @timeframe = params.dig(:timeframe)
+            @invoice_count = params.dig(:invoice_count)
+            @daily_sales_outstanding = params.dig(:daily_sales_outstanding)
+        end
+
+        ##
+        # @return [Date-time] Timeframe (month) the daily sales outstanding values are associated with
+        attr_accessor :timeframe
+
+        ##
+        # @return [Int32] Number of invoices the average daily sales outstanding is calculated on
+        attr_accessor :invoice_count
+
+        ##
+        # @return [Double] Time (in days) between an invoice was completed paid off and when the invoice was issued
+        attr_accessor :daily_sales_outstanding
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'timeframe' => @timeframe,
+                'invoiceCount' => @invoice_count,
+                'dailySalesOutstanding' => @daily_sales_outstanding,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end

data/lib/lockstep_sdk/models/developer_account_submit_model.rb

@@ -0,0 +1,62 @@
+#
+# Lockstep Software Development Kit 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     Ted Spence <tspence@lockstep.io>
+# @author     Manish Narayan B S <manish.n@lockstep.io>
+# @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @version    2022.4
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # Model containing information to create a new developer account.
+    class DeveloperAccountSubmitModel
+
+        ##
+        # Initialize the DeveloperAccountSubmitModel using the provided prototype
+        def initialize(params = {})
+            @name = params.dig(:name)
+            @email = params.dig(:email)
+            @company_name = params.dig(:company_name)
+        end
+
+        ##
+        # @return [String] The name of the developer.
+        attr_accessor :name
+
+        ##
+        # @return [Email] The email address of the developer.
+        attr_accessor :email
+
+        ##
+        # @return [String] The company name of the developer.
+        attr_accessor :company_name
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'name' => @name,
+                'email' => @email,
+                'companyName' => @company_name,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end

data/lib/lockstep_sdk/models/email_model.rb

@@ -0,0 +1,245 @@
+#
+# Lockstep Software Development Kit 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     Ted Spence <tspence@lockstep.io>
+# @author     Manish Narayan B S <manish.n@lockstep.io>
+# @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @version    2022.4
+# @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] AppEnrollmentId for this record; used for mapping purposes.
+        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] All notes attached to this email. To retrieve this collection, specify `Notes` in the "Include" parameter for your query.
+        attr_accessor :notes
+
+        ##
+        # @return [AttachmentModel] All attachments attached to this email. To retrieve this collection, specify `Attachments` in the "Include" parameter for your query.
+        attr_accessor :attachments
+
+        ##
+        # @return [CustomFieldDefinitionModel] All definitions attached to this email. To retrieve this collection, specify `CustomFieldValues` in the "Include" parameter for your query.
+        attr_accessor :custom_field_definitions
+
+        ##
+        # @return [CustomFieldValueModel] All values attached to this email. To retrieve this collection, specify `Attachments` in the "Include" parameter for your query.
+        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

data/lib/lockstep_sdk/models/erp_info_data_model.rb

@@ -0,0 +1,63 @@
+#
+# Lockstep Software Development Kit 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     Ted Spence <tspence@lockstep.io>
+# @author     Manish Narayan B S <manish.n@lockstep.io>
+# @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @version    2022.4
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # Represents all the possible data sent as a part of the provisioning post.
+    # Only send required fields for the given connector.
+    class ErpInfoDataModel
+
+        ##
+        # Initialize the ErpInfoDataModel using the provided prototype
+        def initialize(params = {})
+            @auth_code = params.dig(:auth_code)
+            @realm_id = params.dig(:realm_id)
+            @redirect_uri = params.dig(:redirect_uri)
+        end
+
+        ##
+        # @return [String] The authorization code returned from the first step of the OAuth2 flow https://oauth.net/2/grant-types/authorization-code/
+        attr_accessor :auth_code
+
+        ##
+        # @return [String] The realm id of the account being granted permissions to access
+        attr_accessor :realm_id
+
+        ##
+        # @return [String] The redirect uri used for step one of the OAuth2.0 flow.
+        attr_accessor :redirect_uri
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'authCode' => @auth_code,
+                'realmId' => @realm_id,
+                'redirectUri' => @redirect_uri,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end

data/lib/lockstep_sdk/models/erp_info_model.rb

@@ -0,0 +1,56 @@
+#
+# Lockstep Software Development Kit 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     Ted Spence <tspence@lockstep.io>
+# @author     Manish Narayan B S <manish.n@lockstep.io>
+# @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @version    2022.4
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # Represents the ERP object sent in a provisioning request
+    class ErpInfoModel
+
+        ##
+        # Initialize the ErpInfoModel using the provided prototype
+        def initialize(params = {})
+            @app_id = params.dig(:app_id)
+            @data = params.dig(:data)
+        end
+
+        ##
+        # @return [Uuid] The id of the ERP's App
+        attr_accessor :app_id
+
+        ##
+        # @return [ConnectorInfoModel] The data required to store for connector access
+        attr_accessor :data
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'appId' => @app_id,
+                'data' => @data,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end

data/lib/lockstep_sdk/models/erp_model.rb

@@ -0,0 +1,62 @@
+#
+# Lockstep Software Development Kit 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     Ted Spence <tspence@lockstep.io>
+# @author     Manish Narayan B S <manish.n@lockstep.io>
+# @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @version    2022.4
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # Represents unsupported ERP systems
+    class ErpModel
+
+        ##
+        # Initialize the ErpModel using the provided prototype
+        def initialize(params = {})
+            @erp_system_id = params.dig(:erp_system_id)
+            @name = params.dig(:name)
+            @is_supported = params.dig(:is_supported)
+        end
+
+        ##
+        # @return [Uuid] Unique ID for this ERP
+        attr_accessor :erp_system_id
+
+        ##
+        # @return [String] Name of ERP
+        attr_accessor :name
+
+        ##
+        # @return [Boolean] Flag to indicate if ERP is supported
+        attr_accessor :is_supported
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'erpSystemId' => @erp_system_id,
+                'name' => @name,
+                'isSupported' => @is_supported,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end