lockstep_sdk 2023.1.3.0 → 2023.3.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ed4e526a431a87f3e9fa4ffce45e7bf0084cf614228f155698e6e10ec6a1fd6
-  data.tar.gz: e6f1d7589adbd2b3cfc896e06638f4152be249f10f3c98a772c7ccdd470abfa3
+  metadata.gz: 0d1f5c4c48104c1fbe168d5100f83ab22c372c3a1b4193dc231b05d375fd9e14
+  data.tar.gz: 76a4033fccfb500befa34a06e9fcbe00727e90ce356eb6e5e40cf98d7e552983
 SHA512:
-  metadata.gz: eee249a9fa647b1a57f322aff3b05403275657a9ec08504cf1f41d69eee81cbd53bad940180f7039c3434529f57fab4256f65e1f198690cb227d44337e6c1650
-  data.tar.gz: 97d62df097c426559eafcacfdf2feaeaaf965b8380a6bacd1af615c9abc20d39fad5538a80f020075ab4a91da39ebddd0033e58369a01f95f7cd0f3abc187a2f
+  metadata.gz: e960627ab90c321e409354ab713217d1fda12ccad5f068443a64fdeac75eecc8ccd7f3fdd8e8ad44b42c8e83fed41576dff1a4a4e7e41552f92e5226f321437f
+  data.tar.gz: de3cd0ac9c19ef2211d1c7c13414a9c9851335f6d50b16fb5bd992872e7de825ac3945c10e2266da84fbf118dbd8105e6444789979a6b9bfe4e9a1949b228a05

data/lib/lockstep_sdk/clients/invoices_client.rb

@@ -103,9 +103,11 @@ class InvoicesClient
     ##
     # Retrieves a PDF file for this invoice if it is of one of the supported invoice types and has been synced using an app enrollment to one of the supported apps.
     #
-    # Supported apps: Quickbooks Online, Xero
+    # Sage Intacct supports AR Invoices.
     #
-    # Supported invoice types: Invoice, Credit Memo
+    # Quickbooks Online supports AR Invoices, and AR Credit Memos.
+    #
+    # Xero supports AR Invoices, AP Invoices, AR Credit Memos, and AP Credit Memos.
     #
     # @param id [uuid] The unique Lockstep Platform ID number of this invoice; NOT the customer's ERP key
     def retrieve_invoice_pdf(id:)

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.
     #
-    # Supported apps: Quickbooks Online
+    # 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/clients/profiles_accounting_contacts_client.rb

@@ -88,4 +88,15 @@ class ProfilesAccountingContactsClient
         params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
         @connection.request(:get, path, nil, params)
     end
+
+    ##
+    # Updates an accounting profile contact that matches the specified id with the primary contact attached to the accounting profile
+    #
+    # An Accounting Profile Contact has a link to a Contact that is associated with your company's Accounting Profile. These Contacts are secondary contacts to the primary that is on the profile.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of the Accounting Profile Contact to update
+    def swap_secondary_and_primary_contact(id:)
+        path = "/api/v1/profiles/accounting/contacts/#{id}/primary"
+        @connection.request(:patch, path, nil, nil)
+    end
 end

data/lib/lockstep_sdk/clients/transcriptions_client.rb

@@ -88,4 +88,67 @@ class TranscriptionsClient
         params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
         @connection.request(:get, path, nil, params)
     end
