lockstep_sdk 2023.13.37.0 → 2023.17.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94c3d82bb006438d2d6083a2a1f777ec72d8e3e53a8e9f9d15f97c739c5c7fa3
-  data.tar.gz: f4a97901a63f1ff48303b5439c197a013255e160aea87e32e5e4da928381a147
+  metadata.gz: e57962a47787588b19a99264be9b2ef7601dd8cf52a6f78c704a06c7f8c8355a
+  data.tar.gz: 336f18be792f9724a82227839a68c06ebb2d6d4487d63672ca3f0ae3f0d56346
 SHA512:
-  metadata.gz: 15a56c02466b9db83340d47aaca8d230fbd44be948d30c034c302a203ebb1309a3286522d15195fe59704676e4dcdef012b7d50f303a37929df5dd69b7e12a91
-  data.tar.gz: c92e2b1e5e991cc98029cecd28adfcd780a643bd223bc1682bdfc7e7a1d7bf68bd60fbe351b77df0ba2e0818638ac1d7b899dddbe04e7863e1f0c1bdcc929ce2
+  metadata.gz: e86e45271e0b3b2a71655232f64595b20a7c4e0442e27b0d4d7bb8ac5974bdbb709279b751811e1d8c393080cd0a77e05c5bc541bc54518b70a5e5bdbaa9a1cc
+  data.tar.gz: a31ff3a91b040e7a18cd6bc93e31dad6d515a6c0bb94b81ac6ed36978bcf2191a8138517896d14aa3303739ecdec806a5f599991d6835aa94a395157c760d514

data/lib/lockstep_sdk/clients/invoices_client.rb

@@ -105,7 +105,7 @@ class InvoicesClient
     #
     # Sage Intacct supports AR Invoices.
     #
-    # Quickbooks Online supports AR Invoices, and AR Credit Memos.
+    # QuickBooks Online supports AR Invoices, and AR Credit Memos.
     #
     # Xero supports AR Invoices, AP Invoices, AR Credit Memos, and AP Credit Memos.
     #

data/lib/lockstep_sdk/clients/payments_client.rb

@@ -94,7 +94,7 @@ class PaymentsClient
     ##
     # Retrieves a PDF file for this payment if it has been synced using an app enrollment to one of the supported apps.
     #
-    # Quickbooks Online supports AR Payments.
+    # QuickBooks Online supports AR Payments.
     #
     # @param id [uuid] The unique Lockstep Platform ID number of this payment; NOT the customer's ERP key
     def retrieve_payment_pdf(id:)

data/lib/lockstep_sdk/lockstep_api.rb

@@ -9,7 +9,7 @@
 # @author     Lockstep Network <support@lockstep.io>
 #             Manish Narayan B S <manish.n@lockstep.io>, Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
 # @copyright  2021-2023 Lockstep, Inc.
-# @version    2023.13.37
+# @version    2023.17.21
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -194,7 +194,7 @@ module lockstep_sdk
         #
         # @param env [string] Either "sbx", "prd", or the URI of the server, ending in a slash (/)
         def initialize(env)
-            @version = "2023.13.37.0"
+            @version = "2023.17.21.0"
             @env = case env
                 when "sbx"
                     "https://api.sbx.lockstep.io/"
@@ -307,7 +307,7 @@ module lockstep_sdk
             request["Accept"] = 'application/json'
             request["Content-Type"] = 'application/*+json'
             request["SdkType"] = 'Ruby'
-            request["SdkVersion"] = '2023.13.37.0'
+            request["SdkVersion"] = '2023.17.21.0'
             request["MachineName"] = Socket.gethostname
             request.body = body
 

data/lib/lockstep_sdk/models/cashflow_report_model.rb

@@ -24,6 +24,7 @@ module LockstepSdk
         # Initialize the CashflowReportModel using the provided prototype
         def initialize(params = {})
             @timeframe = params.dig(:timeframe)
+            @base_currency_code = params.dig(:base_currency_code)
             @payments_collected = params.dig(:payments_collected)
             @payments_collected_count = params.dig(:payments_collected_count)
             @invoices_billed = params.dig(:invoices_billed)
@@ -35,7 +36,11 @@ module LockstepSdk
         attr_accessor :timeframe
 
         ##
-        # @return [Double] Amount of payments collected based in the timeframe
+        # @return [String] The base currency code of the group.
+        attr_accessor :base_currency_code
+
+        ##
+        # @return [Double] Amount of payments collected based in the timeframe in the group's base currency
         attr_accessor :payments_collected
 
         ##
@@ -43,7 +48,7 @@ module LockstepSdk
         attr_accessor :payments_collected_count
 
         ##
-        # @return [Double] Amount of invoices billed based in the timeframe
+        # @return [Double] Amount of invoices billed based in the timeframe in the group's base currency
         attr_accessor :invoices_billed
 
         ##
