cloudflare
Version:
The official TypeScript library for the Cloudflare API
98 lines • 4.21 kB
JavaScript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from "../../../resource.mjs";
import * as AnalyticsAPI from "./analytics.mjs";
import { Analytics } from "./analytics.mjs";
import * as KeysAPI from "./keys.mjs";
import { Keys, KeysCursorLimitPagination } from "./keys.mjs";
import * as MetadataAPI from "./metadata.mjs";
import { Metadata } from "./metadata.mjs";
import * as ValuesAPI from "./values.mjs";
import { Values, } from "./values.mjs";
import { V4PagePaginationArray } from "../../../pagination.mjs";
export class Namespaces extends APIResource {
constructor() {
super(...arguments);
this.analytics = new AnalyticsAPI.Analytics(this._client);
this.keys = new KeysAPI.Keys(this._client);
this.metadata = new MetadataAPI.Metadata(this._client);
this.values = new ValuesAPI.Values(this._client);
}
/**
* Creates a namespace under the given title. A `400` is returned if the account
* already owns a namespace with this title. A namespace must be explicitly deleted
* to be replaced.
*/
create(params, options) {
const { account_id, ...body } = params;
return this._client.post(`/accounts/${account_id}/storage/kv/namespaces`, {
body,
...options,
})._thenUnwrap((obj) => obj.result);
}
/**
* Modifies a namespace's title.
*/
update(namespaceId, params, options) {
const { account_id, ...body } = params;
return this._client.put(`/accounts/${account_id}/storage/kv/namespaces/${namespaceId}`, {
body,
...options,
})._thenUnwrap((obj) => obj.result);
}
/**
* Returns the namespaces owned by an account.
*/
list(params, options) {
const { account_id, ...query } = params;
return this._client.getAPIList(`/accounts/${account_id}/storage/kv/namespaces`, NamespacesV4PagePaginationArray, { query, ...options });
}
/**
* Deletes the namespace corresponding to the given ID.
*/
delete(namespaceId, params, options) {
const { account_id } = params;
return this._client.delete(`/accounts/${account_id}/storage/kv/namespaces/${namespaceId}`, options)._thenUnwrap((obj) => obj.result);
}
/**
* Remove multiple KV pairs from the namespace. Body should be an array of up to
* 10,000 keys to be removed.
*/
bulkDelete(namespaceId, params, options) {
const { account_id, body } = params;
return this._client.post(`/accounts/${account_id}/storage/kv/namespaces/${namespaceId}/bulk/delete`, {
body: body,
...options,
})._thenUnwrap((obj) => obj.result);
}
/**
* Write multiple keys and values at once. Body should be an array of up to 10,000
* key-value pairs to be stored, along with optional expiration information.
* Existing values and expirations will be overwritten. If neither `expiration` nor
* `expiration_ttl` is specified, the key-value pair will never expire. If both are
* set, `expiration_ttl` is used and `expiration` is ignored. The entire request
* size must be 100 megabytes or less.
*/
bulkUpdate(namespaceId, params, options) {
const { account_id, body } = params;
return this._client.put(`/accounts/${account_id}/storage/kv/namespaces/${namespaceId}/bulk`, {
body: body,
...options,
})._thenUnwrap((obj) => obj.result);
}
/**
* Get the namespace corresponding to the given ID.
*/
get(namespaceId, params, options) {
const { account_id } = params;
return this._client.get(`/accounts/${account_id}/storage/kv/namespaces/${namespaceId}`, options)._thenUnwrap((obj) => obj.result);
}
}
export class NamespacesV4PagePaginationArray extends V4PagePaginationArray {
}
Namespaces.NamespacesV4PagePaginationArray = NamespacesV4PagePaginationArray;
Namespaces.Analytics = Analytics;
Namespaces.Keys = Keys;
Namespaces.KeysCursorLimitPagination = KeysCursorLimitPagination;
Namespaces.Metadata = Metadata;
Namespaces.Values = Values;
//# sourceMappingURL=namespaces.mjs.map