/**
 * Identity Security Cloud API - Shared Signals Framework (SSF)
 * 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 type { RequestArgs } from './base';
import { BaseAPI } from './base';
/**
 * Authorization scheme supported by the transmitter.
 * @export
 * @interface AuthorizationScheme
 */
export interface AuthorizationScheme {
    /**
     * URN describing the authorization specification. OAuth 2.0: `urn:ietf:rfc:6749`; Bearer token: `urn:ietf:rfc:6750`.
     * @type {string}
     * @memberof AuthorizationScheme
     */
    'spec_urn'?: string;
}
/**
 * Full delivery configuration. method and endpoint_url are required.
 * @export
 * @interface CreateStreamDeliveryRequest
 */
export interface CreateStreamDeliveryRequest {
    /**
     * Delivery method (only push is supported).
     * @type {string}
     * @memberof CreateStreamDeliveryRequest
     */
    'method': string;
    /**
     * Receiver endpoint URL for push delivery.
     * @type {string}
     * @memberof CreateStreamDeliveryRequest
     */
    'endpoint_url': string;
    /**
     * Authorization header value for delivery requests.
     * @type {string}
     * @memberof CreateStreamDeliveryRequest
     */
    'authorization_header'?: string;
}
/**
 * Request body for POST /ssf/streams (create stream).
 * @export
 * @interface CreateStreamRequest
 */
export interface CreateStreamRequest {
    /**
     *
     * @type {CreateStreamDeliveryRequest}
     * @memberof CreateStreamRequest
     */
    'delivery': CreateStreamDeliveryRequest;
    /**
     * Optional list of event types the receiver wants. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session revoke).
     * @type {Array<string>}
     * @memberof CreateStreamRequest
     */
    'events_requested'?: Array<string>;
    /**
     * Optional human-readable description of the stream.
     * @type {string}
     * @memberof CreateStreamRequest
     */
    'description'?: string;
}
/**
 * Delivery configuration for PATCH /ssf/streams (partial update). All fields are optional; only provided fields are updated.
 * @export
 * @interface DeliveryRequest
 */
export interface DeliveryRequest {
    /**
     * Delivery method (optional for PATCH).
     * @type {string}
     * @memberof DeliveryRequest
     */
    'method'?: string;
    /**
     * Receiver endpoint URL (optional for PATCH).
     * @type {string}
     * @memberof DeliveryRequest
     */
    'endpoint_url'?: string;
    /**
     * Optional authorization header value.
     * @type {string}
     * @memberof DeliveryRequest
     */
    'authorization_header'?: string;
}
/**
 * Delivery configuration returned in stream responses.
 * @export
 * @interface DeliveryResponse
 */
export interface DeliveryResponse {
    /**
     * Delivery method.
     * @type {string}
     * @memberof DeliveryResponse
     */
    'method'?: string;
    /**
     * Receiver endpoint URL.
     * @type {string}
     * @memberof DeliveryResponse
     */
    'endpoint_url'?: string;
}
/**
 *
 * @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<ErrorMessageDto>}
     * @memberof ErrorResponseDto
     */
    'messages'?: Array<ErrorMessageDto>;
    /**
     * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
     * @type {Array<ErrorMessageDto>}
     * @memberof ErrorResponseDto
     */
    'causes'?: Array<ErrorMessageDto>;
}
/**
 *
 * @export
 * @interface GetSSFConfigurationV1401Response
 */
export interface GetSSFConfigurationV1401Response {
    /**
     * A message describing the error
     * @type {any}
     * @memberof GetSSFConfigurationV1401Response
     */
    'error'?: any;
}
/**
 *
 * @export
 * @interface GetSSFConfigurationV1429Response
 */
export interface GetSSFConfigurationV1429Response {
    /**
     * A message describing the error
     * @type {any}
     * @memberof GetSSFConfigurationV1429Response
     */
    'message'?: any;
}
/**
 * @type GetStreamV1200Response
 * @export
 */
export type GetStreamV1200Response = Array<StreamConfigResponse> | StreamConfigResponse;
/**
 * A single JSON Web Key used for verifying signed delivery requests.
 * @export
 * @interface JWK
 */
