Skip to content

Commit d2eac92

Browse files
epouepou
committed
Improve namings
1 parent 79f235c commit d2eac92

Some content is hidden

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

48 files changed

+2086
-238
lines changed

‎.openapi-generator/FILES

+30-85
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
README.md
66
docs/AppUserTokenObtainPair.md
77
docs/AppUserTokenObtainPairRequest.md
8-
docs/BaseNotificationCreate.md
98
docs/Bite.md
109
docs/BiteRequest.md
1110
docs/BitesApi.md
@@ -18,18 +17,22 @@ docs/Campaign.md
1817
docs/CampaignsApi.md
1918
docs/CountriesApi.md
2019
docs/Country.md
20+
docs/CreateNotification.md
2121
docs/CreateUser.md
2222
docs/CreateUserRequest.md
23-
docs/DetailNotification.md
24-
docs/DetailNotificationRequest.md
2523
docs/Device.md
2624
docs/DeviceRequest.md
2725
docs/Fix.md
2826
docs/FixLocation.md
2927
docs/FixLocationRequest.md
3028
docs/FixRequest.md
3129
docs/FixesApi.md
30+
docs/Location.md
31+
docs/LocationPoint.md
32+
docs/LocationRequest.md
3233
docs/MetaNotificationRequest.md
34+
docs/Notification.md
35+
docs/NotificationRequest.md
3336
docs/NotificationsApi.md
3437
docs/Observation.md
3538
docs/ObservationPrediction.md
@@ -41,25 +44,22 @@ docs/PackageRequest.md
4144
docs/PaginatedBiteList.md
4245
docs/PaginatedBreedingSiteList.md
4346
docs/PaginatedCampaignList.md
44-
docs/PaginatedDetailNotificationList.md
47+
docs/PaginatedNotificationList.md
4548
docs/PaginatedObservationList.md
4649
docs/PaginatedPartnerList.md
4750
docs/Partner.md
4851
docs/PartnerPoint.md
4952
docs/PartnersApi.md
50-
docs/PatchedDetailNotificationRequest.md
53+
docs/PatchedNotificationRequest.md
5154
docs/PatchedUserRequest.md
5255
docs/Photo.md
5356
docs/PhotoPrediction.md
5457
docs/PhotoPredictionRequest.md
5558
docs/PhotosApi.md
5659
docs/PredictionScore.md
5760
docs/PredictionScoreRequest.md
58-
docs/ReportLocation.md
59-
docs/ReportLocationPoint.md
60-
docs/ReportLocationRequest.md
61-
docs/ReportPhoto.md
62-
docs/ReportPhotoRequest.md
61+
docs/SimplePhoto.md
62+
docs/SimplePhotoRequest.md
6363
docs/TokenApi.md
6464
docs/TokenRefresh.md
6565
docs/TokenRefreshRequest.md
@@ -89,7 +89,6 @@ mosquito_alert/exceptions.py
8989
mosquito_alert/models/__init__.py
9090
mosquito_alert/models/app_user_token_obtain_pair.py
9191
mosquito_alert/models/app_user_token_obtain_pair_request.py
92-
mosquito_alert/models/base_notification_create.py
9392
mosquito_alert/models/bite.py
9493
mosquito_alert/models/bite_request.py
9594
mosquito_alert/models/bounding_box.py
@@ -98,17 +97,21 @@ mosquito_alert/models/breeding_site.py
9897
mosquito_alert/models/breeding_site_request.py
9998
mosquito_alert/models/campaign.py
10099
mosquito_alert/models/country.py
100+
mosquito_alert/models/create_notification.py
101101
mosquito_alert/models/create_user.py
102102
mosquito_alert/models/create_user_request.py
103-
mosquito_alert/models/detail_notification.py
104-
mosquito_alert/models/detail_notification_request.py
105103
mosquito_alert/models/device.py
106104
mosquito_alert/models/device_request.py
107105
mosquito_alert/models/fix.py
108106
mosquito_alert/models/fix_location.py
109107
mosquito_alert/models/fix_location_request.py
110108
mosquito_alert/models/fix_request.py
109+
mosquito_alert/models/location.py
110+
mosquito_alert/models/location_point.py
111+
mosquito_alert/models/location_request.py
111112
mosquito_alert/models/meta_notification_request.py
113+
mosquito_alert/models/notification.py
114+
mosquito_alert/models/notification_request.py
112115
mosquito_alert/models/observation.py
113116
mosquito_alert/models/observation_prediction.py
114117
mosquito_alert/models/observation_prediction_request.py
@@ -118,23 +121,20 @@ mosquito_alert/models/package_request.py
118121
mosquito_alert/models/paginated_bite_list.py
119122
mosquito_alert/models/paginated_breeding_site_list.py
120123
mosquito_alert/models/paginated_campaign_list.py
121-
mosquito_alert/models/paginated_detail_notification_list.py
124+
mosquito_alert/models/paginated_notification_list.py
122125
mosquito_alert/models/paginated_observation_list.py
123126
mosquito_alert/models/paginated_partner_list.py
124127
mosquito_alert/models/partner.py
125128
mosquito_alert/models/partner_point.py
126-
mosquito_alert/models/patched_detail_notification_request.py
129+
mosquito_alert/models/patched_notification_request.py
127130
mosquito_alert/models/patched_user_request.py
128131
mosquito_alert/models/photo.py
129132
mosquito_alert/models/photo_prediction.py
130133
mosquito_alert/models/photo_prediction_request.py
131134
mosquito_alert/models/prediction_score.py
132135
mosquito_alert/models/prediction_score_request.py
133-
mosquito_alert/models/report_location.py
134-
mosquito_alert/models/report_location_point.py
135-
mosquito_alert/models/report_location_request.py
136-
mosquito_alert/models/report_photo.py
137-
mosquito_alert/models/report_photo_request.py
136+
mosquito_alert/models/simple_photo.py
137+
mosquito_alert/models/simple_photo_request.py
138138
mosquito_alert/models/token_refresh.py
139139
mosquito_alert/models/token_refresh_request.py
140140
mosquito_alert/models/topic_notification_create_request.py
@@ -149,69 +149,14 @@ setup.cfg
149149
setup.py
150150
test-requirements.txt
151151
test/__init__.py
152-
test/test_app_user_token_obtain_pair.py
153-
test/test_app_user_token_obtain_pair_request.py
154-
test/test_base_notification_create.py
155-
test/test_bite.py
156-
test/test_bite_request.py
157-
test/test_bites_api.py
158-
test/test_bounding_box.py
159-
test/test_bounding_box_request.py
160-
test/test_breeding_site.py
161-
test/test_breeding_site_request.py
162-
test/test_breeding_sites_api.py
163-
test/test_campaign.py
164-
test/test_campaigns_api.py
165-
test/test_countries_api.py
166-
test/test_country.py
167-
test/test_create_user.py
168-
test/test_create_user_request.py
169-
test/test_detail_notification.py
170-
test/test_detail_notification_request.py
171-
test/test_device.py
172-
test/test_device_request.py
173-
test/test_fix.py
174-
test/test_fix_location.py
175-
test/test_fix_location_request.py
176-
test/test_fix_request.py
177-
test/test_fixes_api.py
178-
test/test_meta_notification_request.py
179-
test/test_notifications_api.py
180-
test/test_observation.py
181-
test/test_observation_prediction.py
182-
test/test_observation_prediction_request.py
183-
test/test_observation_request.py
184-
test/test_observations_api.py
185-
test/test_package.py
186-
test/test_package_request.py
187-
test/test_paginated_bite_list.py
188-
test/test_paginated_breeding_site_list.py
189-
test/test_paginated_campaign_list.py
190-
test/test_paginated_detail_notification_list.py
191-
test/test_paginated_observation_list.py
192-
test/test_paginated_partner_list.py
193-
test/test_partner.py
194-
test/test_partner_point.py
195-
test/test_partners_api.py
196-
test/test_patched_detail_notification_request.py
197-
test/test_patched_user_request.py
198-
test/test_photo.py
199-
test/test_photo_prediction.py
200-
test/test_photo_prediction_request.py
201-
test/test_photos_api.py
202-
test/test_prediction_score.py
203-
test/test_prediction_score_request.py
204-
test/test_report_location.py
205-
test/test_report_location_point.py
206-
test/test_report_location_request.py
207-
test/test_report_photo.py
208-
test/test_report_photo_request.py
209-
test/test_token_api.py
210-
test/test_token_refresh.py
211-
test/test_token_refresh_request.py
212-
test/test_topic_notification_create_request.py
213-
test/test_user.py
214-
test/test_user_notification_create_request.py
215-
test/test_user_request.py
216-
test/test_users_api.py
152+
test/test_create_notification.py
153+
test/test_location.py
154+
test/test_location_point.py
155+
test/test_location_request.py
156+
test/test_notification.py
157+
test/test_notification_request.py
158+
test/test_paginated_notification_list.py
159+
test/test_patched_notification_request.py
160+
test/test_simple_photo.py
161+
test/test_simple_photo_request.py
217162
tox.ini

