lockstep_sdk 2022.4.32.0

data/lib/lockstep_sdk/clients/payments_client.rb

@@ -0,0 +1,138 @@
+#
+# 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 PaymentsClient
+
+    ##
+    # Initialize the PaymentsClient 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 specified by this unique identifier, optionally including nested data sets.
+    #
+    # 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 id [uuid] The unique Lockstep Platform ID number of this Payment; 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: Applications, Notes, Attachments, CustomFields
+    def retrieve_payment(id:, include_param:)
+        path = "/api/v1/Payments/#{id}"
+        params = {:include => include_param}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Updates an existing Payment 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 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 id [uuid] The unique Lockstep Platform ID number of the Payment to update; NOT the customer's ERP key
+    # @param body [object] A list of changes to apply to this Payment
+    def update_payment(id:, body:)
+        path = "/api/v1/Payments/#{id}"
+        @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
+    end
+
+    ##
+    # Deletes the Payment referred to by this unique identifier.
+    #
+    # 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 id [uuid] The unique Lockstep Platform ID number of the Payment to delete; NOT the customer's ERP key
+    def delete_payment(id:)
+        path = "/api/v1/Payments/#{id}"
+        @lockstepsdk.request(:delete, path, nil, nil)
+    end
+
+    ##
+    # Creates one or more Payments within this account and returns the records as created.
+    #
+    # 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 body [PaymentModel] The Payments to create
+    def create_payments(body:)
+        path = "/api/v1/Payments"
+        @lockstepsdk.request(:post, path, body, nil)
+    end
+
+    ##
+    # Queries Payments for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
+    #
+    # More information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.
+    #
+    # 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. 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_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"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Queries Payments for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.  This query endpoint provides extra data about the summary of payment information.
+    #
+    # 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 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 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_summary_view(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/Payments/views/summary"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Retrieves aggregated payment data from your account.
+    #
+    def retrieve_payment_detail_header()
+        path = "/api/v1/Payments/views/detail-header"
+        @lockstepsdk.request(:get, path, nil, nil)
+    end
+
+    ##
+    # Queries Payments 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 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 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_detail_view(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/Payments/views/detail"
+        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/provisioning_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 ProvisioningClient
+
+    ##
+    # Initialize the ProvisioningClient class with a lockstepsdk instance.
+    # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
+    def initialize(lockstepsdk)
+        @lockstepsdk = lockstepsdk
+    end
+
+
+    ##
+    # Creates a new User or updates an Invited user based on metadata provided by the User during the onboarding process
+    #
+    # @param body [ProvisioningModel] Represents a User and their related metadata
+    def provision_user_account(body:)
+        path = "/api/v1/Provisioning"
+        @lockstepsdk.request(:post, path, body, nil)
+    end
+
+    ##
+    # Updates user, company and group metadata for a User of status 'Onboarding' and finalizes a user's onboarding process by changing the user status to 'Active'
+    #
+    # @param body [ProvisioningFinalizeRequestModel] Represents a User and their related metadata
+    def finalize_user_account_provisioning(body:)
+        path = "/api/v1/Provisioning/finalize"
+        @lockstepsdk.request(:post, path, body, nil)
+    end
+
+    ##
+    #
+    #
+    # @param body [DeveloperAccountSubmitModel] 
+    def provision_free_developer_account(body:)
+        path = "/api/v1/Provisioning/free-account"
+        @lockstepsdk.request(:post, path, body, nil)
+    end
+end

data/lib/lockstep_sdk/clients/reports_client.rb

