lockstep_sdk 2022.15.31.1 → 2022.26.12.0

data/lib/lockstep_sdk/models/payables_coming_due_header_model.rb

@@ -0,0 +1,77 @@
+#
+# 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
+
+    ##
+    # Contains summary information for payables that will be due soon
+    class PayablesComingDueHeaderModel
+
+        ##
+        # Initialize the PayablesComingDueHeaderModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @number_of_bills_due = params.dig(:number_of_bills_due)
+            @number_of_vendors = params.dig(:number_of_vendors)
+            @percentage_of_total = params.dig(:percentage_of_total)
+            @total_amount_due = params.dig(:total_amount_due)
+            @due_date = params.dig(:due_date)
+        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] Number of bills due for this time period
+        attr_accessor :number_of_bills_due
+
+        ##
+        # @return [Int32] Number of total vendors for this time period
+        attr_accessor :number_of_vendors
+
+        ##
+        # @return [Double] Percentage of total for this time period
+        attr_accessor :percentage_of_total
+
+        ##
+        # @return [Double] Total amount due for this time period
+        attr_accessor :total_amount_due
+
+        ##
+        # @return [Date-time] This model represents all the payables that are either already due or due within this date.
+        attr_accessor :due_date
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'numberOfBillsDue' => @number_of_bills_due,
+                'numberOfVendors' => @number_of_vendors,
+                'percentageOfTotal' => @percentage_of_total,
+                'totalAmountDue' => @total_amount_due,
+                'dueDate' => @due_date,
+            }
+        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/payables_coming_due_model.rb

@@ -0,0 +1,89 @@
+#
+# 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
+
+    ##
+    # Contains information for payables that will be due soon
+    class PayablesComingDueModel
+
+        ##
+        # Initialize the PayablesComingDueModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @number_of_bills_due = params.dig(:number_of_bills_due)
+            @vendor_id = params.dig(:vendor_id)
+            @vendor_name = params.dig(:vendor_name)
+            @primary_contact = params.dig(:primary_contact)
+            @percentage_of_total = params.dig(:percentage_of_total)
+            @total_amount_due = params.dig(:total_amount_due)
+            @due_date = params.dig(:due_date)
+        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] Number of bills due for this time period
+        attr_accessor :number_of_bills_due
+
+        ##
+        # @return [Uuid] The unique Lockstep Id for the Vendor
+        attr_accessor :vendor_id
+
+        ##
+        # @return [String] Name for this company
+        attr_accessor :vendor_name
+
+        ##
+        # @return [String] Primary Contact for this company
+        attr_accessor :primary_contact
+
+        ##
+        # @return [Double] Percentage of total for this time period
+        attr_accessor :percentage_of_total
+
+        ##
+        # @return [Double] Total amount due for this time period
+        attr_accessor :total_amount_due
+
+        ##
+        # @return [Date-time] This model represents all the payables that are either already due or due within this date.
+        attr_accessor :due_date
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'numberOfBillsDue' => @number_of_bills_due,
+                'vendorId' => @vendor_id,
+                'vendorName' => @vendor_name,
+                'primaryContact' => @primary_contact,
+                'percentageOfTotal' => @percentage_of_total,
+                'totalAmountDue' => @total_amount_due,
+                'dueDate' => @due_date,
+            }
+        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/payables_coming_due_widget_model.rb

@@ -0,0 +1,59 @@
+#
+# 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
+
+    ##
+    # Contains summary information for payables for the widget
+    class PayablesComingDueWidgetModel
+
+        ##
+        # Initialize the PayablesComingDueWidgetModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @date = params.dig(:date)
+            @amount_due = params.dig(:amount_due)
+        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 [Date-time] This model represents all the payables that are either already due or due within this date.
+        attr_accessor :date
+
+        ##
+        # @return [Double] Total amount due for this time period
+        attr_accessor :amount_due
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'date' => @date,
+                'amountDue' => @amount_due,
+            }
+        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/payables_summary_report_model.rb

