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.
Files changed (32) hide show
  1. checksums.yaml +4 -4
  2. data/lib/lockstep_sdk/clients/transcriptions_client.rb +11 -0
  3. data/lib/lockstep_sdk/lockstep_api.rb +3 -8
  4. data/lib/lockstep_sdk/models/application_model.rb +2 -14
  5. data/lib/lockstep_sdk/models/attachment_model.rb +0 -24
  6. data/lib/lockstep_sdk/models/company_model.rb +6 -0
  7. data/lib/lockstep_sdk/models/company_sync_model.rb +7 -1
  8. data/lib/lockstep_sdk/models/contact_sync_model.rb +6 -0
  9. data/lib/lockstep_sdk/models/credit_memo_applied_model.rb +18 -0
  10. data/lib/lockstep_sdk/models/credit_memo_applied_sync_model.rb +6 -0
  11. data/lib/lockstep_sdk/models/custom_field_sync_model.rb +6 -0
  12. data/lib/lockstep_sdk/models/developer_account_submit_model.rb +0 -6
  13. data/lib/lockstep_sdk/models/email_reply_generator_request.rb +59 -0
  14. data/lib/lockstep_sdk/models/email_reply_generator_response.rb +53 -0
  15. data/lib/lockstep_sdk/models/email_reply_generator_suggestions.rb +53 -0
  16. data/lib/lockstep_sdk/models/financial_account_balance_history_model.rb +12 -0
  17. data/lib/lockstep_sdk/models/financial_account_balance_history_sync_model.rb +6 -0
  18. data/lib/lockstep_sdk/models/financial_account_sync_model.rb +6 -0
  19. data/lib/lockstep_sdk/models/group_account_model.rb +6 -0
  20. data/lib/lockstep_sdk/models/invoice_line_sync_model.rb +6 -0
  21. data/lib/lockstep_sdk/models/invoice_sync_model.rb +6 -0
  22. data/lib/lockstep_sdk/models/payment_applied_model.rb +18 -0
  23. data/lib/lockstep_sdk/models/payment_applied_sync_model.rb +6 -0
  24. data/lib/lockstep_sdk/models/payment_detail_model.rb +12 -0
  25. data/lib/lockstep_sdk/models/payment_model.rb +19 -1
  26. data/lib/lockstep_sdk/models/payment_sync_model.rb +6 -0
  27. data/lib/lockstep_sdk/models/status_model.rb +16 -10
  28. data/lib/lockstep_sdk/models/sync_entity_result_model.rb +6 -0
  29. data/lib/lockstep_sdk/version.rb +1 -1
  30. metadata +5 -4
  31. data/lib/lockstep_sdk/clients/invoice_history_client.rb +0 -53
  32. data/lib/lockstep_sdk/models/invoice_history_model.rb +0 -247
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e3c12325f8f3062e6b2f3d0e35abb0bd5c944f21e5fb0f2d98f23d2e65622952
4
- data.tar.gz: a7aa6c606e4ffeabf18003028860d241ad8a519ce2bfa46bfa5657683e7b28bc
3
+ metadata.gz: 94c3d82bb006438d2d6083a2a1f777ec72d8e3e53a8e9f9d15f97c739c5c7fa3
4
+ data.tar.gz: f4a97901a63f1ff48303b5439c197a013255e160aea87e32e5e4da928381a147
5
5
  SHA512:
6
- metadata.gz: 9ef25212f3308858fa81871ec3a82c404c809dc353890420fcdb6fcbe6f57867aa3f14cf5d6caa09b4cacf451cc9b072ea4ff82e1e989a729bd85f9774ce9cd0
7
- data.tar.gz: 0b05410aac2c8246eafee1fa7fff4dee557267bdfd2ac8c432ad3621c134aae4d552d119d5b882102e8387cb8fb9d2889e15b101cbd47282b9dca14c25ef7ab5
6
+ metadata.gz: 15a56c02466b9db83340d47aaca8d230fbd44be948d30c034c302a203ebb1309a3286522d15195fe59704676e4dcdef012b7d50f303a37929df5dd69b7e12a91
7
+ data.tar.gz: c92e2b1e5e991cc98029cecd28adfcd780a643bd223bc1682bdfc7e7a1d7bf68bd60fbe351b77df0ba2e0818638ac1d7b899dddbe04e7863e1f0c1bdcc929ce2
@@ -151,4 +151,15 @@ class TranscriptionsClient
151
151
  params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
