lockstep_sdk 2022.4.32.0

data/lib/lockstep_sdk/models/invoice_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 an invoice
+    class InvoiceSummaryModel
+
+        ##
+        # Initialize the InvoiceSummaryModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @customer_id = params.dig(:customer_id)
+            @invoice_id = params.dig(:invoice_id)
+            @invoice_number = params.dig(:invoice_number)
+            @invoice_date = params.dig(:invoice_date)
+            @customer_name = params.dig(:customer_name)
+            @status = params.dig(:status)
+            @payment_due_date = params.dig(:payment_due_date)
+            @invoice_amount = params.dig(:invoice_amount)
+            @outstanding_balance = params.dig(:outstanding_balance)
+            @invoice_type_code = params.dig(:invoice_type_code)
+            @newest_activity = params.dig(:newest_activity)
+            @days_past_due = params.dig(:days_past_due)
+            @payment_numbers = params.dig(:payment_numbers)
+            @payment_ids = params.dig(:payment_ids)
+        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 ID number of the counterparty for the invoice, for example, a customer or vendor.
+        attr_accessor :customer_id
+
+        ##
+        # @return [Uuid] The unique ID number of this invoice.
+        attr_accessor :invoice_id
+
+        ##
+        # @return [String] A reference code that is used to identify this invoice. The meaning of this field is specific to the ERP or accounting system used by the user.
+        attr_accessor :invoice_number
+
+        ##
+        # @return [Date] The reporting date for this invoice.
+        attr_accessor :invoice_date
+
+        ##
+        # @return [String] The name of the counterparty for the invoice, for example, a customer or vendor.
+        attr_accessor :customer_name
+
+        ##
+        # @return [String] The status of the invoice.
+        attr_accessor :status
+
+        ##
+        # @return [Date] The due date of the invoice.
+        attr_accessor :payment_due_date
+
+        ##
+        # @return [Double] The total amount of the Invoice.
+        attr_accessor :invoice_amount
+
+        ##
+        # @return [Double] The remaining balance value of this invoice.
+        attr_accessor :outstanding_balance
+
+        ##
+        # @return [String] A code identifying the type of this Invoice.
+        attr_accessor :invoice_type_code
+
+        ##
+        # @return [Date] The date stamp for the newest Activity on this Invoice.
+        attr_accessor :newest_activity
+
+        ##
+        # @return [Int32] The number of days this Invoice is past due.
+        attr_accessor :days_past_due
+
+        ##
+        # @return [String] The memo text of the payments associated to this invoice.
+        attr_accessor :payment_numbers
+
+        ##
+        # @return [Uuid] The ids of the payments associated to this invoice.
+        attr_accessor :payment_ids
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'customerId' => @customer_id,
+                'invoiceId' => @invoice_id,
+                'invoiceNumber' => @invoice_number,
+                'invoiceDate' => @invoice_date,
+                'customerName' => @customer_name,
+                'status' => @status,
+                'paymentDueDate' => @payment_due_date,
+                'invoiceAmount' => @invoice_amount,
+                'outstandingBalance' => @outstanding_balance,
+                'invoiceTypeCode' => @invoice_type_code,
+                'newestActivity' => @newest_activity,
+                'daysPastDue' => @days_past_due,
+                'paymentNumbers' => @payment_numbers,
+                'paymentIds' => @payment_ids,
+            }
+        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/lead_model.rb

@@ -0,0 +1,74 @@
+#
+# 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 leads for creating new ERP connectors
+    class LeadModel
+
+        ##
+        # Initialize the LeadModel using the provided prototype
+        def initialize(params = {})
+            @lead_id = params.dig(:lead_id)
+            @name = params.dig(:name)
+            @company = params.dig(:company)
+            @email = params.dig(:email)
+            @erp_system = params.dig(:erp_system)
+        end
+
+        ##
+        # @return [Uuid] The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.
+        attr_accessor :lead_id
+
+        ##
+        # @return [String] Name of lead
+        attr_accessor :name
+
+        ##
+        # @return [String] Name of company of lead
+        attr_accessor :company
+
+        ##
+        # @return [String] Email of lead
+        attr_accessor :email
+
+        ##
+        # @return [String] Requested ERP of lead
+        attr_accessor :erp_system
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'leadId' => @lead_id,
+                'name' => @name,
+                'company' => @company,
+                'email' => @email,
+                'erpSystem' => @erp_system,
+            }
+        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/note_model.rb

