@unumid/types

Index

Enumerations

RSAPadding

Interfaces

Type aliases

Variables

Type aliases

ClaimDict

ClaimDict: {}

Interface to encapsulate an arbitrary number (0 to n) of string keys with values of type ClaimValue.

Type declaration

[key: string]: ClaimValue

ClaimList

ClaimList: ClaimValue[]

Type to encapsulate an array of ClaimValues.

ClaimPrimitive

ClaimPrimitive: string | number | boolean | Date | null

Type to encapsulate supported claim primitives.

ClaimValue

ClaimValue: ClaimPrimitive | ClaimList | ClaimDict

Type to encapsulate valid ClaimValue types.

CredentialStatusOptions

CredentialStatusOptions: Static<typeof _CredentialStatusOptions>

Type to encapsulate Credential status value options

DatesToStrings

DatesToStrings<T>: T extends Date ? string : T extends Function ? T : {[ k in keyof T]: DatesToStrings<T[k]> }

Maps Dates to strings, including nested. Effectively equals the type change caused by JSON.parse(JSON.stringify(x))

Type parameters

DidKeyType

DidKeyType: "secp256r1" | "RSA"

Type to encapsulate supported key types in did documents.

HolderStatus

HolderStatus: "active" | "deactivated"

Encapsulates possible Holder statuses

HolderType

HolderType: "web" | "mobile"

Encapsulates Holder types

PushProvider

PushProvider: typeof pushProviders[number]

A type encapsulating all possible push provider values.

VersionedDto

VersionedDto<N, T>: {[ n in N]: {} }

Type to encapsulate generic response from SaaS API endpoints which return resources keyed by version.

Type parameters

N: string
T = any

WithKeyAndValue

WithKeyAndValue<T, K, V>: T & Record<K, V>

Helper which adds a named key with a specific value type to an existing type.

Type parameters

T
K: string
V

WithVersion

WithVersion<T>: WithKeyAndValue<T, "version", string>

Helper type which adds a version string.

Type parameters

Variables

CredentialPb

CredentialPb: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): CredentialPb
- - Defined in protos/credential.ts:554
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns CredentialPb
encode: function
- encode(message: CredentialPb, writer?: Writer): Writer
- - Defined in protos/credential.ts:511
  Parameters
  - message: CredentialPb
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): CredentialPb
- - Defined in protos/credential.ts:605
  Parameters
  - object: any
  Returns CredentialPb
fromPartial: function
- fromPartial(object: { context?: string[]; credentialStatus?: { id?: string | undefined; type?: string | undefined; }; credentialSubject?: string; expirationDate?: Date; id?: string; issuanceDate?: Date; issuer?: string; proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; }; type?: string[] }): CredentialPb
- - Defined in protos/credential.ts:694
  Parameters
  - object: { context?: string[]; credentialStatus?: { id?: string | undefined; type?: string | undefined; }; credentialSubject?: string; expirationDate?: Date; id?: string; issuanceDate?: Date; issuer?: string; proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; }; type?: string[] }
    - Optional context?: string[]
    - Optional credentialStatus?: { id?: string | undefined; type?: string | undefined; }
    - Optional credentialSubject?: string
    - Optional expirationDate?: Date
      
      optional in the ts types
    - Optional id?: string
    - Optional issuanceDate?: Date
    - Optional issuer?: string
    - Optional proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; }
    - Optional type?: string[]
  Returns CredentialPb
toJSON: function
- toJSON(message: CredentialPb): unknown
- - Defined in protos/credential.ts:665
  Parameters
  - message: CredentialPb
  Returns unknown

CredentialRequest

CredentialRequest: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): CredentialRequest
- - Defined in protos/credential.ts:778
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns CredentialRequest
encode: function
- encode(message: CredentialRequest, writer?: Writer): Writer
- - Defined in protos/credential.ts:762
  Parameters
  - message: CredentialRequest
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): CredentialRequest
- - Defined in protos/credential.ts:803
  Parameters
  - object: any
  Returns CredentialRequest
fromPartial: function
- fromPartial(object: { issuers?: string[]; required?: boolean; type?: string }): CredentialRequest
- - Defined in protos/credential.ts:836
  Parameters
  - object: { issuers?: string[]; required?: boolean; type?: string }
    - Optional issuers?: string[]
      
      list of acceptable issuer DIDs that have issued the credential
    - Optional required?: boolean
      
      to denote wether this particular credential is required in response to the PresentationRequest. Defaults behavior resolves this to true.
    - Optional type?: string
      
      the string matching the desire credential type
  Returns CredentialRequest
toJSON: function
- toJSON(message: CredentialRequest): unknown
- - Defined in protos/credential.ts:824
  Parameters
  - message: CredentialRequest
  Returns unknown

CredentialSchemaData

CredentialSchemaData: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): CredentialSchemaData
- - Defined in protos/schema.ts:425
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns CredentialSchemaData
encode: function
- encode(message: CredentialSchemaData, writer?: Writer): Writer
- - Defined in protos/schema.ts:412
  Parameters
  - message: CredentialSchemaData
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): CredentialSchemaData
- - Defined in protos/schema.ts:452
  Parameters
  - object: any
  Returns CredentialSchemaData
fromPartial: function
- fromPartial(object: { credentials?: { type?: string | undefined; attributes?: { key?: string | undefined; label?: string | undefined; comment?: string | undefined; }[] | undefined; }[]; heading?: string }): CredentialSchemaData
- - Defined in protos/schema.ts:481
  Parameters
  - object: { credentials?: { type?: string | undefined; attributes?: { key?: string | undefined; label?: string | undefined; comment?: string | undefined; }[] | undefined; }[]; heading?: string }
    - Optional credentials?: { type?: string | undefined; attributes?: { key?: string | undefined; label?: string | undefined; comment?: string | undefined; }[] | undefined; }[]
    - Optional heading?: string
      
      human readable GroupingHeaders
  Returns CredentialSchemaData
toJSON: function
- toJSON(message: CredentialSchemaData): unknown
- - Defined in protos/schema.ts:468
  Parameters
  - message: CredentialSchemaData
  Returns unknown

CredentialStatus

CredentialStatus: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): CredentialStatus
- - Defined in protos/credential.ts:208
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns CredentialStatus
encode: function
- encode(message: CredentialStatus, writer?: Writer): Writer
- - Defined in protos/credential.ts:195
  Parameters
  - message: CredentialStatus
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): CredentialStatus
- - Defined in protos/credential.ts:229
  Parameters
  - object: any
  Returns CredentialStatus
fromPartial: function
- fromPartial(object: { id?: string; type?: string }): CredentialStatus
- - Defined in protos/credential.ts:251
  Parameters
  - object: { id?: string; type?: string }
    - Optional id?: string
    - Optional type?: string
  Returns CredentialStatus
toJSON: function
- toJSON(message: CredentialStatus): unknown
- - Defined in protos/credential.ts:244
  Parameters
  - message: CredentialStatus
  Returns unknown

CredentialStatusInfoPb

CredentialStatusInfoPb: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): CredentialStatusInfoPb
- - Defined in protos/credential.ts:1827
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns CredentialStatusInfoPb
encode: function
- encode(message: CredentialStatusInfoPb, writer?: Writer): Writer
- - Defined in protos/credential.ts:1799
  Parameters
  - message: CredentialStatusInfoPb
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): CredentialStatusInfoPb
- - Defined in protos/credential.ts:1864
  Parameters
  - object: any
  Returns CredentialStatusInfoPb
fromPartial: function
- fromPartial(object: { createdAt?: Date; credentialId?: string; status?: string; updatedAt?: Date; uuid?: string }): CredentialStatusInfoPb
- - Defined in protos/credential.ts:1907
  Parameters
  - object: { createdAt?: Date; credentialId?: string; status?: string; updatedAt?: Date; uuid?: string }
    - Optional createdAt?: Date
    - Optional credentialId?: string
    - Optional status?: string
      
      note could be an enum but just simplier this way... only valid values are: revoked, valid
    - Optional updatedAt?: Date
    - Optional uuid?: string
  Returns CredentialStatusInfoPb
toJSON: function
- toJSON(message: CredentialStatusInfoPb): unknown
- - Defined in protos/credential.ts:1894
  Parameters
  - message: CredentialStatusInfoPb
  Returns unknown

CredentialsIssuedResponse

CredentialsIssuedResponse: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): CredentialsIssuedResponse
- - Defined in protos/credential.ts:871
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns CredentialsIssuedResponse
encode: function
- encode(message: CredentialsIssuedResponse, writer?: Writer): Writer
- - Defined in protos/credential.ts:861
  Parameters
  - message: CredentialsIssuedResponse
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): CredentialsIssuedResponse
- - Defined in protos/credential.ts:895
  Parameters
  - object: any
  Returns CredentialsIssuedResponse
fromPartial: function
- fromPartial(object: { credentialTypesIssued?: string[] }): CredentialsIssuedResponse
- - Defined in protos/credential.ts:921
  Parameters
  - object: { credentialTypesIssued?: string[] }
    - Optional credentialTypesIssued?: string[]
  Returns CredentialsIssuedResponse
toJSON: function
- toJSON(message: CredentialsIssuedResponse): unknown
- - Defined in protos/credential.ts:911
  Parameters
  - message: CredentialsIssuedResponse
  Returns unknown

