# 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.Content.V2.Api.Accounts do @moduledoc """ API calls for all endpoints tagged `Accounts`. """ alias GoogleApi.Content.V2.Connection import GoogleApi.Content.V2.RequestBuilder @doc """ Returns information about the authenticated user. ## Parameters - connection (GoogleApi.Content.V2.Connection): Connection to server - opts (KeywordList): [optional] Optional parameters - :alt (String): Data format for the response. - :fields (String): Selector specifying which fields to include in a partial response. - :key (String): 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): OAuth 2.0 token for the current user. - :pretty_print (Boolean): Returns response with indentations and line breaks. - :quota_user (String): 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. Overrides userIp if both are provided. - :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits. ## Returns {:ok, %GoogleApi.Content.V2.Model.AccountsAuthInfoResponse{}} on success {:error, info} on failure """ @spec content_accounts_authinfo(Tesla.Env.client, keyword()) :: {:ok, GoogleApi.Content.V2.Model.AccountsAuthInfoResponse.t} | {:error, Tesla.Env.t} def content_accounts_authinfo(connection, opts \\ []) do optional_params = %{ :"alt" => :query, :"fields" => :query, :"key" => :query, :"oauth_token" => :query, :"prettyPrint" => :query, :"quotaUser" => :query, :"userIp" => :query } %{} |> method(:get) |> url("/accounts/authinfo") |> add_optional_params(optional_params, opts) |> Enum.into([]) |> (&Connection.request(connection, &1)).() |> decode(%GoogleApi.Content.V2.Model.AccountsAuthInfoResponse{}) end @doc """ Claims the website of a Merchant Center sub-account. This method can only be called for accounts to which the managing account has access: either the managing account itself for any Merchant Center account, or any sub-account when the managing account is a multi-client account. ## Parameters - connection (GoogleApi.Content.V2.Connection): Connection to server - merchant_id (String): The ID of the managing account. - account_id (String): The ID of the account whose website is claimed. - opts (KeywordList): [optional] Optional parameters - :alt (String): Data format for the response. - :fields (String): Selector specifying which fields to include in a partial response. - :key (String): 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): OAuth 2.0 token for the current user. - :pretty_print (Boolean): Returns response with indentations and line breaks. - :quota_user (String): 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. Overrides userIp if both are provided. - :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits. - :overwrite (Boolean): Only available to selected merchants. When set to True, this flag removes any existing claim on the requested website by another account and replaces it with a claim from this account. ## Returns {:ok, %GoogleApi.Content.V2.Model.AccountsClaimWebsiteResponse{}} on success {:error, info} on failure """ @spec content_accounts_claimwebsite(Tesla.Env.client, String.t, String.t, keyword()) :: {:ok, GoogleApi.Content.V2.Model.AccountsClaimWebsiteResponse.t} | {:error, Tesla.Env.t} def content_accounts_claimwebsite(connection, merchant_id, account_id, opts \\ []) do optional_params = %{ :"alt" => :query, :"fields" => :query, :"key" => :query, :"oauth_token" => :query, :"prettyPrint" => :query, :"quotaUser" => :query, :"userIp" => :query, :"overwrite" => :query } %{} |> method(:post) |> url("/{merchantId}/accounts/{accountId}/claimwebsite", %{ "merchantId" => URI.encode_www_form(merchant_id), "accountId" => URI.encode_www_form(account_id) }) |> add_optional_params(optional_params, opts) |> Enum.into([]) |> (&Connection.request(connection, &1)).() |> decode(%GoogleApi.Content.V2.Model.AccountsClaimWebsiteResponse{}) end @doc """ Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request. ## Parameters - connection (GoogleApi.Content.V2.Connection): Connection to server - opts (KeywordList): [optional] Optional parameters - :alt (String): Data format for the response. - :fields (String): Selector specifying which fields to include in a partial response. - :key (String): 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): OAuth 2.0 token for the current user. - :pretty_print (Boolean): Returns response with indentations and line breaks. - :quota_user (String): 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. Overrides userIp if both are provided. - :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits. - :dry_run (Boolean): Flag to run the request in dry-run mode. - :body (AccountsCustomBatchRequest): ## Returns {:ok, %GoogleApi.Content.V2.Model.AccountsCustomBatchResponse{}} on success {:error, info} on failure """ @spec content_accounts_custombatch(Tesla.Env.client, keyword()) :: {:ok, GoogleApi.Content.V2.Model.AccountsCustomBatchResponse.t} | {:error, Tesla.Env.t} def content_accounts_custombatch(connection, opts \\ []) do optional_params = %{ :"alt" => :query, :"fields" => :query, :"key" => :query, :"oauth_token" => :query, :"prettyPrint" => :query, :"quotaUser" => :query, :"userIp" => :query, :"dryRun" => :query, :"body" => :body } %{} |> method(:post) |> url("/accounts/batch") |> add_optional_params(optional_params, opts) |> Enum.into([]) |> (&Connection.request(connection, &1)).() |> decode(%GoogleApi.Content.V2.Model.AccountsCustomBatchResponse{}) end @doc """ Deletes a Merchant Center sub-account. This method can only be called for multi-client accounts. ## Parameters - connection (GoogleApi.Content.V2.Connection): Connection to server - merchant_id (String): The ID of the managing account. - account_id (String): The ID of the account. - opts (KeywordList): [optional] Optional parameters - :alt (String): Data format for the response. - :fields (String): Selector specifying which fields to include in a partial response. - :key (String): 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): OAuth 2.0 token for the current user. - :pretty_print (Boolean): Returns response with indentations and line breaks. - :quota_user (String): 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. Overrides userIp if both are provided. - :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits. - :dry_run (Boolean): Flag to run the request in dry-run mode. - :force (Boolean): Flag to delete sub-accounts with products. The default value of false will become active on September 28, 2017. ## Returns {:ok, %{}} on success {:error, info} on failure """ @spec content_accounts_delete(Tesla.Env.client, String.t, String.t, keyword()) :: {:ok, nil} | {:error, Tesla.Env.t} def content_accounts_delete(connection, merchant_id, account_id, opts \\ []) do optional_params = %{ :"alt" => :query, :"fields" => :query, :"key" => :query, :"oauth_token" => :query, :"prettyPrint" => :query, :"quotaUser" => :query, :"userIp" => :query, :"dryRun" => :query, :"force" => :query } %{} |> method(:delete) |> url("/{merchantId}/accounts/{accountId}", %{ "merchantId" => URI.encode_www_form(merchant_id), "accountId" => URI.encode_www_form(account_id) }) |> add_optional_params(optional_params, opts) |> Enum.into([]) |> (&Connection.request(connection, &1)).() |> decode(false) end @doc """ Retrieves a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account itself for any Merchant Center account, or any sub-account when the managing account is a multi-client account. ## Parameters - connection (GoogleApi.Content.V2.Connection): Connection to server - merchant_id (String): The ID of the managing account. - account_id (String): The ID of the account. - opts (KeywordList): [optional] Optional parameters - :alt (String): Data format for the response. - :fields (String): Selector specifying which fields to include in a partial response. - :key (String): 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): OAuth 2.0 token for the current user. - :pretty_print (Boolean): Returns response with indentations and line breaks. - :quota_user (String): 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. Overrides userIp if both are provided. - :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits. ## Returns {:ok, %GoogleApi.Content.V2.Model.Account{}} on success {:error, info} on failure """ @spec content_accounts_get(Tesla.Env.client, String.t, String.t, keyword()) :: {:ok, GoogleApi.Content.V2.Model.Account.t} | {:error, Tesla.Env.t} def content_accounts_get(connection, merchant_id, account_id, opts \\ []) do optional_params = %{ :"alt" => :query, :"fields" => :query, :"key" => :query, :"oauth_token" => :query, :"prettyPrint" => :query, :"quotaUser" => :query, :"userIp" => :query } %{} |> method(:get) |> url("/{merchantId}/accounts/{accountId}", %{ "merchantId" => URI.encode_www_form(merchant_id), "accountId" => URI.encode_www_form(account_id) }) |> add_optional_params(optional_params, opts) |> Enum.into([]) |> (&Connection.request(connection, &1)).() |> decode(%GoogleApi.Content.V2.Model.Account{}) end @doc """ Creates a Merchant Center sub-account. This method can only be called for multi-client accounts. ## Parameters - connection (GoogleApi.Content.V2.Connection): Connection to server - merchant_id (String): The ID of the managing account. - opts (KeywordList): [optional] Optional parameters - :alt (String): Data format for the response. - :fields (String): Selector specifying which fields to include in a partial response. - :key (String): 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): OAuth 2.0 token for the current user. - :pretty_print (Boolean): Returns response with indentations and line breaks. - :quota_user (String): 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. Overrides userIp if both are provided. - :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits. - :dry_run (Boolean): Flag to run the request in dry-run mode. - :body (Account): ## Returns {:ok, %GoogleApi.Content.V2.Model.Account{}} on success {:error, info} on failure """ @spec content_accounts_insert(Tesla.Env.client, String.t, keyword()) :: {:ok, GoogleApi.Content.V2.Model.Account.t} | {:error, Tesla.Env.t} def content_accounts_insert(connection, merchant_id, opts \\ []) do optional_params = %{ :"alt" => :query, :"fields" => :query, :"key" => :query, :"oauth_token" => :query, :"prettyPrint" => :query, :"quotaUser" => :query, :"userIp" => :query, :"dryRun" => :query, :"body" => :body } %{} |> method(:post) |> url("/{merchantId}/accounts", %{ "merchantId" => URI.encode_www_form(merchant_id) }) |> add_optional_params(optional_params, opts) |> Enum.into([]) |> (&Connection.request(connection, &1)).() |> decode(%GoogleApi.Content.V2.Model.Account{}) end @doc """ Lists the sub-accounts in your Merchant Center account. This method can only be called for multi-client accounts. ## Parameters - connection (GoogleApi.Content.V2.Connection): Connection to server - merchant_id (String): The ID of the managing account. - opts (KeywordList): [optional] Optional parameters - :alt (String): Data format for the response. - :fields (String): Selector specifying which fields to include in a partial response. - :key (String): 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): OAuth 2.0 token for the current user. - :pretty_print (Boolean): Returns response with indentations and line breaks. - :quota_user (String): 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. Overrides userIp if both are provided. - :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits. - :max_results (Integer): The maximum number of accounts to return in the response, used for paging. - :page_token (String): The token returned by the previous request. ## Returns {:ok, %GoogleApi.Content.V2.Model.AccountsListResponse{}} on success {:error, info} on failure """ @spec content_accounts_list(Tesla.Env.client, String.t, keyword()) :: {:ok, GoogleApi.Content.V2.Model.AccountsListResponse.t} | {:error, Tesla.Env.t} def content_accounts_list(connection, merchant_id, opts \\ []) do optional_params = %{ :"alt" => :query, :"fields" => :query, :"key" => :query, :"oauth_token" => :query, :"prettyPrint" => :query, :"quotaUser" => :query, :"userIp" => :query, :"maxResults" => :query, :"pageToken" => :query } %{} |> method(:get) |> url("/{merchantId}/accounts", %{ "merchantId" => URI.encode_www_form(merchant_id) }) |> add_optional_params(optional_params, opts) |> Enum.into([]) |> (&Connection.request(connection, &1)).() |> decode(%GoogleApi.Content.V2.Model.AccountsListResponse{}) end @doc """ Updates a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account itself for any Merchant Center account, or any sub-account when the managing account is a multi-client account. This method supports patch semantics. ## Parameters - connection (GoogleApi.Content.V2.Connection): Connection to server - merchant_id (String): The ID of the managing account. - account_id (String): The ID of the account. - opts (KeywordList): [optional] Optional parameters - :alt (String): Data format for the response. - :fields (String): Selector specifying which fields to include in a partial response. - :key (String): 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): OAuth 2.0 token for the current user. - :pretty_print (Boolean): Returns response with indentations and line breaks. - :quota_user (String): 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. Overrides userIp if both are provided. - :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits. - :dry_run (Boolean): Flag to run the request in dry-run mode. - :body (Account): ## Returns {:ok, %GoogleApi.Content.V2.Model.Account{}} on success {:error, info} on failure """ @spec content_accounts_patch(Tesla.Env.client, String.t, String.t, keyword()) :: {:ok, GoogleApi.Content.V2.Model.Account.t} | {:error, Tesla.Env.t} def content_accounts_patch(connection, merchant_id, account_id, opts \\ []) do optional_params = %{ :"alt" => :query, :"fields" => :query, :"key" => :query, :"oauth_token" => :query, :"prettyPrint" => :query, :"quotaUser" => :query, :"userIp" => :query, :"dryRun" => :query, :"body" => :body } %{} |> method(:patch) |> url("/{merchantId}/accounts/{accountId}", %{ "merchantId" => URI.encode_www_form(merchant_id), "accountId" => URI.encode_www_form(account_id) }) |> add_optional_params(optional_params, opts) |> Enum.into([]) |> (&Connection.request(connection, &1)).() |> decode(%GoogleApi.Content.V2.Model.Account{}) end @doc """ Updates a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account itself for any Merchant Center account, or any sub-account when the managing account is a multi-client account. ## Parameters - connection (GoogleApi.Content.V2.Connection): Connection to server - merchant_id (String): The ID of the managing account. - account_id (String): The ID of the account. - opts (KeywordList): [optional] Optional parameters - :alt (String): Data format for the response. - :fields (String): Selector specifying which fields to include in a partial response. - :key (String): 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): OAuth 2.0 token for the current user. - :pretty_print (Boolean): Returns response with indentations and line breaks. - :quota_user (String): 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. Overrides userIp if both are provided. - :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits. - :dry_run (Boolean): Flag to run the request in dry-run mode. - :body (Account): ## Returns {:ok, %GoogleApi.Content.V2.Model.Account{}} on success {:error, info} on failure """ @spec content_accounts_update(Tesla.Env.client, String.t, String.t, keyword()) :: {:ok, GoogleApi.Content.V2.Model.Account.t} | {:error, Tesla.Env.t} def content_accounts_update(connection, merchant_id, account_id, opts \\ []) do optional_params = %{ :"alt" => :query, :"fields" => :query, :"key" => :query, :"oauth_token" => :query, :"prettyPrint" => :query, :"quotaUser" => :query, :"userIp" => :query, :"dryRun" => :query, :"body" => :body } %{} |> method(:put) |> url("/{merchantId}/accounts/{accountId}", %{ "merchantId" => URI.encode_www_form(merchant_id), "accountId" => URI.encode_www_form(account_id) }) |> add_optional_params(optional_params, opts) |> Enum.into([]) |> (&Connection.request(connection, &1)).() |> decode(%GoogleApi.Content.V2.Model.Account{}) end end