lockstep_sdk 2022.4.32.0

data/lib/lockstep_sdk/clients/definitions_client.rb

@@ -0,0 +1,95 @@
+#
+# 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.
+# @version    2022.4
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'awrence'
+
+class DefinitionsClient
+
+    ##
+    # Initialize the DefinitionsClient class with a lockstepsdk instance.
+    # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
+    def initialize(lockstepsdk)
+        @lockstepsdk = lockstepsdk
+    end
+
+
+    ##
+    # Queries the ISO3166 List of Countries 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.  Your program may want to show a list of countries. The ISO maintains a list of countries called [ISO3166](https://www.iso.org/iso-3166-country-codes.html). For convenience, this list is available in the API.
+    #
+    # @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_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    def query_countries(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/Definitions/countries"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Queries Currencies 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.
+    #
+    # Your app may wish to make use of a reference list that contains names and attributes for all ISO-4217 defined currency codes.  This information is provided via a query endpoint so that you can use this API to provide a user selection screen.
+    #
+    # @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_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    def query_currencies(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/Definitions/currencies"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Queries the list of States in the United States 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.  Your app may wish to make use of a reference list that contains names and codes for all states in the United States.  This information is provided for the United States since many financial systems require mailing addresses that use codes for states.
+    #
+    # @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_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    def query_states(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/Definitions/states"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Queries a list of financial systems 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.  Lockstep provides a list of financial systems that may be useful as a selection screen that allows customers to select from a list.  You can query these items by name or attributes and use this data source to help users complete a selection.
+    #
+    # @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_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    def query_financial_systems(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/Definitions/financialsystems"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+end

data/lib/lockstep_sdk/clients/emails_client.rb

@@ -0,0 +1,108 @@
+#
+# 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.
+# @version    2022.4
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'awrence'
+
+class EmailsClient
+
+    ##
+    # Initialize the EmailsClient class with a lockstepsdk instance.
+    # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
+    def initialize(lockstepsdk)
+        @lockstepsdk = lockstepsdk
+    end
+
+
+    ##
+    # Retrieves the email with the specified email identifier.
+    #
+    # An Email represents a communication sent from one company to another.  The creator of the email is identified by the `CompanyId` field, recipient(s) by the `EmailTo` field, and cc recipient(s) by the 'EmailCC' field. The Email Model represents an email and a number of different metadata attributes related to the creation, storage, and ownership of the email.
+    #
+    # @param id [uuid] The unique ID number of the Email to retrieve.
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Attachments, CustomFields, Notes, ResponseOrigin
+    def retrieve_email(id:, include_param:)
+        path = "/api/v1/Emails/#{id}"
+        params = {:include => include_param}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Updates an existing Email 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 Email represents a communication sent from one company to another.  The creator of the email is identified by the `CompanyId` field, recipient(s) by the `EmailTo` field, and cc recipient(s) by the 'EmailCC' field. The Email Model represents an email and a number of different metadata attributes related to the creation, storage, and ownership of the email.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of the email to update
+    # @param body [object] A list of changes to apply to this Email
+    def update_email(id:, body:)
+        path = "/api/v1/Emails/#{id}"
+        @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
+    end
+
+    ##
+    # Deletes the Email referred to by this unique identifier.
+    #
+    # An Email represents a communication sent from one company to another.  The creator of the email is identified by the `CompanyId` field, recipient(s) by the `EmailTo` field, and cc recipient(s) by the 'EmailCC' field. The Email Model represents an email and a number of different metadata attributes related to the creation, storage, and ownership of the email.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of the Email to delete
+    def delete_email(id:)
+        path = "/api/v1/Emails/#{id}"
+        @lockstepsdk.request(:delete, path, nil, nil)
+    end
+
+    ##
+    # Retrieves a signature logo for the email with the specified identifier and increments 'ViewCount'.
+    #
+    # An Email represents a communication sent from one company to another.  The creator of the email is identified by the `CompanyId` field, recipient(s) by the `EmailTo` field, and cc recipient(s) by the 'EmailCC' field. The Email Model represents an email and a number of different metadata attributes related to the creation, storage, and ownership of the email.
+    #
+    # @param email_id [uuid] The unique ID number of the Email to retrieve.
+    # @param nonce [uuid] The random nonce applied at time of url creation.
+    def retrieve_email_logo(email_id:, nonce:)
+        path = "/api/v1/Emails/#{emailId}/logo/#{nonce}"
+        @lockstepsdk.request(:get, path, nil, nil)
+    end
+
+    ##
+    # Creates one or more emails from the specified array of Email Models
+    #
+    # An Email represents a communication sent from one company to another.  The creator of the email is identified by the `CompanyId` field, recipient(s) by the `EmailTo` field, and cc recipient(s) by the 'EmailCC' field. The Email Model represents an email and a number of different metadata attributes related to the creation, storage, and ownership of the email.
+    #
+    # @param body [EmailModel] The array of emails to be created
+    def create_emails(body:)
+        path = "/api/v1/Emails"
+        @lockstepsdk.request(:post, path, body, nil)
+    end
+
+    ##
+    # Queries Emails 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.
+    #
+    # An Email represents a communication sent from one company to another.  The creator of the email is identified by the `CompanyId` field, recipient(s) by the `EmailTo` field, and cc recipient(s) by the 'EmailCC' field. The Email Model represents an email and a number of different metadata attributes related to the creation, storage, and ownership of the email.
+    #
+    # @param filter [string] The filter to use to select from the list of available applications, in the [Searchlight query syntax](https://github.com/tspence/csharp-searchlight).
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Attachments, CustomFields, Notes, ResponseOrigin
+    # @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). 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_emails(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/Emails/query"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+end