@@ -55,6 +60,7 @@ module LockstepSdk
         def as_json(options={})
             {
                 'timeframe' => @timeframe,
+                'baseCurrencyCode' => @base_currency_code,
                 'paymentsCollected' => @payments_collected,
                 'paymentsCollectedCount' => @payments_collected_count,
                 'invoicesBilled' => @invoices_billed,

data/lib/lockstep_sdk/models/company_sync_model.rb

@@ -66,7 +66,7 @@ module LockstepSdk
         attr_accessor :on_match_action
 
         ##
-        # @return [String] This is the primary key of the Company record. For this field, you should use whatever the company's unique identifying number is in the originating system. Search for a unique, non-changing number within the originating financial system for this record. Example: If you store your company records in a database, whatever the primary key for the company table is in the database should be the `ErpKey`. Example: If you use a financial system such as Quickbooks or Xero, look for the primary ID number of the company record within that financial system. For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
+        # @return [String] This is the primary key of the Company record. For this field, you should use whatever the company's unique identifying number is in the originating system. Search for a unique, non-changing number within the originating financial system for this record. Example: If you store your company records in a database, whatever the primary key for the company table is in the database should be the `ErpKey`. Example: If you use a financial system such as QuickBooks or Xero, look for the primary ID number of the company record within that financial system. For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
         attr_accessor :erp_key
 
         ##

data/lib/lockstep_sdk/models/financial_account_balance_history_sync_model.rb

@@ -50,7 +50,7 @@ module LockstepSdk
         attr_accessor :financial_account_code
 
         ##
-        # @return [String] This is the primary key of the FinancialAccount record. For this field, you should use whatever the company's unique identifying number is in the originating system. Search for a unique, non-changing number within the originating financial system for this record. Example: If you store your company records in a database, whatever the primary key for the company table is in the database should be the ErpKey. Example: If you use a financial system such as Quickbooks or Xero, look for the primary ID number of the company record within that financial system.
+        # @return [String] This is the primary key of the FinancialAccount record. For this field, you should use whatever the company's unique identifying number is in the originating system. Search for a unique, non-changing number within the originating financial system for this record. Example: If you store your company records in a database, whatever the primary key for the company table is in the database should be the ErpKey. Example: If you use a financial system such as QuickBooks or Xero, look for the primary ID number of the company record within that financial system.
         attr_accessor :financial_account_erp_key
 
         ##

data/lib/lockstep_sdk/models/invoice_line_model.rb

@@ -46,6 +46,9 @@ module LockstepSdk
             @modified = params.dig(:modified)
             @modified_user_id = params.dig(:modified_user_id)
             @app_enrollment_id = params.dig(:app_enrollment_id)
+            @erp_write_status = params.dig(:erp_write_status)
+            @erp_write_status_name = params.dig(:erp_write_status_name)
+            @source_modified_date = params.dig(:source_modified_date)
             @notes = params.dig(:notes)
             @attachments = params.dig(:attachments)
         end
@@ -142,6 +145,18 @@ 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 [ErpWriteStatuses] Possible statuses for a record that supports ERP write.
+        attr_accessor :erp_write_status
+
+        ##
+        # @return [String] The name of the ErpWriteStatus for this Invoice
+        attr_accessor :erp_write_status_name
+
+        ##
+        # @return [Date-time] The date on which this record was last modified in source ERP.
+        attr_accessor :source_modified_date
+
         ##
         # @return [NoteModel] A collection of notes linked to this record. To retrieve this collection, specify `Notes` in the `include` parameter when retrieving data. To create a note, use the [Create Note](https://developer.lockstep.io/reference/post_api-v1-notes) endpoint with the `TableKey` to `InvoiceLine` and the `ObjectKey` set to the `InvoiceLineId` for this record. For more information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
         attr_accessor :notes
@@ -177,6 +192,9 @@ module LockstepSdk
                 'modified' => @modified,
                 'modifiedUserId' => @modified_user_id,
                 'appEnrollmentId' => @app_enrollment_id,
+                'erpWriteStatus' => @erp_write_status,
+                'erpWriteStatusName' => @erp_write_status_name,
+                'sourceModifiedDate' => @source_modified_date,
                 'notes' => @notes,
                 'attachments' => @attachments,
             }

data/lib/lockstep_sdk/models/invoice_model.rb

@@ -69,6 +69,9 @@ module LockstepSdk
             @base_currency_sales_tax_amount = params.dig(:base_currency_sales_tax_amount)
             @base_currency_discount_amount = params.dig(:base_currency_discount_amount)
             @base_currency_outstanding_balance_amount = params.dig(:base_currency_outstanding_balance_amount)
+            @erp_write_status = params.dig(:erp_write_status)
+            @erp_write_status_name = params.dig(:erp_write_status_name)
+            @source_modified_date = params.dig(:source_modified_date)
             @addresses = params.dig(:addresses)
             @lines = params.dig(:lines)
             @payments = params.dig(:payments)
@@ -246,6 +249,18 @@ module LockstepSdk
         # @return [Double] The remaining balance value of this invoice in the group's base currency.
         attr_accessor :base_currency_outstanding_balance_amount
 
