lockstep_sdk 2022.37.24.0 → 2023.1.3.0

data/lib/lockstep_sdk/models/payment_summary_totals_model.rb

@@ -0,0 +1,53 @@
+#
+# Lockstep Platform SDK for Ruby
+#
+# (c) 2021-2023 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-2023 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # The totals for a Payment Summary
+    class PaymentSummaryTotalsModel
+
+        ##
+        # Initialize the PaymentSummaryTotalsModel using the provided prototype
+        def initialize(params = {})
+            @total_paid_amount = params.dig(:total_paid_amount)
+            @total_unapplied_balance = params.dig(:total_unapplied_balance)
+        end
+
+        ##
+        # @return [Double] The total amount paid.
+        attr_accessor :total_paid_amount
+
+        ##
+        # @return [Double] The total amount unapplied.
+        attr_accessor :total_unapplied_balance
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'totalPaidAmount' => @total_paid_amount,
+                'totalUnappliedBalance' => @total_unapplied_balance,
+            }
+        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_sync_model.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 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.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -47,6 +47,7 @@ module LockstepSdk
             @reference_code = params.dig(:reference_code)
             @is_voided = params.dig(:is_voided)
             @in_dispute = params.dig(:in_dispute)
+            @currency_rate = params.dig(:currency_rate)
         end
 
         ##
@@ -113,6 +114,10 @@ module LockstepSdk
         # @return [Boolean] True if this payment is in dispute.
         attr_accessor :in_dispute
 
+        ##
+        # @return [Double] The Currency Rate used to get from the account's base currency to the payment amount.
+        attr_accessor :currency_rate
+
         ##
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
@@ -133,6 +138,7 @@ module LockstepSdk
                 'referenceCode' => @reference_code,
                 'isVoided' => @is_voided,
                 'inDispute' => @in_dispute,
+                'currencyRate' => @currency_rate,
             }
         end
 

data/lib/lockstep_sdk/models/public_company_profile_model.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 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.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 

data/lib/lockstep_sdk/models/risk_rate_model.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 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.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -24,6 +24,7 @@ module LockstepSdk
         # Initialize the RiskRateModel using the provided prototype
         def initialize(params = {})
             @group_key = params.dig(:group_key)
+            @base_currency_code = params.dig(:base_currency_code)
             @report_period = params.dig(:report_period)
             @report_date = params.dig(:report_date)
             @invoice_month_name = params.dig(:invoice_month_name)
@@ -39,6 +40,10 @@ module LockstepSdk
         # @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 base currency code of the group.
+        attr_accessor :base_currency_code
+
         ##
         # @return [Date-time] The month the risk rate was calculated for
         attr_accessor :report_period
@@ -56,7 +61,7 @@ module LockstepSdk
         attr_accessor :total_invoice_count
 
         ##
-        # @return [Double] The sum of the total amount for invoices in the calculation month
+        # @return [Double] The sum of the total amount for invoices in the calculation month in the group's base currency.
         attr_accessor :total_invoice_amount
 
         ##
@@ -64,7 +69,7 @@ module LockstepSdk
         attr_accessor :at_risk_count
 
         ##
-        # @return [Double] The sum of the outstanding balance of open invoices over 90 days from the calculation month
+        # @return [Double] The sum of the outstanding balance of open invoices over 90 days from the calculation month in the group's base currency.
         attr_accessor :at_risk_amount
 
         ##
