@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.
Files changed (69) hide show
  1. package/asset/asset.cjs +18 -10
  2. package/asset/asset.cjs.map +1 -1
  3. package/asset/asset.d.cts +60 -60
  4. package/asset/asset.d.ts +60 -60
  5. package/asset/asset.js +18 -10
  6. package/asset/asset.js.map +1 -1
  7. package/charges/charges.cjs +3 -3
  8. package/charges/charges.cjs.map +1 -1
  9. package/charges/charges.d.cts +33 -33
  10. package/charges/charges.d.ts +33 -33
  11. package/charges/charges.js +3 -3
  12. package/charges/charges.js.map +1 -1
  13. package/event-stream/event-stream.cjs +8 -5
  14. package/event-stream/event-stream.cjs.map +1 -1
  15. package/event-stream/event-stream.d.cts +30 -30
  16. package/event-stream/event-stream.d.ts +30 -30
  17. package/event-stream/event-stream.js +8 -5
  18. package/event-stream/event-stream.js.map +1 -1
  19. package/index.cjs +8 -8
  20. package/index.cjs.map +1 -1
  21. package/index.d.cts +212 -196
  22. package/index.d.ts +212 -196
  23. package/index.js +8 -8
  24. package/index.js.map +1 -1
  25. package/merchant/merchant.cjs +1 -1
  26. package/merchant/merchant.cjs.map +1 -1
  27. package/merchant/merchant.d.cts +17 -17
  28. package/merchant/merchant.d.ts +17 -17
  29. package/merchant/merchant.js +1 -1
  30. package/merchant/merchant.js.map +1 -1
  31. package/organisation/organisation.cjs +24 -19
  32. package/organisation/organisation.cjs.map +1 -1
  33. package/organisation/organisation.d.cts +56 -56
  34. package/organisation/organisation.d.ts +56 -56
  35. package/organisation/organisation.js +24 -19
  36. package/organisation/organisation.js.map +1 -1
  37. package/package.json +11 -11
  38. package/product/product.cjs +12 -8
  39. package/product/product.cjs.map +1 -1
  40. package/product/product.d.cts +68 -68
  41. package/product/product.d.ts +68 -68
  42. package/product/product.js +12 -8
  43. package/product/product.js.map +1 -1
  44. package/src/account-server-api.schemas.ts +219 -200
  45. package/src/asset/asset.ts +121 -84
  46. package/src/charges/charges.ts +51 -50
  47. package/src/event-stream/event-stream.ts +56 -44
  48. package/src/merchant/merchant.ts +27 -26
  49. package/src/organisation/organisation.ts +104 -85
  50. package/src/product/product.ts +117 -100
  51. package/src/state/state.ts +15 -14
  52. package/src/unit/unit.ts +130 -101
  53. package/src/user/user.ts +91 -70
  54. package/state/state.cjs.map +1 -1
  55. package/state/state.d.cts +9 -9
  56. package/state/state.d.ts +9 -9
  57. package/state/state.js.map +1 -1
  58. package/unit/unit.cjs +29 -22
  59. package/unit/unit.cjs.map +1 -1
  60. package/unit/unit.d.cts +68 -68
  61. package/unit/unit.d.ts +68 -68
  62. package/unit/unit.js +29 -22
  63. package/unit/unit.js.map +1 -1
  64. package/user/user.cjs +10 -6
  65. package/user/user.cjs.map +1 -1
  66. package/user/user.d.cts +49 -49
  67. package/user/user.d.ts +49 -49
  68. package/user/user.js +10 -6
  69. package/user/user.js.map +1 -1
@@ -1,13 +1,13 @@
1
1
  // @ts-nocheck
2
2
  /**
3
- * Generated by orval v7.2.0 🍺
3
+ * Generated by orval v7.4.1 🍺
4
4
  * Do not edit manually.
5
5
  * Account Server API
6
6
  * The Informatics Matters Account Server API.
7
7
 
8
8
  A service that provides access to the Account Server, which gives *registered* users access to and management of **Organisations**, **Units**, **Products**, **Users**, and **Assets**.
9
9
 
10
- * OpenAPI spec version: 4.0
10
+ * OpenAPI spec version: 4.1
11
11
  */
12
12
  export type DetachAssetParams = {
13
13
  /**
@@ -23,30 +23,29 @@ export type AttachAssetParams = {
23
23
  m_id?: QMIdParameter;
24
24
  };
25
25
 
26
+ export type GetUnitsParams = {
26
27
  /**
27
- * 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
+ * An object name
28
29
  */
29
- export type QUntilParameter = string;
30
+ name?: QNameParameter;
31
+ };
30
32
 
33
+ export type GetOrganisationsParams = {
31
34
  /**
32
- * 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
35
+ * An object name
33
36
  */
34
- export type QFromParameter = string;
37
+ name?: QNameParameter;
38
+ };
35
39
 