+        ##
+        # @return [ErpWriteStatuses] Possible statuses for a record that supports ERP write.
+        attr_accessor :erp_write_status
+
+        ##
+        # @return [String] The name of the ErpWriteStatus for this Invoice
+        attr_accessor :erp_write_status_name
+
+        ##
+        # @return [Date-time] The date on which this record was last modified in source ERP.
+        attr_accessor :source_modified_date
+
         ##
         # @return [InvoiceAddressModel] All addresses connected to this invoice. To retrieve this collection, specify `Addresses` in the "Include" parameter for your query.
         attr_accessor :addresses
@@ -335,6 +350,9 @@ module LockstepSdk
                 'baseCurrencySalesTaxAmount' => @base_currency_sales_tax_amount,
                 'baseCurrencyDiscountAmount' => @base_currency_discount_amount,
                 'baseCurrencyOutstandingBalanceAmount' => @base_currency_outstanding_balance_amount,
+                'erpWriteStatus' => @erp_write_status,
+                'erpWriteStatusName' => @erp_write_status_name,
+                'sourceModifiedDate' => @source_modified_date,
                 'addresses' => @addresses,
                 'lines' => @lines,
                 'payments' => @payments,

data/lib/lockstep_sdk/models/payment_summary_model_payment_summary_totals_model_summary_fetch_result.rb

@@ -21,18 +21,14 @@ module LockstepSdk
         ##
         # Initialize the PaymentSummaryModelPaymentSummaryTotalsModelSummaryFetchResult using the provided prototype
         def initialize(params = {})
-            @records = params.dig(:records)
             @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 [PaymentSummaryModel] 
-        attr_accessor :records
-
         ##
         # @return [Int32] 
         attr_accessor :total_count
@@ -45,6 +41,10 @@ module LockstepSdk
         # @return [Int32] 
         attr_accessor :page_number
 
+        ##
+        # @return [PaymentSummaryModel] 
+        attr_accessor :records
+
         ##
         # @return [PaymentSummaryTotalsModel] The totals for a Payment Summary
         attr_accessor :summary
@@ -57,10 +57,10 @@ module LockstepSdk
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
             {
-                'records' => @records,
                 'totalCount' => @total_count,
                 'pageSize' => @page_size,
                 'pageNumber' => @page_number,
+                'records' => @records,
                 'summary' => @summary,
                 'agingSummary' => @aging_summary,
             }

data/lib/lockstep_sdk/version.rb

@@ -1,3 +1,3 @@
 module LockstepSdk
-    VERSION = "2023.13.37.0"
+    VERSION = "2023.17.21.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockstep_sdk
 version: !ruby/object:Gem::Version
-  version: 2023.13.37.0
+  version: 2023.17.21.0
 platform: ruby
 authors:
 - Lockstep
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-31 00:00:00.000000000 Z
+date: 2023-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awrence
@@ -124,7 +124,6 @@ files:
 - lib/lockstep_sdk/models/email_reply_generator_response.rb
 - lib/lockstep_sdk/models/email_reply_generator_suggestions.rb
 - lib/lockstep_sdk/models/erp_model.rb
-- lib/lockstep_sdk/models/error_result.rb
 - lib/lockstep_sdk/models/feature_flags_request_model.rb
 - lib/lockstep_sdk/models/feature_flags_response_model.rb
 - lib/lockstep_sdk/models/financial_account_balance_history_model.rb

data/lib/lockstep_sdk/models/error_result.rb

@@ -1,77 +0,0 @@
-#
-# 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 failed API request.
-    class ErrorResult
-
-        ##
-        # Initialize the ErrorResult using the provided prototype
-        def initialize(params = {})
-            @type = params.dig(:type)
-            @title = params.dig(:title)
-            @status = params.dig(:status)
-            @detail = params.dig(:detail)
-            @instance = params.dig(:instance)
-            @content = params.dig(:content)
-        end
-
-        ##
-        # @return [String] A description of the type of error that occurred.
-        attr_accessor :type
-
-        ##
-        # @return [String] A short title describing the error.
-        attr_accessor :title
-
-        ##
-        # @return [Int32] If an error code is applicable, this contains an error number.
-        attr_accessor :status
-
-        ##
-        # @return [String] If detailed information about this error is available, this value contains more information.
-        attr_accessor :detail
-
-        ##
-        # @return [String] If this error corresponds to a specific instance or object, this field indicates which one.
-        attr_accessor :instance
-
-        ##
-        # @return [String] The full content of the HTTP response.
-        attr_accessor :content
-
-        ##
-        # @return [object] This object as a JSON key-value structure
-        def as_json(options={})
-            {
-                'type' => @type,
-                'title' => @title,
-                'status' => @status,
-                'detail' => @detail,
-                'instance' => @instance,
-                'content' => @content,
-            }
-        end
-
-        ##
-        # @return [String] This object converted to a JSON string
-        def to_json(*options)
-            "[#{as_json(*options).to_json(*options)}]"
-        end
-    end
-end