lockstep_sdk 2022.4.32.0

data/lib/lockstep_sdk/models/currency_rate_model.rb

@@ -0,0 +1,68 @@
+#
+# 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 a currency rate for specific currencies and date
+    class CurrencyRateModel
+
+        ##
+        # Initialize the CurrencyRateModel using the provided prototype
+        def initialize(params = {})
+            @source_currency = params.dig(:source_currency)
+            @destination_currency = params.dig(:destination_currency)
+            @date = params.dig(:date)
+            @currency_rate = params.dig(:currency_rate)
+        end
+
+        ##
+        # @return [String] The source currency
+        attr_accessor :source_currency
+
+        ##
+        # @return [String] The destination currency
+        attr_accessor :destination_currency
+
+        ##
+        # @return [Date] The date for the currency rate
+        attr_accessor :date
+
+        ##
+        # @return [Double] The currency rate value
+        attr_accessor :currency_rate
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'sourceCurrency' => @source_currency,
+                'destinationCurrency' => @destination_currency,
+                'date' => @date,
+                'currencyRate' => @currency_rate,
+            }
+        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/custom_field_definition_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 Custom Field represents metadata added to an object within the Lockstep Platform.  Lockstep provides a
+    # core definition for each object.  The core definition is intended to represent a level of compatibility
+    # that provides support across most accounting systems and products.  When a user or developer requires
+    # information beyond this core definition, you can use Custom Fields to represent this information.
+    #
+    # See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
+    class CustomFieldDefinitionModel
+
+        ##
+        # Initialize the CustomFieldDefinitionModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @custom_field_definition_id = params.dig(:custom_field_definition_id)
+            @table_key = params.dig(:table_key)
+            @app_id = params.dig(:app_id)
+            @custom_field_label = params.dig(:custom_field_label)
+            @data_type = params.dig(:data_type)
+            @sort_order = params.dig(:sort_order)
+            @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)
+        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.
+        attr_accessor :custom_field_definition_id
+
+        ##
+        # @return [String] Table to which this definition belongs
+        attr_accessor :table_key
+
+        ##
+        # @return [Uuid] Id of app this definition belongs to
+        attr_accessor :app_id
+
+        ##
+        # @return [String] Text to display in-application for custom field
+        attr_accessor :custom_field_label
+
+        ##
+        # @return [String] Data type of this definition
+        attr_accessor :data_type
+
+        ##
+        # @return [Int32] Used for display logic when multiple custom fields exist
+        attr_accessor :sort_order
+
+        ##
+        # @return [Date-time] Date created
+        attr_accessor :created
+
+        ##
+        # @return [Uuid] Id of user who created this definition
+        attr_accessor :created_user_id
+
+        ##
+        # @return [Date-time] Date modified
+        attr_accessor :modified
+
+        ##
+        # @return [Uuid] Id of user who modified this definition
+        attr_accessor :modified_user_id
+
+        ##
+        # @return [Uuid] AppEnrollmentId for this record; used for mapping purposes.
+        attr_accessor :app_enrollment_id
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'customFieldDefinitionId' => @custom_field_definition_id,
+                'tableKey' => @table_key,
+                'appId' => @app_id,
+                'customFieldLabel' => @custom_field_label,
+                'dataType' => @data_type,
+                'sortOrder' => @sort_order,
+                'created' => @created,
+                'createdUserId' => @created_user_id,
+                'modified' => @modified,
+                'modifiedUserId' => @modified_user_id,
+                'appEnrollmentId' => @app_enrollment_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/custom_field_value_model.rb

@@ -0,0 +1,115 @@
+#
+# 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 Custom Field represents metadata added to an object within the Lockstep Platform.  Lockstep provides a
+    # core definition for each object.  The core definition is intended to represent a level of compatibility
+    # that provides support across most accounting systems and products.  When a user or developer requires
+    # information beyond this core definition, you can use Custom Fields to represent this information.
+    #
+    # See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
+    class CustomFieldValueModel
+
+        ##
+        # Initialize the CustomFieldValueModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @custom_field_definition_id = params.dig(:custom_field_definition_id)
+            @record_key = params.dig(:record_key)
+            @string_value = params.dig(:string_value)
+            @numeric_value = params.dig(:numeric_value)
+            @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)
+            @custom_field_definition = params.dig(:custom_field_definition)
+        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.
+        attr_accessor :custom_field_definition_id
+
+        ##
+        # @return [Uuid] Additional key if source table doesn't have a unique id
+        attr_accessor :record_key
+
+        ##
+        # @return [String] String of data for field
+        attr_accessor :string_value
+
+        ##
+        # @return [Double] Number data for field
+        attr_accessor :numeric_value
+
+        ##
+        # @return [Date-time] Date created
+        attr_accessor :created
+
+        ##
+        # @return [Uuid] Id of user who created this value
+        attr_accessor :created_user_id
+
+        ##
+        # @return [Date-time] Date modified
+        attr_accessor :modified
+
+        ##
+        # @return [Uuid] Id of user who modified this value
+        attr_accessor :modified_user_id
+
+        ##
+        # @return [Uuid] AppEnrollmentId for this record; used for mapping purposes.
+        attr_accessor :app_enrollment_id
+
+        ##
+        # @return [CustomFieldDefinitionModel] Definition of the value
+        attr_accessor :custom_field_definition
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'customFieldDefinitionId' => @custom_field_definition_id,
+                'recordKey' => @record_key,
+                'stringValue' => @string_value,
+                'numericValue' => @numeric_value,
+                'created' => @created,
+                'createdUserId' => @created_user_id,
+                'modified' => @modified,
+                'modifiedUserId' => @modified_user_id,
+                'appEnrollmentId' => @app_enrollment_id,
+                'customFieldDefinition' => @custom_field_definition,
+            }
+        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/customer_details_model.rb

