api.ts

/// <reference path="./custom.d.ts" />
// tslint:disable
/**
 * OCMacapy80
 * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 *
 * OpenAPI spec version: v1.0.0-rc1
 *
 *
 * NOTE: This file is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 * Do not edit the file manually.
 */

import * as url from "url";
import * as isomorphicFetch from "isomorphic-fetch";
import { Configuration } from "./configuration";

const BASE_PATH = "/".replace(/\/+$/, "");

/**
 *
 * @export
 */
export const COLLECTION_FORMATS = {
    csv: ",",
    ssv: " ",
    tsv: "\t",
    pipes: "|",
};

/**
 *
 * @export
 * @interface FetchAPI
 */
export interface FetchAPI {
    (url: string, init?: any): Promise<Response>;
}

/**
 *
 * @export
 * @interface FetchArgs
 */
export interface FetchArgs {
    url: string;
    options: any;
}

/**
 *
 * @export
 * @class BaseAPI
 */
export class BaseAPI {
    protected configuration: Configuration;

    constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected fetch: FetchAPI = isomorphicFetch) {
        if (configuration) {
            this.configuration = configuration;
            this.basePath = configuration.basePath || this.basePath;
        }
    }
};

/**
 *
 * @export
 * @class RequiredError
 * @extends {Error}
 */
export class RequiredError extends Error {
    name: "RequiredError"
    constructor(public field: string, msg?: string) {
        super(msg);
    }
}

/**
 *
 * @export
 * @interface AMLRecord
 */
export interface AMLRecord {
    /**
     *
     * @type {{ [key: string]: string; }}
     * @memberof AMLRecord
     */
    aml?: { [key: string]: string; };
    /**
     *
     * @type {string}
     * @memberof AMLRecord
     */
    amlContext?: string;
    /**
     *
     * @type {string}
     * @memberof AMLRecord
     */
    version?: string;
}
/**
 *
 * @export
 * @interface ActionMenuFetchResult
 */
export interface ActionMenuFetchResult {
    /**
     * Action menu
     * @type {Menu}
     * @memberof ActionMenuFetchResult
     */
    result?: Menu;
}
/**
 *
 * @export
 * @interface ActionMenuModulesResult
 */
export interface ActionMenuModulesResult {
}
/**
 *
 * @export
 * @interface AdminConfig
 */
export interface AdminConfig {
    /**
     * Configuration settings
     * @type {any}
     * @memberof AdminConfig
     */
    config?: any;
}
/**
 *
 * @export
 * @interface AdminMediationDeny
 */
export interface AdminMediationDeny {
    /**
     * List of mediator rules for recipient
     * @type {Array<string>}
     * @memberof AdminMediationDeny
     */
    mediator_terms?: Array<string>;
    /**
     * List of recipient rules for mediation
     * @type {Array<string>}
     * @memberof AdminMediationDeny
     */
    recipient_terms?: Array<string>;
}
/**
 *
 * @export
 * @interface AdminModules
 */
export interface AdminModules {
    /**
     * List of admin modules
     * @type {Array<string>}
     * @memberof AdminModules
     */
    result?: Array<string>;
}
/**
 *
 * @export
 * @interface AdminReset
 */
export interface AdminReset {
}
/**
 *
 * @export
 * @interface AdminShutdown
 */
export interface AdminShutdown {
}
/**
 *
 * @export
 * @interface AdminStatus
 */
export interface AdminStatus {
    /**
     * Conductor statistics
     * @type {any}
     * @memberof AdminStatus
     */
    conductor?: any;
    /**
     * Default label
     * @type {string}
     * @memberof AdminStatus
     */
    label?: string;
    /**
     * Timing results
     * @type {any}
     * @memberof AdminStatus
     */
    timing?: any;
    /**
     * Version code
     * @type {string}
     * @memberof AdminStatus
     */
    version?: string;
}
/**
 *
 * @export
 * @interface AdminStatusLiveliness
 */
export interface AdminStatusLiveliness {
    /**
     * Liveliness status
     * @type {boolean}
     * @memberof AdminStatusLiveliness
     */
    alive?: boolean;
}
/**
 *
 * @export
 * @interface AdminStatusReadiness
 */