@@ -80,6 +85,7 @@ module LockstepSdk
         def as_json(options={})
             {
                 'groupKey' => @group_key,
+                'baseCurrencyCode' => @base_currency_code,
                 'reportPeriod' => @report_period,
                 'reportDate' => @report_date,
                 'invoiceMonthName' => @invoice_month_name,

data/lib/lockstep_sdk/models/state_model.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 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.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 

data/lib/lockstep_sdk/models/status_model.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 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.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -24,6 +24,7 @@ module LockstepSdk
         # Initialize the StatusModel using the provided prototype
         def initialize(params = {})
             @user_name = params.dig(:user_name)
+            @email_address = params.dig(:email_address)
             @account_name = params.dig(:account_name)
             @account_company_id = params.dig(:account_company_id)
             @user_id = params.dig(:user_id)
@@ -37,14 +38,22 @@ module LockstepSdk
             @environment = params.dig(:environment)
             @version = params.dig(:version)
             @onboarding_scheduled = params.dig(:onboarding_scheduled)
+            @magic_link_id = params.dig(:magic_link_id)
+            @magic_link_company_id = params.dig(:magic_link_company_id)
+            @magic_link = params.dig(:magic_link)
             @dependencies = params.dig(:dependencies)
             @user_groups = params.dig(:user_groups)
+            @base_currency_code = params.dig(:base_currency_code)
         end
 
         ##
         # @return [String] If authentication is successful, contains the username of the logged-in user.
         attr_accessor :user_name
 
+        ##
+        # @return [String] If authentication is successful, contains the email address of the logged-in user.
+        attr_accessor :email_address
+
         ##
         # @return [String] If authentication is successful, contains subscription account name of logged-in user.
         attr_accessor :account_name
@@ -97,6 +106,18 @@ module LockstepSdk
         # @return [Boolean] If authentication is successful, contains the onboarding session status of the logged-in user's group account.
         attr_accessor :onboarding_scheduled
 
+        ##
+        # @return [Uuid] The id of the Magic link used to authenticate.
+        attr_accessor :magic_link_id
+
+        ##
+        # @return [Uuid] The id of the target company for the Magic Link
+        attr_accessor :magic_link_company_id
+
+        ##
+        # @return [MagicLinkStatusModel] Magic link information about the user
+        attr_accessor :magic_link
+
         ##
         # @return [Object] Statuses for the dependencies of this api. OK if the dependency is working.
         attr_accessor :dependencies
@@ -105,11 +126,16 @@ module LockstepSdk
         # @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 [String] Base Currency of the group
+        attr_accessor :base_currency_code
+
         ##
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
             {
                 'userName' => @user_name,
+                'emailAddress' => @email_address,
                 'accountName' => @account_name,
                 'accountCompanyId' => @account_company_id,
                 'userId' => @user_id,
@@ -123,8 +149,12 @@ module LockstepSdk
                 'environment' => @environment,
                 'version' => @version,
                 'onboardingScheduled' => @onboarding_scheduled,
+                'magicLinkId' => @magic_link_id,
+                'magicLinkCompanyId' => @magic_link_company_id,
+                'magicLink' => @magic_link,
                 'dependencies' => @dependencies,
                 'userGroups' => @user_groups,
+                'baseCurrencyCode' => @base_currency_code,
             }
         end
 

data/lib/lockstep_sdk/models/summary_aging_totals_model.rb

@@ -0,0 +1,53 @@
+#
+# Lockstep Platform SDK for Ruby
+#
+# (c) 2021-2023 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-2023 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # Represents summary aging bucket total.
+    class SummaryAgingTotalsModel
+
+        ##
+        # Initialize the SummaryAgingTotalsModel using the provided prototype
+        def initialize(params = {})
+            @bucket = params.dig(:bucket)
+            @outstanding_balance = params.dig(:outstanding_balance)
+        end
+
+        ##
+        # @return [String] Aging bucket outstanding balance is associated to.
+        attr_accessor :bucket
+
+        ##
+        # @return [Double] Aging outstanding balance value.
+        attr_accessor :outstanding_balance
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'bucket' => @bucket,
+                'outstandingBalance' => @outstanding_balance,
+            }
+        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/sync_entity_result_model.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 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.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 

data/lib/lockstep_sdk/models/sync_request_model.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 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.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -33,6 +33,8 @@ module LockstepSdk
             @sync_request_id = params.dig(:sync_request_id)
             @group_key = params.dig(:group_key)
             @status_code = params.dig(:status_code)
+            @operation_type_name = params.dig(:operation_type_name)
+            @operation_type = params.dig(:operation_type)
             @process_result_message = params.dig(:process_result_message)
             @run_full_sync = params.dig(:run_full_sync)
             @app_enrollment_id = params.dig(:app_enrollment_id)
@@ -54,6 +56,14 @@ module LockstepSdk
         # @return [String] The status of processing for this SyncRequest. When a SyncRequest is created, it is flagged as `Ready`. When it is picked up for execution, its status moves to `In Progress`. When it is complete, its status will move to `Success` or `Failed`. If another API call cancels the SyncRequest, its status will move to `Cancelled`. * Ready * In Progress * Cancelled * Failed * Success
         attr_accessor :status_code
 
+        ##
+        # @return [String] The name of the OperationType for this SyncRequest
+        attr_accessor :operation_type_name
+
+        ##
+        # @return [Int32] The name of the OperationType for this SyncRequest
+        attr_accessor :operation_type
+
         ##
         # @return [String] Message containing information about the sync request results
         attr_accessor :process_result_message
@@ -89,6 +99,8 @@ module LockstepSdk
                 'syncRequestId' => @sync_request_id,
                 'groupKey' => @group_key,
                 'statusCode' => @status_code,
+                'operationTypeName' => @operation_type_name,
+                'operationType' => @operation_type,
                 'processResultMessage' => @process_result_message,
                 'runFullSync' => @run_full_sync,
                 'appEnrollmentId' => @app_enrollment_id,

data/lib/lockstep_sdk/models/sync_submit_model.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 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.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 

data/lib/lockstep_sdk/models/transaction_detail_model.rb