36
- export type GetUnitChargesParams = {
37
- /**
38
- * 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
39
- */
40
- from?: QFromParameter;
41
40
  /**
42
41
  * 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
43
42
  */
44
- until?: QUntilParameter;
43
+ export type QUntilParameter = string;
44
+
45
45
  /**
46
- * A charge Prior Billing Period, 0 implies "current" and -23 is for the period 23 months ago.
46
+ * 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
47
47
  */
48
- pbp?: QPbpParameter;
49
- };
48
+ export type QFromParameter = string;
50
49
 
51
50
  export type GetProductChargesParams = {
52
51
  /**
@@ -108,6 +107,21 @@ export type QProductIdParameter = string;
108
107
  */
109
108
  export type QUnitIdParameter = string;
110
109
 
110
+ /**
111
+ * An object name
112
+ */
113
+ export type QNameParameter = string;
114
+
115
+ /**
116
+ * A Merchant Identity
117
+ */
118
+ export type QMIdParameter = number;
119
+
120
+ /**
121
+ * An Organisation Identity
122
+ */
123
+ export type QOrgIdParameter = string;
124
+
111
125
  export type GetAssetParams = {
112
126
  /**
113
127
  * A User Identity
@@ -128,21 +142,31 @@ org_id?: QOrgIdParameter;
128
142
  };
129
143
 
130
144
  /**
131
- * A Merchant Identity
145
+ * A charge Prior Billing Period, 0 implies "current" and -23 is for the period 23 months ago.
132
146
  */
133
- export type QMIdParameter = number;
147
+ export type QPbpParameter = number;
134
148
 
149
+ export type GetUnitChargesParams = {
135
150
  /**
136
- * An Organisation Identity
151
+ * 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
152
  */
138
- export type QOrgIdParameter = string;
139
-
153
+ from?: QFromParameter;
154
+ /**
155
+ * 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
156
+ */
157
+ until?: QUntilParameter;
140
158
  /**
141
159
  * A charge Prior Billing Period, 0 implies "current" and -23 is for the period 23 months ago.
142
160
  */
143
- export type QPbpParameter = number;
161
+ pbp?: QPbpParameter;
162
+ };
144
163
 
145
164
  export type ProductPatchBodyBody = {
165
+ /**
166
+ * The name you want to give the Product
167
+ * @maxLength 80
168
+ */
169
+ name?: string;
146
170
  /**
147
171
  * The Product's built-in coin allowance. Product allowances cannot be reduced
148
172
  * @minimum 1
@@ -153,27 +177,8 @@ export type ProductPatchBodyBody = {
153
177
  * @minimum 1
154
178
  */
155
179
  limit?: number;
156
- /**
157
- * The name you want to give the Product
158
- * @maxLength 80
159
- */
160
- name?: string;
161
180
  };
162
181
 
163
- /**
164
- * The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be provided.
165
-
166
- Project Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products
167
- */
168
- export type UnitProductPostBodyBodyType = typeof UnitProductPostBodyBodyType[keyof typeof UnitProductPostBodyBodyType];
169
-
170
-
171
- // eslint-disable-next-line @typescript-eslint/no-redeclare
172
- export const UnitProductPostBodyBodyType = {
173
- DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: 'DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION',
174
- DATA_MANAGER_STORAGE_SUBSCRIPTION: 'DATA_MANAGER_STORAGE_SUBSCRIPTION',
175
- } as const;
176
-
177
182
  /**
178
183
  * The Flavour of the Product. Used only for Project Tier Products. Do not set this for Storage products
179
184
  */
@@ -188,28 +193,42 @@ export const UnitProductPostBodyBodyFlavour = {
188
193
  GOLD: 'GOLD',
189
194
  } as const;
190
195
 
196
+ /**
197
+ * The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be provided.
198
+
199
+ Project Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products
200
+ */
201
+ export type UnitProductPostBodyBodyType = typeof UnitProductPostBodyBodyType[keyof typeof UnitProductPostBodyBodyType];
202
+
203
+
204
+ // eslint-disable-next-line @typescript-eslint/no-redeclare
205
+ export const UnitProductPostBodyBodyType = {
206
+ DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: 'DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION',
207
+ DATA_MANAGER_STORAGE_SUBSCRIPTION: 'DATA_MANAGER_STORAGE_SUBSCRIPTION',
208
+ } as const;
209
+
191
210
  export type UnitProductPostBodyBody = {
211
+ /**
212
+ * The name you want to give the Product
213
+ * @maxLength 80
214
+ */
215
+ name: string;
216
+ /** The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be provided.
217
+
218
+ Project Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products */
219
+ type: UnitProductPostBodyBodyType;
220
+ /** The Flavour of the Product. Used only for Project Tier Products. Do not set this for Storage products */
221
+ flavour?: UnitProductPostBodyBodyFlavour;
192
222
  /**
193
223
  * The Product's coin allowance. You must provide this for Storage products but you must not provide a value for Project Tier Products
194
224
  * @minimum 1
195
225
  */
196
226
  allowance?: number;
197
- /** The Flavour of the Product. Used only for Project Tier Products. Do not set this for Storage products */
198
- flavour?: UnitProductPostBodyBodyFlavour;
199
227
  /**
200
228
  * 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
201
229
  * @minimum 1
202
230
  */
203
231
  limit?: number;
204
- /**
205
- * The name you want to give the Product
206
- * @maxLength 80
207
- */
208
- name: string;
209
- /** The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be provided.
210
-
211
- Project Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products */
212
- type: UnitProductPostBodyBodyType;
213
232
  };
214
233
 
215
234
  /**
@@ -229,12 +248,12 @@ export const UnitPatchBodyBodyDefaultProductPrivacy = {
229
248
  } as const;
230
249
 
231
250
  export type UnitPatchBodyBody = {
251
+ /** The new name for the Unit */
252
+ name?: string;
232
253
  /** 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`.
233
254
 
234
255
  Whether the privacy can be honoured will depend on the organisation's value */
235
256
  default_product_privacy?: UnitPatchBodyBodyDefaultProductPrivacy;
236
- /** The new name for the Unit */
237
- name?: string;
238
257
  };
239
258
 
240
259
  /**
@@ -254,12 +273,12 @@ export const OrganisationPatchBodyBodyDefaultProductPrivacy = {
254
273
  } as const;
255
274
 
256
275
  export type OrganisationPatchBodyBody = {
276
+ /** The new name for the Organisational */
277
+ name?: string;
257
278
  /** 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`.
258
279
 
259
280
  Whether the privacy can be honoured will depend on the value in any of the organisation's existing units */
260
281
  default_product_privacy?: OrganisationPatchBodyBodyDefaultProductPrivacy;
261
- /** The new name for the Organisational */
262
- name?: string;
263
282
  };
