@squonk/account-server-client 4.3.1 → 4.4.0-4-4.2174798239

package/dist/api/api.schemas.d.ts

@@ -0,0 +1,1032 @@
+//#region src/api/api.schemas.d.ts
+/**
+ * Generated by orval v7.16.1 🍺
+ * 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 **Organisations**, **Units**, **Products**, **Users**, and **Assets**.
+
+ * OpenAPI spec version: 4.4
+ */
+interface AsError {
+  /** Brief error text that can be presented to the user */
+  error: string;
+}
+interface ActionGetResponse {
+  /** A list of Actions
+   */
+  actions: ActionDetail[];
+  /** The number of Actions returned
+   */
+  count: number;
+}
+interface ActionDetail {
+  id: number;
+  action: string;
+  content: string;
+  timestamp: string;
+  merchant?: MerchantSummary;
+  product_id?: string;
+  unit_id?: string;
+  org_id?: string;
+}
+type AssetGetByIdResponse = AssetDetail;
+interface AssetGetResponse {
+  /** A list of Assets
+   */
+  assets: AssetDetail[];
+  /** The number of Assets returned
+   */
+  count: number;
+}
+interface AssetPostResponse {
+  /** The Asset ID
+   */
+  id: string;
+}
+interface ChargesGetResponse {
+  coins: string;
+  count: number;
+  summary: ChargeSummary[];
+  organisation_charges: OrganisationChargeSummary[];
+}
+interface EventStreamGetPostResponse {
+  /** The EventStream ID */
+  id: number;
+  /** A symbolic name, used internally to identify the stream */
+  name: string;
+  /** The Event Stream location. This will be a URL where events can be fetched. The protocol is typically a WebSocket, but the protocol is defined by the specific Event Stream Service that has been deployed. */
+  location: string;
+  /** The Event Stream format. */
+  format: string;
+}
+/**
+ * The Event Stream protocol, used to inform the client how to connect to given locations and handle events. At the moment the AS only supports web-sockets.
+ */
+type EventStreamVersionGetResponseProtocol = (typeof EventStreamVersionGetResponseProtocol)[keyof typeof EventStreamVersionGetResponseProtocol];
+declare const EventStreamVersionGetResponseProtocol: {
+  readonly ERROR_INTERNAL: "ERROR_INTERNAL";
+  readonly SERVICE_NOT_PRESENT: "SERVICE_NOT_PRESENT";
+  readonly WEBSOCKET: "WEBSOCKET";
+};
+interface EventStreamVersionGetResponse {
+  /** The EventStream implementation version */
+  version: string;
+  /** The Event Stream protocol, used to inform the client how to connect to given locations and handle events. At the moment the AS only supports web-sockets. */
+  protocol: EventStreamVersionGetResponseProtocol;
+  /** The name of the Event Stream implementation, often used to identify the service origin and implementation. */
+  name: string;
+}
+interface StateGetVersionResponse {
+  /** The Account Server version. This is guaranteed to be a valid semantic version for official (tagged) images. The version value format for unofficial images is a string but otherwise undefined
+   */
+  version: string;
+}
+interface OrganisationPostResponse {
+  /** The Organisation's unique ID */
+  id: string;
+}
+interface UsersGetResponse {
+  count: number;
+  organisation?: OrganisationDetail;
+  unit?: UnitDetail;
+  /** The list of Organisation Users
+   */
+  users: UserDetail[];
+}
+/**
+ * The Organisation's default product privacy setting
+ */
+type OrganisationGetDefaultResponseDefaultProductPrivacy = (typeof OrganisationGetDefaultResponseDefaultProductPrivacy)[keyof typeof OrganisationGetDefaultResponseDefaultProductPrivacy];
+declare const OrganisationGetDefaultResponseDefaultProductPrivacy: {
+  readonly ALWAYS_PUBLIC: "ALWAYS_PUBLIC";
+  readonly ALWAYS_PRIVATE: "ALWAYS_PRIVATE";
+  readonly DEFAULT_PUBLIC: "DEFAULT_PUBLIC";
+  readonly DEFAULT_PRIVATE: "DEFAULT_PRIVATE";
+};
+interface OrganisationGetDefaultResponse {
+  /** Whether the user making the API call is a member of the Default Organisation. Only admin users are members of the Default organisation */
+  caller_is_member?: boolean;
+  /** The Default Organisation ID
+   */
+  id?: string;
+  /** The Default Organisation Name
+   */
+  name?: string;
+  /** True if the Organisation is private. The Default organisation is always public, although it does not contain a membership (unless you're admin) and only houses Personal Units
+   */
+  private?: boolean;
+  created?: string;
+  /** The Organisation's default product privacy setting */
+  default_product_privacy?: OrganisationGetDefaultResponseDefaultProductPrivacy;
+}
+interface OrganisationUnitPostResponse {
+  /** The unit's unique ID */
+  id: string;
+}
+interface PersonalUnitPutResponse {
+  /** The unit's Organisation. Used to identify the Default organisation */
+  organisation_id: string;
+  /** The unit's unique ID */
+  id: string;
+}
+interface OrganisationChargeSummary {
+  organisation_id: string;
+  name: string;
+  summary: ChargeSummary[];
+}
+interface OrganisationUnitsGetResponse {
+  count?: number;
+  organisation: OrganisationAllDetail;
+  /** A list of Units
+   */
+  units: UnitAllDetail[];
+}
+interface OrganisationChargesGetResponse {
+  organisation_id: string;
+  name: string;
+  coins: string;
+  summary: ChargeSummary[];
+  unit_charges: OrganisationUnitChargeSummary[];
+}
+interface OrganisationUnitChargeSummary {
+  unit_id: string;
+  name: string;
+  /**
+   * @minimum 1
+   * @maximum 28
+   */
+  billing_day: number;
+  /** The start of the charge period */
+  from: string;
+  /** The date where of first day after the charge period */
+  until: string;
+  summary: ChargeSummary[];
+}
+interface OrganisationsGetResponse {
+  count: number;
+  /** A list of Organisations */
+  organisations: OrganisationAllDetail[];
+}
+type OrganisationGetResponse = OrganisationAllDetail;
+type ProductChargesGetResponseProductType = (typeof ProductChargesGetResponseProductType)[keyof typeof ProductChargesGetResponseProductType];
+declare const ProductChargesGetResponseProductType: {
+  readonly DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION";
+  readonly DATA_MANAGER_STORAGE_SUBSCRIPTION: "DATA_MANAGER_STORAGE_SUBSCRIPTION";
+};
+interface ProductChargesGetResponse {
+  product_id: string;
+  product_type: ProductChargesGetResponseProductType;
+  /**
+   * @minimum 1
+   * @maximum 28
+   */
+  billing_day: number;
+  /** True if the product can be (needs to be) claimed. */
+  claimable: boolean;
+  claim?: ProductClaimDetail;
+  count: number;
+  /** The start of the charge period */
+  from: string;
+  /** The date where of first day after the charge period */
+  until: string;
+  /** The total number of coins consumed by this product for the invoice period */
+  coins: string;
+  processing_charges: ProcessingCharges[];
+  storage_charges: StorageCharges;
+}
+type ProductsGetResponseProductsItem = ProductDmStorage | ProductDmProjectTier;
+interface ProductsGetResponse {
+  count: number;
+  /** All the Products you have access to */
+  products: ProductsGetResponseProductsItem[];
+}
+type ProductsGetDefaultStorageCostDefaultStorageCost = {
+  cost: string;
+  units: string;
+  description: string;
+};
+interface ProductsGetDefaultStorageCost {
+  default_storage_cost: ProductsGetDefaultStorageCostDefaultStorageCost;
+}
+interface ProductsGetTypesResponse {
+  /** The number of Product Types */
+  count: number;
+  /** All the Product Types you have access to */
+  product_types: ProductType[];
+}
+/**
+ * The Unit's Product
+ */
+type ProductUnitGetResponseProduct = ProductDmStorage | ProductDmProjectTier;
+interface ProductUnitGetResponse {
+  /** The Unit's Product */
+  product: ProductUnitGetResponseProduct;
+}
+interface UnitChargesGetResponse {
+  /** Whether the user making the API call is a member of the Unit */
+  caller_is_member: boolean;
+  unit_id: string;
+  name?: string;
+  /** The Unit's owner (a username) */
+  owner_id: string;
+  /** True if the Unit is private */
+  private: boolean;
+  created: string;
+  coins: string;
+  count: number;
+  /**
+   * @minimum 1
+   * @maximum 28
+   */
+  billing_day: number;
+  /** The start of the charge period */
+  from: string;
+  /** The date where of first day after the charge period */
+  until: string;
+  summary: UnitChargeSummary;
+  products: UnitProductChargeSummary[];
+}
+interface UnitChargeSummary {
+  charges: ChargeSummary[];
+}
+interface UnitProductChargeSummary {
+  product_id: string;
+  product_type: string;
+  charges: ChargeSummary[];
+}
+/**
+ * The type of charge
+ */
+type ChargeSummaryType = (typeof ChargeSummaryType)[keyof typeof ChargeSummaryType];
+declare const ChargeSummaryType: {
+  readonly PROCESSING: "PROCESSING";
+  readonly STORAGE: "STORAGE";
+};
+interface ChargeSummary {
+  /** The type of charge */
+  type: ChargeSummaryType;
+  /** The cost, in coins of the charge */
+  coins: string;
+}
+interface UnitProductPostResponse {
+  /** The Product's unique ID */
+  id: string;
+}
+type UnitGetResponse = UnitAllDetail;
+interface UnitsGetResponse {
+  /** A list of Units
+   */
+  units: OrganisationUnitsGetResponse[];
+}
+type UserAccountGetResponse = UserAccountDetail;
+type AssetDetailScope = (typeof AssetDetailScope)[keyof typeof AssetDetailScope];
+declare const AssetDetailScope: {
+  readonly USER: "USER";
+  readonly PRODUCT: "PRODUCT";
+  readonly UNIT: "UNIT";
+  readonly ORGANISATION: "ORGANISATION";
+  readonly GLOBAL: "GLOBAL";
+};
+interface AssetDetail {
+  creator: string;
+  id: string;
+  name: string;
+  scope: AssetDetailScope;
+  scope_id: string;
+  secret: boolean;
+  disabled: boolean;
+  content: string;
+  created: string;
+  content_modified?: string;
+  description?: string;
+  merchants: MerchantDetail[];
+}
+type ProcessingChargesMerchantKind = (typeof ProcessingChargesMerchantKind)[keyof typeof ProcessingChargesMerchantKind];
+declare const ProcessingChargesMerchantKind: {
+  readonly DATA_MANAGER: "DATA_MANAGER";
+};
+interface ProcessingCharges {
+  merchant_name: string;
+  merchant_kind: ProcessingChargesMerchantKind;
+  merchant_api_hostname: string;
+  /** The date when the process stopped */
+  closed?: string;
+  /** True if no further change to the charges can occur. Typically True after the charge has been closed for a pre-configured period of time. */
+  final: boolean;
+  /** True if charges were received after the charge record was finalised */
+  post_final_charges?: boolean;
+  charge: ProcessingChargeItem;
+}
+interface ProcessingChargeItem {
+  /** The charge record number */
+  id: number;
+  /** The most recent sequence number for this charge */
+  sqn: number;
+  name?: string;
+  username: string;
+  /** The date and time of the processing charge */
+  timestamp: string;
+  /** The coin-cost of the storage */
+  coins: string;
+  additional_data?: ChargeAdditionalData;
+}
+interface StorageCharges {
+  num_items: number;
+  items: StorageChargeItem[];
+}
+interface StorageChargeItem {
+  item_number: number;
+  /** The date and time of the processing charge */
+  date: string;
+  /** The coin-cost of the storage */
+  coins: string;
+  /** The current burn rate, the approximate amount of coins you are currently consuming each day */
+  current_burn_rate?: string;
+  /** The date when the charges concluded */
+  closed?: string;
+  additional_data?: ChargeAdditionalData;
+}
+interface ChargeAdditionalData {
+  [key: string]: unknown;
+}
+interface ProductDmStorage {
+  product: ProductDetail;
+  organisation: OrganisationAllDetail;
+  unit: UnitAllDetail;
+  storage: ProductDmStorageDetail;
+  coins: ProductCoinsDetail;
+  /** True if the product can be (needs to be) claimed. */
+  claimable: boolean;
+}
+interface ProductDmProjectTier {
+  product: ProductDetail;
+  organisation: OrganisationAllDetail;
+  unit: UnitAllDetail;
+  storage: ProductDmStorageDetail;
+  coins: ProductCoinsDetail;
+  instance: ProductInstanceDetail;
+  /** True if the product can be (needs to be) claimed. */
+  claimable: boolean;
+  claim?: ProductClaimDetail;
+}
+type ProductDmStorageDetailSize = {
+  /** The humanised size of the peak storage used for the current day. The value is reset at the start of each day */
+  peak: string;
+  /** The humanised size of the current storage used for the current day and used to calculate the 'burn rate' */
+  current: string;
+  /** The humanised storage unit. The cost of storage is based on the daily peak of the number of units (or part thereof) used */
+  unit_size: string;
+  /** The peak number of storage units used today */
+  units_used: number;
+};
+type ProductDmStorageDetailCoins = {
+  /** The number of coins currently committed for the current day. This is added to the accumulated coins at the start of each day */
+  used: number;
+  /** The coin cost of a 'unit' of storage or part thereof. The unit size is defined in the storage section of the response */
+  unit_cost: number;
+};
+interface ProductDmStorageDetail {
+  size: ProductDmStorageDetailSize;
+  coins: ProductDmStorageDetailCoins;
+}
+interface ProductClaimDetail {
+  /** The service-specific ID that is using this Subscription
+   */
+  id: string;
+  /** A name for the service-specific ID
+   */
+  name?: string;
+}
+interface ProductCoinsDetail {
+  /** The billing allowance. When you exceed this during the current billing period the *cost multiplier* will increase */
+  allowance: number;
+  /** 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 */
+  limit: number;
+  /** The total number of coins consumed (in this billing period), excluding the coins that have been consumed for the current day */
+  used: number;
+  /** True if the product is operating at or beyond its coin limit. When it is authority to perform actions using the product are severely limited. */
+  at_limit: boolean;
+  /** The current burn rate, the approximate amount of coins you are currently consuming each day */
+  current_burn_rate: number;
+  /** The predicted total billing period amount, if costs continue at the current burn rate until the end of the billing period. This is an estimate */
+  billing_prediction: number;
+  /** The predicted storage contribution to the billing period amount, if costs continue at the current burn rate until the end of the billing period. This is an estimate */
+  billing_prediction_storage_contribution: number;
+  /** The day of the month when the bill is due, and the end of the current billing period */
+  billing_day: number;
+  /** A multiplier applied to your coin usage within your allowance */
+  allowance_multiplier: number;
+  /** A multiplier that will be applied to coin used beyond your allowance */
+  overspend_multiplier: number;
+  /** The number of days remaining, in the current billing period */
+  remaining_days: number;
+}
+/**
+ * The Product Type
+
+ */
+type ProductDetailType = (typeof ProductDetailType)[keyof typeof ProductDetailType];
+declare const ProductDetailType: {
+  readonly DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION";
+  readonly DATA_MANAGER_STORAGE_SUBSCRIPTION: "DATA_MANAGER_STORAGE_SUBSCRIPTION";
+};
+/**
+ * The Product Type flavour. Not all products have flavours
+
+ */
+type ProductDetailFlavour = (typeof ProductDetailFlavour)[keyof typeof ProductDetailFlavour];
+declare const ProductDetailFlavour: {
+  readonly EVALUATION: "EVALUATION";
+  readonly BRONZE: "BRONZE";
+  readonly SILVER: "SILVER";
+  readonly GOLD: "GOLD";
+};
+interface ProductDetail {
+  /** The Product ID
+   */
+  id: string;
+  created: string;
+  /** The Product Type
+   */
+  type: ProductDetailType;
+  /** The Product Type flavour. Not all products have flavours
+   */
+  flavour?: ProductDetailFlavour;
+  /** The name of the Product
+   */
+  name?: string;
+}
+type ProductInstanceDetailCoins = {
+  /** The number of coins used
+   */
+  used: number;
+};
+interface ProductInstanceDetail {
+  coins: ProductInstanceDetailCoins;
+}
+/**
+ * The kind of service that can use the Product
+ */
+type ProductTypeServiceKind = (typeof ProductTypeServiceKind)[keyof typeof ProductTypeServiceKind];
+declare const ProductTypeServiceKind: {
+  readonly DATA_MANAGER: "DATA_MANAGER";
+};
+interface ProductType {
+  /** A product type, this is a unique string amongst all types known to the Account Server */
+  type: string;
+  /** A product flavour. Not all types have a flavour, those that do have a type-specific flavour string */
+  flavour?: string;
+  /** The kind of service that can use the Product */
+  service_kind?: ProductTypeServiceKind;
+}
+/**
+ * The Organisation's default product privacy setting
+ */
+type OrganisationAllDetailDefaultProductPrivacy = (typeof OrganisationAllDetailDefaultProductPrivacy)[keyof typeof OrganisationAllDetailDefaultProductPrivacy];
+declare const OrganisationAllDetailDefaultProductPrivacy: {
+  readonly ALWAYS_PUBLIC: "ALWAYS_PUBLIC";
+  readonly ALWAYS_PRIVATE: "ALWAYS_PRIVATE";
+  readonly DEFAULT_PUBLIC: "DEFAULT_PUBLIC";
+  readonly DEFAULT_PRIVATE: "DEFAULT_PRIVATE";
+};
+interface OrganisationAllDetail {
+  /** Whether the user making the API call is a member of the Unit */
+  caller_is_member: boolean;
+  /** The Organisation's unique ID */
+  id: string;
+  /** The Organisation's name */
+  name: string;
+  /** The username of the Organisation's owner. Not all Organisations have an owner. The Default Organisation has no owner. */
+  owner_id?: string;
+  /** True if the Unit is private */
+  private: boolean;
+  created: string;
+  /** The Organisation's default product privacy setting */
+  default_product_privacy: OrganisationAllDetailDefaultProductPrivacy;
+  /** A list of users that are members of the Organisation */
+  users: UserDetail[];
+}
+/**
+ * The Organisation's default product privacy setting
+ */
+type OrganisationDetailDefaultProductPrivacy = (typeof OrganisationDetailDefaultProductPrivacy)[keyof typeof OrganisationDetailDefaultProductPrivacy];
+declare const OrganisationDetailDefaultProductPrivacy: {
+  readonly ALWAYS_PUBLIC: "ALWAYS_PUBLIC";
+  readonly ALWAYS_PRIVATE: "ALWAYS_PRIVATE";
+  readonly DEFAULT_PUBLIC: "DEFAULT_PUBLIC";
+  readonly DEFAULT_PRIVATE: "DEFAULT_PRIVATE";
+};
+interface OrganisationDetail {
+  /** Whether the user making the API call is a member of the Unit */
+  caller_is_member: boolean;
+  /** The Organisation's unique ID */
+  id: string;
+  /** The Organisation's name */
+  name: string;
+  /** The username of the Organisation's owner. Not all Organisations have an owner. The Default Organisation has no owner. */
+  owner_id?: string;
+  /** True if the Unit is private */
+  private: boolean;
+  created: string;
+  /** The Organisation's default product privacy setting */
+  default_product_privacy: OrganisationDetailDefaultProductPrivacy;
+}
+interface MerchantsGetResponse {
+  count?: number;
+  /** The list of known Merchants
+   */
+  merchants: MerchantDetail[];
+}
+type MerchantGetResponse = MerchantDetail;
+/**
+ * The kind of Service
+ */
+type MerchantDetailKind = (typeof MerchantDetailKind)[keyof typeof MerchantDetailKind];
+declare const MerchantDetailKind: {
+  readonly DATA_MANAGER: "DATA_MANAGER";
+};
+interface MerchantDetail {
+  /** The unique ID of the Service */
+  id: number;
+  created: string;
+  /** The kind of Service */
+  kind: MerchantDetailKind;
+  /** The name assigned to the Service */
+  name: string;
+  /** The hostname used by the Service */
+  api_hostname: string;
+}
+/**
+ * The kind of Service
+ */
+type MerchantSummaryKind = (typeof MerchantSummaryKind)[keyof typeof MerchantSummaryKind];
+declare const MerchantSummaryKind: {
+  readonly DATA_MANAGER: "DATA_MANAGER";
+};
+interface MerchantSummary {
+  /** The unique ID of the Merchant */
+  id: number;
+  /** The kind of Service */
+  kind: MerchantSummaryKind;
+  /** The name assigned to the Service */
+  name: string;
+}
+/**
+ * The Unit's default product privacy setting
+ */
+type UnitAllDetailDefaultProductPrivacy = (typeof UnitAllDetailDefaultProductPrivacy)[keyof typeof UnitAllDetailDefaultProductPrivacy];
+declare const UnitAllDetailDefaultProductPrivacy: {
+  readonly ALWAYS_PUBLIC: "ALWAYS_PUBLIC";
+  readonly ALWAYS_PRIVATE: "ALWAYS_PRIVATE";
+  readonly DEFAULT_PUBLIC: "DEFAULT_PUBLIC";
+  readonly DEFAULT_PRIVATE: "DEFAULT_PRIVATE";
+};
+interface UnitAllDetail {
+  /** Whether the user making the API call is a member of the Unit */
+  caller_is_member: boolean;
+  /** The Unit's unique identity */
+  id: string;
+  /** The Unit's name */
+  name: string;
+  /** The Unit's owner (a username) */
+  owner_id: string;
+  /** True if the Unit is private */
+  private: boolean;
+  created: string;
+  /** The Unit's billing day */
+  billing_day: number;
+  /** The Unit's default product privacy setting */
+  default_product_privacy: UnitAllDetailDefaultProductPrivacy;
+  /** A list of users that are members of the Unit */
+  users: UserDetail[];
+}
+/**
+ * The Unit's default product privacy setting
+ */
+type UnitDetailDefaultProductPrivacy = (typeof UnitDetailDefaultProductPrivacy)[keyof typeof UnitDetailDefaultProductPrivacy];
+declare const UnitDetailDefaultProductPrivacy: {
+  readonly ALWAYS_PUBLIC: "ALWAYS_PUBLIC";
+  readonly ALWAYS_PRIVATE: "ALWAYS_PRIVATE";
+  readonly DEFAULT_PUBLIC: "DEFAULT_PUBLIC";
+  readonly DEFAULT_PRIVATE: "DEFAULT_PRIVATE";
+};
+interface UnitDetail {
+  /** Whether the user making the API call is a member of the Unit */
+  caller_is_member: boolean;
+  /** The Unit's unique identity */
+  id: string;
+  /** The Unit's name */
+  name: string;
+  /** The Unit's owner (a username) */
+  owner_id: string;
+  /** True if the Unit is private */
+  private: boolean;
+  created: string;
+  /** The Unit's billing day */
+  billing_day: number;
+  /** The Unit's default product privacy setting */
+  default_product_privacy: UnitDetailDefaultProductPrivacy;
+}
+interface UserAccountDetail {
+  user: UserDetail;
+  /** Whether the caller has admin privilege */
+  caller_has_admin_privilege: boolean;
+  /** The roles assigned to the user recognised by the Account Server */
+  account_server_roles: string[];
+}
+interface UserDetail {
+  /** The user identity (username) */
+  id: string;
+}
+type AssetPatchBodyBody = {
+  /** 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;
+  /** An optional description for the Asset */
+  description?: string;
+};
+/**
+ * An enumeration of the scope of the asset. This can be one of `USER`, `PRODUCT`, `UNIT`, `ORGANISATION`, or `GLOBAL`. Assets that are not `GLOBAL` need a scope ID.
+ */
+type AssetPostBodyBodyScope = (typeof AssetPostBodyBodyScope)[keyof typeof AssetPostBodyBodyScope];
+declare const AssetPostBodyBodyScope: {
+  readonly USER: "USER";
+  readonly PRODUCT: "PRODUCT";
+  readonly UNIT: "UNIT";
+  readonly ORGANISATION: "ORGANISATION";
+  readonly GLOBAL: "GLOBAL";
+};
+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
+   * @maxLength 80
+   * @pattern ^[a-z0-9-]{1,63}$
+   */
+  name: string;
+  /** A file containing the content for the asset. You must provide a value here or in **content_string** but not both */
+  content_file?: Blob;
+  /** The textual content of the asset. You must provide a value here or in **content_file** but not both */
+  content_string?: string;
+  /** An enumeration of the scope of the asset. This can be one of `USER`, `PRODUCT`, `UNIT`, `ORGANISATION`, or `GLOBAL`. Assets that are not `GLOBAL` need a scope ID. */
+  scope: AssetPostBodyBodyScope;
+  /** The unique identity based on the Scope of the asset. For example, this will be the Unit ID if it's a UNIT. A scope_id is required if the scope is USER as it will be automatically set to your username. Global assets do not have a scope. */
+  scope_id?: string;
+  /** Is this a secret asset? Secret assets are not revealed in a subsequent **GET** but are revealed to merchants they are connected to. */
+  secret: boolean;
+  /** An optional description for the Asset */
+  description?: string;
+};
+type EventStreamPostBodyBodyFormat = (typeof EventStreamPostBodyBodyFormat)[keyof typeof EventStreamPostBodyBodyFormat];
+declare const EventStreamPostBodyBodyFormat: {
+  readonly PROTOCOL_STRING: "PROTOCOL_STRING";
+  readonly JSON_STRING: "JSON_STRING";
+};
+type EventStreamPostBodyBody = {
+  format?: EventStreamPostBodyBodyFormat;
+};
+/**
+ * The default product privacy setting for the Organisation
+ */
+type OrganisationPostBodyBodyDefaultProductPrivacy = (typeof OrganisationPostBodyBodyDefaultProductPrivacy)[keyof typeof OrganisationPostBodyBodyDefaultProductPrivacy];
+declare const OrganisationPostBodyBodyDefaultProductPrivacy: {
+  readonly ALWAYS_PUBLIC: "ALWAYS_PUBLIC";
+  readonly ALWAYS_PRIVATE: "ALWAYS_PRIVATE";
+  readonly DEFAULT_PUBLIC: "DEFAULT_PUBLIC";
+  readonly DEFAULT_PRIVATE: "DEFAULT_PRIVATE";
+};
+type OrganisationPostBodyBody = {
+  /**
+   * The name of the organisation
+   * @maxLength 80
+   */
+  name: string;
+  /** The name of the organisation owner. A user ID */
+  owner: string;
+  /** The default product privacy setting for the Organisation */
+  default_product_privacy?: OrganisationPostBodyBodyDefaultProductPrivacy;
+};
+type PersonalUnitPutBodyBody = {
+  /**
+   * The day you would like to be billed for the Unit's Products (a value from 1 and 28)
+   * @minimum 1
+   * @maximum 28
+   */
+  billing_day: number;
+};
+/**
+ * The default product privacy setting for products in the unit. Whether the privacy can be honoured will depend on the organisation's value
+ */
+type OrganisationUnitPostBodyBodyDefaultProductPrivacy = (typeof OrganisationUnitPostBodyBodyDefaultProductPrivacy)[keyof typeof OrganisationUnitPostBodyBodyDefaultProductPrivacy];
+declare const OrganisationUnitPostBodyBodyDefaultProductPrivacy: {
+  readonly ALWAYS_PUBLIC: "ALWAYS_PUBLIC";
+  readonly ALWAYS_PRIVATE: "ALWAYS_PRIVATE";
+  readonly DEFAULT_PUBLIC: "DEFAULT_PUBLIC";
+  readonly DEFAULT_PRIVATE: "DEFAULT_PRIVATE";
+};
+type OrganisationUnitPostBodyBody = {
+  /**
+   * The name of the unit
+   * @maxLength 80
+   */
+  name: string;
+  /**
+   * The day you would like to be billed for the Unit's Products (a value from 1 and 28)
+   * @minimum 1
+   * @maximum 28
+   */
+  billing_day: number;
+  /** The default product privacy setting for products in the unit. Whether the privacy can be honoured will depend on the organisation's value */
+  default_product_privacy?: OrganisationUnitPostBodyBodyDefaultProductPrivacy;
+};
+/**
+ * The new default **Product** privacy applied to all products that belong to this Organisation. Privacy is also controlled at the **Unit** level. As an example the Organisation level privacy can be `DEFAULT_PRIVATE`, but the unit can declare its Products to be `ALWAYS_PRIVATE`.
+
+Whether the privacy can be honoured will depend on the value in any of the organisation's existing units
+ */
+type OrganisationPatchBodyBodyDefaultProductPrivacy = (typeof OrganisationPatchBodyBodyDefaultProductPrivacy)[keyof typeof OrganisationPatchBodyBodyDefaultProductPrivacy];
+declare const OrganisationPatchBodyBodyDefaultProductPrivacy: {
+  readonly ALWAYS_PUBLIC: "ALWAYS_PUBLIC";
+  readonly ALWAYS_PRIVATE: "ALWAYS_PRIVATE";
+  readonly DEFAULT_PUBLIC: "DEFAULT_PUBLIC";
+  readonly DEFAULT_PRIVATE: "DEFAULT_PRIVATE";
+};
+type OrganisationPatchBodyBody = {
+  /** The new name for the Organisational */
+  name?: string;
+  /** The new default **Product** privacy applied to all products that belong to this Organisation. Privacy is also controlled at the **Unit** level. As an example the Organisation level privacy can be `DEFAULT_PRIVATE`, but the unit can declare its Products to be `ALWAYS_PRIVATE`.
+   Whether the privacy can be honoured will depend on the value in any of the organisation's existing units */
+  default_product_privacy?: OrganisationPatchBodyBodyDefaultProductPrivacy;
+};
+/**
+ * The new default **Product** privacy applied to all products that belong to this Unit. Privacy is also controlled at the **Organisation** level. As an example, the Unit can declare its Products to be `DEFAULT_PRIVATE`, but the Organisation can declare its value to be `DEFAULT_PUBLIC`.
+
+Whether the privacy can be honoured will depend on the organisation's value
+ */
+type UnitPatchBodyBodyDefaultProductPrivacy = (typeof UnitPatchBodyBodyDefaultProductPrivacy)[keyof typeof UnitPatchBodyBodyDefaultProductPrivacy];
+declare const UnitPatchBodyBodyDefaultProductPrivacy: {
+  readonly ALWAYS_PUBLIC: "ALWAYS_PUBLIC";
+  readonly ALWAYS_PRIVATE: "ALWAYS_PRIVATE";
+  readonly DEFAULT_PUBLIC: "DEFAULT_PUBLIC";
+  readonly DEFAULT_PRIVATE: "DEFAULT_PRIVATE";
+};
+type UnitPatchBodyBody = {
+  /** The new name for the Unit */
+  name?: string;
+  /** The new default **Product** privacy applied to all products that belong to this Unit. Privacy is also controlled at the **Organisation** level. As an example, the Unit can declare its Products to be `DEFAULT_PRIVATE`, but the Organisation can declare its value to be `DEFAULT_PUBLIC`.
+   Whether the privacy can be honoured will depend on the organisation's value */
+  default_product_privacy?: UnitPatchBodyBodyDefaultProductPrivacy;
+};
+/**
+ * The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be provided.
+
+Project Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products
+ */
+type UnitProductPostBodyBodyType = (typeof UnitProductPostBodyBodyType)[keyof typeof UnitProductPostBodyBodyType];
+declare const UnitProductPostBodyBodyType: {
+  readonly DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION: "DATA_MANAGER_PROJECT_TIER_SUBSCRIPTION";
+  readonly DATA_MANAGER_STORAGE_SUBSCRIPTION: "DATA_MANAGER_STORAGE_SUBSCRIPTION";
+};
+/**
+ * The Flavour of the Product. Used only for Project Tier Products. Do not set this for Storage products
+ */
+type UnitProductPostBodyBodyFlavour = (typeof UnitProductPostBodyBodyFlavour)[keyof typeof UnitProductPostBodyBodyFlavour];
+declare const UnitProductPostBodyBodyFlavour: {
+  readonly EVALUATION: "EVALUATION";
+  readonly BRONZE: "BRONZE";
+  readonly SILVER: "SILVER";
+  readonly GOLD: "GOLD";
+};
+type UnitProductPostBodyBody = {
+  /**
+   * The name you want to give the Product
+   * @maxLength 80
+   */
+  name: string;
+  /** The Type of Product. Storage subscriptions require an **Allowance** to be defined and the **Flavour** must not be provided.
+   Project Tier subscriptions have built-in allowances and Limits so you must not provide values for these for these products */
+  type: UnitProductPostBodyBodyType;
+  /** The Flavour of the Product. Used only for Project Tier Products. Do not set this for Storage products */
+  flavour?: UnitProductPostBodyBodyFlavour;
+  /**
+   * The Product's coin allowance. You must provide this for Storage products but you must not provide a value for Project Tier Products
+   * @minimum 1
+   */
+  allowance?: number;
+  /**
+   * 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
+   * @minimum 1
+   */
+  limit?: number;
+};
+type ProductPatchBodyBody = {
+  /**
+   * The name you want to give the Product
+   * @maxLength 80
+   */
+  name?: string;
+  /**
+   * The Product's built-in coin allowance. Product allowances cannot be reduced
+   * @minimum 1
+   */
+  allowance?: number;
+  /**
+   * The Product's built-in coin limit. If set it must not be less than the allowance. If not set the allowance is used. The existing product limit cannot be reduced
+   * @minimum 1
+   */
+  limit?: number;
+};
+/**
+ * A charge Prior Billing Period, 0 implies "current" and -23 is for the period 23 months ago.
+ */
+type QPbpParameter = number;
+/**
+ * An Organisation Identity
+ */
+type QOrgIdParameter = string;
+/**
+ * A Merchant Identity
+ */
+type QMIdParameter = number;
+/**
+ * An object name
+ */
+type QNameParameter = string;
+/**
+ * A Unit Identity
+ */
+type QUnitIdParameter = string;
+/**
+ * A Product Identity
+ */
+type QProductIdParameter = string;
+/**
+ * A User Identity
+ */
+type QUserIdParameter = string;
+type QFormatParameter = (typeof QFormatParameter)[keyof typeof QFormatParameter];
+declare const QFormatParameter: {
+  readonly PROTOCOL_STRING: "PROTOCOL_STRING";
+  readonly JSON_STRING: "JSON_STRING";
+};
+/**
+ * A date from which to retrieve assets. Any asset that occurs on ar after this date will be returned. UTC is assumed if no timezone is provided
+ */
+type QFromParameter = string;
+/**
+ * A date where assets prior to this will be returned. Any asset that occurs prior this date will be returned. UTC is assumed if no timezone is provided
+ */
+type QUntilParameter = string;
+type GetChargesParams = {
+  /**
+   * A date from which to retrieve assets. Any asset that occurs on ar after this date will be returned. UTC is assumed if no timezone is provided
+   */
+  from?: QFromParameter;
+  /**
+   * A date where assets prior to this will be returned. Any asset that occurs prior this date will be returned. UTC is assumed if no timezone is provided
+   */
+  until?: QUntilParameter;
+  /**
+   * A charge Prior Billing Period, 0 implies "current" and -23 is for the period 23 months ago.
+   * @minimum -23
+   * @maximum 0
+   */
+  pbp?: QPbpParameter;
+};
+type GetOrganisationChargesParams = {
+  /**
+   * A date from which to retrieve assets. Any asset that occurs on ar after this date will be returned. UTC is assumed if no timezone is provided
+   */
+  from?: QFromParameter;
+  /**
+   * A date where assets prior to this will be returned. Any asset that occurs prior this date will be returned. UTC is assumed if no timezone is provided
+   */
+  until?: QUntilParameter;
+  /**
+   * A charge Prior Billing Period, 0 implies "current" and -23 is for the period 23 months ago.
+   * @minimum -23
+   * @maximum 0
+   */
+  pbp?: QPbpParameter;
+};
+type GetProductChargesParams = {
+  /**
+   * A date from which to retrieve assets. Any asset that occurs on ar after this date will be returned. UTC is assumed if no timezone is provided
+   */
+  from?: QFromParameter;
+  /**
+   * A date where assets prior to this will be returned. Any asset that occurs prior this date will be returned. UTC is assumed if no timezone is provided
+   */
+  until?: QUntilParameter;
+  /**
+   * A charge Prior Billing Period, 0 implies "current" and -23 is for the period 23 months ago.
+   * @minimum -23
+   * @maximum 0
+   */
+  pbp?: QPbpParameter;
+};
+type GetUnitChargesParams = {
+  /**
+   * A date from which to retrieve assets. Any asset that occurs on ar after this date will be returned. UTC is assumed if no timezone is provided
+   */
+  from?: QFromParameter;
+  /**
+   * A date where assets prior to this will be returned. Any asset that occurs prior this date will be returned. UTC is assumed if no timezone is provided
+   */
+  until?: QUntilParameter;
+  /**
+   * A charge Prior Billing Period, 0 implies "current" and -23 is for the period 23 months ago.
+   * @minimum -23
+   * @maximum 0
+   */
+  pbp?: QPbpParameter;
+};
+type GetOrganisationsParams = {
+  /**
+   * An object name
+   */
+  name?: QNameParameter;
+};
+type GetUnitsParams = {
+  /**
+   * An object name
+   */
+  name?: QNameParameter;
+};
+type GetAssetParams = {
+  /**
+   * A User Identity
+   * @minLength 3
+   * @maxLength 80
+   * @pattern ^\w(?:\w*(?:[@.-]\w+)?)*$
+   */
+  user_id?: QUserIdParameter;
+  /**
+   * A Product Identity
+   * @pattern ^product-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
+   */
+  product_id?: QProductIdParameter;
+  /**
+   * A Unit Identity
+   * @pattern ^unit-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
+   */
+  unit_id?: QUnitIdParameter;
+  /**
+   * An Organisation Identity
+   * @pattern ^org-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
+   */
+  org_id?: QOrgIdParameter;
+};
+type AttachAssetParams = {
+  /**
+   * A Merchant Identity
+   * @minimum 1
+   */
+  m_id?: QMIdParameter;
+};
+type DetachAssetParams = {
+  /**
+   * A Merchant Identity
+   * @minimum 1
+   */
+  m_id?: QMIdParameter;
+};
+type GetActionsParams = {
+  /**
+   * The required format for delivered content.
+   */
+  format?: QFormatParameter;
+  /**
+   * A date from which to retrieve assets. Any asset that occurs on ar after this date will be returned. UTC is assumed if no timezone is provided
+   */
+  from?: QFromParameter;
+  /**
+   * A Merchant Identity
+   * @minimum 1
+   */
+  m_id?: QMIdParameter;
+  /**
+   * An Organisation Identity
+   * @pattern ^org-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
+   */
+  org_id?: QOrgIdParameter;
+  /**
+   * A Product Identity
+   * @pattern ^product-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
+   */
+  product_id?: QProductIdParameter;
+  /**
+   * A date where assets prior to this will be returned. Any asset that occurs prior this date will be returned. UTC is assumed if no timezone is provided
+   */
+  until?: QUntilParameter;
+  /**
+   * A Unit Identity
+   * @pattern ^unit-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
+   */
+  unit_id?: QUnitIdParameter;
+};
+//#endregion
+export { ActionDetail, ActionGetResponse, AsError, AssetDetail, AssetDetailScope, AssetGetByIdResponse, AssetGetResponse, AssetPatchBodyBody, AssetPostBodyBody, AssetPostBodyBodyScope, AssetPostResponse, AttachAssetParams, ChargeAdditionalData, ChargeSummary, ChargeSummaryType, ChargesGetResponse, DetachAssetParams, EventStreamGetPostResponse, EventStreamPostBodyBody, EventStreamPostBodyBodyFormat, EventStreamVersionGetResponse, EventStreamVersionGetResponseProtocol, GetActionsParams, GetAssetParams, GetChargesParams, GetOrganisationChargesParams, GetOrganisationsParams, GetProductChargesParams, GetUnitChargesParams, GetUnitsParams, MerchantDetail, MerchantDetailKind, MerchantGetResponse, MerchantSummary, MerchantSummaryKind, MerchantsGetResponse, OrganisationAllDetail, OrganisationAllDetailDefaultProductPrivacy, OrganisationChargeSummary, OrganisationChargesGetResponse, OrganisationDetail, OrganisationDetailDefaultProductPrivacy, OrganisationGetDefaultResponse, OrganisationGetDefaultResponseDefaultProductPrivacy, OrganisationGetResponse, OrganisationPatchBodyBody, OrganisationPatchBodyBodyDefaultProductPrivacy, OrganisationPostBodyBody, OrganisationPostBodyBodyDefaultProductPrivacy, OrganisationPostResponse, OrganisationUnitChargeSummary, OrganisationUnitPostBodyBody, OrganisationUnitPostBodyBodyDefaultProductPrivacy, OrganisationUnitPostResponse, OrganisationUnitsGetResponse, OrganisationsGetResponse, PersonalUnitPutBodyBody, PersonalUnitPutResponse, ProcessingChargeItem, ProcessingCharges, ProcessingChargesMerchantKind, ProductChargesGetResponse, ProductChargesGetResponseProductType, ProductClaimDetail, ProductCoinsDetail, ProductDetail, ProductDetailFlavour, ProductDetailType, ProductDmProjectTier, ProductDmStorage, ProductDmStorageDetail, ProductDmStorageDetailCoins, ProductDmStorageDetailSize, ProductInstanceDetail, ProductInstanceDetailCoins, ProductPatchBodyBody, ProductType, ProductTypeServiceKind, ProductUnitGetResponse, ProductUnitGetResponseProduct, ProductsGetDefaultStorageCost, ProductsGetDefaultStorageCostDefaultStorageCost, ProductsGetResponse, ProductsGetResponseProductsItem, ProductsGetTypesResponse, QFormatParameter, QFromParameter, QMIdParameter, QNameParameter, QOrgIdParameter, QPbpParameter, QProductIdParameter, QUnitIdParameter, QUntilParameter, QUserIdParameter, StateGetVersionResponse, StorageChargeItem, StorageCharges, UnitAllDetail, UnitAllDetailDefaultProductPrivacy, UnitChargeSummary, UnitChargesGetResponse, UnitDetail, UnitDetailDefaultProductPrivacy, UnitGetResponse, UnitPatchBodyBody, UnitPatchBodyBodyDefaultProductPrivacy, UnitProductChargeSummary, UnitProductPostBodyBody, UnitProductPostBodyBodyFlavour, UnitProductPostBodyBodyType, UnitProductPostResponse, UnitsGetResponse, UserAccountDetail, UserAccountGetResponse, UserDetail, UsersGetResponse };
+//# sourceMappingURL=api.schemas.d.ts.map