lockstep_sdk 2022.15.31.1 → 2022.26.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9cd4e886e928a5470f7bbb9957ef0531f95a27a5ed77d0ee7462ea9b9640342
-  data.tar.gz: 8678020ae8c921e9f52e45a8c798c21690978e13ee1ae4e821544d64716bbe97
+  metadata.gz: 8dd5a349eb67e94638b549c030c9f0d14b4949a89678e7ce25569d021002af6f
+  data.tar.gz: 43763005c70106c342563f4de7e628974196db5c437d61b75954041ccb8fe23b
 SHA512:
-  metadata.gz: 83dfd6352c9b93a4579cda46cb5e6c636af35a8a6eef46f124d99cfebbb66b97436af92cac57783905beef89f011aa79a0439fa01fbde06c2569d226bb053dbc
-  data.tar.gz: 5fd4b98bcf0df121b3912893cb597e248e0eee68ca66d2fbf054f3a50e44872936720c295a2874964323c976ce280e5fab68645a0c746d4d848f13dafd3b1711
+  metadata.gz: 00a438f056a6adf07587662642cd9c4180e4e2c7190f995a5b1aa378712ceda3c11fde8b1e129e32e09a68bc233d0aa8c95d61d53bc606e6dde6d6aaffc5ec6d
+  data.tar.gz: 30f50f191c364290777a83ff0416ffeb19b3c096dd3bd1d3cbe3ac03fab01d98dc04368c125959c2b97106f2cde3d097db8c06132806af7e95bebc7b18955d8c

data/lib/lockstep_sdk/clients/app_enrollments_client.rb

@@ -81,6 +81,16 @@ class AppEnrollmentsClient
         @connection.request(:post, path, body, nil)
     end
 
+    ##
+    # Updates the OAuth settings associated with this App Enrollment
+    #
+    # @param id [uuid] 
+    # @param body [string] 
+    def reconnect_app_enrollment_oauth(id:, body:)
+        path = "/api/v1/AppEnrollments/#{id}/reconnect"
+        @connection.request(:patch, path, body, nil)
+    end
+
     ##
     # Queries App Enrollments for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
     #

data/lib/lockstep_sdk/clients/companies_client.rb

@@ -122,15 +122,35 @@ class CompaniesClient
     end
 
     ##
-    # Retrieves the Customer Details specified by this unique identifier, optionally including nested data sets.
+    # Queries Vendor Summaries for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
     #
-    # 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.
+    # 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 Vendor 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 Vendor Summary 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}"
+    # @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_vendor_summary(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/Companies/views/vendor-summary"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @connection.request(:get, path, nil, params)
+    end
+
+    ##
+    # Retrieves the Company Details specified by this unique identifier, optionally including nested data sets.
+    #
+    # The Company 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 Company 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 company's ERP key
+    def retrieve_company_detail(id:)
+        path = "/api/v1/Companies/views/details/#{id}"
         @connection.request(:get, path, nil, nil)
     end
 end

data/lib/lockstep_sdk/clients/financial_account_client.rb

@@ -56,7 +56,7 @@ class FinancialAccountClient
     # Deletes the Financial Account referred to by this unique identifier.
     #
     # @param id [uuid] The unique Lockstep Platform ID number of the Financial Account to disable; NOT the customer's ERP key
-    def deletes_financial_account(id:)
+    def delete_financial_account(id:)
         path = "/api/v1/FinancialAccount/#{id}"
         @connection.request(:delete, path, nil, nil)
     end

data/lib/lockstep_sdk/clients/group_accounts_client.rb

@@ -0,0 +1,46 @@
+#
+# Lockstep Platform SDK 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     Lockstep Network <support@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'awrence'
+
+class GroupAccountsClient
+
+    ##
+    # Initialize the GroupAccountsClient class with an API client instance.
+    # @param connection [LockstepApi] The API client object for this connection
+    def initialize(connection)
+        @connection = connection
+    end
+
+
+    ##
+    # Retrieves group account data for the current user.
+    #
+    def retrieve_group_account_data()
+        path = "/api/v1/GroupAccounts/me"
+        @connection.request(:get, path, nil, nil)
+    end
+
+    ##
+    # Updates a group account 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.
+    #
+    # @param id [uuid] The unique ID number of the Group Account to retrieve
+    # @param body [object] A list of changes to apply to this Group Account
+    def update_group_account(id:, body:)
+        path = "/api/v1/GroupAccounts/#{id}"
+        @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
+    end
+end

