@datadog/datadog-api-client 1.48.0 → 1.50.0

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

@@ -1,9 +1,15 @@
 import { BaseAPIRequestFactory } from "../../datadog-api-client-common/baseapi";
 import { Configuration } from "../../datadog-api-client-common/configuration";
 import { RequestContext, ResponseContext } from "../../datadog-api-client-common/http/http";
+import { CreateOnCallNotificationRuleRequest } from "../models/CreateOnCallNotificationRuleRequest";
+import { CreateUserNotificationChannelRequest } from "../models/CreateUserNotificationChannelRequest";
 import { EscalationPolicy } from "../models/EscalationPolicy";
 import { EscalationPolicyCreateRequest } from "../models/EscalationPolicyCreateRequest";
 import { EscalationPolicyUpdateRequest } from "../models/EscalationPolicyUpdateRequest";
+import { ListNotificationChannelsResponse } from "../models/ListNotificationChannelsResponse";
+import { ListOnCallNotificationRulesResponse } from "../models/ListOnCallNotificationRulesResponse";
+import { NotificationChannel } from "../models/NotificationChannel";
+import { OnCallNotificationRule } from "../models/OnCallNotificationRule";
 import { Schedule } from "../models/Schedule";
 import { ScheduleCreateRequest } from "../models/ScheduleCreateRequest";
 import { ScheduleUpdateRequest } from "../models/ScheduleUpdateRequest";
@@ -11,19 +17,29 @@ import { Shift } from "../models/Shift";
 import { TeamOnCallResponders } from "../models/TeamOnCallResponders";
 import { TeamRoutingRules } from "../models/TeamRoutingRules";
 import { TeamRoutingRulesRequest } from "../models/TeamRoutingRulesRequest";
