lockstep_sdk 2023.5.21.0 → 2023.7.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b06b739d27da3c8618d99c4cea51a76e4769602282bf13b05058fb4dc0e42c1
-  data.tar.gz: 692323ba26707d5fe17e9245463bb113429c460d603bd902741dc5106123eceb
+  metadata.gz: e3c12325f8f3062e6b2f3d0e35abb0bd5c944f21e5fb0f2d98f23d2e65622952
+  data.tar.gz: a7aa6c606e4ffeabf18003028860d241ad8a519ce2bfa46bfa5657683e7b28bc
 SHA512:
-  metadata.gz: 047d3352db233820fba39cc8d6451694c12fda70855181ee75f51cb30de1c93390d7dd2651f4f48779d5f8cddc90ee51d60ff5d16e97cd1dc49cae3e41aadfd9
-  data.tar.gz: 3909a5125f2836863f53c79c2c25fc989c6077bafcea250e01b0dee1c56b75e03ef6391793a3a4deb3d71c80202a018c6e13c0bd4791ac770111bf466f5948a6
+  metadata.gz: 9ef25212f3308858fa81871ec3a82c404c809dc353890420fcdb6fcbe6f57867aa3f14cf5d6caa09b4cacf451cc9b072ea4ff82e1e989a729bd85f9774ce9cd0
+  data.tar.gz: 0b05410aac2c8246eafee1fa7fff4dee557267bdfd2ac8c432ad3621c134aae4d552d119d5b882102e8387cb8fb9d2889e15b101cbd47282b9dca14c25ef7ab5

data/lib/lockstep_sdk/clients/profiles_accounting_contacts_client.rb

@@ -57,20 +57,6 @@ class ProfilesAccountingContactsClient
         @connection.request(:post, path, body, nil)
     end
 
-    ##
-    # Updates an accounting profile contact that matches the specified id with the requested information.
-    #
-    # 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.
-    #
-    # An Accounting Profile Contact has a link to a Contact that is associated with your company's Accounting Profile. A profile has one primary contact and any number of secondary contacts.
-    #
-    # @param id [uuid] The unique Lockstep Platform ID number of the Accounting Profile Contact to update
-    # @param contact_id [uuid] The ID of the contact to link to this Accounting Profile Contact
-    def update_accounting_profile_contact(id:, contact_id:)
-        path = "/api/v1/profiles/accounting/contacts/#{id}/#{contactId}"
-        @connection.request(:patch, path, nil, nil)
-    end
-
     ##
     # Queries Accounting Profile Contacts for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
     #
@@ -110,11 +96,11 @@ class ProfilesAccountingContactsClient
     end
 
     ##
-    # Updates an accounting profile contact that matches the specified id with the primary contact attached to the accounting profile
+    # Reverses the isPrimary fields on the primary and secondary contact to reflect a swap and returns the new primary accounting profile contact model.
     #
     # An Accounting Profile Contact has a link to a Contact that is associated with your company's Accounting Profile. A profile has one primary contact and any number of secondary contacts.
     #
-    # @param id [uuid] The unique Lockstep Platform ID number of the Accounting Profile Contact to update
+    # @param id [uuid] The unique Lockstep Platform ID number of the Accounting Profile Contact to set as primary
     def set_secondary_contact_as_primary(id:)
         path = "/api/v1/profiles/accounting/contacts/#{id}/primary"
         @connection.request(:patch, path, nil, nil)

data/lib/lockstep_sdk/clients/sync_client.rb

@@ -53,10 +53,13 @@ class SyncClient
     #
     # A Sync task represents an action performed by an Application for a particular account.  An Application can provide many different tasks as part of their capabilities.  Sync tasks are executed in the background and will continue running after they are created.  Use one of the creation APIs to request execution of a task. To check on the progress of the task, call GetSync or QuerySync.
     #
+    # @param app_enrollment_id [uuid] The optional existing app enrollment to associate with the data in the zip file.
+    # @param is_full_sync [boolean] True if this is a full sync, false if this is a partial sync. Defaults to false.
     # @param filename [File] The full path of a file to upload to the API
-    def upload_sync_file(filename:)
+    def upload_sync_file(app_enrollment_id:, is_full_sync:, filename:)
         path = "/api/v1/Sync/zip"
-        @connection.request(:post, path, nil, nil)
+        params = {:appEnrollmentId => app_enrollment_id, :isFullSync => is_full_sync}
+        @connection.request(:post, path, nil, params)
     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.5.21
+# @version    2023.7.7
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -198,7 +198,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.5.21.0"
+            @version = "2023.7.7.0"
             @env = case env
                 when "sbx"
                     "https://api.sbx.lockstep.io/"
@@ -312,7 +312,7 @@ module lockstep_sdk
             request["Accept"] = 'application/json'
             request["Content-Type"] = 'application/*+json'
             request["SdkType"] = 'Ruby'
-            request["SdkVersion"] = '2023.5.21.0'
+            request["SdkVersion"] = '2023.7.7.0'
             request["MachineName"] = Socket.gethostname
             request.body = body
 

data/lib/lockstep_sdk/models/batch_sync_model.rb

@@ -31,6 +31,8 @@ module LockstepSdk
         ##
         # Initialize the BatchSyncModel using the provided prototype
         def initialize(params = {})
+            @app_enrollment_id = params.dig(:app_enrollment_id)
+            @is_full_sync = params.dig(:is_full_sync)
             @companies = params.dig(:companies)
             @contacts = params.dig(:contacts)
             @credit_memo_applications = params.dig(:credit_memo_applications)
@@ -45,6 +47,14 @@ module LockstepSdk
             @base_currencies = params.dig(:base_currencies)
         end
 
