@affinidi/internal-api-clients
Version:
SDK core monorepo for affinity DID solution
297 lines (296 loc) • 12.4 kB
TypeScript
declare const _default: {
readonly components: {
readonly examples: {};
readonly headers: {};
readonly parameters: {};
readonly requestBodies: {};
readonly responses: {};
readonly schemas: {
readonly FreeFormObject: {
readonly properties: {};
readonly type: "object";
readonly additionalProperties: {
readonly additionalProperties: true;
readonly type: "object";
};
};
readonly BuildCredentialOfferOutput: {
readonly properties: {
readonly credentialOffer: {
readonly $ref: "#/components/schemas/FreeFormObject";
};
};
readonly required: readonly ["credentialOffer"];
readonly type: "object";
readonly additionalProperties: false;
};
readonly OfferedCredential: {
readonly properties: {
readonly type: {
readonly type: "string";
};
readonly renderInfo: {
readonly $ref: "#/components/schemas/FreeFormObject";
readonly nullable: true;
};
};
readonly required: readonly ["type"];
readonly type: "object";
readonly additionalProperties: false;
};
readonly BuildCredentialOfferInput: {
readonly properties: {
readonly offeredCredentials: {
readonly items: {
readonly $ref: "#/components/schemas/OfferedCredential";
};
readonly type: "array";
};
readonly callbackUrl: {
readonly type: "string";
readonly nullable: true;
};
readonly audienceDid: {
readonly type: "string";
readonly nullable: true;
};
readonly expiresAt: {
readonly type: "string";
readonly nullable: true;
};
readonly nonce: {
readonly type: "string";
readonly nullable: true;
};
};
readonly required: readonly ["offeredCredentials"];
readonly type: "object";
readonly additionalProperties: false;
};
readonly VerifyCredentialOfferResponseOutput: {
readonly properties: {
readonly jti: {
readonly type: "string";
};
readonly errors: {
readonly items: {
readonly type: "string";
};
readonly type: "array";
};
readonly issuer: {
readonly type: "string";
};
readonly isValid: {
readonly type: "boolean";
};
readonly selectedCredentials: {
readonly items: {
readonly $ref: "#/components/schemas/OfferedCredential";
};
readonly type: "array";
};
};
readonly required: readonly ["jti", "errors", "issuer", "isValid", "selectedCredentials"];
readonly type: "object";
readonly additionalProperties: false;
};
readonly VerifyCredentialOfferResponseInput: {
readonly properties: {
readonly credentialOfferResponseToken: {
readonly type: "string";
};
readonly credentialOfferRequestToken: {
readonly type: "string";
readonly nullable: true;
};
};
readonly required: readonly ["credentialOfferResponseToken"];
readonly type: "object";
readonly additionalProperties: false;
};
readonly UnsignedW3cCredential: {
readonly properties: {
readonly "@context": {
readonly $ref: "#/components/schemas/FreeFormObject";
};
readonly id: {
readonly type: "string";
};
readonly type: {
readonly items: {
readonly type: "string";
};
readonly type: "array";
};
readonly holder: {
readonly $ref: "#/components/schemas/FreeFormObject";
};
readonly credentialSubject: {
readonly $ref: "#/components/schemas/FreeFormObject";
};
readonly issuanceDate: {
readonly type: "string";
};
readonly expirationDate: {
readonly type: "string";
readonly nullable: true;
};
};
readonly required: readonly ["@context", "id", "type", "holder", "credentialSubject", "issuanceDate"];
readonly type: "object";
readonly additionalProperties: false;
};
readonly VCBuildUnsignedOutput: {
readonly properties: {
readonly unsignedVC: {
readonly $ref: "#/components/schemas/UnsignedW3cCredential";
};
readonly unsignedCredential: {
readonly $ref: "#/components/schemas/UnsignedW3cCredential";
};
};
readonly required: readonly ["unsignedVC", "unsignedCredential"];
readonly type: "object";
readonly additionalProperties: false;
};
readonly VCBuildUnsignedInput: {
readonly properties: {
readonly type: {
readonly type: "string";
};
readonly data: {
readonly $ref: "#/components/schemas/FreeFormObject";
};
readonly holderDid: {
readonly type: "string";
readonly pattern: "^did:(elem|jolo):.*$";
};
readonly expiresAt: {
readonly type: "string";
readonly nullable: true;
};
};
readonly required: readonly ["type", "data", "holderDid"];
readonly type: "object";
readonly additionalProperties: false;
};
};
readonly securitySchemes: {};
};
readonly info: {
readonly title: "affinity-issuer";
readonly version: "0.0.99";
readonly description: "Affinity issuer";
readonly license: {
readonly name: "ISC";
};
};
readonly openapi: "3.0.0";
readonly paths: {
readonly "/issuer/build-credential-offer": {
readonly post: {
readonly operationId: "BuildCredentialOffer";
readonly responses: {
readonly "200": {
readonly content: {
readonly "application/json": {
readonly schema: {
readonly $ref: "#/components/schemas/BuildCredentialOfferOutput";
};
};
};
readonly description: "Ok";
};
};
readonly description: "Build credential offer JWT object from input data.";
readonly summary: "Builds credential offer object.";
readonly tags: readonly ["Issuer"];
readonly security: readonly [];
readonly parameters: readonly [];
readonly requestBody: {
readonly content: {
readonly "application/json": {
readonly schema: {
readonly $ref: "#/components/schemas/BuildCredentialOfferInput";
};
};
};
};
};
};
readonly "/issuer/verify-offer-response": {
readonly post: {
readonly operationId: "VerifyCredentialOfferResponse";
readonly responses: {
readonly "200": {
readonly content: {
readonly "application/json": {
readonly schema: {
readonly $ref: "#/components/schemas/VerifyCredentialOfferResponseOutput";
};
};
};
readonly description: "Ok";
};
};
readonly description: "Verifying JWT token (signature and expiration), validate response against request if requestToken was passed.";
readonly summary: "Verifying offer response token.";
readonly tags: readonly ["Issuer"];
readonly security: readonly [];
readonly parameters: readonly [{
readonly in: "header";
readonly name: "Api-Key";
readonly required: true;
readonly schema: {
readonly type: "string";
};
}];
readonly requestBody: {
readonly content: {
readonly "application/json": {
readonly schema: {
readonly $ref: "#/components/schemas/VerifyCredentialOfferResponseInput";
};
};
};
};
};
};
readonly "/vc/build-unsigned": {
readonly post: {
readonly operationId: "BuildUnsigned";
readonly responses: {
readonly "200": {
readonly content: {
readonly "application/json": {
readonly schema: {
readonly $ref: "#/components/schemas/VCBuildUnsignedOutput";
};
};
};
readonly description: "Ok";
};
};
readonly description: "Build unsigned VC from input data.\n`unsignedVC` response is become deprecated and will be removed at the future.\nConsumers should use `unsignedCredential` instead.";
readonly summary: "Builds unsigned VC object.";
readonly tags: readonly ["VC"];
readonly security: readonly [];
readonly parameters: readonly [];
readonly requestBody: {
readonly content: {
readonly "application/json": {
readonly schema: {
readonly $ref: "#/components/schemas/VCBuildUnsignedInput";
};
};
};
};
};
};
};
readonly servers: readonly [{
readonly url: "/api/v1";
}];
};
export default _default;