lockstep_sdk 2022.37.24.0 → 2023.1.3.0

data/lib/lockstep_sdk/models/transaction_model.rb

@@ -0,0 +1,144 @@
+#
+# 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 detailed transaction information which represents either Invoices, Credit Memos or Payments
+    # within the group account.
+    class TransactionModel
+
+        ##
+        # Initialize the TransactionModel 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_id = params.dig(:transaction_id)
+            @transaction_status = params.dig(:transaction_status)
+            @transaction_type = params.dig(:transaction_type)
+            @transaction_sub_type = params.dig(:transaction_sub_type)
+            @transaction_date = params.dig(:transaction_date)
+            @due_date = params.dig(:due_date)
+            @days_past_due = params.dig(:days_past_due)
+            @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)
+            @transaction_detail_count = params.dig(:transaction_detail_count)
+            @supports_erp_pdf_retrieval = params.dig(:supports_erp_pdf_retrieval)
+        end
+
+        ##
+        # @return [Uuid] Group account transaction 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. 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 record.
+        attr_accessor :transaction_id
+
+        ##
+        # @return [String] The status of the transaction record. Recognized Invoice status codes are: * `Open` - Represents an invoice that is considered open and needs more work to complete * `Closed` - Represents an invoice that is considered closed and resolved Recognized Payment status codes are: * `Open` - Represents an payment that includes some unassigned amount that has not yet been applied to an invoice * `Closed` - Represents an payment where `UnappliedAmount` will be zero
+        attr_accessor :transaction_status
+
+        ##
+        # @return [String] The type of the transaction 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 record was reported.
+        attr_accessor :transaction_date
+
+        ##
+        # @return [Date-time] The date when a transaction record is due for payment or completion.
+        attr_accessor :due_date
+
+        ##
+        # @return [Int32] The amount of days past the due date the transaction is left un-closed.
+        attr_accessor :days_past_due
+
+        ##
+        # @return [String] The currency code of the transaction.
+        attr_accessor :currency_code
+
+        ##
+        # @return [Double] The total value of this transaction, inclusive or all taxes and line items.
+        attr_accessor :transaction_amount
+
+        ##
+        # @return [Double] The remaining balance of this transaction.
+        attr_accessor :outstanding_amount
+
+        ##
+        # @return [Double] The total value of this transaction, 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 in the group's base currency.
+        attr_accessor :base_currency_outstanding_amount
+
+        ##
+        # @return [Int32] The count of items associated to the transaction. Examples: * Number of payments for an invoice. * Number of invoices a payment or credit memo is applied to.
+        attr_accessor :transaction_detail_count
+
+        ##
+        # @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,
+                'transactionId' => @transaction_id,
+                'transactionStatus' => @transaction_status,
+                'transactionType' => @transaction_type,
+                'transactionSubType' => @transaction_sub_type,
+                'transactionDate' => @transaction_date,
+                'dueDate' => @due_date,
+                'daysPastDue' => @days_past_due,
+                'currencyCode' => @currency_code,
+                'transactionAmount' => @transaction_amount,
+                'outstandingAmount' => @outstanding_amount,
+                'baseCurrencyTransactionAmount' => @base_currency_transaction_amount,
+                'baseCurrencyOutstandingAmount' => @base_currency_outstanding_amount,
+                'transactionDetailCount' => @transaction_detail_count,
+                '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

data/lib/lockstep_sdk/models/transaction_model_transaction_summary_total_model_summary_fetch_result.rb

@@ -0,0 +1,75 @@
+#
+# 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
+
+    class TransactionModelTransactionSummaryTotalModelSummaryFetchResult
+
+        ##
+        # Initialize the TransactionModelTransactionSummaryTotalModelSummaryFetchResult using the provided prototype
+        def initialize(params = {})
+            @total_count = params.dig(:total_count)
+            @page_size = params.dig(:page_size)
+            @page_number = params.dig(:page_number)
+            @records = params.dig(:records)
+            @summary = params.dig(:summary)
+            @aging_summary = params.dig(:aging_summary)
+        end
+
+        ##
+        # @return [Int32] 
+        attr_accessor :total_count
+
+        ##
+        # @return [Int32] 
+        attr_accessor :page_size
+
+        ##
+        # @return [Int32] 
+        attr_accessor :page_number
+
+        ##
+        # @return [TransactionModel] 
+        attr_accessor :records
+
+        ##
+        # @return [TransactionSummaryTotalModel] Represents transaction summary information based on the query request within the group account.
+        attr_accessor :summary
+
+        ##
+        # @return [SummaryAgingTotalsModel] 
+        attr_accessor :aging_summary
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'totalCount' => @total_count,
+                'pageSize' => @page_size,
+                'pageNumber' => @page_number,
+                'records' => @records,
+                'summary' => @summary,
+                'agingSummary' => @aging_summary,
+            }
+        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/transaction_summary_total_model.rb