+
+    ##
+    # Retrieves the TranscriptionValidationRequestItemModel specified by this unique identifier.
+    #
+    # A TranscriptionValidationRequestItemModel represents a file sent from the client to verify the file type using the machine learning platform Sage AI.
+    #
+    # @param body [TranscriptionRequestSubmit] The TranscriptionValidationRequestItemModels to add to an existing TranscriptionValidationRequestItemModel
+    def creates_a_transcriptionvalidationrequestitemmodel(body:)
+        path = "/api/v1/Transcriptions/validation-items"
+        @connection.request(:post, path, body, nil)
+    end
+
+    ##
+    # Retrieves the TranscriptionValidationRequestItemModel specified by this unique identifier.
+    #
+    # A TranscriptionValidationRequestItemModel represents a file sent from the client to verify the file type using the machine learning platform Sage AI.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of the TranscriptionValidationRequestItemModel
+    def retrieve_a_transcriptionvalidationrequestitemmodel(id:)
+        path = "/api/v1/Transcriptions/validation-items/#{id}"
+        @connection.request(:get, path, nil, nil)
+    end
+
+    ##
+    # Updates the TranscriptionValidationRequestItemModel specified by this unique identifier.
+    #
+    # The PATCH method allows you to change specific values on the object while leaving other values alone.  As input you should supply a list of field names and new values.  If you do not provide the name of a field, that field will remain unchanged.  This allows you to ensure that you are only updating the specific fields desired.
+    #
+    # A TranscriptionValidationRequestItemModel represents a file sent from the client to verify the file type using the machine learning platform Sage AI.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of the TranscriptionValidationRequestItemModel
+    # @param body [object] A list of changes to apply to this TranscriptionValidationRequestItemModel
+    def update_a_transcriptionvalidationrequestitemmodel(id:, body:)
+        path = "/api/v1/Transcriptions/validation-items/#{id}"
+        @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
+    end
+
+    ##
+    # Deletes the TranscriptionValidationRequestItemModel specified by this unique identifier.
+    #
+    # A TranscriptionValidationRequestItemModel represents a file sent from the client to verify the file type using the machine learning platform Sage AI.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of the TranscriptionValidationRequestItemModel
+    def delete_a_transcriptionvalidationrequestitemmodel(id:)
+        path = "/api/v1/Transcriptions/validation-items/#{id}"
+        @connection.request(:delete, path, nil, nil)
+    end
+
+    ##
+    # Queries TranscriptionValidationRequestItemModels for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
+    #
+    # More information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.
+    #
+    # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. No collections are currently available but may be offered in the future ///
+    # @param order [string] The sort order for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_size [int32] The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    def query_transcription_validation_request_items(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/Transcriptions/validation-items/query"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @connection.request(:get, path, nil, params)
+    end
 end

data/lib/lockstep_sdk/clients/user_accounts_client.rb

@@ -125,10 +125,23 @@ class UserAccountsClient
     ##
     # Retrieves the user data for the current user. This allows for retrieving extended user data such as UTM parameters.
     #
-    # @param include_param [string] The set of data to retrieve. To avoid any casing confusion, these values are converted to upper case in storage. Possible values are: UTM
+    # @param include_param [string] The set of data to retrieve. To avoid any casing confusion, these values are converted to upper case. Possible values are: UTM
     def get_user_data(include_param:)
         path = "/api/v1/UserAccounts/user-data"
         params = {:include => include_param}
         @connection.request(:get, path, nil, params)
     end
+
+    ##
+    # Set support access for the calling user.
+    #
+    # Support access allows Lockstep to access the user's account to troubleshoot issues. Access is granted for a limited time, can be revoked at any time, and requires a code to verify the access.
+    #
+    # Every call to this API will regenerate the support access code.
+    #
+    # @param body [SupportAccessRequest] 
+    def set_support_access(body:)
+        path = "/api/v1/UserAccounts/support-access"
+        @connection.request(:post, path, body, nil)
+    end
 end

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.1.3
+# @version    2023.3.18
 # @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.1.3.0"
+            @version = "2023.3.18.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.1.3.0'
+            request["SdkVersion"] = '2023.3.18.0'
             request["MachineName"] = Socket.gethostname
             request.body = body
 

data/lib/lockstep_sdk/models/base_currency_sync_model.rb

