@datadog/datadog-api-client 1.11.0 → 1.13.0

package/dist/packages/datadog-api-client-v2/apis/IncidentsApi.d.ts

@@ -15,23 +15,33 @@ import { IncidentRelatedObject } from "../models/IncidentRelatedObject";
 import { IncidentResponse } from "../models/IncidentResponse";
 import { IncidentResponseData } from "../models/IncidentResponseData";
 import { IncidentSearchResponse } from "../models/IncidentSearchResponse";
+import { IncidentSearchResponseIncidentsData } from "../models/IncidentSearchResponseIncidentsData";
 import { IncidentSearchSortOrder } from "../models/IncidentSearchSortOrder";
 import { IncidentsResponse } from "../models/IncidentsResponse";
+import { IncidentTodoCreateRequest } from "../models/IncidentTodoCreateRequest";
+import { IncidentTodoListResponse } from "../models/IncidentTodoListResponse";
+import { IncidentTodoPatchRequest } from "../models/IncidentTodoPatchRequest";
+import { IncidentTodoResponse } from "../models/IncidentTodoResponse";
 import { IncidentUpdateRequest } from "../models/IncidentUpdateRequest";
 export declare class IncidentsApiRequestFactory extends BaseAPIRequestFactory {
     createIncident(body: IncidentCreateRequest, _options?: Configuration): Promise<RequestContext>;
     createIncidentIntegration(incidentId: string, body: IncidentIntegrationMetadataCreateRequest, _options?: Configuration): Promise<RequestContext>;
+    createIncidentTodo(incidentId: string, body: IncidentTodoCreateRequest, _options?: Configuration): Promise<RequestContext>;
     deleteIncident(incidentId: string, _options?: Configuration): Promise<RequestContext>;
     deleteIncidentIntegration(incidentId: string, integrationMetadataId: string, _options?: Configuration): Promise<RequestContext>;
+    deleteIncidentTodo(incidentId: string, todoId: string, _options?: Configuration): Promise<RequestContext>;
     getIncident(incidentId: string, include?: Array<IncidentRelatedObject>, _options?: Configuration): Promise<RequestContext>;
     getIncidentIntegration(incidentId: string, integrationMetadataId: string, _options?: Configuration): Promise<RequestContext>;
+    getIncidentTodo(incidentId: string, todoId: string, _options?: Configuration): Promise<RequestContext>;
     listIncidentAttachments(incidentId: string, include?: Array<IncidentAttachmentRelatedObject>, filterAttachmentType?: Array<IncidentAttachmentAttachmentType>, _options?: Configuration): Promise<RequestContext>;
     listIncidentIntegrations(incidentId: string, _options?: Configuration): Promise<RequestContext>;
     listIncidents(include?: Array<IncidentRelatedObject>, pageSize?: number, pageOffset?: number, _options?: Configuration): Promise<RequestContext>;
-    searchIncidents(query: string, include?: IncidentRelatedObject, sort?: IncidentSearchSortOrder, _options?: Configuration): Promise<RequestContext>;
+    listIncidentTodos(incidentId: string, _options?: Configuration): Promise<RequestContext>;
+    searchIncidents(query: string, include?: IncidentRelatedObject, sort?: IncidentSearchSortOrder, pageSize?: number, pageOffset?: number, _options?: Configuration): Promise<RequestContext>;
     updateIncident(incidentId: string, body: IncidentUpdateRequest, include?: Array<IncidentRelatedObject>, _options?: Configuration): Promise<RequestContext>;
     updateIncidentAttachments(incidentId: string, body: IncidentAttachmentUpdateRequest, include?: Array<IncidentAttachmentRelatedObject>, _options?: Configuration): Promise<RequestContext>;
     updateIncidentIntegration(incidentId: string, integrationMetadataId: string, body: IncidentIntegrationMetadataPatchRequest, _options?: Configuration): Promise<RequestContext>;
+    updateIncidentTodo(incidentId: string, todoId: string, body: IncidentTodoPatchRequest, _options?: Configuration): Promise<RequestContext>;
 }
 export declare class IncidentsApiResponseProcessor {
     /**
@@ -50,6 +60,14 @@ export declare class IncidentsApiResponseProcessor {
      * @throws ApiException if the response code was not in [200, 299]
      */
     createIncidentIntegration(response: ResponseContext): Promise<IncidentIntegrationMetadataResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to createIncidentTodo
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    createIncidentTodo(response: ResponseContext): Promise<IncidentTodoResponse>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -66,6 +84,14 @@ export declare class IncidentsApiResponseProcessor {
      * @throws ApiException if the response code was not in [200, 299]
      */
     deleteIncidentIntegration(response: ResponseContext): Promise<void>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to deleteIncidentTodo
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    deleteIncidentTodo(response: ResponseContext): Promise<void>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -82,6 +108,14 @@ export declare class IncidentsApiResponseProcessor {
      * @throws ApiException if the response code was not in [200, 299]
      */
     getIncidentIntegration(response: ResponseContext): Promise<IncidentIntegrationMetadataResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to getIncidentTodo
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    getIncidentTodo(response: ResponseContext): Promise<IncidentTodoResponse>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -106,6 +140,14 @@ export declare class IncidentsApiResponseProcessor {
      * @throws ApiException if the response code was not in [200, 299]
      */
     listIncidents(response: ResponseContext): Promise<IncidentsResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to listIncidentTodos
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    listIncidentTodos(response: ResponseContext): Promise<IncidentTodoListResponse>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -138,6 +180,14 @@ export declare class IncidentsApiResponseProcessor {
      * @throws ApiException if the response code was not in [200, 299]
      */
     updateIncidentIntegration(response: ResponseContext): Promise<IncidentIntegrationMetadataResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to updateIncidentTodo
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    updateIncidentTodo(response: ResponseContext): Promise<IncidentTodoResponse>;
 }
 export interface IncidentsApiCreateIncidentRequest {
     /**
@@ -158,6 +208,18 @@ export interface IncidentsApiCreateIncidentIntegrationRequest {
      */
     body: IncidentIntegrationMetadataCreateRequest;
 }
+export interface IncidentsApiCreateIncidentTodoRequest {
+    /**
+     * The UUID of the incident.
+     * @type string
+     */
+    incidentId: string;
+    /**
+     * Incident todo payload.
+     * @type IncidentTodoCreateRequest
+     */
+    body: IncidentTodoCreateRequest;
+}
 export interface IncidentsApiDeleteIncidentRequest {
     /**
      * The UUID of the incident.
@@ -177,6 +239,18 @@ export interface IncidentsApiDeleteIncidentIntegrationRequest {
      */
     integrationMetadataId: string;
 }
+export interface IncidentsApiDeleteIncidentTodoRequest {
+    /**
+     * The UUID of the incident.
+     * @type string
+     */
+    incidentId: string;
+    /**
+     * The UUID of the incident todo.
+     * @type string
+     */
+    todoId: string;
+}
 export interface IncidentsApiGetIncidentRequest {
     /**
      * The UUID of the incident.
@@ -201,6 +275,18 @@ export interface IncidentsApiGetIncidentIntegrationRequest {
      */
     integrationMetadataId: string;
 }
+export interface IncidentsApiGetIncidentTodoRequest {
+    /**
+     * The UUID of the incident.
+     * @type string
+     */
+    incidentId: string;
+    /**
+     * The UUID of the incident todo.
+     * @type string
+     */
+    todoId: string;
+}
 export interface IncidentsApiListIncidentAttachmentsRequest {
     /**
      * The UUID of the incident.
@@ -242,6 +328,13 @@ export interface IncidentsApiListIncidentsRequest {
      */
     pageOffset?: number;
 }
+export interface IncidentsApiListIncidentTodosRequest {
+    /**
+     * The UUID of the incident.
+     * @type string
+     */
+    incidentId: string;
+}
 export interface IncidentsApiSearchIncidentsRequest {
     /**
      * Specifies which incidents should be returned. After entering a search query in your [Incidents page][1],
@@ -264,6 +357,16 @@ export interface IncidentsApiSearchIncidentsRequest {
      * @type IncidentSearchSortOrder
      */
     sort?: IncidentSearchSortOrder;
+    /**
+     * Size for a given page. The maximum allowed value is 5000.
+     * @type number
+     */
+    pageSize?: number;
+    /**
+     * Specific offset to use as the beginning of the returned page.
+     * @type number
+     */
+    pageOffset?: number;
 }
 export interface IncidentsApiUpdateIncidentRequest {
     /**
@@ -316,6 +419,23 @@ export interface IncidentsApiUpdateIncidentIntegrationRequest {
      */
     body: IncidentIntegrationMetadataPatchRequest;
 }
+export interface IncidentsApiUpdateIncidentTodoRequest {
+    /**
+     * The UUID of the incident.
+     * @type string
+     */
+    incidentId: string;
+    /**
+     * The UUID of the incident todo.
+     * @type string
+     */
+    todoId: string;
+    /**
+     * Incident todo payload.
+     * @type IncidentTodoPatchRequest
+     */
+    body: IncidentTodoPatchRequest;
+}
 export declare class IncidentsApi {
     private requestFactory;
     private responseProcessor;
@@ -331,6 +451,11 @@ export declare class IncidentsApi {
      * @param param The request object
      */
     createIncidentIntegration(param: IncidentsApiCreateIncidentIntegrationRequest, options?: Configuration): Promise<IncidentIntegrationMetadataResponse>;
+    /**
+     * Create an incident todo.
+     * @param param The request object
+     */
+    createIncidentTodo(param: IncidentsApiCreateIncidentTodoRequest, options?: Configuration): Promise<IncidentTodoResponse>;
     /**
      * Deletes an existing incident from the users organization.
      * @param param The request object
@@ -341,6 +466,11 @@ export declare class IncidentsApi {
      * @param param The request object
      */
     deleteIncidentIntegration(param: IncidentsApiDeleteIncidentIntegrationRequest, options?: Configuration): Promise<void>;
+    /**
+     * Delete an incident todo.
+     * @param param The request object
+     */
+    deleteIncidentTodo(param: IncidentsApiDeleteIncidentTodoRequest, options?: Configuration): Promise<void>;
     /**
      * Get the details of an incident by `incident_id`.
      * @param param The request object
@@ -351,6 +481,11 @@ export declare class IncidentsApi {
      * @param param The request object
      */
     getIncidentIntegration(param: IncidentsApiGetIncidentIntegrationRequest, options?: Configuration): Promise<IncidentIntegrationMetadataResponse>;
+    /**
+     * Get incident todo details.
+     * @param param The request object
+     */
+    getIncidentTodo(param: IncidentsApiGetIncidentTodoRequest, options?: Configuration): Promise<IncidentTodoResponse>;
     /**
      * Get all attachments for a given incident.
      * @param param The request object
@@ -370,11 +505,20 @@ export declare class IncidentsApi {
      * Provide a paginated version of listIncidents returning a generator with all the items.
      */
     listIncidentsWithPagination(param?: IncidentsApiListIncidentsRequest, options?: Configuration): AsyncGenerator<IncidentResponseData>;
+    /**
+     * Get all todos for an incident.
+     * @param param The request object
+     */
+    listIncidentTodos(param: IncidentsApiListIncidentTodosRequest, options?: Configuration): Promise<IncidentTodoListResponse>;
     /**
      * Search for incidents matching a certain query.
      * @param param The request object
      */
     searchIncidents(param: IncidentsApiSearchIncidentsRequest, options?: Configuration): Promise<IncidentSearchResponse>;
+    /**
+     * Provide a paginated version of searchIncidents returning a generator with all the items.
+     */
+    searchIncidentsWithPagination(param: IncidentsApiSearchIncidentsRequest, options?: Configuration): AsyncGenerator<IncidentSearchResponseIncidentsData>;
     /**
      * Updates an incident. Provide only the attributes that should be updated as this request is a partial update.
      * @param param The request object
@@ -390,4 +534,9 @@ export declare class IncidentsApi {
      * @param param The request object
      */
     updateIncidentIntegration(param: IncidentsApiUpdateIncidentIntegrationRequest, options?: Configuration): Promise<IncidentIntegrationMetadataResponse>;
+    /**
+     * Update an incident todo.
+     * @param param The request object
+     */
+    updateIncidentTodo(param: IncidentsApiUpdateIncidentTodoRequest, options?: Configuration): Promise<IncidentTodoResponse>;
 }