@@ -0,0 +1,71 @@
+#
+# 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 summary information based on the query request within the group account.
+    class TransactionSummaryTotalModel
+
+        ##
+        # Initialize the TransactionSummaryTotalModel using the provided prototype
+        def initialize(params = {})
+            @total_count = params.dig(:total_count)
+            @total_amount = params.dig(:total_amount)
+            @outstanding_amount = params.dig(:outstanding_amount)
+            @invoice_open_count = params.dig(:invoice_open_count)
+            @invoice_past_due_count = params.dig(:invoice_past_due_count)
+        end
+
+        ##
+        # @return [Int32] Total count of all transactions from the query request.
+        attr_accessor :total_count
+
+        ##
+        # @return [Double] Total value of all transactions from the query request.
+        attr_accessor :total_amount
+
+        ##
+        # @return [Double] Total outstanding amount value of all transactions from the query request.
+        attr_accessor :outstanding_amount
+
+        ##
+        # @return [Int32] Total open invoice count from the query request.
+        attr_accessor :invoice_open_count
+
+        ##
+        # @return [Int32] Total past due invoice count from the query request.
+        attr_accessor :invoice_past_due_count
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'totalCount' => @total_count,
+                'totalAmount' => @total_amount,
+                'outstandingAmount' => @outstanding_amount,
+                'invoiceOpenCount' => @invoice_open_count,
+                'invoicePastDueCount' => @invoice_past_due_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/transcription_request_submit.rb

@@ -0,0 +1,71 @@
+#
+# 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
+
+    ##
+    # A request to transcribe the provided file content to a Lockstep Platform object.
+    class TranscriptionRequestSubmit
+
+        ##
+        # Initialize the TranscriptionRequestSubmit using the provided prototype
+        def initialize(params = {})
+            @file_content = params.dig(:file_content)
+            @file_url = params.dig(:file_url)
+            @file_content_url = params.dig(:file_content_url)
+            @file_name = params.dig(:file_name)
+            @invoice_type_code = params.dig(:invoice_type_code)
+        end
+
+        ##
+        # @return [String] The base64 string of document content
+        attr_accessor :file_content
+
+        ##
+        # @return [String] The location of the file provided
+        attr_accessor :file_url
+
+        ##
+        # @return [String] The location of the file provided
+        attr_accessor :file_content_url
+
+        ##
+        # @return [String] The name of the file provided
+        attr_accessor :file_name
+
+        ##
+        # @return [String] The type of LockstepApi2.Models.TranscriptionRequestSubmit.InvoiceTypeCode requested to transcribe content to.
+        attr_accessor :invoice_type_code
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'fileContent' => @file_content,
+                'fileUrl' => @file_url,
+                'fileContentUrl' => @file_content_url,
+                'fileName' => @file_name,
+                'invoiceTypeCode' => @invoice_type_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/transcription_validation_request.rb

@@ -0,0 +1,89 @@
+#
+# 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 a transcription validation request that is used to validate if file is of a specific type.
+    class TranscriptionValidationRequest
+
+        ##
+        # Initialize the TranscriptionValidationRequest using the provided prototype
+        def initialize(params = {})
+            @transcription_validation_request_id = params.dig(:transcription_validation_request_id)
+            @group_key = params.dig(:group_key)
+            @status_code = params.dig(:status_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)
+            @items = params.dig(:items)
+        end
+
+        ##
+        # @return [Uuid] The unique identifier of the transcription validation request.
+        attr_accessor :transcription_validation_request_id
+
+        ##
+        # @return [Uuid] Group account transcription validation request is associated with.
+        attr_accessor :group_key
+
+        ##
+        # @return [String] A code identifying the status of this transcription validation request. Recognized Transcription Validation Request status codes are: * `New` - Represents a transcription validation request that is considered new and needs work to complete * `In Progress` - Represents a transcription validation request that is currently being worked on * `Failed` - Represents a transcription validation request that could not complete the validation process * `Complete` - Represents a transcription validation request that is considered complete and does not need any further work
+        attr_accessor :status_code
+
+        ##
+        # @return [Date-time] The date on which this transcription validation request was created.
+        attr_accessor :created
+
+        ##
+        # @return [Uuid] The ID number of the user who created this transcription validation request.
+        attr_accessor :created_user_id
+
+        ##
+        # @return [Date-time] The date on which this transcription validation request was last modified.
+        attr_accessor :modified
+
+        ##
+        # @return [Uuid] The ID number of the user who most recently modified this transcription validation request.
+        attr_accessor :modified_user_id
+
+        ##
+        # @return [TranscriptionValidationRequestItem] All items attached to this transcription validation request. To retrieve this collection, specify `Items` in the "Include" parameter for your query.
+        attr_accessor :items
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'transcriptionValidationRequestId' => @transcription_validation_request_id,
+                'groupKey' => @group_key,
+                'statusCode' => @status_code,
+                'created' => @created,
+                'createdUserId' => @created_user_id,
+                'modified' => @modified,
+                'modifiedUserId' => @modified_user_id,
+                'items' => @items,
+            }
+        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/transcription_validation_request_item.rb

