@webex/jsdoctrinetest 3.0.0-bnr.5 → 3.0.0

package/dist/types/@webex/webex-core/src/interceptors/webex-tracking-id.d.ts

@@ -1,26 +0,0 @@
-/**
- * @class
- */
-export default class WebexTrackingIdInterceptor {
-    /**
-     * @returns {WebexTrackingIdInterceptor}
-     */
-    static create(): WebexTrackingIdInterceptor;
-    /**
-     * Sequence number; increments on access
-     * @type {Number}
-     */
-    get sequence(): number;
-    /**
-     * @see Interceptor#onRequest
-     * @param {Object} options
-     * @returns {Object}
-     */
-    onRequest(options: any): any;
-    /**
-     * Determines whether or not include a tracking id
-     * @param {Object} options
-     * @returns {boolean}
-     */
-    requiresTrackingId(options: any): boolean;
-}

package/dist/types/@webex/webex-core/src/interceptors/webex-user-agent.d.ts

@@ -1,22 +0,0 @@
-/**
- * @class
- */
-export default class WebexUserAgentInterceptor {
-    /**
-     * @returns {WebexUserAgentInterceptor}
-     */
-    static create(): WebexUserAgentInterceptor;
-    /**
-     * @param {Object} [options={}]
-     * @param {WebexCore} [options.webex]
-     * @private
-     * @returns {WebexUserAgentInterceptor}
-     */
-    private constructor();
-    /**
-     * @see Interceptor#onRequest
-     * @param {Object} options
-     * @returns {Object}
-     */
-    onRequest(options: any): any;
-}

package/dist/types/@webex/webex-core/src/lib/batcher.d.ts

@@ -1,6 +0,0 @@
-export default Batcher;
-/**
- * Base class for coalescing requests to batched APIs
- * @class Batcher
- */
-declare const Batcher: any;

package/dist/types/@webex/webex-core/src/lib/credentials/credentials.d.ts

@@ -1,5 +0,0 @@
-export default Credentials;
-/**
- * @class
- */
-declare const Credentials: any;

package/dist/types/@webex/webex-core/src/lib/credentials/grant-errors.d.ts

@@ -1,57 +0,0 @@
-/**
- * Error thrown during oauth flow
- */
-export class OAuthError {
-    /**
-     * @param {HttpResponse} res
-     * @returns {string}
-     */
-    parse(res: HttpResponse): string;
-}
-export default errors;
-declare namespace errors {
-    export { OAuthError };
-    export { InvalidRequestError };
-    export { InvalidClientError };
-    export { InvalidGrantError };
-    export { UnauthorizedClientError };
-    export { UnsupportGrantTypeError };
-    export { InvalidScopeError };
-    export { InvalidRequestError as invalid_request };
-    export { InvalidClientError as invalid_client };
-    export { InvalidGrantError as invalid_grant };
-    export { UnauthorizedClientError as unauthorized_client };
-    export { UnsupportGrantTypeError as unsupported_grant_type };
-    export { InvalidScopeError as invalid_scope };
-    export function select(errorString: any): any;
-}
-/**
- * InvalidRequestError
- */
-declare class InvalidRequestError extends OAuthError {
-}
-/**
- * InvalidClientError
- */
-declare class InvalidClientError extends OAuthError {
-}
-/**
- * InvalidGrantError
- */
-declare class InvalidGrantError extends OAuthError {
-}
-/**
- * UnauthorizedClientError
- */
-declare class UnauthorizedClientError extends OAuthError {
-}
-/**
- * UnsupportGrantTypeError
- */
-declare class UnsupportGrantTypeError extends OAuthError {
-}
-/**
- * InvalidScopeError
- */
-declare class InvalidScopeError extends OAuthError {
-}

package/dist/types/@webex/webex-core/src/lib/credentials/index.d.ts

@@ -1,4 +0,0 @@
-export { default as Credentials } from "./credentials";
-export { default as Token } from "./token";
-export { default as grantErrors } from "./grant-errors";
-export { filterScope, sortScope } from "./scope";

package/dist/types/@webex/webex-core/src/lib/credentials/scope.d.ts

