oci 2.1.0 → 2.1.1

data/lib/oci/email/email_client_composite_operations.rb

@@ -0,0 +1,103 @@
+# Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
+
+# rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
+module OCI
+  # This class provides a wrapper around {OCI::Email::EmailClient} and offers convenience methods
+  # for operations that would otherwise need to be chained together. For example, instead of performing an action
+  # on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource
+  # to enter a given state, you can call a single method in this class to accomplish the same functionality
+  class Email::EmailClientCompositeOperations
+    # The {OCI::Email::EmailClient} used to communicate with the service_client
+    #
+    # @return [OCI::Email::EmailClient]
+    attr_reader :service_client
+
+    # Initializes a new EmailClientCompositeOperations
+    #
+    # @param [OCI::Email::EmailClient] service_client The client used to communicate with the service.
+    #   Defaults to a new service client created via {OCI::Email::EmailClient#initialize} with no arguments
+    def initialize(service_client = OCI::Email::EmailClient.new)
+      @service_client = service_client
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    # rubocop:disable Layout/EmptyLines
+
+
+    # Calls {OCI::Email::EmailClient#create_sender} and then waits for the {OCI::Email::Models::Sender} acted upon
+    # to enter the given state(s).
+    #
+    # @param [OCI::Email::Models::CreateSenderDetails] create_sender_details Create a sender.
+    # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Email::Models::Sender#lifecycle_state}
+    # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Email::EmailClient#create_sender}
+    # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:
+    #   * max_interval_seconds: The maximum interval between queries, in seconds.
+    #   * max_wait_seconds The maximum time to wait, in seconds
+    #
+    # @return [OCI::Response] A {OCI::Response} object with data of type {OCI::Email::Models::Sender}
+    def create_sender_and_wait_for_state(create_sender_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
+      operation_result = @service_client.create_sender(create_sender_details, base_operation_opts)
+
+      return operation_result if wait_for_states.empty?
+
+      lowered_wait_for_states = wait_for_states.map(&:downcase)
+      wait_for_resource_id = operation_result.data.id
+
+      begin
+        waiter_result = @service_client.get_sender(wait_for_resource_id).wait_until(
+          eval_proc: ->(response) { response.data.respond_to?(:lifecycle_state) && lowered_wait_for_states.include?(response.data.lifecycle_state.downcase) },
+          max_interval_seconds: waiter_opts.key?(:max_interval_seconds) ? waiter_opts[:max_interval_seconds] : 30,
+          max_wait_seconds: waiter_opts.key?(:max_wait_seconds) ? waiter_opts[:max_wait_seconds] : 1200
+        )
+        result_to_return = waiter_result
+
+        return result_to_return
+      rescue StandardError
+        raise OCI::Errors::CompositeOperationError.new(partial_results: [operation_result])
+      end
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    # rubocop:enable Layout/EmptyLines
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    # rubocop:disable Layout/EmptyLines
+
+
+    # Calls {OCI::Email::EmailClient#delete_sender} and then waits for the {OCI::Email::Models::Sender} acted upon
+    # to enter the given state(s).
+    #
+    # @param [String] sender_id The unique OCID of the sender.
+    # @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Email::Models::Sender#lifecycle_state}
+    # @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Email::EmailClient#delete_sender}
+    # @param [Hash] waiter_opts Optional arguments for the waiter. Keys should be symbols, and the following keys are supported:
+    #   * max_interval_seconds: The maximum interval between queries, in seconds.
+    #   * max_wait_seconds The maximum time to wait, in seconds
+    #
+    # @return [OCI::Response] A {OCI::Response} object with data of type nil
+    def delete_sender_and_wait_for_state(sender_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
+      initial_get_result = @service_client.get_sender(sender_id)
+      operation_result = @service_client.delete_sender(sender_id, base_operation_opts)
+
+      return operation_result if wait_for_states.empty?
+
+      lowered_wait_for_states = wait_for_states.map(&:downcase)
+
+      begin
+        waiter_result = initial_get_result.wait_until(
+          eval_proc: ->(response) { response.data.respond_to?(:lifecycle_state) && lowered_wait_for_states.include?(response.data.lifecycle_state.downcase) },
+          max_interval_seconds: waiter_opts.key?(:max_interval_seconds) ? waiter_opts[:max_interval_seconds] : 30,
+          max_wait_seconds: waiter_opts.key?(:max_wait_seconds) ? waiter_opts[:max_wait_seconds] : 1200,
+          succeed_on_not_found: true
+        )
+        result_to_return = waiter_result
+
+        return result_to_return
+      rescue StandardError
+        raise OCI::Errors::CompositeOperationError.new(partial_results: [operation_result])
+      end
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    # rubocop:enable Layout/EmptyLines
+  end
+end
+# rubocop:enable Lint/UnneededCopDisableDirective, Metrics/LineLength

data/lib/oci/email/models/create_sender_details.rb

@@ -2,10 +2,11 @@
 
 require 'date'
 
+# rubocop:disable Lint/UnneededCopDisableDirective
 module OCI
   # The details needed for creating a sender.
   #
-  class Email::Models::CreateSenderDetails
+  class Email::Models::CreateSenderDetails # rubocop:disable Metrics/LineLength
     # The OCID of the compartment that contains the sender.
     # @return [String]
     attr_accessor :compartment_id
@@ -14,6 +15,29 @@ module OCI
     # @return [String]
     attr_accessor :email_address
 
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'compartment_id': :'compartmentId',
+        'email_address': :'emailAddress'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'compartment_id': :'String',
+        'email_address': :'String'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/LineLength, Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
@@ -23,50 +47,54 @@ module OCI
       return unless attributes.is_a?(Hash)
 
       # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes[:'compartmentId']
-        self.compartment_id = attributes[:'compartmentId']
-      end
+      self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']
 
       raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')
 
-      if attributes[:'compartment_id']
-        self.compartment_id = attributes[:'compartment_id']
-      end
+      self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']
 
-      if attributes[:'emailAddress']
-        self.email_address = attributes[:'emailAddress']
-      end
+      self.email_address = attributes[:'emailAddress'] if attributes[:'emailAddress']
 
       raise 'You cannot provide both :emailAddress and :email_address' if attributes.key?(:'emailAddress') && attributes.key?(:'email_address')
 
-      if attributes[:'email_address']
-        self.email_address = attributes[:'email_address']
-      end
-
+      self.email_address = attributes[:'email_address'] if attributes[:'email_address']
     end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/LineLength, Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
+
 
     # Checks equality by comparing each attribute.
-    # @param [Object] other_object to be compared
-    def ==(other_object)
-      return true if self.equal?(other_object)
-      self.class == other_object.class &&
-          compartment_id == other_object.compartment_id &&
-          email_address == other_object.email_address
+    # @param [Object] other the other object to be compared
+    def ==(other)
+      return true if equal?(other)
+      self.class == other.class &&
+        compartment_id == other.compartment_id &&
+        email_address == other.email_address
     end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
 
     # @see the `==` method
-    # @param [Object] other_object to be compared
-    def eql?(other_object)
-      self == other_object
+    # @param [Object] other the other object to be compared
+    def eql?(other)
+      self == other
     end
 
+    # rubocop:disable Metrics/AbcSize, Metrics/LineLength, Layout/EmptyLines
+
+
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
       [compartment_id, email_address].hash
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/LineLength, Layout/EmptyLines
+
+    # rubocop:disable Metrics/AbcSize, Layout/EmptyLines
+
 
     # Builds the object from hash
     # @param [Hash] attributes Model attributes in the form of hash
@@ -78,15 +106,22 @@ module OCI
           # check to ensure the input is an array given that the the attribute
           # is documented as an array but the input is not
           if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
+            public_method("#{key}=").call(
+              attributes[self.class.attribute_map[key]]
+                .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
+            )
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
-          self.public_method("#{key}=").call(OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]))
-        end # or else data not found in attributes(hash), not an issue as the data can be optional
+          public_method("#{key}=").call(
+            OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
+          )
+        end
+        # or else data not found in attributes(hash), not an issue as the data can be optional
       end
 
       self
     end