@@ -0,0 +1,55 @@
+#
+# 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 BaseCurrencySyncModel represents information coming into Lockstep from an external financial system or other
+    # enterprise resource planning system.  To import data from an external system, convert your original data into
+    # the BaseCurrencySyncModel format and call the [Upload Sync File API](https://developer.lockstep.io/reference/post_api-v1-sync-zip).
+    # This API retrieves all of the data you uploaded in a compressed ZIP file and imports it into the Lockstep
+    # platform.
+    #
+    # Once imported, this record will be used to update the Group Account base currency code.
+    #
+    # For more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data).
+    class BaseCurrencySyncModel
+
+        ##
+        # Initialize the BaseCurrencySyncModel using the provided prototype
+        def initialize(params = {})
+            @base_currency_code = params.dig(:base_currency_code)
+        end
+
+        ##
+        # @return [String] The default currency code used by this business entity. For a list of defined currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies)
+        attr_accessor :base_currency_code
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'baseCurrencyCode' => @base_currency_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/batch_sync_model.rb

@@ -42,6 +42,7 @@ module LockstepSdk
             @financial_year_settings = params.dig(:financial_year_settings)
             @financial_accounts = params.dig(:financial_accounts)
             @financial_account_balance_histories = params.dig(:financial_account_balance_histories)
+            @base_currencies = params.dig(:base_currencies)
         end
 
         ##
@@ -88,6 +89,10 @@ module LockstepSdk
         # @return [FinancialAccountBalanceHistorySyncModel] A list of FinancialAccountBalanceHistory records to merge with your Lockstep Platform data
         attr_accessor :financial_account_balance_histories
 
+        ##
+        # @return [BaseCurrencySyncModel] A list of BaseCurrency records to merge with your Lockstep Platform data
+        attr_accessor :base_currencies
+
         ##
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
@@ -103,6 +108,7 @@ module LockstepSdk
                 'financialYearSettings' => @financial_year_settings,
                 'financialAccounts' => @financial_accounts,
                 'financialAccountBalanceHistories' => @financial_account_balance_histories,
+                'baseCurrencies' => @base_currencies,
             }
         end
 

data/lib/lockstep_sdk/models/company_details_model.rb

@@ -40,6 +40,7 @@ module LockstepSdk
             @contact_name = params.dig(:contact_name)
             @contact_email = params.dig(:contact_email)
             @outstanding_invoices = params.dig(:outstanding_invoices)
+            @group_base_currency_code = params.dig(:group_base_currency_code)
             @outstanding_amount = params.dig(:outstanding_amount)
             @amount_past_due = params.dig(:amount_past_due)
             @payments = params.dig(:payments)
@@ -114,11 +115,15 @@ module LockstepSdk
         attr_accessor :outstanding_invoices
 
         ##
-        # @return [Double] Company total outstanding invoice amount
+        # @return [String] The group's base currency code.
+        attr_accessor :group_base_currency_code
+
+        ##
+        # @return [Double] Company total outstanding invoice amount in the group's base currency.
         attr_accessor :outstanding_amount
 
         ##
-        # @return [Double] Company total past due amount
+        # @return [Double] Company total past due amount in the group's base currency.
         attr_accessor :amount_past_due
 
         ##
@@ -146,6 +151,7 @@ module LockstepSdk
                 'contactName' => @contact_name,
                 'contactEmail' => @contact_email,
                 'outstandingInvoices' => @outstanding_invoices,
+                'groupBaseCurrencyCode' => @group_base_currency_code,
                 'outstandingAmount' => @outstanding_amount,
                 'amountPastDue' => @amount_past_due,
                 'payments' => @payments,

data/lib/lockstep_sdk/models/company_details_payment_model.rb

@@ -30,8 +30,10 @@ module LockstepSdk
             @invoice_id = params.dig(:invoice_id)
             @invoice_type_code = params.dig(:invoice_type_code)
             @invoice_reference_code = params.dig(:invoice_reference_code)
+            @invoice_currency_code = params.dig(:invoice_currency_code)
             @invoice_total_amount = params.dig(:invoice_total_amount)
             @payment_date = params.dig(:payment_date)
