Packages
Fitness API client library. The Fitness API for managing users' fitness tracking data.
Current section
Files
Jump to
Current section
Files
lib/google_api/fitness/v1/api/users.ex
# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# NOTE: This file is auto generated by the elixir code generator program.
# Do not edit this file manually.
defmodule GoogleApi.Fitness.V1.Api.Users do
@moduledoc """
API calls for all endpoints tagged `Users`.
"""
alias GoogleApi.Fitness.V1.Connection
alias GoogleApi.Gax.{Request, Response}
@library_version Mix.Project.config() |> Keyword.get(:version, "")
@doc """
Creates a new data source that is unique across all data sources belonging
to this user.
A data source is a unique source of sensor data. Data sources can expose
raw data coming from hardware sensors on local or companion devices. They
can also expose derived data, created by transforming or merging other data
sources. Multiple data sources can exist for the same data type. Every data
point in every dataset inserted into or read from the Fitness API has an
associated data source.
Each data source produces a unique stream of dataset updates, with a
unique data source identifier. Not all changes to data source affect the
data stream ID, so that data collected by updated versions of the same
application/device can still be considered to belong to the same data
source.
Data sources are identified using a string generated by the server, based
on the contents of the source being created. The <code>dataStreamId</code>
field should not be set when invoking this method. It
will be automatically generated by the server with the correct format. If
a <code>dataStreamId</code> is set, it must match the format that the
server would generate. This format is a combination of some fields from the
data source, and has a specific order. If it doesn't match, the request
will fail with an error.
Specifying a DataType which is not a known type (beginning with
"com.google.") will create a DataSource with a <em>custom data type</em>.
Custom data types are only readable by the application that created them.
Custom data types are <strong>deprecated</strong>; use standard data types
instead.
In addition to the data source fields included in the data source ID, the
developer project number that is authenticated when creating the data
source is included. This developer project number is obfuscated when read
by any other developer reading public data types.
## Parameters
* `connection` (*type:* `GoogleApi.Fitness.V1.Connection.t`) - Connection to server
* `user_id` (*type:* `String.t`) - Create the data source for the person identified. Use <code>me</code> to
indicate the authenticated user. Only <code>me</code> is supported at this
time.
* `optional_params` (*type:* `keyword()`) - Optional parameters
* `:"$.xgafv"` (*type:* `String.t`) - V1 error format.
* `:access_token` (*type:* `String.t`) - OAuth access token.
* `:alt` (*type:* `String.t`) - Data format for response.
* `:callback` (*type:* `String.t`) - JSONP
* `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response.
* `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
* `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user.
* `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks.
* `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
* `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart").
* `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart").
* `:body` (*type:* `GoogleApi.Fitness.V1.Model.DataSource.t`) -
* `opts` (*type:* `keyword()`) - Call options
## Returns
* `{:ok, %GoogleApi.Fitness.V1.Model.DataSource{}}` on success
* `{:error, info}` on failure
"""
@spec fitness_users_data_sources_create(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
{:ok, GoogleApi.Fitness.V1.Model.DataSource.t()}
| {:ok, Tesla.Env.t()}
| {:error, any()}
def fitness_users_data_sources_create(connection, user_id, optional_params \\ [], opts \\ []) do
optional_params_config = %{
:"$.xgafv" => :query,
:access_token => :query,
:alt => :query,
:callback => :query,
:fields => :query,
:key => :query,
:oauth_token => :query,
:prettyPrint => :query,
:quotaUser => :query,
:uploadType => :query,
:upload_protocol => :query,
:body => :body
}
request =
Request.new()
|> Request.method(:post)
|> Request.url("/fitness/v1/users/{userId}/dataSources", %{
"userId" => URI.encode(user_id, &URI.char_unreserved?/1)
})
|> Request.add_optional_params(optional_params_config, optional_params)
|> Request.library_version(@library_version)
connection
|> Connection.execute(request)
|> Response.decode(opts ++ [struct: %GoogleApi.Fitness.V1.Model.DataSource{}])
end
@doc """
Deletes the specified data source. The request will fail if the data
source contains any data points.
## Parameters
* `connection` (*type:* `GoogleApi.Fitness.V1.Connection.t`) - Connection to server
* `user_id` (*type:* `String.t`) - Retrieve a data source for the person identified. Use <code>me</code> to
indicate the authenticated user. Only <code>me</code> is supported at this
time.
* `data_source_id` (*type:* `String.t`) - The data stream ID of the data source to delete.
* `optional_params` (*type:* `keyword()`) - Optional parameters
* `:"$.xgafv"` (*type:* `String.t`) - V1 error format.
* `:access_token` (*type:* `String.t`) - OAuth access token.
* `:alt` (*type:* `String.t`) - Data format for response.
* `:callback` (*type:* `String.t`) - JSONP
* `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response.
* `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
* `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user.
* `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks.
* `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
* `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart").
* `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart").
* `opts` (*type:* `keyword()`) - Call options
## Returns
* `{:ok, %GoogleApi.Fitness.V1.Model.DataSource{}}` on success
* `{:error, info}` on failure
"""
@spec fitness_users_data_sources_delete(
Tesla.Env.client(),
String.t(),
String.t(),
keyword(),
keyword()
) ::
{:ok, GoogleApi.Fitness.V1.Model.DataSource.t()}
| {:ok, Tesla.Env.t()}
| {:error, any()}
def fitness_users_data_sources_delete(
connection,
user_id,
data_source_id,
optional_params \\ [],
opts \\ []
) do
optional_params_config = %{
:"$.xgafv" => :query,
:access_token => :query,
:alt => :query,
:callback => :query,
:fields => :query,
:key => :query,
:oauth_token => :query,
:prettyPrint => :query,
:quotaUser => :query,
:uploadType => :query,
:upload_protocol => :query
}
request =
Request.new()
|> Request.method(:delete)
|> Request.url("/fitness/v1/users/{userId}/dataSources/{dataSourceId}", %{
"userId" => URI.encode(user_id, &URI.char_unreserved?/1),
"dataSourceId" => URI.encode(data_source_id, &URI.char_unreserved?/1)
})
|> Request.add_optional_params(optional_params_config, optional_params)
|> Request.library_version(@library_version)
connection
|> Connection.execute(request)
|> Response.decode(opts ++ [struct: %GoogleApi.Fitness.V1.Model.DataSource{}])
end
@doc """
Returns the specified data source.
## Parameters
* `connection` (*type:* `GoogleApi.Fitness.V1.Connection.t`) - Connection to server
* `user_id` (*type:* `String.t`) - Retrieve a data source for the person identified. Use <code>me</code> to
indicate the authenticated user. Only <code>me</code> is supported at this
time.
* `data_source_id` (*type:* `String.t`) - The data stream ID of the data source to retrieve.
* `optional_params` (*type:* `keyword()`) - Optional parameters
* `:"$.xgafv"` (*type:* `String.t`) - V1 error format.
* `:access_token` (*type:* `String.t`) - OAuth access token.
* `:alt` (*type:* `String.t`) - Data format for response.
* `:callback` (*type:* `String.t`) - JSONP
* `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response.
* `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
* `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user.
* `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks.
* `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
* `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart").
* `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart").
* `opts` (*type:* `keyword()`) - Call options
## Returns
* `{:ok, %GoogleApi.Fitness.V1.Model.DataSource{}}` on success
* `{:error, info}` on failure
"""
@spec fitness_users_data_sources_get(
Tesla.Env.client(),
String.t(),
String.t(),
keyword(),
keyword()
) ::
{:ok, GoogleApi.Fitness.V1.Model.DataSource.t()}
| {:ok, Tesla.Env.t()}
| {:error, any()}
def fitness_users_data_sources_get(
connection,
user_id,
data_source_id,
optional_params \\ [],
opts \\ []
) do
optional_params_config = %{
:"$.xgafv" => :query,
:access_token => :query,
:alt => :query,
:callback => :query,
:fields => :query,
:key => :query,
:oauth_token => :query,
:prettyPrint => :query,
:quotaUser => :query,
:uploadType => :query,
:upload_protocol => :query
}
request =
Request.new()
|> Request.method(:get)
|> Request.url("/fitness/v1/users/{userId}/dataSources/{dataSourceId}", %{
"userId" => URI.encode(user_id, &URI.char_unreserved?/1),
"dataSourceId" => URI.encode(data_source_id, &URI.char_unreserved?/1)
})
|> Request.add_optional_params(optional_params_config, optional_params)
|> Request.library_version(@library_version)
connection
|> Connection.execute(request)
|> Response.decode(opts ++ [struct: %GoogleApi.Fitness.V1.Model.DataSource{}])
end
@doc """
Lists all data sources that are visible to the developer, using the OAuth
scopes provided. The list is not exhaustive; the user may have private
data sources that are only visible to other developers, or calls using
other scopes.
## Parameters
* `connection` (*type:* `GoogleApi.Fitness.V1.Connection.t`) - Connection to server
* `user_id` (*type:* `String.t`) - List data sources for the person identified. Use <code>me</code> to
indicate the authenticated user. Only <code>me</code> is supported at this
time.
* `optional_params` (*type:* `keyword()`) - Optional parameters
* `:"$.xgafv"` (*type:* `String.t`) - V1 error format.
* `:access_token` (*type:* `String.t`) - OAuth access token.
* `:alt` (*type:* `String.t`) - Data format for response.
* `:callback` (*type:* `String.t`) - JSONP
* `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response.
* `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
* `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user.
* `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks.
* `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
* `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart").
* `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart").
* `:dataTypeName` (*type:* `list(String.t)`) - The names of data types to include in the list. If not specified, all
data sources will be returned.
* `opts` (*type:* `keyword()`) - Call options
## Returns
* `{:ok, %GoogleApi.Fitness.V1.Model.ListDataSourcesResponse{}}` on success
* `{:error, info}` on failure
"""
@spec fitness_users_data_sources_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
{:ok, GoogleApi.Fitness.V1.Model.ListDataSourcesResponse.t()}
| {:ok, Tesla.Env.t()}
| {:error, any()}
def fitness_users_data_sources_list(connection, user_id, optional_params \\ [], opts \\ []) do
optional_params_config = %{
:"$.xgafv" => :query,
:access_token => :query,
:alt => :query,
:callback => :query,
:fields => :query,
:key => :query,
:oauth_token => :query,
:prettyPrint => :query,
:quotaUser => :query,
:uploadType => :query,
:upload_protocol => :query,
:dataTypeName => :query
}
request =
Request.new()
|> Request.method(:get)
|> Request.url("/fitness/v1/users/{userId}/dataSources", %{
"userId" => URI.encode(user_id, &URI.char_unreserved?/1)
})
|> Request.add_optional_params(optional_params_config, optional_params)
|> Request.library_version(@library_version)
connection
|> Connection.execute(request)
|> Response.decode(opts ++ [struct: %GoogleApi.Fitness.V1.Model.ListDataSourcesResponse{}])
end
@doc """
Updates the specified data source. The <code>dataStreamId</code>,
<code>dataType</code>, <code>type</code>, <code>dataStreamName</code>, and
<code>device</code> properties with the exception of <code>version</code>,
cannot be modified.
Data sources are identified by their <code>dataStreamId</code>.
## Parameters
* `connection` (*type:* `GoogleApi.Fitness.V1.Connection.t`) - Connection to server
* `user_id` (*type:* `String.t`) - Update the data source for the person identified. Use <code>me</code> to
indicate the authenticated user. Only <code>me</code> is supported at this
time.
* `data_source_id` (*type:* `String.t`) - The data stream ID of the data source to update.
* `optional_params` (*type:* `keyword()`) - Optional parameters
* `:"$.xgafv"` (*type:* `String.t`) - V1 error format.
* `:access_token` (*type:* `String.t`) - OAuth access token.
* `:alt` (*type:* `String.t`) - Data format for response.
* `:callback` (*type:* `String.t`) - JSONP
* `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response.
* `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
* `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user.
* `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks.
* `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
* `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart").
* `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart").
* `:body` (*type:* `GoogleApi.Fitness.V1.Model.DataSource.t`) -
* `opts` (*type:* `keyword()`) - Call options
## Returns
* `{:ok, %GoogleApi.Fitness.V1.Model.DataSource{}}` on success
* `{:error, info}` on failure
"""
@spec fitness_users_data_sources_update(
Tesla.Env.client(),
String.t(),
String.t(),
keyword(),
keyword()
) ::
{:ok, GoogleApi.Fitness.V1.Model.DataSource.t()}
| {:ok, Tesla.Env.t()}
| {:error, any()}
def fitness_users_data_sources_update(
connection,
user_id,
data_source_id,
optional_params \\ [],
opts \\ []
) do
optional_params_config = %{
:"$.xgafv" => :query,
:access_token => :query,
:alt => :query,
:callback => :query,
:fields => :query,
:key => :query,
:oauth_token => :query,
:prettyPrint => :query,
:quotaUser => :query,
:uploadType => :query,
:upload_protocol => :query,
:body => :body
}
request =
Request.new()
|> Request.method(:put)
|> Request.url("/fitness/v1/users/{userId}/dataSources/{dataSourceId}", %{
"userId" => URI.encode(user_id, &URI.char_unreserved?/1),
"dataSourceId" => URI.encode(data_source_id, &URI.char_unreserved?/1)
})
|> Request.add_optional_params(optional_params_config, optional_params)
|> Request.library_version(@library_version)
connection
|> Connection.execute(request)
|> Response.decode(opts ++ [struct: %GoogleApi.Fitness.V1.Model.DataSource{}])
end
@doc """
Queries for user's data point changes for a particular data source.
## Parameters
* `connection` (*type:* `GoogleApi.Fitness.V1.Connection.t`) - Connection to server
* `user_id` (*type:* `String.t`) - List data points for the person identified. Use <code>me</code> to indicate
the authenticated user. Only <code>me</code> is supported at this time.
* `data_source_id` (*type:* `String.t`) - The data stream ID of the data source that created the dataset.
* `optional_params` (*type:* `keyword()`) - Optional parameters
* `:"$.xgafv"` (*type:* `String.t`) - V1 error format.
* `:access_token` (*type:* `String.t`) - OAuth access token.
* `:alt` (*type:* `String.t`) - Data format for response.
* `:callback` (*type:* `String.t`) - JSONP
* `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response.
* `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
* `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user.
* `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks.
* `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
* `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart").
* `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart").
* `:limit` (*type:* `integer()`) - If specified, no more than this many data point changes will be included
in the response.
* `:pageToken` (*type:* `String.t`) - The continuation token, which is used to page through large result sets.
To get the next page of results, set this parameter to the value of
<code>nextPageToken</code> from the previous response.
* `opts` (*type:* `keyword()`) - Call options
## Returns
* `{:ok, %GoogleApi.Fitness.V1.Model.ListDataPointChangesResponse{}}` on success
* `{:error, info}` on failure
"""
@spec fitness_users_data_sources_data_point_changes_list(
Tesla.Env.client(),
String.t(),
String.t(),
keyword(),
keyword()
) ::
{:ok, GoogleApi.Fitness.V1.Model.ListDataPointChangesResponse.t()}
| {:ok, Tesla.Env.t()}
| {:error, any()}
def fitness_users_data_sources_data_point_changes_list(
connection,
user_id,
data_source_id,
optional_params \\ [],
opts \\ []
) do
optional_params_config = %{
:"$.xgafv" => :query,
:access_token => :query,
:alt => :query,
:callback => :query,
:fields => :query,
:key => :query,
:oauth_token => :query,
:prettyPrint => :query,
:quotaUser => :query,
:uploadType => :query,
:upload_protocol => :query,
:limit => :query,
:pageToken => :query
}
request =
Request.new()
|> Request.method(:get)
|> Request.url("/fitness/v1/users/{userId}/dataSources/{dataSourceId}/dataPointChanges", %{
"userId" => URI.encode(user_id, &URI.char_unreserved?/1),
"dataSourceId" => URI.encode(data_source_id, &URI.char_unreserved?/1)
})
|> Request.add_optional_params(optional_params_config, optional_params)
|> Request.library_version(@library_version)
connection
|> Connection.execute(request)
|> Response.decode(
opts ++ [struct: %GoogleApi.Fitness.V1.Model.ListDataPointChangesResponse{}]
)
end
@doc """
Performs an inclusive delete of all data points whose start and end times
have any overlap with the time range specified by the dataset ID. For most
data types, the entire data point will be deleted. For data types where the
time span represents a consistent value (such as
<code>com.google.activity.segment</code>), and a data point straddles
either end point of the dataset, only the overlapping portion of the data
point will be deleted.
## Parameters
* `connection` (*type:* `GoogleApi.Fitness.V1.Connection.t`) - Connection to server
* `user_id` (*type:* `String.t`) - Delete a dataset for the person identified. Use <code>me</code> to indicate
the authenticated user. Only <code>me</code> is supported at this time.
* `data_source_id` (*type:* `String.t`) - The data stream ID of the data source that created the dataset.
* `dataset_id` (*type:* `String.t`) - Dataset identifier that is a composite of the minimum data point start time
and maximum data point end time represented as nanoseconds from the epoch.
The ID is formatted like: "<var>startTime</var>-<var>endTime</var>"
where <var>startTime</var> and <var>endTime</var> are 64 bit integers.
* `optional_params` (*type:* `keyword()`) - Optional parameters
* `:"$.xgafv"` (*type:* `String.t`) - V1 error format.
* `:access_token` (*type:* `String.t`) - OAuth access token.
* `:alt` (*type:* `String.t`) - Data format for response.
* `:callback` (*type:* `String.t`) - JSONP
* `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response.
* `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
* `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user.
* `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks.
* `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
* `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart").
* `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart").
* `:currentTimeMillis` (*type:* `String.t`) - The client's current time in milliseconds since epoch.
* `:modifiedTimeMillis` (*type:* `String.t`) - When the operation was performed on the client.
* `opts` (*type:* `keyword()`) - Call options
## Returns
* `{:ok, %{}}` on success
* `{:error, info}` on failure
"""
@spec fitness_users_data_sources_datasets_delete(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}
def fitness_users_data_sources_datasets_delete(
connection,
user_id,
data_source_id,
dataset_id,
optional_params \\ [],
opts \\ []
) do
optional_params_config = %{
:"$.xgafv" => :query,
:access_token => :query,
:alt => :query,
:callback => :query,
:fields => :query,
:key => :query,
:oauth_token => :query,
:prettyPrint => :query,
:quotaUser => :query,
:uploadType => :query,
:upload_protocol => :query,
:currentTimeMillis => :query,
:modifiedTimeMillis => :query
}
request =
Request.new()
|> Request.method(:delete)
|> Request.url(
"/fitness/v1/users/{userId}/dataSources/{dataSourceId}/datasets/{datasetId}",
%{
"userId" => URI.encode(user_id, &URI.char_unreserved?/1),
"dataSourceId" => URI.encode(data_source_id, &URI.char_unreserved?/1),
"datasetId" => URI.encode(dataset_id, &URI.char_unreserved?/1)
}
)
|> Request.add_optional_params(optional_params_config, optional_params)
|> Request.library_version(@library_version)
connection
|> Connection.execute(request)
|> Response.decode(opts ++ [decode: false])
end
@doc """
Returns a dataset containing all data points whose start and end times
overlap with the specified range of the dataset minimum start time and
maximum end time. Specifically, any data point whose start time is less
than or equal to the dataset end time and whose end time is greater than or
equal to the dataset start time.
## Parameters
* `connection` (*type:* `GoogleApi.Fitness.V1.Connection.t`) - Connection to server
* `user_id` (*type:* `String.t`) - Retrieve a dataset for the person identified. Use <code>me</code> to
indicate the authenticated user. Only <code>me</code> is supported at this
time.
* `data_source_id` (*type:* `String.t`) - The data stream ID of the data source that created the dataset.
* `dataset_id` (*type:* `String.t`) - Dataset identifier that is a composite of the minimum data point start time
and maximum data point end time represented as nanoseconds from the epoch.
The ID is formatted like: "<var>startTime</var>-<var>endTime</var>"
where <var>startTime</var> and <var>endTime</var> are 64 bit integers.
* `optional_params` (*type:* `keyword()`) - Optional parameters
* `:"$.xgafv"` (*type:* `String.t`) - V1 error format.
* `:access_token` (*type:* `String.t`) - OAuth access token.
* `:alt` (*type:* `String.t`) - Data format for response.
* `:callback` (*type:* `String.t`) - JSONP
* `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response.
* `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
* `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user.
* `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks.
* `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
* `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart").
* `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart").
* `:limit` (*type:* `integer()`) - If specified, no more than this many data points will be included in the
dataset. If there are more data points in the dataset, nextPageToken
will be set in the dataset response.
* `:pageToken` (*type:* `String.t`) - The continuation token, which is used to page through large datasets.
To get the next page of a dataset, set this parameter to the value of
<code>nextPageToken</code> from the previous response. Each subsequent
call will yield a partial dataset with data point end timestamps that are
strictly smaller than those in the previous partial response.
* `opts` (*type:* `keyword()`) - Call options
## Returns
* `{:ok, %GoogleApi.Fitness.V1.Model.Dataset{}}` on success
* `{:error, info}` on failure
"""
@spec fitness_users_data_sources_datasets_get(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) ::
{:ok, GoogleApi.Fitness.V1.Model.Dataset.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
def fitness_users_data_sources_datasets_get(
connection,
user_id,
data_source_id,
dataset_id,
optional_params \\ [],
opts \\ []
) do
optional_params_config = %{
:"$.xgafv" => :query,
:access_token => :query,
:alt => :query,
:callback => :query,
:fields => :query,
:key => :query,
:oauth_token => :query,
:prettyPrint => :query,
:quotaUser => :query,
:uploadType => :query,
:upload_protocol => :query,
:limit => :query,
:pageToken => :query
}
request =
Request.new()
|> Request.method(:get)
|> Request.url(
"/fitness/v1/users/{userId}/dataSources/{dataSourceId}/datasets/{datasetId}",
%{
"userId" => URI.encode(user_id, &URI.char_unreserved?/1),
"dataSourceId" => URI.encode(data_source_id, &URI.char_unreserved?/1),
"datasetId" => URI.encode(dataset_id, &URI.char_unreserved?/1)
}
)
|> Request.add_optional_params(optional_params_config, optional_params)
|> Request.library_version(@library_version)
connection
|> Connection.execute(request)
|> Response.decode(opts ++ [struct: %GoogleApi.Fitness.V1.Model.Dataset{}])
end
@doc """
Adds data points to a dataset. The dataset need not be previously created.
All points within the given dataset will be returned with subsquent calls
to retrieve this dataset. Data points can belong to more than one dataset.
This method does not use patch semantics.
## Parameters
* `connection` (*type:* `GoogleApi.Fitness.V1.Connection.t`) - Connection to server
* `user_id` (*type:* `String.t`) - Patch a dataset for the person identified. Use <code>me</code> to indicate
the authenticated user. Only <code>me</code> is supported at this time.
* `data_source_id` (*type:* `String.t`) - The data stream ID of the data source that created the dataset.
* `dataset_id` (*type:* `String.t`) - Dataset identifier that is a composite of the minimum data point start time
and maximum data point end time represented as nanoseconds from the epoch.
The ID is formatted like: "<var>startTime</var>-<var>endTime</var>"
where <var>startTime</var> and <var>endTime</var> are 64 bit integers.
* `optional_params` (*type:* `keyword()`) - Optional parameters
* `:"$.xgafv"` (*type:* `String.t`) - V1 error format.
* `:access_token` (*type:* `String.t`) - OAuth access token.
* `:alt` (*type:* `String.t`) - Data format for response.
* `:callback` (*type:* `String.t`) - JSONP
* `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response.
* `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
* `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user.
* `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks.
* `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
* `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart").
* `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart").
* `:currentTimeMillis` (*type:* `String.t`) - The client's current time in milliseconds since epoch. Note that the
<code>minStartTimeNs</code> and <code>maxEndTimeNs</code> properties in
the request body are in nanoseconds instead of milliseconds.
* `:body` (*type:* `GoogleApi.Fitness.V1.Model.Dataset.t`) -
* `opts` (*type:* `keyword()`) - Call options
## Returns
* `{:ok, %GoogleApi.Fitness.V1.Model.Dataset{}}` on success
* `{:error, info}` on failure
"""
@spec fitness_users_data_sources_datasets_patch(
Tesla.Env.client(),
String.t(),
String.t(),
String.t(),
keyword(),
keyword()
) ::
{:ok, GoogleApi.Fitness.V1.Model.Dataset.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
def fitness_users_data_sources_datasets_patch(
connection,
user_id,
data_source_id,
dataset_id,
optional_params \\ [],
opts \\ []
) do
optional_params_config = %{
:"$.xgafv" => :query,
:access_token => :query,
:alt => :query,
:callback => :query,
:fields => :query,
:key => :query,
:oauth_token => :query,
:prettyPrint => :query,
:quotaUser => :query,
:uploadType => :query,
:upload_protocol => :query,
:currentTimeMillis => :query,
:body => :body
}
request =
Request.new()
|> Request.method(:patch)
|> Request.url(
"/fitness/v1/users/{userId}/dataSources/{dataSourceId}/datasets/{datasetId}",
%{
"userId" => URI.encode(user_id, &URI.char_unreserved?/1),
"dataSourceId" => URI.encode(data_source_id, &URI.char_unreserved?/1),
"datasetId" => URI.encode(dataset_id, &URI.char_unreserved?/1)
}
)
|> Request.add_optional_params(optional_params_config, optional_params)
|> Request.library_version(@library_version)
connection
|> Connection.execute(request)
|> Response.decode(opts ++ [struct: %GoogleApi.Fitness.V1.Model.Dataset{}])
end
@doc """
Aggregates data of a certain type or stream into buckets divided by a given
type of boundary. Multiple data sets of multiple types and from multiple
sources can be aggregated into exactly one bucket type per request.
## Parameters
* `connection` (*type:* `GoogleApi.Fitness.V1.Connection.t`) - Connection to server
* `user_id` (*type:* `String.t`) - Aggregate data for the person identified. Use <code>me</code> to indicate
the authenticated user. Only <code>me</code> is supported at this time.
* `optional_params` (*type:* `keyword()`) - Optional parameters
* `:"$.xgafv"` (*type:* `String.t`) - V1 error format.
* `:access_token` (*type:* `String.t`) - OAuth access token.
* `:alt` (*type:* `String.t`) - Data format for response.
* `:callback` (*type:* `String.t`) - JSONP
* `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response.
* `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
* `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user.
* `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks.
* `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
* `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart").
* `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart").
* `:body` (*type:* `GoogleApi.Fitness.V1.Model.AggregateRequest.t`) -
* `opts` (*type:* `keyword()`) - Call options
## Returns
* `{:ok, %GoogleApi.Fitness.V1.Model.AggregateResponse{}}` on success
* `{:error, info}` on failure
"""
@spec fitness_users_dataset_aggregate(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
{:ok, GoogleApi.Fitness.V1.Model.AggregateResponse.t()}
| {:ok, Tesla.Env.t()}
| {:error, any()}
def fitness_users_dataset_aggregate(connection, user_id, optional_params \\ [], opts \\ []) do
optional_params_config = %{
:"$.xgafv" => :query,
:access_token => :query,
:alt => :query,
:callback => :query,
:fields => :query,
:key => :query,
:oauth_token => :query,
:prettyPrint => :query,
:quotaUser => :query,
:uploadType => :query,
:upload_protocol => :query,
:body => :body
}
request =
Request.new()
|> Request.method(:post)
|> Request.url("/fitness/v1/users/{userId}/dataset:aggregate", %{
"userId" => URI.encode(user_id, &URI.char_unreserved?/1)
})
|> Request.add_optional_params(optional_params_config, optional_params)
|> Request.library_version(@library_version)
connection
|> Connection.execute(request)
|> Response.decode(opts ++ [struct: %GoogleApi.Fitness.V1.Model.AggregateResponse{}])
end
@doc """
Deletes a session specified by the given session ID.
## Parameters
* `connection` (*type:* `GoogleApi.Fitness.V1.Connection.t`) - Connection to server
* `user_id` (*type:* `String.t`) - Delete a session for the person identified. Use <code>me</code> to indicate
the authenticated user. Only <code>me</code> is supported at this time.
* `session_id` (*type:* `String.t`) - The ID of the session to be deleted.
* `optional_params` (*type:* `keyword()`) - Optional parameters
* `:"$.xgafv"` (*type:* `String.t`) - V1 error format.
* `:access_token` (*type:* `String.t`) - OAuth access token.
* `:alt` (*type:* `String.t`) - Data format for response.
* `:callback` (*type:* `String.t`) - JSONP
* `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response.
* `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
* `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user.
* `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks.
* `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
* `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart").
* `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart").
* `:currentTimeMillis` (*type:* `String.t`) - The client's current time in milliseconds since epoch.
* `opts` (*type:* `keyword()`) - Call options
## Returns
* `{:ok, %{}}` on success
* `{:error, info}` on failure
"""
@spec fitness_users_sessions_delete(
Tesla.Env.client(),
String.t(),
String.t(),
keyword(),
keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}
def fitness_users_sessions_delete(
connection,
user_id,
session_id,
optional_params \\ [],
opts \\ []
) do
optional_params_config = %{
:"$.xgafv" => :query,
:access_token => :query,
:alt => :query,
:callback => :query,
:fields => :query,
:key => :query,
:oauth_token => :query,
:prettyPrint => :query,
:quotaUser => :query,
:uploadType => :query,
:upload_protocol => :query,
:currentTimeMillis => :query
}
request =
Request.new()
|> Request.method(:delete)
|> Request.url("/fitness/v1/users/{userId}/sessions/{sessionId}", %{
"userId" => URI.encode(user_id, &URI.char_unreserved?/1),
"sessionId" => URI.encode(session_id, &URI.char_unreserved?/1)
})
|> Request.add_optional_params(optional_params_config, optional_params)
|> Request.library_version(@library_version)
connection
|> Connection.execute(request)
|> Response.decode(opts ++ [decode: false])
end
@doc """
Lists sessions previously created.
## Parameters
* `connection` (*type:* `GoogleApi.Fitness.V1.Connection.t`) - Connection to server
* `user_id` (*type:* `String.t`) - List sessions for the person identified. Use <code>me</code> to indicate
the authenticated user. Only <code>me</code> is supported at this time.
* `optional_params` (*type:* `keyword()`) - Optional parameters
* `:"$.xgafv"` (*type:* `String.t`) - V1 error format.
* `:access_token` (*type:* `String.t`) - OAuth access token.
* `:alt` (*type:* `String.t`) - Data format for response.
* `:callback` (*type:* `String.t`) - JSONP
* `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response.
* `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
* `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user.
* `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks.
* `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
* `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart").
* `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart").
* `:activityType` (*type:* `list(integer())`) - If non-empty, only sessions with these activity types should be returned.
* `:endTime` (*type:* `String.t`) - An <a href="https://www.ietf.org/rfc/rfc3339.txt">RFC3339</a> timestamp.
Only sessions ending between the start and end times will be included in
the response. If this time is omitted but <var>startTime</var> is
specified, all sessions from <var>startTime</var> to the end of time will
be returned.
* `:includeDeleted` (*type:* `boolean()`) - If true, and if both <var>startTime</var> and <var>endTime</var> are
omitted, session deletions will be returned.
* `:pageToken` (*type:* `String.t`) - The continuation token, which is used for incremental syncing.
To get the next batch of changes, set this parameter to the value of
<code>nextPageToken</code> from the previous response. The page token is
ignored if either start or end time is specified. If none of start time,
end time, and the page token is specified, sessions modified in the last
30 days are returned.
* `:startTime` (*type:* `String.t`) - An <a href="https://www.ietf.org/rfc/rfc3339.txt">RFC3339</a> timestamp.
Only sessions ending between the start and end times will be included in
the response. If this time is omitted but <var>endTime</var> is specified,
all sessions from the start of time up to <var>endTime</var> will be
returned.
* `opts` (*type:* `keyword()`) - Call options
## Returns
* `{:ok, %GoogleApi.Fitness.V1.Model.ListSessionsResponse{}}` on success
* `{:error, info}` on failure
"""
@spec fitness_users_sessions_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
{:ok, GoogleApi.Fitness.V1.Model.ListSessionsResponse.t()}
| {:ok, Tesla.Env.t()}
| {:error, any()}
def fitness_users_sessions_list(connection, user_id, optional_params \\ [], opts \\ []) do
optional_params_config = %{
:"$.xgafv" => :query,
:access_token => :query,
:alt => :query,
:callback => :query,
:fields => :query,
:key => :query,
:oauth_token => :query,
:prettyPrint => :query,
:quotaUser => :query,
:uploadType => :query,
:upload_protocol => :query,
:activityType => :query,
:endTime => :query,
:includeDeleted => :query,
:pageToken => :query,
:startTime => :query
}
request =
Request.new()
|> Request.method(:get)
|> Request.url("/fitness/v1/users/{userId}/sessions", %{
"userId" => URI.encode(user_id, &URI.char_unreserved?/1)
})
|> Request.add_optional_params(optional_params_config, optional_params)
|> Request.library_version(@library_version)
connection
|> Connection.execute(request)
|> Response.decode(opts ++ [struct: %GoogleApi.Fitness.V1.Model.ListSessionsResponse{}])
end
@doc """
Updates or insert a given session.
## Parameters
* `connection` (*type:* `GoogleApi.Fitness.V1.Connection.t`) - Connection to server
* `user_id` (*type:* `String.t`) - Create sessions for the person identified. Use <code>me</code> to indicate
the authenticated user. Only <code>me</code> is supported at this time.
* `session_id` (*type:* `String.t`) - The ID of the session to be created.
* `optional_params` (*type:* `keyword()`) - Optional parameters
* `:"$.xgafv"` (*type:* `String.t`) - V1 error format.
* `:access_token` (*type:* `String.t`) - OAuth access token.
* `:alt` (*type:* `String.t`) - Data format for response.
* `:callback` (*type:* `String.t`) - JSONP
* `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response.
* `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
* `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user.
* `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks.
* `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
* `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart").
* `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart").
* `:currentTimeMillis` (*type:* `String.t`) - The client's current time in milliseconds since epoch.
* `:body` (*type:* `GoogleApi.Fitness.V1.Model.Session.t`) -
* `opts` (*type:* `keyword()`) - Call options
## Returns
* `{:ok, %GoogleApi.Fitness.V1.Model.Session{}}` on success
* `{:error, info}` on failure
"""
@spec fitness_users_sessions_update(
Tesla.Env.client(),
String.t(),
String.t(),
keyword(),
keyword()
) ::
{:ok, GoogleApi.Fitness.V1.Model.Session.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
def fitness_users_sessions_update(
connection,
user_id,
session_id,
optional_params \\ [],
opts \\ []
) do
optional_params_config = %{
:"$.xgafv" => :query,
:access_token => :query,
:alt => :query,
:callback => :query,
:fields => :query,
:key => :query,
:oauth_token => :query,
:prettyPrint => :query,
:quotaUser => :query,
:uploadType => :query,
:upload_protocol => :query,
:currentTimeMillis => :query,
:body => :body
}
request =
Request.new()
|> Request.method(:put)
|> Request.url("/fitness/v1/users/{userId}/sessions/{sessionId}", %{
"userId" => URI.encode(user_id, &URI.char_unreserved?/1),
"sessionId" => URI.encode(session_id, &URI.char_unreserved?/1)
})
|> Request.add_optional_params(optional_params_config, optional_params)
|> Request.library_version(@library_version)
connection
|> Connection.execute(request)
|> Response.decode(opts ++ [struct: %GoogleApi.Fitness.V1.Model.Session{}])
end
end