152
152
  @connection.request(:get, path, nil, params)
153
153
  end
154
+
155
+ ##
156
+ # Retrieves the Email Reply Generator Response containing a list of email reply suggestions
157
+ #
158
+ # An Email Reply Generator Request represents an email to be sent for a list of email reply suggestions.
159
+ #
160
+ # @param body [EmailReplyGeneratorRequest] The Email Reply Generator Request to be sent
161
+ def retrieve_an_emailreplygeneratorresponse(body:)
162
+ path = "/api/v1/Transcriptions/email-reply-suggestions"
163
+ @connection.request(:post, path, body, nil)
164
+ end
154
165
  end
@@ -9,7 +9,7 @@
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
11
  # @copyright 2021-2023 Lockstep, Inc.
12
- # @version 2023.7.7
12
+ # @version 2023.13.37
13
13
  # @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
14
14
  #
15
15
 
@@ -108,10 +108,6 @@ module lockstep_sdk
108
108
  # @return [InvoiceAddressesClient] Client object for InvoiceAddresses endpoints
109
109
  attr_accessor :invoice_addresses
110
110
 
111
- ##
112
- # @return [InvoiceHistoryClient] Client object for InvoiceHistory endpoints
113
- attr_accessor :invoice_history
114
-
115
111
  ##
116
112
  # @return [InvoiceLinesClient] Client object for InvoiceLines endpoints
117
113
  attr_accessor :invoice_lines
@@ -198,7 +194,7 @@ module lockstep_sdk
198
194
  #
199
195
  # @param env [string] Either "sbx", "prd", or the URI of the server, ending in a slash (/)
200
196
  def initialize(env)
201
- @version = "2023.7.7.0"
197
+ @version = "2023.13.37.0"
202
198
  @env = case env
203
199
  when "sbx"
204
200
  "https://api.sbx.lockstep.io/"
@@ -228,7 +224,6 @@ module lockstep_sdk
228
224
  @financial_year_settings = FinancialYearSettingsClient.new(self)
229
225
  @group_accounts = GroupAccountsClient.new(self)
230
226
  @invoice_addresses = InvoiceAddressesClient.new(self)
231
- @invoice_history = InvoiceHistoryClient.new(self)
232
227
  @invoice_lines = InvoiceLinesClient.new(self)
233
228
  @invoices = InvoicesClient.new(self)
234
229
  @leads = LeadsClient.new(self)
@@ -312,7 +307,7 @@ module lockstep_sdk
312
307
  request["Accept"] = 'application/json'
313
308
  request["Content-Type"] = 'application/*+json'
314
309
  request["SdkType"] = 'Ruby'
315
- request["SdkVersion"] = '2023.7.7.0'
310
+ request["SdkVersion"] = '2023.13.37.0'
316
311
  request["MachineName"] = Socket.gethostname
317
312
  request.body = body
318
313
 
@@ -38,13 +38,11 @@ module LockstepSdk
38
38
  @owner_id = params.dig(:owner_id)
39
39
  @project_url = params.dig(:project_url)
40
40
  @icon_url = params.dig(:icon_url)
41
- @price_terms = params.dig(:price_terms)
42
41
  @created_user_id = params.dig(:created_user_id)
43
42
  @modified_user_id = params.dig(:modified_user_id)
44
43
  @created = params.dig(:created)
45
44
  @modified = params.dig(:modified)
46
45
  @is_active = params.dig(:is_active)
47
- @wiki_url = params.dig(:wiki_url)
48
46
  @group_key = params.dig(:group_key)
49
47
  @b2_cclient_id = params.dig(:b2_cclient_id)
50
48
  @notes = params.dig(:notes)
@@ -74,17 +72,13 @@ module LockstepSdk
74
72
  attr_accessor :owner_id
75
73
 
76
74
  ##
77
- # @return [Uri] The URL to visit for more information about this application
75
+ # @return [String] The URL to visit for more information about this application
78
76
  attr_accessor :project_url