+            @payment_currency_code = params.dig(:payment_currency_code)
             @payment_amount = params.dig(:payment_amount)
         end
 
@@ -63,6 +65,10 @@ module LockstepSdk
         # @return [String] Invoice reference code payment is associated with
         attr_accessor :invoice_reference_code
 
+        ##
+        # @return [String] The currency code of the invoice the payment is associated with.
+        attr_accessor :invoice_currency_code
+
         ##
         # @return [Double] Invoice total amount payment is associated with
         attr_accessor :invoice_total_amount
@@ -71,6 +77,10 @@ module LockstepSdk
         # @return [Date-time] Date payment placed
         attr_accessor :payment_date
 
+        ##
+        # @return [String] The currency code of the payment.
+        attr_accessor :payment_currency_code
+
         ##
         # @return [Double] Amount payment was made for
         attr_accessor :payment_amount
@@ -86,8 +96,10 @@ module LockstepSdk
                 'invoiceId' => @invoice_id,
                 'invoiceTypeCode' => @invoice_type_code,
                 'invoiceReferenceCode' => @invoice_reference_code,
+                'invoiceCurrencyCode' => @invoice_currency_code,
                 'invoiceTotalAmount' => @invoice_total_amount,
                 'paymentDate' => @payment_date,
+                'paymentCurrencyCode' => @payment_currency_code,
                 'paymentAmount' => @payment_amount,
             }
         end

data/lib/lockstep_sdk/models/company_model.rb

@@ -65,6 +65,9 @@ module LockstepSdk
             @app_enrollment_id = params.dig(:app_enrollment_id)
             @email_address = params.dig(:email_address)
             @public_url_slug = params.dig(:public_url_slug)
+            @state_tax_id = params.dig(:state_tax_id)
+            @state_of_incorporation = params.dig(:state_of_incorporation)
+            @linked_in_url_slug = params.dig(:linked_in_url_slug)
             @view_box_settings = params.dig(:view_box_settings)
             @notes = params.dig(:notes)
             @attachments = params.dig(:attachments)
@@ -227,6 +230,18 @@ module LockstepSdk
         # @return [String] The public url slug for the Company.
         attr_accessor :public_url_slug
 
+        ##
+        # @return [String] State Tax ID
+        attr_accessor :state_tax_id
+
+        ##
+        # @return [String] The state where the company was registered.
+        attr_accessor :state_of_incorporation
+
+        ##
+        # @return [String] Linkedin Url
+        attr_accessor :linked_in_url_slug
+
         ##
         # @return [ViewBoxSettingsModel] View box settings for the company logo.
         attr_accessor :view_box_settings
@@ -301,6 +316,9 @@ module LockstepSdk
                 'appEnrollmentId' => @app_enrollment_id,
                 'emailAddress' => @email_address,
                 'publicUrlSlug' => @public_url_slug,
+                'stateTaxId' => @state_tax_id,
+                'stateOfIncorporation' => @state_of_incorporation,
+                'linkedInUrlSlug' => @linked_in_url_slug,
                 'viewBoxSettings' => @view_box_settings,
                 'notes' => @notes,
                 'attachments' => @attachments,

data/lib/lockstep_sdk/models/dpo_summary_group_total_model.rb

@@ -26,6 +26,7 @@ module LockstepSdk
             @group_key = params.dig(:group_key)
             @vendors = params.dig(:vendors)
             @bills = params.dig(:bills)
+            @base_currency_code = params.dig(:base_currency_code)
             @amount_outstanding = params.dig(:amount_outstanding)
             @dpo = params.dig(:dpo)
         end
@@ -43,7 +44,11 @@ module LockstepSdk
         attr_accessor :bills
 
         ##
-        # @return [Double] The total amount outstanding
+        # @return [String] The group's base currency code
+        attr_accessor :base_currency_code
+
+        ##
+        # @return [Double] The total amount outstanding at the group's base currency.
         attr_accessor :amount_outstanding
 
         ##
