lockstep_sdk 2022.37.24.0 → 2023.1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/lockstep_sdk/clients/api_keys_client.rb +3 -3
- data/lib/lockstep_sdk/clients/app_enrollments_client.rb +5 -5
- data/lib/lockstep_sdk/clients/applications_client.rb +3 -3
- data/lib/lockstep_sdk/clients/attachments_client.rb +3 -3
- data/lib/lockstep_sdk/clients/code_definitions_client.rb +3 -3
- data/lib/lockstep_sdk/clients/companies_client.rb +40 -10
- data/lib/lockstep_sdk/clients/contacts_client.rb +17 -6
- data/lib/lockstep_sdk/clients/{credit_memo_applied_client.rb → credit_memos_applied_client.rb} +30 -30
- data/lib/lockstep_sdk/clients/currencies_client.rb +2 -2
- data/lib/lockstep_sdk/clients/custom_field_definitions_client.rb +3 -3
- data/lib/lockstep_sdk/clients/custom_field_values_client.rb +3 -3
- data/lib/lockstep_sdk/clients/definitions_client.rb +6 -6
- data/lib/lockstep_sdk/clients/feature_flags_client.rb +35 -0
- data/lib/lockstep_sdk/clients/financial_account_balance_history_client.rb +3 -3
- data/lib/lockstep_sdk/clients/financial_account_client.rb +3 -3
- data/lib/lockstep_sdk/clients/financial_year_settings_client.rb +3 -3
- data/lib/lockstep_sdk/clients/group_accounts_client.rb +2 -2
- data/lib/lockstep_sdk/clients/invoice_addresses_client.rb +91 -0
- data/lib/lockstep_sdk/clients/invoice_history_client.rb +3 -3
- data/lib/lockstep_sdk/clients/invoice_lines_client.rb +88 -0
- data/lib/lockstep_sdk/clients/invoices_client.rb +17 -6
- data/lib/lockstep_sdk/clients/leads_client.rb +2 -2
- data/lib/lockstep_sdk/clients/magic_links_client.rb +62 -0
- data/lib/lockstep_sdk/clients/notes_client.rb +3 -3
- data/lib/lockstep_sdk/clients/payments_applied_client.rb +93 -0
- data/lib/lockstep_sdk/clients/payments_client.rb +6 -6
- data/lib/lockstep_sdk/clients/profiles_accounting_client.rb +104 -0
- data/lib/lockstep_sdk/clients/profiles_accounting_contacts_client.rb +91 -0
- data/lib/lockstep_sdk/clients/{profiles_client.rb → profiles_companies_client.rb} +7 -7
- data/lib/lockstep_sdk/clients/provisioning_client.rb +2 -2
- data/lib/lockstep_sdk/clients/reports_client.rb +4 -4
- data/lib/lockstep_sdk/clients/status_client.rb +2 -2
- data/lib/lockstep_sdk/clients/sync_client.rb +3 -3
- data/lib/lockstep_sdk/clients/transactions_client.rb +54 -0
- data/lib/lockstep_sdk/clients/transcriptions_client.rb +91 -0
- data/lib/lockstep_sdk/clients/user_accounts_client.rb +13 -15
- data/lib/lockstep_sdk/clients/user_roles_client.rb +3 -3
- data/lib/lockstep_sdk/clients/webhook_rules_client.rb +3 -3
- data/lib/lockstep_sdk/clients/webhooks_client.rb +4 -4
- data/lib/lockstep_sdk/lockstep_api.rb +54 -24
- data/lib/lockstep_sdk/models/accounting_profile_contact_model.rb +90 -0
- data/lib/lockstep_sdk/models/accounting_profile_model.rb +183 -0
- data/lib/lockstep_sdk/models/action_result_model.rb +2 -2
- data/lib/lockstep_sdk/models/aging_model.rb +2 -2
- data/lib/lockstep_sdk/models/ap_aging_header_info_model.rb +2 -2
- data/lib/lockstep_sdk/models/ap_header_info_model.rb +8 -2
- data/lib/lockstep_sdk/models/api_key_model.rb +2 -2
- data/lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb +2 -2
- data/lib/lockstep_sdk/models/app_enrollment_model.rb +8 -2
- data/lib/lockstep_sdk/models/{app_enrollment_reconnect_request.rb → app_enrollment_reconnect_info.rb} +10 -4
- data/lib/lockstep_sdk/models/application_model.rb +2 -2
- data/lib/lockstep_sdk/models/ar_aging_header_info_model.rb +2 -2
- data/lib/lockstep_sdk/models/ar_header_info_model.rb +8 -2
- data/lib/lockstep_sdk/models/at_risk_invoice_summary_model.rb +26 -2
- data/lib/lockstep_sdk/models/attachment_header_info_model.rb +2 -2
- data/lib/lockstep_sdk/models/attachment_model.rb +2 -2
- data/lib/lockstep_sdk/models/batch_sync_model.rb +2 -2
- data/lib/lockstep_sdk/models/bulk_currency_conversion_model.rb +2 -2
- data/lib/lockstep_sdk/models/bulk_delete_request_model.rb +47 -0
- data/lib/lockstep_sdk/models/cashflow_report_model.rb +2 -2
- data/lib/lockstep_sdk/models/code_definition_model.rb +2 -2
- data/lib/lockstep_sdk/models/company_details_model.rb +2 -2
- data/lib/lockstep_sdk/models/company_details_payment_model.rb +2 -2
- data/lib/lockstep_sdk/models/company_model.rb +8 -8
- data/lib/lockstep_sdk/models/company_sync_model.rb +2 -8
- data/lib/lockstep_sdk/models/connector_info_model.rb +2 -2
- data/lib/lockstep_sdk/models/contact_model.rb +2 -2
- data/lib/lockstep_sdk/models/contact_sync_model.rb +2 -2
- data/lib/lockstep_sdk/models/country_model.rb +2 -2
- data/lib/lockstep_sdk/models/credit_memo_applied_model.rb +2 -2
- data/lib/lockstep_sdk/models/credit_memo_applied_sync_model.rb +2 -2
- data/lib/lockstep_sdk/models/credit_memo_invoice_model.rb +32 -2
- data/lib/lockstep_sdk/models/currency_model.rb +2 -2
- data/lib/lockstep_sdk/models/currency_rate_model.rb +2 -2
- data/lib/lockstep_sdk/models/custom_field_definition_model.rb +2 -2
- data/lib/lockstep_sdk/models/custom_field_sync_model.rb +2 -2
- data/lib/lockstep_sdk/models/custom_field_value_model.rb +20 -2
- data/lib/lockstep_sdk/models/customer_summary_model.rb +8 -2
- data/lib/lockstep_sdk/models/daily_payable_outstanding_report_model.rb +2 -2
- data/lib/lockstep_sdk/models/daily_sales_outstanding_report_model.rb +2 -2
- data/lib/lockstep_sdk/models/delete_result.rb +47 -0
- data/lib/lockstep_sdk/models/developer_account_submit_model.rb +2 -2
- data/lib/lockstep_sdk/models/dpo_summary_group_total_model.rb +2 -2
- data/lib/lockstep_sdk/models/dpo_summary_model.rb +2 -2
- data/lib/lockstep_sdk/models/erp_model.rb +2 -2
- data/lib/lockstep_sdk/models/error_result.rb +2 -2
- data/lib/lockstep_sdk/models/feature_flags_request_model.rb +47 -0
- data/lib/lockstep_sdk/models/feature_flags_response_model.rb +47 -0
- data/lib/lockstep_sdk/models/financial_account_balance_history_model.rb +2 -2
- data/lib/lockstep_sdk/models/financial_account_balance_history_sync_model.rb +2 -2
- data/lib/lockstep_sdk/models/financial_account_model.rb +2 -2
- data/lib/lockstep_sdk/models/financial_account_sync_model.rb +2 -2
- data/lib/lockstep_sdk/models/financial_report_cell_model.rb +2 -2
- data/lib/lockstep_sdk/models/financial_report_model.rb +2 -2
- data/lib/lockstep_sdk/models/financial_report_row_model.rb +2 -2
- data/lib/lockstep_sdk/models/financial_year_setting_model.rb +2 -2
- data/lib/lockstep_sdk/models/financial_year_setting_sync_model.rb +2 -2
- data/lib/lockstep_sdk/models/group_account_model.rb +8 -2
- data/lib/lockstep_sdk/models/invite_data_model.rb +2 -2
- data/lib/lockstep_sdk/models/invite_model.rb +2 -2
- data/lib/lockstep_sdk/models/invite_submit_model.rb +2 -2
- data/lib/lockstep_sdk/models/invoice_address_model.rb +2 -2
- data/lib/lockstep_sdk/models/invoice_history_model.rb +8 -2
- data/lib/lockstep_sdk/models/invoice_line_model.rb +2 -2
- data/lib/lockstep_sdk/models/invoice_line_sync_model.rb +2 -2
- data/lib/lockstep_sdk/models/invoice_model.rb +8 -2
- data/lib/lockstep_sdk/models/invoice_payment_detail_model.rb +32 -2
- data/lib/lockstep_sdk/models/invoice_summary_model.rb +44 -2
- data/lib/lockstep_sdk/models/invoice_summary_model_invoice_summary_totals_model_summary_fetch_result.rb +75 -0
- data/lib/lockstep_sdk/models/invoice_summary_totals_model.rb +53 -0
- data/lib/lockstep_sdk/models/invoice_sync_model.rb +8 -2
- data/lib/lockstep_sdk/models/lead_model.rb +3 -3
- data/lib/lockstep_sdk/models/magic_link_model.rb +131 -0
- data/lib/lockstep_sdk/models/magic_link_status_model.rb +71 -0
- data/lib/lockstep_sdk/models/note_model.rb +2 -2
- data/lib/lockstep_sdk/models/payables_coming_due_header_model.rb +2 -2
- data/lib/lockstep_sdk/models/payables_coming_due_model.rb +2 -2
- data/lib/lockstep_sdk/models/payables_coming_due_widget_model.rb +2 -2
- data/lib/lockstep_sdk/models/payables_summary_report_model.rb +2 -2
- data/lib/lockstep_sdk/models/payment_applied_model.rb +2 -2
- data/lib/lockstep_sdk/models/payment_applied_sync_model.rb +2 -2
- data/lib/lockstep_sdk/models/payment_detail_header_model.rb +10 -4
- data/lib/lockstep_sdk/models/payment_detail_model.rb +26 -2
- data/lib/lockstep_sdk/models/payment_model.rb +8 -2
- data/lib/lockstep_sdk/models/payment_summary_model.rb +38 -2
- data/lib/lockstep_sdk/models/payment_summary_model_payment_summary_totals_model_summary_fetch_result.rb +75 -0
- data/lib/lockstep_sdk/models/payment_summary_totals_model.rb +53 -0
- data/lib/lockstep_sdk/models/payment_sync_model.rb +8 -2
- data/lib/lockstep_sdk/models/public_company_profile_model.rb +2 -2
- data/lib/lockstep_sdk/models/risk_rate_model.rb +10 -4
- data/lib/lockstep_sdk/models/state_model.rb +2 -2
- data/lib/lockstep_sdk/models/status_model.rb +32 -2
- data/lib/lockstep_sdk/models/summary_aging_totals_model.rb +53 -0
- data/lib/lockstep_sdk/models/sync_entity_result_model.rb +2 -2
- data/lib/lockstep_sdk/models/sync_request_model.rb +14 -2
- data/lib/lockstep_sdk/models/sync_submit_model.rb +2 -2
- data/lib/lockstep_sdk/models/transaction_detail_model.rb +138 -0
- data/lib/lockstep_sdk/models/transaction_model.rb +144 -0
- data/lib/lockstep_sdk/models/transaction_model_transaction_summary_total_model_summary_fetch_result.rb +75 -0
- data/lib/lockstep_sdk/models/transaction_summary_total_model.rb +71 -0
- data/lib/lockstep_sdk/models/transcription_request_submit.rb +71 -0
- data/lib/lockstep_sdk/models/transcription_validation_request.rb +89 -0
- data/lib/lockstep_sdk/models/transcription_validation_request_item.rb +149 -0
- data/lib/lockstep_sdk/models/transfer_owner_model.rb +2 -2
- data/lib/lockstep_sdk/models/transfer_owner_submit_model.rb +2 -2
- data/lib/lockstep_sdk/models/uri_model.rb +2 -2
- data/lib/lockstep_sdk/models/user_account_model.rb +2 -2
- data/lib/lockstep_sdk/models/user_data_response_model.rb +53 -0
- data/lib/lockstep_sdk/models/user_group_model.rb +2 -2
- data/lib/lockstep_sdk/models/user_role_model.rb +2 -2
- data/lib/lockstep_sdk/models/vendor_summary_model.rb +44 -2
- data/lib/lockstep_sdk/models/view_box_settings_model.rb +65 -0
- data/lib/lockstep_sdk/models/webhook_history_table_storage_model.rb +2 -2
- data/lib/lockstep_sdk/models/webhook_model.rb +2 -2
- data/lib/lockstep_sdk/models/webhook_rule_model.rb +2 -2
- data/lib/lockstep_sdk/version.rb +1 -1
- metadata +36 -12
- data/lib/lockstep_sdk/clients/activities_client.rb +0 -116
- data/lib/lockstep_sdk/clients/emails_client.rb +0 -105
- data/lib/lockstep_sdk/clients/payment_applications_client.rb +0 -93
- data/lib/lockstep_sdk/models/activity_model.rb +0 -218
- data/lib/lockstep_sdk/models/activity_stream_item_model.rb +0 -101
- data/lib/lockstep_sdk/models/activity_xref_model.rb +0 -71
- data/lib/lockstep_sdk/models/email_model.rb +0 -242
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9ed4e526a431a87f3e9fa4ffce45e7bf0084cf614228f155698e6e10ec6a1fd6
|
4
|
+
data.tar.gz: e6f1d7589adbd2b3cfc896e06638f4152be249f10f3c98a772c7ccdd470abfa3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: eee249a9fa647b1a57f322aff3b05403275657a9ec08504cf1f41d69eee81cbd53bad940180f7039c3434529f57fab4256f65e1f198690cb227d44337e6c1650
|
7
|
+
data.tar.gz: 97d62df097c426559eafcacfdf2feaeaaf965b8380a6bacd1af615c9abc20d39fad5538a80f020075ab4a91da39ebddd0033e58369a01f95f7cd0f3abc187a2f
|
@@ -1,13 +1,13 @@
|
|
1
1
|
#
|
2
2
|
# Lockstep Platform SDK for Ruby
|
3
3
|
#
|
4
|
-
# (c) 2021-
|
4
|
+
# (c) 2021-2023 Lockstep, Inc.
|
5
5
|
#
|
6
6
|
# For the full copyright and license information, please view the LICENSE
|
7
7
|
# file that was distributed with this source code.
|
8
8
|
#
|
9
9
|
# @author Lockstep Network <support@lockstep.io>
|
10
|
-
# @copyright 2021-
|
10
|
+
# @copyright 2021-2023 Lockstep, Inc.
|
11
11
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
12
12
|
#
|
13
13
|
|
@@ -77,7 +77,7 @@ class ApiKeysClient
|
|
77
77
|
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
78
78
|
# @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.
|
79
79
|
# @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
80
|
-
# @param page_size [int32] The page size for results (default
|
80
|
+
# @param page_size [int32] The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
81
81
|
# @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
82
82
|
def query_api_keys(filter:, include_param:, order:, page_size:, page_number:)
|
83
83
|
path = "/api/v1/ApiKeys/query"
|
@@ -1,13 +1,13 @@
|
|
1
1
|
#
|
2
2
|
# Lockstep Platform SDK for Ruby
|
3
3
|
#
|
4
|
-
# (c) 2021-
|
4
|
+
# (c) 2021-2023 Lockstep, Inc.
|
5
5
|
#
|
6
6
|
# For the full copyright and license information, please view the LICENSE
|
7
7
|
# file that was distributed with this source code.
|
8
8
|
#
|
9
9
|
# @author Lockstep Network <support@lockstep.io>
|
10
|
-
# @copyright 2021-
|
10
|
+
# @copyright 2021-2023 Lockstep, Inc.
|
11
11
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
12
12
|
#
|
13
13
|
|
@@ -86,8 +86,8 @@ class AppEnrollmentsClient
|
|
86
86
|
##
|
87
87
|
# Updates the settings associated with this App Enrollment
|
88
88
|
#
|
89
|
-
# @param id [uuid] The
|
90
|
-
# @param body [
|
89
|
+
# @param id [uuid] The id for the app enrollment
|
90
|
+
# @param body [AppEnrollmentReconnectInfo] Information to reconnect the App Enrollment
|
91
91
|
def reconnect_app_enrollment(id:, body:)
|
92
92
|
path = "/api/v1/AppEnrollments/#{id}/reconnect"
|
93
93
|
@connection.request(:post, path, body, nil)
|
@@ -105,7 +105,7 @@ class AppEnrollmentsClient
|
|
105
105
|
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
106
106
|
# @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: App, CustomFields, LastSync, LastSuccessfulSync
|
107
107
|
# @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
108
|
-
# @param page_size [int32] The page size for results (default
|
108
|
+
# @param page_size [int32] The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
109
109
|
# @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
110
110
|
def query_app_enrollments(filter:, include_param:, order:, page_size:, page_number:)
|
111
111
|
path = "/api/v1/AppEnrollments/query"
|
@@ -1,13 +1,13 @@
|
|
1
1
|
#
|
2
2
|
# Lockstep Platform SDK for Ruby
|
3
3
|
#
|
4
|
-
# (c) 2021-
|
4
|
+
# (c) 2021-2023 Lockstep, Inc.
|
5
5
|
#
|
6
6
|
# For the full copyright and license information, please view the LICENSE
|
7
7
|
# file that was distributed with this source code.
|
8
8
|
#
|
9
9
|
# @author Lockstep Network <support@lockstep.io>
|
10
|
-
# @copyright 2021-
|
10
|
+
# @copyright 2021-2023 Lockstep, Inc.
|
11
11
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
12
12
|
#
|
13
13
|
|
@@ -93,7 +93,7 @@ class ApplicationsClient
|
|
93
93
|
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
94
94
|
# @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Notes, Attachments, CustomFields
|
95
95
|
# @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
96
|
-
# @param page_size [int32] The page size for results (default
|
96
|
+
# @param page_size [int32] The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
97
97
|
# @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
98
98
|
def query_applications(filter:, include_param:, order:, page_size:, page_number:)
|
99
99
|
path = "/api/v1/Applications/query"
|
@@ -1,13 +1,13 @@
|
|
1
1
|
#
|
2
2
|
# Lockstep Platform SDK for Ruby
|
3
3
|
#
|
4
|
-
# (c) 2021-
|
4
|
+
# (c) 2021-2023 Lockstep, Inc.
|
5
5
|
#
|
6
6
|
# For the full copyright and license information, please view the LICENSE
|
7
7
|
# file that was distributed with this source code.
|
8
8
|
#
|
9
9
|
# @author Lockstep Network <support@lockstep.io>
|
10
|
-
# @copyright 2021-
|
10
|
+
# @copyright 2021-2023 Lockstep, Inc.
|
11
11
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
12
12
|
#
|
13
13
|
|
@@ -123,7 +123,7 @@ class AttachmentsClient
|
|
123
123
|
# @param filter [string] The filter to use to select from the list of available Attachments, in the [Searchlight query syntax](https://github.com/tspence/csharp-searchlight).
|
124
124
|
# @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. No collections are currently available for querying but may be available in the future.
|
125
125
|
# @param order [string] The sort order for the results, in the [Searchlight order syntax](https://github.com/tspence/csharp-searchlight).
|
126
|
-
# @param page_size [int32] The page size for results (default
|
126
|
+
# @param page_size [int32] The page size for results (default 250, maximum of 500)
|
127
127
|
# @param page_number [int32] The page number for results (default 0)
|
128
128
|
def query_attachments(filter:, include_param:, order:, page_size:, page_number:)
|
129
129
|
path = "/api/v1/Attachments/query"
|
@@ -1,13 +1,13 @@
|
|
1
1
|
#
|
2
2
|
# Lockstep Platform SDK for Ruby
|
3
3
|
#
|
4
|
-
# (c) 2021-
|
4
|
+
# (c) 2021-2023 Lockstep, Inc.
|
5
5
|
#
|
6
6
|
# For the full copyright and license information, please view the LICENSE
|
7
7
|
# file that was distributed with this source code.
|
8
8
|
#
|
9
9
|
# @author Lockstep Network <support@lockstep.io>
|
10
|
-
# @copyright 2021-
|
10
|
+
# @copyright 2021-2023 Lockstep, Inc.
|
11
11
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
12
12
|
#
|
13
13
|
|
@@ -47,7 +47,7 @@ class CodeDefinitionsClient
|
|
47
47
|
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
48
48
|
# @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
|
49
49
|
# @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
50
|
-
# @param page_size [int32] The page size for results (default
|
50
|
+
# @param page_size [int32] The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
51
51
|
# @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
52
52
|
def query_codedefinitions(filter:, include_param:, order:, page_size:, page_number:)
|
53
53
|
path = "/api/v1/CodeDefinitions/query"
|
@@ -1,13 +1,13 @@
|
|
1
1
|
#
|
2
2
|
# Lockstep Platform SDK for Ruby
|
3
3
|
#
|
4
|
-
# (c) 2021-
|
4
|
+
# (c) 2021-2023 Lockstep, Inc.
|
5
5
|
#
|
6
6
|
# For the full copyright and license information, please view the LICENSE
|
7
7
|
# file that was distributed with this source code.
|
8
8
|
#
|
9
9
|
# @author Lockstep Network <support@lockstep.io>
|
10
|
-
# @copyright 2021-
|
10
|
+
# @copyright 2021-2023 Lockstep, Inc.
|
11
11
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
12
12
|
#
|
13
13
|
|
@@ -56,14 +56,14 @@ class CompaniesClient
|
|
56
56
|
end
|
57
57
|
|
58
58
|
##
|
59
|
-
#
|
59
|
+
# Delete the Company referred to by this unique identifier.
|
60
60
|
#
|
61
61
|
# 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.
|
62
62
|
#
|
63
63
|
# See [Vendors, Customers, and Companies](https://developer.lockstep.io/docs/companies-customers-and-vendors) for more information.
|
64
64
|
#
|
65
65
|
# @param id [uuid] The unique Lockstep Platform ID number of this Company; NOT the customer's ERP key
|
66
|
-
def
|
66
|
+
def delete_company(id:)
|
67
67
|
path = "/api/v1/Companies/#{id}"
|
68
68
|
@connection.request(:delete, path, nil, nil)
|
69
69
|
end
|
@@ -81,6 +81,19 @@ class CompaniesClient
|
|
81
81
|
@connection.request(:post, path, body, nil)
|
82
82
|
end
|
83
83
|
|
84
|
+
##
|
85
|
+
# Delete the Companies referred to by these unique identifiers.
|
86
|
+
#
|
87
|
+
# 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.
|
88
|
+
#
|
89
|
+
# See [Vendors, Customers, and Companies](https://developer.lockstep.io/docs/companies-customers-and-vendors) for more information.
|
90
|
+
#
|
91
|
+
# @param body [BulkDeleteRequestModel] The unique Lockstep Platform ID numbers of the Companies to delete; NOT the customer's ERP key
|
92
|
+
def delete_companies(body:)
|
93
|
+
path = "/api/v1/Companies"
|
94
|
+
@connection.request(:delete, path, body, nil)
|
95
|
+
end
|
96
|
+
|
84
97
|
##
|
85
98
|
# Queries Companies for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
|
86
99
|
#
|
@@ -93,7 +106,7 @@ class CompaniesClient
|
|
93
106
|
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
94
107
|
# @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
|
95
108
|
# @param order [string] The sort order for the results, in the [Searchlight order syntax](https://github.com/tspence/csharp-searchlight).
|
96
|
-
# @param page_size [int32] The page size for results (default
|
109
|
+
# @param page_size [int32] The page size for results (default 250, maximum of 500)
|
97
110
|
# @param page_number [int32] The page number for results (default 0)
|
98
111
|
def query_companies(filter:, include_param:, order:, page_size:, page_number:)
|
99
112
|
path = "/api/v1/Companies/query"
|
@@ -113,7 +126,7 @@ class CompaniesClient
|
|
113
126
|
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
114
127
|
# @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
|
115
128
|
# @param order [string] The sort order for the results, in the [Searchlight order syntax](https://github.com/tspence/csharp-searchlight).
|
116
|
-
# @param page_size [int32] The page size for results (default
|
129
|
+
# @param page_size [int32] The page size for results (default 250, maximum of 500)
|
117
130
|
# @param page_number [int32] The page number for results (default 0)
|
118
131
|
# @param report_date [date-time] The date to calculate the fields on. If no date is entered the current UTC date will be used.
|
119
132
|
def query_customer_summary(filter:, include_param:, order:, page_size:, page_number:, report_date:)
|
@@ -134,7 +147,7 @@ class CompaniesClient
|
|
134
147
|
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
135
148
|
# @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
|
136
149
|
# @param order [string] The sort order for the results, in the [Searchlight order syntax](https://github.com/tspence/csharp-searchlight).
|
137
|
-
# @param page_size [int32] The page size for results (default
|
150
|
+
# @param page_size [int32] The page size for results (default 250, maximum of 500)
|
138
151
|
# @param page_number [int32] The page number for results (default 0)
|
139
152
|
# @param report_date [date-time] The date to calculate the fields on. If no date is entered the current UTC date will be used.
|
140
153
|
def query_vendor_summary(filter:, include_param:, order:, page_size:, page_number:, report_date:)
|
@@ -159,16 +172,33 @@ class CompaniesClient
|
|
159
172
|
##
|
160
173
|
# Sets the logo for specified company. The logo will be stored in the Lockstep Platform and will be **publicly accessible**.
|
161
174
|
#
|
162
|
-
# .jpg, .jpeg, and .
|
175
|
+
# .jpg, .jpeg, .png, and .webp are supported. 2MB maximum. If no logo is uploaded, the existing logo will be deleted.
|
163
176
|
#
|
164
177
|
# 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.
|
165
178
|
#
|
179
|
+
# Optional view box meta data for the provided logo may be supplied using the following query parameters. Please note that you must supply either all of the values or none of the values. <ul><li>min_x</li><li>min_y</li><li>width</li><li>height</li></ul>
|
180
|
+
#
|
166
181
|
# See [Vendors, Customers, and Companies](https://developer.lockstep.io/docs/companies-customers-and-vendors) for more information.
|
167
182
|
#
|
168
183
|
# @param id [uuid] The unique Lockstep Platform ID number of this Company; NOT the customer's ERP key
|
184
|
+
# @param min_x [double] ViewBox minX setting for this Company's logo.
|
185
|
+
# @param min_y [double] ViewBox minY setting for this Company's logo.
|
186
|
+
# @param width [double] ViewBox width setting for this Company's logo.
|
187
|
+
# @param height [double] ViewBox height setting for this Company's logo.
|
169
188
|
# @param filename [File] The full path of a file to upload to the API
|
170
|
-
def set_company_logo(id:, filename:)
|
189
|
+
def set_company_logo(id:, min_x:, min_y:, width:, height:, filename:)
|
171
190
|
path = "/api/v1/Companies/#{id}/logo"
|
172
|
-
|
191
|
+
params = {:min_x => min_x, :min_y => min_y, :width => width, :height => height}
|
192
|
+
@connection.request(:post, path, nil, params)
|
193
|
+
end
|
194
|
+
|
195
|
+
##
|
196
|
+
# Update view box meta data for the given Company id.
|
197
|
+
#
|
198
|
+
# @param id [uuid] The unique Lockstep Platform ID number of this Company; NOT the customer's ERP key
|
199
|
+
# @param body [ViewBoxSettingsModel] The `ViewBoxSettingsModel` containing meta data value updates
|
200
|
+
def update_logo_view_box_settings(id:, body:)
|
201
|
+
path = "/api/v1/Companies/#{id}/logo-settings"
|
202
|
+
@connection.request(:patch, path, body, nil)
|
173
203
|
end
|
174
204
|
end
|
@@ -1,13 +1,13 @@
|
|
1
1
|
#
|
2
2
|
# Lockstep Platform SDK for Ruby
|
3
3
|
#
|
4
|
-
# (c) 2021-
|
4
|
+
# (c) 2021-2023 Lockstep, Inc.
|
5
5
|
#
|
6
6
|
# For the full copyright and license information, please view the LICENSE
|
7
7
|
# file that was distributed with this source code.
|
8
8
|
#
|
9
9
|
# @author Lockstep Network <support@lockstep.io>
|
10
|
-
# @copyright 2021-
|
10
|
+
# @copyright 2021-2023 Lockstep, Inc.
|
11
11
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
12
12
|
#
|
13
13
|
|
@@ -52,12 +52,12 @@ class ContactsClient
|
|
52
52
|
end
|
53
53
|
|
54
54
|
##
|
55
|
-
#
|
55
|
+
# Delete the Contact referred to by this unique identifier.
|
56
56
|
#
|
57
57
|
# 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.
|
58
58
|
#
|
59
|
-
# @param id [uuid] The unique Lockstep Platform ID number of the Contact to
|
60
|
-
def
|
59
|
+
# @param id [uuid] The unique Lockstep Platform ID number of the Contact to delete; NOT the customer's ERP key
|
60
|
+
def delete_contact(id:)
|
61
61
|
path = "/api/v1/Contacts/#{id}"
|
62
62
|
@connection.request(:delete, path, nil, nil)
|
63
63
|
end
|
@@ -73,6 +73,17 @@ class ContactsClient
|
|
73
73
|
@connection.request(:post, path, body, nil)
|
74
74
|
end
|
75
75
|
|
76
|
+
##
|
77
|
+
# Delete the Contacts referred to by these unique identifiers.
|
78
|
+
#
|
79
|
+
# 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.
|
80
|
+
#
|
81
|
+
# @param body [BulkDeleteRequestModel] The unique Lockstep Platform ID numbers of the Contacts to delete; NOT the customer's ERP keys
|
82
|
+
def delete_contacts(body:)
|
83
|
+
path = "/api/v1/Contacts"
|
84
|
+
@connection.request(:delete, path, body, nil)
|
85
|
+
end
|
86
|
+
|
76
87
|
##
|
77
88
|
# Queries Contacts for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
|
78
89
|
#
|
@@ -83,7 +94,7 @@ class ContactsClient
|
|
83
94
|
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
84
95
|
# @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Attachments, CustomFields, Notes
|
85
96
|
# @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
86
|
-
# @param page_size [int32] The page size for results (default
|
97
|
+
# @param page_size [int32] The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
87
98
|
# @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
88
99
|
def query_contacts(filter:, include_param:, order:, page_size:, page_number:)
|
89
100
|
path = "/api/v1/Contacts/query"
|
data/lib/lockstep_sdk/clients/{credit_memo_applied_client.rb → credit_memos_applied_client.rb}
RENAMED
@@ -1,23 +1,23 @@
|
|
1
1
|
#
|
2
2
|
# Lockstep Platform SDK for Ruby
|
3
3
|
#
|
4
|
-
# (c) 2021-
|
4
|
+
# (c) 2021-2023 Lockstep, Inc.
|
5
5
|
#
|
6
6
|
# For the full copyright and license information, please view the LICENSE
|
7
7
|
# file that was distributed with this source code.
|
8
8
|
#
|
9
9
|
# @author Lockstep Network <support@lockstep.io>
|
10
|
-
# @copyright 2021-
|
10
|
+
# @copyright 2021-2023 Lockstep, Inc.
|
11
11
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
12
12
|
#
|
13
13
|
|
14
14
|
|
15
15
|
require 'awrence'
|
16
16
|
|
17
|
-
class
|
17
|
+
class CreditMemosAppliedClient
|
18
18
|
|
19
19
|
##
|
20
|
-
# Initialize the
|
20
|
+
# Initialize the CreditMemosAppliedClient class with an API client instance.
|
21
21
|
# @param connection [LockstepApi] The API client object for this connection
|
22
22
|
def initialize(connection)
|
23
23
|
@connection = connection
|
@@ -25,68 +25,68 @@ class CreditMemoAppliedClient
|
|
25
25
|
|
26
26
|
|
27
27
|
##
|
28
|
-
# Retrieves the Credit Memo
|
28
|
+
# Retrieves the Credit Memo Applied specified by this unique identifier, optionally including nested data sets.
|
29
29
|
#
|
30
|
-
# 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
|
30
|
+
# 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 Applied record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Applied records to track which Invoices were paid using this Credit.
|
31
31
|
#
|
32
|
-
# @param id [uuid] The unique Lockstep Platform ID number of this Credit Memo
|
32
|
+
# @param id [uuid] The unique Lockstep Platform ID number of this Credit Memo Applied; NOT the customer's ERP key
|
33
33
|
# @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Attachments, CustomFields, Notes, Invoice, CreditMemoInvoice
|
34
|
-
def
|
35
|
-
path = "/api/v1/
|
34
|
+
def retrieve_credit_memo_applied(id:, include_param:)
|
35
|
+
path = "/api/v1/credit-memos-applied/#{id}"
|
36
36
|
params = {:include => include_param}
|
37
37
|
@connection.request(:get, path, nil, params)
|
38
38
|
end
|
39
39
|
|
40
40
|
##
|
41
|
-
# Updates an existing Credit
|
41
|
+
# Updates an existing Credit Memo Applied with the information supplied to this PATCH call.
|
42
42
|
#
|
43
43
|
# 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.
|
44
44
|
#
|
45
|
-
# 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
|
45
|
+
# 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 Applied record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Applied records to track which Invoices were paid using this Credit.
|
46
46
|
#
|
47
|
-
# @param id [uuid] The unique Lockstep Platform ID number of the Credit Memo
|
48
|
-
# @param body [object] A list of changes to apply to this Credit Memo
|
49
|
-
def
|
50
|
-
path = "/api/v1/
|
47
|
+
# @param id [uuid] The unique Lockstep Platform ID number of the Credit Memo Applied to update; NOT the customer's ERP key
|
48
|
+
# @param body [object] A list of changes to apply to this Credit Memo Applied
|
49
|
+
def update_credit_memos_applied(id:, body:)
|
50
|
+
path = "/api/v1/credit-memos-applied/#{id}"
|
51
51
|
@connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
|
52
52
|
end
|
53
53
|
|
54
54
|
##
|
55
|
-
# Deletes the Credit Memo
|
55
|
+
# Deletes the Credit Memo Applied referred to by this unique identifier.
|
56
56
|
#
|
57
|
-
# 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
|
57
|
+
# 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 Applied record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Applied records to track which Invoices were paid using this Credit.
|
58
58
|
#
|
59
|
-
# @param id [uuid] The unique Lockstep Platform ID number of the Credit Memo
|
60
|
-
def
|
61
|
-
path = "/api/v1/
|
59
|
+
# @param id [uuid] The unique Lockstep Platform ID number of the Credit Memo Applied to delete; NOT the customer's ERP key
|
60
|
+
def delete_credit_memo_applied(id:)
|
61
|
+
path = "/api/v1/credit-memos-applied/#{id}"
|
62
62
|
@connection.request(:delete, path, nil, nil)
|
63
63
|
end
|
64
64
|
|
65
65
|
##
|
66
|
-
# Creates one or more Credit
|
66
|
+
# Creates one or more Credit Memos Applied within this account and returns the records as created.
|
67
67
|
#
|
68
|
-
# 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
|
68
|
+
# 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 Applied record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Applied records to track which Invoices were paid using this Credit.
|
69
69
|
#
|
70
|
-
# @param body [CreditMemoAppliedModel] The Credit
|
71
|
-
def
|
72
|
-
path = "/api/v1/
|
70
|
+
# @param body [CreditMemoAppliedModel] The Credit Memos Applied to create
|
71
|
+
def create_credit_memos_applied(body:)
|
72
|
+
path = "/api/v1/credit-memos-applied"
|
73
73
|
@connection.request(:post, path, body, nil)
|
74
74
|
end
|
75
75
|
|
76
76
|
##
|
77
|
-
# Queries Credit
|
77
|
+
# Queries Credit Memos Applied for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
|
78
78
|
#
|
79
79
|
# 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.
|
80
80
|
#
|
81
|
-
# 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
|
81
|
+
# 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 Applied record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Applied records to track which Invoices were paid using this Credit.
|
82
82
|
#
|
83
83
|
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
84
84
|
# @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Attachments, CustomFields, Notes
|
85
85
|
# @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
86
|
-
# @param page_size [int32] The page size for results (default
|
86
|
+
# @param page_size [int32] The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
87
87
|
# @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
88
|
-
def
|
89
|
-
path = "/api/v1/
|
88
|
+
def query_credit_memos_applied(filter:, include_param:, order:, page_size:, page_number:)
|
89
|
+
path = "/api/v1/credit-memos-applied/query"
|
90
90
|
params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
|
91
91
|
@connection.request(:get, path, nil, params)
|
92
92
|
end
|
@@ -1,13 +1,13 @@
|
|
1
1
|
#
|
2
2
|
# Lockstep Platform SDK for Ruby
|
3
3
|
#
|
4
|
-
# (c) 2021-
|
4
|
+
# (c) 2021-2023 Lockstep, Inc.
|
5
5
|
#
|
6
6
|
# For the full copyright and license information, please view the LICENSE
|
7
7
|
# file that was distributed with this source code.
|
8
8
|
#
|
9
9
|
# @author Lockstep Network <support@lockstep.io>
|
10
|
-
# @copyright 2021-
|
10
|
+
# @copyright 2021-2023 Lockstep, Inc.
|
11
11
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
12
12
|
#
|
13
13
|
|
@@ -1,13 +1,13 @@
|
|
1
1
|
#
|
2
2
|
# Lockstep Platform SDK for Ruby
|
3
3
|
#
|
4
|
-
# (c) 2021-
|
4
|
+
# (c) 2021-2023 Lockstep, Inc.
|
5
5
|
#
|
6
6
|
# For the full copyright and license information, please view the LICENSE
|
7
7
|
# file that was distributed with this source code.
|
8
8
|
#
|
9
9
|
# @author Lockstep Network <support@lockstep.io>
|
10
|
-
# @copyright 2021-
|
10
|
+
# @copyright 2021-2023 Lockstep, Inc.
|
11
11
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
12
12
|
#
|
13
13
|
|
@@ -93,7 +93,7 @@ class CustomFieldDefinitionsClient
|
|
93
93
|
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
94
94
|
# @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.
|
95
95
|
# @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
96
|
-
# @param page_size [int32] The page size for results (default
|
96
|
+
# @param page_size [int32] The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
97
97
|
# @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
98
98
|
def query_field_definitions(filter:, include_param:, order:, page_size:, page_number:)
|
99
99
|
path = "/api/v1/CustomFieldDefinitions/query"
|
@@ -1,13 +1,13 @@
|
|
1
1
|
#
|
2
2
|
# Lockstep Platform SDK for Ruby
|
3
3
|
#
|
4
|
-
# (c) 2021-
|
4
|
+
# (c) 2021-2023 Lockstep, Inc.
|
5
5
|
#
|
6
6
|
# For the full copyright and license information, please view the LICENSE
|
7
7
|
# file that was distributed with this source code.
|
8
8
|
#
|
9
9
|
# @author Lockstep Network <support@lockstep.io>
|
10
|
-
# @copyright 2021-
|
10
|
+
# @copyright 2021-2023 Lockstep, Inc.
|
11
11
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
12
12
|
#
|
13
13
|
|
@@ -96,7 +96,7 @@ class CustomFieldValuesClient
|
|
96
96
|
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
97
97
|
# @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: CustomFieldDefinition
|
98
98
|
# @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
99
|
-
# @param page_size [int32] The page size for results (default
|
99
|
+
# @param page_size [int32] The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
100
100
|
# @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
101
101
|
def query_fields(filter:, include_param:, order:, page_size:, page_number:)
|
102
102
|
path = "/api/v1/CustomFieldValues/query"
|
@@ -1,13 +1,13 @@
|
|
1
1
|
#
|
2
2
|
# Lockstep Platform SDK for Ruby
|
3
3
|
#
|
4
|
-
# (c) 2021-
|
4
|
+
# (c) 2021-2023 Lockstep, Inc.
|
5
5
|
#
|
6
6
|
# For the full copyright and license information, please view the LICENSE
|
7
7
|
# file that was distributed with this source code.
|
8
8
|
#
|
9
9
|
# @author Lockstep Network <support@lockstep.io>
|
10
|
-
# @copyright 2021-
|
10
|
+
# @copyright 2021-2023 Lockstep, Inc.
|
11
11
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
12
12
|
#
|
13
13
|
|
@@ -34,7 +34,7 @@ class DefinitionsClient
|
|
34
34
|
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
35
35
|
# @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.
|
36
36
|
# @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
37
|
-
# @param page_size [int32] The page size for results (default
|
37
|
+
# @param page_size [int32] The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
38
38
|
# @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
39
39
|
def query_countries(filter:, include_param:, order:, page_size:, page_number:)
|
40
40
|
path = "/api/v1/Definitions/countries"
|
@@ -52,7 +52,7 @@ class DefinitionsClient
|
|
52
52
|
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
53
53
|
# @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.
|
54
54
|
# @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
55
|
-
# @param page_size [int32] The page size for results (default
|
55
|
+
# @param page_size [int32] The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
56
56
|
# @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
57
57
|
def query_currencies(filter:, include_param:, order:, page_size:, page_number:)
|
58
58
|
path = "/api/v1/Definitions/currencies"
|
@@ -70,7 +70,7 @@ class DefinitionsClient
|
|
70
70
|
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
71
71
|
# @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.
|
72
72
|
# @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
73
|
-
# @param page_size [int32] The page size for results (default
|
73
|
+
# @param page_size [int32] The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
74
74
|
# @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
75
75
|
def query_states(filter:, include_param:, order:, page_size:, page_number:)
|
76
76
|
path = "/api/v1/Definitions/states"
|
@@ -88,7 +88,7 @@ class DefinitionsClient
|
|
88
88
|
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
89
89
|
# @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.
|
90
90
|
# @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
91
|
-
# @param page_size [int32] The page size for results (default
|
91
|
+
# @param page_size [int32] The page size for results (default 250, maximum of 500). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
92
92
|
# @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
93
93
|
def query_financial_systems(filter:, include_param:, order:, page_size:, page_number:)
|
94
94
|
path = "/api/v1/Definitions/financialsystems"
|
@@ -0,0 +1,35 @@
|
|
1
|
+
#
|
2
|
+
# Lockstep Platform SDK for Ruby
|
3
|
+
#
|
4
|
+
# (c) 2021-2023 Lockstep, Inc.
|
5
|
+
#
|
6
|
+
# For the full copyright and license information, please view the LICENSE
|
7
|
+
# file that was distributed with this source code.
|
8
|
+
#
|
9
|
+
# @author Lockstep Network <support@lockstep.io>
|
10
|
+
# @copyright 2021-2023 Lockstep, Inc.
|
11
|
+
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
12
|
+
#
|
13
|
+
|
14
|
+
|
15
|
+
require 'awrence'
|
16
|
+
|
17
|
+
class FeatureFlagsClient
|
18
|
+
|
19
|
+
##
|
20
|
+
# Initialize the FeatureFlagsClient class with an API client instance.
|
21
|
+
# @param connection [LockstepApi] The API client object for this connection
|
22
|
+
def initialize(connection)
|
23
|
+
@connection = connection
|
24
|
+
end
|
25
|
+
|
26
|
+
|
27
|
+
##
|
28
|
+
# Retrieves the specified feature flags. True if they are enabled, false otherwise.
|
29
|
+
#
|
30
|
+
# @param body [FeatureFlagsRequestModel]
|
31
|
+
def retrieve_feature_flags(body:)
|
32
|
+
path = "/api/v1/feature-flags"
|
33
|
+
@connection.request(:post, path, body, nil)
|
34
|
+
end
|
35
|
+
end
|