79
77
 
80
78
  ##
81
- # @return [Uri] The URL for the icon for this application
79
+ # @return [String] The URL for the icon for this application
82
80
  attr_accessor :icon_url
83
81
 
84
- ##
85
- # @return [String] The description of the price for this application
86
- attr_accessor :price_terms
87
-
88
82
  ##
89
83
  # @return [Uuid] The ID of the user who created this application
90
84
  attr_accessor :created_user_id
@@ -105,10 +99,6 @@ module LockstepSdk
105
99
  # @return [Boolean] Flag indicating if the application is active.
106
100
  attr_accessor :is_active
107
101
 
108
- ##
109
- # @return [Uri] URL to the Wiki for the Application
110
- attr_accessor :wiki_url
111
-
112
102
  ##
113
103
  # @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).
114
104
  attr_accessor :group_key
@@ -144,13 +134,11 @@ module LockstepSdk
144
134
  'ownerId' => @owner_id,
145
135
  'projectUrl' => @project_url,
146
136
  'iconUrl' => @icon_url,
147
- 'priceTerms' => @price_terms,
148
137
  'createdUserId' => @created_user_id,
149
138
  'modifiedUserId' => @modified_user_id,
150
139
  'created' => @created,
151
140
  'modified' => @modified,
152
141
  'isActive' => @is_active,
153
- 'wikiURL' => @wiki_url,
154
142
  'groupKey' => @group_key,
155
143
  'b2CClientId' => @b2_cclient_id,
156
144
  'notes' => @notes,
@@ -34,11 +34,7 @@ module LockstepSdk
34
34
  @object_key = params.dig(:object_key)
35
35
  @file_name = params.dig(:file_name)
36
36
  @file_ext = params.dig(:file_ext)
37
- @attachment_type_id = params.dig(:attachment_type_id)
38
37
  @is_archived = params.dig(:is_archived)
39
- @origin_attachment_id = params.dig(:origin_attachment_id)
40
- @view_internal = params.dig(:view_internal)
41
- @view_external = params.dig(:view_external)
42
38
  @erp_key = params.dig(:erp_key)
43
39
  @app_enrollment_id = params.dig(:app_enrollment_id)
44
40
  @created = params.dig(:created)
@@ -70,26 +66,10 @@ module LockstepSdk
70
66
  # @return [String] An Attachment represents a file that was uploaded to the Lockstep Platform. This field contains the original extension name of the file on disk.
71
67
  attr_accessor :file_ext
72
68
 
73
- ##
74
- # @return [Uuid] DEPRECATED: This field is replaced by `AttachmentType`.
75
- attr_accessor :attachment_type_id
76
-
77
69
  ##
78
70
  # @return [Boolean] A flag indicating whether this Attachment is archived (also known as hidden or deleted). When you call [ArchiveAttachment](https://developer.lockstep.io/reference/delete_api-v1-attachments-id) this field will be set to true. You should avoid displaying Attachments with the IsArchived field set to true in your user interface.
79
71
  attr_accessor :is_archived
80
72
 
81
- ##
82
- # @return [Uuid] DEPRECATED - Do not use
83
- attr_accessor :origin_attachment_id
84
-
85
- ##
86
- # @return [Boolean] Flag for if LS clients can see this file
87
- attr_accessor :view_internal
88
-
89
- ##
90
- # @return [Boolean] Flag for if Vendors and customers can see this file
91
- attr_accessor :view_external
92
-
93
73
  ##
94
74
  # @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).
95
75
  attr_accessor :erp_key
@@ -120,11 +100,7 @@ module LockstepSdk
120
100
  'objectKey' => @object_key,
121
101
  'fileName' => @file_name,
122
102
  'fileExt' => @file_ext,
123
- 'attachmentTypeId' => @attachment_type_id,
124
103
  'isArchived' => @is_archived,
125
- 'originAttachmentId' => @origin_attachment_id,
126
- 'viewInternal' => @view_internal,
127
- 'viewExternal' => @view_external,
128
104
  'erpKey' => @erp_key,
129
105
  'appEnrollmentId' => @app_enrollment_id,
130
106
  'created' => @created,
@@ -73,6 +73,7 @@ module LockstepSdk
73
73
  @view_box_settings = params.dig(:view_box_settings)
