growwer 1.0.1 → 1.1.0

data/lib/growwer/models/project_catalogue_media_all_of_project_ai_keywords.rb

@@ -0,0 +1,211 @@
+=begin
+#Growwer API
+
+#The Growwer customer API. Authenticate every call with an API key created on your profile page, sent as `Authorization: Bearer <key>`. A read key can call every GET operation; writes need a read and write key and an `Idempotency-Key` header.  Idempotency: use a new `Idempotency-Key` (1 to 255 printable ASCII characters without spaces) for each operation and reuse it only to retry that same operation. Keys belong to your account, not to one API key. - A successful write is stored for 30 days: a retry with the same key and   the same request replays its response with `Idempotent-Replayed: true`   and does nothing again. - A refused write (4xx) has no effect and releases its key: once you fix the   cause, retry with the same key and the write runs. - A failed write (5xx) may have taken effect, so it is never run again under   its key: a retry gets 409 `idempotency_outcome_unknown`. Check whether it   took effect before retrying with a new key. - A retry while the first request is still running gets 409   `idempotency_request_in_progress`. A request still running after 5 minutes   is treated as failed: a retry gets 409 `idempotency_outcome_unknown`. - The same key with a different request (method, path, query or body) gets   409 `idempotency_key_reused`. A write without the header gets 400   `idempotency_key_required`.  Every response carries `X-Request-Id`. Errors share one shape, `{code, message, requestId, details?}`. Money is integer cents plus a currency code and dates are ISO-8601. 
+
+The version of the OpenAPI document: 1
+Contact: support@growwer.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Growwer
+  class ProjectCatalogueMediaAllOfProjectAiKeywords < ApiModelBase
+    attr_accessor :keyword
+
+    # The AI engine that gave the keyword, as the `ranksAiKeyword` filter names it, or null for an engine it does not name. It is never where the media comes from.
+    attr_accessor :source
+
+    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
+      {
+        :'keyword' => :'keyword',
+        :'source' => :'source'
+      }
+    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
+      {
+        :'keyword' => :'String',
+        :'source' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'source'
+      ])
+    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 `Growwer::ProjectCatalogueMediaAllOfProjectAiKeywords` 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 `Growwer::ProjectCatalogueMediaAllOfProjectAiKeywords`. 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?(:'keyword')
+        self.keyword = attributes[:'keyword']
+      else
+        self.keyword = nil
+      end
+
+      if attributes.key?(:'source')
+        self.source = attributes[:'source']
+      else
+        self.source = 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 @keyword.nil?
+        invalid_properties.push('invalid value for "keyword", keyword 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 @keyword.nil?
+      source_validator = EnumAttributeValidator.new('String', ["googleAiOverview", "chatgpt", "googleAiMode"])
+      return false unless source_validator.valid?(@source)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] keyword Value to be assigned
+    def keyword=(keyword)
+      if keyword.nil?
+        fail ArgumentError, 'keyword cannot be nil'
+      end
+
+      @keyword = keyword
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] source Object to be assigned
+    def source=(source)
+      validator = EnumAttributeValidator.new('String', ["googleAiOverview", "chatgpt", "googleAiMode"])
+      unless validator.valid?(source)
+        fail ArgumentError, "invalid value for \"source\", must be one of #{validator.allowable_values}."
+      end
+      @source = source
+    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 &&
+          keyword == o.keyword &&
+          source == o.source
+    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
+      [keyword, source].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/growwer/models/seller_media.rb

@@ -23,6 +23,8 @@ module Growwer
     # The media's root URL.
     attr_accessor :url
 
+    attr_accessor :typology
+
     attr_accessor :state
 
     # How many times the media was deactivated for not publishing.
@@ -92,6 +94,7 @@ module Growwer
         :'id' => :'id',
         :'domain' => :'domain',
         :'url' => :'url',
+        :'typology' => :'typology',
         :'state' => :'state',
         :'deactivation_strikes' => :'deactivationStrikes',
         :'country' => :'country',
@@ -127,6 +130,7 @@ module Growwer
         :'id' => :'String',
         :'domain' => :'String',
         :'url' => :'String',
+        :'typology' => :'String',
         :'state' => :'String',
         :'deactivation_strikes' => :'Integer',
         :'country' => :'String',
@@ -193,6 +197,12 @@ module Growwer
         self.url = nil
       end
 
+      if attributes.key?(:'typology')
+        self.typology = attributes[:'typology']
+      else
+        self.typology = nil
+      end
+
       if attributes.key?(:'state')
         self.state = attributes[:'state']
       else
