lockstep_sdk 2023.7.7.0 → 2023.11.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3c12325f8f3062e6b2f3d0e35abb0bd5c944f21e5fb0f2d98f23d2e65622952
-  data.tar.gz: a7aa6c606e4ffeabf18003028860d241ad8a519ce2bfa46bfa5657683e7b28bc
+  metadata.gz: dc1ed33c76a8102443c13fe87194a85b766cb7fe507f696d0ec6a32e5bff01d1
+  data.tar.gz: 381aae0f3e80a840b7aafa210df73d9e2349f0a380ef66562e8f5a00bc5b0a4a
 SHA512:
-  metadata.gz: 9ef25212f3308858fa81871ec3a82c404c809dc353890420fcdb6fcbe6f57867aa3f14cf5d6caa09b4cacf451cc9b072ea4ff82e1e989a729bd85f9774ce9cd0
-  data.tar.gz: 0b05410aac2c8246eafee1fa7fff4dee557267bdfd2ac8c432ad3621c134aae4d552d119d5b882102e8387cb8fb9d2889e15b101cbd47282b9dca14c25ef7ab5
+  metadata.gz: b104bc2508ef1428c60f3d3004af74d666697028cac43b7b289f5f9e8cec3b1f2333245603247cba12fec53fa6aa9676842aa6c576d0ae81837d1bcfc8477b46
+  data.tar.gz: 8ae4e1fc63e8c4181c1e4c4ed8ac9bf1a1eaf84cfc03b81144e9f63540e644355d8d3246c506ce4f9fe6d864817d9f3e0931752b59e639218b971df54ef3995f

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.7.7
+# @version    2023.11.28
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -108,10 +108,6 @@ module lockstep_sdk
         # @return [InvoiceAddressesClient] Client object for InvoiceAddresses endpoints
         attr_accessor :invoice_addresses
 
-        ##
-        # @return [InvoiceHistoryClient] Client object for InvoiceHistory endpoints
-        attr_accessor :invoice_history
-
         ##
         # @return [InvoiceLinesClient] Client object for InvoiceLines endpoints
         attr_accessor :invoice_lines
@@ -198,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.7.7.0"
+            @version = "2023.11.28.0"
             @env = case env
                 when "sbx"
                     "https://api.sbx.lockstep.io/"
@@ -228,7 +224,6 @@ module lockstep_sdk
             @financial_year_settings = FinancialYearSettingsClient.new(self)
             @group_accounts = GroupAccountsClient.new(self)
             @invoice_addresses = InvoiceAddressesClient.new(self)
-            @invoice_history = InvoiceHistoryClient.new(self)
             @invoice_lines = InvoiceLinesClient.new(self)
             @invoices = InvoicesClient.new(self)
             @leads = LeadsClient.new(self)
@@ -312,7 +307,7 @@ module lockstep_sdk
             request["Accept"] = 'application/json'
             request["Content-Type"] = 'application/*+json'
             request["SdkType"] = 'Ruby'
-            request["SdkVersion"] = '2023.7.7.0'
+            request["SdkVersion"] = '2023.11.28.0'
             request["MachineName"] = Socket.gethostname
             request.body = body
 

data/lib/lockstep_sdk/models/application_model.rb

@@ -38,13 +38,11 @@ module LockstepSdk
             @owner_id = params.dig(:owner_id)
             @project_url = params.dig(:project_url)
             @icon_url = params.dig(:icon_url)
-            @price_terms = params.dig(:price_terms)
             @created_user_id = params.dig(:created_user_id)
             @modified_user_id = params.dig(:modified_user_id)
             @created = params.dig(:created)
             @modified = params.dig(:modified)
             @is_active = params.dig(:is_active)
-            @wiki_url = params.dig(:wiki_url)
             @group_key = params.dig(:group_key)
             @b2_cclient_id = params.dig(:b2_cclient_id)
             @notes = params.dig(:notes)
@@ -74,17 +72,13 @@ module LockstepSdk
         attr_accessor :owner_id
 
         ##
-        # @return [Uri] The URL to visit for more information about this application
+        # @return [String] The URL to visit for more information about this application
         attr_accessor :project_url
 
         ##
-        # @return [Uri] The URL for the icon for this application
+        # @return [String] The URL for the icon for this application
         attr_accessor :icon_url
 
-        ##
-        # @return [String] The description of the price for this application
-        attr_accessor :price_terms
-
         ##
         # @return [Uuid] The ID of the user who created this application
         attr_accessor :created_user_id
@@ -105,10 +99,6 @@ module LockstepSdk
         # @return [Boolean] Flag indicating if the application is active.
         attr_accessor :is_active
 
