lockstep_sdk 2022.37.24.0 → 2023.1.3.0

data/lib/lockstep_sdk/clients/financial_account_balance_history_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 FinancialAccountBalanceHistoryClient
     #
     # @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_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_balance_history(filter:, order:, page_size:, page_number:)
         path = "/api/v1/FinancialAccountBalanceHistory/query"

data/lib/lockstep_sdk/clients/financial_account_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
 #
 
@@ -67,7 +67,7 @@ class FinancialAccountClient
     # @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.
     # @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_financial_accounts(filter:, include_param:, order:, page_size:, page_number:)
         path = "/api/v1/FinancialAccount/query"

data/lib/lockstep_sdk/clients/financial_year_settings_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 FinancialYearSettingsClient
     #
     # @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_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_financial_year_settings(filter:, order:, page_size:, page_number:)
         path = "/api/v1/FinancialYearSettings/query"

data/lib/lockstep_sdk/clients/group_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
 #
 

data/lib/lockstep_sdk/clients/invoice_addresses_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 InvoiceAddressesClient
+
+    ##
+    # Initialize the InvoiceAddressesClient class with an API client instance.
+    # @param connection [LockstepApi] The API client object for this connection
+    def initialize(connection)
+        @connection = connection
+    end
+
+
+    ##
+    # Retrieves the invoice address specified by this unique identifier, optionally including nested data sets.
+    #
+    # An Invoice Address contains address information about an invoice. You can use Invoice Addresses to track information about locations important to an invoice such as: where a company's goods are shipped from, where a company's goods are shipped to or billing addresses to name a few.
+    #
+    # @param id [uuid] The unique ID number of this invoice address
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve.
+    def retrieve_invoice_address(id:, include_param:)
+        path = "/api/v1/invoice-addresses/#{id}"
+        params = {:include => include_param}
+        @connection.request(:get, path, nil, params)
+    end
+
+    ##
+    # Deletes the Invoice Address by this unique identifier.
+    #
+    # An Invoice Address contains address information about an invoice. You can use Invoice Addresses to track information about locations important to an invoice such as: where a company's goods are shipped from, where a company's goods are shipped to or billing addresses to name a few.
+    #
+    # @param id [uuid] The unique ID of the Invoice Address to delete
+    def delete_invoice_address(id:)
+        path = "/api/v1/invoice-addresses/#{id}"
+        @connection.request(:delete, path, nil, nil)
+    end
+
+    ##
+    # Updates an existing Invoice Address 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 Address contains address information about an invoice. You can use Invoice Addresses to track information about locations important to an invoice such as: where a company's goods are shipped from, where a company's goods are shipped to or billing addresses to name a few.
+    #
+    # @param id [uuid] The unique ID number of the Invoice Address to update
+    # @param body [object] A list of changes to apply to this Invoice Address
+    def update_invoice_address(id:, body:)
+        path = "/api/v1/invoice-addresses/#{id}"
+        @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
+    end
+
+    ##
+    # Creates one or more Invoice Addresses within this account and returns the records as created.
+    #
+    # An Invoice Address contains address information about an invoice. You can use Invoice Addresses to track information about locations important to an invoice such as: where a company's goods are shipped from, where a company's goods are shipped to or billing addresses to name a few.
+    #
+    # @param body [InvoiceAddressModel] The Invoice Address to create
+    def create_invoice_address(body:)
+        path = "/api/v1/invoice-addresses"
+        @connection.request(:post, path, body, nil)
+    end
+
+    ##
+    # Queries Invoice Addresses 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 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_addresses(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/invoice-addresses/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/invoice_history_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
 #
 
@@ -43,7 +43,7 @@ class InvoiceHistoryClient
     # @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_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_invoice_history(filter:, include_param:, order:, page_size:, page_number:)
         path = "/api/v1/InvoiceHistory/query"

data/lib/lockstep_sdk/clients/invoice_lines_client.rb

