cloudflare/resources/cloudforce-one/requests/message.d.ts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../../core/resource.js";
import { APIPromise } from "../../../core/api-promise.js";
import { PagePromise, SinglePage } from "../../../core/pagination.js";
import { RequestOptions } from "../../../internal/request-options.js";
export declare class BaseMessageResource extends APIResource {
    static readonly _key: readonly ['cloudforceOne', 'requests', 'message'];
    /**
     * Adds a message to a Cloudforce One intelligence request conversation.
     *
     * @example
     * ```ts
     * const message =
     *   await client.cloudforceOne.requests.message.create(
     *     'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
     *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
     *   );
     * ```
     */
    create(requestID: string, params: MessageCreateParams, options?: RequestOptions): APIPromise<Message>;
    /**
     * Updates a message in a Cloudforce One intelligence request thread.
     *
     * @example
     * ```ts
     * const message =
     *   await client.cloudforceOne.requests.message.update(0, {
     *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
     *     request_id: 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
     *   });
     * ```
     */
    update(messageID: number, params: MessageUpdateParams, options?: RequestOptions): APIPromise<Message>;
    /**
     * Removes a message from a Cloudforce One intelligence request thread.
     *
     * @example
     * ```ts
     * const message =
     *   await client.cloudforceOne.requests.message.delete(0, {
     *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
     *     request_id: 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
     *   });
     * ```
     */
    delete(messageID: number, params: MessageDeleteParams, options?: RequestOptions): APIPromise<MessageDeleteResponse>;
    /**
     * Lists messages in a Cloudforce One intelligence request conversation.
     *
     * @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?: RequestOptions): PagePromise<MessagesSinglePage, Message>;
}
export declare class MessageResource extends BaseMessageResource {
}
export type MessagesSinglePage = 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;
    /**
     * Path param: UUID.
     */
    request_id: string;
    /**
     * Body param: Content of message.
     */
    content?: string;
}
export interface MessageDeleteParams {
    /**
     * Identifier.
     */
    account_id: string;
    /**
     * UUID.
     */
    request_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, type MessagesSinglePage as MessagesSinglePage, type MessageCreateParams as MessageCreateParams, type MessageUpdateParams as MessageUpdateParams, type MessageDeleteParams as MessageDeleteParams, type MessageGetParams as MessageGetParams, };
}
//# sourceMappingURL=message.d.ts.map