lockstep_sdk 2022.26.12.0 → 2022.33.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8dd5a349eb67e94638b549c030c9f0d14b4949a89678e7ce25569d021002af6f
-  data.tar.gz: 43763005c70106c342563f4de7e628974196db5c437d61b75954041ccb8fe23b
+  metadata.gz: ff91eee944f6ed1299763d2652ae74b4cd0dde8ae9b0df52e682d014f7dc34f9
+  data.tar.gz: 47ec24af6e5b7282423ca45b5949a677fc5c22064761fb9a646f22aa806db59f
 SHA512:
-  metadata.gz: 00a438f056a6adf07587662642cd9c4180e4e2c7190f995a5b1aa378712ceda3c11fde8b1e129e32e09a68bc233d0aa8c95d61d53bc606e6dde6d6aaffc5ec6d
-  data.tar.gz: 30f50f191c364290777a83ff0416ffeb19b3c096dd3bd1d3cbe3ac03fab01d98dc04368c125959c2b97106f2cde3d097db8c06132806af7e95bebc7b18955d8c
+  metadata.gz: 9c21ea30bfefb763acf318b3afc43fc087bfdca695e492c1ebde895aa1dbc641c8c058402bc7d26e96ab1eafe66caa34655217441b55f8ca4ca89377e23330c0
+  data.tar.gz: 13ee2ae0e4a5f5d866f8ba163658e142b9f7bb677dc44250e5b9cebe748e9aae11d5d95943d02d4a7f5f724ebe81e4d1b1d03ea9d6868f98850a3cbff50b85a5

data/lib/lockstep_sdk/clients/app_enrollments_client.rb

@@ -75,20 +75,22 @@ class AppEnrollmentsClient
     #
     # See [Applications and Enrollments](https://developer.lockstep.io/docs/applications-and-enrollments) for more information.
     #
+    # @param start_sync [boolean] Option to start sync immediately after creation of app enrollments (default false)
     # @param body [AppEnrollmentModel] The App Enrollments to create
-    def create_app_enrollments(body:)
+    def create_app_enrollments(start_sync:, body:)
         path = "/api/v1/AppEnrollments"
-        @connection.request(:post, path, body, nil)
+        params = {:startSync => start_sync}
+        @connection.request(:post, path, body, params)
     end
 
     ##
     # Updates the OAuth settings associated with this App Enrollment
     #
-    # @param id [uuid] 
-    # @param body [string] 
+    # @param id [uuid] The unique ID number of the App Enrollment to reconnect
+    # @param body [AppEnrollmentReconnectRequest] Information to reconnect the App Enrollment
     def reconnect_app_enrollment_oauth(id:, body:)
         path = "/api/v1/AppEnrollments/#{id}/reconnect"
-        @connection.request(:patch, path, body, nil)
+        @connection.request(:post, path, body, nil)
     end
 
     ##

data/lib/lockstep_sdk/clients/companies_client.rb

@@ -115,9 +115,10 @@ class CompaniesClient
     # @param order [string] The sort order for the results, in the [Searchlight order syntax](https://github.com/tspence/csharp-searchlight).
     # @param page_size [int32] The page size for results (default 200, maximum of 10,000)
     # @param page_number [int32] The page number for results (default 0)
-    def query_customer_summary(filter:, include_param:, order:, page_size:, page_number:)
+    # @param report_date [date-time] The date to calculate the fields on. If no date is entered the current UTC date will be used.
+    def query_customer_summary(filter:, include_param:, order:, page_size:, page_number:, report_date:)
         path = "/api/v1/Companies/views/customer-summary"
-        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number, :reportDate => report_date}
         @connection.request(:get, path, nil, params)
     end
 
@@ -135,9 +136,10 @@ class CompaniesClient
     # @param order [string] The sort order for the results, in the [Searchlight order syntax](https://github.com/tspence/csharp-searchlight).
     # @param page_size [int32] The page size for results (default 200, maximum of 10,000)
     # @param page_number [int32] The page number for results (default 0)
-    def query_vendor_summary(filter:, include_param:, order:, page_size:, page_number:)
+    # @param report_date [date-time] The date to calculate the fields on. If no date is entered the current UTC date will be used.
+    def query_vendor_summary(filter:, include_param:, order:, page_size:, page_number:, report_date:)
         path = "/api/v1/Companies/views/vendor-summary"
-        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number, :reportDate => report_date}
         @connection.request(:get, path, nil, params)
     end
 
@@ -153,4 +155,20 @@ class CompaniesClient
         path = "/api/v1/Companies/views/details/#{id}"
         @connection.request(:get, path, nil, nil)
     end
