# Copyright 2017 Google Inc. # # 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 class is auto generated by the swagger code generator program. # https://github.com/swagger-api/swagger-codegen.git # Do not edit the class manually. defmodule GoogleApi.Reseller.V1.Api.Subscriptions do @moduledoc """ API calls for all endpoints tagged `Subscriptions`. """ alias GoogleApi.Reseller.V1.Connection alias GoogleApi.Gax.{Request, Response} @doc """ Activates a subscription previously suspended by the reseller ## Parameters - connection (GoogleApi.Reseller.V1.Connection): Connection to server - customer_id (String.t): Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. - subscription_id (String.t): This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. - optional_params (KeywordList): [optional] Optional parameters - :alt (String.t): Data format for the response. - :fields (String.t): Selector specifying which fields to include in a partial response. - :key (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 (String.t): OAuth 2.0 token for the current user. - :prettyPrint (boolean()): Returns response with indentations and line breaks. - :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - :userIp (String.t): Deprecated. Please use quotaUser instead. ## Returns {:ok, %GoogleApi.Reseller.V1.Model.Subscription{}} on success {:error, info} on failure """ @spec reseller_subscriptions_activate(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, GoogleApi.Reseller.V1.Model.Subscription.t()} | {:error, Tesla.Env.t()} def reseller_subscriptions_activate( connection, customer_id, subscription_id, optional_params \\ [], opts \\ [] ) do optional_params_config = %{ :alt => :query, :fields => :query, :key => :query, :oauth_token => :query, :prettyPrint => :query, :quotaUser => :query, :userIp => :query } request = Request.new() |> Request.method(:post) |> Request.url("/customers/{customerId}/subscriptions/{subscriptionId}/activate", %{ "customerId" => URI.encode_www_form(customer_id), "subscriptionId" => URI.encode_www_form(subscription_id) }) |> Request.add_optional_params(optional_params_config, optional_params) connection |> Connection.execute(request) |> Response.decode(opts ++ [struct: %GoogleApi.Reseller.V1.Model.Subscription{}]) end @doc """ Update a subscription plan. Use this method to update a plan for a 30-day trial or a flexible plan subscription to an annual commitment plan with monthly or yearly payments. ## Parameters - connection (GoogleApi.Reseller.V1.Connection): Connection to server - customer_id (String.t): Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. - subscription_id (String.t): This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. - optional_params (KeywordList): [optional] Optional parameters - :alt (String.t): Data format for the response. - :fields (String.t): Selector specifying which fields to include in a partial response. - :key (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 (String.t): OAuth 2.0 token for the current user. - :prettyPrint (boolean()): Returns response with indentations and line breaks. - :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - :userIp (String.t): Deprecated. Please use quotaUser instead. - :body (ChangePlanRequest): ## Returns {:ok, %GoogleApi.Reseller.V1.Model.Subscription{}} on success {:error, info} on failure """ @spec reseller_subscriptions_change_plan(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, GoogleApi.Reseller.V1.Model.Subscription.t()} | {:error, Tesla.Env.t()} def reseller_subscriptions_change_plan( connection, customer_id, subscription_id, optional_params \\ [], opts \\ [] ) do optional_params_config = %{ :alt => :query, :fields => :query, :key => :query, :oauth_token => :query, :prettyPrint => :query, :quotaUser => :query, :userIp => :query, :body => :body } request = Request.new() |> Request.method(:post) |> Request.url("/customers/{customerId}/subscriptions/{subscriptionId}/changePlan", %{ "customerId" => URI.encode_www_form(customer_id), "subscriptionId" => URI.encode_www_form(subscription_id) }) |> Request.add_optional_params(optional_params_config, optional_params) connection |> Connection.execute(request) |> Response.decode(opts ++ [struct: %GoogleApi.Reseller.V1.Model.Subscription{}]) end @doc """ Update a user license's renewal settings. This is applicable for accounts with annual commitment plans only. ## Parameters - connection (GoogleApi.Reseller.V1.Connection): Connection to server - customer_id (String.t): Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. - subscription_id (String.t): This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. - optional_params (KeywordList): [optional] Optional parameters - :alt (String.t): Data format for the response. - :fields (String.t): Selector specifying which fields to include in a partial response. - :key (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 (String.t): OAuth 2.0 token for the current user. - :prettyPrint (boolean()): Returns response with indentations and line breaks. - :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - :userIp (String.t): Deprecated. Please use quotaUser instead. - :body (RenewalSettings): ## Returns {:ok, %GoogleApi.Reseller.V1.Model.Subscription{}} on success {:error, info} on failure """ @spec reseller_subscriptions_change_renewal_settings( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.Reseller.V1.Model.Subscription.t()} | {:error, Tesla.Env.t()} def reseller_subscriptions_change_renewal_settings( connection, customer_id, subscription_id, optional_params \\ [], opts \\ [] ) do optional_params_config = %{ :alt => :query, :fields => :query, :key => :query, :oauth_token => :query, :prettyPrint => :query, :quotaUser => :query, :userIp => :query, :body => :body } request = Request.new() |> Request.method(:post) |> Request.url( "/customers/{customerId}/subscriptions/{subscriptionId}/changeRenewalSettings", %{ "customerId" => URI.encode_www_form(customer_id), "subscriptionId" => URI.encode_www_form(subscription_id) } ) |> Request.add_optional_params(optional_params_config, optional_params) connection |> Connection.execute(request) |> Response.decode(opts ++ [struct: %GoogleApi.Reseller.V1.Model.Subscription{}]) end @doc """ Update a subscription's user license settings. ## Parameters - connection (GoogleApi.Reseller.V1.Connection): Connection to server - customer_id (String.t): Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. - subscription_id (String.t): This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. - optional_params (KeywordList): [optional] Optional parameters - :alt (String.t): Data format for the response. - :fields (String.t): Selector specifying which fields to include in a partial response. - :key (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 (String.t): OAuth 2.0 token for the current user. - :prettyPrint (boolean()): Returns response with indentations and line breaks. - :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - :userIp (String.t): Deprecated. Please use quotaUser instead. - :body (Seats): ## Returns {:ok, %GoogleApi.Reseller.V1.Model.Subscription{}} on success {:error, info} on failure """ @spec reseller_subscriptions_change_seats(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, GoogleApi.Reseller.V1.Model.Subscription.t()} | {:error, Tesla.Env.t()} def reseller_subscriptions_change_seats( connection, customer_id, subscription_id, optional_params \\ [], opts \\ [] ) do optional_params_config = %{ :alt => :query, :fields => :query, :key => :query, :oauth_token => :query, :prettyPrint => :query, :quotaUser => :query, :userIp => :query, :body => :body } request = Request.new() |> Request.method(:post) |> Request.url("/customers/{customerId}/subscriptions/{subscriptionId}/changeSeats", %{ "customerId" => URI.encode_www_form(customer_id), "subscriptionId" => URI.encode_www_form(subscription_id) }) |> Request.add_optional_params(optional_params_config, optional_params) connection |> Connection.execute(request) |> Response.decode(opts ++ [struct: %GoogleApi.Reseller.V1.Model.Subscription{}]) end @doc """ Cancel or transfer a subscription to direct. ## Parameters - connection (GoogleApi.Reseller.V1.Connection): Connection to server - customer_id (String.t): Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. - subscription_id (String.t): This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. - deletion_type (String.t): The deletionType query string enables the cancellation, downgrade, or suspension of a subscription. - optional_params (KeywordList): [optional] Optional parameters - :alt (String.t): Data format for the response. - :fields (String.t): Selector specifying which fields to include in a partial response. - :key (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 (String.t): OAuth 2.0 token for the current user. - :prettyPrint (boolean()): Returns response with indentations and line breaks. - :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - :userIp (String.t): Deprecated. Please use quotaUser instead. ## Returns {:ok, %{}} on success {:error, info} on failure """ @spec reseller_subscriptions_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()} def reseller_subscriptions_delete( connection, customer_id, subscription_id, deletion_type, optional_params \\ [], opts \\ [] ) do optional_params_config = %{ :alt => :query, :fields => :query, :key => :query, :oauth_token => :query, :prettyPrint => :query, :quotaUser => :query, :userIp => :query } request = Request.new() |> Request.method(:delete) |> Request.url("/customers/{customerId}/subscriptions/{subscriptionId}", %{ "customerId" => URI.encode_www_form(customer_id), "subscriptionId" => URI.encode_www_form(subscription_id) }) |> Request.add_param(:query, :deletionType, deletion_type) |> Request.add_optional_params(optional_params_config, optional_params) connection |> Connection.execute(request) |> Response.decode(opts ++ [decode: false]) end @doc """ Get a specific subscription. ## Parameters - connection (GoogleApi.Reseller.V1.Connection): Connection to server - customer_id (String.t): Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. - subscription_id (String.t): This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. - optional_params (KeywordList): [optional] Optional parameters - :alt (String.t): Data format for the response. - :fields (String.t): Selector specifying which fields to include in a partial response. - :key (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 (String.t): OAuth 2.0 token for the current user. - :prettyPrint (boolean()): Returns response with indentations and line breaks. - :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - :userIp (String.t): Deprecated. Please use quotaUser instead. ## Returns {:ok, %GoogleApi.Reseller.V1.Model.Subscription{}} on success {:error, info} on failure """ @spec reseller_subscriptions_get(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, GoogleApi.Reseller.V1.Model.Subscription.t()} | {:error, Tesla.Env.t()} def reseller_subscriptions_get( connection, customer_id, subscription_id, optional_params \\ [], opts \\ [] ) do optional_params_config = %{ :alt => :query, :fields => :query, :key => :query, :oauth_token => :query, :prettyPrint => :query, :quotaUser => :query, :userIp => :query } request = Request.new() |> Request.method(:get) |> Request.url("/customers/{customerId}/subscriptions/{subscriptionId}", %{ "customerId" => URI.encode_www_form(customer_id), "subscriptionId" => URI.encode_www_form(subscription_id) }) |> Request.add_optional_params(optional_params_config, optional_params) connection |> Connection.execute(request) |> Response.decode(opts ++ [struct: %GoogleApi.Reseller.V1.Model.Subscription{}]) end @doc """ Create or transfer a subscription. ## Parameters - connection (GoogleApi.Reseller.V1.Connection): Connection to server - customer_id (String.t): Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. - optional_params (KeywordList): [optional] Optional parameters - :alt (String.t): Data format for the response. - :fields (String.t): Selector specifying which fields to include in a partial response. - :key (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 (String.t): OAuth 2.0 token for the current user. - :prettyPrint (boolean()): Returns response with indentations and line breaks. - :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - :userIp (String.t): Deprecated. Please use quotaUser instead. - :customerAuthToken (String.t): The customerAuthToken query string is required when creating a resold account that transfers a direct customer's subscription or transfers another reseller customer's subscription to your reseller management. This is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the administrator help center. - :body (Subscription): ## Returns {:ok, %GoogleApi.Reseller.V1.Model.Subscription{}} on success {:error, info} on failure """ @spec reseller_subscriptions_insert(Tesla.Env.client(), String.t(), keyword()) :: {:ok, GoogleApi.Reseller.V1.Model.Subscription.t()} | {:error, Tesla.Env.t()} def reseller_subscriptions_insert(connection, customer_id, optional_params \\ [], opts \\ []) do optional_params_config = %{ :alt => :query, :fields => :query, :key => :query, :oauth_token => :query, :prettyPrint => :query, :quotaUser => :query, :userIp => :query, :customerAuthToken => :query, :body => :body } request = Request.new() |> Request.method(:post) |> Request.url("/customers/{customerId}/subscriptions", %{ "customerId" => URI.encode_www_form(customer_id) }) |> Request.add_optional_params(optional_params_config, optional_params) connection |> Connection.execute(request) |> Response.decode(opts ++ [struct: %GoogleApi.Reseller.V1.Model.Subscription{}]) end @doc """ List of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions. ## Parameters - connection (GoogleApi.Reseller.V1.Connection): Connection to server - optional_params (KeywordList): [optional] Optional parameters - :alt (String.t): Data format for the response. - :fields (String.t): Selector specifying which fields to include in a partial response. - :key (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 (String.t): OAuth 2.0 token for the current user. - :prettyPrint (boolean()): Returns response with indentations and line breaks. - :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - :userIp (String.t): Deprecated. Please use quotaUser instead. - :customerAuthToken (String.t): The customerAuthToken query string is required when creating a resold account that transfers a direct customer's subscription or transfers another reseller customer's subscription to your reseller management. This is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the administrator help center. - :customerId (String.t): Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. - :customerNamePrefix (String.t): When retrieving all of your subscriptions and filtering for specific customers, you can enter a prefix for a customer name. Using an example customer group that includes exam.com, example20.com and example.com: - exa -- Returns all customer names that start with 'exa' which could include exam.com, example20.com, and example.com. A name prefix is similar to using a regular expression's asterisk, exa*. - example -- Returns example20.com and example.com. - :maxResults (integer()): When retrieving a large list, the maxResults is the maximum number of results per page. The nextPageToken value takes you to the next page. The default is 20. - :pageToken (String.t): Token to specify next page in the list ## Returns {:ok, %GoogleApi.Reseller.V1.Model.Subscriptions{}} on success {:error, info} on failure """ @spec reseller_subscriptions_list(Tesla.Env.client(), keyword()) :: {:ok, GoogleApi.Reseller.V1.Model.Subscriptions.t()} | {:error, Tesla.Env.t()} def reseller_subscriptions_list(connection, optional_params \\ [], opts \\ []) do optional_params_config = %{ :alt => :query, :fields => :query, :key => :query, :oauth_token => :query, :prettyPrint => :query, :quotaUser => :query, :userIp => :query, :customerAuthToken => :query, :customerId => :query, :customerNamePrefix => :query, :maxResults => :query, :pageToken => :query } request = Request.new() |> Request.method(:get) |> Request.url("/subscriptions") |> Request.add_optional_params(optional_params_config, optional_params) connection |> Connection.execute(request) |> Response.decode(opts ++ [struct: %GoogleApi.Reseller.V1.Model.Subscriptions{}]) end @doc """ Immediately move a 30-day free trial subscription to a paid service subscription. ## Parameters - connection (GoogleApi.Reseller.V1.Connection): Connection to server - customer_id (String.t): Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. - subscription_id (String.t): This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. - optional_params (KeywordList): [optional] Optional parameters - :alt (String.t): Data format for the response. - :fields (String.t): Selector specifying which fields to include in a partial response. - :key (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 (String.t): OAuth 2.0 token for the current user. - :prettyPrint (boolean()): Returns response with indentations and line breaks. - :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - :userIp (String.t): Deprecated. Please use quotaUser instead. ## Returns {:ok, %GoogleApi.Reseller.V1.Model.Subscription{}} on success {:error, info} on failure """ @spec reseller_subscriptions_start_paid_service( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.Reseller.V1.Model.Subscription.t()} | {:error, Tesla.Env.t()} def reseller_subscriptions_start_paid_service( connection, customer_id, subscription_id, optional_params \\ [], opts \\ [] ) do optional_params_config = %{ :alt => :query, :fields => :query, :key => :query, :oauth_token => :query, :prettyPrint => :query, :quotaUser => :query, :userIp => :query } request = Request.new() |> Request.method(:post) |> Request.url("/customers/{customerId}/subscriptions/{subscriptionId}/startPaidService", %{ "customerId" => URI.encode_www_form(customer_id), "subscriptionId" => URI.encode_www_form(subscription_id) }) |> Request.add_optional_params(optional_params_config, optional_params) connection |> Connection.execute(request) |> Response.decode(opts ++ [struct: %GoogleApi.Reseller.V1.Model.Subscription{}]) end @doc """ Suspends an active subscription. ## Parameters - connection (GoogleApi.Reseller.V1.Connection): Connection to server - customer_id (String.t): Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates. - subscription_id (String.t): This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method. - optional_params (KeywordList): [optional] Optional parameters - :alt (String.t): Data format for the response. - :fields (String.t): Selector specifying which fields to include in a partial response. - :key (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 (String.t): OAuth 2.0 token for the current user. - :prettyPrint (boolean()): Returns response with indentations and line breaks. - :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - :userIp (String.t): Deprecated. Please use quotaUser instead. ## Returns {:ok, %GoogleApi.Reseller.V1.Model.Subscription{}} on success {:error, info} on failure """ @spec reseller_subscriptions_suspend(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, GoogleApi.Reseller.V1.Model.Subscription.t()} | {:error, Tesla.Env.t()} def reseller_subscriptions_suspend( connection, customer_id, subscription_id, optional_params \\ [], opts \\ [] ) do optional_params_config = %{ :alt => :query, :fields => :query, :key => :query, :oauth_token => :query, :prettyPrint => :query, :quotaUser => :query, :userIp => :query } request = Request.new() |> Request.method(:post) |> Request.url("/customers/{customerId}/subscriptions/{subscriptionId}/suspend", %{ "customerId" => URI.encode_www_form(customer_id), "subscriptionId" => URI.encode_www_form(subscription_id) }) |> Request.add_optional_params(optional_params_config, optional_params) connection |> Connection.execute(request) |> Response.decode(opts ++ [struct: %GoogleApi.Reseller.V1.Model.Subscription{}]) end end