DIDPb

DIDPb: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): DIDPb
- - Defined in protos/didDocument.ts:667
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns DIDPb
encode: function
- encode(message: DIDPb, writer?: Writer): Writer
- - Defined in protos/didDocument.ts:657
  Parameters
  - message: DIDPb
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): DIDPb
- - Defined in protos/didDocument.ts:688
  Parameters
  - object: any
  Returns DIDPb
fromPartial: function
- fromPartial(object: { id?: string; proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; } }): DIDPb
- - Defined in protos/didDocument.ts:711
  Parameters
  - object: { id?: string; proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; } }
    - Optional id?: string
    - Optional proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; }
  Returns DIDPb
toJSON: function
- toJSON(message: DIDPb): unknown
- - Defined in protos/didDocument.ts:703
  Parameters
  - message: DIDPb
  Returns unknown

DidDocumentPb

DidDocumentPb: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): DidDocumentPb
- - Defined in protos/didDocument.ts:145
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns DidDocumentPb
encode: function
- encode(message: DidDocumentPb, writer?: Writer): Writer
- - Defined in protos/didDocument.ts:114
  Parameters
  - message: DidDocumentPb
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): DidDocumentPb
- - Defined in protos/didDocument.ts:187
  Parameters
  - object: any
  Returns DidDocumentPb
fromPartial: function
- fromPartial(object: { context?: string[]; created?: Date; id?: string; publicKey?: { id?: string | undefined; publicKey?: string | undefined; encoding?: string | undefined; type?: string | undefined; status?: string | undefined; createdAt?: Date | undefined; updatedAt?: Date | undefined; rsaPadding?: RSAPadding | undefined; }[]; service?: { id?: string | undefined; serviceEndpoint?: string | undefined; type?: string | undefined; }[]; updated?: Date }): DidDocumentPb
- - Defined in protos/didDocument.ts:254
  Parameters
  - object: { context?: string[]; created?: Date; id?: string; publicKey?: { id?: string | undefined; publicKey?: string | undefined; encoding?: string | undefined; type?: string | undefined; status?: string | undefined; createdAt?: Date | undefined; updatedAt?: Date | undefined; rsaPadding?: RSAPadding | undefined; }[]; service?: { id?: string | undefined; serviceEndpoint?: string | undefined; type?: string | undefined; }[]; updated?: Date }
    - Optional context?: string[]
    - Optional created?: Date
    - Optional id?: string
    - Optional publicKey?: { id?: string | undefined; publicKey?: string | undefined; encoding?: string | undefined; type?: string | undefined; status?: string | undefined; createdAt?: Date | undefined; updatedAt?: Date | undefined; rsaPadding?: RSAPadding | undefined; }[]
    - Optional service?: { id?: string | undefined; serviceEndpoint?: string | undefined; type?: string | undefined; }[]
    - Optional updated?: Date
  Returns DidDocumentPb
toJSON: function
- toJSON(message: DidDocumentPb): unknown
- - Defined in protos/didDocument.ts:225
  Parameters
  - message: DidDocumentPb
  Returns unknown

DidDocumentService

DidDocumentService: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): DidDocumentService
- - Defined in protos/didDocument.ts:316
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns DidDocumentService
encode: function
- encode(message: DidDocumentService, writer?: Writer): Writer
- - Defined in protos/didDocument.ts:300
  Parameters
  - message: DidDocumentService
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): DidDocumentService
- - Defined in protos/didDocument.ts:340
  Parameters
  - object: any
  Returns DidDocumentService
fromPartial: function
- fromPartial(object: { id?: string; serviceEndpoint?: string; type?: string }): DidDocumentService
- - Defined in protos/didDocument.ts:372
  Parameters
  - object: { id?: string; serviceEndpoint?: string; type?: string }
    - Optional id?: string
    - Optional serviceEndpoint?: string
    - Optional type?: string
  Returns DidDocumentService
toJSON: function
- toJSON(message: DidDocumentService): unknown
- - Defined in protos/didDocument.ts:363
  Parameters
  - message: DidDocumentService
  Returns unknown

EncryptedCredentialEnrichedPb

EncryptedCredentialEnrichedPb: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): EncryptedCredentialEnrichedPb
- - Defined in protos/credential.ts:2200
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns EncryptedCredentialEnrichedPb
encode: function
- encode(message: EncryptedCredentialEnrichedPb, writer?: Writer): Writer
- - Defined in protos/credential.ts:2181
  Parameters
  - message: EncryptedCredentialEnrichedPb
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): EncryptedCredentialEnrichedPb
- - Defined in protos/credential.ts:2229
  Parameters
  - object: any
  Returns EncryptedCredentialEnrichedPb
fromPartial: function
- fromPartial(object: { didDocument?: { context?: string[] | undefined; id?: string | undefined; created?: Date | undefined; updated?: Date | undefined; publicKey?: { id?: string | undefined; publicKey?: string | undefined; ... 5 more ...; rsaPadding?: RSAPadding | undefined; }[] | undefined; service?: { ...; }[] | undefined; }; encryptedCredential?: { uuid?: string | undefined; credentialId?: string | undefined; subject?: string | undefined; issuer?: string | undefined; type?: string | undefined; data?: { data?: string | undefined; key?: { ...; } | undefined; rsaPadding?: RSAPadding | undefined; } | undefined; version?: string | undefined; createdAt?: Date | un... }): EncryptedCredentialEnrichedPb
- - Defined in protos/credential.ts:2264
  Parameters
  - object: { didDocument?: { context?: string[] | undefined; id?: string | undefined; created?: Date | undefined; updated?: Date | undefined; publicKey?: { id?: string | undefined; publicKey?: string | undefined; ... 5 more ...; rsaPadding?: RSAPadding | undefined; }[] | undefined; service?: { ...; }[] | undefined; }; encryptedCredential?: { uuid?: string | undefined; credentialId?: string | undefined; subject?: string | undefined; issuer?: string | undefined; type?: string | undefined; data?: { data?: string | undefined; key?: { ...; } | undefined; rsaPadding?: RSAPadding | undefined; } | undefined; version?: string | undefined; createdAt?: Date | un... }
    - Optional didDocument?: { context?: string[] | undefined; id?: string | undefined; created?: Date | undefined; updated?: Date | undefined; publicKey?: { id?: string | undefined; publicKey?: string | undefined; ... 5 more ...; rsaPadding?: RSAPadding | undefined; }[] | undefined; service?: { ...; }[] | undefined; }
    - Optional encryptedCredential?: { uuid?: string | undefined; credentialId?: string | undefined; subject?: string | undefined; issuer?: string | undefined; type?: string | undefined; data?: { data?: string | undefined; key?: { ...; } | undefined; rsaPadding?: RSAPadding | undefined; } | undefined; version?: string | undefined; createdAt?: Date | un...
  Returns EncryptedCredentialEnrichedPb
toJSON: function
- toJSON(message: EncryptedCredentialEnrichedPb): unknown
- - Defined in protos/credential.ts:2251
  Parameters
  - message: EncryptedCredentialEnrichedPb
  Returns unknown

EncryptedCredentialOptionsPb

EncryptedCredentialOptionsPb: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): EncryptedCredentialOptionsPb
- - Defined in protos/credential.ts:1415
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns EncryptedCredentialOptionsPb
encode: function
- encode(message: EncryptedCredentialOptionsPb, writer?: Writer): Writer
- - Defined in protos/credential.ts:1387
  Parameters
  - message: EncryptedCredentialOptionsPb
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): EncryptedCredentialOptionsPb
- - Defined in protos/credential.ts:1455
  Parameters
  - object: any
  Returns EncryptedCredentialOptionsPb
fromPartial: function
- fromPartial(object: { credentialId?: string; data?: { data?: string | undefined; key?: { iv?: string | undefined; key?: string | undefined; algorithm?: string | undefined; did?: string | undefined; } | undefined; rsaPadding?: RSAPadding | undefined; }; expirationDate?: Date; issuer?: string; subject?: string; type?: string }): EncryptedCredentialOptionsPb
- - Defined in protos/credential.ts:1508
  Parameters
  - object: { credentialId?: string; data?: { data?: string | undefined; key?: { iv?: string | undefined; key?: string | undefined; algorithm?: string | undefined; did?: string | undefined; } | undefined; rsaPadding?: RSAPadding | undefined; }; expirationDate?: Date; issuer?: string; subject?: string; type?: string }
    - Optional credentialId?: string
    - Optional data?: { data?: string | undefined; key?: { iv?: string | undefined; key?: string | undefined; algorithm?: string | undefined; did?: string | undefined; } | undefined; rsaPadding?: RSAPadding | undefined; }
    - Optional expirationDate?: Date
    - Optional issuer?: string
    - Optional subject?: string
    - Optional type?: string
  Returns EncryptedCredentialOptionsPb
toJSON: function
- toJSON(message: EncryptedCredentialOptionsPb): unknown
- - Defined in protos/credential.ts:1492
  Parameters
  - message: EncryptedCredentialOptionsPb
  Returns unknown

EncryptedCredentialPb

EncryptedCredentialPb: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): EncryptedCredentialPb
- - Defined in protos/credential.ts:1994
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns EncryptedCredentialPb
encode: function
- encode(message: EncryptedCredentialPb, writer?: Writer): Writer
- - Defined in protos/credential.ts:1948
  Parameters
  - message: EncryptedCredentialPb
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): EncryptedCredentialPb
- - Defined in protos/credential.ts:2045
  Parameters
  - object: any
  Returns EncryptedCredentialPb