export interface AdminStatusReadiness {
    /**
     * Readiness status
     * @type {boolean}
     * @memberof AdminStatusReadiness
     */
    ready?: boolean;
}
/**
 *
 * @export
 * @interface AttachDecorator
 */
export interface AttachDecorator {
    /**
     * Attachment identifier
     * @type {string}
     * @memberof AttachDecorator
     */
    id?: string;
    /**
     * Byte count of data included by reference
     * @type {number}
     * @memberof AttachDecorator
     */
    byte_count?: number;
    /**
     *
     * @type {AttachDecoratorData}
     * @memberof AttachDecorator
     */
    data: AttachDecoratorData;
    /**
     * Human-readable description of content
     * @type {string}
     * @memberof AttachDecorator
     */
    description?: string;
    /**
     * File name
     * @type {string}
     * @memberof AttachDecorator
     */
    filename?: string;
    /**
     * Hint regarding last modification datetime, in ISO-8601 format
     * @type {string}
     * @memberof AttachDecorator
     */
    lastmod_time?: string;
    /**
     * MIME type
     * @type {string}
     * @memberof AttachDecorator
     */
    mime_type?: string;
}
/**
 *
 * @export
 * @interface AttachDecoratorData
 */
export interface AttachDecoratorData {
    /**
     * Base64-encoded data
     * @type {string}
     * @memberof AttachDecoratorData
     */
    base64?: string;
    /**
     * JSON-serialized data
     * @type {any}
     * @memberof AttachDecoratorData
     */
    json?: any;
    /**
     * Detached Java Web Signature
     * @type {AttachDecoratorDataJWS}
     * @memberof AttachDecoratorData
     */
    jws?: AttachDecoratorDataJWS;
    /**
     * List of hypertext links to data
     * @type {Array<string>}
     * @memberof AttachDecoratorData
     */
    links?: Array<string>;
    /**
     * SHA256 hash (binhex encoded) of content
     * @type {string}
     * @memberof AttachDecoratorData
     */
    sha256?: string;
}
/**
 *
 * @export
 * @interface AttachDecoratorData1JWS
 */
export interface AttachDecoratorData1JWS {
    /**
     *
     * @type {AttachDecoratorDataJWSHeader}
     * @memberof AttachDecoratorData1JWS
     */
    header: AttachDecoratorDataJWSHeader;
    /**
     * protected JWS header
     * @type {string}
     * @memberof AttachDecoratorData1JWS
     */
    _protected?: string;
    /**
     * signature
     * @type {string}
     * @memberof AttachDecoratorData1JWS
     */
    signature: string;
}
/**
 *
 * @export
 * @interface AttachDecoratorDataJWS
 */
export interface AttachDecoratorDataJWS {
    /**
     *
     * @type {AttachDecoratorDataJWSHeader}
     * @memberof AttachDecoratorDataJWS
     */
    header?: AttachDecoratorDataJWSHeader;
    /**
     * protected JWS header
     * @type {string}
     * @memberof AttachDecoratorDataJWS
     */
    _protected?: string;
    /**
     * signature
     * @type {string}
     * @memberof AttachDecoratorDataJWS
     */
    signature?: string;
    /**
     * List of signatures
     * @type {Array<AttachDecoratorData1JWS>}
     * @memberof AttachDecoratorDataJWS
     */
    signatures?: Array<AttachDecoratorData1JWS>;
}
/**
 *
 * @export
 * @interface AttachDecoratorDataJWSHeader
 */
export interface AttachDecoratorDataJWSHeader {
    /**
     * Key identifier, in W3C did:key or DID URL format
     * @type {string}
     * @memberof AttachDecoratorDataJWSHeader
     */
    kid: string;
}
/**
 *
 * @export
 * @interface AttachmentDef
 */
export interface AttachmentDef {
    /**
     * Attachment identifier
     * @type {string}
     * @memberof AttachmentDef
     */
    id?: string;
    /**
     * Attachment type
     * @type {string}
     * @memberof AttachmentDef
     */
    type?: AttachmentDef.TypeEnum;
}

/**
 * @export
 * @namespace AttachmentDef
 */