@@ -0,0 +1,114 @@
+#
+# 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 ReportsClient
+
+    ##
+    # Initialize the ReportsClient class with a lockstepsdk instance.
+    # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
+    def initialize(lockstepsdk)
+        @lockstepsdk = lockstepsdk
+    end
+
+
+    ##
+    # Retrieves a current Cash Flow report for this account.
+    #
+    # The Cash Flow report indicates the amount of payments retrieved and invoices billed within a given timeframe.  You can use this report to determine the overall balance of money coming into and out of your accounts receivable and accounts payable businesses.
+    #
+    # @param timeframe [int32] Number of days of data to include for the Cash Flow Report (default is 30 days from today)
+    def cash_flow(timeframe:)
+        path = "/api/v1/Reports/cashflow"
+        params = {:timeframe => timeframe}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Retrieves a current Daily Sales Outstanding (DSO) report for this account.
+    #
+    # Daily Sales Outstanding, or DSO, is a metric that indicates the average number of days that it takes for an invoice to be fully paid.  You can use this report to identify whether a company is improving on its ability to collect on invoices.
+    #
+    def daily_sales_outstanding()
+        path = "/api/v1/Reports/dailysalesoutstanding"
+        @lockstepsdk.request(:get, path, nil, nil)
+    end
+
+    ##
+    # Retrieves a current Risk Rate report for this account.
+    #
+    # Risk Rate is a metric that indicates the percentage of total AR balance left unpaid after 90 days.  You can use this report to identify the percentage of invoice value that is not being collected in a timely manner.
+    #
+    def risk_rates()
+        path = "/api/v1/Reports/riskrates"
+        @lockstepsdk.request(:get, path, nil, nil)
+    end
+
+    ##
+    # Retrieves AR header information up to the date specified.
+    #
+    # @param report_date [date] The date of the report.
+    # @param company_id [uuid] Include a company to get AR data for a specific company, leave as null to include all Companies.
+    def accounts_receivable_header(report_date:, company_id:)
+        path = "/api/v1/Reports/ar-header"
+        params = {:reportDate => report_date, :companyId => company_id}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # The Aging Report contains information about the total dollar value of invoices broken down by their age. Last default or specified bucket treated as a catch all bucket for values that fit in that bucket or beyond.
+    #
+    # You can specify viewing parameters for the aging report such as currency code and date bucket configuration. You can also view aging data for an entire account or a specific company.
+    #
+    # This information is recalculated when invoice data changes.  After each invoice data change occurs, Lockstep queues up a calculation based on the current invoice data at that time.  This information is calculated and persisted for each customer so that the report will be available quickly.
+    #
+    # To force a recalculation of aging data, specify the `recalculate` option.  Note that forcing a recalculation will slow your API response time.
+    #
+    # @param company_id [uuid] Company aging buckets are filtered by (all company aging returned if not company specified)
+    # @param recalculate [boolean] Force api to recalculate aging data, cached data may be returned when set to false
+    # @param currency_code [string] Currency aging buckets are converted to (all aging data returned without currency conversion if no currency is specified)
+    # @param currency_provider [string] Currency provider currency rates should be returned from to convert aging amounts to (default Lockstep currency provider used if no data provider specified)
+    # @param buckets [int32] Customized buckets used for aging calculations (default buckets [0,30,60,90,120,180] will be used if buckets not specified)
+    def invoice_aging_report(company_id:, recalculate:, currency_code:, currency_provider:, buckets:)
+        path = "/api/v1/Reports/aging"
+        params = {:CompanyId => company_id, :Recalculate => recalculate, :CurrencyCode => currency_code, :CurrencyProvider => currency_provider, :Buckets => buckets}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Retrieves AR Aging Header information report broken down by aging bucket.
+    #
+    # The AR Aging Header report contains aggregated information about the `TotalInvoicesPastDue`, `TotalCustomers`, and their respective `PercentageOfTotalAr` grouped by their aging `ReportBucket`.
+    #
+    def accounts_receivable_aging_header()
+        path = "/api/v1/Reports/ar-aging-header"
+        @lockstepsdk.request(:get, path, nil, nil)
+    end
+
+    ##
+    # Retrieves Attachment Header information for the requested companyId.
+    #
+    # The Attachment Header report contains aggregated information about the `TotalAttachments`, `TotalArchived`, and `TotalActive` attachment classifications.
+    #
+    # @param company_id [uuid] Include a specific company to get Attachment data for, leave as null to include all Companies.
+    def attachments_header_information(company_id:)
+        path = "/api/v1/Reports/attachments-header"
+        params = {:companyId => company_id}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+end

data/lib/lockstep_sdk/clients/status_client.rb

@@ -0,0 +1,53 @@
+#
+# 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 StatusClient
+
+    ##
+    # Initialize the StatusClient class with a lockstepsdk instance.
+    # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
+    def initialize(lockstepsdk)
+        @lockstepsdk = lockstepsdk
+    end
+
+
+    ##
+    # Verifies that your application can successfully call the Lockstep Platform API and returns a successful code regardless of your authentication status or permissions.
+    #
+    # The Ping API can be used to verify that your app is working correctly.  The Ping API will always return 200 OK.  If you call this API and you receive a code other than 200 OK, you should check your network connectivity.  A response code of anything other than 200 means that a routing issue or proxy issue may prevent your application from reaching the Lockstep API
+    #
+    def ping()
+        path = "/api/v1/Status"
+        @lockstepsdk.request(:get, path, nil, nil)
+    end
+
+    ##
+    # Generates an error code that your program may use to test handling of common types of error conditions.
+    #
+    # * If you specify `?err=500`, you will receive a 500 internal server error. * If you specify `?err=timeout`, the API will stall for 90 seconds and then return 200 OK.  Many network connections will drop after 60 seconds of no activity. * If you do not specify any of these errors, the API will return 200 OK.
+    #
+    # The Error Test API allows you to test whether your client program is capable of handling certain types of error codes.  Developers writing libraries may find it useful to create integration tests that verify that their code can correctly detect the difference between a validation error resulting in a 400 error code, a network timeout resulting in a broken network connection, and a server error resulting in a 500 error code.  You may use the Error Test API to verify that your code is able to identify and handle these cases correctly.
+    #
+    # @param err [string] The type of error test to execute. Supported error types: 500, timeout
+    def error_test(err:)
+        path = "/api/v1/Status/testing"
+        params = {:err => err}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+end