fromPartial: function
- fromPartial(object: { createdAt?: Date; credentialId?: string; data?: { data?: string | undefined; key?: { iv?: string | undefined; key?: string | undefined; algorithm?: string | undefined; did?: string | undefined; } | undefined; rsaPadding?: RSAPadding | undefined; }; expirationDate?: Date; issuer?: string; subject?: string; type?: string; updatedAt?: Date; uuid?: string; version?: string }): EncryptedCredentialPb
- - Defined in protos/credential.ts:2122
  Parameters
  - object: { createdAt?: Date; credentialId?: string; data?: { data?: string | undefined; key?: { iv?: string | undefined; key?: string | undefined; algorithm?: string | undefined; did?: string | undefined; } | undefined; rsaPadding?: RSAPadding | undefined; }; expirationDate?: Date; issuer?: string; subject?: string; type?: string; updatedAt?: Date; uuid?: string; version?: string }
    - Optional createdAt?: Date
    - Optional credentialId?: string
    - Optional data?: { data?: string | undefined; key?: { iv?: string | undefined; key?: string | undefined; algorithm?: string | undefined; did?: string | undefined; } | undefined; rsaPadding?: RSAPadding | undefined; }
    - Optional expirationDate?: Date
    - Optional issuer?: string
    - Optional subject?: string
    - Optional type?: string
    - Optional updatedAt?: Date
    - Optional uuid?: string
    - Optional version?: string
  Returns EncryptedCredentialPb
toJSON: function
- toJSON(message: EncryptedCredentialPb): unknown
- - Defined in protos/credential.ts:2100
  Parameters
  - message: EncryptedCredentialPb
  Returns unknown

EncryptedKey

EncryptedKey: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): EncryptedKey
- - Defined in protos/crypto.ts:131
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns EncryptedKey
encode: function
- encode(message: EncryptedKey, writer?: Writer): Writer
- - Defined in protos/crypto.ts:112
  Parameters
  - message: EncryptedKey
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): EncryptedKey
- - Defined in protos/crypto.ts:158
  Parameters
  - object: any
  Returns EncryptedKey
fromPartial: function
- fromPartial(object: { algorithm?: string; did?: string; iv?: string; key?: string }): EncryptedKey
- - Defined in protos/crypto.ts:192
  Parameters
  - object: { algorithm?: string; did?: string; iv?: string; key?: string }
    - Optional algorithm?: string
    - Optional did?: string
    - Optional iv?: string
    - Optional key?: string
  Returns EncryptedKey
toJSON: function
- toJSON(message: EncryptedKey): unknown
- - Defined in protos/crypto.ts:183
  Parameters
  - message: EncryptedKey
  Returns unknown

HolderAppInfo

HolderAppInfo: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): HolderAppInfo
- - Defined in protos/holderApp.ts:38
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns HolderAppInfo
encode: function
- encode(message: HolderAppInfo, writer?: Writer): Writer
- - Defined in protos/holderApp.ts:19
  Parameters
  - message: HolderAppInfo
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): HolderAppInfo
- - Defined in protos/holderApp.ts:65
  Parameters
  - object: any
  Returns HolderAppInfo
fromPartial: function
- fromPartial(object: { appStoreUrl?: string; deeplinkButtonImg?: string; name?: string; playStoreUrl?: string }): HolderAppInfo
- - Defined in protos/holderApp.ts:105
  Parameters
  - object: { appStoreUrl?: string; deeplinkButtonImg?: string; name?: string; playStoreUrl?: string }
    - Optional appStoreUrl?: string
    - Optional deeplinkButtonImg?: string
      
      base64 string representation of image
    - Optional name?: string
    - Optional playStoreUrl?: string
  Returns HolderAppInfo
toJSON: function
- toJSON(message: HolderAppInfo): unknown
- - Defined in protos/holderApp.ts:93
  Parameters
  - message: HolderAppInfo
  Returns unknown

IssueCredentialOptions

IssueCredentialOptions: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): IssueCredentialOptions
- - Defined in protos/credential.ts:1578
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns IssueCredentialOptions
encode: function
- encode(message: IssueCredentialOptions, writer?: Writer): Writer
- - Defined in protos/credential.ts:1556
  Parameters
  - message: IssueCredentialOptions
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): IssueCredentialOptions
- - Defined in protos/credential.ts:1614
  Parameters
  - object: any
  Returns IssueCredentialOptions
fromPartial: function
- fromPartial(object: { credentialId?: string; encryptedCredentials?: { credentialId?: string | undefined; subject?: string | undefined; issuer?: string | undefined; type?: string | undefined; data?: { data?: string | undefined; key?: { iv?: string | undefined; key?: string | undefined; algorithm?: string | undefined; did?: string | undefined; } | undefined; rsaPadding?: RSAPadding | ...[]; issuer?: string; subject?: string; type?: string }): IssueCredentialOptions
- - Defined in protos/credential.ts:1667
  Parameters
  - object: { credentialId?: string; encryptedCredentials?: { credentialId?: string | undefined; subject?: string | undefined; issuer?: string | undefined; type?: string | undefined; data?: { data?: string | undefined; key?: { iv?: string | undefined; key?: string | undefined; algorithm?: string | undefined; did?: string | undefined; } | undefined; rsaPadding?: RSAPadding | ...[]; issuer?: string; subject?: string; type?: string }
    - Optional credentialId?: string
    - Optional encryptedCredentials?: { credentialId?: string | undefined; subject?: string | undefined; issuer?: string | undefined; type?: string | undefined; data?: { data?: string | undefined; key?: { iv?: string | undefined; key?: string | undefined; algorithm?: string | undefined; did?: string | undefined; } | undefined; rsaPadding?: RSAPadding | ...[]
    - Optional issuer?: string
    - Optional subject?: string
    - Optional type?: string
  Returns IssueCredentialOptions
toJSON: function
- toJSON(message: IssueCredentialOptions): unknown
- - Defined in protos/credential.ts:1650
  Parameters
  - message: IssueCredentialOptions
  Returns unknown

IssueCredentialsOptions

IssueCredentialsOptions: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): IssueCredentialsOptions
- - Defined in protos/credential.ts:1719
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns IssueCredentialsOptions
encode: function
- encode(message: IssueCredentialsOptions, writer?: Writer): Writer
- - Defined in protos/credential.ts:1709
  Parameters
  - message: IssueCredentialsOptions
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): IssueCredentialsOptions
- - Defined in protos/credential.ts:1745
  Parameters
  - object: any
  Returns IssueCredentialsOptions
fromPartial: function
- fromPartial(object: { credentialRequests?: { credentialId?: string | undefined; subject?: string | undefined; issuer?: string | undefined; type?: string | undefined; encryptedCredentials?: { credentialId?: string | undefined; ... 4 more ...; expirationDate?: Date | undefined; }[] | undefined; }[] }): IssueCredentialsOptions
- - Defined in protos/credential.ts:1773
  Parameters
  - object: { credentialRequests?: { credentialId?: string | undefined; subject?: string | undefined; issuer?: string | undefined; type?: string | undefined; encryptedCredentials?: { credentialId?: string | undefined; ... 4 more ...; expirationDate?: Date | undefined; }[] | undefined; }[] }
    - Optional credentialRequests?: { credentialId?: string | undefined; subject?: string | undefined; issuer?: string | undefined; type?: string | undefined; encryptedCredentials?: { credentialId?: string | undefined; ... 4 more ...; expirationDate?: Date | undefined; }[] | undefined; }[]
  Returns IssueCredentialsOptions
toJSON: function
- toJSON(message: IssueCredentialsOptions): unknown
- - Defined in protos/credential.ts:1761
  Parameters
  - message: IssueCredentialsOptions
  Returns unknown

IssuerInfo

IssuerInfo: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): IssuerInfo
- - Defined in protos/issuer.ts:431
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns IssuerInfo
encode: function
- encode(message: IssuerInfo, writer?: Writer): Writer
- - Defined in protos/issuer.ts:415
  Parameters
  - message: IssuerInfo
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): IssuerInfo
- - Defined in protos/issuer.ts:455
  Parameters
  - object: any
  Returns IssuerInfo
fromPartial: function
- fromPartial(object: { cardImageUrl?: string; did?: string; name?: string }): IssuerInfo
- - Defined in protos/issuer.ts:484
  Parameters
  - object: { cardImageUrl?: string; did?: string; name?: string }
    - Optional cardImageUrl?: string
    - Optional did?: string
    - Optional name?: string
  Returns IssuerInfo
toJSON: function
- toJSON(message: IssuerInfo): unknown
- - Defined in protos/issuer.ts:475
  Parameters
  - message: IssuerInfo
  Returns unknown

KeyPair

KeyPair: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): KeyPair
- - Defined in protos/crypto.ts:533
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns KeyPair
encode: function
- encode(message: KeyPair, writer?: Writer): Writer
- - Defined in protos/crypto.ts:517
  Parameters
  - message: KeyPair
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): KeyPair
- - Defined in protos/crypto.ts:557
  Parameters
  - object: any
  Returns KeyPair