@@ -0,0 +1,88 @@
+#
+# 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 InvoiceLinesClient
+
+    ##
+    # Initialize the InvoiceLinesClient class with an API client instance.
+    # @param connection [LockstepApi] The API client object for this connection
+    def initialize(connection)
+        @connection = connection
+    end
+
+
+    ##
+    # Creates one or more invoice lines within this account and returns the created records
+    #
+    # @param body [InvoiceLineModel] 
+    def create_invoiceline(body:)
+        path = "/api/v1/invoice-lines"
+        @connection.request(:post, path, body, nil)
+    end
+
+    ##
+    #
+    #
+    # @param body [BulkDeleteRequestModel] The unique Lockstep Platform ID numbers of the Invoice Lines to delete; NOT the customer's ERP keys
+    def delete_invoice_lines(body:)
+        path = "/api/v1/invoice-lines"
+        @connection.request(:delete, path, body, nil)
+    end
+
+    ##
+    #
+    #
+    # @param invoice_line_id [uuid] Unique id of the the InvoiceLine
+    def retrieves_invoice_line(invoice_line_id:)
+        path = "/api/v1/invoice-lines/#{invoiceLineId}"
+        @connection.request(:get, path, nil, nil)
+    end
+
+    ##
+    # Updates an existing Invoice Line 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.
+    #
+    # @param invoice_line_id [uuid] Unique id of the the InvoiceLine
+    # @param body [object] A list of changes to apply to this Invoice Line
+    def update_invoice_line(invoice_line_id:, body:)
+        path = "/api/v1/invoice-lines/#{invoiceLineId}"
+        @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
+    end
+
+    ##
+    #
+    #
+    # @param invoice_line_id [uuid] Unique id of the the InvoiceLine
+    def deletes_invoice_line(invoice_line_id:)
+        path = "/api/v1/invoice-lines/#{invoiceLineId}"
+        @connection.request(:delete, path, nil, nil)
+    end
+
+    ##
+    # Queries Invoice Lines for the account using specified filtering 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.
+    # @param order [string] The sort order for the results, in the [Searchlight order syntax]
+    # @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_invoice_lines(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/invoice-lines/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/invoices_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,6 +71,17 @@ class InvoicesClient
         @connection.request(:post, path, body, nil)
     end
 
+    ##
+    # Delete the Invoices referred to by these unique identifiers.
+    #
+    # 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 [BulkDeleteRequestModel] The unique Lockstep Platform ID numbers of the Invoices to delete; NOT the customer's ERP keys
+    def delete_invoices(body:)
+        path = "/api/v1/Invoices"
+        @connection.request(:delete, path, body, nil)
+    end
+
     ##
     # Queries Invoices for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
     #
@@ -81,7 +92,7 @@ class InvoicesClient
     # @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_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_invoices(filter:, include_param:, order:, page_size:, page_number:)
         path = "/api/v1/Invoices/query"
@@ -110,9 +121,9 @@ class InvoicesClient
     # 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 include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Summary, Aging
     # @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_invoice_summary_view(filter:, include_param:, order:, page_size:, page_number:)
         path = "/api/v1/Invoices/views/summary"
@@ -130,7 +141,7 @@ class InvoicesClient
     # @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_at_risk_view(filter:, include_param:, order:, page_size:, page_number:)
         path = "/api/v1/Invoices/views/at-risk-summary"

data/lib/lockstep_sdk/clients/leads_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/magic_links_client.rb

