google_api_iam

# 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.IAM.V1.Api.Organizations do
  @moduledoc """
  API calls for all endpoints tagged `Organizations`.
  """

  alias GoogleApi.IAM.V1.Connection
  import GoogleApi.IAM.V1.RequestBuilder


  @doc """
  Creates a new Role.

  ## Parameters

  - connection (GoogleApi.IAM.V1.Connection): Connection to server
  - organizations_id (String): Part of `parent`. The resource name of the parent resource in one of the following formats: `organizations/{ORGANIZATION_ID}` `projects/{PROJECT_ID}`
  - opts (KeywordList): [optional] Optional parameters
    - :access_token (String): OAuth access token.
    - :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.
    - :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.
    - :pp (Boolean): Pretty-print response.
    - :bearer_token (String): OAuth bearer token.
    - :oauth_token (String): OAuth 2.0 token for the current user.
    - :upload_protocol (String): Upload protocol for media (e.g. \"raw\", \"multipart\").
    - :pretty_print (Boolean): Returns response with indentations and line breaks.
    - :upload_type (String): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
    - :fields (String): Selector specifying which fields to include in a partial response.
    - :callback (String): JSONP
    - :__/xgafv (String): V1 error format.
    - :alt (String): Data format for response.
    - :body (CreateRoleRequest): 

  ## Returns

  {:ok, %GoogleApi.IAM.V1.Model.Role{}} on success
  {:error, info} on failure
  """
  @spec iam_organizations_roles_create(Tesla.Env.client, String.t, keyword()) :: {:ok, GoogleApi.IAM.V1.Model.Role.t} | {:error, Tesla.Env.t}
  def iam_organizations_roles_create(connection, organizations_id, opts \\ []) do
    optional_params = %{
      :"access_token" => :query,
      :"key" => :query,
      :"quotaUser" => :query,
      :"pp" => :query,
      :"bearer_token" => :query,
      :"oauth_token" => :query,
      :"upload_protocol" => :query,
      :"prettyPrint" => :query,
      :"uploadType" => :query,
      :"fields" => :query,
      :"callback" => :query,
      :"$.xgafv" => :query,
      :"alt" => :query,
      :"body" => :body
    }
    %{}
    |> method(:post)
    |> url("/v1/organizations/#{organizations_id}/roles")
    |> add_optional_params(optional_params, opts)
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%GoogleApi.IAM.V1.Model.Role{})
  end

  @doc """
  Soft deletes a role. The role is suspended and cannot be used to create new IAM Policy Bindings. The Role will not be included in `ListRoles()` unless `show_deleted` is set in the `ListRolesRequest`. The Role contains the deleted boolean set. Existing Bindings remains, but are inactive. The Role can be undeleted within 7 days. After 7 days the Role is deleted and all Bindings associated with the role are removed.

  ## Parameters

  - connection (GoogleApi.IAM.V1.Connection): Connection to server
  - organizations_id (String): Part of `name`. The resource name of the role in one of the following formats: `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}`
  - roles_id (String): Part of `name`. See documentation of `organizationsId`.
  - opts (KeywordList): [optional] Optional parameters
    - :access_token (String): OAuth access token.
    - :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.
    - :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.
    - :pp (Boolean): Pretty-print response.
    - :bearer_token (String): OAuth bearer token.
    - :oauth_token (String): OAuth 2.0 token for the current user.
    - :upload_protocol (String): Upload protocol for media (e.g. \"raw\", \"multipart\").
    - :pretty_print (Boolean): Returns response with indentations and line breaks.
    - :upload_type (String): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
    - :fields (String): Selector specifying which fields to include in a partial response.
    - :callback (String): JSONP
    - :__/xgafv (String): V1 error format.
    - :alt (String): Data format for response.
    - :etag (String): Used to perform a consistent read-modify-write.

  ## Returns

  {:ok, %GoogleApi.IAM.V1.Model.Role{}} on success
  {:error, info} on failure
  """
  @spec iam_organizations_roles_delete(Tesla.Env.client, String.t, String.t, keyword()) :: {:ok, GoogleApi.IAM.V1.Model.Role.t} | {:error, Tesla.Env.t}
  def iam_organizations_roles_delete(connection, organizations_id, roles_id, opts \\ []) do
    optional_params = %{
      :"access_token" => :query,
      :"key" => :query,
      :"quotaUser" => :query,
      :"pp" => :query,
      :"bearer_token" => :query,
      :"oauth_token" => :query,
      :"upload_protocol" => :query,
      :"prettyPrint" => :query,
      :"uploadType" => :query,
      :"fields" => :query,
      :"callback" => :query,
      :"$.xgafv" => :query,
      :"alt" => :query,
      :"etag" => :query
    }
    %{}
    |> method(:delete)
    |> url("/v1/organizations/#{organizations_id}/roles/#{roles_id}")
    |> add_optional_params(optional_params, opts)
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%GoogleApi.IAM.V1.Model.Role{})
  end

  @doc """
  Gets a Role definition.

  ## Parameters

  - connection (GoogleApi.IAM.V1.Connection): Connection to server
  - organizations_id (String): Part of `name`. The resource name of the role in one of the following formats: `roles/{ROLE_NAME}` `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}`
  - roles_id (String): Part of `name`. See documentation of `organizationsId`.
  - opts (KeywordList): [optional] Optional parameters
    - :access_token (String): OAuth access token.
    - :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.
    - :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.
    - :pp (Boolean): Pretty-print response.
    - :bearer_token (String): OAuth bearer token.
    - :oauth_token (String): OAuth 2.0 token for the current user.
    - :upload_protocol (String): Upload protocol for media (e.g. \"raw\", \"multipart\").
    - :pretty_print (Boolean): Returns response with indentations and line breaks.
    - :upload_type (String): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
    - :fields (String): Selector specifying which fields to include in a partial response.
    - :callback (String): JSONP
    - :__/xgafv (String): V1 error format.
    - :alt (String): Data format for response.

  ## Returns

  {:ok, %GoogleApi.IAM.V1.Model.Role{}} on success
  {:error, info} on failure
  """
  @spec iam_organizations_roles_get(Tesla.Env.client, String.t, String.t, keyword()) :: {:ok, GoogleApi.IAM.V1.Model.Role.t} | {:error, Tesla.Env.t}
  def iam_organizations_roles_get(connection, organizations_id, roles_id, opts \\ []) do
    optional_params = %{
      :"access_token" => :query,
      :"key" => :query,
      :"quotaUser" => :query,
      :"pp" => :query,
      :"bearer_token" => :query,
      :"oauth_token" => :query,
      :"upload_protocol" => :query,
      :"prettyPrint" => :query,
      :"uploadType" => :query,
      :"fields" => :query,
      :"callback" => :query,
      :"$.xgafv" => :query,
      :"alt" => :query
    }
    %{}
    |> method(:get)
    |> url("/v1/organizations/#{organizations_id}/roles/#{roles_id}")
    |> add_optional_params(optional_params, opts)
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%GoogleApi.IAM.V1.Model.Role{})
  end

  @doc """
  Lists the Roles defined on a resource.

  ## Parameters

  - connection (GoogleApi.IAM.V1.Connection): Connection to server
  - organizations_id (String): Part of `parent`. The resource name of the parent resource in one of the following formats: `` (empty string) -- this refers to curated roles. `organizations/{ORGANIZATION_ID}` `projects/{PROJECT_ID}`
  - opts (KeywordList): [optional] Optional parameters
    - :access_token (String): OAuth access token.
    - :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.
    - :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.
    - :pp (Boolean): Pretty-print response.
    - :bearer_token (String): OAuth bearer token.
    - :oauth_token (String): OAuth 2.0 token for the current user.
    - :upload_protocol (String): Upload protocol for media (e.g. \"raw\", \"multipart\").
    - :pretty_print (Boolean): Returns response with indentations and line breaks.
    - :upload_type (String): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
    - :fields (String): Selector specifying which fields to include in a partial response.
    - :callback (String): JSONP
    - :__/xgafv (String): V1 error format.
    - :alt (String): Data format for response.
    - :page_token (String): Optional pagination token returned in an earlier ListRolesResponse.
    - :page_size (Integer): Optional limit on the number of roles to include in the response.
    - :view (String): Optional view for the returned Role objects.
    - :show_deleted (Boolean): Include Roles that have been deleted.

  ## Returns

  {:ok, %GoogleApi.IAM.V1.Model.ListRolesResponse{}} on success
  {:error, info} on failure
  """
  @spec iam_organizations_roles_list(Tesla.Env.client, String.t, keyword()) :: {:ok, GoogleApi.IAM.V1.Model.ListRolesResponse.t} | {:error, Tesla.Env.t}
  def iam_organizations_roles_list(connection, organizations_id, opts \\ []) do
    optional_params = %{
      :"access_token" => :query,
      :"key" => :query,
      :"quotaUser" => :query,
      :"pp" => :query,
      :"bearer_token" => :query,
      :"oauth_token" => :query,
      :"upload_protocol" => :query,
      :"prettyPrint" => :query,
      :"uploadType" => :query,
      :"fields" => :query,
      :"callback" => :query,
      :"$.xgafv" => :query,
      :"alt" => :query,
      :"pageToken" => :query,
      :"pageSize" => :query,
      :"view" => :query,
      :"showDeleted" => :query
    }
    %{}
    |> method(:get)
    |> url("/v1/organizations/#{organizations_id}/roles")
    |> add_optional_params(optional_params, opts)
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%GoogleApi.IAM.V1.Model.ListRolesResponse{})
  end

  @doc """
  Updates a Role definition.

  ## Parameters

  - connection (GoogleApi.IAM.V1.Connection): Connection to server
  - organizations_id (String): Part of `name`. The resource name of the role in one of the following formats: `roles/{ROLE_NAME}` `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}`
  - roles_id (String): Part of `name`. See documentation of `organizationsId`.
  - opts (KeywordList): [optional] Optional parameters
    - :access_token (String): OAuth access token.
    - :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.
    - :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.
    - :pp (Boolean): Pretty-print response.
    - :bearer_token (String): OAuth bearer token.
    - :oauth_token (String): OAuth 2.0 token for the current user.
    - :upload_protocol (String): Upload protocol for media (e.g. \"raw\", \"multipart\").
    - :pretty_print (Boolean): Returns response with indentations and line breaks.
    - :upload_type (String): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
    - :fields (String): Selector specifying which fields to include in a partial response.
    - :callback (String): JSONP
    - :__/xgafv (String): V1 error format.
    - :alt (String): Data format for response.
    - :update_mask (String): A mask describing which fields in the Role have changed.
    - :body (Role): 

  ## Returns

  {:ok, %GoogleApi.IAM.V1.Model.Role{}} on success
  {:error, info} on failure
  """
  @spec iam_organizations_roles_patch(Tesla.Env.client, String.t, String.t, keyword()) :: {:ok, GoogleApi.IAM.V1.Model.Role.t} | {:error, Tesla.Env.t}
  def iam_organizations_roles_patch(connection, organizations_id, roles_id, opts \\ []) do
    optional_params = %{
      :"access_token" => :query,
      :"key" => :query,
      :"quotaUser" => :query,
      :"pp" => :query,
      :"bearer_token" => :query,
      :"oauth_token" => :query,
      :"upload_protocol" => :query,
      :"prettyPrint" => :query,
      :"uploadType" => :query,
      :"fields" => :query,
      :"callback" => :query,
      :"$.xgafv" => :query,
      :"alt" => :query,
      :"updateMask" => :query,
      :"body" => :body
    }
    %{}
    |> method(:patch)
    |> url("/v1/organizations/#{organizations_id}/roles/#{roles_id}")
    |> add_optional_params(optional_params, opts)
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%GoogleApi.IAM.V1.Model.Role{})
  end

  @doc """
  Undelete a Role, bringing it back in its previous state.

  ## Parameters

  - connection (GoogleApi.IAM.V1.Connection): Connection to server
  - organizations_id (String): Part of `name`. The resource name of the role in one of the following formats: `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}`
  - roles_id (String): Part of `name`. See documentation of `organizationsId`.
  - opts (KeywordList): [optional] Optional parameters
    - :access_token (String): OAuth access token.
    - :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.
    - :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.
    - :pp (Boolean): Pretty-print response.
    - :bearer_token (String): OAuth bearer token.
    - :oauth_token (String): OAuth 2.0 token for the current user.
    - :upload_protocol (String): Upload protocol for media (e.g. \"raw\", \"multipart\").
    - :pretty_print (Boolean): Returns response with indentations and line breaks.
    - :upload_type (String): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
    - :fields (String): Selector specifying which fields to include in a partial response.
    - :callback (String): JSONP
    - :__/xgafv (String): V1 error format.
    - :alt (String): Data format for response.
    - :body (UndeleteRoleRequest): 

  ## Returns

  {:ok, %GoogleApi.IAM.V1.Model.Role{}} on success
  {:error, info} on failure
  """
  @spec iam_organizations_roles_undelete(Tesla.Env.client, String.t, String.t, keyword()) :: {:ok, GoogleApi.IAM.V1.Model.Role.t} | {:error, Tesla.Env.t}
  def iam_organizations_roles_undelete(connection, organizations_id, roles_id, opts \\ []) do
    optional_params = %{
      :"access_token" => :query,
      :"key" => :query,
      :"quotaUser" => :query,
      :"pp" => :query,
      :"bearer_token" => :query,
      :"oauth_token" => :query,
      :"upload_protocol" => :query,
      :"prettyPrint" => :query,
      :"uploadType" => :query,
      :"fields" => :query,
      :"callback" => :query,
      :"$.xgafv" => :query,
      :"alt" => :query,
      :"body" => :body
    }
    %{}
    |> method(:post)
    |> url("/v1/organizations/#{organizations_id}/roles/#{roles_id}:undelete")
    |> add_optional_params(optional_params, opts)
    |> Enum.into([])
    |> (&Connection.request(connection, &1)).()
    |> decode(%GoogleApi.IAM.V1.Model.Role{})
  end
end