@squonk/account-server-client 4.1.0 → 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 +172 -172
- package/index.d.ts +172 -172
- 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 +10 -6
- package/organisation/organisation.cjs.map +1 -1
- package/organisation/organisation.d.cts +44 -44
- package/organisation/organisation.d.ts +44 -44
- package/organisation/organisation.js +10 -6
- 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 +180 -180
- package/src/asset/asset.ts +120 -83
- package/src/charges/charges.ts +50 -49
- package/src/event-stream/event-stream.ts +55 -43
- package/src/merchant/merchant.ts +26 -25
- package/src/organisation/organisation.ts +80 -63
- package/src/product/product.ts +116 -99
- package/src/state/state.ts +14 -13
- package/src/unit/unit.ts +106 -79
- package/src/user/user.ts +90 -69
- 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 +15 -9
- package/unit/unit.cjs.map +1 -1
- package/unit/unit.d.cts +56 -56
- package/unit/unit.d.ts +56 -56
- package/unit/unit.js +15 -9
- 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,7 +2,7 @@ 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.
|
|
@@ -146,6 +146,11 @@ type GetUnitChargesParams = {
|
|
|
146
146
|
pbp?: QPbpParameter;
|
|
147
147
|
};
|
|
148
148
|
type ProductPatchBodyBody = {
|
|
149
|
+
/**
|
|
150
|
+
* The name you want to give the Product
|
|
151
|
+
* @maxLength 80
|
|
152
|
+
*/
|
|
153
|
+
name?: string;
|
|
149
154
|
/**
|
|
150
155
|
* The Product's built-in coin allowance. Product allowances cannot be reduced
|
|
151
156
|
* @minimum 1
|
|
@@ -156,21 +161,6 @@ type ProductPatchBodyBody = {
|
|
|
156
161
|
* @minimum 1
|
|
157
162
|
*/
|
|
158
163
|
limit?: number;
|
|
159
|
-
/**
|
|
160
|
-
* The name you want to give the Product
|
|
161
|
-
* @maxLength 80
|
|
162
|
-
*/
|
|
163
|
-
name?: string;
|
|
164
|
-
};
|
|
165
|
-
/**
|
|
166
|
-
* The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be provided.
|
|
167
|
-
|
|
168
|
-
Project Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products
|
|
169
|
-
*/
|
|
170
|
-
type UnitProductPostBodyBodyType = typeof UnitProductPostBodyBodyType[keyof typeof UnitProductPostBodyBodyType];
|
|
171
|
-
declare const UnitProductPostBodyBodyType: {
|
|
172
|
-
readonly DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION";
|
|
173
|
-
readonly DATA_MANAGER_STORAGE_SUBSCRIPTION: "DATA_MANAGER_STORAGE_SUBSCRIPTION";
|
|
174
164
|
};
|
|
175
165
|
/**
|
|
176
166
|
* The Flavour of the Product. Used only for Project Tier Products. Do not set this for Storage products
|
|
@@ -182,28 +172,38 @@ declare const UnitProductPostBodyBodyFlavour: {
|
|
|
182
172
|
readonly SILVER: "SILVER";
|
|
183
173
|
readonly GOLD: "GOLD";
|
|
184
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
|
+
};
|
|
185
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;
|
|
186
197
|
/**
|
|
187
198
|
* The Product's coin allowance. You must provide this for Storage products but you must not provide a value for Project Tier Products
|
|
188
199
|
* @minimum 1
|
|
189
200
|
*/
|
|
190
201
|
allowance?: number;
|
|
191
|
-
/** The Flavour of the Product. Used only for Project Tier Products. Do not set this for Storage products */
|
|
192
|
-
flavour?: UnitProductPostBodyBodyFlavour;
|
|
193
202
|
/**
|
|
194
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
|
|
195
204
|
* @minimum 1
|
|
196
205
|
*/
|
|
197
206
|
limit?: number;
|
|
198
|
-
/**
|
|
199
|
-
* The name you want to give the Product
|
|
200
|
-
* @maxLength 80
|
|
201
|
-
*/
|
|
202
|
-
name: string;
|
|
203
|
-
/** The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be provided.
|
|
204
|
-
|
|
205
|
-
Project Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products */
|
|
206
|
-
type: UnitProductPostBodyBodyType;
|
|
207
207
|
};
|
|
208
208
|
/**
|
|
209
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`.
|
|
@@ -218,12 +218,12 @@ declare const UnitPatchBodyBodyDefaultProductPrivacy: {
|
|
|
218
218
|
readonly DEFAULT_PRIVATE: "DEFAULT_PRIVATE";
|
|
219
219
|
};
|
|
220
220
|
type UnitPatchBodyBody = {
|
|
221
|
+
/** The new name for the Unit */
|
|
222
|
+
name?: string;
|
|
221
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`.
|
|
222
224
|
|
|
223
225
|
Whether the privacy can be honoured will depend on the organisation's value */
|
|
224
226
|
default_product_privacy?: UnitPatchBodyBodyDefaultProductPrivacy;
|
|
225
|
-
/** The new name for the Unit */
|
|
226
|
-
name?: string;
|
|
227
227
|
};
|
|
228
228
|
/**
|
|
229
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`.
|
|
@@ -238,12 +238,12 @@ declare const OrganisationPatchBodyBodyDefaultProductPrivacy: {
|
|
|
238
238
|
readonly DEFAULT_PRIVATE: "DEFAULT_PRIVATE";
|
|
239
239
|
};
|
|
240
240
|
type OrganisationPatchBodyBody = {
|
|
241
|
+
/** The new name for the Organisational */
|
|
242
|
+
name?: string;
|
|
241
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`.
|
|
242
244
|
|
|
243
245
|
Whether the privacy can be honoured will depend on the value in any of the organisation's existing units */
|
|
244
246
|
default_product_privacy?: OrganisationPatchBodyBodyDefaultProductPrivacy;
|
|
245
|
-
/** The new name for the Organisational */
|
|
246
|
-
name?: string;
|
|
247
247
|
};
|
|
248
248
|
/**
|
|
249
249
|
* The default product privacy setting for products in the unit. Whether the privacy can be honoured will depend on the organisation's value
|
|
@@ -256,6 +256,11 @@ declare const OrganisationUnitPostBodyBodyDefaultProductPrivacy: {
|
|
|
256
256
|
readonly DEFAULT_PRIVATE: "DEFAULT_PRIVATE";
|
|
257
257
|
};
|
|
258
258
|
type OrganisationUnitPostBodyBody = {
|
|
259
|
+
/**
|
|
260
|
+
* The name of the unit
|
|
261
|
+
* @maxLength 80
|
|
262
|
+
*/
|
|
263
|
+
name: string;
|
|
259
264
|
/**
|
|
260
265
|
* The day you would like to be billed for the Unit's Products (a value from 1 and 28)
|
|
261
266
|
* @minimum 1
|
|
@@ -264,11 +269,6 @@ type OrganisationUnitPostBodyBody = {
|
|
|
264
269
|
billing_day: number;
|
|
265
270
|
/** The default product privacy setting for products in the unit. Whether the privacy can be honoured will depend on the organisation's value */
|
|
266
271
|
default_product_privacy?: OrganisationUnitPostBodyBodyDefaultProductPrivacy;
|
|
267
|
-
/**
|
|
268
|
-
* The name of the unit
|
|
269
|
-
* @maxLength 80
|
|
270
|
-
*/
|
|
271
|
-
name: string;
|
|
272
272
|
};
|
|
273
273
|
type PersonalUnitPutBodyBody = {
|
|
274
274
|
/**
|
|
@@ -289,8 +289,6 @@ declare const OrganisationPostBodyBodyDefaultProductPrivacy: {
|
|
|
289
289
|
readonly DEFAULT_PRIVATE: "DEFAULT_PRIVATE";
|
|
290
290
|
};
|
|
291
291
|
type OrganisationPostBodyBody = {
|
|
292
|
-
/** The default product privacy setting for the Organisation */
|
|
293
|
-
default_product_privacy?: OrganisationPostBodyBodyDefaultProductPrivacy;
|
|
294
292
|
/**
|
|
295
293
|
* The name of the organisation
|
|
296
294
|
* @maxLength 80
|
|
@@ -298,6 +296,8 @@ type OrganisationPostBodyBody = {
|
|
|
298
296
|
name: string;
|
|
299
297
|
/** The name of the organisation owner. A user ID */
|
|
300
298
|
owner: string;
|
|
299
|
+
/** The default product privacy setting for the Organisation */
|
|
300
|
+
default_product_privacy?: OrganisationPostBodyBodyDefaultProductPrivacy;
|
|
301
301
|
};
|
|
302
302
|
type AssetPostBodyBodyScope = typeof AssetPostBodyBodyScope[keyof typeof AssetPostBodyBodyScope];
|
|
303
303
|
declare const AssetPostBodyBodyScope: {
|
|
@@ -308,23 +308,23 @@ declare const AssetPostBodyBodyScope: {
|
|
|
308
308
|
readonly GLOBAL: "GLOBAL";
|
|
309
309
|
};
|
|
310
310
|
type AssetPostBodyBody = {
|
|
311
|
-
/** A file containing the content for the asset. You must provide a value here or in content_string */
|
|
312
|
-
content_file?: Blob;
|
|
313
|
-
/** The textual content of the asset. You must provide a value here or in content_file */
|
|
314
|
-
content_string?: string;
|
|
315
|
-
/** An optional description for the Asset */
|
|
316
|
-
description?: string;
|
|
317
311
|
/**
|
|
318
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
|
|
319
313
|
* @maxLength 80
|
|
320
314
|
* @pattern ^[a-z0-9-]{1,63}$
|
|
321
315
|
*/
|
|
322
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;
|
|
323
321
|
scope: AssetPostBodyBodyScope;
|
|
324
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. */
|
|
325
323
|
scope_id?: string;
|
|
326
324
|
/** Is this a secret asset? */
|
|
327
325
|
secret: boolean;
|
|
326
|
+
/** An optional description for the Asset */
|
|
327
|
+
description?: string;
|
|
328
328
|
};
|
|
329
329
|
type AssetPatchBodyBody = {
|
|
330
330
|
/** A file containing the content for the asset. You must provide a value here or in content_string */
|
|
@@ -339,11 +339,11 @@ interface UserDetail {
|
|
|
339
339
|
id: string;
|
|
340
340
|
}
|
|
341
341
|
interface UserAccountDetail {
|
|
342
|
-
|
|
343
|
-
account_server_roles: string[];
|
|
342
|
+
user: UserDetail;
|
|
344
343
|
/** Whether the caller has admin privilege */
|
|
345
344
|
caller_has_admin_privilege: boolean;
|
|
346
|
-
user
|
|
345
|
+
/** The roles assigned to the user recognised by the Account Server */
|
|
346
|
+
account_server_roles: string[];
|
|
347
347
|
}
|
|
348
348
|
/**
|
|
349
349
|
* The Unit's default product privacy setting
|
|
@@ -356,13 +356,8 @@ declare const UnitDetailDefaultProductPrivacy: {
|
|
|
356
356
|
readonly DEFAULT_PRIVATE: "DEFAULT_PRIVATE";
|
|
357
357
|
};
|
|
358
358
|
interface UnitDetail {
|
|
359
|
-
/** The Unit's billing day */
|
|
360
|
-
billing_day: number;
|
|
361
359
|
/** Whether the user making the API call is a member of the Unit */
|
|
362
360
|
caller_is_member: boolean;
|
|
363
|
-
created: string;
|
|
364
|
-
/** The Unit's default product privacy setting */
|
|
365
|
-
default_product_privacy: UnitDetailDefaultProductPrivacy;
|
|
366
361
|
/** The Unit's unique identity */
|
|
367
362
|
id: string;
|
|
368
363
|
/** The Unit's name */
|
|
@@ -371,6 +366,11 @@ interface UnitDetail {
|
|
|
371
366
|
owner_id: string;
|
|
372
367
|
/** True if the Unit is private */
|
|
373
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;
|
|
374
374
|
}
|
|
375
375
|
/**
|
|
376
376
|
* The Unit's default product privacy setting
|
|
@@ -383,13 +383,8 @@ declare const UnitAllDetailDefaultProductPrivacy: {
|
|
|
383
383
|
readonly DEFAULT_PRIVATE: "DEFAULT_PRIVATE";
|
|
384
384
|
};
|
|
385
385
|
interface UnitAllDetail {
|
|
386
|
-
/** The Unit's billing day */
|
|
387
|
-
billing_day: number;
|
|
388
386
|
/** Whether the user making the API call is a member of the Unit */
|
|
389
387
|
caller_is_member: boolean;
|
|
390
|
-
created: string;
|
|
391
|
-
/** The Unit's default product privacy setting */
|
|
392
|
-
default_product_privacy: UnitAllDetailDefaultProductPrivacy;
|
|
393
388
|
/** The Unit's unique identity */
|
|
394
389
|
id: string;
|
|
395
390
|
/** The Unit's name */
|
|
@@ -398,6 +393,11 @@ interface UnitAllDetail {
|
|
|
398
393
|
owner_id: string;
|
|
399
394
|
/** True if the Unit is private */
|
|
400
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;
|
|
401
401
|
/** A list of users that are members of the Unit */
|
|
402
402
|
users: UserDetail[];
|
|
403
403
|
}
|
|
@@ -409,15 +409,15 @@ declare const MerchantDetailKind: {
|
|
|
409
409
|
readonly DATA_MANAGER: "DATA_MANAGER";
|
|
410
410
|
};
|
|
411
411
|
interface MerchantDetail {
|
|
412
|
-
/** The hostname used by the Service */
|
|
413
|
-
api_hostname: string;
|
|
414
|
-
created: string;
|
|
415
412
|
/** The unique ID of the Service */
|
|
416
413
|
id: number;
|
|
414
|
+
created: string;
|
|
417
415
|
/** The kind of Service */
|
|
418
416
|
kind: MerchantDetailKind;
|
|
419
417
|
/** The name assigned to the Service */
|
|
420
418
|
name: string;
|
|
419
|
+
/** The hostname used by the Service */
|
|
420
|
+
api_hostname: string;
|
|
421
421
|
}
|
|
422
422
|
type MerchantGetResponse = MerchantDetail;
|
|
423
423
|
interface MerchantsGetResponse {
|
|
@@ -439,9 +439,6 @@ declare const OrganisationDetailDefaultProductPrivacy: {
|
|
|
439
439
|
interface OrganisationDetail {
|
|
440
440
|
/** Whether the user making the API call is a member of the Unit */
|
|
441
441
|
caller_is_member: boolean;
|
|
442
|
-
created: string;
|
|
443
|
-
/** The Organisation's default product privacy setting */
|
|
444
|
-
default_product_privacy: OrganisationDetailDefaultProductPrivacy;
|
|
445
442
|
/** The Organisation's unique ID */
|
|
446
443
|
id: string;
|
|
447
444
|
/** The Organisation's name */
|
|
@@ -450,6 +447,9 @@ interface OrganisationDetail {
|
|
|
450
447
|
owner_id?: string;
|
|
451
448
|
/** True if the Unit is private */
|
|
452
449
|
private: boolean;
|
|
450
|
+
created: string;
|
|
451
|
+
/** The Organisation's default product privacy setting */
|
|
452
|
+
default_product_privacy: OrganisationDetailDefaultProductPrivacy;
|
|
453
453
|
}
|
|
454
454
|
/**
|
|
455
455
|
* The Organisation's default product privacy setting
|
|
@@ -464,9 +464,6 @@ declare const OrganisationAllDetailDefaultProductPrivacy: {
|
|
|
464
464
|
interface OrganisationAllDetail {
|
|
465
465
|
/** Whether the user making the API call is a member of the Unit */
|
|
466
466
|
caller_is_member: boolean;
|
|
467
|
-
created: string;
|
|
468
|
-
/** The Organisation's default product privacy setting */
|
|
469
|
-
default_product_privacy: OrganisationAllDetailDefaultProductPrivacy;
|
|
470
467
|
/** The Organisation's unique ID */
|
|
471
468
|
id: string;
|
|
472
469
|
/** The Organisation's name */
|
|
@@ -475,6 +472,9 @@ interface OrganisationAllDetail {
|
|
|
475
472
|
owner_id?: string;
|
|
476
473
|
/** True if the Unit is private */
|
|
477
474
|
private: boolean;
|
|
475
|
+
created: string;
|
|
476
|
+
/** The Organisation's default product privacy setting */
|
|
477
|
+
default_product_privacy: OrganisationAllDetailDefaultProductPrivacy;
|
|
478
478
|
/** A list of users that are members of the Organisation */
|
|
479
479
|
users: UserDetail[];
|
|
480
480
|
}
|
|
@@ -486,12 +486,12 @@ declare const ProductTypeServiceKind: {
|
|
|
486
486
|
readonly DATA_MANAGER: "DATA_MANAGER";
|
|
487
487
|
};
|
|
488
488
|
interface ProductType {
|
|
489
|
+
/** A product type, this is a unique string amongst all types known to the Account Server */
|
|
490
|
+
type: string;
|
|
489
491
|
/** A product flavour. Not all types have a flavour, those that do have a type-specific flavour string */
|
|
490
492
|
flavour?: string;
|
|
491
493
|
/** The kind of service that can use the Product */
|
|
492
494
|
service_kind?: ProductTypeServiceKind;
|
|
493
|
-
/** A product type, this is a unique string amongst all types known to the Account Server */
|
|
494
|
-
type: string;
|
|
495
495
|
}
|
|
496
496
|
type ProductInstanceDetailCoins = {
|
|
497
497
|
/** The number of coins used
|
|
@@ -501,15 +501,6 @@ type ProductInstanceDetailCoins = {
|
|
|
501
501
|
interface ProductInstanceDetail {
|
|
502
502
|
coins: ProductInstanceDetailCoins;
|
|
503
503
|
}
|
|
504
|
-
/**
|
|
505
|
-
* The Product Type
|
|
506
|
-
|
|
507
|
-
*/
|
|
508
|
-
type ProductDetailType = typeof ProductDetailType[keyof typeof ProductDetailType];
|
|
509
|
-
declare const ProductDetailType: {
|
|
510
|
-
readonly DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION";
|
|
511
|
-
readonly DATA_MANAGER_STORAGE_SUBSCRIPTION: "DATA_MANAGER_STORAGE_SUBSCRIPTION";
|
|
512
|
-
};
|
|
513
504
|
/**
|
|
514
505
|
* The Product Type flavour. Not all products have flavours
|
|
515
506
|
|
|
@@ -521,44 +512,53 @@ declare const ProductDetailFlavour: {
|
|
|
521
512
|
readonly SILVER: "SILVER";
|
|
522
513
|
readonly GOLD: "GOLD";
|
|
523
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
|
+
};
|
|
524
524
|
interface ProductDetail {
|
|
525
|
+
/** The Product ID
|
|
526
|
+
*/
|
|
527
|
+
id: string;
|
|
525
528
|
created: string;
|
|
529
|
+
/** The Product Type
|
|
530
|
+
*/
|
|
531
|
+
type: ProductDetailType;
|
|
526
532
|
/** The Product Type flavour. Not all products have flavours
|
|
527
533
|
*/
|
|
528
534
|
flavour?: ProductDetailFlavour;
|
|
529
|
-
/** The Product ID
|
|
530
|
-
*/
|
|
531
|
-
id: string;
|
|
532
535
|
/** The name of the Product
|
|
533
536
|
*/
|
|
534
537
|
name?: string;
|
|
535
|
-
/** The Product Type
|
|
536
|
-
*/
|
|
537
|
-
type: ProductDetailType;
|
|
538
538
|
}
|
|
539
539
|
interface ProductCoinsDetail {
|
|
540
540
|
/** The billing allowance. When you exceed this during the current billing period the *cost multiplier* will increase */
|
|
541
541
|
allowance: number;
|
|
542
|
-
/**
|
|
543
|
-
|
|
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;
|
|
544
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. */
|
|
545
547
|
at_limit: boolean;
|
|
546
|
-
/** The
|
|
547
|
-
|
|
548
|
+
/** The current burn rate, the approximate amount of coins you are currently consuming each day */
|
|
549
|
+
current_burn_rate: number;
|
|
548
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 */
|
|
549
551
|
billing_prediction: number;
|
|
550
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 */
|
|
551
553
|
billing_prediction_storage_contribution: number;
|
|
552
|
-
/** The
|
|
553
|
-
|
|
554
|
-
/**
|
|
555
|
-
|
|
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;
|
|
556
558
|
/** A multiplier that will be applied to coin used beyond your allowance */
|
|
557
559
|
overspend_multiplier: number;
|
|
558
560
|
/** The number of days remaining, in the current billing period */
|
|
559
561
|
remaining_days: number;
|
|
560
|
-
/** The total number of coins consumed (in this billing period), excluding the coins that have been consumed for the current day */
|
|
561
|
-
used: number;
|
|
562
562
|
}
|
|
563
563
|
interface ProductClaimDetail {
|
|
564
564
|
/** The service-specific ID that is using this Subscription
|
|
@@ -568,93 +568,93 @@ interface ProductClaimDetail {
|
|
|
568
568
|
*/
|
|
569
569
|
name?: string;
|
|
570
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
|
+
};
|
|
571
577
|
type ProductDmStorageDetailSize = {
|
|
572
|
-
/** The humanised size of the current storage used for the current day and used to calculate the 'burn rate' */
|
|
573
|
-
current: string;
|
|
574
578
|
/** The humanised size of the peak storage used for the current day. The value is reset at the start of each day */
|
|
575
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;
|
|
576
582
|
/** The humanised storage unit. The cost of storage is based on the daily peak of the number of units (or part thereof) used */
|
|
577
583
|
unit_size: string;
|
|
578
584
|
/** The peak number of storage units used today */
|
|
579
585
|
units_used: number;
|
|
580
586
|
};
|
|
581
|
-
type ProductDmStorageDetailCoins = {
|
|
582
|
-
/** The coin cost of a 'unit' of storage or part thereof. The unit size is defined in the storage section of the response */
|
|
583
|
-
unit_cost: number;
|
|
584
|
-
/** The number of coins currently committed for the current day. This is added to the accumulated coins at the start of each day */
|
|
585
|
-
used: number;
|
|
586
|
-
};
|
|
587
587
|
interface ProductDmStorageDetail {
|
|
588
|
-
coins: ProductDmStorageDetailCoins;
|
|
589
588
|
size: ProductDmStorageDetailSize;
|
|
589
|
+
coins: ProductDmStorageDetailCoins;
|
|
590
590
|
}
|
|
591
591
|
interface ProductDmProjectTier {
|
|
592
|
-
claim?: ProductClaimDetail;
|
|
593
|
-
/** True if the product can be (needs to be) claimed. */
|
|
594
|
-
claimable: boolean;
|
|
595
|
-
coins: ProductCoinsDetail;
|
|
596
|
-
instance: ProductInstanceDetail;
|
|
597
|
-
organisation: OrganisationAllDetail;
|
|
598
592
|
product: ProductDetail;
|
|
599
|
-
|
|
593
|
+
organisation: OrganisationAllDetail;
|
|
600
594
|
unit: UnitAllDetail;
|
|
601
|
-
|
|
602
|
-
|
|
595
|
+
storage: ProductDmStorageDetail;
|
|
596
|
+
coins: ProductCoinsDetail;
|
|
597
|
+
instance: ProductInstanceDetail;
|
|
603
598
|
/** True if the product can be (needs to be) claimed. */
|
|
604
599
|
claimable: boolean;
|
|
605
|
-
|
|
606
|
-
|
|
600
|
+
claim?: ProductClaimDetail;
|
|
601
|
+
}
|
|
602
|
+
interface ProductDmStorage {
|
|
607
603
|
product: ProductDetail;
|
|
608
|
-
|
|
604
|
+
organisation: OrganisationAllDetail;
|
|
609
605
|
unit: UnitAllDetail;
|
|
606
|
+
storage: ProductDmStorageDetail;
|
|
607
|
+
coins: ProductCoinsDetail;
|
|
608
|
+
/** True if the product can be (needs to be) claimed. */
|
|
609
|
+
claimable: boolean;
|
|
610
610
|
}
|
|
611
611
|
interface ChargeAdditionalData {
|
|
612
612
|
[key: string]: unknown;
|
|
613
613
|
}
|
|
614
614
|
interface StorageChargeItem {
|
|
615
|
-
|
|
616
|
-
/** The date
|
|
617
|
-
|
|
615
|
+
item_number: number;
|
|
616
|
+
/** The date and time of the processing charge */
|
|
617
|
+
date: string;
|
|
618
618
|
/** The coin-cost of the storage */
|
|
619
619
|
coins: string;
|
|
620
620
|
/** The current burn rate, the approximate amount of coins you are currently consuming each day */
|
|
621
621
|
current_burn_rate?: string;
|
|
622
|
-
/** The date
|
|
623
|
-
|
|
624
|
-
|
|
622
|
+
/** The date when the charges concluded */
|
|
623
|
+
closed?: string;
|
|
624
|
+
additional_data?: ChargeAdditionalData;
|
|
625
625
|
}
|
|
626
626
|
interface StorageCharges {
|
|
627
|
-
items: StorageChargeItem[];
|
|
628
627
|
num_items: number;
|
|
628
|
+
items: StorageChargeItem[];
|
|
629
629
|
}
|
|
630
630
|
interface ProcessingChargeItem {
|
|
631
|
-
additional_data?: ChargeAdditionalData;
|
|
632
|
-
/** The coin-cost of the storage */
|
|
633
|
-
coins: string;
|
|
634
631
|
/** The charge record number */
|
|
635
632
|
id: number;
|
|
636
|
-
name?: string;
|
|
637
633
|
/** The most recent sequence number for this charge */
|
|
638
634
|
sqn: number;
|
|
635
|
+
name?: string;
|
|
636
|
+
username: string;
|
|
639
637
|
/** The date and time of the processing charge */
|
|
640
638
|
timestamp: string;
|
|
641
|
-
|
|
639
|
+
/** The coin-cost of the storage */
|
|
640
|
+
coins: string;
|
|
641
|
+
additional_data?: ChargeAdditionalData;
|
|
642
642
|
}
|
|
643
643
|
type ProcessingChargesMerchantKind = typeof ProcessingChargesMerchantKind[keyof typeof ProcessingChargesMerchantKind];
|
|
644
644
|
declare const ProcessingChargesMerchantKind: {
|
|
645
645
|
readonly DATA_MANAGER: "DATA_MANAGER";
|
|
646
646
|
};
|
|
647
647
|
interface ProcessingCharges {
|
|
648
|
-
|
|
648
|
+
merchant_name: string;
|
|
649
|
+
merchant_kind: ProcessingChargesMerchantKind;
|
|
650
|
+
merchant_api_hostname: string;
|
|
649
651
|
/** The date when the process stopped */
|
|
650
652
|
closed?: string;
|
|
651
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. */
|
|
652
654
|
final: boolean;
|
|
653
|
-
merchant_api_hostname: string;
|
|
654
|
-
merchant_kind: ProcessingChargesMerchantKind;
|
|
655
|
-
merchant_name: string;
|
|
656
655
|
/** True if charges were received after the charge record was finalised */
|
|
657
656
|
post_final_charges?: boolean;
|
|
657
|
+
charge: ProcessingChargeItem;
|
|
658
658
|
}
|
|
659
659
|
type AssetDetailScope = typeof AssetDetailScope[keyof typeof AssetDetailScope];
|
|
660
660
|
declare const AssetDetailScope: {
|
|
@@ -665,18 +665,18 @@ declare const AssetDetailScope: {
|
|
|
665
665
|
readonly GLOBAL: "GLOBAL";
|
|
666
666
|
};
|
|
667
667
|
interface AssetDetail {
|
|
668
|
-
content: string;
|
|
669
|
-
content_modified?: string;
|
|
670
|
-
created: string;
|
|
671
668
|
creator: string;
|
|
672
|
-
description?: string;
|
|
673
|
-
disabled: boolean;
|
|
674
669
|
id: string;
|
|
675
|
-
merchants: MerchantDetail[];
|
|
676
670
|
name: string;
|
|
677
671
|
scope: AssetDetailScope;
|
|
678
672
|
scope_id: string;
|
|
679
673
|
secret: boolean;
|
|
674
|
+
disabled: boolean;
|
|
675
|
+
content: string;
|
|
676
|
+
created: string;
|
|
677
|
+
content_modified?: string;
|
|
678
|
+
description?: string;
|
|
679
|
+
merchants: MerchantDetail[];
|
|
680
680
|
}
|
|
681
681
|
type UserAccountGetResponse = UserAccountDetail;
|
|
682
682
|
interface UnitsGetResponse {
|
|
@@ -698,42 +698,42 @@ declare const ChargeSummaryType: {
|
|
|
698
698
|
readonly STORAGE: "STORAGE";
|
|
699
699
|
};
|
|
700
700
|
interface ChargeSummary {
|
|
701
|
-
/** The cost, in coins of the charge */
|
|
702
|
-
coins: string;
|
|
703
701
|
/** The type of charge */
|
|
704
702
|
type: ChargeSummaryType;
|
|
703
|
+
/** The cost, in coins of the charge */
|
|
704
|
+
coins: string;
|
|
705
705
|
}
|
|
706
706
|
interface UnitProductChargeSummary {
|
|
707
|
-
charges: ChargeSummary[];
|
|
708
707
|
product_id: string;
|
|
709
708
|
product_type: string;
|
|
709
|
+
charges: ChargeSummary[];
|
|
710
710
|
}
|
|
711
711
|
interface UnitChargeSummary {
|
|
712
712
|
charges: ChargeSummary[];
|
|
713
713
|
}
|
|
714
714
|
interface UnitChargesGetResponse {
|
|
715
|
-
/**
|
|
716
|
-
* @minimum 1
|
|
717
|
-
* @maximum 28
|
|
718
|
-
*/
|
|
719
|
-
billing_day: number;
|
|
720
715
|
/** Whether the user making the API call is a member of the Unit */
|
|
721
716
|
caller_is_member: boolean;
|
|
722
|
-
|
|
723
|
-
count: number;
|
|
724
|
-
created: string;
|
|
725
|
-
/** The start of the charge period */
|
|
726
|
-
from: string;
|
|
717
|
+
unit_id: string;
|
|
727
718
|
name?: string;
|
|
728
719
|
/** The Unit's owner (a username) */
|
|
729
720
|
owner_id: string;
|
|
730
721
|
/** True if the Unit is private */
|
|
731
722
|
private: boolean;
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
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;
|
|
735
733
|
/** The date where of first day after the charge period */
|
|
736
734
|
until: string;
|
|
735
|
+
summary: UnitChargeSummary;
|
|
736
|
+
products: UnitProductChargeSummary[];
|
|
737
737
|
}
|
|
738
738
|
/**
|
|
739
739
|
* The Unit's Product
|
|
@@ -751,8 +751,8 @@ interface ProductsGetTypesResponse {
|
|
|
751
751
|
}
|
|
752
752
|
type ProductsGetDefaultStorageCostDefaultStorageCost = {
|
|
753
753
|
cost: string;
|
|
754
|
-
description: string;
|
|
755
754
|
units: string;
|
|
755
|
+
description: string;
|
|
756
756
|
};
|
|
757
757
|
interface ProductsGetDefaultStorageCost {
|
|
758
758
|
default_storage_cost: ProductsGetDefaultStorageCostDefaultStorageCost;
|
|
@@ -769,25 +769,25 @@ declare const ProductChargesGetResponseProductType: {
|
|
|
769
769
|
readonly DATA_MANAGER_STORAGE_SUBSCRIPTION: "DATA_MANAGER_STORAGE_SUBSCRIPTION";
|
|
770
770
|
};
|
|
771
771
|
interface ProductChargesGetResponse {
|
|
772
|
+
product_id: string;
|
|
773
|
+
product_type: ProductChargesGetResponseProductType;
|
|
772
774
|
/**
|
|
773
775
|
* @minimum 1
|
|
774
776
|
* @maximum 28
|
|
775
777
|
*/
|
|
776
778
|
billing_day: number;
|
|
777
|
-
claim?: ProductClaimDetail;
|
|
778
779
|
/** True if the product can be (needs to be) claimed. */
|
|
779
780
|
claimable: boolean;
|
|
780
|
-
|
|
781
|
-
coins: string;
|
|
781
|
+
claim?: ProductClaimDetail;
|
|
782
782
|
count: number;
|
|
783
783
|
/** The start of the charge period */
|
|
784
784
|
from: string;
|
|
785
|
-
processing_charges: ProcessingCharges[];
|
|
786
|
-
product_id: string;
|
|
787
|
-
product_type: ProductChargesGetResponseProductType;
|
|
788
|
-
storage_charges: StorageCharges;
|
|
789
785
|
/** The date where of first day after the charge period */
|
|
790
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;
|
|
791
791
|
}
|
|
792
792
|
type OrganisationGetResponse = OrganisationAllDetail;
|
|
793
793
|
interface OrganisationsGetResponse {
|
|
@@ -796,6 +796,8 @@ interface OrganisationsGetResponse {
|
|
|
796
796
|
organisations: OrganisationAllDetail[];
|
|
797
797
|
}
|
|
798
798
|
interface OrganisationUnitChargeSummary {
|
|
799
|
+
unit_id: string;
|
|
800
|
+
name: string;
|
|
799
801
|
/**
|
|
800
802
|
* @minimum 1
|
|
801
803
|
* @maximum 28
|
|
@@ -803,16 +805,14 @@ interface OrganisationUnitChargeSummary {
|
|
|
803
805
|
billing_day: number;
|
|
804
806
|
/** The start of the charge period */
|
|
805
807
|
from: string;
|
|
806
|
-
name: string;
|
|
807
|
-
summary: ChargeSummary[];
|
|
808
|
-
unit_id: string;
|
|
809
808
|
/** The date where of first day after the charge period */
|
|
810
809
|
until: string;
|
|
810
|
+
summary: ChargeSummary[];
|
|
811
811
|
}
|
|
812
812
|
interface OrganisationChargesGetResponse {
|
|
813
|
-
coins: string;
|
|
814
|
-
name: string;
|
|
815
813
|
organisation_id: string;
|
|
814
|
+
name: string;
|
|
815
|
+
coins: string;
|
|
816
816
|
summary: ChargeSummary[];
|
|
817
817
|
unit_charges: OrganisationUnitChargeSummary[];
|
|
818
818
|
}
|
|
@@ -824,15 +824,15 @@ interface OrganisationUnitsGetResponse {
|
|
|
824
824
|
units: UnitAllDetail[];
|
|
825
825
|
}
|
|
826
826
|
interface OrganisationChargeSummary {
|
|
827
|
-
name: string;
|
|
828
827
|
organisation_id: string;
|
|
828
|
+
name: string;
|
|
829
829
|
summary: ChargeSummary[];
|
|
830
830
|
}
|
|
831
831
|
interface PersonalUnitPutResponse {
|
|
832
|
-
/** The unit's unique ID */
|
|
833
|
-
id: string;
|
|
834
832
|
/** The unit's Organisation. Used to identify the Default organisation */
|
|
835
833
|
organisation_id: string;
|
|
834
|
+
/** The unit's unique ID */
|
|
835
|
+
id: string;
|
|
836
836
|
}
|
|
837
837
|
interface OrganisationUnitPostResponse {
|
|
838
838
|
/** The unit's unique ID */
|
|
@@ -851,9 +851,6 @@ declare const OrganisationGetDefaultResponseDefaultProductPrivacy: {
|
|
|
851
851
|
interface OrganisationGetDefaultResponse {
|
|
852
852
|
/** Whether the user making the API call is a member of the Default Organisation. Only admin users are members of the Default organisation */
|
|
853
853
|
caller_is_member?: boolean;
|
|
854
|
-
created?: string;
|
|
855
|
-
/** The Organisation's default product privacy setting */
|
|
856
|
-
default_product_privacy?: OrganisationGetDefaultResponseDefaultProductPrivacy;
|
|
857
854
|
/** The Default Organisation ID
|
|
858
855
|
*/
|
|
859
856
|
id?: string;
|
|
@@ -863,6 +860,9 @@ interface OrganisationGetDefaultResponse {
|
|
|
863
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
|
|
864
861
|
*/
|
|
865
862
|
private?: boolean;
|
|
863
|
+
created?: string;
|
|
864
|
+
/** The Organisation's default product privacy setting */
|
|
865
|
+
default_product_privacy?: OrganisationGetDefaultResponseDefaultProductPrivacy;
|
|
866
866
|
}
|
|
867
867
|
interface UsersGetResponse {
|
|
868
868
|
count: number;
|
|
@@ -890,8 +890,8 @@ interface EventStreamGetPostResponse {
|
|
|
890
890
|
interface ChargesGetResponse {
|
|
891
891
|
coins: string;
|
|
892
892
|
count: number;
|
|
893
|
-
organisation_charges: OrganisationChargeSummary[];
|
|
894
893
|
summary: ChargeSummary[];
|
|
894
|
+
organisation_charges: OrganisationChargeSummary[];
|
|
895
895
|
}
|
|
896
896
|
interface AssetPostResponse {
|
|
897
897
|
/** The Asset ID
|