/** * Copyright 2022 Splunk, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"): you may * not use this file except in compliance with the License. You may obtain * a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the * License for the specific language governing permissions and limitations * under the License. * * Action Service * With the Action service in Splunk Cloud Services, you can receive incoming trigger events and use pre-defined action templates to turn these events into meaningful actions. * * OpenAPI spec version: v1beta2.12 (recommended default) * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { Action, ActionMutable, ActionResult, ActionResultEmailDetail, PublicWebhookKey, TriggerEvent } from '../models'; import BaseApiService from "../../../../baseapiservice"; import { ActionServiceExtensions } from "../../../../service_extensions/action"; import { RequestStatus } from '../../../../client'; export declare const ACTION_SERVICE_PREFIX: string; export declare const ACTION_SERVICE_CLUSTER: string; /** * Action Service * Version: v1beta2.12 * With the Action service in Splunk Cloud Services, you can receive incoming trigger events and use pre-defined action templates to turn these events into meaningful actions. */ export declare class GeneratedActionService extends BaseApiService { getServiceCluster(): string; getServicePrefix(): string; /** * Creates an action template. * @param action The action template to create. * @param args parameters to be sent with the request * @param requestStatusCallback callback function to listen to the status of a request * @return Action */ createAction: (action: Action, args?: object | undefined, requestStatusCallback?: ((requestStatus: RequestStatus) => void) | undefined) => Promise; /** * Removes an action template. * @param actionName The name of the action as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit. * @param args parameters to be sent with the request * @param requestStatusCallback callback function to listen to the status of a request */ deleteAction: (actionName: string, args?: object | undefined, requestStatusCallback?: ((requestStatus: RequestStatus) => void) | undefined) => Promise; /** * Returns a specific action template. * @param actionName The name of the action as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit. * @param args parameters to be sent with the request * @param requestStatusCallback callback function to listen to the status of a request * @return Action */ getAction: (actionName: string, args?: object | undefined, requestStatusCallback?: ((requestStatus: RequestStatus) => void) | undefined) => Promise; /** * Returns the status of an action that was invoked. The status is available for 4 days after the last status change. * @param actionName The name of the action as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit. * @param statusId The ID of the action status. * @param args parameters to be sent with the request * @param requestStatusCallback callback function to listen to the status of a request * @return ActionResult */ getActionStatus: (actionName: string, statusId: string, args?: object | undefined, requestStatusCallback?: ((requestStatus: RequestStatus) => void) | undefined) => Promise; /** * Returns the status details of the invoked email action. The status is available for 4 days after the last status change. * @param actionName The name of the action as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit. * @param statusId The ID of the action status. * @param args parameters to be sent with the request * @param requestStatusCallback callback function to listen to the status of a request * @return Array */ getActionStatusDetails: (actionName: string, statusId: string, args?: object | undefined, requestStatusCallback?: ((requestStatus: RequestStatus) => void) | undefined) => Promise; /** * Returns an array of one or two webhook keys. The first key is active. The second key, if present, is expired. * @param args parameters to be sent with the request * @param requestStatusCallback callback function to listen to the status of a request * @return Array */ getPublicWebhookKeys: (args?: object | undefined, requestStatusCallback?: ((requestStatus: RequestStatus) => void) | undefined) => Promise; /** * Returns the list of action templates. * @param args parameters to be sent with the request * @param requestStatusCallback callback function to listen to the status of a request * @return Array */ listActions: (args?: object | undefined, requestStatusCallback?: ((requestStatus: RequestStatus) => void) | undefined) => Promise; /** * Invokes an action. * @param actionName The name of the action as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit. * @param triggerEvent The action payload, which should include values for any templated fields. * @param args parameters to be sent with the request * @param requestStatusCallback callback function to listen to the status of a request */ triggerAction: (actionName: string, triggerEvent: TriggerEvent, args?: object | undefined, requestStatusCallback?: ((requestStatus: RequestStatus) => void) | undefined) => Promise; /** * Modifies an action template. * @param actionName The name of the action as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit. * @param actionMutable Updates to the action template. * @param args parameters to be sent with the request * @param requestStatusCallback callback function to listen to the status of a request * @return Action */ updateAction: (actionName: string, actionMutable: ActionMutable, args?: object | undefined, requestStatusCallback?: ((requestStatus: RequestStatus) => void) | undefined) => Promise; } export declare type ActionService = GeneratedActionService & ActionServiceExtensions; export declare const ActionService: { new (...args: any[]): { triggerAction: (actionName: string, triggerEvent: import("../../../../service_extensions/action").TriggerEventInterface) => Promise; getServiceCluster(): string; getServicePrefix(): string; client: import("../../../../client").ServiceClient; template: (strings: TemplateStringsArray, ...keys: string[]) => (tlMap: { [key: string]: string; }) => string; }; } & typeof GeneratedActionService;