+
+    ##
+    # Sets the logo for specified company. The logo will be stored in the Lockstep Platform and will be **publicly accessible**.
+    #
+    # .jpg, .jpeg, and .png are supported. 5MB maximum. If no logo is uploaded, the existing logo will be deleted.
+    #
+    # A Company represents a customer, a vendor, or a company within the organization of the account holder. Companies can have parents and children, representing an organizational hierarchy of corporate entities. You can use Companies to track projects and financial data under this Company label.
+    #
+    # See [Vendors, Customers, and Companies](https://developer.lockstep.io/docs/companies-customers-and-vendors) for more information.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of this Company; NOT the customer's ERP key
+    # @param filename [File] The full path of a file to upload to the API
+    def set_company_logo(id:, filename:)
+        path = "/api/v1/Companies/#{id}/logo"
+        @connection.request(:post, path, nil, nil)
+    end
 end

data/lib/lockstep_sdk/clients/credit_memo_applied_client.rb

@@ -30,7 +30,7 @@ class CreditMemoAppliedClient
     # Credit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds. Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice, Lockstep creates a Credit Memo Application record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Application records to track which Invoices were paid using this Credit.
     #
     # @param id [uuid] The unique Lockstep Platform ID number of this Credit Memo Application; NOT the customer's ERP key
-    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Attachments, CustomFields, Notes
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Attachments, CustomFields, Notes, Invoice, CreditMemoInvoice
     def retrieve_credit_memo_application(id:, include_param:)
         path = "/api/v1/CreditMemoApplied/#{id}"
         params = {:include => include_param}

data/lib/lockstep_sdk/clients/reports_client.rb

@@ -53,9 +53,11 @@ class ReportsClient
     #
     # Daily Sales Outstanding, or DSO, is a metric that indicates the average number of days that it takes for an invoice to be fully paid.  You can use this report to identify whether a company is improving on its ability to collect on invoices.
     #
-    def daily_sales_outstanding()
+    # @param report_date [date-time] Optional: Specify the specific report date to generate the from (default UTC now)
+    def daily_sales_outstanding(report_date:)
         path = "/api/v1/Reports/dailysalesoutstanding"
-        @connection.request(:get, path, nil, nil)
+        params = {:reportDate => report_date}
+        @connection.request(:get, path, nil, params)
     end
 
     ##

data/lib/lockstep_sdk/clients/status_client.rb

@@ -33,18 +33,4 @@ class StatusClient
         path = "/api/v1/Status"
         @connection.request(:get, path, nil, nil)
     end
-
-    ##
-    # Generates an error code that your program may use to test handling of common types of error conditions.
-    #
-    # * If you specify `?err=500`, you will receive a 500 internal server error. * If you specify `?err=timeout`, the API will stall for 90 seconds and then return 200 OK.  Many network connections will drop after 60 seconds of no activity. * If you do not specify any of these errors, the API will return 200 OK.
-    #
-    # The Error Test API allows you to test whether your client program is capable of handling certain types of error codes.  Developers writing libraries may find it useful to create integration tests that verify that their code can correctly detect the difference between a validation error resulting in a 400 error code, a network timeout resulting in a broken network connection, and a server error resulting in a 500 error code.  You may use the Error Test API to verify that your code is able to identify and handle these cases correctly.
-    #
-    # @param err [string] The type of error test to execute. Supported error types: 500, timeout
-    def error_test(err:)
-        path = "/api/v1/Status/testing"
-        params = {:err => err}
-        @connection.request(:get, path, nil, params)
-    end
 end

data/lib/lockstep_sdk/clients/webhooks_client.rb

@@ -92,13 +92,14 @@ class WebhooksClient
     #
     #
     # @param webhook_id [uuid] The unique Lockstep Platform ID number of this Webhook
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collection: Records, RequestMessage, ResponseMessage
     # @param filter [string] The filter for this query. See [Azure Query Language](https://docs.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities)
     # @param select [string] The selection for this query. Selection is the desired properties of an entity to pull from the set. If a property is not selected, it will either return as null or empty. See [Azure Query Language](https://docs.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities)
     # @param page_size [int32] The page size for results (default 200).
     # @param page_number [int32] The page number for results (default 0).
-    def query_webhook_history(webhook_id:, filter:, select:, page_size:, page_number:)
+    def query_webhook_history(webhook_id:, include_param:, filter:, select:, page_size:, page_number:)
         path = "/api/v1/Webhooks/#{webhookId}/history/query"
