@pidginhost/sdk 0.3.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/docs/AuthApi.md CHANGED
@@ -5,9 +5,7 @@ All URIs are relative to *https://www.pidginhost.com*
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**authCliSessionCreate**](#authclisessioncreate) | **POST** /api/auth/cli-session/ | |
8
- |[**authCliSessionCreate2**](#authclisessioncreate2) | **POST** /api/v1/auth/cli-session/ | |
9
8
  |[**authCliSessionRetrieve**](#authclisessionretrieve) | **GET** /api/auth/cli-session/{session_id}/ | |
10
- |[**authCliSessionRetrieve2**](#authclisessionretrieve2) | **GET** /api/v1/auth/cli-session/{session_id}/ | |
11
9
 
12
10
  # **authCliSessionCreate**
13
11
  > CLISessionCreateResponse authCliSessionCreate()
@@ -32,50 +30,6 @@ const { status, data } = await apiInstance.authCliSessionCreate();
32
30
  This endpoint does not have any parameters.
33
31
 
34
32
 
35
- ### Return type
36
-
37
- **CLISessionCreateResponse**
38
-
39
- ### Authorization
40
-
41
- No authorization required
42
-
43
- ### HTTP request headers
44
-
45
- - **Content-Type**: Not defined
46
- - **Accept**: application/json
47
-
48
-
49
- ### HTTP response details
50
- | Status code | Description | Response headers |
51
- |-------------|-------------|------------------|
52
- |**201** | | - |
53
-
54
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
55
-
56
- # **authCliSessionCreate2**
57
- > CLISessionCreateResponse authCliSessionCreate2()
58
-
59
- Create a CLI authentication session for browser-based approval
60
-
61
- ### Example
62
-
63
- ```typescript
64
- import {
65
- AuthApi,
66
- Configuration
67
- } from '@pidginhost/sdk';
68
-
69
- const configuration = new Configuration();
70
- const apiInstance = new AuthApi(configuration);
71
-
72
- const { status, data } = await apiInstance.authCliSessionCreate2();
73
- ```
74
-
75
- ### Parameters
76
- This endpoint does not have any parameters.
77
-
78
-
79
33
  ### Return type
80
34
 
81
35
  **CLISessionCreateResponse**
@@ -148,54 +102,3 @@ No authorization required
148
102
 
149
103
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
150
104
 
151
- # **authCliSessionRetrieve2**
152
- > CLISessionPollResponse authCliSessionRetrieve2()
153
-
154
- Poll a CLI authentication session. Returns token when approved.
155
-
156
- ### Example
157
-
158
- ```typescript
159
- import {
160
- AuthApi,
161
- Configuration
162
- } from '@pidginhost/sdk';
163
-
164
- const configuration = new Configuration();
165
- const apiInstance = new AuthApi(configuration);
166
-
167
- let sessionId: string; // (default to undefined)
168
-
169
- const { status, data } = await apiInstance.authCliSessionRetrieve2(
170
- sessionId
171
- );
172
- ```
173
-
174
- ### Parameters
175
-
176
- |Name | Type | Description | Notes|
177
- |------------- | ------------- | ------------- | -------------|
178
- | **sessionId** | [**string**] | | defaults to undefined|
179
-
180
-
181
- ### Return type
182
-
183
- **CLISessionPollResponse**
184
-
185
- ### Authorization
186
-
187
- No authorization required
188
-
189
- ### HTTP request headers
190
-
191
- - **Content-Type**: Not defined
192
- - **Accept**: application/json
193
-
194
-
195
- ### HTTP response details
196
- | Status code | Description | Response headers |
197
- |-------------|-------------|------------------|
198
- |**200** | | - |
199
-
200
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
201
-