export interface JWK {
    /**
     * Algorithm intended for use with the key (e.g. RS256).
     * @type {string}
     * @memberof JWK
     */
    'alg'?: string;
    /**
     * RSA public exponent (Base64url encoded).
     * @type {string}
     * @memberof JWK
     */
    'e'?: string;
    /**
     * Key ID - unique identifier for the key.
     * @type {string}
     * @memberof JWK
     */
    'kid'?: string;
    /**
     * Key type (e.g. RSA).
     * @type {string}
     * @memberof JWK
     */
    'kty'?: string;
    /**
     * RSA modulus (Base64url encoded).
     * @type {string}
     * @memberof JWK
     */
    'n'?: string;
    /**
     * Intended use of the key (e.g. sig for signature verification).
     * @type {string}
     * @memberof JWK
     */
    'use'?: string;
}
/**
 * JSON Web Key Set containing the transmitter\'s public keys for verifying signed delivery requests.
 * @export
 * @interface JWKS
 */
export interface JWKS {
    /**
     * Array of JSON Web Keys.
     * @type {Array<JWK>}
     * @memberof JWKS
     */
    'keys': Array<JWK>;
}
/**
 * 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 declare const LocaleOrigin: {
    readonly Default: "DEFAULT";
    readonly Request: "REQUEST";
};
export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin];
/**
 * Request body for PUT /ssf/streams (full replace).
 * @export
 * @interface ReplaceStreamConfigurationRequest
 */
export interface ReplaceStreamConfigurationRequest {
    /**
     * ID of the stream to replace.
     * @type {string}
     * @memberof ReplaceStreamConfigurationRequest
     */
    'stream_id': string;
    /**
     *
     * @type {ReplaceStreamConfigurationRequestDelivery}
     * @memberof ReplaceStreamConfigurationRequest
     */
    'delivery': ReplaceStreamConfigurationRequestDelivery;
    /**
     * Event types the receiver wants. Use CAEP event-type URIs.
     * @type {Array<string>}
     * @memberof ReplaceStreamConfigurationRequest
     */
    'events_requested'?: Array<string>;
    /**
     * Optional human-readable description of the stream.
     * @type {string}
     * @memberof ReplaceStreamConfigurationRequest
     */
    'description'?: string;
}
/**
 *
 * @export
 * @interface ReplaceStreamConfigurationRequestDelivery
 */
export interface ReplaceStreamConfigurationRequestDelivery {
    /**
     * Delivery method (only push is supported).
     * @type {string}
     * @memberof ReplaceStreamConfigurationRequestDelivery
     */
    'method': string;
    /**
     * Receiver endpoint URL for push delivery.
     * @type {string}
     * @memberof ReplaceStreamConfigurationRequestDelivery
     */
    'endpoint_url': string;
    /**
     * Authorization header value for delivery requests.
     * @type {string}
     * @memberof ReplaceStreamConfigurationRequestDelivery
     */
    'authorization_header'?: string;
}
/**
 * Full stream configuration returned by create/get/update/replace.
 * @export
 * @interface StreamConfigResponse
 */
export interface StreamConfigResponse {
    /**
     * Unique stream identifier.
     * @type {string}
     * @memberof StreamConfigResponse
     */
    'stream_id'?: string;
    /**
     * Issuer (transmitter) URL.
     * @type {string}
     * @memberof StreamConfigResponse
     */
    'iss'?: string;
    /**
     * Audience for the stream.
     * @type {string}
     * @memberof StreamConfigResponse
     */
    'aud'?: string;
    /**
     *
     * @type {DeliveryResponse}
     * @memberof StreamConfigResponse
     */
    'delivery'?: DeliveryResponse;
    /**
     * Event types supported by the transmitter. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session-revoked).
     * @type {Array<string>}
     * @memberof StreamConfigResponse
     */
    'events_supported'?: Array<string>;
    /**
     * Event types requested by the receiver. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session revoke).
     * @type {Array<string>}
     * @memberof StreamConfigResponse
     */
    'events_requested'?: Array<string>;
    /**
     * Event types currently being delivered (intersection of supported and requested).
     * @type {Array<string>}
     * @memberof StreamConfigResponse
     */
    'events_delivered'?: Array<string>;
    /**
     * Optional stream description.
     * @type {string}
     * @memberof StreamConfigResponse
     */
    'description'?: string;
    /**
     * Inactivity timeout in seconds (optional).
     * @type {number}
     * @memberof StreamConfigResponse
     */
    'inactivity_timeout'?: number;
    /**
     * Minimum verification interval in seconds (optional).
     * @type {number}
     * @memberof StreamConfigResponse
     */
    'min_verification_interval'?: number;
}
/**
 * Stream status returned by GET/POST /ssf/streams/status.
 * @export
 * @interface StreamStatusResponse
 */
