Skip to content

Commit 5f92742

Browse files
skyrpexskyrpex
authored
chore: update cognito and add missing docs (#328)
1 parent 23107e7 commit 5f92742

File tree

11 files changed

+5530
-1125
lines changed

11 files changed

+5530
-1125
lines changed

‎cognito/API.md‎

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
## API Reference
2+
3+
### Table of Contents
4+
5+
- **Classes**
6+
- <a href="#@winglibs/cognito.Cognito">Cognito</a>
7+
- <a href="#@winglibs/cognito.platform.Cognito_tfaws">platform.Cognito_tfaws</a>
8+
- <a href="#@winglibs/cognito.platform.Cognito_sim">platform.Cognito_sim</a>
9+
- **Interfaces**
10+
- <a href="#@winglibs/cognito.ICognito">ICognito</a>
11+
- **Structs**
12+
- <a href="#@winglibs/cognito.CognitoProps">CognitoProps</a>
13+
- **Enums**
14+
- <a href="#@winglibs/cognito.AuthenticationType">AuthenticationType</a>
15+
16+
### Cognito (preflight class) <a class="wing-docs-anchor" id="@winglibs/cognito.Cognito"></a>
17+
18+
*No description*
19+
20+
#### Constructor
21+
22+
```
23+
new(api: Api, props: CognitoProps?): Cognito
24+
```
25+
26+
#### Properties
27+
28+
| **Name** | **Type** | **Description** |
29+
| --- | --- | --- |
30+
| <code>clientId</code> | <code>str</code> | *No description* |
31+
| <code>identityPoolId</code> | <code>str</code> | *No description* |
32+
| <code>userPoolId</code> | <code>str</code> | *No description* |
33+
34+
#### Methods
35+
36+
| **Signature** | **Description** |
37+
| --- | --- |
38+
| <code>inflight adminConfirmUser(email: str): void</code> | *No description* |
39+
| <code>connect(path: str): void</code> | *No description* |
40+
| <code>delete(path: str): void</code> | *No description* |
41+
| <code>get(path: str): void</code> | *No description* |
42+
| <code>inflight getCredentialsForIdentity(token: str, identityId: str): Json</code> | *No description* |
43+
| <code>inflight getId(poolId: str, identityPoolId: str, token: str): str</code> | *No description* |
44+
| <code>head(path: str): void</code> | *No description* |
45+
| <code>inflight initiateAuth(email: str, password: str): str</code> | *No description* |
46+
| <code>options(path: str): void</code> | *No description* |
47+
| <code>patch(path: str): void</code> | *No description* |
48+
| <code>post(path: str): void</code> | *No description* |
49+
| <code>put(path: str): void</code> | *No description* |
50+
| <code>inflight signUp(email: str, password: str): void</code> | *No description* |
51+
52+
### platform.Cognito_tfaws (preflight class) <a class="wing-docs-anchor" id="@winglibs/cognito.platform.Cognito_tfaws"></a>
53+
54+
*No description*
55+
56+
#### Constructor
57+
58+
```
59+
new(api: Api, props: CognitoProps?): Cognito_tfaws
60+
```
61+
62+
#### Properties
63+
64+
| **Name** | **Type** | **Description** |
65+
| --- | --- | --- |
66+
| <code>clientId</code> | <code>str</code> | *No description* |
67+
| <code>identityPoolId</code> | <code>str</code> | *No description* |
68+
| <code>userPoolId</code> | <code>str</code> | *No description* |
69+
70+
#### Methods
71+
72+
| **Signature** | **Description** |
73+
| --- | --- |
74+
| <code>static inflight _adminConfirmUser(poolId: str, email: str): void</code> | *No description* |
75+
| <code>static inflight _getCredentialsForIdentity(poolId: str, token: str, identityPoolId: str): Json</code> | *No description* |
76+
| <code>static inflight _getId(poolId: str, identityPoolId: str, token: str): str</code> | *No description* |
77+
| <code>static inflight _initiateAuth(clientId: str, email: str, password: str): str</code> | *No description* |
78+
| <code>static inflight _signUp(clientId: str, email: str, password: str): void</code> | *No description* |
79+
| <code>inflight adminConfirmUser(email: str): void</code> | *No description* |
80+
| <code>connect(path: str): void</code> | *No description* |
81+
| <code>delete(path: str): void</code> | *No description* |
82+
| <code>get(path: str): void</code> | *No description* |
83+
| <code>inflight getCredentialsForIdentity(token: str, identityId: str): Json</code> | *No description* |
84+
| <code>inflight getId(poolId: str, identityPoolId: str, token: str): str</code> | *No description* |
85+
| <code>head(path: str): void</code> | *No description* |
86+
| <code>inflight initiateAuth(email: str, password: str): str</code> | *No description* |
87+
| <code>options(path: str): void</code> | *No description* |
88+
| <code>patch(path: str): void</code> | *No description* |
89+
| <code>post(path: str): void</code> | *No description* |
90+
| <code>put(path: str): void</code> | *No description* |
91+
| <code>inflight signUp(email: str, password: str): void</code> | *No description* |
92+
93+
### platform.Cognito_sim (preflight class) <a class="wing-docs-anchor" id="@winglibs/cognito.platform.Cognito_sim"></a>
94+
95+
*No description*
96+
97+
#### Constructor
98+
99+
```
100+
new(api: Api, props: CognitoProps?): Cognito_sim
101+
```
102+
103+
#### Properties
104+
105+
*No properties*
106+
107+
#### Methods
108+
109+
| **Signature** | **Description** |
110+
| --- | --- |
111+
| <code>inflight adminConfirmUser(email: str): void</code> | *No description* |
112+
| <code>connect(path: str): void</code> | *No description* |
113+
| <code>delete(path: str): void</code> | *No description* |
114+
| <code>get(path: str): void</code> | *No description* |
115+
| <code>inflight getCredentialsForIdentity(token: str, identityId: str): Json</code> | *No description* |
116+
| <code>inflight getId(poolId: str, identityPoolId: str, token: str): str</code> | *No description* |
117+
| <code>head(path: str): void</code> | *No description* |
118+
| <code>inflight initiateAuth(email: str, password: str): str</code> | *No description* |
119+
| <code>options(path: str): void</code> | *No description* |
120+
| <code>patch(path: str): void</code> | *No description* |
121+
| <code>post(path: str): void</code> | *No description* |
122+
| <code>put(path: str): void</code> | *No description* |
123+
| <code>inflight signUp(email: str, password: str): void</code> | *No description* |
124+
125+
### ICognito (interface) <a class="wing-docs-anchor" id="@winglibs/cognito.ICognito"></a>
126+
127+
*No description*
128+
129+
#### Properties
130+
131+
*No properties*
132+
133+
#### Methods
134+
135+
| **Signature** | **Description** |
136+
| --- | --- |
137+
| <code>inflight adminConfirmUser(email: str): void</code> | *No description* |
138+
| <code>connect(path: str): void</code> | *No description* |
139+
| <code>delete(path: str): void</code> | *No description* |
140+
| <code>get(path: str): void</code> | *No description* |
141+
| <code>inflight getCredentialsForIdentity(token: str, identityId: str): Json</code> | *No description* |
142+
| <code>inflight getId(poolId: str, identityPoolId: str, token: str): str</code> | *No description* |
143+
| <code>head(path: str): void</code> | *No description* |
144+
| <code>inflight initiateAuth(email: str, password: str): str</code> | *No description* |
145+
| <code>options(path: str): void</code> | *No description* |
146+
| <code>patch(path: str): void</code> | *No description* |
147+
| <code>post(path: str): void</code> | *No description* |
148+
| <code>put(path: str): void</code> | *No description* |
149+
| <code>inflight signUp(email: str, password: str): void</code> | *No description* |
150+
151+
### CognitoProps (struct) <a class="wing-docs-anchor" id="@winglibs/cognito.CognitoProps"></a>
152+
153+
*No description*
154+
155+
#### Properties
156+
157+
| **Name** | **Type** | **Description** |
158+
| --- | --- | --- |
159+
| <code>authenticationType</code> | <code>AuthenticationType?</code> | *No description* |
160+
| <code>autoVerifiedAttributes</code> | <code>Array<str>?</code> | *No description* |
161+
| <code>headerKey</code> | <code>str?</code> | *No description* |
162+
| <code>name</code> | <code>str?</code> | *No description* |
163+
| <code>schema</code> | <code>Json?</code> | *No description* |
164+
| <code>usernameAttributes</code> | <code>Array<str>?</code> | *No description* |
165+
166+
### AuthenticationType (enum) <a class="wing-docs-anchor" id="@winglibs/cognito.AuthenticationType"></a>
167+
168+
*No description*
169+
170+
#### Values
171+
172+
| **Name** | **Description** |
173+
| --- | --- |
174+
| <code>AWS_IAM</code> | *No description* |
175+
| <code>COGNITO_USER_POOLS</code> | *No description* |
176+

0 commit comments

Comments
 (0)