plainrouter-sdk 0.2.0 → 0.6.0

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

@@ -0,0 +1,267 @@
+=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
+  # Optional complete per-ad copy override; null uses the plan copy.
+  class DeploymentPlanReadCreativesInnerCopy < ApiModelBase
+    attr_accessor :primary_text
+
+    attr_accessor :headline
+
+    attr_accessor :description
+
+    attr_accessor :cta
+
+    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
+      {
+        :'primary_text' => :'primary_text',
+        :'headline' => :'headline',
+        :'description' => :'description',
+        :'cta' => :'cta'
+      }
+    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
+      {
+        :'primary_text' => :'String',
+        :'headline' => :'String',
+        :'description' => :'String',
+        :'cta' => :'String'
+      }
+    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::DeploymentPlanReadCreativesInnerCopy` 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::DeploymentPlanReadCreativesInnerCopy`. 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?(:'primary_text')
+        self.primary_text = attributes[:'primary_text']
+      else
+        self.primary_text = nil
+      end
+
+      if attributes.key?(:'headline')
+        self.headline = attributes[:'headline']
+      else
+        self.headline = nil
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      else
+        self.description = nil
+      end
+
+      if attributes.key?(:'cta')
+        self.cta = attributes[:'cta']
+      else
+        self.cta = 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 @primary_text.nil?
+        invalid_properties.push('invalid value for "primary_text", primary_text cannot be nil.')
+      end
+
+      if @headline.nil?
+        invalid_properties.push('invalid value for "headline", headline cannot be nil.')
+      end
+
+      if @description.nil?
+        invalid_properties.push('invalid value for "description", description cannot be nil.')
+      end
+
+      if @cta.nil?
+        invalid_properties.push('invalid value for "cta", cta 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 @primary_text.nil?
+      return false if @headline.nil?
+      return false if @description.nil?
+      return false if @cta.nil?
+      cta_validator = EnumAttributeValidator.new('String', ["learn_more", "shop_now", "sign_up"])
+      return false unless cta_validator.valid?(@cta)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] primary_text Value to be assigned
+    def primary_text=(primary_text)
+      if primary_text.nil?
+        fail ArgumentError, 'primary_text cannot be nil'
+      end
+
+      @primary_text = primary_text
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] headline Value to be assigned
+    def headline=(headline)
+      if headline.nil?
+        fail ArgumentError, 'headline cannot be nil'
+      end
+
+      @headline = headline
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if description.nil?
+        fail ArgumentError, 'description cannot be nil'
+      end
+
+      @description = description
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] cta Object to be assigned
+    def cta=(cta)
+      validator = EnumAttributeValidator.new('String', ["learn_more", "shop_now", "sign_up"])
+      unless validator.valid?(cta)
+        fail ArgumentError, "invalid value for \"cta\", must be one of #{validator.allowable_values}."
+      end
+      @cta = cta
+    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 &&
+          primary_text == o.primary_text &&
+          headline == o.headline &&
+          description == o.description &&
+          cta == o.cta
+    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
+      [primary_text, headline, description, cta].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/destination.rb

@@ -36,6 +36,12 @@ module PlainRouter::OpenAPI
 
     attr_accessor :updated_at
 
+    attr_accessor :attention_reason
+
+    attr_accessor :held_count
+
+    attr_accessor :notices
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -70,7 +76,10 @@ module PlainRouter::OpenAPI
         :'config' => :'config',
         :'status' => :'status',
         :'created_at' => :'created_at',
-        :'updated_at' => :'updated_at'
+        :'updated_at' => :'updated_at',
+        :'attention_reason' => :'attention_reason',
+        :'held_count' => :'held_count',
+        :'notices' => :'notices'
       }
     end
 
@@ -93,10 +102,13 @@ module PlainRouter::OpenAPI
         :'platform_ad_account_id' => :'Integer',
         :'type' => :'DestinationType',
         :'credential_source' => :'DestinationCredentialSource',