data/lib/lockstep_sdk/clients/payment_applications_client.rb

@@ -30,7 +30,7 @@ class PaymentApplicationsClient
     # A Payment Application is created by a business who receives a Payment from a customer.  A customer may make a single Payment to match an Invoice exactly, a partial Payment for an Invoice, or a single Payment may be made for multiple smaller Invoices.  The Payment Application contains information about which Invoices are connected to which Payments and for which amounts.
     #
     # @param id [uuid] The unique Lockstep Platform ID number of this Payment Application; NOT the customer's ERP key
-    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Invoice
+    # @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_application(id:, include_param:)
         path = "/api/v1/PaymentApplications/#{id}"
         params = {:include => include_param}

data/lib/lockstep_sdk/clients/provisioning_client.rb

@@ -24,24 +24,6 @@ class ProvisioningClient
     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"
-        @connection.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"
-        @connection.request(:post, path, body, nil)
-    end
-
     ##
     # Creates a new account for a developer, sending an email with information on how to access the API.
     # @param body [DeveloperAccountSubmitModel] 

data/lib/lockstep_sdk/clients/reports_client.rb

@@ -36,6 +36,18 @@ class ReportsClient
         @connection.request(:get, path, nil, params)
     end
 
+    ##
+    # Retrieves a current Payables Summary report for this account.
+    #
+    # The Payables Summary report indicates the amount of payments sent and bills received 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 Payables Summary Report (default is 30 days from today)
+    def payables_summary_report(timeframe:)
+        path = "/api/v1/Reports/payables-summary"
+        params = {:timeframe => timeframe}
+        @connection.request(:get, path, nil, params)
+    end
+
     ##
     # Retrieves a current Daily Sales Outstanding (DSO) report for this account.
     #
@@ -46,6 +58,48 @@ class ReportsClient
         @connection.request(:get, path, nil, nil)
     end
 
+    ##
+    # Retrieves a current Days Payable Outstanding (DPO) report for this account.
+    #
+    # Days payable outstanding (DPO) is a financial ratio that indicates the average time (in days) that a company takes to pay its bills to its trade creditors, which may include suppliers, vendors, or financiers.
+    #
+    def days_payable_outstanding()
+        path = "/api/v1/Reports/daily-payable-outstanding"
+        @connection.request(:get, path, nil, nil)
+    end
+
+    ##
+    # Retrieves payable amount due for 4 time buckets (Today, 7 Days from Today, 14 Days from Today, and 30 Days from Today).
+    #
+    def payables_coming_due()
+        path = "/api/v1/Reports/payables-coming-due"
+        @connection.request(:get, path, nil, nil)
+    end
+
+    ##
+    # Payables coming due represents the amount of cash required to pay vendor bills based on the due dates of the bills. Each bucket represents total amount due within the time period based on open Payables as of today.
+    #
+    # @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 payables_coming_due_summary(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/Reports/payables-coming-due-summary"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @connection.request(:get, path, nil, params)
+    end
+
+    ##
+    # Retrieves total number of vendors, bills, the total amount outstanding, for a group.
+    #
+    # @param report_date [date-time] The date the outstanding values are calculated on. Should be either the current day, 7 days after the current day, 14 days after the current day, or 30 days after the current day.
+    def payables_coming_due_header(report_date:)
+        path = "/api/v1/Reports/payables-coming-due-header"
+        params = {:reportDate => report_date}
+        @connection.request(:get, path, nil, params)
+    end
+
     ##
     # Retrieves a current Risk Rate report for this account.
     #
@@ -67,6 +121,17 @@ class ReportsClient
         @connection.request(:get, path, nil, params)
     end
 
+    ##
+    # Retrieves AP 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 AP data for a specific company, leave as null to include all Companies.
+    def accounts_payable_header(report_date:, company_id:)
+        path = "/api/v1/Reports/ap-header"
+        params = {:reportDate => report_date, :companyId => company_id}
+        @connection.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.
     #