@@ -57,6 +62,7 @@ module LockstepSdk
                 'groupKey' => @group_key,
                 'vendors' => @vendors,
                 'bills' => @bills,
+                'baseCurrencyCode' => @base_currency_code,
                 'amountOutstanding' => @amount_outstanding,
                 'dpo' => @dpo,
             }

data/lib/lockstep_sdk/models/dpo_summary_model.rb

@@ -28,6 +28,7 @@ module LockstepSdk
             @vendor_name = params.dig(:vendor_name)
             @primary_contact = params.dig(:primary_contact)
             @bills = params.dig(:bills)
+            @base_currency_code = params.dig(:base_currency_code)
             @amount_outstanding = params.dig(:amount_outstanding)
             @dpo = params.dig(:dpo)
         end
@@ -53,7 +54,11 @@ module LockstepSdk
         attr_accessor :bills
 
         ##
-        # @return [Double] The total amount outstanding.
+        # @return [String] The group's base currency code.
+        attr_accessor :base_currency_code
+
+        ##
+        # @return [Double] The total amount outstanding at the group's base currency.
         attr_accessor :amount_outstanding
 
         ##
@@ -69,6 +74,7 @@ module LockstepSdk
                 'vendorName' => @vendor_name,
                 'primaryContact' => @primary_contact,
                 'bills' => @bills,
+                'baseCurrencyCode' => @base_currency_code,
                 'amountOutstanding' => @amount_outstanding,
                 'dpo' => @dpo,
             }

data/lib/lockstep_sdk/models/invoice_summary_model_invoice_summary_totals_model_summary_fetch_result.rb

@@ -21,18 +21,14 @@ module LockstepSdk
         ##
         # Initialize the InvoiceSummaryModelInvoiceSummaryTotalsModelSummaryFetchResult 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 [InvoiceSummaryModel] 
-        attr_accessor :records
-
         ##
         # @return [Int32] 
         attr_accessor :total_count
@@ -45,6 +41,10 @@ module LockstepSdk
         # @return [Int32] 
         attr_accessor :page_number
 
+        ##
+        # @return [InvoiceSummaryModel] 
+        attr_accessor :records
+
         ##
         # @return [InvoiceSummaryTotalsModel] The totals for an Invoice 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/models/payables_coming_due_header_model.rb

@@ -27,6 +27,7 @@ module LockstepSdk
             @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)
+            @base_currency_code = params.dig(:base_currency_code)
             @total_amount_due = params.dig(:total_amount_due)
             @due_date = params.dig(:due_date)
         end
@@ -48,7 +49,11 @@ module LockstepSdk
         attr_accessor :percentage_of_total
 
         ##
-        # @return [Double] Total amount due for this time period
+        # @return [String] The group's base currency code.
+        attr_accessor :base_currency_code
+
+        ##
+        # @return [Double] Total amount due for this time period in the group's base currency.
         attr_accessor :total_amount_due
 
         ##
@@ -63,6 +68,7 @@ module LockstepSdk
                 'numberOfBillsDue' => @number_of_bills_due,
                 'numberOfVendors' => @number_of_vendors,
                 'percentageOfTotal' => @percentage_of_total,
+                'baseCurrencyCode' => @base_currency_code,
                 'totalAmountDue' => @total_amount_due,
                 'dueDate' => @due_date,
             }

data/lib/lockstep_sdk/models/payables_coming_due_model.rb

@@ -29,6 +29,7 @@ module LockstepSdk
             @vendor_name = params.dig(:vendor_name)
             @primary_contact = params.dig(:primary_contact)
             @percentage_of_total = params.dig(:percentage_of_total)
+            @base_currency_code = params.dig(:base_currency_code)
             @total_amount_due = params.dig(:total_amount_due)
             @due_date = params.dig(:due_date)
         end
@@ -58,7 +59,11 @@ module LockstepSdk
         attr_accessor :percentage_of_total
 
         ##
