lockstep_sdk 2022.9.6.0 → 2022.10.63.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/attachments_client.rb +3 -2
- data/lib/lockstep_sdk/clients/invoices_client.rb +13 -0
- data/lib/lockstep_sdk/clients/payments_client.rb +11 -0
- data/lib/lockstep_sdk/clients/reports_client.rb +13 -0
- data/lib/lockstep_sdk/lockstep_api.rb +3 -3
- data/lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb +6 -0
- data/lib/lockstep_sdk/models/app_enrollment_model.rb +0 -6
- data/lib/lockstep_sdk/models/attachment_model.rb +21 -10
- data/lib/lockstep_sdk/models/company_model.rb +0 -36
- data/lib/lockstep_sdk/models/connector_info_model.rb +24 -0
- data/lib/lockstep_sdk/models/financial_report_cell_model.rb +49 -0
- data/lib/lockstep_sdk/models/financial_report_model.rb +79 -0
- data/lib/lockstep_sdk/models/financial_report_row_model.rb +67 -0
- data/lib/lockstep_sdk/models/note_model.rb +5 -5
- data/lib/lockstep_sdk/models/provisioning_model.rb +0 -18
- data/lib/lockstep_sdk/models/trial_balance_report_cell_model.rb +49 -0
- data/lib/lockstep_sdk/models/trial_balance_report_model.rb +79 -0
- data/lib/lockstep_sdk/models/trial_balance_report_row_model.rb +67 -0
- data/lib/lockstep_sdk/version.rb +1 -1
- metadata +8 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ba9d5a2c92fb2c8df1dfe1eb381076c1054629fa0f9d2488f9513af0161fd019
|
4
|
+
data.tar.gz: 53389e8077c628152038c5faf8ccb725131f3e1581454a8ea245b59967879c35
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c8e4b59b277980e0683c8701f8478884c38fd2bec93e1b77a19f249fc5b28e13356ead3e368a64efa348b90b256e8be01763716d3811b77c7b4e7294af82738e
|
7
|
+
data.tar.gz: 729cf53e3c23136505313854eabfedd8cbe05bd88a01b622f00f32cef134fd4f2d488f8036a4f99db23012cefbdeb8bfaaff6eb7952ed65f36e9debce0bcc691
|
@@ -92,10 +92,11 @@ class AttachmentsClient
|
|
92
92
|
#
|
93
93
|
# @param table_name [string] The name of the type of object to which this Attachment will be linked
|
94
94
|
# @param object_id [uuid] The unique ID of the object to which this Attachment will be linked
|
95
|
+
# @param attachment_type [string] The type of this attachment
|
95
96
|
# @param filename [File] The full path of a file to upload to the API
|
96
|
-
def upload_attachment(table_name:, object_id:, filename:)
|
97
|
+
def upload_attachment(table_name:, object_id:, attachment_type:, filename:)
|
97
98
|
path = "/api/v1/Attachments"
|
98
|
-
params = {:tableName => table_name, :objectId => object_id}
|
99
|
+
params = {:tableName => table_name, :objectId => object_id, :attachmentType => attachment_type}
|
99
100
|
@lockstepsdk.request(:post, path, nil, params)
|
100
101
|
end
|
101
102
|
|
@@ -91,6 +91,19 @@ class InvoicesClient
|
|
91
91
|
@lockstepsdk.request(:get, path, nil, params)
|
92
92
|
end
|
93
93
|
|
94
|
+
##
|
95
|
+
# Retrieves a PDF file for this invoice if it is of one of the supported invoice types and has been synced using an app enrollment to one of the supported apps.
|
96
|
+
#
|
97
|
+
# Supported apps: Quickbooks Online, Xero
|
98
|
+
#
|
99
|
+
# Supported invoice types: Invoice, Credit Memo
|
100
|
+
#
|
101
|
+
# @param id [uuid] The unique Lockstep Platform ID number of this invoice; NOT the customer's ERP key
|
102
|
+
def retrieve_invoice_pdf(id:)
|
103
|
+
path = "/api/v1/Invoices/#{id}/pdf"
|
104
|
+
@lockstepsdk.request(:get, path, nil, nil)
|
105
|
+
end
|
106
|
+
|
94
107
|
##
|
95
108
|
# Queries Invoices for this account using the specified filtering, sorting, nested fetch, and pagination rules requested. Display the results using the Invoice Summary View format.
|
96
109
|
#
|
@@ -93,6 +93,17 @@ class PaymentsClient
|
|
93
93
|
@lockstepsdk.request(:get, path, nil, params)
|
94
94
|
end
|
95
95
|
|
96
|
+
##
|
97
|
+
# Retrieves a PDF file for this payment if it has been synced using an app enrollment to one of the supported apps.
|
98
|
+
#
|
99
|
+
# Supported apps: Quickbooks Online
|
100
|
+
#
|
101
|
+
# @param id [uuid] The unique Lockstep Platform ID number of this payment; NOT the customer's ERP key
|
102
|
+
def retrieve_payment_pdf(id:)
|
103
|
+
path = "/api/v1/Payments/#{id}/pdf"
|
104
|
+
@lockstepsdk.request(:get, path, nil, nil)
|
105
|
+
end
|
106
|
+
|
96
107
|
##
|
97
108
|
# Queries Payments for this account using the specified filtering, sorting, nested fetch, and pagination rules requested. This query endpoint provides extra data about the summary of payment information.
|
98
109
|
#
|
@@ -110,4 +110,17 @@ class ReportsClient
|
|
110
110
|
params = {:companyId => company_id}
|
111
111
|
@lockstepsdk.request(:get, path, nil, params)
|
112
112
|
end
|
113
|
+
|
114
|
+
##
|
115
|
+
# Generates a Trial Balance Report for the given time range.
|
116
|
+
#
|
117
|
+
# The Attachment Header report contains aggregated information about the `TotalAttachments`, `TotalArchived`, and `TotalActive` attachment classifications.
|
118
|
+
#
|
119
|
+
# @param start_date [date-time]
|
120
|
+
# @param end_date [date-time]
|
121
|
+
def trial_balance_report(start_date:, end_date:)
|
122
|
+
path = "/api/v1/Reports/trial-balance"
|
123
|
+
params = {:startDate => start_date, :endDate => end_date}
|
124
|
+
@lockstepsdk.request(:get, path, nil, params)
|
125
|
+
end
|
113
126
|
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.10.63.0
|
14
14
|
# @link https://github.com/Lockstep-Network/lockstep-sdk-ruby
|
15
15
|
#
|
16
16
|
|
@@ -159,7 +159,7 @@ module LockstepSdk
|
|
159
159
|
#
|
160
160
|
# @param env [string] Either "sbx", "prd", or the URI of the server, ending in a slash (/)
|
161
161
|
def initialize(env)
|
162
|
-
@version = "2022.
|
162
|
+
@version = "2022.10.63.0"
|
163
163
|
@env = case env
|
164
164
|
when "sbx"
|
165
165
|
"https://api.sbx.lockstep.io/"
|
@@ -259,7 +259,7 @@ module LockstepSdk
|
|
259
259
|
request["Accept"] = 'application/json'
|
260
260
|
request["Content-Type"] = 'application/*+json'
|
261
261
|
request["SdkType"] = 'Ruby'
|
262
|
-
request["SdkVersion"] = '2022.
|
262
|
+
request["SdkVersion"] = '2022.10.63.0'
|
263
263
|
request["MachineName"] = Socket.gethostname
|
264
264
|
request.body = body
|
265
265
|
|
@@ -36,6 +36,7 @@ module LockstepSdk
|
|
36
36
|
@sort_order = params.dig(:sort_order)
|
37
37
|
@string_value = params.dig(:string_value)
|
38
38
|
@numeric_value = params.dig(:numeric_value)
|
39
|
+
@value = params.dig(:value)
|
39
40
|
end
|
40
41
|
|
41
42
|
##
|
@@ -82,6 +83,10 @@ module LockstepSdk
|
|
82
83
|
# @return [Double] Number data for field
|
83
84
|
attr_accessor :numeric_value
|
84
85
|
|
86
|
+
##
|
87
|
+
# @return [String] Value for the field
|
88
|
+
attr_accessor :value
|
89
|
+
|
85
90
|
##
|
86
91
|
# @return [object] This object as a JSON key-value structure
|
87
92
|
def as_json(options={})
|
@@ -97,6 +102,7 @@ module LockstepSdk
|
|
97
102
|
'sortOrder' => @sort_order,
|
98
103
|
'stringValue' => @string_value,
|
99
104
|
'numericValue' => @numeric_value,
|
105
|
+
'value' => @value,
|
100
106
|
}
|
101
107
|
end
|
102
108
|
|
@@ -45,7 +45,6 @@ module LockstepSdk
|
|
45
45
|
@custom_field_values = params.dig(:custom_field_values)
|
46
46
|
@last_sync = params.dig(:last_sync)
|
47
47
|
@last_successful_sync = params.dig(:last_successful_sync)
|
48
|
-
@erp_info = params.dig(:erp_info)
|
49
48
|
@connector_info = params.dig(:connector_info)
|
50
49
|
end
|
51
50
|
|
@@ -109,10 +108,6 @@ module LockstepSdk
|
|
109
108
|
# @return [SyncRequestModel] Data about the last successful sync associated with this enrollment
|
110
109
|
attr_accessor :last_successful_sync
|
111
110
|
|
112
|
-
##
|
113
|
-
# @return [ErpInfoDataModel] Use `ConnectorInfo` instead.
|
114
|
-
attr_accessor :erp_info
|
115
|
-
|
116
111
|
##
|
117
112
|
# @return [ConnectorInfoModel] Optional data necessary to create an app enrollment for a supported connector. Only enter relevant fields for the given connector.
|
118
113
|
attr_accessor :connector_info
|
@@ -136,7 +131,6 @@ module LockstepSdk
|
|
136
131
|
'customFieldValues' => @custom_field_values,
|
137
132
|
'lastSync' => @last_sync,
|
138
133
|
'lastSuccessfulSync' => @last_successful_sync,
|
139
|
-
'erpInfo' => @erp_info,
|
140
134
|
'connectorInfo' => @connector_info,
|
141
135
|
}
|
142
136
|
end
|
@@ -19,7 +19,12 @@ require 'json'
|
|
19
19
|
module LockstepSdk
|
20
20
|
|
21
21
|
##
|
22
|
-
#
|
22
|
+
# An Attachment is a file that can be attached to various account attributes within Lockstep.
|
23
|
+
# This data model contains metadata about the attachment. You can upload and download attachments
|
24
|
+
# into the Lockstep Platform along with this metadata. Attachments can be used for invoices, payments,
|
25
|
+
# legal documents, or any other external files that you wish to track.
|
26
|
+
#
|
27
|
+
# See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
|
23
28
|
class AttachmentModel
|
24
29
|
|
25
30
|
##
|
@@ -40,6 +45,7 @@ module LockstepSdk
|
|
40
45
|
@app_enrollment_id = params.dig(:app_enrollment_id)
|
41
46
|
@created = params.dig(:created)
|
42
47
|
@created_user_id = params.dig(:created_user_id)
|
48
|
+
@attachment_type = params.dig(:attachment_type)
|
43
49
|
end
|
44
50
|
|
45
51
|
##
|
@@ -51,31 +57,31 @@ module LockstepSdk
|
|
51
57
|
attr_accessor :group_key
|
52
58
|
|
53
59
|
##
|
54
|
-
# @return [String] The name of the table the
|
60
|
+
# @return [String] An Attachment is connected to an existing item within the Lockstep Platform by the fields `TableKey` and `ObjectKey`. For example, an Attachment connected to Invoice 12345 would have a `TableKey` value of `Invoice` and an `ObjectKey` value of `12345`. The `TableKey` value contains the name of the table within the Lockstep Platform to which this Attachment is connected. For more information, see [linking metadata to an object](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
|
55
61
|
attr_accessor :table_key
|
56
62
|
|
57
63
|
##
|
58
|
-
# @return [Uuid] The
|
64
|
+
# @return [Uuid] An Attachment is connected to an existing item within the Lockstep Platform by the fields `TableKey` and `ObjectKey`. For example, an Attachment connected to Invoice 12345 would have a `TableKey` value of `Invoice` and an `ObjectKey` value of `12345`. The `ObjectKey` value contains the primary key of the record within the Lockstep Platform to which this Attachment is connected. For more information, see [linking metadata to an object](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
|
59
65
|
attr_accessor :object_key
|
60
66
|
|
61
67
|
##
|
62
|
-
# @return [String]
|
68
|
+
# @return [String] An Attachment represents a file that was uploaded to the Lockstep Platform. This field contains the original name of the file on disk, without its extension.
|
63
69
|
attr_accessor :file_name
|
64
70
|
|
65
71
|
##
|
66
|
-
# @return [String]
|
72
|
+
# @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.
|
67
73
|
attr_accessor :file_ext
|
68
74
|
|
69
75
|
##
|
70
|
-
# @return [Uuid]
|
76
|
+
# @return [Uuid] DEPRECATED: This field is replaced by `AttachmentType`.
|
71
77
|
attr_accessor :attachment_type_id
|
72
78
|
|
73
79
|
##
|
74
|
-
# @return [Boolean]
|
80
|
+
# @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.
|
75
81
|
attr_accessor :is_archived
|
76
82
|
|
77
83
|
##
|
78
|
-
# @return [Uuid]
|
84
|
+
# @return [Uuid] DEPRECATED - Do not use
|
79
85
|
attr_accessor :origin_attachment_id
|
80
86
|
|
81
87
|
##
|
@@ -95,13 +101,17 @@ module LockstepSdk
|
|
95
101
|
attr_accessor :app_enrollment_id
|
96
102
|
|
97
103
|
##
|
98
|
-
# @return [Date-time] The date the attachment was created
|
104
|
+
# @return [Date-time] The date the attachment was created.
|
99
105
|
attr_accessor :created
|
100
106
|
|
101
107
|
##
|
102
|
-
# @return [Uuid]
|
108
|
+
# @return [Uuid] The unique ID of the [UserAccount](https://developer.lockstep.io/docs/useraccountmodel) of the user who created this Attachment.
|
103
109
|
attr_accessor :created_user_id
|
104
110
|
|
111
|
+
##
|
112
|
+
# @return [String] A text string describing the type of this Attachment.
|
113
|
+
attr_accessor :attachment_type
|
114
|
+
|
105
115
|
##
|
106
116
|
# @return [object] This object as a JSON key-value structure
|
107
117
|
def as_json(options={})
|
@@ -121,6 +131,7 @@ module LockstepSdk
|
|
121
131
|
'appEnrollmentId' => @app_enrollment_id,
|
122
132
|
'created' => @created,
|
123
133
|
'createdUserId' => @created_user_id,
|
134
|
+
'attachmentType' => @attachment_type,
|
124
135
|
}
|
125
136
|
end
|
126
137
|
|
@@ -44,12 +44,6 @@ module LockstepSdk
|
|
44
44
|
@address1 = params.dig(:address1)
|
45
45
|
@address2 = params.dig(:address2)
|
46
46
|
@address3 = params.dig(:address3)
|
47
|
-
@corp_city = params.dig(:corp_city)
|
48
|
-
@corp_state = params.dig(:corp_state)
|
49
|
-
@corp_postal_code = params.dig(:corp_postal_code)
|
50
|
-
@corp_country = params.dig(:corp_country)
|
51
|
-
@corp_phone = params.dig(:corp_phone)
|
52
|
-
@corp_fax = params.dig(:corp_fax)
|
53
47
|
@city = params.dig(:city)
|
54
48
|
@state_region = params.dig(:state_region)
|
55
49
|
@postal_code = params.dig(:postal_code)
|
@@ -139,30 +133,6 @@ module LockstepSdk
|
|
139
133
|
# @return [String] Address info
|
140
134
|
attr_accessor :address3
|
141
135
|
|
142
|
-
##
|
143
|
-
# @return [String] Corporate Address info
|
144
|
-
attr_accessor :corp_city
|
145
|
-
|
146
|
-
##
|
147
|
-
# @return [String] Corporate Address info
|
148
|
-
attr_accessor :corp_state
|
149
|
-
|
150
|
-
##
|
151
|
-
# @return [String] Corporate Address info
|
152
|
-
attr_accessor :corp_postal_code
|
153
|
-
|
154
|
-
##
|
155
|
-
# @return [String] Corporate Address info
|
156
|
-
attr_accessor :corp_country
|
157
|
-
|
158
|
-
##
|
159
|
-
# @return [String] Corporate phone number
|
160
|
-
attr_accessor :corp_phone
|
161
|
-
|
162
|
-
##
|
163
|
-
# @return [String] Corporate fax number
|
164
|
-
attr_accessor :corp_fax
|
165
|
-
|
166
136
|
##
|
167
137
|
# @return [String] Address info
|
168
138
|
attr_accessor :city
|
@@ -290,12 +260,6 @@ module LockstepSdk
|
|
290
260
|
'address1' => @address1,
|
291
261
|
'address2' => @address2,
|
292
262
|
'address3' => @address3,
|
293
|
-
'corpCity' => @corp_city,
|
294
|
-
'corpState' => @corp_state,
|
295
|
-
'corpPostalCode' => @corp_postal_code,
|
296
|
-
'corpCountry' => @corp_country,
|
297
|
-
'corpPhone' => @corp_phone,
|
298
|
-
'corpFax' => @corp_fax,
|
299
263
|
'city' => @city,
|
300
264
|
'stateRegion' => @state_region,
|
301
265
|
'postalCode' => @postal_code,
|
@@ -30,6 +30,10 @@ module LockstepSdk
|
|
30
30
|
@realm_id = params.dig(:realm_id)
|
31
31
|
@redirect_uri = params.dig(:redirect_uri)
|
32
32
|
@email = params.dig(:email)
|
33
|
+
@username = params.dig(:username)
|
34
|
+
@password = params.dig(:password)
|
35
|
+
@server_name = params.dig(:server_name)
|
36
|
+
@server_port = params.dig(:server_port)
|
33
37
|
end
|
34
38
|
|
35
39
|
##
|
@@ -48,6 +52,22 @@ module LockstepSdk
|
|
48
52
|
# @return [String] The email an email connection is being created for.
|
49
53
|
attr_accessor :email
|
50
54
|
|
55
|
+
##
|
56
|
+
# @return [String] The username of the web services account with access permissions.
|
57
|
+
attr_accessor :username
|
58
|
+
|
59
|
+
##
|
60
|
+
# @return [String] The password for the web services account with access permissions.
|
61
|
+
attr_accessor :password
|
62
|
+
|
63
|
+
##
|
64
|
+
# @return [String] The server name a connection is being created for.
|
65
|
+
attr_accessor :server_name
|
66
|
+
|
67
|
+
##
|
68
|
+
# @return [Int32] The port number of the server a connection is being created for.
|
69
|
+
attr_accessor :server_port
|
70
|
+
|
51
71
|
##
|
52
72
|
# @return [object] This object as a JSON key-value structure
|
53
73
|
def as_json(options={})
|
@@ -56,6 +76,10 @@ module LockstepSdk
|
|
56
76
|
'realmId' => @realm_id,
|
57
77
|
'redirectUri' => @redirect_uri,
|
58
78
|
'email' => @email,
|
79
|
+
'username' => @username,
|
80
|
+
'password' => @password,
|
81
|
+
'serverName' => @server_name,
|
82
|
+
'serverPort' => @server_port,
|
59
83
|
}
|
60
84
|
end
|
61
85
|
|
@@ -0,0 +1,49 @@
|
|
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 'json'
|
18
|
+
|
19
|
+
module LockstepSdk
|
20
|
+
|
21
|
+
##
|
22
|
+
# Represents a cell of a financial report
|
23
|
+
class FinancialReportCellModel
|
24
|
+
|
25
|
+
##
|
26
|
+
# Initialize the FinancialReportCellModel using the provided prototype
|
27
|
+
def initialize(params = {})
|
28
|
+
@value = params.dig(:value)
|
29
|
+
end
|
30
|
+
|
31
|
+
##
|
32
|
+
# @return [String] The value of the financial report cell
|
33
|
+
attr_accessor :value
|
34
|
+
|
35
|
+
##
|
36
|
+
# @return [object] This object as a JSON key-value structure
|
37
|
+
def as_json(options={})
|
38
|
+
{
|
39
|
+
'value' => @value,
|
40
|
+
}
|
41
|
+
end
|
42
|
+
|
43
|
+
##
|
44
|
+
# @return [String] This object converted to a JSON string
|
45
|
+
def to_json(*options)
|
46
|
+
"[#{as_json(*options).to_json(*options)}]"
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
@@ -0,0 +1,79 @@
|
|
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 'json'
|
18
|
+
|
19
|
+
module LockstepSdk
|
20
|
+
|
21
|
+
##
|
22
|
+
# Represents a Financial Report
|
23
|
+
class FinancialReportModel
|
24
|
+
|
25
|
+
##
|
26
|
+
# Initialize the FinancialReportModel using the provided prototype
|
27
|
+
def initialize(params = {})
|
28
|
+
@report_name = params.dig(:report_name)
|
29
|
+
@group_key = params.dig(:group_key)
|
30
|
+
@report_start_date = params.dig(:report_start_date)
|
31
|
+
@report_end_date = params.dig(:report_end_date)
|
32
|
+
@report_created_date = params.dig(:report_created_date)
|
33
|
+
@rows = params.dig(:rows)
|
34
|
+
end
|
35
|
+
|
36
|
+
##
|
37
|
+
# @return [String] The name of the report ("*Report Type* for *Company*")
|
38
|
+
attr_accessor :report_name
|
39
|
+
|
40
|
+
##
|
41
|
+
# @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).
|
42
|
+
attr_accessor :group_key
|
43
|
+
|
44
|
+
##
|
45
|
+
# @return [Date-time] The start date of the financial report
|
46
|
+
attr_accessor :report_start_date
|
47
|
+
|
48
|
+
##
|
49
|
+
# @return [Date-time] The end date of the financial report
|
50
|
+
attr_accessor :report_end_date
|
51
|
+
|
52
|
+
##
|
53
|
+
# @return [Date-time] The created date of the financial report
|
54
|
+
attr_accessor :report_created_date
|
55
|
+
|
56
|
+
##
|
57
|
+
# @return [FinancialReportRowModel] The rows of the financial report
|
58
|
+
attr_accessor :rows
|
59
|
+
|
60
|
+
##
|
61
|
+
# @return [object] This object as a JSON key-value structure
|
62
|
+
def as_json(options={})
|
63
|
+
{
|
64
|
+
'reportName' => @report_name,
|
65
|
+
'groupKey' => @group_key,
|
66
|
+
'reportStartDate' => @report_start_date,
|
67
|
+
'reportEndDate' => @report_end_date,
|
68
|
+
'reportCreatedDate' => @report_created_date,
|
69
|
+
'rows' => @rows,
|
70
|
+
}
|
71
|
+
end
|
72
|
+
|
73
|
+
##
|
74
|
+
# @return [String] This object converted to a JSON string
|
75
|
+
def to_json(*options)
|
76
|
+
"[#{as_json(*options).to_json(*options)}]"
|
77
|
+
end
|
78
|
+
end
|
79
|
+
end
|
@@ -0,0 +1,67 @@
|
|
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 'json'
|
18
|
+
|
19
|
+
module LockstepSdk
|
20
|
+
|
21
|
+
##
|
22
|
+
# Represents a row of a financial Report report
|
23
|
+
class FinancialReportRowModel
|
24
|
+
|
25
|
+
##
|
26
|
+
# Initialize the FinancialReportRowModel using the provided prototype
|
27
|
+
def initialize(params = {})
|
28
|
+
@row_type = params.dig(:row_type)
|
29
|
+
@label = params.dig(:label)
|
30
|
+
@rows = params.dig(:rows)
|
31
|
+
@cells = params.dig(:cells)
|
32
|
+
end
|
33
|
+
|
34
|
+
##
|
35
|
+
# @return [String] Describes what type of row this row is (Header, Summary, Classification, Category, Subcategory, Data)
|
36
|
+
attr_accessor :row_type
|
37
|
+
|
38
|
+
##
|
39
|
+
# @return [String] The label for the row if it is a Classification, Category, or Subcategory.
|
40
|
+
attr_accessor :label
|
41
|
+
|
42
|
+
##
|
43
|
+
# @return [FinancialReportRowModel] The sub rows of this row if it is a Classification, Category, or Subcategory.
|
44
|
+
attr_accessor :rows
|
45
|
+
|
46
|
+
##
|
47
|
+
# @return [FinancialReportCellModel] The cells of the row
|
48
|
+
attr_accessor :cells
|
49
|
+
|
50
|
+
##
|
51
|
+
# @return [object] This object as a JSON key-value structure
|
52
|
+
def as_json(options={})
|
53
|
+
{
|
54
|
+
'rowType' => @row_type,
|
55
|
+
'label' => @label,
|
56
|
+
'rows' => @rows,
|
57
|
+
'cells' => @cells,
|
58
|
+
}
|
59
|
+
end
|
60
|
+
|
61
|
+
##
|
62
|
+
# @return [String] This object converted to a JSON string
|
63
|
+
def to_json(*options)
|
64
|
+
"[#{as_json(*options).to_json(*options)}]"
|
65
|
+
end
|
66
|
+
end
|
67
|
+
end
|
@@ -53,15 +53,15 @@ module LockstepSdk
|
|
53
53
|
attr_accessor :group_key
|
54
54
|
|
55
55
|
##
|
56
|
-
# @return [String] The name of the table the
|
56
|
+
# @return [String] A Note is connected to an existing item within the Lockstep Platform by the fields `TableKey` and `ObjectKey`. For example, a Note connected to Invoice 12345 would have a `TableKey` value of `Invoice` and an `ObjectKey` value of `12345`. The `TableKey` value contains the name of the table within the Lockstep Platform to which this metadata is connected. For more information, see [linking metadata to an object](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
|
57
57
|
attr_accessor :table_key
|
58
58
|
|
59
59
|
##
|
60
|
-
# @return [Uuid] The
|
60
|
+
# @return [Uuid] A Note is connected to an existing item within the Lockstep Platform by the fields `TableKey` and `ObjectKey`. For example, a Note connected to Invoice 12345 would have a `TableKey` value of `Invoice` and an `ObjectKey` value of `12345`. The `ObjectKey` value contains the primary key of the record within the Lockstep Platform to which this metadata is connected. For more information, see [linking metadata to an object](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
|
61
61
|
attr_accessor :object_key
|
62
62
|
|
63
63
|
##
|
64
|
-
# @return [String] The text of the note
|
64
|
+
# @return [String] The full text of the note
|
65
65
|
attr_accessor :note_text
|
66
66
|
|
67
67
|
##
|
@@ -69,7 +69,7 @@ module LockstepSdk
|
|
69
69
|
attr_accessor :note_type
|
70
70
|
|
71
71
|
##
|
72
|
-
# @return [Boolean]
|
72
|
+
# @return [Boolean] A flag indicating whether this Note is archived (also known as hidden or deleted). When you call [ArchiveNote](https://developer.lockstep.io/reference/delete_api-v1-notes-id) this field will be set to true. You should avoid displaying Notes with the IsArchived field set to true in your user interface.
|
73
73
|
attr_accessor :is_archived
|
74
74
|
|
75
75
|
##
|
@@ -77,7 +77,7 @@ module LockstepSdk
|
|
77
77
|
attr_accessor :created
|
78
78
|
|
79
79
|
##
|
80
|
-
# @return [Uuid] The ID of the user who created
|
80
|
+
# @return [Uuid] The unique ID of the [UserAccount](https://developer.lockstep.io/docs/useraccountmodel) of the user who created this Note.
|
81
81
|
attr_accessor :created_user_id
|
82
82
|
|
83
83
|
##
|
@@ -26,41 +26,23 @@ module LockstepSdk
|
|
26
26
|
# Initialize the ProvisioningModel using the provided prototype
|
27
27
|
def initialize(params = {})
|
28
28
|
@full_name = params.dig(:full_name)
|
29
|
-
@time_zone = params.dig(:time_zone)
|
30
|
-
@default_currency = params.dig(:default_currency)
|
31
29
|
@erp = params.dig(:erp)
|
32
|
-
@company = params.dig(:company)
|
33
30
|
end
|
34
31
|
|
35
32
|
##
|
36
33
|
# @return [String] The full name of the new user
|
37
34
|
attr_accessor :full_name
|
38
35
|
|
39
|
-
##
|
40
|
-
# @return [String] The time zone of the new user
|
41
|
-
attr_accessor :time_zone
|
42
|
-
|
43
|
-
##
|
44
|
-
# @return [String] The default currency of the new user
|
45
|
-
attr_accessor :default_currency
|
46
|
-
|
47
36
|
##
|
48
37
|
# @return [ErpInfoModel] The information necessary to enroll the user in their ERP
|
49
38
|
attr_accessor :erp
|
50
39
|
|
51
|
-
##
|
52
|
-
# @return [CompanyModel] The company information for the new user and group
|
53
|
-
attr_accessor :company
|
54
|
-
|
55
40
|
##
|
56
41
|
# @return [object] This object as a JSON key-value structure
|
57
42
|
def as_json(options={})
|
58
43
|
{
|
59
44
|
'fullName' => @full_name,
|
60
|
-
'timeZone' => @time_zone,
|
61
|
-
'defaultCurrency' => @default_currency,
|
62
45
|
'erp' => @erp,
|
63
|
-
'company' => @company,
|
64
46
|
}
|
65
47
|
end
|
66
48
|
|
@@ -0,0 +1,49 @@
|
|
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 'json'
|
18
|
+
|
19
|
+
module LockstepSdk
|
20
|
+
|
21
|
+
##
|
22
|
+
# Represents a cell of a trial balance report
|
23
|
+
class TrialBalanceReportCellModel
|
24
|
+
|
25
|
+
##
|
26
|
+
# Initialize the TrialBalanceReportCellModel using the provided prototype
|
27
|
+
def initialize(params = {})
|
28
|
+
@value = params.dig(:value)
|
29
|
+
end
|
30
|
+
|
31
|
+
##
|
32
|
+
# @return [String] The value of the trial balance report cell
|
33
|
+
attr_accessor :value
|
34
|
+
|
35
|
+
##
|
36
|
+
# @return [object] This object as a JSON key-value structure
|
37
|
+
def as_json(options={})
|
38
|
+
{
|
39
|
+
'value' => @value,
|
40
|
+
}
|
41
|
+
end
|
42
|
+
|
43
|
+
##
|
44
|
+
# @return [String] This object converted to a JSON string
|
45
|
+
def to_json(*options)
|
46
|
+
"[#{as_json(*options).to_json(*options)}]"
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
@@ -0,0 +1,79 @@
|
|
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 'json'
|
18
|
+
|
19
|
+
module LockstepSdk
|
20
|
+
|
21
|
+
##
|
22
|
+
# Represents a Trial Balance Report
|
23
|
+
class TrialBalanceReportModel
|
24
|
+
|
25
|
+
##
|
26
|
+
# Initialize the TrialBalanceReportModel using the provided prototype
|
27
|
+
def initialize(params = {})
|
28
|
+
@report_name = params.dig(:report_name)
|
29
|
+
@group_key = params.dig(:group_key)
|
30
|
+
@report_start_date = params.dig(:report_start_date)
|
31
|
+
@report_end_date = params.dig(:report_end_date)
|
32
|
+
@report_created_date = params.dig(:report_created_date)
|
33
|
+
@rows = params.dig(:rows)
|
34
|
+
end
|
35
|
+
|
36
|
+
##
|
37
|
+
# @return [String] The name of the report ("Trial Balance for *Company*")
|
38
|
+
attr_accessor :report_name
|
39
|
+
|
40
|
+
##
|
41
|
+
# @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).
|
42
|
+
attr_accessor :group_key
|
43
|
+
|
44
|
+
##
|
45
|
+
# @return [Date-time] The start date of the trial balance report
|
46
|
+
attr_accessor :report_start_date
|
47
|
+
|
48
|
+
##
|
49
|
+
# @return [Date-time] The end date of the trial balance report
|
50
|
+
attr_accessor :report_end_date
|
51
|
+
|
52
|
+
##
|
53
|
+
# @return [Date-time] The created date of the trial balance report
|
54
|
+
attr_accessor :report_created_date
|
55
|
+
|
56
|
+
##
|
57
|
+
# @return [TrialBalanceReportRowModel] The rows of the trial balance report
|
58
|
+
attr_accessor :rows
|
59
|
+
|
60
|
+
##
|
61
|
+
# @return [object] This object as a JSON key-value structure
|
62
|
+
def as_json(options={})
|
63
|
+
{
|
64
|
+
'reportName' => @report_name,
|
65
|
+
'groupKey' => @group_key,
|
66
|
+
'reportStartDate' => @report_start_date,
|
67
|
+
'reportEndDate' => @report_end_date,
|
68
|
+
'reportCreatedDate' => @report_created_date,
|
69
|
+
'rows' => @rows,
|
70
|
+
}
|
71
|
+
end
|
72
|
+
|
73
|
+
##
|
74
|
+
# @return [String] This object converted to a JSON string
|
75
|
+
def to_json(*options)
|
76
|
+
"[#{as_json(*options).to_json(*options)}]"
|
77
|
+
end
|
78
|
+
end
|
79
|
+
end
|
@@ -0,0 +1,67 @@
|
|
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 'json'
|
18
|
+
|
19
|
+
module LockstepSdk
|
20
|
+
|
21
|
+
##
|
22
|
+
# Represents a row of a trial balance report
|
23
|
+
class TrialBalanceReportRowModel
|
24
|
+
|
25
|
+
##
|
26
|
+
# Initialize the TrialBalanceReportRowModel using the provided prototype
|
27
|
+
def initialize(params = {})
|
28
|
+
@row_type = params.dig(:row_type)
|
29
|
+
@label = params.dig(:label)
|
30
|
+
@rows = params.dig(:rows)
|
31
|
+
@cells = params.dig(:cells)
|
32
|
+
end
|
33
|
+
|
34
|
+
##
|
35
|
+
# @return [String] Describes what type of row this row is (Header, Summary, Classification, Category, Subcategory, Data)
|
36
|
+
attr_accessor :row_type
|
37
|
+
|
38
|
+
##
|
39
|
+
# @return [String] The label for the row if it is a Classification, Category, or Subcategory.
|
40
|
+
attr_accessor :label
|
41
|
+
|
42
|
+
##
|
43
|
+
# @return [TrialBalanceReportRowModel] The sub rows of this row if it is a Classification, Category, or Subcategory.
|
44
|
+
attr_accessor :rows
|
45
|
+
|
46
|
+
##
|
47
|
+
# @return [TrialBalanceReportCellModel] The cells of the row
|
48
|
+
attr_accessor :cells
|
49
|
+
|
50
|
+
##
|
51
|
+
# @return [object] This object as a JSON key-value structure
|
52
|
+
def as_json(options={})
|
53
|
+
{
|
54
|
+
'rowType' => @row_type,
|
55
|
+
'label' => @label,
|
56
|
+
'rows' => @rows,
|
57
|
+
'cells' => @cells,
|
58
|
+
}
|
59
|
+
end
|
60
|
+
|
61
|
+
##
|
62
|
+
# @return [String] This object converted to a JSON string
|
63
|
+
def to_json(*options)
|
64
|
+
"[#{as_json(*options).to_json(*options)}]"
|
65
|
+
end
|
66
|
+
end
|
67
|
+
end
|
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: 2022.
|
4
|
+
version: 2022.10.63.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Lockstep
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-03-
|
11
|
+
date: 2022-03-14 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: awrence
|
@@ -105,6 +105,9 @@ files:
|
|
105
105
|
- lib/lockstep_sdk/models/erp_model.rb
|
106
106
|
- lib/lockstep_sdk/models/financial_account_balance_history_model.rb
|
107
107
|
- lib/lockstep_sdk/models/financial_account_model.rb
|
108
|
+
- lib/lockstep_sdk/models/financial_report_cell_model.rb
|
109
|
+
- lib/lockstep_sdk/models/financial_report_model.rb
|
110
|
+
- lib/lockstep_sdk/models/financial_report_row_model.rb
|
108
111
|
- lib/lockstep_sdk/models/financial_year_setting_model.rb
|
109
112
|
- lib/lockstep_sdk/models/invite_data_model.rb
|
110
113
|
- lib/lockstep_sdk/models/invite_model.rb
|
@@ -137,6 +140,9 @@ files:
|
|
137
140
|
- lib/lockstep_sdk/models/sync_submit_model.rb
|
138
141
|
- lib/lockstep_sdk/models/transfer_owner_model.rb
|
139
142
|
- lib/lockstep_sdk/models/transfer_owner_submit_model.rb
|
143
|
+
- lib/lockstep_sdk/models/trial_balance_report_cell_model.rb
|
144
|
+
- lib/lockstep_sdk/models/trial_balance_report_model.rb
|
145
|
+
- lib/lockstep_sdk/models/trial_balance_report_row_model.rb
|
140
146
|
- lib/lockstep_sdk/models/uri_model.rb
|
141
147
|
- lib/lockstep_sdk/models/user_account_model.rb
|
142
148
|
- lib/lockstep_sdk/models/user_role_model.rb
|