API referenceresources

ovok_sdk.resources.wearables

Wearable providers and the signed-in user's connections to them.

  • Stable unknown
  • Release candidate since 0.1.0-rc.4
  • Development since 0.1.0-dev.25+2ba84b0

Wearable providers and the signed-in user's connections to them.

WearableProvidersResource

WearableProvidersResource(http: HttpClient)

The project's wearable providers; access it as ovok.wearables.providers.

Parameters

NameTypeDefaultDescription
httpHttpClientThe HTTP client scoped to the wearables routes.

list()

list() -> Resource

List the configured providers.

Returns

  • Resource: The providers.

retrieve()

retrieve(provider: str) -> Resource

Read one provider.

Parameters

NameTypeDefaultDescription
providerstrThe provider name.

Returns

  • Resource: The provider.

create()

create(body: Resource) -> Resource

Configure a provider.

Parameters

NameTypeDefaultDescription
bodyResourceThe provider as the API takes it.

Returns

  • Resource: The created provider.

patch()

patch(provider: str, body: Resource) -> Resource

Update a provider.

Parameters

NameTypeDefaultDescription
providerstrThe provider name.
bodyResourceThe fields to change.

Returns

  • Resource: The updated provider.

delete()

delete(provider: str) -> None

Remove a provider.

Parameters

NameTypeDefaultDescription
providerstrThe provider name.

WearableConnectionsResource

WearableConnectionsResource(http: HttpClient)

The signed-in user's provider connections; access it as ovok.wearables.connections.

Parameters

NameTypeDefaultDescription
httpHttpClientThe HTTP client scoped to the wearables routes.

list()

list() -> Resource

List the user's connections.

Returns

  • Resource: The connections.

authorize()

authorize(provider: str) -> Resource

Start connecting the user to a provider.

Parameters

NameTypeDefaultDescription
providerstrThe provider name.

Returns

  • Resource: The authorization details, such as the URL to send the user to.

sync()

sync(provider: str) -> Resource

Sync the user's data from a connected provider now.

Parameters

NameTypeDefaultDescription
providerstrThe provider name.

Returns

  • Resource: The API's sync response.

delete()

delete(provider: str) -> None

Disconnect the user from a provider.

Parameters

NameTypeDefaultDescription
providerstrThe provider name.

WearablesResource

WearablesResource(http: HttpClient)

Wearable providers and connections.

Created by Ovok; access it as ovok.wearables.

Last updated on

On this page