@@ -81,9 +146,10 @@ class ReportsClient
     # @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:)
+    # @param ap_report [boolean] A boolean to turn on AP Aging reports
+    def invoice_aging_report(company_id:, recalculate:, currency_code:, currency_provider:, buckets:, ap_report:)
         path = "/api/v1/Reports/aging"
-        params = {:CompanyId => company_id, :Recalculate => recalculate, :CurrencyCode => currency_code, :CurrencyProvider => currency_provider, :Buckets => buckets}
+        params = {:CompanyId => company_id, :Recalculate => recalculate, :CurrencyCode => currency_code, :CurrencyProvider => currency_provider, :Buckets => buckets, :ApReport => ap_report}
         @connection.request(:get, path, nil, params)
     end
 
@@ -97,6 +163,16 @@ class ReportsClient
         @connection.request(:get, path, nil, nil)
     end
 
+    ##
+    # Retrieves AP Aging Header information report broken down by aging bucket.
+    #
+    # The AP Aging Header report contains aggregated information about the `TotalBillsPastDue`, `TotalVendors`, and their respective `PercentageOfTotalAp` grouped by their aging `ReportBucket`.
+    #
+    def accounts_payable_aging_header()
+        path = "/api/v1/Reports/ap-aging-header"
+        @connection.request(:get, path, nil, nil)
+    end
+
     ##
     # Retrieves Attachment Header information for the requested companyId.
     #
@@ -114,9 +190,10 @@ class ReportsClient
     #
     # @param start_date [date-time] The start date of the report
     # @param end_date [date-time] The end date of the report
-    def trial_balance_report(start_date:, end_date:)
+    # @param app_enrollment_id [uuid] The app enrollment id of the app enrollment whose data will be used.
+    def trial_balance_report(start_date:, end_date:, app_enrollment_id:)
         path = "/api/v1/Reports/trial-balance"
-        params = {:startDate => start_date, :endDate => end_date}
+        params = {:startDate => start_date, :endDate => end_date, :appEnrollmentId => app_enrollment_id}
         @connection.request(:get, path, nil, params)
     end
 
@@ -125,14 +202,15 @@ class ReportsClient
     #
     # @param start_date [date-time] The start date of the report
     # @param end_date [date-time] The end date of the report
+    # @param app_enrollment_id [uuid] The app enrollment id of the app enrollment whose data will be used.
     # @param column_option [string] The desired column splitting of the report data. An empty string or anything unrecognized will result in only totals being displayed. Options are as follows: By Period - a column for every month/fiscal period within the reporting dates Quarterly - a column for every quarter within the reporting dates Annually - a column for every year within the reporting dates
     # @param display_depth [ReportDepth] The desired row splitting of the report data. For Income Statements, the minimum report depth is 1. Options are as follows: 1 - combine all accounts by their category 2 - combine all accounts by their subcategory 3 - display all accounts
     # @param comparison_period [string] Add a column for historical data with the following options and use showCurrencyDifference and/or show percentageDifference to display a comparison of that historical data to the report period. Options are as follows (note for YTD the data will be compared as a percentage of YTD and showCurrencyDifference and showPercentageDifference should not be used): "PP" - previous period (will show the previous quarter or year if Quarterly or Annually is chosen for columnOption) "PY" - previous year (the same date range as the report, but for the year prior) "YTD" - year to date (the current financial year to the current period)
     # @param show_currency_difference [boolean] A boolean to turn on a currency based difference between the reporting period and the comparison period.
     # @param show_percentage_difference [boolean] A boolean to turn on a percent based difference between the reporting period and the comparison period.
-    def income_statement_report(start_date:, end_date:, column_option:, display_depth:, comparison_period:, show_currency_difference:, show_percentage_difference:)
+    def income_statement_report(start_date:, end_date:, app_enrollment_id:, column_option:, display_depth:, comparison_period:, show_currency_difference:, show_percentage_difference:)
         path = "/api/v1/Reports/income-statement"