‎README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,6 @@ Class | Method | HTTP request | Description
147147

148148
- [AppUserTokenObtainPair](docs/AppUserTokenObtainPair.md)
149149
- [AppUserTokenObtainPairRequest](docs/AppUserTokenObtainPairRequest.md)
150-
- [BaseNotificationCreate](docs/BaseNotificationCreate.md)
151150
- [Bite](docs/Bite.md)
152151
- [BiteRequest](docs/BiteRequest.md)
153152
- [BoundingBox](docs/BoundingBox.md)
@@ -156,17 +155,21 @@ Class | Method | HTTP request | Description
156155
- [BreedingSiteRequest](docs/BreedingSiteRequest.md)
157156
- [Campaign](docs/Campaign.md)
158157
- [Country](docs/Country.md)
158+
- [CreateNotification](docs/CreateNotification.md)
159159
- [CreateUser](docs/CreateUser.md)
160160
- [CreateUserRequest](docs/CreateUserRequest.md)
161-
- [DetailNotification](docs/DetailNotification.md)
162-
- [DetailNotificationRequest](docs/DetailNotificationRequest.md)
163161
- [Device](docs/Device.md)
164162
- [DeviceRequest](docs/DeviceRequest.md)
165163
- [Fix](docs/Fix.md)
166164
- [FixLocation](docs/FixLocation.md)
167165
- [FixLocationRequest](docs/FixLocationRequest.md)
168166
- [FixRequest](docs/FixRequest.md)
167+
- [Location](docs/Location.md)
168+
- [LocationPoint](docs/LocationPoint.md)
169+
- [LocationRequest](docs/LocationRequest.md)
169170
- [MetaNotificationRequest](docs/MetaNotificationRequest.md)
171+
- [Notification](docs/Notification.md)
172+
- [NotificationRequest](docs/NotificationRequest.md)
170173
- [Observation](docs/Observation.md)
171174
- [ObservationPrediction](docs/ObservationPrediction.md)
172175
- [ObservationPredictionRequest](docs/ObservationPredictionRequest.md)
@@ -176,23 +179,20 @@ Class | Method | HTTP request | Description
176179
- [PaginatedBiteList](docs/PaginatedBiteList.md)
177180
- [PaginatedBreedingSiteList](docs/PaginatedBreedingSiteList.md)
178181
- [PaginatedCampaignList](docs/PaginatedCampaignList.md)
179-
- [PaginatedDetailNotificationList](docs/PaginatedDetailNotificationList.md)
182+
- [PaginatedNotificationList](docs/PaginatedNotificationList.md)
180183
- [PaginatedObservationList](docs/PaginatedObservationList.md)
181184
- [PaginatedPartnerList](docs/PaginatedPartnerList.md)
182185
- [Partner](docs/Partner.md)
183186
- [PartnerPoint](docs/PartnerPoint.md)
184-
- [PatchedDetailNotificationRequest](docs/PatchedDetailNotificationRequest.md)
187+
- [PatchedNotificationRequest](docs/PatchedNotificationRequest.md)
185188
- [PatchedUserRequest](docs/PatchedUserRequest.md)
186189
- [Photo](docs/Photo.md)
187190
- [PhotoPrediction](docs/PhotoPrediction.md)
188191
- [PhotoPredictionRequest](docs/PhotoPredictionRequest.md)
189192
- [PredictionScore](docs/PredictionScore.md)
190193
- [PredictionScoreRequest](docs/PredictionScoreRequest.md)
191-
- [ReportLocation](docs/ReportLocation.md)
192-
- [ReportLocationPoint](docs/ReportLocationPoint.md)
193-
- [ReportLocationRequest](docs/ReportLocationRequest.md)
194-
- [ReportPhoto](docs/ReportPhoto.md)
195-
- [ReportPhotoRequest](docs/ReportPhotoRequest.md)
194+
- [SimplePhoto](docs/SimplePhoto.md)
195+
- [SimplePhotoRequest](docs/SimplePhotoRequest.md)
196196
- [TokenRefresh](docs/TokenRefresh.md)
197197
- [TokenRefreshRequest](docs/TokenRefreshRequest.md)
198198
- [TopicNotificationCreateRequest](docs/TopicNotificationCreateRequest.md)

