oci 2.0.8 → 2.0.9

data/lib/oci/dns/models/create_zone_details.rb

@@ -80,7 +80,7 @@ module OCI
     # @param [Object] zone_type Object to be assigned
     def zone_type=(zone_type)
       if zone_type && !ZONE_TYPE_ENUM.include?(zone_type)
-        fail "Invalid value for 'zone_type': this must be one of the values in ZONE_TYPE_ENUM."
+        raise "Invalid value for 'zone_type': this must be one of the values in ZONE_TYPE_ENUM."
       else
         @zone_type = zone_type
       end

data/lib/oci/dns/models/record_operation.rb

@@ -147,7 +147,7 @@ module OCI
     # @param [Object] operation Object to be assigned
     def operation=(operation)
       if operation && !OPERATION_ENUM.include?(operation)
-        fail "Invalid value for 'operation': this must be one of the values in OPERATION_ENUM."
+        raise "Invalid value for 'operation': this must be one of the values in OPERATION_ENUM."
       else
         @operation = operation
       end

data/lib/oci/email/email.rb

@@ -0,0 +1,22 @@
+# Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
+
+module OCI
+  module Email
+    module Models
+    end
+  end
+end
+
+# Require models
+require 'oci/email/models/create_sender_details'
+require 'oci/email/models/create_suppression_details'
+require 'oci/email/models/sender'
+require 'oci/email/models/sender_summary'
+require 'oci/email/models/suppression'
+require 'oci/email/models/suppression_summary'
+
+# Require generated clients
+require 'oci/email/email_client'
+
+# Require service utilities
+require 'oci/email/util'

data/lib/oci/email/email_client.rb

