@affinidi/internal-api-clients

declare const _default: { readonly components: { readonly examples: {}; readonly headers: {}; readonly parameters: {}; readonly requestBodies: {}; readonly responses: {}; readonly schemas: { readonly CreateMessageTemplateInput: { readonly properties: { readonly username: { readonly type: "string"; }; readonly template: { readonly type: "string"; }; readonly subject: { readonly type: "string"; readonly nullable: true; }; readonly htmlTemplate: { readonly type: "string"; readonly nullable: true; }; }; readonly required: readonly ["username", "template"]; readonly type: "object"; readonly additionalProperties: false; }; readonly DeleteMessageTemplateInput: { readonly properties: { readonly username: { readonly type: "string"; }; }; readonly required: readonly ["username"]; readonly type: "object"; readonly additionalProperties: false; }; readonly GetCredentialOfferOutput: { readonly properties: { readonly offerToken: { readonly type: "string"; }; }; readonly required: readonly ["offerToken"]; readonly type: "object"; readonly additionalProperties: false; }; readonly Env: { readonly type: "string"; readonly enum: readonly ["dev", "staging", "prod"]; }; readonly FreeFormObjectResponse: { readonly properties: {}; readonly type: "object"; readonly additionalProperties: {}; }; readonly GetSignedCredentialOutput: { readonly properties: { readonly signedCredentials: { readonly items: { readonly $ref: "#/components/schemas/FreeFormObjectResponse"; }; readonly type: "array"; }; }; readonly required: readonly ["signedCredentials"]; readonly type: "object"; readonly additionalProperties: false; }; readonly TsoaSdkOptions: { readonly properties: { readonly apiKey: { readonly type: "string"; readonly nullable: true; }; readonly accessApiKey: { readonly type: "string"; readonly nullable: true; }; readonly env: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/Env"; }]; readonly nullable: true; }; readonly issuerUrl: { readonly type: "string"; readonly nullable: true; }; }; readonly required: readonly ["accessApiKey"]; readonly type: "object"; readonly additionalProperties: false; }; readonly GetSignedCredentialInput: { readonly properties: { readonly credentialOfferResponseToken: { readonly type: "string"; }; readonly options: { readonly allOf: readonly [{ readonly $ref: "#/components/schemas/TsoaSdkOptions"; }]; readonly nullable: true; }; }; readonly required: readonly ["credentialOfferResponseToken", "options"]; readonly type: "object"; readonly additionalProperties: false; }; readonly KeyOutput: { readonly properties: { readonly encryptedSeed: { readonly type: "string"; }; }; readonly required: readonly ["encryptedSeed"]; readonly type: "object"; readonly additionalProperties: false; }; readonly KeyInput: { readonly properties: { readonly encryptedSeed: { readonly type: "string"; }; }; readonly required: readonly ["encryptedSeed"]; readonly type: "object"; readonly additionalProperties: false; }; readonly ProfileTrueCaller: { readonly properties: { readonly payload: { readonly type: "string"; }; readonly signature: { readonly type: "string"; }; readonly signatureAlgorithm: { readonly type: "string"; }; readonly avatarUrl: { readonly type: "string"; readonly nullable: true; }; readonly city: { readonly type: "string"; readonly nullable: true; }; readonly companyName: { readonly type: "string"; readonly nullable: true; }; readonly countryCode: { readonly type: "string"; readonly nullable: true; }; readonly email: { readonly type: "string"; readonly nullable: true; }; readonly facebookId: { readonly type: "string"; readonly nullable: true; }; readonly firstName: { readonly type: "string"; }; readonly gender: { readonly type: "string"; }; readonly isAmbassador: { readonly type: "boolean"; }; readonly isBusiness: { readonly type: "boolean"; }; readonly isVerified: { readonly type: "boolean"; }; readonly jobTitle: { readonly type: "string"; readonly nullable: true; }; readonly lastName: { readonly type: "string"; }; readonly phoneNumber: { readonly type: "string"; }; readonly requestNonce: { readonly type: "string"; }; readonly street: { readonly type: "string"; readonly nullable: true; }; readonly successful: { readonly type: "boolean"; }; readonly twitterId: { readonly type: "string"; readonly nullable: true; }; readonly url: { readonly type: "string"; readonly nullable: true; }; readonly zipcode: { readonly type: "string"; readonly nullable: true; }; }; readonly required: readonly ["payload", "signature", "signatureAlgorithm"]; readonly type: "object"; readonly additionalProperties: {}; }; readonly TruecallerUserListInput: { readonly properties: { readonly profileTrueCaller: { readonly $ref: "#/components/schemas/ProfileTrueCaller"; }; readonly expiredAt: { readonly type: "string"; }; readonly env: { readonly type: "string"; readonly nullable: true; }; }; readonly required: readonly ["profileTrueCaller"]; readonly type: "object"; readonly additionalProperties: false; }; readonly AdminCreateUserInput: { readonly properties: { readonly profileTrueCaller: { readonly $ref: "#/components/schemas/ProfileTrueCaller"; }; readonly password: { readonly type: "string"; }; readonly username: { readonly type: "string"; }; }; readonly required: readonly ["profileTrueCaller", "password", "username"]; readonly type: "object"; readonly additionalProperties: false; }; readonly AdminConfirmUserInput: { readonly properties: { readonly username: { readonly type: "string"; }; }; readonly required: readonly ["username"]; readonly type: "object"; readonly additionalProperties: false; }; readonly AdminDeleteUnconfirmedUserInput: { readonly properties: { readonly username: { readonly type: "string"; }; }; readonly required: readonly ["username"]; readonly type: "object"; readonly additionalProperties: false; }; readonly AdminGetUserInfoOutput: { readonly properties: { readonly userCreateDate: { readonly type: "string"; }; }; readonly type: "object"; readonly additionalProperties: false; }; }; readonly securitySchemes: { readonly bearerAuth: { readonly type: "http"; readonly scheme: "bearer"; readonly bearerFormat: "JWT"; }; }; }; readonly info: { readonly title: "affinity-wallet-backend"; readonly version: "1.45.2"; readonly description: "Backend for Affinity SaaS Wallet"; readonly license: { readonly name: "ISC"; }; readonly contact: { readonly name: "The Engineering Team"; readonly email: "nucleus.team@affinidi.com"; }; }; readonly openapi: "3.0.0"; readonly paths: { readonly "/message-templates/storeTemplate": { readonly post: { readonly operationId: "StoreTemplate"; readonly responses: { readonly "204": { readonly description: "No content"; }; readonly "400": { readonly description: "Bad Request"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "401": { readonly description: "Unauthorized"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "405": { readonly description: "Method Not Allowed"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; }; readonly description: "Store custom message template for passwordless auth flow."; readonly tags: readonly ["MessageTemplate"]; readonly security: readonly []; readonly parameters: readonly []; readonly requestBody: { readonly required: true; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/CreateMessageTemplateInput"; }; }; }; }; }; }; readonly "/message-templates/deleteTemplate": { readonly delete: { readonly operationId: "DeleteTemplate"; readonly responses: { readonly "204": { readonly description: "No content"; }; readonly "400": { readonly description: "Bad Request"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "401": { readonly description: "Unauthorized"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "405": { readonly description: "Method Not Allowed"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; }; readonly description: "Delete custom message template for passwordless auth flow."; readonly tags: readonly ["MessageTemplate"]; readonly security: readonly []; readonly parameters: readonly []; readonly requestBody: { readonly required: true; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/DeleteMessageTemplateInput"; }; }; }; }; }; }; readonly "/issuer/getCredentialOffer": { readonly get: { readonly operationId: "GetCredentialOffer"; readonly responses: { readonly "200": { readonly description: "Ok"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/GetCredentialOfferOutput"; }; }; }; }; readonly "400": { readonly description: "Bad Request"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "401": { readonly description: "Unauthorized"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "405": { readonly description: "Method Not Allowed"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; }; readonly description: "Initiate request to the issuer for provide a credential offer request token (offerToken)."; readonly tags: readonly ["Issuer"]; readonly security: readonly [{ readonly bearerAuth: readonly []; }]; readonly parameters: readonly [{ readonly in: "header"; readonly name: "Api-Key"; readonly required: true; readonly schema: { readonly type: "string"; }; }, { readonly in: "header"; readonly name: "Authorization"; readonly required: true; readonly schema: { readonly type: "string"; }; }, { readonly in: "query"; readonly name: "env"; readonly required: false; readonly schema: { readonly $ref: "#/components/schemas/Env"; }; }]; }; }; readonly "/issuer/getSignedCredential": { readonly post: { readonly operationId: "GetSignedCredential"; readonly responses: { readonly "200": { readonly description: "Ok"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/GetSignedCredentialOutput"; }; }; }; }; readonly "400": { readonly description: "Bad Request"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "401": { readonly description: "Unauthorized"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "405": { readonly description: "Method Not Allowed"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; }; readonly description: "Route used by SDK for getting users email & phone number signed credentials."; readonly tags: readonly ["Issuer"]; readonly security: readonly [{ readonly bearerAuth: readonly []; }]; readonly parameters: readonly [{ readonly in: "header"; readonly name: "Authorization"; readonly required: true; readonly schema: { readonly type: "string"; }; }]; readonly requestBody: { readonly required: true; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/GetSignedCredentialInput"; }; }; }; }; }; }; readonly "/keys/readMyKey": { readonly get: { readonly operationId: "ReadMyKey"; readonly responses: { readonly "200": { readonly description: "Ok"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/KeyOutput"; }; }; }; }; readonly "400": { readonly description: "Bad Request"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "401": { readonly description: "Unauthorized"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "405": { readonly description: "Method Not Allowed"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; }; readonly description: "Read my encrypted key from a key storage"; readonly tags: readonly ["Key"]; readonly security: readonly [{ readonly bearerAuth: readonly []; }]; readonly parameters: readonly [{ readonly in: "header"; readonly name: "Authorization"; readonly required: true; readonly schema: { readonly type: "string"; }; }, { readonly in: "header"; readonly name: "Api-Key"; readonly required: false; readonly schema: { readonly type: "string"; }; }, { readonly in: "query"; readonly name: "tenantToken"; readonly required: false; readonly schema: { readonly type: "string"; }; }]; }; }; readonly "/keys/storeMyKey": { readonly post: { readonly operationId: "StoreMyKey"; readonly responses: { readonly "200": { readonly description: "Ok"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/KeyOutput"; }; }; }; }; readonly "400": { readonly description: "Bad Request"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "401": { readonly description: "Unauthorized"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "405": { readonly description: "Method Not Allowed"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "409": { readonly description: "Key for this user already exists"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; }; readonly description: "Store my encrypted key on a key storage"; readonly tags: readonly ["Key"]; readonly security: readonly [{ readonly bearerAuth: readonly []; }]; readonly parameters: readonly [{ readonly in: "header"; readonly name: "Authorization"; readonly required: true; readonly schema: { readonly type: "string"; }; }]; readonly requestBody: { readonly required: true; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/KeyInput"; }; }; }; }; }; }; readonly "/truecaller/storeUserInList": { readonly post: { readonly operationId: "StoreInTruecallerUserList"; readonly responses: { readonly "204": { readonly description: "No content"; }; readonly "400": { readonly description: "Bad Request"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; }; readonly description: "Store `Truecaller` user in DDB for further use in Cognito lambdas."; readonly tags: readonly ["StoreTruecallerUserInList"]; readonly security: readonly [{ readonly truecallerAuth: readonly []; }]; readonly parameters: readonly []; readonly requestBody: { readonly required: true; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/TruecallerUserListInput"; }; }; }; }; }; }; readonly "/userManagement/adminCreateConfirmedUser": { readonly post: { readonly operationId: "AdminCreateConfirmedUser"; readonly responses: { readonly "204": { readonly description: "No content"; }; readonly "400": { readonly description: "Bad Request"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "401": { readonly description: "Unauthorized"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "405": { readonly description: "Method Not Allowed"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "409": { readonly description: "User {{username}} already exists."; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "422": { readonly description: "Missing configuration for AWS in environment variables."; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; }; readonly description: "This endpoint should be used to create user confirmed user with a `Truecaller` profile(token)."; readonly tags: readonly ["UserManagement"]; readonly security: readonly [{ readonly truecallerAuth: readonly []; }]; readonly parameters: readonly []; readonly requestBody: { readonly required: true; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/AdminCreateUserInput"; }; }; }; }; }; }; readonly "/userManagement/adminConfirmUser": { readonly post: { readonly operationId: "AdminConfirmUser"; readonly responses: { readonly "204": { readonly description: "No content"; }; readonly "400": { readonly description: "Bad Request"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "401": { readonly description: "Unauthorized"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "404": { readonly description: "User {{username}} not found."; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "405": { readonly description: "Method Not Allowed"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "409": { readonly description: "User {{username}} already confirmed."; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "422": { readonly description: "Missing configuration for AWS in environment variables."; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; }; readonly description: "This endpoint should be used to confirm user creation."; readonly tags: readonly ["UserManagement"]; readonly security: readonly []; readonly parameters: readonly []; readonly requestBody: { readonly required: true; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/AdminConfirmUserInput"; }; }; }; }; }; }; readonly "/userManagement/adminDeleteUnconfirmedUser": { readonly post: { readonly operationId: "AdminDeleteUnconfirmedUser"; readonly responses: { readonly "204": { readonly description: "No content"; }; readonly "400": { readonly description: "Bad Request"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "401": { readonly description: "Unauthorized"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "404": { readonly description: "User {{username}} not found."; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "405": { readonly description: "Method Not Allowed"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "409": { readonly description: "User {{username}} must be UNCONFIRMED (current status is {{userStatus}})."; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "422": { readonly description: "Missing configuration for AWS in environment variables."; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; }; readonly description: "This endpoint should be used to delete unconfirmed user."; readonly tags: readonly ["UserManagement"]; readonly security: readonly []; readonly parameters: readonly []; readonly requestBody: { readonly required: true; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/AdminDeleteUnconfirmedUserInput"; }; }; }; }; }; }; readonly "/userManagement/adminDeleteIncompleteUser": { readonly post: { readonly operationId: "AdminDeleteIncompleteUser"; readonly responses: { readonly "204": { readonly description: "No content"; }; readonly "400": { readonly description: "Bad Request"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "401": { readonly description: "Unauthorized"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "405": { readonly description: "Method Not Allowed"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "422": { readonly description: "Missing configuration for AWS in environment variables."; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; }; readonly description: "This endpoint should be used as a fallback in case user creation hangs,\nand it should delete the user from cognito, to allow retries."; readonly tags: readonly ["UserManagement"]; readonly security: readonly [{ readonly bearerAuth: readonly []; }]; readonly parameters: readonly [{ readonly in: "header"; readonly name: "Authorization"; readonly required: true; readonly schema: { readonly type: "string"; }; }]; }; }; readonly "/userManagement/adminLogOutUser": { readonly post: { readonly operationId: "AdminLogOutUser"; readonly responses: { readonly "204": { readonly description: "No content"; }; readonly "400": { readonly description: "Bad Request"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "401": { readonly description: "Unauthorized"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "405": { readonly description: "Method Not Allowed"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "422": { readonly description: "Missing configuration for AWS in environment variables."; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; }; readonly description: "Signs out a user from all devices.\nIt also invalidates all refresh tokens that Amazon Cognito has issued to a user.\nThe user's current access and ID tokens remain valid until they expire.\nBy default, access and ID tokens expire one hour after they're issued.\nA user can still use a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period of 1 hour."; readonly tags: readonly ["UserManagement"]; readonly security: readonly [{ readonly bearerAuth: readonly []; }]; readonly parameters: readonly [{ readonly in: "header"; readonly name: "Authorization"; readonly required: true; readonly schema: { readonly type: "string"; }; }]; }; }; readonly "/userManagement/adminGetUserInfo": { readonly post: { readonly operationId: "AdminGetUserInfo"; readonly responses: { readonly "200": { readonly description: "Ok"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/AdminGetUserInfoOutput"; }; }; }; }; readonly "400": { readonly description: "Bad Request"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/components/schemas/ErrorObject"; }; }; }; }; readonly "401": { readonly description: "Unauthorized"; readonly content: { readonly "application/json": { readonly schema: { readonly $ref: "#/c