@@ -0,0 +1,149 @@
+#
+# 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 a transcription validation request item to be validated.
+    class TranscriptionValidationRequestItem
+
+        ##
+        # Initialize the TranscriptionValidationRequestItem using the provided prototype
+        def initialize(params = {})
+            @transcription_validation_request_item_id = params.dig(:transcription_validation_request_item_id)
+            @transcription_validation_request_id = params.dig(:transcription_validation_request_id)
+            @group_key = params.dig(:group_key)
+            @file_hash = params.dig(:file_hash)
+            @file_name = params.dig(:file_name)
+            @file_ext = params.dig(:file_ext)
+            @file_location = params.dig(:file_location)
+            @transcription_result = params.dig(:transcription_result)
+            @process_start = params.dig(:process_start)
+            @process_end = params.dig(:process_end)
+            @retry_count = params.dig(:retry_count)
+            @feedback_result = params.dig(:feedback_result)
+            @feedback_sent = params.dig(:feedback_sent)
+            @status_code = params.dig(:status_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)
+        end
+
+        ##
+        # @return [Uuid] The unique identifier of the transcription validation request item.
+        attr_accessor :transcription_validation_request_item_id
+
+        ##
+        # @return [Uuid] The ID number of the transcription validation request this item belongs to.
+        attr_accessor :transcription_validation_request_id
+
+        ##
+        # @return [Uuid] Group account transcription validation request item is associated with.
+        attr_accessor :group_key
+
+        ##
+        # @return [String] Generated hash of the file being validated.
+        attr_accessor :file_hash
+
+        ##
+        # @return [String] Original name of the file on disk, without its extension.
+        attr_accessor :file_name
+
+        ##
+        # @return [String] Original extension name of the file on disk.
+        attr_accessor :file_ext
+
+        ##
+        # @return [String] Location of file in blob storage to be validated.
+        attr_accessor :file_location
+
+        ##
+        # @return [String] Transcription result
+        attr_accessor :transcription_result
+
+        ##
+        # @return [Date-time] Transcription process start date
+        attr_accessor :process_start
+
+        ##
+        # @return [Date-time] Transcription process end date
+        attr_accessor :process_end
+
+        ##
+        # @return [Int32] Amount of times item was processed to retrieve the transcription data
+        attr_accessor :retry_count
+
+        ##
+        # @return [String] Feedback result specified by the client when the transcription result is not correct. This feedback result will be sent back to the transcription services to retrain and improve models over time.
+        attr_accessor :feedback_result
+
+        ##
+        # @return [Date-time] Date when feedback result was sent back to transcription service.
+        attr_accessor :feedback_sent
+
+        ##
+        # @return [String] A code identifying the status of this transcription validation request item. Recognized Transcription Validation Request status codes are: * `New` - Represents a transcription validation request item that is considered new and needs work to complete * `In Progress` - Represents a transcription validation request item that is currently being worked on * `Failed` - Represents a transcription validation request item that could not complete the validation process * `Complete` - Represents a transcription validation request item that is considered complete and does not need any further work
+        attr_accessor :status_code
+
+        ##
+        # @return [Date-time] The date on which this transcription validation request item was created.
+        attr_accessor :created
+
+        ##
+        # @return [Uuid] The ID number of the user who created this transcription validation request item.
+        attr_accessor :created_user_id
+
+        ##
+        # @return [Date-time] The date on which this transcription validation request item was last modified.
+        attr_accessor :modified
+
+        ##
+        # @return [Uuid] The ID number of the user who most recently modified this transcription validation request item.
+        attr_accessor :modified_user_id
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'transcriptionValidationRequestItemId' => @transcription_validation_request_item_id,
+                'transcriptionValidationRequestId' => @transcription_validation_request_id,
+                'groupKey' => @group_key,
+                'fileHash' => @file_hash,
+                'fileName' => @file_name,
+                'fileExt' => @file_ext,
+                'fileLocation' => @file_location,
+                'transcriptionResult' => @transcription_result,
+                'processStart' => @process_start,
+                'processEnd' => @process_end,
+                'retryCount' => @retry_count,
+                'feedbackResult' => @feedback_result,
+                'feedbackSent' => @feedback_sent,
+                'statusCode' => @status_code,
+                'created' => @created,
+                'createdUserId' => @created_user_id,
+                'modified' => @modified,
+                'modifiedUserId' => @modified_user_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/transfer_owner_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/transfer_owner_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/uri_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/user_account_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
 #