-        ##
-        # @return [Uri] URL to the Wiki for the Application
-        attr_accessor :wiki_url
-
         ##
         # @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
@@ -144,13 +134,11 @@ module LockstepSdk
                 'ownerId' => @owner_id,
                 'projectUrl' => @project_url,
                 'iconUrl' => @icon_url,
-                'priceTerms' => @price_terms,
                 'createdUserId' => @created_user_id,
                 'modifiedUserId' => @modified_user_id,
                 'created' => @created,
                 'modified' => @modified,
                 'isActive' => @is_active,
-                'wikiURL' => @wiki_url,
                 'groupKey' => @group_key,
                 'b2CClientId' => @b2_cclient_id,
                 'notes' => @notes,

data/lib/lockstep_sdk/models/attachment_model.rb

@@ -34,11 +34,7 @@ module LockstepSdk
             @object_key = params.dig(:object_key)
             @file_name = params.dig(:file_name)
             @file_ext = params.dig(:file_ext)
-            @attachment_type_id = params.dig(:attachment_type_id)
             @is_archived = params.dig(:is_archived)
-            @origin_attachment_id = params.dig(:origin_attachment_id)
-            @view_internal = params.dig(:view_internal)
-            @view_external = params.dig(:view_external)
             @erp_key = params.dig(:erp_key)
             @app_enrollment_id = params.dig(:app_enrollment_id)
             @created = params.dig(:created)
@@ -70,26 +66,10 @@ module LockstepSdk
         # @return [String] An Attachment represents a file that was uploaded to the Lockstep Platform. This field contains the original extension name of the file on disk.
         attr_accessor :file_ext
 
-        ##
-        # @return [Uuid] DEPRECATED: This field is replaced by `AttachmentType`.
-        attr_accessor :attachment_type_id
-
         ##
         # @return [Boolean] A flag indicating whether this Attachment is archived (also known as hidden or deleted). When you call [ArchiveAttachment](https://developer.lockstep.io/reference/delete_api-v1-attachments-id) this field will be set to true. You should avoid displaying Attachments with the IsArchived field set to true in your user interface.
         attr_accessor :is_archived
 
-        ##
-        # @return [Uuid] DEPRECATED - Do not use
-        attr_accessor :origin_attachment_id
-
-        ##
-        # @return [Boolean] Flag for if LS clients can see this file
-        attr_accessor :view_internal
-
-        ##
-        # @return [Boolean] Flag for if Vendors and customers can see this file
-        attr_accessor :view_external
-
         ##
         # @return [String] The unique ID of this record as it was known in its originating financial system. If this company record was imported from a financial system, it will have the value `ErpKey` set to the original primary key number of the record as it was known in the originating financial system. If this record was not imported from a financial system, this value will be `null`. For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
         attr_accessor :erp_key
@@ -120,11 +100,7 @@ module LockstepSdk
                 'objectKey' => @object_key,
                 'fileName' => @file_name,
                 'fileExt' => @file_ext,
-                'attachmentTypeId' => @attachment_type_id,
                 'isArchived' => @is_archived,
-                'originAttachmentId' => @origin_attachment_id,
-                'viewInternal' => @view_internal,
-                'viewExternal' => @view_external,
                 'erpKey' => @erp_key,
                 'appEnrollmentId' => @app_enrollment_id,
                 'created' => @created,

data/lib/lockstep_sdk/models/company_model.rb

@@ -73,6 +73,7 @@ module LockstepSdk
             @view_box_settings = params.dig(:view_box_settings)
             @service_fabric_org_id = params.dig(:service_fabric_org_id)
             @service_fabric_company_id = params.dig(:service_fabric_company_id)
+            @company_registration_number = params.dig(:company_registration_number)
             @notes = params.dig(:notes)
             @attachments = params.dig(:attachments)
             @contacts = params.dig(:contacts)
@@ -266,6 +267,10 @@ module LockstepSdk
         # @return [Uuid] The unique ID of this record within Service Fabric.
         attr_accessor :service_fabric_company_id
 
+        ##
+        # @return [String] A unique identification number assigned to the company by the national registration office.
+        attr_accessor :company_registration_number
+
         ##
         # @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 `Company` and the `ObjectKey` set to the `CompanyId` 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
@@ -344,6 +349,7 @@ module LockstepSdk
                 'viewBoxSettings' => @view_box_settings,
                 'serviceFabricOrgId' => @service_fabric_org_id,
                 'serviceFabricCompanyId' => @service_fabric_company_id,
+                'companyRegistrationNumber' => @company_registration_number,
                 'notes' => @notes,
                 'attachments' => @attachments,
                 'contacts' => @contacts,