data/lib/lockstep_sdk/clients/invoice_history_client.rb

@@ -0,0 +1,56 @@
+#
+# 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.
+# @version    2022.4
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'awrence'
+
+class InvoiceHistoryClient
+
+    ##
+    # Initialize the InvoiceHistoryClient class with a lockstepsdk instance.
+    # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
+    def initialize(lockstepsdk)
+        @lockstepsdk = lockstepsdk
+    end
+
+
+    ##
+    # Retrieves the history of the Invoice specified by this unique identifier.
+    #
+    # An Invoice represents a bill sent from one company to another.  The Lockstep Platform tracks changes to each Invoice so that you can observe the changes over time.  You can view the InvoiceHistory list to monitor and observe the changes of this Invoice and track the dates when changes occurred.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of this invoice; NOT the customer's ERP key
+    def retrieve_invoice_history(id:)
+        path = "/api/v1/InvoiceHistory/#{id}"
+        @lockstepsdk.request(:get, path, nil, nil)
+    end
+
+    ##
+    # Queries Invoice History for this account using the specified filtering, sorting, and pagination rules requested.
+    #
+    # An Invoice represents a bill sent from one company to another.  The Lockstep Platform tracks changes to each Invoice so that you can observe the changes over time.  You can view the InvoiceHistory list to monitor and observe the changes of this Invoice and track the dates when changes occurred.
+    #
+    # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. No collections are currently available for querying but may be available in the future.
+    # @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_size [int32] The page size for results (default 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_invoice_history(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/InvoiceHistory/query"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+end

data/lib/lockstep_sdk/clients/invoices_client.rb

@@ -0,0 +1,126 @@
+#
+# 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.
+# @version    2022.4
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'awrence'
+
+class InvoicesClient
+
+    ##
+    # Initialize the InvoicesClient class with a lockstepsdk instance.
+    # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
+    def initialize(lockstepsdk)
+        @lockstepsdk = lockstepsdk
+    end
+
+
+    ##
+    # Retrieves the Invoice specified by this unique identifier, optionally including nested data sets.
+    #
+    # 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 this invoice; 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: Addresses, Lines, Payments, Notes, Attachments, Company, Customer, CustomFields, CreditMemos
+    def retrieve_invoice(id:, include_param:)
+        path = "/api/v1/Invoices/#{id}"
+        params = {:include => include_param}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # 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.
+    #
+    # @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
+    def update_invoice(id:, body:)
+        path = "/api/v1/Invoices/#{id}"
+        @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
+    end
+
+    ##
+    # Deletes the Invoice referred to by this unique identifier. 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 delete; NOT the customer's ERP key
+    def delete_invoice(id:)
+        path = "/api/v1/Invoices/#{id}"
+        @lockstepsdk.request(:delete, path, nil, nil)
+    end
+
+    ##
+    # Creates one or more Invoices within this account and returns the records as created.
+    #
+    # 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 body [InvoiceModel] The Invoices to create
+    def create_invoices(body:)
+        path = "/api/v1/Invoices"
+        @lockstepsdk.request(:post, path, body, nil)
+    end
+
+    ##
+    # 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.
+    #
+    # @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
+    # @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_invoices(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/Invoices/query"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Queries Invoices for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.  Display the results using the Invoice Summary View format.
+    #
+    # 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.
+    #
+    # The Invoice Summary View represents a slightly different view of the data and includes some extra fields that might be useful.  For more information, see the data format of the Invoice Summary Model.
+    #
+    # @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_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    def query_invoice_summary_view(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/Invoices/views/summary"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Queries At Risk Invoices for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.  Display the results using the At Risk Invoice Summary View format.
+    #
+    # 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.
+    #
+    # The At Risk Invoice Summary View represents a slightly different view of the data and includes some extra fields that might be useful.  For more information, see the data format of the At Risk Invoice Summary Model.
+    #
+    # @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_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    def query_at_risk_invoice_summary_view(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/Invoices/views/at-risk-summary"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+end

