growwer 1.0.2 → 1.1.1

data/lib/growwer/models/create_seller_media_request_post_offer.rb

@@ -0,0 +1,273 @@
+=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 CreateSellerMediaRequestPostOffer < ApiModelBase
+    attr_accessor :pricing_options
+
+    attr_accessor :maximum_links
+
+    attr_accessor :advertising_labelling_policy
+
+    attr_accessor :promoted_social_networks
+
+    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'
+      }
+    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
+      {
+        :'pricing_options' => :'Array<UpdateSellerMediaRequestPostOfferPricingOptionsInner>',
+        :'maximum_links' => :'Integer',
+        :'advertising_labelling_policy' => :'String',
+        :'promoted_social_networks' => :'Array<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 `Growwer::CreateSellerMediaRequestPostOffer` 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::CreateSellerMediaRequestPostOffer`. 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?(:'pricing_options')
+        if (value = attributes[:'pricing_options']).is_a?(Array)
+          self.pricing_options = value
+        end
+      else
+        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']
+      end
+
+      if attributes.key?(:'promoted_social_networks')
+        if (value = attributes[:'promoted_social_networks']).is_a?(Array)
+          self.promoted_social_networks = 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 @pricing_options.nil?
+        invalid_properties.push('invalid value for "pricing_options", pricing_options cannot be nil.')
+      end
+
+      if @pricing_options.length < 1
+        invalid_properties.push('invalid value for "pricing_options", number of items must be greater than or equal to 1.')
+      end
+
+      if @maximum_links.nil?
+        invalid_properties.push('invalid value for "maximum_links", maximum_links cannot be nil.')
+      end
+
+      if @maximum_links > 4
+        invalid_properties.push('invalid value for "maximum_links", must be smaller than or equal to 4.')
+      end
+
+      if @maximum_links < 1
+        invalid_properties.push('invalid value for "maximum_links", must be greater than or equal to 1.')
+      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 @pricing_options.nil?
+      return false if @pricing_options.length < 1
+      return false if @maximum_links.nil?
+      return false if @maximum_links > 4
+      return false if @maximum_links < 1
+      advertising_labelling_policy_validator = EnumAttributeValidator.new('String', ["always", "never"])
+      return false unless advertising_labelling_policy_validator.valid?(@advertising_labelling_policy)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] pricing_options Value to be assigned
+    def pricing_options=(pricing_options)
+      if pricing_options.nil?
+        fail ArgumentError, 'pricing_options cannot be nil'
+      end
+
+      if pricing_options.length < 1
+        fail ArgumentError, 'invalid value for "pricing_options", number of items must be greater than or equal to 1.'
+      end
+
+      @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
+
+      if maximum_links > 4
+        fail ArgumentError, 'invalid value for "maximum_links", must be smaller than or equal to 4.'
+      end
+
+      if maximum_links < 1
+        fail ArgumentError, 'invalid value for "maximum_links", must be greater than or equal to 1.'
+      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
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      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
+    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
+      [pricing_options, maximum_links, advertising_labelling_policy, promoted_social_networks].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/get_me200_response_catalogue.rb

@@ -21,7 +21,7 @@ module Growwer
     # How many distinct medias the catalogue operations show you per UTC day: the full cap when `eligible` is true, the trial quota otherwise. 0 means the catalogue answers 403 `catalogue_requires_recent_order` until you have a recent completed order.
     attr_accessor :daily_cap
 
-    # How many new distinct medias still fit in `dailyCap` today (UTC). Medias you have already seen today are free. Null when the count cannot be read right now; the catalogue operations then answer 503 until it can.
+    # How many units of `dailyCap` still fit today (UTC): each new distinct media costs one, and a catalogue response that holds no new media, an empty one or a saved filter count included, costs one unless the same request was answered today and the media lists, topics and language of its project have not changed since. Medias you have already seen today, and requests already answered today, are free. Null when the count cannot be read right now; the catalogue operations then answer 503 until it can.
     attr_accessor :remaining_today
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/growwer/models/link_addition_order_briefing_request.rb

@@ -16,7 +16,7 @@ require 'time'
 module Growwer
   # The briefing of a link addition (`type` `link_addition`), checked against the media's link addition offer as the web checks it.
   class LinkAdditionOrderBriefingRequest < ApiModelBase
-    # The URL of an existing article on the media's domain that the link goes into.
+    # The URL of an existing article on the media's domain that the link goes into, without `<` or `>`.
     attr_accessor :linking_from
 
     attr_accessor :link

data/lib/growwer/models/project_catalogue_media_all_of_project.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Growwer
-  # The media's state in the project.
+  # The media's state in the project, and the AI keywords the web lists for the media in this project.
   class ProjectCatalogueMediaAllOfProject < ApiModelBase
     attr_accessor :favourite
 
@@ -31,6 +31,9 @@ module Growwer
     # Growwer matched the media with the project recently.
     attr_accessor :new
 
+    # The AI keywords the web lists for the media in this project, one entry per keyword of each stored source, empty when there are none. Keywords an AI answer gave without referencing any domain may be listed for every media of the project, so an entry does not mean that the engine cited the media. Entries keep their order within an engine, and a keyword listed by two engines appears once for each; the order of the engines is not promised.
+    attr_accessor :ai_keywords
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -39,7 +42,8 @@ module Growwer
         :'requested' => :'requested',
         :'recommended' => :'recommended',
         :'bought' => :'bought',
-        :'new' => :'new'
+        :'new' => :'new',
+        :'ai_keywords' => :'aiKeywords'
       }
     end
 
@@ -61,7 +65,8 @@ module Growwer
         :'requested' => :'Boolean',
         :'recommended' => :'Boolean',
         :'bought' => :'Boolean',
-        :'new' => :'Boolean'
+        :'new' => :'Boolean',
+        :'ai_keywords' => :'Array<ProjectCatalogueMediaAllOfProjectAiKeywords>'
       }
     end
 
@@ -122,6 +127,14 @@ module Growwer
       else
         self.new = nil
       end
+
+      if attributes.key?(:'ai_keywords')
+        if (value = attributes[:'ai_keywords']).is_a?(Array)
+          self.ai_keywords = value
+        end
+      else
+        self.ai_keywords = nil
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -153,6 +166,10 @@ module Growwer
         invalid_properties.push('invalid value for "new", new cannot be nil.')
       end
 
+      if @ai_keywords.nil?
+        invalid_properties.push('invalid value for "ai_keywords", ai_keywords cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -166,6 +183,7 @@ module Growwer
       return false if @recommended.nil?
       return false if @bought.nil?
       return false if @new.nil?
+      return false if @ai_keywords.nil?
       true
     end
 
@@ -229,6 +247,16 @@ module Growwer
       @new = new
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] ai_keywords Value to be assigned
+    def ai_keywords=(ai_keywords)
+      if ai_keywords.nil?
+        fail ArgumentError, 'ai_keywords cannot be nil'
+      end
+
+      @ai_keywords = ai_keywords
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -239,7 +267,8 @@ module Growwer
           requested == o.requested &&
           recommended == o.recommended &&
           bought == o.bought &&
-          new == o.new
+          new == o.new &&
+          ai_keywords == o.ai_keywords
     end
 
     # @see the `==` method
@@ -251,7 +280,7 @@ module Growwer
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [favourite, discarded, requested, recommended, bought, new].hash
+      [favourite, discarded, requested, recommended, bought, new, ai_keywords].hash
     end
 
     # Builds the object from hash

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