cloudflare/resources/r2/buckets/buckets.d.ts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../../resource.js";
import * as Core from "../../../core.js";
import * as CORSAPI from "./cors.js";
import { CORS, CORSDeleteParams, CORSDeleteResponse, CORSGetParams, CORSGetResponse, CORSUpdateParams, CORSUpdateResponse } from "./cors.js";
import * as EventNotificationsAPI from "./event-notifications.js";
import { EventNotificationDeleteParams, EventNotificationDeleteResponse, EventNotificationGetParams, EventNotificationGetResponse, EventNotificationUpdateParams, EventNotificationUpdateResponse, EventNotifications } from "./event-notifications.js";
import * as LifecycleAPI from "./lifecycle.js";
import { Lifecycle, LifecycleGetParams, LifecycleGetResponse, LifecycleUpdateParams, LifecycleUpdateResponse } from "./lifecycle.js";
import * as LocksAPI from "./locks.js";
import { LockGetParams, LockGetResponse, LockUpdateParams, LockUpdateResponse, Locks } from "./locks.js";
import * as MetricsAPI from "./metrics.js";
import { MetricListParams, MetricListResponse, Metrics } from "./metrics.js";
import * as SippyAPI from "./sippy.js";
import { Provider, Sippy, SippyDeleteParams, SippyDeleteResponse, SippyGetParams, SippyResource, SippyUpdateParams } from "./sippy.js";
import * as DomainsAPI from "./domains/domains.js";
import { Domains } from "./domains/domains.js";
export declare class Buckets extends APIResource {
    lifecycle: LifecycleAPI.Lifecycle;
    cors: CORSAPI.CORS;
    domains: DomainsAPI.Domains;
    eventNotifications: EventNotificationsAPI.EventNotifications;
    locks: LocksAPI.Locks;
    metrics: MetricsAPI.Metrics;
    sippy: SippyAPI.SippyResource;
    /**
     * Creates a new R2 bucket.
     */
    create(params: BucketCreateParams, options?: Core.RequestOptions): Core.APIPromise<Bucket>;
    /**
     * Lists all R2 buckets on your account
     */
    list(params: BucketListParams, options?: Core.RequestOptions): Core.APIPromise<BucketListResponse>;
    /**
     * Deletes an existing R2 bucket.
     */
    delete(bucketName: string, params: BucketDeleteParams, options?: Core.RequestOptions): Core.APIPromise<BucketDeleteResponse>;
    /**
     * Gets metadata for an existing R2 bucket.
     */
    get(bucketName: string, params: BucketGetParams, options?: Core.RequestOptions): Core.APIPromise<Bucket>;
}
/**
 * A single R2 bucket
 */
export interface Bucket {
    /**
     * Creation timestamp
     */
    creation_date?: string;
    /**
     * Location of the bucket
     */
    location?: 'apac' | 'eeur' | 'enam' | 'weur' | 'wnam' | 'oc';
    /**
     * Name of the bucket
     */
    name?: string;
    /**
     * Storage class for newly uploaded objects, unless specified otherwise.
     */
    storage_class?: 'Standard' | 'InfrequentAccess';
}
export interface BucketListResponse {
    buckets?: Array<Bucket>;
}
export type BucketDeleteResponse = unknown;
export interface BucketCreateParams {
    /**
     * Path param: Account ID
     */
    account_id: string;
    /**
     * Body param: Name of the bucket
     */
    name: string;
    /**
     * Body param: Location of the bucket
     */
    locationHint?: 'apac' | 'eeur' | 'enam' | 'weur' | 'wnam' | 'oc';
    /**
     * Body param: Storage class for newly uploaded objects, unless specified
     * otherwise.
     */
    storageClass?: 'Standard' | 'InfrequentAccess';
    /**
     * Header param: Creates the bucket in the provided jurisdiction
     */
    jurisdiction?: 'default' | 'eu' | 'fedramp';
}
export interface BucketListParams {
    /**
     * Path param: Account ID
     */
    account_id: string;
    /**
     * Query param: Pagination cursor received during the last List Buckets call. R2
     * buckets are paginated using cursors instead of page numbers.
     */
    cursor?: string;
    /**
     * Query param: Direction to order buckets
     */
    direction?: 'asc' | 'desc';
    /**
     * Query param: Bucket names to filter by. Only buckets with this phrase in their
     * name will be returned.
     */
    name_contains?: string;
    /**
     * Query param: Field to order buckets by
     */
    order?: 'name';
    /**
     * Query param: Maximum number of buckets to return in a single call
     */
    per_page?: number;
    /**
     * Query param: Bucket name to start searching after. Buckets are ordered
     * lexicographically.
     */
    start_after?: string;
    /**
     * Header param: Lists buckets in the provided jurisdiction
     */
    jurisdiction?: 'default' | 'eu' | 'fedramp';
}
export interface BucketDeleteParams {
    /**
     * Path param: Account ID
     */
    account_id: string;
    /**
     * Header param: The bucket jurisdiction
     */
    jurisdiction?: 'default' | 'eu' | 'fedramp';
}
export interface BucketGetParams {
    /**
     * Path param: Account ID
     */
    account_id: string;
    /**
     * Header param: The bucket jurisdiction
     */
    jurisdiction?: 'default' | 'eu' | 'fedramp';
}
export declare namespace Buckets {
    export { type Bucket as Bucket, type BucketListResponse as BucketListResponse, type BucketDeleteResponse as BucketDeleteResponse, type BucketCreateParams as BucketCreateParams, type BucketListParams as BucketListParams, type BucketDeleteParams as BucketDeleteParams, type BucketGetParams as BucketGetParams, };
    export { Lifecycle as Lifecycle, type LifecycleUpdateResponse as LifecycleUpdateResponse, type LifecycleGetResponse as LifecycleGetResponse, type LifecycleUpdateParams as LifecycleUpdateParams, type LifecycleGetParams as LifecycleGetParams, };
    export { CORS as CORS, type CORSUpdateResponse as CORSUpdateResponse, type CORSDeleteResponse as CORSDeleteResponse, type CORSGetResponse as CORSGetResponse, type CORSUpdateParams as CORSUpdateParams, type CORSDeleteParams as CORSDeleteParams, type CORSGetParams as CORSGetParams, };
    export { Domains as Domains };
    export { EventNotifications as EventNotifications, type EventNotificationUpdateResponse as EventNotificationUpdateResponse, type EventNotificationDeleteResponse as EventNotificationDeleteResponse, type EventNotificationGetResponse as EventNotificationGetResponse, type EventNotificationUpdateParams as EventNotificationUpdateParams, type EventNotificationDeleteParams as EventNotificationDeleteParams, type EventNotificationGetParams as EventNotificationGetParams, };
    export { Locks as Locks, type LockUpdateResponse as LockUpdateResponse, type LockGetResponse as LockGetResponse, type LockUpdateParams as LockUpdateParams, type LockGetParams as LockGetParams, };
    export { Metrics as Metrics, type MetricListResponse as MetricListResponse, type MetricListParams as MetricListParams, };
    export { SippyResource as SippyResource, type Provider as Provider, type Sippy as Sippy, type SippyDeleteResponse as SippyDeleteResponse, type SippyUpdateParams as SippyUpdateParams, type SippyDeleteParams as SippyDeleteParams, type SippyGetParams as SippyGetParams, };
}
//# sourceMappingURL=buckets.d.ts.map