// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. import { APIResource } from '../../../core/resource'; import { APIPromise } from '../../../core/api-promise'; import { type Uploadable } from '../../../core/uploads'; import { buildHeaders } from '../../../internal/headers'; import { RequestOptions } from '../../../internal/request-options'; import { multipartFormRequestOptions } from '../../../internal/uploads'; import { path } from '../../../internal/utils/path'; export class BaseValues extends APIResource { static override readonly _key: readonly ['kv', 'namespaces', 'values'] = Object.freeze([ 'kv', 'namespaces', 'values', ] as const); /** * Write a value identified by a key. Use URL-encoding to use special characters * (for example, `:`, `!`, `%`) in the key name. Body should be the value to be * stored. If JSON metadata to be associated with the key/value pair is needed, use * `multipart/form-data` content type for your PUT request (see dropdown below in * `REQUEST BODY SCHEMA`). Existing values, expirations, and metadata 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. * * @example * ```ts * const value = await client.kv.namespaces.values.update( * 'My-Key', * { * account_id: '023e105f4ecef8ad9ca31a8372d0c353', * namespace_id: '0f2ac74b498b48028cb68387c421e279', * value: 'Some Value', * }, * ); * ``` */ update( keyName: string, params: ValueUpdateParams, options?: RequestOptions, ): APIPromise { const { account_id, namespace_id, expiration, expiration_ttl, ...body } = params; return ( this._client.put( path`/accounts/${account_id}/storage/kv/namespaces/${namespace_id}/values/${keyName}`, multipartFormRequestOptions( { query: { expiration, expiration_ttl }, body, ...options }, this._client, ), ) as APIPromise<{ result: ValueUpdateResponse | null }> )._thenUnwrap((obj) => obj.result); } /** * Remove a KV pair from the namespace. Use URL-encoding to use special characters * (for example, `:`, `!`, `%`) in the key name. * * @example * ```ts * const value = await client.kv.namespaces.values.delete( * 'My-Key', * { * account_id: '023e105f4ecef8ad9ca31a8372d0c353', * namespace_id: '0f2ac74b498b48028cb68387c421e279', * }, * ); * ``` */ delete( keyName: string, params: ValueDeleteParams, options?: RequestOptions, ): APIPromise { const { account_id, namespace_id } = params; return ( this._client.delete( path`/accounts/${account_id}/storage/kv/namespaces/${namespace_id}/values/${keyName}`, options, ) as APIPromise<{ result: ValueDeleteResponse | null }> )._thenUnwrap((obj) => obj.result); } /** * Returns the value associated with the given key in the given namespace. Use * URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key * name. If the KV-pair is set to expire at some point, the expiration time as * measured in seconds since the UNIX epoch will be returned in the `expiration` * response header. * * @example * ```ts * const value = await client.kv.namespaces.values.get( * 'My-Key', * { * account_id: '023e105f4ecef8ad9ca31a8372d0c353', * namespace_id: '0f2ac74b498b48028cb68387c421e279', * }, * ); * * const content = await value.blob(); * console.log(content); * ``` */ get(keyName: string, params: ValueGetParams, options?: RequestOptions): APIPromise { const { account_id, namespace_id } = params; return this._client.get( path`/accounts/${account_id}/storage/kv/namespaces/${namespace_id}/values/${keyName}`, { ...options, headers: buildHeaders([{ Accept: 'application/octet-stream' }, options?.headers]), __binaryResponse: true, }, ); } } export class Values extends BaseValues {} export interface ValueUpdateResponse {} export interface ValueDeleteResponse {} export interface ValueUpdateParams { /** * Path param: Identifier. */ account_id: string; /** * Path param: Namespace identifier tag. */ namespace_id: string; /** * Body param: A byte sequence to be stored, up to 25 MiB in length. */ value: string | Uploadable; /** * Query param: Expires the key at a certain time, measured in number of seconds * since the UNIX epoch. */ expiration?: number; /** * Query param: Expires the key after a number of seconds. Must be at least 60. */ expiration_ttl?: number; /** * Body param: Associates arbitrary JSON data with a key/value pair. */ metadata?: unknown; } export interface ValueDeleteParams { /** * Identifier. */ account_id: string; /** * Namespace identifier tag. */ namespace_id: string; } export interface ValueGetParams { /** * Identifier. */ account_id: string; /** * Namespace identifier tag. */ namespace_id: string; } export declare namespace Values { export { type ValueUpdateResponse as ValueUpdateResponse, type ValueDeleteResponse as ValueDeleteResponse, type ValueUpdateParams as ValueUpdateParams, type ValueDeleteParams as ValueDeleteParams, type ValueGetParams as ValueGetParams, }; }