lockstep_sdk 2023.7.7.0 → 2023.13.37.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/lockstep_sdk/clients/transcriptions_client.rb +11 -0
- data/lib/lockstep_sdk/lockstep_api.rb +3 -8
- data/lib/lockstep_sdk/models/application_model.rb +2 -14
- data/lib/lockstep_sdk/models/attachment_model.rb +0 -24
- data/lib/lockstep_sdk/models/company_model.rb +6 -0
- data/lib/lockstep_sdk/models/company_sync_model.rb +7 -1
- data/lib/lockstep_sdk/models/contact_sync_model.rb +6 -0
- data/lib/lockstep_sdk/models/credit_memo_applied_model.rb +18 -0
- data/lib/lockstep_sdk/models/credit_memo_applied_sync_model.rb +6 -0
- data/lib/lockstep_sdk/models/custom_field_sync_model.rb +6 -0
- data/lib/lockstep_sdk/models/developer_account_submit_model.rb +0 -6
- data/lib/lockstep_sdk/models/email_reply_generator_request.rb +59 -0
- data/lib/lockstep_sdk/models/email_reply_generator_response.rb +53 -0
- data/lib/lockstep_sdk/models/email_reply_generator_suggestions.rb +53 -0
- data/lib/lockstep_sdk/models/financial_account_balance_history_model.rb +12 -0
- data/lib/lockstep_sdk/models/financial_account_balance_history_sync_model.rb +6 -0
- data/lib/lockstep_sdk/models/financial_account_sync_model.rb +6 -0
- data/lib/lockstep_sdk/models/group_account_model.rb +6 -0
- data/lib/lockstep_sdk/models/invoice_line_sync_model.rb +6 -0
- data/lib/lockstep_sdk/models/invoice_sync_model.rb +6 -0
- data/lib/lockstep_sdk/models/payment_applied_model.rb +18 -0
- data/lib/lockstep_sdk/models/payment_applied_sync_model.rb +6 -0
- data/lib/lockstep_sdk/models/payment_detail_model.rb +12 -0
- data/lib/lockstep_sdk/models/payment_model.rb +19 -1
- data/lib/lockstep_sdk/models/payment_sync_model.rb +6 -0
- data/lib/lockstep_sdk/models/status_model.rb +16 -10
- data/lib/lockstep_sdk/models/sync_entity_result_model.rb +6 -0
- data/lib/lockstep_sdk/version.rb +1 -1
- metadata +5 -4
- data/lib/lockstep_sdk/clients/invoice_history_client.rb +0 -53
- data/lib/lockstep_sdk/models/invoice_history_model.rb +0 -247
@@ -31,6 +31,7 @@ module LockstepSdk
|
|
31
31
|
##
|
32
32
|
# Initialize the FinancialAccountSyncModel using the provided prototype
|
33
33
|
def initialize(params = {})
|
34
|
+
@on_match_action = params.dig(:on_match_action)
|
34
35
|
@code = params.dig(:code)
|
35
36
|
@erp_key = params.dig(:erp_key)
|
36
37
|
@name = params.dig(:name)
|
@@ -42,6 +43,10 @@ module LockstepSdk
|
|
42
43
|
@subcategory = params.dig(:subcategory)
|
43
44
|
end
|
44
45
|
|
46
|
+
##
|
47
|
+
# @return [MatchAction] Indicates what action to take when an existing object has been found during the sync process.
|
48
|
+
attr_accessor :on_match_action
|
49
|
+
|
45
50
|
##
|
46
51
|
# @return [String] The code for the Financial Account. Can either be a general ledger or an account code.
|
47
52
|
attr_accessor :code
|
@@ -82,6 +87,7 @@ module LockstepSdk
|
|
82
87
|
# @return [object] This object as a JSON key-value structure
|
83
88
|
def as_json(options={})
|
84
89
|
{
|
90
|
+
'onMatchAction' => @on_match_action,
|
85
91
|
'code' => @code,
|
86
92
|
'erpKey' => @erp_key,
|
87
93
|
'name' => @name,
|
@@ -34,6 +34,7 @@ module LockstepSdk
|
|
34
34
|
@created_user_id = params.dig(:created_user_id)
|
35
35
|
@modified = params.dig(:modified)
|
36
36
|
@modified_user_id = params.dig(:modified_user_id)
|
37
|
+
@country_code = params.dig(:country_code)
|
37
38
|
end
|
38
39
|
|
39
40
|
##
|
@@ -80,6 +81,10 @@ module LockstepSdk
|
|
80
81
|
# @return [Uuid] The ID of the user who last modified this group account
|
81
82
|
attr_accessor :modified_user_id
|
82
83
|
|
84
|
+
##
|
85
|
+
# @return [String] The 2-letter ISO country code for the group
|
86
|
+
attr_accessor :country_code
|
87
|
+
|
83
88
|
##
|
84
89
|
# @return [object] This object as a JSON key-value structure
|
85
90
|
def as_json(options={})
|
@@ -95,6 +100,7 @@ module LockstepSdk
|
|
95
100
|
'createdUserId' => @created_user_id,
|
96
101
|
'modified' => @modified,
|
97
102
|
'modifiedUserId' => @modified_user_id,
|
103
|
+
'countryCode' => @country_code,
|
98
104
|
}
|
99
105
|
end
|
100
106
|
|
@@ -31,6 +31,7 @@ module LockstepSdk
|
|
31
31
|
##
|
32
32
|
# Initialize the InvoiceLineSyncModel using the provided prototype
|
33
33
|
def initialize(params = {})
|
34
|
+
@on_match_action = params.dig(:on_match_action)
|
34
35
|
@erp_key = params.dig(:erp_key)
|
35
36
|
@invoice_erp_key = params.dig(:invoice_erp_key)
|
36
37
|
@line_number = params.dig(:line_number)
|
@@ -75,6 +76,10 @@ module LockstepSdk
|
|
75
76
|
@modified = params.dig(:modified)
|
76
77
|
end
|
77
78
|
|
79
|
+
##
|
80
|
+
# @return [MatchAction] Indicates what action to take when an existing object has been found during the sync process.
|
81
|
+
attr_accessor :on_match_action
|
82
|
+
|
78
83
|
##
|
79
84
|
# @return [String] This is the primary key of the Invoice Line record. For this field, you should use whatever the contact's unique identifying number is in the originating system. Search for a unique, non-changing number within the originating financial system for this record. Example: If you store your invoice line records in a database, whatever the primary key for the invoice line table is in the database should be the "ErpKey". For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
|
80
85
|
attr_accessor :erp_key
|
@@ -247,6 +252,7 @@ module LockstepSdk
|
|
247
252
|
# @return [object] This object as a JSON key-value structure
|
248
253
|
def as_json(options={})
|
249
254
|
{
|
255
|
+
'onMatchAction' => @on_match_action,
|
250
256
|
'erpKey' => @erp_key,
|
251
257
|
'invoiceErpKey' => @invoice_erp_key,
|
252
258
|
'lineNumber' => @line_number,
|
@@ -31,6 +31,7 @@ module LockstepSdk
|
|
31
31
|
##
|
32
32
|
# Initialize the InvoiceSyncModel using the provided prototype
|
33
33
|
def initialize(params = {})
|
34
|
+
@on_match_action = params.dig(:on_match_action)
|
34
35
|
@erp_key = params.dig(:erp_key)
|
35
36
|
@company_erp_key = params.dig(:company_erp_key)
|
36
37
|
@customer_erp_key = params.dig(:customer_erp_key)
|
@@ -92,6 +93,10 @@ module LockstepSdk
|
|
92
93
|
@base_currency_outstanding_balance_amount = params.dig(:base_currency_outstanding_balance_amount)
|
93
94
|
end
|
94
95
|
|
96
|
+
##
|
97
|
+
# @return [MatchAction] Indicates what action to take when an existing object has been found during the sync process.
|
98
|
+
attr_accessor :on_match_action
|
99
|
+
|
95
100
|
##
|
96
101
|
# @return [String] This is the primary key of the Invoice record. For this field, you should use whatever the invoice's unique identifying number is in the originating system. Search for a unique, non-changing number within the originating financial system for this record. Example: If you store your invoice records in a database, whatever the primary key for the invoice table is in the database should be the "ErpKey". For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
|
97
102
|
attr_accessor :erp_key
|
@@ -332,6 +337,7 @@ module LockstepSdk
|
|
332
337
|
# @return [object] This object as a JSON key-value structure
|
333
338
|
def as_json(options={})
|
334
339
|
{
|
340
|
+
'onMatchAction' => @on_match_action,
|
335
341
|
'erpKey' => @erp_key,
|
336
342
|
'companyErpKey' => @company_erp_key,
|
337
343
|
'customerErpKey' => @customer_erp_key,
|
@@ -31,6 +31,8 @@ module LockstepSdk
|
|
31
31
|
@invoice_id = params.dig(:invoice_id)
|
32
32
|
@payment_id = params.dig(:payment_id)
|
33
33
|
@erp_key = params.dig(:erp_key)
|
34
|
+
@erp_write_status = params.dig(:erp_write_status)
|
35
|
+
@erp_write_status_name = params.dig(:erp_write_status_name)
|
34
36
|
@entry_number = params.dig(:entry_number)
|
35
37
|
@apply_to_invoice_date = params.dig(:apply_to_invoice_date)
|
36
38
|
@payment_applied_amount = params.dig(:payment_applied_amount)
|
@@ -39,6 +41,7 @@ module LockstepSdk
|
|
39
41
|
@modified = params.dig(:modified)
|
40
42
|
@modified_user_id = params.dig(:modified_user_id)
|
41
43
|
@app_enrollment_id = params.dig(:app_enrollment_id)
|
44
|
+
@source_modified_date = params.dig(:source_modified_date)
|
42
45
|
@payment = params.dig(:payment)
|
43
46
|
@invoice = params.dig(:invoice)
|
44
47
|
end
|
@@ -63,6 +66,14 @@ module LockstepSdk
|
|
63
66
|
# @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, this value will be `null`. For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
|
64
67
|
attr_accessor :erp_key
|
65
68
|
|
69
|
+
##
|
70
|
+
# @return [ErpWriteStatuses] Possible statuses for a record that supports ERP write.
|
71
|
+
attr_accessor :erp_write_status
|
72
|
+
|
73
|
+
##
|
74
|
+
# @return [String] The name of the ErpWriteStatus for this payment application
|
75
|
+
attr_accessor :erp_write_status_name
|
76
|
+
|
66
77
|
##
|
67
78
|
# @return [Int32] The entry number of this payment application. This is often a journal entry number, confirmation code, or other identifying field for this payment application.
|
68
79
|
attr_accessor :entry_number
|
@@ -95,6 +106,10 @@ module LockstepSdk
|
|
95
106
|
# @return [Uuid] The AppEnrollmentId of the application that imported this record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record. This value is null if this record was not loaded from an external ERP or financial system.
|
96
107
|
attr_accessor :app_enrollment_id
|
97
108
|
|
109
|
+
##
|
110
|
+
# @return [Date-time] The date on which this record was last modified in source ERP.
|
111
|
+
attr_accessor :source_modified_date
|
112
|
+
|
98
113
|
##
|
99
114
|
# @return [PaymentModel] The payment associated with this applied payment
|
100
115
|
attr_accessor :payment
|
@@ -112,6 +127,8 @@ module LockstepSdk
|
|
112
127
|
'invoiceId' => @invoice_id,
|
113
128
|
'paymentId' => @payment_id,
|
114
129
|
'erpKey' => @erp_key,
|
130
|
+
'erpWriteStatus' => @erp_write_status,
|
131
|
+
'erpWriteStatusName' => @erp_write_status_name,
|
115
132
|
'entryNumber' => @entry_number,
|
116
133
|
'applyToInvoiceDate' => @apply_to_invoice_date,
|
117
134
|
'paymentAppliedAmount' => @payment_applied_amount,
|
@@ -120,6 +137,7 @@ module LockstepSdk
|
|
120
137
|
'modified' => @modified,
|
121
138
|
'modifiedUserId' => @modified_user_id,
|
122
139
|
'appEnrollmentId' => @app_enrollment_id,
|
140
|
+
'sourceModifiedDate' => @source_modified_date,
|
123
141
|
'payment' => @payment,
|
124
142
|
'invoice' => @invoice,
|
125
143
|
}
|
@@ -31,6 +31,7 @@ module LockstepSdk
|
|
31
31
|
##
|
32
32
|
# Initialize the PaymentAppliedSyncModel using the provided prototype
|
33
33
|
def initialize(params = {})
|
34
|
+
@on_match_action = params.dig(:on_match_action)
|
34
35
|
@erp_key = params.dig(:erp_key)
|
35
36
|
@invoice_erp_key = params.dig(:invoice_erp_key)
|
36
37
|
@payment_erp_key = params.dig(:payment_erp_key)
|
@@ -41,6 +42,10 @@ module LockstepSdk
|
|
41
42
|
@modified = params.dig(:modified)
|
42
43
|
end
|
43
44
|
|
45
|
+
##
|
46
|
+
# @return [MatchAction] Indicates what action to take when an existing object has been found during the sync process.
|
47
|
+
attr_accessor :on_match_action
|
48
|
+
|
44
49
|
##
|
45
50
|
# @return [String] This is the primary key of the Payment Application record. For this field, you should use whatever this transaction's unique identifying number is in the originating system. Search for a unique, non-changing number within the originating financial system for this record. Since Payment Applications are often considered transactions, a typical value to look for will be the transaction ID number, the payment confirmation number, or some other record of this payment. For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
|
46
51
|
attr_accessor :erp_key
|
@@ -77,6 +82,7 @@ module LockstepSdk
|
|
77
82
|
# @return [object] This object as a JSON key-value structure
|
78
83
|
def as_json(options={})
|
79
84
|
{
|
85
|
+
'onMatchAction' => @on_match_action,
|
80
86
|
'erpKey' => @erp_key,
|
81
87
|
'invoiceErpKey' => @invoice_erp_key,
|
82
88
|
'paymentErpKey' => @payment_erp_key,
|
@@ -31,6 +31,8 @@ module LockstepSdk
|
|
31
31
|
@reference_code = params.dig(:reference_code)
|
32
32
|
@primary_contact = params.dig(:primary_contact)
|
33
33
|
@email = params.dig(:email)
|
34
|
+
@erp_write_status = params.dig(:erp_write_status)
|
35
|
+
@erp_write_status_name = params.dig(:erp_write_status_name)
|
34
36
|
@currency_code = params.dig(:currency_code)
|
35
37
|
@payment_amount = params.dig(:payment_amount)
|
36
38
|
@unapplied_amount = params.dig(:unapplied_amount)
|
@@ -84,6 +86,14 @@ module LockstepSdk
|
|
84
86
|
# @return [String] The Email address of the Customer.
|
85
87
|
attr_accessor :email
|
86
88
|
|
89
|
+
##
|
90
|
+
# @return [ErpWriteStatuses] Possible statuses for a record that supports ERP write.
|
91
|
+
attr_accessor :erp_write_status
|
92
|
+
|
93
|
+
##
|
94
|
+
# @return [String] The name of the ErpWriteStatus for this payment
|
95
|
+
attr_accessor :erp_write_status_name
|
96
|
+
|
87
97
|
##
|
88
98
|
# @return [String] The currency code of the payment.
|
89
99
|
attr_accessor :currency_code
|
@@ -172,6 +182,8 @@ module LockstepSdk
|
|
172
182
|
'referenceCode' => @reference_code,
|
173
183
|
'primaryContact' => @primary_contact,
|
174
184
|
'email' => @email,
|
185
|
+
'erpWriteStatus' => @erp_write_status,
|
186
|
+
'erpWriteStatusName' => @erp_write_status_name,
|
175
187
|
'currencyCode' => @currency_code,
|
176
188
|
'paymentAmount' => @payment_amount,
|
177
189
|
'unappliedAmount' => @unapplied_amount,
|
@@ -33,6 +33,8 @@ module LockstepSdk
|
|
33
33
|
@payment_id = params.dig(:payment_id)
|
34
34
|
@company_id = params.dig(:company_id)
|
35
35
|
@erp_key = params.dig(:erp_key)
|
36
|
+
@erp_write_status = params.dig(:erp_write_status)
|
37
|
+
@erp_write_status_name = params.dig(:erp_write_status_name)
|
36
38
|
@payment_type = params.dig(:payment_type)
|
37
39
|
@tender_type = params.dig(:tender_type)
|
38
40
|
@is_open = params.dig(:is_open)
|
@@ -54,6 +56,7 @@ module LockstepSdk
|
|
54
56
|
@base_currency_payment_amount = params.dig(:base_currency_payment_amount)
|
55
57
|
@base_currency_unapplied_amount = params.dig(:base_currency_unapplied_amount)
|
56
58
|
@service_fabric_status = params.dig(:service_fabric_status)
|
59
|
+
@source_modified_date = params.dig(:source_modified_date)
|
57
60
|
@applications = params.dig(:applications)
|
58
61
|
@notes = params.dig(:notes)
|
59
62
|
@attachments = params.dig(:attachments)
|
@@ -77,6 +80,14 @@ module LockstepSdk
|
|
77
80
|
# @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, this value will be `null`. For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
|
78
81
|
attr_accessor :erp_key
|
79
82
|
|
83
|
+
##
|
84
|
+
# @return [ErpWriteStatuses] Possible statuses for a record that supports ERP write.
|
85
|
+
attr_accessor :erp_write_status
|
86
|
+
|
87
|
+
##
|
88
|
+
# @return [String] The name of the ErpWriteStatus for this Payment
|
89
|
+
attr_accessor :erp_write_status_name
|
90
|
+
|
80
91
|
##
|
81
92
|
# @return [String] The type of payment, AR Payment or AP Payment. Recognized PaymentType values are: * `AR Payment` - A payment made by a Customer to the Company * `AP Payment` - A payment made by the Company to a Vendor
|
82
93
|
attr_accessor :payment_type
|
@@ -110,7 +121,7 @@ module LockstepSdk
|
|
110
121
|
attr_accessor :unapplied_amount
|
111
122
|
|
112
123
|
##
|
113
|
-
# @return [String] The ISO 4217 currency code for this payment. For a list of ISO 4217 currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies).
|
124
|
+
# @return [String] The ISO 4217 currency code for this payment. For a list of ISO 4217 currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies).
|
114
125
|
attr_accessor :currency_code
|
115
126
|
|
116
127
|
##
|
@@ -161,6 +172,10 @@ module LockstepSdk
|
|
161
172
|
# @return [String] The status of this payment within Service Fabric. "UNAUTHORISED" "PENDING" "PAID" "PAID_OFFLINE" "FAILED" "CANCELLED" "REJECTED" "REFUNDED" "PARTIALLY" "PARTIALLY_REFUNDED"
|
162
173
|
attr_accessor :service_fabric_status
|
163
174
|
|
175
|
+
##
|
176
|
+
# @return [Date-time] The date on which this record was last modified in source ERP.
|
177
|
+
attr_accessor :source_modified_date
|
178
|
+
|
164
179
|
##
|
165
180
|
# @return [PaymentAppliedModel] All applications this payment is associated with. To retrieve this collection, specify `Applications` in the "Include" parameter for your query.
|
166
181
|
attr_accessor :applications
|
@@ -189,6 +204,8 @@ module LockstepSdk
|
|
189
204
|
'paymentId' => @payment_id,
|
190
205
|
'companyId' => @company_id,
|
191
206
|
'erpKey' => @erp_key,
|
207
|
+
'erpWriteStatus' => @erp_write_status,
|
208
|
+
'erpWriteStatusName' => @erp_write_status_name,
|
192
209
|
'paymentType' => @payment_type,
|
193
210
|
'tenderType' => @tender_type,
|
194
211
|
'isOpen' => @is_open,
|
@@ -210,6 +227,7 @@ module LockstepSdk
|
|
210
227
|
'baseCurrencyPaymentAmount' => @base_currency_payment_amount,
|
211
228
|
'baseCurrencyUnappliedAmount' => @base_currency_unapplied_amount,
|
212
229
|
'serviceFabricStatus' => @service_fabric_status,
|
230
|
+
'sourceModifiedDate' => @source_modified_date,
|
213
231
|
'applications' => @applications,
|
214
232
|
'notes' => @notes,
|
215
233
|
'attachments' => @attachments,
|
@@ -31,6 +31,7 @@ module LockstepSdk
|
|
31
31
|
##
|
32
32
|
# Initialize the PaymentSyncModel using the provided prototype
|
33
33
|
def initialize(params = {})
|
34
|
+
@on_match_action = params.dig(:on_match_action)
|
34
35
|
@erp_key = params.dig(:erp_key)
|
35
36
|
@company_erp_key = params.dig(:company_erp_key)
|
36
37
|
@payment_type = params.dig(:payment_type)
|
@@ -52,6 +53,10 @@ module LockstepSdk
|
|
52
53
|
@base_currency_unapplied_amount = params.dig(:base_currency_unapplied_amount)
|
53
54
|
end
|
54
55
|
|
56
|
+
##
|
57
|
+
# @return [MatchAction] Indicates what action to take when an existing object has been found during the sync process.
|
58
|
+
attr_accessor :on_match_action
|
59
|
+
|
55
60
|
##
|
56
61
|
# @return [String] This is the primary key of the Payment record. For this field, you should use whatever the payment's unique identifying number is in the originating system. Search for a unique, non-changing number within the originating financial system for this record. Example: If you store your payment records in a database, whatever the primary key for the payment table is in the database should be the "ErpKey". For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
|
57
62
|
attr_accessor :erp_key
|
@@ -132,6 +137,7 @@ module LockstepSdk
|
|
132
137
|
# @return [object] This object as a JSON key-value structure
|
133
138
|
def as_json(options={})
|
134
139
|
{
|
140
|
+
'onMatchAction' => @on_match_action,
|
135
141
|
'erpKey' => @erp_key,
|
136
142
|
'companyErpKey' => @company_erp_key,
|
137
143
|
'paymentType' => @payment_type,
|
@@ -38,14 +38,15 @@ module LockstepSdk
|
|
38
38
|
@environment = params.dig(:environment)
|
39
39
|
@version = params.dig(:version)
|
40
40
|
@onboarding_scheduled = params.dig(:onboarding_scheduled)
|
41
|
+
@base_currency_code = params.dig(:base_currency_code)
|
42
|
+
@country_code = params.dig(:country_code)
|
41
43
|
@magic_link_id = params.dig(:magic_link_id)
|
42
44
|
@magic_link_company_id = params.dig(:magic_link_company_id)
|
43
45
|
@magic_link = params.dig(:magic_link)
|
44
46
|
@support_access = params.dig(:support_access)
|
45
47
|
@is_impersonated = params.dig(:is_impersonated)
|
46
|
-
@dependencies = params.dig(:dependencies)
|
47
48
|
@user_groups = params.dig(:user_groups)
|
48
|
-
@
|
49
|
+
@dependencies = params.dig(:dependencies)
|
49
50
|
end
|
50
51
|
|
51
52
|
##
|
@@ -108,6 +109,14 @@ module LockstepSdk
|
|
108
109
|
# @return [Boolean] If authentication is successful, contains the onboarding session status of the logged-in user's group account.
|
109
110
|
attr_accessor :onboarding_scheduled
|
110
111
|
|
112
|
+
##
|
113
|
+
# @return [String] Base Currency of the group
|
114
|
+
attr_accessor :base_currency_code
|
115
|
+
|
116
|
+
##
|
117
|
+
# @return [String] Country code of the group
|
118
|
+
attr_accessor :country_code
|
119
|
+
|
111
120
|
##
|
112
121
|
# @return [Uuid] The id of the Magic link used to authenticate.
|
113
122
|
attr_accessor :magic_link_id
|
@@ -128,17 +137,13 @@ module LockstepSdk
|
|
128
137
|
# @return [Boolean] True if the user is being impersonated by the Lockstep support team.
|
129
138
|
attr_accessor :is_impersonated
|
130
139
|
|
131
|
-
##
|
132
|
-
# @return [Object] Statuses for the dependencies of this api. OK if the dependency is working.
|
133
|
-
attr_accessor :dependencies
|
134
|
-
|
135
140
|
##
|
136
141
|
# @return [UserGroupModel] The set of Groups that the user has access to. You can use the /api/v1/useraccounts/change-group endpoint to change your active group.
|
137
142
|
attr_accessor :user_groups
|
138
143
|
|
139
144
|
##
|
140
|
-
# @return [
|
141
|
-
attr_accessor :
|
145
|
+
# @return [Object] Statuses for the dependencies of this api. OK if the dependency is working.
|
146
|
+
attr_accessor :dependencies
|
142
147
|
|
143
148
|
##
|
144
149
|
# @return [object] This object as a JSON key-value structure
|
@@ -159,14 +164,15 @@ module LockstepSdk
|
|
159
164
|
'environment' => @environment,
|
160
165
|
'version' => @version,
|
161
166
|
'onboardingScheduled' => @onboarding_scheduled,
|
167
|
+
'baseCurrencyCode' => @base_currency_code,
|
168
|
+
'countryCode' => @country_code,
|
162
169
|
'magicLinkId' => @magic_link_id,
|
163
170
|
'magicLinkCompanyId' => @magic_link_company_id,
|
164
171
|
'magicLink' => @magic_link,
|
165
172
|
'supportAccess' => @support_access,
|
166
173
|
'isImpersonated' => @is_impersonated,
|
167
|
-
'dependencies' => @dependencies,
|
168
174
|
'userGroups' => @user_groups,
|
169
|
-
'
|
175
|
+
'dependencies' => @dependencies,
|
170
176
|
}
|
171
177
|
end
|
172
178
|
|
@@ -29,6 +29,7 @@ module LockstepSdk
|
|
29
29
|
@skip_count = params.dig(:skip_count)
|
30
30
|
@error_count = params.dig(:error_count)
|
31
31
|
@errors = params.dig(:errors)
|
32
|
+
@skips = params.dig(:skips)
|
32
33
|
end
|
33
34
|
|
34
35
|
##
|
@@ -55,6 +56,10 @@ module LockstepSdk
|
|
55
56
|
# @return [Object] The errors encountered during sync keyed by ERP key
|
56
57
|
attr_accessor :errors
|
57
58
|
|
59
|
+
##
|
60
|
+
# @return [Object] The records that were skipped during sync keyed by ERP key
|
61
|
+
attr_accessor :skips
|
62
|
+
|
58
63
|
##
|
59
64
|
# @return [object] This object as a JSON key-value structure
|
60
65
|
def as_json(options={})
|
@@ -65,6 +70,7 @@ module LockstepSdk
|
|
65
70
|
'skipCount' => @skip_count,
|
66
71
|
'errorCount' => @error_count,
|
67
72
|
'errors' => @errors,
|
73
|
+
'skips' => @skips,
|
68
74
|
}
|
69
75
|
end
|
70
76
|
|
data/lib/lockstep_sdk/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: lockstep_sdk
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 2023.
|
4
|
+
version: 2023.13.37.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Lockstep
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-
|
11
|
+
date: 2023-03-31 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: awrence
|
@@ -51,7 +51,6 @@ files:
|
|
51
51
|
- lib/lockstep_sdk/clients/financial_year_settings_client.rb
|
52
52
|
- lib/lockstep_sdk/clients/group_accounts_client.rb
|
53
53
|
- lib/lockstep_sdk/clients/invoice_addresses_client.rb
|
54
|
-
- lib/lockstep_sdk/clients/invoice_history_client.rb
|
55
54
|
- lib/lockstep_sdk/clients/invoice_lines_client.rb
|
56
55
|
- lib/lockstep_sdk/clients/invoices_client.rb
|
57
56
|
- lib/lockstep_sdk/clients/leads_client.rb
|
@@ -121,6 +120,9 @@ files:
|
|
121
120
|
- lib/lockstep_sdk/models/developer_account_submit_model.rb
|
122
121
|
- lib/lockstep_sdk/models/dpo_summary_group_total_model.rb
|
123
122
|
- lib/lockstep_sdk/models/dpo_summary_model.rb
|
123
|
+
- lib/lockstep_sdk/models/email_reply_generator_request.rb
|
124
|
+
- lib/lockstep_sdk/models/email_reply_generator_response.rb
|
125
|
+
- lib/lockstep_sdk/models/email_reply_generator_suggestions.rb
|
124
126
|
- lib/lockstep_sdk/models/erp_model.rb
|
125
127
|
- lib/lockstep_sdk/models/error_result.rb
|
126
128
|
- lib/lockstep_sdk/models/feature_flags_request_model.rb
|
@@ -139,7 +141,6 @@ files:
|
|
139
141
|
- lib/lockstep_sdk/models/invite_model.rb
|
140
142
|
- lib/lockstep_sdk/models/invite_submit_model.rb
|
141
143
|
- lib/lockstep_sdk/models/invoice_address_model.rb
|
142
|
-
- lib/lockstep_sdk/models/invoice_history_model.rb
|
143
144
|
- lib/lockstep_sdk/models/invoice_line_model.rb
|
144
145
|
- lib/lockstep_sdk/models/invoice_line_sync_model.rb
|
145
146
|
- lib/lockstep_sdk/models/invoice_model.rb
|
@@ -1,53 +0,0 @@
|
|
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 InvoiceHistoryClient
|
18
|
-
|
19
|
-
##
|
20
|
-
# Initialize the InvoiceHistoryClient 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 history of the Invoice specified by this unique identifier.
|
29
|
-
#
|
30
|
-
# An Invoice represents a bill sent from one company to another. The Lockstep Platform tracks changes to each Invoice so that you can observe the changes over time. You can view the InvoiceHistory list to monitor and observe the changes of this Invoice and track the dates when changes occurred.
|
31
|
-
#
|
32
|
-
# @param id [uuid] The unique Lockstep Platform ID number of this invoice; NOT the customer's ERP key
|
33
|
-
def retrieve_invoice_history(id:)
|
34
|
-
path = "/api/v1/InvoiceHistory/#{id}"
|
35
|
-
@connection.request(:get, path, nil, nil)
|
36
|
-
end
|
37
|
-
|
38
|
-
##
|
39
|
-
# Queries Invoice History for this account using the specified filtering, sorting, and pagination rules requested.
|
40
|
-
#
|
41
|
-
# An Invoice represents a bill sent from one company to another. The Lockstep Platform tracks changes to each Invoice so that you can observe the changes over time. You can view the InvoiceHistory list to monitor and observe the changes of this Invoice and track the dates when changes occurred.
|
42
|
-
#
|
43
|
-
# @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
44
|
-
# @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.
|
45
|
-
# @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
46
|
-
# @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)
|
47
|
-
# @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
|
48
|
-
def query_invoice_history(filter:, include_param:, order:, page_size:, page_number:)
|
49
|
-
path = "/api/v1/InvoiceHistory/query"
|
50
|
-
params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
|
51
|
-
@connection.request(:get, path, nil, params)
|
52
|
-
end
|
53
|
-
end
|