lockstep_sdk 2022.37.24.0 → 2023.1.3.0

data/lib/lockstep_sdk/clients/profiles_accounting_client.rb

@@ -0,0 +1,104 @@
+#
+# Lockstep Platform SDK for Ruby
+#
+# (c) 2021-2023 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Lockstep Network <support@lockstep.io>
+# @copyright  2021-2023 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'awrence'
+
+class ProfilesAccountingClient
+
+    ##
+    # Initialize the ProfilesAccountingClient class with an API client instance.
+    # @param connection [LockstepApi] The API client object for this connection
+    def initialize(connection)
+        @connection = connection
+    end
+
+
+    ##
+    # Retrieves the Accounting Profile specified by this unique identifier, optionally including nested data sets.
+    #
+    # An Accounting Profile is a child of a Company Profile, and collectively, they comprise the identity and necessary information for an accounting  team to work with trading partners, financial institutions, auditors, and others. You can use Accounting Profiles to define an accounting function by what the function does and how to interface with the function.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of this Accounting Profile
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Attachments, CustomFields, Notes
+    def retrieve_accounting_profile(id:, include_param:)
+        path = "/api/v1/profiles/accounting/#{id}"
+        params = {:include => include_param}
+        @connection.request(:get, path, nil, params)
+    end
+
+    ##
+    # Updates an accounting profile that matches the specified id with the requested information.
+    #
+    # The PATCH method allows you to change specific values on the object while leaving other values alone.  As input you should supply a list of field names and new values.  If you do not provide the name of a field, that field will remain unchanged.  This allows you to ensure that you are only updating the specific fields desired.
+    #
+    # An Accounting Profile is a child of a Company Profile, and collectively, they comprise the identity and necessary information for an accounting  team to work with trading partners, financial institutions, auditors, and others. You can use Accounting Profiles to define an accounting function by what the function does and how to interface with the function.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of the Accounting Profile to update
+    # @param body [object] A list of changes to apply to this Accounting Profile
+    def update_accounting_profile(id:, body:)
+        path = "/api/v1/profiles/accounting/#{id}"
+        @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
+    end
+
+    ##
+    # Delete the Accounting Profile referred to by this unique identifier.
+    #
+    # An Accounting Profile is a child of a Company Profile, and collectively, they comprise the identity and necessary information for an accounting  team to work with trading partners, financial institutions, auditors, and others. You can use Accounting Profiles to define an accounting function by what the function does and how to interface with the function.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of the Accounting Profile to disable
+    def delete_accounting_profile(id:)
+        path = "/api/v1/profiles/accounting/#{id}"
+        @connection.request(:delete, path, nil, nil)
+    end
+
+    ##
+    # Creates one or more accounting profiles from a given model.
+    #
+    # An Accounting Profile is a child of a Company Profile, and collectively, they comprise the identity and necessary information for an accounting  team to work with trading partners, financial institutions, auditors, and others. You can use Accounting Profiles to define an accounting function by what the function does and how to interface with the function.
+    #
+    # @param body [AccountingProfileModel] The Accounting Profiles to create
+    def create_accounting_profiles(body:)
+        path = "/api/v1/profiles/accounting"
+        @connection.request(:post, path, body, nil)
+    end
+
+    ##
+    # Queries Accounting Profiles 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 Accounting Profile is a child of a Company Profile, and collectively, they comprise the identity and necessary information for an accounting  team to work with trading partners, financial institutions, auditors, and others. You can use Accounting Profiles to define an accounting function by what the function does and how to interface with the function.
+    #
+    # @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: Attachments, CustomFields, Notes
+    # @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_size [int32] The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    def query_accounting_profiles(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/profiles/accounting/query"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @connection.request(:get, path, nil, params)
+    end
+
+    ##
+    # Retrieves all the Contacts associated with the Accounting Profile by this unique identifier, optionally including nested data sets.
+    #
+    # A Contact has a link to a Contact that is associated with your company's Accounting Profile.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of this Accounting Profile
+    def retrieve_all_accounting_profile_contacts(id:)
+        path = "/api/v1/profiles/accounting/#{id}/contacts/models"
+        @connection.request(:get, path, nil, nil)
+    end
+end