-        # @return [Double] Total amount due for this time period
+        # @return [String] The base currency code of the group
+        attr_accessor :base_currency_code
+
+        ##
+        # @return [Double] Total amount due for this time period at the group's base currency
         attr_accessor :total_amount_due
 
         ##
@@ -75,6 +80,7 @@ module LockstepSdk
                 'vendorName' => @vendor_name,
                 'primaryContact' => @primary_contact,
                 'percentageOfTotal' => @percentage_of_total,
+                'baseCurrencyCode' => @base_currency_code,
                 'totalAmountDue' => @total_amount_due,
                 'dueDate' => @due_date,
             }

data/lib/lockstep_sdk/models/payables_coming_due_widget_model.rb

@@ -25,6 +25,7 @@ module LockstepSdk
         def initialize(params = {})
             @group_key = params.dig(:group_key)
             @date = params.dig(:date)
+            @base_currency_code = params.dig(:base_currency_code)
             @amount_due = params.dig(:amount_due)
         end
 
@@ -37,7 +38,11 @@ module LockstepSdk
         attr_accessor :date
 
         ##
-        # @return [Double] Total amount due for this time period
+        # @return [String] The group's base currency code.
+        attr_accessor :base_currency_code
+
+        ##
+        # @return [Double] Total amount due for this time period at the group's base currency.
         attr_accessor :amount_due
 
         ##
@@ -46,6 +51,7 @@ module LockstepSdk
             {
                 'groupKey' => @group_key,
                 'date' => @date,
+                'baseCurrencyCode' => @base_currency_code,
                 'amountDue' => @amount_due,
             }
         end

data/lib/lockstep_sdk/models/payables_summary_report_model.rb

@@ -25,6 +25,7 @@ module LockstepSdk
         def initialize(params = {})
             @group_key = params.dig(:group_key)
             @timeframe = params.dig(:timeframe)
+            @base_currency_code = params.dig(:base_currency_code)
             @total_payments_amount = params.dig(:total_payments_amount)
             @total_payments_count = params.dig(:total_payments_count)
             @total_amount_billed = params.dig(:total_amount_billed)
@@ -40,7 +41,11 @@ module LockstepSdk
         attr_accessor :timeframe
 
         ##
-        # @return [Double] Amount of payments made based in the timeframe
+        # @return [String] The base currency code of the group.
+        attr_accessor :base_currency_code
+
+        ##
+        # @return [Double] Amount of payments made based in the timeframe in the group's base currency.
         attr_accessor :total_payments_amount
 
         ##
@@ -48,7 +53,7 @@ module LockstepSdk
         attr_accessor :total_payments_count
 
         ##
-        # @return [Double] Amount of bills received based in the timeframe
+        # @return [Double] Amount of bills received based in the timeframe in the group's base currency.
         attr_accessor :total_amount_billed
 
         ##
