@squonk/account-server-client 0.1.31 → 0.1.32

package/{custom-instance-13412a15.d.ts → custom-instance-b985e1be.d.ts}

@@ -2,7 +2,7 @@ import * as axios from 'axios';
 import { AxiosRequestConfig, AxiosError } from 'axios';
 
 /**
- * Generated by orval v6.7.1 🍺
+ * Generated by orval v6.8.0 🍺
  * Do not edit manually.
  * Account Server API
  * The Informatics Matters Account Server API.
@@ -11,6 +11,38 @@ A service that provides access to the Account Server, which gives *registered* u
 
  * OpenAPI spec version: 0.1
  */
+declare type DetachAssetParams = {
+    m_id?: QMIdParameter;
+};
+declare type AttachAssetParams = {
+    m_id?: QMIdParameter;
+};
+/**
+ * A User Identity
+ */
+declare type QUserIdParameter = string;
+/**
+ * A Product Identity
+ */
+declare type QProductIdParameter = string;
+/**
+ * A Unit Identity
+ */
+declare type QUnitIdParameter = string;
+declare type GetAssetParams = {
+    user_id?: QUserIdParameter;
+    product_id?: QProductIdParameter;
+    unit_id?: QUnitIdParameter;
+    org_id?: QOrgIdParameter;
+};
+/**
+ * A Merchant Identity
+ */
+declare type QMIdParameter = number;
+/**
+ * An Organisation Identity
+ */
+declare type QOrgIdParameter = string;
 declare type ProductPatchBodyBody = {
     /** The name you want to give the Product */
     name?: string;
@@ -22,22 +54,22 @@ declare type ProductPatchBodyBody = {
 /**
  * The Flavour of the Product. Used only for Project Tier Products. Do not set this for Storage products
  */
-declare type UnitProductPostBodyBodyFlavour = "EVALUATION" | "BRONZE" | "SILVER" | "GOLD";
+declare type UnitProductPostBodyBodyFlavour = typeof UnitProductPostBodyBodyFlavour[keyof typeof UnitProductPostBodyBodyFlavour];
 declare const UnitProductPostBodyBodyFlavour: {
-    EVALUATION: UnitProductPostBodyBodyFlavour;
-    BRONZE: UnitProductPostBodyBodyFlavour;
-    SILVER: UnitProductPostBodyBodyFlavour;
-    GOLD: UnitProductPostBodyBodyFlavour;
+    readonly EVALUATION: "EVALUATION";
+    readonly BRONZE: "BRONZE";
+    readonly SILVER: "SILVER";
+    readonly GOLD: "GOLD";
 };
 /**
  * The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be provided.
 
 Project Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products
  */
-declare type UnitProductPostBodyBodyType = "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION" | "DATA_MANAGER_STORAGE_SUBSCRIPTION";
+declare type UnitProductPostBodyBodyType = typeof UnitProductPostBodyBodyType[keyof typeof UnitProductPostBodyBodyType];
 declare const UnitProductPostBodyBodyType: {
-    DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: UnitProductPostBodyBodyType;
-    DATA_MANAGER_STORAGE_SUBSCRIPTION: UnitProductPostBodyBodyType;
+    readonly DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION";
+    readonly DATA_MANAGER_STORAGE_SUBSCRIPTION: "DATA_MANAGER_STORAGE_SUBSCRIPTION";
 };
 declare type UnitProductPostBodyBody = {
     /** The name you want to give the Product */
@@ -67,6 +99,28 @@ declare type OrganisationPostBodyBody = {
     /** The name of the organisation owner. A user ID */
     owner: string;
 };
+declare type AssetPostBodyBodyScope = typeof AssetPostBodyBodyScope[keyof typeof AssetPostBodyBodyScope];
+declare const AssetPostBodyBodyScope: {
+    readonly USER: "USER";
+    readonly PRODUCT: "PRODUCT";
+    readonly UNIT: "UNIT";
+    readonly ORGANISATION: "ORGANISATION";
+};
+declare type AssetPostBodyBody = {
+    /** 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 */
+    name: string;
+    /** A file containing the content for the asset. You must provide a value here or in content_string */
+    content_file?: Blob;
+    /** The textual content of the asset. You must provide a value here or in content_file */
+    content_string?: string;
+    scope: AssetPostBodyBodyScope;
+    /** The unique identity based on the Scope of the asset. For example, this wil be the Unit ID if it's a UNIT. A scope_id is required if the scope is USER as it wil be automatically set to your username */
+    scope_id?: string;
+    /** Is this a secret asset? */
+    secret: boolean;
+    /** An optional description for the Asset */
+    description?: string;
+};
 interface UserDetail {
     /** The user identity (username) */
     id: string;
@@ -91,22 +145,25 @@ interface UnitDetail {
 /**
  * The kind of Service
  */
-declare type ServiceGetResponseKind = "DATA_MANAGER";
-declare const ServiceGetResponseKind: {
-    DATA_MANAGER: "DATA_MANAGER";
+declare type MerchantDetailKind = typeof MerchantDetailKind[keyof typeof MerchantDetailKind];
+declare const MerchantDetailKind: {
+    readonly DATA_MANAGER: "DATA_MANAGER";
 };
-interface ServiceGetResponse {
+interface MerchantDetail {
     /** The unique ID of the Service */
     id: number;
     /** The kind of Service */
-    kind: ServiceGetResponseKind;
+    kind: MerchantDetailKind;
     /** The name assigned to the Service */
-    name?: string;
+    name: string;
+    /** The hostname used by the Service */
+    api_hostname: string;
 }
-interface ServicesGetResponse {
-    /** The list of known Services
+declare type MerchantGetResponse = MerchantDetail;
+interface MerchantsGetResponse {
+    /** The list of known Merchants
      */
-    services: ServiceGetResponse[];
+    merchants: MerchantDetail[];
 }
 interface OrganisationDetail {
     /** Whether the user making the API call is a member of the Unit */
@@ -120,13 +177,20 @@ interface OrganisationDetail {
     /** True if the Unit is private */
     private: boolean;
 }
+/**
+ * The kind of service that can use the Product
+ */
+declare type ProductTypeServiceKind = typeof ProductTypeServiceKind[keyof typeof ProductTypeServiceKind];
+declare const ProductTypeServiceKind: {
+    readonly DATA_MANAGER: "DATA_MANAGER";
+};
 interface ProductType {
     /** A product type, this is a unique string amongst all types known to the Account Server */
     type: string;
     /** A product flavour. Not all types have a flavour, those that do have a type-specific flavour string */
     flavour?: string;
-    /** For a product that belongs to a specific service, the service that owns it is provided */
-    service?: ServiceGetResponse;
+    /** The kind of service that can use the Product */
+    service_kind?: ProductTypeServiceKind;
 }
 declare type ProductInstanceDetailCoins = {
     /** The number of coins used
@@ -140,21 +204,21 @@ interface ProductInstanceDetail {
  * The Product Type falvour. Not all products have flavours
 
  */
-declare type ProductDetailFlavour = "EVALUATION" | "BRONZE" | "SILVER" | "GOLD";
+declare type ProductDetailFlavour = typeof ProductDetailFlavour[keyof typeof ProductDetailFlavour];
 declare const ProductDetailFlavour: {
-    EVALUATION: ProductDetailFlavour;
-    BRONZE: ProductDetailFlavour;
-    SILVER: ProductDetailFlavour;
-    GOLD: ProductDetailFlavour;
+    readonly EVALUATION: "EVALUATION";
+    readonly BRONZE: "BRONZE";
+    readonly SILVER: "SILVER";
+    readonly GOLD: "GOLD";
 };
 /**
  * The Product Type
 
  */
-declare type ProductDetailType = "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION" | "DATA_MANAGER_STORAGE_SUBSCRIPTION";
+declare type ProductDetailType = typeof ProductDetailType[keyof typeof ProductDetailType];
 declare const ProductDetailType: {
-    DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: ProductDetailType;
-    DATA_MANAGER_STORAGE_SUBSCRIPTION: ProductDetailType;
+    readonly DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION";
+    readonly DATA_MANAGER_STORAGE_SUBSCRIPTION: "DATA_MANAGER_STORAGE_SUBSCRIPTION";
 };
 interface ProductDetail {
     /** The Product ID
@@ -239,15 +303,33 @@ interface ProductDmStorage {
     storage: ProductDmStorageDetail;
     coins: ProductCoinsDetail;
 }
-declare type UserAccountGetResponse = UserAccountDetail;
-interface UnitGetResponse {
-    /** The Unit's unique ID */
+declare type AssetDetailScope = typeof AssetDetailScope[keyof typeof AssetDetailScope];
+declare const AssetDetailScope: {
+    readonly USER: "USER";
+    readonly PRODUCT: "PRODUCT";
+    readonly UNIT: "UNIT";
+    readonly ORGANISATION: "ORGANISATION";
+};
+interface AssetDetail {
+    creator: string;
     id: string;
-    /** The Unit's name */
     name: string;
-    /** The Unit's oener (username) */
-    owner_id: string;
+    scope: AssetDetailScope;
+    scope_id: string;
+    secret: boolean;
+    disabled: boolean;
+    content: string;
+    created: string;
+    description?: string;
+    merchants: MerchantDetail[];
+}
+declare type UserAccountGetResponse = UserAccountDetail;
+interface UnitsGetResponse {
+    /** A list of Units
+     */
+    units: OrganisationUnitsGetResponse[];
 }
+declare type UnitGetResponse = UnitDetail;
 interface UnitProductPostResponse {
     /** The Products's unique ID */
     id: string;
@@ -279,11 +361,6 @@ interface OrganisationUnitsGetResponse {
      */
     units: UnitDetail[];
 }
-interface UnitsGetResponse {
-    /** A list of Units
-     */
-    units: OrganisationUnitsGetResponse[];
-}
 interface PersonalUnitPutResponse {
     /** The unit's Organisation. Used to identify the Default organisation */
     organisation_id: string;
@@ -323,6 +400,16 @@ interface StateGetVersionResponse {
      */
     version: string;
 }
+interface AssetPostResponse {
+    /** The Asset ID
+     */
+    id: string;
+}
+interface AssetGetResponse {
+    /** A list of Assets
+     */
+    assets: AssetDetail[];
+}
 interface AsError {
     /** Brief error text that can be presented to the user */
     error: string;
@@ -343,4 +430,4 @@ declare const setBaseUrl: (baseUrl: string) => void;
 declare const customInstance: <TReturn>(config: AxiosRequestConfig, options?: AxiosRequestConfig<any> | undefined) => Promise<TReturn>;
 declare type ErrorType<TError> = AxiosError<TError>;
 
-export { ProductUnitGetResponse as A, ProductsGetTypesResponse as B, ProductsGetResponseProductsItem as C, ProductsGetResponse as D, OrganisationsGetResponse as E, OrganisationUnitsGetResponse as F, UnitsGetResponse as G, PersonalUnitPutResponse as H, OrganisationUnitPostResponse as I, OrganisationGetDefaultResponse as J, UsersGetResponse as K, OrganisationPostResponse as L, StateGetVersionResponse as M, AsError as N, OrganisationUnitPostBodyBody as O, ProductPatchBodyBody as P, AXIOS_INSTANCE as Q, setAuthToken as R, ServiceGetResponseKind as S, setBaseUrl as T, UnitProductPostBodyBodyFlavour as U, customInstance as V, ErrorType as W, UnitProductPostBodyBodyType as a, UnitProductPostBodyBody as b, OrganisationPostBodyBody as c, UserDetail as d, UserAccountDetail as e, UnitDetail as f, ServiceGetResponse as g, ServicesGetResponse as h, OrganisationDetail as i, ProductType as j, ProductInstanceDetailCoins as k, ProductInstanceDetail as l, ProductDetailFlavour as m, ProductDetailType as n, ProductDetail as o, ProductCoinsDetail as p, ProductClaimDetail as q, ProductDmStorageDetailCoins as r, ProductDmStorageDetailSize as s, ProductDmStorageDetail as t, ProductDmProjectTier as u, ProductDmStorage as v, UserAccountGetResponse as w, UnitGetResponse as x, UnitProductPostResponse as y, ProductUnitGetResponseProduct as z };
+export { OrganisationGetDefaultResponse as $, AttachAssetParams as A, ProductDmStorageDetailSize as B, ProductDmStorageDetail as C, DetachAssetParams as D, ProductDmProjectTier as E, ProductDmStorage as F, GetAssetParams as G, AssetDetailScope as H, AssetDetail as I, UserAccountGetResponse as J, UnitsGetResponse as K, UnitGetResponse as L, MerchantDetailKind as M, UnitProductPostResponse as N, OrganisationUnitPostBodyBody as O, ProductPatchBodyBody as P, QUserIdParameter as Q, ProductUnitGetResponseProduct as R, ProductUnitGetResponse as S, ProductsGetTypesResponse as T, UnitProductPostBodyBodyFlavour as U, ProductsGetResponseProductsItem as V, ProductsGetResponse as W, OrganisationsGetResponse as X, OrganisationUnitsGetResponse as Y, PersonalUnitPutResponse as Z, OrganisationUnitPostResponse as _, QProductIdParameter as a, UsersGetResponse as a0, OrganisationPostResponse as a1, StateGetVersionResponse as a2, AssetPostResponse as a3, AssetGetResponse as a4, AsError as a5, AXIOS_INSTANCE as a6, setAuthToken as a7, setBaseUrl as a8, customInstance as a9, ErrorType as aa, QUnitIdParameter as b, QMIdParameter as c, QOrgIdParameter as d, UnitProductPostBodyBodyType as e, UnitProductPostBodyBody as f, OrganisationPostBodyBody as g, AssetPostBodyBodyScope as h, AssetPostBodyBody as i, UserDetail as j, UserAccountDetail as k, UnitDetail as l, MerchantDetail as m, MerchantGetResponse as n, MerchantsGetResponse as o, OrganisationDetail as p, ProductTypeServiceKind as q, ProductType as r, ProductInstanceDetailCoins as s, ProductInstanceDetail as t, ProductDetailFlavour as u, ProductDetailType as v, ProductDetail as w, ProductCoinsDetail as x, ProductClaimDetail as y, ProductDmStorageDetailCoins as z };

package/index.cjs

@@ -16,7 +16,16 @@ var UnitProductPostBodyBodyType = {
   DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION",
   DATA_MANAGER_STORAGE_SUBSCRIPTION: "DATA_MANAGER_STORAGE_SUBSCRIPTION"
 };
-var ServiceGetResponseKind = {
+var AssetPostBodyBodyScope = {
+  USER: "USER",
+  PRODUCT: "PRODUCT",
+  UNIT: "UNIT",
+  ORGANISATION: "ORGANISATION"
+};
+var MerchantDetailKind = {
+  DATA_MANAGER: "DATA_MANAGER"
+};
+var ProductTypeServiceKind = {
   DATA_MANAGER: "DATA_MANAGER"
 };
 var ProductDetailFlavour = {
@@ -29,6 +38,15 @@ var ProductDetailType = {
   DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION",
   DATA_MANAGER_STORAGE_SUBSCRIPTION: "DATA_MANAGER_STORAGE_SUBSCRIPTION"
 };
+var AssetDetailScope = {
+  USER: "USER",
+  PRODUCT: "PRODUCT",
+  UNIT: "UNIT",
+  ORGANISATION: "ORGANISATION"
+};
+
+
+
 
 
 
@@ -39,5 +57,5 @@ var ProductDetailType = {
 
 
 
-exports.AXIOS_INSTANCE = _chunkNGBTCJWScjs.AXIOS_INSTANCE; exports.ProductDetailFlavour = ProductDetailFlavour; exports.ProductDetailType = ProductDetailType; exports.ServiceGetResponseKind = ServiceGetResponseKind; exports.UnitProductPostBodyBodyFlavour = UnitProductPostBodyBodyFlavour; exports.UnitProductPostBodyBodyType = UnitProductPostBodyBodyType; exports.customInstance = _chunkNGBTCJWScjs.customInstance; exports.setAuthToken = _chunkNGBTCJWScjs.setAuthToken; exports.setBaseUrl = _chunkNGBTCJWScjs.setBaseUrl;
+exports.AXIOS_INSTANCE = _chunkNGBTCJWScjs.AXIOS_INSTANCE; exports.AssetDetailScope = AssetDetailScope; exports.AssetPostBodyBodyScope = AssetPostBodyBodyScope; exports.MerchantDetailKind = MerchantDetailKind; exports.ProductDetailFlavour = ProductDetailFlavour; exports.ProductDetailType = ProductDetailType; exports.ProductTypeServiceKind = ProductTypeServiceKind; exports.UnitProductPostBodyBodyFlavour = UnitProductPostBodyBodyFlavour; exports.UnitProductPostBodyBodyType = UnitProductPostBodyBodyType; exports.customInstance = _chunkNGBTCJWScjs.customInstance; exports.setAuthToken = _chunkNGBTCJWScjs.setAuthToken; exports.setBaseUrl = _chunkNGBTCJWScjs.setBaseUrl;
 //# sourceMappingURL=index.cjs.map

package/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/account-server-api.schemas.ts"],"names":[],"mappings":";;;;;;;;AA6BO,IAAM,iCAAiC;AAAA,EAC5C,YAAY;AAAA,EACZ,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,MAAM;AACR;AAYO,IAAM,8BAA8B;AAAA,EACzC,wCACE;AAAA,EACF,mCACE;AACJ;AA+DO,IAAM,yBAAyB;AAAA,EACpC,cAAc;AAChB;AAwDO,IAAM,uBAAuB;AAAA,EAClC,YAAY;AAAA,EACZ,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,MAAM;AACR;AAWO,IAAM,oBAAoB;AAAA,EAC/B,wCACE;AAAA,EACF,mCACE;AACJ","sourcesContent":["/**\n * Generated by orval v6.7.1 🍺\n * Do not edit manually.\n * Account Server API\n * The Informatics Matters Account Server API.\n\nA service that provides access to the Account Server, which gives *registered* users access to and management of **Products**, **Organisations**, **Units** and **Users**.\n\n * OpenAPI spec version: 0.1\n */\nexport type ProductPatchBodyBody = {\n  /** The name you want to give the Product */\n  name?: string;\n  /** The Product's built-in coin allowance. Product allowances cannot be reduced */\n  allowance?: number;\n  /** The Product's built-in coin limit. If set it must not be less than the allowance. If not set the allowance is used. The existing product limit cannot be reduced */\n  limit?: number;\n};\n\n/**\n * The Flavour of the Product. Used only for Project Tier Products. Do not set this for Storage products\n */\nexport type UnitProductPostBodyBodyFlavour =\n  | \"EVALUATION\"\n  | \"BRONZE\"\n  | \"SILVER\"\n  | \"GOLD\";\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const UnitProductPostBodyBodyFlavour = {\n  EVALUATION: \"EVALUATION\" as UnitProductPostBodyBodyFlavour,\n  BRONZE: \"BRONZE\" as UnitProductPostBodyBodyFlavour,\n  SILVER: \"SILVER\" as UnitProductPostBodyBodyFlavour,\n  GOLD: \"GOLD\" as UnitProductPostBodyBodyFlavour,\n};\n\n/**\n * The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be provided.\n\nProject Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products\n */\nexport type UnitProductPostBodyBodyType =\n  | \"DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION\"\n  | \"DATA_MANAGER_STORAGE_SUBSCRIPTION\";\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const UnitProductPostBodyBodyType = {\n  DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION:\n    \"DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION\" as UnitProductPostBodyBodyType,\n  DATA_MANAGER_STORAGE_SUBSCRIPTION:\n    \"DATA_MANAGER_STORAGE_SUBSCRIPTION\" as UnitProductPostBodyBodyType,\n};\n\nexport type UnitProductPostBodyBody = {\n  /** The name you want to give the Product */\n  name: string;\n  /** The service identity for the Product. Products are created for use on a specific service, like a Data Manager instance */\n  service_id: number;\n  /** The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be provided.\n\nProject Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products */\n  type: UnitProductPostBodyBodyType;\n  /** The Flavour of the Product. Used only for Project Tier Products. Do not set this for Storage products */\n  flavour?: UnitProductPostBodyBodyFlavour;\n  /** The Product's coin allowance. You must provide this for Storage products but you must not provide a value for Project Tier Products */\n  allowance?: number;\n  /** 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 */\n  limit?: number;\n  /** The day you would like to be billed for the Product's subscription (a value from 1 and 28) */\n  billing_day: number;\n};\n\nexport type OrganisationUnitPostBodyBody = {\n  /** The name of the unit */\n  name: string;\n};\n\nexport type OrganisationPostBodyBody = {\n  /** The name of the organisation */\n  name: string;\n  /** The name of the organisation owner. A user ID */\n  owner: string;\n};\n\nexport interface UserDetail {\n  /** The user identity (username) */\n  id: string;\n}\n\nexport interface UserAccountDetail {\n  user: UserDetail;\n  /** Whether the caller has admin privilege */\n  caller_has_admin_privilege: boolean;\n}\n\nexport interface UnitDetail {\n  /** Whether the user making the API call is a member of the Unit */\n  caller_is_member: boolean;\n  /** The Unit's unique identity */\n  id: string;\n  /** The Unit's name */\n  name: string;\n  /** The Unit's owner (a username) */\n  owner_id: string;\n  /** True if the Unit is private */\n  private: boolean;\n}\n\n/**\n * The kind of Service\n */\nexport type ServiceGetResponseKind = \"DATA_MANAGER\";\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const ServiceGetResponseKind = {\n  DATA_MANAGER: \"DATA_MANAGER\" as ServiceGetResponseKind,\n};\n\nexport interface ServiceGetResponse {\n  /** The unique ID of the Service */\n  id: number;\n  /** The kind of Service */\n  kind: ServiceGetResponseKind;\n  /** The name assigned to the Service */\n  name?: string;\n}\n\nexport interface ServicesGetResponse {\n  /** The list of known Services\n   */\n  services: ServiceGetResponse[];\n}\n\nexport interface OrganisationDetail {\n  /** Whether the user making the API call is a member of the Unit */\n  caller_is_member: boolean;\n  /** The Organisation's unique ID */\n  id: string;\n  /** The Organisation's name */\n  name: string;\n  /** The username of the Organisation's owner. Not all Organisations have an owner. The Default Organisation has no owner. */\n  owner_id?: string;\n  /** True if the Unit is private */\n  private: boolean;\n}\n\nexport interface ProductType {\n  /** A product type, this is a unique string amongst all types known to the Account Server */\n  type: string;\n  /** A product flavour. Not all types have a flavour, those that do have a type-specific flavour string */\n  flavour?: string;\n  /** For a product that belongs to a specific service, the service that owns it is provided */\n  service?: ServiceGetResponse;\n}\n\nexport type ProductInstanceDetailCoins = {\n  /** The number of coins used\n   */\n  used: number;\n};\n\nexport interface ProductInstanceDetail {\n  coins: ProductInstanceDetailCoins;\n}\n\n/**\n * The Product Type falvour. Not all products have flavours\n\n */\nexport type ProductDetailFlavour = \"EVALUATION\" | \"BRONZE\" | \"SILVER\" | \"GOLD\";\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const ProductDetailFlavour = {\n  EVALUATION: \"EVALUATION\" as ProductDetailFlavour,\n  BRONZE: \"BRONZE\" as ProductDetailFlavour,\n  SILVER: \"SILVER\" as ProductDetailFlavour,\n  GOLD: \"GOLD\" as ProductDetailFlavour,\n};\n\n/**\n * The Product Type\n\n */\nexport type ProductDetailType =\n  | \"DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION\"\n  | \"DATA_MANAGER_STORAGE_SUBSCRIPTION\";\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const ProductDetailType = {\n  DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION:\n    \"DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION\" as ProductDetailType,\n  DATA_MANAGER_STORAGE_SUBSCRIPTION:\n    \"DATA_MANAGER_STORAGE_SUBSCRIPTION\" as ProductDetailType,\n};\n\nexport interface ProductDetail {\n  /** The Product ID\n   */\n  id: string;\n  /** The Product Service ID\n   */\n  service_id?: number;\n  /** The Product Type\n   */\n  type: ProductDetailType;\n  /** The Product Type falvour. Not all products have flavours\n   */\n  flavour?: ProductDetailFlavour;\n  /** The name of the Product\n   */\n  name?: string;\n}\n\nexport interface ProductCoinsDetail {\n  /** The billing allowance. When you exceed this during the current billing period the *cost multiplier* will increase */\n  allowance: number;\n  /** 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 */\n  limit: number;\n  /** The total number of coins consumed (in this billing period), excluding the coins that have been consumed for the current day */\n  used: number;\n  /** 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. */\n  at_limit: boolean;\n  /** The current burn rate, the approximate amount of coins you are currently consuming each day */\n  current_burn_rate: number;\n  /** The predicted billing period amount, if costs continue at the current burn rate until the end of the billing period */\n  billing_prediction: number;\n  /** The day of the month when the bill is due, and the end of the current billing period */\n  billing_day: number;\n  /** A multiplier applied to your coin usage within your allowance */\n  allowance_multiplier: number;\n  /** A multiplier that will be applied to coin used beyond your allowance */\n  overspend_multiplier: number;\n  /** The number of days remaining, in the current billing period */\n  remaining_days: number;\n}\n\nexport interface ProductClaimDetail {\n  /** The service-specific ID that is using this Subscription\n   */\n  id: string;\n  /** A name for the service-specific ID\n   */\n  name?: string;\n}\n\nexport type ProductDmStorageDetailCoins = {\n  /** The number of coins currently committed for the current day. This is added to the accumulated coins at the start of each day */\n  used: number;\n  /** The coin cost of a 'unit' of storage or part thereof. The unit size is defined in the storage section of the response */\n  unit_cost: number;\n};\n\nexport type ProductDmStorageDetailSize = {\n  /** The humanised size of the peak storage used for the current day. The value is reset at the start of each day */\n  peak: string;\n  /** The humanised size of the current storage used for the current day and used to calculate the 'burn rate' */\n  current: string;\n  /** The humanised storage unit. The cost of storage is based on the daily peak of the number of units (or part thereof) used */\n  unit_size: string;\n  /** The peak number of storage units used today */\n  units_used: number;\n};\n\nexport interface ProductDmStorageDetail {\n  size: ProductDmStorageDetailSize;\n  coins: ProductDmStorageDetailCoins;\n}\n\nexport interface ProductDmProjectTier {\n  product: ProductDetail;\n  organisation: OrganisationDetail;\n  unit: UnitDetail;\n  storage: ProductDmStorageDetail;\n  coins: ProductCoinsDetail;\n  instance: ProductInstanceDetail;\n  claim?: ProductClaimDetail;\n}\n\nexport interface ProductDmStorage {\n  product: ProductDetail;\n  organisation: OrganisationDetail;\n  unit: UnitDetail;\n  storage: ProductDmStorageDetail;\n  coins: ProductCoinsDetail;\n}\n\nexport type UserAccountGetResponse = UserAccountDetail;\n\nexport interface UnitGetResponse {\n  /** The Unit's unique ID */\n  id: string;\n  /** The Unit's name */\n  name: string;\n  /** The Unit's oener (username) */\n  owner_id: string;\n}\n\nexport interface UnitProductPostResponse {\n  /** The Products's unique ID */\n  id: string;\n}\n\n/**\n * The Unit's Product\n */\nexport type ProductUnitGetResponseProduct =\n  | ProductDmStorage\n  | ProductDmProjectTier;\n\nexport interface ProductUnitGetResponse {\n  /** The Unit's Product */\n  product: ProductUnitGetResponseProduct;\n}\n\nexport interface ProductsGetTypesResponse {\n  /** All the Product Types you have access to */\n  product_types: ProductType[];\n}\n\nexport type ProductsGetResponseProductsItem =\n  | ProductDmStorage\n  | ProductDmProjectTier;\n\nexport interface ProductsGetResponse {\n  /** All the Products you have access to */\n  products: ProductsGetResponseProductsItem[];\n}\n\nexport interface OrganisationsGetResponse {\n  /** A list of Organisations */\n  organisations: OrganisationDetail[];\n}\n\nexport interface OrganisationUnitsGetResponse {\n  organisation: OrganisationDetail;\n  /** A list of Units\n   */\n  units: UnitDetail[];\n}\n\nexport interface UnitsGetResponse {\n  /** A list of Units\n   */\n  units: OrganisationUnitsGetResponse[];\n}\n\nexport interface PersonalUnitPutResponse {\n  /** The unit's Organisation. Used to identify the Default organisation */\n  organisation_id: string;\n  /** The unit's unique ID */\n  id: string;\n}\n\nexport interface OrganisationUnitPostResponse {\n  /** The unit's unique ID */\n  id: string;\n}\n\nexport interface OrganisationGetDefaultResponse {\n  /** Whether the user making the API call is a member of the Default Organisation. Only admin users are members of the Default organisation */\n  caller_is_member: boolean;\n  /** The Default Organisation ID\n   */\n  id: string;\n  /** The Default Organisation Name\n   */\n  name: string;\n  /** 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\n   */\n  private: boolean;\n}\n\nexport interface UsersGetResponse {\n  organisation?: OrganisationDetail;\n  unit?: UnitDetail;\n  /** The list of Organisation Users\n   */\n  users: UserDetail[];\n}\n\nexport interface OrganisationPostResponse {\n  /** The Organisation's unique ID */\n  id: string;\n}\n\nexport interface StateGetVersionResponse {\n  /** The Account Server version. This is guaranteed to be a valid semantic version for official (tagged) images. The version value format for unofficial images is a string but otherwise undefined\n   */\n  version: string;\n}\n\nexport interface AsError {\n  /** Brief error text that can be presented to the user */\n  error: string;\n}\n"]}
+{"version":3,"sources":["../src/account-server-api.schemas.ts"],"names":[],"mappings":";;;;;;;;AA8DO,IAAM,iCAAiC;AAAA,EAC5C,YAAY;AAAA,EACZ,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,MAAM;AACR;AAWO,IAAM,8BAA8B;AAAA,EACzC,wCACE;AAAA,EACF,mCAAmC;AACrC;AAqCO,IAAM,yBAAyB;AAAA,EACpC,MAAM;AAAA,EACN,SAAS;AAAA,EACT,MAAM;AAAA,EACN,cAAc;AAChB;AAiDO,IAAM,qBAAqB;AAAA,EAChC,cAAc;AAChB;AAyCO,IAAM,yBAAyB;AAAA,EACpC,cAAc;AAChB;AA6BO,IAAM,uBAAuB;AAAA,EAClC,YAAY;AAAA,EACZ,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,MAAM;AACR;AAUO,IAAM,oBAAoB;AAAA,EAC/B,wCACE;AAAA,EACF,mCAAmC;AACrC;AAiGO,IAAM,mBAAmB;AAAA,EAC9B,MAAM;AAAA,EACN,SAAS;AAAA,EACT,MAAM;AAAA,EACN,cAAc;AAChB","sourcesContent":["/**\n * Generated by orval v6.8.0 🍺\n * Do not edit manually.\n * Account Server API\n * The Informatics Matters Account Server API.\n\nA service that provides access to the Account Server, which gives *registered* users access to and management of **Products**, **Organisations**, **Units** and **Users**.\n\n * OpenAPI spec version: 0.1\n */\nexport type DetachAssetParams = { m_id?: QMIdParameter };\n\nexport type AttachAssetParams = { m_id?: QMIdParameter };\n\n/**\n * A User Identity\n */\nexport type QUserIdParameter = string;\n\n/**\n * A Product Identity\n */\nexport type QProductIdParameter = string;\n\n/**\n * A Unit Identity\n */\nexport type QUnitIdParameter = string;\n\nexport type GetAssetParams = {\n  user_id?: QUserIdParameter;\n  product_id?: QProductIdParameter;\n  unit_id?: QUnitIdParameter;\n  org_id?: QOrgIdParameter;\n};\n\n/**\n * A Merchant Identity\n */\nexport type QMIdParameter = number;\n\n/**\n * An Organisation Identity\n */\nexport type QOrgIdParameter = string;\n\nexport type ProductPatchBodyBody = {\n  /** The name you want to give the Product */\n  name?: string;\n  /** The Product's built-in coin allowance. Product allowances cannot be reduced */\n  allowance?: number;\n  /** The Product's built-in coin limit. If set it must not be less than the allowance. If not set the allowance is used. The existing product limit cannot be reduced */\n  limit?: number;\n};\n\n/**\n * The Flavour of the Product. Used only for Project Tier Products. Do not set this for Storage products\n */\nexport type UnitProductPostBodyBodyFlavour =\n  typeof UnitProductPostBodyBodyFlavour[keyof typeof UnitProductPostBodyBodyFlavour];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const UnitProductPostBodyBodyFlavour = {\n  EVALUATION: \"EVALUATION\",\n  BRONZE: \"BRONZE\",\n  SILVER: \"SILVER\",\n  GOLD: \"GOLD\",\n} as const;\n\n/**\n * The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be provided.\n\nProject Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products\n */\nexport type UnitProductPostBodyBodyType =\n  typeof UnitProductPostBodyBodyType[keyof typeof UnitProductPostBodyBodyType];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const UnitProductPostBodyBodyType = {\n  DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION:\n    \"DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION\",\n  DATA_MANAGER_STORAGE_SUBSCRIPTION: \"DATA_MANAGER_STORAGE_SUBSCRIPTION\",\n} as const;\n\nexport type UnitProductPostBodyBody = {\n  /** The name you want to give the Product */\n  name: string;\n  /** The service identity for the Product. Products are created for use on a specific service, like a Data Manager instance */\n  service_id: number;\n  /** The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be provided.\n\nProject Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products */\n  type: UnitProductPostBodyBodyType;\n  /** The Flavour of the Product. Used only for Project Tier Products. Do not set this for Storage products */\n  flavour?: UnitProductPostBodyBodyFlavour;\n  /** The Product's coin allowance. You must provide this for Storage products but you must not provide a value for Project Tier Products */\n  allowance?: number;\n  /** 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 */\n  limit?: number;\n  /** The day you would like to be billed for the Product's subscription (a value from 1 and 28) */\n  billing_day: number;\n};\n\nexport type OrganisationUnitPostBodyBody = {\n  /** The name of the unit */\n  name: string;\n};\n\nexport type OrganisationPostBodyBody = {\n  /** The name of the organisation */\n  name: string;\n  /** The name of the organisation owner. A user ID */\n  owner: string;\n};\n\nexport type AssetPostBodyBodyScope =\n  typeof AssetPostBodyBodyScope[keyof typeof AssetPostBodyBodyScope];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const AssetPostBodyBodyScope = {\n  USER: \"USER\",\n  PRODUCT: \"PRODUCT\",\n  UNIT: \"UNIT\",\n  ORGANISATION: \"ORGANISATION\",\n} as const;\n\nexport type AssetPostBodyBody = {\n  /** 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 */\n  name: string;\n  /** A file containing the content for the asset. You must provide a value here or in content_string */\n  content_file?: Blob;\n  /** The textual content of the asset. You must provide a value here or in content_file */\n  content_string?: string;\n  scope: AssetPostBodyBodyScope;\n  /** The unique identity based on the Scope of the asset. For example, this wil be the Unit ID if it's a UNIT. A scope_id is required if the scope is USER as it wil be automatically set to your username */\n  scope_id?: string;\n  /** Is this a secret asset? */\n  secret: boolean;\n  /** An optional description for the Asset */\n  description?: string;\n};\n\nexport interface UserDetail {\n  /** The user identity (username) */\n  id: string;\n}\n\nexport interface UserAccountDetail {\n  user: UserDetail;\n  /** Whether the caller has admin privilege */\n  caller_has_admin_privilege: boolean;\n}\n\nexport interface UnitDetail {\n  /** Whether the user making the API call is a member of the Unit */\n  caller_is_member: boolean;\n  /** The Unit's unique identity */\n  id: string;\n  /** The Unit's name */\n  name: string;\n  /** The Unit's owner (a username) */\n  owner_id: string;\n  /** True if the Unit is private */\n  private: boolean;\n}\n\n/**\n * The kind of Service\n */\nexport type MerchantDetailKind =\n  typeof MerchantDetailKind[keyof typeof MerchantDetailKind];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const MerchantDetailKind = {\n  DATA_MANAGER: \"DATA_MANAGER\",\n} as const;\n\nexport interface MerchantDetail {\n  /** The unique ID of the Service */\n  id: number;\n  /** The kind of Service */\n  kind: MerchantDetailKind;\n  /** The name assigned to the Service */\n  name: string;\n  /** The hostname used by the Service */\n  api_hostname: string;\n}\n\nexport type MerchantGetResponse = MerchantDetail;\n\nexport interface MerchantsGetResponse {\n  /** The list of known Merchants\n   */\n  merchants: MerchantDetail[];\n}\n\nexport interface OrganisationDetail {\n  /** Whether the user making the API call is a member of the Unit */\n  caller_is_member: boolean;\n  /** The Organisation's unique ID */\n  id: string;\n  /** The Organisation's name */\n  name: string;\n  /** The username of the Organisation's owner. Not all Organisations have an owner. The Default Organisation has no owner. */\n  owner_id?: string;\n  /** True if the Unit is private */\n  private: boolean;\n}\n\n/**\n * The kind of service that can use the Product\n */\nexport type ProductTypeServiceKind =\n  typeof ProductTypeServiceKind[keyof typeof ProductTypeServiceKind];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const ProductTypeServiceKind = {\n  DATA_MANAGER: \"DATA_MANAGER\",\n} as const;\n\nexport interface ProductType {\n  /** A product type, this is a unique string amongst all types known to the Account Server */\n  type: string;\n  /** A product flavour. Not all types have a flavour, those that do have a type-specific flavour string */\n  flavour?: string;\n  /** The kind of service that can use the Product */\n  service_kind?: ProductTypeServiceKind;\n}\n\nexport type ProductInstanceDetailCoins = {\n  /** The number of coins used\n   */\n  used: number;\n};\n\nexport interface ProductInstanceDetail {\n  coins: ProductInstanceDetailCoins;\n}\n\n/**\n * The Product Type falvour. Not all products have flavours\n\n */\nexport type ProductDetailFlavour =\n  typeof ProductDetailFlavour[keyof typeof ProductDetailFlavour];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const ProductDetailFlavour = {\n  EVALUATION: \"EVALUATION\",\n  BRONZE: \"BRONZE\",\n  SILVER: \"SILVER\",\n  GOLD: \"GOLD\",\n} as const;\n\n/**\n * The Product Type\n\n */\nexport type ProductDetailType =\n  typeof ProductDetailType[keyof typeof ProductDetailType];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const ProductDetailType = {\n  DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION:\n    \"DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION\",\n  DATA_MANAGER_STORAGE_SUBSCRIPTION: \"DATA_MANAGER_STORAGE_SUBSCRIPTION\",\n} as const;\n\nexport interface ProductDetail {\n  /** The Product ID\n   */\n  id: string;\n  /** The Product Service ID\n   */\n  service_id?: number;\n  /** The Product Type\n   */\n  type: ProductDetailType;\n  /** The Product Type falvour. Not all products have flavours\n   */\n  flavour?: ProductDetailFlavour;\n  /** The name of the Product\n   */\n  name?: string;\n}\n\nexport interface ProductCoinsDetail {\n  /** The billing allowance. When you exceed this during the current billing period the *cost multiplier* will increase */\n  allowance: number;\n  /** 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 */\n  limit: number;\n  /** The total number of coins consumed (in this billing period), excluding the coins that have been consumed for the current day */\n  used: number;\n  /** 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. */\n  at_limit: boolean;\n  /** The current burn rate, the approximate amount of coins you are currently consuming each day */\n  current_burn_rate: number;\n  /** The predicted billing period amount, if costs continue at the current burn rate until the end of the billing period */\n  billing_prediction: number;\n  /** The day of the month when the bill is due, and the end of the current billing period */\n  billing_day: number;\n  /** A multiplier applied to your coin usage within your allowance */\n  allowance_multiplier: number;\n  /** A multiplier that will be applied to coin used beyond your allowance */\n  overspend_multiplier: number;\n  /** The number of days remaining, in the current billing period */\n  remaining_days: number;\n}\n\nexport interface ProductClaimDetail {\n  /** The service-specific ID that is using this Subscription\n   */\n  id: string;\n  /** A name for the service-specific ID\n   */\n  name?: string;\n}\n\nexport type ProductDmStorageDetailCoins = {\n  /** The number of coins currently committed for the current day. This is added to the accumulated coins at the start of each day */\n  used: number;\n  /** The coin cost of a 'unit' of storage or part thereof. The unit size is defined in the storage section of the response */\n  unit_cost: number;\n};\n\nexport type ProductDmStorageDetailSize = {\n  /** The humanised size of the peak storage used for the current day. The value is reset at the start of each day */\n  peak: string;\n  /** The humanised size of the current storage used for the current day and used to calculate the 'burn rate' */\n  current: string;\n  /** The humanised storage unit. The cost of storage is based on the daily peak of the number of units (or part thereof) used */\n  unit_size: string;\n  /** The peak number of storage units used today */\n  units_used: number;\n};\n\nexport interface ProductDmStorageDetail {\n  size: ProductDmStorageDetailSize;\n  coins: ProductDmStorageDetailCoins;\n}\n\nexport interface ProductDmProjectTier {\n  product: ProductDetail;\n  organisation: OrganisationDetail;\n  unit: UnitDetail;\n  storage: ProductDmStorageDetail;\n  coins: ProductCoinsDetail;\n  instance: ProductInstanceDetail;\n  claim?: ProductClaimDetail;\n}\n\nexport interface ProductDmStorage {\n  product: ProductDetail;\n  organisation: OrganisationDetail;\n  unit: UnitDetail;\n  storage: ProductDmStorageDetail;\n  coins: ProductCoinsDetail;\n}\n\nexport type AssetDetailScope =\n  typeof AssetDetailScope[keyof typeof AssetDetailScope];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const AssetDetailScope = {\n  USER: \"USER\",\n  PRODUCT: \"PRODUCT\",\n  UNIT: \"UNIT\",\n  ORGANISATION: \"ORGANISATION\",\n} as const;\n\nexport interface AssetDetail {\n  creator: string;\n  id: string;\n  name: string;\n  scope: AssetDetailScope;\n  scope_id: string;\n  secret: boolean;\n  disabled: boolean;\n  content: string;\n  created: string;\n  description?: string;\n  merchants: MerchantDetail[];\n}\n\nexport type UserAccountGetResponse = UserAccountDetail;\n\nexport interface UnitsGetResponse {\n  /** A list of Units\n   */\n  units: OrganisationUnitsGetResponse[];\n}\n\nexport type UnitGetResponse = UnitDetail;\n\nexport interface UnitProductPostResponse {\n  /** The Products's unique ID */\n  id: string;\n}\n\n/**\n * The Unit's Product\n */\nexport type ProductUnitGetResponseProduct =\n  | ProductDmStorage\n  | ProductDmProjectTier;\n\nexport interface ProductUnitGetResponse {\n  /** The Unit's Product */\n  product: ProductUnitGetResponseProduct;\n}\n\nexport interface ProductsGetTypesResponse {\n  /** All the Product Types you have access to */\n  product_types: ProductType[];\n}\n\nexport type ProductsGetResponseProductsItem =\n  | ProductDmStorage\n  | ProductDmProjectTier;\n\nexport interface ProductsGetResponse {\n  /** All the Products you have access to */\n  products: ProductsGetResponseProductsItem[];\n}\n\nexport interface OrganisationsGetResponse {\n  /** A list of Organisations */\n  organisations: OrganisationDetail[];\n}\n\nexport interface OrganisationUnitsGetResponse {\n  organisation: OrganisationDetail;\n  /** A list of Units\n   */\n  units: UnitDetail[];\n}\n\nexport interface PersonalUnitPutResponse {\n  /** The unit's Organisation. Used to identify the Default organisation */\n  organisation_id: string;\n  /** The unit's unique ID */\n  id: string;\n}\n\nexport interface OrganisationUnitPostResponse {\n  /** The unit's unique ID */\n  id: string;\n}\n\nexport interface OrganisationGetDefaultResponse {\n  /** Whether the user making the API call is a member of the Default Organisation. Only admin users are members of the Default organisation */\n  caller_is_member: boolean;\n  /** The Default Organisation ID\n   */\n  id: string;\n  /** The Default Organisation Name\n   */\n  name: string;\n  /** 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\n   */\n  private: boolean;\n}\n\nexport interface UsersGetResponse {\n  organisation?: OrganisationDetail;\n  unit?: UnitDetail;\n  /** The list of Organisation Users\n   */\n  users: UserDetail[];\n}\n\nexport interface OrganisationPostResponse {\n  /** The Organisation's unique ID */\n  id: string;\n}\n\nexport interface StateGetVersionResponse {\n  /** The Account Server version. This is guaranteed to be a valid semantic version for official (tagged) images. The version value format for unofficial images is a string but otherwise undefined\n   */\n  version: string;\n}\n\nexport interface AssetPostResponse {\n  /** The Asset ID\n   */\n  id: string;\n}\n\nexport interface AssetGetResponse {\n  /** A list of Assets\n   */\n  assets: AssetDetail[];\n}\n\nexport interface AsError {\n  /** Brief error text that can be presented to the user */\n  error: string;\n}\n"]}

package/index.d.ts

@@ -1,2 +1,2 @@
-export { Q as AXIOS_INSTANCE, N as AsError, W as ErrorType, i as OrganisationDetail, J as OrganisationGetDefaultResponse, c as OrganisationPostBodyBody, L as OrganisationPostResponse, O as OrganisationUnitPostBodyBody, I as OrganisationUnitPostResponse, F as OrganisationUnitsGetResponse, E as OrganisationsGetResponse, H as PersonalUnitPutResponse, q as ProductClaimDetail, p as ProductCoinsDetail, o as ProductDetail, m as ProductDetailFlavour, n as ProductDetailType, u as ProductDmProjectTier, v as ProductDmStorage, t as ProductDmStorageDetail, r as ProductDmStorageDetailCoins, s as ProductDmStorageDetailSize, l as ProductInstanceDetail, k as ProductInstanceDetailCoins, P as ProductPatchBodyBody, j as ProductType, A as ProductUnitGetResponse, z as ProductUnitGetResponseProduct, D as ProductsGetResponse, C as ProductsGetResponseProductsItem, B as ProductsGetTypesResponse, g as ServiceGetResponse, S as ServiceGetResponseKind, h as ServicesGetResponse, M as StateGetVersionResponse, f as UnitDetail, x as UnitGetResponse, b as UnitProductPostBodyBody, U as UnitProductPostBodyBodyFlavour, a as UnitProductPostBodyBodyType, y as UnitProductPostResponse, G as UnitsGetResponse, e as UserAccountDetail, w as UserAccountGetResponse, d as UserDetail, K as UsersGetResponse, V as customInstance, R as setAuthToken, T as setBaseUrl } from './custom-instance-13412a15.js';
+export { a6 as AXIOS_INSTANCE, a5 as AsError, I as AssetDetail, H as AssetDetailScope, a4 as AssetGetResponse, i as AssetPostBodyBody, h as AssetPostBodyBodyScope, a3 as AssetPostResponse, A as AttachAssetParams, D as DetachAssetParams, aa as ErrorType, G as GetAssetParams, m as MerchantDetail, M as MerchantDetailKind, n as MerchantGetResponse, o as MerchantsGetResponse, p as OrganisationDetail, $ as OrganisationGetDefaultResponse, g as OrganisationPostBodyBody, a1 as OrganisationPostResponse, O as OrganisationUnitPostBodyBody, _ as OrganisationUnitPostResponse, Y as OrganisationUnitsGetResponse, X as OrganisationsGetResponse, Z as PersonalUnitPutResponse, y as ProductClaimDetail, x as ProductCoinsDetail, w as ProductDetail, u as ProductDetailFlavour, v as ProductDetailType, E as ProductDmProjectTier, F as ProductDmStorage, C as ProductDmStorageDetail, z as ProductDmStorageDetailCoins, B as ProductDmStorageDetailSize, t as ProductInstanceDetail, s as ProductInstanceDetailCoins, P as ProductPatchBodyBody, r as ProductType, q as ProductTypeServiceKind, S as ProductUnitGetResponse, R as ProductUnitGetResponseProduct, W as ProductsGetResponse, V as ProductsGetResponseProductsItem, T as ProductsGetTypesResponse, c as QMIdParameter, d as QOrgIdParameter, a as QProductIdParameter, b as QUnitIdParameter, Q as QUserIdParameter, a2 as StateGetVersionResponse, l as UnitDetail, L as UnitGetResponse, f as UnitProductPostBodyBody, U as UnitProductPostBodyBodyFlavour, e as UnitProductPostBodyBodyType, N as UnitProductPostResponse, K as UnitsGetResponse, k as UserAccountDetail, J as UserAccountGetResponse, j as UserDetail, a0 as UsersGetResponse, a9 as customInstance, a7 as setAuthToken, a8 as setBaseUrl } from './custom-instance-b985e1be.js';
 import 'axios';

package/index.js

@@ -16,7 +16,16 @@ var UnitProductPostBodyBodyType = {
   DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION",
   DATA_MANAGER_STORAGE_SUBSCRIPTION: "DATA_MANAGER_STORAGE_SUBSCRIPTION"
 };
-var ServiceGetResponseKind = {
+var AssetPostBodyBodyScope = {
+  USER: "USER",
+  PRODUCT: "PRODUCT",
+  UNIT: "UNIT",
+  ORGANISATION: "ORGANISATION"
+};
+var MerchantDetailKind = {
+  DATA_MANAGER: "DATA_MANAGER"
+};
+var ProductTypeServiceKind = {
   DATA_MANAGER: "DATA_MANAGER"
 };
 var ProductDetailFlavour = {
@@ -29,11 +38,20 @@ var ProductDetailType = {
   DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION",
   DATA_MANAGER_STORAGE_SUBSCRIPTION: "DATA_MANAGER_STORAGE_SUBSCRIPTION"
 };
+var AssetDetailScope = {
+  USER: "USER",
+  PRODUCT: "PRODUCT",
+  UNIT: "UNIT",
+  ORGANISATION: "ORGANISATION"
+};
 export {
   AXIOS_INSTANCE,
+  AssetDetailScope,
+  AssetPostBodyBodyScope,
+  MerchantDetailKind,
   ProductDetailFlavour,
   ProductDetailType,
-  ServiceGetResponseKind,
+  ProductTypeServiceKind,
   UnitProductPostBodyBodyFlavour,
   UnitProductPostBodyBodyType,
   customInstance,

package/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/account-server-api.schemas.ts"],"sourcesContent":["/**\n * Generated by orval v6.7.1 🍺\n * Do not edit manually.\n * Account Server API\n * The Informatics Matters Account Server API.\n\nA service that provides access to the Account Server, which gives *registered* users access to and management of **Products**, **Organisations**, **Units** and **Users**.\n\n * OpenAPI spec version: 0.1\n */\nexport type ProductPatchBodyBody = {\n  /** The name you want to give the Product */\n  name?: string;\n  /** The Product's built-in coin allowance. Product allowances cannot be reduced */\n  allowance?: number;\n  /** The Product's built-in coin limit. If set it must not be less than the allowance. If not set the allowance is used. The existing product limit cannot be reduced */\n  limit?: number;\n};\n\n/**\n * The Flavour of the Product. Used only for Project Tier Products. Do not set this for Storage products\n */\nexport type UnitProductPostBodyBodyFlavour =\n  | \"EVALUATION\"\n  | \"BRONZE\"\n  | \"SILVER\"\n  | \"GOLD\";\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const UnitProductPostBodyBodyFlavour = {\n  EVALUATION: \"EVALUATION\" as UnitProductPostBodyBodyFlavour,\n  BRONZE: \"BRONZE\" as UnitProductPostBodyBodyFlavour,\n  SILVER: \"SILVER\" as UnitProductPostBodyBodyFlavour,\n  GOLD: \"GOLD\" as UnitProductPostBodyBodyFlavour,\n};\n\n/**\n * The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be provided.\n\nProject Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products\n */\nexport type UnitProductPostBodyBodyType =\n  | \"DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION\"\n  | \"DATA_MANAGER_STORAGE_SUBSCRIPTION\";\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const UnitProductPostBodyBodyType = {\n  DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION:\n    \"DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION\" as UnitProductPostBodyBodyType,\n  DATA_MANAGER_STORAGE_SUBSCRIPTION:\n    \"DATA_MANAGER_STORAGE_SUBSCRIPTION\" as UnitProductPostBodyBodyType,\n};\n\nexport type UnitProductPostBodyBody = {\n  /** The name you want to give the Product */\n  name: string;\n  /** The service identity for the Product. Products are created for use on a specific service, like a Data Manager instance */\n  service_id: number;\n  /** The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be provided.\n\nProject Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products */\n  type: UnitProductPostBodyBodyType;\n  /** The Flavour of the Product. Used only for Project Tier Products. Do not set this for Storage products */\n  flavour?: UnitProductPostBodyBodyFlavour;\n  /** The Product's coin allowance. You must provide this for Storage products but you must not provide a value for Project Tier Products */\n  allowance?: number;\n  /** 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 */\n  limit?: number;\n  /** The day you would like to be billed for the Product's subscription (a value from 1 and 28) */\n  billing_day: number;\n};\n\nexport type OrganisationUnitPostBodyBody = {\n  /** The name of the unit */\n  name: string;\n};\n\nexport type OrganisationPostBodyBody = {\n  /** The name of the organisation */\n  name: string;\n  /** The name of the organisation owner. A user ID */\n  owner: string;\n};\n\nexport interface UserDetail {\n  /** The user identity (username) */\n  id: string;\n}\n\nexport interface UserAccountDetail {\n  user: UserDetail;\n  /** Whether the caller has admin privilege */\n  caller_has_admin_privilege: boolean;\n}\n\nexport interface UnitDetail {\n  /** Whether the user making the API call is a member of the Unit */\n  caller_is_member: boolean;\n  /** The Unit's unique identity */\n  id: string;\n  /** The Unit's name */\n  name: string;\n  /** The Unit's owner (a username) */\n  owner_id: string;\n  /** True if the Unit is private */\n  private: boolean;\n}\n\n/**\n * The kind of Service\n */\nexport type ServiceGetResponseKind = \"DATA_MANAGER\";\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const ServiceGetResponseKind = {\n  DATA_MANAGER: \"DATA_MANAGER\" as ServiceGetResponseKind,\n};\n\nexport interface ServiceGetResponse {\n  /** The unique ID of the Service */\n  id: number;\n  /** The kind of Service */\n  kind: ServiceGetResponseKind;\n  /** The name assigned to the Service */\n  name?: string;\n}\n\nexport interface ServicesGetResponse {\n  /** The list of known Services\n   */\n  services: ServiceGetResponse[];\n}\n\nexport interface OrganisationDetail {\n  /** Whether the user making the API call is a member of the Unit */\n  caller_is_member: boolean;\n  /** The Organisation's unique ID */\n  id: string;\n  /** The Organisation's name */\n  name: string;\n  /** The username of the Organisation's owner. Not all Organisations have an owner. The Default Organisation has no owner. */\n  owner_id?: string;\n  /** True if the Unit is private */\n  private: boolean;\n}\n\nexport interface ProductType {\n  /** A product type, this is a unique string amongst all types known to the Account Server */\n  type: string;\n  /** A product flavour. Not all types have a flavour, those that do have a type-specific flavour string */\n  flavour?: string;\n  /** For a product that belongs to a specific service, the service that owns it is provided */\n  service?: ServiceGetResponse;\n}\n\nexport type ProductInstanceDetailCoins = {\n  /** The number of coins used\n   */\n  used: number;\n};\n\nexport interface ProductInstanceDetail {\n  coins: ProductInstanceDetailCoins;\n}\n\n/**\n * The Product Type falvour. Not all products have flavours\n\n */\nexport type ProductDetailFlavour = \"EVALUATION\" | \"BRONZE\" | \"SILVER\" | \"GOLD\";\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const ProductDetailFlavour = {\n  EVALUATION: \"EVALUATION\" as ProductDetailFlavour,\n  BRONZE: \"BRONZE\" as ProductDetailFlavour,\n  SILVER: \"SILVER\" as ProductDetailFlavour,\n  GOLD: \"GOLD\" as ProductDetailFlavour,\n};\n\n/**\n * The Product Type\n\n */\nexport type ProductDetailType =\n  | \"DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION\"\n  | \"DATA_MANAGER_STORAGE_SUBSCRIPTION\";\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const ProductDetailType = {\n  DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION:\n    \"DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION\" as ProductDetailType,\n  DATA_MANAGER_STORAGE_SUBSCRIPTION:\n    \"DATA_MANAGER_STORAGE_SUBSCRIPTION\" as ProductDetailType,\n};\n\nexport interface ProductDetail {\n  /** The Product ID\n   */\n  id: string;\n  /** The Product Service ID\n   */\n  service_id?: number;\n  /** The Product Type\n   */\n  type: ProductDetailType;\n  /** The Product Type falvour. Not all products have flavours\n   */\n  flavour?: ProductDetailFlavour;\n  /** The name of the Product\n   */\n  name?: string;\n}\n\nexport interface ProductCoinsDetail {\n  /** The billing allowance. When you exceed this during the current billing period the *cost multiplier* will increase */\n  allowance: number;\n  /** 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 */\n  limit: number;\n  /** The total number of coins consumed (in this billing period), excluding the coins that have been consumed for the current day */\n  used: number;\n  /** 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. */\n  at_limit: boolean;\n  /** The current burn rate, the approximate amount of coins you are currently consuming each day */\n  current_burn_rate: number;\n  /** The predicted billing period amount, if costs continue at the current burn rate until the end of the billing period */\n  billing_prediction: number;\n  /** The day of the month when the bill is due, and the end of the current billing period */\n  billing_day: number;\n  /** A multiplier applied to your coin usage within your allowance */\n  allowance_multiplier: number;\n  /** A multiplier that will be applied to coin used beyond your allowance */\n  overspend_multiplier: number;\n  /** The number of days remaining, in the current billing period */\n  remaining_days: number;\n}\n\nexport interface ProductClaimDetail {\n  /** The service-specific ID that is using this Subscription\n   */\n  id: string;\n  /** A name for the service-specific ID\n   */\n  name?: string;\n}\n\nexport type ProductDmStorageDetailCoins = {\n  /** The number of coins currently committed for the current day. This is added to the accumulated coins at the start of each day */\n  used: number;\n  /** The coin cost of a 'unit' of storage or part thereof. The unit size is defined in the storage section of the response */\n  unit_cost: number;\n};\n\nexport type ProductDmStorageDetailSize = {\n  /** The humanised size of the peak storage used for the current day. The value is reset at the start of each day */\n  peak: string;\n  /** The humanised size of the current storage used for the current day and used to calculate the 'burn rate' */\n  current: string;\n  /** The humanised storage unit. The cost of storage is based on the daily peak of the number of units (or part thereof) used */\n  unit_size: string;\n  /** The peak number of storage units used today */\n  units_used: number;\n};\n\nexport interface ProductDmStorageDetail {\n  size: ProductDmStorageDetailSize;\n  coins: ProductDmStorageDetailCoins;\n}\n\nexport interface ProductDmProjectTier {\n  product: ProductDetail;\n  organisation: OrganisationDetail;\n  unit: UnitDetail;\n  storage: ProductDmStorageDetail;\n  coins: ProductCoinsDetail;\n  instance: ProductInstanceDetail;\n  claim?: ProductClaimDetail;\n}\n\nexport interface ProductDmStorage {\n  product: ProductDetail;\n  organisation: OrganisationDetail;\n  unit: UnitDetail;\n  storage: ProductDmStorageDetail;\n  coins: ProductCoinsDetail;\n}\n\nexport type UserAccountGetResponse = UserAccountDetail;\n\nexport interface UnitGetResponse {\n  /** The Unit's unique ID */\n  id: string;\n  /** The Unit's name */\n  name: string;\n  /** The Unit's oener (username) */\n  owner_id: string;\n}\n\nexport interface UnitProductPostResponse {\n  /** The Products's unique ID */\n  id: string;\n}\n\n/**\n * The Unit's Product\n */\nexport type ProductUnitGetResponseProduct =\n  | ProductDmStorage\n  | ProductDmProjectTier;\n\nexport interface ProductUnitGetResponse {\n  /** The Unit's Product */\n  product: ProductUnitGetResponseProduct;\n}\n\nexport interface ProductsGetTypesResponse {\n  /** All the Product Types you have access to */\n  product_types: ProductType[];\n}\n\nexport type ProductsGetResponseProductsItem =\n  | ProductDmStorage\n  | ProductDmProjectTier;\n\nexport interface ProductsGetResponse {\n  /** All the Products you have access to */\n  products: ProductsGetResponseProductsItem[];\n}\n\nexport interface OrganisationsGetResponse {\n  /** A list of Organisations */\n  organisations: OrganisationDetail[];\n}\n\nexport interface OrganisationUnitsGetResponse {\n  organisation: OrganisationDetail;\n  /** A list of Units\n   */\n  units: UnitDetail[];\n}\n\nexport interface UnitsGetResponse {\n  /** A list of Units\n   */\n  units: OrganisationUnitsGetResponse[];\n}\n\nexport interface PersonalUnitPutResponse {\n  /** The unit's Organisation. Used to identify the Default organisation */\n  organisation_id: string;\n  /** The unit's unique ID */\n  id: string;\n}\n\nexport interface OrganisationUnitPostResponse {\n  /** The unit's unique ID */\n  id: string;\n}\n\nexport interface OrganisationGetDefaultResponse {\n  /** Whether the user making the API call is a member of the Default Organisation. Only admin users are members of the Default organisation */\n  caller_is_member: boolean;\n  /** The Default Organisation ID\n   */\n  id: string;\n  /** The Default Organisation Name\n   */\n  name: string;\n  /** 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\n   */\n  private: boolean;\n}\n\nexport interface UsersGetResponse {\n  organisation?: OrganisationDetail;\n  unit?: UnitDetail;\n  /** The list of Organisation Users\n   */\n  users: UserDetail[];\n}\n\nexport interface OrganisationPostResponse {\n  /** The Organisation's unique ID */\n  id: string;\n}\n\nexport interface StateGetVersionResponse {\n  /** The Account Server version. This is guaranteed to be a valid semantic version for official (tagged) images. The version value format for unofficial images is a string but otherwise undefined\n   */\n  version: string;\n}\n\nexport interface AsError {\n  /** Brief error text that can be presented to the user */\n  error: string;\n}\n"],"mappings":";;;;;;;;AA6BO,IAAM,iCAAiC;AAAA,EAC5C,YAAY;AAAA,EACZ,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,MAAM;AACR;AAYO,IAAM,8BAA8B;AAAA,EACzC,wCACE;AAAA,EACF,mCACE;AACJ;AA+DO,IAAM,yBAAyB;AAAA,EACpC,cAAc;AAChB;AAwDO,IAAM,uBAAuB;AAAA,EAClC,YAAY;AAAA,EACZ,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,MAAM;AACR;AAWO,IAAM,oBAAoB;AAAA,EAC/B,wCACE;AAAA,EACF,mCACE;AACJ;","names":[]}
+{"version":3,"sources":["../src/account-server-api.schemas.ts"],"sourcesContent":["/**\n * Generated by orval v6.8.0 🍺\n * Do not edit manually.\n * Account Server API\n * The Informatics Matters Account Server API.\n\nA service that provides access to the Account Server, which gives *registered* users access to and management of **Products**, **Organisations**, **Units** and **Users**.\n\n * OpenAPI spec version: 0.1\n */\nexport type DetachAssetParams = { m_id?: QMIdParameter };\n\nexport type AttachAssetParams = { m_id?: QMIdParameter };\n\n/**\n * A User Identity\n */\nexport type QUserIdParameter = string;\n\n/**\n * A Product Identity\n */\nexport type QProductIdParameter = string;\n\n/**\n * A Unit Identity\n */\nexport type QUnitIdParameter = string;\n\nexport type GetAssetParams = {\n  user_id?: QUserIdParameter;\n  product_id?: QProductIdParameter;\n  unit_id?: QUnitIdParameter;\n  org_id?: QOrgIdParameter;\n};\n\n/**\n * A Merchant Identity\n */\nexport type QMIdParameter = number;\n\n/**\n * An Organisation Identity\n */\nexport type QOrgIdParameter = string;\n\nexport type ProductPatchBodyBody = {\n  /** The name you want to give the Product */\n  name?: string;\n  /** The Product's built-in coin allowance. Product allowances cannot be reduced */\n  allowance?: number;\n  /** The Product's built-in coin limit. If set it must not be less than the allowance. If not set the allowance is used. The existing product limit cannot be reduced */\n  limit?: number;\n};\n\n/**\n * The Flavour of the Product. Used only for Project Tier Products. Do not set this for Storage products\n */\nexport type UnitProductPostBodyBodyFlavour =\n  typeof UnitProductPostBodyBodyFlavour[keyof typeof UnitProductPostBodyBodyFlavour];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const UnitProductPostBodyBodyFlavour = {\n  EVALUATION: \"EVALUATION\",\n  BRONZE: \"BRONZE\",\n  SILVER: \"SILVER\",\n  GOLD: \"GOLD\",\n} as const;\n\n/**\n * The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be provided.\n\nProject Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products\n */\nexport type UnitProductPostBodyBodyType =\n  typeof UnitProductPostBodyBodyType[keyof typeof UnitProductPostBodyBodyType];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const UnitProductPostBodyBodyType = {\n  DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION:\n    \"DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION\",\n  DATA_MANAGER_STORAGE_SUBSCRIPTION: \"DATA_MANAGER_STORAGE_SUBSCRIPTION\",\n} as const;\n\nexport type UnitProductPostBodyBody = {\n  /** The name you want to give the Product */\n  name: string;\n  /** The service identity for the Product. Products are created for use on a specific service, like a Data Manager instance */\n  service_id: number;\n  /** The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be provided.\n\nProject Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products */\n  type: UnitProductPostBodyBodyType;\n  /** The Flavour of the Product. Used only for Project Tier Products. Do not set this for Storage products */\n  flavour?: UnitProductPostBodyBodyFlavour;\n  /** The Product's coin allowance. You must provide this for Storage products but you must not provide a value for Project Tier Products */\n  allowance?: number;\n  /** 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 */\n  limit?: number;\n  /** The day you would like to be billed for the Product's subscription (a value from 1 and 28) */\n  billing_day: number;\n};\n\nexport type OrganisationUnitPostBodyBody = {\n  /** The name of the unit */\n  name: string;\n};\n\nexport type OrganisationPostBodyBody = {\n  /** The name of the organisation */\n  name: string;\n  /** The name of the organisation owner. A user ID */\n  owner: string;\n};\n\nexport type AssetPostBodyBodyScope =\n  typeof AssetPostBodyBodyScope[keyof typeof AssetPostBodyBodyScope];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const AssetPostBodyBodyScope = {\n  USER: \"USER\",\n  PRODUCT: \"PRODUCT\",\n  UNIT: \"UNIT\",\n  ORGANISATION: \"ORGANISATION\",\n} as const;\n\nexport type AssetPostBodyBody = {\n  /** 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 */\n  name: string;\n  /** A file containing the content for the asset. You must provide a value here or in content_string */\n  content_file?: Blob;\n  /** The textual content of the asset. You must provide a value here or in content_file */\n  content_string?: string;\n  scope: AssetPostBodyBodyScope;\n  /** The unique identity based on the Scope of the asset. For example, this wil be the Unit ID if it's a UNIT. A scope_id is required if the scope is USER as it wil be automatically set to your username */\n  scope_id?: string;\n  /** Is this a secret asset? */\n  secret: boolean;\n  /** An optional description for the Asset */\n  description?: string;\n};\n\nexport interface UserDetail {\n  /** The user identity (username) */\n  id: string;\n}\n\nexport interface UserAccountDetail {\n  user: UserDetail;\n  /** Whether the caller has admin privilege */\n  caller_has_admin_privilege: boolean;\n}\n\nexport interface UnitDetail {\n  /** Whether the user making the API call is a member of the Unit */\n  caller_is_member: boolean;\n  /** The Unit's unique identity */\n  id: string;\n  /** The Unit's name */\n  name: string;\n  /** The Unit's owner (a username) */\n  owner_id: string;\n  /** True if the Unit is private */\n  private: boolean;\n}\n\n/**\n * The kind of Service\n */\nexport type MerchantDetailKind =\n  typeof MerchantDetailKind[keyof typeof MerchantDetailKind];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const MerchantDetailKind = {\n  DATA_MANAGER: \"DATA_MANAGER\",\n} as const;\n\nexport interface MerchantDetail {\n  /** The unique ID of the Service */\n  id: number;\n  /** The kind of Service */\n  kind: MerchantDetailKind;\n  /** The name assigned to the Service */\n  name: string;\n  /** The hostname used by the Service */\n  api_hostname: string;\n}\n\nexport type MerchantGetResponse = MerchantDetail;\n\nexport interface MerchantsGetResponse {\n  /** The list of known Merchants\n   */\n  merchants: MerchantDetail[];\n}\n\nexport interface OrganisationDetail {\n  /** Whether the user making the API call is a member of the Unit */\n  caller_is_member: boolean;\n  /** The Organisation's unique ID */\n  id: string;\n  /** The Organisation's name */\n  name: string;\n  /** The username of the Organisation's owner. Not all Organisations have an owner. The Default Organisation has no owner. */\n  owner_id?: string;\n  /** True if the Unit is private */\n  private: boolean;\n}\n\n/**\n * The kind of service that can use the Product\n */\nexport type ProductTypeServiceKind =\n  typeof ProductTypeServiceKind[keyof typeof ProductTypeServiceKind];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const ProductTypeServiceKind = {\n  DATA_MANAGER: \"DATA_MANAGER\",\n} as const;\n\nexport interface ProductType {\n  /** A product type, this is a unique string amongst all types known to the Account Server */\n  type: string;\n  /** A product flavour. Not all types have a flavour, those that do have a type-specific flavour string */\n  flavour?: string;\n  /** The kind of service that can use the Product */\n  service_kind?: ProductTypeServiceKind;\n}\n\nexport type ProductInstanceDetailCoins = {\n  /** The number of coins used\n   */\n  used: number;\n};\n\nexport interface ProductInstanceDetail {\n  coins: ProductInstanceDetailCoins;\n}\n\n/**\n * The Product Type falvour. Not all products have flavours\n\n */\nexport type ProductDetailFlavour =\n  typeof ProductDetailFlavour[keyof typeof ProductDetailFlavour];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const ProductDetailFlavour = {\n  EVALUATION: \"EVALUATION\",\n  BRONZE: \"BRONZE\",\n  SILVER: \"SILVER\",\n  GOLD: \"GOLD\",\n} as const;\n\n/**\n * The Product Type\n\n */\nexport type ProductDetailType =\n  typeof ProductDetailType[keyof typeof ProductDetailType];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const ProductDetailType = {\n  DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION:\n    \"DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION\",\n  DATA_MANAGER_STORAGE_SUBSCRIPTION: \"DATA_MANAGER_STORAGE_SUBSCRIPTION\",\n} as const;\n\nexport interface ProductDetail {\n  /** The Product ID\n   */\n  id: string;\n  /** The Product Service ID\n   */\n  service_id?: number;\n  /** The Product Type\n   */\n  type: ProductDetailType;\n  /** The Product Type falvour. Not all products have flavours\n   */\n  flavour?: ProductDetailFlavour;\n  /** The name of the Product\n   */\n  name?: string;\n}\n\nexport interface ProductCoinsDetail {\n  /** The billing allowance. When you exceed this during the current billing period the *cost multiplier* will increase */\n  allowance: number;\n  /** 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 */\n  limit: number;\n  /** The total number of coins consumed (in this billing period), excluding the coins that have been consumed for the current day */\n  used: number;\n  /** 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. */\n  at_limit: boolean;\n  /** The current burn rate, the approximate amount of coins you are currently consuming each day */\n  current_burn_rate: number;\n  /** The predicted billing period amount, if costs continue at the current burn rate until the end of the billing period */\n  billing_prediction: number;\n  /** The day of the month when the bill is due, and the end of the current billing period */\n  billing_day: number;\n  /** A multiplier applied to your coin usage within your allowance */\n  allowance_multiplier: number;\n  /** A multiplier that will be applied to coin used beyond your allowance */\n  overspend_multiplier: number;\n  /** The number of days remaining, in the current billing period */\n  remaining_days: number;\n}\n\nexport interface ProductClaimDetail {\n  /** The service-specific ID that is using this Subscription\n   */\n  id: string;\n  /** A name for the service-specific ID\n   */\n  name?: string;\n}\n\nexport type ProductDmStorageDetailCoins = {\n  /** The number of coins currently committed for the current day. This is added to the accumulated coins at the start of each day */\n  used: number;\n  /** The coin cost of a 'unit' of storage or part thereof. The unit size is defined in the storage section of the response */\n  unit_cost: number;\n};\n\nexport type ProductDmStorageDetailSize = {\n  /** The humanised size of the peak storage used for the current day. The value is reset at the start of each day */\n  peak: string;\n  /** The humanised size of the current storage used for the current day and used to calculate the 'burn rate' */\n  current: string;\n  /** The humanised storage unit. The cost of storage is based on the daily peak of the number of units (or part thereof) used */\n  unit_size: string;\n  /** The peak number of storage units used today */\n  units_used: number;\n};\n\nexport interface ProductDmStorageDetail {\n  size: ProductDmStorageDetailSize;\n  coins: ProductDmStorageDetailCoins;\n}\n\nexport interface ProductDmProjectTier {\n  product: ProductDetail;\n  organisation: OrganisationDetail;\n  unit: UnitDetail;\n  storage: ProductDmStorageDetail;\n  coins: ProductCoinsDetail;\n  instance: ProductInstanceDetail;\n  claim?: ProductClaimDetail;\n}\n\nexport interface ProductDmStorage {\n  product: ProductDetail;\n  organisation: OrganisationDetail;\n  unit: UnitDetail;\n  storage: ProductDmStorageDetail;\n  coins: ProductCoinsDetail;\n}\n\nexport type AssetDetailScope =\n  typeof AssetDetailScope[keyof typeof AssetDetailScope];\n\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport const AssetDetailScope = {\n  USER: \"USER\",\n  PRODUCT: \"PRODUCT\",\n  UNIT: \"UNIT\",\n  ORGANISATION: \"ORGANISATION\",\n} as const;\n\nexport interface AssetDetail {\n  creator: string;\n  id: string;\n  name: string;\n  scope: AssetDetailScope;\n  scope_id: string;\n  secret: boolean;\n  disabled: boolean;\n  content: string;\n  created: string;\n  description?: string;\n  merchants: MerchantDetail[];\n}\n\nexport type UserAccountGetResponse = UserAccountDetail;\n\nexport interface UnitsGetResponse {\n  /** A list of Units\n   */\n  units: OrganisationUnitsGetResponse[];\n}\n\nexport type UnitGetResponse = UnitDetail;\n\nexport interface UnitProductPostResponse {\n  /** The Products's unique ID */\n  id: string;\n}\n\n/**\n * The Unit's Product\n */\nexport type ProductUnitGetResponseProduct =\n  | ProductDmStorage\n  | ProductDmProjectTier;\n\nexport interface ProductUnitGetResponse {\n  /** The Unit's Product */\n  product: ProductUnitGetResponseProduct;\n}\n\nexport interface ProductsGetTypesResponse {\n  /** All the Product Types you have access to */\n  product_types: ProductType[];\n}\n\nexport type ProductsGetResponseProductsItem =\n  | ProductDmStorage\n  | ProductDmProjectTier;\n\nexport interface ProductsGetResponse {\n  /** All the Products you have access to */\n  products: ProductsGetResponseProductsItem[];\n}\n\nexport interface OrganisationsGetResponse {\n  /** A list of Organisations */\n  organisations: OrganisationDetail[];\n}\n\nexport interface OrganisationUnitsGetResponse {\n  organisation: OrganisationDetail;\n  /** A list of Units\n   */\n  units: UnitDetail[];\n}\n\nexport interface PersonalUnitPutResponse {\n  /** The unit's Organisation. Used to identify the Default organisation */\n  organisation_id: string;\n  /** The unit's unique ID */\n  id: string;\n}\n\nexport interface OrganisationUnitPostResponse {\n  /** The unit's unique ID */\n  id: string;\n}\n\nexport interface OrganisationGetDefaultResponse {\n  /** Whether the user making the API call is a member of the Default Organisation. Only admin users are members of the Default organisation */\n  caller_is_member: boolean;\n  /** The Default Organisation ID\n   */\n  id: string;\n  /** The Default Organisation Name\n   */\n  name: string;\n  /** 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\n   */\n  private: boolean;\n}\n\nexport interface UsersGetResponse {\n  organisation?: OrganisationDetail;\n  unit?: UnitDetail;\n  /** The list of Organisation Users\n   */\n  users: UserDetail[];\n}\n\nexport interface OrganisationPostResponse {\n  /** The Organisation's unique ID */\n  id: string;\n}\n\nexport interface StateGetVersionResponse {\n  /** The Account Server version. This is guaranteed to be a valid semantic version for official (tagged) images. The version value format for unofficial images is a string but otherwise undefined\n   */\n  version: string;\n}\n\nexport interface AssetPostResponse {\n  /** The Asset ID\n   */\n  id: string;\n}\n\nexport interface AssetGetResponse {\n  /** A list of Assets\n   */\n  assets: AssetDetail[];\n}\n\nexport interface AsError {\n  /** Brief error text that can be presented to the user */\n  error: string;\n}\n"],"mappings":";;;;;;;;AA8DO,IAAM,iCAAiC;AAAA,EAC5C,YAAY;AAAA,EACZ,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,MAAM;AACR;AAWO,IAAM,8BAA8B;AAAA,EACzC,wCACE;AAAA,EACF,mCAAmC;AACrC;AAqCO,IAAM,yBAAyB;AAAA,EACpC,MAAM;AAAA,EACN,SAAS;AAAA,EACT,MAAM;AAAA,EACN,cAAc;AAChB;AAiDO,IAAM,qBAAqB;AAAA,EAChC,cAAc;AAChB;AAyCO,IAAM,yBAAyB;AAAA,EACpC,cAAc;AAChB;AA6BO,IAAM,uBAAuB;AAAA,EAClC,YAAY;AAAA,EACZ,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,MAAM;AACR;AAUO,IAAM,oBAAoB;AAAA,EAC/B,wCACE;AAAA,EACF,mCAAmC;AACrC;AAiGO,IAAM,mBAAmB;AAAA,EAC9B,MAAM;AAAA,EACN,SAAS;AAAA,EACT,MAAM;AAAA,EACN,cAAc;AAChB;","names":[]}

package/merchant/merchant.cjs

@@ -0,0 +1,48 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }
+
+
+var _chunkNGBTCJWScjs = require('../chunk-NGBTCJWS.cjs');
+
+// src/merchant/merchant.ts
+
+
+var _reactquery = require('react-query');
+var getMerchants = (options, signal) => {
+  return _chunkNGBTCJWScjs.customInstance.call(void 0, { url: `/merchant`, method: "get", signal }, options);
+};
+var getGetMerchantsQueryKey = () => [`/merchant`];
+var useGetMerchants = (options) => {
+  const { query: queryOptions, request: requestOptions } = _nullishCoalesce(options, () => ( {}));
+  const queryKey = _nullishCoalesce((queryOptions == null ? void 0 : queryOptions.queryKey), () => ( getGetMerchantsQueryKey()));
+  const queryFn = ({
+    signal
+  }) => getMerchants(requestOptions, signal);
+  const query = _reactquery.useQuery.call(void 0, queryKey, queryFn, queryOptions);
+  return _chunkNGBTCJWScjs.__spreadValues.call(void 0, {
+    queryKey
+  }, query);
+};
+var getService = (mId, options, signal) => {
+  return _chunkNGBTCJWScjs.customInstance.call(void 0, { url: `/merchant/${mId}`, method: "get", signal }, options);
+};
+var getGetServiceQueryKey = (mId) => [`/merchant/${mId}`];
+var useGetService = (mId, options) => {
+  const { query: queryOptions, request: requestOptions } = _nullishCoalesce(options, () => ( {}));
+  const queryKey = _nullishCoalesce((queryOptions == null ? void 0 : queryOptions.queryKey), () => ( getGetServiceQueryKey(mId)));
+  const queryFn = ({
+    signal
+  }) => getService(mId, requestOptions, signal);
+  const query = _reactquery.useQuery.call(void 0, queryKey, queryFn, _chunkNGBTCJWScjs.__spreadValues.call(void 0, { enabled: !!mId }, queryOptions));
+  return _chunkNGBTCJWScjs.__spreadValues.call(void 0, {
+    queryKey
+  }, query);
+};
+
+
+
+
+
+
+
+exports.getGetMerchantsQueryKey = getGetMerchantsQueryKey; exports.getGetServiceQueryKey = getGetServiceQueryKey; exports.getMerchants = getMerchants; exports.getService = getService; exports.useGetMerchants = useGetMerchants; exports.useGetService = useGetService;
+//# sourceMappingURL=merchant.cjs.map

package/merchant/merchant.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/merchant/merchant.ts"],"names":[],"mappings":";;;;;;AAUA;AAAA;AAAA;AA+BO,IAAM,eAAe,CAC1B,SACA,WACG;AACH,SAAO,eACL,EAAE,KAAK,aAAa,QAAQ,OAAO,OAAO,GAC1C,OACF;AACF;AAEO,IAAM,0BAA0B,MAAM,CAAC,WAAW;AAOlD,IAAM,kBAAkB,CAG7B,YAO4D;AAC5D,QAAM,EAAE,OAAO,cAAc,SAAS,mBAAmB,WAAW,CAAC;AAErE,QAAM,WAAW,8CAAc,aAAY,wBAAwB;AAEnE,QAAM,UAAmE,CAAC;AAAA,IACxE;AAAA,QACI,aAAa,gBAAgB,MAAM;AAEzC,QAAM,QAAQ,SAIZ,UAAU,SAAS,YAAY;AAEjC,SAAO;AAAA,IACL;AAAA,KACG;AAEP;AAOO,IAAM,aAAa,CACxB,KACA,SACA,WACG;AACH,SAAO,eACL,EAAE,KAAK,aAAa,OAAO,QAAQ,OAAO,OAAO,GACjD,OACF;AACF;AAEO,IAAM,wBAAwB,CAAC,QAAgB,CAAC,aAAa,KAAK;AAOlE,IAAM,gBAAgB,CAI3B,KACA,YAQ2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,mBAAmB,WAAW,CAAC;AAErE,QAAM,WAAW,8CAAc,aAAY,sBAAsB,GAAG;AAEpE,QAAM,UAAiE,CAAC;AAAA,IACtE;AAAA,QACI,WAAW,KAAK,gBAAgB,MAAM;AAE5C,QAAM,QAAQ,SACZ,UACA,SACA,iBAAE,SAAS,CAAC,CAAC,OAAQ,aACvB;AAEA,SAAO;AAAA,IACL;AAAA,KACG;AAEP","sourcesContent":["/**\n * Generated by orval v6.8.0 🍺\n * Do not edit manually.\n * Account Server API\n * The Informatics Matters Account Server API.\n\nA service that provides access to the Account Server, which gives *registered* users access to and management of **Products**, **Organisations**, **Units** and **Users**.\n\n * OpenAPI spec version: 0.1\n */\nimport {\n  useQuery,\n  UseQueryOptions,\n  QueryFunction,\n  UseQueryResult,\n  QueryKey,\n} from \"react-query\";\nimport type {\n  MerchantsGetResponse,\n  AsError,\n  MerchantGetResponse,\n} from \"../account-server-api.schemas\";\nimport { customInstance, ErrorType } from \".././custom-instance\";\n\nexport type AwaitedInput<T> = PromiseLike<T> | T;\n\nexport type Awaited<O> = O extends AwaitedInput<infer T> ? T : never;\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype SecondParameter<T extends (...args: any) => any> = T extends (\n  config: any,\n  args: infer P\n) => any\n  ? P\n  : never;\n\n/**\n * Gets merchants known to the Account Server\n\n * @summary Gets all Merchants\n */\nexport const getMerchants = (\n  options?: SecondParameter<typeof customInstance>,\n  signal?: AbortSignal\n) => {\n  return customInstance<MerchantsGetResponse>(\n    { url: `/merchant`, method: \"get\", signal },\n    options\n  );\n};\n\nexport const getGetMerchantsQueryKey = () => [`/merchant`];\n\nexport type GetMerchantsQueryResult = NonNullable<\n  Awaited<ReturnType<typeof getMerchants>>\n>;\nexport type GetMerchantsQueryError = ErrorType<AsError | void>;\n\nexport const useGetMerchants = <\n  TData = Awaited<ReturnType<typeof getMerchants>>,\n  TError = ErrorType<AsError | void>\n>(options?: {\n  query?: UseQueryOptions<\n    Awaited<ReturnType<typeof getMerchants>>,\n    TError,\n    TData\n  >;\n  request?: SecondParameter<typeof customInstance>;\n}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n  const { query: queryOptions, request: requestOptions } = options ?? {};\n\n  const queryKey = queryOptions?.queryKey ?? getGetMerchantsQueryKey();\n\n  const queryFn: QueryFunction<Awaited<ReturnType<typeof getMerchants>>> = ({\n    signal,\n  }) => getMerchants(requestOptions, signal);\n\n  const query = useQuery<\n    Awaited<ReturnType<typeof getMerchants>>,\n    TError,\n    TData\n  >(queryKey, queryFn, queryOptions);\n\n  return {\n    queryKey,\n    ...query,\n  };\n};\n\n/**\n * Gets a known merchant\n\n * @summary Gets a specific Merchant\n */\nexport const getService = (\n  mId: number,\n  options?: SecondParameter<typeof customInstance>,\n  signal?: AbortSignal\n) => {\n  return customInstance<MerchantGetResponse>(\n    { url: `/merchant/${mId}`, method: \"get\", signal },\n    options\n  );\n};\n\nexport const getGetServiceQueryKey = (mId: number) => [`/merchant/${mId}`];\n\nexport type GetServiceQueryResult = NonNullable<\n  Awaited<ReturnType<typeof getService>>\n>;\nexport type GetServiceQueryError = ErrorType<AsError | void>;\n\nexport const useGetService = <\n  TData = Awaited<ReturnType<typeof getService>>,\n  TError = ErrorType<AsError | void>\n>(\n  mId: number,\n  options?: {\n    query?: UseQueryOptions<\n      Awaited<ReturnType<typeof getService>>,\n      TError,\n      TData\n    >;\n    request?: SecondParameter<typeof customInstance>;\n  }\n): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n  const { query: queryOptions, request: requestOptions } = options ?? {};\n\n  const queryKey = queryOptions?.queryKey ?? getGetServiceQueryKey(mId);\n\n  const queryFn: QueryFunction<Awaited<ReturnType<typeof getService>>> = ({\n    signal,\n  }) => getService(mId, requestOptions, signal);\n\n  const query = useQuery<Awaited<ReturnType<typeof getService>>, TError, TData>(\n    queryKey,\n    queryFn,\n    { enabled: !!mId, ...queryOptions }\n  );\n\n  return {\n    queryKey,\n    ...query,\n  };\n};\n"]}

package/merchant/merchant.d.ts

@@ -0,0 +1,39 @@
+import { a9 as customInstance, o as MerchantsGetResponse, aa as ErrorType, a5 as AsError, m as MerchantDetail } from '../custom-instance-b985e1be.js';
+import { UseQueryOptions, QueryKey, UseQueryResult } from 'react-query';
+import 'axios';
+
+declare type AwaitedInput<T> = PromiseLike<T> | T;
+declare type Awaited<O> = O extends AwaitedInput<infer T> ? T : never;
+declare type SecondParameter<T extends (...args: any) => any> = T extends (config: any, args: infer P) => any ? P : never;
+/**
+ * Gets merchants known to the Account Server
+
+ * @summary Gets all Merchants
+ */
+declare const getMerchants: (options?: SecondParameter<typeof customInstance>, signal?: AbortSignal | undefined) => Promise<MerchantsGetResponse>;
+declare const getGetMerchantsQueryKey: () => string[];
+declare type GetMerchantsQueryResult = NonNullable<Awaited<ReturnType<typeof getMerchants>>>;
+declare type GetMerchantsQueryError = ErrorType<AsError | void>;
+declare const useGetMerchants: <TData = MerchantsGetResponse, TError = ErrorType<void | AsError>>(options?: {
+    query?: UseQueryOptions<MerchantsGetResponse, TError, TData, QueryKey> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+/**
+ * Gets a known merchant
+
+ * @summary Gets a specific Merchant
+ */
+declare const getService: (mId: number, options?: SecondParameter<typeof customInstance>, signal?: AbortSignal | undefined) => Promise<MerchantDetail>;
+declare const getGetServiceQueryKey: (mId: number) => string[];
+declare type GetServiceQueryResult = NonNullable<Awaited<ReturnType<typeof getService>>>;
+declare type GetServiceQueryError = ErrorType<AsError | void>;
+declare const useGetService: <TData = MerchantDetail, TError = ErrorType<void | AsError>>(mId: number, options?: {
+    query?: UseQueryOptions<MerchantDetail, TError, TData, QueryKey> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+
+export { Awaited, AwaitedInput, GetMerchantsQueryError, GetMerchantsQueryResult, GetServiceQueryError, GetServiceQueryResult, getGetMerchantsQueryKey, getGetServiceQueryKey, getMerchants, getService, useGetMerchants, useGetService };