74
74
  @service_fabric_org_id = params.dig(:service_fabric_org_id)
75
75
  @service_fabric_company_id = params.dig(:service_fabric_company_id)
76
+ @company_registration_number = params.dig(:company_registration_number)
76
77
  @notes = params.dig(:notes)
77
78
  @attachments = params.dig(:attachments)
78
79
  @contacts = params.dig(:contacts)
@@ -266,6 +267,10 @@ module LockstepSdk
266
267
  # @return [Uuid] The unique ID of this record within Service Fabric.
267
268
  attr_accessor :service_fabric_company_id
268
269
 
270
+ ##
271
+ # @return [String] A unique identification number assigned to the company by the national registration office.
272
+ attr_accessor :company_registration_number
273
+
269
274
  ##
270
275
  # @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 `Company` and the `ObjectKey` set to the `CompanyId` 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).
271
276
  attr_accessor :notes
@@ -344,6 +349,7 @@ module LockstepSdk
344
349
  'viewBoxSettings' => @view_box_settings,
345
350
  'serviceFabricOrgId' => @service_fabric_org_id,
346
351
  'serviceFabricCompanyId' => @service_fabric_company_id,
352
+ 'companyRegistrationNumber' => @company_registration_number,
347
353
  'notes' => @notes,
348
354
  'attachments' => @attachments,
349
355
  'contacts' => @contacts,
@@ -58,10 +58,11 @@ module LockstepSdk
58
58
  @preferred_delivery_method = params.dig(:preferred_delivery_method)
59
59
  @email_address = params.dig(:email_address)
60
60
  @external_reference = params.dig(:external_reference)
61
+ @company_registration_number = params.dig(:company_registration_number)
61
62
  end
62
63
 
63
64
  ##
64
- # @return [UpdateAction] Indicates what action to take when a sync model has been found during the sync process.
65
+ # @return [MatchAction] Indicates what action to take when an existing object has been found during the sync process.
65
66
  attr_accessor :on_match_action
66
67
 
67
68
  ##
@@ -168,6 +169,10 @@ module LockstepSdk
168
169
  # @return [String] An external reference that identifies the Company from the originating ERP system, separate from the ErpKey.
169
170
  attr_accessor :external_reference
170
171
 
172
+ ##
173
+ # @return [String] A unique identification number assigned to the company by the national registration office.
174
+ attr_accessor :company_registration_number
175
+
171
176
  ##
172
177
  # @return [object] This object as a JSON key-value structure
173
178
  def as_json(options={})
@@ -199,6 +204,7 @@ module LockstepSdk
199
204
  'preferredDeliveryMethod' => @preferred_delivery_method,
200
205
  'emailAddress' => @email_address,
201
206
  'externalReference' => @external_reference,
207
+ 'companyRegistrationNumber' => @company_registration_number,
202
208
  }
203
209
  end
204
210
 
@@ -31,6 +31,7 @@ module LockstepSdk
31
31
  ##
32
32
  # Initialize the ContactSyncModel 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
  @contact_name = params.dig(:contact_name)
@@ -54,6 +55,10 @@ module LockstepSdk
54
55
  @modified = params.dig(:modified)
55
56
  end
56
57
 
58
+ ##
59
+ # @return [MatchAction] Indicates what action to take when an existing object has been found during the sync process.
60
+ attr_accessor :on_match_action
61
+
57
62
  ##
58
63
  # @return [String] This is the primary key of the Contact 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 contact records in a database, whatever the primary key for the contact table is in the database should be the "ErpKey". As some ERP systems don't maintain a unique key for Contacts, we also support syncing Contacts with ERP keys of the form {prefix}|{index}, for example ContactPrefix|1, ContactPrefix|2 and so on. For this reason, please ensure that your Contact ERP keys don't otherwise contain the '|' symbol or that it is replaced by an alternate symbol if they do. For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
59
64
  attr_accessor :erp_key
@@ -142,6 +147,7 @@ module LockstepSdk
142
147
  # @return [object] This object as a JSON key-value structure
143
148
  def as_json(options={})