-        params = {:filter => filter, :select => select, :pageSize => page_size, :pageNumber => page_number}
+        params = {:include => include_param, :filter => filter, :select => select, :pageSize => page_size, :pageNumber => page_number}
         @connection.request(:get, 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-2022 Lockstep, Inc.
-# @version    2022.26.12
+# @version    2022.33.14
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -166,7 +166,7 @@ module lockstep_sdk
         #
         # @param env [string] Either "sbx", "prd", or the URI of the server, ending in a slash (/)
         def initialize(env)
-            @version = "2022.26.12.0"
+            @version = "2022.33.14.0"
             @env = case env
                 when "sbx"
                     "https://api.sbx.lockstep.io/"
@@ -272,7 +272,7 @@ module lockstep_sdk
             request["Accept"] = 'application/json'
             request["Content-Type"] = 'application/*+json'
             request["SdkType"] = 'Ruby'
-            request["SdkVersion"] = '2022.26.12.0'
+            request["SdkVersion"] = '2022.33.14.0'
             request["MachineName"] = Socket.gethostname
             request.body = body
 

data/lib/lockstep_sdk/models/app_enrollment_reconnect_request.rb

@@ -0,0 +1,47 @@
+#
+# Lockstep Platform SDK for Ruby
+#
+# (c) 2021-2022 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Lockstep Network <support@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # Information to reconnect an ERP.
+    class AppEnrollmentReconnectRequest
+
+        ##
+        # Initialize the AppEnrollmentReconnectRequest using the provided prototype
+        def initialize(params = {})
+            @auth_code = params.dig(:auth_code)
+        end
+
+        ##
+        # @return [String] The OAuth authentication code.
+        attr_accessor :auth_code
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'authCode' => @auth_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

@@ -39,6 +39,9 @@ module LockstepSdk
             @custom_fields = params.dig(:custom_fields)
             @payments = params.dig(:payments)
             @payment_applications = params.dig(:payment_applications)
+            @financial_year_settings = params.dig(:financial_year_settings)
+            @financial_accounts = params.dig(:financial_accounts)
+            @financial_account_balance_histories = params.dig(:financial_account_balance_histories)
         end
 
         ##
@@ -73,6 +76,18 @@ module LockstepSdk
         # @return [PaymentAppliedSyncModel] A list of PaymentApplied records to merge with your Lockstep Platform data
         attr_accessor :payment_applications
 
+        ##
+        # @return [FinancialYearSettingSyncModel] A list of FinancialYearSetting records to merge with your Lockstep Platform data
+        attr_accessor :financial_year_settings
+
+        ##
+        # @return [FinancialAccountSyncModel] A list of FinancialAccount records to merge with your Lockstep Platform data
+        attr_accessor :financial_accounts
+
+        ##
+        # @return [FinancialAccountBalanceHistorySyncModel] A list of FinancialAccountBalanceHistory records to merge with your Lockstep Platform data
+        attr_accessor :financial_account_balance_histories
+
         ##
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
@@ -85,6 +100,9 @@ module LockstepSdk
                 'customFields' => @custom_fields,
                 'payments' => @payments,
                 'paymentApplications' => @payment_applications,
+                'financialYearSettings' => @financial_year_settings,
+                'financialAccounts' => @financial_accounts,
+                'financialAccountBalanceHistories' => @financial_account_balance_histories,
             }
         end
 

data/lib/lockstep_sdk/models/company_model.rb

@@ -64,6 +64,7 @@ module LockstepSdk
             @description = params.dig(:description)
             @website = params.dig(:website)
             @app_enrollment_id = params.dig(:app_enrollment_id)
+            @email_address = params.dig(:email_address)
             @notes = params.dig(:notes)
             @attachments = params.dig(:attachments)
             @contacts = params.dig(:contacts)
@@ -221,6 +222,10 @@ module LockstepSdk
         # @return [Uuid] The AppEnrollmentId of the application that imported this record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record. This value is null if this record was not loaded from an external ERP or financial system.
         attr_accessor :app_enrollment_id
 
+        ##
+        # @return [Email] Company Email Address
+        attr_accessor :email_address
+
         ##
         # @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
@@ -290,6 +295,7 @@ module LockstepSdk
                 'description' => @description,
                 'website' => @website,
                 'appEnrollmentId' => @app_enrollment_id,
+                'emailAddress' => @email_address,
                 'notes' => @notes,
                 'attachments' => @attachments,
                 'contacts' => @contacts,

data/lib/lockstep_sdk/models/company_sync_model.rb

@@ -31,6 +31,7 @@ module LockstepSdk
         ##
         # Initialize the CompanySyncModel using the provided prototype
         def initialize(params = {})
+            @on_match_action = params.dig(:on_match_action)
             @erp_key = params.dig(:erp_key)
             @company_name = params.dig(:company_name)
             @company_type = params.dig(:company_type)
@@ -56,9 +57,14 @@ module LockstepSdk
             @ap_email_address = params.dig(:ap_email_address)
             @ar_email_address = params.dig(:ar_email_address)
             @preferred_delivery_method = params.dig(:preferred_delivery_method)
+            @email_address = params.dig(:email_address)
             @external_reference = params.dig(:external_reference)
         end
 
