bunny-client
Version:
TypeScript API Client for BunnyCDN 🐰
56 lines • 1.72 kB
TypeScript
import type { StorageZone } from "../types";
export interface ListStorageZonesRequest {
/**
* User-specific [API Key](https://dash.bunny.net/account/settings)
* @example "cb1a7c68-89a0-462a-9495-13ebd7366cfe"
*/
apiKey?: string;
/**
* Should include deleted storage zones
* @example false
*/
includeDeleted?: boolean;
/**
* Page number between 1 and 2147483647
* @example 1
*/
page?: number;
/**
* Number of results per page between 5 and 1000
* @example 1000
*/
perPage?: number;
/**
* The search term that will be used to filter the results
* @example "storage-zone-name-substring"
*/
search?: string;
}
export interface ListStorageZonesResponse {
/**
* The current query page number
* @example 1
*/
CurrentPage: number;
/**
* Whether the query has additional pages of results
* @example false
*/
HasMoreItems: boolean;
/**
* List of storage zones that match the query
*/
Items: StorageZone[];
/**
* The total number of queried items in all pages
* @example 5
*/
TotalItems: number;
}
export declare const listStorageZones: import("untypeable/dist/client-ca591958").g<ListStorageZonesRequest, ListStorageZonesResponse>;
export declare const listStorageZonesEndpoints: {
readonly "GET /storagezone": "GET /storagezone";
readonly listStorageZones: "listStorageZones";
};
export declare function listStorageZonesClient(defaultRequestInit: RequestInit, { apiKey, includeDeleted, page, perPage, search, }: ListStorageZonesRequest): Promise<ListStorageZonesResponse>;
//# sourceMappingURL=listStorageZones.d.ts.map