export namespace AttachmentDef {
    /**
     * @export
     * @enum {string}
     */
    export enum TypeEnum {
        CredentialOffer = <any> 'credential-offer',
        PresentProof = <any> 'present-proof'
    }
}
/**
 *
 * @export
 * @interface AttributeMimeTypesResult
 */
export interface AttributeMimeTypesResult {
    /**
     *
     * @type {{ [key: string]: string; }}
     * @memberof AttributeMimeTypesResult
     */
    results?: { [key: string]: string; };
}
/**
 *
 * @export
 * @interface BasicMessageModuleResponse
 */
export interface BasicMessageModuleResponse {
}
/**
 *
 * @export
 * @interface ClaimFormat
 */
export interface ClaimFormat {
    /**
     *
     * @type {any}
     * @memberof ClaimFormat
     */
    jwt?: any;
    /**
     *
     * @type {any}
     * @memberof ClaimFormat
     */
    jwt_vc?: any;
    /**
     *
     * @type {any}
     * @memberof ClaimFormat
     */
    jwt_vp?: any;
    /**
     *
     * @type {any}
     * @memberof ClaimFormat
     */
    ldp?: any;
    /**
     *
     * @type {any}
     * @memberof ClaimFormat
     */
    ldp_vc?: any;
    /**
     *
     * @type {any}
     * @memberof ClaimFormat
     */
    ldp_vp?: any;
}
/**
 *
 * @export
 * @interface ClearPendingRevocationsRequest
 */
export interface ClearPendingRevocationsRequest {
    /**
     * Credential revocation ids by revocation registry id: omit for all, specify null or empty list for all pending per revocation registry
     * @type {{ [key: string]: Array<string>; }}
     * @memberof ClearPendingRevocationsRequest
     */
    purge?: { [key: string]: Array<string>; };
}
/**
 *
 * @export
 * @interface ConnRecord
 */
export interface ConnRecord {
    /**
     * Connection acceptance: manual or auto
     * @type {string}
     * @memberof ConnRecord
     */
    accept?: ConnRecord.AcceptEnum;
    /**
     * Optional alias to apply to connection for later use
     * @type {string}
     * @memberof ConnRecord
     */
    alias?: string;
    /**
     * Connection identifier
     * @type {string}
     * @memberof ConnRecord
     */
    connection_id?: string;
    /**
     * Connection protocol used
     * @type {string}
     * @memberof ConnRecord
     */
    connection_protocol?: ConnRecord.ConnectionProtocolEnum;
    /**
     * Time of record creation
     * @type {string}
     * @memberof ConnRecord
     */
    created_at?: string;
    /**
     * Error message
     * @type {string}
     * @memberof ConnRecord
     */
    error_msg?: string;
    /**
     * Inbound routing connection id to use
     * @type {string}
     * @memberof ConnRecord
     */
    inbound_connection_id?: string;
    /**
     * Public key for connection
     * @type {string}
     * @memberof ConnRecord
     */
    invitation_key?: string;
    /**
     * Invitation mode
     * @type {string}
     * @memberof ConnRecord
     */
    invitation_mode?: ConnRecord.InvitationModeEnum;
    /**
     * ID of out-of-band invitation message
     * @type {string}
     * @memberof ConnRecord
     */
    invitation_msg_id?: string;
    /**
     * Our DID for connection
     * @type {string}
     * @memberof ConnRecord
     */
    my_did?: string;
    /**
     * Connection request identifier
     * @type {string}
     * @memberof ConnRecord
     */
    request_id?: string;
    /**
     * State per RFC 23
     * @type {string}
     * @memberof ConnRecord
     */
    rfc23_state?: string;
    /**
     * Routing state of connection
     * @type {string}
     * @memberof ConnRecord
     */
    routing_state?: ConnRecord.RoutingStateEnum;
    /**
     * Current record state
     * @type {string}
     * @memberof ConnRecord
     */
    state?: string;
    /**
     * Their DID for connection
     * @type {string}
     * @memberof ConnRecord
     */
    their_did?: string;
    /**
     * Their label for connection
     * @type {string}
     * @memberof ConnRecord
     */
    their_label?: string;
    /**
     * Other agent's public DID for connection
     * @type {string}
     * @memberof ConnRecord
     */
    their_public_did?: string;
    /**
     * Their role in the connection protocol
     * @type {string}
     * @memberof ConnRecord
     */
    their_role?: ConnRecord.TheirRoleEnum;
    /**
     * Time of last record update
     * @type {string}
     * @memberof ConnRecord
     */
    updated_at?: string;
}

