growwer 1.0.0

data/lib/growwer/models/seller_media.rb

@@ -0,0 +1,573 @@
+=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
+  # One of your medias, as its seller sees it.
+  class SellerMedia < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :domain
+
+    # The media's root URL.
+    attr_accessor :url
+
+    attr_accessor :state
+
+    # How many times the media was deactivated for not publishing.
+    attr_accessor :deactivation_strikes
+
+    # A country code, as in GET /vocabulary, or null for none.
+    attr_accessor :country
+
+    # A language code, as in GET /vocabulary.
+    attr_accessor :language
+
+    # Topic ids, as in GET /vocabulary.
+    attr_accessor :topics
+
+    # The topic ids the media refuses, as in GET /vocabulary.
+    attr_accessor :banned_topics
+
+    # Your notes for buyers, or null for none.
+    attr_accessor :provider_comments
+
+    # The share of the media's orders that were published, in percent, or null without orders.
+    attr_accessor :publication_rate
+
+    # The average days from order to publication, or null without published orders.
+    attr_accessor :average_days_to_publication
+
+    attr_accessor :num_published_orders
+
+    attr_accessor :on_holiday
+
+    attr_accessor :flash_offer
+
+    attr_accessor :post_offer
+
+    attr_accessor :link_addition_offer
+
+    # The post fees Growwer suggests to sell more, as the seller media page does, or null when it suggests none. A side Growwer finds no competitive fee for is null: unlike the page, it never shows the fixed fee the page falls back to. POST /seller/medias/{id}/apply-competitive-fees sets them.
+    attr_accessor :competitive_fees
+
+    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',
+        :'domain' => :'domain',
+        :'url' => :'url',
+        :'state' => :'state',
+        :'deactivation_strikes' => :'deactivationStrikes',
+        :'country' => :'country',
+        :'language' => :'language',
+        :'topics' => :'topics',
+        :'banned_topics' => :'bannedTopics',
+        :'provider_comments' => :'providerComments',
+        :'publication_rate' => :'publicationRate',
+        :'average_days_to_publication' => :'averageDaysToPublication',
+        :'num_published_orders' => :'numPublishedOrders',
+        :'on_holiday' => :'onHoliday',
+        :'flash_offer' => :'flashOffer',
+        :'post_offer' => :'postOffer',
+        :'link_addition_offer' => :'linkAdditionOffer',
+        :'competitive_fees' => :'competitiveFees',
+        :'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',
+        :'domain' => :'String',
+        :'url' => :'String',
+        :'state' => :'String',
+        :'deactivation_strikes' => :'Integer',
+        :'country' => :'String',
+        :'language' => :'String',
+        :'topics' => :'Array<Integer>',
+        :'banned_topics' => :'Array<Integer>',
+        :'provider_comments' => :'String',
+        :'publication_rate' => :'Integer',
+        :'average_days_to_publication' => :'Integer',
+        :'num_published_orders' => :'Integer',
+        :'on_holiday' => :'Boolean',
+        :'flash_offer' => :'SellerMediaFlashOffer',
+        :'post_offer' => :'SellerMediaPostOffer',
+        :'link_addition_offer' => :'SellerMediaLinkAdditionOffer',
+        :'competitive_fees' => :'SellerFeesOrNull',
+        :'created_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'country',
+        :'provider_comments',
+        :'publication_rate',
+        :'average_days_to_publication',
+        :'flash_offer',
+        :'link_addition_offer',
+        :'competitive_fees',
+      ])
+    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::SellerMedia` 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::SellerMedia`. 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?(:'domain')
+        self.domain = attributes[:'domain']
+      else
+        self.domain = nil
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      else
+        self.url = nil
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      else
+        self.state = nil
+      end
+
+      if attributes.key?(:'deactivation_strikes')
+        self.deactivation_strikes = attributes[:'deactivation_strikes']
+      else
+        self.deactivation_strikes = nil
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      else
+        self.country = nil
+      end
+
+      if attributes.key?(:'language')
+        self.language = attributes[:'language']
+      else
+        self.language = 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?(:'banned_topics')
+        if (value = attributes[:'banned_topics']).is_a?(Array)
+          self.banned_topics = value
+        end
+      else
+        self.banned_topics = nil
+      end
+
+      if attributes.key?(:'provider_comments')
+        self.provider_comments = attributes[:'provider_comments']
+      else
+        self.provider_comments = nil
+      end
+
+      if attributes.key?(:'publication_rate')
+        self.publication_rate = attributes[:'publication_rate']
+      else
+        self.publication_rate = nil
+      end
+
+      if attributes.key?(:'average_days_to_publication')
+        self.average_days_to_publication = attributes[:'average_days_to_publication']
+      else
+        self.average_days_to_publication = nil
+      end
+
+      if attributes.key?(:'num_published_orders')
+        self.num_published_orders = attributes[:'num_published_orders']
+      else
+        self.num_published_orders = nil
+      end
+
+      if attributes.key?(:'on_holiday')
+        self.on_holiday = attributes[:'on_holiday']
+      else
+        self.on_holiday = nil
+      end
+
+      if attributes.key?(:'flash_offer')
+        self.flash_offer = attributes[:'flash_offer']
+      else
+        self.flash_offer = nil
+      end
+
+      if attributes.key?(:'post_offer')
+        self.post_offer = attributes[:'post_offer']
+      else
+        self.post_offer = nil
+      end
+
+      if attributes.key?(:'link_addition_offer')
+        self.link_addition_offer = attributes[:'link_addition_offer']
+      else
+        self.link_addition_offer = nil
+      end
+
+      if attributes.key?(:'competitive_fees')
+        self.competitive_fees = attributes[:'competitive_fees']
+      else
+        self.competitive_fees = 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 @domain.nil?
+        invalid_properties.push('invalid value for "domain", domain cannot be nil.')
+      end
+
+      if @url.nil?
+        invalid_properties.push('invalid value for "url", url cannot be nil.')
+      end
+
+      if @state.nil?
+        invalid_properties.push('invalid value for "state", state cannot be nil.')
+      end
+
+      if @deactivation_strikes.nil?
+        invalid_properties.push('invalid value for "deactivation_strikes", deactivation_strikes cannot be nil.')
+      end
+
+      if @language.nil?
+        invalid_properties.push('invalid value for "language", language cannot be nil.')
+      end
+
+      if @topics.nil?
+        invalid_properties.push('invalid value for "topics", topics cannot be nil.')
+      end
+
+      if @banned_topics.nil?
+        invalid_properties.push('invalid value for "banned_topics", banned_topics cannot be nil.')
+      end
+
+      if @num_published_orders.nil?
+        invalid_properties.push('invalid value for "num_published_orders", num_published_orders cannot be nil.')
+      end
+
+      if @on_holiday.nil?
+        invalid_properties.push('invalid value for "on_holiday", on_holiday cannot be nil.')
+      end
+
+      if @post_offer.nil?
+        invalid_properties.push('invalid value for "post_offer", post_offer 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 @domain.nil?
+      return false if @url.nil?
+      return false if @state.nil?
+      state_validator = EnumAttributeValidator.new('String', ["analyzing", "pending_review", "active", "deactivated"])
+      return false unless state_validator.valid?(@state)
+      return false if @deactivation_strikes.nil?
+      return false if @language.nil?
+      return false if @topics.nil?
+      return false if @banned_topics.nil?
+      return false if @num_published_orders.nil?
+      return false if @on_holiday.nil?
+      return false if @post_offer.nil?
+      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] domain Value to be assigned
+    def domain=(domain)
+      if domain.nil?
+        fail ArgumentError, 'domain cannot be nil'
+      end
+
+      @domain = domain
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] url Value to be assigned
+    def url=(url)
+      if url.nil?
+        fail ArgumentError, 'url cannot be nil'
+      end
+
+      @url = url
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] state Object to be assigned
+    def state=(state)
+      validator = EnumAttributeValidator.new('String', ["analyzing", "pending_review", "active", "deactivated"])
+      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] deactivation_strikes Value to be assigned
+    def deactivation_strikes=(deactivation_strikes)
+      if deactivation_strikes.nil?
+        fail ArgumentError, 'deactivation_strikes cannot be nil'
+      end
+
+      @deactivation_strikes = deactivation_strikes
+    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] 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] banned_topics Value to be assigned
+    def banned_topics=(banned_topics)
+      if banned_topics.nil?
+        fail ArgumentError, 'banned_topics cannot be nil'
+      end
+
+      @banned_topics = banned_topics
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] num_published_orders Value to be assigned
+    def num_published_orders=(num_published_orders)
+      if num_published_orders.nil?
+        fail ArgumentError, 'num_published_orders cannot be nil'
+      end
+
+      @num_published_orders = num_published_orders
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] on_holiday Value to be assigned
+    def on_holiday=(on_holiday)
+      if on_holiday.nil?
+        fail ArgumentError, 'on_holiday cannot be nil'
+      end
+
+      @on_holiday = on_holiday
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] post_offer Value to be assigned
+    def post_offer=(post_offer)
+      if post_offer.nil?
+        fail ArgumentError, 'post_offer cannot be nil'
+      end
+
+      @post_offer = post_offer
+    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 &&
+          domain == o.domain &&
+          url == o.url &&
+          state == o.state &&
+          deactivation_strikes == o.deactivation_strikes &&
+          country == o.country &&
+          language == o.language &&
+          topics == o.topics &&
+          banned_topics == o.banned_topics &&
+          provider_comments == o.provider_comments &&
+          publication_rate == o.publication_rate &&
+          average_days_to_publication == o.average_days_to_publication &&
+          num_published_orders == o.num_published_orders &&
+          on_holiday == o.on_holiday &&
+          flash_offer == o.flash_offer &&
+          post_offer == o.post_offer &&
+          link_addition_offer == o.link_addition_offer &&
+          competitive_fees == o.competitive_fees &&
+          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, 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
+    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