@@ -0,0 +1,121 @@
+#
+# 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
+
+    ##
+    # A note is a customizable text string that can be attached to various account attributes
+    # within Lockstep. You can use notes for internal communication, correspondence with
+    # clients, or personal reminders. The Note Model represents a note and a number of
+    # different metadata attributes related to the creation, storage, and ownership of the note.
+    #
+    # See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
+    class NoteModel
+
+        ##
+        # Initialize the NoteModel using the provided prototype
+        def initialize(params = {})
+            @note_id = params.dig(:note_id)
+            @group_key = params.dig(:group_key)
+            @table_key = params.dig(:table_key)
+            @object_key = params.dig(:object_key)
+            @note_text = params.dig(:note_text)
+            @note_type = params.dig(:note_type)
+            @is_archived = params.dig(:is_archived)
+            @created = params.dig(:created)
+            @created_user_id = params.dig(:created_user_id)
+            @created_user_name = params.dig(:created_user_name)
+            @app_enrollment_id = params.dig(:app_enrollment_id)
+            @recipient_name = params.dig(:recipient_name)
+        end
+
+        ##
+        # @return [Uuid] The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.
+        attr_accessor :note_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 [String] The name of the table the note is associated with
+        attr_accessor :table_key
+
+        ##
+        # @return [Uuid] The ID of the object the note is associated with
+        attr_accessor :object_key
+
+        ##
+        # @return [String] The text of the note
+        attr_accessor :note_text
+
+        ##
+        # @return [String] The type of the note
+        attr_accessor :note_type
+
+        ##
+        # @return [Boolean] Flag indicating if the note has been archived
+        attr_accessor :is_archived
+
+        ##
+        # @return [Date-time] The date the note was created
+        attr_accessor :created
+
+        ##
+        # @return [Uuid] The ID of the user who created the note
+        attr_accessor :created_user_id
+
+        ##
+        # @return [String] The name of the user who created the note
+        attr_accessor :created_user_name
+
+        ##
+        # @return [Uuid] AppEnrollmentId for this record; used for mapping purposes.
+        attr_accessor :app_enrollment_id
+
+        ##
+        # @return [String] The person to whom this note is intended for.
+        attr_accessor :recipient_name
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'noteId' => @note_id,
+                'groupKey' => @group_key,
+                'tableKey' => @table_key,
+                'objectKey' => @object_key,
+                'noteText' => @note_text,
+                'noteType' => @note_type,
+                'isArchived' => @is_archived,
+                'created' => @created,
+                'createdUserId' => @created_user_id,
+                'createdUserName' => @created_user_name,
+                'appEnrollmentId' => @app_enrollment_id,
+                'recipientName' => @recipient_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/payment_applied_model.rb