data/lib/lockstep_sdk/clients/profiles_accounting_contacts_client.rb

@@ -0,0 +1,91 @@
+#
+# Lockstep Platform SDK for Ruby
+#
+# (c) 2021-2023 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Lockstep Network <support@lockstep.io>
+# @copyright  2021-2023 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'awrence'
+
+class ProfilesAccountingContactsClient
+
+    ##
+    # Initialize the ProfilesAccountingContactsClient class with an API client instance.
+    # @param connection [LockstepApi] The API client object for this connection
+    def initialize(connection)
+        @connection = connection
+    end
+
+
+    ##
+    # Retrieves the Accounting Profile Contact specified by this unique identifier, optionally including nested data sets.
+    #
+    # A Contact has a link to a Contact that is associated with your company's Accounting Profile. These Contacts are secondary contacts to the primary that is on the profile.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of this Accounting Profile Contact
+    def retrieve_accounting_profile_contact(id:)
+        path = "/api/v1/profiles/accounting/contacts/#{id}"
+        @connection.request(:get, path, nil, nil)
+    end
+
+    ##
+    # Delete the Accounting Profile Contact referred to by this unique identifier.
+    #
+    # An Accounting Profile Contact has a link to a Contact that is associated with your company's Accounting Profile. These Contacts are secondary contacts to the primary that is on the profile.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of the Accounting Profile Contact to delete
+    def delete_accounting_profile_contact(id:)
+        path = "/api/v1/profiles/accounting/contacts/#{id}"
+        @connection.request(:delete, path, nil, nil)
+    end
+
+    ##
+    # Creates one or more Accounting Profile Contacts from a given model.
+    #
+    # An Accounting Profile Contact has a link to a Contact that is associated with your company's Accounting Profile. These Contacts are secondary contacts to the primary that is on the profile.
+    #
+    # @param body [AccountingProfileContactModel] The Accounting Profile Contacts to create
+    def create_accounting_profile_contacts(body:)
+        path = "/api/v1/profiles/accounting/contacts"
+        @connection.request(:post, path, body, nil)
+    end
+
+    ##
+    # Updates an accounting profile contact that matches the specified id with the requested information.
+    #
+    # The PATCH method allows you to change specific values on the object while leaving other values alone.  As input you should supply a list of field names and new values.  If you do not provide the name of a field, that field will remain unchanged.  This allows you to ensure that you are only updating the specific fields desired.
+    #
+    # An Accounting Profile Contact has a link to a Contact that is associated with your company's Accounting Profile. These Contacts are secondary contacts to the primary that is on the profile.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of the Accounting Profile Contact to update
+    # @param contact_id [uuid] The ID of the contact to link to this Accounting Profile Contact
+    def update_accounting_profile_contact(id:, contact_id:)
+        path = "/api/v1/profiles/accounting/contacts/#{id}/#{contactId}"
+        @connection.request(:patch, path, nil, nil)
+    end
+
+    ##
+    # Queries Accounting Profile Contacts for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
+    #
+    # 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 Accounting Profile Contact has a link to a Contact that is associated with your company's Accounting Profile. These Contacts are secondary contacts to the primary that is on the profile.
+    #
+    # @param 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: None
+    # @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_size [int32] The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    def query_accounting_profile_contacts(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/profiles/accounting/contacts/query"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @connection.request(:get, path, nil, params)
+    end
+end

data/lib/lockstep_sdk/clients/{profiles_client.rb → profiles_companies_client.rb}

@@ -1,23 +1,23 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 Lockstep, Inc.
 #
 # For the full copyright and license information, please view the LICENSE
 # file that was distributed with this source code.
 #
 # @author     Lockstep Network <support@lockstep.io>
-# @copyright  2021-2022 Lockstep, Inc.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
 
 require 'awrence'
 
-class ProfilesClient
+class ProfilesCompaniesClient
 
     ##