@@ -0,0 +1,62 @@
+#
+# 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 MagicLinksClient
+
+    ##
+    # Initialize the MagicLinksClient class with an API client instance.
+    # @param connection [LockstepApi] The API client object for this connection
+    def initialize(connection)
+        @connection = connection
+    end
+
+
+    ##
+    # Retrieves the Magic Link specified by this unique identifier, optionally including nested data sets.
+    #
+    # @param id [uuid] The id of the Magic Link
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: User
+    def retrieve_magic_link(id:, include_param:)
+        path = "/api/v1/useraccounts/magic-links/#{id}"
+        params = {:include => include_param}
+        @connection.request(:get, path, nil, params)
+    end
+
+    ##
+    # Revokes the magic link with the specified id so it cannot be used to call the API.
+    #
+    # Revocation will be received by all servers within five minutes of revocation. API calls made using this magic link after the revocation will fail. A revoked magic link cannot be un-revoked.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of this magic link
+    def revoke_magic_link(id:)
+        path = "/api/v1/useraccounts/magic-links/#{id}"
+        @connection.request(:delete, path, nil, nil)
+    end
+
+    ##
+    # Queries Magic Links for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
+    #
+    # @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: User
+    # @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 250, maximum of 500)
+    # @param page_number [int32] The page number for results (default 0)
+    def query_magic_links(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/useraccounts/magic-links/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/notes_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
 #
 
@@ -77,7 +77,7 @@ class NotesClient
     # @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_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_notes(filter:, include_param:, order:, page_size:, page_number:)
         path = "/api/v1/Notes/query"

data/lib/lockstep_sdk/clients/payments_applied_client.rb

@@ -0,0 +1,93 @@
+#
+# 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 PaymentsAppliedClient
+
+    ##
+    # Initialize the PaymentsAppliedClient class with an API client instance.
+    # @param connection [LockstepApi] The API client object for this connection
+    def initialize(connection)
+        @connection = connection
+    end
+
+
+    ##
+    # Retrieves the Payment Applied specified by this unique identifier, optionally including nested data sets.
+    #
+    # A Payment Applied 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 Applied 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 Applied; 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, Payment
+    def retrieve_payment_applied(id:, include_param:)
+        path = "/api/v1/payments-applied/#{id}"
+        params = {:include => include_param}
+        @connection.request(:get, path, nil, params)
+    end
+
+    ##
+    # Updates an existing Payment Applied 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 Applied 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 Applied 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 Applied to update; NOT the customer's ERP key
+    # @param body [object] A list of changes to apply to this Payment Applied
+    def update_payment_applied(id:, body:)
+        path = "/api/v1/payments-applied/#{id}"
+        @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
+    end
+
+    ##
+    # Deletes the Payment Applied referred to by this unique identifier.
+    #
+    # A Payment Applied 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 Applied 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 Applied to delete; NOT the customer's ERP key
+    def delete_payment_applied(id:)
+        path = "/api/v1/payments-applied/#{id}"
+        @connection.request(:delete, path, nil, nil)
+    end
+
+    ##
+    # Creates one or more Payments Applied within this account and returns the records as created.
+    #
+    # A Payment Applied 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 Applied contains information about which Invoices are connected to which Payments and for which amounts.
+    #
+    # @param body [PaymentAppliedModel] The Payments Applied to create
+    def create_payments_applied(body:)
+        path = "/api/v1/payments-applied"
+        @connection.request(:post, path, body, nil)
+    end
+
+    ##
+    # Queries Payments Applied 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 Applied 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 Applied 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 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_payments_applied(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/payments-applied/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/payments_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
 #
 
@@ -83,7 +83,7 @@ class PaymentsClient
     # @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: Applications, Notes, Attachments, CustomFields
     # @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_payments(filter:, include_param:, order:, page_size:, page_number:)
         path = "/api/v1/Payments/query"
@@ -110,9 +110,9 @@ class PaymentsClient
     # A Payment represents money sent from one company to another.  A single payment may contain payments for one or more invoices; it is also possible for payments to be made in advance of an invoice, for example, as a deposit.  The creator of the Payment is identified by the `CustomerId` field, and the recipient of the Payment is identified by the `CompanyId` field.  Most Payments are uniquely identified both by a Lockstep Platform ID number and a customer ERP "key" that was generated by the system that originated the Payment.  Payments that have not been fully applied have a nonzero `UnappliedAmount` value, which represents a deposit that has been paid and not yet applied to an Invoice.
     #
     # @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 include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Summary, Aging
     # @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_payment_summary_view(filter:, include_param:, order:, page_size:, page_number:)
         path = "/api/v1/Payments/views/summary"
@@ -136,7 +136,7 @@ class PaymentsClient
     # @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_payment_detail_view(filter:, include_param:, order:, page_size:, page_number:)
         path = "/api/v1/Payments/views/detail"