UNPKG

2.3 kBTypeScriptView Raw
1import { ResilienceOptions } from '../resilience-options';
2import { CachingOptions } from '../cache';
3import { Destination } from './destination-service-types';
4/**
5 * Fetches all instance destinations from the given URI.
6 * @param destinationServiceUri - The URI of the destination service
7 * @param jwt - The access token
8 * @param options - Options to use by retrieving destinations
9 * @returns A promise resolving to a list of instance destinations
10 */
11export declare function fetchInstanceDestinations(destinationServiceUri: string, jwt: string, options?: ResilienceOptions & CachingOptions): Promise<Destination[]>;
12/**
13 * Fetches all subaccount destinations from the given URI.
14 * @param destinationServiceUri - The URI of the destination service
15 * @param jwt - The access token
16 * @param options - Options to use by retrieving destinations
17 * @returns A promise resolving to a list of subaccount destinations
18 */
19export declare function fetchSubaccountDestinations(destinationServiceUri: string, jwt: string, options?: ResilienceOptions & CachingOptions): Promise<Destination[]>;
20export interface AuthAndExchangeTokens {
21 authHeaderJwt: string;
22 exchangeHeaderJwt?: string;
23 exchangeTenant?: string;
24}
25/**
26 * Fetches a specific destination by name from the given URI, including authorization tokens.
27 * For destinations with authenticationType OAuth2SAMLBearerAssertion, this call will trigger the OAuth2SAMLBearerFlow against the target destination.
28 * In this pass the access token as string.
29 * Fetches a specific destination with authenticationType OAuth2UserTokenExchange by name from the given URI, including authorization tokens.
30 * @param destinationServiceUri - The URI of the destination service
31 * @param token - The access token or AuthAndExchangeTokens if you want to include the X-user-token for OAuth2UserTokenExchange.
32 * @param destinationName - The name of the desired destination
33 * @param options - Options to use by retrieving destinations
34 * @returns A Promise resolving to the destination
35 * @internal
36 */
37export declare function fetchDestination(destinationServiceUri: string, token: string | AuthAndExchangeTokens, destinationName: string, options?: ResilienceOptions & CachingOptions): Promise<Destination>;
38//# sourceMappingURL=destination-service.d.ts.map
\No newline at end of file