-    # Initialize the ProfilesClient class with an API client instance.
+    # Initialize the ProfilesCompaniesClient class with an API client instance.
     # @param connection [LockstepApi] The API client object for this connection
     def initialize(connection)
         @connection = connection
@@ -31,7 +31,7 @@ class ProfilesClient
     #
     # @param url_slug [string] 
     def retrieve_public_company_profile(url_slug:)
-        path = "/api/v1/Profiles/companies/#{urlSlug}"
+        path = "/api/v1/profiles/companies/#{urlSlug}"
         @connection.request(:get, path, nil, nil)
     end
 
@@ -46,10 +46,10 @@ class ProfilesClient
     #
     # @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 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_size [int32] The page size for results (default 250, maximum of 500)
     # @param page_number [int32] The page number for results (default 0)
     def query_public_company_profiles(filter:, order:, page_size:, page_number:)
-        path = "/api/v1/Profiles/companies/query"
+        path = "/api/v1/profiles/companies/query"
         params = {:filter => filter, :order => order, :pageSize => page_size, :pageNumber => page_number}
         @connection.request(:get, path, nil, params)
     end

data/lib/lockstep_sdk/clients/provisioning_client.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 Lockstep, Inc.
 #
 # For the full copyright and license information, please view the LICENSE
 # file that was distributed with this source code.
 #
 # @author     Lockstep Network <support@lockstep.io>
-# @copyright  2021-2022 Lockstep, Inc.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 

data/lib/lockstep_sdk/clients/reports_client.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 Lockstep, Inc.
 #
 # For the full copyright and license information, please view the LICENSE
 # file that was distributed with this source code.
 #
 # @author     Lockstep Network <support@lockstep.io>
-# @copyright  2021-2022 Lockstep, Inc.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -84,7 +84,7 @@ class ReportsClient
     # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. No collections are currently available but may be offered in the future
     # @param order [string] The sort order for 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_size [int32] The page size for results (default 250, maximum of 500)
     # @param page_number [int32] The page number for results (default 0)
     def payables_coming_due_summary(filter:, include_param:, order:, page_size:, page_number:)
         path = "/api/v1/Reports/payables-coming-due-summary"
@@ -258,7 +258,7 @@ class ReportsClient
     # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. No collections are currently available but may be offered in the future
     # @param order [string] The sort order for 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_size [int32] The page size for results (default 250, maximum of 500)
     # @param page_number [int32] The page number for results (default 0)
     def days_payable_outstanding_summary(report_date:, filter:, include_param:, order:, page_size:, page_number:)
         path = "/api/v1/Reports/daily-payable-outstanding-summary"

data/lib/lockstep_sdk/clients/status_client.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 Lockstep, Inc.
 #
 # For the full copyright and license information, please view the LICENSE
 # file that was distributed with this source code.
 #
 # @author     Lockstep Network <support@lockstep.io>
-# @copyright  2021-2022 Lockstep, Inc.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 

data/lib/lockstep_sdk/clients/sync_client.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 Lockstep, Inc.
 #
 # For the full copyright and license information, please view the LICENSE
 # file that was distributed with this source code.
 #
 # @author     Lockstep Network <support@lockstep.io>
-# @copyright  2021-2022 Lockstep, Inc.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -109,7 +109,7 @@ class SyncClient
     # @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: Details
     # @param order [string] The sort order for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
-    # @param page_size [int32] The page size for results (default 200). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_size [int32] The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     # @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     def query_syncs(filter:, include_param:, order:, page_size:, page_number:)
         path = "/api/v1/Sync/query"

data/lib/lockstep_sdk/clients/transactions_client.rb

