@squonk/account-server-client 4.0.1-rc.3 → 4.1.1-rc.1
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/asset/asset.cjs +18 -10
- package/asset/asset.cjs.map +1 -1
- package/asset/asset.d.cts +60 -60
- package/asset/asset.d.ts +60 -60
- package/asset/asset.js +18 -10
- package/asset/asset.js.map +1 -1
- package/charges/charges.cjs +3 -3
- package/charges/charges.cjs.map +1 -1
- package/charges/charges.d.cts +33 -33
- package/charges/charges.d.ts +33 -33
- package/charges/charges.js +3 -3
- package/charges/charges.js.map +1 -1
- package/event-stream/event-stream.cjs +8 -5
- package/event-stream/event-stream.cjs.map +1 -1
- package/event-stream/event-stream.d.cts +30 -30
- package/event-stream/event-stream.d.ts +30 -30
- package/event-stream/event-stream.js +8 -5
- package/event-stream/event-stream.js.map +1 -1
- package/index.cjs +8 -8
- package/index.cjs.map +1 -1
- package/index.d.cts +212 -196
- package/index.d.ts +212 -196
- package/index.js +8 -8
- package/index.js.map +1 -1
- package/merchant/merchant.cjs +1 -1
- package/merchant/merchant.cjs.map +1 -1
- package/merchant/merchant.d.cts +17 -17
- package/merchant/merchant.d.ts +17 -17
- package/merchant/merchant.js +1 -1
- package/merchant/merchant.js.map +1 -1
- package/organisation/organisation.cjs +24 -19
- package/organisation/organisation.cjs.map +1 -1
- package/organisation/organisation.d.cts +56 -56
- package/organisation/organisation.d.ts +56 -56
- package/organisation/organisation.js +24 -19
- package/organisation/organisation.js.map +1 -1
- package/package.json +11 -11
- package/product/product.cjs +12 -8
- package/product/product.cjs.map +1 -1
- package/product/product.d.cts +68 -68
- package/product/product.d.ts +68 -68
- package/product/product.js +12 -8
- package/product/product.js.map +1 -1
- package/src/account-server-api.schemas.ts +219 -200
- package/src/asset/asset.ts +121 -84
- package/src/charges/charges.ts +51 -50
- package/src/event-stream/event-stream.ts +56 -44
- package/src/merchant/merchant.ts +27 -26
- package/src/organisation/organisation.ts +104 -85
- package/src/product/product.ts +117 -100
- package/src/state/state.ts +15 -14
- package/src/unit/unit.ts +130 -101
- package/src/user/user.ts +91 -70
- package/state/state.cjs.map +1 -1
- package/state/state.d.cts +9 -9
- package/state/state.d.ts +9 -9
- package/state/state.js.map +1 -1
- package/unit/unit.cjs +29 -22
- package/unit/unit.cjs.map +1 -1
- package/unit/unit.d.cts +68 -68
- package/unit/unit.d.ts +68 -68
- package/unit/unit.js +29 -22
- package/unit/unit.js.map +1 -1
- package/user/user.cjs +10 -6
- package/user/user.cjs.map +1 -1
- package/user/user.d.cts +49 -49
- package/user/user.d.ts +49 -49
- package/user/user.js +10 -6
- package/user/user.js.map +1 -1
package/index.d.cts
CHANGED
|
@@ -2,14 +2,14 @@ import * as axios from 'axios';
|
|
|
2
2
|
import { AxiosRequestConfig, AxiosError } from 'axios';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
|
-
* Generated by orval v7.
|
|
5
|
+
* Generated by orval v7.4.1 🍺
|
|
6
6
|
* Do not edit manually.
|
|
7
7
|
* Account Server API
|
|
8
8
|
* The Informatics Matters Account Server API.
|
|
9
9
|
|
|
10
10
|
A service that provides access to the Account Server, which gives *registered* users access to and management of **Organisations**, **Units**, **Products**, **Users**, and **Assets**.
|
|
11
11
|
|
|
12
|
-
* OpenAPI spec version: 4.
|
|
12
|
+
* OpenAPI spec version: 4.1
|
|
13
13
|
*/
|
|
14
14
|
type DetachAssetParams = {
|
|
15
15
|
/**
|
|
@@ -23,6 +23,18 @@ type AttachAssetParams = {
|
|
|
23
23
|
*/
|
|
24
24
|
m_id?: QMIdParameter;
|
|
25
25
|
};
|
|
26
|
+
type GetUnitsParams = {
|
|
27
|
+
/**
|
|
28
|
+
* An object name
|
|
29
|
+
*/
|
|
30
|
+
name?: QNameParameter;
|
|
31
|
+
};
|
|
32
|
+
type GetOrganisationsParams = {
|
|
33
|
+
/**
|
|
34
|
+
* An object name
|
|
35
|
+
*/
|
|
36
|
+
name?: QNameParameter;
|
|
37
|
+
};
|
|
26
38
|
/**
|
|
27
39
|
* A date where assets prior to this will be returned. This can be a date-time string but it is interpreted as a date, i.e. `2020-01-01T00:00:00Z` is interpreted as `2020-01-01`. Any asset that occurs prior this date will be returned. UTC is assumed if no timezone is provided
|
|
28
40
|
*/
|
|
@@ -31,20 +43,6 @@ type QUntilParameter = string;
|
|
|
31
43
|
* A date from which to retrieve assets. This can be a date-time string but it is interpreted as a date, i.e. `2020-01-01T00:00:00Z` is interpreted as `2020-01-01`. Any asset that occurs on ar after this date will be returned. UTC is assumed if no timezone is provided
|
|
32
44
|
*/
|
|
33
45
|
type QFromParameter = string;
|
|
34
|
-
type GetUnitChargesParams = {
|
|
35
|
-
/**
|
|
36
|
-
* A date from which to retrieve assets. This can be a date-time string but it is interpreted as a date, i.e. `2020-01-01T00:00:00Z` is interpreted as `2020-01-01`. Any asset that occurs on ar after this date will be returned. UTC is assumed if no timezone is provided
|
|
37
|
-
*/
|
|
38
|
-
from?: QFromParameter;
|
|
39
|
-
/**
|
|
40
|
-
* A date where assets prior to this will be returned. This can be a date-time string but it is interpreted as a date, i.e. `2020-01-01T00:00:00Z` is interpreted as `2020-01-01`. Any asset that occurs prior this date will be returned. UTC is assumed if no timezone is provided
|
|
41
|
-
*/
|
|
42
|
-
until?: QUntilParameter;
|
|
43
|
-
/**
|
|
44
|
-
* A charge Prior Billing Period, 0 implies "current" and -23 is for the period 23 months ago.
|
|
45
|
-
*/
|
|
46
|
-
pbp?: QPbpParameter;
|
|
47
|
-
};
|
|
48
46
|
type GetProductChargesParams = {
|
|
49
47
|
/**
|
|
50
48
|
* A date from which to retrieve assets. This can be a date-time string but it is interpreted as a date, i.e. `2020-01-01T00:00:00Z` is interpreted as `2020-01-01`. Any asset that occurs on ar after this date will be returned. UTC is assumed if no timezone is provided
|
|
@@ -99,6 +97,18 @@ type QProductIdParameter = string;
|
|
|
99
97
|
* A Unit Identity
|
|
100
98
|
*/
|
|
101
99
|
type QUnitIdParameter = string;
|
|
100
|
+
/**
|
|
101
|
+
* An object name
|
|
102
|
+
*/
|
|
103
|
+
type QNameParameter = string;
|
|
104
|
+
/**
|
|
105
|
+
* A Merchant Identity
|
|
106
|
+
*/
|
|
107
|
+
type QMIdParameter = number;
|
|
108
|
+
/**
|
|
109
|
+
* An Organisation Identity
|
|
110
|
+
*/
|
|
111
|
+
type QOrgIdParameter = string;
|
|
102
112
|
type GetAssetParams = {
|
|
103
113
|
/**
|
|
104
114
|
* A User Identity
|
|
@@ -117,19 +127,30 @@ type GetAssetParams = {
|
|
|
117
127
|
*/
|
|
118
128
|
org_id?: QOrgIdParameter;
|
|
119
129
|
};
|
|
120
|
-
/**
|
|
121
|
-
* A Merchant Identity
|
|
122
|
-
*/
|
|
123
|
-
type QMIdParameter = number;
|
|
124
|
-
/**
|
|
125
|
-
* An Organisation Identity
|
|
126
|
-
*/
|
|
127
|
-
type QOrgIdParameter = string;
|
|
128
130
|
/**
|
|
129
131
|
* A charge Prior Billing Period, 0 implies "current" and -23 is for the period 23 months ago.
|
|
130
132
|
*/
|
|
131
133
|
type QPbpParameter = number;
|
|
134
|
+
type GetUnitChargesParams = {
|
|
135
|
+
/**
|
|
136
|
+
* A date from which to retrieve assets. This can be a date-time string but it is interpreted as a date, i.e. `2020-01-01T00:00:00Z` is interpreted as `2020-01-01`. Any asset that occurs on ar after this date will be returned. UTC is assumed if no timezone is provided
|
|
137
|
+
*/
|
|
138
|
+
from?: QFromParameter;
|
|
139
|
+
/**
|
|
140
|
+
* A date where assets prior to this will be returned. This can be a date-time string but it is interpreted as a date, i.e. `2020-01-01T00:00:00Z` is interpreted as `2020-01-01`. Any asset that occurs prior this date will be returned. UTC is assumed if no timezone is provided
|
|
141
|
+
*/
|
|
142
|
+
until?: QUntilParameter;
|
|
143
|
+
/**
|
|
144
|
+
* A charge Prior Billing Period, 0 implies "current" and -23 is for the period 23 months ago.
|
|
145
|
+
*/
|
|
146
|
+
pbp?: QPbpParameter;
|
|
147
|
+
};
|
|
132
148
|
type ProductPatchBodyBody = {
|
|
149
|
+
/**
|
|
150
|
+
* The name you want to give the Product
|
|
151
|
+
* @maxLength 80
|
|
152
|
+
*/
|
|
153
|
+
name?: string;
|
|
133
154
|
/**
|
|
134
155
|
* The Product's built-in coin allowance. Product allowances cannot be reduced
|
|
135
156
|
* @minimum 1
|
|
@@ -140,21 +161,6 @@ type ProductPatchBodyBody = {
|
|
|
140
161
|
* @minimum 1
|
|
141
162
|
*/
|
|
142
163
|
limit?: number;
|
|
143
|
-
/**
|
|
144
|
-
* The name you want to give the Product
|
|
145
|
-
* @maxLength 80
|
|
146
|
-
*/
|
|
147
|
-
name?: string;
|
|
148
|
-
};
|
|
149
|
-
/**
|
|
150
|
-
* The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be provided.
|
|
151
|
-
|
|
152
|
-
Project Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products
|
|
153
|
-
*/
|
|
154
|
-
type UnitProductPostBodyBodyType = typeof UnitProductPostBodyBodyType[keyof typeof UnitProductPostBodyBodyType];
|
|
155
|
-
declare const UnitProductPostBodyBodyType: {
|
|
156
|
-
readonly DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION";
|
|
157
|
-
readonly DATA_MANAGER_STORAGE_SUBSCRIPTION: "DATA_MANAGER_STORAGE_SUBSCRIPTION";
|
|
158
164
|
};
|
|
159
165
|
/**
|
|
160
166
|
* The Flavour of the Product. Used only for Project Tier Products. Do not set this for Storage products
|
|
@@ -166,28 +172,38 @@ declare const UnitProductPostBodyBodyFlavour: {
|
|
|
166
172
|
readonly SILVER: "SILVER";
|
|
167
173
|
readonly GOLD: "GOLD";
|
|
168
174
|
};
|
|
175
|
+
/**
|
|
176
|
+
* The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be provided.
|
|
177
|
+
|
|
178
|
+
Project Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products
|
|
179
|
+
*/
|
|
180
|
+
type UnitProductPostBodyBodyType = typeof UnitProductPostBodyBodyType[keyof typeof UnitProductPostBodyBodyType];
|
|
181
|
+
declare const UnitProductPostBodyBodyType: {
|
|
182
|
+
readonly DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION";
|
|
183
|
+
readonly DATA_MANAGER_STORAGE_SUBSCRIPTION: "DATA_MANAGER_STORAGE_SUBSCRIPTION";
|
|
184
|
+
};
|
|
169
185
|
type UnitProductPostBodyBody = {
|
|
186
|
+
/**
|
|
187
|
+
* The name you want to give the Product
|
|
188
|
+
* @maxLength 80
|
|
189
|
+
*/
|
|
190
|
+
name: string;
|
|
191
|
+
/** The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be provided.
|
|
192
|
+
|
|
193
|
+
Project Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products */
|
|
194
|
+
type: UnitProductPostBodyBodyType;
|
|
195
|
+
/** The Flavour of the Product. Used only for Project Tier Products. Do not set this for Storage products */
|
|
196
|
+
flavour?: UnitProductPostBodyBodyFlavour;
|
|
170
197
|
/**
|
|
171
198
|
* The Product's coin allowance. You must provide this for Storage products but you must not provide a value for Project Tier Products
|
|
172
199
|
* @minimum 1
|
|
173
200
|
*/
|
|
174
201
|
allowance?: number;
|
|
175
|
-
/** The Flavour of the Product. Used only for Project Tier Products. Do not set this for Storage products */
|
|
176
|
-
flavour?: UnitProductPostBodyBodyFlavour;
|
|
177
202
|
/**
|
|
178
203
|
* The Product's built-in coin limit. If set it must not be less than the allowance. If not set the allowance is used. You can provide this for Storage products but you must not provide a value for Project Tier Products
|
|
179
204
|
* @minimum 1
|
|
180
205
|
*/
|
|
181
206
|
limit?: number;
|
|
182
|
-
/**
|
|
183
|
-
* The name you want to give the Product
|
|
184
|
-
* @maxLength 80
|
|
185
|
-
*/
|
|
186
|
-
name: string;
|
|
187
|
-
/** The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be provided.
|
|
188
|
-
|
|
189
|
-
Project Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products */
|
|
190
|
-
type: UnitProductPostBodyBodyType;
|
|
191
207
|
};
|
|
192
208
|
/**
|
|
193
209
|
* The new default **Product** privacy applied to all products that belong to this Unit. Privacy is also controlled at the **Organisation** level. As an example, the Unit can declare its Products to be `DEFAULT_PRIVATE`, but the Organisation can declare its value to be `DEFAULT_PUBLIC`.
|
|
@@ -202,12 +218,12 @@ declare const UnitPatchBodyBodyDefaultProductPrivacy: {
|
|
|
202
218
|
readonly DEFAULT_PRIVATE: "DEFAULT_PRIVATE";
|
|
203
219
|
};
|
|
204
220
|
type UnitPatchBodyBody = {
|
|
221
|
+
/** The new name for the Unit */
|
|
222
|
+
name?: string;
|
|
205
223
|
/** The new default **Product** privacy applied to all products that belong to this Unit. Privacy is also controlled at the **Organisation** level. As an example, the Unit can declare its Products to be `DEFAULT_PRIVATE`, but the Organisation can declare its value to be `DEFAULT_PUBLIC`.
|
|
206
224
|
|
|
207
225
|
Whether the privacy can be honoured will depend on the organisation's value */
|
|
208
226
|
default_product_privacy?: UnitPatchBodyBodyDefaultProductPrivacy;
|
|
209
|
-
/** The new name for the Unit */
|
|
210
|
-
name?: string;
|
|
211
227
|
};
|
|
212
228
|
/**
|
|
213
229
|
* The new default **Product** privacy applied to all products that belong to this Organisation. Privacy is also controlled at the **Unit** level. As an example the Organisation level privacy can be `DEFAULT_PRIVATE`, but the unit can declare its Products to be `ALWAYS_PRIVATE`.
|
|
@@ -222,12 +238,12 @@ declare const OrganisationPatchBodyBodyDefaultProductPrivacy: {
|
|
|
222
238
|
readonly DEFAULT_PRIVATE: "DEFAULT_PRIVATE";
|
|
223
239
|
};
|
|
224
240
|
type OrganisationPatchBodyBody = {
|
|
241
|
+
/** The new name for the Organisational */
|
|
242
|
+
name?: string;
|
|
225
243
|
/** The new default **Product** privacy applied to all products that belong to this Organisation. Privacy is also controlled at the **Unit** level. As an example the Organisation level privacy can be `DEFAULT_PRIVATE`, but the unit can declare its Products to be `ALWAYS_PRIVATE`.
|
|
226
244
|
|
|
227
245
|
Whether the privacy can be honoured will depend on the value in any of the organisation's existing units */
|
|
228
246
|
default_product_privacy?: OrganisationPatchBodyBodyDefaultProductPrivacy;
|
|
229
|
-
/** The new name for the Organisational */
|
|
230
|
-
name?: string;
|
|
231
247
|
};
|
|
232
248
|
/**
|
|
233
249
|
* The default product privacy setting for products in the unit. Whether the privacy can be honoured will depend on the organisation's value
|
|
@@ -240,6 +256,11 @@ declare const OrganisationUnitPostBodyBodyDefaultProductPrivacy: {
|
|
|
240
256
|
readonly DEFAULT_PRIVATE: "DEFAULT_PRIVATE";
|
|
241
257
|
};
|
|
242
258
|
type OrganisationUnitPostBodyBody = {
|
|
259
|
+
/**
|
|
260
|
+
* The name of the unit
|
|
261
|
+
* @maxLength 80
|
|
262
|
+
*/
|
|
263
|
+
name: string;
|
|
243
264
|
/**
|
|
244
265
|
* The day you would like to be billed for the Unit's Products (a value from 1 and 28)
|
|
245
266
|
* @minimum 1
|
|
@@ -248,11 +269,6 @@ type OrganisationUnitPostBodyBody = {
|
|
|
248
269
|
billing_day: number;
|
|
249
270
|
/** The default product privacy setting for products in the unit. Whether the privacy can be honoured will depend on the organisation's value */
|
|
250
271
|
default_product_privacy?: OrganisationUnitPostBodyBodyDefaultProductPrivacy;
|
|
251
|
-
/**
|
|
252
|
-
* The name of the unit
|
|
253
|
-
* @maxLength 80
|
|
254
|
-
*/
|
|
255
|
-
name: string;
|
|
256
272
|
};
|
|
257
273
|
type PersonalUnitPutBodyBody = {
|
|
258
274
|
/**
|
|
@@ -273,8 +289,6 @@ declare const OrganisationPostBodyBodyDefaultProductPrivacy: {
|
|
|
273
289
|
readonly DEFAULT_PRIVATE: "DEFAULT_PRIVATE";
|
|
274
290
|
};
|
|
275
291
|
type OrganisationPostBodyBody = {
|
|
276
|
-
/** The default product privacy setting for the Organisation */
|
|
277
|
-
default_product_privacy?: OrganisationPostBodyBodyDefaultProductPrivacy;
|
|
278
292
|
/**
|
|
279
293
|
* The name of the organisation
|
|
280
294
|
* @maxLength 80
|
|
@@ -282,6 +296,8 @@ type OrganisationPostBodyBody = {
|
|
|
282
296
|
name: string;
|
|
283
297
|
/** The name of the organisation owner. A user ID */
|
|
284
298
|
owner: string;
|
|
299
|
+
/** The default product privacy setting for the Organisation */
|
|
300
|
+
default_product_privacy?: OrganisationPostBodyBodyDefaultProductPrivacy;
|
|
285
301
|
};
|
|
286
302
|
type AssetPostBodyBodyScope = typeof AssetPostBodyBodyScope[keyof typeof AssetPostBodyBodyScope];
|
|
287
303
|
declare const AssetPostBodyBodyScope: {
|
|
@@ -292,23 +308,23 @@ declare const AssetPostBodyBodyScope: {
|
|
|
292
308
|
readonly GLOBAL: "GLOBAL";
|
|
293
309
|
};
|
|
294
310
|
type AssetPostBodyBody = {
|
|
295
|
-
/** A file containing the content for the asset. You must provide a value here or in content_string */
|
|
296
|
-
content_file?: Blob;
|
|
297
|
-
/** The textual content of the asset. You must provide a value here or in content_file */
|
|
298
|
-
content_string?: string;
|
|
299
|
-
/** An optional description for the Asset */
|
|
300
|
-
description?: string;
|
|
301
311
|
/**
|
|
302
312
|
* The name of the asset. This must be unique within its scope. For example, only one asset can be called "asset-1" within a given Unit. Asset names must be valid RFC 1123 Label Names
|
|
303
313
|
* @maxLength 80
|
|
304
314
|
* @pattern ^[a-z0-9-]{1,63}$
|
|
305
315
|
*/
|
|
306
316
|
name: string;
|
|
317
|
+
/** A file containing the content for the asset. You must provide a value here or in content_string */
|
|
318
|
+
content_file?: Blob;
|
|
319
|
+
/** The textual content of the asset. You must provide a value here or in content_file */
|
|
320
|
+
content_string?: string;
|
|
307
321
|
scope: AssetPostBodyBodyScope;
|
|
308
322
|
/** The unique identity based on the Scope of the asset. For example, this will be the Unit ID if it's a UNIT. A scope_id is required if the scope is USER as it will be automatically set to your username. Global assets do not have a scope. */
|
|
309
323
|
scope_id?: string;
|
|
310
324
|
/** Is this a secret asset? */
|
|
311
325
|
secret: boolean;
|
|
326
|
+
/** An optional description for the Asset */
|
|
327
|
+
description?: string;
|
|
312
328
|
};
|
|
313
329
|
type AssetPatchBodyBody = {
|
|
314
330
|
/** A file containing the content for the asset. You must provide a value here or in content_string */
|
|
@@ -323,11 +339,11 @@ interface UserDetail {
|
|
|
323
339
|
id: string;
|
|
324
340
|
}
|
|
325
341
|
interface UserAccountDetail {
|
|
326
|
-
|
|
327
|
-
account_server_roles: string[];
|
|
342
|
+
user: UserDetail;
|
|
328
343
|
/** Whether the caller has admin privilege */
|
|
329
344
|
caller_has_admin_privilege: boolean;
|
|
330
|
-
user
|
|
345
|
+
/** The roles assigned to the user recognised by the Account Server */
|
|
346
|
+
account_server_roles: string[];
|
|
331
347
|
}
|
|
332
348
|
/**
|
|
333
349
|
* The Unit's default product privacy setting
|
|
@@ -340,13 +356,8 @@ declare const UnitDetailDefaultProductPrivacy: {
|
|
|
340
356
|
readonly DEFAULT_PRIVATE: "DEFAULT_PRIVATE";
|
|
341
357
|
};
|
|
342
358
|
interface UnitDetail {
|
|
343
|
-
/** The Unit's billing day */
|
|
344
|
-
billing_day: number;
|
|
345
359
|
/** Whether the user making the API call is a member of the Unit */
|
|
346
360
|
caller_is_member: boolean;
|
|
347
|
-
created: string;
|
|
348
|
-
/** The Unit's default product privacy setting */
|
|
349
|
-
default_product_privacy: UnitDetailDefaultProductPrivacy;
|
|
350
361
|
/** The Unit's unique identity */
|
|
351
362
|
id: string;
|
|
352
363
|
/** The Unit's name */
|
|
@@ -355,6 +366,11 @@ interface UnitDetail {
|
|
|
355
366
|
owner_id: string;
|
|
356
367
|
/** True if the Unit is private */
|
|
357
368
|
private: boolean;
|
|
369
|
+
created: string;
|
|
370
|
+
/** The Unit's billing day */
|
|
371
|
+
billing_day: number;
|
|
372
|
+
/** The Unit's default product privacy setting */
|
|
373
|
+
default_product_privacy: UnitDetailDefaultProductPrivacy;
|
|
358
374
|
}
|
|
359
375
|
/**
|
|
360
376
|
* The Unit's default product privacy setting
|
|
@@ -367,13 +383,8 @@ declare const UnitAllDetailDefaultProductPrivacy: {
|
|
|
367
383
|
readonly DEFAULT_PRIVATE: "DEFAULT_PRIVATE";
|
|
368
384
|
};
|
|
369
385
|
interface UnitAllDetail {
|
|
370
|
-
/** The Unit's billing day */
|
|
371
|
-
billing_day: number;
|
|
372
386
|
/** Whether the user making the API call is a member of the Unit */
|
|
373
387
|
caller_is_member: boolean;
|
|
374
|
-
created: string;
|
|
375
|
-
/** The Unit's default product privacy setting */
|
|
376
|
-
default_product_privacy: UnitAllDetailDefaultProductPrivacy;
|
|
377
388
|
/** The Unit's unique identity */
|
|
378
389
|
id: string;
|
|
379
390
|
/** The Unit's name */
|
|
@@ -382,6 +393,11 @@ interface UnitAllDetail {
|
|
|
382
393
|
owner_id: string;
|
|
383
394
|
/** True if the Unit is private */
|
|
384
395
|
private: boolean;
|
|
396
|
+
created: string;
|
|
397
|
+
/** The Unit's billing day */
|
|
398
|
+
billing_day: number;
|
|
399
|
+
/** The Unit's default product privacy setting */
|
|
400
|
+
default_product_privacy: UnitAllDetailDefaultProductPrivacy;
|
|
385
401
|
/** A list of users that are members of the Unit */
|
|
386
402
|
users: UserDetail[];
|
|
387
403
|
}
|
|
@@ -393,15 +409,15 @@ declare const MerchantDetailKind: {
|
|
|
393
409
|
readonly DATA_MANAGER: "DATA_MANAGER";
|
|
394
410
|
};
|
|
395
411
|
interface MerchantDetail {
|
|
396
|
-
/** The hostname used by the Service */
|
|
397
|
-
api_hostname: string;
|
|
398
|
-
created: string;
|
|
399
412
|
/** The unique ID of the Service */
|
|
400
413
|
id: number;
|
|
414
|
+
created: string;
|
|
401
415
|
/** The kind of Service */
|
|
402
416
|
kind: MerchantDetailKind;
|
|
403
417
|
/** The name assigned to the Service */
|
|
404
418
|
name: string;
|
|
419
|
+
/** The hostname used by the Service */
|
|
420
|
+
api_hostname: string;
|
|
405
421
|
}
|
|
406
422
|
type MerchantGetResponse = MerchantDetail;
|
|
407
423
|
interface MerchantsGetResponse {
|
|
@@ -423,9 +439,6 @@ declare const OrganisationDetailDefaultProductPrivacy: {
|
|
|
423
439
|
interface OrganisationDetail {
|
|
424
440
|
/** Whether the user making the API call is a member of the Unit */
|
|
425
441
|
caller_is_member: boolean;
|
|
426
|
-
created: string;
|
|
427
|
-
/** The Organisation's default product privacy setting */
|
|
428
|
-
default_product_privacy: OrganisationDetailDefaultProductPrivacy;
|
|
429
442
|
/** The Organisation's unique ID */
|
|
430
443
|
id: string;
|
|
431
444
|
/** The Organisation's name */
|
|
@@ -434,6 +447,9 @@ interface OrganisationDetail {
|
|
|
434
447
|
owner_id?: string;
|
|
435
448
|
/** True if the Unit is private */
|
|
436
449
|
private: boolean;
|
|
450
|
+
created: string;
|
|
451
|
+
/** The Organisation's default product privacy setting */
|
|
452
|
+
default_product_privacy: OrganisationDetailDefaultProductPrivacy;
|
|
437
453
|
}
|
|
438
454
|
/**
|
|
439
455
|
* The Organisation's default product privacy setting
|
|
@@ -448,9 +464,6 @@ declare const OrganisationAllDetailDefaultProductPrivacy: {
|
|
|
448
464
|
interface OrganisationAllDetail {
|
|
449
465
|
/** Whether the user making the API call is a member of the Unit */
|
|
450
466
|
caller_is_member: boolean;
|
|
451
|
-
created: string;
|
|
452
|
-
/** The Organisation's default product privacy setting */
|
|
453
|
-
default_product_privacy: OrganisationAllDetailDefaultProductPrivacy;
|
|
454
467
|
/** The Organisation's unique ID */
|
|
455
468
|
id: string;
|
|
456
469
|
/** The Organisation's name */
|
|
@@ -459,6 +472,9 @@ interface OrganisationAllDetail {
|
|
|
459
472
|
owner_id?: string;
|
|
460
473
|
/** True if the Unit is private */
|
|
461
474
|
private: boolean;
|
|
475
|
+
created: string;
|
|
476
|
+
/** The Organisation's default product privacy setting */
|
|
477
|
+
default_product_privacy: OrganisationAllDetailDefaultProductPrivacy;
|
|
462
478
|
/** A list of users that are members of the Organisation */
|
|
463
479
|
users: UserDetail[];
|
|
464
480
|
}
|
|
@@ -470,12 +486,12 @@ declare const ProductTypeServiceKind: {
|
|
|
470
486
|
readonly DATA_MANAGER: "DATA_MANAGER";
|
|
471
487
|
};
|
|
472
488
|
interface ProductType {
|
|
489
|
+
/** A product type, this is a unique string amongst all types known to the Account Server */
|
|
490
|
+
type: string;
|
|
473
491
|
/** A product flavour. Not all types have a flavour, those that do have a type-specific flavour string */
|
|
474
492
|
flavour?: string;
|
|
475
493
|
/** The kind of service that can use the Product */
|
|
476
494
|
service_kind?: ProductTypeServiceKind;
|
|
477
|
-
/** A product type, this is a unique string amongst all types known to the Account Server */
|
|
478
|
-
type: string;
|
|
479
495
|
}
|
|
480
496
|
type ProductInstanceDetailCoins = {
|
|
481
497
|
/** The number of coins used
|
|
@@ -485,15 +501,6 @@ type ProductInstanceDetailCoins = {
|
|
|
485
501
|
interface ProductInstanceDetail {
|
|
486
502
|
coins: ProductInstanceDetailCoins;
|
|
487
503
|
}
|
|
488
|
-
/**
|
|
489
|
-
* The Product Type
|
|
490
|
-
|
|
491
|
-
*/
|
|
492
|
-
type ProductDetailType = typeof ProductDetailType[keyof typeof ProductDetailType];
|
|
493
|
-
declare const ProductDetailType: {
|
|
494
|
-
readonly DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION";
|
|
495
|
-
readonly DATA_MANAGER_STORAGE_SUBSCRIPTION: "DATA_MANAGER_STORAGE_SUBSCRIPTION";
|
|
496
|
-
};
|
|
497
504
|
/**
|
|
498
505
|
* The Product Type flavour. Not all products have flavours
|
|
499
506
|
|
|
@@ -505,44 +512,53 @@ declare const ProductDetailFlavour: {
|
|
|
505
512
|
readonly SILVER: "SILVER";
|
|
506
513
|
readonly GOLD: "GOLD";
|
|
507
514
|
};
|
|
515
|
+
/**
|
|
516
|
+
* The Product Type
|
|
517
|
+
|
|
518
|
+
*/
|
|
519
|
+
type ProductDetailType = typeof ProductDetailType[keyof typeof ProductDetailType];
|
|
520
|
+
declare const ProductDetailType: {
|
|
521
|
+
readonly DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION";
|
|
522
|
+
readonly DATA_MANAGER_STORAGE_SUBSCRIPTION: "DATA_MANAGER_STORAGE_SUBSCRIPTION";
|
|
523
|
+
};
|
|
508
524
|
interface ProductDetail {
|
|
525
|
+
/** The Product ID
|
|
526
|
+
*/
|
|
527
|
+
id: string;
|
|
509
528
|
created: string;
|
|
529
|
+
/** The Product Type
|
|
530
|
+
*/
|
|
531
|
+
type: ProductDetailType;
|
|
510
532
|
/** The Product Type flavour. Not all products have flavours
|
|
511
533
|
*/
|
|
512
534
|
flavour?: ProductDetailFlavour;
|
|
513
|
-
/** The Product ID
|
|
514
|
-
*/
|
|
515
|
-
id: string;
|
|
516
535
|
/** The name of the Product
|
|
517
536
|
*/
|
|
518
537
|
name?: string;
|
|
519
|
-
/** The Product Type
|
|
520
|
-
*/
|
|
521
|
-
type: ProductDetailType;
|
|
522
538
|
}
|
|
523
539
|
interface ProductCoinsDetail {
|
|
524
540
|
/** The billing allowance. When you exceed this during the current billing period the *cost multiplier* will increase */
|
|
525
541
|
allowance: number;
|
|
526
|
-
/**
|
|
527
|
-
|
|
542
|
+
/** The limit on your billing period spend. You can exceed the allowance but you cannot exceed the spend limit. Once reached the dependent may be restricted */
|
|
543
|
+
limit: number;
|
|
544
|
+
/** The total number of coins consumed (in this billing period), excluding the coins that have been consumed for the current day */
|
|
545
|
+
used: number;
|
|
528
546
|
/** True if the product is operating at or beyond its coin limit. When it is authority to perform actions using the product are severely limited. */
|
|
529
547
|
at_limit: boolean;
|
|
530
|
-
/** The
|
|
531
|
-
|
|
548
|
+
/** The current burn rate, the approximate amount of coins you are currently consuming each day */
|
|
549
|
+
current_burn_rate: number;
|
|
532
550
|
/** The predicted total billing period amount, if costs continue at the current burn rate until the end of the billing period. This is an estimate */
|
|
533
551
|
billing_prediction: number;
|
|
534
552
|
/** The predicted storage contribution to the billing period amount, if costs continue at the current burn rate until the end of the billing period. This is an estimate */
|
|
535
553
|
billing_prediction_storage_contribution: number;
|
|
536
|
-
/** The
|
|
537
|
-
|
|
538
|
-
/**
|
|
539
|
-
|
|
554
|
+
/** The day of the month when the bill is due, and the end of the current billing period */
|
|
555
|
+
billing_day: number;
|
|
556
|
+
/** A multiplier applied to your coin usage within your allowance */
|
|
557
|
+
allowance_multiplier: number;
|
|
540
558
|
/** A multiplier that will be applied to coin used beyond your allowance */
|
|
541
559
|
overspend_multiplier: number;
|
|
542
560
|
/** The number of days remaining, in the current billing period */
|
|
543
561
|
remaining_days: number;
|
|
544
|
-
/** The total number of coins consumed (in this billing period), excluding the coins that have been consumed for the current day */
|
|
545
|
-
used: number;
|
|
546
562
|
}
|
|
547
563
|
interface ProductClaimDetail {
|
|
548
564
|
/** The service-specific ID that is using this Subscription
|
|
@@ -552,93 +568,93 @@ interface ProductClaimDetail {
|
|
|
552
568
|
*/
|
|
553
569
|
name?: string;
|
|
554
570
|
}
|
|
571
|
+
type ProductDmStorageDetailCoins = {
|
|
572
|
+
/** The number of coins currently committed for the current day. This is added to the accumulated coins at the start of each day */
|
|
573
|
+
used: number;
|
|
574
|
+
/** The coin cost of a 'unit' of storage or part thereof. The unit size is defined in the storage section of the response */
|
|
575
|
+
unit_cost: number;
|
|
576
|
+
};
|
|
555
577
|
type ProductDmStorageDetailSize = {
|
|
556
|
-
/** The humanised size of the current storage used for the current day and used to calculate the 'burn rate' */
|
|
557
|
-
current: string;
|
|
558
578
|
/** The humanised size of the peak storage used for the current day. The value is reset at the start of each day */
|
|
559
579
|
peak: string;
|
|
580
|
+
/** The humanised size of the current storage used for the current day and used to calculate the 'burn rate' */
|
|
581
|
+
current: string;
|
|
560
582
|
/** The humanised storage unit. The cost of storage is based on the daily peak of the number of units (or part thereof) used */
|
|
561
583
|
unit_size: string;
|
|
562
584
|
/** The peak number of storage units used today */
|
|
563
585
|
units_used: number;
|
|
564
586
|
};
|
|
565
|
-
type ProductDmStorageDetailCoins = {
|
|
566
|
-
/** The coin cost of a 'unit' of storage or part thereof. The unit size is defined in the storage section of the response */
|
|
567
|
-
unit_cost: number;
|
|
568
|
-
/** The number of coins currently committed for the current day. This is added to the accumulated coins at the start of each day */
|
|
569
|
-
used: number;
|
|
570
|
-
};
|
|
571
587
|
interface ProductDmStorageDetail {
|
|
572
|
-
coins: ProductDmStorageDetailCoins;
|
|
573
588
|
size: ProductDmStorageDetailSize;
|
|
589
|
+
coins: ProductDmStorageDetailCoins;
|
|
574
590
|
}
|
|
575
591
|
interface ProductDmProjectTier {
|
|
576
|
-
claim?: ProductClaimDetail;
|
|
577
|
-
/** True if the product can be (needs to be) claimed. */
|
|
578
|
-
claimable: boolean;
|
|
579
|
-
coins: ProductCoinsDetail;
|
|
580
|
-
instance: ProductInstanceDetail;
|
|
581
|
-
organisation: OrganisationAllDetail;
|
|
582
592
|
product: ProductDetail;
|
|
583
|
-
|
|
593
|
+
organisation: OrganisationAllDetail;
|
|
584
594
|
unit: UnitAllDetail;
|
|
585
|
-
|
|
586
|
-
|
|
595
|
+
storage: ProductDmStorageDetail;
|
|
596
|
+
coins: ProductCoinsDetail;
|
|
597
|
+
instance: ProductInstanceDetail;
|
|
587
598
|
/** True if the product can be (needs to be) claimed. */
|
|
588
599
|
claimable: boolean;
|
|
589
|
-
|
|
590
|
-
|
|
600
|
+
claim?: ProductClaimDetail;
|
|
601
|
+
}
|
|
602
|
+
interface ProductDmStorage {
|
|
591
603
|
product: ProductDetail;
|
|
592
|
-
|
|
604
|
+
organisation: OrganisationAllDetail;
|
|
593
605
|
unit: UnitAllDetail;
|
|
606
|
+
storage: ProductDmStorageDetail;
|
|
607
|
+
coins: ProductCoinsDetail;
|
|
608
|
+
/** True if the product can be (needs to be) claimed. */
|
|
609
|
+
claimable: boolean;
|
|
594
610
|
}
|
|
595
611
|
interface ChargeAdditionalData {
|
|
596
612
|
[key: string]: unknown;
|
|
597
613
|
}
|
|
598
614
|
interface StorageChargeItem {
|
|
599
|
-
|
|
600
|
-
/** The date
|
|
601
|
-
|
|
615
|
+
item_number: number;
|
|
616
|
+
/** The date and time of the processing charge */
|
|
617
|
+
date: string;
|
|
602
618
|
/** The coin-cost of the storage */
|
|
603
619
|
coins: string;
|
|
604
620
|
/** The current burn rate, the approximate amount of coins you are currently consuming each day */
|
|
605
621
|
current_burn_rate?: string;
|
|
606
|
-
/** The date
|
|
607
|
-
|
|
608
|
-
|
|
622
|
+
/** The date when the charges concluded */
|
|
623
|
+
closed?: string;
|
|
624
|
+
additional_data?: ChargeAdditionalData;
|
|
609
625
|
}
|
|
610
626
|
interface StorageCharges {
|
|
611
|
-
items: StorageChargeItem[];
|
|
612
627
|
num_items: number;
|
|
628
|
+
items: StorageChargeItem[];
|
|
613
629
|
}
|
|
614
630
|
interface ProcessingChargeItem {
|
|
615
|
-
additional_data?: ChargeAdditionalData;
|
|
616
|
-
/** The coin-cost of the storage */
|
|
617
|
-
coins: string;
|
|
618
631
|
/** The charge record number */
|
|
619
632
|
id: number;
|
|
620
|
-
name?: string;
|
|
621
633
|
/** The most recent sequence number for this charge */
|
|
622
634
|
sqn: number;
|
|
635
|
+
name?: string;
|
|
636
|
+
username: string;
|
|
623
637
|
/** The date and time of the processing charge */
|
|
624
638
|
timestamp: string;
|
|
625
|
-
|
|
639
|
+
/** The coin-cost of the storage */
|
|
640
|
+
coins: string;
|
|
641
|
+
additional_data?: ChargeAdditionalData;
|
|
626
642
|
}
|
|
627
643
|
type ProcessingChargesMerchantKind = typeof ProcessingChargesMerchantKind[keyof typeof ProcessingChargesMerchantKind];
|
|
628
644
|
declare const ProcessingChargesMerchantKind: {
|
|
629
645
|
readonly DATA_MANAGER: "DATA_MANAGER";
|
|
630
646
|
};
|
|
631
647
|
interface ProcessingCharges {
|
|
632
|
-
|
|
648
|
+
merchant_name: string;
|
|
649
|
+
merchant_kind: ProcessingChargesMerchantKind;
|
|
650
|
+
merchant_api_hostname: string;
|
|
633
651
|
/** The date when the process stopped */
|
|
634
652
|
closed?: string;
|
|
635
653
|
/** True if no further change to the charges can occur. Typically True after the charge has been closed for a pre-configured period of time. */
|
|
636
654
|
final: boolean;
|
|
637
|
-
merchant_api_hostname: string;
|
|
638
|
-
merchant_kind: ProcessingChargesMerchantKind;
|
|
639
|
-
merchant_name: string;
|
|
640
655
|
/** True if charges were received after the charge record was finalised */
|
|
641
656
|
post_final_charges?: boolean;
|
|
657
|
+
charge: ProcessingChargeItem;
|
|
642
658
|
}
|
|
643
659
|
type AssetDetailScope = typeof AssetDetailScope[keyof typeof AssetDetailScope];
|
|
644
660
|
declare const AssetDetailScope: {
|
|
@@ -649,18 +665,18 @@ declare const AssetDetailScope: {
|
|
|
649
665
|
readonly GLOBAL: "GLOBAL";
|
|
650
666
|
};
|
|
651
667
|
interface AssetDetail {
|
|
652
|
-
content: string;
|
|
653
|
-
content_modified?: string;
|
|
654
|
-
created: string;
|
|
655
668
|
creator: string;
|
|
656
|
-
description?: string;
|
|
657
|
-
disabled: boolean;
|
|
658
669
|
id: string;
|
|
659
|
-
merchants: MerchantDetail[];
|
|
660
670
|
name: string;
|
|
661
671
|
scope: AssetDetailScope;
|
|
662
672
|
scope_id: string;
|
|
663
673
|
secret: boolean;
|
|
674
|
+
disabled: boolean;
|
|
675
|
+
content: string;
|
|
676
|
+
created: string;
|
|
677
|
+
content_modified?: string;
|
|
678
|
+
description?: string;
|
|
679
|
+
merchants: MerchantDetail[];
|
|
664
680
|
}
|
|
665
681
|
type UserAccountGetResponse = UserAccountDetail;
|
|
666
682
|
interface UnitsGetResponse {
|
|
@@ -682,42 +698,42 @@ declare const ChargeSummaryType: {
|
|
|
682
698
|
readonly STORAGE: "STORAGE";
|
|
683
699
|
};
|
|
684
700
|
interface ChargeSummary {
|
|
685
|
-
/** The cost, in coins of the charge */
|
|
686
|
-
coins: string;
|
|
687
701
|
/** The type of charge */
|
|
688
702
|
type: ChargeSummaryType;
|
|
703
|
+
/** The cost, in coins of the charge */
|
|
704
|
+
coins: string;
|
|
689
705
|
}
|
|
690
706
|
interface UnitProductChargeSummary {
|
|
691
|
-
charges: ChargeSummary[];
|
|
692
707
|
product_id: string;
|
|
693
708
|
product_type: string;
|
|
709
|
+
charges: ChargeSummary[];
|
|
694
710
|
}
|
|
695
711
|
interface UnitChargeSummary {
|
|
696
712
|
charges: ChargeSummary[];
|
|
697
713
|
}
|
|
698
714
|
interface UnitChargesGetResponse {
|
|
699
|
-
/**
|
|
700
|
-
* @minimum 1
|
|
701
|
-
* @maximum 28
|
|
702
|
-
*/
|
|
703
|
-
billing_day: number;
|
|
704
715
|
/** Whether the user making the API call is a member of the Unit */
|
|
705
716
|
caller_is_member: boolean;
|
|
706
|
-
|
|
707
|
-
count: number;
|
|
708
|
-
created: string;
|
|
709
|
-
/** The start of the charge period */
|
|
710
|
-
from: string;
|
|
717
|
+
unit_id: string;
|
|
711
718
|
name?: string;
|
|
712
719
|
/** The Unit's owner (a username) */
|
|
713
720
|
owner_id: string;
|
|
714
721
|
/** True if the Unit is private */
|
|
715
722
|
private: boolean;
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
723
|
+
created: string;
|
|
724
|
+
coins: string;
|
|
725
|
+
count: number;
|
|
726
|
+
/**
|
|
727
|
+
* @minimum 1
|
|
728
|
+
* @maximum 28
|
|
729
|
+
*/
|
|
730
|
+
billing_day: number;
|
|
731
|
+
/** The start of the charge period */
|
|
732
|
+
from: string;
|
|
719
733
|
/** The date where of first day after the charge period */
|
|
720
734
|
until: string;
|
|
735
|
+
summary: UnitChargeSummary;
|
|
736
|
+
products: UnitProductChargeSummary[];
|
|
721
737
|
}
|
|
722
738
|
/**
|
|
723
739
|
* The Unit's Product
|
|
@@ -735,8 +751,8 @@ interface ProductsGetTypesResponse {
|
|
|
735
751
|
}
|
|
736
752
|
type ProductsGetDefaultStorageCostDefaultStorageCost = {
|
|
737
753
|
cost: string;
|
|
738
|
-
description: string;
|
|
739
754
|
units: string;
|
|
755
|
+
description: string;
|
|
740
756
|
};
|
|
741
757
|
interface ProductsGetDefaultStorageCost {
|
|
742
758
|
default_storage_cost: ProductsGetDefaultStorageCostDefaultStorageCost;
|
|
@@ -753,25 +769,25 @@ declare const ProductChargesGetResponseProductType: {
|
|
|
753
769
|
readonly DATA_MANAGER_STORAGE_SUBSCRIPTION: "DATA_MANAGER_STORAGE_SUBSCRIPTION";
|
|
754
770
|
};
|
|
755
771
|
interface ProductChargesGetResponse {
|
|
772
|
+
product_id: string;
|
|
773
|
+
product_type: ProductChargesGetResponseProductType;
|
|
756
774
|
/**
|
|
757
775
|
* @minimum 1
|
|
758
776
|
* @maximum 28
|
|
759
777
|
*/
|
|
760
778
|
billing_day: number;
|
|
761
|
-
claim?: ProductClaimDetail;
|
|
762
779
|
/** True if the product can be (needs to be) claimed. */
|
|
763
780
|
claimable: boolean;
|
|
764
|
-
|
|
765
|
-
coins: string;
|
|
781
|
+
claim?: ProductClaimDetail;
|
|
766
782
|
count: number;
|
|
767
783
|
/** The start of the charge period */
|
|
768
784
|
from: string;
|
|
769
|
-
processing_charges: ProcessingCharges[];
|
|
770
|
-
product_id: string;
|
|
771
|
-
product_type: ProductChargesGetResponseProductType;
|
|
772
|
-
storage_charges: StorageCharges;
|
|
773
785
|
/** The date where of first day after the charge period */
|
|
774
786
|
until: string;
|
|
787
|
+
/** The total number of coins consumed by this product for the invoice period */
|
|
788
|
+
coins: string;
|
|
789
|
+
processing_charges: ProcessingCharges[];
|
|
790
|
+
storage_charges: StorageCharges;
|
|
775
791
|
}
|
|
776
792
|
type OrganisationGetResponse = OrganisationAllDetail;
|
|
777
793
|
interface OrganisationsGetResponse {
|
|
@@ -780,6 +796,8 @@ interface OrganisationsGetResponse {
|
|
|
780
796
|
organisations: OrganisationAllDetail[];
|
|
781
797
|
}
|
|
782
798
|
interface OrganisationUnitChargeSummary {
|
|
799
|
+
unit_id: string;
|
|
800
|
+
name: string;
|
|
783
801
|
/**
|
|
784
802
|
* @minimum 1
|
|
785
803
|
* @maximum 28
|
|
@@ -787,16 +805,14 @@ interface OrganisationUnitChargeSummary {
|
|
|
787
805
|
billing_day: number;
|
|
788
806
|
/** The start of the charge period */
|
|
789
807
|
from: string;
|
|
790
|
-
name: string;
|
|
791
|
-
summary: ChargeSummary[];
|
|
792
|
-
unit_id: string;
|
|
793
808
|
/** The date where of first day after the charge period */
|
|
794
809
|
until: string;
|
|
810
|
+
summary: ChargeSummary[];
|
|
795
811
|
}
|
|
796
812
|
interface OrganisationChargesGetResponse {
|
|
797
|
-
coins: string;
|
|
798
|
-
name: string;
|
|
799
813
|
organisation_id: string;
|
|
814
|
+
name: string;
|
|
815
|
+
coins: string;
|
|
800
816
|
summary: ChargeSummary[];
|
|
801
817
|
unit_charges: OrganisationUnitChargeSummary[];
|
|
802
818
|
}
|
|
@@ -808,15 +824,15 @@ interface OrganisationUnitsGetResponse {
|
|
|
808
824
|
units: UnitAllDetail[];
|
|
809
825
|
}
|
|
810
826
|
interface OrganisationChargeSummary {
|
|
811
|
-
name: string;
|
|
812
827
|
organisation_id: string;
|
|
828
|
+
name: string;
|
|
813
829
|
summary: ChargeSummary[];
|
|
814
830
|
}
|
|
815
831
|
interface PersonalUnitPutResponse {
|
|
816
|
-
/** The unit's unique ID */
|
|
817
|
-
id: string;
|
|
818
832
|
/** The unit's Organisation. Used to identify the Default organisation */
|
|
819
833
|
organisation_id: string;
|
|
834
|
+
/** The unit's unique ID */
|
|
835
|
+
id: string;
|
|
820
836
|
}
|
|
821
837
|
interface OrganisationUnitPostResponse {
|
|
822
838
|
/** The unit's unique ID */
|
|
@@ -835,9 +851,6 @@ declare const OrganisationGetDefaultResponseDefaultProductPrivacy: {
|
|
|
835
851
|
interface OrganisationGetDefaultResponse {
|
|
836
852
|
/** Whether the user making the API call is a member of the Default Organisation. Only admin users are members of the Default organisation */
|
|
837
853
|
caller_is_member?: boolean;
|
|
838
|
-
created?: string;
|
|
839
|
-
/** The Organisation's default product privacy setting */
|
|
840
|
-
default_product_privacy?: OrganisationGetDefaultResponseDefaultProductPrivacy;
|
|
841
854
|
/** The Default Organisation ID
|
|
842
855
|
*/
|
|
843
856
|
id?: string;
|
|
@@ -847,6 +860,9 @@ interface OrganisationGetDefaultResponse {
|
|
|
847
860
|
/** True if the Organisation is private. The Default organisation is always public, although it does not contain a membership (unless you're admin) and only houses Personal Units
|
|
848
861
|
*/
|
|
849
862
|
private?: boolean;
|
|
863
|
+
created?: string;
|
|
864
|
+
/** The Organisation's default product privacy setting */
|
|
865
|
+
default_product_privacy?: OrganisationGetDefaultResponseDefaultProductPrivacy;
|
|
850
866
|
}
|
|
851
867
|
interface UsersGetResponse {
|
|
852
868
|
count: number;
|
|
@@ -874,8 +890,8 @@ interface EventStreamGetPostResponse {
|
|
|
874
890
|
interface ChargesGetResponse {
|
|
875
891
|
coins: string;
|
|
876
892
|
count: number;
|
|
877
|
-
organisation_charges: OrganisationChargeSummary[];
|
|
878
893
|
summary: ChargeSummary[];
|
|
894
|
+
organisation_charges: OrganisationChargeSummary[];
|
|
879
895
|
}
|
|
880
896
|
interface AssetPostResponse {
|
|
881
897
|
/** The Asset ID
|
|
@@ -911,4 +927,4 @@ declare const setBaseUrl: (baseUrl: string) => void;
|
|
|
911
927
|
declare const customInstance: <TReturn>(config: AxiosRequestConfig, options?: AxiosRequestConfig) => Promise<TReturn>;
|
|
912
928
|
type ErrorType<TError> = AxiosError<TError>;
|
|
913
929
|
|
|
914
|
-
export { AXIOS_INSTANCE, type AsError, type AssetDetail, AssetDetailScope, type AssetGetByIdResponse, type AssetGetResponse, type AssetPatchBodyBody, type AssetPostBodyBody, AssetPostBodyBodyScope, type AssetPostResponse, type AttachAssetParams, type ChargeAdditionalData, type ChargeSummary, ChargeSummaryType, type ChargesGetResponse, type DetachAssetParams, type ErrorType, type EventStreamGetPostResponse, type GetAssetParams, type GetChargesParams, type GetOrganisationChargesParams, type GetProductChargesParams, type GetUnitChargesParams, type MerchantDetail, MerchantDetailKind, type MerchantGetResponse, type MerchantsGetResponse, type OrganisationAllDetail, OrganisationAllDetailDefaultProductPrivacy, type OrganisationChargeSummary, type OrganisationChargesGetResponse, type OrganisationDetail, OrganisationDetailDefaultProductPrivacy, type OrganisationGetDefaultResponse, OrganisationGetDefaultResponseDefaultProductPrivacy, type OrganisationGetResponse, type OrganisationPatchBodyBody, OrganisationPatchBodyBodyDefaultProductPrivacy, type OrganisationPostBodyBody, OrganisationPostBodyBodyDefaultProductPrivacy, type OrganisationPostResponse, type OrganisationUnitChargeSummary, type OrganisationUnitPostBodyBody, OrganisationUnitPostBodyBodyDefaultProductPrivacy, type OrganisationUnitPostResponse, type OrganisationUnitsGetResponse, type OrganisationsGetResponse, type PersonalUnitPutBodyBody, type PersonalUnitPutResponse, type ProcessingChargeItem, type ProcessingCharges, ProcessingChargesMerchantKind, type ProductChargesGetResponse, ProductChargesGetResponseProductType, type ProductClaimDetail, type ProductCoinsDetail, type ProductDetail, ProductDetailFlavour, ProductDetailType, type ProductDmProjectTier, type ProductDmStorage, type ProductDmStorageDetail, type ProductDmStorageDetailCoins, type ProductDmStorageDetailSize, type ProductInstanceDetail, type ProductInstanceDetailCoins, type ProductPatchBodyBody, type ProductType, ProductTypeServiceKind, type ProductUnitGetResponse, type ProductUnitGetResponseProduct, type ProductsGetDefaultStorageCost, type ProductsGetDefaultStorageCostDefaultStorageCost, type ProductsGetResponse, type ProductsGetResponseProductsItem, type ProductsGetTypesResponse, type QFromParameter, type QMIdParameter, type QOrgIdParameter, type QPbpParameter, type QProductIdParameter, type QUnitIdParameter, type QUntilParameter, type QUserIdParameter, type StateGetVersionResponse, type StorageChargeItem, type StorageCharges, type UnitAllDetail, UnitAllDetailDefaultProductPrivacy, type UnitChargeSummary, type UnitChargesGetResponse, type UnitDetail, UnitDetailDefaultProductPrivacy, type UnitGetResponse, type UnitPatchBodyBody, UnitPatchBodyBodyDefaultProductPrivacy, type UnitProductChargeSummary, type UnitProductPostBodyBody, UnitProductPostBodyBodyFlavour, UnitProductPostBodyBodyType, type UnitProductPostResponse, type UnitsGetResponse, type UserAccountDetail, type UserAccountGetResponse, type UserDetail, type UsersGetResponse, customInstance, setAuthToken, setBaseUrl };
|
|
930
|
+
export { AXIOS_INSTANCE, type AsError, type AssetDetail, AssetDetailScope, type AssetGetByIdResponse, type AssetGetResponse, type AssetPatchBodyBody, type AssetPostBodyBody, AssetPostBodyBodyScope, type AssetPostResponse, type AttachAssetParams, type ChargeAdditionalData, type ChargeSummary, ChargeSummaryType, type ChargesGetResponse, type DetachAssetParams, type ErrorType, type EventStreamGetPostResponse, type GetAssetParams, type GetChargesParams, type GetOrganisationChargesParams, type GetOrganisationsParams, type GetProductChargesParams, type GetUnitChargesParams, type GetUnitsParams, type MerchantDetail, MerchantDetailKind, type MerchantGetResponse, type MerchantsGetResponse, type OrganisationAllDetail, OrganisationAllDetailDefaultProductPrivacy, type OrganisationChargeSummary, type OrganisationChargesGetResponse, type OrganisationDetail, OrganisationDetailDefaultProductPrivacy, type OrganisationGetDefaultResponse, OrganisationGetDefaultResponseDefaultProductPrivacy, type OrganisationGetResponse, type OrganisationPatchBodyBody, OrganisationPatchBodyBodyDefaultProductPrivacy, type OrganisationPostBodyBody, OrganisationPostBodyBodyDefaultProductPrivacy, type OrganisationPostResponse, type OrganisationUnitChargeSummary, type OrganisationUnitPostBodyBody, OrganisationUnitPostBodyBodyDefaultProductPrivacy, type OrganisationUnitPostResponse, type OrganisationUnitsGetResponse, type OrganisationsGetResponse, type PersonalUnitPutBodyBody, type PersonalUnitPutResponse, type ProcessingChargeItem, type ProcessingCharges, ProcessingChargesMerchantKind, type ProductChargesGetResponse, ProductChargesGetResponseProductType, type ProductClaimDetail, type ProductCoinsDetail, type ProductDetail, ProductDetailFlavour, ProductDetailType, type ProductDmProjectTier, type ProductDmStorage, type ProductDmStorageDetail, type ProductDmStorageDetailCoins, type ProductDmStorageDetailSize, type ProductInstanceDetail, type ProductInstanceDetailCoins, type ProductPatchBodyBody, type ProductType, ProductTypeServiceKind, type ProductUnitGetResponse, type ProductUnitGetResponseProduct, type ProductsGetDefaultStorageCost, type ProductsGetDefaultStorageCostDefaultStorageCost, type ProductsGetResponse, type ProductsGetResponseProductsItem, type ProductsGetTypesResponse, type QFromParameter, type QMIdParameter, type QNameParameter, type QOrgIdParameter, type QPbpParameter, type QProductIdParameter, type QUnitIdParameter, type QUntilParameter, type QUserIdParameter, type StateGetVersionResponse, type StorageChargeItem, type StorageCharges, type UnitAllDetail, UnitAllDetailDefaultProductPrivacy, type UnitChargeSummary, type UnitChargesGetResponse, type UnitDetail, UnitDetailDefaultProductPrivacy, type UnitGetResponse, type UnitPatchBodyBody, UnitPatchBodyBodyDefaultProductPrivacy, type UnitProductChargeSummary, type UnitProductPostBodyBody, UnitProductPostBodyBodyFlavour, UnitProductPostBodyBodyType, type UnitProductPostResponse, type UnitsGetResponse, type UserAccountDetail, type UserAccountGetResponse, type UserDetail, type UsersGetResponse, customInstance, setAuthToken, setBaseUrl };
|