growwer 1.0.0

data/lib/growwer/models/managed_service_proposal.rb

@@ -0,0 +1,428 @@
+=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
+  # A media the team proposes for a campaign, with the publication it would get.
+  class ManagedServiceProposal < ApiModelBase
+    attr_accessor :id
+
+    # `proposed` awaits your review. `accepted` awaits the order the team places for you. `purchase_started` and `purchase_finished` follow that order.
+    attr_accessor :state
+
+    attr_accessor :media
+
+    attr_accessor :service
+
+    # The price the proposal was made at, the one the summary PDF shows.
+    attr_accessor :proposed_price
+
+    # What the media charges for the service today; null when it no longer offers it.
+    attr_accessor :current_price
+
+    attr_accessor :briefing
+
+    # Why the proposal reached its state, in your language, such as your comment when you rejected it.
+    attr_accessor :state_reason
+
+    # The order placed for the proposal (GET /orders/{id}).
+    attr_accessor :order_id
+
+    # The state of that order while its purchase is in progress.
+    attr_accessor :order_state
+
+    attr_accessor :created_at
+
+    # When the proposal last changed state.
+    attr_accessor :updated_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',
+        :'state' => :'state',
+        :'media' => :'media',
+        :'service' => :'service',
+        :'proposed_price' => :'proposedPrice',
+        :'current_price' => :'currentPrice',
+        :'briefing' => :'briefing',
+        :'state_reason' => :'stateReason',
+        :'order_id' => :'orderId',
+        :'order_state' => :'orderState',
+        :'created_at' => :'createdAt',
+        :'updated_at' => :'updatedAt'
+      }
+    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',
+        :'state' => :'String',
+        :'media' => :'ManagedServiceProposalMedia',
+        :'service' => :'String',
+        :'proposed_price' => :'Money',
+        :'current_price' => :'MoneyOrNull',
+        :'briefing' => :'ManagedServiceProposalBriefing',
+        :'state_reason' => :'String',
+        :'order_id' => :'String',
+        :'order_state' => :'String',
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'current_price',
+        :'state_reason',
+        :'order_id',
+        :'order_state',
+      ])
+    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::ManagedServiceProposal` 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::ManagedServiceProposal`. 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?(:'state')
+        self.state = attributes[:'state']
+      else
+        self.state = nil
+      end
+
+      if attributes.key?(:'media')
+        self.media = attributes[:'media']
+      else
+        self.media = nil
+      end
+
+      if attributes.key?(:'service')
+        self.service = attributes[:'service']
+      else
+        self.service = nil
+      end
+
+      if attributes.key?(:'proposed_price')
+        self.proposed_price = attributes[:'proposed_price']
+      else
+        self.proposed_price = nil
+      end
+
+      if attributes.key?(:'current_price')
+        self.current_price = attributes[:'current_price']
+      else
+        self.current_price = nil
+      end
+
+      if attributes.key?(:'briefing')
+        self.briefing = attributes[:'briefing']
+      else
+        self.briefing = nil
+      end
+
+      if attributes.key?(:'state_reason')
+        self.state_reason = attributes[:'state_reason']
+      else
+        self.state_reason = nil
+      end
+
+      if attributes.key?(:'order_id')
+        self.order_id = attributes[:'order_id']
+      else
+        self.order_id = nil
+      end
+
+      if attributes.key?(:'order_state')
+        self.order_state = attributes[:'order_state']
+      else
+        self.order_state = 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
+    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 @state.nil?
+        invalid_properties.push('invalid value for "state", state cannot be nil.')
+      end
+
+      if @media.nil?
+        invalid_properties.push('invalid value for "media", media cannot be nil.')
+      end
+
+      if @service.nil?
+        invalid_properties.push('invalid value for "service", service cannot be nil.')
+      end
+
+      if @proposed_price.nil?
+        invalid_properties.push('invalid value for "proposed_price", proposed_price cannot be nil.')
+      end
+
+      if @briefing.nil?
+        invalid_properties.push('invalid value for "briefing", briefing 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
+
+      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 @state.nil?
+      state_validator = EnumAttributeValidator.new('String', ["proposed", "accepted", "cancelled", "purchase_started", "purchase_finished"])
+      return false unless state_validator.valid?(@state)
+      return false if @media.nil?
+      return false if @service.nil?
+      service_validator = EnumAttributeValidator.new('String', ["post", "link_addition"])
+      return false unless service_validator.valid?(@service)
+      return false if @proposed_price.nil?
+      return false if @briefing.nil?
+      return false if @created_at.nil?
+      return false if @updated_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 checking allowed values (enum).
+    # @param [Object] state Object to be assigned
+    def state=(state)
+      validator = EnumAttributeValidator.new('String', ["proposed", "accepted", "cancelled", "purchase_started", "purchase_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] 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 checking allowed values (enum).
+    # @param [Object] service Object to be assigned
+    def service=(service)
+      validator = EnumAttributeValidator.new('String', ["post", "link_addition"])
+      unless validator.valid?(service)
+        fail ArgumentError, "invalid value for \"service\", must be one of #{validator.allowable_values}."
+      end
+      @service = service
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] proposed_price Value to be assigned
+    def proposed_price=(proposed_price)
+      if proposed_price.nil?
+        fail ArgumentError, 'proposed_price cannot be nil'
+      end
+
+      @proposed_price = proposed_price
+    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] 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
+
+    # 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 &&
+          state == o.state &&
+          media == o.media &&
+          service == o.service &&
+          proposed_price == o.proposed_price &&
+          current_price == o.current_price &&
+          briefing == o.briefing &&
+          state_reason == o.state_reason &&
+          order_id == o.order_id &&
+          order_state == o.order_state &&
+          created_at == o.created_at &&
+          updated_at == o.updated_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, state, media, service, proposed_price, current_price, briefing, state_reason, order_id, order_state, created_at, updated_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

data/lib/growwer/models/managed_service_proposal_briefing.rb

@@ -0,0 +1,244 @@
+=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 ManagedServiceProposalBriefing < ApiModelBase
+    attr_accessor :main_info
+
+    attr_accessor :links
+
+    attr_accessor :additional_info
+
+    attr_accessor :requires_draft
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'main_info' => :'mainInfo',
+        :'links' => :'links',
+        :'additional_info' => :'additionalInfo',
+        :'requires_draft' => :'requiresDraft'
+      }
+    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
+      {
+        :'main_info' => :'String',
+        :'links' => :'Array<ManagedServiceProposalBriefingLinksInner>',
+        :'additional_info' => :'String',
+        :'requires_draft' => :'Boolean'
+      }
+    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::ManagedServiceProposalBriefing` 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::ManagedServiceProposalBriefing`. 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?(:'main_info')
+        self.main_info = attributes[:'main_info']
+      else
+        self.main_info = nil
+      end
+
+      if attributes.key?(:'links')
+        if (value = attributes[:'links']).is_a?(Array)
+          self.links = value
+        end
+      else
+        self.links = nil
+      end
+
+      if attributes.key?(:'additional_info')
+        self.additional_info = attributes[:'additional_info']
+      else
+        self.additional_info = nil
+      end
+
+      if attributes.key?(:'requires_draft')
+        self.requires_draft = attributes[:'requires_draft']
+      else
+        self.requires_draft = 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 @main_info.nil?
+        invalid_properties.push('invalid value for "main_info", main_info cannot be nil.')
+      end
+
+      if @links.nil?
+        invalid_properties.push('invalid value for "links", links cannot be nil.')
+      end
+
+      if @additional_info.nil?
+        invalid_properties.push('invalid value for "additional_info", additional_info cannot be nil.')
+      end
+
+      if @requires_draft.nil?
+        invalid_properties.push('invalid value for "requires_draft", requires_draft 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 @main_info.nil?
+      return false if @links.nil?
+      return false if @additional_info.nil?
+      return false if @requires_draft.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] main_info Value to be assigned
+    def main_info=(main_info)
+      if main_info.nil?
+        fail ArgumentError, 'main_info cannot be nil'
+      end
+
+      @main_info = main_info
+    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
+
+    # Custom attribute writer method with validation
+    # @param [Object] additional_info Value to be assigned
+    def additional_info=(additional_info)
+      if additional_info.nil?
+        fail ArgumentError, 'additional_info cannot be nil'
+      end
+
+      @additional_info = additional_info
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] requires_draft Value to be assigned
+    def requires_draft=(requires_draft)
+      if requires_draft.nil?
+        fail ArgumentError, 'requires_draft cannot be nil'
+      end
+
+      @requires_draft = requires_draft
+    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 &&
+          main_info == o.main_info &&
+          links == o.links &&
+          additional_info == o.additional_info &&
+          requires_draft == o.requires_draft
+    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
+      [main_info, links, additional_info, requires_draft].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