data/lib/lockstep_sdk/models/company_sync_model.rb

@@ -58,10 +58,11 @@ module LockstepSdk
             @preferred_delivery_method = params.dig(:preferred_delivery_method)
             @email_address = params.dig(:email_address)
             @external_reference = params.dig(:external_reference)
+            @company_registration_number = params.dig(:company_registration_number)
         end
 
         ##
-        # @return [UpdateAction] Indicates what action to take when a sync model has been found during the sync process.
+        # @return [MatchAction] Indicates what action to take when an existing object has been found during the sync process.
         attr_accessor :on_match_action
 
         ##
@@ -168,6 +169,10 @@ module LockstepSdk
         # @return [String] An external reference that identifies the Company from the originating ERP system, separate from the ErpKey.
         attr_accessor :external_reference
 
+        ##
+        # @return [String] A unique identification number assigned to the company by the national registration office.
+        attr_accessor :company_registration_number
+
         ##
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
@@ -199,6 +204,7 @@ module LockstepSdk
                 'preferredDeliveryMethod' => @preferred_delivery_method,
                 'emailAddress' => @email_address,
                 'externalReference' => @external_reference,
+                'companyRegistrationNumber' => @company_registration_number,
             }
         end
 

data/lib/lockstep_sdk/models/contact_sync_model.rb

@@ -31,6 +31,7 @@ module LockstepSdk
         ##
         # Initialize the ContactSyncModel using the provided prototype
         def initialize(params = {})
+            @on_match_action = params.dig(:on_match_action)
             @erp_key = params.dig(:erp_key)
             @company_erp_key = params.dig(:company_erp_key)
             @contact_name = params.dig(:contact_name)
@@ -54,6 +55,10 @@ module LockstepSdk
             @modified = params.dig(:modified)
         end
 
+        ##
+        # @return [MatchAction] Indicates what action to take when an existing object has been found during the sync process.
+        attr_accessor :on_match_action
+
         ##
         # @return [String] This is the primary key of the Contact record. For this field, you should use whatever the contact'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 contact records in a database, whatever the primary key for the contact table is in the database should be the "ErpKey". As some ERP systems don't maintain a unique key for Contacts, we also support syncing Contacts with ERP keys of the form {prefix}|{index}, for example ContactPrefix|1, ContactPrefix|2 and so on. For this reason, please ensure that your Contact ERP keys don't otherwise contain the '|' symbol or that it is replaced by an alternate symbol if they do. For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
         attr_accessor :erp_key
