plainrouter-sdk 0.2.0 → 0.6.0

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

@@ -0,0 +1,511 @@
+=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 UpdateDeploymentPlanRequest < ApiModelBase
+    attr_accessor :name
+
+    attr_accessor :platform_ad_account_id
+
+    attr_accessor :platform
+
+    attr_accessor :campaign_ref
+
+    attr_accessor :campaign_spec
+
+    attr_accessor :ad_set_ref
+
+    attr_accessor :ad_set_spec
+
+    attr_accessor :budget_type
+
+    attr_accessor :budget_amount_minor
+
+    attr_accessor :currency
+
+    attr_accessor :copy
+
+    attr_accessor :landing_page
+
+    attr_accessor :utm_policy_name
+
+    attr_accessor :naming_policy_name
+
+    attr_accessor :creative_ids
+
+    attr_accessor :creative_overrides
+
+    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
+      {
+        :'name' => :'name',
+        :'platform_ad_account_id' => :'platform_ad_account_id',
+        :'platform' => :'platform',
+        :'campaign_ref' => :'campaign_ref',
+        :'campaign_spec' => :'campaign_spec',
+        :'ad_set_ref' => :'ad_set_ref',
+        :'ad_set_spec' => :'ad_set_spec',
+        :'budget_type' => :'budget_type',
+        :'budget_amount_minor' => :'budget_amount_minor',
+        :'currency' => :'currency',
+        :'copy' => :'copy',
+        :'landing_page' => :'landing_page',
+        :'utm_policy_name' => :'utm_policy_name',
+        :'naming_policy_name' => :'naming_policy_name',
+        :'creative_ids' => :'creative_ids',
+        :'creative_overrides' => :'creative_overrides'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'platform_ad_account_id' => :'Integer',
+        :'platform' => :'String',
+        :'campaign_ref' => :'String',
+        :'campaign_spec' => :'Array<String>',
+        :'ad_set_ref' => :'String',
+        :'ad_set_spec' => :'StoreDeploymentPlanRequestAdSetSpec',
+        :'budget_type' => :'String',
+        :'budget_amount_minor' => :'Integer',
+        :'currency' => :'String',
+        :'copy' => :'StoreDeploymentPlanRequestCopy',
+        :'landing_page' => :'String',
+        :'utm_policy_name' => :'String',
+        :'naming_policy_name' => :'String',
+        :'creative_ids' => :'Array<String>',
+        :'creative_overrides' => :'Array<StoreDeploymentPlanRequestCreativeOverridesInner>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'name',
+        :'campaign_ref',
+        :'campaign_spec',
+        :'ad_set_ref',
+        :'ad_set_spec',
+        :'utm_policy_name',
+        :'naming_policy_name',
+      ])
+    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::UpdateDeploymentPlanRequest` 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::UpdateDeploymentPlanRequest`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'platform_ad_account_id')
+        self.platform_ad_account_id = attributes[:'platform_ad_account_id']
+      end
+
+      if attributes.key?(:'platform')
+        self.platform = attributes[:'platform']
+      end
+
+      if attributes.key?(:'campaign_ref')
+        self.campaign_ref = attributes[:'campaign_ref']
+      end
+
+      if attributes.key?(:'campaign_spec')
+        if (value = attributes[:'campaign_spec']).is_a?(Array)
+          self.campaign_spec = value
+        end
+      end
+
+      if attributes.key?(:'ad_set_ref')
+        self.ad_set_ref = attributes[:'ad_set_ref']
+      end
+
+      if attributes.key?(:'ad_set_spec')
+        self.ad_set_spec = attributes[:'ad_set_spec']
+      end
+
+      if attributes.key?(:'budget_type')
+        self.budget_type = attributes[:'budget_type']
+      end
+
+      if attributes.key?(:'budget_amount_minor')
+        self.budget_amount_minor = attributes[:'budget_amount_minor']
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.key?(:'copy')
+        self.copy = attributes[:'copy']
+      end
+
+      if attributes.key?(:'landing_page')
+        self.landing_page = attributes[:'landing_page']
+      end
+
+      if attributes.key?(:'utm_policy_name')
+        self.utm_policy_name = attributes[:'utm_policy_name']
+      end
+
+      if attributes.key?(:'naming_policy_name')
+        self.naming_policy_name = attributes[:'naming_policy_name']
+      end
+
+      if attributes.key?(:'creative_ids')
+        if (value = attributes[:'creative_ids']).is_a?(Array)
+          self.creative_ids = value
+        end
+      end
+
+      if attributes.key?(:'creative_overrides')
+        if (value = attributes[:'creative_overrides']).is_a?(Array)
+          self.creative_overrides = 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
+      if !@name.nil? && @name.to_s.length > 255
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
+      end
+
+      if !@platform_ad_account_id.nil? && @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 !@campaign_ref.nil? && @campaign_ref.to_s.length > 255
+        invalid_properties.push('invalid value for "campaign_ref", the character length must be smaller than or equal to 255.')
+      end
+
+      if !@ad_set_ref.nil? && @ad_set_ref.to_s.length > 255
+        invalid_properties.push('invalid value for "ad_set_ref", the character length must be smaller than or equal to 255.')
+      end
+
+      if !@budget_amount_minor.nil? && @budget_amount_minor < 1
+        invalid_properties.push('invalid value for "budget_amount_minor", must be greater than or equal to 1.')
+      end
+
+      if !@currency.nil? && @currency.to_s.length > 3
+        invalid_properties.push('invalid value for "currency", the character length must be smaller than or equal to 3.')
+      end
+
+      if !@currency.nil? && @currency.to_s.length < 3
+        invalid_properties.push('invalid value for "currency", the character length must be greater than or equal to 3.')
+      end
+
+      if !@landing_page.nil? && @landing_page.to_s.length > 2048
+        invalid_properties.push('invalid value for "landing_page", the character length must be smaller than or equal to 2048.')
+      end
+
+      if !@utm_policy_name.nil? && @utm_policy_name.to_s.length > 255
+        invalid_properties.push('invalid value for "utm_policy_name", the character length must be smaller than or equal to 255.')
+      end
+
+      if !@naming_policy_name.nil? && @naming_policy_name.to_s.length > 255
+        invalid_properties.push('invalid value for "naming_policy_name", the character length must be smaller than or equal to 255.')
+      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 !@name.nil? && @name.to_s.length > 255
+      return false if !@platform_ad_account_id.nil? && @platform_ad_account_id < 1
+      platform_validator = EnumAttributeValidator.new('String', ["google", "meta", "microsoft"])
+      return false unless platform_validator.valid?(@platform)
+      return false if !@campaign_ref.nil? && @campaign_ref.to_s.length > 255
+      return false if !@ad_set_ref.nil? && @ad_set_ref.to_s.length > 255
+      budget_type_validator = EnumAttributeValidator.new('String', ["daily", "lifetime"])
+      return false unless budget_type_validator.valid?(@budget_type)
+      return false if !@budget_amount_minor.nil? && @budget_amount_minor < 1
+      return false if !@currency.nil? && @currency.to_s.length > 3
+      return false if !@currency.nil? && @currency.to_s.length < 3
+      return false if !@landing_page.nil? && @landing_page.to_s.length > 2048
+      return false if !@utm_policy_name.nil? && @utm_policy_name.to_s.length > 255
+      return false if !@naming_policy_name.nil? && @naming_policy_name.to_s.length > 255
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if !name.nil? && name.to_s.length > 255
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 255.'
+      end
+
+      @name = name
+    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 checking allowed values (enum).
+    # @param [Object] platform Object to be assigned
+    def platform=(platform)
+      validator = EnumAttributeValidator.new('String', ["google", "meta", "microsoft"])
+      unless validator.valid?(platform)
+        fail ArgumentError, "invalid value for \"platform\", must be one of #{validator.allowable_values}."
+      end
+      @platform = platform
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] campaign_ref Value to be assigned
+    def campaign_ref=(campaign_ref)
+      if !campaign_ref.nil? && campaign_ref.to_s.length > 255
+        fail ArgumentError, 'invalid value for "campaign_ref", the character length must be smaller than or equal to 255.'
+      end
+
+      @campaign_ref = campaign_ref
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ad_set_ref Value to be assigned
+    def ad_set_ref=(ad_set_ref)
+      if !ad_set_ref.nil? && ad_set_ref.to_s.length > 255
+        fail ArgumentError, 'invalid value for "ad_set_ref", the character length must be smaller than or equal to 255.'
+      end
+
+      @ad_set_ref = ad_set_ref
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] budget_type Object to be assigned
+    def budget_type=(budget_type)
+      validator = EnumAttributeValidator.new('String', ["daily", "lifetime"])
+      unless validator.valid?(budget_type)
+        fail ArgumentError, "invalid value for \"budget_type\", must be one of #{validator.allowable_values}."
+      end
+      @budget_type = budget_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] budget_amount_minor Value to be assigned
+    def budget_amount_minor=(budget_amount_minor)
+      if budget_amount_minor.nil?
+        fail ArgumentError, 'budget_amount_minor cannot be nil'
+      end
+
+      if budget_amount_minor < 1
+        fail ArgumentError, 'invalid value for "budget_amount_minor", must be greater than or equal to 1.'
+      end
+
+      @budget_amount_minor = budget_amount_minor
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] currency Value to be assigned
+    def currency=(currency)
+      if currency.nil?
+        fail ArgumentError, 'currency cannot be nil'
+      end
+
+      if currency.to_s.length > 3
+        fail ArgumentError, 'invalid value for "currency", the character length must be smaller than or equal to 3.'
+      end
+
+      if currency.to_s.length < 3
+        fail ArgumentError, 'invalid value for "currency", the character length must be greater than or equal to 3.'
+      end
+
+      @currency = currency
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] landing_page Value to be assigned
+    def landing_page=(landing_page)
+      if landing_page.nil?
+        fail ArgumentError, 'landing_page cannot be nil'
+      end
+
+      if landing_page.to_s.length > 2048
+        fail ArgumentError, 'invalid value for "landing_page", the character length must be smaller than or equal to 2048.'
+      end
+
+      @landing_page = landing_page
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] utm_policy_name Value to be assigned
+    def utm_policy_name=(utm_policy_name)
+      if !utm_policy_name.nil? && utm_policy_name.to_s.length > 255
+        fail ArgumentError, 'invalid value for "utm_policy_name", the character length must be smaller than or equal to 255.'
+      end
+
+      @utm_policy_name = utm_policy_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] naming_policy_name Value to be assigned
+    def naming_policy_name=(naming_policy_name)
+      if !naming_policy_name.nil? && naming_policy_name.to_s.length > 255
+        fail ArgumentError, 'invalid value for "naming_policy_name", the character length must be smaller than or equal to 255.'
+      end
+
+      @naming_policy_name = naming_policy_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] creative_overrides Value to be assigned
+    def creative_overrides=(creative_overrides)
+      if creative_overrides.nil?
+        fail ArgumentError, 'creative_overrides cannot be nil'
+      end
+
+      @creative_overrides = creative_overrides
+    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 &&
+          name == o.name &&
+          platform_ad_account_id == o.platform_ad_account_id &&
+          platform == o.platform &&
+          campaign_ref == o.campaign_ref &&
+          campaign_spec == o.campaign_spec &&
+          ad_set_ref == o.ad_set_ref &&
+          ad_set_spec == o.ad_set_spec &&
+          budget_type == o.budget_type &&
+          budget_amount_minor == o.budget_amount_minor &&
+          currency == o.currency &&
+          copy == o.copy &&
+          landing_page == o.landing_page &&
+          utm_policy_name == o.utm_policy_name &&
+          naming_policy_name == o.naming_policy_name &&
+          creative_ids == o.creative_ids &&
+          creative_overrides == o.creative_overrides
+    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
+      [name, platform_ad_account_id, platform, campaign_ref, campaign_spec, ad_set_ref, ad_set_spec, budget_type, budget_amount_minor, currency, copy, landing_page, utm_policy_name, naming_policy_name, creative_ids, creative_overrides].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/workspace_lock_timeout.rb

@@ -0,0 +1,164 @@
+=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 WorkspaceLockTimeout < ApiModelBase
+    attr_accessor :error
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error' => :'error'
+      }
+    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
+      {
+        :'error' => :'WorkspaceLockTimeoutError'
+      }
+    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::WorkspaceLockTimeout` 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::WorkspaceLockTimeout`. 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?(:'error')
+        self.error = attributes[:'error']
+      else
+        self.error = 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 @error.nil?
+        invalid_properties.push('invalid value for "error", error 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 @error.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] error Value to be assigned
+    def error=(error)
+      if error.nil?
+        fail ArgumentError, 'error cannot be nil'
+      end
+
+      @error = error
+    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 &&
+          error == o.error
+    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
+      [error].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