google_api_mirror v0.7.0 GoogleApi.Mirror.V1.Api.Subscriptions View Source
API calls for all endpoints tagged Subscriptions
.
Link to this section Summary
Functions
Deletes a subscription.
Creates a new subscription.
Retrieves a list of subscriptions for the authenticated user and service.
Updates an existing subscription in place.
Link to this section Functions
Link to this function
mirror_subscriptions_delete(connection, id, optional_params \\ [], opts \\ [])
View Sourcemirror_subscriptions_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes a subscription.
Parameters
connection
(type:GoogleApi.Mirror.V1.Connection.t
) - Connection to serverid
(type:String.t
) - The ID of the subscription.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, %{}}
on success{:error, info}
on failure
Link to this function
mirror_subscriptions_insert(connection, optional_params \\ [], opts \\ [])
View Sourcemirror_subscriptions_insert(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Mirror.V1.Model.Subscription.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Creates a new subscription.
Parameters
connection
(type:GoogleApi.Mirror.V1.Connection.t
) - Connection to serveroptional_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.:body
(type:GoogleApi.Mirror.V1.Model.Subscription.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Mirror.V1.Model.Subscription{}}
on success{:error, info}
on failure
Link to this function
mirror_subscriptions_list(connection, optional_params \\ [], opts \\ [])
View Sourcemirror_subscriptions_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Mirror.V1.Model.SubscriptionsListResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Retrieves a list of subscriptions for the authenticated user and service.
Parameters
connection
(type:GoogleApi.Mirror.V1.Connection.t
) - Connection to serveroptional_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.SubscriptionsListResponse{}}
on success{:error, info}
on failure
Link to this function
mirror_subscriptions_update(connection, id, optional_params \\ [], opts \\ [])
View Sourcemirror_subscriptions_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Mirror.V1.Model.Subscription.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates an existing subscription in place.
Parameters
connection
(type:GoogleApi.Mirror.V1.Connection.t
) - Connection to serverid
(type:String.t
) - The ID of the subscription.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.:body
(type:GoogleApi.Mirror.V1.Model.Subscription.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Mirror.V1.Model.Subscription{}}
on success{:error, info}
on failure