class OCI::TenantManagerControlPlane::RecipientInvitationClient

The Organizations API allows you to consolidate multiple OCI tenancies into an organization, and centrally manage your tenancies and its resources.

Attributes

api_client[R]

Client used to make HTTP requests. @return [OCI::ApiClient]

endpoint[R]

Fully qualified endpoint URL @return [String]

region[R]

The region, which will usually correspond to a value in {OCI::Regions::REGION_ENUM}. @return [String]

retry_config[R]

The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is `nil`, which means that an operation will not perform any retries @return [OCI::Retry::RetryConfig]

Public Class Methods

new(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) click to toggle source

Creates a new RecipientInvitationClient. Notes:

If a config is not specified, then the global OCI.config will be used.

This client is not thread-safe

Either a region or an endpoint must be specified.  If an endpoint is specified, it will be used instead of the
  region. A region may be specified in the config or via or the region parameter. If specified in both, then the
  region parameter will be used.

@param [Config] config A Config object. @param [String] region A region used to determine the service endpoint. This will usually

correspond to a value in {OCI::Regions::REGION_ENUM}, but may be an arbitrary string.

@param [String] endpoint The fully qualified endpoint URL @param [OCI::BaseSigner] signer A signer implementation which can be used by this client. If this is not provided then

a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication,
so that the instance principals signer can be provided to the client

@param [OCI::ApiClientProxySettings] proxy_settings If your environment requires you to use a proxy server for outgoing HTTP requests

the details for the proxy can be provided in this parameter

@param [OCI::Retry::RetryConfig] retry_config The retry configuration for this service client. This represents the default retry configuration to

apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is `nil`, which means that an operation
will not perform any retries
# File lib/oci/tenant_manager_control_plane/recipient_invitation_client.rb, line 53
def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
  # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers)
  # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
  # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
  # pass it to this constructor.
  #
  # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
  # so try and load the config from the default file.
  config = OCI::Config.validate_and_build_config_with_signer(config, signer)

  signer = OCI::Signer.config_file_auth_builder(config) if signer.nil?

  @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
  @retry_config = retry_config

  if endpoint
    @endpoint = endpoint + '/20200801'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "RecipientInvitationClient endpoint set to '#{@endpoint}'." if logger
end

Public Instance Methods

accept_recipient_invitation(recipient_invitation_id, opts = {}) click to toggle source

Accepts a recipient invitation. @param [String] recipient_invitation_id OCID of recipient invitation to accept. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level

retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry

@option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call

for a resource, set the `if-match` parameter to the value of the
etag from a previous GET or POST response for that resource.
The resource will be updated or deleted only if the etag you
provide matches the resource's current etag value.

@option opts [String] :opc_retry_token A token that uniquely identifies a request, so it can be retried in case of a timeout or

server error, without risk of executing that same action again. Retry tokens expire after 24
hours, but can be invalidated before then due to conflicting operations. For example, if a resource
has been deleted and purged from the system, then a retry of the original creation request
might be rejected.

@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response object with data of type nil @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/tenantmanagercontrolplane/accept_recipient_invitation.rb.html) to see an example of how to use accept_recipient_invitation API.

# File lib/oci/tenant_manager_control_plane/recipient_invitation_client.rb, line 121
def accept_recipient_invitation(recipient_invitation_id, opts = {})
  logger.debug 'Calling operation RecipientInvitationClient#accept_recipient_invitation.' if logger

  raise "Missing the required parameter 'recipient_invitation_id' when calling accept_recipient_invitation." if recipient_invitation_id.nil?
  raise "Parameter value for 'recipient_invitation_id' must not be blank" if OCI::Internal::Util.blank_string?(recipient_invitation_id)

  path = '/recipientInvitations/{recipientInvitationId}/actions/accept'.sub('{recipientInvitationId}', recipient_invitation_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'RecipientInvitationClient#accept_recipient_invitation') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end