export interface StreamStatusResponse {
    /**
     * Stream identifier.
     * @type {string}
     * @memberof StreamStatusResponse
     */
    'stream_id'?: string;
    /**
     * Operational status of the stream (enabled, paused, or disabled).
     * @type {string}
     * @memberof StreamStatusResponse
     */
    'status'?: StreamStatusResponseStatusEnum;
    /**
     * Optional reason for the current status (e.g. set when status is updated).
     * @type {string}
     * @memberof StreamStatusResponse
     */
    'reason'?: string;
}
export declare const StreamStatusResponseStatusEnum: {
    readonly Enabled: "enabled";
    readonly Paused: "paused";
    readonly Disabled: "disabled";
};
export type StreamStatusResponseStatusEnum = typeof StreamStatusResponseStatusEnum[keyof typeof StreamStatusResponseStatusEnum];
/**
 * SSF transmitter discovery metadata per the SSF specification.
 * @export
 * @interface TransmitterMetadata
 */
export interface TransmitterMetadata {
    /**
     * Version of the SSF specification supported.
     * @type {string}
     * @memberof TransmitterMetadata
     */
    'spec_version'?: string;
    /**
     * Base URL of the transmitter (issuer).
     * @type {string}
     * @memberof TransmitterMetadata
     */
    'issuer'?: string;
    /**
     * URL of the transmitter\'s JSON Web Key Set.
     * @type {string}
     * @memberof TransmitterMetadata
     */
    'jwks_uri'?: string;
    /**
     * Supported delivery methods (e.g. push URN).
     * @type {Array<string>}
     * @memberof TransmitterMetadata
     */
    'delivery_methods_supported'?: Array<string>;
    /**
     * Endpoint for stream configuration (create, read, update, replace, delete).
     * @type {string}
     * @memberof TransmitterMetadata
     */
    'configuration_endpoint'?: string;
    /**
     * Endpoint for reading and updating stream status.
     * @type {string}
     * @memberof TransmitterMetadata
     */
    'status_endpoint'?: string;
    /**
     * Endpoint for receiver verification.
     * @type {string}
     * @memberof TransmitterMetadata
     */
    'verification_endpoint'?: string;
    /**
     * Supported authorization schemes (e.g. OAuth2, Bearer).
     * @type {Array<AuthorizationScheme>}
     * @memberof TransmitterMetadata
     */
    'authorization_schemes'?: Array<AuthorizationScheme>;
}
/**
 * Stream configuration response including updatedAt (for PATCH/PUT). Same JSON shape as GET single stream plus updatedAt.
 * @export
 * @interface UpdateStreamConfigResponse
 */
export interface UpdateStreamConfigResponse {
    /**
     * Unique stream identifier.
     * @type {string}
     * @memberof UpdateStreamConfigResponse
     */
    'stream_id'?: string;
    /**
     * Issuer (transmitter) URL.
     * @type {string}
     * @memberof UpdateStreamConfigResponse
     */
    'iss'?: string;
    /**
     * Audience for the stream.
     * @type {string}
     * @memberof UpdateStreamConfigResponse
     */
    'aud'?: string;
    /**
     *
     * @type {DeliveryResponse}
     * @memberof UpdateStreamConfigResponse
     */
    'delivery'?: DeliveryResponse;
    /**
     * Event types supported by the transmitter. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session-revoked).
     * @type {Array<string>}
     * @memberof UpdateStreamConfigResponse
     */
    'events_supported'?: Array<string>;
    /**
     * Event types requested by the receiver. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session revoke).
     * @type {Array<string>}
     * @memberof UpdateStreamConfigResponse
     */
    'events_requested'?: Array<string>;
    /**
     * Event types currently being delivered (intersection of supported and requested).
     * @type {Array<string>}
     * @memberof UpdateStreamConfigResponse
     */
    'events_delivered'?: Array<string>;
    /**
     * Optional stream description.
     * @type {string}
     * @memberof UpdateStreamConfigResponse
     */
    'description'?: string;
    /**
     * Inactivity timeout in seconds (optional).
     * @type {number}
     * @memberof UpdateStreamConfigResponse
     */
    'inactivity_timeout'?: number;
    /**
     * Minimum verification interval in seconds (optional).
     * @type {number}
     * @memberof UpdateStreamConfigResponse
     */
    'min_verification_interval'?: number;
    /**
     * Timestamp of the last configuration update.
     * @type {string}
     * @memberof UpdateStreamConfigResponse
     */
    'updatedAt'?: string;
}
/**
 * Request body for PATCH /ssf/streams (partial update).
 * @export
 * @interface UpdateStreamConfigurationRequest
 */
