Skip to content

Commit bd75e06

Browse files
epouepou
committed
Bump to v0.1.0
1 parent 73e44b0 commit bd75e06

File tree

501 files changed

+18498
-14972
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

501 files changed

+18498
-14972
lines changed

‎.openapi-generator/FILES

+279-258
Large diffs are not rendered by default.

‎.openapi-generator/VERSION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
7.10.0-SNAPSHOT
1+
7.10.0

‎README.md

+146-146
Large diffs are not rendered by default.

‎docs/AppUserTokenObtainPairRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**uuid** | **str** | |
8+
**username** | **str** | |
99
**password** | **str** | |
1010
**device_id** | **str** | | [optional]
1111

‎docs/AuthApi.md

+368
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,368 @@
1+
# mosquito_alert.AuthApi
2+
3+
All URIs are relative to *https://api.mosquitoalert.com/v1*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**change_password**](AuthApi.md#change_password) | **POST** /auth/password/change/ |
8+
[**obtain_token**](AuthApi.md#obtain_token) | **POST** /auth/token/ |
9+
[**refresh_token**](AuthApi.md#refresh_token) | **POST** /auth/token/refresh/ |
10+
[**signup_guest**](AuthApi.md#signup_guest) | **POST** /auth/signup/guest/ |
11+
[**verify_token**](AuthApi.md#verify_token) | **POST** /auth/token/verify/ |
12+
13+
14+
# **change_password**
15+
> change_password(password_change_request)
16+
17+
18+
19+
### Example
20+
21+
* Bearer (JWT) Authentication (jwtAuth):
22+
23+
```python
24+
import mosquito_alert
25+
from mosquito_alert.models.password_change_request import PasswordChangeRequest
26+
from mosquito_alert.rest import ApiException
27+
from pprint import pprint
28+
29+
# Defining the host is optional and defaults to https://api.mosquitoalert.com/v1
30+
# See configuration.py for a list of all supported configuration parameters.
31+
configuration = mosquito_alert.Configuration(
32+
host = "https://api.mosquitoalert.com/v1"
33+
)
34+
35+
# The client must configure the authentication and authorization parameters
36+
# in accordance with the API server security policy.
37+
# Examples for each auth method are provided below, use the example that
38+
# satisfies your auth use case.
39+
40+
# Configure Bearer authorization (JWT): jwtAuth
41+
configuration = mosquito_alert.Configuration(
42+
access_token = os.environ["BEARER_TOKEN"]
43+
)
44+
45+
# Enter a context with an instance of the API client
46+
with mosquito_alert.ApiClient(configuration) as api_client:
47+
# Create an instance of the API class
48+
api_instance = mosquito_alert.AuthApi(api_client)
49+
password_change_request = mosquito_alert.PasswordChangeRequest() # PasswordChangeRequest |
50+
51+
try:
52+
api_instance.change_password(password_change_request)
53+
except Exception as e:
54+
print("Exception when calling AuthApi->change_password: %s\n" % e)
55+
```
56+
57+
58+
59+
### Parameters
60+
61+
62+
Name | Type | Description | Notes
63+
------------- | ------------- | ------------- | -------------
64+
**password_change_request** | [**PasswordChangeRequest**](PasswordChangeRequest.md)| |
65+
66+
### Return type
67+
68+
void (empty response body)
69+
70+
### Authorization
71+
72+
[jwtAuth](../README.md#jwtAuth)
73+
74+
### HTTP request headers
75+
76+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
77+
- **Accept**: application/json
78+
79+
### HTTP response details
80+
81+
| Status code | Description | Response headers |
82+
|-------------|-------------|------------------|
83+
**400** | | - |
84+
**401** | | - |
85+
**403** | | - |
86+
**404** | | - |
87+
**200** | No response body | - |
88+
89+
[[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)
90+
91+
# **obtain_token**
92+
> AppUserTokenObtainPair obtain_token(app_user_token_obtain_pair_request)
93+
94+
95+
96+
Takes a set of user credentials and returns an access and refresh JSON web token pair to prove the authentication of those credentials.
97+
98+
### Example
99+
100+
101+
```python
102+
import mosquito_alert
103+
from mosquito_alert.models.app_user_token_obtain_pair import AppUserTokenObtainPair
104+
from mosquito_alert.models.app_user_token_obtain_pair_request import AppUserTokenObtainPairRequest
105+
from mosquito_alert.rest import ApiException
106+
from pprint import pprint
107+
108+
# Defining the host is optional and defaults to https://api.mosquitoalert.com/v1
109+
# See configuration.py for a list of all supported configuration parameters.
110+
configuration = mosquito_alert.Configuration(
111+
host = "https://api.mosquitoalert.com/v1"
112+
)
113+
114+
115+
# Enter a context with an instance of the API client
116+
with mosquito_alert.ApiClient(configuration) as api_client:
117+
# Create an instance of the API class
118+
api_instance = mosquito_alert.AuthApi(api_client)
119+
app_user_token_obtain_pair_request = mosquito_alert.AppUserTokenObtainPairRequest() # AppUserTokenObtainPairRequest |
120+
121+
try:
122+
api_response = api_instance.obtain_token(app_user_token_obtain_pair_request)
123+
print("The response of AuthApi->obtain_token:\n")
124+
pprint(api_response)
125+
except Exception as e:
126+
print("Exception when calling AuthApi->obtain_token: %s\n" % e)
127+
```
128+
129+
130+
131+
### Parameters
132+
133+
134+
Name | Type | Description | Notes
135+
------------- | ------------- | ------------- | -------------
136+
**app_user_token_obtain_pair_request** | [**AppUserTokenObtainPairRequest**](AppUserTokenObtainPairRequest.md)| |
137+
138+
### Return type
139+
140+
[**AppUserTokenObtainPair**](AppUserTokenObtainPair.md)
141+
142+
### Authorization
143+
144+
No authorization required
145+
146+
### HTTP request headers
147+
148+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
149+
- **Accept**: application/json
150+
151+
### HTTP response details
152+
153+
| Status code | Description | Response headers |
154+
|-------------|-------------|------------------|
155+
**400** | | - |
156+
**404** | | - |
157+
**200** | | - |
158+
**401** | | - |
159+
160+
[[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)
161+
162+
# **refresh_token**
163+
> TokenRefresh refresh_token(token_refresh_request)
164+
165+
166+
167+
Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.
168+
169+
### Example
170+
171+
172+
```python
173+
import mosquito_alert
174+
from mosquito_alert.models.token_refresh import TokenRefresh
175+
from mosquito_alert.models.token_refresh_request import TokenRefreshRequest
176+
from mosquito_alert.rest import ApiException
177+
from pprint import pprint
178+
179+
# Defining the host is optional and defaults to https://api.mosquitoalert.com/v1
180+
# See configuration.py for a list of all supported configuration parameters.
181+
configuration = mosquito_alert.Configuration(
182+
host = "https://api.mosquitoalert.com/v1"
183+
)
184+
185+
186+
# Enter a context with an instance of the API client
187+
with mosquito_alert.ApiClient(configuration) as api_client:
188+
# Create an instance of the API class
189+
api_instance = mosquito_alert.AuthApi(api_client)
190+
token_refresh_request = mosquito_alert.TokenRefreshRequest() # TokenRefreshRequest |
191+
192+
try:
193+
api_response = api_instance.refresh_token(token_refresh_request)
194+
print("The response of AuthApi->refresh_token:\n")
195+
pprint(api_response)
196+
except Exception as e:
197+
print("Exception when calling AuthApi->refresh_token: %s\n" % e)
198+
```
199+
200+
201+
202+
### Parameters
203+
204+
205+
Name | Type | Description | Notes
206+
------------- | ------------- | ------------- | -------------
207+
**token_refresh_request** | [**TokenRefreshRequest**](TokenRefreshRequest.md)| |
208+
209+
### Return type
210+
211+
[**TokenRefresh**](TokenRefresh.md)
212+
213+
### Authorization
214+
215+
No authorization required
216+
217+
### HTTP request headers
218+
219+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
220+
- **Accept**: application/json
221+
222+
### HTTP response details
223+
224+
| Status code | Description | Response headers |
225+
|-------------|-------------|------------------|
226+
**400** | | - |
227+
**404** | | - |
228+
**200** | | - |
229+
**401** | | - |
230+
231+
[[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)
232+
233+
# **signup_guest**
234+
> GuestRegistration signup_guest(guest_registration_request)
235+
236+
237+
238+
### Example
239+
240+
241+
```python
242+
import mosquito_alert
243+
from mosquito_alert.models.guest_registration import GuestRegistration
244+
from mosquito_alert.models.guest_registration_request import GuestRegistrationRequest
245+
from mosquito_alert.rest import ApiException
246+
from pprint import pprint
247+
248+
# Defining the host is optional and defaults to https://api.mosquitoalert.com/v1
249+
# See configuration.py for a list of all supported configuration parameters.
250+
configuration = mosquito_alert.Configuration(
251+
host = "https://api.mosquitoalert.com/v1"
252+
)
253+
254+
255+
# Enter a context with an instance of the API client
256+
with mosquito_alert.ApiClient(configuration) as api_client:
257+
# Create an instance of the API class
258+
api_instance = mosquito_alert.AuthApi(api_client)
259+
guest_registration_request = mosquito_alert.GuestRegistrationRequest() # GuestRegistrationRequest |
260+
261+
try:
262+
api_response = api_instance.signup_guest(guest_registration_request)
263+
print("The response of AuthApi->signup_guest:\n")
264+
pprint(api_response)
265+
except Exception as e:
266+
print("Exception when calling AuthApi->signup_guest: %s\n" % e)
267+
```
268+
269+
270+
271+
### Parameters
272+
273+
274+
Name | Type | Description | Notes
275+
------------- | ------------- | ------------- | -------------
276+
**guest_registration_request** | [**GuestRegistrationRequest**](GuestRegistrationRequest.md)| |
277+
278+
### Return type
279+
280+
[**GuestRegistration**](GuestRegistration.md)
281+
282+
### Authorization
283+
284+
No authorization required
285+
286+
### HTTP request headers
287+
288+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
289+
- **Accept**: application/json
290+
291+
### HTTP response details
292+
293+
| Status code | Description | Response headers |
294+
|-------------|-------------|------------------|
295+
**400** | | - |
296+
**404** | | - |
297+
**201** | | - |
298+
299+
[[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)
300+
301+
# **verify_token**
302+
> verify_token(token_verify_request)
303+
304+
305+
306+
Takes a token and indicates if it is valid. This view provides no information about a token's fitness for a particular use.
307+
308+
### Example
309+
310+
311+
```python
312+
import mosquito_alert
313+
from mosquito_alert.models.token_verify_request import TokenVerifyRequest
314+
from mosquito_alert.rest import ApiException
315+
from pprint import pprint
316+
317+
# Defining the host is optional and defaults to https://api.mosquitoalert.com/v1
318+
# See configuration.py for a list of all supported configuration parameters.
319+
configuration = mosquito_alert.Configuration(
320+
host = "https://api.mosquitoalert.com/v1"
321+
)
322+
323+
324+
# Enter a context with an instance of the API client
325+
with mosquito_alert.ApiClient(configuration) as api_client:
326+
# Create an instance of the API class
327+
api_instance = mosquito_alert.AuthApi(api_client)
328+
token_verify_request = mosquito_alert.TokenVerifyRequest() # TokenVerifyRequest |
329+
330+
try:
331+
api_instance.verify_token(token_verify_request)
332+
except Exception as e:
333+
print("Exception when calling AuthApi->verify_token: %s\n" % e)
334+
```
335+
336+
337+
338+
### Parameters
339+
340+
341+
Name | Type | Description | Notes
342+
------------- | ------------- | ------------- | -------------
343+
**token_verify_request** | [**TokenVerifyRequest**](TokenVerifyRequest.md)| |
344+
345+
### Return type
346+
347+
void (empty response body)
348+
349+
### Authorization
350+
351+
No authorization required
352+
353+
### HTTP request headers
354+
355+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
356+
- **Accept**: application/json
357+
358+
### HTTP response details
359+
360+
| Status code | Description | Response headers |
361+
|-------------|-------------|------------------|
362+
**400** | | - |
363+
**404** | | - |
364+
**200** | No response body | - |
365+
**401** | | - |
366+
367+
[[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)
368+

0 commit comments

Comments
 (0)