@@ -0,0 +1,164 @@
+#
+# 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 customer details data
+    class CustomerDetailsModel
+
+        ##
+        # Initialize the CustomerDetailsModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @customer_id = params.dig(:customer_id)
+            @name = params.dig(:name)
+            @address1 = params.dig(:address1)
+            @address2 = params.dig(:address2)
+            @address3 = params.dig(:address3)
+            @city = params.dig(:city)
+            @state = params.dig(:state)
+            @postal_code = params.dig(:postal_code)
+            @country = params.dig(:country)
+            @phone_number = params.dig(:phone_number)
+            @fax_number = params.dig(:fax_number)
+            @email = params.dig(:email)
+            @contact_id = params.dig(:contact_id)
+            @contact_name = params.dig(:contact_name)
+            @contact_email = params.dig(:contact_email)
+            @outstanding_invoices = params.dig(:outstanding_invoices)
+            @outstanding_amount = params.dig(:outstanding_amount)
+            @amount_past_due = params.dig(:amount_past_due)
+            @payments = params.dig(:payments)
+        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 customer
+        attr_accessor :customer_id
+
+        ##
+        # @return [String] The unique ID of this customer
+        attr_accessor :name
+
+        ##
+        # @return [String] Customer address info
+        attr_accessor :address1
+
+        ##
+        # @return [String] Customer address info
+        attr_accessor :address2
+
+        ##
+        # @return [String] Customer address info
+        attr_accessor :address3
+
+        ##
+        # @return [String] Customer address info
+        attr_accessor :city
+
+        ##
+        # @return [String] Customer address info
+        attr_accessor :state
+
+        ##
+        # @return [String] Customer address info
+        attr_accessor :postal_code
+
+        ##
+        # @return [String] Customer address country
+        attr_accessor :country
+
+        ##
+        # @return [String] Customer phone number
+        attr_accessor :phone_number
+
+        ##
+        # @return [String] Customer fax number
+        attr_accessor :fax_number
+
+        ##
+        # @return [String] Customer AR email address
+        attr_accessor :email
+
+        ##
+        # @return [Uuid] Customer primary contact id
+        attr_accessor :contact_id
+
+        ##
+        # @return [String] Customer primary contact name
+        attr_accessor :contact_name
+
+        ##
+        # @return [String] Customer primary contact email address
+        attr_accessor :contact_email
+
+        ##
+        # @return [Int32] Customer number of outstanding invoices
+        attr_accessor :outstanding_invoices
+
+        ##
+        # @return [Double] Customer total outstanding invoice amount
+        attr_accessor :outstanding_amount
+
+        ##
+        # @return [Double] Customer total past due amount
+        attr_accessor :amount_past_due
+
+        ##
+        # @return [CustomerDetailsPaymentModel] Customer payments collected
+        attr_accessor :payments
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'customerId' => @customer_id,
+                'name' => @name,
+                'address1' => @address1,
+                'address2' => @address2,
+                'address3' => @address3,
+                'city' => @city,
+                'state' => @state,
+                'postalCode' => @postal_code,
+                'country' => @country,
+                'phoneNumber' => @phone_number,
+                'faxNumber' => @fax_number,
+                'email' => @email,
+                'contactId' => @contact_id,
+                'contactName' => @contact_name,
+                'contactEmail' => @contact_email,
+                'outstandingInvoices' => @outstanding_invoices,
+                'outstandingAmount' => @outstanding_amount,
+                'amountPastDue' => @amount_past_due,
+                'payments' => @payments,
+            }
+        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/customer_details_payment_model.rb

@@ -0,0 +1,104 @@
+#
+# 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
+
+    ##
+    # Customer payment collected information
+    class CustomerDetailsPaymentModel
+
+        ##
+        # Initialize the CustomerDetailsPaymentModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @payment_id = params.dig(:payment_id)
+            @payment_applied_id = params.dig(:payment_applied_id)
+            @payment_type = params.dig(:payment_type)
+            @invoice_id = params.dig(:invoice_id)
+            @invoice_type_code = params.dig(:invoice_type_code)
+            @invoice_reference_code = params.dig(:invoice_reference_code)
+            @invoice_total_amount = params.dig(:invoice_total_amount)
+            @payment_date = params.dig(:payment_date)
+            @payment_amount = params.dig(:payment_amount)
+        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] Unique identifier for payment
+        attr_accessor :payment_id
+
+        ##
+        # @return [Uuid] Unique identifier for payment applied
+        attr_accessor :payment_applied_id
+
+        ##
+        # @return [String] Payment type
+        attr_accessor :payment_type
+
+        ##
+        # @return [Uuid] Unique identifier for invoice payment is associated with
+        attr_accessor :invoice_id
+
+        ##
+        # @return [String] Invoice type payment is associated with
+        attr_accessor :invoice_type_code
+
+        ##
+        # @return [String] Invoice reference code payment is associated with
+        attr_accessor :invoice_reference_code
+
+        ##
+        # @return [Double] Invoice total amount payment is associated with
+        attr_accessor :invoice_total_amount
+
+        ##
+        # @return [Date-time] Date payment placed
+        attr_accessor :payment_date
+
+        ##
+        # @return [Double] Amount payment was made for
+        attr_accessor :payment_amount
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'paymentId' => @payment_id,
+                'paymentAppliedId' => @payment_applied_id,
+                'paymentType' => @payment_type,
+                'invoiceId' => @invoice_id,
+                'invoiceTypeCode' => @invoice_type_code,
+                'invoiceReferenceCode' => @invoice_reference_code,
+                'invoiceTotalAmount' => @invoice_total_amount,
+                'paymentDate' => @payment_date,
+                'paymentAmount' => @payment_amount,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end