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
@@ -1,15 +1,15 @@
|
|
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
10
|
# Manish Narayan B S <manish.n@lockstep.io>, Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
|
11
|
-
# @copyright 2021-
|
12
|
-
# @version
|
11
|
+
# @copyright 2021-2023 Lockstep, Inc.
|
12
|
+
# @version 2023.1.3
|
13
13
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
14
14
|
#
|
15
15
|
|
@@ -32,10 +32,6 @@ module lockstep_sdk
|
|
32
32
|
# @return [String] The name or URL of the environment
|
33
33
|
attr_accessor :env
|
34
34
|
|
35
|
-
##
|
36
|
-
# @return [ActivitiesClient] Client object for Activities endpoints
|
37
|
-
attr_accessor :activities
|
38
|
-
|
39
35
|
##
|
40
36
|
# @return [ApiKeysClient] Client object for ApiKeys endpoints
|
41
37
|
attr_accessor :api_keys
|
@@ -65,8 +61,8 @@ module lockstep_sdk
|
|
65
61
|
attr_accessor :contacts
|
66
62
|
|
67
63
|
##
|
68
|
-
# @return [
|
69
|
-
attr_accessor :
|
64
|
+
# @return [CreditMemosAppliedClient] Client object for CreditMemosApplied endpoints
|
65
|
+
attr_accessor :credit_memos_applied
|
70
66
|
|
71
67
|
##
|
72
68
|
# @return [CurrenciesClient] Client object for Currencies endpoints
|
@@ -85,8 +81,8 @@ module lockstep_sdk
|
|
85
81
|
attr_accessor :definitions
|
86
82
|
|
87
83
|
##
|
88
|
-
# @return [
|
89
|
-
attr_accessor :
|
84
|
+
# @return [FeatureFlagsClient] Client object for FeatureFlags endpoints
|
85
|
+
attr_accessor :feature_flags
|
90
86
|
|
91
87
|
##
|
92
88
|
# @return [FinancialAccountClient] Client object for FinancialAccount endpoints
|
@@ -104,10 +100,18 @@ module lockstep_sdk
|
|
104
100
|
# @return [GroupAccountsClient] Client object for GroupAccounts endpoints
|
105
101
|
attr_accessor :group_accounts
|
106
102
|
|
103
|
+
##
|
104
|
+
# @return [InvoiceAddressesClient] Client object for InvoiceAddresses endpoints
|
105
|
+
attr_accessor :invoice_addresses
|
106
|
+
|
107
107
|
##
|
108
108
|
# @return [InvoiceHistoryClient] Client object for InvoiceHistory endpoints
|
109
109
|
attr_accessor :invoice_history
|
110
110
|
|
111
|
+
##
|
112
|
+
# @return [InvoiceLinesClient] Client object for InvoiceLines endpoints
|
113
|
+
attr_accessor :invoice_lines
|
114
|
+
|
111
115
|
##
|
112
116
|
# @return [InvoicesClient] Client object for Invoices endpoints
|
113
117
|
attr_accessor :invoices
|
@@ -117,20 +121,32 @@ module lockstep_sdk
|
|
117
121
|
attr_accessor :leads
|
118
122
|
|
119
123
|
##
|
120
|
-
# @return [
|
121
|
-
attr_accessor :
|
124
|
+
# @return [MagicLinksClient] Client object for MagicLinks endpoints
|
125
|
+
attr_accessor :magic_links
|
122
126
|
|
123
127
|
##
|
124
|
-
# @return [
|
125
|
-
attr_accessor :
|
128
|
+
# @return [NotesClient] Client object for Notes endpoints
|
129
|
+
attr_accessor :notes
|
126
130
|
|
127
131
|
##
|
128
132
|
# @return [PaymentsClient] Client object for Payments endpoints
|
129
133
|
attr_accessor :payments
|
130
134
|
|
131
135
|
##
|
132
|
-
# @return [
|
133
|
-
attr_accessor :
|
136
|
+
# @return [PaymentsAppliedClient] Client object for PaymentsApplied endpoints
|
137
|
+
attr_accessor :payments_applied
|
138
|
+
|
139
|
+
##
|
140
|
+
# @return [ProfilesAccountingClient] Client object for ProfilesAccounting endpoints
|
141
|
+
attr_accessor :profiles_accounting
|
142
|
+
|
143
|
+
##
|
144
|
+
# @return [ProfilesAccountingContactsClient] Client object for ProfilesAccountingContacts endpoints
|
145
|
+
attr_accessor :profiles_accounting_contacts
|
146
|
+
|
147
|
+
##
|
148
|
+
# @return [ProfilesCompaniesClient] Client object for ProfilesCompanies endpoints
|
149
|
+
attr_accessor :profiles_companies
|
134
150
|
|
135
151
|
##
|
136
152
|
# @return [ProvisioningClient] Client object for Provisioning endpoints
|
@@ -148,6 +164,14 @@ module lockstep_sdk
|
|
148
164
|
# @return [SyncClient] Client object for Sync endpoints
|
149
165
|
attr_accessor :sync
|
150
166
|
|
167
|
+
##
|
168
|
+
# @return [TransactionsClient] Client object for Transactions endpoints
|
169
|
+
attr_accessor :transactions
|
170
|
+
|
171
|
+
##
|
172
|
+
# @return [TranscriptionsClient] Client object for Transcriptions endpoints
|
173
|
+
attr_accessor :transcriptions
|
174
|
+
|
151
175
|
##
|
152
176
|
# @return [UserAccountsClient] Client object for UserAccounts endpoints
|
153
177
|
attr_accessor :user_accounts
|
@@ -170,7 +194,7 @@ module lockstep_sdk
|
|
170
194
|
#
|
171
195
|
# @param env [string] Either "sbx", "prd", or the URI of the server, ending in a slash (/)
|
172
196
|
def initialize(env)
|
173
|
-
@version = "
|
197
|
+
@version = "2023.1.3.0"
|
174
198
|
@env = case env
|
175
199
|
when "sbx"
|
176
200
|
"https://api.sbx.lockstep.io/"
|
@@ -181,7 +205,6 @@ module lockstep_sdk
|
|
181
205
|
end
|
182
206
|
|
183
207
|
# Construct all the clients
|
184
|
-
@activities = ActivitiesClient.new(self)
|
185
208
|
@api_keys = ApiKeysClient.new(self)
|
186
209
|
@app_enrollments = AppEnrollmentsClient.new(self)
|
187
210
|
@applications = ApplicationsClient.new(self)
|
@@ -189,27 +212,34 @@ module lockstep_sdk
|
|
189
212
|
@code_definitions = CodeDefinitionsClient.new(self)
|
190
213
|
@companies = CompaniesClient.new(self)
|
191
214
|
@contacts = ContactsClient.new(self)
|
192
|
-
@
|
215
|
+
@credit_memos_applied = CreditMemosAppliedClient.new(self)
|
193
216
|
@currencies = CurrenciesClient.new(self)
|
194
217
|
@custom_field_definitions = CustomFieldDefinitionsClient.new(self)
|
195
218
|
@custom_field_values = CustomFieldValuesClient.new(self)
|
196
219
|
@definitions = DefinitionsClient.new(self)
|
197
|
-
@
|
220
|
+
@feature_flags = FeatureFlagsClient.new(self)
|
198
221
|
@financial_account = FinancialAccountClient.new(self)
|
199
222
|
@financial_account_balance_history = FinancialAccountBalanceHistoryClient.new(self)
|
200
223
|
@financial_year_settings = FinancialYearSettingsClient.new(self)
|
201
224
|
@group_accounts = GroupAccountsClient.new(self)
|
225
|
+
@invoice_addresses = InvoiceAddressesClient.new(self)
|
202
226
|
@invoice_history = InvoiceHistoryClient.new(self)
|
227
|
+
@invoice_lines = InvoiceLinesClient.new(self)
|
203
228
|
@invoices = InvoicesClient.new(self)
|
204
229
|
@leads = LeadsClient.new(self)
|
230
|
+
@magic_links = MagicLinksClient.new(self)
|
205
231
|
@notes = NotesClient.new(self)
|
206
|
-
@payment_applications = PaymentApplicationsClient.new(self)
|
207
232
|
@payments = PaymentsClient.new(self)
|
208
|
-
@
|
233
|
+
@payments_applied = PaymentsAppliedClient.new(self)
|
234
|
+
@profiles_accounting = ProfilesAccountingClient.new(self)
|
235
|
+
@profiles_accounting_contacts = ProfilesAccountingContactsClient.new(self)
|
236
|
+
@profiles_companies = ProfilesCompaniesClient.new(self)
|
209
237
|
@provisioning = ProvisioningClient.new(self)
|
210
238
|
@reports = ReportsClient.new(self)
|
211
239
|
@status = StatusClient.new(self)
|
212
240
|
@sync = SyncClient.new(self)
|
241
|
+
@transactions = TransactionsClient.new(self)
|
242
|
+
@transcriptions = TranscriptionsClient.new(self)
|
213
243
|
@user_accounts = UserAccountsClient.new(self)
|
214
244
|
@user_roles = UserRolesClient.new(self)
|
215
245
|
@webhook_rules = WebhookRulesClient.new(self)
|
@@ -277,7 +307,7 @@ module lockstep_sdk
|
|
277
307
|
request["Accept"] = 'application/json'
|
278
308
|
request["Content-Type"] = 'application/*+json'
|
279
309
|
request["SdkType"] = 'Ruby'
|
280
|
-
request["SdkVersion"] = '
|
310
|
+
request["SdkVersion"] = '2023.1.3.0'
|
281
311
|
request["MachineName"] = Socket.gethostname
|
282
312
|
request.body = body
|
283
313
|
|
@@ -0,0 +1,90 @@
|
|
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 'json'
|
16
|
+
|
17
|
+
module LockstepSdk
|
18
|
+
|
19
|
+
##
|
20
|
+
# An Accounting Profile Contact has a link to a Contact that is associated with your company's
|
21
|
+
# Accounting Profile. These Contacts are secondary contacts to the primary that is on the profile.
|
22
|
+
class AccountingProfileContactModel
|
23
|
+
|
24
|
+
##
|
25
|
+
# Initialize the AccountingProfileContactModel using the provided prototype
|
26
|
+
def initialize(params = {})
|
27
|
+
@accounting_profile_contact_id = params.dig(:accounting_profile_contact_id)
|
28
|
+
@accounting_profile_id = params.dig(:accounting_profile_id)
|
29
|
+
@contact_id = params.dig(:contact_id)
|
30
|
+
@group_key = params.dig(:group_key)
|
31
|
+
@created = params.dig(:created)
|
32
|
+
@created_user_id = params.dig(:created_user_id)
|
33
|
+
@modified = params.dig(:modified)
|
34
|
+
@modified_user_id = params.dig(:modified_user_id)
|
35
|
+
end
|
36
|
+
|
37
|
+
##
|
38
|
+
# @return [Uuid] The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.
|
39
|
+
attr_accessor :accounting_profile_contact_id
|
40
|
+
|
41
|
+
##
|
42
|
+
# @return [Uuid] The ID of the profile this contact is belongs to.
|
43
|
+
attr_accessor :accounting_profile_id
|
44
|
+
|
45
|
+
##
|
46
|
+
# @return [Uuid] The ID of the contact that is linked to this profile.
|
47
|
+
attr_accessor :contact_id
|
48
|
+
|
49
|
+
##
|
50
|
+
# @return [Uuid] The GroupKey uniquely identifies a single Lockstep Platform account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created. For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
|
51
|
+
attr_accessor :group_key
|
52
|
+
|
53
|
+
##
|
54
|
+
# @return [Date-time] The date on which this record was created.
|
55
|
+
attr_accessor :created
|
56
|
+
|
57
|
+
##
|
58
|
+
# @return [Uuid] The ID of the user who created this contact.
|
59
|
+
attr_accessor :created_user_id
|
60
|
+
|
61
|
+
##
|
62
|
+
# @return [Date-time] The date on which this record was last modified.
|
63
|
+
attr_accessor :modified
|
64
|
+
|
65
|
+
##
|
66
|
+
# @return [Uuid] The ID of the user who last modified this contact.
|
67
|
+
attr_accessor :modified_user_id
|
68
|
+
|
69
|
+
##
|
70
|
+
# @return [object] This object as a JSON key-value structure
|
71
|
+
def as_json(options={})
|
72
|
+
{
|
73
|
+
'accountingProfileContactId' => @accounting_profile_contact_id,
|
74
|
+
'accountingProfileId' => @accounting_profile_id,
|
75
|
+
'contactId' => @contact_id,
|
76
|
+
'groupKey' => @group_key,
|
77
|
+
'created' => @created,
|
78
|
+
'createdUserId' => @created_user_id,
|
79
|
+
'modified' => @modified,
|
80
|
+
'modifiedUserId' => @modified_user_id,
|
81
|
+
}
|
82
|
+
end
|
83
|
+
|
84
|
+
##
|
85
|
+
# @return [String] This object converted to a JSON string
|
86
|
+
def to_json(*options)
|
87
|
+
"[#{as_json(*options).to_json(*options)}]"
|
88
|
+
end
|
89
|
+
end
|
90
|
+
end
|
@@ -0,0 +1,183 @@
|
|
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 'json'
|
16
|
+
|
17
|
+
module LockstepSdk
|
18
|
+
|
19
|
+
##
|
20
|
+
# An Accounting Profile is a child of a Company Profile, and collectively,
|
21
|
+
# they comprise the identity and necessary information for an accounting team
|
22
|
+
# to work with trading partners, financial institutions, auditors, and others.
|
23
|
+
# You can use Accounting Profiles to define an accounting function by what
|
24
|
+
# the function does and how to interface with the function.
|
25
|
+
class AccountingProfileModel
|
26
|
+
|
27
|
+
##
|
28
|
+
# Initialize the AccountingProfileModel using the provided prototype
|
29
|
+
def initialize(params = {})
|
30
|
+
@accounting_profile_id = params.dig(:accounting_profile_id)
|
31
|
+
@company_id = params.dig(:company_id)
|
32
|
+
@group_key = params.dig(:group_key)
|
33
|
+
@name = params.dig(:name)
|
34
|
+
@type = params.dig(:type)
|
35
|
+
@email_address = params.dig(:email_address)
|
36
|
+
@phone = params.dig(:phone)
|
37
|
+
@address1 = params.dig(:address1)
|
38
|
+
@address2 = params.dig(:address2)
|
39
|
+
@address3 = params.dig(:address3)
|
40
|
+
@city = params.dig(:city)
|
41
|
+
@region = params.dig(:region)
|
42
|
+
@postal_code = params.dig(:postal_code)
|
43
|
+
@country = params.dig(:country)
|
44
|
+
@primary_contact_id = params.dig(:primary_contact_id)
|
45
|
+
@created = params.dig(:created)
|
46
|
+
@created_user_id = params.dig(:created_user_id)
|
47
|
+
@modified = params.dig(:modified)
|
48
|
+
@modified_user_id = params.dig(:modified_user_id)
|
49
|
+
@notes = params.dig(:notes)
|
50
|
+
@attachments = params.dig(:attachments)
|
51
|
+
@custom_field_definitions = params.dig(:custom_field_definitions)
|
52
|
+
@custom_field_values = params.dig(:custom_field_values)
|
53
|
+
end
|
54
|
+
|
55
|
+
##
|
56
|
+
# @return [Uuid] The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.
|
57
|
+
attr_accessor :accounting_profile_id
|
58
|
+
|
59
|
+
##
|
60
|
+
# @return [Uuid] The ID of the company profile to which this accounting profile belongs.
|
61
|
+
attr_accessor :company_id
|
62
|
+
|
63
|
+
##
|
64
|
+
# @return [Uuid] The GroupKey uniquely identifies a single Lockstep Platform account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created. For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
|
65
|
+
attr_accessor :group_key
|
66
|
+
|
67
|
+
##
|
68
|
+
# @return [String] The name of the accounting profile.
|
69
|
+
attr_accessor :name
|
70
|
+
|
71
|
+
##
|
72
|
+
# @return [String] The type of the accounting profile. Some examples include 'AR', 'AP', 'AR+AP', 'General Accounting', 'Treasury', 'Payroll', 'Finance'
|
73
|
+
attr_accessor :type
|
74
|
+
|
75
|
+
##
|
76
|
+
# @return [Email] The email address associated with the accounting profile.
|
77
|
+
attr_accessor :email_address
|
78
|
+
|
79
|
+
##
|
80
|
+
# @return [String] The phone number associated with the accounting profile.
|
81
|
+
attr_accessor :phone
|
82
|
+
|
83
|
+
##
|
84
|
+
# @return [String] The first line of the address.
|
85
|
+
attr_accessor :address1
|
86
|
+
|
87
|
+
##
|
88
|
+
# @return [String] The second line of the address.
|
89
|
+
attr_accessor :address2
|
90
|
+
|
91
|
+
##
|
92
|
+
# @return [String] The third line of the address.
|
93
|
+
attr_accessor :address3
|
94
|
+
|
95
|
+
##
|
96
|
+
# @return [String] The city of the address.
|
97
|
+
attr_accessor :city
|
98
|
+
|
99
|
+
##
|
100
|
+
# @return [String] The state/region of the address.
|
101
|
+
attr_accessor :region
|
102
|
+
|
103
|
+
##
|
104
|
+
# @return [String] The postal/zip code of the address.
|
105
|
+
attr_accessor :postal_code
|
106
|
+
|
107
|
+
##
|
108
|
+
# @return [String] The two character country code of the address.
|
109
|
+
attr_accessor :country
|
110
|
+
|
111
|
+
##
|
112
|
+
# @return [Uuid] The ID of the primary contact with which this accounting profile is associated.
|
113
|
+
attr_accessor :primary_contact_id
|
114
|
+
|
115
|
+
##
|
116
|
+
# @return [Date-time] The date on which this record was created.
|
117
|
+
attr_accessor :created
|
118
|
+
|
119
|
+
##
|
120
|
+
# @return [Uuid] The ID of the user who created this accounting profile.
|
121
|
+
attr_accessor :created_user_id
|
122
|
+
|
123
|
+
##
|
124
|
+
# @return [Date-time] The date on which this record was last modified.
|
125
|
+
attr_accessor :modified
|
126
|
+
|
127
|
+
##
|
128
|
+
# @return [Uuid] The ID of the user who last modified this accounting profile.
|
129
|
+
attr_accessor :modified_user_id
|
130
|
+
|
131
|
+
##
|
132
|
+
# @return [NoteModel] A collection of notes linked to this record. To retrieve this collection, specify `Notes` in the `include` parameter when retrieving data. To create a note, use the [Create Note](https://developer.lockstep.io/reference/post_api-v1-notes) endpoint with the `TableKey` to `AccountingProfile` and the `ObjectKey` set to the `AccountingProfileId` for this record. For more information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
|
133
|
+
attr_accessor :notes
|
134
|
+
|
135
|
+
##
|
136
|
+
# @return [AttachmentModel] A collection of attachments linked to this record. To retrieve this collection, specify `Attachments` in the `include` parameter when retrieving data. To create an attachment, use the [Upload Attachment](https://developer.lockstep.io/reference/post_api-v1-attachments) endpoint with the `TableKey` to `AccountingProfile` and the `ObjectKey` set to the `AccountingProfileId` for this record. For more information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
|
137
|
+
attr_accessor :attachments
|
138
|
+
|
139
|
+
##
|
140
|
+
# @return [CustomFieldDefinitionModel] A collection of custom fields linked to this record. To retrieve this collection, specify `CustomFieldDefinitions` in the `include` parameter when retrieving data. To create a custom field, use the [Create Custom Field](https://developer.lockstep.io/reference/post_api-v1-customfieldvalues) endpoint with the `TableKey` to `AccountingProfile` and the `ObjectKey` set to the `AccountingProfileId` for this record. For more information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
|
141
|
+
attr_accessor :custom_field_definitions
|
142
|
+
|
143
|
+
##
|
144
|
+
# @return [CustomFieldValueModel] A collection of custom fields linked to this record. To retrieve this collection, specify `CustomFieldValues` in the `include` parameter when retrieving data. To create a custom field, use the [Create Custom Field](https://developer.lockstep.io/reference/post_api-v1-customfieldvalues) endpoint with the `TableKey` to `AccountingProfile` and the `ObjectKey` set to the `AccountingProfileId` for this record. For more information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
|
145
|
+
attr_accessor :custom_field_values
|
146
|
+
|
147
|
+
##
|
148
|
+
# @return [object] This object as a JSON key-value structure
|
149
|
+
def as_json(options={})
|
150
|
+
{
|
151
|
+
'accountingProfileId' => @accounting_profile_id,
|
152
|
+
'companyId' => @company_id,
|
153
|
+
'groupKey' => @group_key,
|
154
|
+
'name' => @name,
|
155
|
+
'type' => @type,
|
156
|
+
'emailAddress' => @email_address,
|
157
|
+
'phone' => @phone,
|
158
|
+
'address1' => @address1,
|
159
|
+
'address2' => @address2,
|
160
|
+
'address3' => @address3,
|
161
|
+
'city' => @city,
|
162
|
+
'region' => @region,
|
163
|
+
'postalCode' => @postal_code,
|
164
|
+
'country' => @country,
|
165
|
+
'primaryContactId' => @primary_contact_id,
|
166
|
+
'created' => @created,
|
167
|
+
'createdUserId' => @created_user_id,
|
168
|
+
'modified' => @modified,
|
169
|
+
'modifiedUserId' => @modified_user_id,
|
170
|
+
'notes' => @notes,
|
171
|
+
'attachments' => @attachments,
|
172
|
+
'customFieldDefinitions' => @custom_field_definitions,
|
173
|
+
'customFieldValues' => @custom_field_values,
|
174
|
+
}
|
175
|
+
end
|
176
|
+
|
177
|
+
##
|
178
|
+
# @return [String] This object converted to a JSON string
|
179
|
+
def to_json(*options)
|
180
|
+
"[#{as_json(*options).to_json(*options)}]"
|
181
|
+
end
|
182
|
+
end
|
183
|
+
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
|
|
@@ -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
|
|
@@ -24,6 +24,7 @@ module LockstepSdk
|
|
24
24
|
# Initialize the ApHeaderInfoModel using the provided prototype
|
25
25
|
def initialize(params = {})
|
26
26
|
@group_key = params.dig(:group_key)
|
27
|
+
@base_currency_code = params.dig(:base_currency_code)
|
27
28
|
@report_date = params.dig(:report_date)
|
28
29
|
@report_period = params.dig(:report_period)
|
29
30
|
@total_vendors = params.dig(:total_vendors)
|
@@ -56,6 +57,10 @@ module LockstepSdk
|
|
56
57
|
# @return [Uuid] The GroupKey uniquely identifies a single Lockstep Platform account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created. For more information, see [Accounts and GroupKeys](https://developer.lockstep.io/docs/accounts-and-groupkeys).
|
57
58
|
attr_accessor :group_key
|
58
59
|
|
60
|
+
##
|
61
|
+
# @return [String] The base currency code of the group account
|
62
|
+
attr_accessor :base_currency_code
|
63
|
+
|
59
64
|
##
|
60
65
|
# @return [Date-time] The date of the report
|
61
66
|
attr_accessor :report_date
|
@@ -165,6 +170,7 @@ module LockstepSdk
|
|
165
170
|
def as_json(options={})
|
166
171
|
{
|
167
172
|
'groupKey' => @group_key,
|
173
|
+
'baseCurrencyCode' => @base_currency_code,
|
168
174
|
'reportDate' => @report_date,
|
169
175
|
'reportPeriod' => @report_period,
|
170
176
|
'totalVendors' => @total_vendors,
|
@@ -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
|
|
@@ -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
|
|
@@ -38,6 +38,7 @@ module LockstepSdk
|
|
38
38
|
@modified_user_id = params.dig(:modified_user_id)
|
39
39
|
@cron_settings = params.dig(:cron_settings)
|
40
40
|
@sync_schedule_is_active = params.dig(:sync_schedule_is_active)
|
41
|
+
@is_deleted = params.dig(:is_deleted)
|
41
42
|
@app = params.dig(:app)
|
42
43
|
@custom_field_definitions = params.dig(:custom_field_definitions)
|
43
44
|
@custom_field_values = params.dig(:custom_field_values)
|
@@ -86,6 +87,10 @@ module LockstepSdk
|
|
86
87
|
# @return [Boolean] Flag indicating if the Sync process should be ran on the specified schedule
|
87
88
|
attr_accessor :sync_schedule_is_active
|
88
89
|
|
90
|
+
##
|
91
|
+
# @return [Boolean] Flag indicating if the App Enrollment is currently being deleted from the Platform.
|
92
|
+
attr_accessor :is_deleted
|
93
|
+
|
89
94
|
##
|
90
95
|
# @return [ApplicationModel] The Application to which this AppEnrollment belongs. Contains general name, description, logo, and other metadata about this application. To retrieve this object, specify `App` in the "Include" parameter for your query.
|
91
96
|
attr_accessor :app
|
@@ -124,6 +129,7 @@ module LockstepSdk
|
|
124
129
|
'modifiedUserId' => @modified_user_id,
|
125
130
|
'cronSettings' => @cron_settings,
|
126
131
|
'syncScheduleIsActive' => @sync_schedule_is_active,
|
132
|
+
'isDeleted' => @is_deleted,
|
127
133
|
'app' => @app,
|
128
134
|
'customFieldDefinitions' => @custom_field_definitions,
|
129
135
|
'customFieldValues' => @custom_field_values,
|