growwer 1.0.0

data/lib/growwer/models/order.rb

@@ -0,0 +1,541 @@
+=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 Order < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :reference
+
+    attr_accessor :type
+
+    # The raw state name. GET /orders documents the values its `state` filter takes.
+    attr_accessor :state
+
+    # Who the order is waiting on, or null when it waits on no one.
+    attr_accessor :pending_action
+
+    # What you pay for the order.
+    attr_accessor :price
+
+    attr_accessor :project
+
+    attr_accessor :media
+
+    attr_accessor :created_at
+
+    # When the order last changed state. It changes on state changes only, so poll with GET /orders?updatedSince= on it.
+    attr_accessor :updated_at
+
+    attr_accessor :scheduled_publication_date
+
+    attr_accessor :delivery
+
+    attr_accessor :briefing
+
+    attr_accessor :draft
+
+    # Every state change, oldest first.
+    attr_accessor :state_history
+
+    attr_accessor :channel
+
+    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',
+        :'reference' => :'reference',
+        :'type' => :'type',
+        :'state' => :'state',
+        :'pending_action' => :'pendingAction',
+        :'price' => :'price',
+        :'project' => :'project',
+        :'media' => :'media',
+        :'created_at' => :'createdAt',
+        :'updated_at' => :'updatedAt',
+        :'scheduled_publication_date' => :'scheduledPublicationDate',
+        :'delivery' => :'delivery',
+        :'briefing' => :'briefing',
+        :'draft' => :'draft',
+        :'state_history' => :'stateHistory',
+        :'channel' => :'channel'
+      }
+    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',
+        :'reference' => :'String',
+        :'type' => :'String',
+        :'state' => :'String',
+        :'pending_action' => :'String',
+        :'price' => :'Money',
+        :'project' => :'OrderProject',
+        :'media' => :'OrderMedia',
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time',
+        :'scheduled_publication_date' => :'Time',
+        :'delivery' => :'OrderDelivery',
+        :'briefing' => :'OrderBriefing',
+        :'draft' => :'OrderDraft',
+        :'state_history' => :'Array<OrderStateHistoryInner>',
+        :'channel' => :'OrderChannel'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'pending_action',
+        :'scheduled_publication_date',
+        :'delivery',
+        :'draft',
+      ])
+    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::Order` 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::Order`. 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?(:'reference')
+        self.reference = attributes[:'reference']
+      else
+        self.reference = nil
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      else
+        self.state = nil
+      end
+
+      if attributes.key?(:'pending_action')
+        self.pending_action = attributes[:'pending_action']
+      else
+        self.pending_action = nil
+      end
+
+      if attributes.key?(:'price')
+        self.price = attributes[:'price']
+      else
+        self.price = nil
+      end
+
+      if attributes.key?(:'project')
+        self.project = attributes[:'project']
+      else
+        self.project = nil
+      end
+
+      if attributes.key?(:'media')
+        self.media = attributes[:'media']
+      else
+        self.media = 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?(:'scheduled_publication_date')
+        self.scheduled_publication_date = attributes[:'scheduled_publication_date']
+      else
+        self.scheduled_publication_date = nil
+      end
+
+      if attributes.key?(:'delivery')
+        self.delivery = attributes[:'delivery']
+      else
+        self.delivery = nil
+      end
+
+      if attributes.key?(:'briefing')
+        self.briefing = attributes[:'briefing']
+      else
+        self.briefing = nil
+      end
+
+      if attributes.key?(:'draft')
+        self.draft = attributes[:'draft']
+      else
+        self.draft = nil
+      end
+
+      if attributes.key?(:'state_history')
+        if (value = attributes[:'state_history']).is_a?(Array)
+          self.state_history = value
+        end
+      else
+        self.state_history = nil
+      end
+
+      if attributes.key?(:'channel')
+        self.channel = attributes[:'channel']
+      else
+        self.channel = 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 @reference.nil?
+        invalid_properties.push('invalid value for "reference", reference cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @state.nil?
+        invalid_properties.push('invalid value for "state", state cannot be nil.')
+      end
+
+      if @price.nil?
+        invalid_properties.push('invalid value for "price", price cannot be nil.')
+      end
+
+      if @project.nil?
+        invalid_properties.push('invalid value for "project", project cannot be nil.')
+      end
+
+      if @media.nil?
+        invalid_properties.push('invalid value for "media", media cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
+      end
+
+      if @briefing.nil?
+        invalid_properties.push('invalid value for "briefing", briefing cannot be nil.')
+      end
+
+      if @state_history.nil?
+        invalid_properties.push('invalid value for "state_history", state_history cannot be nil.')
+      end
+
+      if @channel.nil?
+        invalid_properties.push('invalid value for "channel", channel 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 @reference.nil?
+      return false if @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["post", "link_addition"])
+      return false unless type_validator.valid?(@type)
+      return false if @state.nil?
+      pending_action_validator = EnumAttributeValidator.new('String', ["buyer", "seller", "growwer"])
+      return false unless pending_action_validator.valid?(@pending_action)
+      return false if @price.nil?
+      return false if @project.nil?
+      return false if @media.nil?
+      return false if @created_at.nil?
+      return false if @updated_at.nil?
+      return false if @briefing.nil?
+      return false if @state_history.nil?
+      return false if @channel.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] reference Value to be assigned
+    def reference=(reference)
+      if reference.nil?
+        fail ArgumentError, 'reference cannot be nil'
+      end
+
+      @reference = reference
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["post", "link_addition"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] state Value to be assigned
+    def state=(state)
+      if state.nil?
+        fail ArgumentError, 'state cannot be nil'
+      end
+
+      @state = state
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] pending_action Object to be assigned
+    def pending_action=(pending_action)
+      validator = EnumAttributeValidator.new('String', ["buyer", "seller", "growwer"])
+      unless validator.valid?(pending_action)
+        fail ArgumentError, "invalid value for \"pending_action\", must be one of #{validator.allowable_values}."
+      end
+      @pending_action = pending_action
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] price Value to be assigned
+    def price=(price)
+      if price.nil?
+        fail ArgumentError, 'price cannot be nil'
+      end
+
+      @price = price
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] project Value to be assigned
+    def project=(project)
+      if project.nil?
+        fail ArgumentError, 'project cannot be nil'
+      end
+
+      @project = project
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] media Value to be assigned
+    def media=(media)
+      if media.nil?
+        fail ArgumentError, 'media cannot be nil'
+      end
+
+      @media = media
+    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
+
+    # Custom attribute writer method with validation
+    # @param [Object] updated_at Value to be assigned
+    def updated_at=(updated_at)
+      if updated_at.nil?
+        fail ArgumentError, 'updated_at cannot be nil'
+      end
+
+      @updated_at = updated_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] briefing Value to be assigned
+    def briefing=(briefing)
+      if briefing.nil?
+        fail ArgumentError, 'briefing cannot be nil'
+      end
+
+      @briefing = briefing
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] state_history Value to be assigned
+    def state_history=(state_history)
+      if state_history.nil?
+        fail ArgumentError, 'state_history cannot be nil'
+      end
+
+      @state_history = state_history
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] channel Value to be assigned
+    def channel=(channel)
+      if channel.nil?
+        fail ArgumentError, 'channel cannot be nil'
+      end
+
+      @channel = channel
+    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 &&
+          reference == o.reference &&
+          type == o.type &&
+          state == o.state &&
+          pending_action == o.pending_action &&
+          price == o.price &&
+          project == o.project &&
+          media == o.media &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at &&
+          scheduled_publication_date == o.scheduled_publication_date &&
+          delivery == o.delivery &&
+          briefing == o.briefing &&
+          draft == o.draft &&
+          state_history == o.state_history &&
+          channel == o.channel
+    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, reference, type, state, pending_action, price, project, media, created_at, updated_at, scheduled_publication_date, delivery, briefing, draft, state_history, channel].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