plainrouter-sdk 0.2.0 → 0.5.0

data/lib/plainrouter/openapi/models/ad_test_create_read_test_members_inner.rb

@@ -0,0 +1,232 @@
+=begin
+#Plainrouter Conversion API
+
+#Plainrouter public Signals Conversion API.
+
+The version of the OpenAPI document: 0.5.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PlainRouter::OpenAPI
+  class AdTestCreateReadTestMembersInner < ApiModelBase
+    attr_accessor :ad_id
+
+    attr_accessor :position
+
+    # Immutable normalized landing host once the member has a baseline.
+    attr_accessor :baseline_host
+
+    # Immutable normalized landing path once the member has a baseline.
+    attr_accessor :baseline_path
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ad_id' => :'ad_id',
+        :'position' => :'position',
+        :'baseline_host' => :'baseline_host',
+        :'baseline_path' => :'baseline_path'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'ad_id' => :'String',
+        :'position' => :'Integer',
+        :'baseline_host' => :'String',
+        :'baseline_path' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'baseline_host',
+        :'baseline_path'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PlainRouter::OpenAPI::AdTestCreateReadTestMembersInner` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PlainRouter::OpenAPI::AdTestCreateReadTestMembersInner`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'ad_id')
+        self.ad_id = attributes[:'ad_id']
+      else
+        self.ad_id = nil
+      end
+
+      if attributes.key?(:'position')
+        self.position = attributes[:'position']
+      else
+        self.position = nil
+      end
+
+      if attributes.key?(:'baseline_host')
+        self.baseline_host = attributes[:'baseline_host']
+      end
+
+      if attributes.key?(:'baseline_path')
+        self.baseline_path = attributes[:'baseline_path']
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @ad_id.nil?
+        invalid_properties.push('invalid value for "ad_id", ad_id cannot be nil.')
+      end
+
+      if @ad_id.to_s.length > 128
+        invalid_properties.push('invalid value for "ad_id", the character length must be smaller than or equal to 128.')
+      end
+
+      pattern = Regexp.new(/^[0-9]+$/)
+      if @ad_id !~ pattern
+        invalid_properties.push("invalid value for \"ad_id\", must conform to the pattern #{pattern}.")
+      end
+
+      if @position.nil?
+        invalid_properties.push('invalid value for "position", position cannot be nil.')
+      end
+
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @ad_id.nil?
+      return false if @ad_id.to_s.length > 128
+      return false if @ad_id !~ Regexp.new(/^[0-9]+$/)
+      return false if @position.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ad_id Value to be assigned
+    def ad_id=(ad_id)
+      if ad_id.nil?
+        fail ArgumentError, 'ad_id cannot be nil'
+      end
+
+      if ad_id.to_s.length > 128
+        fail ArgumentError, 'invalid value for "ad_id", the character length must be smaller than or equal to 128.'
+      end
+
+      pattern = Regexp.new(/^[0-9]+$/)
+      if ad_id !~ pattern
+        fail ArgumentError, "invalid value for \"ad_id\", must conform to the pattern #{pattern}."
+      end
+
+      @ad_id = ad_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] position Value to be assigned
+    def position=(position)
+      if position.nil?
+        fail ArgumentError, 'position cannot be nil'
+      end
+
+      @position = position
+    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 &&
+          ad_id == o.ad_id &&
+          position == o.position &&
+          baseline_host == o.baseline_host &&
+          baseline_path == o.baseline_path
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [ad_id, position, baseline_host, baseline_path].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/plainrouter/openapi/models/ad_test_create_read_test_pause_proposals_inner.rb

