/* tslint:disable */ /* eslint-disable */ /** * Identity Security Cloud API - Notifications * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import globalAxios from 'axios'; // Some imports not used depending on template conditions // @ts-ignore import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; import type { RequestArgs } from './base'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base'; /** * * @export * @interface CreateDomainDkimV1405Response */ export interface CreateDomainDkimV1405Response { /** * A message describing the error * @type {any} * @memberof CreateDomainDkimV1405Response */ 'errorName'?: any; /** * Description of the error * @type {any} * @memberof CreateDomainDkimV1405Response */ 'errorMessage'?: any; /** * Unique tracking id for the error. * @type {string} * @memberof CreateDomainDkimV1405Response */ 'trackingId'?: string; } /** * DKIM attributes for a domain or identity * @export * @interface DkimAttributes */ export interface DkimAttributes { /** * UUID associated with domain to be verified * @type {string} * @memberof DkimAttributes */ 'id'?: string; /** * The identity or domain address * @type {string} * @memberof DkimAttributes */ 'address'?: string; /** * Whether or not DKIM has been enabled for this domain / identity * @type {boolean} * @memberof DkimAttributes */ 'dkimEnabled'?: boolean; /** * The tokens to be added to a DNS for verification * @type {Array} * @memberof DkimAttributes */ 'dkimTokens'?: Array; /** * The current status if the domain /identity has been verified. Ie SUCCESS, FAILED, PENDING * @type {string} * @memberof DkimAttributes */ 'dkimVerificationStatus'?: string; /** * The AWS SES region the domain is associated with * @type {string} * @memberof DkimAttributes */ 'region'?: string; } /** * * @export * @interface DomainAddress */ export interface DomainAddress { /** * A domain address * @type {string} * @memberof DomainAddress */ 'domain'?: string; } /** * Domain status DTO containing everything required to verify via DKIM * @export * @interface DomainStatusDto */ export interface DomainStatusDto { /** * New UUID associated with domain to be verified * @type {string} * @memberof DomainStatusDto */ 'id'?: string; /** * A domain address * @type {string} * @memberof DomainStatusDto */ 'domain'?: string; /** * DKIM is enabled for this domain * @type {boolean} * @memberof DomainStatusDto */ 'dkimEnabled'?: boolean; /** * DKIM tokens required for authentication * @type {Array} * @memberof DomainStatusDto */ 'dkimTokens'?: Array; /** * Status of DKIM authentication * @type {string} * @memberof DomainStatusDto */ 'dkimVerificationStatus'?: string; /** * The AWS SES region the domain is associated with * @type {string} * @memberof DomainStatusDto */ 'region'?: string; } /** * * @export * @interface EmailStatusDto */ export interface EmailStatusDto { /** * Unique identifier for the verified sender address * @type {string} * @memberof EmailStatusDto */ 'id'?: string | null; /** * The verified sender email address * @type {string} * @memberof EmailStatusDto */ 'email'?: string; /** * Whether the sender address is verified by domain * @type {boolean} * @memberof EmailStatusDto */ 'isVerifiedByDomain'?: boolean; /** * The verification status of the sender address * @type {string} * @memberof EmailStatusDto */ 'verificationStatus'?: EmailStatusDtoVerificationStatusEnum; /** * The AWS SES region the sender address is associated with * @type {string} * @memberof EmailStatusDto */ 'region'?: string | null; } export const EmailStatusDtoVerificationStatusEnum = { Pending: 'PENDING', Success: 'SUCCESS', Failed: 'FAILED', Na: 'NA' } as const; export type EmailStatusDtoVerificationStatusEnum = typeof EmailStatusDtoVerificationStatusEnum[keyof typeof EmailStatusDtoVerificationStatusEnum]; /** * * @export * @interface ErrorMessageDto */ export interface ErrorMessageDto { /** * The locale for the message text, a BCP 47 language tag. * @type {string} * @memberof ErrorMessageDto */ 'locale'?: string | null; /** * * @type {LocaleOrigin} * @memberof ErrorMessageDto */ 'localeOrigin'?: LocaleOrigin | null; /** * Actual text of the error message in the indicated locale. * @type {string} * @memberof ErrorMessageDto */ 'text'?: string; } /** * * @export * @interface ErrorResponseDto */ export interface ErrorResponseDto { /** * Fine-grained error code providing more detail of the error. * @type {string} * @memberof ErrorResponseDto */ 'detailCode'?: string; /** * Unique tracking id for the error. * @type {string} * @memberof ErrorResponseDto */ 'trackingId'?: string; /** * Generic localized reason for error * @type {Array} * @memberof ErrorResponseDto */ 'messages'?: Array; /** * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field * @type {Array} * @memberof ErrorResponseDto */ 'causes'?: Array; } /** * * @export * @interface GetNotificationTemplateVariablesV1401Response */ export interface GetNotificationTemplateVariablesV1401Response { /** * A message describing the error * @type {any} * @memberof GetNotificationTemplateVariablesV1401Response */ 'error'?: any; } /** * * @export * @interface GetNotificationTemplateVariablesV1429Response */ export interface GetNotificationTemplateVariablesV1429Response { /** * A message describing the error * @type {any} * @memberof GetNotificationTemplateVariablesV1429Response */ 'message'?: any; } /** * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. * @export * @enum {string} */ export const LocaleOrigin = { Default: 'DEFAULT', Request: 'REQUEST' } as const; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * MAIL FROM attributes for a domain / identity * @export * @interface MailFromAttributes */ export interface MailFromAttributes { /** * The email identity * @type {string} * @memberof MailFromAttributes */ 'identity'?: string; /** * The name of a domain that an email identity uses as a custom MAIL FROM domain * @type {string} * @memberof MailFromAttributes */ 'mailFromDomain'?: string; /** * MX record that is required in customer\'s DNS to allow the domain to receive bounce and complaint notifications that email providers send you * @type {string} * @memberof MailFromAttributes */ 'mxRecord'?: string; /** * TXT record that is required in customer\'s DNS in order to prove that Amazon SES is authorized to send email from your domain * @type {string} * @memberof MailFromAttributes */ 'txtRecord'?: string; /** * The current status of the MAIL FROM verification * @type {string} * @memberof MailFromAttributes */ 'mailFromDomainStatus'?: MailFromAttributesMailFromDomainStatusEnum; } export const MailFromAttributesMailFromDomainStatusEnum = { Pending: 'PENDING', Success: 'SUCCESS', Failed: 'FAILED' } as const; export type MailFromAttributesMailFromDomainStatusEnum = typeof MailFromAttributesMailFromDomainStatusEnum[keyof typeof MailFromAttributesMailFromDomainStatusEnum]; /** * MAIL FROM attributes for a domain / identity * @export * @interface MailFromAttributesDto */ export interface MailFromAttributesDto { /** * The identity or domain address * @type {string} * @memberof MailFromAttributesDto */ 'identity'?: string; /** * The new MAIL FROM domain of the identity. Must be a subdomain of the identity. * @type {string} * @memberof MailFromAttributesDto */ 'mailFromDomain'?: string; } /** * The notification medium (EMAIL, SLACK, or TEAMS) * @export * @enum {string} */ export const Medium = { Email: 'EMAIL', Slack: 'SLACK', Teams: 'TEAMS' } as const; export type Medium = typeof Medium[keyof typeof Medium]; /** * * @export * @interface NotificationTemplateContext */ export interface NotificationTemplateContext { /** * A JSON object that stores the context. * @type {{ [key: string]: any; }} * @memberof NotificationTemplateContext */ 'attributes'?: { [key: string]: any; }; /** * When the global context was created * @type {string} * @memberof NotificationTemplateContext */ 'created'?: string; /** * When the global context was last modified * @type {string} * @memberof NotificationTemplateContext */ 'modified'?: string; } /** * Maps an Identity\'s attribute key to a list of preferred notification mediums. * @export * @interface PreferencesDto */ export interface PreferencesDto { /** * The template notification key. * @type {string} * @memberof PreferencesDto */ 'key'?: string; /** * List of preferred notification mediums, i.e., the mediums (or method) for which notifications are enabled. More mediums may be added in the future. * @type {Array} * @memberof PreferencesDto */ 'mediums'?: Array; /** * Modified date of preference * @type {string} * @memberof PreferencesDto */ 'modified'?: string; } /** * * @export * @interface SendTestNotificationRequestDto */ export interface SendTestNotificationRequestDto { /** * The template notification key. * @type {string} * @memberof SendTestNotificationRequestDto */ 'key'?: string; /** * The notification medium. Has to be one of the following enum values. * @type {string} * @memberof SendTestNotificationRequestDto */ 'medium'?: SendTestNotificationRequestDtoMediumEnum; /** * The locale for the message text. * @type {string} * @memberof SendTestNotificationRequestDto */ 'locale'?: string; /** * A Json object that denotes the context specific to the template. * @type {object} * @memberof SendTestNotificationRequestDto */ 'context'?: object; /** * A list of override recipient email addresses for the test notification. * @type {Array} * @memberof SendTestNotificationRequestDto */ 'recipientEmailList'?: Array; /** * A list of CC email addresses for the test notification. * @type {Array} * @memberof SendTestNotificationRequestDto */ 'carbonCopy'?: Array; /** * A list of BCC email addresses for the test notification. * @type {Array} * @memberof SendTestNotificationRequestDto */ 'blindCarbonCopy'?: Array; } export const SendTestNotificationRequestDtoMediumEnum = { Email: 'EMAIL', Slack: 'SLACK', Teams: 'TEAMS' } as const; export type SendTestNotificationRequestDtoMediumEnum = typeof SendTestNotificationRequestDtoMediumEnum[keyof typeof SendTestNotificationRequestDtoMediumEnum]; /** * * @export * @interface TemplateBulkDeleteDto */ export interface TemplateBulkDeleteDto { /** * The template key to delete * @type {string} * @memberof TemplateBulkDeleteDto */ 'key': string; /** * The notification medium (EMAIL, SLACK, or TEAMS) * @type {string} * @memberof TemplateBulkDeleteDto */ 'medium'?: TemplateBulkDeleteDtoMediumEnum; /** * The locale for the message text, a BCP 47 language tag. * @type {string} * @memberof TemplateBulkDeleteDto */ 'locale'?: string; } export const TemplateBulkDeleteDtoMediumEnum = { Email: 'EMAIL', Slack: 'SLACK', Teams: 'TEAMS' } as const; export type TemplateBulkDeleteDtoMediumEnum = typeof TemplateBulkDeleteDtoMediumEnum[keyof typeof TemplateBulkDeleteDtoMediumEnum]; /** * * @export * @interface TemplateDto */ export interface TemplateDto { /** * The key of the template * @type {string} * @memberof TemplateDto */ 'key': string; /** * The name of the Task Manager Subscription * @type {string} * @memberof TemplateDto */ 'name'?: string; /** * The message medium. More mediums may be added in the future. * @type {string} * @memberof TemplateDto */ 'medium': TemplateDtoMediumEnum; /** * The locale for the message text, a BCP 47 language tag. * @type {string} * @memberof TemplateDto */ 'locale': string; /** * The subject line in the template * @type {string} * @memberof TemplateDto */ 'subject'?: string; /** * The header value is now located within the body field. If included with non-null values, will result in a 400. * @type {string} * @memberof TemplateDto * @deprecated */ 'header'?: string | null; /** * The body in the template * @type {string} * @memberof TemplateDto */ 'body'?: string; /** * The footer value is now located within the body field. If included with non-null values, will result in a 400. * @type {string} * @memberof TemplateDto * @deprecated */ 'footer'?: string | null; /** * The \"From:\" address in the template * @type {string} * @memberof TemplateDto */ 'from'?: string; /** * The \"Reply To\" line in the template * @type {string} * @memberof TemplateDto */ 'replyTo'?: string; /** * The description in the template * @type {string} * @memberof TemplateDto */ 'description'?: string; /** * This is auto-generated. * @type {string} * @memberof TemplateDto */ 'id'?: string; /** * The time when this template is created. This is auto-generated. * @type {string} * @memberof TemplateDto */ 'created'?: string; /** * The time when this template was last modified. This is auto-generated. * @type {string} * @memberof TemplateDto */ 'modified'?: string; /** * * @type {TemplateDtoSlackTemplate} * @memberof TemplateDto */ 'slackTemplate'?: TemplateDtoSlackTemplate; /** * * @type {TemplateDtoTeamsTemplate} * @memberof TemplateDto */ 'teamsTemplate'?: TemplateDtoTeamsTemplate; } export const TemplateDtoMediumEnum = { Email: 'EMAIL', Slack: 'SLACK', Teams: 'TEAMS' } as const; export type TemplateDtoMediumEnum = typeof TemplateDtoMediumEnum[keyof typeof TemplateDtoMediumEnum]; /** * * @export * @interface TemplateDtoDefault */ export interface TemplateDtoDefault { /** * The key of the default template * @type {string} * @memberof TemplateDtoDefault */ 'key'?: string; /** * The name of the default template * @type {string} * @memberof TemplateDtoDefault */ 'name'?: string; /** * The message medium. More mediums may be added in the future. * @type {string} * @memberof TemplateDtoDefault */ 'medium'?: TemplateDtoDefaultMediumEnum; /** * The locale for the message text, a BCP 47 language tag. * @type {string} * @memberof TemplateDtoDefault */ 'locale'?: string; /** * The subject of the default template * @type {string} * @memberof TemplateDtoDefault */ 'subject'?: string | null; /** * The header value is now located within the body field. If included with non-null values, will result in a 400. * @type {string} * @memberof TemplateDtoDefault * @deprecated */ 'header'?: string | null; /** * The body of the default template * @type {string} * @memberof TemplateDtoDefault */ 'body'?: string; /** * The footer value is now located within the body field. If included with non-null values, will result in a 400. * @type {string} * @memberof TemplateDtoDefault * @deprecated */ 'footer'?: string | null; /** * The \"From:\" address of the default template * @type {string} * @memberof TemplateDtoDefault */ 'from'?: string | null; /** * The \"Reply To\" field of the default template * @type {string} * @memberof TemplateDtoDefault */ 'replyTo'?: string | null; /** * The description of the default template * @type {string} * @memberof TemplateDtoDefault */ 'description'?: string | null; /** * * @type {TemplateSlack} * @memberof TemplateDtoDefault */ 'slackTemplate'?: TemplateSlack | null; /** * * @type {TemplateTeams} * @memberof TemplateDtoDefault */ 'teamsTemplate'?: TemplateTeams | null; } export const TemplateDtoDefaultMediumEnum = { Email: 'EMAIL', Slack: 'SLACK', Teams: 'TEAMS' } as const; export type TemplateDtoDefaultMediumEnum = typeof TemplateDtoDefaultMediumEnum[keyof typeof TemplateDtoDefaultMediumEnum]; /** * * @export * @interface TemplateDtoSlackTemplate */ export interface TemplateDtoSlackTemplate { /** * The template key * @type {string} * @memberof TemplateDtoSlackTemplate */ 'key'?: string | null; /** * The main text content of the Slack message * @type {string} * @memberof TemplateDtoSlackTemplate */ 'text'?: string; /** * JSON string of Slack Block Kit blocks for rich formatting * @type {string} * @memberof TemplateDtoSlackTemplate */ 'blocks'?: string | null; /** * JSON string of Slack attachments * @type {string} * @memberof TemplateDtoSlackTemplate */ 'attachments'?: string; /** * The type of notification * @type {string} * @memberof TemplateDtoSlackTemplate */ 'notificationType'?: string | null; /** * The approval request ID * @type {string} * @memberof TemplateDtoSlackTemplate */ 'approvalId'?: string | null; /** * The request ID * @type {string} * @memberof TemplateDtoSlackTemplate */ 'requestId'?: string | null; /** * The ID of the user who made the request * @type {string} * @memberof TemplateDtoSlackTemplate */ 'requestedById'?: string | null; /** * Whether this is a subscription notification * @type {boolean} * @memberof TemplateDtoSlackTemplate */ 'isSubscription'?: boolean | null; /** * * @type {TemplateSlackAutoApprovalData} * @memberof TemplateDtoSlackTemplate */ 'autoApprovalData'?: TemplateSlackAutoApprovalData | null; /** * * @type {TemplateSlackCustomFields} * @memberof TemplateDtoSlackTemplate */ 'customFields'?: TemplateSlackCustomFields | null; } /** * * @export * @interface TemplateDtoTeamsTemplate */ export interface TemplateDtoTeamsTemplate { /** * The template key * @type {string} * @memberof TemplateDtoTeamsTemplate */ 'key'?: string | null; /** * The title of the Teams message * @type {string} * @memberof TemplateDtoTeamsTemplate */ 'title'?: string | null; /** * The main text content of the Teams message * @type {string} * @memberof TemplateDtoTeamsTemplate */ 'text'?: string; /** * JSON string of the Teams adaptive card * @type {string} * @memberof TemplateDtoTeamsTemplate */ 'messageJSON'?: string | null; /** * Whether this is a subscription notification * @type {boolean} * @memberof TemplateDtoTeamsTemplate */ 'isSubscription'?: boolean | null; /** * The approval request ID * @type {string} * @memberof TemplateDtoTeamsTemplate */ 'approvalId'?: string | null; /** * The request ID * @type {string} * @memberof TemplateDtoTeamsTemplate */ 'requestId'?: string | null; /** * The ID of the user who made the request * @type {string} * @memberof TemplateDtoTeamsTemplate */ 'requestedById'?: string | null; /** * The type of notification * @type {string} * @memberof TemplateDtoTeamsTemplate */ 'notificationType'?: string | null; /** * * @type {TemplateSlackAutoApprovalData} * @memberof TemplateDtoTeamsTemplate */ 'autoApprovalData'?: TemplateSlackAutoApprovalData | null; /** * * @type {TemplateSlackCustomFields} * @memberof TemplateDtoTeamsTemplate */ 'customFields'?: TemplateSlackCustomFields | null; } /** * The notification delivery medium. * @export * @enum {string} */ export const TemplateMediumDto = { Email: 'EMAIL', Slack: 'SLACK', Teams: 'TEAMS' } as const; export type TemplateMediumDto = typeof TemplateMediumDto[keyof typeof TemplateMediumDto]; /** * * @export * @interface TemplateSlack */ export interface TemplateSlack { /** * The template key * @type {string} * @memberof TemplateSlack */ 'key'?: string | null; /** * The main text content of the Slack message * @type {string} * @memberof TemplateSlack */ 'text'?: string; /** * JSON string of Slack Block Kit blocks for rich formatting * @type {string} * @memberof TemplateSlack */ 'blocks'?: string | null; /** * JSON string of Slack attachments * @type {string} * @memberof TemplateSlack */ 'attachments'?: string; /** * The type of notification * @type {string} * @memberof TemplateSlack */ 'notificationType'?: string | null; /** * The approval request ID * @type {string} * @memberof TemplateSlack */ 'approvalId'?: string | null; /** * The request ID * @type {string} * @memberof TemplateSlack */ 'requestId'?: string | null; /** * The ID of the user who made the request * @type {string} * @memberof TemplateSlack */ 'requestedById'?: string | null; /** * Whether this is a subscription notification * @type {boolean} * @memberof TemplateSlack */ 'isSubscription'?: boolean | null; /** * * @type {TemplateSlackAutoApprovalData} * @memberof TemplateSlack */ 'autoApprovalData'?: TemplateSlackAutoApprovalData | null; /** * * @type {TemplateSlackCustomFields} * @memberof TemplateSlack */ 'customFields'?: TemplateSlackCustomFields | null; } /** * * @export * @interface TemplateSlackAutoApprovalData */ export interface TemplateSlackAutoApprovalData { /** * Whether the request was auto-approved * @type {string} * @memberof TemplateSlackAutoApprovalData */ 'isAutoApproved'?: string | null; /** * The item ID * @type {string} * @memberof TemplateSlackAutoApprovalData */ 'itemId'?: string | null; /** * The item type * @type {string} * @memberof TemplateSlackAutoApprovalData */ 'itemType'?: string | null; /** * JSON message for auto-approval * @type {string} * @memberof TemplateSlackAutoApprovalData */ 'autoApprovalMessageJSON'?: string | null; /** * Title for auto-approval * @type {string} * @memberof TemplateSlackAutoApprovalData */ 'autoApprovalTitle'?: string | null; } /** * * @export * @interface TemplateSlackCustomFields */ export interface TemplateSlackCustomFields { /** * The type of request * @type {string} * @memberof TemplateSlackCustomFields */ 'requestType'?: string | null; /** * Whether the request contains a deny action * @type {string} * @memberof TemplateSlackCustomFields */ 'containsDeny'?: string | null; /** * The campaign ID * @type {string} * @memberof TemplateSlackCustomFields */ 'campaignId'?: string | null; /** * The campaign status * @type {string} * @memberof TemplateSlackCustomFields */ 'campaignStatus'?: string | null; } /** * * @export * @interface TemplateTeams */ export interface TemplateTeams { /** * The template key * @type {string} * @memberof TemplateTeams */ 'key'?: string | null; /** * The title of the Teams message * @type {string} * @memberof TemplateTeams */ 'title'?: string | null; /** * The main text content of the Teams message * @type {string} * @memberof TemplateTeams */ 'text'?: string; /** * JSON string of the Teams adaptive card * @type {string} * @memberof TemplateTeams */ 'messageJSON'?: string | null; /** * Whether this is a subscription notification * @type {boolean} * @memberof TemplateTeams */ 'isSubscription'?: boolean | null; /** * The approval request ID * @type {string} * @memberof TemplateTeams */ 'approvalId'?: string | null; /** * The request ID * @type {string} * @memberof TemplateTeams */ 'requestId'?: string | null; /** * The ID of the user who made the request * @type {string} * @memberof TemplateTeams */ 'requestedById'?: string | null; /** * The type of notification * @type {string} * @memberof TemplateTeams */ 'notificationType'?: string | null; /** * * @type {TemplateSlackAutoApprovalData} * @memberof TemplateTeams */ 'autoApprovalData'?: TemplateSlackAutoApprovalData | null; /** * * @type {TemplateSlackCustomFields} * @memberof TemplateTeams */ 'customFields'?: TemplateSlackCustomFields | null; } /** * A variable available for use in a notification template. Variables can be template-specific (from domain events) or global (available to all templates like __recipient, __global, __util). Template variables provide self-documenting metadata about what variables are available when customizing notification templates. * @export * @interface TemplateVariable */ export interface TemplateVariable { /** * The variable name as used when rendering context in templates. * @type {string} * @memberof TemplateVariable */ 'key'?: string; /** * The data type for this variable. Use JSON Schema-like names for values (string, boolean, number, object, array) or \"function\" for template utility/helper functions (e.g. __dateTool.format(), __esc.html()). * @type {string} * @memberof TemplateVariable */ 'type'?: TemplateVariableTypeEnum; /** * Human-readable description explaining what this variable represents. * @type {string} * @memberof TemplateVariable */ 'description'?: string | null; /** * Example value demonstrating the format and usage. For type \"function\", often a Velocity-style call (e.g. $__esc.html($value)). Can be a string, number, boolean, object, array, or null when no example is defined. * @type {any} * @memberof TemplateVariable */ 'example'?: any | null; } export const TemplateVariableTypeEnum = { String: 'string', Boolean: 'boolean', Number: 'number', Object: 'object', Array: 'array', Function: 'function' } as const; export type TemplateVariableTypeEnum = typeof TemplateVariableTypeEnum[keyof typeof TemplateVariableTypeEnum]; /** * Variables available for use in a notification template. Variables can be template-specific (from domain events) or global (available to all templates like __recipient, __global, __util). * @export * @interface TemplateVariablesDto */ export interface TemplateVariablesDto { /** * The notification template key. * @type {string} * @memberof TemplateVariablesDto */ 'key'?: string; /** * * @type {TemplateMediumDto} * @memberof TemplateVariablesDto */ 'medium'?: TemplateMediumDto; /** * Global variables available to all templates for this tenant (e.g. __global.*, __recipient, __util.*, __dateTool.*, __esc.*). Includes both data variables and function-type helpers. * @type {Array} * @memberof TemplateVariablesDto */ 'globalVariables'?: Array | null; /** * Template-specific variables for the given key and medium (e.g. approverPath, requester, attributes). * @type {Array} * @memberof TemplateVariablesDto */ 'templateVariables'?: Array | null; } /** * NotificationsApi - axios parameter creator * @export */ export const NotificationsApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * Create a domain to be verified via DKIM (DomainKeys Identified Mail) * @summary Verify domain address via dkim * @param {DomainAddress} domainAddress * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createDomainDkimV1: async (domainAddress: DomainAddress, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'domainAddress' is not null or undefined assertParamExists('createDomainDkimV1', 'domainAddress', domainAddress) const localVarPath = `/verified-domains/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(domainAddress, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/docs/api/get-notification-template-v-1) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. * @summary Create notification template * @param {TemplateDto} templateDto * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createNotificationTemplateV1: async (templateDto: TemplateDto, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'templateDto' is not null or undefined assertParamExists('createNotificationTemplateV1', 'templateDto', templateDto) const localVarPath = `/notification-templates/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(templateDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Create a new sender email address and initiate verification process. * @summary Create verified from address * @param {EmailStatusDto} emailStatusDto * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createVerifiedFromAddressV1: async (emailStatusDto: EmailStatusDto, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'emailStatusDto' is not null or undefined assertParamExists('createVerifiedFromAddressV1', 'emailStatusDto', emailStatusDto) const localVarPath = `/verified-from-addresses/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(emailStatusDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This lets you bulk delete templates that you previously created for your site. * @summary Bulk delete notification templates * @param {Array} templateBulkDeleteDto * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteNotificationTemplatesInBulkV1: async (templateBulkDeleteDto: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'templateBulkDeleteDto' is not null or undefined assertParamExists('deleteNotificationTemplatesInBulkV1', 'templateBulkDeleteDto', templateBulkDeleteDto) const localVarPath = `/notification-templates/v1/bulk-delete`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(templateBulkDeleteDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Delete a verified sender email address * @summary Delete verified from address * @param {string} id Unique identifier of the verified sender address to delete. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteVerifiedFromAddressV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('deleteVerifiedFromAddressV1', 'id', id) const localVarPath = `/verified-from-addresses/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call. * @summary Get dkim attributes * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getDkimAttributesV1: async (limit?: number, offset?: number, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/verified-domains/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Retrieve MAIL FROM attributes for a given AWS SES identity. * @summary Get mail from attributes * @param {string} identity Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getMailFromAttributesV1: async (identity: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'identity' is not null or undefined assertParamExists('getMailFromAttributesV1', 'identity', identity) const localVarPath = `/mail-from-attributes/v1/{identity}` .replace(`{${"identity"}}`, encodeURIComponent(String(identity))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Returns a list of notification preferences for tenant. * @summary List notification preferences for tenant. * @param {string} key The key. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNotificationPreferencesV1: async (key: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'key' is not null or undefined assertParamExists('getNotificationPreferencesV1', 'key', key) const localVarPath = `/notification-preferences/v1/{key}` .replace(`{${"key"}}`, encodeURIComponent(String(key))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This gets a template that you have modified for your site by Id. * @summary Get notification template by id * @param {string} id Id of the Notification Template * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNotificationTemplateV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getNotificationTemplateV1', 'id', id) const localVarPath = `/notification-templates/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Returns global variables and template-specific variables for a given notification template key and medium. Use these variable names in template content; they are replaced at send time with the corresponding values. Variable lists can be sorted by key, type, or description via the sorters query parameter (default ascending by key). * @summary Get notification template variables * @param {string} key The notification template key. Valid keys (and key/medium pairs) are available from the list notification templates operation. * @param {GetNotificationTemplateVariablesV1MediumEnum} medium The notification template medium (e.g. EMAIL, SLACK, TEAMS). Valid key/medium pairs are available from the list notification templates operation. * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **key, type, description** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNotificationTemplateVariablesV1: async (key: string, medium: GetNotificationTemplateVariablesV1MediumEnum, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'key' is not null or undefined assertParamExists('getNotificationTemplateVariablesV1', 'key', key) // verify required parameter 'medium' is not null or undefined assertParamExists('getNotificationTemplateVariablesV1', 'medium', medium) const localVarPath = `/notification-template-variables/v1/{key}/{medium}` .replace(`{${"key"}}`, encodeURIComponent(String(key))) .replace(`{${"medium"}}`, encodeURIComponent(String(medium))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). * @summary Get notification template context * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNotificationsTemplateContextV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/notification-template-context/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Retrieve a list of sender email addresses and their verification statuses * @summary List from addresses * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, gt, lt* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listFromAddressesV1: async (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/verified-from-addresses/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This lists the default templates used for notifications, such as emails from IdentityNow. * @summary List notification template defaults * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listNotificationTemplateDefaultsV1: async (limit?: number, offset?: number, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/notification-template-defaults/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This lists the templates that you have modified for your site. * @summary List notification templates * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **key, name, medium** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listNotificationTemplatesV1: async (limit?: number, offset?: number, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/notification-templates/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS * @summary Change mail from domain * @param {MailFromAttributesDto} mailFromAttributesDto * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putMailFromAttributesV1: async (mailFromAttributesDto: MailFromAttributesDto, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'mailFromAttributesDto' is not null or undefined assertParamExists('putMailFromAttributesV1', 'mailFromAttributesDto', mailFromAttributesDto) const localVarPath = `/mail-from-attributes/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(mailFromAttributesDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Send a Test Notification * @summary Send test notification * @param {SendTestNotificationRequestDto} sendTestNotificationRequestDto * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ sendTestNotificationV1: async (sendTestNotificationRequestDto: SendTestNotificationRequestDto, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'sendTestNotificationRequestDto' is not null or undefined assertParamExists('sendTestNotificationV1', 'sendTestNotificationRequestDto', sendTestNotificationRequestDto) const localVarPath = `/send-test-notification/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(sendTestNotificationRequestDto, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, } }; /** * NotificationsApi - functional programming interface * @export */ export const NotificationsApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = NotificationsApiAxiosParamCreator(configuration) return { /** * Create a domain to be verified via DKIM (DomainKeys Identified Mail) * @summary Verify domain address via dkim * @param {DomainAddress} domainAddress * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async createDomainDkimV1(domainAddress: DomainAddress, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createDomainDkimV1(domainAddress, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NotificationsApi.createDomainDkimV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/docs/api/get-notification-template-v-1) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. * @summary Create notification template * @param {TemplateDto} templateDto * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async createNotificationTemplateV1(templateDto: TemplateDto, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createNotificationTemplateV1(templateDto, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NotificationsApi.createNotificationTemplateV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Create a new sender email address and initiate verification process. * @summary Create verified from address * @param {EmailStatusDto} emailStatusDto * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async createVerifiedFromAddressV1(emailStatusDto: EmailStatusDto, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createVerifiedFromAddressV1(emailStatusDto, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NotificationsApi.createVerifiedFromAddressV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This lets you bulk delete templates that you previously created for your site. * @summary Bulk delete notification templates * @param {Array} templateBulkDeleteDto * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deleteNotificationTemplatesInBulkV1(templateBulkDeleteDto: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNotificationTemplatesInBulkV1(templateBulkDeleteDto, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NotificationsApi.deleteNotificationTemplatesInBulkV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Delete a verified sender email address * @summary Delete verified from address * @param {string} id Unique identifier of the verified sender address to delete. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deleteVerifiedFromAddressV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteVerifiedFromAddressV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NotificationsApi.deleteVerifiedFromAddressV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call. * @summary Get dkim attributes * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getDkimAttributesV1(limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getDkimAttributesV1(limit, offset, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NotificationsApi.getDkimAttributesV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Retrieve MAIL FROM attributes for a given AWS SES identity. * @summary Get mail from attributes * @param {string} identity Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getMailFromAttributesV1(identity: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getMailFromAttributesV1(identity, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NotificationsApi.getMailFromAttributesV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Returns a list of notification preferences for tenant. * @summary List notification preferences for tenant. * @param {string} key The key. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getNotificationPreferencesV1(key: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getNotificationPreferencesV1(key, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NotificationsApi.getNotificationPreferencesV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This gets a template that you have modified for your site by Id. * @summary Get notification template by id * @param {string} id Id of the Notification Template * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getNotificationTemplateV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getNotificationTemplateV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NotificationsApi.getNotificationTemplateV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Returns global variables and template-specific variables for a given notification template key and medium. Use these variable names in template content; they are replaced at send time with the corresponding values. Variable lists can be sorted by key, type, or description via the sorters query parameter (default ascending by key). * @summary Get notification template variables * @param {string} key The notification template key. Valid keys (and key/medium pairs) are available from the list notification templates operation. * @param {GetNotificationTemplateVariablesV1MediumEnum} medium The notification template medium (e.g. EMAIL, SLACK, TEAMS). Valid key/medium pairs are available from the list notification templates operation. * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **key, type, description** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getNotificationTemplateVariablesV1(key: string, medium: GetNotificationTemplateVariablesV1MediumEnum, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getNotificationTemplateVariablesV1(key, medium, sorters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NotificationsApi.getNotificationTemplateVariablesV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). * @summary Get notification template context * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getNotificationsTemplateContextV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getNotificationsTemplateContextV1(axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NotificationsApi.getNotificationsTemplateContextV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Retrieve a list of sender email addresses and their verification statuses * @summary List from addresses * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, gt, lt* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listFromAddressesV1(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listFromAddressesV1(limit, offset, count, filters, sorters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NotificationsApi.listFromAddressesV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This lists the default templates used for notifications, such as emails from IdentityNow. * @summary List notification template defaults * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listNotificationTemplateDefaultsV1(limit?: number, offset?: number, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listNotificationTemplateDefaultsV1(limit, offset, filters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NotificationsApi.listNotificationTemplateDefaultsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This lists the templates that you have modified for your site. * @summary List notification templates * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **key, name, medium** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listNotificationTemplatesV1(limit?: number, offset?: number, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listNotificationTemplatesV1(limit, offset, filters, sorters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NotificationsApi.listNotificationTemplatesV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS * @summary Change mail from domain * @param {MailFromAttributesDto} mailFromAttributesDto * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async putMailFromAttributesV1(mailFromAttributesDto: MailFromAttributesDto, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.putMailFromAttributesV1(mailFromAttributesDto, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NotificationsApi.putMailFromAttributesV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Send a Test Notification * @summary Send test notification * @param {SendTestNotificationRequestDto} sendTestNotificationRequestDto * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async sendTestNotificationV1(sendTestNotificationRequestDto: SendTestNotificationRequestDto, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.sendTestNotificationV1(sendTestNotificationRequestDto, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NotificationsApi.sendTestNotificationV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, } }; /** * NotificationsApi - factory interface * @export */ export const NotificationsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = NotificationsApiFp(configuration) return { /** * Create a domain to be verified via DKIM (DomainKeys Identified Mail) * @summary Verify domain address via dkim * @param {NotificationsApiCreateDomainDkimV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createDomainDkimV1(requestParameters: NotificationsApiCreateDomainDkimV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createDomainDkimV1(requestParameters.domainAddress, axiosOptions).then((request) => request(axios, basePath)); }, /** * This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/docs/api/get-notification-template-v-1) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. * @summary Create notification template * @param {NotificationsApiCreateNotificationTemplateV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createNotificationTemplateV1(requestParameters: NotificationsApiCreateNotificationTemplateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createNotificationTemplateV1(requestParameters.templateDto, axiosOptions).then((request) => request(axios, basePath)); }, /** * Create a new sender email address and initiate verification process. * @summary Create verified from address * @param {NotificationsApiCreateVerifiedFromAddressV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createVerifiedFromAddressV1(requestParameters: NotificationsApiCreateVerifiedFromAddressV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createVerifiedFromAddressV1(requestParameters.emailStatusDto, axiosOptions).then((request) => request(axios, basePath)); }, /** * This lets you bulk delete templates that you previously created for your site. * @summary Bulk delete notification templates * @param {NotificationsApiDeleteNotificationTemplatesInBulkV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteNotificationTemplatesInBulkV1(requestParameters: NotificationsApiDeleteNotificationTemplatesInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteNotificationTemplatesInBulkV1(requestParameters.templateBulkDeleteDto, axiosOptions).then((request) => request(axios, basePath)); }, /** * Delete a verified sender email address * @summary Delete verified from address * @param {NotificationsApiDeleteVerifiedFromAddressV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteVerifiedFromAddressV1(requestParameters: NotificationsApiDeleteVerifiedFromAddressV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteVerifiedFromAddressV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call. * @summary Get dkim attributes * @param {NotificationsApiGetDkimAttributesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getDkimAttributesV1(requestParameters: NotificationsApiGetDkimAttributesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.getDkimAttributesV1(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(axios, basePath)); }, /** * Retrieve MAIL FROM attributes for a given AWS SES identity. * @summary Get mail from attributes * @param {NotificationsApiGetMailFromAttributesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getMailFromAttributesV1(requestParameters: NotificationsApiGetMailFromAttributesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getMailFromAttributesV1(requestParameters.identity, axiosOptions).then((request) => request(axios, basePath)); }, /** * Returns a list of notification preferences for tenant. * @summary List notification preferences for tenant. * @param {NotificationsApiGetNotificationPreferencesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNotificationPreferencesV1(requestParameters: NotificationsApiGetNotificationPreferencesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getNotificationPreferencesV1(requestParameters.key, axiosOptions).then((request) => request(axios, basePath)); }, /** * This gets a template that you have modified for your site by Id. * @summary Get notification template by id * @param {NotificationsApiGetNotificationTemplateV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNotificationTemplateV1(requestParameters: NotificationsApiGetNotificationTemplateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getNotificationTemplateV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * Returns global variables and template-specific variables for a given notification template key and medium. Use these variable names in template content; they are replaced at send time with the corresponding values. Variable lists can be sorted by key, type, or description via the sorters query parameter (default ascending by key). * @summary Get notification template variables * @param {NotificationsApiGetNotificationTemplateVariablesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNotificationTemplateVariablesV1(requestParameters: NotificationsApiGetNotificationTemplateVariablesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getNotificationTemplateVariablesV1(requestParameters.key, requestParameters.medium, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); }, /** * The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). * @summary Get notification template context * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNotificationsTemplateContextV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getNotificationsTemplateContextV1(axiosOptions).then((request) => request(axios, basePath)); }, /** * Retrieve a list of sender email addresses and their verification statuses * @summary List from addresses * @param {NotificationsApiListFromAddressesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listFromAddressesV1(requestParameters: NotificationsApiListFromAddressesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listFromAddressesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); }, /** * This lists the default templates used for notifications, such as emails from IdentityNow. * @summary List notification template defaults * @param {NotificationsApiListNotificationTemplateDefaultsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listNotificationTemplateDefaultsV1(requestParameters: NotificationsApiListNotificationTemplateDefaultsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listNotificationTemplateDefaultsV1(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); }, /** * This lists the templates that you have modified for your site. * @summary List notification templates * @param {NotificationsApiListNotificationTemplatesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listNotificationTemplatesV1(requestParameters: NotificationsApiListNotificationTemplatesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listNotificationTemplatesV1(requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); }, /** * Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS * @summary Change mail from domain * @param {NotificationsApiPutMailFromAttributesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ putMailFromAttributesV1(requestParameters: NotificationsApiPutMailFromAttributesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.putMailFromAttributesV1(requestParameters.mailFromAttributesDto, axiosOptions).then((request) => request(axios, basePath)); }, /** * Send a Test Notification * @summary Send test notification * @param {NotificationsApiSendTestNotificationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ sendTestNotificationV1(requestParameters: NotificationsApiSendTestNotificationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.sendTestNotificationV1(requestParameters.sendTestNotificationRequestDto, axiosOptions).then((request) => request(axios, basePath)); }, }; }; /** * Request parameters for createDomainDkimV1 operation in NotificationsApi. * @export * @interface NotificationsApiCreateDomainDkimV1Request */ export interface NotificationsApiCreateDomainDkimV1Request { /** * * @type {DomainAddress} * @memberof NotificationsApiCreateDomainDkimV1 */ readonly domainAddress: DomainAddress } /** * Request parameters for createNotificationTemplateV1 operation in NotificationsApi. * @export * @interface NotificationsApiCreateNotificationTemplateV1Request */ export interface NotificationsApiCreateNotificationTemplateV1Request { /** * * @type {TemplateDto} * @memberof NotificationsApiCreateNotificationTemplateV1 */ readonly templateDto: TemplateDto } /** * Request parameters for createVerifiedFromAddressV1 operation in NotificationsApi. * @export * @interface NotificationsApiCreateVerifiedFromAddressV1Request */ export interface NotificationsApiCreateVerifiedFromAddressV1Request { /** * * @type {EmailStatusDto} * @memberof NotificationsApiCreateVerifiedFromAddressV1 */ readonly emailStatusDto: EmailStatusDto } /** * Request parameters for deleteNotificationTemplatesInBulkV1 operation in NotificationsApi. * @export * @interface NotificationsApiDeleteNotificationTemplatesInBulkV1Request */ export interface NotificationsApiDeleteNotificationTemplatesInBulkV1Request { /** * * @type {Array} * @memberof NotificationsApiDeleteNotificationTemplatesInBulkV1 */ readonly templateBulkDeleteDto: Array } /** * Request parameters for deleteVerifiedFromAddressV1 operation in NotificationsApi. * @export * @interface NotificationsApiDeleteVerifiedFromAddressV1Request */ export interface NotificationsApiDeleteVerifiedFromAddressV1Request { /** * Unique identifier of the verified sender address to delete. * @type {string} * @memberof NotificationsApiDeleteVerifiedFromAddressV1 */ readonly id: string } /** * Request parameters for getDkimAttributesV1 operation in NotificationsApi. * @export * @interface NotificationsApiGetDkimAttributesV1Request */ export interface NotificationsApiGetDkimAttributesV1Request { /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof NotificationsApiGetDkimAttributesV1 */ readonly limit?: number /** * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof NotificationsApiGetDkimAttributesV1 */ readonly offset?: number } /** * Request parameters for getMailFromAttributesV1 operation in NotificationsApi. * @export * @interface NotificationsApiGetMailFromAttributesV1Request */ export interface NotificationsApiGetMailFromAttributesV1Request { /** * Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status * @type {string} * @memberof NotificationsApiGetMailFromAttributesV1 */ readonly identity: string } /** * Request parameters for getNotificationPreferencesV1 operation in NotificationsApi. * @export * @interface NotificationsApiGetNotificationPreferencesV1Request */ export interface NotificationsApiGetNotificationPreferencesV1Request { /** * The key. * @type {string} * @memberof NotificationsApiGetNotificationPreferencesV1 */ readonly key: string } /** * Request parameters for getNotificationTemplateV1 operation in NotificationsApi. * @export * @interface NotificationsApiGetNotificationTemplateV1Request */ export interface NotificationsApiGetNotificationTemplateV1Request { /** * Id of the Notification Template * @type {string} * @memberof NotificationsApiGetNotificationTemplateV1 */ readonly id: string } /** * Request parameters for getNotificationTemplateVariablesV1 operation in NotificationsApi. * @export * @interface NotificationsApiGetNotificationTemplateVariablesV1Request */ export interface NotificationsApiGetNotificationTemplateVariablesV1Request { /** * The notification template key. Valid keys (and key/medium pairs) are available from the list notification templates operation. * @type {string} * @memberof NotificationsApiGetNotificationTemplateVariablesV1 */ readonly key: string /** * The notification template medium (e.g. EMAIL, SLACK, TEAMS). Valid key/medium pairs are available from the list notification templates operation. * @type {'EMAIL' | 'SLACK' | 'TEAMS'} * @memberof NotificationsApiGetNotificationTemplateVariablesV1 */ readonly medium: GetNotificationTemplateVariablesV1MediumEnum /** * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **key, type, description** * @type {string} * @memberof NotificationsApiGetNotificationTemplateVariablesV1 */ readonly sorters?: string } /** * Request parameters for listFromAddressesV1 operation in NotificationsApi. * @export * @interface NotificationsApiListFromAddressesV1Request */ export interface NotificationsApiListFromAddressesV1Request { /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof NotificationsApiListFromAddressesV1 */ readonly limit?: number /** * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof NotificationsApiListFromAddressesV1 */ readonly offset?: number /** * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {boolean} * @memberof NotificationsApiListFromAddressesV1 */ readonly count?: boolean /** * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, gt, lt* * @type {string} * @memberof NotificationsApiListFromAddressesV1 */ readonly filters?: string /** * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** * @type {string} * @memberof NotificationsApiListFromAddressesV1 */ readonly sorters?: string } /** * Request parameters for listNotificationTemplateDefaultsV1 operation in NotificationsApi. * @export * @interface NotificationsApiListNotificationTemplateDefaultsV1Request */ export interface NotificationsApiListNotificationTemplateDefaultsV1Request { /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof NotificationsApiListNotificationTemplateDefaultsV1 */ readonly limit?: number /** * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof NotificationsApiListNotificationTemplateDefaultsV1 */ readonly offset?: number /** * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* * @type {string} * @memberof NotificationsApiListNotificationTemplateDefaultsV1 */ readonly filters?: string } /** * Request parameters for listNotificationTemplatesV1 operation in NotificationsApi. * @export * @interface NotificationsApiListNotificationTemplatesV1Request */ export interface NotificationsApiListNotificationTemplatesV1Request { /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof NotificationsApiListNotificationTemplatesV1 */ readonly limit?: number /** * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof NotificationsApiListNotificationTemplatesV1 */ readonly offset?: number /** * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* * @type {string} * @memberof NotificationsApiListNotificationTemplatesV1 */ readonly filters?: string /** * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **key, name, medium** * @type {string} * @memberof NotificationsApiListNotificationTemplatesV1 */ readonly sorters?: string } /** * Request parameters for putMailFromAttributesV1 operation in NotificationsApi. * @export * @interface NotificationsApiPutMailFromAttributesV1Request */ export interface NotificationsApiPutMailFromAttributesV1Request { /** * * @type {MailFromAttributesDto} * @memberof NotificationsApiPutMailFromAttributesV1 */ readonly mailFromAttributesDto: MailFromAttributesDto } /** * Request parameters for sendTestNotificationV1 operation in NotificationsApi. * @export * @interface NotificationsApiSendTestNotificationV1Request */ export interface NotificationsApiSendTestNotificationV1Request { /** * * @type {SendTestNotificationRequestDto} * @memberof NotificationsApiSendTestNotificationV1 */ readonly sendTestNotificationRequestDto: SendTestNotificationRequestDto } /** * NotificationsApi - object-oriented interface * @export * @class NotificationsApi * @extends {BaseAPI} */ export class NotificationsApi extends BaseAPI { /** * Create a domain to be verified via DKIM (DomainKeys Identified Mail) * @summary Verify domain address via dkim * @param {NotificationsApiCreateDomainDkimV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NotificationsApi */ public createDomainDkimV1(requestParameters: NotificationsApiCreateDomainDkimV1Request, axiosOptions?: RawAxiosRequestConfig) { return NotificationsApiFp(this.configuration).createDomainDkimV1(requestParameters.domainAddress, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This will update notification templates that are available in your tenant. Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/docs/api/get-notification-template-v-1) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. * @summary Create notification template * @param {NotificationsApiCreateNotificationTemplateV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NotificationsApi */ public createNotificationTemplateV1(requestParameters: NotificationsApiCreateNotificationTemplateV1Request, axiosOptions?: RawAxiosRequestConfig) { return NotificationsApiFp(this.configuration).createNotificationTemplateV1(requestParameters.templateDto, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Create a new sender email address and initiate verification process. * @summary Create verified from address * @param {NotificationsApiCreateVerifiedFromAddressV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NotificationsApi */ public createVerifiedFromAddressV1(requestParameters: NotificationsApiCreateVerifiedFromAddressV1Request, axiosOptions?: RawAxiosRequestConfig) { return NotificationsApiFp(this.configuration).createVerifiedFromAddressV1(requestParameters.emailStatusDto, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This lets you bulk delete templates that you previously created for your site. * @summary Bulk delete notification templates * @param {NotificationsApiDeleteNotificationTemplatesInBulkV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NotificationsApi */ public deleteNotificationTemplatesInBulkV1(requestParameters: NotificationsApiDeleteNotificationTemplatesInBulkV1Request, axiosOptions?: RawAxiosRequestConfig) { return NotificationsApiFp(this.configuration).deleteNotificationTemplatesInBulkV1(requestParameters.templateBulkDeleteDto, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Delete a verified sender email address * @summary Delete verified from address * @param {NotificationsApiDeleteVerifiedFromAddressV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NotificationsApi */ public deleteVerifiedFromAddressV1(requestParameters: NotificationsApiDeleteVerifiedFromAddressV1Request, axiosOptions?: RawAxiosRequestConfig) { return NotificationsApiFp(this.configuration).deleteVerifiedFromAddressV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants\' AWS SES identities. Limits retrieval to 100 identities per call. * @summary Get dkim attributes * @param {NotificationsApiGetDkimAttributesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NotificationsApi */ public getDkimAttributesV1(requestParameters: NotificationsApiGetDkimAttributesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return NotificationsApiFp(this.configuration).getDkimAttributesV1(requestParameters.limit, requestParameters.offset, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Retrieve MAIL FROM attributes for a given AWS SES identity. * @summary Get mail from attributes * @param {NotificationsApiGetMailFromAttributesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NotificationsApi */ public getMailFromAttributesV1(requestParameters: NotificationsApiGetMailFromAttributesV1Request, axiosOptions?: RawAxiosRequestConfig) { return NotificationsApiFp(this.configuration).getMailFromAttributesV1(requestParameters.identity, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Returns a list of notification preferences for tenant. * @summary List notification preferences for tenant. * @param {NotificationsApiGetNotificationPreferencesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NotificationsApi */ public getNotificationPreferencesV1(requestParameters: NotificationsApiGetNotificationPreferencesV1Request, axiosOptions?: RawAxiosRequestConfig) { return NotificationsApiFp(this.configuration).getNotificationPreferencesV1(requestParameters.key, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This gets a template that you have modified for your site by Id. * @summary Get notification template by id * @param {NotificationsApiGetNotificationTemplateV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NotificationsApi */ public getNotificationTemplateV1(requestParameters: NotificationsApiGetNotificationTemplateV1Request, axiosOptions?: RawAxiosRequestConfig) { return NotificationsApiFp(this.configuration).getNotificationTemplateV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Returns global variables and template-specific variables for a given notification template key and medium. Use these variable names in template content; they are replaced at send time with the corresponding values. Variable lists can be sorted by key, type, or description via the sorters query parameter (default ascending by key). * @summary Get notification template variables * @param {NotificationsApiGetNotificationTemplateVariablesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NotificationsApi */ public getNotificationTemplateVariablesV1(requestParameters: NotificationsApiGetNotificationTemplateVariablesV1Request, axiosOptions?: RawAxiosRequestConfig) { return NotificationsApiFp(this.configuration).getNotificationTemplateVariablesV1(requestParameters.key, requestParameters.medium, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called \"Global Context\" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). * @summary Get notification template context * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NotificationsApi */ public getNotificationsTemplateContextV1(axiosOptions?: RawAxiosRequestConfig) { return NotificationsApiFp(this.configuration).getNotificationsTemplateContextV1(axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Retrieve a list of sender email addresses and their verification statuses * @summary List from addresses * @param {NotificationsApiListFromAddressesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NotificationsApi */ public listFromAddressesV1(requestParameters: NotificationsApiListFromAddressesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return NotificationsApiFp(this.configuration).listFromAddressesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This lists the default templates used for notifications, such as emails from IdentityNow. * @summary List notification template defaults * @param {NotificationsApiListNotificationTemplateDefaultsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NotificationsApi */ public listNotificationTemplateDefaultsV1(requestParameters: NotificationsApiListNotificationTemplateDefaultsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return NotificationsApiFp(this.configuration).listNotificationTemplateDefaultsV1(requestParameters.limit, requestParameters.offset, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This lists the templates that you have modified for your site. * @summary List notification templates * @param {NotificationsApiListNotificationTemplatesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NotificationsApi */ public listNotificationTemplatesV1(requestParameters: NotificationsApiListNotificationTemplatesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return NotificationsApiFp(this.configuration).listNotificationTemplatesV1(requestParameters.limit, requestParameters.offset, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller\'s DNS * @summary Change mail from domain * @param {NotificationsApiPutMailFromAttributesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NotificationsApi */ public putMailFromAttributesV1(requestParameters: NotificationsApiPutMailFromAttributesV1Request, axiosOptions?: RawAxiosRequestConfig) { return NotificationsApiFp(this.configuration).putMailFromAttributesV1(requestParameters.mailFromAttributesDto, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Send a Test Notification * @summary Send test notification * @param {NotificationsApiSendTestNotificationV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NotificationsApi */ public sendTestNotificationV1(requestParameters: NotificationsApiSendTestNotificationV1Request, axiosOptions?: RawAxiosRequestConfig) { return NotificationsApiFp(this.configuration).sendTestNotificationV1(requestParameters.sendTestNotificationRequestDto, axiosOptions).then((request) => request(this.axios, this.basePath)); } } /** * @export */ export const GetNotificationTemplateVariablesV1MediumEnum = { Email: 'EMAIL', Slack: 'SLACK', Teams: 'TEAMS' } as const; export type GetNotificationTemplateVariablesV1MediumEnum = typeof GetNotificationTemplateVariablesV1MediumEnum[keyof typeof GetNotificationTemplateVariablesV1MediumEnum];