@@ -0,0 +1,131 @@
+#
+# 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
+
+    ##
+    # A Payment Application is created by a business who receives a Payment from a customer.  A customer may make
+    # a single Payment to match an Invoice exactly, a partial Payment for an Invoice, or a single Payment may be
+    # made for multiple smaller Invoices.  The Payment Application contains information about which Invoices are connected
+    # to which Payments and for which amounts.
+    class PaymentAppliedModel
+
+        ##
+        # Initialize the PaymentAppliedModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @payment_applied_id = params.dig(:payment_applied_id)
+            @invoice_id = params.dig(:invoice_id)
+            @payment_id = params.dig(:payment_id)
+            @erp_key = params.dig(:erp_key)
+            @entry_number = params.dig(:entry_number)
+            @apply_to_invoice_date = params.dig(:apply_to_invoice_date)
+            @payment_applied_amount = params.dig(:payment_applied_amount)
+            @created = params.dig(:created)
+            @created_user_id = params.dig(:created_user_id)
+            @modified = params.dig(:modified)
+            @modified_user_id = params.dig(:modified_user_id)
+            @app_enrollment_id = params.dig(:app_enrollment_id)
+            @invoice = params.dig(:invoice)
+        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 record, automatically assigned by Lockstep when this record is added to the Lockstep platform. For the ID of this record in its originating financial system, see `ErpKey`.
+        attr_accessor :payment_applied_id
+
+        ##
+        # @return [Uuid] The Invoice this payment is applied to.
+        attr_accessor :invoice_id
+
+        ##
+        # @return [Uuid] The Payment applied to the invoice.
+        attr_accessor :payment_id
+
+        ##
+        # @return [String] The unique ID of this record as it was known in its originating financial system. If this company record was imported from a financial system, it will have the value `ErpKey` set to the original primary key number of the record as it was known in the originating financial system. If this record was not imported, this value will be `null`. For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
+        attr_accessor :erp_key
+
+        ##
+        # @return [Int32] Reference number for the payment applied.
+        attr_accessor :entry_number
+
+        ##
+        # @return [Date-time] Date payment applied to invoice.
+        attr_accessor :apply_to_invoice_date
+
+        ##
+        # @return [Double] Amount applied to invoice.
+        attr_accessor :payment_applied_amount
+
+        ##
+        # @return [Date-time] Date payment applied record was created.
+        attr_accessor :created
+
+        ##
+        # @return [Uuid] The id of the user who created this applied payment.
+        attr_accessor :created_user_id
+
+        ##
+        # @return [Date-time] Date payment applied record was modified.
+        attr_accessor :modified
+
+        ##
+        # @return [Uuid] The id of the user who modified this applied payment.
+        attr_accessor :modified_user_id
+
+        ##
+        # @return [Uuid] AppEnrollmentId for this record; used for mapping purposes.
+        attr_accessor :app_enrollment_id
+
+        ##
+        # @return [InvoiceModel] The invoice associated with this applied payment.
+        attr_accessor :invoice
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'paymentAppliedId' => @payment_applied_id,
+                'invoiceId' => @invoice_id,
+                'paymentId' => @payment_id,
+                'erpKey' => @erp_key,
+                'entryNumber' => @entry_number,
+                'applyToInvoiceDate' => @apply_to_invoice_date,
+                'paymentAppliedAmount' => @payment_applied_amount,
+                'created' => @created,
+                'createdUserId' => @created_user_id,
+                'modified' => @modified,
+                'modifiedUserId' => @modified_user_id,
+                'appEnrollmentId' => @app_enrollment_id,
+                'invoice' => @invoice,
+            }
+        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/payment_detail_header_model.rb

@@ -0,0 +1,80 @@
+#
+# 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 group level payment data.
+    class PaymentDetailHeaderModel
+
+        ##
+        # Initialize the PaymentDetailHeaderModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @customer_count = params.dig(:customer_count)
+            @amount_collected = params.dig(:amount_collected)
+            @unapplied_amount = params.dig(:unapplied_amount)
+            @paid_invoice_count = params.dig(:paid_invoice_count)
+            @open_invoice_count = params.dig(:open_invoice_count)
+        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 [Int32] The total number of Customers.
+        attr_accessor :customer_count
+
+        ##
+        # @return [Double] The total amount collected.
+        attr_accessor :amount_collected
+
+        ##
+        # @return [Double] The total unapplied amount.
+        attr_accessor :unapplied_amount
+
+        ##
+        # @return [Int32] The number of paid invoices.
+        attr_accessor :paid_invoice_count
+
+        ##
+        # @return [Int32] The number of open invoices.
+        attr_accessor :open_invoice_count
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'customerCount' => @customer_count,
+                'amountCollected' => @amount_collected,
+                'unappliedAmount' => @unapplied_amount,
+                'paidInvoiceCount' => @paid_invoice_count,
+                'openInvoiceCount' => @open_invoice_count,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end