lockstep_sdk 2022.4.32.0 → 2022.6.49.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/activities_client.rb +0 -1
- data/lib/lockstep_sdk/clients/api_keys_client.rb +0 -1
- data/lib/lockstep_sdk/clients/app_enrollments_client.rb +0 -1
- data/lib/lockstep_sdk/clients/applications_client.rb +0 -1
- data/lib/lockstep_sdk/clients/attachments_client.rb +2 -2
- data/lib/lockstep_sdk/clients/code_definitions_client.rb +0 -1
- data/lib/lockstep_sdk/clients/companies_client.rb +0 -1
- data/lib/lockstep_sdk/clients/contacts_client.rb +0 -1
- data/lib/lockstep_sdk/clients/credit_memo_applied_client.rb +0 -1
- data/lib/lockstep_sdk/clients/currencies_client.rb +0 -1
- data/lib/lockstep_sdk/clients/custom_field_definitions_client.rb +0 -1
- data/lib/lockstep_sdk/clients/custom_field_values_client.rb +0 -1
- data/lib/lockstep_sdk/clients/definitions_client.rb +0 -1
- data/lib/lockstep_sdk/clients/emails_client.rb +0 -1
- data/lib/lockstep_sdk/clients/invoice_history_client.rb +0 -1
- data/lib/lockstep_sdk/clients/invoices_client.rb +0 -1
- data/lib/lockstep_sdk/clients/leads_client.rb +0 -1
- data/lib/lockstep_sdk/clients/notes_client.rb +0 -1
- data/lib/lockstep_sdk/clients/payment_applications_client.rb +0 -1
- data/lib/lockstep_sdk/clients/payments_client.rb +0 -1
- data/lib/lockstep_sdk/clients/provisioning_client.rb +0 -5
- data/lib/lockstep_sdk/clients/reports_client.rb +0 -1
- data/lib/lockstep_sdk/clients/status_client.rb +0 -1
- data/lib/lockstep_sdk/clients/sync_client.rb +15 -2
- data/lib/lockstep_sdk/clients/user_accounts_client.rb +0 -1
- data/lib/lockstep_sdk/clients/user_roles_client.rb +0 -1
- data/lib/lockstep_sdk/clients/webhooks_client.rb +91 -0
- data/lib/lockstep_sdk/lockstep_api.rb +8 -3
- data/lib/lockstep_sdk/models/activity_model.rb +0 -1
- data/lib/lockstep_sdk/models/activity_stream_item_model.rb +0 -1
- data/lib/lockstep_sdk/models/activity_xref_model.rb +0 -1
- data/lib/lockstep_sdk/models/aging_model.rb +0 -1
- data/lib/lockstep_sdk/models/api_key_model.rb +0 -1
- data/lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb +0 -1
- data/lib/lockstep_sdk/models/app_enrollment_model.rb +0 -1
- data/lib/lockstep_sdk/models/application_model.rb +0 -1
- data/lib/lockstep_sdk/models/ar_aging_header_info_model.rb +0 -1
- data/lib/lockstep_sdk/models/ar_header_info_model.rb +0 -1
- data/lib/lockstep_sdk/models/at_risk_invoice_summary_model.rb +0 -1
- data/lib/lockstep_sdk/models/attachment_header_info_model.rb +0 -1
- data/lib/lockstep_sdk/models/attachment_model.rb +12 -1
- data/lib/lockstep_sdk/models/batch_sync_model.rb +99 -0
- data/lib/lockstep_sdk/models/bulk_currency_conversion_model.rb +0 -1
- data/lib/lockstep_sdk/models/cashflow_report_model.rb +0 -1
- data/lib/lockstep_sdk/models/code_definition_model.rb +0 -1
- data/lib/lockstep_sdk/models/company_model.rb +0 -1
- data/lib/lockstep_sdk/models/company_sync_model.rb +195 -0
- data/lib/lockstep_sdk/models/connector_info_model.rb +0 -1
- data/lib/lockstep_sdk/models/contact_model.rb +0 -1
- data/lib/lockstep_sdk/models/contact_sync_model.rb +177 -0
- data/lib/lockstep_sdk/models/country_model.rb +0 -1
- data/lib/lockstep_sdk/models/credit_memo_applied_model.rb +6 -7
- data/lib/lockstep_sdk/models/credit_memo_applied_sync_model.rb +99 -0
- data/lib/lockstep_sdk/models/credit_memo_invoice_model.rb +0 -1
- data/lib/lockstep_sdk/models/currency_model.rb +0 -1
- data/lib/lockstep_sdk/models/currency_rate_model.rb +0 -1
- data/lib/lockstep_sdk/models/custom_field_definition_model.rb +0 -1
- data/lib/lockstep_sdk/models/custom_field_sync_model.rb +97 -0
- data/lib/lockstep_sdk/models/custom_field_value_model.rb +0 -1
- data/lib/lockstep_sdk/models/customer_details_model.rb +0 -1
- data/lib/lockstep_sdk/models/customer_details_payment_model.rb +0 -1
- data/lib/lockstep_sdk/models/customer_summary_model.rb +0 -1
- data/lib/lockstep_sdk/models/daily_sales_outstanding_report_model.rb +0 -1
- data/lib/lockstep_sdk/models/developer_account_submit_model.rb +0 -1
- data/lib/lockstep_sdk/models/email_model.rb +0 -1
- data/lib/lockstep_sdk/models/erp_info_data_model.rb +0 -1
- data/lib/lockstep_sdk/models/erp_info_model.rb +0 -1
- data/lib/lockstep_sdk/models/erp_model.rb +0 -1
- data/lib/lockstep_sdk/models/invite_data_model.rb +0 -1
- data/lib/lockstep_sdk/models/invite_model.rb +0 -1
- data/lib/lockstep_sdk/models/invite_submit_model.rb +0 -1
- data/lib/lockstep_sdk/models/invoice_address_model.rb +0 -1
- data/lib/lockstep_sdk/models/invoice_history_model.rb +0 -1
- data/lib/lockstep_sdk/models/invoice_line_model.rb +0 -1
- data/lib/lockstep_sdk/models/invoice_line_sync_model.rb +303 -0
- data/lib/lockstep_sdk/models/invoice_model.rb +5 -6
- data/lib/lockstep_sdk/models/invoice_payment_detail_model.rb +0 -1
- data/lib/lockstep_sdk/models/invoice_summary_model.rb +0 -1
- data/lib/lockstep_sdk/models/invoice_sync_model.rb +369 -0
- data/lib/lockstep_sdk/models/lead_model.rb +0 -1
- data/lib/lockstep_sdk/models/note_model.rb +0 -1
- data/lib/lockstep_sdk/models/payment_applied_model.rb +3 -4
- data/lib/lockstep_sdk/models/payment_applied_sync_model.rb +99 -0
- data/lib/lockstep_sdk/models/payment_detail_header_model.rb +0 -1
- data/lib/lockstep_sdk/models/payment_detail_model.rb +0 -1
- data/lib/lockstep_sdk/models/payment_model.rb +7 -8
- data/lib/lockstep_sdk/models/payment_summary_model.rb +0 -1
- data/lib/lockstep_sdk/models/payment_sync_model.rb +147 -0
- data/lib/lockstep_sdk/models/provisioning_finalize_request_model.rb +0 -1
- data/lib/lockstep_sdk/models/provisioning_model.rb +0 -1
- data/lib/lockstep_sdk/models/provisioning_response_model.rb +0 -1
- data/lib/lockstep_sdk/models/risk_rate_model.rb +0 -1
- data/lib/lockstep_sdk/models/state_model.rb +0 -1
- data/lib/lockstep_sdk/models/status_model.rb +0 -1
- data/lib/lockstep_sdk/models/sync_entity_result_model.rb +0 -1
- data/lib/lockstep_sdk/models/sync_request_model.rb +10 -4
- data/lib/lockstep_sdk/models/sync_submit_model.rb +10 -3
- data/lib/lockstep_sdk/models/transfer_owner_model.rb +0 -1
- data/lib/lockstep_sdk/models/transfer_owner_submit_model.rb +0 -1
- data/lib/lockstep_sdk/models/uri_model.rb +49 -0
- data/lib/lockstep_sdk/models/user_account_model.rb +0 -1
- data/lib/lockstep_sdk/models/user_role_model.rb +0 -1
- data/lib/lockstep_sdk/models/webhook_model.rb +137 -0
- data/lib/lockstep_sdk/version.rb +1 -1
- metadata +14 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 2d0eeeee35c6eaed90ba78c52fd24b19a098242d1c547d2cb2acb9947c40aa29
|
4
|
+
data.tar.gz: 604add46661d919b7e23cddb0af8d1f8b323d74753bec82d32b50599ab2175b3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a80e94d466748e8ff9e520b16a3339b03ae0284577ef53cbce66bc65e93457e02377107abb3803c8945e7528cf2526a665a9a2fd6bb8eaa58daeb2fdc05f4871
|
7
|
+
data.tar.gz: 96a056785afffe95e2e112b051207aa89b515577c6960ba7ba5e64163a6677ed3f041b05cf957d8a6a6153c3a6cba7a4e82d98cd99a0642a7f0bb50a51c72f6d
|
@@ -10,7 +10,6 @@
|
|
10
10
|
# @author Manish Narayan B S <manish.n@lockstep.io>
|
11
11
|
# @author Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
|
12
12
|
# @copyright 2021-2022 Lockstep, Inc.
|
13
|
-
# @version 2022.4
|
14
13
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
15
14
|
#
|
16
15
|
|
@@ -93,7 +92,8 @@ class AttachmentsClient
|
|
93
92
|
#
|
94
93
|
# @param table_name [string] The name of the type of object to which this Attachment will be linked
|
95
94
|
# @param object_id [uuid] The unique ID of the object to which this Attachment will be linked
|
96
|
-
|
95
|
+
# @param filename [File] The full path of a file to upload to the API
|
96
|
+
def upload_attachment(table_name:, object_id:, filename:)
|
97
97
|
path = "/api/v1/Attachments"
|
98
98
|
params = {:tableName => table_name, :objectId => object_id}
|
99
99
|
@lockstepsdk.request(:post, path, nil, params)
|
@@ -10,7 +10,6 @@
|
|
10
10
|
# @author Manish Narayan B S <manish.n@lockstep.io>
|
11
11
|
# @author Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
|
12
12
|
# @copyright 2021-2022 Lockstep, Inc.
|
13
|
-
# @version 2022.4
|
14
13
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
15
14
|
#
|
16
15
|
|
@@ -45,10 +44,6 @@ class ProvisioningClient
|
|
45
44
|
@lockstepsdk.request(:post, path, body, nil)
|
46
45
|
end
|
47
46
|
|
48
|
-
##
|
49
|
-
#
|
50
|
-
#
|
51
|
-
# @param body [DeveloperAccountSubmitModel]
|
52
47
|
def provision_free_developer_account(body:)
|
53
48
|
path = "/api/v1/Provisioning/free-account"
|
54
49
|
@lockstepsdk.request(:post, path, body, nil)
|
@@ -10,7 +10,6 @@
|
|
10
10
|
# @author Manish Narayan B S <manish.n@lockstep.io>
|
11
11
|
# @author Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
|
12
12
|
# @copyright 2021-2022 Lockstep, Inc.
|
13
|
-
# @version 2022.4
|
14
13
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
15
14
|
#
|
16
15
|
|
@@ -38,12 +37,26 @@ class SyncClient
|
|
38
37
|
@lockstepsdk.request(:post, path, body, nil)
|
39
38
|
end
|
40
39
|
|
40
|
+
##
|
41
|
+
# Creates a new batch import Sync task that imports all the models provided to this API call.
|
42
|
+
#
|
43
|
+
# A Sync task represents ingestion of data from a source. For each data model in the source, the Sync process will determine whether the data is new, updated, or unchanged from data that already exists within the Lockstep Platform. For records that are new, the Sync process will add them to the Lockstep Platform data. For records that are updated, the Sync process will update existing data to match the newly uploaded records. If records have not changed, no action will be taken.
|
44
|
+
#
|
45
|
+
# You can use this Batch Import process to load data in bulk directly into the Lockstep Platform.
|
46
|
+
#
|
47
|
+
# @param body [BatchSyncModel] Information about the Sync to execute
|
48
|
+
def create_batch_import(body:)
|
49
|
+
path = "/api/v1/Sync/batch"
|
50
|
+
@lockstepsdk.request(:post, path, body, nil)
|
51
|
+
end
|
52
|
+
|
41
53
|
##
|
42
54
|
# Requests a new Sync task from a ZIP file you provide. This ZIP file can contain one or more files with data from the customer's platform. Individual files can be in the format CSV or JSONL (JSON with Lines).
|
43
55
|
#
|
44
56
|
# A Sync task represents an action performed by an Application for a particular account. An Application can provide many different tasks as part of their capabilities. Sync tasks are executed in the background and will continue running after they are created. Use one of the creation APIs to request execution of a task. To check on the progress of the task, call GetSync or QuerySync.
|
45
57
|
#
|
46
|
-
|
58
|
+
# @param filename [File] The full path of a file to upload to the API
|
59
|
+
def upload_sync_file(filename:)
|
47
60
|
path = "/api/v1/Sync/zip"
|
48
61
|
@lockstepsdk.request(:post, path, nil, nil)
|
49
62
|
end
|
@@ -0,0 +1,91 @@
|
|
1
|
+
#
|
2
|
+
# Lockstep Software Development Kit for Ruby
|
3
|
+
#
|
4
|
+
# (c) 2021-2022 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 Ted Spence <tspence@lockstep.io>
|
10
|
+
# @author Manish Narayan B S <manish.n@lockstep.io>
|
11
|
+
# @author Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
|
12
|
+
# @copyright 2021-2022 Lockstep, Inc.
|
13
|
+
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
14
|
+
#
|
15
|
+
|
16
|
+
|
17
|
+
require 'awrence'
|
18
|
+
|
19
|
+
class WebhooksClient
|
20
|
+
|
21
|
+
##
|
22
|
+
# Initialize the WebhooksClient class with a lockstepsdk instance.
|
23
|
+
# @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
|
24
|
+
def initialize(lockstepsdk)
|
25
|
+
@lockstepsdk = lockstepsdk
|
26
|
+
end
|
27
|
+
|
28
|
+
|
29
|
+
##
|
30
|
+
# Retrieves the Webhook specified by this unique identifier.
|
31
|
+
#
|
32
|
+
# @param id [uuid] The unique Lockstep Platform ID number of this Webhook
|
33
|
+
def retrieve_webhook(id:)
|
34
|
+
path = "/api/v1/Webhooks/#{id}"
|
35
|
+
@lockstepsdk.request(:get, path, nil, nil)
|
36
|
+
end
|
37
|
+
|
38
|
+
##
|
39
|
+
# Updates a webhook that matches the specified id with the requested information.
|
40
|
+
#
|
41
|
+
# 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.
|
42
|
+
#
|
43
|
+
# @param id [uuid] The unique Lockstep Platform ID number of the Webhook to update.
|
44
|
+
# @param body [object] A list of changes to apply to this Webhook
|
45
|
+
def update_webhook(id:, body:)
|
46
|
+
path = "/api/v1/Webhooks/#{id}"
|
47
|
+
@lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
|
48
|
+
end
|
49
|
+
|
50
|
+
##
|
51
|
+
# Deletes the Webhook referred to by this unique identifier.
|
52
|
+
#
|
53
|
+
# @param id [uuid] The unique Lockstep Platform ID number of the Webhook to delete.
|
54
|
+
def delete_webhook(id:)
|
55
|
+
path = "/api/v1/Webhooks/#{id}"
|
56
|
+
@lockstepsdk.request(:delete, path, nil, nil)
|
57
|
+
end
|
58
|
+
|
59
|
+
##
|
60
|
+
# Creates one or more webhooks from a given model.
|
61
|
+
#
|
62
|
+
# @param body [WebhookModel] The Webhooks to create
|
63
|
+
def create_webhooks(body:)
|
64
|
+
path = "/api/v1/Webhooks"
|
65
|
+
@lockstepsdk.request(:post, path, body, nil)
|
66
|
+
end
|
67
|
+
|
68
|
+
##
|
69
|
+
# Updates a webhook that matches the specified id with a new client secret.
|
70
|
+
#
|
71
|
+
# @param id [uuid] The unique Lockstep Platform ID number of the Webhook to update.
|
72
|
+
def regenerate_client_secret(id:)
|
73
|
+
path = "/api/v1/Webhooks/#{id}/regenerateclientsecret"
|
74
|
+
@lockstepsdk.request(:patch, path, nil, nil)
|
75
|
+
end
|
76
|
+
|
77
|
+
##
|
78
|
+
# Queries Webhooks for this account using the specified filtering, sorting, and pagination rules requested.
|
79
|
+
#
|
80
|
+
# 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.
|
81
|
+
#
|
82
|
+
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
83
|
+
# @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
84
|
+
# @param page_size [int32] The page size for results (default 200). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
85
|
+
# @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
86
|
+
def query_webhooks(filter:, order:, page_size:, page_number:)
|
87
|
+
path = "/api/v1/Webhooks/query"
|
88
|
+
params = {:filter => filter, :order => order, :pageSize => page_size, :pageNumber => page_number}
|
89
|
+
@lockstepsdk.request(:get, path, nil, params)
|
90
|
+
end
|
91
|
+
end
|
@@ -10,7 +10,7 @@
|
|
10
10
|
# @author Manish Narayan B S <manish.n@lockstep.io>
|
11
11
|
# @author Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
|
12
12
|
# @copyright 2021-2022 Lockstep, Inc.
|
13
|
-
# @version 2022.
|
13
|
+
# @version 2022.6.49.0
|
14
14
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
15
15
|
#
|
16
16
|
|
@@ -137,13 +137,17 @@ module LockstepSdk
|
|
137
137
|
# @return [UserRolesClient] Client object for UserRoles endpoints
|
138
138
|
attr_accessor :user_roles
|
139
139
|
|
140
|
+
##
|
141
|
+
# @return [WebhooksClient] Client object for Webhooks endpoints
|
142
|
+
attr_accessor :webhooks
|
143
|
+
|
140
144
|
|
141
145
|
##
|
142
146
|
# Construct a new Lockstep API client targeting the specified server.
|
143
147
|
#
|
144
148
|
# @param env [string] Either "sbx", "prd", or the URI of the server, ending in a slash (/)
|
145
149
|
def initialize(env)
|
146
|
-
@version = "2022.
|
150
|
+
@version = "2022.6.49.0"
|
147
151
|
@env = case env
|
148
152
|
when "sbx"
|
149
153
|
"https://api.sbx.lockstep.io/"
|
@@ -180,6 +184,7 @@ module LockstepSdk
|
|
180
184
|
@sync = SyncClient.new(self)
|
181
185
|
@user_accounts = UserAccountsClient.new(self)
|
182
186
|
@user_roles = UserRolesClient.new(self)
|
187
|
+
@webhooks = WebhooksClient.new(self)
|
183
188
|
end
|
184
189
|
|
185
190
|
##
|
@@ -239,7 +244,7 @@ module LockstepSdk
|
|
239
244
|
request["Accept"] = 'application/json'
|
240
245
|
request["Content-Type"] = 'application/*+json'
|
241
246
|
request["SdkType"] = 'Ruby'
|
242
|
-
request["SdkVersion"] = '2022.
|
247
|
+
request["SdkVersion"] = '2022.6.49.0'
|
243
248
|
request["MachineName"] = Socket.gethostname
|
244
249
|
request.body = body
|
245
250
|
|
@@ -10,7 +10,6 @@
|
|
10
10
|
# @author Manish Narayan B S <manish.n@lockstep.io>
|
11
11
|
# @author Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
|
12
12
|
# @copyright 2021-2022 Lockstep, Inc.
|
13
|
-
# @version 2022.4
|
14
13
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
15
14
|
#
|
16
15
|
|
@@ -37,6 +36,8 @@ module LockstepSdk
|
|
37
36
|
@origin_attachment_id = params.dig(:origin_attachment_id)
|
38
37
|
@view_internal = params.dig(:view_internal)
|
39
38
|
@view_external = params.dig(:view_external)
|
39
|
+
@erp_key = params.dig(:erp_key)
|
40
|
+
@app_enrollment_id = params.dig(:app_enrollment_id)
|
40
41
|
@created = params.dig(:created)
|
41
42
|
@created_user_id = params.dig(:created_user_id)
|
42
43
|
end
|
@@ -85,6 +86,14 @@ module LockstepSdk
|
|
85
86
|
# @return [Boolean] Flag for if Vendors and customers can see this file
|
86
87
|
attr_accessor :view_external
|
87
88
|
|
89
|
+
##
|
90
|
+
# @return [String] The unique ID of this record as it was known in its originating financial system. If this company record was imported from a financial system, it will have the value `ErpKey` set to the original primary key number of the record as it was known in the originating financial system. If this record was not imported from a financial system, this value will be `null`. For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
|
91
|
+
attr_accessor :erp_key
|
92
|
+
|
93
|
+
##
|
94
|
+
# @return [Uuid] The AppEnrollmentId of the application that imported this attachment record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record.
|
95
|
+
attr_accessor :app_enrollment_id
|
96
|
+
|
88
97
|
##
|
89
98
|
# @return [Date-time] The date the attachment was created
|
90
99
|
attr_accessor :created
|
@@ -108,6 +117,8 @@ module LockstepSdk
|
|
108
117
|
'originAttachmentId' => @origin_attachment_id,
|
109
118
|
'viewInternal' => @view_internal,
|
110
119
|
'viewExternal' => @view_external,
|
120
|
+
'erpKey' => @erp_key,
|
121
|
+
'appEnrollmentId' => @app_enrollment_id,
|
111
122
|
'created' => @created,
|
112
123
|
'createdUserId' => @created_user_id,
|
113
124
|
}
|