-        params = {:startDate => start_date, :endDate => end_date, :columnOption => column_option, :displayDepth => display_depth, :comparisonPeriod => comparison_period, :showCurrencyDifference => show_currency_difference, :showPercentageDifference => show_percentage_difference}
+        params = {:startDate => start_date, :endDate => end_date, :appEnrollmentId => app_enrollment_id, :columnOption => column_option, :displayDepth => display_depth, :comparisonPeriod => comparison_period, :showCurrencyDifference => show_currency_difference, :showPercentageDifference => show_percentage_difference}
         @connection.request(:get, path, nil, params)
     end
 
@@ -141,14 +219,60 @@ class ReportsClient
     #
     # @param start_date [date-time] The start date of the report
     # @param end_date [date-time] The end date of the report
+    # @param app_enrollment_id [uuid] The app enrollment id of the app enrollment whose data will be used.
     # @param column_option [string] The desired column splitting of the report data. An empty string or anything unrecognized will result in only totals being displayed. Options are as follows: By Period - a column for every month/fiscal period within the reporting dates Quarterly - a column for every quarter within the reporting dates Annually - a column for every year within the reporting dates
     # @param display_depth [ReportDepth] The desired row splitting of the report data. For Balance Sheets, the minimum report depth is 1. Options are as follows: 1 - combine all accounts by their category 2 - combine all accounts by their subcategory 3 - display all accounts
     # @param comparison_period [string] Add a column for historical data with the following options and use showCurrencyDifference and/or show percentageDifference to display a comparison of that historical data to the report period. "PP" - previous period (will show the previous quarter or year if Quarterly or Annually is chosen for columnOption) "PY" - previous year (the same date range as the report, but for the year prior)
     # @param show_currency_difference [boolean] A boolean to turn on a currency based difference between the reporting period and the comparison period.
     # @param show_percentage_difference [boolean] A boolean to turn on a percent based difference between the reporting period and the comparison period.
-    def balance_sheet_report(start_date:, end_date:, column_option:, display_depth:, comparison_period:, show_currency_difference:, show_percentage_difference:)
+    def balance_sheet_report(start_date:, end_date:, app_enrollment_id:, column_option:, display_depth:, comparison_period:, show_currency_difference:, show_percentage_difference:)
         path = "/api/v1/Reports/balance-sheet"
