GoogleApi.WalletObjects.V1.Api.Media (google_api_wallet_objects v0.12.0)

API calls for all endpoints tagged Media.

Summary

Functions

walletobjects_media_download(connection, resource_id, optional_params \\ [], opts \\ [])

Downloads rotating barcode values for the transit object referenced by the given object ID.

walletobjects_media_upload(connection, resource_id, optional_params \\ [], opts \\ [])

Uploads rotating barcode values for the transit object referenced by the given object ID. Note the max upload size is specified in google3/production/config/cdd/apps-upload/customers/payments-consumer-passes/config.gcl and enforced by Scotty.

walletobjects_media_upload_iodata(connection, resource_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

walletobjects_media_upload_simple(connection, resource_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

Functions

walletobjects_media_download(connection, resource_id, optional_params \\ [], opts \\ [])

@spec walletobjects_media_download(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WalletObjects.V1.Model.Media.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Downloads rotating barcode values for the transit object referenced by the given object ID.

Parameters

connection (type: GoogleApi.WalletObjects.V1.Connection.t) - Connection to server
resource_id (type: String.t) - The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
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.WalletObjects.V1.Model.Media{}} on success
{:error, info} on failure

walletobjects_media_upload(connection, resource_id, optional_params \\ [], opts \\ [])

@spec walletobjects_media_upload(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok,
   GoogleApi.WalletObjects.V1.Model.TransitObjectUploadRotatingBarcodeValuesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.WalletObjects.V1.Connection.t) - Connection to server
resource_id (type: String.t) - The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
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.WalletObjects.V1.Model.TransitObjectUploadRotatingBarcodeValuesRequest.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.WalletObjects.V1.Model.TransitObjectUploadRotatingBarcodeValuesResponse{}} on success
{:error, info} on failure

walletobjects_media_upload_iodata(connection, resource_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

@spec walletobjects_media_upload_iodata(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  GoogleApi.WalletObjects.V1.Model.TransitObjectUploadRotatingBarcodeValuesRequest.t(),
  iodata(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.WalletObjects.V1.Model.TransitObjectUploadRotatingBarcodeValuesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.WalletObjects.V1.Connection.t) - Connection to server
resource_id (type: String.t) - The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
upload_type (type: String.t) - Upload type. Must be "multipart".
metadata (type: GoogleApi.WalletObjects.V1.Model.TransitObjectUploadRotatingBarcodeValuesRequest.t) - object metadata
data (type: iodata) - Content to upload, as a string or iolist
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.WalletObjects.V1.Model.TransitObjectUploadRotatingBarcodeValuesResponse{}} on success
{:error, info} on failure

walletobjects_media_upload_simple(connection, resource_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

@spec walletobjects_media_upload_simple(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  GoogleApi.WalletObjects.V1.Model.TransitObjectUploadRotatingBarcodeValuesRequest.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.WalletObjects.V1.Model.TransitObjectUploadRotatingBarcodeValuesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.WalletObjects.V1.Connection.t) - Connection to server
resource_id (type: String.t) - The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.
upload_type (type: String.t) - Upload type. Must be "multipart".
metadata (type: GoogleApi.WalletObjects.V1.Model.TransitObjectUploadRotatingBarcodeValuesRequest.t) - object metadata
data (type: String.t) - Path to file containing content to upload
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.WalletObjects.V1.Model.TransitObjectUploadRotatingBarcodeValuesResponse{}} on success
{:error, info} on failure