@squonk/account-server-client 0.1.31 → 0.1.32

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

@@ -1,5 +1,5 @@
 /**
- * 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.
@@ -8,6 +8,42 @@ A service that provides access to the Account Server, which gives *registered* u
 
  * OpenAPI spec version: 0.1
  */
+export type DetachAssetParams = { m_id?: QMIdParameter };
+
+export type AttachAssetParams = { m_id?: QMIdParameter };
+
+/**
+ * A User Identity
+ */
+export type QUserIdParameter = string;
+
+/**
+ * A Product Identity
+ */
+export type QProductIdParameter = string;
+
+/**
+ * A Unit Identity
+ */
+export type QUnitIdParameter = string;
+
+export type GetAssetParams = {
+  user_id?: QUserIdParameter;
+  product_id?: QProductIdParameter;
+  unit_id?: QUnitIdParameter;
+  org_id?: QOrgIdParameter;
+};
+
+/**
+ * A Merchant Identity
+ */
+export type QMIdParameter = number;
+
+/**
+ * An Organisation Identity
+ */
+export type QOrgIdParameter = string;
+
 export type ProductPatchBodyBody = {
   /** The name you want to give the Product */
   name?: string;
@@ -21,18 +57,15 @@ export type ProductPatchBodyBody = {
  * The Flavour of the Product. Used only for Project Tier Products. Do not set this for Storage products
  */
 export type UnitProductPostBodyBodyFlavour =
-  | "EVALUATION"
-  | "BRONZE"
-  | "SILVER"
-  | "GOLD";
+  typeof UnitProductPostBodyBodyFlavour[keyof typeof UnitProductPostBodyBodyFlavour];
 
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const UnitProductPostBodyBodyFlavour = {
-  EVALUATION: "EVALUATION" as UnitProductPostBodyBodyFlavour,
-  BRONZE: "BRONZE" as UnitProductPostBodyBodyFlavour,
-  SILVER: "SILVER" as UnitProductPostBodyBodyFlavour,
-  GOLD: "GOLD" as UnitProductPostBodyBodyFlavour,
-};
+  EVALUATION: "EVALUATION",
+  BRONZE: "BRONZE",
+  SILVER: "SILVER",
+  GOLD: "GOLD",
+} as const;
 
 /**
  * The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be provided.
@@ -40,16 +73,14 @@ export const UnitProductPostBodyBodyFlavour = {
 Project Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products
  */
 export type UnitProductPostBodyBodyType =
-  | "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION"
-  | "DATA_MANAGER_STORAGE_SUBSCRIPTION";
+  typeof UnitProductPostBodyBodyType[keyof typeof UnitProductPostBodyBodyType];
 
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const UnitProductPostBodyBodyType = {
   DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION:
-    "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION" as UnitProductPostBodyBodyType,
-  DATA_MANAGER_STORAGE_SUBSCRIPTION:
-    "DATA_MANAGER_STORAGE_SUBSCRIPTION" as UnitProductPostBodyBodyType,
-};
+    "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION",
+  DATA_MANAGER_STORAGE_SUBSCRIPTION: "DATA_MANAGER_STORAGE_SUBSCRIPTION",
+} as const;
 
 export type UnitProductPostBodyBody = {
   /** The name you want to give the Product */
@@ -82,6 +113,33 @@ export type OrganisationPostBodyBody = {
   owner: string;
 };
 
+export type AssetPostBodyBodyScope =
+  typeof AssetPostBodyBodyScope[keyof typeof AssetPostBodyBodyScope];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const AssetPostBodyBodyScope = {
+  USER: "USER",
+  PRODUCT: "PRODUCT",
+  UNIT: "UNIT",
+  ORGANISATION: "ORGANISATION",
+} as const;
+
+export 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;
+};
+
 export interface UserDetail {
   /** The user identity (username) */
   id: string;
@@ -109,26 +167,31 @@ export interface UnitDetail {
 /**
  * The kind of Service
  */
-export type ServiceGetResponseKind = "DATA_MANAGER";
+export type MerchantDetailKind =
+  typeof MerchantDetailKind[keyof typeof MerchantDetailKind];
 
 // eslint-disable-next-line @typescript-eslint/no-redeclare
-export const ServiceGetResponseKind = {
-  DATA_MANAGER: "DATA_MANAGER" as ServiceGetResponseKind,
-};
+export const MerchantDetailKind = {
+  DATA_MANAGER: "DATA_MANAGER",
+} as const;
 
-export interface ServiceGetResponse {
+export 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;
 }
 
-export interface ServicesGetResponse {
-  /** The list of known Services
+export type MerchantGetResponse = MerchantDetail;
+
+export interface MerchantsGetResponse {
+  /** The list of known Merchants
    */
-  services: ServiceGetResponse[];
+  merchants: MerchantDetail[];
 }
 
 export interface OrganisationDetail {
@@ -144,13 +207,24 @@ export interface OrganisationDetail {
   private: boolean;
 }
 
+/**
+ * The kind of service that can use the Product
+ */
+export type ProductTypeServiceKind =
+  typeof ProductTypeServiceKind[keyof typeof ProductTypeServiceKind];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const ProductTypeServiceKind = {
+  DATA_MANAGER: "DATA_MANAGER",
+} as const;
+
 export 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;
 }
 
 export type ProductInstanceDetailCoins = {
@@ -167,31 +241,30 @@ export interface ProductInstanceDetail {
  * The Product Type falvour. Not all products have flavours
 
  */
-export type ProductDetailFlavour = "EVALUATION" | "BRONZE" | "SILVER" | "GOLD";
+export type ProductDetailFlavour =
+  typeof ProductDetailFlavour[keyof typeof ProductDetailFlavour];
 
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const ProductDetailFlavour = {
-  EVALUATION: "EVALUATION" as ProductDetailFlavour,
-  BRONZE: "BRONZE" as ProductDetailFlavour,
-  SILVER: "SILVER" as ProductDetailFlavour,
-  GOLD: "GOLD" as ProductDetailFlavour,
-};
+  EVALUATION: "EVALUATION",
+  BRONZE: "BRONZE",
+  SILVER: "SILVER",
+  GOLD: "GOLD",
+} as const;
 
 /**
  * The Product Type
 
  */
 export type ProductDetailType =
-  | "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION"
-  | "DATA_MANAGER_STORAGE_SUBSCRIPTION";
+  typeof ProductDetailType[keyof typeof ProductDetailType];
 
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 export const ProductDetailType = {
   DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION:
-    "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION" as ProductDetailType,
-  DATA_MANAGER_STORAGE_SUBSCRIPTION:
-    "DATA_MANAGER_STORAGE_SUBSCRIPTION" as ProductDetailType,
-};
+    "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION",
+  DATA_MANAGER_STORAGE_SUBSCRIPTION: "DATA_MANAGER_STORAGE_SUBSCRIPTION",
+} as const;
 
 export interface ProductDetail {
   /** The Product ID
@@ -284,17 +357,41 @@ export interface ProductDmStorage {
   coins: ProductCoinsDetail;
 }
 
-export type UserAccountGetResponse = UserAccountDetail;
+export type AssetDetailScope =
+  typeof AssetDetailScope[keyof typeof AssetDetailScope];
 
-export interface UnitGetResponse {
-  /** The Unit's unique ID */
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const AssetDetailScope = {
+  USER: "USER",
+  PRODUCT: "PRODUCT",
+  UNIT: "UNIT",
+  ORGANISATION: "ORGANISATION",
+} as const;
+
+export 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[];
 }
 
+export type UserAccountGetResponse = UserAccountDetail;
+
+export interface UnitsGetResponse {
+  /** A list of Units
+   */
+  units: OrganisationUnitsGetResponse[];
+}
+
+export type UnitGetResponse = UnitDetail;
+
 export interface UnitProductPostResponse {
   /** The Products's unique ID */
   id: string;
@@ -338,12 +435,6 @@ export interface OrganisationUnitsGetResponse {
   units: UnitDetail[];
 }
 
-export interface UnitsGetResponse {
-  /** A list of Units
-   */
-  units: OrganisationUnitsGetResponse[];
-}
-
 export interface PersonalUnitPutResponse {
   /** The unit's Organisation. Used to identify the Default organisation */
   organisation_id: string;
@@ -389,6 +480,18 @@ export interface StateGetVersionResponse {
   version: string;
 }
 
+export interface AssetPostResponse {
+  /** The Asset ID
+   */
+  id: string;
+}
+
+export interface AssetGetResponse {
+  /** A list of Assets
+   */
+  assets: AssetDetail[];
+}
+
 export interface AsError {
   /** Brief error text that can be presented to the user */
   error: string;