-        params = {:startDate => start_date, :endDate => end_date, :columnOption => column_option, :displayDepth => display_depth, :comparisonPeriod => comparison_period, :showCurrencyDifference => show_currency_difference, :showPercentageDifference => show_percentage_difference}
+        params = {:startDate => start_date, :endDate => end_date, :appEnrollmentId => app_enrollment_id, :columnOption => column_option, :displayDepth => display_depth, :comparisonPeriod => comparison_period, :showCurrencyDifference => show_currency_difference, :showPercentageDifference => show_percentage_difference}
+        @connection.request(:get, path, nil, params)
+    end
+
+    ##
+    # Generates a cash flow statement for the given time range.
+    #
+    # @param start_date [date-time] The start date of the report
+    # @param end_date [date-time] The end date of the report
+    # @param app_enrollment_id [uuid] The app enrollment id of the app enrollment whose data will be used.
+    # @param column_option [string] The desired column splitting of the report data. An empty string or anything unrecognized will result in only totals being displayed. Options are as follows: By Period - a column for every month/fiscal period within the reporting dates Quarterly - a column for every quarter within the reporting dates Annually - a column for every year within the reporting dates
+    # @param display_depth [ReportDepth] The desired row splitting of the report data. Options are as follows: 0 - combine all accounts by their classification 1 - combine all accounts by their category 2 - combine all accounts by their subcategory 3 - display all accounts
+    def cash_flow_statement_report(start_date:, end_date:, app_enrollment_id:, column_option:, display_depth:)
+        path = "/api/v1/Reports/cash-flow-statement"
+        params = {:startDate => start_date, :endDate => end_date, :appEnrollmentId => app_enrollment_id, :columnOption => column_option, :displayDepth => display_depth}
+        @connection.request(:get, path, nil, params)
+    end
+
+    ##
+    # Retrieves a summary for each vendor that includes a count of their outstanding bills, the total amount outstanding, and their daily payable outstanding value.
+    #
+    # Days payable outstanding (DPO) is a financial ratio that indicates the average time (in days) that a company takes to pay its bills to its trade creditors, which may include suppliers, vendors, or financiers.
+    #
+    # 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 report_date [date-time] The date the outstanding values are calculated on. Should be either the current day or the end of a previous quarter.
+    # @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 days_payable_outstanding_summary(report_date:, filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/Reports/daily-payable-outstanding-summary"
+        params = {:reportDate => report_date, :filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @connection.request(:get, path, nil, params)
+    end
+
+    ##
+    # Retrieves total number of vendors, bills, the total amount outstanding, and the daily payable outstanding value for a group.
+    #
+    # Days payable outstanding (DPO) is a financial ratio that indicates the average time (in days) that a company takes to pay its bills to its trade creditors, which may include suppliers, vendors, or financiers.
+    #
+    # @param report_date [date-time] The date the outstanding values are calculated on. Should be either the current day or the end of a previous quarter.
+    def days_payable_outstanding_summary_total(report_date:)
+        path = "/api/v1/Reports/daily-payable-outstanding-summary-total"
+        params = {:reportDate => report_date}
         @connection.request(:get, path, nil, params)
     end
 end

data/lib/lockstep_sdk/clients/user_accounts_client.rb

@@ -121,4 +121,16 @@ class UserAccountsClient
         params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
         @connection.request(:get, path, nil, params)
     end
+
+    ##
+    # Change the active GroupKey of the calling user.
+    #
+    # 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 group_key [uuid] 
+    def change_user_group(group_key:)
+        path = "/api/v1/UserAccounts/change-group"
+        params = {:groupKey => group_key}
+        @connection.request(:post, path, nil, params)
+    end
 end

data/lib/lockstep_sdk/clients/webhook_rules_client.rb

@@ -0,0 +1,81 @@
+#
+# Lockstep Platform SDK 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     Lockstep Network <support@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'awrence'
+
+class WebhookRulesClient
+
+    ##
+    # Initialize the WebhookRulesClient class with an API client instance.
+    # @param connection [LockstepApi] The API client object for this connection
+    def initialize(connection)
+        @connection = connection
+    end
+
+
+    ##
+    # Retrieves the Webhook Rule specified by this unique identifier.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of this Webhook Rule
+    def retrieve_webhook_rule(id:)
+        path = "/api/v1/WebhookRules/#{id}"
+        @connection.request(:get, path, nil, nil)
+    end
+
+    ##
+    # Updates a webhook rule 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.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of the Webhook Rule to update.
+    # @param body [object] A list of changes to apply to this Webhook Rule
+    def update_webhook_rule(id:, body:)
+        path = "/api/v1/WebhookRules/#{id}"
+        @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
+    end
+
+    ##
+    # Deletes the Webhook Rule referred to by this unique identifier.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of the Webhook Rule to delete.
+    def delete_webhook_rule(id:)
+        path = "/api/v1/WebhookRules/#{id}"
+        @connection.request(:delete, path, nil, nil)
+    end
+
+    ##
+    # Creates one or more webhook rules from a given model.
+    #
+    # @param body [WebhookRuleModel] The Webhook Rules to create
+    def create_webhook_rules(body:)
+        path = "/api/v1/WebhookRules"
+        @connection.request(:post, path, body, nil)
+    end
+
+    ##
+    # Queries Webhook Rules for this account using the specified filtering, sorting, 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_webhook_rules(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/WebhookRules/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/webhooks_client.rb

@@ -78,12 +78,13 @@ class WebhooksClient
     # More information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.
     #
     # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collection: WebhookRules
     # @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     # @param page_size [int32] The page size for results (default 200). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     # @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
-    def query_webhooks(filter:, order:, page_size:, page_number:)
+    def query_webhooks(filter:, include_param:, order:, page_size:, page_number:)
         path = "/api/v1/Webhooks/query"
-        params = {:filter => filter, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
         @connection.request(:get, path, nil, params)
     end
 
@@ -100,4 +101,14 @@ class WebhooksClient
         params = {:filter => filter, :select => select, :pageSize => page_size, :pageNumber => page_number}
         @connection.request(:get, path, nil, params)
     end
+
+    ##
+    #
+    #
+    # @param webhook_id [uuid] The unique Lockstep Platform ID number of this Webhook
+    # @param webhook_history_id [uuid] The unique Lockstep Platform ID number of the Webhook History to be retried. Note: the webhook history supplied must have a isSuccessful status of false to be retried.
+    def retry_failed_webhook_history(webhook_id:, webhook_history_id:)
+        path = "/api/v1/Webhooks/#{webhookId}/history/#{webhookHistoryId}/retry"
+        @connection.request(:get, path, nil, nil)
+    end
 end

data/lib/lockstep_sdk/lockstep_api.rb

@@ -9,7 +9,7 @@
 # @author     Lockstep Network <support@lockstep.io>
 #             Manish Narayan B S <manish.n@lockstep.io>, Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
 # @copyright  2021-2022 Lockstep, Inc.
-# @version    2022.15.31
+# @version    2022.26.12
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -21,7 +21,7 @@ require 'socket'
 project_root = File.dirname(File.absolute_path(__FILE__))
 Dir.glob(project_root + '/clients/*') {|file| require file}
 
-module Lockstep_sdk
+module lockstep_sdk
     class LockstepApi
     
         ##
@@ -100,6 +100,10 @@ module Lockstep_sdk
         # @return [FinancialYearSettingsClient] Client object for FinancialYearSettings endpoints
         attr_accessor :financial_year_settings
 
+        ##
+        # @return [GroupAccountsClient] Client object for GroupAccounts endpoints
+        attr_accessor :group_accounts
+
         ##
         # @return [InvoiceHistoryClient] Client object for InvoiceHistory endpoints
         attr_accessor :invoice_history
@@ -148,6 +152,10 @@ module Lockstep_sdk
         # @return [UserRolesClient] Client object for UserRoles endpoints
         attr_accessor :user_roles
 
+        ##
+        # @return [WebhookRulesClient] Client object for WebhookRules endpoints
+        attr_accessor :webhook_rules
+
         ##
         # @return [WebhooksClient] Client object for Webhooks endpoints
         attr_accessor :webhooks
@@ -158,7 +166,7 @@ module Lockstep_sdk
         #
         # @param env [string] Either "sbx", "prd", or the URI of the server, ending in a slash (/)
         def initialize(env)
-            @version = "2022.15.31.0"
+            @version = "2022.26.12.0"
             @env = case env
                 when "sbx"
                     "https://api.sbx.lockstep.io/"
@@ -186,6 +194,7 @@ module Lockstep_sdk
             @financial_account = FinancialAccountClient.new(self)
             @financial_account_balance_history = FinancialAccountBalanceHistoryClient.new(self)
             @financial_year_settings = FinancialYearSettingsClient.new(self)
+            @group_accounts = GroupAccountsClient.new(self)
             @invoice_history = InvoiceHistoryClient.new(self)
             @invoices = InvoicesClient.new(self)
             @leads = LeadsClient.new(self)
@@ -198,6 +207,7 @@ module Lockstep_sdk
             @sync = SyncClient.new(self)
             @user_accounts = UserAccountsClient.new(self)
             @user_roles = UserRolesClient.new(self)
+            @webhook_rules = WebhookRulesClient.new(self)
             @webhooks = WebhooksClient.new(self)
         end
 
@@ -262,7 +272,7 @@ module Lockstep_sdk
             request["Accept"] = 'application/json'
             request["Content-Type"] = 'application/*+json'
             request["SdkType"] = 'Ruby'
-            request["SdkVersion"] = '2022.15.31.0'
+            request["SdkVersion"] = '2022.26.12.0'
             request["MachineName"] = Socket.gethostname
             request.body = body
 

data/lib/lockstep_sdk/models/action_result_model.rb

@@ -0,0 +1,52 @@
+#
+# Lockstep Platform SDK 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     Lockstep Network <support@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # Represents the result of an action.
+    #
+    # In the Lockstep API, an Action is returned when an API call does not produce any data
+    # but does produce messages that can be useful in understanding what work was performed.
+    # You may use the messages text to display user visible error messages or the results of
+    # various operations.
+    class ActionResultModel
+
+        ##
+        # Initialize the ActionResultModel using the provided prototype
+        def initialize(params = {})
+            @messages = params.dig(:messages)
+        end
+
+        ##
+        # @return [String] If the API call produced messages, this element will contain a list of user-visible text strings that contain information about what work occurred in the API.
+        attr_accessor :messages
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'messages' => @messages,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end