fromPartial: function
- fromPartial(object: { id?: string; privateKey?: string; publicKey?: string }): KeyPair
- - Defined in protos/crypto.ts:585
  Parameters
  - object: { id?: string; privateKey?: string; publicKey?: string }
    - Optional id?: string
    - Optional privateKey?: string
    - Optional publicKey?: string
  Returns KeyPair
toJSON: function
- toJSON(message: KeyPair): unknown
- - Defined in protos/crypto.ts:577
  Parameters
  - message: KeyPair
  Returns unknown

KeyPairSet

KeyPairSet: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): KeyPairSet
- - Defined in protos/crypto.ts:622
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns KeyPairSet
encode: function
- encode(message: KeyPairSet, writer?: Writer): Writer
- - Defined in protos/crypto.ts:609
  Parameters
  - message: KeyPairSet
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): KeyPairSet
- - Defined in protos/crypto.ts:643
  Parameters
  - object: any
  Returns KeyPairSet
fromPartial: function
- fromPartial(object: { encryption?: { privateKey?: string | undefined; publicKey?: string | undefined; id?: string | undefined; }; signing?: { privateKey?: string | undefined; publicKey?: string | undefined; id?: string | undefined; } }): KeyPairSet
- - Defined in protos/crypto.ts:671
  Parameters
  - object: { encryption?: { privateKey?: string | undefined; publicKey?: string | undefined; id?: string | undefined; }; signing?: { privateKey?: string | undefined; publicKey?: string | undefined; id?: string | undefined; } }
    - Optional encryption?: { privateKey?: string | undefined; publicKey?: string | undefined; id?: string | undefined; }
    - Optional signing?: { privateKey?: string | undefined; publicKey?: string | undefined; id?: string | undefined; }
  Returns KeyPairSet
toJSON: function
- toJSON(message: KeyPairSet): unknown
- - Defined in protos/crypto.ts:658
  Parameters
  - message: KeyPairSet
  Returns unknown

PresentationPb

PresentationPb: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Note the proto defined types import with a 'Pb' suffix that also have older, vanilla ts types defined. The "Pb" serves to differentiate until we can ditch the legacy ts defined types.

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): PresentationPb
- - Defined in protos/presentation.ts:263
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns PresentationPb
encode: function
- encode(message: PresentationPb, writer?: Writer): Writer
- - Defined in protos/presentation.ts:235
  Parameters
  - message: PresentationPb
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): PresentationPb
- - Defined in protos/presentation.ts:304
  Parameters
  - object: any
  Returns PresentationPb
fromPartial: function
- fromPartial(object: { context?: string[]; presentationRequestId?: string; proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; }; type?: string[]; uuid?: string; verifiableCredential?: { context?: string[] | undefined; credentialSubject?: string | undefined; credentialStatus?: { id?: string | undefined; type?: string | undefined; } | undefined; issuer?: string | undefined; ... 4 more ...; expirationDate?: Date | undefined; }[]; verifierDid?: string }): PresentationPb
- - Defined in protos/presentation.ts:382
  Parameters
  - object: { context?: string[]; presentationRequestId?: string; proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; }; type?: string[]; uuid?: string; verifiableCredential?: { context?: string[] | undefined; credentialSubject?: string | undefined; credentialStatus?: { id?: string | undefined; type?: string | undefined; } | undefined; issuer?: string | undefined; ... 4 more ...; expirationDate?: Date | undefined; }[]; verifierDid?: string }
    - Optional context?: string[]
    - Optional presentationRequestId?: string
    - Optional proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; }
    - Optional type?: string[]
    - Optional uuid?: string
    - Optional verifiableCredential?: { context?: string[] | undefined; credentialSubject?: string | undefined; credentialStatus?: { id?: string | undefined; type?: string | undefined; } | undefined; issuer?: string | undefined; ... 4 more ...; expirationDate?: Date | undefined; }[]
      
      Optional. If undefined or empty it means the presentation request was declined
    - Optional verifierDid?: string
  Returns PresentationPb
toJSON: function
- toJSON(message: PresentationPb): unknown
- - Defined in protos/presentation.ts:353
  Parameters
  - message: PresentationPb
  Returns unknown

PresentationRequestDisplayMessage

PresentationRequestDisplayMessage: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): PresentationRequestDisplayMessage
- - Defined in protos/presentationRequestEnriched.ts:259
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns PresentationRequestDisplayMessage
encode: function
- encode(message: PresentationRequestDisplayMessage, writer?: Writer): Writer
- - Defined in protos/presentationRequestEnriched.ts:246
  Parameters
  - message: PresentationRequestDisplayMessage
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): PresentationRequestDisplayMessage
- - Defined in protos/presentationRequestEnriched.ts:285
  Parameters
  - object: any
  Returns PresentationRequestDisplayMessage
fromPartial: function
- fromPartial(object: { html?: string; text?: string }): PresentationRequestDisplayMessage
- - Defined in protos/presentationRequestEnriched.ts:309
  Parameters
  - object: { html?: string; text?: string }
    - Optional html?: string
    - Optional text?: string
  Returns PresentationRequestDisplayMessage
toJSON: function
- toJSON(message: PresentationRequestDisplayMessage): unknown
- - Defined in protos/presentationRequestEnriched.ts:302
  Parameters
  - message: PresentationRequestDisplayMessage
  Returns unknown

PresentationRequestPb

PresentationRequestPb: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): PresentationRequestPb
- - Defined in protos/presentationRequest.ts:606
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns PresentationRequestPb
encode: function
- encode(message: PresentationRequestPb, writer?: Writer): Writer
- - Defined in protos/presentationRequest.ts:557
  Parameters
  - message: PresentationRequestPb
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): PresentationRequestPb
- - Defined in protos/presentationRequest.ts:663
  Parameters
  - object: any
  Returns PresentationRequestPb
fromPartial: function
- fromPartial(object: { createdAt?: Date; credentialRequests?: { type?: string | undefined; issuers?: string[] | undefined; required?: boolean | undefined; }[]; expiresAt?: Date; holderAppUuid?: string; id?: string; metadata?: string; proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; }; updatedAt?: Date; uuid?: string; verifier?: string; version?: string }): PresentationRequestPb
- - Defined in protos/presentationRequest.ts:754
  Parameters
  - object: { createdAt?: Date; credentialRequests?: { type?: string | undefined; issuers?: string[] | undefined; required?: boolean | undefined; }[]; expiresAt?: Date; holderAppUuid?: string; id?: string; metadata?: string; proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; }; updatedAt?: Date; uuid?: string; verifier?: string; version?: string }
    - Optional createdAt?: Date
    - Optional credentialRequests?: { type?: string | undefined; issuers?: string[] | undefined; required?: boolean | undefined; }[]
    - Optional expiresAt?: Date
    - Optional holderAppUuid?: string
    - Optional id?: string
      
      An indentifier for related presetnation requests across versions
    - Optional metadata?: string
      
      A string representation of an ambiguous object. Note: the Any type does not work because still needs a scheme (but can be assigned dymanically) & Struct does not work becuase not determinsitcally serialzied across langauges
    - Optional proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; }
    - Optional updatedAt?: Date
    - Optional uuid?: string
    - Optional verifier?: string
    - Optional version?: string
  Returns PresentationRequestPb
toJSON: function
- toJSON(message: PresentationRequestPb): unknown
- - Defined in protos/presentationRequest.ts:727
  Parameters
  - message: PresentationRequestPb
  Returns unknown

PresentationSchema

PresentationSchema: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): PresentationSchema
- - Defined in protos/schema.ts:339
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns PresentationSchema
encode: function
- encode(message: PresentationSchema, writer?: Writer): Writer
- - Defined in protos/schema.ts:323
  Parameters
  - message: PresentationSchema
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): PresentationSchema
- - Defined in protos/schema.ts:363
  Parameters
  - object: any
  Returns PresentationSchema
fromPartial: function
- fromPartial(object: { attributes?: { key?: string | undefined; label?: string | undefined; comment?: string | undefined; }[]; type?: string }): PresentationSchema
- - Defined in protos/schema.ts:392
  Parameters
  - object: { attributes?: { key?: string | undefined; label?: string | undefined; comment?: string | undefined; }[]; type?: string }
    - Optional attributes?: { key?: string | undefined; label?: string | undefined; comment?: string | undefined; }[]
    - Optional type?: string
      
      credentialType
  Returns PresentationSchema
toJSON: function
- toJSON(message: PresentationSchema): unknown
- - Defined in protos/schema.ts:379
  Parameters
  - message: PresentationSchema
  Returns unknown

PresentationSchemaAttributes

PresentationSchemaAttributes: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): PresentationSchemaAttributes
- - Defined in protos/schema.ts:236
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns PresentationSchemaAttributes
encode: function
- encode(message: PresentationSchemaAttributes, writer?: Writer): Writer
- - Defined in protos/schema.ts:220
  Parameters
  - message: PresentationSchemaAttributes
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): PresentationSchemaAttributes
- - Defined in protos/schema.ts:265
  Parameters
  - object: any
  Returns PresentationSchemaAttributes
fromPartial: function
- fromPartial(object: { comment?: string; key?: string; label?: string }): PresentationSchemaAttributes
- - Defined in protos/schema.ts:295
  Parameters
  - object: { comment?: string; key?: string; label?: string }
    - Optional comment?: string
      
      comment for the credential value
    - Optional key?: string
      
      credential value key
    - Optional label?: string
      
      label for the credential value
  Returns PresentationSchemaAttributes
