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

146 lines (83 loc) • 5.01 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
135
136
137
138
139
140
141
142
143
144
145
146
# ConfigurationApi All URIs are relative to *https://apse1.api.affinidi.io/cis* | Method | HTTP request | Description | | ---------------------------------------------------------------------------- | ----------------------------------------------- | ----------- | | [**createIssuanceConfig**](ConfigurationApi.md#createIssuanceConfig) | **POST** /v1/configurations | | | [**deleteIssuanceConfigById**](ConfigurationApi.md#deleteIssuanceConfigById) | **DELETE** /v1/configurations/{configurationId} | | | [**getIssuanceConfigById**](ConfigurationApi.md#getIssuanceConfigById) | **GET** /v1/configurations/{configurationId} | | | [**getIssuanceConfigList**](ConfigurationApi.md#getIssuanceConfigList) | **GET** /v1/configurations | | | [**updateIssuanceConfigById**](ConfigurationApi.md#updateIssuanceConfigById) | **PUT** /v1/configurations/{configurationId} | | <a name="createIssuanceConfig"></a> # **createIssuanceConfig** > IssuanceConfigDto createIssuanceConfig(CreateIssuanceConfigInput) Create issuance configuration, project have only one configuration ### Parameters | Name | Type | Description | Notes | | ----------------------------- | ----------------------------------------------------------------------- | ------------------------------------ | ----- | | **CreateIssuanceConfigInput** | [**CreateIssuanceConfigInput**](../Models/CreateIssuanceConfigInput.md) | Request body of create configuration | | ### Return type [**IssuanceConfigDto**](../Models/IssuanceConfigDto.md) ### Authorization [ProjectTokenAuth](../README.md#ProjectTokenAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json <a name="deleteIssuanceConfigById"></a> # **deleteIssuanceConfigById** > deleteIssuanceConfigById(configurationId) Delete project issuance configuration ### Parameters | Name | Type | Description | Notes | | ------------------- | ---------- | ------------------------------------ | ----------------- | | **configurationId** | **String** | The id of the issuance configuration | [default to null] | ### Return type null (empty response body) ### Authorization [ProjectTokenAuth](../README.md#ProjectTokenAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json <a name="getIssuanceConfigById"></a> # **getIssuanceConfigById** > IssuanceConfigDto getIssuanceConfigById(configurationId) Get issuance configuration by id ### Parameters | Name | Type | Description | Notes | | ------------------- | ---------- | ------------------------------------ | ----------------- | | **configurationId** | **String** | The id of the issuance configuration | [default to null] | ### Return type [**IssuanceConfigDto**](../Models/IssuanceConfigDto.md) ### Authorization [ProjectTokenAuth](../README.md#ProjectTokenAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json <a name="getIssuanceConfigList"></a> # **getIssuanceConfigList** > IssuanceConfigListResponse getIssuanceConfigList() Get issuance configuration for my selected project ### Parameters This endpoint does not need any parameter. ### Return type [**IssuanceConfigListResponse**](../Models/IssuanceConfigListResponse.md) ### Authorization [ProjectTokenAuth](../README.md#ProjectTokenAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json <a name="updateIssuanceConfigById"></a> # **updateIssuanceConfigById** > IssuanceConfigDto updateIssuanceConfigById(configurationId, UpdateIssuanceConfigInput) Update issuance configuration ### Parameters | Name | Type | Description | Notes | | ----------------------------- | ----------------------------------------------------------------------- | ------------------------------------ | ----------------- | | **configurationId** | **String** | The id of the issuance configuration | [default to null] | | **UpdateIssuanceConfigInput** | [**UpdateIssuanceConfigInput**](../Models/UpdateIssuanceConfigInput.md) | Request body of update configuration | | ### Return type [**IssuanceConfigDto**](../Models/IssuanceConfigDto.md) ### Authorization [ProjectTokenAuth](../README.md#ProjectTokenAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json