oci 2.0.8 → 2.0.9

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

@@ -0,0 +1,195 @@
+# Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
+
+require 'date'
+
+module OCI
+  # The email addresses and `senderId` representing an approved sender.
+  class Email::Models::SenderSummary
+
+    LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_CREATING = 'CREATING',
+                LIFECYCLE_STATE_ACTIVE = 'ACTIVE',
+                LIFECYCLE_STATE_DELETING = 'DELETING',
+                LIFECYCLE_STATE_DELETED = 'DELETED',
+                LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
+
+    # The email address of the sender.
+    # @return [String]
+    attr_accessor :email_address
+
+    # The unique ID of the sender.
+    # @return [String]
+    attr_accessor :id
+
+    # The current status of the approved sender.
+    # @return [String]
+    attr_accessor :lifecycle_state
+
+    # Date time the approved sender was added, in \"YYYY-MM-ddThh:mmZ\"
+    # format with a Z offset, as defined by RFC 3339.
+    # 
+    # @return [DateTime]
+    attr_accessor :time_created
+
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :email_address The value to assign to the {#email_address} property
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property
+    # @option attributes [DateTime] :time_created The value to assign to the {#time_created} property
+    def initialize(attributes = {})
+      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}
+
+      if attributes[:'emailAddress']
+        self.email_address = attributes[:'emailAddress']
+      end
+
+      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
+
+      if attributes[:'id']
+        self.id = attributes[:'id']
+      end
+
+      if attributes[:'lifecycleState']
+        self.lifecycle_state = attributes[:'lifecycleState']
+      end
+
+      raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')
+
+      if attributes[:'lifecycle_state']
+        self.lifecycle_state = attributes[:'lifecycle_state']
+      end
+
+      if attributes[:'timeCreated']
+        self.time_created = attributes[:'timeCreated']
+      end
+
+      raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')
+
+      if attributes[:'time_created']
+        self.time_created = attributes[:'time_created']
+      end
+
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] lifecycle_state Object to be assigned
+    def lifecycle_state=(lifecycle_state)
+      if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state)
+        @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE
+      else
+        @lifecycle_state = lifecycle_state
+      end
+    end
+
+    # 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 &&
+          email_address == other_object.email_address &&
+          id == other_object.id &&
+          lifecycle_state == other_object.lifecycle_state &&
+          time_created == other_object.time_created
+    end
+
+    # @see the `==` method
+    # @param [Object] other_object to be compared
+    def eql?(other_object)
+      self == other_object
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [email_address, id, lifecycle_state, time_created].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          # 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) } )
+          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
+      end
+
+      self
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = public_method(attr).call
+        next if value.nil? && !instance_variable_defined?("@#{attr}")
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    private
+
+    # 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 
+    # @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) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      { 
+        :'email_address' => :'emailAddress',
+        :'id' => :'id',
+        :'lifecycle_state' => :'lifecycleState',
+        :'time_created' => :'timeCreated'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      { 
+        :'email_address' => :'String',
+        :'id' => :'String',
+        :'lifecycle_state' => :'String',
+        :'time_created' => :'DateTime'
+      }
+    end
+  end
+end

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