@@ -61,6 +66,7 @@ module LockstepSdk
             {
                 'groupKey' => @group_key,
                 'timeframe' => @timeframe,
+                'baseCurrencyCode' => @base_currency_code,
                 'totalPaymentsAmount' => @total_payments_amount,
                 'totalPaymentsCount' => @total_payments_count,
                 'totalAmountBilled' => @total_amount_billed,

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/models/status_model.rb

@@ -41,6 +41,8 @@ module LockstepSdk
             @magic_link_id = params.dig(:magic_link_id)
             @magic_link_company_id = params.dig(:magic_link_company_id)
             @magic_link = params.dig(:magic_link)
+            @support_access = params.dig(:support_access)
+            @is_impersonated = params.dig(:is_impersonated)
             @dependencies = params.dig(:dependencies)
             @user_groups = params.dig(:user_groups)
             @base_currency_code = params.dig(:base_currency_code)
@@ -118,6 +120,14 @@ module LockstepSdk
         # @return [MagicLinkStatusModel] Magic link information about the user
         attr_accessor :magic_link
 
+        ##
+        # @return [SupportAccessModel] Information allowing Lockstep to offer direct support to the user
+        attr_accessor :support_access
+
+        ##
+        # @return [Boolean] True if the user is being impersonated by the Lockstep support team.
+        attr_accessor :is_impersonated
+
         ##
         # @return [Object] Statuses for the dependencies of this api. OK if the dependency is working.
         attr_accessor :dependencies
@@ -152,6 +162,8 @@ module LockstepSdk
                 'magicLinkId' => @magic_link_id,
                 'magicLinkCompanyId' => @magic_link_company_id,
                 'magicLink' => @magic_link,
+                'supportAccess' => @support_access,
+                'isImpersonated' => @is_impersonated,
                 'dependencies' => @dependencies,
                 'userGroups' => @user_groups,
                 'baseCurrencyCode' => @base_currency_code,

data/lib/lockstep_sdk/models/support_access_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
+
+    ##
+    # Contains information for Lockstep to support/assist a user.
+    class SupportAccessModel
+
+        ##
+        # Initialize the SupportAccessModel using the provided prototype
+        def initialize(params = {})
+            @code = params.dig(:code)
+            @expires_at = params.dig(:expires_at)
+        end
+
+        ##
+        # @return [String] The code required to assist the user.
+        attr_accessor :code
+
+        ##
+        # @return [Date-time] The UTC date and time when the support access will expire.
+        attr_accessor :expires_at
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'code' => @code,
+                'expiresAt' => @expires_at,
+            }
+        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/support_access_request.rb

@@ -0,0 +1,47 @@
+#
+# 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
+
+    ##
+    # Sets support access data for a user.
+    class SupportAccessRequest
+
+        ##
+        # Initialize the SupportAccessRequest using the provided prototype
+        def initialize(params = {})
+            @expires_at = params.dig(:expires_at)
+        end
+
+        ##
+        # @return [Date-time] The UTC date and time when support access should expire.
+        attr_accessor :expires_at
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'expiresAt' => @expires_at,
+            }
+        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

@@ -28,6 +28,7 @@ module LockstepSdk
             @file_content_url = params.dig(:file_content_url)
             @file_name = params.dig(:file_name)
             @invoice_type_code = params.dig(:invoice_type_code)
+            @transcription_validation_request_id = params.dig(:transcription_validation_request_id)
         end
 
         ##
@@ -47,9 +48,13 @@ module LockstepSdk
         attr_accessor :file_name
 
         ##
-        # @return [String] The type of LockstepApi2.Models.TranscriptionRequestSubmit.InvoiceTypeCode requested to transcribe content to.
+        # @return [String] The type of TranscriptionRequestSubmit.InvoiceTypeCode requested to transcribe content to.
         attr_accessor :invoice_type_code
 
+        ##
+        # @return [Uuid] Group account transcription validation request item is associated with.
+        attr_accessor :transcription_validation_request_id
+
         ##
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
@@ -59,6 +64,7 @@ module LockstepSdk
                 'fileContentUrl' => @file_content_url,
                 'fileName' => @file_name,
                 'invoiceTypeCode' => @invoice_type_code,
+                'transcriptionValidationRequestId' => @transcription_validation_request_id,
             }
         end
 

data/lib/lockstep_sdk/models/{transcription_validation_request_item.rb → transcription_validation_request_item_model.rb}

@@ -18,10 +18,10 @@ module LockstepSdk
 
     ##
     # Represents a transcription validation request item to be validated.
-    class TranscriptionValidationRequestItem
+    class TranscriptionValidationRequestItemModel
 
         ##
-        # Initialize the TranscriptionValidationRequestItem using the provided prototype
+        # Initialize the TranscriptionValidationRequestItemModel 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)

data/lib/lockstep_sdk/models/{transcription_validation_request.rb → transcription_validation_request_model.rb}

@@ -18,10 +18,10 @@ module LockstepSdk
 
     ##
     # Represents a transcription validation request that is used to validate if file is of a specific type.
