lockstep_sdk 2022.4.32.0

data/lib/lockstep_sdk/models/payment_detail_model.rb

@@ -0,0 +1,176 @@
+#
+# 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 detailed information about a Payment.
+    class PaymentDetailModel
+
+        ##
+        # Initialize the PaymentDetailModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @payment_id = params.dig(:payment_id)
+            @customer_id = params.dig(:customer_id)
+            @customer_name = params.dig(:customer_name)
+            @memo_text = params.dig(:memo_text)
+            @reference_code = params.dig(:reference_code)
+            @primary_contact = params.dig(:primary_contact)
+            @email = params.dig(:email)
+            @payment_amount = params.dig(:payment_amount)
+            @unapplied_amount = params.dig(:unapplied_amount)
+            @payment_type = params.dig(:payment_type)
+            @payment_date = params.dig(:payment_date)
+            @post_date = params.dig(:post_date)
+            @phone = params.dig(:phone)
+            @fax = params.dig(:fax)
+            @address1 = params.dig(:address1)
+            @address2 = params.dig(:address2)
+            @address3 = params.dig(:address3)
+            @city = params.dig(:city)
+            @state_region = params.dig(:state_region)
+            @postal_code = params.dig(:postal_code)
+            @country_code = params.dig(:country_code)
+        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 Payment.
+        attr_accessor :payment_id
+
+        ##
+        # @return [Uuid] The ID of the customer to which this Payment belongs.
+        attr_accessor :customer_id
+
+        ##
+        # @return [String] The name of the customer to which this Payment belongs.
+        attr_accessor :customer_name
+
+        ##
+        # @return [String] Memo or reference text (ex. memo field on a check).
+        attr_accessor :memo_text
+
+        ##
+        # @return [String] Reference code for the payment for the given Erp system.
+        attr_accessor :reference_code
+
+        ##
+        # @return [String] The name of the Primary Contact for the Customer.
+        attr_accessor :primary_contact
+
+        ##
+        # @return [String] The Email address of the Customer.
+        attr_accessor :email
+
+        ##
+        # @return [Double] Total amount of this Payment.
+        attr_accessor :payment_amount
+
+        ##
+        # @return [Double] Unapplied balance of this Payment.
+        attr_accessor :unapplied_amount
+
+        ##
+        # @return [String] The type of payment, Payment or AP Payment.
+        attr_accessor :payment_type
+
+        ##
+        # @return [Date] The date of this Payment.
+        attr_accessor :payment_date
+
+        ##
+        # @return [Date] Payment post date.
+        attr_accessor :post_date
+
+        ##
+        # @return [String] The phone number of the Customer's Primary Contact.
+        attr_accessor :phone
+
+        ##
+        # @return [String] The fax number of the Customer's Primary Contact.
+        attr_accessor :fax
+
+        ##
+        # @return [String] The first line of the address for the Customer's Primary Contact.
+        attr_accessor :address1
+
+        ##
+        # @return [String] The second line of the address for the Customer's Primary Contact.
+        attr_accessor :address2
+
+        ##
+        # @return [String] The third line of the address for the Customer's Primary Contact.
+        attr_accessor :address3
+
+        ##
+        # @return [String] The city of the address for the Customer's Primary Contact.
+        attr_accessor :city
+
+        ##
+        # @return [String] The state/region of the address for the Customer's Primary Contact.
+        attr_accessor :state_region
+
+        ##
+        # @return [String] The postal/zip code of the address for the Customer's Primary Contact.
+        attr_accessor :postal_code
+
+        ##
+        # @return [String] The 2 character country code of the address for the Customer's Primary Contact.
+        attr_accessor :country_code
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'paymentId' => @payment_id,
+                'customerId' => @customer_id,
+                'customerName' => @customer_name,
+                'memoText' => @memo_text,
+                'referenceCode' => @reference_code,
+                'primaryContact' => @primary_contact,
+                'email' => @email,
+                'paymentAmount' => @payment_amount,
+                'unappliedAmount' => @unapplied_amount,
+                'paymentType' => @payment_type,
+                'paymentDate' => @payment_date,
+                'postDate' => @post_date,
+                'phone' => @phone,
+                'fax' => @fax,
+                'address1' => @address1,
+                'address2' => @address2,
+                'address3' => @address3,
+                'city' => @city,
+                'stateRegion' => @state_region,
+                'postalCode' => @postal_code,
+                'countryCode' => @country_code,
+            }
+        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_model.rb