144
149
  {
150
+ 'onMatchAction' => @on_match_action,
145
151
  'erpKey' => @erp_key,
146
152
  'companyErpKey' => @company_erp_key,
147
153
  'contactName' => @contact_name,
@@ -32,6 +32,8 @@ module LockstepSdk
32
32
  @invoice_id = params.dig(:invoice_id)
33
33
  @credit_memo_invoice_id = params.dig(:credit_memo_invoice_id)
34
34
  @erp_key = params.dig(:erp_key)
35
+ @erp_write_status = params.dig(:erp_write_status)
36
+ @erp_write_status_name = params.dig(:erp_write_status_name)
35
37
  @entry_number = params.dig(:entry_number)
36
38
  @apply_to_invoice_date = params.dig(:apply_to_invoice_date)
37
39
  @credit_memo_applied_amount = params.dig(:credit_memo_applied_amount)
@@ -40,6 +42,7 @@ module LockstepSdk
40
42
  @modified = params.dig(:modified)
41
43
  @modified_user_id = params.dig(:modified_user_id)
42
44
  @app_enrollment_id = params.dig(:app_enrollment_id)
45
+ @source_modified_date = params.dig(:source_modified_date)
43
46
  @attachments = params.dig(:attachments)
44
47
  @notes = params.dig(:notes)
45
48
  @custom_field_definitions = params.dig(:custom_field_definitions)
@@ -68,6 +71,14 @@ module LockstepSdk
68
71
  # @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).
69
72
  attr_accessor :erp_key
70
73
 
74
+ ##
75
+ # @return [ErpWriteStatuses] Possible statuses for a record that supports ERP write.
76
+ attr_accessor :erp_write_status
77
+
78
+ ##
79
+ # @return [String] The name of the ErpWriteStatus for this credit memo application
80
+ attr_accessor :erp_write_status_name
81
+
71
82
  ##
72
83
  # @return [Int32] Reference number for the applied credit memo.
73
84
  attr_accessor :entry_number
@@ -100,6 +111,10 @@ module LockstepSdk
100
111
  # @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.
101
112
  attr_accessor :app_enrollment_id
102
113
 
114
+ ##
115
+ # @return [Date-time] The date on which this record was last modified in source ERP.
116
+ attr_accessor :source_modified_date
117
+
103
118
  ##
104
119
  # @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 `CreditMemoApplied` and the `ObjectKey` set to the `CreditMemoAppliedId` 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).
105
120
  attr_accessor :attachments
@@ -133,6 +148,8 @@ module LockstepSdk
133
148
  'invoiceId' => @invoice_id,
134
149
  'creditMemoInvoiceId' => @credit_memo_invoice_id,
135
150
  'erpKey' => @erp_key,
151
+ 'erpWriteStatus' => @erp_write_status,
152
+ 'erpWriteStatusName' => @erp_write_status_name,
136
153
  'entryNumber' => @entry_number,
137
154
  'applyToInvoiceDate' => @apply_to_invoice_date,
138
155
  'creditMemoAppliedAmount' => @credit_memo_applied_amount,
@@ -141,6 +158,7 @@ module LockstepSdk
141
158
  'modified' => @modified,
142
159
  'modifiedUserId' => @modified_user_id,
143
160
  'appEnrollmentId' => @app_enrollment_id,
161
+ 'sourceModifiedDate' => @source_modified_date,
144
162
  'attachments' => @attachments,
145
163
  'notes' => @notes,
146
164
  'customFieldDefinitions' => @custom_field_definitions,
@@ -31,6 +31,7 @@ module LockstepSdk
31
31
  ##
32
32
  # Initialize the CreditMemoAppliedSyncModel 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
  @credit_memo_invoice_erp_key = params.dig(:credit_memo_invoice_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 Credit Memo 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 Credit Memo 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
  'creditMemoInvoiceErpKey' => @credit_memo_invoice_erp_key,
@@ -35,6 +35,7 @@ module LockstepSdk
35
35
  ##
36
36
  # Initialize the CustomFieldSyncModel using the provided prototype
37
37
  def initialize(params = {})
38
+ @on_match_action = params.dig(:on_match_action)
38
39
  @erp_key = params.dig(:erp_key)
39
40
  @table_key = params.dig(:table_key)
40
41
  @custom_field_label = params.dig(:custom_field_label)
@@ -45,6 +46,10 @@ module LockstepSdk
45
46
  @modified = params.dig(:modified)
46
47
  end
47
48
 
49
+ ##
50
+ # @return [MatchAction] Indicates what action to take when an existing object has been found during the sync process.
51
+ attr_accessor :on_match_action
52
+
48
53
  ##
49
54
  # @return [String] This is the primary key of the record to which you will attach this custom field. You should provide the identifying number as it is stored in the originating financial system. Search for a unique, non-changing number within the originating financial system for this record. Custom Fields are identified by the `TableKey` and `ErpKey` values together. Example: You have an invoice whose ID number is 100047878, and you wish to store a custom field on that invoice named "ApprovalStatusCode". For the `ErpKey` field, specify the value `100047878`. For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
50
55
  attr_accessor :erp_key
@@ -81,6 +86,7 @@ module LockstepSdk
81
86
  # @return [object] This object as a JSON key-value structure
82
87
  def as_json(options={})
83
88
  {
89
+ 'onMatchAction' => @on_match_action,
84
90
  'erpKey' => @erp_key,
85
91
  'tableKey' => @table_key,
86
92
  'customFieldLabel' => @custom_field_label,
@@ -23,17 +23,12 @@ module LockstepSdk
23
23
  ##
24
24
  # Initialize the DeveloperAccountSubmitModel using the provided prototype
25
25
  def initialize(params = {})
26
- @name = params.dig(:name)
27
26
  @first_name = params.dig(:first_name)
28
27
  @last_name = params.dig(:last_name)
29
28
  @email = params.dig(:email)
30
29
  @company_name = params.dig(:company_name)
31
30
  end
32
31
 
33
- ##
34
- # @return [String] The name of the developer.
35
- attr_accessor :name
36
-
37
32
  ##
38
33
  # @return [String] The first name of the person requesting the developer account.
39
34
  attr_accessor :first_name
@@ -54,7 +49,6 @@ module LockstepSdk
54
49
  # @return [object] This object as a JSON key-value structure
55
50
  def as_json(options={})
56
51
  {
57
- 'name' => @name,
58
52
  'firstName' => @first_name,
59
53
  'lastName' => @last_name,
60
54
  'email' => @email,
@@ -0,0 +1,59 @@
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
+ # Represents the request to the SAGE GMS API
21
+ class EmailReplyGeneratorRequest
22
+
23
+ ##
24
+ # Initialize the EmailReplyGeneratorRequest using the provided prototype
25
+ def initialize(params = {})
26
+ @date = params.dig(:date)
27
+ @body = params.dig(:body)
28
+ @subject = params.dig(:subject)
29
+ end
30
+
31
+ ##
32
+ # @return [Date-time] The date associated with the email
33
+ attr_accessor :date
34
+
35
+ ##
36
+ # @return [String] The body associated with the email
37
+ attr_accessor :body
38
+
39
+ ##
40
+ # @return [String] The subject associated with the email
41
+ attr_accessor :subject
42
+
43
+ ##
44
+ # @return [object] This object as a JSON key-value structure
45
+ def as_json(options={})
46
+ {
47
+ 'date' => @date,
48
+ 'body' => @body,
49
+ 'subject' => @subject,
50
+ }
51
+ end
52
+
53
+ ##
54
+ # @return [String] This object converted to a JSON string
55
+ def to_json(*options)
56
+ "[#{as_json(*options).to_json(*options)}]"
57
+ end
58
+ end
59
+ end
@@ -0,0 +1,53 @@
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
+ # Represents the response from SAGE GMS API
21
+ class EmailReplyGeneratorResponse
22
+
23
+ ##
24
+ # Initialize the EmailReplyGeneratorResponse using the provided prototype
25
+ def initialize(params = {})
26
+ @message_id = params.dig(:message_id)
27
+ @suggestions = params.dig(:suggestions)
28
+ end
29
+
30
+ ##
31
+ # @return [Uuid] The id for this request in the GMS system
32
+ attr_accessor :message_id
33
+
34
+ ##
35
+ # @return [EmailReplyGeneratorSuggestions] A list of suggested email reply responses
36
+ attr_accessor :suggestions
37
+
38
+ ##
39
+ # @return [object] This object as a JSON key-value structure
40
+ def as_json(options={})
41
+ {
42
+ 'message_id' => @message_id,
43
+ 'suggestions' => @suggestions,
44
+ }
45
+ end
46
+
47
+ ##
48
+ # @return [String] This object converted to a JSON string
49
+ def to_json(*options)
50
+ "[#{as_json(*options).to_json(*options)}]"
51
+ end
52
+ end
53
+ end
@@ -0,0 +1,53 @@
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
+ # Represents the email reply suggestion from the SAGE GMS API
21
+ class EmailReplyGeneratorSuggestions
22
+
23
+ ##
24
+ # Initialize the EmailReplyGeneratorSuggestions using the provided prototype
25
+ def initialize(params = {})
26
+ @kind = params.dig(:kind)
27
+ @body = params.dig(:body)
28
+ end
29
+
30
+ ##
31
+ # @return [String] The kind of reply generated by the GMS Api
32
+ attr_accessor :kind
33
+
34
+ ##
35
+ # @return [String] The body of the reply generated by the GMS Api
36
+ attr_accessor :body
37
+
38
+ ##
39
+ # @return [object] This object as a JSON key-value structure
40
+ def as_json(options={})
41
+ {
42
+ 'kind' => @kind,
43
+ 'body' => @body,
44
+ }
45
+ end
46
+
47
+ ##
48
+ # @return [String] This object converted to a JSON string
49
+ def to_json(*options)
50
+ "[#{as_json(*options).to_json(*options)}]"
51
+ end
52
+ end
53
+ end
@@ -33,6 +33,8 @@ module LockstepSdk
33
33
  @period_end_date = params.dig(:period_end_date)
34
34
  @status = params.dig(:status)
35
35
  @balance = params.dig(:balance)
36
+ @balance_type = params.dig(:balance_type)
37
+ @balance_type_name = params.dig(:balance_type_name)
36
38
  @created = params.dig(:created)
37
39
  @created_user_id = params.dig(:created_user_id)
38
40
  @modified = params.dig(:modified)
@@ -79,6 +81,14 @@ module LockstepSdk
79
81
  # @return [Double] The current or end balance of this period.
80
82
  attr_accessor :balance
81
83
 
84
+ ##
85
+ # @return [FinancialAccountBalanceType] Financial Account Balance Types
86
+ attr_accessor :balance_type
87
+
88
+ ##
89
+ # @return [String] The name of the BalanceType for this record.
90
+ attr_accessor :balance_type_name
91
+
82
92
  ##
83
93
  # @return [Date-time] The date on which this financial account balance history record was created.
84
94
  attr_accessor :created
@@ -109,6 +119,8 @@ module LockstepSdk
109
119
  'periodEndDate' => @period_end_date,
110
120
  'status' => @status,
111
121
  'balance' => @balance,
122
+ 'balanceType' => @balance_type,
123
+ 'balanceTypeName' => @balance_type_name,
112
124
  'created' => @created,
113
125
  'createdUserId' => @created_user_id,
114
126
  'modified' => @modified,
@@ -42,6 +42,7 @@ module LockstepSdk
42
42
  @period_end_date = params.dig(:period_end_date)
43
43
  @status = params.dig(:status)
44
44
  @balance = params.dig(:balance)
45
+ @balance_type = params.dig(:balance_type)
45
46
  end
46
47
 
47
48
  ##
@@ -76,6 +77,10 @@ module LockstepSdk
76
77
  # @return [Double] The current or end balance of this period.
77
78
  attr_accessor :balance
78
79
 
80
+ ##
81
+ # @return [FinancialAccountBalanceType] The balance type of this period. If left null, the balance type will be determined by the balance.
82
+ attr_accessor :balance_type
83
+
79
84
  ##
80
85
  # @return [object] This object as a JSON key-value structure
81
86
  def as_json(options={})
@@ -88,6 +93,7 @@ module LockstepSdk
88
93
  'periodEndDate' => @period_end_date,
89
94
  'status' => @status,
90
95
  'balance' => @balance,
96
+ 'balanceType' => @balance_type,
91
97
  }
92
98
  end
93
99