plainrouter-sdk 0.5.0 → 0.6.1

data/lib/plainrouter/openapi/models/{deployment_plan.rb → store_deployment_plan_request.rb}

@@ -14,10 +14,8 @@ require 'date'
 require 'time'
 
 module PlainRouter::OpenAPI
-  class DeploymentPlan < ApiModelBase
-    attr_accessor :id
-
-    attr_accessor :workspace_id
+  class StoreDeploymentPlanRequest < ApiModelBase
+    attr_accessor :name
 
     attr_accessor :platform_ad_account_id
 
@@ -29,7 +27,6 @@ module PlainRouter::OpenAPI
 
     attr_accessor :ad_set_ref
 
-    # When present, bid_amount must be a positive integer in Meta minor units for the account currency. Digit-only strings of at most 18 digits are accepted and normalized to integers. Null, zero, negatives, decimals and other strings are refused on ad_set_spec.bid_amount.
     attr_accessor :ad_set_spec
 
     attr_accessor :budget_type
@@ -42,33 +39,40 @@ module PlainRouter::OpenAPI
 
     attr_accessor :landing_page
 
-    attr_accessor :utm_policy_id
-
-    attr_accessor :naming_policy_id
-
-    attr_accessor :status
+    attr_accessor :utm_policy_name
 
-    attr_accessor :validation_result
+    attr_accessor :naming_policy_name
 
-    attr_accessor :diff
+    attr_accessor :creative_ids
 
-    attr_accessor :validated_at
+    attr_accessor :creative_overrides
 
-    attr_accessor :approval_id
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
 
-    attr_accessor :created_at
-
-    attr_accessor :updated_at
-
-    attr_accessor :platform_object_ids
+      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
 
-    attr_accessor :name
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
-        :'workspace_id' => :'workspace_id',
+        :'name' => :'name',
         :'platform_ad_account_id' => :'platform_ad_account_id',
         :'platform' => :'platform',
         :'campaign_ref' => :'campaign_ref',
@@ -80,17 +84,10 @@ module PlainRouter::OpenAPI
         :'currency' => :'currency',
         :'copy' => :'copy',
         :'landing_page' => :'landing_page',
-        :'utm_policy_id' => :'utm_policy_id',
-        :'naming_policy_id' => :'naming_policy_id',
-        :'status' => :'status',
-        :'validation_result' => :'validation_result',
-        :'diff' => :'diff',
-        :'validated_at' => :'validated_at',
-        :'approval_id' => :'approval_id',
-        :'created_at' => :'created_at',
-        :'updated_at' => :'updated_at',
-        :'platform_object_ids' => :'platform_object_ids',
-        :'name' => :'name'
+        :'utm_policy_name' => :'utm_policy_name',
+        :'naming_policy_name' => :'naming_policy_name',
+        :'creative_ids' => :'creative_ids',
+        :'creative_overrides' => :'creative_overrides'
       }
     end
 
@@ -107,49 +104,35 @@ module PlainRouter::OpenAPI
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'id' => :'String',
-        :'workspace_id' => :'Integer',
+        :'name' => :'String',
         :'platform_ad_account_id' => :'Integer',
         :'platform' => :'String',
         :'campaign_ref' => :'String',
-        :'campaign_spec' => :'Array<Object>',
+        :'campaign_spec' => :'Array<String>',
         :'ad_set_ref' => :'String',
-        :'ad_set_spec' => :'Array<Object>',
+        :'ad_set_spec' => :'StoreDeploymentPlanRequestAdSetSpec',
         :'budget_type' => :'String',
         :'budget_amount_minor' => :'Integer',
         :'currency' => :'String',
-        :'copy' => :'Array<Object>',
+        :'copy' => :'StoreDeploymentPlanRequestCopy',
         :'landing_page' => :'String',
-        :'utm_policy_id' => :'String',
-        :'naming_policy_id' => :'String',
-        :'status' => :'String',
-        :'validation_result' => :'Array<Object>',
-        :'diff' => :'Array<Object>',
-        :'validated_at' => :'Time',
-        :'approval_id' => :'String',
-        :'created_at' => :'Time',
-        :'updated_at' => :'Time',
-        :'platform_object_ids' => :'Array<Object>',
-        :'name' => :'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_id',
-        :'naming_policy_id',
-        :'validation_result',
-        :'diff',
-        :'validated_at',
-        :'approval_id',
-        :'created_at',
-        :'updated_at',
-        :'name'
+        :'utm_policy_name',
+        :'naming_policy_name',
       ])
     end
 
@@ -157,28 +140,20 @@ module PlainRouter::OpenAPI
     # @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::DeploymentPlan` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PlainRouter::OpenAPI::StoreDeploymentPlanRequest` 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::DeploymentPlan`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PlainRouter::OpenAPI::StoreDeploymentPlanRequest`. 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?(:'id')