‎docs/Bite.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
1313
**sent_at** | **datetime** | |
1414
**received_at** | **datetime** | | [readonly]
1515
**updated_at** | **datetime** | Date and time when the report was last modified | [readonly]
16-
**location** | [**ReportLocation**](ReportLocation.md) | |
16+
**location** | [**Location**](Location.md) | |
1717
**note** | **str** | Note user attached to report. | [optional]
1818
**tags** | **List[str]** | | [optional]
1919
**published** | **bool** | | [readonly]

‎docs/BiteRequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**created_at** | **datetime** | |
99
**sent_at** | **datetime** | |
10-
**location** | [**ReportLocationRequest**](ReportLocationRequest.md) | |
10+
**location** | [**LocationRequest**](LocationRequest.md) | |
1111
**note** | **str** | Note user attached to report. | [optional]
1212
**tags** | **List[str]** | | [optional]
1313
**package** | [**PackageRequest**](PackageRequest.md) | | [optional]

‎docs/BreedingSite.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ Name | Type | Description | Notes
1313
**sent_at** | **datetime** | |
1414
**received_at** | **datetime** | | [readonly]
1515
**updated_at** | **datetime** | Date and time when the report was last modified | [readonly]
16-
**location** | [**ReportLocation**](ReportLocation.md) | |
16+
**location** | [**Location**](Location.md) | |
1717
**note** | **str** | Note user attached to report. | [optional]
1818
**tags** | **List[str]** | | [optional]
1919
**published** | **bool** | | [readonly]
20-
**photos** | [**List[ReportPhoto]**](ReportPhoto.md) | |
20+
**photos** | [**List[SimplePhoto]**](SimplePhoto.md) | |
2121
**site_type** | **str** | Breeding site type. | [optional]
2222
**has_water** | **bool** | Either if the user perceived water in the breeding site. | [optional]
2323
**in_public_area** | **bool** | Either if the breeding site is found in a public area. | [optional]