toJSON: function
- toJSON(message: PresentationSchemaAttributes): unknown
- - Defined in protos/schema.ts:287
  Parameters
  - message: PresentationSchemaAttributes
  Returns unknown

ProofPb

ProofPb: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): ProofPb
- - Defined in protos/proof.ts:47
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns ProofPb
encode: function
- encode(message: ProofPb, writer?: Writer): Writer
- - Defined in protos/proof.ts:25
  Parameters
  - message: ProofPb
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): ProofPb
- - Defined in protos/proof.ts:79
  Parameters
  - object: any
  Returns ProofPb
fromPartial: function
- fromPartial(object: { created?: Date; proofPurpose?: string; signatureValue?: string; type?: string; verificationMethod?: string }): ProofPb
- - Defined in protos/proof.ts:126
  Parameters
  - object: { created?: Date; proofPurpose?: string; signatureValue?: string; type?: string; verificationMethod?: string }
    - Optional created?: Date
    - Optional proofPurpose?: string
    - Optional signatureValue?: string
    - Optional type?: string
    - Optional verificationMethod?: string
  Returns ProofPb
toJSON: function
- toJSON(message: ProofPb): unknown
- - Defined in protos/proof.ts:112
  Parameters
  - message: ProofPb
  Returns unknown

PublicKeyInfoUpdateOptions

PublicKeyInfoUpdateOptions: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): PublicKeyInfoUpdateOptions
- - Defined in protos/didDocument.ts:956
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns PublicKeyInfoUpdateOptions
encode: function
- encode(message: PublicKeyInfoUpdateOptions, writer?: Writer): Writer
- - Defined in protos/didDocument.ts:934
  Parameters
  - message: PublicKeyInfoUpdateOptions
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): PublicKeyInfoUpdateOptions
- - Defined in protos/didDocument.ts:991
  Parameters
  - object: any
  Returns PublicKeyInfoUpdateOptions
fromPartial: function
- fromPartial(object: { encoding?: string; id?: string; publicKey?: string; status?: string; type?: string }): PublicKeyInfoUpdateOptions
- - Defined in protos/didDocument.ts:1033
  Parameters
  - object: { encoding?: string; id?: string; publicKey?: string; status?: string; type?: string }
    - Optional encoding?: string
      
      optional, required to add a new key
    - Optional id?: string
    - Optional publicKey?: string
      
      optional, but required to add a new key
    - Optional status?: string
      
      optional required to add a new key or update key status of an existing key. Can invaliate an existing by setting to value 'invalid'
    - Optional type?: string
      
      optional, required to add a new key
  Returns PublicKeyInfoUpdateOptions
toJSON: function
- toJSON(message: PublicKeyInfoUpdateOptions): unknown
- - Defined in protos/didDocument.ts:1023
  Parameters
  - message: PublicKeyInfoUpdateOptions
  Returns unknown

RegisterVerifierOptions

RegisterVerifierOptions: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): RegisterVerifierOptions
- - Defined in protos/verifier.ts:565
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns RegisterVerifierOptions
encode: function
- encode(message: RegisterVerifierOptions, writer?: Writer): Writer
- - Defined in protos/verifier.ts:555
  Parameters
  - message: RegisterVerifierOptions
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): RegisterVerifierOptions
- - Defined in protos/verifier.ts:588
  Parameters
  - object: any
  Returns RegisterVerifierOptions
fromPartial: function
- fromPartial(object: { url?: string }): RegisterVerifierOptions
- - Defined in protos/verifier.ts:606
  Parameters
  - object: { url?: string }
    - Optional url?: string
  Returns RegisterVerifierOptions
toJSON: function
- toJSON(message: RegisterVerifierOptions): unknown
- - Defined in protos/verifier.ts:600
  Parameters
  - message: RegisterVerifierOptions
  Returns unknown

RevokeAllCredentials

RevokeAllCredentials: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): RevokeAllCredentials
- - Defined in protos/credential.ts:2374
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns RevokeAllCredentials
encode: function
- encode(message: RevokeAllCredentials, writer?: Writer): Writer
- - Defined in protos/credential.ts:2361
  Parameters
  - message: RevokeAllCredentials
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): RevokeAllCredentials
- - Defined in protos/credential.ts:2398
  Parameters
  - object: any
  Returns RevokeAllCredentials
fromPartial: function
- fromPartial(object: { did?: string; proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; } }): RevokeAllCredentials
- - Defined in protos/credential.ts:2421
  Parameters
  - object: { did?: string; proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; } }
    - Optional did?: string
      
      for now can only be a subject DID, however concievably could be an other entity DID
    - Optional proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; }
      
      proof signed by the issuer
  Returns RevokeAllCredentials
toJSON: function
- toJSON(message: RevokeAllCredentials): unknown
- - Defined in protos/credential.ts:2413
  Parameters
  - message: RevokeAllCredentials
  Returns unknown

SchemaAttributesDto

SchemaAttributesDto: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): SchemaAttributesDto
- - Defined in protos/schema.ts:672
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns SchemaAttributesDto
encode: function
- encode(message: SchemaAttributesDto, writer?: Writer): Writer
- - Defined in protos/schema.ts:662
  Parameters
  - message: SchemaAttributesDto
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): SchemaAttributesDto
- - Defined in protos/schema.ts:693
  Parameters
  - object: any
  Returns SchemaAttributesDto
fromPartial: function
- fromPartial(object: { credentials?: { type?: string | undefined; attributes?: { key?: string | undefined; label?: string | undefined; comment?: string | undefined; }[] | undefined; }[] }): SchemaAttributesDto
- - Defined in protos/schema.ts:716
  Parameters
  - object: { credentials?: { type?: string | undefined; attributes?: { key?: string | undefined; label?: string | undefined; comment?: string | undefined; }[] | undefined; }[] }
    - Optional credentials?: { type?: string | undefined; attributes?: { key?: string | undefined; label?: string | undefined; comment?: string | undefined; }[] | undefined; }[]
  Returns SchemaAttributesDto
toJSON: function
- toJSON(message: SchemaAttributesDto): unknown
- - Defined in protos/schema.ts:704
  Parameters
  - message: SchemaAttributesDto
  Returns unknown

SchemaAttributesRequestsDto

SchemaAttributesRequestsDto: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): SchemaAttributesRequestsDto
- - Defined in protos/schema.ts:62
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns SchemaAttributesRequestsDto
encode: function
- encode(message: SchemaAttributesRequestsDto, writer?: Writer): Writer
- - Defined in protos/schema.ts:52
  Parameters
  - message: SchemaAttributesRequestsDto
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): SchemaAttributesRequestsDto
- - Defined in protos/schema.ts:86
  Parameters
  - object: any
  Returns SchemaAttributesRequestsDto
fromPartial: function
- fromPartial(object: { credentialTypes?: string[] }): SchemaAttributesRequestsDto
- - Defined in protos/schema.ts:112
  Parameters
  - object: { credentialTypes?: string[] }
    - Optional credentialTypes?: string[]
  Returns SchemaAttributesRequestsDto
toJSON: function
- toJSON(message: SchemaAttributesRequestsDto): unknown
- - Defined in protos/schema.ts:102
  Parameters
  - message: SchemaAttributesRequestsDto
  Returns unknown

SchemaGroupings

SchemaGroupings: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): SchemaGroupings
- - Defined in protos/schema.ts:520
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns SchemaGroupings
encode: function
- encode(message: SchemaGroupings, writer?: Writer): Writer
- - Defined in protos/schema.ts:501
  Parameters
  - message: SchemaGroupings
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): SchemaGroupings
- - Defined in protos/schema.ts:544
  Parameters
  - object: any
  Returns SchemaGroupings
fromPartial: function
- fromPartial(object: { contactInfo?: { heading?: string | undefined; credentials?: { type?: string | undefined; attributes?: { key?: string | undefined; label?: string | undefined; comment?: string | undefined; }[] | undefined; }[] | undefined; }; name?: { heading?: string | undefined; credentials?: { type?: string | undefined; attributes?: { key?: string | undefined; label?: string | undefined; comment?: string | undefined; }[] | undefined; }[] | undefined; } }): SchemaGroupings
- - Defined in protos/schema.ts:572
  Parameters
  - object: { contactInfo?: { heading?: string | undefined; credentials?: { type?: string | undefined; attributes?: { key?: string | undefined; label?: string | undefined; comment?: string | undefined; }[] | undefined; }[] | undefined; }; name?: { heading?: string | undefined; credentials?: { type?: string | undefined; attributes?: { key?: string | undefined; label?: string | undefined; comment?: string | undefined; }[] | undefined; }[] | undefined; } }
    - Optional contactInfo?: { heading?: string | undefined; credentials?: { type?: string | undefined; attributes?: { key?: string | undefined; label?: string | undefined; comment?: string | undefined; }[] | undefined; }[] | undefined; }
    - Optional name?: { heading?: string | undefined; credentials?: { type?: string | undefined; attributes?: { key?: string | undefined; label?: string | undefined; comment?: string | undefined; }[] | undefined; }[] | undefined; }
  Returns SchemaGroupings
