lockstep_sdk 2022.13.29.0 → 2022.14.30.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/LockstepSdk/lockstep_api.rb +287 -0
- data/lib/lockstep_sdk/clients/activities_client.rb +13 -15
- data/lib/lockstep_sdk/clients/api_keys_client.rb +10 -12
- data/lib/lockstep_sdk/clients/app_enrollments_client.rb +12 -14
- data/lib/lockstep_sdk/clients/applications_client.rb +11 -13
- data/lib/lockstep_sdk/clients/attachments_client.rb +13 -15
- data/lib/lockstep_sdk/clients/code_definitions_client.rb +8 -10
- data/lib/lockstep_sdk/clients/companies_client.rb +13 -15
- data/lib/lockstep_sdk/clients/contacts_client.rb +11 -13
- data/lib/lockstep_sdk/clients/credit_memo_applied_client.rb +11 -13
- data/lib/lockstep_sdk/clients/currencies_client.rb +8 -10
- data/lib/lockstep_sdk/clients/custom_field_definitions_client.rb +11 -13
- data/lib/lockstep_sdk/clients/custom_field_values_client.rb +11 -13
- data/lib/lockstep_sdk/clients/definitions_client.rb +10 -12
- data/lib/lockstep_sdk/clients/emails_client.rb +12 -14
- data/lib/lockstep_sdk/clients/financial_account_balance_history_client.rb +11 -13
- data/lib/lockstep_sdk/clients/financial_account_client.rb +11 -13
- data/lib/lockstep_sdk/clients/financial_year_settings_client.rb +11 -13
- data/lib/lockstep_sdk/clients/invoice_history_client.rb +8 -10
- data/lib/lockstep_sdk/clients/invoices_client.rb +14 -16
- data/lib/lockstep_sdk/clients/leads_client.rb +7 -9
- data/lib/lockstep_sdk/clients/notes_client.rb +10 -12
- data/lib/lockstep_sdk/clients/payment_applications_client.rb +11 -13
- data/lib/lockstep_sdk/clients/payments_client.rb +15 -17
- data/lib/lockstep_sdk/clients/provisioning_client.rb +9 -11
- data/lib/lockstep_sdk/clients/reports_client.rb +31 -17
- data/lib/lockstep_sdk/clients/status_client.rb +8 -10
- data/lib/lockstep_sdk/clients/sync_client.rb +13 -15
- data/lib/lockstep_sdk/clients/user_accounts_client.rb +14 -16
- data/lib/lockstep_sdk/clients/user_roles_client.rb +8 -10
- data/lib/lockstep_sdk/clients/webhooks_client.rb +13 -15
- data/lib/lockstep_sdk/lockstep_api.rb +9 -10
- data/lib/lockstep_sdk/models/activity_model.rb +2 -4
- data/lib/lockstep_sdk/models/activity_stream_item_model.rb +2 -4
- data/lib/lockstep_sdk/models/activity_xref_model.rb +2 -4
- data/lib/lockstep_sdk/models/aging_model.rb +2 -4
- data/lib/lockstep_sdk/models/api_key_model.rb +2 -4
- data/lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb +2 -4
- data/lib/lockstep_sdk/models/app_enrollment_model.rb +2 -4
- data/lib/lockstep_sdk/models/application_model.rb +2 -4
- data/lib/lockstep_sdk/models/ar_aging_header_info_model.rb +2 -4
- data/lib/lockstep_sdk/models/ar_header_info_model.rb +2 -4
- data/lib/lockstep_sdk/models/at_risk_invoice_summary_model.rb +2 -4
- data/lib/lockstep_sdk/models/attachment_header_info_model.rb +2 -4
- data/lib/lockstep_sdk/models/attachment_model.rb +2 -4
- data/lib/lockstep_sdk/models/batch_sync_model.rb +2 -4
- data/lib/lockstep_sdk/models/bulk_currency_conversion_model.rb +2 -4
- data/lib/lockstep_sdk/models/cashflow_report_model.rb +2 -4
- data/lib/lockstep_sdk/models/code_definition_model.rb +2 -4
- data/lib/lockstep_sdk/models/company_model.rb +2 -4
- data/lib/lockstep_sdk/models/company_sync_model.rb +2 -4
- data/lib/lockstep_sdk/models/connector_info_model.rb +2 -4
- data/lib/lockstep_sdk/models/contact_model.rb +2 -4
- data/lib/lockstep_sdk/models/contact_sync_model.rb +2 -4
- data/lib/lockstep_sdk/models/country_model.rb +2 -4
- data/lib/lockstep_sdk/models/credit_memo_applied_model.rb +2 -4
- data/lib/lockstep_sdk/models/credit_memo_applied_sync_model.rb +2 -4
- data/lib/lockstep_sdk/models/credit_memo_invoice_model.rb +2 -4
- data/lib/lockstep_sdk/models/currency_model.rb +2 -4
- data/lib/lockstep_sdk/models/currency_rate_model.rb +2 -4
- data/lib/lockstep_sdk/models/custom_field_definition_model.rb +2 -4
- data/lib/lockstep_sdk/models/custom_field_sync_model.rb +2 -4
- data/lib/lockstep_sdk/models/custom_field_value_model.rb +2 -4
- data/lib/lockstep_sdk/models/customer_details_model.rb +2 -4
- data/lib/lockstep_sdk/models/customer_details_payment_model.rb +2 -4
- data/lib/lockstep_sdk/models/customer_summary_model.rb +2 -4
- data/lib/lockstep_sdk/models/daily_sales_outstanding_report_model.rb +2 -4
- data/lib/lockstep_sdk/models/developer_account_submit_model.rb +2 -4
- data/lib/lockstep_sdk/models/email_model.rb +2 -4
- data/lib/lockstep_sdk/models/erp_info_model.rb +2 -4
- data/lib/lockstep_sdk/models/erp_model.rb +2 -4
- data/lib/lockstep_sdk/models/financial_account_balance_history_model.rb +2 -4
- data/lib/lockstep_sdk/models/financial_account_model.rb +2 -4
- data/lib/lockstep_sdk/models/financial_report_cell_model.rb +2 -4
- data/lib/lockstep_sdk/models/financial_report_model.rb +2 -4
- data/lib/lockstep_sdk/models/financial_report_row_model.rb +2 -4
- data/lib/lockstep_sdk/models/financial_year_setting_model.rb +2 -4
- data/lib/lockstep_sdk/models/invite_data_model.rb +2 -4
- data/lib/lockstep_sdk/models/invite_model.rb +2 -4
- data/lib/lockstep_sdk/models/invite_submit_model.rb +2 -4
- data/lib/lockstep_sdk/models/invoice_address_model.rb +2 -4
- data/lib/lockstep_sdk/models/invoice_history_model.rb +2 -4
- data/lib/lockstep_sdk/models/invoice_line_model.rb +2 -4
- data/lib/lockstep_sdk/models/invoice_line_sync_model.rb +2 -4
- data/lib/lockstep_sdk/models/invoice_model.rb +2 -4
- data/lib/lockstep_sdk/models/invoice_payment_detail_model.rb +2 -4
- data/lib/lockstep_sdk/models/invoice_summary_model.rb +2 -4
- data/lib/lockstep_sdk/models/invoice_sync_model.rb +2 -4
- data/lib/lockstep_sdk/models/lead_model.rb +2 -4
- data/lib/lockstep_sdk/models/note_model.rb +2 -4
- data/lib/lockstep_sdk/models/payment_applied_model.rb +2 -4
- data/lib/lockstep_sdk/models/payment_applied_sync_model.rb +2 -4
- data/lib/lockstep_sdk/models/payment_detail_header_model.rb +2 -4
- data/lib/lockstep_sdk/models/payment_detail_model.rb +2 -4
- data/lib/lockstep_sdk/models/payment_model.rb +2 -4
- data/lib/lockstep_sdk/models/payment_summary_model.rb +2 -4
- data/lib/lockstep_sdk/models/payment_sync_model.rb +2 -4
- data/lib/lockstep_sdk/models/provisioning_finalize_request_model.rb +2 -4
- data/lib/lockstep_sdk/models/provisioning_model.rb +2 -4
- data/lib/lockstep_sdk/models/provisioning_response_model.rb +2 -4
- data/lib/lockstep_sdk/models/risk_rate_model.rb +2 -4
- data/lib/lockstep_sdk/models/state_model.rb +2 -4
- data/lib/lockstep_sdk/models/status_model.rb +2 -4
- data/lib/lockstep_sdk/models/sync_entity_result_model.rb +2 -4
- data/lib/lockstep_sdk/models/sync_request_model.rb +2 -4
- data/lib/lockstep_sdk/models/sync_submit_model.rb +2 -4
- data/lib/lockstep_sdk/models/transfer_owner_model.rb +2 -4
- data/lib/lockstep_sdk/models/transfer_owner_submit_model.rb +2 -4
- data/lib/lockstep_sdk/models/uri_model.rb +2 -4
- data/lib/lockstep_sdk/models/user_account_model.rb +2 -4
- data/lib/lockstep_sdk/models/user_role_model.rb +2 -4
- data/lib/lockstep_sdk/models/webhook_history_table_storage_model.rb +2 -4
- data/lib/lockstep_sdk/models/webhook_model.rb +2 -4
- metadata +3 -2
@@ -1,14 +1,12 @@
|
|
1
1
|
#
|
2
|
-
# Lockstep
|
2
|
+
# Lockstep Platform SDK for Ruby
|
3
3
|
#
|
4
4
|
# (c) 2021-2022 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
|
-
# @author
|
10
|
-
# @author Manish Narayan B S <manish.n@lockstep.io>
|
11
|
-
# @author Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
|
9
|
+
# @author Lockstep Network <support@lockstep.io>
|
12
10
|
# @copyright 2021-2022 Lockstep, Inc.
|
13
11
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
14
12
|
#
|
@@ -19,10 +17,10 @@ require 'awrence'
|
|
19
17
|
class PaymentsClient
|
20
18
|
|
21
19
|
##
|
22
|
-
# Initialize the PaymentsClient class with
|
23
|
-
# @param
|
24
|
-
def initialize(
|
25
|
-
@
|
20
|
+
# Initialize the PaymentsClient class with an API client instance.
|
21
|
+
# @param connection [LockstepApi] The API client object for this connection
|
22
|
+
def initialize(connection)
|
23
|
+
@connection = connection
|
26
24
|
end
|
27
25
|
|
28
26
|
|
@@ -36,7 +34,7 @@ class PaymentsClient
|
|
36
34
|
def retrieve_payment(id:, include_param:)
|
37
35
|
path = "/api/v1/Payments/#{id}"
|
38
36
|
params = {:include => include_param}
|
39
|
-
@
|
37
|
+
@connection.request(:get, path, nil, params)
|
40
38
|
end
|
41
39
|
|
42
40
|
##
|
@@ -50,7 +48,7 @@ class PaymentsClient
|
|
50
48
|
# @param body [object] A list of changes to apply to this Payment
|
51
49
|
def update_payment(id:, body:)
|
52
50
|
path = "/api/v1/Payments/#{id}"
|
53
|
-
@
|
51
|
+
@connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
|
54
52
|
end
|
55
53
|
|
56
54
|
##
|
@@ -61,7 +59,7 @@ class PaymentsClient
|
|
61
59
|
# @param id [uuid] The unique Lockstep Platform ID number of the Payment to delete; NOT the customer's ERP key
|
62
60
|
def delete_payment(id:)
|
63
61
|
path = "/api/v1/Payments/#{id}"
|
64
|
-
@
|
62
|
+
@connection.request(:delete, path, nil, nil)
|
65
63
|
end
|
66
64
|
|
67
65
|
##
|
@@ -72,7 +70,7 @@ class PaymentsClient
|
|
72
70
|
# @param body [PaymentModel] The Payments to create
|
73
71
|
def create_payments(body:)
|
74
72
|
path = "/api/v1/Payments"
|
75
|
-
@
|
73
|
+
@connection.request(:post, path, body, nil)
|
76
74
|
end
|
77
75
|
|
78
76
|
##
|
@@ -90,7 +88,7 @@ class PaymentsClient
|
|
90
88
|
def query_payments(filter:, include_param:, order:, page_size:, page_number:)
|
91
89
|
path = "/api/v1/Payments/query"
|
92
90
|
params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
|
93
|
-
@
|
91
|
+
@connection.request(:get, path, nil, params)
|
94
92
|
end
|
95
93
|
|
96
94
|
##
|
@@ -101,7 +99,7 @@ class PaymentsClient
|
|
101
99
|
# @param id [uuid] The unique Lockstep Platform ID number of this payment; NOT the customer's ERP key
|
102
100
|
def retrieve_payment_pdf(id:)
|
103
101
|
path = "/api/v1/Payments/#{id}/pdf"
|
104
|
-
@
|
102
|
+
@connection.request(:get, path, nil, nil)
|
105
103
|
end
|
106
104
|
|
107
105
|
##
|
@@ -119,7 +117,7 @@ class PaymentsClient
|
|
119
117
|
def query_payment_summary_view(filter:, include_param:, order:, page_size:, page_number:)
|
120
118
|
path = "/api/v1/Payments/views/summary"
|
121
119
|
params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
|
122
|
-
@
|
120
|
+
@connection.request(:get, path, nil, params)
|
123
121
|
end
|
124
122
|
|
125
123
|
##
|
@@ -127,7 +125,7 @@ class PaymentsClient
|
|
127
125
|
#
|
128
126
|
def retrieve_payment_detail_header()
|
129
127
|
path = "/api/v1/Payments/views/detail-header"
|
130
|
-
@
|
128
|
+
@connection.request(:get, path, nil, nil)
|
131
129
|
end
|
132
130
|
|
133
131
|
##
|
@@ -143,6 +141,6 @@ class PaymentsClient
|
|
143
141
|
def query_payment_detail_view(filter:, include_param:, order:, page_size:, page_number:)
|
144
142
|
path = "/api/v1/Payments/views/detail"
|
145
143
|
params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
|
146
|
-
@
|
144
|
+
@connection.request(:get, path, nil, params)
|
147
145
|
end
|
148
146
|
end
|
@@ -1,14 +1,12 @@
|
|
1
1
|
#
|
2
|
-
# Lockstep
|
2
|
+
# Lockstep Platform SDK for Ruby
|
3
3
|
#
|
4
4
|
# (c) 2021-2022 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
|
-
# @author
|
10
|
-
# @author Manish Narayan B S <manish.n@lockstep.io>
|
11
|
-
# @author Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
|
9
|
+
# @author Lockstep Network <support@lockstep.io>
|
12
10
|
# @copyright 2021-2022 Lockstep, Inc.
|
13
11
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
14
12
|
#
|
@@ -19,10 +17,10 @@ require 'awrence'
|
|
19
17
|
class ProvisioningClient
|
20
18
|
|
21
19
|
##
|
22
|
-
# Initialize the ProvisioningClient class with
|
23
|
-
# @param
|
24
|
-
def initialize(
|
25
|
-
@
|
20
|
+
# Initialize the ProvisioningClient class with an API client instance.
|
21
|
+
# @param connection [LockstepApi] The API client object for this connection
|
22
|
+
def initialize(connection)
|
23
|
+
@connection = connection
|
26
24
|
end
|
27
25
|
|
28
26
|
|
@@ -32,7 +30,7 @@ class ProvisioningClient
|
|
32
30
|
# @param body [ProvisioningModel] Represents a User and their related metadata
|
33
31
|
def provision_user_account(body:)
|
34
32
|
path = "/api/v1/Provisioning"
|
35
|
-
@
|
33
|
+
@connection.request(:post, path, body, nil)
|
36
34
|
end
|
37
35
|
|
38
36
|
##
|
@@ -41,7 +39,7 @@ class ProvisioningClient
|
|
41
39
|
# @param body [ProvisioningFinalizeRequestModel] Represents a User and their related metadata
|
42
40
|
def finalize_user_account_provisioning(body:)
|
43
41
|
path = "/api/v1/Provisioning/finalize"
|
44
|
-
@
|
42
|
+
@connection.request(:post, path, body, nil)
|
45
43
|
end
|
46
44
|
|
47
45
|
##
|
@@ -49,6 +47,6 @@ class ProvisioningClient
|
|
49
47
|
# @param body [DeveloperAccountSubmitModel]
|
50
48
|
def provision_free_developer_account(body:)
|
51
49
|
path = "/api/v1/Provisioning/free-account"
|
52
|
-
@
|
50
|
+
@connection.request(:post, path, body, nil)
|
53
51
|
end
|
54
52
|
end
|
@@ -1,14 +1,12 @@
|
|
1
1
|
#
|
2
|
-
# Lockstep
|
2
|
+
# Lockstep Platform SDK for Ruby
|
3
3
|
#
|
4
4
|
# (c) 2021-2022 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
|
-
# @author
|
10
|
-
# @author Manish Narayan B S <manish.n@lockstep.io>
|
11
|
-
# @author Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
|
9
|
+
# @author Lockstep Network <support@lockstep.io>
|
12
10
|
# @copyright 2021-2022 Lockstep, Inc.
|
13
11
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
14
12
|
#
|
@@ -19,10 +17,10 @@ require 'awrence'
|
|
19
17
|
class ReportsClient
|
20
18
|
|
21
19
|
##
|
22
|
-
# Initialize the ReportsClient class with
|
23
|
-
# @param
|
24
|
-
def initialize(
|
25
|
-
@
|
20
|
+
# Initialize the ReportsClient class with an API client instance.
|
21
|
+
# @param connection [LockstepApi] The API client object for this connection
|
22
|
+
def initialize(connection)
|
23
|
+
@connection = connection
|
26
24
|
end
|
27
25
|
|
28
26
|
|
@@ -35,7 +33,7 @@ class ReportsClient
|
|
35
33
|
def cash_flow(timeframe:)
|
36
34
|
path = "/api/v1/Reports/cashflow"
|
37
35
|
params = {:timeframe => timeframe}
|
38
|
-
@
|
36
|
+
@connection.request(:get, path, nil, params)
|
39
37
|
end
|
40
38
|
|
41
39
|
##
|
@@ -45,7 +43,7 @@ class ReportsClient
|
|
45
43
|
#
|
46
44
|
def daily_sales_outstanding()
|
47
45
|
path = "/api/v1/Reports/dailysalesoutstanding"
|
48
|
-
@
|
46
|
+
@connection.request(:get, path, nil, nil)
|
49
47
|
end
|
50
48
|
|
51
49
|
##
|
@@ -55,7 +53,7 @@ class ReportsClient
|
|
55
53
|
#
|
56
54
|
def risk_rates()
|
57
55
|
path = "/api/v1/Reports/riskrates"
|
58
|
-
@
|
56
|
+
@connection.request(:get, path, nil, nil)
|
59
57
|
end
|
60
58
|
|
61
59
|
##
|
@@ -66,7 +64,7 @@ class ReportsClient
|
|
66
64
|
def accounts_receivable_header(report_date:, company_id:)
|
67
65
|
path = "/api/v1/Reports/ar-header"
|
68
66
|
params = {:reportDate => report_date, :companyId => company_id}
|
69
|
-
@
|
67
|
+
@connection.request(:get, path, nil, params)
|
70
68
|
end
|
71
69
|
|
72
70
|
##
|
@@ -86,7 +84,7 @@ class ReportsClient
|
|
86
84
|
def invoice_aging_report(company_id:, recalculate:, currency_code:, currency_provider:, buckets:)
|
87
85
|
path = "/api/v1/Reports/aging"
|
88
86
|
params = {:CompanyId => company_id, :Recalculate => recalculate, :CurrencyCode => currency_code, :CurrencyProvider => currency_provider, :Buckets => buckets}
|
89
|
-
@
|
87
|
+
@connection.request(:get, path, nil, params)
|
90
88
|
end
|
91
89
|
|
92
90
|
##
|
@@ -96,7 +94,7 @@ class ReportsClient
|
|
96
94
|
#
|
97
95
|
def accounts_receivable_aging_header()
|
98
96
|
path = "/api/v1/Reports/ar-aging-header"
|
99
|
-
@
|
97
|
+
@connection.request(:get, path, nil, nil)
|
100
98
|
end
|
101
99
|
|
102
100
|
##
|
@@ -108,7 +106,7 @@ class ReportsClient
|
|
108
106
|
def attachments_header_information(company_id:)
|
109
107
|
path = "/api/v1/Reports/attachments-header"
|
110
108
|
params = {:companyId => company_id}
|
111
|
-
@
|
109
|
+
@connection.request(:get, path, nil, params)
|
112
110
|
end
|
113
111
|
|
114
112
|
##
|
@@ -119,7 +117,7 @@ class ReportsClient
|
|
119
117
|
def trial_balance_report(start_date:, end_date:)
|
120
118
|
path = "/api/v1/Reports/trial-balance"
|
121
119
|
params = {:startDate => start_date, :endDate => end_date}
|
122
|
-
@
|
120
|
+
@connection.request(:get, path, nil, params)
|
123
121
|
end
|
124
122
|
|
125
123
|
##
|
@@ -135,6 +133,22 @@ class ReportsClient
|
|
135
133
|
def income_statement_report(start_date:, end_date:, column_option:, display_depth:, comparison_period:, show_currency_difference:, show_percentage_difference:)
|
136
134
|
path = "/api/v1/Reports/income-statement"
|
137
135
|
params = {:startDate => start_date, :endDate => end_date, :columnOption => column_option, :displayDepth => display_depth, :comparisonPeriod => comparison_period, :showCurrencyDifference => show_currency_difference, :showPercentageDifference => show_percentage_difference}
|
138
|
-
@
|
136
|
+
@connection.request(:get, path, nil, params)
|
137
|
+
end
|
138
|
+
|
139
|
+
##
|
140
|
+
# Generates a balance sheet for the given time range.
|
141
|
+
#
|
142
|
+
# @param start_date [date-time] The start date of the report
|
143
|
+
# @param end_date [date-time] The end date of the report
|
144
|
+
# @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
|
145
|
+
# @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
|
146
|
+
# @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)
|
147
|
+
# @param show_currency_difference [boolean] A boolean to turn on a currency based difference between the reporting period and the comparison period.
|
148
|
+
# @param show_percentage_difference [boolean] A boolean to turn on a percent based difference between the reporting period and the comparison period.
|
149
|
+
def balance_sheet_report(start_date:, end_date:, column_option:, display_depth:, comparison_period:, show_currency_difference:, show_percentage_difference:)
|
150
|
+
path = "/api/v1/Reports/balance-sheet"
|
151
|
+
params = {:startDate => start_date, :endDate => end_date, :columnOption => column_option, :displayDepth => display_depth, :comparisonPeriod => comparison_period, :showCurrencyDifference => show_currency_difference, :showPercentageDifference => show_percentage_difference}
|
152
|
+
@connection.request(:get, path, nil, params)
|
139
153
|
end
|
140
154
|
end
|
@@ -1,14 +1,12 @@
|
|
1
1
|
#
|
2
|
-
# Lockstep
|
2
|
+
# Lockstep Platform SDK for Ruby
|
3
3
|
#
|
4
4
|
# (c) 2021-2022 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
|
-
# @author
|
10
|
-
# @author Manish Narayan B S <manish.n@lockstep.io>
|
11
|
-
# @author Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
|
9
|
+
# @author Lockstep Network <support@lockstep.io>
|
12
10
|
# @copyright 2021-2022 Lockstep, Inc.
|
13
11
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
14
12
|
#
|
@@ -19,10 +17,10 @@ require 'awrence'
|
|
19
17
|
class StatusClient
|
20
18
|
|
21
19
|
##
|
22
|
-
# Initialize the StatusClient class with
|
23
|
-
# @param
|
24
|
-
def initialize(
|
25
|
-
@
|
20
|
+
# Initialize the StatusClient class with an API client instance.
|
21
|
+
# @param connection [LockstepApi] The API client object for this connection
|
22
|
+
def initialize(connection)
|
23
|
+
@connection = connection
|
26
24
|
end
|
27
25
|
|
28
26
|
|
@@ -33,7 +31,7 @@ class StatusClient
|
|
33
31
|
#
|
34
32
|
def ping()
|
35
33
|
path = "/api/v1/Status"
|
36
|
-
@
|
34
|
+
@connection.request(:get, path, nil, nil)
|
37
35
|
end
|
38
36
|
|
39
37
|
##
|
@@ -47,6 +45,6 @@ class StatusClient
|
|
47
45
|
def error_test(err:)
|
48
46
|
path = "/api/v1/Status/testing"
|
49
47
|
params = {:err => err}
|
50
|
-
@
|
48
|
+
@connection.request(:get, path, nil, params)
|
51
49
|
end
|
52
50
|
end
|
@@ -1,14 +1,12 @@
|
|
1
1
|
#
|
2
|
-
# Lockstep
|
2
|
+
# Lockstep Platform SDK for Ruby
|
3
3
|
#
|
4
4
|
# (c) 2021-2022 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
|
-
# @author
|
10
|
-
# @author Manish Narayan B S <manish.n@lockstep.io>
|
11
|
-
# @author Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
|
9
|
+
# @author Lockstep Network <support@lockstep.io>
|
12
10
|
# @copyright 2021-2022 Lockstep, Inc.
|
13
11
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
14
12
|
#
|
@@ -19,10 +17,10 @@ require 'awrence'
|
|
19
17
|
class SyncClient
|
20
18
|
|
21
19
|
##
|
22
|
-
# Initialize the SyncClient class with
|
23
|
-
# @param
|
24
|
-
def initialize(
|
25
|
-
@
|
20
|
+
# Initialize the SyncClient class with an API client instance.
|
21
|
+
# @param connection [LockstepApi] The API client object for this connection
|
22
|
+
def initialize(connection)
|
23
|
+
@connection = connection
|
26
24
|
end
|
27
25
|
|
28
26
|
|
@@ -34,7 +32,7 @@ class SyncClient
|
|
34
32
|
# @param body [SyncSubmitModel] Information about the Sync to execute
|
35
33
|
def create_sync(body:)
|
36
34
|
path = "/api/v1/Sync"
|
37
|
-
@
|
35
|
+
@connection.request(:post, path, body, nil)
|
38
36
|
end
|
39
37
|
|
40
38
|
##
|
@@ -47,7 +45,7 @@ class SyncClient
|
|
47
45
|
# @param body [BatchSyncModel] Information about the Sync to execute
|
48
46
|
def create_batch_import(body:)
|
49
47
|
path = "/api/v1/Sync/batch"
|
50
|
-
@
|
48
|
+
@connection.request(:post, path, body, nil)
|
51
49
|
end
|
52
50
|
|
53
51
|
##
|
@@ -58,7 +56,7 @@ class SyncClient
|
|
58
56
|
# @param filename [File] The full path of a file to upload to the API
|
59
57
|
def upload_sync_file(filename:)
|
60
58
|
path = "/api/v1/Sync/zip"
|
61
|
-
@
|
59
|
+
@connection.request(:post, path, nil, nil)
|
62
60
|
end
|
63
61
|
|
64
62
|
##
|
@@ -74,7 +72,7 @@ class SyncClient
|
|
74
72
|
# @param body [object] A list of changes to apply to this Application
|
75
73
|
def update_sync(id:, body:)
|
76
74
|
path = "/api/v1/Sync/#{id}"
|
77
|
-
@
|
75
|
+
@connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
|
78
76
|
end
|
79
77
|
|
80
78
|
##
|
@@ -87,7 +85,7 @@ class SyncClient
|
|
87
85
|
def retrieve_sync(id:, include_param:)
|
88
86
|
path = "/api/v1/Sync/#{id}"
|
89
87
|
params = {:include => include_param}
|
90
|
-
@
|
88
|
+
@connection.request(:get, path, nil, params)
|
91
89
|
end
|
92
90
|
|
93
91
|
##
|
@@ -98,7 +96,7 @@ class SyncClient
|
|
98
96
|
# @param id [uuid] The unique ID number of the Sync task to cancel
|
99
97
|
def cancel_sync(id:)
|
100
98
|
path = "/api/v1/Sync/#{id}"
|
101
|
-
@
|
99
|
+
@connection.request(:delete, path, nil, nil)
|
102
100
|
end
|
103
101
|
|
104
102
|
##
|
@@ -116,6 +114,6 @@ class SyncClient
|
|
116
114
|
def query_syncs(filter:, include_param:, order:, page_size:, page_number:)
|
117
115
|
path = "/api/v1/Sync/query"
|
118
116
|
params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
|
119
|
-
@
|
117
|
+
@connection.request(:get, path, nil, params)
|
120
118
|
end
|
121
119
|
end
|
@@ -1,14 +1,12 @@
|
|
1
1
|
#
|
2
|
-
# Lockstep
|
2
|
+
# Lockstep Platform SDK for Ruby
|
3
3
|
#
|
4
4
|
# (c) 2021-2022 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
|
-
# @author
|
10
|
-
# @author Manish Narayan B S <manish.n@lockstep.io>
|
11
|
-
# @author Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
|
9
|
+
# @author Lockstep Network <support@lockstep.io>
|
12
10
|
# @copyright 2021-2022 Lockstep, Inc.
|
13
11
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
14
12
|
#
|
@@ -19,10 +17,10 @@ require 'awrence'
|
|
19
17
|
class UserAccountsClient
|
20
18
|
|
21
19
|
##
|
22
|
-
# Initialize the UserAccountsClient class with
|
23
|
-
# @param
|
24
|
-
def initialize(
|
25
|
-
@
|
20
|
+
# Initialize the UserAccountsClient class with an API client instance.
|
21
|
+
# @param connection [LockstepApi] The API client object for this connection
|
22
|
+
def initialize(connection)
|
23
|
+
@connection = connection
|
26
24
|
end
|
27
25
|
|
28
26
|
|
@@ -36,7 +34,7 @@ class UserAccountsClient
|
|
36
34
|
def retrieve_user(id:, include_param:)
|
37
35
|
path = "/api/v1/UserAccounts/#{id}"
|
38
36
|
params = {:include => include_param}
|
39
|
-
@
|
37
|
+
@connection.request(:get, path, nil, params)
|
40
38
|
end
|
41
39
|
|
42
40
|
##
|
@@ -50,7 +48,7 @@ class UserAccountsClient
|
|
50
48
|
# @param body [object] A list of changes to apply to this User
|
51
49
|
def update_user(id:, body:)
|
52
50
|
path = "/api/v1/UserAccounts/#{id}"
|
53
|
-
@
|
51
|
+
@connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
|
54
52
|
end
|
55
53
|
|
56
54
|
##
|
@@ -61,7 +59,7 @@ class UserAccountsClient
|
|
61
59
|
# @param id [uuid] The unique Lockstep Platform ID number of this User
|
62
60
|
def disable_user(id:)
|
63
61
|
path = "/api/v1/UserAccounts/#{id}"
|
64
|
-
@
|
62
|
+
@connection.request(:delete, path, nil, nil)
|
65
63
|
end
|
66
64
|
|
67
65
|
##
|
@@ -73,7 +71,7 @@ class UserAccountsClient
|
|
73
71
|
def reenable_user(id:)
|
74
72
|
path = "/api/v1/UserAccounts/reenable"
|
75
73
|
params = {:id => id}
|
76
|
-
@
|
74
|
+
@connection.request(:post, path, nil, params)
|
77
75
|
end
|
78
76
|
|
79
77
|
##
|
@@ -84,7 +82,7 @@ class UserAccountsClient
|
|
84
82
|
# @param body [InviteSubmitModel] The user to invite
|
85
83
|
def invite_user(body:)
|
86
84
|
path = "/api/v1/UserAccounts/invite"
|
87
|
-
@
|
85
|
+
@connection.request(:post, path, body, nil)
|
88
86
|
end
|
89
87
|
|
90
88
|
##
|
@@ -96,7 +94,7 @@ class UserAccountsClient
|
|
96
94
|
def retrieve_invite_data(code:)
|
97
95
|
path = "/api/v1/UserAccounts/invite"
|
98
96
|
params = {:code => code}
|
99
|
-
@
|
97
|
+
@connection.request(:get, path, nil, params)
|
100
98
|
end
|
101
99
|
|
102
100
|
##
|
@@ -107,7 +105,7 @@ class UserAccountsClient
|
|
107
105
|
# @param body [TransferOwnerSubmitModel]
|
108
106
|
def transfer_owner(body:)
|
109
107
|
path = "/api/v1/UserAccounts/transfer-owner"
|
110
|
-
@
|
108
|
+
@connection.request(:post, path, body, nil)
|
111
109
|
end
|
112
110
|
|
113
111
|
##
|
@@ -121,6 +119,6 @@ class UserAccountsClient
|
|
121
119
|
def query_users(filter:, include_param:, order:, page_size:, page_number:)
|
122
120
|
path = "/api/v1/UserAccounts/query"
|
123
121
|
params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
|
124
|
-
@
|
122
|
+
@connection.request(:get, path, nil, params)
|
125
123
|
end
|
126
124
|
end
|
@@ -1,14 +1,12 @@
|
|
1
1
|
#
|
2
|
-
# Lockstep
|
2
|
+
# Lockstep Platform SDK for Ruby
|
3
3
|
#
|
4
4
|
# (c) 2021-2022 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
|
-
# @author
|
10
|
-
# @author Manish Narayan B S <manish.n@lockstep.io>
|
11
|
-
# @author Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
|
9
|
+
# @author Lockstep Network <support@lockstep.io>
|
12
10
|
# @copyright 2021-2022 Lockstep, Inc.
|
13
11
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
14
12
|
#
|
@@ -19,10 +17,10 @@ require 'awrence'
|
|
19
17
|
class UserRolesClient
|
20
18
|
|
21
19
|
##
|
22
|
-
# Initialize the UserRolesClient class with
|
23
|
-
# @param
|
24
|
-
def initialize(
|
25
|
-
@
|
20
|
+
# Initialize the UserRolesClient class with an API client instance.
|
21
|
+
# @param connection [LockstepApi] The API client object for this connection
|
22
|
+
def initialize(connection)
|
23
|
+
@connection = connection
|
26
24
|
end
|
27
25
|
|
28
26
|
|
@@ -34,7 +32,7 @@ class UserRolesClient
|
|
34
32
|
def retrieve_user_role(id:, include_param:)
|
35
33
|
path = "/api/v1/UserRoles/#{id}"
|
36
34
|
params = {:include => include_param}
|
37
|
-
@
|
35
|
+
@connection.request(:get, path, nil, params)
|
38
36
|
end
|
39
37
|
|
40
38
|
##
|
@@ -48,6 +46,6 @@ class UserRolesClient
|
|
48
46
|
def query_user_roles(filter:, include_param:, order:, page_size:, page_number:)
|
49
47
|
path = "/api/v1/UserRoles/query"
|
50
48
|
params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
|
51
|
-
@
|
49
|
+
@connection.request(:get, path, nil, params)
|
52
50
|
end
|
53
51
|
end
|
@@ -1,14 +1,12 @@
|
|
1
1
|
#
|
2
|
-
# Lockstep
|
2
|
+
# Lockstep Platform SDK for Ruby
|
3
3
|
#
|
4
4
|
# (c) 2021-2022 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
|
-
# @author
|
10
|
-
# @author Manish Narayan B S <manish.n@lockstep.io>
|
11
|
-
# @author Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
|
9
|
+
# @author Lockstep Network <support@lockstep.io>
|
12
10
|
# @copyright 2021-2022 Lockstep, Inc.
|
13
11
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
14
12
|
#
|
@@ -19,10 +17,10 @@ require 'awrence'
|
|
19
17
|
class WebhooksClient
|
20
18
|
|
21
19
|
##
|
22
|
-
# Initialize the WebhooksClient class with
|
23
|
-
# @param
|
24
|
-
def initialize(
|
25
|
-
@
|
20
|
+
# Initialize the WebhooksClient class with an API client instance.
|
21
|
+
# @param connection [LockstepApi] The API client object for this connection
|
22
|
+
def initialize(connection)
|
23
|
+
@connection = connection
|
26
24
|
end
|
27
25
|
|
28
26
|
|
@@ -32,7 +30,7 @@ class WebhooksClient
|
|
32
30
|
# @param id [uuid] The unique Lockstep Platform ID number of this Webhook
|
33
31
|
def retrieve_webhook(id:)
|
34
32
|
path = "/api/v1/Webhooks/#{id}"
|
35
|
-
@
|
33
|
+
@connection.request(:get, path, nil, nil)
|
36
34
|
end
|
37
35
|
|
38
36
|
##
|
@@ -44,7 +42,7 @@ class WebhooksClient
|
|
44
42
|
# @param body [object] A list of changes to apply to this Webhook
|
45
43
|
def update_webhook(id:, body:)
|
46
44
|
path = "/api/v1/Webhooks/#{id}"
|
47
|
-
@
|
45
|
+
@connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
|
48
46
|
end
|
49
47
|
|
50
48
|
##
|
@@ -53,7 +51,7 @@ class WebhooksClient
|
|
53
51
|
# @param id [uuid] The unique Lockstep Platform ID number of the Webhook to delete.
|
54
52
|
def delete_webhook(id:)
|
55
53
|
path = "/api/v1/Webhooks/#{id}"
|
56
|
-
@
|
54
|
+
@connection.request(:delete, path, nil, nil)
|
57
55
|
end
|
58
56
|
|
59
57
|
##
|
@@ -62,7 +60,7 @@ class WebhooksClient
|
|
62
60
|
# @param body [WebhookModel] The Webhooks to create
|
63
61
|
def create_webhooks(body:)
|
64
62
|
path = "/api/v1/Webhooks"
|
65
|
-
@
|
63
|
+
@connection.request(:post, path, body, nil)
|
66
64
|
end
|
67
65
|
|
68
66
|
##
|
@@ -71,7 +69,7 @@ class WebhooksClient
|
|
71
69
|
# @param id [uuid] The unique Lockstep Platform ID number of the Webhook to update.
|
72
70
|
def regenerate_client_secret(id:)
|
73
71
|
path = "/api/v1/Webhooks/#{id}/regenerateclientsecret"
|
74
|
-
@
|
72
|
+
@connection.request(:patch, path, nil, nil)
|
75
73
|
end
|
76
74
|
|
77
75
|
##
|
@@ -86,7 +84,7 @@ class WebhooksClient
|
|
86
84
|
def query_webhooks(filter:, order:, page_size:, page_number:)
|
87
85
|
path = "/api/v1/Webhooks/query"
|
88
86
|
params = {:filter => filter, :order => order, :pageSize => page_size, :pageNumber => page_number}
|
89
|
-
@
|
87
|
+
@connection.request(:get, path, nil, params)
|
90
88
|
end
|
91
89
|
|
92
90
|
##
|
@@ -100,6 +98,6 @@ class WebhooksClient
|
|
100
98
|
def query_webhook_history(webhook_id:, filter:, select:, page_size:, page_number:)
|
101
99
|
path = "/api/v1/Webhooks/#{webhookId}/history/query"
|
102
100
|
params = {:filter => filter, :select => select, :pageSize => page_size, :pageNumber => page_number}
|
103
|
-
@
|
101
|
+
@connection.request(:get, path, nil, params)
|
104
102
|
end
|
105
103
|
end
|