@@ -1,16 +0,0 @@
-/*!
- * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
- */
-/**
- * sorts a list of scopes
- * @param {string} scope
- * @returns {string}
- */
-export function sortScope(scope: string): string;
-/**
- * sorts a list of scopes and filters the specified scope
- * @param {string} toFilter
- * @param {string} scope
- * @returns {string}
- */
-export function filterScope(toFilter: string, scope: string): string;

package/dist/types/@webex/webex-core/src/lib/credentials/token-collection.d.ts

@@ -1,2 +0,0 @@
-export default TokenCollection;
-declare const TokenCollection: any;

package/dist/types/@webex/webex-core/src/lib/credentials/token.d.ts

@@ -1,5 +0,0 @@
-export default Token;
-/**
- * @class
- */
-declare const Token: any;

package/dist/types/@webex/webex-core/src/lib/page.d.ts

@@ -1,76 +0,0 @@
-/**
- * @class Page
- */
-export default class Page {
-    /**
-     * Separate a single link header string into an actionable object
-     * @param {string} linkHeaders
-     * @private
-     * @returns {Object}
-     */
-    private static parseLinkHeaders;
-    /**
-     * @constructs {Page}
-     * @param {HttpResponse} res
-     * @param {ProxyWebex} webex
-     * @returns {Page}
-     */
-    constructor(res: HttpResponse, webex: ProxyWebex);
-    /**
-     * @type {Array}
-     */
-    get items(): any[];
-    /**
-     * @type {number}
-     */
-    get length(): number;
-    /**
-     * @private
-     * @type {Object}
-     */
-    private get links();
-    /**
-     * @private
-     * @type {ProxyWebex}
-     */
-    private get webex();
-    /**
-     * Get next page
-     * @returns {Function}
-     */
-    next(): Function;
-    /**
-     * Indicates if there's another page
-     * @returns {Boolean}
-     */
-    hasNext(): boolean;
-    /**
-     * Get previous page
-     * @returns {Page}
-     */
-    previous(): Page;
-    /**
-     * Indicates if there is a previous Page
-     * @returns {Boolean}
-     */
-    hasPrevious(): boolean;
-    /**
-     * Retrieves the `Page` at url specified by `link`
-     * @param {string} link Specifies which link header to return
-     * @private
-     * @returns {Promise<Page>}
-     */
-    private getLink;
-    /**
-     * Indicates if the specified link is in the link header
-     * @param {string} link
-     * @private
-     * @returns {Boolean}
-     */
-    private hasLink;
-    /**
-     * Iterator
-     * @returns {Object}
-     */
-    [Symbol.iterator](): any;
-}

package/dist/types/@webex/webex-core/src/lib/services/constants.d.ts

@@ -1,6 +0,0 @@
-export namespace SERVICE_CATALOGS_ENUM_TYPES {
-    const STRING: string;
-    const NUMBER: string;
-}
-export const NAMESPACE: "services";
-export const SERVICE_CATALOGS: string[];

package/dist/types/@webex/webex-core/src/lib/services/index.d.ts

@@ -1,10 +0,0 @@
-export { constants };
-export { default as ServiceInterceptor } from "./interceptors/service";
-export { default as ServerErrorInterceptor } from "./interceptors/server-error";
-export { default as Services } from "./services";
-export { default as ServiceCatalog } from "./service-catalog";
-export { default as ServiceRegistry } from "./service-registry";
-export { default as ServiceState } from "./service-state";
-export { default as ServiceHost } from "./service-host";
-export { default as ServiceUrl } from "./service-url";
-import * as constants from "./constants";

package/dist/types/@webex/webex-core/src/lib/services/interceptors/server-error.d.ts

@@ -1,16 +0,0 @@
-/**
- * Changes server url when it fails
- */
-export default class ServerErrorInterceptor {
-    /**
-     * @returns {HAMessagingInterceptor}
-     */
-    static create(): HAMessagingInterceptor;
-    /**
-     * @see Interceptor#onResponseError
-     * @param {Object} options
-     * @param {Object} reason
-     * @returns {Object}
-     */
-    onResponseError(options: any, reason: any): any;
-}