@@ -0,0 +1,206 @@
+#
+# 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 represents money sent from one company to another.  A single payment may contain payments for
+    # one or more invoices; it is also possible for payments to be made in advance of an invoice, for example,
+    # as a deposit.  The creator of the Payment is identified by the `CustomerId` field, and the recipient of
+    # the Payment is identified by the `CompanyId` field.  Most Payments are uniquely identified both by a
+    # Lockstep Platform ID number and a customer ERP "key" that was generated by the system that originated
+    # the Payment.  Payments that have not been fully applied have a nonzero `UnappliedAmount` value, which
+    # represents a deposit that has been paid and not yet applied to an Invoice.
+    class PaymentModel
+
+        ##
+        # Initialize the PaymentModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @payment_id = params.dig(:payment_id)
+            @company_id = params.dig(:company_id)
+            @erp_key = params.dig(:erp_key)
+            @payment_type = params.dig(:payment_type)
+            @tender_type = params.dig(:tender_type)
+            @is_open = params.dig(:is_open)
+            @memo_text = params.dig(:memo_text)
+            @payment_date = params.dig(:payment_date)
+            @post_date = params.dig(:post_date)
+            @payment_amount = params.dig(:payment_amount)
+            @unapplied_amount = params.dig(:unapplied_amount)
+            @currency_code = params.dig(:currency_code)
+            @reference_code = params.dig(:reference_code)
+            @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)
+            @is_voided = params.dig(:is_voided)
+            @in_dispute = params.dig(:in_dispute)
+            @applications = params.dig(:applications)
+            @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 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_id
+
+        ##
+        # @return [Uuid] The ID of the company to which this payment belongs.
+        attr_accessor :company_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 [String] The type of payment, cash or check.
+        attr_accessor :payment_type
+
+        ##
+        # @return [String] Cash, check, credit card, wire transfer.
+        attr_accessor :tender_type
+
+        ##
+        # @return [Boolean] Has the payment been fully applied?
+        attr_accessor :is_open
+
+        ##
+        # @return [String] Memo or reference text (ex. memo field on a check).
+        attr_accessor :memo_text
+
+        ##
+        # @return [Date] The date of this payment.
+        attr_accessor :payment_date
+
+        ##
+        # @return [Date] Payment post date.
+        attr_accessor :post_date
+
+        ##
+        # @return [Double] Total amount of this payment.
+        attr_accessor :payment_amount
+
+        ##
+        # @return [Double] Unapplied balance of this payment.
+        attr_accessor :unapplied_amount
+
+        ##
+        # @return [String] Currency of the payment. This will be validated by the /api/v1/currencies data set
+        attr_accessor :currency_code
+
+        ##
+        # @return [String] Reference code for the payment for the given Erp system.
+        attr_accessor :reference_code
+
+        ##
+        # @return [Date-time] The date on which this record was created.
+        attr_accessor :created
+
+        ##
+        # @return [Uuid] The ID of the user who created this payment.
+        attr_accessor :created_user_id
+
+        ##
+        # @return [Date-time] The date on which this record was last modified.
+        attr_accessor :modified
+
+        ##
+        # @return [Uuid] The ID of the user who last modified this payment.
+        attr_accessor :modified_user_id
+
+        ##
+        # @return [Uuid] AppEnrollmentId for this record; used for mapping purposes.
+        attr_accessor :app_enrollment_id
+
+        ##
+        # @return [Boolean] Is the payment voided?
+        attr_accessor :is_voided
+
+        ##
+        # @return [Boolean] Is the payment in dispute?
+        attr_accessor :in_dispute
+
+        ##
+        # @return [PaymentAppliedModel] All applications this payment is associated with. To retrieve this collection, specify `Applications` in the "Include" parameter for your query.
+        attr_accessor :applications
+
+        ##
+        # @return [NoteModel] All notes attached to this payment. To retrieve this collection, specify `Notes` in the "Include" parameter for your query.
+        attr_accessor :notes
+
+        ##
+        # @return [AttachmentModel] All attachments attached to this payment. To retrieve this collection, specify `Attachments` in the "Include" parameter for your query.
+        attr_accessor :attachments
+
+        ##
+        # @return [CustomFieldDefinitionModel] All definitions attached to this payment. 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 payment. To retrieve this collection, specify `CustomFieldValues` 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={})
+            {
+                'groupKey' => @group_key,
+                'paymentId' => @payment_id,
+                'companyId' => @company_id,
+                'erpKey' => @erp_key,
+                'paymentType' => @payment_type,
+                'tenderType' => @tender_type,
+                'isOpen' => @is_open,
+                'memoText' => @memo_text,
+                'paymentDate' => @payment_date,
+                'postDate' => @post_date,
+                'paymentAmount' => @payment_amount,
+                'unappliedAmount' => @unapplied_amount,
+                'currencyCode' => @currency_code,
+                'referenceCode' => @reference_code,
+                'created' => @created,
+                'createdUserId' => @created_user_id,
+                'modified' => @modified,
+                'modifiedUserId' => @modified_user_id,
+                'appEnrollmentId' => @app_enrollment_id,
+                'isVoided' => @is_voided,
+                'inDispute' => @in_dispute,
+                'applications' => @applications,
+                '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/payment_summary_model.rb

@@ -0,0 +1,128 @@
+#
+# 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 summary information for a Payment
+    class PaymentSummaryModel
+
+        ##
+        # Initialize the PaymentSummaryModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @payment_id = params.dig(:payment_id)
+            @memo_text = params.dig(:memo_text)
+            @reference_code = params.dig(:reference_code)
+            @payment_type = params.dig(:payment_type)
+            @payment_date = params.dig(:payment_date)
+            @payment_amount = params.dig(:payment_amount)
+            @unapplied_amount = params.dig(:unapplied_amount)
+            @invoice_count = params.dig(:invoice_count)
+            @total_payments_applied = params.dig(:total_payments_applied)
+            @invoice_list = params.dig(:invoice_list)
+            @invoice_id_list = params.dig(:invoice_id_list)
+            @customer_name = params.dig(:customer_name)
+            @customer_id = params.dig(:customer_id)
+        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 of the payment
+        attr_accessor :payment_id
+
+        ##
+        # @return [String] Memo or reference text (ex. memo field on a check).
+        attr_accessor :memo_text
+
+        ##
+        # @return [String] Reference code for the payment for the given Erp system.
+        attr_accessor :reference_code
+
+        ##
+        # @return [String] The type of payment, Payment or AP Payment.
+        attr_accessor :payment_type
+
+        ##
+        # @return [Date] The date of this payment.
+        attr_accessor :payment_date
+
+        ##
+        # @return [Double] Total amount of this payment.
+        attr_accessor :payment_amount
+
+        ##
+        # @return [Double] Unapplied balance of this payment.
+        attr_accessor :unapplied_amount
+
+        ##
+        # @return [Int32] The number of invoices associated to this payment.
+        attr_accessor :invoice_count
+
+        ##
+        # @return [Double] The number of payments applied to this payment.
+        attr_accessor :total_payments_applied
+
+        ##
+        # @return [String] The reference codes of the invoices associated to this payment.
+        attr_accessor :invoice_list
+
+        ##
+        # @return [Uuid] The ids of the invoices associated to this payment.
+        attr_accessor :invoice_id_list
+
+        ##
+        # @return [String] The name of the customer for this payment.
+        attr_accessor :customer_name
+
+        ##
+        # @return [Uuid] The id of the customer for this payment.
+        attr_accessor :customer_id
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'paymentId' => @payment_id,
+                'memoText' => @memo_text,
+                'referenceCode' => @reference_code,
+                'paymentType' => @payment_type,
+                'paymentDate' => @payment_date,
+                'paymentAmount' => @payment_amount,
+                'unappliedAmount' => @unapplied_amount,
+                'invoiceCount' => @invoice_count,
+                'totalPaymentsApplied' => @total_payments_applied,
+                'invoiceList' => @invoice_list,
+                'invoiceIdList' => @invoice_id_list,
+                'customerName' => @customer_name,
+                'customerId' => @customer_id,
+            }
+        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/provisioning_finalize_request_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 the data to finalize onboarding for a user
+    class ProvisioningFinalizeRequestModel
+
+        ##
+        # Initialize the ProvisioningFinalizeRequestModel using the provided prototype
+        def initialize(params = {})
+            @full_name = params.dig(:full_name)
+            @time_zone = params.dig(:time_zone)
+            @default_currency = params.dig(:default_currency)
+            @company = params.dig(:company)
+            @email_connector = params.dig(:email_connector)
+        end
+
+        ##
+        # @return [String] The full name of the user
+        attr_accessor :full_name
+
+        ##
+        # @return [String] The time zone of the user
+        attr_accessor :time_zone
+
+        ##
+        # @return [String] The default currency of the user
+        attr_accessor :default_currency
+
+        ##
+        # @return [CompanyModel] The company information for the user and group
+        attr_accessor :company
+
+        ##
+        # @return [ErpInfoModel] Optional connector information needed to enroll user to their email connector
+        attr_accessor :email_connector
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'fullName' => @full_name,
+                'timeZone' => @time_zone,
+                'defaultCurrency' => @default_currency,
+                'company' => @company,
+                'emailConnector' => @email_connector,
+            }
+        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/provisioning_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 the data sent during the onboarding flow
+    class ProvisioningModel
+
+        ##
+        # Initialize the ProvisioningModel using the provided prototype
+        def initialize(params = {})
+            @full_name = params.dig(:full_name)
+            @time_zone = params.dig(:time_zone)
+            @default_currency = params.dig(:default_currency)
+            @erp = params.dig(:erp)
+            @company = params.dig(:company)
+        end
+
+        ##
+        # @return [String] The full name of the new user
+        attr_accessor :full_name
+
+        ##
+        # @return [String] The time zone of the new user
+        attr_accessor :time_zone
+
+        ##
+        # @return [String] The default currency of the new user
+        attr_accessor :default_currency
+
+        ##
+        # @return [ErpInfoModel] The information necessary to enroll the user in their ERP
+        attr_accessor :erp
+
+        ##
+        # @return [CompanyModel] The company information for the new user and group
+        attr_accessor :company
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'fullName' => @full_name,
+                'timeZone' => @time_zone,
+                'defaultCurrency' => @default_currency,
+                'erp' => @erp,
+                'company' => @company,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end