plainrouter-sdk 0.5.0 → 0.6.1

data/lib/plainrouter/openapi/models/destination_config.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 DestinationConfig
+    class << self
+      # List of class defined in anyOf (OpenAPI v3)
+      def openapi_any_of
+        [
+          :'Array<Object>',
+          :'Hash<String, Object>'
+        ]
+      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/destination_status.rb

@@ -16,10 +16,11 @@ require 'time'
 module PlainRouter::OpenAPI
   class DestinationStatus
     ACTIVE = "active".freeze
+    NEEDS_ATTENTION = "needs_attention".freeze
     INACTIVE = "inactive".freeze
 
     def self.all_vars
-      @all_vars ||= [ACTIVE, INACTIVE].freeze
+      @all_vars ||= [ACTIVE, NEEDS_ATTENTION, INACTIVE].freeze
     end
 
     # Builds the enum from string

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

@@ -0,0 +1,41 @@
+=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 DraftBatchMode
+    DUPLICATE_ADSET = "duplicate_adset".freeze
+    DUPLICATE_ADSET_PER_MEDIA = "duplicate_adset_per_media".freeze
+    ADD_TO_ADSET = "add_to_adset".freeze
+
+    def self.all_vars
+      @all_vars ||= [DUPLICATE_ADSET, DUPLICATE_ADSET_PER_MEDIA, ADD_TO_ADSET].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if DraftBatchMode.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #DraftBatchMode"
+    end
+  end
+end

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