toJSON: function
- toJSON(message: SchemaGroupings): unknown
- - Defined in protos/schema.ts:559
  Parameters
  - message: SchemaGroupings
  Returns unknown

SchemaPresentationRequestDto

SchemaPresentationRequestDto: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): SchemaPresentationRequestDto
- - Defined in protos/schema.ts:144
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns SchemaPresentationRequestDto
encode: function
- encode(message: SchemaPresentationRequestDto, writer?: Writer): Writer
- - Defined in protos/schema.ts:134
  Parameters
  - message: SchemaPresentationRequestDto
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): SchemaPresentationRequestDto
- - Defined in protos/schema.ts:168
  Parameters
  - object: any
  Returns SchemaPresentationRequestDto
fromPartial: function
- fromPartial(object: { credentialTypes?: string[] }): SchemaPresentationRequestDto
- - Defined in protos/schema.ts:194
  Parameters
  - object: { credentialTypes?: string[] }
    - Optional credentialTypes?: string[]
  Returns SchemaPresentationRequestDto
toJSON: function
- toJSON(message: SchemaPresentationRequestDto): unknown
- - Defined in protos/schema.ts:184
  Parameters
  - message: SchemaPresentationRequestDto
  Returns unknown

SignedDidDocumentPb

SignedDidDocumentPb: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): SignedDidDocumentPb
- - Defined in protos/didDocument.ts:433
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns SignedDidDocumentPb
encode: function
- encode(message: SignedDidDocumentPb, writer?: Writer): Writer
- - Defined in protos/didDocument.ts:399
  Parameters
  - message: SignedDidDocumentPb
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): SignedDidDocumentPb
- - Defined in protos/didDocument.ts:478
  Parameters
  - object: any
  Returns SignedDidDocumentPb
fromPartial: function
- fromPartial(object: { context?: string[]; created?: Date; id?: string; proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; }; publicKey?: { id?: string | undefined; publicKey?: string | undefined; encoding?: string | undefined; type?: string | undefined; status?: string | undefined; createdAt?: Date | undefined; updatedAt?: Date | undefined; rsaPadding?: RSAPadding | undefined; }[]; service?: { id?: string | undefined; serviceEndpoint?: string | undefined; type?: string | undefined; }[]; updated?: Date }): SignedDidDocumentPb
- - Defined in protos/didDocument.ts:552
  Parameters
  - object: { context?: string[]; created?: Date; id?: string; proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; }; publicKey?: { id?: string | undefined; publicKey?: string | undefined; encoding?: string | undefined; type?: string | undefined; status?: string | undefined; createdAt?: Date | undefined; updatedAt?: Date | undefined; rsaPadding?: RSAPadding | undefined; }[]; service?: { id?: string | undefined; serviceEndpoint?: string | undefined; type?: string | undefined; }[]; updated?: Date }
    - Optional context?: string[]
    - Optional created?: Date
    - Optional id?: string
    - Optional proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; }
    - Optional publicKey?: { id?: string | undefined; publicKey?: string | undefined; encoding?: string | undefined; type?: string | undefined; status?: string | undefined; createdAt?: Date | undefined; updatedAt?: Date | undefined; rsaPadding?: RSAPadding | undefined; }[]
    - Optional service?: { id?: string | undefined; serviceEndpoint?: string | undefined; type?: string | undefined; }[]
    - Optional updated?: Date
  Returns SignedDidDocumentPb
toJSON: function
- toJSON(message: SignedDidDocumentPb): unknown
- - Defined in protos/didDocument.ts:521
  Parameters
  - message: SignedDidDocumentPb
  Returns unknown

SignedString

SignedString: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): SignedString
- - Defined in protos/crypto.ts:761
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns SignedString
encode: function
- encode(message: SignedString, writer?: Writer): Writer
- - Defined in protos/crypto.ts:748
  Parameters
  - message: SignedString
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): SignedString
- - Defined in protos/crypto.ts:782
  Parameters
  - object: any
  Returns SignedString
fromPartial: function
- fromPartial(object: { data?: string; proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; } }): SignedString
- - Defined in protos/crypto.ts:805
  Parameters
  - object: { data?: string; proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; } }
    - Optional data?: string
    - Optional proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; }
  Returns SignedString
toJSON: function
- toJSON(message: SignedString): unknown
- - Defined in protos/crypto.ts:797
  Parameters
  - message: SignedString
  Returns unknown

SubjectAbsentCredentials

SubjectAbsentCredentials: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): SubjectAbsentCredentials
- - Defined in protos/subject.ts:40
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns SubjectAbsentCredentials
encode: function
- encode(message: SubjectAbsentCredentials, writer?: Writer): Writer
- - Defined in protos/subject.ts:27
  Parameters
  - message: SubjectAbsentCredentials
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): SubjectAbsentCredentials
- - Defined in protos/subject.ts:67
  Parameters
  - object: any
  Returns SubjectAbsentCredentials
fromPartial: function
- fromPartial(object: { issuer?: string; types?: string[] }): SubjectAbsentCredentials
- - Defined in protos/subject.ts:96
  Parameters
  - object: { issuer?: string; types?: string[] }
    - Optional issuer?: string
    - Optional types?: string[]
  Returns SubjectAbsentCredentials
toJSON: function
- toJSON(message: SubjectAbsentCredentials): unknown
- - Defined in protos/subject.ts:85
  Parameters
  - message: SubjectAbsentCredentials
  Returns unknown

SubjectCredentialIssuerInfoDto

SubjectCredentialIssuerInfoDto: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): SubjectCredentialIssuerInfoDto
- - Defined in protos/subject.ts:220
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns SubjectCredentialIssuerInfoDto
encode: function
- encode(message: SubjectCredentialIssuerInfoDto, writer?: Writer): Writer
- - Defined in protos/subject.ts:210
  Parameters
  - message: SubjectCredentialIssuerInfoDto
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): SubjectCredentialIssuerInfoDto
- - Defined in protos/subject.ts:244
  Parameters
  - object: any
  Returns SubjectCredentialIssuerInfoDto
fromPartial: function
- fromPartial(object: { issuerInfo?: { did?: string | undefined; name?: string | undefined; cardImageUrl?: string | undefined; }[] }): SubjectCredentialIssuerInfoDto
- - Defined in protos/subject.ts:269
  Parameters
  - object: { issuerInfo?: { did?: string | undefined; name?: string | undefined; cardImageUrl?: string | undefined; }[] }
    - Optional issuerInfo?: { did?: string | undefined; name?: string | undefined; cardImageUrl?: string | undefined; }[]
  Returns SubjectCredentialIssuerInfoDto
toJSON: function
- toJSON(message: SubjectCredentialIssuerInfoDto): unknown
- - Defined in protos/subject.ts:257
  Parameters
  - message: SubjectCredentialIssuerInfoDto
  Returns unknown

SubjectCredentialRequestsEnrichedDtoPb

SubjectCredentialRequestsEnrichedDtoPb: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): SubjectCredentialRequestsEnrichedDtoPb
- - Defined in protos/credential.ts:1277
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns SubjectCredentialRequestsEnrichedDtoPb
encode: function
- encode(message: SubjectCredentialRequestsEnrichedDtoPb, writer?: Writer): Writer
- - Defined in protos/credential.ts:1258
  Parameters
  - message: SubjectCredentialRequestsEnrichedDtoPb
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): SubjectCredentialRequestsEnrichedDtoPb
- - Defined in protos/credential.ts:1309
  Parameters
  - object: any
  Returns SubjectCredentialRequestsEnrichedDtoPb
fromPartial: function
- fromPartial(object: { credentialRequestsInfo?: { subjectCredentialRequests?: { credentialRequests?: { type?: string | undefined; issuers?: string[] | undefined; required?: boolean | undefined; }[] | undefined; proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpos...; userDidAssociation?: { userCode?: string | undefined; did?: { id?: string | undefined; proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; } | undefined; } | undefined; issuerDid?: string | undefined; } }): SubjectCredentialRequestsEnrichedDtoPb
- - Defined in protos/credential.ts:1349
  Parameters
  - object: { credentialRequestsInfo?: { subjectCredentialRequests?: { credentialRequests?: { type?: string | undefined; issuers?: string[] | undefined; required?: boolean | undefined; }[] | undefined; proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpos...; userDidAssociation?: { userCode?: string | undefined; did?: { id?: string | undefined; proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; } | undefined; } | undefined; issuerDid?: string | undefined; } }
    - Optional credentialRequestsInfo?: { subjectCredentialRequests?: { credentialRequests?: { type?: string | undefined; issuers?: string[] | undefined; required?: boolean | undefined; }[] | undefined; proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpos...
    - Optional userDidAssociation?: { userCode?: string | undefined; did?: { id?: string | undefined; proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; } | undefined; } | undefined; issuerDid?: string | undefined; }
  Returns SubjectCredentialRequestsEnrichedDtoPb
toJSON: function
- toJSON(message: SubjectCredentialRequestsEnrichedDtoPb): unknown
- - Defined in protos/credential.ts:1336
  Parameters
  - message: SubjectCredentialRequestsEnrichedDtoPb
  Returns unknown

SubjectCredentialsAbsentDto

SubjectCredentialsAbsentDto: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): SubjectCredentialsAbsentDto
- - Defined in protos/subject.ts:130
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns SubjectCredentialsAbsentDto
encode: function
- encode(message: SubjectCredentialsAbsentDto, writer?: Writer): Writer
- - Defined in protos/subject.ts:120
  Parameters
  - message: SubjectCredentialsAbsentDto
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): SubjectCredentialsAbsentDto
- - Defined in protos/subject.ts:156
  Parameters
  - object: any
  Returns SubjectCredentialsAbsentDto
fromPartial: function
- fromPartial(object: { subjectCredentialsAbsent?: { types?: string[] | undefined; issuer?: string | undefined; }[] }): SubjectCredentialsAbsentDto
- - Defined in protos/subject.ts:186
  Parameters
  - object: { subjectCredentialsAbsent?: { types?: string[] | undefined; issuer?: string | undefined; }[] }
    - Optional subjectCredentialsAbsent?: { types?: string[] | undefined; issuer?: string | undefined; }[]
  Returns SubjectCredentialsAbsentDto
toJSON: function
- toJSON(message: SubjectCredentialsAbsentDto): unknown
- - Defined in protos/subject.ts:174
  Parameters
  - message: SubjectCredentialsAbsentDto
  Returns unknown

UnsignedCredentialPb

UnsignedCredentialPb: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): UnsignedCredentialPb
- - Defined in protos/credential.ts:316
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns UnsignedCredentialPb
encode: function
- encode(message: UnsignedCredentialPb, writer?: Writer): Writer
- - Defined in protos/credential.ts:276
  Parameters
  - message: UnsignedCredentialPb
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): UnsignedCredentialPb
- - Defined in protos/credential.ts:364
  Parameters
  - object: any
  Returns UnsignedCredentialPb