package/dist/types/@webex/webex-core/src/lib/services/interceptors/service.d.ts

@@ -1,37 +0,0 @@
-/**
- * @class
- */
-export default class ServiceInterceptor {
-    /**
-     * @returns {ServiceInterceptor}
-     */
-    static create(): ServiceInterceptor;
-    /**
-     * @see Interceptor#onRequest
-     * @param {Object} options - The request PTO.
-     * @returns {Object} - The mutated request PTO.
-     */
-    onRequest(options: any): any;
-    /**
-     * Generate a usable request uri string from a service url and a resouce.
-     *
-     * @param {string} serviceUrl - The service url.
-     * @param {string} [resource] - The resouce to be appended to the service url.
-     * @returns {string} - The combined service url and resource.
-     */
-    generateUri(serviceUrl: string, resource?: string): string;
-    /**
-     * Normalizes request options relative to service identification.
-     *
-     * @param {Object} options - The request PTO.
-     * @returns {Object} - The mutated request PTO.
-     */
-    normalizeOptions(options: any): any;
-    /**
-     * Validates that the appropriate options for this interceptor are present.
-     *
-     * @param {Object} options - The request PTO.
-     * @returns {Object} - The mutated request PTO.
-     */
-    validateOptions(options: any): any;
-}

package/dist/types/@webex/webex-core/src/lib/services/metrics.d.ts

@@ -1,4 +0,0 @@
-declare namespace _default {
-    const JS_SDK_SERVICE_NOT_FOUND: string;
-}
-export default _default;

package/dist/types/@webex/webex-core/src/lib/services/service-catalog.d.ts

@@ -1,5 +0,0 @@
-export default ServiceCatalog;
-/**
- * @class
- */
-declare const ServiceCatalog: any;

package/dist/types/@webex/webex-core/src/lib/services/service-fed-ramp.d.ts

@@ -1,5 +0,0 @@
-declare namespace _default {
-    const hydra: string;
-    const u2c: string;
-}
-export default _default;

package/dist/types/@webex/webex-core/src/lib/services/service-host.d.ts