@@ -0,0 +1,286 @@
+=begin
+#Plainrouter Conversion API
+
+#Plainrouter public Signals Conversion API.
+
+The version of the OpenAPI document: 0.5.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PlainRouter::OpenAPI
+  class AdTestCreateReadTestPauseProposalsInner < ApiModelBase
+    attr_accessor :ad_id
+
+    attr_accessor :status
+
+    # Stable reason code when the proposal was skipped or expired.
+    attr_accessor :reason
+
+    # Immutable deadline 24 hours after the Test's candidates are created on the database clock.
+    attr_accessor :decision_deadline_at
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ad_id' => :'ad_id',
+        :'status' => :'status',
+        :'reason' => :'reason',
+        :'decision_deadline_at' => :'decision_deadline_at'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'ad_id' => :'String',
+        :'status' => :'String',
+        :'reason' => :'String',
+        :'decision_deadline_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'reason',
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PlainRouter::OpenAPI::AdTestCreateReadTestPauseProposalsInner` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PlainRouter::OpenAPI::AdTestCreateReadTestPauseProposalsInner`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'ad_id')
+        self.ad_id = attributes[:'ad_id']
+      else
+        self.ad_id = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'reason')
+        self.reason = attributes[:'reason']
+      else
+        self.reason = nil
+      end
+
+      if attributes.key?(:'decision_deadline_at')
+        self.decision_deadline_at = attributes[:'decision_deadline_at']
+      else
+        self.decision_deadline_at = nil
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @ad_id.nil?
+        invalid_properties.push('invalid value for "ad_id", ad_id cannot be nil.')
+      end
+
+      if @ad_id.to_s.length > 128
+        invalid_properties.push('invalid value for "ad_id", the character length must be smaller than or equal to 128.')
+      end
+
+      pattern = Regexp.new(/^[0-9]+$/)
+      if @ad_id !~ pattern
+        invalid_properties.push("invalid value for \"ad_id\", must conform to the pattern #{pattern}.")
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @decision_deadline_at.nil?
+        invalid_properties.push('invalid value for "decision_deadline_at", decision_deadline_at cannot be nil.')
+      end
+
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @ad_id.nil?
+      return false if @ad_id.to_s.length > 128
+      return false if @ad_id !~ Regexp.new(/^[0-9]+$/)
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["pending", "proposed", "skipped", "expired"])
+      return false unless status_validator.valid?(@status)
+      reason_validator = EnumAttributeValidator.new('String', ["already_paused", "deleted", "archived", "campaign_paused", "adset_paused", "decision_window_elapsed"])
+      return false unless reason_validator.valid?(@reason)
+      return false if @decision_deadline_at.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ad_id Value to be assigned
+    def ad_id=(ad_id)
+      if ad_id.nil?
+        fail ArgumentError, 'ad_id cannot be nil'
+      end
+
+      if ad_id.to_s.length > 128
+        fail ArgumentError, 'invalid value for "ad_id", the character length must be smaller than or equal to 128.'
+      end
+
+      pattern = Regexp.new(/^[0-9]+$/)
+      if ad_id !~ pattern
+        fail ArgumentError, "invalid value for \"ad_id\", must conform to the pattern #{pattern}."
+      end
+
+      @ad_id = ad_id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["pending", "proposed", "skipped", "expired"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] reason Object to be assigned
+    def reason=(reason)
+      validator = EnumAttributeValidator.new('String', ["already_paused", "deleted", "archived", "campaign_paused", "adset_paused", "decision_window_elapsed"])
+      unless validator.valid?(reason)
+        fail ArgumentError, "invalid value for \"reason\", must be one of #{validator.allowable_values}."
+      end
+      @reason = reason
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] decision_deadline_at Value to be assigned
+    def decision_deadline_at=(decision_deadline_at)
+      if decision_deadline_at.nil?
+        fail ArgumentError, 'decision_deadline_at cannot be nil'
+      end
+
+      @decision_deadline_at = decision_deadline_at
+    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 &&
+          ad_id == o.ad_id &&
+          status == o.status &&
+          reason == o.reason &&
+          decision_deadline_at == o.decision_deadline_at
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [ad_id, status, reason, decision_deadline_at].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end