fromPartial: function
- fromPartial(object: { context?: string[]; credentialStatus?: { id?: string | undefined; type?: string | undefined; }; credentialSubject?: string; expirationDate?: Date; id?: string; issuanceDate?: Date; issuer?: string; type?: string[] }): UnsignedCredentialPb
- - Defined in protos/credential.ts:446
  Parameters
  - object: { context?: string[]; credentialStatus?: { id?: string | undefined; type?: string | undefined; }; credentialSubject?: string; expirationDate?: Date; id?: string; issuanceDate?: Date; issuer?: string; type?: string[] }
    - Optional context?: string[]
    - Optional credentialStatus?: { id?: string | undefined; type?: string | undefined; }
    - Optional credentialSubject?: string
    - Optional expirationDate?: Date
      
      optional in the ts types
    - Optional id?: string
    - Optional issuanceDate?: Date
    - Optional issuer?: string
    - Optional type?: string[]
  Returns UnsignedCredentialPb
toJSON: function
- toJSON(message: UnsignedCredentialPb): unknown
- - Defined in protos/credential.ts:419
  Parameters
  - message: UnsignedCredentialPb
  Returns unknown

UnsignedDID

UnsignedDID: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): UnsignedDID
- - Defined in protos/didDocument.ts:609
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns UnsignedDID
encode: function
- encode(message: UnsignedDID, writer?: Writer): Writer
- - Defined in protos/didDocument.ts:599
  Parameters
  - message: UnsignedDID
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): UnsignedDID
- - Defined in protos/didDocument.ts:627
  Parameters
  - object: any
  Returns UnsignedDID
fromPartial: function
- fromPartial(object: { id?: string }): UnsignedDID
- - Defined in protos/didDocument.ts:643
  Parameters
  - object: { id?: string }
    - Optional id?: string
  Returns UnsignedDID
toJSON: function
- toJSON(message: UnsignedDID): unknown
- - Defined in protos/didDocument.ts:637
  Parameters
  - message: UnsignedDID
  Returns unknown

UnsignedPresentation

UnsignedPresentation: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Note the proto defined types import with a 'Pb' suffix that also have older, vanilla ts types defined. The "Pb" serves to differentiate until we can ditch the legacy ts defined types.

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): UnsignedPresentation
- - Defined in protos/presentation.ts:69
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns UnsignedPresentation
encode: function
- encode(message: UnsignedPresentation, writer?: Writer): Writer
- - Defined in protos/presentation.ts:44
  Parameters
  - message: UnsignedPresentation
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): UnsignedPresentation
- - Defined in protos/presentation.ts:110
  Parameters
  - object: any
  Returns UnsignedPresentation
fromPartial: function
- fromPartial(object: { context?: string[]; presentationRequestId?: string; type?: string[]; uuid?: string; verifiableCredential?: { context?: string[] | undefined; credentialSubject?: string | undefined; credentialStatus?: { id?: string | undefined; type?: string | undefined; } | undefined; issuer?: string | undefined; ... 4 more ...; expirationDate?: Date | undefined; }[]; verifierDid?: string }): UnsignedPresentation
- - Defined in protos/presentation.ts:181
  Parameters
  - object: { context?: string[]; presentationRequestId?: string; type?: string[]; uuid?: string; verifiableCredential?: { context?: string[] | undefined; credentialSubject?: string | undefined; credentialStatus?: { id?: string | undefined; type?: string | undefined; } | undefined; issuer?: string | undefined; ... 4 more ...; expirationDate?: Date | undefined; }[]; verifierDid?: string }
    - Optional context?: string[]
    - Optional presentationRequestId?: string
    - Optional type?: string[]
    - Optional uuid?: string
    - Optional verifiableCredential?: { context?: string[] | undefined; credentialSubject?: string | undefined; credentialStatus?: { id?: string | undefined; type?: string | undefined; } | undefined; issuer?: string | undefined; ... 4 more ...; expirationDate?: Date | undefined; }[]
      
      Optional. If undefined or empty it means the presentation request was declined
    - Optional verifierDid?: string
  Returns UnsignedPresentation
toJSON: function
- toJSON(message: UnsignedPresentation): unknown
- - Defined in protos/presentation.ts:154
  Parameters
  - message: UnsignedPresentation
  Returns unknown

UnsignedPresentationRequestPb

UnsignedPresentationRequestPb: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): UnsignedPresentationRequestPb
- - Defined in protos/presentationRequest.ts:339
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns UnsignedPresentationRequestPb
encode: function
- encode(message: UnsignedPresentationRequestPb, writer?: Writer): Writer
- - Defined in protos/presentationRequest.ts:293
  Parameters
  - message: UnsignedPresentationRequestPb
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): UnsignedPresentationRequestPb
- - Defined in protos/presentationRequest.ts:398
  Parameters
  - object: any
  Returns UnsignedPresentationRequestPb
fromPartial: function
- fromPartial(object: { createdAt?: Date; credentialRequests?: { type?: string | undefined; issuers?: string[] | undefined; required?: boolean | undefined; }[]; expiresAt?: Date; holderAppUuid?: string; id?: string; metadata?: string; updatedAt?: Date; uuid?: string; verifier?: string; version?: string }): UnsignedPresentationRequestPb
- - Defined in protos/presentationRequest.ts:484
  Parameters
  - object: { createdAt?: Date; credentialRequests?: { type?: string | undefined; issuers?: string[] | undefined; required?: boolean | undefined; }[]; expiresAt?: Date; holderAppUuid?: string; id?: string; metadata?: string; updatedAt?: Date; uuid?: string; verifier?: string; version?: string }
    - Optional createdAt?: Date
    - Optional credentialRequests?: { type?: string | undefined; issuers?: string[] | undefined; required?: boolean | undefined; }[]
    - Optional expiresAt?: Date
    - Optional holderAppUuid?: string
    - Optional id?: string
      
      An indentifier for related presetnation requests across versions
    - Optional metadata?: string
      
      A string representation of an ambiguous object. Note: the Any type does not work because still needs a scheme (but can be assigned dymanically) & Struct does not work becuase not determinsitcally serialzied across langauges
    - Optional updatedAt?: Date
    - Optional uuid?: string
    - Optional verifier?: string
    - Optional version?: string
  Returns UnsignedPresentationRequestPb
toJSON: function
- toJSON(message: UnsignedPresentationRequestPb): unknown
- - Defined in protos/presentationRequest.ts:459
  Parameters
  - message: UnsignedPresentationRequestPb
  Returns unknown

UnsignedRevokeAllCredentials

UnsignedRevokeAllCredentials: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): UnsignedRevokeAllCredentials
- - Defined in protos/credential.ts:2302
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns UnsignedRevokeAllCredentials
encode: function
- encode(message: UnsignedRevokeAllCredentials, writer?: Writer): Writer
- - Defined in protos/credential.ts:2292
  Parameters
  - message: UnsignedRevokeAllCredentials
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): UnsignedRevokeAllCredentials
- - Defined in protos/credential.ts:2325
  Parameters
  - object: any
  Returns UnsignedRevokeAllCredentials
fromPartial: function
- fromPartial(object: { did?: string }): UnsignedRevokeAllCredentials
- - Defined in protos/credential.ts:2343
  Parameters
  - object: { did?: string }
    - Optional did?: string
      
      for now can only be a subject DID, however concievably could be an other entity DID
  Returns UnsignedRevokeAllCredentials
toJSON: function
- toJSON(message: UnsignedRevokeAllCredentials): unknown
- - Defined in protos/credential.ts:2337
  Parameters
  - message: UnsignedRevokeAllCredentials
  Returns unknown

UnsignedString