@@ -0,0 +1,77 @@
+#
+# 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
+
+    ##
+    # Represents the payables summary report based on a timeframe
+    class PayablesSummaryReportModel
+
+        ##
+        # Initialize the PayablesSummaryReportModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @timeframe = params.dig(:timeframe)
+            @total_payments_amount = params.dig(:total_payments_amount)
+            @total_payments_count = params.dig(:total_payments_count)
+            @total_amount_billed = params.dig(:total_amount_billed)
+            @total_bills_count = params.dig(:total_bills_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] Timeframe in days the payables summary report is generated on
+        attr_accessor :timeframe
+
+        ##
+        # @return [Double] Amount of payments made based in the timeframe
+        attr_accessor :total_payments_amount
+
+        ##
+        # @return [Int32] Number of payments made based in the timeframe
+        attr_accessor :total_payments_count
+
+        ##
+        # @return [Double] Amount of bills received based in the timeframe
+        attr_accessor :total_amount_billed
+
+        ##
+        # @return [Int32] Number of bills received in the timeframe
+        attr_accessor :total_bills_count
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'timeframe' => @timeframe,
+                'totalPaymentsAmount' => @total_payments_amount,
+                'totalPaymentsCount' => @total_payments_count,
+                'totalAmountBilled' => @total_amount_billed,
+                'totalBillsCount' => @total_bills_count,
+            }
+        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

@@ -39,6 +39,7 @@ module LockstepSdk
             @modified = params.dig(:modified)
             @modified_user_id = params.dig(:modified_user_id)
             @app_enrollment_id = params.dig(:app_enrollment_id)
+            @payment = params.dig(:payment)
             @invoice = params.dig(:invoice)
         end
 
@@ -94,6 +95,10 @@ module LockstepSdk
         # @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 [PaymentModel] The payment associated with this applied payment
+        attr_accessor :payment
+
         ##
         # @return [InvoiceModel] The invoice associated with this applied payment.
         attr_accessor :invoice
@@ -115,6 +120,7 @@ module LockstepSdk
                 'modified' => @modified,
                 'modifiedUserId' => @modified_user_id,
                 'appEnrollmentId' => @app_enrollment_id,
+                'payment' => @payment,
                 'invoice' => @invoice,
             }
         end

data/lib/lockstep_sdk/models/payment_detail_model.rb

@@ -34,6 +34,7 @@ module LockstepSdk
             @payment_amount = params.dig(:payment_amount)
             @unapplied_amount = params.dig(:unapplied_amount)
             @payment_type = params.dig(:payment_type)
+            @tender_type = params.dig(:tender_type)
             @payment_date = params.dig(:payment_date)
             @post_date = params.dig(:post_date)
             @phone = params.dig(:phone)
@@ -88,9 +89,13 @@ module LockstepSdk
         attr_accessor :unapplied_amount
 
         ##
-        # @return [String] The type of payment, Payment or AP Payment.
+        # @return [String] The type of payment, AR Payment or AP Payment. Recognized PaymentType values are: * `AR Payment` - A payment made by a Customer to the Company * `AP Payment` - A payment made by the Company to a Vendor
         attr_accessor :payment_type
 
+        ##
+        # @return [String] Cash, check, credit card, wire transfer. Recognized TenderType values are: * `Cash` - A cash payment or other direct transfer. * `Check` - A check payment. * `Credit Card` - A payment made via a credit card. * `Wire Transfer` - A payment made via wire transfer from another financial institution. * `Other` - A payment made via another method not listed above.
+        attr_accessor :tender_type
+
         ##
         # @return [Date] The date of this Payment.
         attr_accessor :payment_date
@@ -150,6 +155,7 @@ module LockstepSdk
                 'paymentAmount' => @payment_amount,
                 'unappliedAmount' => @unapplied_amount,
                 'paymentType' => @payment_type,
+                'tenderType' => @tender_type,
                 'paymentDate' => @payment_date,
                 'postDate' => @post_date,
                 'phone' => @phone,

data/lib/lockstep_sdk/models/payment_model.rb

@@ -74,11 +74,11 @@ module LockstepSdk
         attr_accessor :erp_key
 
         ##
-        # @return [String] The type of payment, cash or check. Recognized PaymentType values are: * `Cash` - A cash payment or other direct transfer. * `Check` - A check payment.
+        # @return [String] The type of payment, AR Payment or AP Payment. Recognized PaymentType values are: * `AR Payment` - A payment made by a Customer to the Company * `AP Payment` - A payment made by the Company to a Vendor
         attr_accessor :payment_type
 
         ##