@@ -311,6 +321,10 @@ module Growwer
         invalid_properties.push('invalid value for "url", url cannot be nil.')
       end
 
+      if @typology.nil?
+        invalid_properties.push('invalid value for "typology", typology cannot be nil.')
+      end
+
       if @state.nil?
         invalid_properties.push('invalid value for "state", state cannot be nil.')
       end
@@ -357,6 +371,9 @@ module Growwer
       return false if @id.nil?
       return false if @domain.nil?
       return false if @url.nil?
+      return false if @typology.nil?
+      typology_validator = EnumAttributeValidator.new('String', ["blog", "press"])
+      return false unless typology_validator.valid?(@typology)
       return false if @state.nil?
       state_validator = EnumAttributeValidator.new('String', ["analyzing", "pending_review", "active", "deactivated"])
       return false unless state_validator.valid?(@state)
@@ -401,6 +418,16 @@ module Growwer
       @url = url
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] typology Object to be assigned
+    def typology=(typology)
+      validator = EnumAttributeValidator.new('String', ["blog", "press"])
+      unless validator.valid?(typology)
+        fail ArgumentError, "invalid value for \"typology\", must be one of #{validator.allowable_values}."
+      end
+      @typology = typology
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] state Object to be assigned
     def state=(state)
@@ -499,6 +526,7 @@ module Growwer
           id == o.id &&
           domain == o.domain &&
           url == o.url &&
+          typology == o.typology &&
           state == o.state &&
           deactivation_strikes == o.deactivation_strikes &&
           country == o.country &&
@@ -526,7 +554,7 @@ module Growwer
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, domain, url, state, deactivation_strikes, country, language, topics, banned_topics, provider_comments, publication_rate, average_days_to_publication, num_published_orders, on_holiday, flash_offer, post_offer, link_addition_offer, competitive_fees, created_at].hash
+      [id, domain, url, typology, state, deactivation_strikes, country, language, topics, banned_topics, provider_comments, publication_rate, average_days_to_publication, num_published_orders, on_holiday, flash_offer, post_offer, link_addition_offer, competitive_fees, created_at].hash
     end
 
     # Builds the object from hash

data/lib/growwer/models/seller_media_post_offer.rb

@@ -18,12 +18,47 @@ module Growwer
     # One entry per link type you offer.
     attr_accessor :pricing_options
 
+    # How many links a sponsored post may hold, 1 to 4.
+    attr_accessor :maximum_links
+
+    # Whether sponsored posts are labelled as advertising.
+    attr_accessor :advertising_labelling_policy
+
+    # The social networks sponsored posts are promoted on.
+    attr_accessor :promoted_social_networks
+
+    # Read here, but PATCH /seller/medias/{id} and POST /seller/medias take it at the top level of the body.
     attr_accessor :extra_services
 
+    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
       {
         :'pricing_options' => :'pricingOptions',
+        :'maximum_links' => :'maximumLinks',
+        :'advertising_labelling_policy' => :'advertisingLabellingPolicy',
+        :'promoted_social_networks' => :'promotedSocialNetworks',
         :'extra_services' => :'extraServices'
       }
     end
@@ -42,6 +77,9 @@ module Growwer
     def self.openapi_types
       {
         :'pricing_options' => :'Array<SellerMediaPostOfferPricingOptionsInner>',
+        :'maximum_links' => :'Integer',
+        :'advertising_labelling_policy' => :'String',
+        :'promoted_social_networks' => :'Array<String>',
         :'extra_services' => :'Array<UpdateSellerMediaRequestExtraServicesInner>'
       }
     end
@@ -76,6 +114,26 @@ module Growwer
         self.pricing_options = nil
       end
 
+      if attributes.key?(:'maximum_links')
+        self.maximum_links = attributes[:'maximum_links']
+      else
+        self.maximum_links = nil
+      end
+
+      if attributes.key?(:'advertising_labelling_policy')
+        self.advertising_labelling_policy = attributes[:'advertising_labelling_policy']
+      else
+        self.advertising_labelling_policy = nil
+      end
+
+      if attributes.key?(:'promoted_social_networks')
+        if (value = attributes[:'promoted_social_networks']).is_a?(Array)
+          self.promoted_social_networks = value
+        end
+      else
+        self.promoted_social_networks = nil
+      end
+
       if attributes.key?(:'extra_services')
         if (value = attributes[:'extra_services']).is_a?(Array)
           self.extra_services = value
@@ -94,6 +152,18 @@ module Growwer
         invalid_properties.push('invalid value for "pricing_options", pricing_options cannot be nil.')
       end
 