-        self.id = attributes[:'id']
-      else
-        self.id = nil
-      end
-
-      if attributes.key?(:'workspace_id')
-        self.workspace_id = attributes[:'workspace_id']
-      else
-        self.workspace_id = nil
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
       end
 
       if attributes.key?(:'platform_ad_account_id')
@@ -195,30 +170,20 @@ module PlainRouter::OpenAPI
 
       if attributes.key?(:'campaign_ref')
         self.campaign_ref = attributes[:'campaign_ref']
-      else
-        self.campaign_ref = nil
       end
 
       if attributes.key?(:'campaign_spec')
         if (value = attributes[:'campaign_spec']).is_a?(Array)
           self.campaign_spec = value
         end
-      else
-        self.campaign_spec = nil
       end
 
       if attributes.key?(:'ad_set_ref')
         self.ad_set_ref = attributes[:'ad_set_ref']
-      else
-        self.ad_set_ref = nil
       end
 
       if attributes.key?(:'ad_set_spec')
-        if (value = attributes[:'ad_set_spec']).is_a?(Array)
-          self.ad_set_spec = value
-        end
-      else
-        self.ad_set_spec = nil
+        self.ad_set_spec = attributes[:'ad_set_spec']
       end
 
       if attributes.key?(:'budget_type')
@@ -240,9 +205,7 @@ module PlainRouter::OpenAPI
       end
 
       if attributes.key?(:'copy')
-        if (value = attributes[:'copy']).is_a?(Array)
-          self.copy = value
-        end
+        self.copy = attributes[:'copy']
       else
         self.copy = nil
       end
@@ -253,76 +216,24 @@ module PlainRouter::OpenAPI
         self.landing_page = nil
       end
 
-      if attributes.key?(:'utm_policy_id')
-        self.utm_policy_id = attributes[:'utm_policy_id']
-      else
-        self.utm_policy_id = nil
-      end
-
-      if attributes.key?(:'naming_policy_id')
-        self.naming_policy_id = attributes[:'naming_policy_id']
-      else
-        self.naming_policy_id = nil
+      if attributes.key?(:'utm_policy_name')
+        self.utm_policy_name = attributes[:'utm_policy_name']
       end
 
-      if attributes.key?(:'status')
-        self.status = attributes[:'status']
-      else
-        self.status = nil
+      if attributes.key?(:'naming_policy_name')
+        self.naming_policy_name = attributes[:'naming_policy_name']
       end
 
-      if attributes.key?(:'validation_result')
-        if (value = attributes[:'validation_result']).is_a?(Array)
-          self.validation_result = value
+      if attributes.key?(:'creative_ids')
+        if (value = attributes[:'creative_ids']).is_a?(Array)
+          self.creative_ids = value
         end
-      else
-        self.validation_result = nil
       end
 
-      if attributes.key?(:'diff')
-        if (value = attributes[:'diff']).is_a?(Array)
-          self.diff = value
+      if attributes.key?(:'creative_overrides')
+        if (value = attributes[:'creative_overrides']).is_a?(Array)
+          self.creative_overrides = value
         end
-      else
-        self.diff = nil
-      end
-
-      if attributes.key?(:'validated_at')
-        self.validated_at = attributes[:'validated_at']
-      else
-        self.validated_at = nil
-      end
-
-      if attributes.key?(:'approval_id')
-        self.approval_id = attributes[:'approval_id']
-      else
-        self.approval_id = nil
-      end
-
-      if attributes.key?(:'created_at')
-        self.created_at = attributes[:'created_at']
-      else
-        self.created_at = nil
-      end
-
-      if attributes.key?(:'updated_at')
-        self.updated_at = attributes[:'updated_at']
-      else
-        self.updated_at = nil
-      end
-
-      if attributes.key?(:'platform_object_ids')
-        if (value = attributes[:'platform_object_ids']).is_a?(Array)
-          self.platform_object_ids = value
-        end
-      else
-        self.platform_object_ids = nil
-      end
-
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
-      else
-        self.name = nil
       end
     end
 
@@ -331,22 +242,30 @@ module PlainRouter::OpenAPI
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @id.nil?
-        invalid_properties.push('invalid value for "id", id cannot be nil.')
-      end
-
-      if @workspace_id.nil?
-        invalid_properties.push('invalid value for "workspace_id", workspace_id cannot be nil.')
+      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?
         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 @platform.nil?
         invalid_properties.push('invalid value for "platform", platform cannot be nil.')
       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_type.nil?
         invalid_properties.push('invalid value for "budget_type", budget_type cannot be nil.')
       end