‎docs/BreedingSiteRequest.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**created_at** | **datetime** | |
99
**sent_at** | **datetime** | |
10-
**location** | [**ReportLocationRequest**](ReportLocationRequest.md) | |
10+
**location** | [**LocationRequest**](LocationRequest.md) | |
1111
**note** | **str** | Note user attached to report. | [optional]
1212
**tags** | **List[str]** | | [optional]
1313
**package** | [**PackageRequest**](PackageRequest.md) | | [optional]
1414
**device** | [**DeviceRequest**](DeviceRequest.md) | | [optional]
15-
**photos** | [**List[ReportPhotoRequest]**](ReportPhotoRequest.md) | |
15+
**photos** | [**List[SimplePhotoRequest]**](SimplePhotoRequest.md) | |
1616
**site_type** | **str** | Breeding site type. | [optional]
1717
**has_water** | **bool** | Either if the user perceived water in the breeding site. | [optional]
1818
**in_public_area** | **bool** | Either if the breeding site is found in a public area. | [optional]

‎docs/CreateNotification.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# CreateNotification
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**id** | **int** | | [readonly]
9+
**created_at** | **datetime** | | [readonly]
10+
11+
## Example
12+
13+
```python
14+
from mosquito_alert.models.create_notification import CreateNotification
15+
16+
# TODO update the JSON string below
17+
json = "{}"
18+
# create an instance of CreateNotification from a JSON string
19+
create_notification_instance = CreateNotification.from_json(json)
20+
# print the JSON string representation of the object
21+
print(CreateNotification.to_json())
22+
23+
# convert the object into a dict
24+
create_notification_dict = create_notification_instance.to_dict()
25+
# create an instance of CreateNotification from a dict
26+
create_notification_from_dict = CreateNotification.from_dict(create_notification_dict)
27+
```
28+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
29+
30+

‎docs/Location.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Location
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**type** | **str** | Did user indicate that report relates to current location of phone ('current') or to a location selected manually on the map ('selected')? Or is the choice missing ('missing') |
9+
**point** | [**LocationPoint**](LocationPoint.md) | |
10+
**timezone** | **str** | | [readonly]
11+
**country_id** | **int** | | [readonly]
12+
**nuts_2** | **str** | | [readonly]
13+
**nuts_3** | **str** | | [readonly]
14+
15+
## Example
16+
17+
```python
18+
from mosquito_alert.models.location import Location
19+
20+
# TODO update the JSON string below
21+
json = "{}"
22+
# create an instance of Location from a JSON string
23+
location_instance = Location.from_json(json)
24+
# print the JSON string representation of the object
25+
print(Location.to_json())
26+
27+
# convert the object into a dict
28+
location_dict = location_instance.to_dict()
29+
# create an instance of Location from a dict
30+
location_from_dict = Location.from_dict(location_dict)
31+
```
32+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
33+
34+

0 commit comments

Comments
 (0)