oci 2.14.0 → 2.15.0

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

@@ -0,0 +1,17 @@
+# Copyright (c) 2016, 2021, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+module OCI
+  module Email::Models
+    OPERATION_TYPE_ENUM = [
+      OPERATION_TYPE_CREATE_DKIM = 'CREATE_DKIM'.freeze,
+      OPERATION_TYPE_DELETE_DKIM = 'DELETE_DKIM'.freeze,
+      OPERATION_TYPE_MOVE_DKIM = 'MOVE_DKIM'.freeze,
+      OPERATION_TYPE_UPDATE_DKIM = 'UPDATE_DKIM'.freeze,
+      OPERATION_TYPE_CREATE_EMAIL_DOMAIN = 'CREATE_EMAIL_DOMAIN'.freeze,
+      OPERATION_TYPE_DELETE_EMAIL_DOMAIN = 'DELETE_EMAIL_DOMAIN'.freeze,
+      OPERATION_TYPE_MOVE_EMAIL_DOMAIN = 'MOVE_EMAIL_DOMAIN'.freeze,
+      OPERATION_TYPE_UPDATE_EMAIL_DOMAIN = 'UPDATE_EMAIL_DOMAIN'.freeze
+    ].freeze
+  end
+end

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

@@ -16,15 +16,15 @@ module OCI
       LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
     ].freeze
 
-    # The OCID for the compartment.
+    # **[Required]** The OCID for the compartment.
     # @return [String]
     attr_accessor :compartment_id
 
-    # Email address of the sender.
+    # **[Required]** Email address of the sender.
     # @return [String]
     attr_accessor :email_address
 
-    # The unique OCID of the sender.
+    # **[Required]** The unique OCID of the sender.
     # @return [String]
     attr_accessor :id
 
@@ -44,8 +44,14 @@ module OCI
     # @return [DateTime]
     attr_accessor :time_created
 
+    # The email domain used to assert responsibility for emails sent from this sender.
+    #
+    # @return [String]
+    attr_accessor :email_domain_id
+
     # Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
     # For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
+    #
     # Example: `{\"Department\": \"Finance\"}`
     #
     # @return [Hash<String, String>]
@@ -53,6 +59,7 @@ module OCI
 
     # Defined tags for this resource. Each key is predefined and scoped to a namespace.
     # For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
+    #
     # Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
     #
     # @return [Hash<String, Hash<String, Object>>]
@@ -68,6 +75,7 @@ module OCI
         'is_spf': :'isSpf',
         'lifecycle_state': :'lifecycleState',
         'time_created': :'timeCreated',
+        'email_domain_id': :'emailDomainId',
         'freeform_tags': :'freeformTags',
         'defined_tags': :'definedTags'
         # rubocop:enable Style/SymbolLiteral
@@ -84,6 +92,7 @@ module OCI
         'is_spf': :'BOOLEAN',
         'lifecycle_state': :'String',
         'time_created': :'DateTime',
+        'email_domain_id': :'String',
         'freeform_tags': :'Hash<String, String>',
         'defined_tags': :'Hash<String, Hash<String, Object>>'
         # rubocop:enable Style/SymbolLiteral
@@ -102,6 +111,7 @@ module OCI
     # @option attributes [BOOLEAN] :is_spf The value to assign to the {#is_spf} 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
+    # @option attributes [String] :email_domain_id The value to assign to the {#email_domain_id} property
     # @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property
     # @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property
     def initialize(attributes = {})
@@ -144,6 +154,12 @@ module OCI
 
       self.time_created = attributes[:'time_created'] if attributes[:'time_created']
 
+      self.email_domain_id = attributes[:'emailDomainId'] if attributes[:'emailDomainId']
+
+      raise 'You cannot provide both :emailDomainId and :email_domain_id' if attributes.key?(:'emailDomainId') && attributes.key?(:'email_domain_id')
+
+      self.email_domain_id = attributes[:'email_domain_id'] if attributes[:'email_domain_id']
+
       self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']
 
       raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')
@@ -187,6 +203,7 @@ module OCI
         is_spf == other.is_spf &&
         lifecycle_state == other.lifecycle_state &&
         time_created == other.time_created &&
+        email_domain_id == other.email_domain_id &&
         freeform_tags == other.freeform_tags &&
         defined_tags == other.defined_tags
     end
@@ -204,7 +221,7 @@ module OCI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [compartment_id, email_address, id, is_spf, lifecycle_state, time_created, freeform_tags, defined_tags].hash
+      [compartment_id, email_address, id, is_spf, lifecycle_state, time_created, email_domain_id, freeform_tags, defined_tags].hash
     end
     # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
 

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

