/** * This file was auto-generated by Fern from our API Definition. */ import * as core from '../../../../core'; import * as environments from '../../../../environments'; import * as Truvity from '../../../index'; export declare namespace Desk { interface Options { environment?: core.Supplier; /** Specify a custom URL to connect the client to. */ baseUrl?: core.Supplier; apiKey?: core.Supplier; /** Additional headers to include in requests. */ headers?: Record | undefined>; fetcher?: core.FetchFunction; } interface RequestOptions { /** The maximum time to wait for a response in seconds. */ timeoutInSeconds?: number; /** The number of times to retry the request. Defaults to 2. */ maxRetries?: number; /** A hook to abort the request. */ abortSignal?: AbortSignal; /** Additional query string parameters to include in the request. */ queryParams?: Record; /** Additional headers to include in the request. */ headers?: Record | undefined>; } } /** * The API to manage DID Documents and to receive DIDComm messages. */ export declare class Desk { protected readonly _options: Desk.Options; constructor(_options?: Desk.Options); /** * Get the published JSON Schema for a given slug and version. The slug is the unique identifier for the schema, and the version is the specific version of the schema. * * @param {string} tenantId - The ID of the tenant. * @param {string} slug - Slug of a CredentialSchema. * @param {number} version - The version of the resource. * @param {Truvity.PublishedJsonSchemaFetchRequest} request * @param {Desk.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Truvity.BadRequestError} * @throws {@link Truvity.UnauthorizedError} * @throws {@link Truvity.ForbiddenError} * @throws {@link Truvity.NotFoundError} * @throws {@link Truvity.TooManyRequestsError} * @throws {@link Truvity.InternalServerError} * * @example * await client.desk.publishedJsonSchemaFetch("tenant_id", "slug", 1000000) */ publishedJsonSchemaFetch(tenantId: string, slug: string, version: number, request?: Truvity.PublishedJsonSchemaFetchRequest, requestOptions?: Desk.RequestOptions): core.HttpResponsePromise>; private __publishedJsonSchemaFetch; /** * Get the published Meta Schema for a given slug and version. The slug is the unique identifier for the schema. * * @param {string} tenantId - The ID of the tenant. * @param {string} slug - Slug of a CredentialSchema. * @param {number} version - The version of the resource. * @param {Truvity.PublishedMetaSchemaFetchRequest} request * @param {Desk.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Truvity.BadRequestError} * @throws {@link Truvity.UnauthorizedError} * @throws {@link Truvity.ForbiddenError} * @throws {@link Truvity.NotFoundError} * @throws {@link Truvity.TooManyRequestsError} * @throws {@link Truvity.InternalServerError} * * @example * await client.desk.publishedMetaSchemaFetch("tenant_id", "slug", 1000000) */ publishedMetaSchemaFetch(tenantId: string, slug: string, version: number, request?: Truvity.PublishedMetaSchemaFetchRequest, requestOptions?: Desk.RequestOptions): core.HttpResponsePromise; private __publishedMetaSchemaFetch; /** * Get the published VCDM JSON Schema for a given slug and version. The slug is the unique identifier for the schema, and the version is the specific version of the schema. * * @param {string} tenantId - The ID of the tenant. * @param {string} slug - Slug of a CredentialSchema. * @param {number} version - The version of the resource. * @param {Truvity.PublishedVcdmJsonSchemaFetchRequest} request * @param {Desk.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Truvity.BadRequestError} * @throws {@link Truvity.UnauthorizedError} * @throws {@link Truvity.ForbiddenError} * @throws {@link Truvity.NotFoundError} * @throws {@link Truvity.TooManyRequestsError} * @throws {@link Truvity.InternalServerError} * * @example * await client.desk.publishedVcdmJsonSchemaFetch("tenant_id", "slug", 1000000) */ publishedVcdmJsonSchemaFetch(tenantId: string, slug: string, version: number, request?: Truvity.PublishedVcdmJsonSchemaFetchRequest, requestOptions?: Desk.RequestOptions): core.HttpResponsePromise>; private __publishedVcdmJsonSchemaFetch; /** * Get the published JSON-LD Vocab for a given slug and version. The slug is the unique identifier for the schema, and the version is the specific version of the schema. * * @param {string} tenantId - The ID of the tenant. * @param {string} slug - Slug of a CredentialSchema. * @param {number} version - The version of the resource. * @param {Truvity.PublishedJsonLdVocabFetchRequest} request * @param {Desk.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Truvity.BadRequestError} * @throws {@link Truvity.UnauthorizedError} * @throws {@link Truvity.ForbiddenError} * @throws {@link Truvity.NotFoundError} * @throws {@link Truvity.TooManyRequestsError} * @throws {@link Truvity.InternalServerError} * * @example * await client.desk.publishedJsonLdVocabFetch("tenant_id", "slug", 1000000) */ publishedJsonLdVocabFetch(tenantId: string, slug: string, version: number, request?: Truvity.PublishedJsonLdVocabFetchRequest, requestOptions?: Desk.RequestOptions): core.HttpResponsePromise>; private __publishedJsonLdVocabFetch; /** * Get DID-Document for [did:web Method Specification](https://w3c-ccg.github.io/did-method-web/). * * @param {string} tenantId - The ID of the tenant. * @param {Truvity.DidDocumentGetRequest} request * @param {Desk.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Truvity.BadRequestError} * @throws {@link Truvity.TooManyRequestsError} * @throws {@link Truvity.InternalServerError} * * @example * await client.desk.didDocumentGet("tenant_id") */ didDocumentGet(tenantId: string, request?: Truvity.DidDocumentGetRequest, requestOptions?: Desk.RequestOptions): core.HttpResponsePromise; private __didDocumentGet; /** * Receive DIDComm Message. * * @param {string} tenantId - The ID of the tenant. * @param {Truvity.DidCommMessageRecvRequest} request * @param {Desk.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Truvity.BadRequestError} * @throws {@link Truvity.UnsupportedMediaTypeError} * @throws {@link Truvity.InternalServerError} * * @example * await client.desk.didCommMessageRecv("tenant_id", { * body: "string" * }) */ didCommMessageRecv(tenantId: string, request: Truvity.DidCommMessageRecvRequest, requestOptions?: Desk.RequestOptions): core.HttpResponsePromise; private __didCommMessageRecv; protected _getCustomAuthorizationHeaders(): Promise<{ 'X-API-KEY': string | undefined; }>; } //# sourceMappingURL=Client.d.ts.map