@squonk/account-server-client 4.4.0-4-4.2194860267 → 4.4.0-4-4.2197069952

package/src/api/api-schemas/productUnitGetResponse.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+import type { ProductUnitGetResponseProduct } from "./productUnitGetResponseProduct";
+
+export interface ProductUnitGetResponse {
+  /** The Unit's Product */
+  product: ProductUnitGetResponseProduct;
+}

package/src/api/api-schemas/productUnitGetResponseProduct.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+import type { ProductDmStorage } from "./productDmStorage";
+import type { ProductDmProjectTier } from "./productDmProjectTier";
+
+/**
+ * The Unit's Product
+ */
+export type ProductUnitGetResponseProduct = ProductDmStorage | ProductDmProjectTier;

package/src/api/api-schemas/productsGetDefaultStorageCost.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+import type { ProductsGetDefaultStorageCostDefaultStorageCost } from "./productsGetDefaultStorageCostDefaultStorageCost";
+
+export interface ProductsGetDefaultStorageCost {
+  default_storage_cost: ProductsGetDefaultStorageCostDefaultStorageCost;
+}

package/src/api/api-schemas/productsGetDefaultStorageCostDefaultStorageCost.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+
+export type ProductsGetDefaultStorageCostDefaultStorageCost = {
+  cost: string;
+  units: string;
+  description: string;
+};

package/src/api/api-schemas/productsGetResponse.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+import type { ProductsGetResponseProductsItem } from "./productsGetResponseProductsItem";
+
+export interface ProductsGetResponse {
+  count: number;
+  /** All the Products you have access to */
+  products: ProductsGetResponseProductsItem[];
+}

package/src/api/api-schemas/productsGetResponseProductsItem.ts

@@ -0,0 +1,14 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+import type { ProductDmStorage } from "./productDmStorage";
+import type { ProductDmProjectTier } from "./productDmProjectTier";
+
+export type ProductsGetResponseProductsItem = ProductDmStorage | ProductDmProjectTier;

package/src/api/api-schemas/productsGetTypesResponse.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+import type { ProductType } from "./productType";
+
+export interface ProductsGetTypesResponse {
+  /** The number of Product Types */
+  count: number;
+  /** All the Product Types you have access to */
+  product_types: ProductType[];
+}

package/src/api/api-schemas/qFormatParameter.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+
+export type QFormatParameter = (typeof QFormatParameter)[keyof typeof QFormatParameter];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const QFormatParameter = {
+  PROTOCOL_STRING: "PROTOCOL_STRING",
+  JSON_STRING: "JSON_STRING",
+} as const;

package/src/api/api-schemas/qFromParameter.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+
+/**
+ * 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
+ */
+export type QFromParameter = string;

package/src/api/api-schemas/qMIdParameter.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+
+/**
+ * A Merchant Identity
+ */
+export type QMIdParameter = number;

package/src/api/api-schemas/qNameParameter.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+
+/**
+ * An object name
+ */
+export type QNameParameter = string;

package/src/api/api-schemas/qOrgIdParameter.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+
+/**
+ * An Organisation Identity
+ */
+export type QOrgIdParameter = string;

package/src/api/api-schemas/qPbpParameter.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+
+/**
+ * A charge Prior Billing Period, 0 implies "current" and -23 is for the period 23 months ago.
+ */
+export type QPbpParameter = number;

package/src/api/api-schemas/qProductIdParameter.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+
+/**
+ * A Product Identity
+ */
+export type QProductIdParameter = string;

package/src/api/api-schemas/qUnitIdParameter.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+
+/**
+ * A Unit Identity
+ */
+export type QUnitIdParameter = string;

package/src/api/api-schemas/qUntilParameter.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+
+/**
+ * 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
+ */
+export type QUntilParameter = string;

package/src/api/api-schemas/qUserIdParameter.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+
+/**
+ * A User Identity
+ */
+export type QUserIdParameter = string;

package/src/api/api-schemas/stateGetVersionResponse.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+
+export 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;
+}

package/src/api/api-schemas/storageChargeItem.ts

@@ -0,0 +1,24 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+import type { ChargeAdditionalData } from "./chargeAdditionalData";
+
+export 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;
+}

package/src/api/api-schemas/storageCharges.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+import type { StorageChargeItem } from "./storageChargeItem";
+
+export interface StorageCharges {
+  num_items: number;
+  items: StorageChargeItem[];
+}