-        # @return [String] Cash, check, credit card, wire transfer. Recognized TenderType values are: * `Cash` - A cash payment or other direct transfer. * `Check` - A check payment. * `Credit Card` - A payment made via a credit card. * `Wire Transfer` - A payment made via wire transfer from another financial institution.
+        # @return [String] Cash, check, credit card, wire transfer. Recognized TenderType values are: * `Cash` - A cash payment or other direct transfer. * `Check` - A check payment. * `Credit Card` - A payment made via a credit card. * `Wire Transfer` - A payment made via wire transfer from another financial institution. * `Other` - A payment made via another method not listed above.
         attr_accessor :tender_type
 
         ##

data/lib/lockstep_sdk/models/payment_summary_model.rb

@@ -27,16 +27,22 @@ module LockstepSdk
             @payment_id = params.dig(:payment_id)
             @memo_text = params.dig(:memo_text)
             @reference_code = params.dig(:reference_code)
+            @tender_type = params.dig(:tender_type)
             @payment_type = params.dig(:payment_type)
             @payment_date = params.dig(:payment_date)
             @payment_amount = params.dig(:payment_amount)
             @unapplied_amount = params.dig(:unapplied_amount)
+            @is_open = params.dig(:is_open)
             @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)
+            @payment_company_id = params.dig(:payment_company_id)
+            @payment_company_name = params.dig(:payment_company_name)
+            @customer_ids = params.dig(:customer_ids)
+            @customer_names = params.dig(:customer_names)
+            @company_ids = params.dig(:company_ids)
+            @company_names = params.dig(:company_names)
         end
 
         ##
@@ -56,7 +62,11 @@ module LockstepSdk
         attr_accessor :reference_code
 
         ##
-        # @return [String] The type of payment, Payment or AP Payment.
+        # @return [String] The tender type of payment (Cash, Check, etc.)
+        attr_accessor :tender_type
+
+        ##
+        # @return [String] The type of payment, AR Payment or AP Payment.
         attr_accessor :payment_type
 
         ##
@@ -71,6 +81,10 @@ module LockstepSdk
         # @return [Double] Unapplied balance of this payment.
         attr_accessor :unapplied_amount
 
+        ##
+        # @return [Boolean] True if this payment includes some unassigned amount that has not yet been applied to an invoice. If this value is true, the field `UnappliedAmount` will be nonzero.
+        attr_accessor :is_open
+
         ##
         # @return [Int32] The number of invoices associated to this payment.
         attr_accessor :invoice_count
@@ -88,12 +102,28 @@ module LockstepSdk
         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 company for this payment.
+        attr_accessor :payment_company_id
+
+        ##
+        # @return [String] The name of the company for this payment.
+        attr_accessor :payment_company_name
+
+        ##
+        # @return [Uuid] The ids of the customer for the associated invoices.
+        attr_accessor :customer_ids
+
+        ##
+        # @return [String] The names of the customer for the associated invoices.
+        attr_accessor :customer_names
+
+        ##
+        # @return [Uuid] The ids of the company for the associated invoices.
+        attr_accessor :company_ids
 
         ##
-        # @return [Uuid] The id of the customer for this payment.
-        attr_accessor :customer_id
+        # @return [String] The names of the company for the associated invoices.
+        attr_accessor :company_names
 
         ##
         # @return [object] This object as a JSON key-value structure
@@ -103,16 +133,22 @@ module LockstepSdk
                 'paymentId' => @payment_id,
                 'memoText' => @memo_text,
                 'referenceCode' => @reference_code,
+                'tenderType' => @tender_type,
                 'paymentType' => @payment_type,
                 'paymentDate' => @payment_date,
                 'paymentAmount' => @payment_amount,
                 'unappliedAmount' => @unapplied_amount,
+                'isOpen' => @is_open,
                 'invoiceCount' => @invoice_count,
                 'totalPaymentsApplied' => @total_payments_applied,
                 'invoiceList' => @invoice_list,
                 'invoiceIdList' => @invoice_id_list,
-                'customerName' => @customer_name,
-                'customerId' => @customer_id,
+                'paymentCompanyId' => @payment_company_id,
+                'paymentCompanyName' => @payment_company_name,
+                'customerIds' => @customer_ids,
+                'customerNames' => @customer_names,
+                'companyIds' => @company_ids,
+                'companyNames' => @company_names,
             }
         end
 

data/lib/lockstep_sdk/models/payment_sync_model.rb

@@ -58,11 +58,11 @@ module LockstepSdk
         attr_accessor :company_erp_key
 
         ##