/**
 * @export
 * @namespace ConnRecord
 */
export namespace ConnRecord {
    /**
     * @export
     * @enum {string}
     */
    export enum AcceptEnum {
        Manual = <any> 'manual',
        Auto = <any> 'auto'
    }
    /**
     * @export
     * @enum {string}
     */
    export enum ConnectionProtocolEnum {
        Connections10 = <any> 'connections/1.0',
        Didexchange10 = <any> 'didexchange/1.0'
    }
    /**
     * @export
     * @enum {string}
     */
    export enum InvitationModeEnum {
        Once = <any> 'once',
        Multi = <any> 'multi',
        Static = <any> 'static'
    }
    /**
     * @export
     * @enum {string}
     */
    export enum RoutingStateEnum {
        None = <any> 'none',
        Request = <any> 'request',
        Active = <any> 'active',
        Error = <any> 'error'
    }
    /**
     * @export
     * @enum {string}
     */
    export enum TheirRoleEnum {
        Invitee = <any> 'invitee',
        Requester = <any> 'requester',
        Inviter = <any> 'inviter',
        Responder = <any> 'responder'
    }
}
/**
 *
 * @export
 * @interface ConnectionInvitation
 */
export interface ConnectionInvitation {
    /**
     * Message identifier
     * @type {string}
     * @memberof ConnectionInvitation
     */
    id?: string;
    /**
     * Message type
     * @type {string}
     * @memberof ConnectionInvitation
     */
    type?: string;
    /**
     * DID for connection invitation
     * @type {string}
     * @memberof ConnectionInvitation
     */
    did?: string;
    /**
     * Optional image URL for connection invitation
     * @type {string}
     * @memberof ConnectionInvitation
     */
    imageUrl?: string;
    /**
     * Optional label for connection invitation
     * @type {string}
     * @memberof ConnectionInvitation
     */
    label?: string;
    /**
     * List of recipient keys
     * @type {Array<string>}
     * @memberof ConnectionInvitation
     */
    recipientKeys?: Array<string>;
    /**
     * List of routing keys
     * @type {Array<string>}
     * @memberof ConnectionInvitation
     */
    routingKeys?: Array<string>;
    /**
     * Service endpoint at which to reach this agent
     * @type {string}
     * @memberof ConnectionInvitation
     */
    serviceEndpoint?: string;
}
/**
 *
 * @export
 * @interface ConnectionList
 */
export interface ConnectionList {
    /**
     * List of connection records
     * @type {Array<ConnRecord>}
     * @memberof ConnectionList
     */
    results?: Array<ConnRecord>;
}
/**
 *
 * @export
 * @interface ConnectionMetadata
 */
export interface ConnectionMetadata {
    /**
     * Dictionary of metadata associated with connection.
     * @type {any}
     * @memberof ConnectionMetadata
     */
    results?: any;
}
/**
 *
 * @export
 * @interface ConnectionMetadataSetRequest
 */
export interface ConnectionMetadataSetRequest {
    /**
     * Dictionary of metadata to set for connection.
     * @type {any}
     * @memberof ConnectionMetadataSetRequest
     */
    metadata: any;
}
/**
 *
 * @export
 * @interface ConnectionModuleResponse
 */
export interface ConnectionModuleResponse {
}
/**
 *
 * @export
 * @interface ConnectionStaticRequest
 */