UnsignedString: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): UnsignedString
- - Defined in protos/crypto.ts:700
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns UnsignedString
encode: function
- encode(message: UnsignedString, writer?: Writer): Writer
- - Defined in protos/crypto.ts:690
  Parameters
  - message: UnsignedString
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): UnsignedString
- - Defined in protos/crypto.ts:718
  Parameters
  - object: any
  Returns UnsignedString
fromPartial: function
- fromPartial(object: { data?: string }): UnsignedString
- - Defined in protos/crypto.ts:734
  Parameters
  - object: { data?: string }
    - Optional data?: string
  Returns UnsignedString
toJSON: function
- toJSON(message: UnsignedString): unknown
- - Defined in protos/crypto.ts:728
  Parameters
  - message: UnsignedString
  Returns unknown

UnsignedSubjectCredentialRequests

UnsignedSubjectCredentialRequests: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): UnsignedSubjectCredentialRequests
- - Defined in protos/credential.ts:953
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns UnsignedSubjectCredentialRequests
encode: function
- encode(message: UnsignedSubjectCredentialRequests, writer?: Writer): Writer
- - Defined in protos/credential.ts:943
  Parameters
  - message: UnsignedSubjectCredentialRequests
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): UnsignedSubjectCredentialRequests
- - Defined in protos/credential.ts:979
  Parameters
  - object: any
  Returns UnsignedSubjectCredentialRequests
fromPartial: function
- fromPartial(object: { credentialRequests?: { type?: string | undefined; issuers?: string[] | undefined; required?: boolean | undefined; }[] }): UnsignedSubjectCredentialRequests
- - Defined in protos/credential.ts:1007
  Parameters
  - object: { credentialRequests?: { type?: string | undefined; issuers?: string[] | undefined; required?: boolean | undefined; }[] }
    - Optional credentialRequests?: { type?: string | undefined; issuers?: string[] | undefined; required?: boolean | undefined; }[]
  Returns UnsignedSubjectCredentialRequests
toJSON: function
- toJSON(message: UnsignedSubjectCredentialRequests): unknown
- - Defined in protos/credential.ts:995
  Parameters
  - message: UnsignedSubjectCredentialRequests
  Returns unknown

UserDidAssociationPb

UserDidAssociationPb: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): UserDidAssociationPb
- - Defined in protos/didDocument.ts:746
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns UserDidAssociationPb
encode: function
- encode(message: UserDidAssociationPb, writer?: Writer): Writer
- - Defined in protos/didDocument.ts:730
  Parameters
  - message: UserDidAssociationPb
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): UserDidAssociationPb
- - Defined in protos/didDocument.ts:770
  Parameters
  - object: any
  Returns UserDidAssociationPb
fromPartial: function
- fromPartial(object: { did?: { id?: string | undefined; proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; } | undefined; }; issuerDid?: string; userCode?: string }): UserDidAssociationPb
- - Defined in protos/didDocument.ts:799
  Parameters
  - object: { did?: { id?: string | undefined; proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; } | undefined; }; issuerDid?: string; userCode?: string }
    - Optional did?: { id?: string | undefined; proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; } | undefined; }
      
      the subject did to be associated to the user.
    - Optional issuerDid?: string
    - Optional userCode?: string
      
      the userCode should be a short lived, one time use user alias.
  Returns UserDidAssociationPb
toJSON: function
- toJSON(message: UserDidAssociationPb): unknown
- - Defined in protos/didDocument.ts:790
  Parameters
  - message: UserDidAssociationPb
  Returns unknown

VerifierDto

VerifierDto: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): VerifierDto
- - Defined in protos/verifier.ts:640
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns VerifierDto
encode: function
- encode(message: VerifierDto, writer?: Writer): Writer
- - Defined in protos/verifier.ts:624
  Parameters
  - message: VerifierDto
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): VerifierDto
- - Defined in protos/verifier.ts:664
  Parameters
  - object: any
  Returns VerifierDto
fromPartial: function
- fromPartial(object: { apiKey?: string; did?: string; name?: string }): VerifierDto
- - Defined in protos/verifier.ts:692
  Parameters
  - object: { apiKey?: string; did?: string; name?: string }
    - Optional apiKey?: string
    - Optional did?: string
    - Optional name?: string
  Returns VerifierDto
toJSON: function
- toJSON(message: VerifierDto): unknown
- - Defined in protos/verifier.ts:684
  Parameters
  - message: VerifierDto
  Returns unknown

VerifierInfoPb

VerifierInfoPb: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

decode: function
- decode(input: Uint8Array | Reader, length?: number): VerifierInfoPb
- - Defined in protos/verifier.ts:433
  Parameters
  - input: Uint8Array | Reader
  - Optional length: number
  Returns VerifierInfoPb
encode: function
- encode(message: VerifierInfoPb, writer?: Writer): Writer
- - Defined in protos/verifier.ts:408
  Parameters
  - message: VerifierInfoPb
  - writer: Writer = ...
  Returns Writer
fromJSON: function
- fromJSON(object: any): VerifierInfoPb
- - Defined in protos/verifier.ts:466
  Parameters
  - object: any
  Returns VerifierInfoPb
fromPartial: function
- fromPartial(object: { did?: string; encryptionPublicKey?: { id?: string | undefined; publicKey?: string | undefined; encoding?: string | undefined; type?: string | undefined; status?: string | undefined; createdAt?: Date | undefined; updatedAt?: Date | undefined; rsaPadding?: RSAPadding | undefined; }; name?: string; signingPublicKey?: { id?: string | undefined; publicKey?: string | undefined; encoding?: string | undefined; type?: string | undefined; status?: string | undefined; createdAt?: Date | undefined; updatedAt?: Date | undefined; rsaPadding?: RSAPadding | undefined; } }): VerifierInfoPb
- - Defined in protos/verifier.ts:516
  Parameters
  - object: { did?: string; encryptionPublicKey?: { id?: string | undefined; publicKey?: string | undefined; encoding?: string | undefined; type?: string | undefined; status?: string | undefined; createdAt?: Date | undefined; updatedAt?: Date | undefined; rsaPadding?: RSAPadding | undefined; }; name?: string; signingPublicKey?: { id?: string | undefined; publicKey?: string | undefined; encoding?: string | undefined; type?: string | undefined; status?: string | undefined; createdAt?: Date | undefined; updatedAt?: Date | undefined; rsaPadding?: RSAPadding | undefined; } }
    - Optional did?: string
    - Optional encryptionPublicKey?: { id?: string | undefined; publicKey?: string | undefined; encoding?: string | undefined; type?: string | undefined; status?: string | undefined; createdAt?: Date | undefined; updatedAt?: Date | undefined; rsaPadding?: RSAPadding | undefined; }
    - Optional name?: string
    - Optional signingPublicKey?: { id?: string | undefined; publicKey?: string | undefined; encoding?: string | undefined; type?: string | undefined; status?: string | undefined; createdAt?: Date | undefined; updatedAt?: Date | undefined; rsaPadding?: RSAPadding | undefined; }
  Returns VerifierInfoPb
toJSON: function
- toJSON(message: VerifierInfoPb): unknown
- - Defined in protos/verifier.ts:501
  Parameters
  - message: VerifierInfoPb
  Returns unknown

Const _CredentialStatusOptions

_CredentialStatusOptions: Union<[Literal<"valid">, Literal<"revoked">]> = ...

Credential status value options Runtype, which has the benefit of runtime type checking and guards with literals. More info here: https://github.com/pelotom/runtypes

Const pushProviders

pushProviders: readonly ["FCM", "APNS"] = ...

A readonly list of push notification providers.

Const receiptGroupTypes

receiptGroupTypes: string[] = ...

Saas supported receipt group types

Const receiptTypes

receiptTypes: string[] = ...

Saas supported receipt types

Index

Enumerations

Interfaces

Type aliases

Variables

Type aliases

ClaimDict

Type declaration

[key: string]: ClaimValue

ClaimList

ClaimPrimitive

ClaimValue

CredentialStatusOptions

DatesToStrings

Type parameters

T

DidKeyType

HolderStatus

HolderType

PushProvider

VersionedDto

Type parameters

N: string

T = any

WithKeyAndValue

Type parameters

T

K: string

V

WithVersion

Type parameters

T

Variables

CredentialPb

Type declaration

decode: function

Parameters

input: Uint8Array | Reader

Optional length: number

Returns CredentialPb

encode: function

Parameters

message: CredentialPb

writer: Writer = ...

Returns Writer

fromJSON: function

Parameters

object: any

Returns CredentialPb

fromPartial: function

Parameters

Optional context?: string[]

Optional credentialStatus?: { id?: string | undefined; type?: string | undefined; }

Optional credentialSubject?: string

Optional expirationDate?: Date

Optional id?: string

Optional issuanceDate?: Date

Optional issuer?: string

Optional proof?: { signatureValue?: string | undefined; type?: string | undefined; verificationMethod?: string | undefined; created?: Date | undefined; proofPurpose?: string | undefined; }

Optional type?: string[]

Returns CredentialPb

toJSON: function

Parameters

message: CredentialPb

Returns unknown

CredentialRequest

Type declaration

decode: function

Parameters

input: Uint8Array | Reader

Optional length: number

Returns CredentialRequest

encode: function

Parameters

message: CredentialRequest

writer: Writer = ...

Returns Writer

fromJSON: function

Parameters

object: any