@@ -0,0 +1,138 @@
+#
+# Lockstep Platform SDK for Ruby
+#
+# (c) 2021-2023 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-2023 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # Represents transaction detail information associated to a transaction. This can either be Invoices which are paid with a
+    # Credit Memo or Payment transaction, or Credit Memos or Payments used as payment for an Invoice transaction.
+    class TransactionDetailModel
+
+        ##
+        # Initialize the TransactionDetailModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @base_currency_code = params.dig(:base_currency_code)
+            @reference_number = params.dig(:reference_number)
+            @transaction_detail_id = params.dig(:transaction_detail_id)
+            @transaction_detail_applied_id = params.dig(:transaction_detail_applied_id)
+            @transaction_id = params.dig(:transaction_id)
+            @transaction_type = params.dig(:transaction_type)
+            @transaction_sub_type = params.dig(:transaction_sub_type)
+            @transaction_date = params.dig(:transaction_date)
+            @transaction_invoice_date = params.dig(:transaction_invoice_date)
+            @currency_code = params.dig(:currency_code)
+            @transaction_amount = params.dig(:transaction_amount)
+            @outstanding_amount = params.dig(:outstanding_amount)
+            @base_currency_transaction_amount = params.dig(:base_currency_transaction_amount)
+            @base_currency_outstanding_amount = params.dig(:base_currency_outstanding_amount)
+            @supports_erp_pdf_retrieval = params.dig(:supports_erp_pdf_retrieval)
+        end
+
+        ##
+        # @return [Uuid] Group account transaction detail is associated with.
+        attr_accessor :group_key
+
+        ##
+        # @return [String] The base currency code of the group.
+        attr_accessor :base_currency_code
+
+        ##
+        # @return [String] An additional reference number that is sometimes used to identify a transaction detail. The meaning of this field is specific to the ERP or accounting system used by the user.
+        attr_accessor :reference_number
+
+        ##
+        # @return [Uuid] The unique ID of the transaction detail record.
+        attr_accessor :transaction_detail_id
+
+        ##
+        # @return [Uuid] The unique ID of the entity applying the transaction to the transaction detail record.
+        attr_accessor :transaction_detail_applied_id
+
+        ##
+        # @return [Uuid] The unique ID of the transaction record.
+        attr_accessor :transaction_id
+
+        ##
+        # @return [String] The type of the transaction detail record. Recognized Invoice types are: * `AR Invoice` - Represents an invoice sent by Company to the Customer * `AP Invoice` - Represents an invoice sent by Vendor to the Company * `AR Credit Memo` - Represents a credit memo generated by Company given to Customer * `AP Credit Memo` - Represents a credit memo generated by Vendor given to Company 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 :transaction_type
+
+        ##
+        # @return [String] Additional type categorization of the transaction.
+        attr_accessor :transaction_sub_type
+
+        ##
+        # @return [Date-time] The date when a transaction detail record was reported.
+        attr_accessor :transaction_date
+
+        ##
+        # @return [Date-time] The date of the invoice associated to the transaction detail record.
+        attr_accessor :transaction_invoice_date
+
+        ##
+        # @return [String] The currency code of the transaction.
+        attr_accessor :currency_code
+
+        ##
+        # @return [Double] The total value of this transaction detail, inclusive or all taxes and line items.
+        attr_accessor :transaction_amount
+
+        ##
+        # @return [Double] The remaining balance of this transaction detail.
+        attr_accessor :outstanding_amount
+
+        ##
+        # @return [Double] The total value of this transaction detail, inclusive or all taxes and line items in the group's base currency.
+        attr_accessor :base_currency_transaction_amount
+
+        ##
+        # @return [Double] The remaining balance of this transaction detail in the group's base currency.
+        attr_accessor :base_currency_outstanding_amount
+
+        ##
+        # @return [Boolean] Specific transactions have support for pdf retrieval from their respective erp. When this flag is true, an additional call to Invoices/{id}/pdf or Payments/{id}/pdf can be made to retrieve a pdf directly from the erp.
+        attr_accessor :supports_erp_pdf_retrieval
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'baseCurrencyCode' => @base_currency_code,
+                'referenceNumber' => @reference_number,
+                'transactionDetailId' => @transaction_detail_id,
+                'transactionDetailAppliedId' => @transaction_detail_applied_id,
+                'transactionId' => @transaction_id,
+                'transactionType' => @transaction_type,
+                'transactionSubType' => @transaction_sub_type,
+                'transactionDate' => @transaction_date,
+                'transactionInvoiceDate' => @transaction_invoice_date,
+                'currencyCode' => @currency_code,
+                'transactionAmount' => @transaction_amount,
+                'outstandingAmount' => @outstanding_amount,
+                'baseCurrencyTransactionAmount' => @base_currency_transaction_amount,
+                'baseCurrencyOutstandingAmount' => @base_currency_outstanding_amount,
+                'supportsErpPdfRetrieval' => @supports_erp_pdf_retrieval,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end