@@ -0,0 +1,191 @@
+# Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
+
+require 'date'
+
+module OCI
+  # The full information representing an email suppression.
+  class Email::Models::Suppression
+
+    REASON_ENUM = [REASON_UNKNOWN = 'UNKNOWN',
+                REASON_HARDBOUNCE = 'HARDBOUNCE',
+                REASON_COMPLAINT = 'COMPLAINT',
+                REASON_MANUAL = 'MANUAL',
+                REASON_SOFTBOUNCE = 'SOFTBOUNCE',
+                REASON_UNSUBSCRIBE = 'UNSUBSCRIBE',
+                REASON_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
+
+    # Email address of the suppression.
+    # @return [String]
+    attr_accessor :email_address
+
+    # The unique ID of the suppression.
+    # @return [String]
+    attr_accessor :id
+
+    # The reason that the email address was suppressed. For more information on the types of bounces, see [Suppresion List](https://docs.us-phoenix-1.oraclecloud.com/Content/Email/Concepts/emaildeliveryoverview.htm#suppressionlist).
+    # @return [String]
+    attr_accessor :reason
+
+    # The date and time the approved sender was added in \"YYYY-MM-ddThh:mmZ\"
+    # format with a Z offset, as defined by RFC 3339.
+    # 
+    # @return [DateTime]
+    attr_accessor :time_created
+
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :email_address The value to assign to the {#email_address} property
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [String] :reason The value to assign to the {#reason} property
+    # @option attributes [DateTime] :time_created The value to assign to the {#time_created} property
+    def initialize(attributes = {})
+      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}
+
+      if attributes[:'emailAddress']
+        self.email_address = attributes[:'emailAddress']
+      end
+
+      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
+
+      if attributes[:'id']
+        self.id = attributes[:'id']
+      end
+
+      if attributes[:'reason']
+        self.reason = attributes[:'reason']
+      end
+
+      if attributes[:'timeCreated']
+        self.time_created = attributes[:'timeCreated']
+      end
+
+      raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')
+
+      if attributes[:'time_created']
+        self.time_created = attributes[:'time_created']
+      end
+
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] reason Object to be assigned
+    def reason=(reason)
+      if reason && !REASON_ENUM.include?(reason)
+        @reason = REASON_UNKNOWN_ENUM_VALUE
+      else
+        @reason = reason
+      end
+    end
+
+    # 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 &&
+          email_address == other_object.email_address &&
+          id == other_object.id &&
+          reason == other_object.reason &&
+          time_created == other_object.time_created
+    end
+
+    # @see the `==` method
+    # @param [Object] other_object to be compared
+    def eql?(other_object)
+      self == other_object
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [email_address, id, reason, time_created].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          # 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) } )
+          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
+      end
+
+      self
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = public_method(attr).call
+        next if value.nil? && !instance_variable_defined?("@#{attr}")
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    private
+
+    # 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 
+    # @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) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      { 
+        :'email_address' => :'emailAddress',
+        :'id' => :'id',
+        :'reason' => :'reason',
+        :'time_created' => :'timeCreated'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      { 
+        :'email_address' => :'String',
+        :'id' => :'String',
+        :'reason' => :'String',
+        :'time_created' => :'DateTime'
+      }
+    end
+  end
+end

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

@@ -0,0 +1,192 @@
+# Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
+
+require 'date'
+
+module OCI
+  # The full information representing a suppression.
+  class Email::Models::SuppressionSummary
+
+    REASON_ENUM = [REASON_UNKNOWN = 'UNKNOWN',
+                REASON_HARDBOUNCE = 'HARDBOUNCE',
+                REASON_COMPLAINT = 'COMPLAINT',
+                REASON_MANUAL = 'MANUAL',
+                REASON_SOFTBOUNCE = 'SOFTBOUNCE',
+                REASON_UNSUBSCRIBE = 'UNSUBSCRIBE',
+                REASON_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
+
+    # The email address of the suppression.
+    # @return [String]
+    attr_accessor :email_address
+
+    # The unique OCID of the suppression.
+    # @return [String]
+    attr_accessor :id
+
+    # The reason that the email address was suppressed.
+    # @return [String]
+    attr_accessor :reason
+
+    # The date and time a recipient's email address was added to the
+    # suppression list, in \"YYYY-MM-ddThh:mmZ\" format with a Z offset, as
+    # defined by RFC 3339.
+    # 
+    # @return [DateTime]
+    attr_accessor :time_created
+
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :email_address The value to assign to the {#email_address} property
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [String] :reason The value to assign to the {#reason} property
+    # @option attributes [DateTime] :time_created The value to assign to the {#time_created} property
+    def initialize(attributes = {})
+      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}
+
+      if attributes[:'emailAddress']
+        self.email_address = attributes[:'emailAddress']
+      end
+
+      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
+
+      if attributes[:'id']
+        self.id = attributes[:'id']
+      end
+
+      if attributes[:'reason']
+        self.reason = attributes[:'reason']
+      end
+
+      if attributes[:'timeCreated']
+        self.time_created = attributes[:'timeCreated']
+      end
+
+      raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')
+
+      if attributes[:'time_created']
+        self.time_created = attributes[:'time_created']
+      end
+
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] reason Object to be assigned
+    def reason=(reason)
+      if reason && !REASON_ENUM.include?(reason)
+        @reason = REASON_UNKNOWN_ENUM_VALUE
+      else
+        @reason = reason
+      end
+    end
+
+    # 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 &&
+          email_address == other_object.email_address &&
+          id == other_object.id &&
+          reason == other_object.reason &&
+          time_created == other_object.time_created
+    end
+
+    # @see the `==` method
+    # @param [Object] other_object to be compared
+    def eql?(other_object)
+      self == other_object
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [email_address, id, reason, time_created].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          # 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) } )
+          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
+      end
+
+      self
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = public_method(attr).call
+        next if value.nil? && !instance_variable_defined?("@#{attr}")
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    private
+
+    # 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 
+    # @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) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      { 
+        :'email_address' => :'emailAddress',
+        :'id' => :'id',
+        :'reason' => :'reason',
+        :'time_created' => :'timeCreated'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      { 
+        :'email_address' => :'String',
+        :'id' => :'String',
+        :'reason' => :'String',
+        :'time_created' => :'DateTime'
+      }
+    end
+  end
+end