Merge pull request #9 from esper-io/token-renew

Update in Renew token spec and Addition of spec for Install devices
esper-io · Sep 9, 2020 · fe4217d · fe4217d
2 parents be9314b + 0267152
commit fe4217d
Show file tree

Hide file tree

Showing 41 changed files with 996 additions and 131 deletions.
diff --git a/README.md b/README.md
@@ -86,6 +86,7 @@ Class | Method | HTTP request
 *ApplicationApi* | [**get_app_version**](docs/ApplicationApi.md#get_app_version) | **GET** /enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/
 *ApplicationApi* | [**get_app_versions**](docs/ApplicationApi.md#get_app_versions) | **GET** /enterprise/{enterprise_id}/application/{application_id}/version/
 *ApplicationApi* | [**get_application**](docs/ApplicationApi.md#get_application) | **GET** /enterprise/{enterprise_id}/application/{application_id}/
+*ApplicationApi* | [**get_install_devices**](docs/ApplicationApi.md#get_install_devices) | **GET** /enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/installdevices
 *ApplicationApi* | [**upload**](docs/ApplicationApi.md#upload) | **POST** /enterprise/{enterprise_id}/application/upload/
 *CommandsApi* | [**get_command**](docs/CommandsApi.md#get_command) | **GET** /enterprise/{enterprise_id}/device/{device_id}/command/{command_id}/
 *CommandsApi* | [**run_command**](docs/CommandsApi.md#run_command) | **POST** /enterprise/{enterprise_id}/device/{device_id}/command/
@@ -163,6 +164,7 @@ Class | Method | HTTP request
  - [InlineResponse200](docs/InlineResponse200.md)
  - [InlineResponse2001](docs/InlineResponse2001.md)
  - [InlineResponse20010](docs/InlineResponse20010.md)
+ - [InlineResponse20011](docs/InlineResponse20011.md)
  - [InlineResponse2002](docs/InlineResponse2002.md)
  - [InlineResponse2003](docs/InlineResponse2003.md)
  - [InlineResponse2004](docs/InlineResponse2004.md)
@@ -172,6 +174,7 @@ Class | Method | HTTP request
  - [InlineResponse2008](docs/InlineResponse2008.md)
  - [InlineResponse2009](docs/InlineResponse2009.md)
  - [InlineResponse201](docs/InlineResponse201.md)
+ - [InstallDevices](docs/InstallDevices.md)
  - [TokenInfoV1](docs/TokenInfoV1.md)
  - [TokenRenewV0](docs/TokenRenewV0.md)
  - [V0CommandArgs](docs/V0CommandArgs.md)

diff --git a/docs/ApplicationApi.md b/docs/ApplicationApi.md
@@ -10,7 +10,8 @@ Method | HTTP request | Description
 [**get_app_version**](ApplicationApi.md#get_app_version) | **GET** /enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/ | Get app version information
 [**get_app_versions**](ApplicationApi.md#get_app_versions) | **GET** /enterprise/{enterprise_id}/application/{application_id}/version/ | List App versions
 [**get_application**](ApplicationApi.md#get_application) | **GET** /enterprise/{enterprise_id}/application/{application_id}/ | Get application information
-[**upload**](ApplicationApi.md#upload) | **POST** /enterprise/{enterprise_id}/application/upload/ | upload an application to enterprise
+[**get_install_devices**](ApplicationApi.md#get_install_devices) | **GET** /enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/installdevices | List install devices
+[**upload**](ApplicationApi.md#upload) | **POST** /enterprise/{enterprise_id}/application/upload/ | Upload an application to enterprise
 
 
 # **delete_app_version**
@@ -349,10 +350,71 @@ Name | Type | Description  | Notes
 
 [[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)
 
+# **get_install_devices**
+> InlineResponse2002 get_install_devices(version_id, application_id, enterprise_id, search=search, limit=limit, offset=offset)
+
+List install devices
+
+Returns list of devices with the specified app version installed
+
+### Example
+```python
+import esperclient
+from esperclient.rest import ApiException
+
+# Configure API key authorization: apiKey
+configuration = esperclient.Configuration()
+configuration.host = 'SERVER_URL'
+configuration.api_key['Authorization'] = 'YOUR_API_KEY'
+configuration.api_key_prefix['Authorization'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = esperclient.ApplicationApi(esperclient.ApiClient(configuration))
+version_id = 'version_id_example' # str | A UUID string identifying this app version.
+application_id = 'application_id_example' # str | A UUID string identifying this application.
+enterprise_id = 'enterprise_id_example' # str | A UUID string identifying enterprise.
+search = 'search_example' # str | A search term (optional)
+limit = 56 # int | Number of results to return per page (optional)
+offset = 56 # int | The initial index from which to return the results (optional)
+
+try:
+    # List install devices
+    api_response = api_instance.get_install_devices(version_id, application_id, enterprise_id, search=search, limit=limit, offset=offset)
+    print(api_response)
+except ApiException as e:
+    print("Exception when calling ApplicationApi->get_install_devices: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **version_id** | [**str**](.md)| A UUID string identifying this app version. | 
+ **application_id** | [**str**](.md)| A UUID string identifying this application. | 
+ **enterprise_id** | **str**| A UUID string identifying enterprise. | 
+ **search** | **str**| A search term | [optional] 
+ **limit** | **int**| Number of results to return per page | [optional] 
+ **offset** | **int**| The initial index from which to return the results | [optional] 
+
+### Return type
+
+[**InlineResponse2002**](InlineResponse2002.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+[[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)
+
 # **upload**
 > InlineResponse201 upload(enterprise_id, app_file)
 
-upload an application to enterprise
+Upload an application to enterprise
 
 Returns application
 
@@ -370,10 +432,10 @@ configuration.api_key_prefix['Authorization'] = 'Bearer'
 # create an instance of the API class
 api_instance = esperclient.ApplicationApi(esperclient.ApiClient(configuration))
 enterprise_id = 'enterprise_id_example' # str | A UUID string identifying this enterprise.
-app_file = '/path/to/file.txt' # file | valid APK file
+app_file = '/path/to/file.txt' # file | Valid APK file
 
 try:
-    # upload an application to enterprise
+    # Upload an application to enterprise
     api_response = api_instance.upload(enterprise_id, app_file)
     print(api_response)
 except ApiException as e:
@@ -385,7 +447,7 @@ except ApiException as e:
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **enterprise_id** | **str**| A UUID string identifying this enterprise. | 
- **app_file** | **file**| valid APK file | 
+ **app_file** | **file**| Valid APK file | 
 
 ### Return type
 

diff --git a/docs/CommandsV2Api.md b/docs/CommandsV2Api.md
@@ -65,7 +65,7 @@ Name | Type | Description  | Notes
 [[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)
 
 # **get_command_request_status**
-> InlineResponse2009 get_command_request_status(enterprise_id, request_id, device=device, state=state)
+> InlineResponse20010 get_command_request_status(enterprise_id, request_id, device=device, state=state)
 
 get status list for command request
 
@@ -108,7 +108,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**InlineResponse2009**](InlineResponse2009.md)
+[**InlineResponse20010**](InlineResponse20010.md)
 
 ### Authorization
 
@@ -122,7 +122,7 @@ Name | Type | Description  | Notes
 [[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)
 
 # **get_device_command_history**
-> InlineResponse2009 get_device_command_history(enterprise_id, device_id, state=state)
+> InlineResponse20010 get_device_command_history(enterprise_id, device_id, state=state)
 
 get command history for device
 
@@ -163,7 +163,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**InlineResponse2009**](InlineResponse2009.md)
+[**InlineResponse20010**](InlineResponse20010.md)
 
 ### Authorization
 
@@ -177,7 +177,7 @@ Name | Type | Description  | Notes
 [[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)
 
 # **list_command_request**
-> InlineResponse2008 list_command_request(enterprise_id, command_type=command_type, devices=devices, device_type=device_type, command=command, issued_by=issued_by)
+> InlineResponse2009 list_command_request(enterprise_id, command_type=command_type, devices=devices, device_type=device_type, command=command, issued_by=issued_by)
 
 List command requests
 
@@ -224,7 +224,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**InlineResponse2008**](InlineResponse2008.md)
+[**InlineResponse2009**](InlineResponse2009.md)
 
 ### Authorization
 

diff --git a/docs/DeviceApi.md b/docs/DeviceApi.md
@@ -13,7 +13,7 @@ Method | HTTP request | Description
 
 
 # **get_all_devices**
-> InlineResponse2002 get_all_devices(enterprise_id, name=name, group=group, imei=imei, serial=serial, state=state, brand=brand, is_gms=is_gms, search=search, tags=tags, limit=limit, offset=offset)
+> InlineResponse2003 get_all_devices(enterprise_id, name=name, group=group, imei=imei, serial=serial, state=state, brand=brand, is_gms=is_gms, search=search, tags=tags, limit=limit, offset=offset)
 
 Fetch all devices in an enterprise
 
@@ -72,7 +72,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**InlineResponse2002**](InlineResponse2002.md)
+[**InlineResponse2003**](InlineResponse2003.md)
 
 ### Authorization
 
@@ -86,7 +86,7 @@ Name | Type | Description  | Notes
 [[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)
 
 # **get_app_installs**
-> InlineResponse2004 get_app_installs(enterprise_id, device_id, device=device, package_name=package_name, application_name=application_name, install_state=install_state, limit=limit, offset=offset)
+> InlineResponse2005 get_app_installs(enterprise_id, device_id, device=device, package_name=package_name, application_name=application_name, install_state=install_state, limit=limit, offset=offset)
 
 List installed apps
 
@@ -137,7 +137,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**InlineResponse2004**](InlineResponse2004.md)
+[**InlineResponse2005**](InlineResponse2005.md)
 
 ### Authorization
 
@@ -206,7 +206,7 @@ Name | Type | Description  | Notes
 [[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)
 
 # **get_device_apps**
-> InlineResponse2003 get_device_apps(enterprise_id, device_id, package_name=package_name, whitelisted=whitelisted, search=search, limit=limit, offset=offset)
+> InlineResponse2004 get_device_apps(enterprise_id, device_id, package_name=package_name, whitelisted=whitelisted, search=search, limit=limit, offset=offset)
 
 List all device apps
 
@@ -255,7 +255,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**InlineResponse2003**](InlineResponse2003.md)
+[**InlineResponse2004**](InlineResponse2004.md)
 
 ### Authorization
 
@@ -322,7 +322,7 @@ Name | Type | Description  | Notes
 [[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)
 
 # **get_device_event**
-> InlineResponse2005 get_device_event(enterprise_id, device_id, latest_event)
+> InlineResponse2006 get_device_event(enterprise_id, device_id, latest_event)
 
 Get latest device event
 
@@ -363,7 +363,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**InlineResponse2005**](InlineResponse2005.md)
+[**InlineResponse2006**](InlineResponse2006.md)
 
 ### Authorization
 

diff --git a/docs/DeviceGroupApi.md b/docs/DeviceGroupApi.md
@@ -118,7 +118,7 @@ void (empty response body)
 [[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)
 
 # **get_all_groups**
-> InlineResponse2006 get_all_groups(enterprise_id, name=name, limit=limit, offset=offset)
+> InlineResponse2007 get_all_groups(enterprise_id, name=name, limit=limit, offset=offset)
 
 List device groups
 
@@ -161,7 +161,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**InlineResponse2006**](InlineResponse2006.md)
+[**InlineResponse2007**](InlineResponse2007.md)
 
 ### Authorization
 

diff --git a/docs/EnterprisePolicyApi.md b/docs/EnterprisePolicyApi.md
@@ -171,7 +171,7 @@ Name | Type | Description  | Notes
 [[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)
 
 # **list_policies**
-> InlineResponse2007 list_policies(enterprise_id, name=name, is_active=is_active, limit=limit, offset=offset)
+> InlineResponse2008 list_policies(enterprise_id, name=name, is_active=is_active, limit=limit, offset=offset)
 
 List all policies in enterprise
 
@@ -216,7 +216,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**InlineResponse2007**](InlineResponse2007.md)
+[**InlineResponse2008**](InlineResponse2008.md)
 
 ### Authorization
 

diff --git a/docs/GeofenceApi.md b/docs/GeofenceApi.md
@@ -118,7 +118,7 @@ void (empty response body)
 [[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)
 
 # **get_all_geofences**
-> InlineResponse20010 get_all_geofences(enterprise_id, search=search, limit=limit, offset=offset)
+> InlineResponse20011 get_all_geofences(enterprise_id, search=search, limit=limit, offset=offset)
 
 List Geofences in Enterprise
 
@@ -161,7 +161,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**InlineResponse20010**](InlineResponse20010.md)
+[**InlineResponse20011**](InlineResponse20011.md)
 
 ### Authorization
 

diff --git a/docs/InlineResponse20010.md b/docs/InlineResponse20010.md
@@ -6,10 +6,10 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**count** | **int** |  | 
+**count** | **int** |  | [optional] 
 **next** | **str** |  | [optional] 
 **previous** | **str** |  | [optional] 
-**results** | [**list[Geofence]**](Geofence.md) |  | 
+**results** | [**list[V0CommandStatus]**](V0CommandStatus.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/InlineResponse20011.md b/docs/InlineResponse20011.md
@@ -0,0 +1,16 @@
+# InlineResponse20011
+> esperclient.models.inline_response20011
+
+### Description
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **int** |  | 
+**next** | **str** |  | [optional] 
+**previous** | **str** |  | [optional] 
+**results** | [**list[Geofence]**](Geofence.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/docs/InlineResponse2002.md b/docs/InlineResponse2002.md
@@ -6,10 +6,10 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**count** | **int** |  | [optional] 
+**count** | **int** |  | 
 **next** | **str** |  | [optional] 
 **previous** | **str** |  | [optional] 
-**results** | [**list[Device]**](Device.md) |  | [optional] 
+**results** | [**list[InstallDevices]**](InstallDevices.md) |  | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/InlineResponse2003.md b/docs/InlineResponse2003.md
@@ -6,10 +6,10 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**count** | **int** |  | 
+**count** | **int** |  | [optional] 
 **next** | **str** |  | [optional] 
 **previous** | **str** |  | [optional] 
-**results** | [**list[DeviceApp]**](DeviceApp.md) |  | 
+**results** | [**list[Device]**](Device.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/InlineResponse2004.md b/docs/InlineResponse2004.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **count** | **int** |  | 
 **next** | **str** |  | [optional] 
 **previous** | **str** |  | [optional] 
-**results** | [**list[AppInstall]**](AppInstall.md) |  | 
+**results** | [**list[DeviceApp]**](DeviceApp.md) |  | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/InlineResponse2005.md b/docs/InlineResponse2005.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **count** | **int** |  | 
 **next** | **str** |  | [optional] 
 **previous** | **str** |  | [optional] 
-**results** | [**list[DeviceStatus]**](DeviceStatus.md) |  | 
+**results** | [**list[AppInstall]**](AppInstall.md) |  | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/InlineResponse2006.md b/docs/InlineResponse2006.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **count** | **int** |  | 
 **next** | **str** |  | [optional] 
 **previous** | **str** |  | [optional] 
-**results** | [**list[DeviceGroup]**](DeviceGroup.md) |  | 
+**results** | [**list[DeviceStatus]**](DeviceStatus.md) |  | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)