lockstep_sdk 2022.4.32.0

data/lib/lockstep_sdk/clients/companies_client.rb

@@ -0,0 +1,123 @@
+#
+# 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 CompaniesClient
+
+    ##
+    # Initialize the CompaniesClient class with a lockstepsdk instance.
+    # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
+    def initialize(lockstepsdk)
+        @lockstepsdk = lockstepsdk
+    end
+
+
+    ##
+    # Retrieves the Company specified by this unique identifier, optionally including nested data sets.  A Company represents a customer, a vendor, or a company within the organization of the account holder. Companies can have parents and children, representing an organizational hierarchy of corporate entities. You can use Companies to track projects and financial data under this Company label.
+    #
+    # See [Vendors, Customers, and Companies](https://developer.lockstep.io/docs/companies-customers-and-vendors) for more information.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of this Company; NOT the customer's ERP key
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Attachments, Contacts, CustomFields, Invoices, Notes, Classification
+    def retrieve_company(id:, include_param:)
+        path = "/api/v1/Companies/#{id}"
+        params = {:include => include_param}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Updates a Company that matches the specified id with the requested information.
+    #
+    # The PATCH method allows you to change specific values on the object while leaving other values alone.  As input you should supply a list of field names and new values.  If you do not provide the name of a field, that field will remain unchanged.  This allows you to ensure that you are only updating the specific fields desired.  A Company represents a customer, a vendor, or a company within the organization of the account holder. Companies can have parents and children, representing an organizational hierarchy of corporate entities. You can use Companies to track projects and financial data under this Company label.
+    #
+    # See [Vendors, Customers, and Companies](https://developer.lockstep.io/docs/companies-customers-and-vendors) for more information.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of this Company; NOT the customer's ERP key
+    # @param body [object] A list of changes to apply to this Company
+    def update_company(id:, body:)
+        path = "/api/v1/Companies/#{id}"
+        @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
+    end
+
+    ##
+    # Disable the Company referred to by this unique identifier.
+    #
+    # A Company represents a customer, a vendor, or a company within the organization of the account holder. Companies can have parents and children, representing an organizational hierarchy of corporate entities. You can use Companies to track projects and financial data under this Company label.
+    #
+    # See [Vendors, Customers, and Companies](https://developer.lockstep.io/docs/companies-customers-and-vendors) for more information.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of this Company; NOT the customer's ERP key
+    def disable_company(id:)
+        path = "/api/v1/Companies/#{id}"
+        @lockstepsdk.request(:delete, path, nil, nil)
+    end
+
+    ##
+    # Creates one or more Companies from a given model.  A Company represents a customer, a vendor, or a company within the organization of the account holder. Companies can have parents and children, representing an organizational hierarchy of corporate entities. You can use Companies to track projects and financial data under this Company label.
+    #
+    # See [Vendors, Customers, and Companies](https://developer.lockstep.io/docs/companies-customers-and-vendors) for more information.
+    #
+    # @param body [CompanyModel] The Companies to create
+    def create_companies(body:)
+        path = "/api/v1/Companies"
+        @lockstepsdk.request(:post, path, body, nil)
+    end
+
+    ##
+    # Queries Companies 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 Company represents a customer, a vendor, or a company within the organization of the account holder. Companies can have parents and children, representing an organizational hierarchy of corporate entities. You can use Companies to track projects and financial data under this Company label.
+    #
+    # See [Vendors, Customers, and Companies](https://developer.lockstep.io/docs/companies-customers-and-vendors) for more information.
+    #
+    # @param 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, Contacts, CustomFields, Invoices, Notes, Classification
+    # @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_companies(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/Companies/query"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Queries Customer Summaries 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.  The Customer 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 Customer Summary Model.  See [Vendors, Customers, and Companies](https://developer.lockstep.io/docs/companies-customers-and-vendors) for more information.
+    #
+    # @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_number [int32] The page number for results (default 0)
+    def query_customer_summary(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/Companies/views/customer-summary"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Retrieves the Customer Details specified by this unique identifier, optionally including nested data sets.  The Customer Detail 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 Customer Detail Model.  See [Vendors, Customers, and Companies](https://developer.lockstep.io/docs/companies-customers-and-vendors) for more information.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of this Company; NOT the customer's ERP key
+    def retrieve_customer_detail(id:)
+        path = "/api/v1/Companies/views/customer-details/#{id}"
+        @lockstepsdk.request(:get, path, nil, nil)
+    end
+end

data/lib/lockstep_sdk/clients/contacts_client.rb

@@ -0,0 +1,90 @@
+#
+# 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 ContactsClient
+
+    ##
+    # Initialize the ContactsClient class with a lockstepsdk instance.
+    # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
+    def initialize(lockstepsdk)
+        @lockstepsdk = lockstepsdk
+    end
+
+
+    ##
+    # Retrieves the Contact specified by this unique identifier, optionally including nested data sets.  A Contact contains information about a person or role within a Company. You can use Contacts to track information about who is responsible for a specific project, who handles invoices, or information about which role at a particular customer or vendor you should speak with about invoices.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of this Contact; NOT the customer's ERP key
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Attachments, CustomFields, Notes
+    def retrieve_contact(id:, include_param:)
+        path = "/api/v1/Contacts/#{id}"
+        params = {:include => include_param}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Updates a 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.  A Contact contains information about a person or role within a Company. You can use Contacts to track information about who is responsible for a specific project, who handles invoices, or information about which role at a particular customer or vendor you should speak with about invoices.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of the Contact to update; NOT the customer's ERP key
+    # @param body [object] A list of changes to apply to this Contact
+    def update_contact(id:, body:)
+        path = "/api/v1/Contacts/#{id}"
+        @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
+    end
+
+    ##
+    # Disable the Contact referred to by this unique identifier.
+    #
+    # A Contact contains information about a person or role within a Company. You can use Contacts to track information about who is responsible for a specific project, who handles invoices, or information about which role at a particular customer or vendor you should speak with about invoices.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of the Contact to disable; NOT the customer's ERP key
+    def disable_contact(id:)
+        path = "/api/v1/Contacts/#{id}"
+        @lockstepsdk.request(:delete, path, nil, nil)
+    end
+
+    ##
+    # Creates one or more contacts from a given model.
+    #
+    # A Contact contains information about a person or role within a Company. You can use Contacts to track information about who is responsible for a specific project, who handles invoices, or information about which role at a particular customer or vendor you should speak with about invoices.
+    #
+    # @param body [ContactModel] The Contacts to create
+    def create_contacts(body:)
+        path = "/api/v1/Contacts"
+        @lockstepsdk.request(:post, path, body, nil)
+    end
+
+    ##
+    # Queries 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.  A Contact contains information about a person or role within a Company. You can use Contacts to track information about who is responsible for a specific project, who handles invoices, or information about which role at a particular customer or vendor you should speak with about invoices.
+    #
+    # @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 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_contacts(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/Contacts/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/credit_memo_applied_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 CreditMemoAppliedClient
+
+    ##
+    # Initialize the CreditMemoAppliedClient class with a lockstepsdk instance.
+    # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
+    def initialize(lockstepsdk)
+        @lockstepsdk = lockstepsdk
+    end
+
+
+    ##
+    # Retrieves the Credit Memo Application specified by this unique identifier, optionally including nested data sets.
+    #
+    # Credit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds. Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice, Lockstep creates a Credit Memo Application record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Application records to track which Invoices were paid using this Credit.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of this Credit Memo Application; NOT the customer's ERP key
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Attachments, CustomFields, Notes
+    def retrieve_credit_memo_application(id:, include_param:)
+        path = "/api/v1/CreditMemoApplied/#{id}"
+        params = {:include => include_param}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Updates an existing Credit memo 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.  Credit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds. Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice, Lockstep creates a Credit Memo Application record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Application records to track which Invoices were paid using this Credit.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of the Credit Memo Application to update; NOT the customer's ERP key
+    # @param body [object] A list of changes to apply to this Credit Memo Application
+    def update_credit_memo_application(id:, body:)
+        path = "/api/v1/CreditMemoApplied/#{id}"
+        @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
+    end
+
+    ##
+    # Deletes the Credit Memo Application referred to by this unique identifier.
+    #
+    # Credit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds. Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice, Lockstep creates a Credit Memo Application record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Application records to track which Invoices were paid using this Credit.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of the Credit Memo Application to delete; NOT the customer's ERP key
+    def delete_credit_memo_application(id:)
+        path = "/api/v1/CreditMemoApplied/#{id}"
+        @lockstepsdk.request(:delete, path, nil, nil)
+    end
+
+    ##
+    # Creates one or more Credit Memo Applications within this account and returns the records as created.
+    #
+    # Credit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds. Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice, Lockstep creates a Credit Memo Application record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Application records to track which Invoices were paid using this Credit.
+    #
+    # @param body [CreditMemoAppliedModel] The Credit Memo Applications to create
+    def create_credit_memo_applications(body:)
+        path = "/api/v1/CreditMemoApplied"
+        @lockstepsdk.request(:post, path, body, nil)
+    end
+
+    ##
+    # Queries Credit Memo 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.  Credit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds. Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice, Lockstep creates a Credit Memo Application record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Application records to track which Invoices were paid using this Credit.
+    #
+    # @param 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 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_credit_memo_applications(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/CreditMemoApplied/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/currencies_client.rb

@@ -0,0 +1,55 @@
+#
+# 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 CurrenciesClient
+
+    ##
+    # Initialize the CurrenciesClient class with a lockstepsdk instance.
+    # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
+    def initialize(lockstepsdk)
+        @lockstepsdk = lockstepsdk
+    end
+
+
+    ##
+    # Retrieve a currency conversation rate from one currency to another as of the specified date.              Optionally, you can specify which currency data provider to use.
+    #
+    #              The currency rate model contains all of the information used to make the API call, plus the rate to              use for the conversion.
+    #
+    # @param source_currency [string] The ISO 4217 currency code of the origin currency. For a list of currency codes, call List Currencies.
+    # @param destination_currency [string] The ISO 4217 currency code of the target currency. For a list of currency codes, call List Currencies.
+    # @param date [date] The date for which we should cto use for this currency conversion.
+    # @param data_provider [string] Optionally, you can specify a data provider.
+    def retrieve_currency_rate(source_currency:, destination_currency:, date:, data_provider:)
+        path = "/api/v1/Currencies/#{sourceCurrency}/#{destinationCurrency}"
+        params = {:date => date, :dataProvider => data_provider}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Receives an array of dates and currencies and a destination currency and returns an array of the corresponding currency rates to the given destination currency (Limit X).
+    #
+    # @param destination_currency [string] The currency to convert to.
+    # @param body [BulkCurrencyConversionModel] A list of dates and source currencies.
+    def bulk_currency_data(destination_currency:, body:)
+        path = "/api/v1/Currencies/bulk"
+        params = {:destinationCurrency => destination_currency}
+        @lockstepsdk.request(:post, path, body, params)
+    end
+end

data/lib/lockstep_sdk/clients/custom_field_definitions_client.rb

@@ -0,0 +1,94 @@
+#
+# 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 CustomFieldDefinitionsClient
+
+    ##
+    # Initialize the CustomFieldDefinitionsClient class with a lockstepsdk instance.
+    # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
+    def initialize(lockstepsdk)
+        @lockstepsdk = lockstepsdk
+    end
+
+
+    ##
+    # Retrieves the Custom Field Definition specified by this unique identifier.
+    #
+    # A Custom Field represents metadata added to an object within the Lockstep Platform.  Lockstep provides a core definition for each object.  The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products.  When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.  See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of this Custom Field Definition
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. No additional data collections are currently defined on this object, but may be supported in the future.
+    def retrieve_field_definition(id:, include_param:)
+        path = "/api/v1/CustomFieldDefinitions/#{id}"
+        params = {:include => include_param}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Updates an existing Custom Field Definition 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 Custom Field represents metadata added to an object within the Lockstep Platform.  Lockstep provides a core definition for each object.  The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products.  When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.  See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of the Custom Field Definition to update
+    # @param body [object] A list of changes to apply to this Custom Field Definition
+    def update_field_definition(id:, body:)
+        path = "/api/v1/CustomFieldDefinitions/#{id}"
+        @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
+    end
+
+    ##
+    # Deletes the Custom Field Definition referred to by this unique identifier.
+    #
+    # A Custom Field represents metadata added to an object within the Lockstep Platform.  Lockstep provides a core definition for each object.  The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products.  When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.  See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of the Custom Field Definition to delete
+    def delete_field_definition(id:)
+        path = "/api/v1/CustomFieldDefinitions/#{id}"
+        @lockstepsdk.request(:delete, path, nil, nil)
+    end
+
+    ##
+    # Creates one or more Custom Field Definitions and returns the records as created.  A Custom Field represents metadata added to an object within the Lockstep Platform.  Lockstep provides a core definition for each object.  The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products.  When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.  See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
+    #
+    # @param body [CustomFieldDefinitionModel] The Custom Field Definitions to create
+    def create_field_definitions(body:)
+        path = "/api/v1/CustomFieldDefinitions"
+        @lockstepsdk.request(:post, path, body, nil)
+    end
+
+    ##
+    # Queries Custom Field Definitions within 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 Custom Field represents metadata added to an object within the Lockstep Platform.  Lockstep provides a core definition for each object.  The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products.  When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.  See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
+    #
+    # @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 additional data collections are currently defined on this object, but may be supported 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_field_definitions(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/CustomFieldDefinitions/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/custom_field_values_client.rb

@@ -0,0 +1,97 @@
+#
+# 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 CustomFieldValuesClient
+
+    ##
+    # Initialize the CustomFieldValuesClient class with a lockstepsdk instance.
+    # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
+    def initialize(lockstepsdk)
+        @lockstepsdk = lockstepsdk
+    end
+
+
+    ##
+    # Retrieves all Custom Field Definitions.
+    #
+    # A Custom Field represents metadata added to an object within the Lockstep Platform.  Lockstep provides a core definition for each object.  The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products.  When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.  See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
+    #
+    # @param definition_id [uuid] The unique Lockstep Platform ID number of the Custom Field Definition for the Custom Field Value to retrieve.
+    # @param record_key [uuid] The unique Lockstep Platform ID number of the Lockstep Platform object the Custom Field Value is attached to.
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: CustomFieldDefinition
+    def retrieve_field(definition_id:, record_key:, include_param:)
+        path = "/api/v1/CustomFieldValues/#{definitionId}/#{recordKey}"
+        params = {:include => include_param}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Updates an existing Custom Field 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 Custom Field represents metadata added to an object within the Lockstep Platform.  Lockstep provides a core definition for each object.  The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products.  When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.  See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
+    #
+    # @param definition_id [uuid] The unique Lockstep Platform ID number of the Custom Field Definition for the Custom Field Value to retrieve.
+    # @param record_key [uuid] The unique Lockstep Platform ID number of the Lockstep Platform object the Custom Field Value is attached to.
+    # @param body [object] A list of changes to apply to this Custom Field
+    def update_field(definition_id:, record_key:, body:)
+        path = "/api/v1/CustomFieldValues/#{definitionId}/#{recordKey}"
+        @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
+    end
+
+    ##
+    # Deletes the Custom Field referred to by this unique identifier.
+    #
+    # A Custom Field represents metadata added to an object within the Lockstep Platform.  Lockstep provides a core definition for each object.  The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products.  When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.  See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
+    #
+    # @param definition_id [uuid] The unique Lockstep Platform ID number of the Custom Field Definition for the Custom Field Value to retrieve.
+    # @param record_key [uuid] The unique Lockstep Platform ID number of the Lockstep Platform object the Custom Field Value is attached to.
+    def delete_field(definition_id:, record_key:)
+        path = "/api/v1/CustomFieldValues/#{definitionId}/#{recordKey}"
+        @lockstepsdk.request(:delete, path, nil, nil)
+    end
+
+    ##
+    # Creates one or more Custom Fields and returns the records as created.  A Custom Field represents metadata added to an object within the Lockstep Platform.  Lockstep provides a core definition for each object.  The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products.  When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.  See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
+    #
+    # @param body [CustomFieldValueModel] The Custom Fields to create
+    def create_fields(body:)
+        path = "/api/v1/CustomFieldValues"
+        @lockstepsdk.request(:post, path, body, nil)
+    end
+
+    ##
+    # Queries Custom Fields within 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 Custom Field represents metadata added to an object within the Lockstep Platform.  Lockstep provides a core definition for each object.  The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products.  When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.  See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
+    #
+    # @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: CustomFieldDefinition
+    # @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_fields(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/CustomFieldValues/query"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+end