-        :'config' => :'Array<Object>',
+        :'config' => :'DestinationConfig',
         :'status' => :'DestinationStatus',
         :'created_at' => :'Time',
-        :'updated_at' => :'Time'
+        :'updated_at' => :'Time',
+        :'attention_reason' => :'GetEvent200ResponseEventConsent',
+        :'held_count' => :'Integer',
+        :'notices' => :'Array<Hash<String, Object>>'
       }
     end
 
@@ -105,7 +117,8 @@ module PlainRouter::OpenAPI
       Set.new([
         :'platform_ad_account_id',
         :'created_at',
-        :'updated_at'
+        :'updated_at',
+        :'attention_reason',
       ])
     end
 
@@ -162,9 +175,7 @@ module PlainRouter::OpenAPI
       end
 
       if attributes.key?(:'config')
-        if (value = attributes[:'config']).is_a?(Array)
-          self.config = value
-        end
+        self.config = attributes[:'config']
       else
         self.config = nil
       end
@@ -186,6 +197,26 @@ module PlainRouter::OpenAPI
       else
         self.updated_at = nil
       end
+
+      if attributes.key?(:'attention_reason')
+        self.attention_reason = attributes[:'attention_reason']
+      else
+        self.attention_reason = nil
+      end
+
+      if attributes.key?(:'held_count')
+        self.held_count = attributes[:'held_count']
+      else
+        self.held_count = nil
+      end
+
+      if attributes.key?(:'notices')
+        if (value = attributes[:'notices']).is_a?(Array)
+          self.notices = value
+        end
+      else
+        self.notices = nil
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -221,6 +252,14 @@ module PlainRouter::OpenAPI
         invalid_properties.push('invalid value for "status", status cannot be nil.')
       end
 
+      if @held_count.nil?
+        invalid_properties.push('invalid value for "held_count", held_count cannot be nil.')
+      end
+
+      if @notices.nil?
+        invalid_properties.push('invalid value for "notices", notices cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -235,6 +274,8 @@ module PlainRouter::OpenAPI
       return false if @credential_source.nil?
       return false if @config.nil?
       return false if @status.nil?
+      return false if @held_count.nil?
+      return false if @notices.nil?
       true
     end
 
@@ -308,6 +349,26 @@ module PlainRouter::OpenAPI
       @status = status
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] held_count Value to be assigned
+    def held_count=(held_count)
+      if held_count.nil?
+        fail ArgumentError, 'held_count cannot be nil'
+      end
+
+      @held_count = held_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] notices Value to be assigned
+    def notices=(notices)
+      if notices.nil?
+        fail ArgumentError, 'notices cannot be nil'
+      end
+
+      @notices = notices
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -322,7 +383,10 @@ module PlainRouter::OpenAPI
           config == o.config &&
           status == o.status &&
           created_at == o.created_at &&
-          updated_at == o.updated_at
+          updated_at == o.updated_at &&
+          attention_reason == o.attention_reason &&
+          held_count == o.held_count &&
+          notices == o.notices
     end
 
     # @see the `==` method
@@ -334,7 +398,7 @@ module PlainRouter::OpenAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, workspace_id, signal_tracker_id, platform_ad_account_id, type, credential_source, config, status, created_at, updated_at].hash
+      [id, workspace_id, signal_tracker_id, platform_ad_account_id, type, credential_source, config, status, created_at, updated_at, attention_reason, held_count, notices].hash
     end
 
     # Builds the object from hash

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/destination_type.rb

@@ -16,9 +16,10 @@ require 'time'
 module PlainRouter::OpenAPI
   class DestinationType
     META = "meta".freeze
+    GOOGLE_ADS = "google_ads".freeze
 
     def self.all_vars
-      @all_vars ||= [META].freeze
+      @all_vars ||= [META, GOOGLE_ADS].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