growwer 1.0.0

data/lib/growwer/models/post_order_briefing_request.rb

@@ -0,0 +1,220 @@
+=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
+  # The briefing of a post order (`type` `post`), checked against the media's post offer as the web checks it.
+  class PostOrderBriefingRequest < ApiModelBase
+    # No more links than the offer allows.
+    attr_accessor :links
+
+    # Extra services the offer has, added to the ones the web selects for your project by default. A project with a sensitive topic always carries `extra_charge_for_sensitive_topic` when the media charges it.
+    attr_accessor :extra_services
+
+    attr_accessor :title
+
+    attr_accessor :additional_info
+
+    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
+      {
+        :'links' => :'links',
+        :'extra_services' => :'extraServices',
+        :'title' => :'title',
+        :'additional_info' => :'additionalInfo'
+      }
+    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
+      {
+        :'links' => :'Array<OrderLinkRequest>',
+        :'extra_services' => :'Array<String>',
+        :'title' => :'String',
+        :'additional_info' => :'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::PostOrderBriefingRequest` 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::PostOrderBriefingRequest`. 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?(:'links')
+        if (value = attributes[:'links']).is_a?(Array)
+          self.links = value
+        end
+      else
+        self.links = nil
+      end
+
+      if attributes.key?(:'extra_services')
+        if (value = attributes[:'extra_services']).is_a?(Array)
+          self.extra_services = value
+        end
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'additional_info')
+        self.additional_info = attributes[:'additional_info']
+      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 @links.nil?
+        invalid_properties.push('invalid value for "links", links 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 @links.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] links Value to be assigned
+    def links=(links)
+      if links.nil?
+        fail ArgumentError, 'links cannot be nil'
+      end
+
+      @links = links
+    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 &&
+          links == o.links &&
+          extra_services == o.extra_services &&
+          title == o.title &&
+          additional_info == o.additional_info
+    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
+      [links, extra_services, title, additional_info].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/project.rb

@@ -0,0 +1,437 @@
+=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 Project < ApiModelBase
+    attr_accessor :id
+
+    # Your name for the project, or null when it has none.
+    attr_accessor :name
+
+    # The website the project promotes. It cannot be changed once the project exists.
+    attr_accessor :root_url
+
+    # What the website is: an online shop (`ecommerce`), a services business (`services`) or anything else (`other`).
+    attr_accessor :website_type
+
+    # The website's topic, as a topic id from GET /vocabulary. Exactly one.
+    attr_accessor :topics
+
+    # The language of the campaign, as a language code from GET /vocabulary.
+    attr_accessor :language
+
+    # The country the campaign targets, as a country code from GET /vocabulary, or null for worldwide.
+    attr_accessor :country
+
+    # The products or services the campaign promotes, 5 to 10.
+    attr_accessor :promoted_products
+
+    # Keywords you want the campaign to target, at most 100.
+    attr_accessor :user_keywords
+
+    # `finished` once Growwer has recommended media for the project, `analyzing` until then. Analysis can take hours, and it never finishes when no medium matches the project. Poll with backoff, and use `createdAt` to decide how long to keep polling. 
+    attr_accessor :state
+
+    attr_accessor :created_at
+
+    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
+      {
+        :'id' => :'id',
+        :'name' => :'name',
+        :'root_url' => :'rootUrl',
+        :'website_type' => :'websiteType',
+        :'topics' => :'topics',
+        :'language' => :'language',
+        :'country' => :'country',
+        :'promoted_products' => :'promotedProducts',
+        :'user_keywords' => :'userKeywords',
+        :'state' => :'state',
+        :'created_at' => :'createdAt'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'name' => :'String',
+        :'root_url' => :'String',
+        :'website_type' => :'String',
+        :'topics' => :'Array<Integer>',
+        :'language' => :'String',
+        :'country' => :'String',
+        :'promoted_products' => :'Array<String>',
+        :'user_keywords' => :'Array<String>',
+        :'state' => :'String',
+        :'created_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'name',
+        :'country',
+      ])
+    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::Project` 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::Project`. 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?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'root_url')
+        self.root_url = attributes[:'root_url']
+      else
+        self.root_url = nil
+      end
+
+      if attributes.key?(:'website_type')
+        self.website_type = attributes[:'website_type']
+      else
+        self.website_type = nil
+      end
+
+      if attributes.key?(:'topics')
+        if (value = attributes[:'topics']).is_a?(Array)
+          self.topics = value
+        end
+      else
+        self.topics = nil
+      end
+
+      if attributes.key?(:'language')
+        self.language = attributes[:'language']
+      else
+        self.language = nil
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      else
+        self.country = nil
+      end
+
+      if attributes.key?(:'promoted_products')
+        if (value = attributes[:'promoted_products']).is_a?(Array)
+          self.promoted_products = value
+        end
+      else
+        self.promoted_products = nil
+      end
+
+      if attributes.key?(:'user_keywords')
+        if (value = attributes[:'user_keywords']).is_a?(Array)
+          self.user_keywords = value
+        end
+      else
+        self.user_keywords = nil
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      else
+        self.state = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = 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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @root_url.nil?
+        invalid_properties.push('invalid value for "root_url", root_url cannot be nil.')
+      end
+
+      if @website_type.nil?
+        invalid_properties.push('invalid value for "website_type", website_type cannot be nil.')
+      end
+
+      if @topics.nil?
+        invalid_properties.push('invalid value for "topics", topics cannot be nil.')
+      end
+
+      if @language.nil?
+        invalid_properties.push('invalid value for "language", language cannot be nil.')
+      end
+
+      if @promoted_products.nil?
+        invalid_properties.push('invalid value for "promoted_products", promoted_products cannot be nil.')
+      end
+
+      if @user_keywords.nil?
+        invalid_properties.push('invalid value for "user_keywords", user_keywords cannot be nil.')
+      end
+
+      if @state.nil?
+        invalid_properties.push('invalid value for "state", state cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at 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 @id.nil?
+      return false if @root_url.nil?
+      return false if @website_type.nil?
+      website_type_validator = EnumAttributeValidator.new('String', ["ecommerce", "services", "other"])
+      return false unless website_type_validator.valid?(@website_type)
+      return false if @topics.nil?
+      return false if @language.nil?
+      return false if @promoted_products.nil?
+      return false if @user_keywords.nil?
+      return false if @state.nil?
+      state_validator = EnumAttributeValidator.new('String', ["analyzing", "finished"])
+      return false unless state_validator.valid?(@state)
+      return false if @created_at.nil?
+      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] root_url Value to be assigned
+    def root_url=(root_url)
+      if root_url.nil?
+        fail ArgumentError, 'root_url cannot be nil'
+      end
+
+      @root_url = root_url
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] website_type Object to be assigned
+    def website_type=(website_type)
+      validator = EnumAttributeValidator.new('String', ["ecommerce", "services", "other"])
+      unless validator.valid?(website_type)
+        fail ArgumentError, "invalid value for \"website_type\", must be one of #{validator.allowable_values}."
+      end
+      @website_type = website_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] topics Value to be assigned
+    def topics=(topics)
+      if topics.nil?
+        fail ArgumentError, 'topics cannot be nil'
+      end
+
+      @topics = topics
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] language Value to be assigned
+    def language=(language)
+      if language.nil?
+        fail ArgumentError, 'language cannot be nil'
+      end
+
+      @language = language
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] promoted_products Value to be assigned
+    def promoted_products=(promoted_products)
+      if promoted_products.nil?
+        fail ArgumentError, 'promoted_products cannot be nil'
+      end
+
+      @promoted_products = promoted_products
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] user_keywords Value to be assigned
+    def user_keywords=(user_keywords)
+      if user_keywords.nil?
+        fail ArgumentError, 'user_keywords cannot be nil'
+      end
+
+      @user_keywords = user_keywords
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] state Object to be assigned
+    def state=(state)
+      validator = EnumAttributeValidator.new('String', ["analyzing", "finished"])
+      unless validator.valid?(state)
+        fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
+      end
+      @state = state
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created_at Value to be assigned
+    def created_at=(created_at)
+      if created_at.nil?
+        fail ArgumentError, 'created_at cannot be nil'
+      end
+
+      @created_at = created_at
+    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 &&
+          id == o.id &&
+          name == o.name &&
+          root_url == o.root_url &&
+          website_type == o.website_type &&
+          topics == o.topics &&
+          language == o.language &&
+          country == o.country &&
+          promoted_products == o.promoted_products &&
+          user_keywords == o.user_keywords &&
+          state == o.state &&
+          created_at == o.created_at
+    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
+      [id, name, root_url, website_type, topics, language, country, promoted_products, user_keywords, state, created_at].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