get_recipient_invitation(recipient_invitation_id, opts = {}) click to toggle source

Gets information about the recipient invitation. @param [String] recipient_invitation_id OCID of the recipient invitation to retrieve. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level

retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry

@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response object with data of type {OCI::TenantManagerControlPlane::Models::RecipientInvitation RecipientInvitation} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/tenantmanagercontrolplane/get_recipient_invitation.rb.html) to see an example of how to use get_recipient_invitation API.

# File lib/oci/tenant_manager_control_plane/recipient_invitation_client.rb, line 177
def get_recipient_invitation(recipient_invitation_id, opts = {})
  logger.debug 'Calling operation RecipientInvitationClient#get_recipient_invitation.' if logger

  raise "Missing the required parameter 'recipient_invitation_id' when calling get_recipient_invitation." if recipient_invitation_id.nil?
  raise "Parameter value for 'recipient_invitation_id' must not be blank" if OCI::Internal::Util.blank_string?(recipient_invitation_id)

  path = '/recipientInvitations/{recipientInvitationId}'.sub('{recipientInvitationId}', recipient_invitation_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'RecipientInvitationClient#get_recipient_invitation') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::TenantManagerControlPlane::Models::RecipientInvitation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end
ignore_recipient_invitation(recipient_invitation_id, opts = {}) click to toggle source

Ignores a recipient invitation. @param [String] recipient_invitation_id OCID of recipient invitation to ignore. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level

retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry

@option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call

for a resource, set the `if-match` parameter to the value of the
etag from a previous GET or POST response for that resource.
The resource will be updated or deleted only if the etag you
provide matches the resource's current etag value.

@option opts [String] :opc_retry_token A token that uniquely identifies a request, so it can be retried in case of a timeout or

server error, without risk of executing that same action again. Retry tokens expire after 24
hours, but can be invalidated before then due to conflicting operations. For example, if a resource
has been deleted and purged from the system, then a retry of the original creation request
might be rejected.

@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response object with data of type {OCI::TenantManagerControlPlane::Models::RecipientInvitation RecipientInvitation} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/tenantmanagercontrolplane/ignore_recipient_invitation.rb.html) to see an example of how to use ignore_recipient_invitation API.

# File lib/oci/tenant_manager_control_plane/recipient_invitation_client.rb, line 243
def ignore_recipient_invitation(recipient_invitation_id, opts = {})
  logger.debug 'Calling operation RecipientInvitationClient#ignore_recipient_invitation.' if logger

  raise "Missing the required parameter 'recipient_invitation_id' when calling ignore_recipient_invitation." if recipient_invitation_id.nil?
  raise "Parameter value for 'recipient_invitation_id' must not be blank" if OCI::Internal::Util.blank_string?(recipient_invitation_id)

  path = '/recipientInvitations/{recipientInvitationId}/actions/ignore'.sub('{recipientInvitationId}', recipient_invitation_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'RecipientInvitationClient#ignore_recipient_invitation') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::TenantManagerControlPlane::Models::RecipientInvitation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end
list_recipient_invitations(compartment_id, opts = {}) click to toggle source

Return a (paginated) list of recipient invitations.

@param [String] compartment_id The ID of the compartment in which to list resources. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level

retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry

@option opts [String] :sender_tenancy_id The tenancy that sent the invitation. @option opts [String] :lifecycle_state The lifecycle state of the resource. @option opts [String] :status The status of the recipient invitation. @option opts [String] :opc_request_id The client request ID for tracing. @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. @return [Response] A Response object with data of type {OCI::TenantManagerControlPlane::Models::RecipientInvitationCollection RecipientInvitationCollection} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/tenantmanagercontrolplane/list_recipient_invitations.rb.html) to see an example of how to use list_recipient_invitations API.