+        ##
+        # @return [UpdateAction] Indicates what action to take when a sync model has been found during the sync process.
+        attr_accessor :on_match_action
+
         ##
         # @return [String] This is the primary key of the Company record. For this field, you should use whatever the company's unique identifying number is in the originating system. Search for a unique, non-changing number within the originating financial system for this record. Example: If you store your company records in a database, whatever the primary key for the company table is in the database should be the `ErpKey`. Example: If you use a financial system such as Quickbooks or Xero, look for the primary ID number of the company record within that financial system. For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
         attr_accessor :erp_key
@@ -84,7 +90,7 @@ module LockstepSdk
         attr_accessor :is_active
 
         ##
-        # @return [String] The default currency code for transactions related to this company. For a list of 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 default currency code for transactions related to this company. For a list of currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies).
         attr_accessor :default_currency_code
 
         ##
@@ -159,6 +165,10 @@ module LockstepSdk
         # @return [String] Indicates the preferred invoice delivery method. Examples include Print, Email, Fax
         attr_accessor :preferred_delivery_method
 
+        ##
+        # @return [String] The company email address.
+        attr_accessor :email_address
+
         ##
         # @return [String] An external reference that identifies the Company from the originating ERP system, separate from the ErpKey.
         attr_accessor :external_reference
@@ -167,6 +177,7 @@ module LockstepSdk
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
             {
+                'onMatchAction' => @on_match_action,
                 'erpKey' => @erp_key,
                 'companyName' => @company_name,
                 'companyType' => @company_type,
@@ -192,6 +203,7 @@ module LockstepSdk
                 'apEmailAddress' => @ap_email_address,
                 'arEmailAddress' => @ar_email_address,
                 'preferredDeliveryMethod' => @preferred_delivery_method,
+                'emailAddress' => @email_address,
                 'externalReference' => @external_reference,
             }
         end

data/lib/lockstep_sdk/models/credit_memo_applied_model.rb

@@ -44,6 +44,8 @@ module LockstepSdk
             @notes = params.dig(:notes)
             @custom_field_definitions = params.dig(:custom_field_definitions)
             @custom_field_values = params.dig(:custom_field_values)
+            @credit_memo_invoice = params.dig(:credit_memo_invoice)
+            @invoice = params.dig(:invoice)
         end
 
         ##
@@ -114,6 +116,14 @@ module LockstepSdk
         # @return [CustomFieldValueModel] A collection of custom fields linked to this record. To retrieve this collection, specify `CustomFieldValues` in the `include` parameter when retrieving data. To create a custom field, use the [Create Custom Field](https://developer.lockstep.io/reference/post_api-v1-customfieldvalues) endpoint with the `TableKey` to `CreditMemoApplied` and the `ObjectKey` set to the `CreditMemoAppliedId` 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 :custom_field_values
 
+        ##
+        # @return [InvoiceModel] The credit memo invoice associated with this applied credit memo
+        attr_accessor :credit_memo_invoice
+
+        ##
+        # @return [InvoiceModel] The invoice associated with this applied credit memo
+        attr_accessor :invoice
+
         ##
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
@@ -135,6 +145,8 @@ module LockstepSdk
                 'notes' => @notes,
                 'customFieldDefinitions' => @custom_field_definitions,
                 'customFieldValues' => @custom_field_values,
+                'creditMemoInvoice' => @credit_memo_invoice,
+                'invoice' => @invoice,
             }
         end
 

data/lib/lockstep_sdk/models/custom_field_sync_model.rb

@@ -23,7 +23,7 @@ module LockstepSdk
     # information about an object that does not match Lockstep's official schema, you can store it in the Custom
     # Field system using CustomFieldSyncModel.
     #
-    # To store a custom field for an object, create a CustomFieldSyncModel record containing the `EntityType` and
+    # To store a custom field for an object, create a CustomFieldSyncModel record containing the `TableKey` and
     # `ErpKey` of the entity to which you will attach a custom field. Next specify the field's `CustomFieldLabel`
     # and either a `StringValue` or `NumericValue`.
     #
@@ -36,7 +36,7 @@ module LockstepSdk
         # Initialize the CustomFieldSyncModel using the provided prototype
         def initialize(params = {})
             @erp_key = params.dig(:erp_key)
-            @entity_type = params.dig(:entity_type)
+            @table_key = params.dig(:table_key)
             @custom_field_label = params.dig(:custom_field_label)
             @string_value = params.dig(:string_value)
             @numeric_value = params.dig(:numeric_value)
@@ -46,12 +46,12 @@ module LockstepSdk
         end
 
         ##
-        # @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 `EntityType` 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).
+        # @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
 
         ##