@@ -1,217 +0,0 @@
-/**
- * The parameter transfer object for {@link ServiceHost#constructor}.
- *
- * @typedef {Object} ServiceHostConstructorPTO
- * @property {string} ServiceHostConstructorPTO.catalog - The host's catalog.
- * @property {string} ServiceHostConstructorPTO.defaultUri - The host's default.
- * @property {string} ServiceHostConstructorPTO.hostGroup - The host's group.
- * @property {string} ServiceHostConstructorPTO.id - The host's clusterId.
- * @property {number} ServiceHostConstructorPTO.priority - The host's priority.
- * @property {string} ServiceHostConstructorPTO.uri - The host's uri.
- */
-/**
- * The parameter transfer object for {@link ServiceHost#polyGenerate}.
- *
- * @typedef {Object} ServiceHostPolyGeneratePTO
- * @property {string} ServiceHostPolyGeneratePTO.catalog - The target catalog.
- * @property {string} ServiceHostPolyGeneratePTO.name - The service name.
- * @property {string} ServiceHostPolyGeneratePTO.url - The service url.
- */
-/**
- * @class
- * @classdesc - Manages a single service host and its associated data.
- */
-export default class ServiceHost {
-    /**
-     * Generate a service host using only a catalog, name, and URL.
-     *
-     * @public
-     * @static
-     * @memberof ServiceHost
-     * @param {ServiceHostPolyGeneratePTO} pto
-     * @returns {ServiceHost} - The generated service host.
-     */
-    public static polyGenerate({ catalog, name, url }: ServiceHostPolyGeneratePTO): ServiceHost;
-    /**
-     * Validate that a constructor parameter transfer object is valid.
-     *
-     * @public
-     * @static
-     * @memberof ServiceHost
-     * @param {ServiceHostConstructorPTO} pto
-     * @throws - If the parameter transfer object is not valid.
-     * @returns {undefined}
-     */
-    public static validate({ catalog, defaultUri, hostGroup, id, priority, uri }: ServiceHostConstructorPTO): undefined;
-    /**
-     * Generate a new {@link ServiceHost}.
-     *
-     * @public
-     * @constructor
-     * @memberof ServiceHost
-     * @param {ServiceHostConstructorPTO} pto
-     */
-    constructor(pto: ServiceHostConstructorPTO);
-    /**
-     * The catalog name that the {@link ServiceHost} is associated with.
-     *
-     * @instance
-     * @type {string}
-     * @public
-     * @memberof ServiceHost
-     */
-    public catalog: string;
-    /**
-     * The default URI for the {@link ServiceHost}.
-     *
-     * @instance
-     * @type {string}
-     * @public
-     * @memberof ServiceHost
-     */
-    public default: string;
-    /**
-     * The host group that the {@link ServiceHost} is associated with.
-     *
-     * @instance
-     * @type {string}
-     * @public
-     * @memberof ServiceHost
-     */
-    public hostGroup: string;
-    /**
-     * The cluster ID of the {@link ServiceHost}.
-     *
-     * @instance
-     * @type {string}
-     * @public
-     * @memberof ServiceHost
-     */
-    public id: string;
-    /**
-     * The priority value of the {@link ServiceHost}. The lower the number, the
-     * higher the priority.
-     *
-     * @instance
-     * @type {number}
-     * @public
-     * @memberof ServiceHost
-     */
-    public priority: number;
-    /**
-     * The host uri of the {@link ServiceHost}.
-     *
-     * @instance
-     * @type {string}
-     * @public
-     * @memberof ServiceHost
-     */
-    public uri: string;
-    /**
-     * If the {@link ServiceHost} is marked as failed.
-     *
-     * @instance
-     * @type {boolean}
-     * @protected
-     * @memberof ServiceHost
-     */
-    protected failed: boolean;
-    /**
-     * If the {@link ServiceHost} is marked as replaced.
-     *
-     * @instance
-     * @type {boolean}
-     * @protected
-     * @memberof ServiceHost
-     */
-    protected replaced: boolean;
-    /**
-     * If the {@link ServiceHost} is in an active state.
-     *
-     * @public
-     * @memberof ServiceHost
-     * @type {boolean} - `true` if the service is active and usable.
-     */
-    public get active(): boolean;
-    /**
-     * If the host is local to the user's cluster.
-     *
-     * @public
-     * @memberof ServiceHost
-     * @type {boolean} - If the host is local.
-     */
-    public get local(): boolean;
-    /**
-     * The service value.
-     *
-     * @public
-     * @memberof ServiceHost
-     * @type {string} - The service value.
-     */
-    public get service(): string;
-    /**
-     * The formatted url for the host.
-     *
-     * @public
-     * @memberof ServiceHost
-     * @type {string} - The service url.
-     */
-    public get url(): string;
-    /**
-     * Set one or more of the status properties of the class object.
-     *
-     * @public
-     * @memberof ServiceHost
-     * @param {Object} pto - The parameter transfer object.
-     * @property {boolean} [pto.failed] - The failed status to set.
-     * @property {boolean} [pto.replaced] - the replaced status to set.
-     * @returns {this}
-     */
-    public setStatus({ failed, replaced }: any): this;
-}
-/**
- * The parameter transfer object for {@link ServiceHostconstructor }.
- */
-export type ServiceHostConstructorPTO = {
-    /**
-     * - The host's catalog.
-     */
-    catalog: string;
-    /**
-     * - The host's default.
-     */
-    defaultUri: string;
-    /**
-     * - The host's group.
-     */
-    hostGroup: string;
-    /**
-     * - The host's clusterId.
-     */
-    id: string;
-    /**
-     * - The host's priority.
-     */
-    priority: number;
-    /**
-     * - The host's uri.
-     */
-    uri: string;
-};
-/**
- * The parameter transfer object for {@link ServiceHostpolyGenerate }.
- */
-export type ServiceHostPolyGeneratePTO = {
-    /**
-     * - The target catalog.
-     */
-    catalog: string;
-    /**
-     * - The service name.
-     */
-    name: string;
-    /**
-     * - The service url.
-     */
-    url: string;
-};