@@ -16,15 +16,15 @@ module OCI
       LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
     ].freeze
 
-    # The OCID for the compartment.
+    # **[Required]** The OCID for the compartment.
     # @return [String]
     attr_accessor :compartment_id
 
-    # The email address of the sender.
+    # **[Required]** The email address of the sender.
     # @return [String]
     attr_accessor :email_address
 
-    # The unique ID of the sender.
+    # **[Required]** The unique ID of the sender.
     # @return [String]
     attr_accessor :id
 
@@ -40,6 +40,7 @@ module OCI
 
     # Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
     # For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
+    #
     # Example: `{\"Department\": \"Finance\"}`
     #
     # @return [Hash<String, String>]
@@ -47,6 +48,7 @@ module OCI
 
     # Defined tags for this resource. Each key is predefined and scoped to a namespace.
     # For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
+    #
     # Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
     #
     # @return [Hash<String, Hash<String, Object>>]

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

@@ -0,0 +1,11 @@
+# Copyright (c) 2016, 2021, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+module OCI
+  module Email::Models
+    SORT_ORDER_ENUM = [
+      SORT_ORDER_ASC = 'ASC'.freeze,
+      SORT_ORDER_DESC = 'DESC'.freeze
+    ].freeze
+  end
+end

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

@@ -18,18 +18,18 @@ module OCI
       REASON_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
     ].freeze
 
-    # The OCID of the compartment to contain the suppression. Since
+    # **[Required]** 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
 
-    # Email address of the suppression.
+    # **[Required]** Email address of the suppression.
     # @return [String]
     attr_accessor :email_address
 
-    # The unique ID of the suppression.
+    # **[Required]** The unique ID of the suppression.
     # @return [String]
     attr_accessor :id
 
@@ -43,6 +43,36 @@ module OCI
     # @return [DateTime]
     attr_accessor :time_created
 
+    # The last date and time the suppression prevented submission
+    # in \"YYYY-MM-ddThh:mmZ\"
+    # format with a Z offset, as defined by RFC 3339.
+    #
+    # @return [DateTime]
+    attr_accessor :time_last_suppressed
+
+    # The value of the Message-ID header from the email that triggered a suppression.
+    # This value is as defined in RFC 5322 section 3.6.4, excluding angle-brackets.
+    # Not provided for all types of suppressions.
+    #
+    # @return [String]
+    attr_accessor :message_id
+
+    # The specific error message returned by a system that resulted in the suppression.
+    # This message is usually an SMTP error code with additional descriptive text.
+    # Not provided for all types of suppressions.
+    #
+    # @return [String]
+    attr_accessor :error_detail
+
+    # DNS name of the source of the error that caused the suppression.
+    # Will be set to either the remote-mta or reporting-mta field from a delivery status notification (RFC 3464) when available.
+    # Not provided for all types of suppressions, and not always known.
+    #
+    # Note: Most SMTP errors that cause suppressions come from software run by email receiving systems rather than from OCI email delivery itself.
+    #
+    # @return [String]
+    attr_accessor :error_source
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -51,7 +81,11 @@ module OCI
         'email_address': :'emailAddress',
         'id': :'id',
         'reason': :'reason',
-        'time_created': :'timeCreated'
+        'time_created': :'timeCreated',
+        'time_last_suppressed': :'timeLastSuppressed',
+        'message_id': :'messageId',
+        'error_detail': :'errorDetail',
+        'error_source': :'errorSource'
         # rubocop:enable Style/SymbolLiteral
       }
     end
@@ -64,7 +98,11 @@ module OCI
         'email_address': :'String',
         'id': :'String',
         'reason': :'String',
-        'time_created': :'DateTime'
+        'time_created': :'DateTime',
+        'time_last_suppressed': :'DateTime',
+        'message_id': :'String',
+        'error_detail': :'String',
+        'error_source': :'String'
         # rubocop:enable Style/SymbolLiteral
       }
     end
@@ -80,6 +118,10 @@ module OCI
     # @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
+    # @option attributes [DateTime] :time_last_suppressed The value to assign to the {#time_last_suppressed} property
+    # @option attributes [String] :message_id The value to assign to the {#message_id} property
+    # @option attributes [String] :error_detail The value to assign to the {#error_detail} property
+    # @option attributes [String] :error_source The value to assign to the {#error_source} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
@@ -107,6 +149,30 @@ module OCI
       raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')
 
       self.time_created = attributes[:'time_created'] if attributes[:'time_created']