+      if @maximum_links.nil?
+        invalid_properties.push('invalid value for "maximum_links", maximum_links cannot be nil.')
+      end
+
+      if @advertising_labelling_policy.nil?
+        invalid_properties.push('invalid value for "advertising_labelling_policy", advertising_labelling_policy cannot be nil.')
+      end
+
+      if @promoted_social_networks.nil?
+        invalid_properties.push('invalid value for "promoted_social_networks", promoted_social_networks cannot be nil.')
+      end
+
       if @extra_services.nil?
         invalid_properties.push('invalid value for "extra_services", extra_services cannot be nil.')
       end
@@ -106,6 +176,11 @@ module Growwer
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @pricing_options.nil?
+      return false if @maximum_links.nil?
+      return false if @advertising_labelling_policy.nil?
+      advertising_labelling_policy_validator = EnumAttributeValidator.new('String', ["always", "never"])
+      return false unless advertising_labelling_policy_validator.valid?(@advertising_labelling_policy)
+      return false if @promoted_social_networks.nil?
       return false if @extra_services.nil?
       true
     end
@@ -120,6 +195,26 @@ module Growwer
       @pricing_options = pricing_options
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] maximum_links Value to be assigned
+    def maximum_links=(maximum_links)
+      if maximum_links.nil?
+        fail ArgumentError, 'maximum_links cannot be nil'
+      end
+
+      @maximum_links = maximum_links
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] advertising_labelling_policy Object to be assigned
+    def advertising_labelling_policy=(advertising_labelling_policy)
+      validator = EnumAttributeValidator.new('String', ["always", "never"])
+      unless validator.valid?(advertising_labelling_policy)
+        fail ArgumentError, "invalid value for \"advertising_labelling_policy\", must be one of #{validator.allowable_values}."
+      end
+      @advertising_labelling_policy = advertising_labelling_policy
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] extra_services Value to be assigned
     def extra_services=(extra_services)
@@ -136,6 +231,9 @@ module Growwer
       return true if self.equal?(o)
       self.class == o.class &&
           pricing_options == o.pricing_options &&
+          maximum_links == o.maximum_links &&
+          advertising_labelling_policy == o.advertising_labelling_policy &&
+          promoted_social_networks == o.promoted_social_networks &&
           extra_services == o.extra_services
     end
 
@@ -148,7 +246,7 @@ module Growwer
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [pricing_options, extra_services].hash
+      [pricing_options, maximum_links, advertising_labelling_policy, promoted_social_networks, extra_services].hash
     end
 
     # Builds the object from hash

data/lib/growwer/models/update_seller_media_request.rb

@@ -15,15 +15,40 @@ require 'time'
 
 module Growwer
   class UpdateSellerMediaRequest < ApiModelBase
+    attr_accessor :typology
+
     attr_accessor :post_offer
 
     attr_accessor :link_addition_offer
 
     attr_accessor :extra_services
 
+    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
       {
+        :'typology' => :'typology',
         :'post_offer' => :'postOffer',
         :'link_addition_offer' => :'linkAdditionOffer',
         :'extra_services' => :'extraServices'
@@ -43,6 +68,7 @@ module Growwer
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'typology' => :'String',
         :'post_offer' => :'UpdateSellerMediaRequestPostOffer',
         :'link_addition_offer' => :'UpdateSellerMediaRequestLinkAdditionOffer',
         :'extra_services' => :'Array<UpdateSellerMediaRequestExtraServicesInner>'
@@ -72,6 +98,10 @@ module Growwer
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'typology')
+        self.typology = attributes[:'typology']
+      end
+
       if attributes.key?(:'post_offer')
         self.post_offer = attributes[:'post_offer']
       end
@@ -99,14 +129,27 @@ module Growwer
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      typology_validator = EnumAttributeValidator.new('String', ["blog", "press"])
+      return false unless typology_validator.valid?(@typology)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] typology Object to be assigned
+    def typology=(typology)
+      validator = EnumAttributeValidator.new('String', ["blog", "press"])
+      unless validator.valid?(typology)
+        fail ArgumentError, "invalid value for \"typology\", must be one of #{validator.allowable_values}."
+      end
+      @typology = typology
+    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 &&
+          typology == o.typology &&
           post_offer == o.post_offer &&
           link_addition_offer == o.link_addition_offer &&
           extra_services == o.extra_services
@@ -121,7 +164,7 @@ module Growwer
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [post_offer, link_addition_offer, extra_services].hash
+      [typology, post_offer, link_addition_offer, extra_services].hash
     end
 
     # Builds the object from hash