export interface ConnectionStaticRequest {
    /**
     * Alias to assign to this connection
     * @type {string}
     * @memberof ConnectionStaticRequest
     */
    alias?: string;
    /**
     * Local DID
     * @type {string}
     * @memberof ConnectionStaticRequest
     */
    my_did?: string;
    /**
     * Seed to use for the local DID
     * @type {string}
     * @memberof ConnectionStaticRequest
     */
    my_seed?: string;
    /**
     * Remote DID
     * @type {string}
     * @memberof ConnectionStaticRequest
     */
    their_did?: string;
    /**
     * URL endpoint for other party
     * @type {string}
     * @memberof ConnectionStaticRequest
     */
    their_endpoint?: string;
    /**
     * Other party's label for this connection
     * @type {string}
     * @memberof ConnectionStaticRequest
     */
    their_label?: string;
    /**
     * Seed to use for the remote DID
     * @type {string}
     * @memberof ConnectionStaticRequest
     */
    their_seed?: string;
    /**
     * Remote verification key
     * @type {string}
     * @memberof ConnectionStaticRequest
     */
    their_verkey?: string;
}
/**
 *
 * @export
 * @interface ConnectionStaticResult
 */
export interface ConnectionStaticResult {
    /**
     * Local DID
     * @type {string}
     * @memberof ConnectionStaticResult
     */
    my_did: string;
    /**
     * My URL endpoint
     * @type {string}
     * @memberof ConnectionStaticResult
     */
    my_endpoint: string;
    /**
     * My verification key
     * @type {string}
     * @memberof ConnectionStaticResult
     */
    my_verkey: string;
    /**
     *
     * @type {ConnRecord}
     * @memberof ConnectionStaticResult
     */
    record: ConnRecord;
    /**
     * Remote DID
     * @type {string}
     * @memberof ConnectionStaticResult
     */
    their_did: string;
    /**
     * Remote verification key
     * @type {string}
     * @memberof ConnectionStaticResult
     */
    their_verkey: string;
}
/**
 *
 * @export
 * @interface Constraints
 */
export interface Constraints {
    /**
     *
     * @type {Array<DIFField>}
     * @memberof Constraints
     */
    fields?: Array<DIFField>;
    /**
     *
     * @type {Array<DIFHolder>}
     * @memberof Constraints
     */
    is_holder?: Array<DIFHolder>;
    /**
     * LimitDisclosure
     * @type {string}
     * @memberof Constraints
     */
    limit_disclosure?: string;
    /**
     *
     * @type {string}
     * @memberof Constraints
     */
    status_active?: Constraints.StatusActiveEnum;
    /**
     *
     * @type {string}
     * @memberof Constraints
     */
    status_revoked?: Constraints.StatusRevokedEnum;
    /**
     *
     * @type {string}
     * @memberof Constraints
     */
    status_suspended?: Constraints.StatusSuspendedEnum;
    /**
     * SubjectIsIssuer
     * @type {string}
     * @memberof Constraints
     */
    subject_is_issuer?: Constraints.SubjectIsIssuerEnum;
}

/**
 * @export
 * @namespace Constraints
 */
export namespace Constraints {
    /**
     * @export
     * @enum {string}
     */
    export enum StatusActiveEnum {
        Required = <any> 'required',
        Allowed = <any> 'allowed',
        Disallowed = <any> 'disallowed'
    }
    /**
     * @export
     * @enum {string}
     */
    export enum StatusRevokedEnum {
        Required = <any> 'required',
        Allowed = <any> 'allowed',
        Disallowed = <any> 'disallowed'
    }
    /**
     * @export
     * @enum {string}
     */
    export enum StatusSuspendedEnum {
        Required = <any> 'required',
        Allowed = <any> 'allowed',
        Disallowed = <any> 'disallowed'
    }
    /**
     * @export
     * @enum {string}
     */
    export enum SubjectIsIssuerEnum {
        Required = <any> 'required',
        Preferred = <any> 'preferred'
    }
}
/**
 *
 * @export
 * @interface CreateInvitationRequest
 */
export interface CreateInvitationRequest {
    /**
     * Identifier for active mediation record to be used
     * @type {string}
     * @memberof CreateInvitationRequest
     */
    mediation_id?: string;
    /**
     * Optional metadata to attach to the connection created with the invitation
     * @type {any}
     * @memberof CreateInvitationRequest
     */
    metadata?: any;
    /**
     * Optional label for connection invitation
     * @type {string}
     * @memberof CreateInvitationRequest
     */
    my_label?: string;
    /**
     * List of recipient keys