data/lib/lockstep_sdk/clients/leads_client.rb

@@ -0,0 +1,40 @@
+#
+# 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.
+# @version    2022.4
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'awrence'
+
+class LeadsClient
+
+    ##
+    # Initialize the LeadsClient class with a lockstepsdk instance.
+    # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
+    def initialize(lockstepsdk)
+        @lockstepsdk = lockstepsdk
+    end
+
+
+    ##
+    # Creates one or more Leads within the Lockstep platform and returns the records as created.
+    #
+    # A Lead is a person who is interested in the Lockstep platform but needs certain new features in order to use it. If you are interested in the Lockstep platform, you can create a lead with your information and our team will prioritize the feature you need.
+    #
+    # @param body [LeadModel] The Leads to create
+    def create_leads(body:)
+        path = "/api/v1/Leads"
+        @lockstepsdk.request(:post, path, body, nil)
+    end
+end

data/lib/lockstep_sdk/clients/notes_client.rb

@@ -0,0 +1,84 @@
+#
+# 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.
+# @version    2022.4
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'awrence'
+
+class NotesClient
+
+    ##
+    # Initialize the NotesClient class with a lockstepsdk instance.
+    # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
+    def initialize(lockstepsdk)
+        @lockstepsdk = lockstepsdk
+    end
+
+
+    ##
+    # 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.
+    #
+    # @param id [uuid] The unique ID number of the Note to retrieve
+    # @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
+    def retrieve_note(id:, include_param:)
+        path = "/api/v1/Notes/#{id}"
+        params = {:include => include_param}
+        @lockstepsdk.request(:get, path, nil, params)
+    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.
+    #
+    # See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
+    #
+    # @param id [uuid] Note id to be archived
+    def archive_note(id:)
+        path = "/api/v1/Notes/#{id}"
+        @lockstepsdk.request(:delete, path, nil, nil)
+    end
+
+    ##
+    # Creates one or more notes from the specified array of Note Models
+    #
+    # 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.
+    #
+    # @param body [NoteModel] The array of notes to be created
+    def create_notes(body:)
+        path = "/api/v1/Notes"
+        @lockstepsdk.request(:post, path, body, nil)
+    end
+
+    ##
+    # 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.
+    #
+    # See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
+    #
+    # @param filter [string] The filter to use to select from the list of available applications, in the [Searchlight query syntax](https://github.com/tspence/csharp-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_number [int32] The page number for results (default 0)
+    def query_notes(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/Notes/query"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+end

data/lib/lockstep_sdk/clients/payment_applications_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.
+# @version    2022.4
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'awrence'
+
+class PaymentApplicationsClient
+
+    ##
+    # Initialize the PaymentApplicationsClient class with a lockstepsdk instance.
+    # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
+    def initialize(lockstepsdk)
+        @lockstepsdk = lockstepsdk
+    end
+
+
+    ##
+    # Retrieves the Payment Application specified by this unique identifier, optionally including nested data sets.
+    #
+    # 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 this Payment 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: Invoice
+    def retrieve_payment_application(id:, include_param:)
+        path = "/api/v1/PaymentApplications/#{id}"
+        params = {:include => include_param}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # 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.
+    #
+    # @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
+    def update_payment_application(id:, body:)
+        path = "/api/v1/PaymentApplications/#{id}"
+        @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
+    end
+
+    ##
+    # Deletes the Payment Application referred to by this unique identifier.
+    #
+    # 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 delete; NOT the customer's ERP key
+    def delete_payment_application(id:)
+        path = "/api/v1/PaymentApplications/#{id}"
+        @lockstepsdk.request(:delete, path, nil, nil)
+    end
+
+    ##
+    # Creates one or more Payment Applications within this account and returns the records as created.
+    #
+    # 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 body [PaymentAppliedModel] The Payment Applications to create
+    def create_payment_applications(body:)
+        path = "/api/v1/PaymentApplications"
+        @lockstepsdk.request(:post, path, body, nil)
+    end
+
+    ##
+    # 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.
+    #
+    # @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
+    # @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_payment_applications(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/PaymentApplications/query"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+end