+import { UpdateOnCallNotificationRuleRequest } from "../models/UpdateOnCallNotificationRuleRequest";
 export declare class OnCallApiRequestFactory extends BaseAPIRequestFactory {
     createOnCallEscalationPolicy(body: EscalationPolicyCreateRequest, include?: string, _options?: Configuration): Promise<RequestContext>;
     createOnCallSchedule(body: ScheduleCreateRequest, include?: string, _options?: Configuration): Promise<RequestContext>;
+    createUserNotificationChannel(userId: string, body: CreateUserNotificationChannelRequest, _options?: Configuration): Promise<RequestContext>;
+    createUserNotificationRule(userId: string, body: CreateOnCallNotificationRuleRequest, _options?: Configuration): Promise<RequestContext>;
     deleteOnCallEscalationPolicy(policyId: string, _options?: Configuration): Promise<RequestContext>;
     deleteOnCallSchedule(scheduleId: string, _options?: Configuration): Promise<RequestContext>;
+    deleteUserNotificationChannel(userId: string, channelId: string, _options?: Configuration): Promise<RequestContext>;
+    deleteUserNotificationRule(userId: string, ruleId: string, _options?: Configuration): Promise<RequestContext>;
     getOnCallEscalationPolicy(policyId: string, include?: string, _options?: Configuration): Promise<RequestContext>;
     getOnCallSchedule(scheduleId: string, include?: string, _options?: Configuration): Promise<RequestContext>;
     getOnCallTeamRoutingRules(teamId: string, include?: string, _options?: Configuration): Promise<RequestContext>;
     getScheduleOnCallUser(scheduleId: string, include?: string, filterAtTs?: string, _options?: Configuration): Promise<RequestContext>;
     getTeamOnCallUsers(teamId: string, include?: string, _options?: Configuration): Promise<RequestContext>;
+    getUserNotificationChannel(userId: string, channelId: string, _options?: Configuration): Promise<RequestContext>;
+    getUserNotificationRule(userId: string, ruleId: string, include?: string, _options?: Configuration): Promise<RequestContext>;
+    listUserNotificationChannels(userId: string, _options?: Configuration): Promise<RequestContext>;
+    listUserNotificationRules(userId: string, include?: string, _options?: Configuration): Promise<RequestContext>;
     setOnCallTeamRoutingRules(teamId: string, body: TeamRoutingRulesRequest, include?: string, _options?: Configuration): Promise<RequestContext>;
     updateOnCallEscalationPolicy(policyId: string, body: EscalationPolicyUpdateRequest, include?: string, _options?: Configuration): Promise<RequestContext>;
     updateOnCallSchedule(scheduleId: string, body: ScheduleUpdateRequest, include?: string, _options?: Configuration): Promise<RequestContext>;
+    updateUserNotificationRule(userId: string, ruleId: string, body: UpdateOnCallNotificationRuleRequest, include?: string, _options?: Configuration): Promise<RequestContext>;
 }
 export declare class OnCallApiResponseProcessor {
     /**
@@ -42,6 +58,22 @@ export declare class OnCallApiResponseProcessor {
      * @throws ApiException if the response code was not in [200, 299]
      */
     createOnCallSchedule(response: ResponseContext): Promise<Schedule>;
+    /**
+     * 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 createUserNotificationChannel
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    createUserNotificationChannel(response: ResponseContext): Promise<NotificationChannel>;
+    /**
+     * 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 createUserNotificationRule
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    createUserNotificationRule(response: ResponseContext): Promise<OnCallNotificationRule>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -58,6 +90,22 @@ export declare class OnCallApiResponseProcessor {
      * @throws ApiException if the response code was not in [200, 299]
      */
     deleteOnCallSchedule(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 deleteUserNotificationChannel
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    deleteUserNotificationChannel(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 deleteUserNotificationRule
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    deleteUserNotificationRule(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
@@ -98,6 +146,38 @@ export declare class OnCallApiResponseProcessor {
      * @throws ApiException if the response code was not in [200, 299]
      */
     getTeamOnCallUsers(response: ResponseContext): Promise<TeamOnCallResponders>;
+    /**
+     * 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 getUserNotificationChannel
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    getUserNotificationChannel(response: ResponseContext): Promise<NotificationChannel>;
+    /**
+     * 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 getUserNotificationRule
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    getUserNotificationRule(response: ResponseContext): Promise<OnCallNotificationRule>;
+    /**
+     * 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 listUserNotificationChannels
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    listUserNotificationChannels(response: ResponseContext): Promise<ListNotificationChannelsResponse>;
+    /**
+     * 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 listUserNotificationRules
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    listUserNotificationRules(response: ResponseContext): Promise<ListOnCallNotificationRulesResponse>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -122,6 +202,14 @@ export declare class OnCallApiResponseProcessor {
      * @throws ApiException if the response code was not in [200, 299]
      */
     updateOnCallSchedule(response: ResponseContext): Promise<Schedule>;
+    /**
+     * 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 updateUserNotificationRule
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    updateUserNotificationRule(response: ResponseContext): Promise<OnCallNotificationRule>;
 }
 export interface OnCallApiCreateOnCallEscalationPolicyRequest {
     /**
@@ -145,6 +233,28 @@ export interface OnCallApiCreateOnCallScheduleRequest {
      */
     include?: string;
 }
+export interface OnCallApiCreateUserNotificationChannelRequest {
+    /**
+     * The user ID
+     * @type string
+     */
+    userId: string;
+    /**
+     * @type CreateUserNotificationChannelRequest
+     */
+    body: CreateUserNotificationChannelRequest;
+}
+export interface OnCallApiCreateUserNotificationRuleRequest {
+    /**
+     * The user ID
+     * @type string
+     */
+    userId: string;
+    /**
+     * @type CreateOnCallNotificationRuleRequest
+     */
+    body: CreateOnCallNotificationRuleRequest;
+}
 export interface OnCallApiDeleteOnCallEscalationPolicyRequest {
     /**
      * The ID of the escalation policy
@@ -159,6 +269,30 @@ export interface OnCallApiDeleteOnCallScheduleRequest {
      */
     scheduleId: string;
 }
+export interface OnCallApiDeleteUserNotificationChannelRequest {
+    /**
+     * The user ID
+     * @type string
+     */
+    userId: string;
+    /**
+     * The channel ID
+     * @type string
+     */
+    channelId: string;
+}
+export interface OnCallApiDeleteUserNotificationRuleRequest {
+    /**
+     * The user ID
+     * @type string
+     */
+    userId: string;
+    /**
+     * The rule ID
+     * @type string
+     */
+    ruleId: string;
+}
 export interface OnCallApiGetOnCallEscalationPolicyRequest {
     /**
      * The ID of the escalation policy
@@ -224,6 +358,54 @@ export interface OnCallApiGetTeamOnCallUsersRequest {
      */
     include?: string;
 }
+export interface OnCallApiGetUserNotificationChannelRequest {
+    /**
+     * The user ID
+     * @type string
+     */
+    userId: string;
+    /**
+     * The channel ID
+     * @type string
+     */
+    channelId: string;
+}
+export interface OnCallApiGetUserNotificationRuleRequest {
+    /**
+     * The user ID
+     * @type string
+     */
+    userId: string;
+    /**
+     * The rule ID
+     * @type string
+     */
+    ruleId: string;
+    /**
+     * Comma-separated list of included relationships to be returned. Allowed values: `channel`.
+     * @type string
+     */
+    include?: string;
+}
+export interface OnCallApiListUserNotificationChannelsRequest {
+    /**
+     * The user ID
+     * @type string
+     */
+    userId: string;
+}
+export interface OnCallApiListUserNotificationRulesRequest {
+    /**
+     * The user ID
+     * @type string
+     */
+    userId: string;
+    /**
+     * Comma-separated list of included relationships to be returned. Allowed values: `channel`.
+     * @type string
+     */
+    include?: string;
+}
 export interface OnCallApiSetOnCallTeamRoutingRulesRequest {
     /**
      * The team ID
@@ -272,6 +454,27 @@ export interface OnCallApiUpdateOnCallScheduleRequest {
      */
     include?: string;
 }
+export interface OnCallApiUpdateUserNotificationRuleRequest {
+    /**
+     * The user ID
+     * @type string
+     */
+    userId: string;
+    /**
+     * The rule ID
+     * @type string
+     */
+    ruleId: string;
+    /**
+     * @type UpdateOnCallNotificationRuleRequest
+     */
+    body: UpdateOnCallNotificationRuleRequest;
+    /**
+     * Comma-separated list of included relationships to be returned. Allowed values: `channel`.
+     * @type string
+     */
+    include?: string;
+}
 export declare class OnCallApi {
     private requestFactory;
     private responseProcessor;
@@ -287,6 +490,16 @@ export declare class OnCallApi {
      * @param param The request object
      */
     createOnCallSchedule(param: OnCallApiCreateOnCallScheduleRequest, options?: Configuration): Promise<Schedule>;
+    /**
+     * Create a new notification channel for a user. The authenticated user must be the target user or have the `on_call_admin` permission
+     * @param param The request object
+     */
+    createUserNotificationChannel(param: OnCallApiCreateUserNotificationChannelRequest, options?: Configuration): Promise<NotificationChannel>;
+    /**
+     * Create a new notification rule for a user. The authenticated user must be the target user or have the `on_call_admin` permission
+     * @param param The request object
+     */
+    createUserNotificationRule(param: OnCallApiCreateUserNotificationRuleRequest, options?: Configuration): Promise<OnCallNotificationRule>;
     /**
      * Delete an On-Call escalation policy
      * @param param The request object
@@ -297,6 +510,16 @@ export declare class OnCallApi {
      * @param param The request object
      */
     deleteOnCallSchedule(param: OnCallApiDeleteOnCallScheduleRequest, options?: Configuration): Promise<void>;
+    /**
+     * Delete a notification channel for a user. The authenticated user must be the target user or have the `on_call_admin` permission
+     * @param param The request object
+     */
+    deleteUserNotificationChannel(param: OnCallApiDeleteUserNotificationChannelRequest, options?: Configuration): Promise<void>;
+    /**
+     * Delete a notification rule for a user. The authenticated user must be the target user or have the `on_call_admin` permission
+     * @param param The request object
+     */
+    deleteUserNotificationRule(param: OnCallApiDeleteUserNotificationRuleRequest, options?: Configuration): Promise<void>;
     /**
      * Get an On-Call escalation policy
      * @param param The request object
@@ -322,6 +545,26 @@ export declare class OnCallApi {
      * @param param The request object
      */
     getTeamOnCallUsers(param: OnCallApiGetTeamOnCallUsersRequest, options?: Configuration): Promise<TeamOnCallResponders>;
+    /**
+     * Get a notification channel for a user. The authenticated user must be the target user or have the `on_call_admin` permission
+     * @param param The request object
+     */
+    getUserNotificationChannel(param: OnCallApiGetUserNotificationChannelRequest, options?: Configuration): Promise<NotificationChannel>;
+    /**
+     * Get a notification rule for a user. The authenticated user must be the target user or have the `on_call_admin` permission
+     * @param param The request object
+     */
+    getUserNotificationRule(param: OnCallApiGetUserNotificationRuleRequest, options?: Configuration): Promise<OnCallNotificationRule>;
+    /**
+     * List the notification channels for a user. The authenticated user must be the target user or have the `on_call_admin` permission
+     * @param param The request object
+     */
+    listUserNotificationChannels(param: OnCallApiListUserNotificationChannelsRequest, options?: Configuration): Promise<ListNotificationChannelsResponse>;
+    /**
+     * List the notification rules for a user. The authenticated user must be the target user or have the `on_call_admin` permission
+     * @param param The request object
+     */
+    listUserNotificationRules(param: OnCallApiListUserNotificationRulesRequest, options?: Configuration): Promise<ListOnCallNotificationRulesResponse>;
     /**
      * Set a team's On-Call routing rules
      * @param param The request object
@@ -337,4 +580,9 @@ export declare class OnCallApi {
      * @param param The request object
      */
     updateOnCallSchedule(param: OnCallApiUpdateOnCallScheduleRequest, options?: Configuration): Promise<Schedule>;
+    /**
+     * Update a notification rule for a user. The authenticated user must be the target user or have the `on_call_admin` permission
+     * @param param The request object
+     */
+    updateUserNotificationRule(param: OnCallApiUpdateUserNotificationRuleRequest, options?: Configuration): Promise<OnCallNotificationRule>;
 }