+    # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
 
     # Returns the string representation of the object
     # @return [String] String presentation of the object
@@ -110,11 +145,11 @@ module OCI
 
     # Outputs non-array value in the form of hash
     # For object, use to_hash. Otherwise, just return the value
-    # @param [Object] value Any valid value 
+    # @param [Object] value Any valid value
     # @return [Hash] Returns the value in the form of hash
     def _to_hash(value)
       if value.is_a?(Array)
-        value.compact.map{ |v| _to_hash(v) }
+        value.compact.map { |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -125,23 +160,6 @@ module OCI
         value
       end
     end
-
-
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      { 
-        :'compartment_id' => :'compartmentId',
-        :'email_address' => :'emailAddress'
-      }
-    end
-
-    # Attribute type mapping.
-    def self.swagger_types
-      { 
-        :'compartment_id' => :'String',
-        :'email_address' => :'String'
-      }
-    end
   end
 end
+# rubocop:enable Lint/UnneededCopDisableDirective

data/lib/oci/email/models/create_suppression_details.rb

@@ -2,13 +2,14 @@
 
 require 'date'
 
+# rubocop:disable Lint/UnneededCopDisableDirective
 module OCI
   # The details needed for creating a single suppression.
-  class Email::Models::CreateSuppressionDetails
+  class Email::Models::CreateSuppressionDetails # rubocop:disable Metrics/LineLength
     # The OCID of the compartment to contain the suppression. Since
     # suppressions are at the customer level, this must be the tenancy
     # OCID.
-    # 
+    #
     # @return [String]
     attr_accessor :compartment_id
 
@@ -16,6 +17,29 @@ module OCI
     # @return [String]
     attr_accessor :email_address
 
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'compartment_id': :'compartmentId',
+        'email_address': :'emailAddress'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'compartment_id': :'String',
+        'email_address': :'String'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/LineLength, Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
@@ -25,50 +49,54 @@ module OCI
       return unless attributes.is_a?(Hash)
 
       # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes[:'compartmentId']
-        self.compartment_id = attributes[:'compartmentId']
-      end
+      self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']
 
       raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')
 
-      if attributes[:'compartment_id']
-        self.compartment_id = attributes[:'compartment_id']
-      end
+      self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']
 
-      if attributes[:'emailAddress']
-        self.email_address = attributes[:'emailAddress']
-      end
+      self.email_address = attributes[:'emailAddress'] if attributes[:'emailAddress']
 
       raise 'You cannot provide both :emailAddress and :email_address' if attributes.key?(:'emailAddress') && attributes.key?(:'email_address')
 
-      if attributes[:'email_address']
-        self.email_address = attributes[:'email_address']
-      end
-
+      self.email_address = attributes[:'email_address'] if attributes[:'email_address']
     end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/LineLength, Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
+
 
     # Checks equality by comparing each attribute.
-    # @param [Object] other_object to be compared
-    def ==(other_object)
-      return true if self.equal?(other_object)
-      self.class == other_object.class &&
-          compartment_id == other_object.compartment_id &&
-          email_address == other_object.email_address
+    # @param [Object] other the other object to be compared
+    def ==(other)
+      return true if equal?(other)
+      self.class == other.class &&
+        compartment_id == other.compartment_id &&
+        email_address == other.email_address
     end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
 
     # @see the `==` method
-    # @param [Object] other_object to be compared
-    def eql?(other_object)
-      self == other_object
+    # @param [Object] other the other object to be compared
+    def eql?(other)
+      self == other
     end
 
+    # rubocop:disable Metrics/AbcSize, Metrics/LineLength, Layout/EmptyLines
+
+
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
       [compartment_id, email_address].hash
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/LineLength, Layout/EmptyLines
+
+    # rubocop:disable Metrics/AbcSize, Layout/EmptyLines
+
 
     # Builds the object from hash
     # @param [Hash] attributes Model attributes in the form of hash
@@ -80,15 +108,22 @@ module OCI
           # check to ensure the input is an array given that the the attribute
           # is documented as an array but the input is not
           if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
+            public_method("#{key}=").call(
+              attributes[self.class.attribute_map[key]]
+                .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
+            )
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
-          self.public_method("#{key}=").call(OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]))
-        end # or else data not found in attributes(hash), not an issue as the data can be optional
+          public_method("#{key}=").call(
+            OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
+          )
+        end
+        # or else data not found in attributes(hash), not an issue as the data can be optional
       end
 
       self
     end
+    # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
 
     # Returns the string representation of the object
     # @return [String] String presentation of the object
@@ -112,11 +147,11 @@ module OCI
 
     # Outputs non-array value in the form of hash
     # For object, use to_hash. Otherwise, just return the value
-    # @param [Object] value Any valid value 
+    # @param [Object] value Any valid value
     # @return [Hash] Returns the value in the form of hash
     def _to_hash(value)
       if value.is_a?(Array)
-        value.compact.map{ |v| _to_hash(v) }
+        value.compact.map { |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -127,23 +162,6 @@ module OCI
         value
       end
     end
-
-
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      { 
-        :'compartment_id' => :'compartmentId',
-        :'email_address' => :'emailAddress'
-      }
-    end
-
-    # Attribute type mapping.
-    def self.swagger_types
-      { 
-        :'compartment_id' => :'String',
-        :'email_address' => :'String'
-      }
-    end
   end
 end
+# rubocop:enable Lint/UnneededCopDisableDirective