# File lib/oci/tenant_manager_control_plane/recipient_invitation_client.rb, line 305
def list_recipient_invitations(compartment_id, opts = {})
  logger.debug 'Calling operation RecipientInvitationClient#list_recipient_invitations.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_recipient_invitations." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::TenantManagerControlPlane::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::TenantManagerControlPlane::Models::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:status] && !OCI::TenantManagerControlPlane::Models::RECIPIENT_INVITATION_STATUS_ENUM.include?(opts[:status])
    raise 'Invalid value for "status", must be one of the values in OCI::TenantManagerControlPlane::Models::RECIPIENT_INVITATION_STATUS_ENUM.'
  end

  path = '/recipientInvitations'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:senderTenancyId] = opts[:sender_tenancy_id] if opts[:sender_tenancy_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:status] = opts[:status] if opts[:status]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'RecipientInvitationClient#list_recipient_invitations') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::TenantManagerControlPlane::Models::RecipientInvitationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end
logger() click to toggle source

@return [Logger] The logger for this client. May be nil.

# File lib/oci/tenant_manager_control_plane/recipient_invitation_client.rb, line 92
def logger
  @api_client.config.logger
end
region=(new_region) click to toggle source

Set the region that will be used to determine the service endpoint. This will usually correspond to a value in {OCI::Regions::REGION_ENUM}, but may be an arbitrary string.

# File lib/oci/tenant_manager_control_plane/recipient_invitation_client.rb, line 82
def region=(new_region)
  @region = new_region

  raise 'A region must be specified.' unless @region

  @endpoint = OCI::Regions.get_service_endpoint_for_template(@region, 'https://organizations.{region}.oci.{secondLevelDomain}') + '/20200801'
  logger.info "RecipientInvitationClient endpoint set to '#{@endpoint} from region #{@region}'." if logger
end
update_recipient_invitation(recipient_invitation_id, update_recipient_invitation_details, opts = {}) click to toggle source

Updates the RecipientInvitation. @param [String] recipient_invitation_id OCID of the recipient invitation to update. @param [OCI::TenantManagerControlPlane::Models::UpdateRecipientInvitationDetails] update_recipient_invitation_details The information to be updated. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level

retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry

@option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call

for a resource, set the `if-match` parameter to the value of the
etag from a previous GET or POST response for that resource.
The resource will be updated or deleted only if the etag you
provide matches the resource's current etag value.

@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response object with data of type {OCI::TenantManagerControlPlane::Models::RecipientInvitation RecipientInvitation} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/tenantmanagercontrolplane/update_recipient_invitation.rb.html) to see an example of how to use update_recipient_invitation API.

# File lib/oci/tenant_manager_control_plane/recipient_invitation_client.rb, line 378
def update_recipient_invitation(recipient_invitation_id, update_recipient_invitation_details, opts = {})
  logger.debug 'Calling operation RecipientInvitationClient#update_recipient_invitation.' if logger

  raise "Missing the required parameter 'recipient_invitation_id' when calling update_recipient_invitation." if recipient_invitation_id.nil?
  raise "Missing the required parameter 'update_recipient_invitation_details' when calling update_recipient_invitation." if update_recipient_invitation_details.nil?
  raise "Parameter value for 'recipient_invitation_id' must not be blank" if OCI::Internal::Util.blank_string?(recipient_invitation_id)

  path = '/recipientInvitations/{recipientInvitationId}'.sub('{recipientInvitationId}', recipient_invitation_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_recipient_invitation_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'RecipientInvitationClient#update_recipient_invitation') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::TenantManagerControlPlane::Models::RecipientInvitation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

Private Instance Methods

applicable_retry_config(opts = {}) click to toggle source

rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity rubocop:enable Style/IfUnlessModifier, Metrics/ParameterLists rubocop:enable Metrics/MethodLength, Layout/EmptyLines

# File lib/oci/tenant_manager_control_plane/recipient_invitation_client.rb, line 423
def applicable_retry_config(opts = {})
  return @retry_config unless opts.key?(:retry_config)

  opts[:retry_config]
end