-    class TranscriptionValidationRequest
+    class TranscriptionValidationRequestModel
 
         ##
-        # Initialize the TranscriptionValidationRequest using the provided prototype
+        # Initialize the TranscriptionValidationRequestModel using the provided prototype
         def initialize(params = {})
             @transcription_validation_request_id = params.dig(:transcription_validation_request_id)
             @group_key = params.dig(:group_key)
@@ -62,7 +62,7 @@ module LockstepSdk
         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.
+        # @return [TranscriptionValidationRequestItemModel] All items attached to this transcription validation request. To retrieve this collection, specify `Items` in the "Include" parameter for your query.
         attr_accessor :items
 
         ##

data/lib/lockstep_sdk/models/webhook_model.rb

@@ -86,7 +86,7 @@ module LockstepSdk
         attr_accessor :expiration_date
 
         ##
-        # @return [Int32] The amount of consecutive failed notifications, not including the current attempt, before marking the webhook as errored (i.e. if the value is set to 0, the webhook will be marked errored on the first failure, if the value is set to 1 the webhook will be marked errored on the second failure, and so on). Use -1 to never mark the webhook as errored due to failures.
+        # @return [Int32] The amount of consecutive failed notifications, not including the current attempt, before marking the webhook as errored (i.e. if the value is set to 0, the webhook will be marked errored on the first failure, if the value is set to 1 the webhook will be marked errored on the second failure, and so on). The maximum retry attempts is 5.
         attr_accessor :retry_count
 
         ##

data/lib/lockstep_sdk/version.rb

@@ -1,3 +1,3 @@
 module LockstepSdk
-    VERSION = "2023.1.3.0"
+    VERSION = "2023.3.18.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockstep_sdk
 version: !ruby/object:Gem::Version
-  version: 2023.1.3.0
+  version: 2023.3.18.0
 platform: ruby
 authors:
 - Lockstep
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-09 00:00:00.000000000 Z
+date: 2023-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awrence
@@ -88,6 +88,7 @@ files:
 - lib/lockstep_sdk/models/at_risk_invoice_summary_model.rb
 - lib/lockstep_sdk/models/attachment_header_info_model.rb
 - lib/lockstep_sdk/models/attachment_model.rb
+- lib/lockstep_sdk/models/base_currency_sync_model.rb
 - lib/lockstep_sdk/models/batch_sync_model.rb
 - lib/lockstep_sdk/models/bulk_currency_conversion_model.rb
 - lib/lockstep_sdk/models/bulk_delete_request_model.rb
@@ -165,6 +166,8 @@ files:
 - lib/lockstep_sdk/models/state_model.rb
 - lib/lockstep_sdk/models/status_model.rb
 - lib/lockstep_sdk/models/summary_aging_totals_model.rb
+- lib/lockstep_sdk/models/support_access_model.rb
+- lib/lockstep_sdk/models/support_access_request.rb
 - lib/lockstep_sdk/models/sync_entity_result_model.rb
 - lib/lockstep_sdk/models/sync_request_model.rb
 - lib/lockstep_sdk/models/sync_submit_model.rb
@@ -173,8 +176,8 @@ files:
 - lib/lockstep_sdk/models/transaction_model_transaction_summary_total_model_summary_fetch_result.rb
 - lib/lockstep_sdk/models/transaction_summary_total_model.rb
 - lib/lockstep_sdk/models/transcription_request_submit.rb
-- lib/lockstep_sdk/models/transcription_validation_request.rb
-- lib/lockstep_sdk/models/transcription_validation_request_item.rb
+- lib/lockstep_sdk/models/transcription_validation_request_item_model.rb
+- lib/lockstep_sdk/models/transcription_validation_request_model.rb
 - lib/lockstep_sdk/models/transfer_owner_model.rb
 - lib/lockstep_sdk/models/transfer_owner_submit_model.rb
 - lib/lockstep_sdk/models/uri_model.rb