package/src/api/api-schemas/unitAllDetail.ts

@@ -0,0 +1,32 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+import type { UnitAllDetailDefaultProductPrivacy } from "./unitAllDetailDefaultProductPrivacy";
+import type { UserDetail } from "./userDetail";
+
+export 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[];
+}

package/src/api/api-schemas/unitAllDetailDefaultProductPrivacy.ts

@@ -0,0 +1,24 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+
+/**
+ * The Unit's default product privacy setting
+ */
+export type UnitAllDetailDefaultProductPrivacy =
+  (typeof UnitAllDetailDefaultProductPrivacy)[keyof typeof UnitAllDetailDefaultProductPrivacy];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const UnitAllDetailDefaultProductPrivacy = {
+  ALWAYS_PUBLIC: "ALWAYS_PUBLIC",
+  ALWAYS_PRIVATE: "ALWAYS_PRIVATE",
+  DEFAULT_PUBLIC: "DEFAULT_PUBLIC",
+  DEFAULT_PRIVATE: "DEFAULT_PRIVATE",
+} as const;

package/src/api/api-schemas/unitChargeSummary.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+import type { ChargeSummary } from "./chargeSummary";
+
+export interface UnitChargeSummary {
+  charges: ChargeSummary[];
+}

package/src/api/api-schemas/unitChargesGetResponse.ts

@@ -0,0 +1,37 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+import type { UnitChargeSummary } from "./unitChargeSummary";
+import type { UnitProductChargeSummary } from "./unitProductChargeSummary";
+
+export 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[];
+}

package/src/api/api-schemas/unitDetail.ts

@@ -0,0 +1,29 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+import type { UnitDetailDefaultProductPrivacy } from "./unitDetailDefaultProductPrivacy";
+
+export 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;
+}

package/src/api/api-schemas/unitDetailDefaultProductPrivacy.ts

@@ -0,0 +1,24 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+
+/**
+ * The Unit's default product privacy setting
+ */
+export type UnitDetailDefaultProductPrivacy =
+  (typeof UnitDetailDefaultProductPrivacy)[keyof typeof UnitDetailDefaultProductPrivacy];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const UnitDetailDefaultProductPrivacy = {
+  ALWAYS_PUBLIC: "ALWAYS_PUBLIC",
+  ALWAYS_PRIVATE: "ALWAYS_PRIVATE",
+  DEFAULT_PUBLIC: "DEFAULT_PUBLIC",
+  DEFAULT_PRIVATE: "DEFAULT_PRIVATE",
+} as const;

package/src/api/api-schemas/unitGetResponse.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+import type { UnitAllDetail } from "./unitAllDetail";
+
+export type UnitGetResponse = UnitAllDetail;

package/src/api/api-schemas/unitPatchBodyBody.ts

@@ -0,0 +1,20 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+import type { UnitPatchBodyBodyDefaultProductPrivacy } from "./unitPatchBodyBodyDefaultProductPrivacy";
+
+export 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;
+};

package/src/api/api-schemas/unitPatchBodyBodyDefaultProductPrivacy.ts

@@ -0,0 +1,26 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+
+/**
+ * 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
+ */
+export type UnitPatchBodyBodyDefaultProductPrivacy =
+  (typeof UnitPatchBodyBodyDefaultProductPrivacy)[keyof typeof UnitPatchBodyBodyDefaultProductPrivacy];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const UnitPatchBodyBodyDefaultProductPrivacy = {
+  ALWAYS_PUBLIC: "ALWAYS_PUBLIC",
+  ALWAYS_PRIVATE: "ALWAYS_PRIVATE",
+  DEFAULT_PUBLIC: "DEFAULT_PUBLIC",
+  DEFAULT_PRIVATE: "DEFAULT_PRIVATE",
+} as const;

package/src/api/api-schemas/unitProductChargeSummary.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+import type { ChargeSummary } from "./chargeSummary";
+
+export interface UnitProductChargeSummary {
+  product_id: string;
+  product_type: string;
+  charges: ChargeSummary[];
+}

package/src/api/api-schemas/unitProductPostBodyBody.ts

@@ -0,0 +1,36 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * 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
+ */
+import type { UnitProductPostBodyBodyType } from "./unitProductPostBodyBodyType";
+import type { UnitProductPostBodyBodyFlavour } from "./unitProductPostBodyBodyFlavour";
+
+export 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;
+};