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

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as RequestsAPI from 'cloudflare/resources/cloudforce-one/requests/requests';
import * as MessageAPI from 'cloudflare/resources/cloudforce-one/requests/message';
import * as PriorityAPI from 'cloudflare/resources/cloudforce-one/requests/priority';
import { V4PagePaginationArray, type V4PagePaginationArrayParams } from 'cloudflare/pagination';
export declare class Requests extends APIResource {
    message: MessageAPI.MessageResource;
    priority: PriorityAPI.PriorityResource;
    /**
     * Creating a request adds the request into the Cloudforce One queue for analysis.
     * In addition to the content, a short title, type, priority, and releasability
     * should be provided. If one is not provided a default will be assigned.
     */
    create(accountIdentifier: string, body: RequestCreateParams, options?: Core.RequestOptions): Core.APIPromise<Item>;
    /**
     * Updating a request alters the request in the Cloudforce One queue. This API may
     * be used to update any attributes of the request after the initial submission.
     * Only fields that you choose to update need to be add to the request body
     */
    update(accountIdentifier: string, requestIdentifier: string, body: RequestUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Item>;
    /**
     * List Requests
     */
    list(accountIdentifier: string, body: RequestListParams, options?: Core.RequestOptions): Core.PagePromise<ListItemsV4PagePaginationArray, ListItem>;
    /**
     * Delete a Request
     */
    delete(accountIdentifier: string, requestIdentifier: string, options?: Core.RequestOptions): Core.APIPromise<RequestDeleteResponse>;
    /**
     * Get Request Priority, Status, and TLP constants
     */
    constants(accountIdentifier: string, options?: Core.RequestOptions): Core.APIPromise<RequestConstants>;
    /**
     * Get a Request
     */
    get(accountIdentifier: string, requestIdentifier: string, options?: Core.RequestOptions): Core.APIPromise<Item>;
    /**
     * Get Request Quota
     */
    quota(accountIdentifier: string, options?: Core.RequestOptions): Core.APIPromise<Quota>;
    /**
     * Get Request Types
     */
    types(accountIdentifier: string, options?: Core.RequestOptions): Core.APIPromise<RequestTypes>;
}
export declare class ListItemsV4PagePaginationArray extends V4PagePaginationArray<ListItem> {
}
export interface Item {
    /**
     * UUID
     */
    id: string;
    /**
     * Request content
     */
    content: string;
    created: string;
    priority: string;
    /**
     * Requested information from request
     */
    request: string;
    /**
     * Brief description of the request
     */
    summary: string;
    /**
     * The CISA defined Traffic Light Protocol (TLP)
     */
    tlp: 'clear' | 'amber' | 'amber-strict' | 'green' | 'red';
    updated: string;
    completed?: string;
    /**
     * Tokens for the request messages
     */
    message_tokens?: number;
    /**
     * Readable Request ID
     */
    readable_id?: string;
    /**
     * Request Status
     */
    status?: 'open' | 'accepted' | 'reported' | 'approved' | 'completed' | 'declined';
    /**
     * Tokens for the request
     */
    tokens?: number;
}
export interface ListItem {
    /**
     * UUID
     */
    id: string;
    /**
     * Request creation time
     */
    created: string;
    priority: 'routine' | 'high' | 'urgent';
    /**
     * Requested information from request
     */
    request: string;
    /**
     * Brief description of the request
     */
    summary: string;
    /**
     * The CISA defined Traffic Light Protocol (TLP)
     */
    tlp: 'clear' | 'amber' | 'amber-strict' | 'green' | 'red';
    /**
     * Request last updated time
     */
    updated: string;
    /**
     * Request completion time
     */
    completed?: string;
    /**
     * Tokens for the request messages
     */
    message_tokens?: number;
    /**
     * Readable Request ID
     */
    readable_id?: string;
    /**
     * Request Status
     */
    status?: 'open' | 'accepted' | 'reported' | 'approved' | 'completed' | 'declined';
    /**
     * Tokens for the request
     */
    tokens?: number;
}
export interface Quota {
    /**
     * Anniversary date is when annual quota limit is refresh
     */
    anniversary_date?: string;
    /**
     * Quater anniversary date is when quota limit is refreshed each quarter
     */
    quarter_anniversary_date?: string;
    /**
     * Tokens for the quarter
     */
    quota?: number;
    /**
     * Tokens remaining for the quarter
     */
    remaining?: number;
}
export interface RequestConstants {
    priority?: Array<'routine' | 'high' | 'urgent'>;
    status?: Array<'open' | 'accepted' | 'reported' | 'approved' | 'completed' | 'declined'>;
    tlp?: Array<'clear' | 'amber' | 'amber-strict' | 'green' | 'red'>;
}
export type RequestTypes = Array<string>;
export type RequestDeleteResponse = unknown | Array<unknown> | string;
export interface RequestCreateParams {
    /**
     * Request content
     */
    content?: string;
    /**
     * Priority for analyzing the request
     */
    priority?: string;
    /**
     * Requested information from request
     */
    request_type?: string;
    /**
     * Brief description of the request
     */
    summary?: string;
    /**
     * The CISA defined Traffic Light Protocol (TLP)
     */
    tlp?: 'clear' | 'amber' | 'amber-strict' | 'green' | 'red';
}
export interface RequestUpdateParams {
    /**
     * Request content
     */
    content?: string;
    /**
     * Priority for analyzing the request
     */
    priority?: string;
    /**
     * Requested information from request
     */
    request_type?: string;
    /**
     * Brief description of the request
     */
    summary?: string;
    /**
     * The CISA defined Traffic Light Protocol (TLP)
     */
    tlp?: 'clear' | 'amber' | 'amber-strict' | 'green' | 'red';
}
export interface RequestListParams extends V4PagePaginationArrayParams {
    /**
     * Retrieve requests completed after this time
     */
    completed_after?: string;
    /**
     * Retrieve requests completed before this time
     */
    completed_before?: string;
    /**
     * Retrieve requests created after this time
     */
    created_after?: string;
    /**
     * Retrieve requests created before this time
     */
    created_before?: string;
    /**
     * Requested information from request
     */
    request_type?: string;
    /**
     * Field to sort results by
     */
    sort_by?: string;
    /**
     * Sort order (asc or desc)
     */
    sort_order?: 'asc' | 'desc';
    /**
     * Request Status
     */
    status?: 'open' | 'accepted' | 'reported' | 'approved' | 'completed' | 'declined';
}
export declare namespace Requests {
    export import Item = RequestsAPI.Item;
    export import ListItem = RequestsAPI.ListItem;
    export import Quota = RequestsAPI.Quota;
    export import RequestConstants = RequestsAPI.RequestConstants;
    export import RequestTypes = RequestsAPI.RequestTypes;
    export import RequestDeleteResponse = RequestsAPI.RequestDeleteResponse;
    export import ListItemsV4PagePaginationArray = RequestsAPI.ListItemsV4PagePaginationArray;
    export import RequestCreateParams = RequestsAPI.RequestCreateParams;
    export import RequestUpdateParams = RequestsAPI.RequestUpdateParams;
    export import RequestListParams = RequestsAPI.RequestListParams;
    export import MessageResource = MessageAPI.MessageResource;
    export import Message = MessageAPI.Message;
    export import MessageDeleteResponse = MessageAPI.MessageDeleteResponse;
    export import MessageGetResponse = MessageAPI.MessageGetResponse;
    export import MessageCreateParams = MessageAPI.MessageCreateParams;
    export import MessageUpdateParams = MessageAPI.MessageUpdateParams;
    export import MessageGetParams = MessageAPI.MessageGetParams;
    export import PriorityResource = PriorityAPI.PriorityResource;
    export import Label = PriorityAPI.Label;
    export import Priority = PriorityAPI.Priority;
    export import PriorityEdit = PriorityAPI.PriorityEdit;
    export import PriorityDeleteResponse = PriorityAPI.PriorityDeleteResponse;
    export import PriorityCreateParams = PriorityAPI.PriorityCreateParams;
    export import PriorityUpdateParams = PriorityAPI.PriorityUpdateParams;
}
//# sourceMappingURL=requests.d.ts.map