-        # @return [String] The type of payment, cash or check. Recognized PaymentType values are: * `Cash` - A cash payment or other direct transfer. * `Check` - A check payment.
+        # @return [String] The type of payment, AR Payment or AP Payment. Recognized PaymentType values are: * `AR Payment` - A payment made by a Customer to the Company * `AP Payment` - A payment made by the Company to a Vendor
         attr_accessor :payment_type
 
         ##
-        # @return [String] Cash, check, credit card, wire transfer. Recognized TenderType values are: * `Cash` - A cash payment or other direct transfer. * `Check` - A check payment. * `Credit Card` - A payment made via a credit card. * `Wire Transfer` - A payment made via wire transfer from another financial institution.
+        # @return [String] Cash, check, credit card, wire transfer. Recognized TenderType values are: * `Cash` - A cash payment or other direct transfer. * `Check` - A check payment. * `Credit Card` - A payment made via a credit card. * `Wire Transfer` - A payment made via wire transfer from another financial institution. * `Other` - A payment made via another method not listed above.
         attr_accessor :tender_type
 
         ##

data/lib/lockstep_sdk/models/status_model.rb

@@ -36,7 +36,9 @@ module LockstepSdk
             @user_status = params.dig(:user_status)
             @environment = params.dig(:environment)
             @version = params.dig(:version)
+            @onboarding_scheduled = params.dig(:onboarding_scheduled)
             @dependencies = params.dig(:dependencies)
+            @user_groups = params.dig(:user_groups)
         end
 
         ##
@@ -91,10 +93,18 @@ module LockstepSdk
         # @return [String] The version currently being used
         attr_accessor :version
 
+        ##
+        # @return [Boolean] If authentication is successful, contains the onboarding session status of the logged-in user's group account.
+        attr_accessor :onboarding_scheduled
+
         ##
         # @return [Object] Statuses for the dependencies of this api. OK if the dependency is working.
         attr_accessor :dependencies
 
+        ##
+        # @return [UserGroupModel] The set of Groups that the user has access to. You can use the /api/v1/useraccounts/change-group endpoint to change your active group.
+        attr_accessor :user_groups
+
         ##
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
@@ -112,7 +122,9 @@ module LockstepSdk
                 'userStatus' => @user_status,
                 'environment' => @environment,
                 'version' => @version,
+                'onboardingScheduled' => @onboarding_scheduled,
                 'dependencies' => @dependencies,
+                'userGroups' => @user_groups,
             }
         end
 

data/lib/lockstep_sdk/models/sync_entity_result_model.rb

@@ -25,6 +25,7 @@ module LockstepSdk
         def initialize(params = {})
             @insert_count = params.dig(:insert_count)
             @update_count = params.dig(:update_count)
+            @delete_count = params.dig(:delete_count)
             @skip_count = params.dig(:skip_count)
             @error_count = params.dig(:error_count)
             @errors = params.dig(:errors)
@@ -38,6 +39,10 @@ module LockstepSdk
         # @return [Int32] The number of entities updated
         attr_accessor :update_count
 
+        ##
+        # @return [Int32] The number of entities deleted
+        attr_accessor :delete_count
+
         ##
         # @return [Int32] The number of entities skipped
         attr_accessor :skip_count
@@ -56,6 +61,7 @@ module LockstepSdk
             {
                 'insertCount' => @insert_count,
                 'updateCount' => @update_count,
+                'deleteCount' => @delete_count,
                 'skipCount' => @skip_count,
                 'errorCount' => @error_count,
                 'errors' => @errors,

data/lib/lockstep_sdk/models/user_group_model.rb

@@ -0,0 +1,66 @@
+#
+# 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
+
+    ##
+    # A UserGroup represents the groups that the user is a member of.
+    # A user may have varying permissions/access within a Group.
+    class UserGroupModel
+
+        ##
+        # Initialize the UserGroupModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @user_role = params.dig(:user_role)
+            @group_name = params.dig(:group_name)
+            @status = params.dig(:status)
+        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 [String] The name of the Permission Level for the group.
+        attr_accessor :user_role
+
+        ##
+        # @return [String] The name of the group
+        attr_accessor :group_name
+
+        ##
+        # @return [String] The user's status in the group
+        attr_accessor :status
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'userRole' => @user_role,
+                'groupName' => @group_name,
+                'status' => @status,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end