export interface UpdateStreamConfigurationRequest {
    /**
     * ID of the stream to update.
     * @type {string}
     * @memberof UpdateStreamConfigurationRequest
     */
    'stream_id': string;
    /**
     *
     * @type {DeliveryRequest}
     * @memberof UpdateStreamConfigurationRequest
     */
    'delivery'?: DeliveryRequest;
    /**
     * Event types the receiver wants. Use CAEP event-type URIs.
     * @type {Array<string>}
     * @memberof UpdateStreamConfigurationRequest
     */
    'events_requested'?: Array<string>;
    /**
     * Optional human-readable description of the stream.
     * @type {string}
     * @memberof UpdateStreamConfigurationRequest
     */
    'description'?: string;
}
/**
 * Request body for POST /ssf/streams/status.
 * @export
 * @interface UpdateStreamStatusRequest
 */
export interface UpdateStreamStatusRequest {
    /**
     * ID of the stream whose status to update.
     * @type {string}
     * @memberof UpdateStreamStatusRequest
     */
    'stream_id': string;
    /**
     * Desired stream status.
     * @type {string}
     * @memberof UpdateStreamStatusRequest
     */
    'status': UpdateStreamStatusRequestStatusEnum;
    /**
     * Optional reason for the status change.
     * @type {string}
     * @memberof UpdateStreamStatusRequest
     */
    'reason'?: string;
}
export declare const UpdateStreamStatusRequestStatusEnum: {
    readonly Enabled: "enabled";
    readonly Paused: "paused";
    readonly Disabled: "disabled";
};
export type UpdateStreamStatusRequestStatusEnum = typeof UpdateStreamStatusRequestStatusEnum[keyof typeof UpdateStreamStatusRequestStatusEnum];
/**
 * Request body for POST /ssf/streams/verify (receiver verification).
 * @export
 * @interface VerificationRequest
 */
export interface VerificationRequest {
    /**
     * Stream ID for verification.
     * @type {string}
     * @memberof VerificationRequest
     */
    'stream_id': string;
    /**
     * Optional state value for verification challenge.
     * @type {string}
     * @memberof VerificationRequest
     */
    'state'?: string;
}
/**
 * SharedSignalsFrameworkSSFApi - axios parameter creator
 * @export
 */
export declare const SharedSignalsFrameworkSSFApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * An SSF stream is associated with the client ID of the OAuth 2.0 access token used to create the stream. One SSF stream is allowed for each client ID.  You can create a maximum of 10 SSF stream configurations for one org.
     * @summary Create stream
     * @param {CreateStreamRequest} createStreamRequest
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    createStreamV1: (createStreamRequest: CreateStreamRequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Deletes a stream by its ID. There is no request body; the stream is identified by the required query parameter `stream_id`. On success the response has no body (204 No Content).  The associated stream with the client ID (through the request OAuth 2.0 access token) is deleted.
     * @summary Delete stream
     * @param {string} streamId ID of the stream to delete. Required; omitted or empty returns 400.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    deleteStreamV1: (streamId: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Returns the transmitter\'s JSON Web Key Set (JWKS) for verifying signed delivery requests.
     * @summary Get JWKS
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    getJWKSDataV1: (axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Returns the SSF transmitter discovery metadata (well-known configuration).
     * @summary Get SSF configuration
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    getSSFConfigurationV1: (axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Returns the status (enabled, paused, disabled) and optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. The stream_id query parameter is required.
     * @summary Get stream status
     * @param {string} streamId ID of the stream whose status to retrieve.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    getStreamStatusV1: (streamId: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Retrieves either a list of all SSF stream configurations or the individual configuration if specified by ID.  As stream configurations are tied to a client ID, you can only view the stream associated with the client ID of the request OAuth 2.0 access token.  Query parameter `aud` (co filter) can be used to filter by audience.
     * @summary Get stream(s)
     * @param {string} [streamId] If provided, returns that stream; otherwise returns list of all streams.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    getStreamV1: (streamId?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Verifies an SSF stream by publishing a verification event requested by a security events provider.
     * @summary Verify stream
     * @param {VerificationRequest} verificationRequest
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    sendStreamVerificationV1: (verificationRequest: VerificationRequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Replaces a stream\'s configuration (PUT). stream_id and delivery are required; full receiver-supplied properties.  The associated stream with the client ID (through the request OAuth 2.0 access token) is replaced.
     * @summary Replace stream configuration
     * @param {ReplaceStreamConfigurationRequest} replaceStreamConfigurationRequest
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    setStreamConfigurationV1: (replaceStreamConfigurationRequest: ReplaceStreamConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Partially updates a stream\'s configuration (PATCH). Only provided fields are updated.  The associated stream with the client ID (through the request OAuth 2.0 access token) is updated.
     * @summary Update stream configuration
     * @param {UpdateStreamConfigurationRequest} updateStreamConfigurationRequest
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    updateStreamConfigurationV1: (updateStreamConfigurationRequest: UpdateStreamConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Updates the operational status (enabled, paused, disabled) with an optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token.
     * @summary Update stream status
     * @param {UpdateStreamStatusRequest} updateStreamStatusRequest
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    updateStreamStatusV1: (updateStreamStatusRequest: UpdateStreamStatusRequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * SharedSignalsFrameworkSSFApi - functional programming interface
 * @export
 */
export declare const SharedSignalsFrameworkSSFApiFp: (configuration?: Configuration) => {
    /**
     * An SSF stream is associated with the client ID of the OAuth 2.0 access token used to create the stream. One SSF stream is allowed for each client ID.  You can create a maximum of 10 SSF stream configurations for one org.
     * @summary Create stream
     * @param {CreateStreamRequest} createStreamRequest
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    createStreamV1(createStreamRequest: CreateStreamRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StreamConfigResponse>>;
    /**
     * Deletes a stream by its ID. There is no request body; the stream is identified by the required query parameter `stream_id`. On success the response has no body (204 No Content).  The associated stream with the client ID (through the request OAuth 2.0 access token) is deleted.
     * @summary Delete stream
     * @param {string} streamId ID of the stream to delete. Required; omitted or empty returns 400.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    deleteStreamV1(streamId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     * Returns the transmitter\'s JSON Web Key Set (JWKS) for verifying signed delivery requests.
     * @summary Get JWKS
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    getJWKSDataV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JWKS>>;
    /**
     * Returns the SSF transmitter discovery metadata (well-known configuration).
     * @summary Get SSF configuration
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    getSSFConfigurationV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransmitterMetadata>>;
    /**
     * Returns the status (enabled, paused, disabled) and optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. The stream_id query parameter is required.
     * @summary Get stream status
     * @param {string} streamId ID of the stream whose status to retrieve.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    getStreamStatusV1(streamId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StreamStatusResponse>>;
    /**
     * Retrieves either a list of all SSF stream configurations or the individual configuration if specified by ID.  As stream configurations are tied to a client ID, you can only view the stream associated with the client ID of the request OAuth 2.0 access token.  Query parameter `aud` (co filter) can be used to filter by audience.
     * @summary Get stream(s)
     * @param {string} [streamId] If provided, returns that stream; otherwise returns list of all streams.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    getStreamV1(streamId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamV1200Response>>;
    /**
     * Verifies an SSF stream by publishing a verification event requested by a security events provider.
     * @summary Verify stream
     * @param {VerificationRequest} verificationRequest
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    sendStreamVerificationV1(verificationRequest: VerificationRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     * Replaces a stream\'s configuration (PUT). stream_id and delivery are required; full receiver-supplied properties.  The associated stream with the client ID (through the request OAuth 2.0 access token) is replaced.
     * @summary Replace stream configuration
     * @param {ReplaceStreamConfigurationRequest} replaceStreamConfigurationRequest
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    setStreamConfigurationV1(replaceStreamConfigurationRequest: ReplaceStreamConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateStreamConfigResponse>>;
    /**
     * Partially updates a stream\'s configuration (PATCH). Only provided fields are updated.  The associated stream with the client ID (through the request OAuth 2.0 access token) is updated.
     * @summary Update stream configuration
     * @param {UpdateStreamConfigurationRequest} updateStreamConfigurationRequest
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    updateStreamConfigurationV1(updateStreamConfigurationRequest: UpdateStreamConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateStreamConfigResponse>>;
    /**
     * Updates the operational status (enabled, paused, disabled) with an optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token.
     * @summary Update stream status
     * @param {UpdateStreamStatusRequest} updateStreamStatusRequest
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    updateStreamStatusV1(updateStreamStatusRequest: UpdateStreamStatusRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StreamStatusResponse>>;
};
/**
 * SharedSignalsFrameworkSSFApi - factory interface
 * @export
 */
export declare const SharedSignalsFrameworkSSFApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * An SSF stream is associated with the client ID of the OAuth 2.0 access token used to create the stream. One SSF stream is allowed for each client ID.  You can create a maximum of 10 SSF stream configurations for one org.
     * @summary Create stream
     * @param {SharedSignalsFrameworkSSFApiCreateStreamV1Request} requestParameters Request parameters.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    createStreamV1(requestParameters: SharedSignalsFrameworkSSFApiCreateStreamV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<StreamConfigResponse>;
    /**
     * Deletes a stream by its ID. There is no request body; the stream is identified by the required query parameter `stream_id`. On success the response has no body (204 No Content).  The associated stream with the client ID (through the request OAuth 2.0 access token) is deleted.
     * @summary Delete stream
     * @param {SharedSignalsFrameworkSSFApiDeleteStreamV1Request} requestParameters Request parameters.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    deleteStreamV1(requestParameters: SharedSignalsFrameworkSSFApiDeleteStreamV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     * Returns the transmitter\'s JSON Web Key Set (JWKS) for verifying signed delivery requests.
     * @summary Get JWKS
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    getJWKSDataV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise<JWKS>;
    /**
     * Returns the SSF transmitter discovery metadata (well-known configuration).
     * @summary Get SSF configuration
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    getSSFConfigurationV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise<TransmitterMetadata>;
    /**
     * Returns the status (enabled, paused, disabled) and optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. The stream_id query parameter is required.
     * @summary Get stream status
     * @param {SharedSignalsFrameworkSSFApiGetStreamStatusV1Request} requestParameters Request parameters.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    getStreamStatusV1(requestParameters: SharedSignalsFrameworkSSFApiGetStreamStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<StreamStatusResponse>;
    /**
     * Retrieves either a list of all SSF stream configurations or the individual configuration if specified by ID.  As stream configurations are tied to a client ID, you can only view the stream associated with the client ID of the request OAuth 2.0 access token.  Query parameter `aud` (co filter) can be used to filter by audience.
     * @summary Get stream(s)
     * @param {SharedSignalsFrameworkSSFApiGetStreamV1Request} requestParameters Request parameters.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    getStreamV1(requestParameters?: SharedSignalsFrameworkSSFApiGetStreamV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<GetStreamV1200Response>;
    /**
     * Verifies an SSF stream by publishing a verification event requested by a security events provider.
     * @summary Verify stream
     * @param {SharedSignalsFrameworkSSFApiSendStreamVerificationV1Request} requestParameters Request parameters.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    sendStreamVerificationV1(requestParameters: SharedSignalsFrameworkSSFApiSendStreamVerificationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     * Replaces a stream\'s configuration (PUT). stream_id and delivery are required; full receiver-supplied properties.  The associated stream with the client ID (through the request OAuth 2.0 access token) is replaced.
     * @summary Replace stream configuration
     * @param {SharedSignalsFrameworkSSFApiSetStreamConfigurationV1Request} requestParameters Request parameters.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    setStreamConfigurationV1(requestParameters: SharedSignalsFrameworkSSFApiSetStreamConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<UpdateStreamConfigResponse>;
    /**
     * Partially updates a stream\'s configuration (PATCH). Only provided fields are updated.  The associated stream with the client ID (through the request OAuth 2.0 access token) is updated.
     * @summary Update stream configuration
     * @param {SharedSignalsFrameworkSSFApiUpdateStreamConfigurationV1Request} requestParameters Request parameters.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    updateStreamConfigurationV1(requestParameters: SharedSignalsFrameworkSSFApiUpdateStreamConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<UpdateStreamConfigResponse>;
    /**
     * Updates the operational status (enabled, paused, disabled) with an optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token.
     * @summary Update stream status
     * @param {SharedSignalsFrameworkSSFApiUpdateStreamStatusV1Request} requestParameters Request parameters.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    updateStreamStatusV1(requestParameters: SharedSignalsFrameworkSSFApiUpdateStreamStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<StreamStatusResponse>;
};
/**
 * Request parameters for createStreamV1 operation in SharedSignalsFrameworkSSFApi.
 * @export
 * @interface SharedSignalsFrameworkSSFApiCreateStreamV1Request
 */
export interface SharedSignalsFrameworkSSFApiCreateStreamV1Request {
    /**
     *
     * @type {CreateStreamRequest}
     * @memberof SharedSignalsFrameworkSSFApiCreateStreamV1
     */
    readonly createStreamRequest: CreateStreamRequest;
}
/**
 * Request parameters for deleteStreamV1 operation in SharedSignalsFrameworkSSFApi.
 * @export
 * @interface SharedSignalsFrameworkSSFApiDeleteStreamV1Request
 */
export interface SharedSignalsFrameworkSSFApiDeleteStreamV1Request {
    /**
     * ID of the stream to delete. Required; omitted or empty returns 400.
     * @type {string}
     * @memberof SharedSignalsFrameworkSSFApiDeleteStreamV1
     */
    readonly streamId: string;
}
/**
 * Request parameters for getStreamStatusV1 operation in SharedSignalsFrameworkSSFApi.
 * @export
 * @interface SharedSignalsFrameworkSSFApiGetStreamStatusV1Request
 */
export interface SharedSignalsFrameworkSSFApiGetStreamStatusV1Request {
    /**
     * ID of the stream whose status to retrieve.
     * @type {string}
     * @memberof SharedSignalsFrameworkSSFApiGetStreamStatusV1
     */
    readonly streamId: string;
}
/**
 * Request parameters for getStreamV1 operation in SharedSignalsFrameworkSSFApi.
 * @export
 * @interface SharedSignalsFrameworkSSFApiGetStreamV1Request
 */
export interface SharedSignalsFrameworkSSFApiGetStreamV1Request {
    /**
     * If provided, returns that stream; otherwise returns list of all streams.
     * @type {string}
     * @memberof SharedSignalsFrameworkSSFApiGetStreamV1
     */
    readonly streamId?: string;
}
/**
 * Request parameters for sendStreamVerificationV1 operation in SharedSignalsFrameworkSSFApi.
 * @export
 * @interface SharedSignalsFrameworkSSFApiSendStreamVerificationV1Request
 */
export interface SharedSignalsFrameworkSSFApiSendStreamVerificationV1Request {
    /**
     *
     * @type {VerificationRequest}
     * @memberof SharedSignalsFrameworkSSFApiSendStreamVerificationV1
     */
    readonly verificationRequest: VerificationRequest;
}
/**
 * Request parameters for setStreamConfigurationV1 operation in SharedSignalsFrameworkSSFApi.
 * @export
 * @interface SharedSignalsFrameworkSSFApiSetStreamConfigurationV1Request
 */
export interface SharedSignalsFrameworkSSFApiSetStreamConfigurationV1Request {
    /**
     *
     * @type {ReplaceStreamConfigurationRequest}
     * @memberof SharedSignalsFrameworkSSFApiSetStreamConfigurationV1
     */
    readonly replaceStreamConfigurationRequest: ReplaceStreamConfigurationRequest;
}
/**
 * Request parameters for updateStreamConfigurationV1 operation in SharedSignalsFrameworkSSFApi.
 * @export
 * @interface SharedSignalsFrameworkSSFApiUpdateStreamConfigurationV1Request
 */
export interface SharedSignalsFrameworkSSFApiUpdateStreamConfigurationV1Request {
    /**
     *
     * @type {UpdateStreamConfigurationRequest}
     * @memberof SharedSignalsFrameworkSSFApiUpdateStreamConfigurationV1
     */
    readonly updateStreamConfigurationRequest: UpdateStreamConfigurationRequest;
}
/**
 * Request parameters for updateStreamStatusV1 operation in SharedSignalsFrameworkSSFApi.
 * @export
 * @interface SharedSignalsFrameworkSSFApiUpdateStreamStatusV1Request
 */
export interface SharedSignalsFrameworkSSFApiUpdateStreamStatusV1Request {
    /**
     *
     * @type {UpdateStreamStatusRequest}
     * @memberof SharedSignalsFrameworkSSFApiUpdateStreamStatusV1
     */
    readonly updateStreamStatusRequest: UpdateStreamStatusRequest;
}
/**
 * SharedSignalsFrameworkSSFApi - object-oriented interface
 * @export
 * @class SharedSignalsFrameworkSSFApi
 * @extends {BaseAPI}
 */
export declare class SharedSignalsFrameworkSSFApi extends BaseAPI {
    /**
     * An SSF stream is associated with the client ID of the OAuth 2.0 access token used to create the stream. One SSF stream is allowed for each client ID.  You can create a maximum of 10 SSF stream configurations for one org.
     * @summary Create stream
     * @param {SharedSignalsFrameworkSSFApiCreateStreamV1Request} requestParameters Request parameters.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     * @memberof SharedSignalsFrameworkSSFApi
     */
    createStreamV1(requestParameters: SharedSignalsFrameworkSSFApiCreateStreamV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StreamConfigResponse, any>>;
    /**
     * Deletes a stream by its ID. There is no request body; the stream is identified by the required query parameter `stream_id`. On success the response has no body (204 No Content).  The associated stream with the client ID (through the request OAuth 2.0 access token) is deleted.
     * @summary Delete stream
     * @param {SharedSignalsFrameworkSSFApiDeleteStreamV1Request} requestParameters Request parameters.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     * @memberof SharedSignalsFrameworkSSFApi
     */
    deleteStreamV1(requestParameters: SharedSignalsFrameworkSSFApiDeleteStreamV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     * Returns the transmitter\'s JSON Web Key Set (JWKS) for verifying signed delivery requests.
     * @summary Get JWKS
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     * @memberof SharedSignalsFrameworkSSFApi
     */
    getJWKSDataV1(axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<JWKS, any>>;
    /**
     * Returns the SSF transmitter discovery metadata (well-known configuration).
     * @summary Get SSF configuration
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     * @memberof SharedSignalsFrameworkSSFApi
     */
    getSSFConfigurationV1(axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransmitterMetadata, any>>;
    /**
     * Returns the status (enabled, paused, disabled) and optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. The stream_id query parameter is required.
     * @summary Get stream status
     * @param {SharedSignalsFrameworkSSFApiGetStreamStatusV1Request} requestParameters Request parameters.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     * @memberof SharedSignalsFrameworkSSFApi
     */
    getStreamStatusV1(requestParameters: SharedSignalsFrameworkSSFApiGetStreamStatusV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StreamStatusResponse, any>>;
    /**
     * Retrieves either a list of all SSF stream configurations or the individual configuration if specified by ID.  As stream configurations are tied to a client ID, you can only view the stream associated with the client ID of the request OAuth 2.0 access token.  Query parameter `aud` (co filter) can be used to filter by audience.
     * @summary Get stream(s)
     * @param {SharedSignalsFrameworkSSFApiGetStreamV1Request} requestParameters Request parameters.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     * @memberof SharedSignalsFrameworkSSFApi
     */
    getStreamV1(requestParameters?: SharedSignalsFrameworkSSFApiGetStreamV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamV1200Response, any>>;
    /**
     * Verifies an SSF stream by publishing a verification event requested by a security events provider.
     * @summary Verify stream
     * @param {SharedSignalsFrameworkSSFApiSendStreamVerificationV1Request} requestParameters Request parameters.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     * @memberof SharedSignalsFrameworkSSFApi
     */
    sendStreamVerificationV1(requestParameters: SharedSignalsFrameworkSSFApiSendStreamVerificationV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     * Replaces a stream\'s configuration (PUT). stream_id and delivery are required; full receiver-supplied properties.  The associated stream with the client ID (through the request OAuth 2.0 access token) is replaced.
     * @summary Replace stream configuration
     * @param {SharedSignalsFrameworkSSFApiSetStreamConfigurationV1Request} requestParameters Request parameters.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     * @memberof SharedSignalsFrameworkSSFApi
     */
    setStreamConfigurationV1(requestParameters: SharedSignalsFrameworkSSFApiSetStreamConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateStreamConfigResponse, any>>;
    /**
     * Partially updates a stream\'s configuration (PATCH). Only provided fields are updated.  The associated stream with the client ID (through the request OAuth 2.0 access token) is updated.
     * @summary Update stream configuration
     * @param {SharedSignalsFrameworkSSFApiUpdateStreamConfigurationV1Request} requestParameters Request parameters.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     * @memberof SharedSignalsFrameworkSSFApi
     */
    updateStreamConfigurationV1(requestParameters: SharedSignalsFrameworkSSFApiUpdateStreamConfigurationV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateStreamConfigResponse, any>>;
    /**
     * Updates the operational status (enabled, paused, disabled) with an optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token.
     * @summary Update stream status
     * @param {SharedSignalsFrameworkSSFApiUpdateStreamStatusV1Request} requestParameters Request parameters.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     * @memberof SharedSignalsFrameworkSSFApi
     */
    updateStreamStatusV1(requestParameters: SharedSignalsFrameworkSSFApiUpdateStreamStatusV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StreamStatusResponse, any>>;
}