@incomy/platform-sdk 0.6.0-beta.2446 → 0.6.1-beta.2464
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/dist/services/hub/index.d.ts +2 -0
- package/dist/services/hub/models/BalanceTimeline.d.ts +17 -0
- package/dist/services/hub/models/BalanceTimeline.js +1 -0
- package/dist/services/hub/models/BalanceTimelinePoint.d.ts +19 -0
- package/dist/services/hub/models/BalanceTimelinePoint.js +1 -0
- package/dist/services/hub/services/ProjectsService.d.ts +20 -0
- package/dist/services/hub/services/ProjectsService.js +27 -0
- package/meta.json +5 -5
- package/package.json +1 -1
|
@@ -8,6 +8,8 @@ export type { AccrualInsert } from './models/AccrualInsert';
|
|
|
8
8
|
export type { AccrualPaginatedList } from './models/AccrualPaginatedList';
|
|
9
9
|
export type { Balance } from './models/Balance';
|
|
10
10
|
export type { BalanceReport } from './models/BalanceReport';
|
|
11
|
+
export type { BalanceTimeline } from './models/BalanceTimeline';
|
|
12
|
+
export type { BalanceTimelinePoint } from './models/BalanceTimelinePoint';
|
|
11
13
|
export type { Bucket } from './models/Bucket';
|
|
12
14
|
export type { BucketableBalance } from './models/BucketableBalance';
|
|
13
15
|
export type { BucketBalance } from './models/BucketBalance';
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type { BalanceTimelinePoint } from './BalanceTimelinePoint';
|
|
2
|
+
/**
|
|
3
|
+
* A balance-over-time series for a project, sampled at a fixed Incomy.Platform.Hub.Models.BalanceTimeline.Interval. Each point carries two
|
|
4
|
+
* per-currency figures: Incomy.Platform.Hub.Models.BalanceTimelinePoint.Actual (wallet state derived from operations —
|
|
5
|
+
* historical only, so it is empty for points after Incomy.Platform.Hub.Models.BalanceTimeline.Now) and
|
|
6
|
+
* Incomy.Platform.Hub.Models.BalanceTimelinePoint.Effective (actual combined with accruals — it may extend past
|
|
7
|
+
* Incomy.Platform.Hub.Models.BalanceTimeline.Now as a prediction driven by future-dated accruals). No FX conversion is applied: every
|
|
8
|
+
* figure is a list with one entry per currency.
|
|
9
|
+
*/
|
|
10
|
+
export type BalanceTimeline = {
|
|
11
|
+
interval: 'day' | 'week' | 'month';
|
|
12
|
+
/**
|
|
13
|
+
* Server "now": the boundary between realized history and prediction. Points dated after this are projections.
|
|
14
|
+
*/
|
|
15
|
+
now: string;
|
|
16
|
+
points: Array<BalanceTimelinePoint>;
|
|
17
|
+
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type { Money } from './Money';
|
|
2
|
+
export type BalanceTimelinePoint = {
|
|
3
|
+
/**
|
|
4
|
+
* Wallet state from operations, per currency. Empty for projection points (dated after Incomy.Platform.Hub.Models.BalanceTimeline.Now).
|
|
5
|
+
*/
|
|
6
|
+
actual: Array<Money>;
|
|
7
|
+
/**
|
|
8
|
+
* Bucket start, aligned to Incomy.Platform.Hub.Models.BalanceTimeline.Interval. The values are the closing balance of the bucket.
|
|
9
|
+
*/
|
|
10
|
+
date: string;
|
|
11
|
+
/**
|
|
12
|
+
* Actual balance combined with accruals, per currency. Spans the whole horizon, including the prediction tail.
|
|
13
|
+
*/
|
|
14
|
+
effective: Array<Money>;
|
|
15
|
+
/**
|
|
16
|
+
* True when Incomy.Platform.Hub.Models.BalanceTimelinePoint.Date is after Incomy.Platform.Hub.Models.BalanceTimeline.Now — a predicted point rather than realized history.
|
|
17
|
+
*/
|
|
18
|
+
isProjection: boolean;
|
|
19
|
+
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { BalanceReport } from '../models/BalanceReport';
|
|
2
|
+
import type { BalanceTimeline } from '../models/BalanceTimeline';
|
|
2
3
|
import type { LogItemPaginatedList } from '../models/LogItemPaginatedList';
|
|
3
4
|
import type { MemberBalancePaginatedList } from '../models/MemberBalancePaginatedList';
|
|
4
5
|
import type { Project } from '../models/Project';
|
|
@@ -83,6 +84,25 @@ export declare class ProjectsService {
|
|
|
83
84
|
limit?: number;
|
|
84
85
|
next?: string;
|
|
85
86
|
}): CancelablePromise<MemberBalancePaginatedList>;
|
|
87
|
+
/**
|
|
88
|
+
* Balance-over-time series for the project: an actual (wallet-state) line up to now and an effective line that
|
|
89
|
+
* combines accruals and may extend into the future as a prediction. Filters mirror the log feed: a wallet
|
|
90
|
+
* filter scopes operations (actual line), a member filter scopes accruals (effective line), and label/company
|
|
91
|
+
* narrow both. With no `from`, the series starts at the project's first recorded event; `to` defaults
|
|
92
|
+
* to now; the default interval is daily.
|
|
93
|
+
* @returns BalanceTimeline OK
|
|
94
|
+
* @throws ApiError
|
|
95
|
+
*/
|
|
96
|
+
static getProjectsBalanceTimeline({ projectId, from, to, interval, walletIds, labelIds, companyIds, memberIds, }: {
|
|
97
|
+
projectId: string;
|
|
98
|
+
from?: string;
|
|
99
|
+
to?: string;
|
|
100
|
+
interval?: 'day' | 'week' | 'month';
|
|
101
|
+
walletIds?: Array<string>;
|
|
102
|
+
labelIds?: Array<string>;
|
|
103
|
+
companyIds?: Array<string>;
|
|
104
|
+
memberIds?: Array<string>;
|
|
105
|
+
}): CancelablePromise<BalanceTimeline>;
|
|
86
106
|
/**
|
|
87
107
|
* @returns WalletBalancePaginatedList OK
|
|
88
108
|
* @throws ApiError
|
|
@@ -125,6 +125,33 @@ export class ProjectsService {
|
|
|
125
125
|
},
|
|
126
126
|
});
|
|
127
127
|
}
|
|
128
|
+
/**
|
|
129
|
+
* Balance-over-time series for the project: an actual (wallet-state) line up to now and an effective line that
|
|
130
|
+
* combines accruals and may extend into the future as a prediction. Filters mirror the log feed: a wallet
|
|
131
|
+
* filter scopes operations (actual line), a member filter scopes accruals (effective line), and label/company
|
|
132
|
+
* narrow both. With no `from`, the series starts at the project's first recorded event; `to` defaults
|
|
133
|
+
* to now; the default interval is daily.
|
|
134
|
+
* @returns BalanceTimeline OK
|
|
135
|
+
* @throws ApiError
|
|
136
|
+
*/
|
|
137
|
+
static getProjectsBalanceTimeline({ projectId, from, to, interval, walletIds, labelIds, companyIds, memberIds, }) {
|
|
138
|
+
return __request(OpenAPI, {
|
|
139
|
+
method: 'GET',
|
|
140
|
+
url: '/projects/{projectId}/balance/timeline',
|
|
141
|
+
path: {
|
|
142
|
+
'projectId': projectId,
|
|
143
|
+
},
|
|
144
|
+
query: {
|
|
145
|
+
'from': from,
|
|
146
|
+
'to': to,
|
|
147
|
+
'interval': interval,
|
|
148
|
+
'walletIds': walletIds,
|
|
149
|
+
'labelIds': labelIds,
|
|
150
|
+
'companyIds': companyIds,
|
|
151
|
+
'memberIds': memberIds,
|
|
152
|
+
},
|
|
153
|
+
});
|
|
154
|
+
}
|
|
128
155
|
/**
|
|
129
156
|
* @returns WalletBalancePaginatedList OK
|
|
130
157
|
* @throws ApiError
|
package/meta.json
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
{
|
|
2
|
-
"sdkVersion": "0.6.
|
|
3
|
-
"generatedAt": "2026-07-
|
|
4
|
-
"apiCommit": "
|
|
5
|
-
"pipelineUrl": "https://gitlab.com/incomy/platform/-/pipelines/
|
|
2
|
+
"sdkVersion": "0.6.1-beta.2464",
|
|
3
|
+
"generatedAt": "2026-07-13T19:59:12.113Z",
|
|
4
|
+
"apiCommit": "1399f588",
|
|
5
|
+
"pipelineUrl": "https://gitlab.com/incomy/platform/-/pipelines/2673700007",
|
|
6
6
|
"sources": {
|
|
7
7
|
"hub": {
|
|
8
|
-
"sha256": "
|
|
8
|
+
"sha256": "edcdb01237ddf137916d2f8c08df86f4cffb46d3a50b4e2ad61d21a025d3d4d2"
|
|
9
9
|
}
|
|
10
10
|
}
|
|
11
11
|
}
|