lockstep_sdk 2022.6.49.0 → 2022.9.6.0

data/lib/lockstep_sdk/clients/financial_year_settings_client.rb

@@ -0,0 +1,92 @@
+#
+# Lockstep Software Development Kit 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     Ted Spence <tspence@lockstep.io>
+# @author     Manish Narayan B S <manish.n@lockstep.io>
+# @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'awrence'
+
+class FinancialYearSettingsClient
+
+    ##
+    # Initialize the FinancialYearSettingsClient class with a lockstepsdk instance.
+    # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
+    def initialize(lockstepsdk)
+        @lockstepsdk = lockstepsdk
+    end
+
+
+    ##
+    # Retrieves the Financial Year Setting specified by this unique identifier.
+    #
+    # A Financial Year Setting is used to to set the type, beginning, end, and number of periods of a year used to calculate accounting reports. The financial setting can either be for a specific app enrollment id via a sync or, when the financial year setting is manually created, will cover all account data without an app enrollment id.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of this Financial Year Setting
+    def retrieve_financial_year_setting(id:)
+        path = "/api/v1/FinancialYearSettings/#{id}"
+        @lockstepsdk.request(:get, path, nil, nil)
+    end
+
+    ##
+    # Updates a financial year setting 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.
+    #
+    # A Financial Year Setting is used to to set the type, beginning, end, and number of periods of a year used to calculate accounting reports. The financial setting can either be for a specific app enrollment id via a sync or, when the financial year setting is manually created, will cover all account data without an app enrollment id.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of the Financial Year Setting to update
+    # @param body [object] A list of changes to apply to this Financial Year Setting
+    def update_financial_year_setting(id:, body:)
+        path = "/api/v1/FinancialYearSettings/#{id}"
+        @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
+    end
+
+    ##
+    # Delete the Financial Year Setting referred to by this unique identifier.
+    #
+    # A Financial Year Setting is used to to set the type, beginning, end, and number of periods of a year used to calculate accounting reports. The financial setting can either be for a specific app enrollment id via a sync or, when the financial year setting is manually created, will cover all account data without an app enrollment id.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of the Financial Year Setting to disable
+    def delete_financial_year_setting(id:)
+        path = "/api/v1/FinancialYearSettings/#{id}"
+        @lockstepsdk.request(:delete, path, nil, nil)
+    end
+
+    ##
+    # Creates a financial year setting from a given model.
+    #
+    # A Financial Year Setting is used to to set the type, beginning, end, and number of periods of a year used to calculate accounting reports. The financial setting can either be for a specific app enrollment id via a sync or, when the financial year setting is manually created, will cover all account data without an app enrollment id.
+    #
+    # @param body [FinancialYearSettingModel] The Financial Year Setting to create
+    def create_financial_year_setting(body:)
+        path = "/api/v1/FinancialYearSettings"
+        @lockstepsdk.request(:post, path, body, nil)
+    end
+
+    ##
+    # Queries Financial Year Settings for this account using the specified filtering, sorting, and pagination rules requested.
+    #
+    # More information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.
+    #
+    # A Financial Year Setting is used to to set the type, beginning, end, and number of periods of a year used to calculate accounting reports. The financial setting can either be for a specific app enrollment id via a sync or, when the financial year setting is manually created, will cover all account data without an app enrollment id.
+    #
+    # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @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 200). 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_financial_year_settings(filter:, order:, page_size:, page_number:)
+        path = "/api/v1/FinancialYearSettings/query"
+        params = {:filter => filter, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+end

data/lib/lockstep_sdk/clients/invoices_client.rb

@@ -42,7 +42,9 @@ class InvoicesClient
     ##
     # Updates an existing Invoice with the information supplied to this PATCH call.
     #
-    # 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 Invoice represents a bill sent from one company to another.  The creator of the invoice is identified by the `CompanyId` field, and the recipient of the invoice is identified by the `CustomerId` field.  Most invoices are uniquely identified both by a Lockstep Platform ID number and a customer ERP "key" that was generated by the system that originated the invoice.  Invoices have a total amount and a due date, and when some payments have been made on the Invoice the `TotalAmount` and the `OutstandingBalanceAmount` may be different.
+    # 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 Invoice represents a bill sent from one company to another.  The creator of the invoice is identified by the `CompanyId` field, and the recipient of the invoice is identified by the `CustomerId` field.  Most invoices are uniquely identified both by a Lockstep Platform ID number and a customer ERP "key" that was generated by the system that originated the invoice.  Invoices have a total amount and a due date, and when some payments have been made on the Invoice the `TotalAmount` and the `OutstandingBalanceAmount` may be different.
     #
     # @param id [uuid] The unique Lockstep Platform ID number of the invoice to update; NOT the customer's ERP key
     # @param body [object] A list of changes to apply to this Invoice
@@ -74,7 +76,9 @@ class InvoicesClient
     ##
     # Queries Invoices for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
     #
-    # More information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.  An Invoice represents a bill sent from one company to another.  The creator of the invoice is identified by the `CompanyId` field, and the recipient of the invoice is identified by the `CustomerId` field.  Most invoices are uniquely identified both by a Lockstep Platform ID number and a customer ERP "key" that was generated by the system that originated the invoice.  Invoices have a total amount and a due date, and when some payments have been made on the Invoice the `TotalAmount` and the `OutstandingBalanceAmount` may be different.
+    # More information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.
+    #
+    # An Invoice represents a bill sent from one company to another.  The creator of the invoice is identified by the `CompanyId` field, and the recipient of the invoice is identified by the `CustomerId` field.  Most invoices are uniquely identified both by a Lockstep Platform ID number and a customer ERP "key" that was generated by the system that originated the invoice.  Invoices have a total amount and a due date, and when some payments have been made on the Invoice the `TotalAmount` and the `OutstandingBalanceAmount` may be different.
     #
     # @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. Available collections: Addresses, Lines, Payments, Notes, Attachments, Company, Customer, CustomFields, CreditMemos

data/lib/lockstep_sdk/clients/notes_client.rb

@@ -27,7 +27,9 @@ class NotesClient
 
 
     ##
-    # Retrieves the note with the specified note identifier.  A note is a customizable text string that can be attached to various account attributes within Lockstep. You can use notes for internal communication, correspondence with clients, or personal reminders. The Note Model represents a note and a number of different metadata attributes related to the creation, storage, and ownership of the note.
+    # Retrieves the note with the specified note identifier.
+    #
+    # A note is a customizable text string that can be attached to various account attributes within Lockstep. You can use notes for internal communication, correspondence with clients, or personal reminders. The Note Model represents a note and a number of different metadata attributes related to the creation, storage, and ownership of the note.
     #
     # See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
     #
@@ -40,7 +42,9 @@ class NotesClient
     end
 
     ##
-    # Archives the Note with the unique ID specified.  A note is a customizable text string that can be attached to various account attributes within Lockstep. You can use notes for internal communication, correspondence with clients, or personal reminders. The Note Model represents a note and a number of different metadata attributes related to the creation, storage, and ownership of the note.
+    # Archives the Note with the unique ID specified.
+    #
+    # A note is a customizable text string that can be attached to various account attributes within Lockstep. You can use notes for internal communication, correspondence with clients, or personal reminders. The Note Model represents a note and a number of different metadata attributes related to the creation, storage, and ownership of the note.
     #
     # See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
     #
@@ -66,7 +70,9 @@ class NotesClient
     ##
     # Queries Notes on the Lockstep Platform using the specified filtering, sorting, nested fetch, and pagination rules requested.
     #
-    # More information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.  A note is a customizable text string that can be attached to various account attributes within Lockstep. You can use notes for internal communication, correspondence with clients, or personal reminders. The Note Model represents a note and a number of different metadata attributes related to the creation, storage, and ownership of the note.
+    # More information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.
+    #
+    # A note is a customizable text string that can be attached to various account attributes within Lockstep. You can use notes for internal communication, correspondence with clients, or personal reminders. The Note Model represents a note and a number of different metadata attributes related to the creation, storage, and ownership of the note.
     #
     # See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
     #

data/lib/lockstep_sdk/clients/payment_applications_client.rb

@@ -42,7 +42,9 @@ class PaymentApplicationsClient
     ##
     # Updates an existing Payment Application with the information supplied to this PATCH call.
     #
-    # The PATCH method allows you to change specific values on the object while leaving other values alone.  As input you should supply a list of field names and new values.  If you do not provide the name of a field, that field will remain unchanged.  This allows you to ensure that you are only updating the specific fields desired.  A Payment Application is created by a business who receives a Payment from a customer.  A customer may make a single Payment to match an Invoice exactly, a partial Payment for an Invoice, or a single Payment may be made for multiple smaller Invoices.  The Payment Application contains information about which Invoices are connected to which Payments and for which amounts.
+    # The PATCH method allows you to change specific values on the object while leaving other values alone.  As input you should supply a list of field names and new values.  If you do not provide the name of a field, that field will remain unchanged.  This allows you to ensure that you are only updating the specific fields desired.
+    #
+    # A Payment Application is created by a business who receives a Payment from a customer.  A customer may make a single Payment to match an Invoice exactly, a partial Payment for an Invoice, or a single Payment may be made for multiple smaller Invoices.  The Payment Application contains information about which Invoices are connected to which Payments and for which amounts.
     #
     # @param id [uuid] The unique Lockstep Platform ID number of the Payment Application to update; NOT the customer's ERP key
     # @param body [object] A list of changes to apply to this Payment Application
@@ -76,7 +78,9 @@ class PaymentApplicationsClient
     ##
     # Queries Payment Applications for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
     #
-    # More information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.  A Payment Application is created by a business who receives a Payment from a customer.  A customer may make a single Payment to match an Invoice exactly, a partial Payment for an Invoice, or a single Payment may be made for multiple smaller Invoices.  The Payment Application contains information about which Invoices are connected to which Payments and for which amounts.
+    # More information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.
+    #
+    # A Payment Application is created by a business who receives a Payment from a customer.  A customer may make a single Payment to match an Invoice exactly, a partial Payment for an Invoice, or a single Payment may be made for multiple smaller Invoices.  The Payment Application contains information about which Invoices are connected to which Payments and for which amounts.
     #
     # @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. Available collections: Invoice

data/lib/lockstep_sdk/clients/provisioning_client.rb

@@ -44,6 +44,9 @@ class ProvisioningClient
         @lockstepsdk.request(:post, path, body, nil)
     end
 
+    ##
+    # Creates a new account for a developer, sending an email with information on how to access the API.
+    # @param body [DeveloperAccountSubmitModel] 
     def provision_free_developer_account(body:)
         path = "/api/v1/Provisioning/free-account"
         @lockstepsdk.request(:post, path, body, nil)

data/lib/lockstep_sdk/clients/webhooks_client.rb

@@ -88,4 +88,18 @@ class WebhooksClient
         params = {:filter => filter, :order => order, :pageSize => page_size, :pageNumber => page_number}
         @lockstepsdk.request(:get, path, nil, params)
     end
+
+    ##
+    #
+    #
+    # @param webhook_id [uuid] The unique Lockstep Platform ID number of this Webhook
+    # @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:)
+        path = "/api/v1/Webhooks/#{webhookId}/history/query"
+        params = {:filter => filter, :select => select, :pageSize => page_size, :pageNumber => page_number}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
 end

data/lib/lockstep_sdk/lockstep_api.rb

@@ -10,7 +10,7 @@
 # @author     Manish Narayan B S <manish.n@lockstep.io>
 # @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
 # @copyright  2021-2022 Lockstep, Inc.
-# @version    2022.6.49.0
+# @version    2022.9.6.0
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -89,6 +89,18 @@ module LockstepSdk
         # @return [EmailsClient] Client object for Emails endpoints
         attr_accessor :emails
 
+        ##
+        # @return [FinancialAccountClient] Client object for FinancialAccount endpoints
+        attr_accessor :financial_account
+
+        ##
+        # @return [FinancialAccountBalanceHistoryClient] Client object for FinancialAccountBalanceHistory endpoints
+        attr_accessor :financial_account_balance_history
+
+        ##
+        # @return [FinancialYearSettingsClient] Client object for FinancialYearSettings endpoints
+        attr_accessor :financial_year_settings
+
         ##
         # @return [InvoiceHistoryClient] Client object for InvoiceHistory endpoints
         attr_accessor :invoice_history
@@ -147,7 +159,7 @@ module LockstepSdk
         #
         # @param env [string] Either "sbx", "prd", or the URI of the server, ending in a slash (/)
         def initialize(env)
-            @version = "2022.6.49.0"
+            @version = "2022.9.6.0"
             @env = case env
                 when "sbx"
                     "https://api.sbx.lockstep.io/"
@@ -172,6 +184,9 @@ module LockstepSdk
             @custom_field_values = CustomFieldValuesClient.new(self)
             @definitions = DefinitionsClient.new(self)
             @emails = EmailsClient.new(self)
+            @financial_account = FinancialAccountClient.new(self)
+            @financial_account_balance_history = FinancialAccountBalanceHistoryClient.new(self)
+            @financial_year_settings = FinancialYearSettingsClient.new(self)
             @invoice_history = InvoiceHistoryClient.new(self)
             @invoices = InvoicesClient.new(self)
             @leads = LeadsClient.new(self)
@@ -244,7 +259,7 @@ module LockstepSdk
             request["Accept"] = 'application/json'
             request["Content-Type"] = 'application/*+json'
             request["SdkType"] = 'Ruby'
-            request["SdkVersion"] = '2022.6.49.0'
+            request["SdkVersion"] = '2022.9.6.0'
             request["MachineName"] = Socket.gethostname
             request.body = body
 

data/lib/lockstep_sdk/models/activity_model.rb

@@ -88,7 +88,7 @@ module LockstepSdk
         attr_accessor :activity_status
 
         ##
-        # @return [Boolean] True if this activity is currently "open", which indicates that the activitiy is currently in progress.
+        # @return [Boolean] True if this activity is currently "open", which indicates that the activity is currently in progress.
         attr_accessor :is_open
 
         ##
@@ -156,19 +156,19 @@ module LockstepSdk
         attr_accessor :user_assigned_to_name
 
         ##
-        # @return [AttachmentModel] All attachments attached to applied activity. To retrieve this collection, specify `Attachments` in the "Include" parameter for your query.
+        # @return [AttachmentModel] A collection of attachments linked to this record. To retrieve this collection, specify `Attachments` in the `include` parameter when retrieving data. To create an attachment, use the [Upload Attachment](https://developer.lockstep.io/reference/post_api-v1-attachments) endpoint with the `TableKey` to `Activity` and the `ObjectKey` set to the `ActivityId` 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 :attachments
 
         ##
-        # @return [NoteModel] All notes attached to this applied activity. To retrieve this collection, specify `Notes` in the "Include" parameter for your query.
+        # @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 `Activity` and the `ObjectKey` set to the `ActivityId` 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
 
         ##
-        # @return [CustomFieldDefinitionModel] All definitions attached to this applied activity. To retrieve this collection, specify `CustomFieldValues` in the "Include" parameter for your query.
+        # @return [CustomFieldDefinitionModel] A collection of custom fields linked to this record. To retrieve this collection, specify `CustomFieldDefinitions` 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 `Activity` and the `ObjectKey` set to the `ActivityId` 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_definitions
 
         ##
-        # @return [CustomFieldValueModel] All values attached to this activity. To retrieve this collection, specify `CustomFieldValues` in the "Include" parameter for your query.
+        # @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 `Activity` and the `ObjectKey` set to the `ActivityId` 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
 
         ##

data/lib/lockstep_sdk/models/activity_xref_model.rb

@@ -18,6 +18,8 @@ require 'json'
 
 module LockstepSdk
 
+    ##
+    # Represents links between an Activity and another record.
     class ActivityXRefModel
 
         ##

data/lib/lockstep_sdk/models/app_enrollment_model.rb

@@ -94,11 +94,11 @@ module LockstepSdk
         attr_accessor :app
 
         ##
-        # @return [CustomFieldDefinitionModel] All definitions attached to this app. To retrieve this collection, specify `CustomFieldValues` in the "Include" parameter for your query.
+        # @return [CustomFieldDefinitionModel] A collection of custom fields linked to this record. To retrieve this collection, specify `CustomFieldDefinitions` 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 `AppEnrollment` and the `ObjectKey` set to the `AppEnrollmentId` 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_definitions
 
         ##
-        # @return [CustomFieldValueModel] All values attached to this app. To retrieve this collection, specify `CustomFieldValues` in the "Include" parameter for your query.
+        # @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 `AppEnrollment` and the `ObjectKey` set to the `AppEnrollmentId` 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
 
         ##

data/lib/lockstep_sdk/models/application_model.rb

@@ -115,19 +115,19 @@ module LockstepSdk
         attr_accessor :group_key
 
         ##
-        # @return [NoteModel] All notes attached to this app. To retrieve this collection, specify `Notes` in the "Include" parameter for your query.
+        # @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 `Application` and the `ObjectKey` set to the `ApplicationId` 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
 
         ##
-        # @return [AttachmentModel] All attachments attached to this app. To retrieve this collection, specify `Attachments` in the "Include" parameter for your query.
+        # @return [AttachmentModel] A collection of attachments linked to this record. To retrieve this collection, specify `Attachments` in the `include` parameter when retrieving data. To create an attachment, use the [Upload Attachment](https://developer.lockstep.io/reference/post_api-v1-attachments) endpoint with the `TableKey` to `Application` and the `ObjectKey` set to the `ApplicationId` 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 :attachments
 
         ##
-        # @return [CustomFieldDefinitionModel] All definitions attached to the application. To retrieve this collection, specify `CustomFieldValues` in the "Include" parameter for your query.
+        # @return [CustomFieldDefinitionModel] A collection of custom fields linked to this record. To retrieve this collection, specify `CustomFieldDefinitions` 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 `Application` and the `ObjectKey` set to the `ApplicationId` 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_definitions
 
         ##
-        # @return [CustomFieldValueModel] All values attached to the application. To retrieve this collection, specify `CustomFieldValues` in the "Include" parameter for your query.
+        # @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 `Application` and the `ObjectKey` set to the `ApplicationId` 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
 
         ##

data/lib/lockstep_sdk/models/attachment_model.rb

@@ -75,7 +75,7 @@ module LockstepSdk
         attr_accessor :is_archived
 
         ##
-        # @return [Uuid] 
+        # @return [Uuid] Tracks the original record for this attachment, not currently used.
         attr_accessor :origin_attachment_id
 
         ##
@@ -91,7 +91,7 @@ module LockstepSdk
         attr_accessor :erp_key
 
         ##
-        # @return [Uuid] The AppEnrollmentId of the application that imported this attachment record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record.
+        # @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
 
         ##

data/lib/lockstep_sdk/models/company_model.rb

@@ -240,15 +240,15 @@ module LockstepSdk
         attr_accessor :website
 
         ##
-        # @return [Uuid] The AppEnrollmentId of the application that imported this company record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record.
+        # @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 [NoteModel] All notes attached to this company. To retrieve this collection, specify `Notes` in the "Include" parameter for your query.
+        # @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
 
         ##
-        # @return [AttachmentModel] All attachments attached to this company. To retrieve this collection, specify `Attachments` in the "Include" parameter for your query.
+        # @return [AttachmentModel] A collection of attachments linked to this record. To retrieve this collection, specify `Attachments` in the `include` parameter when retrieving data. To create an attachment, use the [Upload Attachment](https://developer.lockstep.io/reference/post_api-v1-attachments) 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 :attachments
 
         ##
@@ -260,11 +260,11 @@ module LockstepSdk
         attr_accessor :invoices
 
         ##
-        # @return [CustomFieldDefinitionModel] All definitions attached to this company. To retrieve this collection, specify `CustomFieldValues` in the "Include" parameter for your query.
+        # @return [CustomFieldDefinitionModel] A collection of custom fields linked to this record. To retrieve this collection, specify `CustomFieldDefinitions` 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 `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 :custom_field_definitions
 
         ##
-        # @return [CustomFieldValueModel] All values attached to this company. To retrieve this collection, specify `CustomFieldValues` in the "Include" parameter for your query.
+        # @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 `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 :custom_field_values
 
         ##

data/lib/lockstep_sdk/models/company_sync_model.rb

@@ -72,7 +72,7 @@ module LockstepSdk
         attr_accessor :company_type
 
         ##
-        # @return [String] Either `Active` or `Inactive`.
+        # @return [String] An optional field including status codes. Defined status codes are `Active` and `Inactive`.
         attr_accessor :company_status
 
         ##
@@ -88,7 +88,7 @@ module LockstepSdk
         attr_accessor :default_currency_code
 
         ##
-        # @return [Uri] The URL of this company's logo, if known.
+        # @return [String] The URL of this company's logo, if known.
         attr_accessor :company_logo_url
 
         ##
@@ -124,11 +124,11 @@ module LockstepSdk
         attr_accessor :country
 
         ##
-        # @return [Tel] The main phone number of this company.
+        # @return [String] The main phone number of this company.
         attr_accessor :phone_number
 
         ##
-        # @return [Tel] The main fax number of this company.
+        # @return [String] The main fax number of this company.
         attr_accessor :fax_number
 
         ##
@@ -148,11 +148,11 @@ module LockstepSdk
         attr_accessor :duns_number
 
         ##
-        # @return [Email] If you know the AP (accounts payable) email address of this company, fill it in here. This is the email address where you would send questions to the company if the company owed you money.
+        # @return [String] If you know the AP (accounts payable) email address of this company, fill it in here. This is the email address where you would send questions to the company if the company owed you money.
         attr_accessor :ap_email_address
 
         ##
-        # @return [Email] If you know the AR (accounts receivable) email address of this company, fill it in here. This is the email address where you would send questions to the company if you owed this company money.
+        # @return [String] If you know the AR (accounts receivable) email address of this company, fill it in here. This is the email address where you would send questions to the company if you owed this company money.
         attr_accessor :ar_email_address
 
         ##

data/lib/lockstep_sdk/models/contact_model.rb

@@ -73,7 +73,7 @@ module LockstepSdk
         attr_accessor :group_key
 
         ##
-        # @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).
+        # @return [String] The unique ID of this record as it was known in its originating financial system. If this contact 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
 
         ##
@@ -161,23 +161,23 @@ module LockstepSdk
         attr_accessor :modified_user_id
 
         ##
-        # @return [Uuid] AppEnrollmentId for this record; used for mapping purposes.
+        # @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 [NoteModel] All notes attached to this company. To retrieve this collection, specify `Notes` in the "Include" parameter for your query.
+        # @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 `Contact` and the `ObjectKey` set to the `ContactId` 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
 
         ##
-        # @return [AttachmentModel] All attachments attached to this company. To retrieve this collection, specify `Attachments` in the "Include" parameter for your query.
+        # @return [AttachmentModel] A collection of attachments linked to this record. To retrieve this collection, specify `Attachments` in the `include` parameter when retrieving data. To create an attachment, use the [Upload Attachment](https://developer.lockstep.io/reference/post_api-v1-attachments) endpoint with the `TableKey` to `Contact` and the `ObjectKey` set to the `ContactId` 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 :attachments
 
         ##
-        # @return [CustomFieldDefinitionModel] All definitions attached to this contact. To retrieve this collection, specify `CustomFieldValues` in the "Include" parameter for your query.
+        # @return [CustomFieldDefinitionModel] A collection of custom fields linked to this record. To retrieve this collection, specify `CustomFieldDefinitions` 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 `Contact` and the `ObjectKey` set to the `ContactId` 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_definitions
 
         ##
-        # @return [CustomFieldValueModel] All values attached to this contact. To retrieve this collection, specify `Attachments` in the "Include" parameter for your query.
+        # @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 `Contact` and the `ObjectKey` set to the `ContactId` 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
 
         ##

data/lib/lockstep_sdk/models/contact_sync_model.rb

@@ -81,7 +81,7 @@ module LockstepSdk
         attr_accessor :role_code
 
         ##
-        # @return [Email] The email address of the contact.
+        # @return [String] The email address of the contact.
         attr_accessor :email_address
 
         ##
@@ -125,11 +125,11 @@ module LockstepSdk
         attr_accessor :is_active
 
         ##
-        # @return [Uri] A webpage URL for more information about this contact.
+        # @return [String] A webpage URL for more information about this contact.
         attr_accessor :webpage_url
 
         ##
-        # @return [Uri] If available, the URL of a photograph that shows this contact.
+        # @return [String] If available, the URL of a photograph that shows this contact.
         attr_accessor :picture_url
 
         ##

data/lib/lockstep_sdk/models/credit_memo_applied_model.rb

@@ -97,23 +97,23 @@ module LockstepSdk
         attr_accessor :modified_user_id
 
         ##
-        # @return [Uuid] AppEnrollmentId for this record; used for mapping purposes.
+        # @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 [AttachmentModel] All attachments attached to applied Credit Memo. To retrieve this collection, specify `Attachments` in the "Include" parameter for your query.
+        # @return [AttachmentModel] A collection of attachments linked to this record. To retrieve this collection, specify `Attachments` in the `include` parameter when retrieving data. To create an attachment, use the [Upload Attachment](https://developer.lockstep.io/reference/post_api-v1-attachments) 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 :attachments
 
         ##
-        # @return [NoteModel] All notes attached to this applied Credit Memo. To retrieve this collection, specify `Notes` in the "Include" parameter for your query.
+        # @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 `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 :notes
 
         ##
-        # @return [CustomFieldDefinitionModel] All definitions attached to this applied Credit Memo. To retrieve this collection, specify `CustomFields` in the "Include" parameter for your query.
+        # @return [CustomFieldDefinitionModel] A collection of custom fields linked to this record. To retrieve this collection, specify `CustomFieldDefinitions` 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_definitions
 
         ##
-        # @return [CustomFieldValueModel] All values attached to this Credit Memo. To retrieve this collection, specify `CustomFields` in the "Include" parameter for your query.
+        # @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
 
         ##

data/lib/lockstep_sdk/models/custom_field_definition_model.rb

@@ -89,7 +89,7 @@ module LockstepSdk
         attr_accessor :modified_user_id
 
         ##
-        # @return [Uuid] AppEnrollmentId for this record; used for mapping purposes.
+        # @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
 
         ##

data/lib/lockstep_sdk/models/custom_field_sync_model.rb

@@ -42,6 +42,7 @@ module LockstepSdk
             @custom_field_label = params.dig(:custom_field_label)
             @string_value = params.dig(:string_value)
             @numeric_value = params.dig(:numeric_value)
+            @value = params.dig(:value)
             @created = params.dig(:created)
             @modified = params.dig(:modified)
         end
@@ -66,6 +67,10 @@ module LockstepSdk
         # @return [Double] The value of this custom field, if it is stored in numeric format.
         attr_accessor :numeric_value
 
+        ##
+        # @return [String] The value of this custom field.
+        attr_accessor :value
+
         ##
         # @return [Date-time] If known, the date when this record was created according to the originating financial system in which this record is maintained. If the originating financial system does not maintain a created-date, leave this field null.
         attr_accessor :created
@@ -83,6 +88,7 @@ module LockstepSdk
                 'customFieldLabel' => @custom_field_label,
                 'stringValue' => @string_value,
                 'numericValue' => @numeric_value,
+                'value' => @value,
                 'created' => @created,
                 'modified' => @modified,
             }