@squonk/account-server-client 0.1.8-rc.1 → 0.1.9-rc.1

package/{custom-instance-cc5da68e.d.ts → custom-instance-3334b00b.d.ts}

@@ -45,6 +45,8 @@ declare const UnitProductPostBodyBodyType: {
 declare type UnitProductPostBodyBody = {
     /** The name you want to give the Product */
     name: string;
+    /** The service identity for the Product. Products are created for use on a specific service, like a Data Manager instance */
+    service_id: number;
     /** The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be providec. Project Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products */
     type: UnitProductPostBodyBodyType;
     /** The Flavour of the Product. Used only for Project Tier Products. Do nto set this for Storage products */
@@ -74,6 +76,16 @@ interface UnitDetail {
     name: string;
     owner_id?: string;
 }
+interface ServiceGetResponse {
+    id: number;
+    kind: string;
+    name?: string;
+}
+interface ServicesGetResponse {
+    /** The list of known Servcies
+     */
+    services: ServiceGetResponse[];
+}
 interface OrganisationDetail {
     id: string;
     name: string;
@@ -101,6 +113,9 @@ interface ProductDetail {
     /** The Product ID
      */
     id: string;
+    /** The Product Service ID
+     */
+    service_id?: number;
     type: ProductDetailType;
     flavour?: ProductDetailFlavour;
     name?: string;
@@ -238,4 +253,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 { OrganisationUnitPostResponse as A, UsersGetResponse as B, OrganisationPostResponse as C, AsError as D, AXIOS_INSTANCE as E, setAuthToken as F, setBaseUrl as G, customInstance as H, ErrorType as I, OrganisationUnitPostBodyBody as O, ProductPatchBodyBody as P, QDummyParameter as Q, UnitProductPostBodyBodyFlavour as U, UnitProductPostBodyBodyType as a, UnitProductPostBodyBody as b, OrganisationPostBodyBody as c, UserDetail as d, UnitDetail as e, OrganisationDetail as f, ProductInstanceDetailCoins as g, ProductInstanceDetail as h, ProductDetailFlavour as i, ProductDetailType as j, ProductDetail as k, ProductCoinsDetail as l, ProductClaimDetail as m, ProductDmStorageDetailCoins as n, ProductDmStorageDetailSize as o, ProductDmStorageDetail as p, ProductDmProjectTier as q, ProductDmStorage as r, UnitsGetResponse as s, UnitProductPostResponse as t, ProductUnitGetResponseProduct as u, ProductUnitGetResponse as v, ProductsGetResponseProductsItem as w, ProductsGetResponse as x, OrganisationsGetResponse as y, OrganisationUnitsGetResponse as z };
+export { OrganisationUnitsGetResponse as A, OrganisationUnitPostResponse as B, UsersGetResponse as C, OrganisationPostResponse as D, AsError as E, AXIOS_INSTANCE as F, setAuthToken as G, setBaseUrl as H, customInstance as I, ErrorType as J, OrganisationUnitPostBodyBody as O, ProductPatchBodyBody as P, QDummyParameter as Q, ServiceGetResponse as S, UnitProductPostBodyBodyFlavour as U, UnitProductPostBodyBodyType as a, UnitProductPostBodyBody as b, OrganisationPostBodyBody as c, UserDetail as d, UnitDetail as e, ServicesGetResponse as f, OrganisationDetail as g, ProductInstanceDetailCoins as h, ProductInstanceDetail as i, ProductDetailFlavour as j, ProductDetailType as k, ProductDetail as l, ProductCoinsDetail as m, ProductClaimDetail as n, ProductDmStorageDetailCoins as o, ProductDmStorageDetailSize as p, ProductDmStorageDetail as q, ProductDmProjectTier as r, ProductDmStorage as s, UnitsGetResponse as t, UnitProductPostResponse as u, ProductUnitGetResponseProduct as v, ProductUnitGetResponse as w, ProductsGetResponseProductsItem as x, ProductsGetResponse as y, OrganisationsGetResponse as z };

package/index.cjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/index.ts", "../src/account-server-api.schemas.ts", "../src/custom-instance.ts"],
-  "sourcesContent": ["// Generated by orval\n// account-server-api Is replaced with the api name\nexport * from './account-server-api.schemas';\n\n// Request instance and methods to change the baseUrl and auth token\nexport * from './custom-instance';\n", "/**\n * Generated by orval v6.4.2 \uD83C\uDF7A\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 */\n/**\n * A dummy\n\n */\nexport type QDummyParameter = boolean;\n\nexport type ProductPatchBodyBody = {\n  /** The name you want to give the Product */\n  name?: string;\n  /** The Product's built-in coin alloance. */\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 */\n  limit?: number;\n};\n\n/**\n * The Flavour of the Product. Used only for Project Tier Products. Do nto 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 providec. Project 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 Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be providec. Project 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 nto set this for Storage products */\n  flavour?: UnitProductPostBodyBodyFlavour;\n  /** The Product's coin alloance. 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 organisaion */\n  name: string;\n  /** The name of the organisation owner. A user ID */\n  owner: string;\n};\n\nexport interface UserDetail {\n  id: string;\n}\n\nexport interface UnitDetail {\n  id: string;\n  name: string;\n  owner_id?: string;\n}\n\nexport interface OrganisationDetail {\n  id: string;\n  name: string;\n  owner_id?: string;\n}\n\nexport type ProductInstanceDetailCoins = {\n  used: number;\n};\n\nexport interface ProductInstanceDetail {\n  coins: ProductInstanceDetailCoins;\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\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  type: ProductDetailType;\n  flavour?: ProductDetailFlavour;\n  name?: string;\n}\n\nexport interface ProductCoinsDetail {\n  /** The billing allowance. When you exceed this during the current billign period the *cost multipler* 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), exclding the coins that have been consumed for the current day */\n  used: number;\n  /** True if the product is oeprating at or beyond its coin limit. When it is authority to perform actions using the product are severly 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 billign period */\n  billing_day: number;\n  /** A multipler applied to your coin usage within yoru allowance */\n  allowance_multiplier: number;\n  /** A multipler 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 ID using this Subscription.\n   */\n  id: string;\n  /** A name for the service\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 acumulated coins at the start of each day */\n  used: number;\n  /** The coin cost of a 'unit' of strage 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 interface UnitsGetResponse {\n  /** A list of Units\n   */\n  units: OrganisationUnitsGetResponse[];\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 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 Organisaions */\n  organisations: OrganisationDetail[];\n}\n\nexport interface OrganisationUnitsGetResponse {\n  organisation: OrganisationDetail;\n  /** A list of Units\n   */\n  units: UnitDetail[];\n}\n\nexport interface OrganisationUnitPostResponse {\n  /** The unit's unique ID */\n  id: string;\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 AsError {\n  /** Brief error text that can be presented to the user */\n  error: string;\n}\n", "/** Based off the example custom-instance from Orval docs\n * https://github.com/anymaniax/orval/blob/master/samples/react-app-with-react-query/src/api/mutator/custom-instance.ts\n *\n * See https://react-query.tanstack.com/guides/query-cancellation\n *\n * TODO: Considering using Fetch-API instead of axios. This instance will have to change. Could be\n * achieved without changing much using `redaxios`\n * Or use 'ky'\n */\n\nimport Axios, { AxiosError, AxiosRequestConfig } from 'axios';\n\n// ? Need the baseUrl or does it default to ''?\nexport const AXIOS_INSTANCE = Axios.create({ baseURL: '' });\n\n/**\n * Set the access token to be added as the `Authorization: Bearer 'token'` header\n * Useful for client only apps where a proxy API route isn't involved to securely add the access token\n * @param token access token\n */\nexport const setAuthToken = (token: string) => {\n  AXIOS_INSTANCE.defaults.headers.common['Authorization'] = `Bearer ${token}`;\n};\n\n/**\n * Set the url to which request paths are added to.\n * @param baseUrl origin + subpath e.g. 'https://example.com/subpath' or '/subpath'\n */\nexport const setBaseUrl = (baseUrl: string) => {\n  AXIOS_INSTANCE.defaults.baseURL = baseUrl;\n};\n\nexport const customInstance = <TReturn>(\n  config: AxiosRequestConfig,\n  options?: AxiosRequestConfig,\n): Promise<TReturn> => {\n  const source = Axios.CancelToken.source();\n\n  const promise = AXIOS_INSTANCE({ ...config, ...options, cancelToken: source.token }).then(\n    ({ data }) => data,\n  );\n\n  // Promise doesn't have a cancel method but react-query requires this method to make cancellations general.\n  // This can either be a any assertion or a @ts-ignore comment.\n  (promise as any).cancel = () => {\n    source.cancel('Query was cancelled by React Query');\n  };\n\n  return promise;\n};\n\nexport type ErrorType<TError> = AxiosError<TError>;\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACmCO,IAAM,iCAAiC;AAAA,EAC5C,YAAY;AAAA,EACZ,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,MAAM;AAAA;AAWD,IAAM,8BAA8B;AAAA,EACzC,wCACE;AAAA,EACF,mCACE;AAAA;AAyDG,IAAM,uBAAuB;AAAA,EAClC,YAAY;AAAA,EACZ,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,MAAM;AAAA;AAQD,IAAM,oBAAoB;AAAA,EAC/B,wCACE;AAAA,EACF,mCACE;AAAA;;;ACrHJ,mBAAsD;AAG/C,IAAM,iBAAiB,qBAAM,OAAO,EAAE,SAAS;AAO/C,IAAM,eAAe,CAAC,UAAkB;AAC7C,iBAAe,SAAS,QAAQ,OAAO,mBAAmB,UAAU;AAAA;AAO/D,IAAM,aAAa,CAAC,YAAoB;AAC7C,iBAAe,SAAS,UAAU;AAAA;AAG7B,IAAM,iBAAiB,CAC5B,QACA,YACqB;AACrB,QAAM,SAAS,qBAAM,YAAY;AAEjC,QAAM,UAAU,eAAe,gDAAK,SAAW,UAAhB,EAAyB,aAAa,OAAO,UAAS,KACnF,CAAC,EAAE,WAAW;AAKhB,EAAC,QAAgB,SAAS,MAAM;AAC9B,WAAO,OAAO;AAAA;AAGhB,SAAO;AAAA;",
+  "sourcesContent": ["// Generated by orval\n// account-server-api Is replaced with the api name\nexport * from './account-server-api.schemas';\n\n// Request instance and methods to change the baseUrl and auth token\nexport * from './custom-instance';\n", "/**\n * Generated by orval v6.4.2 \uD83C\uDF7A\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 */\n/**\n * A dummy\n\n */\nexport type QDummyParameter = boolean;\n\nexport type ProductPatchBodyBody = {\n  /** The name you want to give the Product */\n  name?: string;\n  /** The Product's built-in coin alloance. */\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 */\n  limit?: number;\n};\n\n/**\n * The Flavour of the Product. Used only for Project Tier Products. Do nto 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 providec. Project 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 providec. Project 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 nto set this for Storage products */\n  flavour?: UnitProductPostBodyBodyFlavour;\n  /** The Product's coin alloance. 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 organisaion */\n  name: string;\n  /** The name of the organisation owner. A user ID */\n  owner: string;\n};\n\nexport interface UserDetail {\n  id: string;\n}\n\nexport interface UnitDetail {\n  id: string;\n  name: string;\n  owner_id?: string;\n}\n\nexport interface ServiceGetResponse {\n  id: number;\n  kind: string;\n  name?: string;\n}\n\nexport interface ServicesGetResponse {\n  /** The list of known Servcies\n   */\n  services: ServiceGetResponse[];\n}\n\nexport interface OrganisationDetail {\n  id: string;\n  name: string;\n  owner_id?: string;\n}\n\nexport type ProductInstanceDetailCoins = {\n  used: number;\n};\n\nexport interface ProductInstanceDetail {\n  coins: ProductInstanceDetailCoins;\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\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  type: ProductDetailType;\n  flavour?: ProductDetailFlavour;\n  name?: string;\n}\n\nexport interface ProductCoinsDetail {\n  /** The billing allowance. When you exceed this during the current billign period the *cost multipler* 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), exclding the coins that have been consumed for the current day */\n  used: number;\n  /** True if the product is oeprating at or beyond its coin limit. When it is authority to perform actions using the product are severly 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 billign period */\n  billing_day: number;\n  /** A multipler applied to your coin usage within yoru allowance */\n  allowance_multiplier: number;\n  /** A multipler 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 ID using this Subscription.\n   */\n  id: string;\n  /** A name for the service\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 acumulated coins at the start of each day */\n  used: number;\n  /** The coin cost of a 'unit' of strage 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 interface UnitsGetResponse {\n  /** A list of Units\n   */\n  units: OrganisationUnitsGetResponse[];\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 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 Organisaions */\n  organisations: OrganisationDetail[];\n}\n\nexport interface OrganisationUnitsGetResponse {\n  organisation: OrganisationDetail;\n  /** A list of Units\n   */\n  units: UnitDetail[];\n}\n\nexport interface OrganisationUnitPostResponse {\n  /** The unit's unique ID */\n  id: string;\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 AsError {\n  /** Brief error text that can be presented to the user */\n  error: string;\n}\n", "/** Based off the example custom-instance from Orval docs\n * https://github.com/anymaniax/orval/blob/master/samples/react-app-with-react-query/src/api/mutator/custom-instance.ts\n *\n * See https://react-query.tanstack.com/guides/query-cancellation\n *\n * TODO: Considering using Fetch-API instead of axios. This instance will have to change. Could be\n * achieved without changing much using `redaxios`\n * Or use 'ky'\n */\n\nimport Axios, { AxiosError, AxiosRequestConfig } from 'axios';\n\n// ? Need the baseUrl or does it default to ''?\nexport const AXIOS_INSTANCE = Axios.create({ baseURL: '' });\n\n/**\n * Set the access token to be added as the `Authorization: Bearer 'token'` header\n * Useful for client only apps where a proxy API route isn't involved to securely add the access token\n * @param token access token\n */\nexport const setAuthToken = (token: string) => {\n  AXIOS_INSTANCE.defaults.headers.common['Authorization'] = `Bearer ${token}`;\n};\n\n/**\n * Set the url to which request paths are added to.\n * @param baseUrl origin + subpath e.g. 'https://example.com/subpath' or '/subpath'\n */\nexport const setBaseUrl = (baseUrl: string) => {\n  AXIOS_INSTANCE.defaults.baseURL = baseUrl;\n};\n\nexport const customInstance = <TReturn>(\n  config: AxiosRequestConfig,\n  options?: AxiosRequestConfig,\n): Promise<TReturn> => {\n  const source = Axios.CancelToken.source();\n\n  const promise = AXIOS_INSTANCE({ ...config, ...options, cancelToken: source.token }).then(\n    ({ data }) => data,\n  );\n\n  // Promise doesn't have a cancel method but react-query requires this method to make cancellations general.\n  // This can either be a any assertion or a @ts-ignore comment.\n  (promise as any).cancel = () => {\n    source.cancel('Query was cancelled by React Query');\n  };\n\n  return promise;\n};\n\nexport type ErrorType<TError> = AxiosError<TError>;\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACmCO,IAAM,iCAAiC;AAAA,EAC5C,YAAY;AAAA,EACZ,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,MAAM;AAAA;AAWD,IAAM,8BAA8B;AAAA,EACzC,wCACE;AAAA,EACF,mCACE;AAAA;AAuEG,IAAM,uBAAuB;AAAA,EAClC,YAAY;AAAA,EACZ,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,MAAM;AAAA;AAQD,IAAM,oBAAoB;AAAA,EAC/B,wCACE;AAAA,EACF,mCACE;AAAA;;;ACnIJ,mBAAsD;AAG/C,IAAM,iBAAiB,qBAAM,OAAO,EAAE,SAAS;AAO/C,IAAM,eAAe,CAAC,UAAkB;AAC7C,iBAAe,SAAS,QAAQ,OAAO,mBAAmB,UAAU;AAAA;AAO/D,IAAM,aAAa,CAAC,YAAoB;AAC7C,iBAAe,SAAS,UAAU;AAAA;AAG7B,IAAM,iBAAiB,CAC5B,QACA,YACqB;AACrB,QAAM,SAAS,qBAAM,YAAY;AAEjC,QAAM,UAAU,eAAe,gDAAK,SAAW,UAAhB,EAAyB,aAAa,OAAO,UAAS,KACnF,CAAC,EAAE,WAAW;AAKhB,EAAC,QAAgB,SAAS,MAAM;AAC9B,WAAO,OAAO;AAAA;AAGhB,SAAO;AAAA;",
   "names": []
 }

package/index.d.ts

@@ -1,2 +1,2 @@
-export { E as AXIOS_INSTANCE, D as AsError, I as ErrorType, f as OrganisationDetail, c as OrganisationPostBodyBody, C as OrganisationPostResponse, O as OrganisationUnitPostBodyBody, A as OrganisationUnitPostResponse, z as OrganisationUnitsGetResponse, y as OrganisationsGetResponse, m as ProductClaimDetail, l as ProductCoinsDetail, k as ProductDetail, i as ProductDetailFlavour, j as ProductDetailType, q as ProductDmProjectTier, r as ProductDmStorage, p as ProductDmStorageDetail, n as ProductDmStorageDetailCoins, o as ProductDmStorageDetailSize, h as ProductInstanceDetail, g as ProductInstanceDetailCoins, P as ProductPatchBodyBody, v as ProductUnitGetResponse, u as ProductUnitGetResponseProduct, x as ProductsGetResponse, w as ProductsGetResponseProductsItem, Q as QDummyParameter, e as UnitDetail, b as UnitProductPostBodyBody, U as UnitProductPostBodyBodyFlavour, a as UnitProductPostBodyBodyType, t as UnitProductPostResponse, s as UnitsGetResponse, d as UserDetail, B as UsersGetResponse, H as customInstance, F as setAuthToken, G as setBaseUrl } from './custom-instance-cc5da68e';
+export { F as AXIOS_INSTANCE, E as AsError, J as ErrorType, g as OrganisationDetail, c as OrganisationPostBodyBody, D as OrganisationPostResponse, O as OrganisationUnitPostBodyBody, B as OrganisationUnitPostResponse, A as OrganisationUnitsGetResponse, z as OrganisationsGetResponse, n as ProductClaimDetail, m as ProductCoinsDetail, l as ProductDetail, j as ProductDetailFlavour, k as ProductDetailType, r as ProductDmProjectTier, s as ProductDmStorage, q as ProductDmStorageDetail, o as ProductDmStorageDetailCoins, p as ProductDmStorageDetailSize, i as ProductInstanceDetail, h as ProductInstanceDetailCoins, P as ProductPatchBodyBody, w as ProductUnitGetResponse, v as ProductUnitGetResponseProduct, y as ProductsGetResponse, x as ProductsGetResponseProductsItem, Q as QDummyParameter, S as ServiceGetResponse, f as ServicesGetResponse, e as UnitDetail, b as UnitProductPostBodyBody, U as UnitProductPostBodyBodyFlavour, a as UnitProductPostBodyBodyType, u as UnitProductPostResponse, t as UnitsGetResponse, d as UserDetail, C as UsersGetResponse, I as customInstance, G as setAuthToken, H as setBaseUrl } from './custom-instance-3334b00b';
 import 'axios';

package/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/account-server-api.schemas.ts", "../src/custom-instance.ts"],
-  "sourcesContent": ["/**\n * Generated by orval v6.4.2 \uD83C\uDF7A\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 */\n/**\n * A dummy\n\n */\nexport type QDummyParameter = boolean;\n\nexport type ProductPatchBodyBody = {\n  /** The name you want to give the Product */\n  name?: string;\n  /** The Product's built-in coin alloance. */\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 */\n  limit?: number;\n};\n\n/**\n * The Flavour of the Product. Used only for Project Tier Products. Do nto 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 providec. Project 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 Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be providec. Project 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 nto set this for Storage products */\n  flavour?: UnitProductPostBodyBodyFlavour;\n  /** The Product's coin alloance. 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 organisaion */\n  name: string;\n  /** The name of the organisation owner. A user ID */\n  owner: string;\n};\n\nexport interface UserDetail {\n  id: string;\n}\n\nexport interface UnitDetail {\n  id: string;\n  name: string;\n  owner_id?: string;\n}\n\nexport interface OrganisationDetail {\n  id: string;\n  name: string;\n  owner_id?: string;\n}\n\nexport type ProductInstanceDetailCoins = {\n  used: number;\n};\n\nexport interface ProductInstanceDetail {\n  coins: ProductInstanceDetailCoins;\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\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  type: ProductDetailType;\n  flavour?: ProductDetailFlavour;\n  name?: string;\n}\n\nexport interface ProductCoinsDetail {\n  /** The billing allowance. When you exceed this during the current billign period the *cost multipler* 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), exclding the coins that have been consumed for the current day */\n  used: number;\n  /** True if the product is oeprating at or beyond its coin limit. When it is authority to perform actions using the product are severly 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 billign period */\n  billing_day: number;\n  /** A multipler applied to your coin usage within yoru allowance */\n  allowance_multiplier: number;\n  /** A multipler 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 ID using this Subscription.\n   */\n  id: string;\n  /** A name for the service\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 acumulated coins at the start of each day */\n  used: number;\n  /** The coin cost of a 'unit' of strage 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 interface UnitsGetResponse {\n  /** A list of Units\n   */\n  units: OrganisationUnitsGetResponse[];\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 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 Organisaions */\n  organisations: OrganisationDetail[];\n}\n\nexport interface OrganisationUnitsGetResponse {\n  organisation: OrganisationDetail;\n  /** A list of Units\n   */\n  units: UnitDetail[];\n}\n\nexport interface OrganisationUnitPostResponse {\n  /** The unit's unique ID */\n  id: string;\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 AsError {\n  /** Brief error text that can be presented to the user */\n  error: string;\n}\n", "/** Based off the example custom-instance from Orval docs\n * https://github.com/anymaniax/orval/blob/master/samples/react-app-with-react-query/src/api/mutator/custom-instance.ts\n *\n * See https://react-query.tanstack.com/guides/query-cancellation\n *\n * TODO: Considering using Fetch-API instead of axios. This instance will have to change. Could be\n * achieved without changing much using `redaxios`\n * Or use 'ky'\n */\n\nimport Axios, { AxiosError, AxiosRequestConfig } from 'axios';\n\n// ? Need the baseUrl or does it default to ''?\nexport const AXIOS_INSTANCE = Axios.create({ baseURL: '' });\n\n/**\n * Set the access token to be added as the `Authorization: Bearer 'token'` header\n * Useful for client only apps where a proxy API route isn't involved to securely add the access token\n * @param token access token\n */\nexport const setAuthToken = (token: string) => {\n  AXIOS_INSTANCE.defaults.headers.common['Authorization'] = `Bearer ${token}`;\n};\n\n/**\n * Set the url to which request paths are added to.\n * @param baseUrl origin + subpath e.g. 'https://example.com/subpath' or '/subpath'\n */\nexport const setBaseUrl = (baseUrl: string) => {\n  AXIOS_INSTANCE.defaults.baseURL = baseUrl;\n};\n\nexport const customInstance = <TReturn>(\n  config: AxiosRequestConfig,\n  options?: AxiosRequestConfig,\n): Promise<TReturn> => {\n  const source = Axios.CancelToken.source();\n\n  const promise = AXIOS_INSTANCE({ ...config, ...options, cancelToken: source.token }).then(\n    ({ data }) => data,\n  );\n\n  // Promise doesn't have a cancel method but react-query requires this method to make cancellations general.\n  // This can either be a any assertion or a @ts-ignore comment.\n  (promise as any).cancel = () => {\n    source.cancel('Query was cancelled by React Query');\n  };\n\n  return promise;\n};\n\nexport type ErrorType<TError> = AxiosError<TError>;\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;AAmCO,IAAM,iCAAiC;AAAA,EAC5C,YAAY;AAAA,EACZ,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,MAAM;AAAA;AAWD,IAAM,8BAA8B;AAAA,EACzC,wCACE;AAAA,EACF,mCACE;AAAA;AAyDG,IAAM,uBAAuB;AAAA,EAClC,YAAY;AAAA,EACZ,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,MAAM;AAAA;AAQD,IAAM,oBAAoB;AAAA,EAC/B,wCACE;AAAA,EACF,mCACE;AAAA;;;ACrHJ;AAGO,IAAM,iBAAiB,MAAM,OAAO,EAAE,SAAS;AAO/C,IAAM,eAAe,CAAC,UAAkB;AAC7C,iBAAe,SAAS,QAAQ,OAAO,mBAAmB,UAAU;AAAA;AAO/D,IAAM,aAAa,CAAC,YAAoB;AAC7C,iBAAe,SAAS,UAAU;AAAA;AAG7B,IAAM,iBAAiB,CAC5B,QACA,YACqB;AACrB,QAAM,SAAS,MAAM,YAAY;AAEjC,QAAM,UAAU,eAAe,gDAAK,SAAW,UAAhB,EAAyB,aAAa,OAAO,UAAS,KACnF,CAAC,EAAE,WAAW;AAKhB,EAAC,QAAgB,SAAS,MAAM;AAC9B,WAAO,OAAO;AAAA;AAGhB,SAAO;AAAA;",
+  "sourcesContent": ["/**\n * Generated by orval v6.4.2 \uD83C\uDF7A\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 */\n/**\n * A dummy\n\n */\nexport type QDummyParameter = boolean;\n\nexport type ProductPatchBodyBody = {\n  /** The name you want to give the Product */\n  name?: string;\n  /** The Product's built-in coin alloance. */\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 */\n  limit?: number;\n};\n\n/**\n * The Flavour of the Product. Used only for Project Tier Products. Do nto 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 providec. Project 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 providec. Project 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 nto set this for Storage products */\n  flavour?: UnitProductPostBodyBodyFlavour;\n  /** The Product's coin alloance. 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 organisaion */\n  name: string;\n  /** The name of the organisation owner. A user ID */\n  owner: string;\n};\n\nexport interface UserDetail {\n  id: string;\n}\n\nexport interface UnitDetail {\n  id: string;\n  name: string;\n  owner_id?: string;\n}\n\nexport interface ServiceGetResponse {\n  id: number;\n  kind: string;\n  name?: string;\n}\n\nexport interface ServicesGetResponse {\n  /** The list of known Servcies\n   */\n  services: ServiceGetResponse[];\n}\n\nexport interface OrganisationDetail {\n  id: string;\n  name: string;\n  owner_id?: string;\n}\n\nexport type ProductInstanceDetailCoins = {\n  used: number;\n};\n\nexport interface ProductInstanceDetail {\n  coins: ProductInstanceDetailCoins;\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\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  type: ProductDetailType;\n  flavour?: ProductDetailFlavour;\n  name?: string;\n}\n\nexport interface ProductCoinsDetail {\n  /** The billing allowance. When you exceed this during the current billign period the *cost multipler* 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), exclding the coins that have been consumed for the current day */\n  used: number;\n  /** True if the product is oeprating at or beyond its coin limit. When it is authority to perform actions using the product are severly 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 billign period */\n  billing_day: number;\n  /** A multipler applied to your coin usage within yoru allowance */\n  allowance_multiplier: number;\n  /** A multipler 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 ID using this Subscription.\n   */\n  id: string;\n  /** A name for the service\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 acumulated coins at the start of each day */\n  used: number;\n  /** The coin cost of a 'unit' of strage 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 interface UnitsGetResponse {\n  /** A list of Units\n   */\n  units: OrganisationUnitsGetResponse[];\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 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 Organisaions */\n  organisations: OrganisationDetail[];\n}\n\nexport interface OrganisationUnitsGetResponse {\n  organisation: OrganisationDetail;\n  /** A list of Units\n   */\n  units: UnitDetail[];\n}\n\nexport interface OrganisationUnitPostResponse {\n  /** The unit's unique ID */\n  id: string;\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 AsError {\n  /** Brief error text that can be presented to the user */\n  error: string;\n}\n", "/** Based off the example custom-instance from Orval docs\n * https://github.com/anymaniax/orval/blob/master/samples/react-app-with-react-query/src/api/mutator/custom-instance.ts\n *\n * See https://react-query.tanstack.com/guides/query-cancellation\n *\n * TODO: Considering using Fetch-API instead of axios. This instance will have to change. Could be\n * achieved without changing much using `redaxios`\n * Or use 'ky'\n */\n\nimport Axios, { AxiosError, AxiosRequestConfig } from 'axios';\n\n// ? Need the baseUrl or does it default to ''?\nexport const AXIOS_INSTANCE = Axios.create({ baseURL: '' });\n\n/**\n * Set the access token to be added as the `Authorization: Bearer 'token'` header\n * Useful for client only apps where a proxy API route isn't involved to securely add the access token\n * @param token access token\n */\nexport const setAuthToken = (token: string) => {\n  AXIOS_INSTANCE.defaults.headers.common['Authorization'] = `Bearer ${token}`;\n};\n\n/**\n * Set the url to which request paths are added to.\n * @param baseUrl origin + subpath e.g. 'https://example.com/subpath' or '/subpath'\n */\nexport const setBaseUrl = (baseUrl: string) => {\n  AXIOS_INSTANCE.defaults.baseURL = baseUrl;\n};\n\nexport const customInstance = <TReturn>(\n  config: AxiosRequestConfig,\n  options?: AxiosRequestConfig,\n): Promise<TReturn> => {\n  const source = Axios.CancelToken.source();\n\n  const promise = AXIOS_INSTANCE({ ...config, ...options, cancelToken: source.token }).then(\n    ({ data }) => data,\n  );\n\n  // Promise doesn't have a cancel method but react-query requires this method to make cancellations general.\n  // This can either be a any assertion or a @ts-ignore comment.\n  (promise as any).cancel = () => {\n    source.cancel('Query was cancelled by React Query');\n  };\n\n  return promise;\n};\n\nexport type ErrorType<TError> = AxiosError<TError>;\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;AAmCO,IAAM,iCAAiC;AAAA,EAC5C,YAAY;AAAA,EACZ,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,MAAM;AAAA;AAWD,IAAM,8BAA8B;AAAA,EACzC,wCACE;AAAA,EACF,mCACE;AAAA;AAuEG,IAAM,uBAAuB;AAAA,EAClC,YAAY;AAAA,EACZ,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,MAAM;AAAA;AAQD,IAAM,oBAAoB;AAAA,EAC/B,wCACE;AAAA,EACF,mCACE;AAAA;;;ACnIJ;AAGO,IAAM,iBAAiB,MAAM,OAAO,EAAE,SAAS;AAO/C,IAAM,eAAe,CAAC,UAAkB;AAC7C,iBAAe,SAAS,QAAQ,OAAO,mBAAmB,UAAU;AAAA;AAO/D,IAAM,aAAa,CAAC,YAAoB;AAC7C,iBAAe,SAAS,UAAU;AAAA;AAG7B,IAAM,iBAAiB,CAC5B,QACA,YACqB;AACrB,QAAM,SAAS,MAAM,YAAY;AAEjC,QAAM,UAAU,eAAe,gDAAK,SAAW,UAAhB,EAAyB,aAAa,OAAO,UAAS,KACnF,CAAC,EAAE,WAAW;AAKhB,EAAC,QAAgB,SAAS,MAAM;AAC9B,WAAO,OAAO;AAAA;AAGhB,SAAO;AAAA;",
   "names": []
 }

package/organisation/organisation.d.ts

@@ -1,6 +1,6 @@
 import * as react_query from 'react-query';
 import { UseQueryOptions, QueryKey, UseQueryResult, UseMutationOptions } from 'react-query';
-import { H as customInstance, y as OrganisationsGetResponse, I as ErrorType, D as AsError, c as OrganisationPostBodyBody, C as OrganisationPostResponse } from '../custom-instance-cc5da68e';
+import { I as customInstance, z as OrganisationsGetResponse, J as ErrorType, E as AsError, c as OrganisationPostBodyBody, D as OrganisationPostResponse } from '../custom-instance-3334b00b';
 import 'axios';
 
 declare type SecondParameter<T extends (...args: any) => any> = T extends (config: any, args: infer P) => any ? P : never;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.1.8-rc.1",
+  "version": "0.1.9-rc.1",
   "author": "Oliver Dudgeon",
   "name": "@squonk/account-server-client",
   "private": false,

package/product/product.d.ts

@@ -1,6 +1,6 @@
 import * as react_query from 'react-query';
 import { UseQueryOptions, QueryKey, UseQueryResult, UseMutationOptions } from 'react-query';
-import { H as customInstance, x as ProductsGetResponse, I as ErrorType, D as AsError, b as UnitProductPostBodyBody, t as UnitProductPostResponse, v as ProductUnitGetResponse, P as ProductPatchBodyBody } from '../custom-instance-cc5da68e';
+import { I as customInstance, y as ProductsGetResponse, J as ErrorType, E as AsError, b as UnitProductPostBodyBody, u as UnitProductPostResponse, w as ProductUnitGetResponse, P as ProductPatchBodyBody } from '../custom-instance-3334b00b';
 import 'axios';
 
 declare type SecondParameter<T extends (...args: any) => any> = T extends (config: any, args: infer P) => any ? P : never;

package/service/package.json

@@ -0,0 +1,7 @@
+{
+  "module": "./service.js",
+  "main": "./service.cjs",
+  "types": "./service.d.ts",
+  "sideEffects": false,
+  "type": "module"
+}

package/service/service.cjs

@@ -0,0 +1,100 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+var __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
+var __export = (target, all) => {
+  __markAsModule(target);
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __reExport = (target, module2, desc) => {
+  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
+    for (let key of __getOwnPropNames(module2))
+      if (!__hasOwnProp.call(target, key) && key !== "default")
+        __defProp(target, key, { get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable });
+  }
+  return target;
+};
+var __toModule = (module2) => {
+  return __reExport(__markAsModule(__defProp(module2 != null ? __create(__getProtoOf(module2)) : {}, "default", module2 && module2.__esModule && "default" in module2 ? { get: () => module2.default, enumerable: true } : { value: module2, enumerable: true })), module2);
+};
+
+// src/service/service.ts
+__export(exports, {
+  getGetServiceQueryKey: () => getGetServiceQueryKey,
+  getGetServicesQueryKey: () => getGetServicesQueryKey,
+  getService: () => getService,
+  getServices: () => getServices,
+  useGetService: () => useGetService,
+  useGetServices: () => useGetServices
+});
+var import_react_query = __toModule(require("react-query"));
+
+// src/custom-instance.ts
+var import_axios = __toModule(require("axios"));
+var AXIOS_INSTANCE = import_axios.default.create({ baseURL: "" });
+var customInstance = (config, options) => {
+  const source = import_axios.default.CancelToken.source();
+  const promise = AXIOS_INSTANCE(__spreadProps(__spreadValues(__spreadValues({}, config), options), { cancelToken: source.token })).then(({ data }) => data);
+  promise.cancel = () => {
+    source.cancel("Query was cancelled by React Query");
+  };
+  return promise;
+};
+
+// src/service/service.ts
+var getServices = (options) => {
+  return customInstance({ url: `/service`, method: "get" }, options);
+};
+var getGetServicesQueryKey = () => [`/service`];
+var useGetServices = (options) => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+  const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getGetServicesQueryKey();
+  const queryFn = () => getServices(requestOptions);
+  const query = (0, import_react_query.useQuery)(queryKey, queryFn, queryOptions);
+  return __spreadValues({
+    queryKey
+  }, query);
+};
+var getService = (svcid, options) => {
+  return customInstance({ url: `/service/${svcid}`, method: "get" }, options);
+};
+var getGetServiceQueryKey = (svcid) => [`/service/${svcid}`];
+var useGetService = (svcid, options) => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+  const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getGetServiceQueryKey(svcid);
+  const queryFn = () => getService(svcid, requestOptions);
+  const query = (0, import_react_query.useQuery)(queryKey, queryFn, __spreadValues({ enabled: !!svcid }, queryOptions));
+  return __spreadValues({
+    queryKey
+  }, query);
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getGetServiceQueryKey,
+  getGetServicesQueryKey,
+  getService,
+  getServices,
+  useGetService,
+  useGetServices
+});

package/service/service.cjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/service/service.ts", "../../src/custom-instance.ts"],
+  "sourcesContent": ["/**\n * Generated by orval v6.4.2 \uD83C\uDF7A\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  ServicesGetResponse,\n  AsError,\n  ServiceGetResponse,\n} from \"../account-server-api.schemas\";\nimport { customInstance, ErrorType } from \".././custom-instance\";\n\ntype AsyncReturnType<T extends (...args: any) => Promise<any>> = T extends (\n  ...args: any\n) => Promise<infer R>\n  ? R\n  : any;\n\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 services known to the Account Server\n\n * @summary Gets all Services\n */\nexport const getServices = (\n  options?: SecondParameter<typeof customInstance>\n) => {\n  return customInstance<ServicesGetResponse>(\n    { url: `/service`, method: \"get\" },\n    options\n  );\n};\n\nexport const getGetServicesQueryKey = () => [`/service`];\n\nexport const useGetServices = <\n  TData = AsyncReturnType<typeof getServices>,\n  TError = ErrorType<AsError | void>\n>(options?: {\n  query?: UseQueryOptions<AsyncReturnType<typeof getServices>, TError, TData>;\n  request?: SecondParameter<typeof customInstance>;\n}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n  const { query: queryOptions, request: requestOptions } = options || {};\n\n  const queryKey = queryOptions?.queryKey ?? getGetServicesQueryKey();\n\n  const queryFn: QueryFunction<AsyncReturnType<typeof getServices>> = () =>\n    getServices(requestOptions);\n\n  const query = useQuery<AsyncReturnType<typeof getServices>, TError, TData>(\n    queryKey,\n    queryFn,\n    queryOptions\n  );\n\n  return {\n    queryKey,\n    ...query,\n  };\n};\n\n/**\n * Gets a known service\n\n * @summary Gets a specific Service\n */\nexport const getService = (\n  svcid: number,\n  options?: SecondParameter<typeof customInstance>\n) => {\n  return customInstance<ServiceGetResponse>(\n    { url: `/service/${svcid}`, method: \"get\" },\n    options\n  );\n};\n\nexport const getGetServiceQueryKey = (svcid: number) => [`/service/${svcid}`];\n\nexport const useGetService = <\n  TData = AsyncReturnType<typeof getService>,\n  TError = ErrorType<AsError | void>\n>(\n  svcid: number,\n  options?: {\n    query?: UseQueryOptions<AsyncReturnType<typeof getService>, TError, TData>;\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(svcid);\n\n  const queryFn: QueryFunction<AsyncReturnType<typeof getService>> = () =>\n    getService(svcid, requestOptions);\n\n  const query = useQuery<AsyncReturnType<typeof getService>, TError, TData>(\n    queryKey,\n    queryFn,\n    { enabled: !!svcid, ...queryOptions }\n  );\n\n  return {\n    queryKey,\n    ...query,\n  };\n};\n", "/** Based off the example custom-instance from Orval docs\n * https://github.com/anymaniax/orval/blob/master/samples/react-app-with-react-query/src/api/mutator/custom-instance.ts\n *\n * See https://react-query.tanstack.com/guides/query-cancellation\n *\n * TODO: Considering using Fetch-API instead of axios. This instance will have to change. Could be\n * achieved without changing much using `redaxios`\n * Or use 'ky'\n */\n\nimport Axios, { AxiosError, AxiosRequestConfig } from 'axios';\n\n// ? Need the baseUrl or does it default to ''?\nexport const AXIOS_INSTANCE = Axios.create({ baseURL: '' });\n\n/**\n * Set the access token to be added as the `Authorization: Bearer 'token'` header\n * Useful for client only apps where a proxy API route isn't involved to securely add the access token\n * @param token access token\n */\nexport const setAuthToken = (token: string) => {\n  AXIOS_INSTANCE.defaults.headers.common['Authorization'] = `Bearer ${token}`;\n};\n\n/**\n * Set the url to which request paths are added to.\n * @param baseUrl origin + subpath e.g. 'https://example.com/subpath' or '/subpath'\n */\nexport const setBaseUrl = (baseUrl: string) => {\n  AXIOS_INSTANCE.defaults.baseURL = baseUrl;\n};\n\nexport const customInstance = <TReturn>(\n  config: AxiosRequestConfig,\n  options?: AxiosRequestConfig,\n): Promise<TReturn> => {\n  const source = Axios.CancelToken.source();\n\n  const promise = AXIOS_INSTANCE({ ...config, ...options, cancelToken: source.token }).then(\n    ({ data }) => data,\n  );\n\n  // Promise doesn't have a cancel method but react-query requires this method to make cancellations general.\n  // This can either be a any assertion or a @ts-ignore comment.\n  (promise as any).cancel = () => {\n    source.cancel('Query was cancelled by React Query');\n  };\n\n  return promise;\n};\n\nexport type ErrorType<TError> = AxiosError<TError>;\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAUA,yBAMO;;;ACNP,mBAAsD;AAG/C,IAAM,iBAAiB,qBAAM,OAAO,EAAE,SAAS;AAmB/C,IAAM,iBAAiB,CAC5B,QACA,YACqB;AACrB,QAAM,SAAS,qBAAM,YAAY;AAEjC,QAAM,UAAU,eAAe,gDAAK,SAAW,UAAhB,EAAyB,aAAa,OAAO,UAAS,KACnF,CAAC,EAAE,WAAW;AAKhB,EAAC,QAAgB,SAAS,MAAM;AAC9B,WAAO,OAAO;AAAA;AAGhB,SAAO;AAAA;;;ADNF,IAAM,cAAc,CACzB,YACG;AACH,SAAO,eACL,EAAE,KAAK,YAAY,QAAQ,SAC3B;AAAA;AAIG,IAAM,yBAAyB,MAAM,CAAC;AAEtC,IAAM,iBAAiB,CAG5B,YAG4D;AAC5D,QAAM,EAAE,OAAO,cAAc,SAAS,mBAAmB,WAAW;AAEpE,QAAM,WAAW,8CAAc,aAAY;AAE3C,QAAM,UAA8D,MAClE,YAAY;AAEd,QAAM,QAAQ,iCACZ,UACA,SACA;AAGF,SAAO;AAAA,IACL;AAAA,KACG;AAAA;AASA,IAAM,aAAa,CACxB,OACA,YACG;AACH,SAAO,eACL,EAAE,KAAK,YAAY,SAAS,QAAQ,SACpC;AAAA;AAIG,IAAM,wBAAwB,CAAC,UAAkB,CAAC,YAAY;AAE9D,IAAM,gBAAgB,CAI3B,OACA,YAI2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,mBAAmB,WAAW;AAEpE,QAAM,WAAW,8CAAc,aAAY,sBAAsB;AAEjE,QAAM,UAA6D,MACjE,WAAW,OAAO;AAEpB,QAAM,QAAQ,iCACZ,UACA,SACA,iBAAE,SAAS,CAAC,CAAC,SAAU;AAGzB,SAAO;AAAA,IACL;AAAA,KACG;AAAA;",
+  "names": []
+}

package/service/service.d.ts

@@ -0,0 +1,44 @@
+import { UseQueryOptions, QueryKey, UseQueryResult } from 'react-query';
+import { I as customInstance, f as ServicesGetResponse, J as ErrorType, E as AsError, S as ServiceGetResponse } from '../custom-instance-3334b00b';
+import 'axios';
+
+/**
+ * Generated by orval v6.4.2 🍺
+ * Do not edit manually.
+ * Account Server API
+ * The Informatics Matters Account Server API.
+
+A service that provides access to the Account Server, which gives *registered* users access to and management of **Products**, **Organisations**, **Units** and **Users**.
+
+ * OpenAPI spec version: 0.1
+ */
+
+declare type SecondParameter<T extends (...args: any) => any> = T extends (config: any, args: infer P) => any ? P : never;
+/**
+ * Gets services known to the Account Server
+
+ * @summary Gets all Services
+ */
+declare const getServices: (options?: SecondParameter<typeof customInstance>) => Promise<ServicesGetResponse>;
+declare const getGetServicesQueryKey: () => string[];
+declare const useGetServices: <TData = ServicesGetResponse, TError = ErrorType<void | AsError>>(options?: {
+    query?: UseQueryOptions<ServicesGetResponse, TError, TData, QueryKey> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+/**
+ * Gets a known service
+
+ * @summary Gets a specific Service
+ */
+declare const getService: (svcid: number, options?: SecondParameter<typeof customInstance>) => Promise<ServiceGetResponse>;
+declare const getGetServiceQueryKey: (svcid: number) => string[];
+declare const useGetService: <TData = ServiceGetResponse, TError = ErrorType<void | AsError>>(svcid: number, options?: {
+    query?: UseQueryOptions<ServiceGetResponse, TError, TData, QueryKey> | undefined;
+    request?: SecondParameter<typeof customInstance>;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+
+export { getGetServiceQueryKey, getGetServicesQueryKey, getService, getServices, useGetService, useGetServices };

package/service/service.js

@@ -0,0 +1,72 @@
+var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+
+// src/service/service.ts
+import {
+  useQuery
+} from "react-query";
+
+// src/custom-instance.ts
+import Axios from "axios";
+var AXIOS_INSTANCE = Axios.create({ baseURL: "" });
+var customInstance = (config, options) => {
+  const source = Axios.CancelToken.source();
+  const promise = AXIOS_INSTANCE(__spreadProps(__spreadValues(__spreadValues({}, config), options), { cancelToken: source.token })).then(({ data }) => data);
+  promise.cancel = () => {
+    source.cancel("Query was cancelled by React Query");
+  };
+  return promise;
+};
+
+// src/service/service.ts
+var getServices = (options) => {
+  return customInstance({ url: `/service`, method: "get" }, options);
+};
+var getGetServicesQueryKey = () => [`/service`];
+var useGetServices = (options) => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+  const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getGetServicesQueryKey();
+  const queryFn = () => getServices(requestOptions);
+  const query = useQuery(queryKey, queryFn, queryOptions);
+  return __spreadValues({
+    queryKey
+  }, query);
+};
+var getService = (svcid, options) => {
+  return customInstance({ url: `/service/${svcid}`, method: "get" }, options);
+};
+var getGetServiceQueryKey = (svcid) => [`/service/${svcid}`];
+var useGetService = (svcid, options) => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+  const queryKey = (queryOptions == null ? void 0 : queryOptions.queryKey) ?? getGetServiceQueryKey(svcid);
+  const queryFn = () => getService(svcid, requestOptions);
+  const query = useQuery(queryKey, queryFn, __spreadValues({ enabled: !!svcid }, queryOptions));
+  return __spreadValues({
+    queryKey
+  }, query);
+};
+export {
+  getGetServiceQueryKey,
+  getGetServicesQueryKey,
+  getService,
+  getServices,
+  useGetService,
+  useGetServices
+};

package/service/service.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/service/service.ts", "../../src/custom-instance.ts"],
+  "sourcesContent": ["/**\n * Generated by orval v6.4.2 \uD83C\uDF7A\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  ServicesGetResponse,\n  AsError,\n  ServiceGetResponse,\n} from \"../account-server-api.schemas\";\nimport { customInstance, ErrorType } from \".././custom-instance\";\n\ntype AsyncReturnType<T extends (...args: any) => Promise<any>> = T extends (\n  ...args: any\n) => Promise<infer R>\n  ? R\n  : any;\n\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 services known to the Account Server\n\n * @summary Gets all Services\n */\nexport const getServices = (\n  options?: SecondParameter<typeof customInstance>\n) => {\n  return customInstance<ServicesGetResponse>(\n    { url: `/service`, method: \"get\" },\n    options\n  );\n};\n\nexport const getGetServicesQueryKey = () => [`/service`];\n\nexport const useGetServices = <\n  TData = AsyncReturnType<typeof getServices>,\n  TError = ErrorType<AsError | void>\n>(options?: {\n  query?: UseQueryOptions<AsyncReturnType<typeof getServices>, TError, TData>;\n  request?: SecondParameter<typeof customInstance>;\n}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {\n  const { query: queryOptions, request: requestOptions } = options || {};\n\n  const queryKey = queryOptions?.queryKey ?? getGetServicesQueryKey();\n\n  const queryFn: QueryFunction<AsyncReturnType<typeof getServices>> = () =>\n    getServices(requestOptions);\n\n  const query = useQuery<AsyncReturnType<typeof getServices>, TError, TData>(\n    queryKey,\n    queryFn,\n    queryOptions\n  );\n\n  return {\n    queryKey,\n    ...query,\n  };\n};\n\n/**\n * Gets a known service\n\n * @summary Gets a specific Service\n */\nexport const getService = (\n  svcid: number,\n  options?: SecondParameter<typeof customInstance>\n) => {\n  return customInstance<ServiceGetResponse>(\n    { url: `/service/${svcid}`, method: \"get\" },\n    options\n  );\n};\n\nexport const getGetServiceQueryKey = (svcid: number) => [`/service/${svcid}`];\n\nexport const useGetService = <\n  TData = AsyncReturnType<typeof getService>,\n  TError = ErrorType<AsError | void>\n>(\n  svcid: number,\n  options?: {\n    query?: UseQueryOptions<AsyncReturnType<typeof getService>, TError, TData>;\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(svcid);\n\n  const queryFn: QueryFunction<AsyncReturnType<typeof getService>> = () =>\n    getService(svcid, requestOptions);\n\n  const query = useQuery<AsyncReturnType<typeof getService>, TError, TData>(\n    queryKey,\n    queryFn,\n    { enabled: !!svcid, ...queryOptions }\n  );\n\n  return {\n    queryKey,\n    ...query,\n  };\n};\n", "/** Based off the example custom-instance from Orval docs\n * https://github.com/anymaniax/orval/blob/master/samples/react-app-with-react-query/src/api/mutator/custom-instance.ts\n *\n * See https://react-query.tanstack.com/guides/query-cancellation\n *\n * TODO: Considering using Fetch-API instead of axios. This instance will have to change. Could be\n * achieved without changing much using `redaxios`\n * Or use 'ky'\n */\n\nimport Axios, { AxiosError, AxiosRequestConfig } from 'axios';\n\n// ? Need the baseUrl or does it default to ''?\nexport const AXIOS_INSTANCE = Axios.create({ baseURL: '' });\n\n/**\n * Set the access token to be added as the `Authorization: Bearer 'token'` header\n * Useful for client only apps where a proxy API route isn't involved to securely add the access token\n * @param token access token\n */\nexport const setAuthToken = (token: string) => {\n  AXIOS_INSTANCE.defaults.headers.common['Authorization'] = `Bearer ${token}`;\n};\n\n/**\n * Set the url to which request paths are added to.\n * @param baseUrl origin + subpath e.g. 'https://example.com/subpath' or '/subpath'\n */\nexport const setBaseUrl = (baseUrl: string) => {\n  AXIOS_INSTANCE.defaults.baseURL = baseUrl;\n};\n\nexport const customInstance = <TReturn>(\n  config: AxiosRequestConfig,\n  options?: AxiosRequestConfig,\n): Promise<TReturn> => {\n  const source = Axios.CancelToken.source();\n\n  const promise = AXIOS_INSTANCE({ ...config, ...options, cancelToken: source.token }).then(\n    ({ data }) => data,\n  );\n\n  // Promise doesn't have a cancel method but react-query requires this method to make cancellations general.\n  // This can either be a any assertion or a @ts-ignore comment.\n  (promise as any).cancel = () => {\n    source.cancel('Query was cancelled by React Query');\n  };\n\n  return promise;\n};\n\nexport type ErrorType<TError> = AxiosError<TError>;\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;AAUA;AAAA;AAAA;;;ACAA;AAGO,IAAM,iBAAiB,MAAM,OAAO,EAAE,SAAS;AAmB/C,IAAM,iBAAiB,CAC5B,QACA,YACqB;AACrB,QAAM,SAAS,MAAM,YAAY;AAEjC,QAAM,UAAU,eAAe,gDAAK,SAAW,UAAhB,EAAyB,aAAa,OAAO,UAAS,KACnF,CAAC,EAAE,WAAW;AAKhB,EAAC,QAAgB,SAAS,MAAM;AAC9B,WAAO,OAAO;AAAA;AAGhB,SAAO;AAAA;;;ADNF,IAAM,cAAc,CACzB,YACG;AACH,SAAO,eACL,EAAE,KAAK,YAAY,QAAQ,SAC3B;AAAA;AAIG,IAAM,yBAAyB,MAAM,CAAC;AAEtC,IAAM,iBAAiB,CAG5B,YAG4D;AAC5D,QAAM,EAAE,OAAO,cAAc,SAAS,mBAAmB,WAAW;AAEpE,QAAM,WAAW,8CAAc,aAAY;AAE3C,QAAM,UAA8D,MAClE,YAAY;AAEd,QAAM,QAAQ,SACZ,UACA,SACA;AAGF,SAAO;AAAA,IACL;AAAA,KACG;AAAA;AASA,IAAM,aAAa,CACxB,OACA,YACG;AACH,SAAO,eACL,EAAE,KAAK,YAAY,SAAS,QAAQ,SACpC;AAAA;AAIG,IAAM,wBAAwB,CAAC,UAAkB,CAAC,YAAY;AAE9D,IAAM,gBAAgB,CAI3B,OACA,YAI2D;AAC3D,QAAM,EAAE,OAAO,cAAc,SAAS,mBAAmB,WAAW;AAEpE,QAAM,WAAW,8CAAc,aAAY,sBAAsB;AAEjE,QAAM,UAA6D,MACjE,WAAW,OAAO;AAEpB,QAAM,QAAQ,SACZ,UACA,SACA,iBAAE,SAAS,CAAC,CAAC,SAAU;AAGzB,SAAO;AAAA,IACL;AAAA,KACG;AAAA;",
+  "names": []
+}

package/src/account-server-api.schemas.ts

@@ -58,6 +58,8 @@ export const UnitProductPostBodyBodyType = {
 export type UnitProductPostBodyBody = {
   /** The name you want to give the Product */
   name: string;
+  /** The service identity for the Product. Products are created for use on a specific service, like a Data Manager instance */
+  service_id: number;
   /** The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be providec. Project Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products */
   type: UnitProductPostBodyBodyType;
   /** The Flavour of the Product. Used only for Project Tier Products. Do nto set this for Storage products */
@@ -92,6 +94,18 @@ export interface UnitDetail {
   owner_id?: string;
 }
 
+export interface ServiceGetResponse {
+  id: number;
+  kind: string;
+  name?: string;
+}
+
+export interface ServicesGetResponse {
+  /** The list of known Servcies
+   */
+  services: ServiceGetResponse[];
+}
+
 export interface OrganisationDetail {
   id: string;
   name: string;
@@ -132,6 +146,9 @@ export interface ProductDetail {
   /** The Product ID
    */
   id: string;
+  /** The Product Service ID
+   */
+  service_id?: number;
   type: ProductDetailType;
   flavour?: ProductDetailFlavour;
   name?: string;

package/src/service/service.ts

@@ -0,0 +1,124 @@
+/**
+ * Generated by orval v6.4.2 🍺
+ * Do not edit manually.
+ * Account Server API
+ * The Informatics Matters Account Server API.
+
+A service that provides access to the Account Server, which gives *registered* users access to and management of **Products**, **Organisations**, **Units** and **Users**.
+
+ * OpenAPI spec version: 0.1
+ */
+import {
+  useQuery,
+  UseQueryOptions,
+  QueryFunction,
+  UseQueryResult,
+  QueryKey,
+} from "react-query";
+import type {
+  ServicesGetResponse,
+  AsError,
+  ServiceGetResponse,
+} from "../account-server-api.schemas";
+import { customInstance, ErrorType } from ".././custom-instance";
+
+type AsyncReturnType<T extends (...args: any) => Promise<any>> = T extends (
+  ...args: any
+) => Promise<infer R>
+  ? R
+  : any;
+
+type SecondParameter<T extends (...args: any) => any> = T extends (
+  config: any,
+  args: infer P
+) => any
+  ? P
+  : never;
+
+/**
+ * Gets services known to the Account Server
+
+ * @summary Gets all Services
+ */
+export const getServices = (
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<ServicesGetResponse>(
+    { url: `/service`, method: "get" },
+    options
+  );
+};
+
+export const getGetServicesQueryKey = () => [`/service`];
+
+export const useGetServices = <
+  TData = AsyncReturnType<typeof getServices>,
+  TError = ErrorType<AsError | void>
+>(options?: {
+  query?: UseQueryOptions<AsyncReturnType<typeof getServices>, TError, TData>;
+  request?: SecondParameter<typeof customInstance>;
+}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetServicesQueryKey();
+
+  const queryFn: QueryFunction<AsyncReturnType<typeof getServices>> = () =>
+    getServices(requestOptions);
+
+  const query = useQuery<AsyncReturnType<typeof getServices>, TError, TData>(
+    queryKey,
+    queryFn,
+    queryOptions
+  );
+
+  return {
+    queryKey,
+    ...query,
+  };
+};
+
+/**
+ * Gets a known service
+
+ * @summary Gets a specific Service
+ */
+export const getService = (
+  svcid: number,
+  options?: SecondParameter<typeof customInstance>
+) => {
+  return customInstance<ServiceGetResponse>(
+    { url: `/service/${svcid}`, method: "get" },
+    options
+  );
+};
+
+export const getGetServiceQueryKey = (svcid: number) => [`/service/${svcid}`];
+
+export const useGetService = <
+  TData = AsyncReturnType<typeof getService>,
+  TError = ErrorType<AsError | void>
+>(
+  svcid: number,
+  options?: {
+    query?: UseQueryOptions<AsyncReturnType<typeof getService>, TError, TData>;
+    request?: SecondParameter<typeof customInstance>;
+  }
+): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, request: requestOptions } = options || {};
+
+  const queryKey = queryOptions?.queryKey ?? getGetServiceQueryKey(svcid);
+
+  const queryFn: QueryFunction<AsyncReturnType<typeof getService>> = () =>
+    getService(svcid, requestOptions);
+
+  const query = useQuery<AsyncReturnType<typeof getService>, TError, TData>(
+    queryKey,
+    queryFn,
+    { enabled: !!svcid, ...queryOptions }
+  );
+
+  return {
+    queryKey,
+    ...query,
+  };
+};

package/unit/unit.d.ts

@@ -1,6 +1,6 @@
 import * as react_query from 'react-query';
 import { UseQueryOptions, QueryKey, UseQueryResult, UseMutationOptions } from 'react-query';
-import { H as customInstance, z as OrganisationUnitsGetResponse, I as ErrorType, D as AsError, O as OrganisationUnitPostBodyBody, A as OrganisationUnitPostResponse, s as UnitsGetResponse } from '../custom-instance-cc5da68e';
+import { I as customInstance, A as OrganisationUnitsGetResponse, J as ErrorType, E as AsError, O as OrganisationUnitPostBodyBody, B as OrganisationUnitPostResponse, t as UnitsGetResponse } from '../custom-instance-3334b00b';
 import 'axios';
 
 declare type SecondParameter<T extends (...args: any) => any> = T extends (config: any, args: infer P) => any ? P : never;

package/user/user.d.ts

@@ -1,6 +1,6 @@
 import * as react_query from 'react-query';
 import { UseQueryOptions, QueryKey, UseQueryResult, UseMutationOptions } from 'react-query';
-import { H as customInstance, B as UsersGetResponse, I as ErrorType, D as AsError } from '../custom-instance-cc5da68e';
+import { I as customInstance, C as UsersGetResponse, J as ErrorType, E as AsError } from '../custom-instance-3334b00b';
 import 'axios';
 
 declare type SecondParameter<T extends (...args: any) => any> = T extends (config: any, args: infer P) => any ? P : never;