cloudflare
Version:
The official TypeScript library for the Cloudflare API
185 lines • 4.95 kB
TypeScript
import { APIResource } from "../../../resource.js";
import * as Core from "../../../core.js";
import { SinglePage } from "../../../pagination.js";
export declare class MessageResource extends APIResource {
/**
* Create a New Request Message
*
* @example
* ```ts
* const message =
* await client.cloudforceOne.requests.message.create(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
create(requestId: string, params: MessageCreateParams, options?: Core.RequestOptions): Core.APIPromise<Message>;
/**
* Update a Request Message
*
* @example
* ```ts
* const message =
* await client.cloudforceOne.requests.message.update(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* 0,
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
update(requestId: string, messageId: number, params: MessageUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Message>;
/**
* Delete a Request Message
*
* @example
* ```ts
* const message =
* await client.cloudforceOne.requests.message.delete(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* 0,
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
delete(requestId: string, messageId: number, params: MessageDeleteParams, options?: Core.RequestOptions): Core.APIPromise<MessageDeleteResponse>;
/**
* List Request Messages
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const message of client.cloudforceOne.requests.message.get(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* page: 0,
* per_page: 10,
* },
* )) {
* // ...
* }
* ```
*/
get(requestId: string, params: MessageGetParams, options?: Core.RequestOptions): Core.PagePromise<MessagesSinglePage, Message>;
}
export declare class MessagesSinglePage extends SinglePage<Message> {
}
export interface Message {
/**
* Message ID.
*/
id: number;
/**
* Author of message.
*/
author: string;
/**
* Content of message.
*/
content: string;
/**
* Whether the message is a follow-on request.
*/
is_follow_on_request: boolean;
/**
* Defines the message last updated time.
*/
updated: string;
/**
* Defines the message creation time.
*/
created?: string;
}
export interface MessageDeleteResponse {
errors: Array<MessageDeleteResponse.Error>;
messages: Array<MessageDeleteResponse.Message>;
/**
* Whether the API call was successful.
*/
success: true;
}
export declare namespace MessageDeleteResponse {
interface Error {
code: number;
message: string;
documentation_url?: string;
source?: Error.Source;
}
namespace Error {
interface Source {
pointer?: string;
}
}
interface Message {
code: number;
message: string;
documentation_url?: string;
source?: Message.Source;
}
namespace Message {
interface Source {
pointer?: string;
}
}
}
export interface MessageCreateParams {
/**
* Path param: Identifier.
*/
account_id: string;
/**
* Body param: Content of message.
*/
content?: string;
}
export interface MessageUpdateParams {
/**
* Path param: Identifier.
*/
account_id: string;
/**
* Body param: Content of message.
*/
content?: string;
}
export interface MessageDeleteParams {
/**
* Identifier.
*/
account_id: string;
}
export interface MessageGetParams {
/**
* Path param: Identifier.
*/
account_id: string;
/**
* Body param: Page number of results.
*/
page: number;
/**
* Body param: Number of results per page.
*/
per_page: number;
/**
* Body param: Retrieve mes ges created after this time.
*/
after?: string;
/**
* Body param: Retrieve messages created before this time.
*/
before?: string;
/**
* Body param: Field to sort results by.
*/
sort_by?: string;
/**
* Body param: Sort order (asc or desc).
*/
sort_order?: 'asc' | 'desc';
}
export declare namespace MessageResource {
export { type Message as Message, type MessageDeleteResponse as MessageDeleteResponse, MessagesSinglePage as MessagesSinglePage, type MessageCreateParams as MessageCreateParams, type MessageUpdateParams as MessageUpdateParams, type MessageDeleteParams as MessageDeleteParams, type MessageGetParams as MessageGetParams, };
}
//# sourceMappingURL=message.d.ts.map