UNPKG

@affinidi-tdk/credential-issuance-client

Version:

Affinidi TDK typescript client for Affinidi CREDENTIAL ISSUANCE

github.com/affinidi/affinidi-tdk/tree/main

affinidi/affinidi-tdk

134 lines (80 loc) • 6.47 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
# CredentialsApi All URIs are relative to *https://apse1.api.affinidi.io/cis* | Method | HTTP request | Description | | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ----------------------------------------------------- | | [**batchCredential**](CredentialsApi.md#batchCredential) | **POST** /v1/{projectId}/batch_credential | Allows wallets to claim multiple credentials at once. | | [**generateCredentials**](CredentialsApi.md#generateCredentials) | **POST** /v1/{projectId}/credential | | | [**getClaimedCredentials**](CredentialsApi.md#getClaimedCredentials) | **GET** /v1/{projectId}/configurations/{configurationId}/credentials | Get claimed credential in the specified range | | [**getIssuanceIdClaimedCredential**](CredentialsApi.md#getIssuanceIdClaimedCredential) | **GET** /v1/{projectId}/configurations/{configurationId}/issuances/{issuanceId}/credentials | Get claimed VC linked to the issuanceId | <a name="batchCredential"></a> # **batchCredential** > BatchCredentialResponse batchCredential(projectId, BatchCredentialInput) Allows wallets to claim multiple credentials at once. Allows wallets to claim multiple credentials at once. For authentication, it uses a token from the authorization server ### Parameters | Name | Type | Description | Notes | | ------------------------ | ------------------------------------------------------------- | --------------------------------- | ----------------- | | **projectId** | **String** | Affinidi project id | [default to null] | | **BatchCredentialInput** | [**BatchCredentialInput**](../Models/BatchCredentialInput.md) | Request body for batch credential | | ### Return type [**BatchCredentialResponse**](../Models/BatchCredentialResponse.md) ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json <a name="generateCredentials"></a> # **generateCredentials** > CredentialResponse generateCredentials(projectId, CreateCredentialInput) Issue credential for end user upon presentation a valid access token. Since we don&#39;t immediate issue credential It&#39;s expected to return &#x60;transaction_id&#x60; and use this &#x60;transaction_id&#x60; to get the deferred credentials ### Parameters | Name | Type | Description | Notes | | ------------------------- | --------------------------------------------------------------- | --------------------------------- | ----------------- | | **projectId** | **String** | Affinidi project id | [default to null] | | **CreateCredentialInput** | [**CreateCredentialInput**](../Models/CreateCredentialInput.md) | Request body to issue credentials | | ### Return type [**CredentialResponse**](../Models/CredentialResponse.md) ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json <a name="getClaimedCredentials"></a> # **getClaimedCredentials** > ClaimedCredentialListResponse getClaimedCredentials(projectId, configurationId, rangeStartTime, rangeEndTime, exclusiveStartKey, limit) Get claimed credential in the specified range Get claimed credential in the specified range ### Parameters | Name | Type | Description | Notes | | --------------------- | ----------- | -------------------------------------------------------- | ---------------------------- | | **projectId** | **String** | project id | [default to null] | | **configurationId** | **String** | configuration id | [default to null] | | **rangeStartTime** | **String** | | [default to null] | | **rangeEndTime** | **String** | | [optional] [default to null] | | **exclusiveStartKey** | **String** | exclusiveStartKey for retrieving the next batch of data. | [optional] [default to null] | | **limit** | **Integer** | | [optional] [default to 20] | ### Return type [**ClaimedCredentialListResponse**](../Models/ClaimedCredentialListResponse.md) ### Authorization [ProjectTokenAuth](../README.md#ProjectTokenAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json <a name="getIssuanceIdClaimedCredential"></a> # **getIssuanceIdClaimedCredential** > ClaimedCredentialResponse getIssuanceIdClaimedCredential(projectId, configurationId, issuanceId) Get claimed VC linked to the issuanceId Get claimed VC linked to the issuanceId ### Parameters | Name | Type | Description | Notes | | ------------------- | ---------- | ---------------- | ----------------- | | **projectId** | **String** | project id | [default to null] | | **configurationId** | **String** | configuration id | [default to null] | | **issuanceId** | **String** | issuance id | [default to null] | ### Return type [**ClaimedCredentialResponse**](../Models/ClaimedCredentialResponse.md) ### Authorization [ProjectTokenAuth](../README.md#ProjectTokenAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json