data/lib/lockstep_sdk/clients/sync_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 SyncClient
+
+    ##
+    # Initialize the SyncClient class with a lockstepsdk instance.
+    # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
+    def initialize(lockstepsdk)
+        @lockstepsdk = lockstepsdk
+    end
+
+
+    ##
+    # Requests a new Sync task from the Application specified in the request and returns a token that can be used to check the progress and status of the task.
+    #
+    # A Sync task represents an action performed by an Application for a particular account.  An Application can provide many different tasks as part of their capabilities.  Sync tasks are executed in the background and will continue running after they are created.  Use one of the creation APIs to request execution of a task. To check on the progress of the task, call GetSync or QuerySync.
+    #
+    # @param body [SyncSubmitModel] Information about the Sync to execute
+    def create_sync(body:)
+        path = "/api/v1/Sync"
+        @lockstepsdk.request(:post, path, body, nil)
+    end
+
+    ##
+    # Requests a new Sync task from a ZIP file you provide.  This ZIP file can contain one or more files with data from the customer's platform.  Individual files can be in the format CSV or JSONL (JSON with Lines).
+    #
+    # A Sync task represents an action performed by an Application for a particular account.  An Application can provide many different tasks as part of their capabilities.  Sync tasks are executed in the background and will continue running after they are created.  Use one of the creation APIs to request execution of a task. To check on the progress of the task, call GetSync or QuerySync.
+    #
+    def upload_sync_file()
+        path = "/api/v1/Sync/zip"
+        @lockstepsdk.request(:post, path, nil, nil)
+    end
+
+    ##
+    # Updates an existing Sync with the information supplied to this PATCH call.
+    #
+    # This API is restricted to internal service users and may not be called by customers or partners.
+    #
+    # 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.  For example, you can provide the field name "IsActive" and specify the new value "False"; this API will then change the value of IsActive to false.
+    #
+    # A Sync task represents an action performed by an Application for a particular account.  An Application can provide many different tasks as part of their capabilities.  Sync tasks are executed in the background and will continue running after they are created.  Use one of the creation APIs to request execution of a task. To check on the progress of the task, call GetSync or QuerySync.
+    #
+    # @param id [uuid] The unique ID number of the Sync to update
+    # @param body [object] A list of changes to apply to this Application
+    def update_sync(id:, body:)
+        path = "/api/v1/Sync/#{id}"
+        @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
+    end
+
+    ##
+    # Retrieves the status and information about a Sync operation by the requested ID.  Provides status and progress information about this task.
+    #
+    # A Sync task represents an action performed by an Application for a particular account.  An Application can provide many different tasks as part of their capabilities.  Sync tasks are executed in the background and will continue running after they are created.  Use one of the creation APIs to request execution of a task. To check on the progress of the task, call GetSync or QuerySync.
+    #
+    # @param id [uuid] The unique ID number of the Sync task to retrieve
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Details
+    def retrieve_sync(id:, include_param:)
+        path = "/api/v1/Sync/#{id}"
+        params = {:include => include_param}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Queries Sync tasks 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 Sync task represents an action performed by an Application for a particular account.  An Application can provide many different tasks as part of their capabilities.  Sync tasks are executed in the background and will continue running after they are created.  Use one of the creation APIs to request execution of a task. To check on the progress of the task, call GetSync or QuerySync.
+    #
+    # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Details
+    # @param order [string] The sort order for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_size [int32] The page size for results (default 200). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    def query_syncs(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/Sync/query"
+        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/user_accounts_client.rb