+
+      self.time_last_suppressed = attributes[:'timeLastSuppressed'] if attributes[:'timeLastSuppressed']
+
+      raise 'You cannot provide both :timeLastSuppressed and :time_last_suppressed' if attributes.key?(:'timeLastSuppressed') && attributes.key?(:'time_last_suppressed')
+
+      self.time_last_suppressed = attributes[:'time_last_suppressed'] if attributes[:'time_last_suppressed']
+
+      self.message_id = attributes[:'messageId'] if attributes[:'messageId']
+
+      raise 'You cannot provide both :messageId and :message_id' if attributes.key?(:'messageId') && attributes.key?(:'message_id')
+
+      self.message_id = attributes[:'message_id'] if attributes[:'message_id']
+
+      self.error_detail = attributes[:'errorDetail'] if attributes[:'errorDetail']
+
+      raise 'You cannot provide both :errorDetail and :error_detail' if attributes.key?(:'errorDetail') && attributes.key?(:'error_detail')
+
+      self.error_detail = attributes[:'error_detail'] if attributes[:'error_detail']
+
+      self.error_source = attributes[:'errorSource'] if attributes[:'errorSource']
+
+      raise 'You cannot provide both :errorSource and :error_source' if attributes.key?(:'errorSource') && attributes.key?(:'error_source')
+
+      self.error_source = attributes[:'error_source'] if attributes[:'error_source']
     end
     # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
     # rubocop:enable Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
@@ -137,7 +203,11 @@ module OCI
         email_address == other.email_address &&
         id == other.id &&
         reason == other.reason &&
-        time_created == other.time_created
+        time_created == other.time_created &&
+        time_last_suppressed == other.time_last_suppressed &&
+        message_id == other.message_id &&
+        error_detail == other.error_detail &&
+        error_source == other.error_source
     end
     # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
 
@@ -153,7 +223,7 @@ module OCI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [compartment_id, email_address, id, reason, time_created].hash
+      [compartment_id, email_address, id, reason, time_created, time_last_suppressed, message_id, error_detail, error_source].hash
     end
     # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
 

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

@@ -18,15 +18,15 @@ module OCI
       REASON_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
     ].freeze
 
-    # The OCID for the compartment.
+    # **[Required]** The OCID for the compartment.
     # @return [String]
     attr_accessor :compartment_id
 
-    # The email address of the suppression.
+    # **[Required]** The email address of the suppression.
     # @return [String]
     attr_accessor :email_address
 
-    # The unique OCID of the suppression.
+    # **[Required]** The unique OCID of the suppression.
     # @return [String]
     attr_accessor :id
 

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

@@ -0,0 +1,189 @@
+# Copyright (c) 2016, 2021, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+require 'date'
+
+# rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
+module OCI
+  # The attributes to update in the DKIM.
+  #
+  class Email::Models::UpdateDkimDetails
+    # A string that describes the details about the DKIM. It does not have to be unique,
+    # and you can change it. Avoid entering confidential information.
+    #
+    # @return [String]
+    attr_accessor :description
+
+    # Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
+    # For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
+    #
+    # Example: `{\"Department\": \"Finance\"}`
+    #
+    # @return [Hash<String, String>]
+    attr_accessor :freeform_tags
+
+    # Defined tags for this resource. Each key is predefined and scoped to a namespace.
+    # For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
+    #
+    # Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
+    #
+    # @return [Hash<String, Hash<String, Object>>]
+    attr_accessor :defined_tags
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'description': :'description',
+        'freeform_tags': :'freeformTags',
+        'defined_tags': :'definedTags'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'description': :'String',
+        'freeform_tags': :'Hash<String, String>',
+        'defined_tags': :'Hash<String, Hash<String, Object>>'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :description The value to assign to the {#description} property
+    # @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property
+    # @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} 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 }
+
+      self.description = attributes[:'description'] if attributes[:'description']
+
+      self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']
+
+      raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')
+
+      self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']
+
+      self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']
+
+      raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')
+
+      self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable 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 the other object to be compared
+    def ==(other)
+      return true if equal?(other)
+
+      self.class == other.class &&
+        description == other.description &&
+        freeform_tags == other.freeform_tags &&
+        defined_tags == other.defined_tags
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
+
+    # @see the `==` method
+    # @param [Object] other the other object to be compared
+    def eql?(other)
+      self == other
+    end
+
+    # rubocop:disable Metrics/AbcSize, Layout/EmptyLines
+
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [description, freeform_tags, defined_tags].hash
+    end
+    # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
+
+    # rubocop:disable Metrics/AbcSize, Layout/EmptyLines
+
+
+    # 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)
+            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?
+          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
+    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
+  end
+end
+# rubocop:enable Lint/UnneededCopDisableDirective, Metrics/LineLength