google_api_mirror

v0.5.0

google_api_mirror v0.5.0 GoogleApi.Mirror.V1.Api.Locations View Source

API calls for all endpoints tagged Locations.

Link to this section Summary

Functions

mirror_locations_get(connection, id, optional_params \\ [], opts \\ [])

Gets a single location by ID.

mirror_locations_list(connection, optional_params \\ [], opts \\ [])

Retrieves a list of locations for the user.

Link to this section Functions

Link to this function

mirror_locations_get(connection, id, optional_params \\ [], opts \\ [])

View Source 
mirror_locations_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Mirror.V1.Model.Location.t()} | {:error, Tesla.Env.t()}

Gets a single location by ID.

Parameters

  • connection (type: GoogleApi.Mirror.V1.Connection.t) - Connection to server
  • id (type: String.t) - The ID of the location or latest for the last known location.

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Mirror.V1.Model.Location{}} on success
  • {:error, info} on failure
Link to this function

mirror_locations_list(connection, optional_params \\ [], opts \\ [])

View Source 
mirror_locations_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Mirror.V1.Model.LocationsListResponse.t()}
  | {:error, Tesla.Env.t()}

Retrieves a list of locations for the user.

Parameters

  • connection (type: GoogleApi.Mirror.V1.Connection.t) - Connection to server

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Mirror.V1.Model.LocationsListResponse{}} on success
  • {:error, info} on failure