@@ -0,0 +1,54 @@
+#
+# Lockstep Platform SDK for Ruby
+#
+# (c) 2021-2023 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Lockstep Network <support@lockstep.io>
+# @copyright  2021-2023 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'awrence'
+
+class TransactionsClient
+
+    ##
+    # Initialize the TransactionsClient class with an API client instance.
+    # @param connection [LockstepApi] The API client object for this connection
+    def initialize(connection)
+        @connection = connection
+    end
+
+
+    ##
+    # Queries transactions (invoices/credit memos/payments) for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
+    #
+    # More information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.
+    #
+    # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. No collections are currently available but may be offered in the future
+    # @param order [string] The sort order for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_size [int32] The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param current_date [date-time] The date the days past due value will be calculated against. If no currentDate is provided the current UTC date will be used.
+    def query_transactions(filter:, include_param:, order:, page_size:, page_number:, current_date:)
+        path = "/api/v1/Transactions/query"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number, :currentDate => current_date}
+        @connection.request(:get, path, nil, params)
+    end
+
+    ##
+    # Retrieves a list of transaction details for the supplied transaction id.
+    #
+    # A Transaction Detail contains information about the associated Transaction. This information can be an invoice associated to a payment or credit memo or a payment or credit memo used as payment for one or more invoices.
+    #
+    # @param id [uuid] 
+    def retrieve_transaction_details(id:)
+        path = "/api/v1/Transactions/#{id}/details"
+        @connection.request(:get, path, nil, nil)
+    end
+end

data/lib/lockstep_sdk/clients/transcriptions_client.rb

@@ -0,0 +1,91 @@
+#
+# Lockstep Platform SDK for Ruby
+#
+# (c) 2021-2023 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Lockstep Network <support@lockstep.io>
+# @copyright  2021-2023 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'awrence'
+
+class TranscriptionsClient
+
+    ##
+    # Initialize the TranscriptionsClient class with an API client instance.
+    # @param connection [LockstepApi] The API client object for this connection
+    def initialize(connection)
+        @connection = connection
+    end
+
+
+    ##
+    # Retrieves the Transcription Validation Request specified by this unique identifier, optionally including nested data sets.
+    #
+    # A Transcription Validation Request represents a collection of files sent from the client to verify the file type using the machine learning platform Sage AI.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of the transcription validation request
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Items
+    def retrieve_transcription_validation_request(id:, include_param:)
+        path = "/api/v1/Transcriptions/validate/#{id}"
+        params = {:include => include_param}
+        @connection.request(:get, path, nil, params)
+    end
+
+    ##
+    # Updates an existing Transcription Validation Request 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 Transcription Validation Request represents a collection of files sent from the client to verify the file type using the machine learning platform Sage AI.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of the Transcription Validation Request to update
+    # @param body [object] A list of changes to apply to this Transcription Validation Request
+    def update_transcription_validation_request(id:, body:)
+        path = "/api/v1/Transcriptions/validate/#{id}"
+        @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
+    end
+
+    ##
+    # Deletes the Transcription Validation Request and all associated items referred to by this unique identifier.
+    #
+    # A Transcription Validation Request represents a collection of files sent from the client to verify the file type using the machine learning platform Sage AI.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of the transcription validation request to delete
+    def delete_transcription_validation_request(id:)
+        path = "/api/v1/Transcriptions/validate/#{id}"
+        @connection.request(:delete, path, nil, nil)
+    end
+
+    ##
+    # Creates one Transcription Validation Request with all the associated request items within this account and returns the record as created.
+    #
+    # A Transcription Validation Request represents a collection of files sent from the client to verify the file type using the machine learning platform Sage AI.
+    #
+    # @param body [TranscriptionRequestSubmit] The files which will be verified
+    def create_transcription_validation_request(body:)
+        path = "/api/v1/Transcriptions/validate"
+        @connection.request(:post, path, body, nil)
+    end
+
+    ##
+    # Queries transcription validation requests transactions for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
+    #
+    # More information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.
+    #
+    # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Items
+    # @param order [string] The sort order for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_size [int32] The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    def query_transcription_validation_requests(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/Transcriptions/validate/query"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @connection.request(:get, path, nil, params)
+    end
+end

data/lib/lockstep_sdk/clients/user_accounts_client.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 Lockstep, Inc.
 #
 # For the full copyright and license information, please view the LICENSE
 # file that was distributed with this source code.
 #
 # @author     Lockstep Network <support@lockstep.io>
