Interface QuotasAPI

interface QuotasAPI {
    clearCache: () => void;
    getQuota: (
        id: string,
        query: { reportUsage?: boolean },
        options?: ApiCallOptions,
    ) => Promise<GetQuotaHttpResponse>;
    getQuotas: (
        query: { reportUsage?: boolean },
        options?: ApiCallOptions,
    ) => Promise<GetQuotasHttpResponse>;
}
Index

Properties

clearCache getQuota getQuotas

Properties

clearCache: () => void

Clears the cache for quotas api requests.

Type declaration

    • (): void

    • Clears the cache for quotas api requests.

      Returns void

getQuota: (
    id: string,
    query: { reportUsage?: boolean },
    options?: ApiCallOptions,
) => Promise<GetQuotaHttpResponse>

Returns a specific quota item for the tenant (provided in JWT).

Type declaration

    • (
          id: string,
          query: { reportUsage?: boolean },
          options?: ApiCallOptions,
      ): Promise<GetQuotaHttpResponse>

    • Returns a specific quota item for the tenant (provided in JWT).

      Parameters

      • id: string

        The unique identifier of the quota item. For example, "app_mem_size", "app_upload_disk_size", or "shared_spaces".

      • query: { reportUsage?: boolean }

        an object with query parameters

        • OptionalreportUsage?: boolean

          The Boolean flag indicating whether quota usage shall be part of the response. The default value is false (usage not included).

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetQuotaHttpResponse>

      GetQuotaHttpError

The unique identifier of the quota item. For example, "app_mem_size", "app_upload_disk_size", or "shared_spaces".

an object with query parameters

GetQuotaHttpError

getQuotas: (
    query: { reportUsage?: boolean },
    options?: ApiCallOptions,
) => Promise<GetQuotasHttpResponse>

Returns all quota items for the tenant (provided in JWT).

Type declaration

    • (
          query: { reportUsage?: boolean },
          options?: ApiCallOptions,
      ): Promise<GetQuotasHttpResponse>

    • Returns all quota items for the tenant (provided in JWT).

      Parameters

      • query: { reportUsage?: boolean }

        an object with query parameters

        • OptionalreportUsage?: boolean

          The Boolean flag indicating whether quota usage shall be part of the response. The default value is false (only limits returned).

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetQuotasHttpResponse>

      GetQuotasHttpError

an object with query parameters

GetQuotasHttpError

Settings

Member Visibility

On This Page

Properties