-        # @return [String] Custom Fields are identified by the `EntityType` 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 `EntityType` field, specify the value `Invoice`. Recognized types include: * `Company` - Link this custom field to a CompanySyncModel * `Contact` - Link this custom field to a ContactSyncModel * `Invoice` - Link this custom field to an InvoiceSyncModel * `InvoiceLine` - Link this custom field to an InvoiceLineSyncModel * `Payment` - Link this custom field to a PaymentSyncModel
-        attr_accessor :entity_type
+        # @return [String] 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 `TableKey` field, specify the value `Invoice`. Recognized types include: * `Company` - Link this custom field to a CompanySyncModel * `Contact` - Link this custom field to a ContactSyncModel * `Invoice` - Link this custom field to an InvoiceSyncModel * `InvoiceLine` - Link this custom field to an InvoiceLineSyncModel * `Payment` - Link this custom field to a PaymentSyncModel
+        attr_accessor :table_key
 
         ##
         # @return [String] A label that uniquely identifies this custom field within your software. 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 `CustomFieldLabel` field, specify the value `ApprovalStatusCode`.
@@ -82,7 +82,7 @@ module LockstepSdk
         def as_json(options={})
             {
                 'erpKey' => @erp_key,
-                'entityType' => @entity_type,
+                'tableKey' => @table_key,
                 'customFieldLabel' => @custom_field_label,
                 'stringValue' => @string_value,
                 'numericValue' => @numeric_value,

data/lib/lockstep_sdk/models/customer_summary_model.rb

@@ -27,6 +27,7 @@ module LockstepSdk
             @company_id = params.dig(:company_id)
             @company_name = params.dig(:company_name)
             @primary_contact = params.dig(:primary_contact)
+            @app_enrollment_id = params.dig(:app_enrollment_id)
             @outstanding_invoices = params.dig(:outstanding_invoices)
             @total_invoices_open = params.dig(:total_invoices_open)
             @total_invoices_past_due = params.dig(:total_invoices_past_due)
@@ -62,6 +63,10 @@ module LockstepSdk
         # @return [String] The name of the primary contact.
         attr_accessor :primary_contact
 
+        ##
+        # @return [Uuid] The app enrollment ID this Customer is associated with
+        attr_accessor :app_enrollment_id
+
         ##
         # @return [Int32] The number of outstanding invoices for this customer.
         attr_accessor :outstanding_invoices
@@ -138,6 +143,7 @@ module LockstepSdk
                 'companyId' => @company_id,
                 'companyName' => @company_name,
                 'primaryContact' => @primary_contact,
+                'appEnrollmentId' => @app_enrollment_id,
                 'outstandingInvoices' => @outstanding_invoices,
                 'totalInvoicesOpen' => @total_invoices_open,
                 'totalInvoicesPastDue' => @total_invoices_past_due,

data/lib/lockstep_sdk/models/financial_account_balance_history_sync_model.rb

@@ -0,0 +1,100 @@
+#
+# Lockstep Platform SDK for Ruby
+#
+# (c) 2021-2022 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Lockstep Network <support@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # The FinancialAccountBalanceHistorySyncModel 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 FinancialAccountBalanceHistorySyncModel 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.
+    #
+    # If the FinancialAccountBalanceHistorySyncModels are imported via a connector instead, please ensure that all records are passed in
+    # on every sync. Records that are not passed in will be assumed to be deleted.
+    #
+    # Once imported, this record will be available in the Lockstep API as a [FinancialAccountBalanceHistoryModel](https://developer.lockstep.io/docs/financialaccountbalancehistorymodel).
+    #
+    # For more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data).
+    class FinancialAccountBalanceHistorySyncModel
+
+        ##
+        # Initialize the FinancialAccountBalanceHistorySyncModel using the provided prototype
+        def initialize(params = {})
+            @financial_account_code = params.dig(:financial_account_code)
+            @financial_account_erp_key = params.dig(:financial_account_erp_key)
+            @financial_year = params.dig(:financial_year)
+            @period_number = params.dig(:period_number)
+            @period_start_date = params.dig(:period_start_date)
+            @period_end_date = params.dig(:period_end_date)
+            @status = params.dig(:status)
+            @balance = params.dig(:balance)
+        end
+
+        ##
+        # @return [String] The code for the Financial Account. Can either be a general ledger or an account code.
+        attr_accessor :financial_account_code
+
+        ##
+        # @return [String] This is the primary key of the FinancialAccount record. For this field, you should use whatever the company's unique identifying number is in the originating system. Search for a unique, non-changing number within the originating financial system for this record. Example: If you store your company records in a database, whatever the primary key for the company table is in the database should be the ErpKey. Example: If you use a financial system such as Quickbooks or Xero, look for the primary ID number of the company record within that financial system.
+        attr_accessor :financial_account_erp_key
+
+        ##
+        # @return [Int32] The financial year that this period falls under
+        attr_accessor :financial_year
+
+        ##
+        # @return [Int32] The period number (1-12 or 1-13) that this balance history is for
+        attr_accessor :period_number
+
+        ##
+        # @return [Date-time] The start date of this period.
+        attr_accessor :period_start_date
+
+        ##
+        # @return [Date-time] The end date of this period.
+        attr_accessor :period_end_date
+
+        ##
+        # @return [String] The status of this period. The status should be Closed if the books for this period have been closed, if not the status should be Open. The status can also be Deleted if there was a recalculation that needed to occur, for example due to a change in financial year settings.
+        attr_accessor :status
+
+        ##
+        # @return [Double] The current or end balance of this period.
+        attr_accessor :balance
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'financialAccountCode' => @financial_account_code,
+                'financialAccountErpKey' => @financial_account_erp_key,
+                'financialYear' => @financial_year,
+                'periodNumber' => @period_number,
+                'periodStartDate' => @period_start_date,
+                'periodEndDate' => @period_end_date,
+                'status' => @status,
+                'balance' => @balance,
+            }
+        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/financial_account_sync_model.rb

