cybersource_rest_client 0.0.72 → 0.0.74

data/lib/cybersource_rest_client/models/notificationsubscriptionsv2webhooks_retry_policy.rb

@@ -1,270 +1,270 @@
-=begin
-#CyberSource Merged Spec
-
-#All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
-
-OpenAPI spec version: 0.0.1
-
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.38
-=end
-
-require 'date'
-
-module CyberSource
-  # Retry policy for the individual webhooks that are a part of your subscription. If a message fails to deliver, it will execute through this retry policy.  Automatic suspend and resume:  If you experience downtime and have `deactivateFlag = true` any new messages will be held in a \"SUSPENDED\" status. When your healthCheckUrl returns healthy again, the subscription will automatically be re-enabled and your messages will be sent. We will ping your healthCheckUrl routinely using a POST call with an empty payload to check availability. If your endpoint returns an unhealthy status of != 200, we will check the healthCheckUrl at a more frequent rate until it is healthy again.  If you experience downtime and have `deactivateFlag = false` and your message exhausts all retry attempts the message will go to a \"FAILED\" status. Support will be notified and will reach out to suggest you execute the \"REPLAY\" endpoint at a later date when your server is healthy.   Reference the below values for formulas and calculations related to the frequency of retries depending on algorithm and configuration. 
-  class Notificationsubscriptionsv2webhooksRetryPolicy
-    # This is used to calculate the Retry Sequence.  Sample calculations using firstRetry=10, interval=30, maxNumberOfRetries=3 Arithmetic = a+r(n-1) Retry 1 - 10 minutes Retry 2 - 10+30x1 = 40 minutes Retry 3 - 10+30x2 = 70 minutes  Geometric = ar^(n-1) Retry 1 - 10 minutes Retry 2 - 10x30^1 = 300 minutes Retry 3 - 10x30^2 = 9,000 minutes 
-    attr_accessor :algorithm
-
-    # When to initiate first retry, after the initial call failed. (in mins).
-    attr_accessor :first_retry
-
-    # The interval between retries (in mins).
-    attr_accessor :interval
-
-    # The number of retries per sequence.
-    attr_accessor :number_of_retries
-
-    # Deactivate the subscription if your retries fail to deliver.  If this is set to `true`, the automatic suspend and resume feature will occur. This would prevent new webhooks from attempting to deliver and to queue up until your healthCheckUrl returns 200 again, then all messages will be sent.  If this is set to `false`, new individual messages will continue to retry and exhaust all failures, but the subscription will stay active. 
-    attr_accessor :deactivate_flag
-
-    # The number of times to repeat the complete retry sequence. 0 => don't repeat the retry sequence 1 => repeat the retry sequence once (R1, R2, R3)+ (R1, R2, R3) 2 => repeat the retry sequence twice (R1, R2, R3) + (R1, R2, R3) + (R1, R2, R3) 
-    attr_accessor :repeat_sequence_count
-
-    # The time to wait to before repeating the complete retry sequence. Amount of time to wait between each sequence. Sample calculation using repeatSequenceWaitTime=10 (R1, R2, R3) + (10) + (R1, R2, R3) + (10) + (R1, R2, R3) 
-    attr_accessor :repeat_sequence_wait_time
-
-    # Additional data, if any.
-    attr_accessor :additional_attributes
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'algorithm' => :'algorithm',
-        :'first_retry' => :'firstRetry',
-        :'interval' => :'interval',
-        :'number_of_retries' => :'numberOfRetries',
-        :'deactivate_flag' => :'deactivateFlag',
-        :'repeat_sequence_count' => :'repeatSequenceCount',
-        :'repeat_sequence_wait_time' => :'repeatSequenceWaitTime',
-        :'additional_attributes' => :'additionalAttributes'
-      }
-    end
-
-    # Attribute mapping from JSON key to ruby-style variable name.
-    def self.json_map
-      {
-        :'algorithm' => :'algorithm',
-        :'first_retry' => :'first_retry',
-        :'interval' => :'interval',
-        :'number_of_retries' => :'number_of_retries',
-        :'deactivate_flag' => :'deactivate_flag',
-        :'repeat_sequence_count' => :'repeat_sequence_count',
-        :'repeat_sequence_wait_time' => :'repeat_sequence_wait_time',
-        :'additional_attributes' => :'additional_attributes'
-      }
-    end
-
-    # Attribute type mapping.
-    def self.swagger_types
-      {
-        :'algorithm' => :'String',
-        :'first_retry' => :'Integer',
-        :'interval' => :'Integer',
-        :'number_of_retries' => :'Integer',
-        :'deactivate_flag' => :'String',
-        :'repeat_sequence_count' => :'Integer',
-        :'repeat_sequence_wait_time' => :'Integer',
-        :'additional_attributes' => :'Array<Hash<String, String>>'
-      }
-    end
-
-    # Initializes the object
-    # @param [Hash] attributes Model attributes in the form of hash
-    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.has_key?(:'algorithm')
-        self.algorithm = attributes[:'algorithm']
-      end
-
-      if attributes.has_key?(:'firstRetry')
-        self.first_retry = attributes[:'firstRetry']
-      end
-
-      if attributes.has_key?(:'interval')
-        self.interval = attributes[:'interval']
-      end
-
-      if attributes.has_key?(:'numberOfRetries')
-        self.number_of_retries = attributes[:'numberOfRetries']
-      end
-
-      if attributes.has_key?(:'deactivateFlag')
-        self.deactivate_flag = attributes[:'deactivateFlag']
-      end
-
-      if attributes.has_key?(:'repeatSequenceCount')
-        self.repeat_sequence_count = attributes[:'repeatSequenceCount']
-      end
-
-      if attributes.has_key?(:'repeatSequenceWaitTime')
-        self.repeat_sequence_wait_time = attributes[:'repeatSequenceWaitTime']
-      end
-
-      if attributes.has_key?(:'additionalAttributes')
-        if (value = attributes[:'additionalAttributes']).is_a?(Array)
-          self.additional_attributes = value
-        end
-      end
-    end
-
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    def list_invalid_properties
-      invalid_properties = Array.new
-      invalid_properties
-    end
-
-    # Check to see if the all the properties in the model are valid
-    # @return true if the model is valid
-    def valid?
-      true
-    end
-
-    # Checks equality by comparing each attribute.
-    # @param [Object] Object to be compared
-    def ==(o)
-      return true if self.equal?(o)
-      self.class == o.class &&
-          algorithm == o.algorithm &&
-          first_retry == o.first_retry &&
-          interval == o.interval &&
-          number_of_retries == o.number_of_retries &&
-          deactivate_flag == o.deactivate_flag &&
-          repeat_sequence_count == o.repeat_sequence_count &&
-          repeat_sequence_wait_time == o.repeat_sequence_wait_time &&
-          additional_attributes == o.additional_attributes
-    end
-
-    # @see the `==` method
-    # @param [Object] Object to be compared
-    def eql?(o)
-      self == o
-    end
-
-    # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
-    def hash
-      [algorithm, first_retry, interval, number_of_retries, deactivate_flag, repeat_sequence_count, repeat_sequence_wait_time, additional_attributes].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 =~ /\AArray<(.*)>/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.send("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
-          end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{self.class.json_map[key]}=", _deserialize(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
-
-    # Deserializes the data based on type
-    # @param string type Data type
-    # @param string value Value to be deserialized
-    # @return [Object] Deserialized data
-    def _deserialize(type, value)
-      case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
-      when :Date
-        Date.parse(value)
-      when :String
-        value.to_s
-      when :Integer
-        value.to_i
-      when :Float
-        value.to_f
-      when :BOOLEAN
-        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
-          true
-        else
-          false
-        end
-      when :Object
-        # generic object (usually a Hash), return directly
-        value
-      when /\AArray<(?<inner_type>.+)>\z/
-        inner_type = Regexp.last_match[:inner_type]
-        value.map { |v| _deserialize(inner_type, v) }
-      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
-        k_type = Regexp.last_match[:k_type]
-        v_type = Regexp.last_match[:v_type]
-        {}.tap do |hash|
-          value.each do |k, v|
-            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
-          end
-        end
-      else # model
-        temp_model = CyberSource.const_get(type).new
-        temp_model.build_from_hash(value)
-      end
-    end
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
-    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 = self.send(attr)
-        next if value.nil?
-        hash[param] = _to_hash(value)
-      end
-      hash
-    end
-
-    # 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
+=begin
+#CyberSource Merged Spec
+
+#All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
+
+OpenAPI spec version: 0.0.1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.38
+=end
+
+require 'date'
+
+module CyberSource
+  # Retry policy for the individual webhooks that are a part of your subscription. If a message fails to deliver, it will execute through this retry policy.  Automatic suspend and resume:  If you experience downtime and have `deactivateFlag = true` any new messages will be held in a \"SUSPENDED\" status. When your healthCheckUrl returns healthy again, the subscription will automatically be re-enabled and your messages will be sent. We will ping your healthCheckUrl routinely using a POST call with an empty payload to check availability. If your endpoint returns an unhealthy status of != 200, we will check the healthCheckUrl at a more frequent rate until it is healthy again.  If you experience downtime and have `deactivateFlag = false` and your message exhausts all retry attempts the message will go to a \"FAILED\" status. Support will be notified and will reach out to suggest you execute the \"REPLAY\" endpoint at a later date when your server is healthy.   Reference the below values for formulas and calculations related to the frequency of retries depending on algorithm and configuration. 
+  class Notificationsubscriptionsv2webhooksRetryPolicy
+    # This is used to calculate the Retry Sequence.  Sample calculations using firstRetry=10, interval=30, maxNumberOfRetries=3 Arithmetic = a+r(n-1) Retry 1 - 10 minutes Retry 2 - 10+30x1 = 40 minutes Retry 3 - 10+30x2 = 70 minutes  Geometric = ar^(n-1) Retry 1 - 10 minutes Retry 2 - 10x30^1 = 300 minutes Retry 3 - 10x30^2 = 9,000 minutes 
+    attr_accessor :algorithm
+
+    # When to initiate first retry, after the initial call failed. (in mins).
+    attr_accessor :first_retry
+
+    # The interval between retries (in mins).
+    attr_accessor :interval
+
+    # The number of retries per sequence.
+    attr_accessor :number_of_retries
+
+    # Deactivate the subscription if your retries fail to deliver.  If this is set to `true`, the automatic suspend and resume feature will occur. This would prevent new webhooks from attempting to deliver and to queue up until your healthCheckUrl returns 200 again, then all messages will be sent.  If this is set to `false`, new individual messages will continue to retry and exhaust all failures, but the subscription will stay active. 
+    attr_accessor :deactivate_flag
+
+    # The number of times to repeat the complete retry sequence. 0 => don't repeat the retry sequence 1 => repeat the retry sequence once (R1, R2, R3)+ (R1, R2, R3) 2 => repeat the retry sequence twice (R1, R2, R3) + (R1, R2, R3) + (R1, R2, R3) 
+    attr_accessor :repeat_sequence_count
+
+    # The time to wait to before repeating the complete retry sequence. Amount of time to wait between each sequence. Sample calculation using repeatSequenceWaitTime=10 (R1, R2, R3) + (10) + (R1, R2, R3) + (10) + (R1, R2, R3) 
+    attr_accessor :repeat_sequence_wait_time
+
+    # Additional data, if any.
+    attr_accessor :additional_attributes
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'algorithm' => :'algorithm',
+        :'first_retry' => :'firstRetry',
+        :'interval' => :'interval',
+        :'number_of_retries' => :'numberOfRetries',
+        :'deactivate_flag' => :'deactivateFlag',
+        :'repeat_sequence_count' => :'repeatSequenceCount',
+        :'repeat_sequence_wait_time' => :'repeatSequenceWaitTime',
+        :'additional_attributes' => :'additionalAttributes'
+      }
+    end
+
+    # Attribute mapping from JSON key to ruby-style variable name.
+    def self.json_map
+      {
+        :'algorithm' => :'algorithm',
+        :'first_retry' => :'first_retry',
+        :'interval' => :'interval',
+        :'number_of_retries' => :'number_of_retries',
+        :'deactivate_flag' => :'deactivate_flag',
+        :'repeat_sequence_count' => :'repeat_sequence_count',
+        :'repeat_sequence_wait_time' => :'repeat_sequence_wait_time',
+        :'additional_attributes' => :'additional_attributes'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'algorithm' => :'String',
+        :'first_retry' => :'Integer',
+        :'interval' => :'Integer',
+        :'number_of_retries' => :'Integer',
+        :'deactivate_flag' => :'String',
+        :'repeat_sequence_count' => :'Integer',
+        :'repeat_sequence_wait_time' => :'Integer',
+        :'additional_attributes' => :'Array<Hash<String, String>>'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    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.has_key?(:'algorithm')
+        self.algorithm = attributes[:'algorithm']
+      end
+
+      if attributes.has_key?(:'firstRetry')
+        self.first_retry = attributes[:'firstRetry']
+      end
+
+      if attributes.has_key?(:'interval')
+        self.interval = attributes[:'interval']
+      end
+
+      if attributes.has_key?(:'numberOfRetries')
+        self.number_of_retries = attributes[:'numberOfRetries']
+      end
+
+      if attributes.has_key?(:'deactivateFlag')
+        self.deactivate_flag = attributes[:'deactivateFlag']
+      end
+
+      if attributes.has_key?(:'repeatSequenceCount')
+        self.repeat_sequence_count = attributes[:'repeatSequenceCount']
+      end
+
+      if attributes.has_key?(:'repeatSequenceWaitTime')
+        self.repeat_sequence_wait_time = attributes[:'repeatSequenceWaitTime']
+      end
+
+      if attributes.has_key?(:'additionalAttributes')
+        if (value = attributes[:'additionalAttributes']).is_a?(Array)
+          self.additional_attributes = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          algorithm == o.algorithm &&
+          first_retry == o.first_retry &&
+          interval == o.interval &&
+          number_of_retries == o.number_of_retries &&
+          deactivate_flag == o.deactivate_flag &&
+          repeat_sequence_count == o.repeat_sequence_count &&
+          repeat_sequence_wait_time == o.repeat_sequence_wait_time &&
+          additional_attributes == o.additional_attributes
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [algorithm, first_retry, interval, number_of_retries, deactivate_flag, repeat_sequence_count, repeat_sequence_wait_time, additional_attributes].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 =~ /\AArray<(.*)>/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.send("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{self.class.json_map[key]}=", _deserialize(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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = CyberSource.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    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 = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # 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