@@ -0,0 +1,341 @@
+=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
+  # Complete projection rows are paged within 80,000 JSON bytes, accounting for both MCP representations. Defaults are bounded. Follow next_cursor with the same scope and filters. One oversized row is explicitly refused; fields are never silently clipped.
+  class GetAccountInventory200Response < ApiModelBase
+    attr_accessor :account
+
+    attr_accessor :sync
+
+    attr_accessor :staleness
+
+    attr_accessor :summary
+
+    attr_accessor :objects
+
+    attr_accessor :next_cursor
+
+    attr_accessor :truncated
+
+    attr_accessor :continuation
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'account' => :'account',
+        :'sync' => :'sync',
+        :'staleness' => :'staleness',
+        :'summary' => :'summary',
+        :'objects' => :'objects',
+        :'next_cursor' => :'next_cursor',
+        :'truncated' => :'truncated',
+        :'continuation' => :'continuation'
+      }
+    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
+      {
+        :'account' => :'Hash<String, Object>',
+        :'sync' => :'Hash<String, Object>',
+        :'staleness' => :'Hash<String, Object>',
+        :'summary' => :'GetAccountInventory200ResponseSummary',
+        :'objects' => :'Array<Hash<String, Object>>',
+        :'next_cursor' => :'Integer',
+        :'truncated' => :'Boolean',
+        :'continuation' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'next_cursor',
+      ])
+    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::GetAccountInventory200Response` 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::GetAccountInventory200Response`. 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?(:'account')
+        if (value = attributes[:'account']).is_a?(Hash)
+          self.account = value
+        end
+      else
+        self.account = nil
+      end
+
+      if attributes.key?(:'sync')
+        if (value = attributes[:'sync']).is_a?(Hash)
+          self.sync = value
+        end
+      else
+        self.sync = nil
+      end
+
+      if attributes.key?(:'staleness')
+        if (value = attributes[:'staleness']).is_a?(Hash)
+          self.staleness = value
+        end
+      else
+        self.staleness = nil
+      end
+
+      if attributes.key?(:'summary')
+        self.summary = attributes[:'summary']
+      else
+        self.summary = nil
+      end
+
+      if attributes.key?(:'objects')
+        if (value = attributes[:'objects']).is_a?(Array)
+          self.objects = value
+        end
+      else
+        self.objects = nil
+      end
+
+      if attributes.key?(:'next_cursor')
+        self.next_cursor = attributes[:'next_cursor']
+      else
+        self.next_cursor = nil
+      end
+
+      if attributes.key?(:'truncated')
+        self.truncated = attributes[:'truncated']
+      else
+        self.truncated = nil
+      end
+
+      if attributes.key?(:'continuation')
+        self.continuation = attributes[:'continuation']
+      else
+        self.continuation = 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 @account.nil?
+        invalid_properties.push('invalid value for "account", account cannot be nil.')
+      end
+
+      if @sync.nil?
+        invalid_properties.push('invalid value for "sync", sync cannot be nil.')
+      end
+
+      if @staleness.nil?
+        invalid_properties.push('invalid value for "staleness", staleness cannot be nil.')
+      end
+
+      if @summary.nil?
+        invalid_properties.push('invalid value for "summary", summary cannot be nil.')
+      end
+
+      if @objects.nil?
+        invalid_properties.push('invalid value for "objects", objects cannot be nil.')
+      end
+
+      if @truncated.nil?
+        invalid_properties.push('invalid value for "truncated", truncated cannot be nil.')
+      end
+
+      if @continuation.nil?
+        invalid_properties.push('invalid value for "continuation", continuation 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 @account.nil?
+      return false if @sync.nil?
+      return false if @staleness.nil?
+      return false if @summary.nil?
+      return false if @objects.nil?
+      return false if @truncated.nil?
+      return false if @continuation.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] account Value to be assigned
+    def account=(account)
+      if account.nil?
+        fail ArgumentError, 'account cannot be nil'
+      end
+
+      @account = account
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sync Value to be assigned
+    def sync=(sync)
+      if sync.nil?
+        fail ArgumentError, 'sync cannot be nil'
+      end
+
+      @sync = sync
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] staleness Value to be assigned
+    def staleness=(staleness)
+      if staleness.nil?
+        fail ArgumentError, 'staleness cannot be nil'
+      end
+
+      @staleness = staleness
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] summary Value to be assigned
+    def summary=(summary)
+      if summary.nil?
+        fail ArgumentError, 'summary cannot be nil'
+      end
+
+      @summary = summary
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] objects Value to be assigned
+    def objects=(objects)
+      if objects.nil?
+        fail ArgumentError, 'objects cannot be nil'
+      end
+
+      @objects = objects
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] truncated Value to be assigned
+    def truncated=(truncated)
+      if truncated.nil?
+        fail ArgumentError, 'truncated cannot be nil'
+      end
+
+      @truncated = truncated
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] continuation Value to be assigned
+    def continuation=(continuation)
+      if continuation.nil?
+        fail ArgumentError, 'continuation cannot be nil'
+      end
+
+      @continuation = continuation
+    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 &&
+          account == o.account &&
+          sync == o.sync &&
+          staleness == o.staleness &&
+          summary == o.summary &&
+          objects == o.objects &&
+          next_cursor == o.next_cursor &&
+          truncated == o.truncated &&
+          continuation == o.continuation
+    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
+      [account, sync, staleness, summary, objects, next_cursor, truncated, continuation].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/get_account_inventory200_response_summary.rb

@@ -0,0 +1,158 @@
+=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 GetAccountInventory200ResponseSummary < ApiModelBase
+    attr_accessor :total
+
+    attr_accessor :by_level
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'total' => :'total',
+        :'by_level' => :'by_level'
+      }
+    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
+      {
+        :'total' => :'Integer',
+        :'by_level' => :'Hash<String, Integer>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::GetAccountInventory200ResponseSummary` 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::GetAccountInventory200ResponseSummary`. 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?(:'total')
+        self.total = attributes[:'total']
+      end
+
+      if attributes.key?(:'by_level')
+        if (value = attributes[:'by_level']).is_a?(Hash)
+          self.by_level = 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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      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 &&
+          total == o.total &&
+          by_level == o.by_level
+    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
+      [total, by_level].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