@@ -142,6 +147,7 @@ module LockstepSdk
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
             {
+                'onMatchAction' => @on_match_action,
                 'erpKey' => @erp_key,
                 'companyErpKey' => @company_erp_key,
                 'contactName' => @contact_name,

data/lib/lockstep_sdk/models/credit_memo_applied_sync_model.rb

@@ -31,6 +31,7 @@ module LockstepSdk
         ##
         # Initialize the CreditMemoAppliedSyncModel using the provided prototype
         def initialize(params = {})
+            @on_match_action = params.dig(:on_match_action)
             @erp_key = params.dig(:erp_key)
             @invoice_erp_key = params.dig(:invoice_erp_key)
             @credit_memo_invoice_erp_key = params.dig(:credit_memo_invoice_erp_key)
@@ -41,6 +42,10 @@ module LockstepSdk
             @modified = params.dig(:modified)
         end
 
+        ##
+        # @return [MatchAction] Indicates what action to take when an existing object has been found during the sync process.
+        attr_accessor :on_match_action
+
         ##
         # @return [String] This is the primary key of the Credit Memo Application record. For this field, you should use whatever this transaction's unique identifying number is in the originating system. Search for a unique, non-changing number within the originating financial system for this record. Since Credit Memo Applications are often considered transactions, a typical value to look for will be the transaction ID number, the payment confirmation number, or some other record of this payment. For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
         attr_accessor :erp_key
@@ -77,6 +82,7 @@ module LockstepSdk
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
             {
+                'onMatchAction' => @on_match_action,
                 'erpKey' => @erp_key,
                 'invoiceErpKey' => @invoice_erp_key,
                 'creditMemoInvoiceErpKey' => @credit_memo_invoice_erp_key,

data/lib/lockstep_sdk/models/custom_field_sync_model.rb

@@ -35,6 +35,7 @@ module LockstepSdk
         ##
         # Initialize the CustomFieldSyncModel using the provided prototype
         def initialize(params = {})
+            @on_match_action = params.dig(:on_match_action)
             @erp_key = params.dig(:erp_key)
             @table_key = params.dig(:table_key)
             @custom_field_label = params.dig(:custom_field_label)
@@ -45,6 +46,10 @@ module LockstepSdk
             @modified = params.dig(:modified)
         end
 
+        ##
+        # @return [MatchAction] Indicates what action to take when an existing object has been found during the sync process.
+        attr_accessor :on_match_action
+
         ##
         # @return [String] This is the primary key of the record to which you will attach this custom field. You should provide the identifying number as it is stored in the originating financial system. Search for a unique, non-changing number within the originating financial system for this record. Custom Fields are identified by the `TableKey` and `ErpKey` values together. Example: You have an invoice whose ID number is 100047878, and you wish to store a custom field on that invoice named "ApprovalStatusCode". For the `ErpKey` field, specify the value `100047878`. For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
         attr_accessor :erp_key
@@ -81,6 +86,7 @@ module LockstepSdk
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
             {
+                'onMatchAction' => @on_match_action,
                 'erpKey' => @erp_key,
                 'tableKey' => @table_key,
                 'customFieldLabel' => @custom_field_label,

data/lib/lockstep_sdk/models/developer_account_submit_model.rb

@@ -23,17 +23,12 @@ module LockstepSdk
         ##
         # Initialize the DeveloperAccountSubmitModel using the provided prototype
         def initialize(params = {})
-            @name = params.dig(:name)
             @first_name = params.dig(:first_name)
             @last_name = params.dig(:last_name)
             @email = params.dig(:email)
             @company_name = params.dig(:company_name)
         end
 
-        ##
-        # @return [String] The name of the developer.
-        attr_accessor :name
-
         ##
         # @return [String] The first name of the person requesting the developer account.
         attr_accessor :first_name
@@ -54,7 +49,6 @@ module LockstepSdk
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
             {
-                'name' => @name,
                 'firstName' => @first_name,
                 'lastName' => @last_name,
                 'email' => @email,

data/lib/lockstep_sdk/models/financial_account_sync_model.rb

@@ -31,6 +31,7 @@ module LockstepSdk
         ##
         # Initialize the FinancialAccountSyncModel using the provided prototype
         def initialize(params = {})
+            @on_match_action = params.dig(:on_match_action)
             @code = params.dig(:code)
             @erp_key = params.dig(:erp_key)
             @name = params.dig(:name)
@@ -42,6 +43,10 @@ module LockstepSdk
             @subcategory = params.dig(:subcategory)
         end
 
+        ##
+        # @return [MatchAction] Indicates what action to take when an existing object has been found during the sync process.
+        attr_accessor :on_match_action
+
         ##
         # @return [String] The code for the Financial Account. Can either be a general ledger or an account code.
         attr_accessor :code
@@ -82,6 +87,7 @@ module LockstepSdk
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
             {
+                'onMatchAction' => @on_match_action,
                 'code' => @code,
                 'erpKey' => @erp_key,
                 'name' => @name,

data/lib/lockstep_sdk/models/group_account_model.rb

@@ -34,6 +34,7 @@ module LockstepSdk
             @created_user_id = params.dig(:created_user_id)
             @modified = params.dig(:modified)
             @modified_user_id = params.dig(:modified_user_id)
+            @country_code = params.dig(:country_code)
         end
 
         ##
@@ -80,6 +81,10 @@ module LockstepSdk
         # @return [Uuid] The ID of the user who last modified this group account
         attr_accessor :modified_user_id
 
+        ##
+        # @return [String] The 2-letter ISO country code for the group
+        attr_accessor :country_code
+
         ##
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
@@ -95,6 +100,7 @@ module LockstepSdk
                 'createdUserId' => @created_user_id,
                 'modified' => @modified,
                 'modifiedUserId' => @modified_user_id,
+                'countryCode' => @country_code,
             }
         end
 

data/lib/lockstep_sdk/models/invoice_line_sync_model.rb

@@ -31,6 +31,7 @@ module LockstepSdk
         ##
         # Initialize the InvoiceLineSyncModel using the provided prototype
         def initialize(params = {})
+            @on_match_action = params.dig(:on_match_action)
             @erp_key = params.dig(:erp_key)
             @invoice_erp_key = params.dig(:invoice_erp_key)
             @line_number = params.dig(:line_number)
@@ -75,6 +76,10 @@ module LockstepSdk
             @modified = params.dig(:modified)
         end
 
+        ##
+        # @return [MatchAction] Indicates what action to take when an existing object has been found during the sync process.
+        attr_accessor :on_match_action
+
         ##
         # @return [String] This is the primary key of the Invoice Line record. For this field, you should use whatever the contact'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 invoice line records in a database, whatever the primary key for the invoice line table is in the database should be the "ErpKey". For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
         attr_accessor :erp_key
@@ -247,6 +252,7 @@ module LockstepSdk
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
             {
+                'onMatchAction' => @on_match_action,
                 'erpKey' => @erp_key,
                 'invoiceErpKey' => @invoice_erp_key,
                 'lineNumber' => @line_number,

data/lib/lockstep_sdk/models/invoice_sync_model.rb

@@ -31,6 +31,7 @@ module LockstepSdk
         ##
         # Initialize the InvoiceSyncModel using the provided prototype
         def initialize(params = {})
+            @on_match_action = params.dig(:on_match_action)
             @erp_key = params.dig(:erp_key)
             @company_erp_key = params.dig(:company_erp_key)
             @customer_erp_key = params.dig(:customer_erp_key)
@@ -92,6 +93,10 @@ module LockstepSdk
             @base_currency_outstanding_balance_amount = params.dig(:base_currency_outstanding_balance_amount)
         end
 
+        ##
+        # @return [MatchAction] Indicates what action to take when an existing object has been found during the sync process.
+        attr_accessor :on_match_action
+
         ##
         # @return [String] This is the primary key of the Invoice record. For this field, you should use whatever the invoice'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 invoice records in a database, whatever the primary key for the invoice table is in the database should be the "ErpKey". For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
         attr_accessor :erp_key
@@ -332,6 +337,7 @@ module LockstepSdk
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
             {
+                'onMatchAction' => @on_match_action,
                 'erpKey' => @erp_key,
                 'companyErpKey' => @company_erp_key,
                 'customerErpKey' => @customer_erp_key,

data/lib/lockstep_sdk/models/payment_applied_sync_model.rb

@@ -31,6 +31,7 @@ module LockstepSdk
         ##
         # Initialize the PaymentAppliedSyncModel using the provided prototype
         def initialize(params = {})
+            @on_match_action = params.dig(:on_match_action)
             @erp_key = params.dig(:erp_key)
             @invoice_erp_key = params.dig(:invoice_erp_key)
             @payment_erp_key = params.dig(:payment_erp_key)
@@ -41,6 +42,10 @@ module LockstepSdk
             @modified = params.dig(:modified)
         end
 
+        ##
+        # @return [MatchAction] Indicates what action to take when an existing object has been found during the sync process.
+        attr_accessor :on_match_action
+
         ##
         # @return [String] This is the primary key of the Payment Application record. For this field, you should use whatever this transaction's unique identifying number is in the originating system. Search for a unique, non-changing number within the originating financial system for this record. Since Payment Applications are often considered transactions, a typical value to look for will be the transaction ID number, the payment confirmation number, or some other record of this payment. For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
         attr_accessor :erp_key
@@ -77,6 +82,7 @@ module LockstepSdk
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
             {
+                'onMatchAction' => @on_match_action,
                 'erpKey' => @erp_key,
                 'invoiceErpKey' => @invoice_erp_key,
                 'paymentErpKey' => @payment_erp_key,

data/lib/lockstep_sdk/models/payment_model.rb

@@ -110,7 +110,7 @@ module LockstepSdk
         attr_accessor :unapplied_amount
 
         ##
-        # @return [String] The ISO 4217 currency code for this payment. For a list of ISO 4217 currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies). This will be validated by the /api/v1/definitions/currencies data set
+        # @return [String] The ISO 4217 currency code for this payment. For a list of ISO 4217 currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies).
         attr_accessor :currency_code
 
         ##

data/lib/lockstep_sdk/models/payment_sync_model.rb

@@ -31,6 +31,7 @@ module LockstepSdk
         ##
         # Initialize the PaymentSyncModel using the provided prototype
         def initialize(params = {})
+            @on_match_action = params.dig(:on_match_action)
             @erp_key = params.dig(:erp_key)
             @company_erp_key = params.dig(:company_erp_key)
             @payment_type = params.dig(:payment_type)
@@ -52,6 +53,10 @@ module LockstepSdk
             @base_currency_unapplied_amount = params.dig(:base_currency_unapplied_amount)
         end
 
+        ##
+        # @return [MatchAction] Indicates what action to take when an existing object has been found during the sync process.
+        attr_accessor :on_match_action
+
         ##
         # @return [String] This is the primary key of the Payment record. For this field, you should use whatever the payment'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 payment records in a database, whatever the primary key for the payment table is in the database should be the "ErpKey". For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
         attr_accessor :erp_key
@@ -132,6 +137,7 @@ module LockstepSdk
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
             {
+                'onMatchAction' => @on_match_action,
                 'erpKey' => @erp_key,
                 'companyErpKey' => @company_erp_key,
                 'paymentType' => @payment_type,

data/lib/lockstep_sdk/models/status_model.rb

@@ -38,14 +38,15 @@ module LockstepSdk
             @environment = params.dig(:environment)
             @version = params.dig(:version)
             @onboarding_scheduled = params.dig(:onboarding_scheduled)
+            @base_currency_code = params.dig(:base_currency_code)
+            @country_code = params.dig(:country_code)
             @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)
+            @dependencies = params.dig(:dependencies)
         end
 
         ##
@@ -108,6 +109,14 @@ 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 [String] Base Currency of the group
+        attr_accessor :base_currency_code
+
+        ##
+        # @return [String] Country code of the group
+        attr_accessor :country_code
+
         ##
         # @return [Uuid] The id of the Magic link used to authenticate.
         attr_accessor :magic_link_id
@@ -128,17 +137,13 @@ module LockstepSdk
         # @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
-
         ##
         # @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] Statuses for the dependencies of this api. OK if the dependency is working.
+        attr_accessor :dependencies
 
         ##
         # @return [object] This object as a JSON key-value structure
@@ -159,14 +164,15 @@ module LockstepSdk
                 'environment' => @environment,
                 'version' => @version,
                 'onboardingScheduled' => @onboarding_scheduled,
+                'baseCurrencyCode' => @base_currency_code,
+                'countryCode' => @country_code,
                 '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,
+                'dependencies' => @dependencies,
             }
         end
 

data/lib/lockstep_sdk/version.rb

@@ -1,3 +1,3 @@
 module LockstepSdk
-    VERSION = "2023.7.7.0"
+    VERSION = "2023.11.28.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockstep_sdk
 version: !ruby/object:Gem::Version
-  version: 2023.7.7.0
+  version: 2023.11.28.0
 platform: ruby
 authors:
 - Lockstep
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-16 00:00:00.000000000 Z
+date: 2023-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awrence
@@ -51,7 +51,6 @@ files:
 - lib/lockstep_sdk/clients/financial_year_settings_client.rb
 - lib/lockstep_sdk/clients/group_accounts_client.rb
 - lib/lockstep_sdk/clients/invoice_addresses_client.rb
-- lib/lockstep_sdk/clients/invoice_history_client.rb
 - lib/lockstep_sdk/clients/invoice_lines_client.rb
 - lib/lockstep_sdk/clients/invoices_client.rb
 - lib/lockstep_sdk/clients/leads_client.rb
@@ -139,7 +138,6 @@ files:
 - lib/lockstep_sdk/models/invite_model.rb
 - lib/lockstep_sdk/models/invite_submit_model.rb
 - lib/lockstep_sdk/models/invoice_address_model.rb
-- lib/lockstep_sdk/models/invoice_history_model.rb
 - lib/lockstep_sdk/models/invoice_line_model.rb
 - lib/lockstep_sdk/models/invoice_line_sync_model.rb
 - lib/lockstep_sdk/models/invoice_model.rb

data/lib/lockstep_sdk/clients/invoice_history_client.rb

@@ -1,53 +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 'awrence'
-
-class InvoiceHistoryClient
-
-    ##
-    # Initialize the InvoiceHistoryClient class with an API client instance.
-    # @param connection [LockstepApi] The API client object for this connection
-    def initialize(connection)
-        @connection = connection
-    end
-
-
-    ##
-    # Retrieves the history of the Invoice specified by this unique identifier.
-    #
-    # An Invoice represents a bill sent from one company to another.  The Lockstep Platform tracks changes to each Invoice so that you can observe the changes over time.  You can view the InvoiceHistory list to monitor and observe the changes of this Invoice and track the dates when changes occurred.
-    #
-    # @param id [uuid] The unique Lockstep Platform ID number of this invoice; NOT the customer's ERP key
-    def retrieve_invoice_history(id:)
-        path = "/api/v1/InvoiceHistory/#{id}"
-        @connection.request(:get, path, nil, nil)
-    end
-
-    ##
-    # Queries Invoice History for this account using the specified filtering, sorting, and pagination rules requested.
-    #
-    # An Invoice represents a bill sent from one company to another.  The Lockstep Platform tracks changes to each Invoice so that you can observe the changes over time.  You can view the InvoiceHistory list to monitor and observe the changes of this Invoice and track the dates when changes occurred.
-    #
-    # @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 for querying but may be available in the future.
-    # @param order [string] The sort order for this query. See 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_invoice_history(filter:, include_param:, order:, page_size:, page_number:)
-        path = "/api/v1/InvoiceHistory/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/models/invoice_history_model.rb

@@ -1,247 +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
-
-    ##
-    # An Invoice represents a bill sent from one company to another.  The Lockstep Platform tracks changes to
-    # each Invoice so that you can observe the changes over time.  You can view the InvoiceHistory list to
-    # monitor and observe the changes of this Invoice and track the dates when changes occurred.
-    class InvoiceHistoryModel
-
-        ##
-        # Initialize the InvoiceHistoryModel using the provided prototype
-        def initialize(params = {})
-            @group_key = params.dig(:group_key)
-            @invoice_history_id = params.dig(:invoice_history_id)
-            @invoice_id = params.dig(:invoice_id)
-            @company_id = params.dig(:company_id)
-            @customer_id = params.dig(:customer_id)
-            @erp_key = params.dig(:erp_key)
-            @purchase_order_code = params.dig(:purchase_order_code)
-            @reference_code = params.dig(:reference_code)
-            @salesperson_code = params.dig(:salesperson_code)
-            @salesperson_name = params.dig(:salesperson_name)
-            @invoice_type_code = params.dig(:invoice_type_code)
-            @invoice_status_code = params.dig(:invoice_status_code)
-            @terms_code = params.dig(:terms_code)
-            @special_terms = params.dig(:special_terms)
-            @currency_code = params.dig(:currency_code)
-            @total_amount = params.dig(:total_amount)
-            @sales_tax_amount = params.dig(:sales_tax_amount)
-            @discount_amount = params.dig(:discount_amount)
-            @outstanding_balance_amount = params.dig(:outstanding_balance_amount)
-            @invoice_date = params.dig(:invoice_date)
-            @discount_date = params.dig(:discount_date)
-            @posted_date = params.dig(:posted_date)
-            @invoice_closed_date = params.dig(:invoice_closed_date)
-            @payment_due_date = params.dig(:payment_due_date)
-            @imported_date = params.dig(:imported_date)
-            @primary_origin_address_id = params.dig(:primary_origin_address_id)
-            @primary_bill_to_address_id = params.dig(:primary_bill_to_address_id)
-            @primary_ship_to_address_id = params.dig(:primary_ship_to_address_id)
-            @created = params.dig(:created)
-            @created_user_id = params.dig(:created_user_id)
-            @modified = params.dig(:modified)
-            @modified_user_id = params.dig(:modified_user_id)
-            @app_enrollment_id = params.dig(:app_enrollment_id)
-            @currency_rate = params.dig(:currency_rate)
-        end
-
-        ##
-        # @return [Uuid] The GroupKey uniquely identifies a single Lockstep Platform account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created. For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
-        attr_accessor :group_key
-
-        ##
-        # @return [Uuid] The unique ID number of this invoice history entry.
-        attr_accessor :invoice_history_id
-
-        ##
-        # @return [Uuid] The unique ID of the Invoice represented by this history entry. This ID was automatically assigned by Lockstep to the Invoice record when it was added to the Lockstep platform. For the ID of this record in its originating financial system, see `ErpKey`.
-        attr_accessor :invoice_id
-
-        ##
-        # @return [Uuid] The ID number of the company that created this invoice.
-        attr_accessor :company_id
-
-        ##
-        # @return [Uuid] The ID number of the counterparty for the invoice, for example, a customer or vendor.
-        attr_accessor :customer_id
-
-        ##
-        # @return [String] The unique ID of this record as it was known in its originating financial system. If this company record was imported from a financial system, it will have the value `ErpKey` set to the original primary key number of the record as it was known in the originating financial system. If this record was not imported, this value will be `null`. For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
-        attr_accessor :erp_key
-
-        ##
-        # @return [String] The purchase order code as it exists in the user's ERP or accounting system.
-        attr_accessor :purchase_order_code
-
-        ##
-        # @return [String] An additional reference code that is sometimes used to identify this invoice. The meaning of this field is specific to the ERP or accounting system used by the user.
-        attr_accessor :reference_code
-
-        ##
-        # @return [String] A code identifying the salesperson responsible for writing this invoice.
-        attr_accessor :salesperson_code
-
-        ##
-        # @return [String] A string identifying the salesperson responsible for writing this invoice.
-        attr_accessor :salesperson_name
-
-        ##
-        # @return [String] A code identifying the type of this invoice.
-        attr_accessor :invoice_type_code
-
-        ##
-        # @return [String] A code identifying the status of this invoice.
-        attr_accessor :invoice_status_code
-
-        ##
-        # @return [String] A code identifying the terms given to the purchaser.
-        attr_accessor :terms_code
-
-        ##
-        # @return [String] If the customer negotiated any special terms different from the standard terms above, describe them here.
-        attr_accessor :special_terms
-
-        ##
-        # @return [String] The three-character ISO 4217 currency code used for this invoice. This will be validated by the /api/v1/definitions/currencies data set
-        attr_accessor :currency_code
-
-        ##
-        # @return [Double] The total value of this invoice, inclusive of all taxes and line items.
-        attr_accessor :total_amount
-
-        ##
-        # @return [Double] The total sales (or transactional) tax calculated for this invoice.
-        attr_accessor :sales_tax_amount
-
-        ##
-        # @return [Double] The total discounts given by the seller to the buyer on this invoice.
-        attr_accessor :discount_amount
-
-        ##
-        # @return [Double] The remaining balance value of this invoice.
-        attr_accessor :outstanding_balance_amount
-
-        ##
-        # @return [Date] The reporting date for this invoice.
-        attr_accessor :invoice_date
-
-        ##
-        # @return [Date] The date when discounts were adjusted for this invoice.
-        attr_accessor :discount_date
-
-        ##
-        # @return [Date] The date when this invoice posted to the company's general ledger.
-        attr_accessor :posted_date
-
-        ##
-        # @return [Date] The date when the invoice was closed and finalized after completion of all payments and delivery of all products and services.
-        attr_accessor :invoice_closed_date
-
-        ##
-        # @return [Date] The date when the remaining outstanding balance is due.
-        attr_accessor :payment_due_date
-
-        ##
-        # @return [Date-time] The date and time when this record was imported from the user's ERP or accounting system.
-        attr_accessor :imported_date
-
-        ##
-        # @return [Uuid] The ID number of the invoice's origination address
-        attr_accessor :primary_origin_address_id
-
-        ##
-        # @return [Uuid] The ID number of the invoice's bill-to address
-        attr_accessor :primary_bill_to_address_id
-
-        ##
-        # @return [Uuid] The ID number of the invoice's ship-to address
-        attr_accessor :primary_ship_to_address_id
-
-        ##
-        # @return [Date-time] The date on which this invoice record was created.
-        attr_accessor :created
-
-        ##
-        # @return [Uuid] The ID number of the user who created this invoice.
-        attr_accessor :created_user_id
-
-        ##
-        # @return [Date-time] The date on which this invoice record was last modified.
-        attr_accessor :modified
-
-        ##
-        # @return [Uuid] The ID number of the user who most recently modified this invoice.
-        attr_accessor :modified_user_id
-
-        ##
-        # @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 [Double] The Currency Rate used to get from the account's base currency to the invoice amount.
-        attr_accessor :currency_rate
-
-        ##
-        # @return [object] This object as a JSON key-value structure
-        def as_json(options={})
-            {
-                'groupKey' => @group_key,
-                'invoiceHistoryId' => @invoice_history_id,
-                'invoiceId' => @invoice_id,
-                'companyId' => @company_id,
-                'customerId' => @customer_id,
-                'erpKey' => @erp_key,
-                'purchaseOrderCode' => @purchase_order_code,
-                'referenceCode' => @reference_code,
-                'salespersonCode' => @salesperson_code,
-                'salespersonName' => @salesperson_name,
-                'invoiceTypeCode' => @invoice_type_code,
-                'invoiceStatusCode' => @invoice_status_code,
-                'termsCode' => @terms_code,
-                'specialTerms' => @special_terms,
-                'currencyCode' => @currency_code,
-                'totalAmount' => @total_amount,
-                'salesTaxAmount' => @sales_tax_amount,
-                'discountAmount' => @discount_amount,
-                'outstandingBalanceAmount' => @outstanding_balance_amount,
-                'invoiceDate' => @invoice_date,
-                'discountDate' => @discount_date,
-                'postedDate' => @posted_date,
-                'invoiceClosedDate' => @invoice_closed_date,
-                'paymentDueDate' => @payment_due_date,
-                'importedDate' => @imported_date,
-                'primaryOriginAddressId' => @primary_origin_address_id,
-                'primaryBillToAddressId' => @primary_bill_to_address_id,
-                'primaryShipToAddressId' => @primary_ship_to_address_id,
-                'created' => @created,
-                'createdUserId' => @created_user_id,
-                'modified' => @modified,
-                'modifiedUserId' => @modified_user_id,
-                'appEnrollmentId' => @app_enrollment_id,
-                'currencyRate' => @currency_rate,
-            }
-        end
-
-        ##
-        # @return [String] This object converted to a JSON string
-        def to_json(*options)
-            "[#{as_json(*options).to_json(*options)}]"
-        end
-    end
-end