@smartbooks-ai/api-client 0.0.6 → 0.0.8
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.
- package/package.json +14 -15
- package/src/.openapi-generator/FILES +0 -56
- package/src/.openapi-generator/VERSION +0 -1
- package/src/.openapi-generator-ignore +0 -23
- package/src/dist/esm/index.d.ts +0 -1
- package/src/dist/esm/index.js +0 -1
- package/src/dist/esm/src/apis/AiApi.d.ts +0 -289
- package/src/dist/esm/src/apis/AiApi.js +0 -452
- package/src/dist/esm/src/apis/AnalyticsApi.d.ts +0 -242
- package/src/dist/esm/src/apis/AnalyticsApi.js +0 -391
- package/src/dist/esm/src/apis/AsyncOperationsApi.d.ts +0 -48
- package/src/dist/esm/src/apis/AsyncOperationsApi.js +0 -53
- package/src/dist/esm/src/apis/BusinessModelModulesApi.d.ts +0 -182
- package/src/dist/esm/src/apis/BusinessModelModulesApi.js +0 -285
- package/src/dist/esm/src/apis/ColorPalettesApi.d.ts +0 -62
- package/src/dist/esm/src/apis/ColorPalettesApi.js +0 -78
- package/src/dist/esm/src/apis/CommentsApi.d.ts +0 -94
- package/src/dist/esm/src/apis/CommentsApi.js +0 -134
- package/src/dist/esm/src/apis/CompaniesApi.d.ts +0 -88
- package/src/dist/esm/src/apis/CompaniesApi.js +0 -118
- package/src/dist/esm/src/apis/CompanyManagementApi.d.ts +0 -90
- package/src/dist/esm/src/apis/CompanyManagementApi.js +0 -123
- package/src/dist/esm/src/apis/ConnectionParametersApi.d.ts +0 -98
- package/src/dist/esm/src/apis/ConnectionParametersApi.js +0 -151
- package/src/dist/esm/src/apis/ConnectionTypesApi.d.ts +0 -90
- package/src/dist/esm/src/apis/ConnectionTypesApi.js +0 -124
- package/src/dist/esm/src/apis/ConnectionsApi.d.ts +0 -156
- package/src/dist/esm/src/apis/ConnectionsApi.js +0 -236
- package/src/dist/esm/src/apis/ConnectionsAuthorizationApi.d.ts +0 -74
- package/src/dist/esm/src/apis/ConnectionsAuthorizationApi.js +0 -108
- package/src/dist/esm/src/apis/ConnectionsClientCredentialsApi.d.ts +0 -72
- package/src/dist/esm/src/apis/ConnectionsClientCredentialsApi.js +0 -100
- package/src/dist/esm/src/apis/ConsolidationApi.d.ts +0 -192
- package/src/dist/esm/src/apis/ConsolidationApi.js +0 -297
- package/src/dist/esm/src/apis/CostCenterApi.d.ts +0 -130
- package/src/dist/esm/src/apis/CostCenterApi.js +0 -188
- package/src/dist/esm/src/apis/DashboardsApi.d.ts +0 -306
- package/src/dist/esm/src/apis/DashboardsApi.js +0 -515
- package/src/dist/esm/src/apis/DataSynchronizationApi.d.ts +0 -92
- package/src/dist/esm/src/apis/DataSynchronizationApi.js +0 -127
- package/src/dist/esm/src/apis/ExplanationApi.d.ts +0 -110
- package/src/dist/esm/src/apis/ExplanationApi.js +0 -227
- package/src/dist/esm/src/apis/FormatsApi.d.ts +0 -46
- package/src/dist/esm/src/apis/FormatsApi.js +0 -48
- package/src/dist/esm/src/apis/FormulasApi.d.ts +0 -62
- package/src/dist/esm/src/apis/FormulasApi.js +0 -81
- package/src/dist/esm/src/apis/FuturesApi.d.ts +0 -136
- package/src/dist/esm/src/apis/FuturesApi.js +0 -204
- package/src/dist/esm/src/apis/IdentityLinkingApi.d.ts +0 -46
- package/src/dist/esm/src/apis/IdentityLinkingApi.js +0 -49
- package/src/dist/esm/src/apis/InputApi.d.ts +0 -55
- package/src/dist/esm/src/apis/InputApi.js +0 -57
- package/src/dist/esm/src/apis/IntercompanyMatchingApi.d.ts +0 -174
- package/src/dist/esm/src/apis/IntercompanyMatchingApi.js +0 -260
- package/src/dist/esm/src/apis/InvitationsApi.d.ts +0 -156
- package/src/dist/esm/src/apis/InvitationsApi.js +0 -235
- package/src/dist/esm/src/apis/MaintenanceApi.d.ts +0 -182
- package/src/dist/esm/src/apis/MaintenanceApi.js +0 -278
- package/src/dist/esm/src/apis/ManualInputApi.d.ts +0 -204
- package/src/dist/esm/src/apis/ManualInputApi.js +0 -328
- package/src/dist/esm/src/apis/ModulesApi.d.ts +0 -88
- package/src/dist/esm/src/apis/ModulesApi.js +0 -112
- package/src/dist/esm/src/apis/NodePurposesApi.d.ts +0 -68
- package/src/dist/esm/src/apis/NodePurposesApi.js +0 -86
- package/src/dist/esm/src/apis/ProfileApi.d.ts +0 -85
- package/src/dist/esm/src/apis/ProfileApi.js +0 -114
- package/src/dist/esm/src/apis/RelationsApi.d.ts +0 -46
- package/src/dist/esm/src/apis/RelationsApi.js +0 -48
- package/src/dist/esm/src/apis/ReportGroupsApi.d.ts +0 -72
- package/src/dist/esm/src/apis/ReportGroupsApi.js +0 -92
- package/src/dist/esm/src/apis/ReportingApi.d.ts +0 -267
- package/src/dist/esm/src/apis/ReportingApi.js +0 -379
- package/src/dist/esm/src/apis/ReportingPeriodsApi.d.ts +0 -46
- package/src/dist/esm/src/apis/ReportingPeriodsApi.js +0 -48
- package/src/dist/esm/src/apis/SourceAccountsApi.d.ts +0 -46
- package/src/dist/esm/src/apis/SourceAccountsApi.js +0 -48
- package/src/dist/esm/src/apis/StructureApi.d.ts +0 -134
- package/src/dist/esm/src/apis/StructureApi.js +0 -163
- package/src/dist/esm/src/apis/StructureDefinitionApi.d.ts +0 -164
- package/src/dist/esm/src/apis/StructureDefinitionApi.js +0 -259
- package/src/dist/esm/src/apis/StructureImprovementApi.d.ts +0 -70
- package/src/dist/esm/src/apis/StructureImprovementApi.js +0 -91
- package/src/dist/esm/src/apis/TemplatesApi.d.ts +0 -120
- package/src/dist/esm/src/apis/TemplatesApi.js +0 -178
- package/src/dist/esm/src/apis/TemplatesGenerationApi.d.ts +0 -66
- package/src/dist/esm/src/apis/TemplatesGenerationApi.js +0 -85
- package/src/dist/esm/src/apis/TenantIntercompanySettingsApi.d.ts +0 -90
- package/src/dist/esm/src/apis/TenantIntercompanySettingsApi.js +0 -123
- package/src/dist/esm/src/apis/TenantsApi.d.ts +0 -124
- package/src/dist/esm/src/apis/TenantsApi.js +0 -180
- package/src/dist/esm/src/apis/TransactionDetailsApi.d.ts +0 -50
- package/src/dist/esm/src/apis/TransactionDetailsApi.js +0 -57
- package/src/dist/esm/src/apis/UsersApi.d.ts +0 -114
- package/src/dist/esm/src/apis/UsersApi.js +0 -165
- package/src/dist/esm/src/apis/WebhooksApi.d.ts +0 -68
- package/src/dist/esm/src/apis/WebhooksApi.js +0 -86
- package/src/dist/esm/src/apis/WizardApi.d.ts +0 -74
- package/src/dist/esm/src/apis/WizardApi.js +0 -101
- package/src/dist/esm/src/apis/index.d.ts +0 -46
- package/src/dist/esm/src/apis/index.js +0 -48
- package/src/dist/esm/src/index.d.ts +0 -3
- package/src/dist/esm/src/index.js +0 -5
- package/src/dist/esm/src/models/index.d.ts +0 -15406
- package/src/dist/esm/src/models/index.js +0 -1279
- package/src/dist/esm/src/runtime.d.ts +0 -181
- package/src/dist/esm/src/runtime.js +0 -326
- package/src/index.ts +0 -1
- package/src/package.json +0 -24
- package/src/src/apis/AiApi.ts +0 -1043
- package/src/src/apis/AnalyticsApi.ts +0 -925
- package/src/src/apis/AsyncOperationsApi.ts +0 -112
- package/src/src/apis/BusinessModelModulesApi.ts +0 -649
- package/src/src/apis/ColorPalettesApi.ts +0 -148
- package/src/src/apis/CommentsApi.ts +0 -308
- package/src/src/apis/CompaniesApi.ts +0 -260
- package/src/src/apis/CompanyManagementApi.ts +0 -270
- package/src/src/apis/ConnectionParametersApi.ts +0 -339
- package/src/src/apis/ConnectionTypesApi.ts +0 -280
- package/src/src/apis/ConnectionsApi.ts +0 -533
- package/src/src/apis/ConnectionsAuthorizationApi.ts +0 -241
- package/src/src/apis/ConnectionsClientCredentialsApi.ts +0 -224
- package/src/src/apis/ConsolidationApi.ts +0 -682
- package/src/src/apis/CostCenterApi.ts +0 -428
- package/src/src/apis/DashboardsApi.ts +0 -1179
- package/src/src/apis/DataSynchronizationApi.ts +0 -288
- package/src/src/apis/ExplanationApi.ts +0 -504
- package/src/src/apis/FormatsApi.ts +0 -96
- package/src/src/apis/FormulasApi.ts +0 -154
- package/src/src/apis/FuturesApi.ts +0 -463
- package/src/src/apis/IdentityLinkingApi.ts +0 -101
- package/src/src/apis/InputApi.ts +0 -126
- package/src/src/apis/IntercompanyMatchingApi.ts +0 -588
- package/src/src/apis/InvitationsApi.ts +0 -523
- package/src/src/apis/MaintenanceApi.ts +0 -597
- package/src/src/apis/ManualInputApi.ts +0 -771
- package/src/src/apis/ModulesApi.ts +0 -246
- package/src/src/apis/NodePurposesApi.ts +0 -184
- package/src/src/apis/ProfileApi.ts +0 -203
- package/src/src/apis/RelationsApi.ts +0 -99
- package/src/src/apis/ReportGroupsApi.ts +0 -205
- package/src/src/apis/ReportingApi.ts +0 -851
- package/src/src/apis/ReportingPeriodsApi.ts +0 -99
- package/src/src/apis/SourceAccountsApi.ts +0 -102
- package/src/src/apis/StructureApi.ts +0 -334
- package/src/src/apis/StructureDefinitionApi.ts +0 -601
- package/src/src/apis/StructureImprovementApi.ts +0 -214
- package/src/src/apis/TemplatesApi.ts +0 -334
- package/src/src/apis/TemplatesGenerationApi.ts +0 -187
- package/src/src/apis/TenantIntercompanySettingsApi.ts +0 -286
- package/src/src/apis/TenantsApi.ts +0 -374
- package/src/src/apis/TransactionDetailsApi.ts +0 -127
- package/src/src/apis/UsersApi.ts +0 -356
- package/src/src/apis/WebhooksApi.ts +0 -193
- package/src/src/apis/WizardApi.ts +0 -230
- package/src/src/apis/index.ts +0 -48
- package/src/src/index.ts +0 -5
- package/src/src/models/index.ts +0 -15625
- package/src/src/runtime.ts +0 -469
- package/src/tsconfig.esm.json +0 -7
- package/src/tsconfig.json +0 -11
- package/tsconfig.json +0 -11
|
@@ -1,851 +0,0 @@
|
|
|
1
|
-
/* tslint:disable */
|
|
2
|
-
/* eslint-disable */
|
|
3
|
-
/**
|
|
4
|
-
* Smartbooks Restful API
|
|
5
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
6
|
-
*
|
|
7
|
-
* The version of the OpenAPI document: 0.0.1
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
-
* https://openapi-generator.tech
|
|
12
|
-
* Do not edit the class manually.
|
|
13
|
-
*/
|
|
14
|
-
import type {
|
|
15
|
-
AmountsResponse,
|
|
16
|
-
BulkReportGenerationRequest,
|
|
17
|
-
BulkReportGenerationResponse,
|
|
18
|
-
GeneratedReport,
|
|
19
|
-
OutstandingPayables,
|
|
20
|
-
OutstandingReceivables,
|
|
21
|
-
PreviewGenerationResponse,
|
|
22
|
-
ReportDataResponse,
|
|
23
|
-
ReportGenerationRequest,
|
|
24
|
-
ReportGroupsResponse,
|
|
25
|
-
ReportPreviewGenerationRequest,
|
|
26
|
-
} from '../models/index';
|
|
27
|
-
import * as runtime from '../runtime';
|
|
28
|
-
|
|
29
|
-
export interface ReportingApiForVisualRequest {
|
|
30
|
-
companyCode: string;
|
|
31
|
-
reportGenerationRequest: ReportGenerationRequest;
|
|
32
|
-
}
|
|
33
|
-
|
|
34
|
-
export interface ReportingApiForVisualsRequest {
|
|
35
|
-
companyCode: string;
|
|
36
|
-
bulkReportGenerationRequest: BulkReportGenerationRequest;
|
|
37
|
-
}
|
|
38
|
-
|
|
39
|
-
export interface ReportingApiOutstandingPayablesRequest {
|
|
40
|
-
companyCode: string;
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
export interface ReportingApiOutstandingReceivablesRequest {
|
|
44
|
-
companyCode: string;
|
|
45
|
-
}
|
|
46
|
-
|
|
47
|
-
export interface ReportingApiPreviewReportRequest {
|
|
48
|
-
companyCode: string;
|
|
49
|
-
reportPreviewGenerationRequest: ReportPreviewGenerationRequest;
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
export interface ReportingApiReportDataRequest {
|
|
53
|
-
companyCode: string;
|
|
54
|
-
reportGroupCode: string;
|
|
55
|
-
reportCode: string;
|
|
56
|
-
}
|
|
57
|
-
|
|
58
|
-
export interface ReportingApiReportGroupsRequest {
|
|
59
|
-
companyCode: string;
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
export interface ReportingApiYearlyAmountsRequest {
|
|
63
|
-
companyCode: string;
|
|
64
|
-
year: number | null;
|
|
65
|
-
category?: string | null;
|
|
66
|
-
entity?: string | null;
|
|
67
|
-
businessDimensionMember?: string | null;
|
|
68
|
-
view?: YearlyAmountsViewEnum;
|
|
69
|
-
experimental?: string | null;
|
|
70
|
-
glimpse?: boolean | null;
|
|
71
|
-
moduleCode?: string | null;
|
|
72
|
-
structureType?: YearlyAmountsStructureTypeEnum;
|
|
73
|
-
}
|
|
74
|
-
|
|
75
|
-
/**
|
|
76
|
-
* ReportingApi - interface
|
|
77
|
-
*
|
|
78
|
-
* @export
|
|
79
|
-
* @interface ReportingApiInterface
|
|
80
|
-
*/
|
|
81
|
-
export interface ReportingApiInterface {
|
|
82
|
-
/**
|
|
83
|
-
*
|
|
84
|
-
* @param {string} companyCode
|
|
85
|
-
* @param {ReportGenerationRequest} reportGenerationRequest
|
|
86
|
-
* @param {*} [options] Override http request option.
|
|
87
|
-
* @throws {RequiredError}
|
|
88
|
-
* @memberof ReportingApiInterface
|
|
89
|
-
*/
|
|
90
|
-
forVisualRaw(
|
|
91
|
-
requestParameters: ReportingApiForVisualRequest,
|
|
92
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
93
|
-
): Promise<runtime.ApiResponse<GeneratedReport>>;
|
|
94
|
-
|
|
95
|
-
/**
|
|
96
|
-
*/
|
|
97
|
-
forVisual(
|
|
98
|
-
companyCode: string,
|
|
99
|
-
reportGenerationRequest: ReportGenerationRequest,
|
|
100
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
101
|
-
): Promise<GeneratedReport>;
|
|
102
|
-
|
|
103
|
-
/**
|
|
104
|
-
*
|
|
105
|
-
* @param {string} companyCode
|
|
106
|
-
* @param {BulkReportGenerationRequest} bulkReportGenerationRequest
|
|
107
|
-
* @param {*} [options] Override http request option.
|
|
108
|
-
* @throws {RequiredError}
|
|
109
|
-
* @memberof ReportingApiInterface
|
|
110
|
-
*/
|
|
111
|
-
forVisualsRaw(
|
|
112
|
-
requestParameters: ReportingApiForVisualsRequest,
|
|
113
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
114
|
-
): Promise<runtime.ApiResponse<BulkReportGenerationResponse>>;
|
|
115
|
-
|
|
116
|
-
/**
|
|
117
|
-
*/
|
|
118
|
-
forVisuals(
|
|
119
|
-
companyCode: string,
|
|
120
|
-
bulkReportGenerationRequest: BulkReportGenerationRequest,
|
|
121
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
122
|
-
): Promise<BulkReportGenerationResponse>;
|
|
123
|
-
|
|
124
|
-
/**
|
|
125
|
-
* Get outstanding payables
|
|
126
|
-
* @summary Get outstanding payables
|
|
127
|
-
* @param {string} companyCode
|
|
128
|
-
* @param {*} [options] Override http request option.
|
|
129
|
-
* @throws {RequiredError}
|
|
130
|
-
* @memberof ReportingApiInterface
|
|
131
|
-
*/
|
|
132
|
-
outstandingPayablesRaw(
|
|
133
|
-
requestParameters: ReportingApiOutstandingPayablesRequest,
|
|
134
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
135
|
-
): Promise<runtime.ApiResponse<OutstandingPayables>>;
|
|
136
|
-
|
|
137
|
-
/**
|
|
138
|
-
* Get outstanding payables
|
|
139
|
-
* Get outstanding payables
|
|
140
|
-
*/
|
|
141
|
-
outstandingPayables(
|
|
142
|
-
companyCode: string,
|
|
143
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
144
|
-
): Promise<OutstandingPayables>;
|
|
145
|
-
|
|
146
|
-
/**
|
|
147
|
-
* Get outstanding receivables
|
|
148
|
-
* @summary Get outstanding receivables
|
|
149
|
-
* @param {string} companyCode
|
|
150
|
-
* @param {*} [options] Override http request option.
|
|
151
|
-
* @throws {RequiredError}
|
|
152
|
-
* @memberof ReportingApiInterface
|
|
153
|
-
*/
|
|
154
|
-
outstandingReceivablesRaw(
|
|
155
|
-
requestParameters: ReportingApiOutstandingReceivablesRequest,
|
|
156
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
157
|
-
): Promise<runtime.ApiResponse<OutstandingReceivables>>;
|
|
158
|
-
|
|
159
|
-
/**
|
|
160
|
-
* Get outstanding receivables
|
|
161
|
-
* Get outstanding receivables
|
|
162
|
-
*/
|
|
163
|
-
outstandingReceivables(
|
|
164
|
-
companyCode: string,
|
|
165
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
166
|
-
): Promise<OutstandingReceivables>;
|
|
167
|
-
|
|
168
|
-
/**
|
|
169
|
-
*
|
|
170
|
-
* @param {string} companyCode
|
|
171
|
-
* @param {ReportPreviewGenerationRequest} reportPreviewGenerationRequest
|
|
172
|
-
* @param {*} [options] Override http request option.
|
|
173
|
-
* @throws {RequiredError}
|
|
174
|
-
* @memberof ReportingApiInterface
|
|
175
|
-
*/
|
|
176
|
-
previewReportRaw(
|
|
177
|
-
requestParameters: ReportingApiPreviewReportRequest,
|
|
178
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
179
|
-
): Promise<runtime.ApiResponse<PreviewGenerationResponse>>;
|
|
180
|
-
|
|
181
|
-
/**
|
|
182
|
-
*/
|
|
183
|
-
previewReport(
|
|
184
|
-
companyCode: string,
|
|
185
|
-
reportPreviewGenerationRequest: ReportPreviewGenerationRequest,
|
|
186
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
187
|
-
): Promise<PreviewGenerationResponse>;
|
|
188
|
-
|
|
189
|
-
/**
|
|
190
|
-
* Get report data
|
|
191
|
-
* @summary Get report data
|
|
192
|
-
* @param {string} companyCode
|
|
193
|
-
* @param {string} reportGroupCode
|
|
194
|
-
* @param {string} reportCode
|
|
195
|
-
* @param {*} [options] Override http request option.
|
|
196
|
-
* @throws {RequiredError}
|
|
197
|
-
* @memberof ReportingApiInterface
|
|
198
|
-
*/
|
|
199
|
-
reportDataRaw(
|
|
200
|
-
requestParameters: ReportingApiReportDataRequest,
|
|
201
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
202
|
-
): Promise<runtime.ApiResponse<ReportDataResponse>>;
|
|
203
|
-
|
|
204
|
-
/**
|
|
205
|
-
* Get report data
|
|
206
|
-
* Get report data
|
|
207
|
-
*/
|
|
208
|
-
reportData(
|
|
209
|
-
companyCode: string,
|
|
210
|
-
reportGroupCode: string,
|
|
211
|
-
reportCode: string,
|
|
212
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
213
|
-
): Promise<ReportDataResponse>;
|
|
214
|
-
|
|
215
|
-
/**
|
|
216
|
-
* Get report groups
|
|
217
|
-
* @summary Get report groups
|
|
218
|
-
* @param {string} companyCode
|
|
219
|
-
* @param {*} [options] Override http request option.
|
|
220
|
-
* @throws {RequiredError}
|
|
221
|
-
* @memberof ReportingApiInterface
|
|
222
|
-
*/
|
|
223
|
-
reportGroupsRaw(
|
|
224
|
-
requestParameters: ReportingApiReportGroupsRequest,
|
|
225
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
226
|
-
): Promise<runtime.ApiResponse<ReportGroupsResponse>>;
|
|
227
|
-
|
|
228
|
-
/**
|
|
229
|
-
* Get report groups
|
|
230
|
-
* Get report groups
|
|
231
|
-
*/
|
|
232
|
-
reportGroups(
|
|
233
|
-
companyCode: string,
|
|
234
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
235
|
-
): Promise<ReportGroupsResponse>;
|
|
236
|
-
|
|
237
|
-
/**
|
|
238
|
-
* Get yearly amounts for a given year
|
|
239
|
-
* @summary Get yearly amounts
|
|
240
|
-
* @param {string} companyCode
|
|
241
|
-
* @param {number} year
|
|
242
|
-
* @param {string} [category]
|
|
243
|
-
* @param {string} [entity]
|
|
244
|
-
* @param {string} [businessDimensionMember]
|
|
245
|
-
* @param {'periodic' | 'ytd' | 'qtd' | 'ltd'} [view]
|
|
246
|
-
* @param {string} [experimental]
|
|
247
|
-
* @param {boolean} [glimpse]
|
|
248
|
-
* @param {string} [moduleCode]
|
|
249
|
-
* @param {'default' | 'cashflow'} [structureType]
|
|
250
|
-
* @param {*} [options] Override http request option.
|
|
251
|
-
* @throws {RequiredError}
|
|
252
|
-
* @memberof ReportingApiInterface
|
|
253
|
-
*/
|
|
254
|
-
yearlyAmountsRaw(
|
|
255
|
-
requestParameters: ReportingApiYearlyAmountsRequest,
|
|
256
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
257
|
-
): Promise<runtime.ApiResponse<AmountsResponse>>;
|
|
258
|
-
|
|
259
|
-
/**
|
|
260
|
-
* Get yearly amounts for a given year
|
|
261
|
-
* Get yearly amounts
|
|
262
|
-
*/
|
|
263
|
-
yearlyAmounts(
|
|
264
|
-
companyCode: string,
|
|
265
|
-
year: number | null,
|
|
266
|
-
category?: string | null,
|
|
267
|
-
entity?: string | null,
|
|
268
|
-
businessDimensionMember?: string | null,
|
|
269
|
-
view?: YearlyAmountsViewEnum,
|
|
270
|
-
experimental?: string | null,
|
|
271
|
-
glimpse?: boolean | null,
|
|
272
|
-
moduleCode?: string | null,
|
|
273
|
-
structureType?: YearlyAmountsStructureTypeEnum,
|
|
274
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
275
|
-
): Promise<AmountsResponse>;
|
|
276
|
-
}
|
|
277
|
-
|
|
278
|
-
/**
|
|
279
|
-
*
|
|
280
|
-
*/
|
|
281
|
-
export class ReportingApi extends runtime.BaseAPI implements ReportingApiInterface {
|
|
282
|
-
/**
|
|
283
|
-
*/
|
|
284
|
-
async forVisualRaw(
|
|
285
|
-
requestParameters: ReportingApiForVisualRequest,
|
|
286
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
287
|
-
): Promise<runtime.ApiResponse<GeneratedReport>> {
|
|
288
|
-
if (requestParameters['companyCode'] == null) {
|
|
289
|
-
throw new runtime.RequiredError(
|
|
290
|
-
'companyCode',
|
|
291
|
-
'Required parameter "companyCode" was null or undefined when calling forVisual().',
|
|
292
|
-
);
|
|
293
|
-
}
|
|
294
|
-
|
|
295
|
-
if (requestParameters['reportGenerationRequest'] == null) {
|
|
296
|
-
throw new runtime.RequiredError(
|
|
297
|
-
'reportGenerationRequest',
|
|
298
|
-
'Required parameter "reportGenerationRequest" was null or undefined when calling forVisual().',
|
|
299
|
-
);
|
|
300
|
-
}
|
|
301
|
-
|
|
302
|
-
const queryParameters: any = {};
|
|
303
|
-
|
|
304
|
-
const headerParameters: runtime.HTTPHeaders = {};
|
|
305
|
-
|
|
306
|
-
headerParameters['Content-Type'] = 'application/json';
|
|
307
|
-
|
|
308
|
-
if (this.configuration && this.configuration.accessToken) {
|
|
309
|
-
const token = this.configuration.accessToken;
|
|
310
|
-
const tokenString = await token('bearerToken', ['internal']);
|
|
311
|
-
|
|
312
|
-
if (tokenString) {
|
|
313
|
-
headerParameters['Authorization'] = `Bearer ${tokenString}`;
|
|
314
|
-
}
|
|
315
|
-
}
|
|
316
|
-
const response = await this.request(
|
|
317
|
-
{
|
|
318
|
-
path: `/api/v1/c/{company_code}/reporting/for-visual`.replace(
|
|
319
|
-
`{${'company_code'}}`,
|
|
320
|
-
encodeURIComponent(String(requestParameters['companyCode'])),
|
|
321
|
-
),
|
|
322
|
-
method: 'POST',
|
|
323
|
-
headers: headerParameters,
|
|
324
|
-
query: queryParameters,
|
|
325
|
-
body: requestParameters['reportGenerationRequest'],
|
|
326
|
-
},
|
|
327
|
-
initOverrides,
|
|
328
|
-
);
|
|
329
|
-
|
|
330
|
-
return new runtime.JSONApiResponse(response);
|
|
331
|
-
}
|
|
332
|
-
|
|
333
|
-
/**
|
|
334
|
-
*/
|
|
335
|
-
async forVisual(
|
|
336
|
-
companyCode: string,
|
|
337
|
-
reportGenerationRequest: ReportGenerationRequest,
|
|
338
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
339
|
-
): Promise<GeneratedReport> {
|
|
340
|
-
const response = await this.forVisualRaw(
|
|
341
|
-
{ companyCode: companyCode, reportGenerationRequest: reportGenerationRequest },
|
|
342
|
-
initOverrides,
|
|
343
|
-
);
|
|
344
|
-
return await response.value();
|
|
345
|
-
}
|
|
346
|
-
|
|
347
|
-
/**
|
|
348
|
-
*/
|
|
349
|
-
async forVisualsRaw(
|
|
350
|
-
requestParameters: ReportingApiForVisualsRequest,
|
|
351
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
352
|
-
): Promise<runtime.ApiResponse<BulkReportGenerationResponse>> {
|
|
353
|
-
if (requestParameters['companyCode'] == null) {
|
|
354
|
-
throw new runtime.RequiredError(
|
|
355
|
-
'companyCode',
|
|
356
|
-
'Required parameter "companyCode" was null or undefined when calling forVisuals().',
|
|
357
|
-
);
|
|
358
|
-
}
|
|
359
|
-
|
|
360
|
-
if (requestParameters['bulkReportGenerationRequest'] == null) {
|
|
361
|
-
throw new runtime.RequiredError(
|
|
362
|
-
'bulkReportGenerationRequest',
|
|
363
|
-
'Required parameter "bulkReportGenerationRequest" was null or undefined when calling forVisuals().',
|
|
364
|
-
);
|
|
365
|
-
}
|
|
366
|
-
|
|
367
|
-
const queryParameters: any = {};
|
|
368
|
-
|
|
369
|
-
const headerParameters: runtime.HTTPHeaders = {};
|
|
370
|
-
|
|
371
|
-
headerParameters['Content-Type'] = 'application/json';
|
|
372
|
-
|
|
373
|
-
if (this.configuration && this.configuration.accessToken) {
|
|
374
|
-
const token = this.configuration.accessToken;
|
|
375
|
-
const tokenString = await token('bearerToken', ['internal']);
|
|
376
|
-
|
|
377
|
-
if (tokenString) {
|
|
378
|
-
headerParameters['Authorization'] = `Bearer ${tokenString}`;
|
|
379
|
-
}
|
|
380
|
-
}
|
|
381
|
-
const response = await this.request(
|
|
382
|
-
{
|
|
383
|
-
path: `/api/v1/c/{company_code}/reporting/for-visuals`.replace(
|
|
384
|
-
`{${'company_code'}}`,
|
|
385
|
-
encodeURIComponent(String(requestParameters['companyCode'])),
|
|
386
|
-
),
|
|
387
|
-
method: 'POST',
|
|
388
|
-
headers: headerParameters,
|
|
389
|
-
query: queryParameters,
|
|
390
|
-
body: requestParameters['bulkReportGenerationRequest'],
|
|
391
|
-
},
|
|
392
|
-
initOverrides,
|
|
393
|
-
);
|
|
394
|
-
|
|
395
|
-
return new runtime.JSONApiResponse(response);
|
|
396
|
-
}
|
|
397
|
-
|
|
398
|
-
/**
|
|
399
|
-
*/
|
|
400
|
-
async forVisuals(
|
|
401
|
-
companyCode: string,
|
|
402
|
-
bulkReportGenerationRequest: BulkReportGenerationRequest,
|
|
403
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
404
|
-
): Promise<BulkReportGenerationResponse> {
|
|
405
|
-
const response = await this.forVisualsRaw(
|
|
406
|
-
{ companyCode: companyCode, bulkReportGenerationRequest: bulkReportGenerationRequest },
|
|
407
|
-
initOverrides,
|
|
408
|
-
);
|
|
409
|
-
return await response.value();
|
|
410
|
-
}
|
|
411
|
-
|
|
412
|
-
/**
|
|
413
|
-
* Get outstanding payables
|
|
414
|
-
* Get outstanding payables
|
|
415
|
-
*/
|
|
416
|
-
async outstandingPayablesRaw(
|
|
417
|
-
requestParameters: ReportingApiOutstandingPayablesRequest,
|
|
418
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
419
|
-
): Promise<runtime.ApiResponse<OutstandingPayables>> {
|
|
420
|
-
if (requestParameters['companyCode'] == null) {
|
|
421
|
-
throw new runtime.RequiredError(
|
|
422
|
-
'companyCode',
|
|
423
|
-
'Required parameter "companyCode" was null or undefined when calling outstandingPayables().',
|
|
424
|
-
);
|
|
425
|
-
}
|
|
426
|
-
|
|
427
|
-
const queryParameters: any = {};
|
|
428
|
-
|
|
429
|
-
const headerParameters: runtime.HTTPHeaders = {};
|
|
430
|
-
|
|
431
|
-
if (this.configuration && this.configuration.accessToken) {
|
|
432
|
-
const token = this.configuration.accessToken;
|
|
433
|
-
const tokenString = await token('bearerToken', ['reporting:read']);
|
|
434
|
-
|
|
435
|
-
if (tokenString) {
|
|
436
|
-
headerParameters['Authorization'] = `Bearer ${tokenString}`;
|
|
437
|
-
}
|
|
438
|
-
}
|
|
439
|
-
const response = await this.request(
|
|
440
|
-
{
|
|
441
|
-
path: `/api/v1/c/{company_code}/reporting/outstanding/payables`.replace(
|
|
442
|
-
`{${'company_code'}}`,
|
|
443
|
-
encodeURIComponent(String(requestParameters['companyCode'])),
|
|
444
|
-
),
|
|
445
|
-
method: 'GET',
|
|
446
|
-
headers: headerParameters,
|
|
447
|
-
query: queryParameters,
|
|
448
|
-
},
|
|
449
|
-
initOverrides,
|
|
450
|
-
);
|
|
451
|
-
|
|
452
|
-
return new runtime.JSONApiResponse(response);
|
|
453
|
-
}
|
|
454
|
-
|
|
455
|
-
/**
|
|
456
|
-
* Get outstanding payables
|
|
457
|
-
* Get outstanding payables
|
|
458
|
-
*/
|
|
459
|
-
async outstandingPayables(
|
|
460
|
-
companyCode: string,
|
|
461
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
462
|
-
): Promise<OutstandingPayables> {
|
|
463
|
-
const response = await this.outstandingPayablesRaw({ companyCode: companyCode }, initOverrides);
|
|
464
|
-
return await response.value();
|
|
465
|
-
}
|
|
466
|
-
|
|
467
|
-
/**
|
|
468
|
-
* Get outstanding receivables
|
|
469
|
-
* Get outstanding receivables
|
|
470
|
-
*/
|
|
471
|
-
async outstandingReceivablesRaw(
|
|
472
|
-
requestParameters: ReportingApiOutstandingReceivablesRequest,
|
|
473
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
474
|
-
): Promise<runtime.ApiResponse<OutstandingReceivables>> {
|
|
475
|
-
if (requestParameters['companyCode'] == null) {
|
|
476
|
-
throw new runtime.RequiredError(
|
|
477
|
-
'companyCode',
|
|
478
|
-
'Required parameter "companyCode" was null or undefined when calling outstandingReceivables().',
|
|
479
|
-
);
|
|
480
|
-
}
|
|
481
|
-
|
|
482
|
-
const queryParameters: any = {};
|
|
483
|
-
|
|
484
|
-
const headerParameters: runtime.HTTPHeaders = {};
|
|
485
|
-
|
|
486
|
-
if (this.configuration && this.configuration.accessToken) {
|
|
487
|
-
const token = this.configuration.accessToken;
|
|
488
|
-
const tokenString = await token('bearerToken', ['reporting:read']);
|
|
489
|
-
|
|
490
|
-
if (tokenString) {
|
|
491
|
-
headerParameters['Authorization'] = `Bearer ${tokenString}`;
|
|
492
|
-
}
|
|
493
|
-
}
|
|
494
|
-
const response = await this.request(
|
|
495
|
-
{
|
|
496
|
-
path: `/api/v1/c/{company_code}/reporting/outstanding/receivables`.replace(
|
|
497
|
-
`{${'company_code'}}`,
|
|
498
|
-
encodeURIComponent(String(requestParameters['companyCode'])),
|
|
499
|
-
),
|
|
500
|
-
method: 'GET',
|
|
501
|
-
headers: headerParameters,
|
|
502
|
-
query: queryParameters,
|
|
503
|
-
},
|
|
504
|
-
initOverrides,
|
|
505
|
-
);
|
|
506
|
-
|
|
507
|
-
return new runtime.JSONApiResponse(response);
|
|
508
|
-
}
|
|
509
|
-
|
|
510
|
-
/**
|
|
511
|
-
* Get outstanding receivables
|
|
512
|
-
* Get outstanding receivables
|
|
513
|
-
*/
|
|
514
|
-
async outstandingReceivables(
|
|
515
|
-
companyCode: string,
|
|
516
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
517
|
-
): Promise<OutstandingReceivables> {
|
|
518
|
-
const response = await this.outstandingReceivablesRaw({ companyCode: companyCode }, initOverrides);
|
|
519
|
-
return await response.value();
|
|
520
|
-
}
|
|
521
|
-
|
|
522
|
-
/**
|
|
523
|
-
*/
|
|
524
|
-
async previewReportRaw(
|
|
525
|
-
requestParameters: ReportingApiPreviewReportRequest,
|
|
526
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
527
|
-
): Promise<runtime.ApiResponse<PreviewGenerationResponse>> {
|
|
528
|
-
if (requestParameters['companyCode'] == null) {
|
|
529
|
-
throw new runtime.RequiredError(
|
|
530
|
-
'companyCode',
|
|
531
|
-
'Required parameter "companyCode" was null or undefined when calling previewReport().',
|
|
532
|
-
);
|
|
533
|
-
}
|
|
534
|
-
|
|
535
|
-
if (requestParameters['reportPreviewGenerationRequest'] == null) {
|
|
536
|
-
throw new runtime.RequiredError(
|
|
537
|
-
'reportPreviewGenerationRequest',
|
|
538
|
-
'Required parameter "reportPreviewGenerationRequest" was null or undefined when calling previewReport().',
|
|
539
|
-
);
|
|
540
|
-
}
|
|
541
|
-
|
|
542
|
-
const queryParameters: any = {};
|
|
543
|
-
|
|
544
|
-
const headerParameters: runtime.HTTPHeaders = {};
|
|
545
|
-
|
|
546
|
-
headerParameters['Content-Type'] = 'application/json';
|
|
547
|
-
|
|
548
|
-
if (this.configuration && this.configuration.accessToken) {
|
|
549
|
-
const token = this.configuration.accessToken;
|
|
550
|
-
const tokenString = await token('bearerToken', ['internal']);
|
|
551
|
-
|
|
552
|
-
if (tokenString) {
|
|
553
|
-
headerParameters['Authorization'] = `Bearer ${tokenString}`;
|
|
554
|
-
}
|
|
555
|
-
}
|
|
556
|
-
const response = await this.request(
|
|
557
|
-
{
|
|
558
|
-
path: `/api/v1/c/{company_code}/reporting/preview/report`.replace(
|
|
559
|
-
`{${'company_code'}}`,
|
|
560
|
-
encodeURIComponent(String(requestParameters['companyCode'])),
|
|
561
|
-
),
|
|
562
|
-
method: 'POST',
|
|
563
|
-
headers: headerParameters,
|
|
564
|
-
query: queryParameters,
|
|
565
|
-
body: requestParameters['reportPreviewGenerationRequest'],
|
|
566
|
-
},
|
|
567
|
-
initOverrides,
|
|
568
|
-
);
|
|
569
|
-
|
|
570
|
-
return new runtime.JSONApiResponse(response);
|
|
571
|
-
}
|
|
572
|
-
|
|
573
|
-
/**
|
|
574
|
-
*/
|
|
575
|
-
async previewReport(
|
|
576
|
-
companyCode: string,
|
|
577
|
-
reportPreviewGenerationRequest: ReportPreviewGenerationRequest,
|
|
578
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
579
|
-
): Promise<PreviewGenerationResponse> {
|
|
580
|
-
const response = await this.previewReportRaw(
|
|
581
|
-
{ companyCode: companyCode, reportPreviewGenerationRequest: reportPreviewGenerationRequest },
|
|
582
|
-
initOverrides,
|
|
583
|
-
);
|
|
584
|
-
return await response.value();
|
|
585
|
-
}
|
|
586
|
-
|
|
587
|
-
/**
|
|
588
|
-
* Get report data
|
|
589
|
-
* Get report data
|
|
590
|
-
*/
|
|
591
|
-
async reportDataRaw(
|
|
592
|
-
requestParameters: ReportingApiReportDataRequest,
|
|
593
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
594
|
-
): Promise<runtime.ApiResponse<ReportDataResponse>> {
|
|
595
|
-
if (requestParameters['companyCode'] == null) {
|
|
596
|
-
throw new runtime.RequiredError(
|
|
597
|
-
'companyCode',
|
|
598
|
-
'Required parameter "companyCode" was null or undefined when calling reportData().',
|
|
599
|
-
);
|
|
600
|
-
}
|
|
601
|
-
|
|
602
|
-
if (requestParameters['reportGroupCode'] == null) {
|
|
603
|
-
throw new runtime.RequiredError(
|
|
604
|
-
'reportGroupCode',
|
|
605
|
-
'Required parameter "reportGroupCode" was null or undefined when calling reportData().',
|
|
606
|
-
);
|
|
607
|
-
}
|
|
608
|
-
|
|
609
|
-
if (requestParameters['reportCode'] == null) {
|
|
610
|
-
throw new runtime.RequiredError(
|
|
611
|
-
'reportCode',
|
|
612
|
-
'Required parameter "reportCode" was null or undefined when calling reportData().',
|
|
613
|
-
);
|
|
614
|
-
}
|
|
615
|
-
|
|
616
|
-
const queryParameters: any = {};
|
|
617
|
-
|
|
618
|
-
const headerParameters: runtime.HTTPHeaders = {};
|
|
619
|
-
|
|
620
|
-
if (this.configuration && this.configuration.accessToken) {
|
|
621
|
-
const token = this.configuration.accessToken;
|
|
622
|
-
const tokenString = await token('bearerToken', ['reporting:read']);
|
|
623
|
-
|
|
624
|
-
if (tokenString) {
|
|
625
|
-
headerParameters['Authorization'] = `Bearer ${tokenString}`;
|
|
626
|
-
}
|
|
627
|
-
}
|
|
628
|
-
const response = await this.request(
|
|
629
|
-
{
|
|
630
|
-
path: `/api/v1/c/{company_code}/reporting/report-groups/{reportGroupCode}/report/{reportCode}`
|
|
631
|
-
.replace(`{${'company_code'}}`, encodeURIComponent(String(requestParameters['companyCode'])))
|
|
632
|
-
.replace(`{${'reportGroupCode'}}`, encodeURIComponent(String(requestParameters['reportGroupCode'])))
|
|
633
|
-
.replace(`{${'reportCode'}}`, encodeURIComponent(String(requestParameters['reportCode']))),
|
|
634
|
-
method: 'GET',
|
|
635
|
-
headers: headerParameters,
|
|
636
|
-
query: queryParameters,
|
|
637
|
-
},
|
|
638
|
-
initOverrides,
|
|
639
|
-
);
|
|
640
|
-
|
|
641
|
-
return new runtime.JSONApiResponse(response);
|
|
642
|
-
}
|
|
643
|
-
|
|
644
|
-
/**
|
|
645
|
-
* Get report data
|
|
646
|
-
* Get report data
|
|
647
|
-
*/
|
|
648
|
-
async reportData(
|
|
649
|
-
companyCode: string,
|
|
650
|
-
reportGroupCode: string,
|
|
651
|
-
reportCode: string,
|
|
652
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
653
|
-
): Promise<ReportDataResponse> {
|
|
654
|
-
const response = await this.reportDataRaw(
|
|
655
|
-
{ companyCode: companyCode, reportGroupCode: reportGroupCode, reportCode: reportCode },
|
|
656
|
-
initOverrides,
|
|
657
|
-
);
|
|
658
|
-
return await response.value();
|
|
659
|
-
}
|
|
660
|
-
|
|
661
|
-
/**
|
|
662
|
-
* Get report groups
|
|
663
|
-
* Get report groups
|
|
664
|
-
*/
|
|
665
|
-
async reportGroupsRaw(
|
|
666
|
-
requestParameters: ReportingApiReportGroupsRequest,
|
|
667
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
668
|
-
): Promise<runtime.ApiResponse<ReportGroupsResponse>> {
|
|
669
|
-
if (requestParameters['companyCode'] == null) {
|
|
670
|
-
throw new runtime.RequiredError(
|
|
671
|
-
'companyCode',
|
|
672
|
-
'Required parameter "companyCode" was null or undefined when calling reportGroups().',
|
|
673
|
-
);
|
|
674
|
-
}
|
|
675
|
-
|
|
676
|
-
const queryParameters: any = {};
|
|
677
|
-
|
|
678
|
-
const headerParameters: runtime.HTTPHeaders = {};
|
|
679
|
-
|
|
680
|
-
if (this.configuration && this.configuration.accessToken) {
|
|
681
|
-
const token = this.configuration.accessToken;
|
|
682
|
-
const tokenString = await token('bearerToken', ['reporting:read']);
|
|
683
|
-
|
|
684
|
-
if (tokenString) {
|
|
685
|
-
headerParameters['Authorization'] = `Bearer ${tokenString}`;
|
|
686
|
-
}
|
|
687
|
-
}
|
|
688
|
-
const response = await this.request(
|
|
689
|
-
{
|
|
690
|
-
path: `/api/v1/c/{company_code}/reporting/report-groups`.replace(
|
|
691
|
-
`{${'company_code'}}`,
|
|
692
|
-
encodeURIComponent(String(requestParameters['companyCode'])),
|
|
693
|
-
),
|
|
694
|
-
method: 'GET',
|
|
695
|
-
headers: headerParameters,
|
|
696
|
-
query: queryParameters,
|
|
697
|
-
},
|
|
698
|
-
initOverrides,
|
|
699
|
-
);
|
|
700
|
-
|
|
701
|
-
return new runtime.JSONApiResponse(response);
|
|
702
|
-
}
|
|
703
|
-
|
|
704
|
-
/**
|
|
705
|
-
* Get report groups
|
|
706
|
-
* Get report groups
|
|
707
|
-
*/
|
|
708
|
-
async reportGroups(
|
|
709
|
-
companyCode: string,
|
|
710
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
711
|
-
): Promise<ReportGroupsResponse> {
|
|
712
|
-
const response = await this.reportGroupsRaw({ companyCode: companyCode }, initOverrides);
|
|
713
|
-
return await response.value();
|
|
714
|
-
}
|
|
715
|
-
|
|
716
|
-
/**
|
|
717
|
-
* Get yearly amounts for a given year
|
|
718
|
-
* Get yearly amounts
|
|
719
|
-
*/
|
|
720
|
-
async yearlyAmountsRaw(
|
|
721
|
-
requestParameters: ReportingApiYearlyAmountsRequest,
|
|
722
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
723
|
-
): Promise<runtime.ApiResponse<AmountsResponse>> {
|
|
724
|
-
if (requestParameters['companyCode'] == null) {
|
|
725
|
-
throw new runtime.RequiredError(
|
|
726
|
-
'companyCode',
|
|
727
|
-
'Required parameter "companyCode" was null or undefined when calling yearlyAmounts().',
|
|
728
|
-
);
|
|
729
|
-
}
|
|
730
|
-
|
|
731
|
-
if (requestParameters['year'] == null) {
|
|
732
|
-
throw new runtime.RequiredError(
|
|
733
|
-
'year',
|
|
734
|
-
'Required parameter "year" was null or undefined when calling yearlyAmounts().',
|
|
735
|
-
);
|
|
736
|
-
}
|
|
737
|
-
|
|
738
|
-
const queryParameters: any = {};
|
|
739
|
-
|
|
740
|
-
if (requestParameters['category'] != null) {
|
|
741
|
-
queryParameters['category'] = requestParameters['category'];
|
|
742
|
-
}
|
|
743
|
-
|
|
744
|
-
if (requestParameters['entity'] != null) {
|
|
745
|
-
queryParameters['entity'] = requestParameters['entity'];
|
|
746
|
-
}
|
|
747
|
-
|
|
748
|
-
if (requestParameters['businessDimensionMember'] != null) {
|
|
749
|
-
queryParameters['businessDimensionMember'] = requestParameters['businessDimensionMember'];
|
|
750
|
-
}
|
|
751
|
-
|
|
752
|
-
if (requestParameters['view'] != null) {
|
|
753
|
-
queryParameters['view'] = requestParameters['view'];
|
|
754
|
-
}
|
|
755
|
-
|
|
756
|
-
if (requestParameters['experimental'] != null) {
|
|
757
|
-
queryParameters['experimental'] = requestParameters['experimental'];
|
|
758
|
-
}
|
|
759
|
-
|
|
760
|
-
if (requestParameters['glimpse'] != null) {
|
|
761
|
-
queryParameters['glimpse'] = requestParameters['glimpse'];
|
|
762
|
-
}
|
|
763
|
-
|
|
764
|
-
if (requestParameters['moduleCode'] != null) {
|
|
765
|
-
queryParameters['moduleCode'] = requestParameters['moduleCode'];
|
|
766
|
-
}
|
|
767
|
-
|
|
768
|
-
if (requestParameters['structureType'] != null) {
|
|
769
|
-
queryParameters['structureType'] = requestParameters['structureType'];
|
|
770
|
-
}
|
|
771
|
-
|
|
772
|
-
const headerParameters: runtime.HTTPHeaders = {};
|
|
773
|
-
|
|
774
|
-
if (this.configuration && this.configuration.accessToken) {
|
|
775
|
-
const token = this.configuration.accessToken;
|
|
776
|
-
const tokenString = await token('bearerToken', ['reporting:read']);
|
|
777
|
-
|
|
778
|
-
if (tokenString) {
|
|
779
|
-
headerParameters['Authorization'] = `Bearer ${tokenString}`;
|
|
780
|
-
}
|
|
781
|
-
}
|
|
782
|
-
const response = await this.request(
|
|
783
|
-
{
|
|
784
|
-
path: `/api/v1/c/{company_code}/reporting/amounts/yearly/{year}`
|
|
785
|
-
.replace(`{${'company_code'}}`, encodeURIComponent(String(requestParameters['companyCode'])))
|
|
786
|
-
.replace(`{${'year'}}`, encodeURIComponent(String(requestParameters['year']))),
|
|
787
|
-
method: 'GET',
|
|
788
|
-
headers: headerParameters,
|
|
789
|
-
query: queryParameters,
|
|
790
|
-
},
|
|
791
|
-
initOverrides,
|
|
792
|
-
);
|
|
793
|
-
|
|
794
|
-
return new runtime.JSONApiResponse(response);
|
|
795
|
-
}
|
|
796
|
-
|
|
797
|
-
/**
|
|
798
|
-
* Get yearly amounts for a given year
|
|
799
|
-
* Get yearly amounts
|
|
800
|
-
*/
|
|
801
|
-
async yearlyAmounts(
|
|
802
|
-
companyCode: string,
|
|
803
|
-
year: number | null,
|
|
804
|
-
category?: string | null,
|
|
805
|
-
entity?: string | null,
|
|
806
|
-
businessDimensionMember?: string | null,
|
|
807
|
-
view?: YearlyAmountsViewEnum,
|
|
808
|
-
experimental?: string | null,
|
|
809
|
-
glimpse?: boolean | null,
|
|
810
|
-
moduleCode?: string | null,
|
|
811
|
-
structureType?: YearlyAmountsStructureTypeEnum,
|
|
812
|
-
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
813
|
-
): Promise<AmountsResponse> {
|
|
814
|
-
const response = await this.yearlyAmountsRaw(
|
|
815
|
-
{
|
|
816
|
-
companyCode: companyCode,
|
|
817
|
-
year: year,
|
|
818
|
-
category: category,
|
|
819
|
-
entity: entity,
|
|
820
|
-
businessDimensionMember: businessDimensionMember,
|
|
821
|
-
view: view,
|
|
822
|
-
experimental: experimental,
|
|
823
|
-
glimpse: glimpse,
|
|
824
|
-
moduleCode: moduleCode,
|
|
825
|
-
structureType: structureType,
|
|
826
|
-
},
|
|
827
|
-
initOverrides,
|
|
828
|
-
);
|
|
829
|
-
return await response.value();
|
|
830
|
-
}
|
|
831
|
-
}
|
|
832
|
-
|
|
833
|
-
/**
|
|
834
|
-
* @export
|
|
835
|
-
*/
|
|
836
|
-
export const YearlyAmountsViewEnum = {
|
|
837
|
-
Periodic: 'periodic',
|
|
838
|
-
Ytd: 'ytd',
|
|
839
|
-
Qtd: 'qtd',
|
|
840
|
-
Ltd: 'ltd',
|
|
841
|
-
} as const;
|
|
842
|
-
export type YearlyAmountsViewEnum = (typeof YearlyAmountsViewEnum)[keyof typeof YearlyAmountsViewEnum];
|
|
843
|
-
/**
|
|
844
|
-
* @export
|
|
845
|
-
*/
|
|
846
|
-
export const YearlyAmountsStructureTypeEnum = {
|
|
847
|
-
Default: 'default',
|
|
848
|
-
Cashflow: 'cashflow',
|
|
849
|
-
} as const;
|
|
850
|
-
export type YearlyAmountsStructureTypeEnum =
|
|
851
|
-
(typeof YearlyAmountsStructureTypeEnum)[keyof typeof YearlyAmountsStructureTypeEnum];
|