@@ -355,10 +274,22 @@ module PlainRouter::OpenAPI
         invalid_properties.push('invalid value for "budget_amount_minor", budget_amount_minor cannot be nil.')
       end
 
+      if @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?
         invalid_properties.push('invalid value for "currency", currency cannot be nil.')
       end
 
+      if @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.to_s.length < 3
+        invalid_properties.push('invalid value for "currency", the character length must be greater than or equal to 3.')
+      end
+
       if @copy.nil?
         invalid_properties.push('invalid value for "copy", copy cannot be nil.')
       end
@@ -367,12 +298,16 @@ module PlainRouter::OpenAPI
         invalid_properties.push('invalid value for "landing_page", landing_page cannot be nil.')
       end
 
-      if @status.nil?
-        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      if @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 @platform_object_ids.nil?
-        invalid_properties.push('invalid value for "platform_object_ids", platform_object_ids cannot be nil.')
+      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
@@ -382,38 +317,38 @@ module PlainRouter::OpenAPI
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @id.nil?
-      return false if @workspace_id.nil?
+      return false if !@name.nil? && @name.to_s.length > 255
       return false if @platform_ad_account_id.nil?
+      return false if @platform_ad_account_id < 1
       return false if @platform.nil?
+      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
       return false if @budget_type.nil?
+      budget_type_validator = EnumAttributeValidator.new('String', ["daily", "lifetime"])
+      return false unless budget_type_validator.valid?(@budget_type)
       return false if @budget_amount_minor.nil?
+      return false if @budget_amount_minor < 1
       return false if @currency.nil?
+      return false if @currency.to_s.length > 3
+      return false if @currency.to_s.length < 3
       return false if @copy.nil?
       return false if @landing_page.nil?
-      return false if @status.nil?
-      return false if @platform_object_ids.nil?
+      return false if @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] id Value to be assigned
-    def id=(id)
-      if id.nil?
-        fail ArgumentError, 'id cannot be nil'
-      end
-
-      @id = id
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] workspace_id Value to be assigned
-    def workspace_id=(workspace_id)
-      if workspace_id.nil?
-        fail ArgumentError, 'workspace_id cannot be nil'
+    # @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
 
-      @workspace_id = workspace_id
+      @name = name
     end
 
     # Custom attribute writer method with validation
@@ -423,26 +358,50 @@ module PlainRouter::OpenAPI
         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] platform Value to be assigned
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] platform Object to be assigned
     def platform=(platform)
-      if platform.nil?
-        fail ArgumentError, 'platform cannot be nil'
+      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] budget_type Value to be assigned
-    def budget_type=(budget_type)
-      if budget_type.nil?
-        fail ArgumentError, 'budget_type cannot be nil'
+    # @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
 
@@ -453,6 +412,10 @@ module PlainRouter::OpenAPI
         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
 
@@ -463,6 +426,14 @@ module PlainRouter::OpenAPI
         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
 
@@ -483,27 +454,41 @@ module PlainRouter::OpenAPI
         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] status Value to be assigned
-    def status=(status)
-      if status.nil?
-        fail ArgumentError, 'status cannot be nil'
+    # @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
 
-      @status = status
+      @naming_policy_name = naming_policy_name
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] platform_object_ids Value to be assigned
-    def platform_object_ids=(platform_object_ids)
-      if platform_object_ids.nil?
-        fail ArgumentError, 'platform_object_ids cannot be nil'
+    # @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
 
-      @platform_object_ids = platform_object_ids
+      @creative_overrides = creative_overrides
     end
 
     # Checks equality by comparing each attribute.
@@ -511,8 +496,7 @@ module PlainRouter::OpenAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id == o.id &&
-          workspace_id == o.workspace_id &&
+          name == o.name &&
           platform_ad_account_id == o.platform_ad_account_id &&
           platform == o.platform &&
           campaign_ref == o.campaign_ref &&
@@ -524,17 +508,10 @@ module PlainRouter::OpenAPI
           currency == o.currency &&
           copy == o.copy &&
           landing_page == o.landing_page &&
-          utm_policy_id == o.utm_policy_id &&
-          naming_policy_id == o.naming_policy_id &&
-          status == o.status &&
-          validation_result == o.validation_result &&
-          diff == o.diff &&
-          validated_at == o.validated_at &&
-          approval_id == o.approval_id &&
-          created_at == o.created_at &&
-          updated_at == o.updated_at &&
-          platform_object_ids == o.platform_object_ids &&
-          name == o.name
+          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
@@ -546,7 +523,7 @@ module PlainRouter::OpenAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, workspace_id, 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_id, naming_policy_id, status, validation_result, diff, validated_at, approval_id, created_at, updated_at, platform_object_ids, name].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