Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Eh/documentation #10

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/AppInstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
> esperclient.models.app_install

### Description
A class which encapsulates the metadata of a single app, installed on one device.

## Properties
Name | Type | Description | Notes
Expand Down
4 changes: 4 additions & 0 deletions docs/Device.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
> esperclient.models.device

### Description
A class which describes an Esper-provisioned device. It contains, as properties, a multitude of device qualities. Objects of this class are commonly returned from API calls, sometimes in lists.

Returned by:
* [get_device_by_id](DeviceApi.md#get_device_by_id)

## Properties
Name | Type | Description | Notes
Expand Down
26 changes: 13 additions & 13 deletions docs/DeviceApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ Method | HTTP request | Description
# **get_all_devices**
> 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
Fetch the data for all devices in an Enterprise from Esper's cloud servers.

Returns a list of devices
Returns a list of Device objects, containing device state data retrieved from Esper servers.

### Example
```python
Expand Down Expand Up @@ -88,9 +88,9 @@ Name | Type | Description | Notes
# **get_app_installs**
> 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
Fetch a list all of the apps which are installed on a single device.

Returns AppInstall list
Returns a list of AppInstall objects.

### Example
```python
Expand Down Expand Up @@ -153,9 +153,9 @@ Name | Type | Description | Notes
# **get_device_app_by_id**
> DeviceApp get_device_app_by_id(app_id, enterprise_id, device_id)

Get device app details
Fetch the details of a specified app (which may or may not be installed) associated with a specified device.

Returns DeviceApp instance
Returns a DeviceApp object containing the app details.

### Example
```python
Expand Down Expand Up @@ -208,9 +208,9 @@ Name | Type | Description | Notes
# **get_device_apps**
> InlineResponse2004 get_device_apps(enterprise_id, device_id, package_name=package_name, whitelisted=whitelisted, search=search, limit=limit, offset=offset)

List all device apps
Fetch a list of all apps (installed or not) associated with a specified device.

Returns DeviceApp list
Returns a list of DeviceApp objects.

### Example
```python
Expand Down Expand Up @@ -271,9 +271,9 @@ Name | Type | Description | Notes
# **get_device_by_id**
> Device get_device_by_id(enterprise_id, device_id)

Fetch device details by ID
Fetch device details based on a specified device ID.

Returns details of a device
Returns a single Device object.

### Example
```python
Expand Down Expand Up @@ -324,9 +324,9 @@ Name | Type | Description | Notes
# **get_device_event**
> InlineResponse2006 get_device_event(enterprise_id, device_id, latest_event)

Get latest device event
Fetch the latest device event registered by the Esper cloud servers, for one specified device.

Returns DeviceStatus instance
Returns a list of DeviceStatus objects.

### Example
```python
Expand Down Expand Up @@ -359,7 +359,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**enterprise_id** | **str**| A UUID string identifying this enterprise. |
**device_id** | **str**| A UUID string identifying device. |
**latest_event** | **int**| Flag to get latest event |
**latest_event** | **int**| A necessary flag to get latest event. | May be any positive integer. Flag value has no effect on return results.

### Return type

Expand Down
1 change: 1 addition & 0 deletions docs/DeviceApp.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
> esperclient.models.device_app

### Description
A class which encapsulates the metadata of a single app. This app may be installed or not installed on its particular device.

## Properties
Name | Type | Description | Notes
Expand Down
1 change: 1 addition & 0 deletions docs/DeviceStatus.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
> esperclient.models.device_status

### Description
A class which encapsulates the data from one device event from a single device.

## Properties
Name | Type | Description | Notes
Expand Down
4 changes: 4 additions & 0 deletions docs/InlineResponse2003.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
> esperclient.models.inline_response2003

### Description
A class which encapsulates the data returned from an API call. Returned data is in the form of a list of [Device](Device.md) objects. Objects of this class are commonly returned from API calls.

Returned by:
* [get_all_devices](DeviceApi.md#get_all_devices)

## Properties
Name | Type | Description | Notes
Expand Down
4 changes: 4 additions & 0 deletions docs/InlineResponse2004.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
> esperclient.models.inline_response2004

### Description
A class which encapsulates the data returned from an API call. Returned data is in the form of a list of [DeviceApp](DeviceApp.md) objects. Objects of this class are commonly returned from API calls.

Returned by:
* [get_device_app_by_id](DeviceApi.md#get_device_app_by_id)

## Properties
Name | Type | Description | Notes
Expand Down
4 changes: 4 additions & 0 deletions docs/InlineResponse2005.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
> esperclient.models.inline_response2005

### Description
A class which encapsulates the data returned from an API call. Returned data is in the form of a list of [AppInstall](AppInstall.md) objects. Objects of this class are commonly returned from API calls.

Returned by:
* [get_app_installs](DeviceApi.md#get_app_installs)

## Properties
Name | Type | Description | Notes
Expand Down
4 changes: 4 additions & 0 deletions docs/InlineResponse2006.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
> esperclient.models.inline_response2006

### Description
A class which encapsulates the data returned from an API call. Returned data is in the form of a list of [DeviceStatus](DeviceStatus.md) objects. Objects of this class are commonly returned from API calls.

Returned by:
* [get_device_event](DeviceApi.md#get_device_event)

## Properties
Name | Type | Description | Notes
Expand Down