@@ -0,0 +1,103 @@
+#
+# Lockstep Platform SDK for Ruby
+#
+# (c) 2021-2022 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Lockstep Network <support@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # The FinancialAccountSyncModel 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 FinancialAccountSyncModel 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 available in the Lockstep API as a [FinancialAccountModel](https://developer.lockstep.io/docs/financialaccountmodel).
+    #
+    # For more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data).
+    class FinancialAccountSyncModel
+
+        ##
+        # Initialize the FinancialAccountSyncModel using the provided prototype
+        def initialize(params = {})
+            @code = params.dig(:code)
+            @erp_key = params.dig(:erp_key)
+            @name = params.dig(:name)
+            @status = params.dig(:status)
+            @cashflow_type = params.dig(:cashflow_type)
+            @description = params.dig(:description)
+            @classification = params.dig(:classification)
+            @category = params.dig(:category)
+            @subcategory = params.dig(:subcategory)
+        end
+
+        ##
+        # @return [String] The code for the Financial Account. Can either be a general ledger or an account code.
+        attr_accessor :code
+
+        ##
+        # @return [String] The External Id for the Financial Account.
+        attr_accessor :erp_key
+
+        ##
+        # @return [String] The name of the Financial Account.
+        attr_accessor :name
+
+        ##
+        # @return [String] The status of the Financial Account. Possible values are active, inactive, deleted or archived.
+        attr_accessor :status
+
+        ##
+        # @return [String] The cashflow type for the Financial Account. Examples include cash, financing, investment or operation.
+        attr_accessor :cashflow_type
+
+        ##
+        # @return [String] The description for the Financial Account.
+        attr_accessor :description
+
+        ##
+        # @return [String] The classification for the Financial Account. Possible values are Asset, Equity, Expense, Liability or Income.
+        attr_accessor :classification
+
+        ##
+        # @return [String] The category for the Financial Account. Examples include Current Asset, Current Liability, Common Stock
+        attr_accessor :category
+
+        ##
+        # @return [String] The subcategory for the Financial Account. Examples include Cash, Property, Bank Loan, etc.
+        attr_accessor :subcategory
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'code' => @code,
+                'erpKey' => @erp_key,
+                'name' => @name,
+                'status' => @status,
+                'cashflowType' => @cashflow_type,
+                'description' => @description,
+                'classification' => @classification,
+                'category' => @category,
+                'subcategory' => @subcategory,
+            }
+        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/financial_year_setting_sync_model.rb

@@ -0,0 +1,75 @@
+#
+# Lockstep Platform SDK for Ruby
+#
+# (c) 2021-2022 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Lockstep Network <support@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # The FinancialYearSettingSyncModel 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 FinancialYearSettingSyncModel 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 available in the Lockstep API as a [FinancialYearSettingModel](https://developer.lockstep.io/docs/financialyearsettingmodel).
+    # Sync is supported for only one FinancialYearSetting per app enrollment and one FinancialYearSetting imported outside of
+    # an app enrollment - please submit only one model here.  If multiple models are submitted, only the latest one is considered for Sync.
+    #
+    # For more information on writing your own connector, see [Connector Data](https://developer.lockstep.io/docs/connector-data).
+    class FinancialYearSettingSyncModel
+
+        ##
+        # Initialize the FinancialYearSettingSyncModel using the provided prototype
+        def initialize(params = {})
+            @year_type = params.dig(:year_type)
+            @total_periods = params.dig(:total_periods)
+            @start_date = params.dig(:start_date)
+            @end_date = params.dig(:end_date)
+        end
+
+        ##
+        # @return [String] The type of financial year, either Calendar or Fiscal.
+        attr_accessor :year_type
+
+        ##
+        # @return [Int32] Total number of periods in the year. For Calendar year types this should always be 12. For Fiscal year types this can either be 12 or 13 for a 4 week 13 period year.
+        attr_accessor :total_periods
+
+        ##
+        # @return [String] The start date of the financial year. Should be entered in MM-DD format.
+        attr_accessor :start_date
+
+        ##
+        # @return [String] The end date of the financial year. Should be entered in MM-DD format.
+        attr_accessor :end_date
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'yearType' => @year_type,
+                'totalPeriods' => @total_periods,
+                'startDate' => @start_date,
+                'endDate' => @end_date,
+            }
+        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/invoice_sync_model.rb