@@ -0,0 +1,417 @@
+# Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
+
+require "uri"
+require "logger"
+
+module OCI
+
+  class Email::EmailClient
+
+    # Client used to make HTTP requests.
+    # @return [OCI::ApiClient]
+    attr_reader :api_client
+
+    # Fully qualified endpoint URL
+    # @return [String]
+    attr_reader :endpoint
+
+    # The region, which will usually correspond to a value in {OCI::Regions::REGION_ENUM}.
+    # @return [String]
+    attr_accessor :region
+
+    # Creates a new EmailClient.
+    # If a config is not specified, then the global OCI.config will be used.
+    #
+    # A region must be specified in either the config 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 [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
+    def initialize(config:nil, region:nil, signer:nil)
+      # If the signer is an InstancePrincipalsSecurityTokenSigner and no config was supplied (which is valid for instance principals)
+      # 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 unless signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner)
+      config ||= OCI::Config.new if signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner)
+      config.validate unless signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner)
+
+      if signer.nil?
+        signer = Signer.new(config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase: config.pass_phrase, private_key_content: config.key_content, signing_strategy: Signer::STANDARD)
+      end
+
+      @api_client = ApiClient.new(config, signer)
+
+      region ||= config.region
+      region ||= signer.region if signer.respond_to?(:region)
+      self.region = region
+    end
+
+    # 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.
+    def region=(r)
+      @region = r
+
+      raise 'A region must be specified.' unless @region
+
+      @endpoint = OCI::Regions.get_service_endpoint(@region, :EmailClient) + '/20170907'
+      logger.info "EmailClient endpoint set to '#{endpoint}'." if logger
+    end
+
+    # @return [Logger] The logger for this client. May be nil.
+    def logger
+      @api_client.config.logger
+    end
+
+
+    # Creates a sender for a tenancy in a given compartment.
+    # @param [CreateSenderDetails] create_sender_details Create a sender.
+    # @param [Hash] opts the optional parameters
+    # @return [Response] A Response object with data of type OCI::Email::Models::Sender
+    def create_sender(create_sender_details, opts = {})
+      logger.debug "Calling operation EmailClient#create_sender." if logger
+
+      raise "Missing the required parameter 'create_sender_details' when calling create_sender." if create_sender_details.nil?
+
+      path = "/senders"
+
+      # Query Params
+      query_params = {}
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+
+      post_body = @api_client.object_to_http_body(create_sender_details)
+
+      return @api_client.call_api(
+        :POST,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'OCI::Email::Models::Sender')
+    end
+
+    # Adds recipient email addresses to the suppression list for a tenancy.
+    # 
+    # @param [CreateSuppressionDetails] create_suppression_details Adds a single email address to the suppression list for a compartment's tenancy.
+    #   
+    # @param [Hash] opts the optional parameters
+    # @return [Response] A Response object with data of type OCI::Email::Models::Suppression
+    def create_suppression(create_suppression_details, opts = {})
+      logger.debug "Calling operation EmailClient#create_suppression." if logger
+
+      raise "Missing the required parameter 'create_suppression_details' when calling create_suppression." if create_suppression_details.nil?
+
+      path = "/suppressions"
+
+      # Query Params
+      query_params = {}
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+
+      post_body = @api_client.object_to_http_body(create_suppression_details)
+
+      return @api_client.call_api(
+        :POST,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'OCI::Email::Models::Suppression')
+    end
+
+    # Deletes an approved sender for a tenancy in a given compartment for a
+    # provided `senderId`.
+    # 
+    # @param [String] sender_id The unique OCID of the sender.
+    # @param [Hash] opts the optional parameters
+    # @return [Response] A Response object with data of type nil
+    def delete_sender(sender_id, opts = {})
+      logger.debug "Calling operation EmailClient#delete_sender." if logger
+
+      raise "Missing the required parameter 'sender_id' when calling delete_sender." if sender_id.nil?
+
+      path = "/senders/{senderId}".sub('{senderId}', sender_id.to_s)
+
+      # Query Params
+      query_params = {}
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :DELETE,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body)
+    end
+
+    # Removes a suppressed recipient email address from the suppression list
+    # for a tenancy in a given compartment for a provided `suppressionId`.
+    # 
+    # @param [String] suppression_id The unique OCID of the suppression.
+    # @param [Hash] opts the optional parameters
+    # @return [Response] A Response object with data of type nil
+    def delete_suppression(suppression_id, opts = {})
+      logger.debug "Calling operation EmailClient#delete_suppression." if logger
+
+      raise "Missing the required parameter 'suppression_id' when calling delete_suppression." if suppression_id.nil?
+
+      path = "/suppressions/{suppressionId}".sub('{suppressionId}', suppression_id.to_s)
+
+      # Query Params
+      query_params = {}
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :DELETE,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body)
+    end
+
+    # Gets an approved sender for a given `senderId`.
+    # @param [String] sender_id The unique OCID of the sender.
+    # @param [Hash] opts the optional parameters
+    # @return [Response] A Response object with data of type OCI::Email::Models::Sender
+    def get_sender(sender_id, opts = {})
+      logger.debug "Calling operation EmailClient#get_sender." if logger
+
+      raise "Missing the required parameter 'sender_id' when calling get_sender." if sender_id.nil?
+
+      path = "/senders/{senderId}".sub('{senderId}', sender_id.to_s)
+
+      # Query Params
+      query_params = {}
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :GET,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'OCI::Email::Models::Sender')
+    end
+
+    # Gets the details of a suppressed recipient email address for a given
+    # `suppressionId`. Each suppression is given a unique OCID.
+    # 
+    # @param [String] suppression_id The unique OCID of the suppression.
+    # @param [Hash] opts the optional parameters
+    # @return [Response] A Response object with data of type OCI::Email::Models::Suppression
+    def get_suppression(suppression_id, opts = {})
+      logger.debug "Calling operation EmailClient#get_suppression." if logger
+
+      raise "Missing the required parameter 'suppression_id' when calling get_suppression." if suppression_id.nil?
+
+      path = "/suppressions/{suppressionId}".sub('{suppressionId}', suppression_id.to_s)
+
+      # Query Params
+      query_params = {}
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :GET,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'OCI::Email::Models::Suppression')
+    end
+
+    # Gets a collection of approved sender email addresses and sender IDs.
+    # 
+    # @param [String] compartment_id The OCID for the compartment.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :lifecycle_state The current state of a sender.
+    # @option opts [String] :email_address The email address of the approved sender.
+    # @option opts [String] :page The value of the `opc-next-page` response header from the previous
+    #   GET request.
+    #   
+    # @option opts [Integer] :limit The maximum number of items to return in a paginated GET request.
+    #   
+    # @option opts [String] :sort_by The field to sort by. The `TIMECREATED` value returns the list in in
+    #   descending order by default. The `EMAILADDRESS` value returns the list in
+    #   ascending order by default. Use the `SortOrderQueryParam` to change the
+    #   direction of the returned list of items.
+    #   
+    #   Allowed values are: TIMECREATED, EMAILADDRESS
+    # @option opts [String] :sort_order The sort order to use, either ascending or descending order.
+    #   
+    #   Allowed values are: ASC, DESC
+    # @return [Response] A Response object with data of type Array<OCI::Email::Models::SenderSummary>
+    def list_senders(compartment_id, opts = {})
+      logger.debug "Calling operation EmailClient#list_senders." if logger
+
+      raise "Missing the required parameter 'compartment_id' when calling list_senders." if compartment_id.nil?
+
+      if opts[:'lifecycle_state'] && !OCI::Email::Models::Sender::LIFECYCLE_STATE_ENUM.include?(opts[:'lifecycle_state'])
+        raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Email::Models::Sender::LIFECYCLE_STATE_ENUM.'
+      end
+
+      if opts[:'sort_by'] && !['TIMECREATED', 'EMAILADDRESS'].include?(opts[:'sort_by'])
+        raise 'Invalid value for "sort_by", must be one of TIMECREATED, EMAILADDRESS.'
+      end
+
+      if opts[:'sort_order'] && !['ASC', 'DESC'].include?(opts[:'sort_order'])
+        raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
+      end
+
+      path = "/senders"
+
+      # Query Params
+      query_params = {}
+      query_params[:'compartmentId'] = compartment_id
+      query_params[:'lifecycleState'] = opts[:'lifecycle_state'] if opts[:'lifecycle_state']
+      query_params[:'emailAddress'] = opts[:'email_address'] if opts[:'email_address']
+      query_params[:'page'] = opts[:'page'] if opts[:'page']
+      query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
+      query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
+      query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :GET,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'Array<OCI::Email::Models::SenderSummary>')
+    end
+
+    # Gets a list of suppressed recipient email addresses for a user. The
+    # `compartmentId` for suppressions must be a tenancy OCID. The returned list
+    # is sorted by creation time in descending order.
+    # 
+    # @param [String] compartment_id The OCID for the compartment.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :email_address The email address of the suppression.
+    # @option opts [DateTime] :time_created_greater_than_or_equal_to Search for suppressions that were created within a specific date range,
+    #   using this parameter to specify the earliest creation date for the
+    #   returned list (inclusive). Specifying this parameter without the
+    #   corresponding `timeCreatedLessThan` parameter will retrieve suppressions created from the
+    #   given `timeCreatedGreaterThanOrEqualTo` to the current time, in \"YYYY-MM-ddThh:mmZ\" format with a
+    #   Z offset, as defined by RFC 3339.
+    #   
+    #   **Example:** 2016-12-19T16:39:57.600Z
+    #   
+    # @option opts [DateTime] :time_created_less_than Search for suppressions that were created within a specific date range,
+    #   using this parameter to specify the latest creation date for the returned
+    #   list (exclusive). Specifying this parameter without the corresponding
+    #   `timeCreatedGreaterThanOrEqualTo` parameter will retrieve all suppressions created before the
+    #   specified end date, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as
+    #   defined by RFC 3339.
+    #   
+    #   **Example:** 2016-12-19T16:39:57.600Z
+    #   
+    # @option opts [String] :page The value of the `opc-next-page` response header from the previous
+    #   GET request.
+    #   
+    # @option opts [Integer] :limit The maximum number of items to return in a paginated GET request.
+    #   
+    # @option opts [String] :sort_by The field to sort by. The `TIMECREATED` value returns the list in in
+    #   descending order by default. The `EMAILADDRESS` value returns the list in
+    #   ascending order by default. Use the `SortOrderQueryParam` to change the
+    #   direction of the returned list of items.
+    #   
+    #   Allowed values are: TIMECREATED, EMAILADDRESS
+    # @option opts [String] :sort_order The sort order to use, either ascending or descending order.
+    #   
+    #   Allowed values are: ASC, DESC
+    # @return [Response] A Response object with data of type Array<OCI::Email::Models::SuppressionSummary>
+    def list_suppressions(compartment_id, opts = {})
+      logger.debug "Calling operation EmailClient#list_suppressions." if logger
+
+      raise "Missing the required parameter 'compartment_id' when calling list_suppressions." if compartment_id.nil?
+
+      if opts[:'sort_by'] && !['TIMECREATED', 'EMAILADDRESS'].include?(opts[:'sort_by'])
+        raise 'Invalid value for "sort_by", must be one of TIMECREATED, EMAILADDRESS.'
+      end
+
+      if opts[:'sort_order'] && !['ASC', 'DESC'].include?(opts[:'sort_order'])
+        raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
+      end
+
+      path = "/suppressions"
+
+      # Query Params
+      query_params = {}
+      query_params[:'compartmentId'] = compartment_id
+      query_params[:'emailAddress'] = opts[:'email_address'] if opts[:'email_address']
+      query_params[:'timeCreatedGreaterThanOrEqualTo'] = opts[:'time_created_greater_than_or_equal_to'] if opts[:'time_created_greater_than_or_equal_to']
+      query_params[:'timeCreatedLessThan'] = opts[:'time_created_less_than'] if opts[:'time_created_less_than']
+      query_params[:'page'] = opts[:'page'] if opts[:'page']
+      query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
+      query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
+      query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
+
+      # Header Params
+      header_params = {}
+      header_params['accept'] = 'application/json'
+      header_params['content-type'] = 'application/json'
+
+      post_body = nil
+
+      return @api_client.call_api(
+        :GET,
+        path,
+        endpoint,
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :return_type => 'Array<OCI::Email::Models::SuppressionSummary>')
+    end
+  end
+end