264
283
 
265
284
  /**
@@ -277,6 +296,11 @@ export const OrganisationUnitPostBodyBodyDefaultProductPrivacy = {
277
296
  } as const;
278
297
 
279
298
  export type OrganisationUnitPostBodyBody = {
299
+ /**
300
+ * The name of the unit
301
+ * @maxLength 80
302
+ */
303
+ name: string;
280
304
  /**
281
305
  * The day you would like to be billed for the Unit's Products (a value from 1 and 28)
282
306
  * @minimum 1
@@ -285,11 +309,6 @@ export type OrganisationUnitPostBodyBody = {
285
309
  billing_day: number;
286
310
  /** The default product privacy setting for products in the unit. Whether the privacy can be honoured will depend on the organisation's value */
287
311
  default_product_privacy?: OrganisationUnitPostBodyBodyDefaultProductPrivacy;
288
- /**
289
- * The name of the unit
290
- * @maxLength 80
291
- */
292
- name: string;
293
312
  };
294
313
 
295
314
  export type PersonalUnitPutBodyBody = {
@@ -316,8 +335,6 @@ export const OrganisationPostBodyBodyDefaultProductPrivacy = {
316
335
  } as const;
317
336
 
318
337
  export type OrganisationPostBodyBody = {
319
- /** The default product privacy setting for the Organisation */
320
- default_product_privacy?: OrganisationPostBodyBodyDefaultProductPrivacy;
321
338
  /**
322
339
  * The name of the organisation
323
340
  * @maxLength 80
@@ -325,6 +342,8 @@ export type OrganisationPostBodyBody = {
325
342
  name: string;
326
343
  /** The name of the organisation owner. A user ID */
327
344
  owner: string;
345
+ /** The default product privacy setting for the Organisation */
346
+ default_product_privacy?: OrganisationPostBodyBodyDefaultProductPrivacy;
328
347
  };
329
348
 
330
349
  export type AssetPostBodyBodyScope = typeof AssetPostBodyBodyScope[keyof typeof AssetPostBodyBodyScope];
@@ -340,23 +359,23 @@ export const AssetPostBodyBodyScope = {
340
359
  } as const;
341
360
 
342
361
  export type AssetPostBodyBody = {
343
- /** A file containing the content for the asset. You must provide a value here or in content_string */
344
- content_file?: Blob;
345
- /** The textual content of the asset. You must provide a value here or in content_file */
346
- content_string?: string;
347
- /** An optional description for the Asset */
348
- description?: string;
349
362
  /**
350
363
  * 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
351
364
  * @maxLength 80
352
365
  * @pattern ^[a-z0-9-]{1,63}$
353
366
  */
354
367
  name: string;
368
+ /** A file containing the content for the asset. You must provide a value here or in content_string */
369
+ content_file?: Blob;
370
+ /** The textual content of the asset. You must provide a value here or in content_file */
371
+ content_string?: string;
355
372
  scope: AssetPostBodyBodyScope;
356
373
  /** 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. */
357
374
  scope_id?: string;
358
375
  /** Is this a secret asset? */
359
376
  secret: boolean;
377
+ /** An optional description for the Asset */
378
+ description?: string;
360
379
  };
361
380
 
362
381
  export type AssetPatchBodyBody = {
@@ -374,11 +393,11 @@ export interface UserDetail {
374
393
  }
375
394
 
376
395
  export interface UserAccountDetail {
377
- /** The roles assigned to the user recognised by the Account Server */
378
- account_server_roles: string[];
396
+ user: UserDetail;
379
397
  /** Whether the caller has admin privilege */
380
398
  caller_has_admin_privilege: boolean;
381
- user: UserDetail;
399
+ /** The roles assigned to the user recognised by the Account Server */
400
+ account_server_roles: string[];
382
401
  }
383
402
 
384
403
  /**
@@ -396,13 +415,8 @@ export const UnitDetailDefaultProductPrivacy = {
396
415
  } as const;
397
416
 
398
417
  export interface UnitDetail {
399
- /** The Unit's billing day */
400
- billing_day: number;
401
418
  /** Whether the user making the API call is a member of the Unit */
402
419
  caller_is_member: boolean;
403
- created: string;
404
- /** The Unit's default product privacy setting */
405
- default_product_privacy: UnitDetailDefaultProductPrivacy;
406
420
  /** The Unit's unique identity */
407
421
  id: string;
408
422
  /** The Unit's name */
@@ -411,6 +425,11 @@ export interface UnitDetail {
411
425
  owner_id: string;
412
426
  /** True if the Unit is private */
413
427
  private: boolean;
428
+ created: string;
429
+ /** The Unit's billing day */
430
+ billing_day: number;
431
+ /** The Unit's default product privacy setting */
432
+ default_product_privacy: UnitDetailDefaultProductPrivacy;
414
433
  }
415
434
 
416
435
  /**
@@ -428,13 +447,8 @@ export const UnitAllDetailDefaultProductPrivacy = {
428
447
  } as const;
429
448
 
430
449
  export interface UnitAllDetail {
431
- /** The Unit's billing day */
432
- billing_day: number;
433
450
  /** Whether the user making the API call is a member of the Unit */
434
451
  caller_is_member: boolean;
435
- created: string;
436
- /** The Unit's default product privacy setting */
437
- default_product_privacy: UnitAllDetailDefaultProductPrivacy;
438
452
  /** The Unit's unique identity */
439
453
  id: string;
440
454
  /** The Unit's name */
@@ -443,6 +457,11 @@ export interface UnitAllDetail {
443
457
  owner_id: string;
444
458
  /** True if the Unit is private */
445
459
  private: boolean;
460
+ created: string;
461
+ /** The Unit's billing day */
462
+ billing_day: number;
463
+ /** The Unit's default product privacy setting */
464
+ default_product_privacy: UnitAllDetailDefaultProductPrivacy;
446
465
  /** A list of users that are members of the Unit */
447
466
  users: UserDetail[];
448
467
  }
@@ -459,15 +478,15 @@ export const MerchantDetailKind = {
459
478
  } as const;
460
479
 
461
480
  export interface MerchantDetail {
462
- /** The hostname used by the Service */
463
- api_hostname: string;
464
- created: string;
465
481
  /** The unique ID of the Service */
466
482
  id: number;
483
+ created: string;
467
484
  /** The kind of Service */
468
485
  kind: MerchantDetailKind;
469
486
  /** The name assigned to the Service */
470
487
  name: string;
488
+ /** The hostname used by the Service */
489
+ api_hostname: string;
471
490
  }
472
491
 
473
492
  export type MerchantGetResponse = MerchantDetail;
@@ -496,9 +515,6 @@ export const OrganisationDetailDefaultProductPrivacy = {
496
515
  export interface OrganisationDetail {
497
516
  /** Whether the user making the API call is a member of the Unit */
498
517
  caller_is_member: boolean;
499
- created: string;
500
- /** The Organisation's default product privacy setting */
501
- default_product_privacy: OrganisationDetailDefaultProductPrivacy;
502
518
  /** The Organisation's unique ID */
503
519
  id: string;
504
520
  /** The Organisation's name */
@@ -507,6 +523,9 @@ export interface OrganisationDetail {
507
523
  owner_id?: string;
508
524
  /** True if the Unit is private */
509
525
  private: boolean;
526
+ created: string;
527
+ /** The Organisation's default product privacy setting */
528
+ default_product_privacy: OrganisationDetailDefaultProductPrivacy;
510
529
  }
511
530
 
512
531
  /**
@@ -526,9 +545,6 @@ export const OrganisationAllDetailDefaultProductPrivacy = {
526
545
  export interface OrganisationAllDetail {
527
546
  /** Whether the user making the API call is a member of the Unit */
528
547
  caller_is_member: boolean;
529
- created: string;
530
- /** The Organisation's default product privacy setting */
531
- default_product_privacy: OrganisationAllDetailDefaultProductPrivacy;
532
548
  /** The Organisation's unique ID */
533
549
  id: string;
534
550
  /** The Organisation's name */
@@ -537,6 +553,9 @@ export interface OrganisationAllDetail {
537
553
  owner_id?: string;
538
554
  /** True if the Unit is private */
539
555
  private: boolean;
556
+ created: string;
557
+ /** The Organisation's default product privacy setting */
558
+ default_product_privacy: OrganisationAllDetailDefaultProductPrivacy;
540
559
  /** A list of users that are members of the Organisation */
541
560
  users: UserDetail[];
542
561
  }
@@ -553,12 +572,12 @@ export const ProductTypeServiceKind = {
553
572
  } as const;
554
573
 
555
574
  export interface ProductType {
575
+ /** A product type, this is a unique string amongst all types known to the Account Server */
576
+ type: string;
556
577
  /** A product flavour. Not all types have a flavour, those that do have a type-specific flavour string */
557
578
  flavour?: string;
558
579
  /** The kind of service that can use the Product */
559
580
  service_kind?: ProductTypeServiceKind;
560
- /** A product type, this is a unique string amongst all types known to the Account Server */
561
- type: string;
562
581
  }
563
582
 
564
583
  export type ProductInstanceDetailCoins = {
@@ -572,72 +591,72 @@ export interface ProductInstanceDetail {
572
591
  }
573
592
 
574
593
  /**
575
- * The Product Type
594
+ * The Product Type flavour. Not all products have flavours
576
595
 
577
596
  */
578
- export type ProductDetailType = typeof ProductDetailType[keyof typeof ProductDetailType];
597
+ export type ProductDetailFlavour = typeof ProductDetailFlavour[keyof typeof ProductDetailFlavour];
579
598
 
580
599
 
581
600
  // eslint-disable-next-line @typescript-eslint/no-redeclare
582
- export const ProductDetailType = {
583
- DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: 'DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION',
584
- DATA_MANAGER_STORAGE_SUBSCRIPTION: 'DATA_MANAGER_STORAGE_SUBSCRIPTION',
601
+ export const ProductDetailFlavour = {
602
+ EVALUATION: 'EVALUATION',
603
+ BRONZE: 'BRONZE',
604
+ SILVER: 'SILVER',
605
+ GOLD: 'GOLD',
585
606
  } as const;
586
607
 
587
608
  /**
588
- * The Product Type flavour. Not all products have flavours
609
+ * The Product Type
589
610
 
590
611
  */
591
- export type ProductDetailFlavour = typeof ProductDetailFlavour[keyof typeof ProductDetailFlavour];
612
+ export type ProductDetailType = typeof ProductDetailType[keyof typeof ProductDetailType];
592
613
 
593
614
 
594
615
  // eslint-disable-next-line @typescript-eslint/no-redeclare
595
- export const ProductDetailFlavour = {
596
- EVALUATION: 'EVALUATION',
597
- BRONZE: 'BRONZE',
598
- SILVER: 'SILVER',
599
- GOLD: 'GOLD',
616
+ export const ProductDetailType = {
617
+ DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: 'DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION',
618
+ DATA_MANAGER_STORAGE_SUBSCRIPTION: 'DATA_MANAGER_STORAGE_SUBSCRIPTION',
600
619
  } as const;
601
620
 
602
621
  export interface ProductDetail {
622
+ /** The Product ID
623
+ */
624
+ id: string;
603
625
  created: string;
626
+ /** The Product Type
627
+ */
628
+ type: ProductDetailType;
604
629
  /** The Product Type flavour. Not all products have flavours
605
630
  */
606
631
  flavour?: ProductDetailFlavour;
607
- /** The Product ID
608
- */
609
- id: string;
610
632
  /** The name of the Product
611
633
  */
612
634
  name?: string;
613
- /** The Product Type
614
- */
615
- type: ProductDetailType;
616
635
  }
617
636
 
618
637
  export interface ProductCoinsDetail {
619
638
  /** The billing allowance. When you exceed this during the current billing period the *cost multiplier* will increase */
620
639
  allowance: number;
621
- /** A multiplier applied to your coin usage within your allowance */
622
- allowance_multiplier: number;
640
+ /** 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 */
641
+ limit: number;
642
+ /** The total number of coins consumed (in this billing period), excluding the coins that have been consumed for the current day */
643
+ used: number;
623
644
  /** 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. */
624
645
  at_limit: boolean;
625
- /** The day of the month when the bill is due, and the end of the current billing period */
626
- billing_day: number;
646
+ /** The current burn rate, the approximate amount of coins you are currently consuming each day */
647
+ current_burn_rate: number;
627
648
  /** 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 */
628
649
  billing_prediction: number;
629
650
  /** 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 */
630
651
  billing_prediction_storage_contribution: number;
631
- /** The current burn rate, the approximate amount of coins you are currently consuming each day */
632
- current_burn_rate: number;
633
- /** 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 */
634
- limit: number;
652
+ /** The day of the month when the bill is due, and the end of the current billing period */
653
+ billing_day: number;
654
+ /** A multiplier applied to your coin usage within your allowance */
655
+ allowance_multiplier: number;
635
656
  /** A multiplier that will be applied to coin used beyond your allowance */
636
657
  overspend_multiplier: number;
637
658
  /** The number of days remaining, in the current billing period */
638
659
  remaining_days: number;
639
- /** The total number of coins consumed (in this billing period), excluding the coins that have been consumed for the current day */
640
- used: number;
641
660
  }
642
661
 
643
662
  export interface ProductClaimDetail {
@@ -649,83 +668,83 @@ export interface ProductClaimDetail {
649
668
  name?: string;
650
669
  }
651
670
 
671
+ export type ProductDmStorageDetailCoins = {
672
+ /** The number of coins currently committed for the current day. This is added to the accumulated coins at the start of each day */
673
+ used: number;
674
+ /** The coin cost of a 'unit' of storage or part thereof. The unit size is defined in the storage section of the response */
675
+ unit_cost: number;
676
+ };
677
+
652
678
  export type ProductDmStorageDetailSize = {
653
- /** The humanised size of the current storage used for the current day and used to calculate the 'burn rate' */
654
- current: string;
655
679
  /** The humanised size of the peak storage used for the current day. The value is reset at the start of each day */
656
680
  peak: string;
681
+ /** The humanised size of the current storage used for the current day and used to calculate the 'burn rate' */
682
+ current: string;
657
683
  /** The humanised storage unit. The cost of storage is based on the daily peak of the number of units (or part thereof) used */
658
684
  unit_size: string;
659
685
  /** The peak number of storage units used today */
660
686
  units_used: number;
661
687
  };
662
688
 
663
- export type ProductDmStorageDetailCoins = {
664
- /** The coin cost of a 'unit' of storage or part thereof. The unit size is defined in the storage section of the response */
665
- unit_cost: number;
666
- /** The number of coins currently committed for the current day. This is added to the accumulated coins at the start of each day */
667
- used: number;
668
- };
669
-
670
689
  export interface ProductDmStorageDetail {
671
- coins: ProductDmStorageDetailCoins;
672
690
  size: ProductDmStorageDetailSize;
691
+ coins: ProductDmStorageDetailCoins;
673
692
  }
674
693
 
675
694
  export interface ProductDmProjectTier {
676
- claim?: ProductClaimDetail;
677
- /** True if the product can be (needs to be) claimed. */
678
- claimable: boolean;
679
- coins: ProductCoinsDetail;
680
- instance: ProductInstanceDetail;
681
- organisation: OrganisationAllDetail;
682
695
  product: ProductDetail;
683
- storage: ProductDmStorageDetail;
696
+ organisation: OrganisationAllDetail;
684
697
  unit: UnitAllDetail;
698
+ storage: ProductDmStorageDetail;
699
+ coins: ProductCoinsDetail;
700
+ instance: ProductInstanceDetail;
701
+ /** True if the product can be (needs to be) claimed. */
702
+ claimable: boolean;
703
+ claim?: ProductClaimDetail;
685
704
  }
686
705
 
687
706
  export interface ProductDmStorage {
688
- /** True if the product can be (needs to be) claimed. */
689
- claimable: boolean;
690
- coins: ProductCoinsDetail;
691
- organisation: OrganisationAllDetail;
692
707
  product: ProductDetail;
693
- storage: ProductDmStorageDetail;
708
+ organisation: OrganisationAllDetail;
694
709
  unit: UnitAllDetail;
710
+ storage: ProductDmStorageDetail;
711
+ coins: ProductCoinsDetail;
712
+ /** True if the product can be (needs to be) claimed. */
713
+ claimable: boolean;
695
714
  }
696
715
 
697
716
  export interface ChargeAdditionalData { [key: string]: unknown }
698
717
 
699
718
  export interface StorageChargeItem {
700
- additional_data?: ChargeAdditionalData;
701
- /** The date when the charges concluded */
702
- closed?: string;
719
+ item_number: number;
720
+ /** The date and time of the processing charge */
721
+ date: string;
703
722
  /** The coin-cost of the storage */
704
723
  coins: string;
705
724
  /** The current burn rate, the approximate amount of coins you are currently consuming each day */
706
725
  current_burn_rate?: string;
707
- /** The date and time of the processing charge */
708
- date: string;
709
- item_number: number;
726
+ /** The date when the charges concluded */
727
+ closed?: string;
728
+ additional_data?: ChargeAdditionalData;
710
729
  }
711
730
 
712
731
  export interface StorageCharges {
713
- items: StorageChargeItem[];
714
732
  num_items: number;
733
+ items: StorageChargeItem[];
715
734
  }
716
735
 
717
736
  export interface ProcessingChargeItem {
718
- additional_data?: ChargeAdditionalData;
719
- /** The coin-cost of the storage */
720
- coins: string;
721
737
  /** The charge record number */
722
738
  id: number;
723
- name?: string;
724
739
  /** The most recent sequence number for this charge */
725
740
  sqn: number;
741
+ name?: string;
742
+ username: string;
726
743
  /** The date and time of the processing charge */
727
744
  timestamp: string;
728
- username: string;
745
+ /** The coin-cost of the storage */
746
+ coins: string;
747
+ additional_data?: ChargeAdditionalData;
729
748
  }
730
749
 
731
750
  export type ProcessingChargesMerchantKind = typeof ProcessingChargesMerchantKind[keyof typeof ProcessingChargesMerchantKind];
@@ -737,16 +756,16 @@ export const ProcessingChargesMerchantKind = {
737
756
  } as const;
738
757
 
739
758
  export interface ProcessingCharges {
740
- charge: ProcessingChargeItem;
759
+ merchant_name: string;
760
+ merchant_kind: ProcessingChargesMerchantKind;
761
+ merchant_api_hostname: string;
741
762
  /** The date when the process stopped */
742
763
  closed?: string;
743
764
  /** 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. */
744
765
  final: boolean;
745
- merchant_api_hostname: string;
746
- merchant_kind: ProcessingChargesMerchantKind;
747
- merchant_name: string;
748
766
  /** True if charges were received after the charge record was finalised */
749
767
  post_final_charges?: boolean;
768
+ charge: ProcessingChargeItem;
750
769
  }
751
770
 
752
771
  export type AssetDetailScope = typeof AssetDetailScope[keyof typeof AssetDetailScope];
@@ -762,18 +781,18 @@ export const AssetDetailScope = {
762
781
  } as const;
763
782
 
764
783
  export interface AssetDetail {
765
- content: string;
766
- content_modified?: string;
767
- created: string;
768
784
  creator: string;
769
- description?: string;
770
- disabled: boolean;
771
785
  id: string;
772
- merchants: MerchantDetail[];
773
786
  name: string;
774
787
  scope: AssetDetailScope;
775
788
  scope_id: string;
776
789
  secret: boolean;
790
+ disabled: boolean;
791
+ content: string;
792
+ created: string;
793
+ content_modified?: string;
794
+ description?: string;
795
+ merchants: MerchantDetail[];
777
796
  }
778
797
 
779
798
  export type UserAccountGetResponse = UserAccountDetail;
@@ -804,16 +823,16 @@ export const ChargeSummaryType = {
804
823
  } as const;
805
824
 
806
825
  export interface ChargeSummary {
807
- /** The cost, in coins of the charge */
808
- coins: string;
809
826
  /** The type of charge */
810
827
  type: ChargeSummaryType;
828
+ /** The cost, in coins of the charge */
829
+ coins: string;
811
830
  }
812
831
 
813
832
  export interface UnitProductChargeSummary {
814
- charges: ChargeSummary[];
815
833
  product_id: string;
816
834
  product_type: string;
835
+ charges: ChargeSummary[];
817
836
  }
818
837
 
819
838
  export interface UnitChargeSummary {
@@ -821,28 +840,28 @@ export interface UnitChargeSummary {
821
840
  }
822
841
 
823
842
  export interface UnitChargesGetResponse {
824
- /**
825
- * @minimum 1
826
- * @maximum 28
827
- */
828
- billing_day: number;
829
843
  /** Whether the user making the API call is a member of the Unit */
830
844
  caller_is_member: boolean;
831
- coins: string;
832
- count: number;
833
- created: string;
834
- /** The start of the charge period */
835
- from: string;
845
+ unit_id: string;
836
846
  name?: string;
837
847
  /** The Unit's owner (a username) */
838
848
  owner_id: string;
839
849
  /** True if the Unit is private */
840
850
  private: boolean;
841
- products: UnitProductChargeSummary[];
842
- summary: UnitChargeSummary;
843
- unit_id: string;
851
+ created: string;
852
+ coins: string;
853
+ count: number;
854
+ /**
855
+ * @minimum 1
856
+ * @maximum 28
857
+ */
858
+ billing_day: number;
859
+ /** The start of the charge period */
860
+ from: string;
844
861
  /** The date where of first day after the charge period */
845
862
  until: string;
863
+ summary: UnitChargeSummary;
864
+ products: UnitProductChargeSummary[];
846
865
  }
847
866
 
848
867
  /**
@@ -864,8 +883,8 @@ export interface ProductsGetTypesResponse {
864
883
 
865
884
  export type ProductsGetDefaultStorageCostDefaultStorageCost = {
866
885
  cost: string;
867
- description: string;
868
886
  units: string;
887
+ description: string;
869
888
  };
870
889
 
871
890
  export interface ProductsGetDefaultStorageCost {
@@ -890,25 +909,25 @@ export const ProductChargesGetResponseProductType = {
890
909
  } as const;
891
910
 
892
911
  export interface ProductChargesGetResponse {
912
+ product_id: string;
913
+ product_type: ProductChargesGetResponseProductType;
893
914
  /**
894
915
  * @minimum 1
895
916
  * @maximum 28
896
917
  */
897
918
  billing_day: number;
898
- claim?: ProductClaimDetail;
899
919
  /** True if the product can be (needs to be) claimed. */
900
920
  claimable: boolean;
901
- /** The total number of coins consumed by this product for the invoice period */
902
- coins: string;
921
+ claim?: ProductClaimDetail;
903
922
  count: number;
904
923
  /** The start of the charge period */
905
924
  from: string;
906
- processing_charges: ProcessingCharges[];
907
- product_id: string;
908
- product_type: ProductChargesGetResponseProductType;
909
- storage_charges: StorageCharges;
910
925
  /** The date where of first day after the charge period */
911
926
  until: string;
927
+ /** The total number of coins consumed by this product for the invoice period */
928
+ coins: string;
929
+ processing_charges: ProcessingCharges[];
930
+ storage_charges: StorageCharges;
912
931
  }
913
932
 
914
933
  export type OrganisationGetResponse = OrganisationAllDetail;
@@ -920,6 +939,8 @@ export interface OrganisationsGetResponse {
920
939
  }
921
940
 
922
941
  export interface OrganisationUnitChargeSummary {
942
+ unit_id: string;
943
+ name: string;
923
944
  /**
924
945
  * @minimum 1
925
946
  * @maximum 28
@@ -927,17 +948,15 @@ export interface OrganisationUnitChargeSummary {
927
948
  billing_day: number;
928
949
  /** The start of the charge period */
929
950
  from: string;
930
- name: string;
931
- summary: ChargeSummary[];
932
- unit_id: string;
933
951
  /** The date where of first day after the charge period */
934
952
  until: string;
953
+ summary: ChargeSummary[];
935
954
  }
936
955
 
937
956
  export interface OrganisationChargesGetResponse {
938
- coins: string;
939
- name: string;
940
957
  organisation_id: string;
958
+ name: string;
959
+ coins: string;
941
960
  summary: ChargeSummary[];
942
961
  unit_charges: OrganisationUnitChargeSummary[];
943
962
  }
@@ -951,16 +970,16 @@ export interface OrganisationUnitsGetResponse {
951
970
  }
952
971
 
953
972
  export interface OrganisationChargeSummary {
954
- name: string;
955
973
  organisation_id: string;
974
+ name: string;
956
975
  summary: ChargeSummary[];
957
976
  }
958
977
 
959
978
  export interface PersonalUnitPutResponse {
960
- /** The unit's unique ID */
961
- id: string;
962
979
  /** The unit's Organisation. Used to identify the Default organisation */
963
980
  organisation_id: string;
981
+ /** The unit's unique ID */
982
+ id: string;
964
983
  }
965
984
 
966
985
  export interface OrganisationUnitPostResponse {
@@ -985,9 +1004,6 @@ export const OrganisationGetDefaultResponseDefaultProductPrivacy = {
985
1004
  export interface OrganisationGetDefaultResponse {
986
1005
  /** Whether the user making the API call is a member of the Default Organisation. Only admin users are members of the Default organisation */
987
1006
  caller_is_member?: boolean;
988
- created?: string;
989
- /** The Organisation's default product privacy setting */
990
- default_product_privacy?: OrganisationGetDefaultResponseDefaultProductPrivacy;
991
1007
  /** The Default Organisation ID
992
1008
  */
993
1009
  id?: string;
@@ -997,6 +1013,9 @@ export interface OrganisationGetDefaultResponse {
997
1013
  /** 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
998
1014
  */
999
1015
  private?: boolean;
1016
+ created?: string;
1017
+ /** The Organisation's default product privacy setting */
1018
+ default_product_privacy?: OrganisationGetDefaultResponseDefaultProductPrivacy;
1000
1019
  }
1001
1020
 
1002
1021
  export interface UsersGetResponse {
@@ -1029,8 +1048,8 @@ export interface EventStreamGetPostResponse {
1029
1048
  export interface ChargesGetResponse {
1030
1049
  coins: string;
1031
1050
  count: number;
1032
- organisation_charges: OrganisationChargeSummary[];
1033
1051
  summary: ChargeSummary[];
1052
+ organisation_charges: OrganisationChargeSummary[];
1034
1053
  }
1035
1054
 
1036
1055
  export interface AssetPostResponse {