@shipengine/connect-carrier-api/lib/app/metadata/auth-specification.d.ts

This is the typescript/javascript definitions for carrier api

import { AuthIdentifier } from './auth-identifier';
import { AccessToken, AuthorizationConfiguration, Parameter, RefreshTokenConfiguration, RequestTokenConfiguration } from './monoauth';
import Joi from 'joi';
/** @description Used to specify information about an integrations authentication */
export declare class AuthSpecification {
    /** @description Identify the type of Auth being used by the integration */
    Identifier: AuthIdentifier;
    /** @description Added to allow oauth 1.0 to work. */
    access_token?: AccessToken;
    /** @description Authorization: the beginning of an OAuth2.0 flow that ensures the user is logged in and approves access to the Resource. */
    authorization?: AuthorizationConfiguration;
    /** @description Request Token: server-server code for token exchange */
    request_token?: RequestTokenConfiguration;
    /** @description Refresh Token: server-server refresh token exchange for access token **NOTE: sometimes a new RT is also created** */
    refresh_token?: RefreshTokenConfiguration;
    /** @description Advanced configurations used for oauth 1.0 */
    advanced_configuration?: Parameter[];
}
export declare const AuthSpecificationSchema: Joi.ObjectSchema<any>;