-# @copyright  2021-2022 Lockstep, Inc.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -62,18 +62,6 @@ class UserAccountsClient
         @connection.request(:delete, path, nil, nil)
     end
 
-    ##
-    # Reenable the user referred to by this unique identifier.
-    #
-    # A User represents a person who has the ability to authenticate against the Lockstep Platform and use services such as Lockstep Inbox.  A User is uniquely identified by an Azure identity, and each user must have an email address defined within their account.  All Users must validate their email to make use of Lockstep platform services.  Users may have different privileges and access control rights within the Lockstep Platform.
-    #
-    # @param id [uuid] The unique Lockstep Platform ID number of this User
-    def reenable_user(id:)
-        path = "/api/v1/UserAccounts/reenable"
-        params = {:id => id}
-        @connection.request(:post, path, nil, params)
-    end
-
     ##
     # Invite a user with the specified email to join your accounting group. The user will receive an email to set up their account.
     #
@@ -114,7 +102,7 @@ class UserAccountsClient
     # @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: Notes, Attachments, CustomFields, AccountingRole
     # @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_size [int32] The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     # @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     def query_users(filter:, include_param:, order:, page_size:, page_number:)
         path = "/api/v1/UserAccounts/query"
@@ -133,4 +121,14 @@ class UserAccountsClient
         params = {:groupKey => group_key}
         @connection.request(:post, path, nil, params)
     end
+
+    ##
+    # Retrieves the user data for the current user. This allows for retrieving extended user data such as UTM parameters.
+    #
+    # @param include_param [string] The set of data to retrieve. To avoid any casing confusion, these values are converted to upper case in storage. Possible values are: UTM
+    def get_user_data(include_param:)
+        path = "/api/v1/UserAccounts/user-data"
+        params = {:include => include_param}
+        @connection.request(:get, path, nil, params)
+    end
 end

data/lib/lockstep_sdk/clients/user_roles_client.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 Lockstep, Inc.
 #
 # For the full copyright and license information, please view the LICENSE
 # file that was distributed with this source code.
 #
 # @author     Lockstep Network <support@lockstep.io>
-# @copyright  2021-2022 Lockstep, Inc.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -41,7 +41,7 @@ class UserRolesClient
     # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. No collections are currently available but may be offered in the future
     # @param order [string] The sort order for this query. See 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_size [int32] The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     # @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     def query_user_roles(filter:, include_param:, order:, page_size:, page_number:)
         path = "/api/v1/UserRoles/query"

data/lib/lockstep_sdk/clients/webhook_rules_client.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 Lockstep, Inc.
 #
 # For the full copyright and license information, please view the LICENSE
 # file that was distributed with this source code.
 #
 # @author     Lockstep Network <support@lockstep.io>
-# @copyright  2021-2022 Lockstep, Inc.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -71,7 +71,7 @@ class WebhookRulesClient
     # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. No collections are currently available but may be offered in the future
     # @param order [string] The sort order for this query. See 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_size [int32] The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     # @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     def query_webhook_rules(filter:, include_param:, order:, page_size:, page_number:)
         path = "/api/v1/WebhookRules/query"

data/lib/lockstep_sdk/clients/webhooks_client.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 Lockstep, Inc.
 #
 # For the full copyright and license information, please view the LICENSE
 # file that was distributed with this source code.
 #
 # @author     Lockstep Network <support@lockstep.io>
-# @copyright  2021-2022 Lockstep, Inc.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -80,7 +80,7 @@ class WebhooksClient
     # @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 collection: WebhookRules
     # @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_size [int32] The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     # @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     def query_webhooks(filter:, include_param:, order:, page_size:, page_number:)
         path = "/api/v1/Webhooks/query"
@@ -95,7 +95,7 @@ class WebhooksClient
     # @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_size [int32] The page size for results (default 250, maximum of 500).
     # @param page_number [int32] The page number for results (default 0).
     def query_webhook_history(webhook_id:, include_param:, filter:, select:, page_size:, page_number:)
         path = "/api/v1/Webhooks/#{webhookId}/history/query"