cloudflare
Version:
The official TypeScript library for the Cloudflare API
90 lines • 2.78 kB
TypeScript
import { APIResource } from "../../../resource.js";
import * as Core from "../../../core.js";
import { SinglePage } from "../../../pagination.js";
export declare class Bookmarks extends APIResource {
/**
* Create a new Bookmark application.
*/
create(bookmarkId: string, params: BookmarkCreateParams, options?: Core.RequestOptions): Core.APIPromise<Bookmark>;
/**
* Updates a configured Bookmark application.
*/
update(bookmarkId: string, params: BookmarkUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Bookmark>;
/**
* Lists Bookmark applications.
*/
list(params: BookmarkListParams, options?: Core.RequestOptions): Core.PagePromise<BookmarksSinglePage, Bookmark>;
/**
* Deletes a Bookmark application.
*/
delete(bookmarkId: string, params: BookmarkDeleteParams, options?: Core.RequestOptions): Core.APIPromise<BookmarkDeleteResponse>;
/**
* Fetches a single Bookmark application.
*/
get(bookmarkId: string, params: BookmarkGetParams, options?: Core.RequestOptions): Core.APIPromise<Bookmark>;
}
export declare class BookmarksSinglePage extends SinglePage<Bookmark> {
}
export interface Bookmark {
/**
* The unique identifier for the Bookmark application.
*/
id?: string;
/**
* Displays the application in the App Launcher.
*/
app_launcher_visible?: boolean;
created_at?: string;
/**
* The domain of the Bookmark application.
*/
domain?: string;
/**
* The image URL for the logo shown in the App Launcher dashboard.
*/
logo_url?: string;
/**
* The name of the Bookmark application.
*/
name?: string;
updated_at?: string;
}
export interface BookmarkDeleteResponse {
/**
* UUID
*/
id?: string;
}
export interface BookmarkCreateParams {
/**
* Path param:
*/
account_id: string;
/**
* Body param:
*/
body: unknown;
}
export interface BookmarkUpdateParams {
/**
* Path param:
*/
account_id: string;
/**
* Body param:
*/
body: unknown;
}
export interface BookmarkListParams {
account_id: string;
}
export interface BookmarkDeleteParams {
account_id: string;
}
export interface BookmarkGetParams {
account_id: string;
}
export declare namespace Bookmarks {
export { type Bookmark as Bookmark, type BookmarkDeleteResponse as BookmarkDeleteResponse, BookmarksSinglePage as BookmarksSinglePage, type BookmarkCreateParams as BookmarkCreateParams, type BookmarkUpdateParams as BookmarkUpdateParams, type BookmarkListParams as BookmarkListParams, type BookmarkDeleteParams as BookmarkDeleteParams, type BookmarkGetParams as BookmarkGetParams, };
}
//# sourceMappingURL=bookmarks.d.ts.map