+        ##
+        # @return [Uuid] The optional existing app enrollment to associate with the data in this batch.
+        attr_accessor :app_enrollment_id
+
+        ##
+        # @return [Boolean] True if this is a full sync, false if this is a partial sync. Defaults to false.
+        attr_accessor :is_full_sync
+
         ##
         # @return [CompanySyncModel] A list of Company records to merge with your Lockstep Platform data
         attr_accessor :companies
@@ -97,6 +107,8 @@ module LockstepSdk
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
             {
+                'appEnrollmentId' => @app_enrollment_id,
+                'isFullSync' => @is_full_sync,
                 'companies' => @companies,
                 'contacts' => @contacts,
                 'creditMemoApplications' => @credit_memo_applications,

data/lib/lockstep_sdk/models/company_model.rb

@@ -71,6 +71,8 @@ module LockstepSdk
             @is_verified = params.dig(:is_verified)
             @last_verified_date = params.dig(:last_verified_date)
             @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)
             @notes = params.dig(:notes)
             @attachments = params.dig(:attachments)
             @contacts = params.dig(:contacts)
@@ -256,6 +258,14 @@ module LockstepSdk
         # @return [ViewBoxSettingsModel] View box settings for the company logo.
         attr_accessor :view_box_settings
 
+        ##
+        # @return [Uuid] The unique ID of the Service Fabric organisation to which this record belongs.
+        attr_accessor :service_fabric_org_id
+
+        ##
+        # @return [Uuid] The unique ID of this record within Service Fabric.
+        attr_accessor :service_fabric_company_id
+
         ##
         # @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
@@ -332,6 +342,8 @@ module LockstepSdk
                 'isVerified' => @is_verified,
                 'lastVerifiedDate' => @last_verified_date,
                 'viewBoxSettings' => @view_box_settings,
+                'serviceFabricOrgId' => @service_fabric_org_id,
+                'serviceFabricCompanyId' => @service_fabric_company_id,
                 'notes' => @notes,
                 'attachments' => @attachments,
                 'contacts' => @contacts,

data/lib/lockstep_sdk/models/payment_model.rb

@@ -53,6 +53,7 @@ module LockstepSdk
             @currency_rate = params.dig(:currency_rate)
             @base_currency_payment_amount = params.dig(:base_currency_payment_amount)
             @base_currency_unapplied_amount = params.dig(:base_currency_unapplied_amount)
+            @service_fabric_status = params.dig(:service_fabric_status)
             @applications = params.dig(:applications)
             @notes = params.dig(:notes)
             @attachments = params.dig(:attachments)
@@ -156,6 +157,10 @@ module LockstepSdk
         # @return [Double] Unapplied balance of this payment in the group's base currency. If this amount is nonzero, the field `IsOpen` will be true.
         attr_accessor :base_currency_unapplied_amount
 
+        ##
+        # @return [String] The status of this payment within Service Fabric. "UNAUTHORISED" "PENDING" "PAID" "PAID_OFFLINE" "FAILED" "CANCELLED" "REJECTED" "REFUNDED" "PARTIALLY" "PARTIALLY_REFUNDED"
+        attr_accessor :service_fabric_status
+
         ##
         # @return [PaymentAppliedModel] All applications this payment is associated with. To retrieve this collection, specify `Applications` in the "Include" parameter for your query.
         attr_accessor :applications
@@ -204,6 +209,7 @@ module LockstepSdk
                 'currencyRate' => @currency_rate,
                 'baseCurrencyPaymentAmount' => @base_currency_payment_amount,
                 'baseCurrencyUnappliedAmount' => @base_currency_unapplied_amount,
+                'serviceFabricStatus' => @service_fabric_status,
                 'applications' => @applications,
                 'notes' => @notes,
                 'attachments' => @attachments,

data/lib/lockstep_sdk/models/sync_request_model.rb

@@ -62,7 +62,7 @@ module LockstepSdk
         attr_accessor :operation_type_name
 
         ##
-        # @return [Int32] The name of the OperationType for this SyncRequest
+        # @return [SyncOperationType] Possible operation types for a SyncRequest
         attr_accessor :operation_type
 
         ##
@@ -74,7 +74,7 @@ module LockstepSdk
         attr_accessor :failure_count
 
         ##
-        # @return [String] A boolean indicating whether a sync from an ERP system should process all the data from the ERP as opposed to just the delta of changes since the previous sync run
+        # @return [Boolean] A boolean indicating whether a sync from an ERP system should process all the data from the ERP as opposed to just the delta of changes since the previous sync run
         attr_accessor :run_full_sync
 
         ##

data/lib/lockstep_sdk/models/transaction_model_transaction_summary_total_model_summary_fetch_result.rb

@@ -21,18 +21,14 @@ module LockstepSdk
         ##
         # Initialize the TransactionModelTransactionSummaryTotalModelSummaryFetchResult 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 [TransactionModel] 
-        attr_accessor :records
-
         ##
         # @return [Int32] 
         attr_accessor :total_count
@@ -45,6 +41,10 @@ module LockstepSdk
         # @return [Int32] 
         attr_accessor :page_number
 
+        ##
+        # @return [TransactionModel] 
+        attr_accessor :records
+
         ##
         # @return [TransactionSummaryTotalModel] Represents transaction summary information based on the query request within the group account.
         attr_accessor :summary
@@ -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.5.21.0"
+    VERSION = "2023.7.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockstep_sdk
 version: !ruby/object:Gem::Version
-  version: 2023.5.21.0
+  version: 2023.7.7.0
 platform: ruby
 authors:
 - Lockstep
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-07 00:00:00.000000000 Z
+date: 2023-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awrence