plainrouter-sdk 0.2.0 → 0.5.0

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

@@ -0,0 +1,103 @@
+=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
+  module ActionsApiDryRun401Response
+    class << self
+      # List of class defined in anyOf (OpenAPI v3)
+      def openapi_any_of
+        [
+          :'AgentCredentialError',
+          :'ErrorMessage'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of anyOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of anyOf items and attempt to identify the appropriate one.
+        # Note:
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_any_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            return find_and_cast_into_type(klass, data)
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_any_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.iso8601(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = PlainRouter::OpenAPI.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_any_of) # nested anyOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      end
+    end
+  end
+
+end

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

@@ -0,0 +1,103 @@
+=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
+  module ActionsTestsApiIndex404Response
+    class << self
+      # List of class defined in anyOf (OpenAPI v3)
+      def openapi_any_of
+        [
+          :'ApiRouteNotFound',
+          :'ErrorMessage'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of anyOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of anyOf items and attempt to identify the appropriate one.
+        # Note:
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_any_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            return find_and_cast_into_type(klass, data)
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_any_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.iso8601(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = PlainRouter::OpenAPI.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_any_of) # nested anyOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      end
+    end
+  end
+
+end

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

@@ -0,0 +1,467 @@
+=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 ActionsTestsApiStoreRequest < ApiModelBase
+    attr_accessor :platform_ad_account_id
+
+    attr_accessor :ad_set_id
+
+    # Two to four distinct Meta ad IDs shown in the selected ad set inventory.
+    attr_accessor :member_ad_ids
+
+    attr_accessor :axis
+
+    # An observed workspace conversion event other than PageView.
+    attr_accessor :event_name
+
+    # Optional override; default 50 counted arrivals per member.
+    attr_accessor :arrivals_floor
+
+    # Optional override; default 10 recorded conversions for a winner.
+    attr_accessor :minimum_conversions
+
+    # Optional override; default 14 complete account-local days.
+    attr_accessor :maximum_days
+
+    attr_accessor :maximum_spend_minor
+
+    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
+      {
+        :'platform_ad_account_id' => :'platform_ad_account_id',
+        :'ad_set_id' => :'ad_set_id',
+        :'member_ad_ids' => :'member_ad_ids',
+        :'axis' => :'axis',
+        :'event_name' => :'event_name',
+        :'arrivals_floor' => :'arrivals_floor',
+        :'minimum_conversions' => :'minimum_conversions',
+        :'maximum_days' => :'maximum_days',
+        :'maximum_spend_minor' => :'maximum_spend_minor'
+      }
+    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
+      {
+        :'platform_ad_account_id' => :'Integer',
+        :'ad_set_id' => :'String',
+        :'member_ad_ids' => :'Array<String>',
+        :'axis' => :'String',
+        :'event_name' => :'String',
+        :'arrivals_floor' => :'Integer',
+        :'minimum_conversions' => :'Integer',
+        :'maximum_days' => :'Integer',
+        :'maximum_spend_minor' => :'ActionsTestsApiStoreRequestMaximumSpendMinor'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'maximum_spend_minor'
+      ])
+    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::ActionsTestsApiStoreRequest` 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::ActionsTestsApiStoreRequest`. 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?(:'platform_ad_account_id')
+        self.platform_ad_account_id = attributes[:'platform_ad_account_id']
+      else
+        self.platform_ad_account_id = nil
+      end
+
+      if attributes.key?(:'ad_set_id')
+        self.ad_set_id = attributes[:'ad_set_id']
+      else
+        self.ad_set_id = nil
+      end
+
+      if attributes.key?(:'member_ad_ids')
+        if (value = attributes[:'member_ad_ids']).is_a?(Array)
+          self.member_ad_ids = value
+        end
+      else
+        self.member_ad_ids = nil
+      end
+
+      if attributes.key?(:'axis')
+        self.axis = attributes[:'axis']
+      else
+        self.axis = nil
+      end
+
+      if attributes.key?(:'event_name')
+        self.event_name = attributes[:'event_name']
+      else
+        self.event_name = nil
+      end
+
+      if attributes.key?(:'arrivals_floor')
+        self.arrivals_floor = attributes[:'arrivals_floor']
+      end
+
+      if attributes.key?(:'minimum_conversions')
+        self.minimum_conversions = attributes[:'minimum_conversions']
+      end
+
+      if attributes.key?(:'maximum_days')
+        self.maximum_days = attributes[:'maximum_days']
+      end
+
+      if attributes.key?(:'maximum_spend_minor')
+        self.maximum_spend_minor = attributes[:'maximum_spend_minor']
+      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 @platform_ad_account_id.nil?
+        invalid_properties.push('invalid value for "platform_ad_account_id", platform_ad_account_id cannot be nil.')
+      end
+
+      if @platform_ad_account_id < 1
+        invalid_properties.push('invalid value for "platform_ad_account_id", must be greater than or equal to 1.')
+      end
+
+      if @ad_set_id.nil?
+        invalid_properties.push('invalid value for "ad_set_id", ad_set_id cannot be nil.')
+      end
+
+      if @ad_set_id.to_s.length > 128
+        invalid_properties.push('invalid value for "ad_set_id", the character length must be smaller than or equal to 128.')
+      end
+
+      pattern = Regexp.new(/^[0-9]+$/)
+      if @ad_set_id !~ pattern
+        invalid_properties.push("invalid value for \"ad_set_id\", must conform to the pattern #{pattern}.")
+      end
+
+      if @member_ad_ids.nil?
+        invalid_properties.push('invalid value for "member_ad_ids", member_ad_ids cannot be nil.')
+      end
+
+      if @member_ad_ids.length > 4
+        invalid_properties.push('invalid value for "member_ad_ids", number of items must be less than or equal to 4.')
+      end
+
+      if @member_ad_ids.length < 2
+        invalid_properties.push('invalid value for "member_ad_ids", number of items must be greater than or equal to 2.')
+      end
+
+      if @axis.nil?
+        invalid_properties.push('invalid value for "axis", axis cannot be nil.')
+      end
+
+      if @event_name.nil?
+        invalid_properties.push('invalid value for "event_name", event_name cannot be nil.')
+      end
+
+      if @event_name.to_s.length > 255
+        invalid_properties.push('invalid value for "event_name", the character length must be smaller than or equal to 255.')
+      end
+
+      if @event_name.to_s.length < 1
+        invalid_properties.push('invalid value for "event_name", the character length must be greater than or equal to 1.')
+      end
+
+      if !@arrivals_floor.nil? && @arrivals_floor < 50
+        invalid_properties.push('invalid value for "arrivals_floor", must be greater than or equal to 50.')
+      end
+
+      if !@minimum_conversions.nil? && @minimum_conversions < 1
+        invalid_properties.push('invalid value for "minimum_conversions", must be greater than or equal to 1.')
+      end
+
+      if !@maximum_days.nil? && @maximum_days > 30
+        invalid_properties.push('invalid value for "maximum_days", must be smaller than or equal to 30.')
+      end
+
+      if !@maximum_days.nil? && @maximum_days < 3
+        invalid_properties.push('invalid value for "maximum_days", must be greater than or equal to 3.')
+      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 @platform_ad_account_id.nil?
+      return false if @platform_ad_account_id < 1
+      return false if @ad_set_id.nil?
+      return false if @ad_set_id.to_s.length > 128
+      return false if @ad_set_id !~ Regexp.new(/^[0-9]+$/)
+      return false if @member_ad_ids.nil?
+      return false if @member_ad_ids.length > 4
+      return false if @member_ad_ids.length < 2
+      return false if @axis.nil?
+      axis_validator = EnumAttributeValidator.new('String', ["hook", "angle", "visual", "offer", "format", "landing"])
+      return false unless axis_validator.valid?(@axis)
+      return false if @event_name.nil?
+      return false if @event_name.to_s.length > 255
+      return false if @event_name.to_s.length < 1
+      return false if !@arrivals_floor.nil? && @arrivals_floor < 50
+      return false if !@minimum_conversions.nil? && @minimum_conversions < 1
+      return false if !@maximum_days.nil? && @maximum_days > 30
+      return false if !@maximum_days.nil? && @maximum_days < 3
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] platform_ad_account_id Value to be assigned
+    def platform_ad_account_id=(platform_ad_account_id)
+      if platform_ad_account_id.nil?
+        fail ArgumentError, 'platform_ad_account_id cannot be nil'
+      end
+
+      if platform_ad_account_id < 1
+        fail ArgumentError, 'invalid value for "platform_ad_account_id", must be greater than or equal to 1.'
+      end
+
+      @platform_ad_account_id = platform_ad_account_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ad_set_id Value to be assigned
+    def ad_set_id=(ad_set_id)
+      if ad_set_id.nil?
+        fail ArgumentError, 'ad_set_id cannot be nil'
+      end
+
+      if ad_set_id.to_s.length > 128
+        fail ArgumentError, 'invalid value for "ad_set_id", the character length must be smaller than or equal to 128.'
+      end
+
+      pattern = Regexp.new(/^[0-9]+$/)
+      if ad_set_id !~ pattern
+        fail ArgumentError, "invalid value for \"ad_set_id\", must conform to the pattern #{pattern}."
+      end
+
+      @ad_set_id = ad_set_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] member_ad_ids Value to be assigned
+    def member_ad_ids=(member_ad_ids)
+      if member_ad_ids.nil?
+        fail ArgumentError, 'member_ad_ids cannot be nil'
+      end
+
+      if member_ad_ids.length > 4
+        fail ArgumentError, 'invalid value for "member_ad_ids", number of items must be less than or equal to 4.'
+      end
+
+      if member_ad_ids.length < 2
+        fail ArgumentError, 'invalid value for "member_ad_ids", number of items must be greater than or equal to 2.'
+      end
+
+      @member_ad_ids = member_ad_ids
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] axis Object to be assigned
+    def axis=(axis)
+      validator = EnumAttributeValidator.new('String', ["hook", "angle", "visual", "offer", "format", "landing"])
+      unless validator.valid?(axis)
+        fail ArgumentError, "invalid value for \"axis\", must be one of #{validator.allowable_values}."
+      end
+      @axis = axis
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] event_name Value to be assigned
+    def event_name=(event_name)
+      if event_name.nil?
+        fail ArgumentError, 'event_name cannot be nil'
+      end
+
+      if event_name.to_s.length > 255
+        fail ArgumentError, 'invalid value for "event_name", the character length must be smaller than or equal to 255.'
+      end
+
+      if event_name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "event_name", the character length must be greater than or equal to 1.'
+      end
+
+      @event_name = event_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] arrivals_floor Value to be assigned
+    def arrivals_floor=(arrivals_floor)
+      if arrivals_floor.nil?
+        fail ArgumentError, 'arrivals_floor cannot be nil'
+      end
+
+      if arrivals_floor < 50
+        fail ArgumentError, 'invalid value for "arrivals_floor", must be greater than or equal to 50.'
+      end
+
+      @arrivals_floor = arrivals_floor
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] minimum_conversions Value to be assigned
+    def minimum_conversions=(minimum_conversions)
+      if minimum_conversions.nil?
+        fail ArgumentError, 'minimum_conversions cannot be nil'
+      end
+
+      if minimum_conversions < 1
+        fail ArgumentError, 'invalid value for "minimum_conversions", must be greater than or equal to 1.'
+      end
+
+      @minimum_conversions = minimum_conversions
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] maximum_days Value to be assigned
+    def maximum_days=(maximum_days)
+      if maximum_days.nil?
+        fail ArgumentError, 'maximum_days cannot be nil'
+      end
+
+      if maximum_days > 30
+        fail ArgumentError, 'invalid value for "maximum_days", must be smaller than or equal to 30.'
+      end
+
+      if maximum_days < 3
+        fail ArgumentError, 'invalid value for "maximum_days", must be greater than or equal to 3.'
+      end
+
+      @maximum_days = maximum_days
+    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 &&
+          platform_ad_account_id == o.platform_ad_account_id &&
+          ad_set_id == o.ad_set_id &&
+          member_ad_ids == o.member_ad_ids &&
+          axis == o.axis &&
+          event_name == o.event_name &&
+          arrivals_floor == o.arrivals_floor &&
+          minimum_conversions == o.minimum_conversions &&
+          maximum_days == o.maximum_days &&
+          maximum_spend_minor == o.maximum_spend_minor
+    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
+      [platform_ad_account_id, ad_set_id, member_ad_ids, axis, event_name, arrivals_floor, minimum_conversions, maximum_days, maximum_spend_minor].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