@@ -0,0 +1,127 @@
+#
+# 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 UserAccountsClient
+
+    ##
+    # Initialize the UserAccountsClient class with a lockstepsdk instance.
+    # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
+    def initialize(lockstepsdk)
+        @lockstepsdk = lockstepsdk
+    end
+
+
+    ##
+    # Retrieves the User with this identifier.
+    #
+    # A User represents a person who has the ability to authenticate against the Lockstep Platform and use services such as Lockstep Inbox.  A User is uniquely identified by an Azure identity, and each user must have an email address defined within their account.  All Users must validate their email to make use of Lockstep platform services.  Users may have different privileges and access control rights within the Lockstep Platform.
+    #
+    # @param id [uuid] The unique ID number of the User to retrieve
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Notes, Attachments, CustomFields, AccountingRole
+    def retrieve_user(id:, include_param:)
+        path = "/api/v1/UserAccounts/#{id}"
+        params = {:include => include_param}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Updates a User 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 User represents a person who has the ability to authenticate against the Lockstep Platform and use services such as Lockstep Inbox.  A User is uniquely identified by an Azure identity, and each user must have an email address defined within their account.  All Users must validate their email to make use of Lockstep platform services.  Users may have different privileges and access control rights within the Lockstep Platform.
+    #
+    # @param id [uuid] The unique ID number of the User to retrieve
+    # @param body [object] A list of changes to apply to this User
+    def update_user(id:, body:)
+        path = "/api/v1/UserAccounts/#{id}"
+        @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
+    end
+
+    ##
+    # Disable the user referred to by this unique identifier.
+    #
+    # A User represents a person who has the ability to authenticate against the Lockstep Platform and use services such as Lockstep Inbox.  A User is uniquely identified by an Azure identity, and each user must have an email address defined within their account.  All Users must validate their email to make use of Lockstep platform services.  Users may have different privileges and access control rights within the Lockstep Platform.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of this User
+    def disable_user(id:)
+        path = "/api/v1/UserAccounts/#{id}"
+        @lockstepsdk.request(:delete, path, nil, nil)
+    end
+
+    ##
+    # Reenable the user referred to by this unique identifier.
+    #
+    # A User represents a person who has the ability to authenticate against the Lockstep Platform and use services such as Lockstep Inbox.  A User is uniquely identified by an Azure identity, and each user must have an email address defined within their account.  All Users must validate their email to make use of Lockstep platform services.  Users may have different privileges and access control rights within the Lockstep Platform.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of this User
+    def reenable_user(id:)
+        path = "/api/v1/UserAccounts/reenable"
+        params = {:id => id}
+        @lockstepsdk.request(:post, path, nil, params)
+    end
+
+    ##
+    # Invite a user with the specified email to join your accounting group. The user will receive an email to set up their account.
+    #
+    # A User represents a person who has the ability to authenticate against the Lockstep Platform and use services such as Lockstep Inbox.  A User is uniquely identified by an Azure identity, and each user must have an email address defined within their account.  All Users must validate their email to make use of Lockstep platform services.  Users may have different privileges and access control rights within the Lockstep Platform.
+    #
+    # @param body [InviteSubmitModel] The user to invite
+    def invite_user(body:)
+        path = "/api/v1/UserAccounts/invite"
+        @lockstepsdk.request(:post, path, body, nil)
+    end
+
+    ##
+    # Retrieves invite information for the specified invite token.
+    #
+    # A User represents a person who has the ability to authenticate against the Lockstep Platform and use services such as Lockstep Inbox.  A User is uniquely identified by an Azure identity, and each user must have an email address defined within their account.  All Users must validate their email to make use of Lockstep platform services.  Users may have different privileges and access control rights within the Lockstep Platform.
+    #
+    # @param code [uuid] The code of the invite
+    def retrieve_invite_data(code:)
+        path = "/api/v1/UserAccounts/invite"
+        params = {:code => code}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Transfer the ownership of a group to another user. This API must be called by the current owner of the group.
+    #
+    # A User represents a person who has the ability to authenticate against the Lockstep Platform and use services such as Lockstep Inbox.  A User is uniquely identified by an Azure identity, and each user must have an email address defined within their account.  All Users must validate their email to make use of Lockstep platform services.  Users may have different privileges and access control rights within the Lockstep Platform.
+    #
+    # @param body [TransferOwnerSubmitModel] 
+    def transfer_owner(body:)
+        path = "/api/v1/UserAccounts/transfer-owner"
+        @lockstepsdk.request(:post, path, body, nil)
+    end
+
+    ##
+    # Queries Users for this account using the specified filtering, sorting, nested fetch, and pagination rules requested. A User represents a person who has the ability to authenticate against the Lockstep Platform and use services such as Lockstep Inbox.  A User is uniquely identified by an Azure identity, and each user must have an email address defined within their account.  All Users must validate their email to make use of Lockstep platform services.  Users may have different privileges and access control rights within the Lockstep Platform.
+    #
+    # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Notes, Attachments, CustomFields, AccountingRole
+    # @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_size [int32] The page size for results (default 200). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    def query_users(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/UserAccounts/query"
+        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/user_roles_client.rb

@@ -0,0 +1,54 @@
+#
+# 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 UserRolesClient
+
+    ##
+    # Initialize the UserRolesClient class with a lockstepsdk instance.
+    # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
+    def initialize(lockstepsdk)
+        @lockstepsdk = lockstepsdk
+    end
+
+
+    ##
+    # Retrieves the User Role with this identifier.
+    #
+    # @param id [uuid] The unique ID number of the User Role 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_user_role(id:, include_param:)
+        path = "/api/v1/UserRoles/#{id}"
+        params = {:include => include_param}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Queries User Roles 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. 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_user_roles(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/UserRoles/query"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+end