@@ -132,7 +132,7 @@ module LockstepSdk
         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
+        # @return [String] The three-character ISO 4217 currency code used for this invoice.
         attr_accessor :currency_code
 
         ##

data/lib/lockstep_sdk/models/payment_sync_model.rb

@@ -90,7 +90,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/sync_request_model.rb

@@ -34,6 +34,7 @@ module LockstepSdk
             @group_key = params.dig(:group_key)
             @status_code = params.dig(:status_code)
             @process_result_message = params.dig(:process_result_message)
+            @run_full_sync = params.dig(:run_full_sync)
             @app_enrollment_id = params.dig(:app_enrollment_id)
             @created = params.dig(:created)
             @modified = params.dig(:modified)
@@ -57,6 +58,10 @@ module LockstepSdk
         # @return [String] Message containing information about the sync request results
         attr_accessor :process_result_message
 
+        ##
+        # @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
+        attr_accessor :run_full_sync
+
         ##
         # @return [Uuid] The AppEnrollmentId of the AppEnrollment object that executed this sync request
         attr_accessor :app_enrollment_id
@@ -85,6 +90,7 @@ module LockstepSdk
                 'groupKey' => @group_key,
                 'statusCode' => @status_code,
                 'processResultMessage' => @process_result_message,
+                'runFullSync' => @run_full_sync,
                 'appEnrollmentId' => @app_enrollment_id,
                 'created' => @created,
                 'modified' => @modified,

data/lib/lockstep_sdk/models/sync_submit_model.rb

@@ -32,17 +32,23 @@ module LockstepSdk
         # Initialize the SyncSubmitModel using the provided prototype
         def initialize(params = {})
             @app_enrollment_id = params.dig(:app_enrollment_id)
+            @run_full_sync = params.dig(:run_full_sync)
         end
 
         ##
         # @return [Uuid] The unique identifier of the app enrollment that is creating this sync request.
         attr_accessor :app_enrollment_id
 
+        ##
+        # @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. For the Demo Data Connector, setting this to True refreshes the data with new dates as opposed to leaving it unchanged.
+        attr_accessor :run_full_sync
+
         ##
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
             {
                 'appEnrollmentId' => @app_enrollment_id,
+                'runFullSync' => @run_full_sync,
             }
         end
 

data/lib/lockstep_sdk/models/vendor_summary_model.rb

@@ -40,6 +40,7 @@ module LockstepSdk
             @open_bill_count = params.dig(:open_bill_count)
             @paid_bill_count = params.dig(:paid_bill_count)
             @total_bill_count = params.dig(:total_bill_count)
+            @dpo = params.dig(:dpo)
         end
 
         ##
@@ -110,6 +111,10 @@ module LockstepSdk
         # @return [Int32] The total count of open and closed bills.
         attr_accessor :total_bill_count
 
+        ##
+        # @return [Double] The days payabale outstanding.
+        attr_accessor :dpo
+
         ##
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
@@ -131,6 +136,7 @@ module LockstepSdk
                 'openBillCount' => @open_bill_count,
                 'paidBillCount' => @paid_bill_count,
                 'totalBillCount' => @total_bill_count,
+                'dpo' => @dpo,
             }
         end
 

data/lib/lockstep_sdk/models/webhook_history_table_storage_model.rb

@@ -33,6 +33,9 @@ module LockstepSdk
             @process_result_message = params.dig(:process_result_message)
             @failure_count = params.dig(:failure_count)
             @timestamp = params.dig(:timestamp)
+            @records = params.dig(:records)
+            @request_message = params.dig(:request_message)
+            @response_message = params.dig(:response_message)
         end
 
         ##
@@ -75,6 +78,18 @@ module LockstepSdk
         # @return [Date-time] Timestamp of when a request is sent to a webhook callback. Contains the last time message is sent if failures occur.
         attr_accessor :timestamp
 
+        ##
+        # @return [String] The records sent with the webhook.
+        attr_accessor :records
+
+        ##
+        # @return [String] The request message sent with the webhook.
+        attr_accessor :request_message
+
+        ##
+        # @return [String] The response received back from the webhook.
+        attr_accessor :response_message
+
         ##
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
@@ -89,6 +104,9 @@ module LockstepSdk
                 'processResultMessage' => @process_result_message,
                 'failureCount' => @failure_count,
                 'timestamp' => @timestamp,
+                'records' => @records,
+                'requestMessage' => @request_message,
+                'responseMessage' => @response_message,
             }
         end
 

data/lib/lockstep_sdk/models/webhook_model.rb

