cloudflare
Version:
The official TypeScript library for the Cloudflare API
101 lines • 2.69 kB
TypeScript
import { APIResource } from "../../core/resource.js";
import { APIPromise } from "../../core/api-promise.js";
import { RequestOptions } from "../../internal/request-options.js";
export declare class BaseApps extends APIResource {
static readonly _key: readonly ['realtimeKit', 'apps'];
/**
* Fetch all apps for your account
*
* @example
* ```ts
* const app = await client.realtimeKit.apps.get({
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* });
* ```
*/
get(params: AppGetParams, options?: RequestOptions): APIPromise<AppGetResponse>;
/**
* Create new app for your account
*
* @example
* ```ts
* const response = await client.realtimeKit.apps.post({
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* name: 'x',
* });
* ```
*/
post(params: AppPostParams, options?: RequestOptions): APIPromise<AppPostResponse>;
}
export declare class Apps extends BaseApps {
}
export interface AppGetResponse {
data?: Array<AppGetResponse.Data>;
paging?: AppGetResponse.Paging;
success?: boolean;
}
export declare namespace AppGetResponse {
interface Data {
id?: string;
created_at?: string;
name?: string;
}
interface Paging {
end_offset?: number;
start_offset?: number;
total_count?: number;
}
}
export interface AppPostResponse {
data?: AppPostResponse.Data;
success?: boolean;
}
export declare namespace AppPostResponse {
interface Data {
app?: Data.App;
}
namespace Data {
interface App {
id?: string;
created_at?: string;
name?: string;
}
}
}
export interface AppGetParams {
/**
* Path param: The account identifier tag.
*/
account_id: string;
/**
* Query param: The page number from which you want your page search results to be
* displayed.
*/
page_no?: number;
/**
* Query param: Number of results per page.
*/
per_page?: number;
/**
* Query param: Search string that matches apps by name.
*/
search?: string;
/**
* Query param: Sort order for apps by creation time.
*/
sort_order?: 'ASC' | 'DESC';
}
export interface AppPostParams {
/**
* Path param: The account identifier tag.
*/
account_id: string;
/**
* Body param
*/
name: string;
}
export declare namespace Apps {
export { type AppGetResponse as AppGetResponse, type AppPostResponse as AppPostResponse, type AppGetParams as AppGetParams, type AppPostParams as AppPostParams, };
}
//# sourceMappingURL=apps.d.ts.map