@@ -20,8 +20,7 @@ module LockstepSdk
     # A Webhook is a subscription to receive notifications automatically to the supplied
     # callback url when changes are made to a supported object.
     #
-    # Currently supported objects:
-    #  * `SyncRequest` - Receive a notification when a new sync request has completed for the group key.
+    # You will need to create at least one Webhook rule to receive notifications when a specific type of object is inserted, deleted, or updated.
     class WebhookModel
 
         ##
@@ -87,7 +86,7 @@ module LockstepSdk
         attr_accessor :expiration_date
 
         ##
-        # @return [Int32] The amount of times a notification should be retried before marking the webhook as errored.
+        # @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.
         attr_accessor :retry_count
 
         ##

data/lib/lockstep_sdk/models/webhook_rule_model.rb

@@ -17,10 +17,10 @@ require 'json'
 module LockstepSdk
 
     ##
-    # A Webhook Rule is a subscription to receive notifications automatically for
+    # A Webhook Rule is a subscription to receive notifications whenever a specific event occurs.
     #
-    # Currently supported objects:
-    #  * `SyncRequest` - Receive a notification when a new sync request has completed for the group key.
+    # With the rule, you specify the Table and event you want to subscribe to.
+    # You can also optionally specify a filter to further refine the updates you want to receive.
     class WebhookRuleModel
 
         ##
@@ -31,9 +31,7 @@ module LockstepSdk
             @group_key = params.dig(:group_key)
             @table_key = params.dig(:table_key)
             @event_type = params.dig(:event_type)
-            @expiration_date = params.dig(:expiration_date)
             @filter = params.dig(:filter)
-            @request_content_type = params.dig(:request_content_type)
             @created = params.dig(:created)
             @created_user_id = params.dig(:created_user_id)
             @modified = params.dig(:modified)
@@ -61,17 +59,9 @@ module LockstepSdk
         attr_accessor :event_type
 
         ##
-        # @return [Date-time] The expiration date for the given webhook subscription. Once the expiration date passes, notifications will no longer be sent to the callback url.
-        attr_accessor :expiration_date
-
-        ##
-        # @return [String] The filter for this webhook rule (if necessary) . See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+        # @return [String] An optional Searchlight filter for this webhook rule. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
         attr_accessor :filter
 
-        ##
-        # @return [String] The format of the content to be returned in the webhook notifications. Current options are 'Full' or 'Id'.
-        attr_accessor :request_content_type
-
         ##
         # @return [Date-time] The date this webhook rule was created
         attr_accessor :created
@@ -97,9 +87,7 @@ module LockstepSdk
                 'groupKey' => @group_key,
                 'tableKey' => @table_key,
                 'eventType' => @event_type,
-                'expirationDate' => @expiration_date,
                 'filter' => @filter,
-                'requestContentType' => @request_content_type,
                 'created' => @created,
                 'createdUserId' => @created_user_id,
                 'modified' => @modified,

data/lib/lockstep_sdk/version.rb

@@ -1,3 +1,3 @@
 module LockstepSdk
-    VERSION = "2022.26.12.0"
+    VERSION = "2022.33.14.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockstep_sdk
 version: !ruby/object:Gem::Version
-  version: 2022.26.12.0
+  version: 2022.33.14.0
 platform: ruby
 authors:
 - Lockstep
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-05 00:00:00.000000000 Z
+date: 2022-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awrence
@@ -75,6 +75,7 @@ files:
 - lib/lockstep_sdk/models/api_key_model.rb
 - lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb
 - lib/lockstep_sdk/models/app_enrollment_model.rb
+- lib/lockstep_sdk/models/app_enrollment_reconnect_request.rb
 - lib/lockstep_sdk/models/application_model.rb
 - lib/lockstep_sdk/models/ar_aging_header_info_model.rb
 - lib/lockstep_sdk/models/ar_header_info_model.rb
@@ -112,11 +113,14 @@ files:
 - lib/lockstep_sdk/models/erp_model.rb
 - lib/lockstep_sdk/models/error_result.rb
 - lib/lockstep_sdk/models/financial_account_balance_history_model.rb
+- lib/lockstep_sdk/models/financial_account_balance_history_sync_model.rb
 - lib/lockstep_sdk/models/financial_account_model.rb
+- lib/lockstep_sdk/models/financial_account_sync_model.rb
 - lib/lockstep_sdk/models/financial_report_cell_model.rb
 - lib/lockstep_sdk/models/financial_report_model.rb
 - lib/lockstep_sdk/models/financial_report_row_model.rb
 - lib/lockstep_sdk/models/financial_year_setting_model.rb
+- lib/lockstep_sdk/models/financial_year_setting_sync_model.rb
 - lib/lockstep_sdk/models/group_account_model.rb
 - lib/lockstep_sdk/models/invite_data_model.rb
 - lib/lockstep_sdk/models/invite_model.rb