factorial_api 3.0.1

data/lib/factorial_api/models/procurement_purchase_orders_id_put_request.rb

@@ -0,0 +1,425 @@
+=begin
+#Factorial API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 2026-10-01
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module F::Api
+  class ProcurementPurchaseOrdersIdPutRequest < ApiModelBase
+    # Identifier of the purchase order to update.
+    attr_accessor :id
+
+    # Company identifier, as returned by the credentials endpoint (`/resources/api_public/credentials`).
+    attr_accessor :company_id
+
+    # Formatted purchase order number with prefix, as returned by the read endpoint — send back the value you read.
+    attr_accessor :formatted_po_number
+
+    # Description or notes about the purchase order.
+    attr_accessor :description
+
+    # Preferred payment method for this purchase order. Send null to clear it.
+    attr_accessor :preferred_payment_method
+
+    # Status of the purchase order. Omitted or null keeps the current status; send a new one to transition. Once closed, the purchase order becomes immutable.
+    attr_accessor :status
+
+    # Identifier of the legal entity that owns the purchase order. Must belong to the company.
+    attr_accessor :legal_entity_id
+
+    attr_accessor :cost
+
+    # Identifier of the vendor (Finance contact) by internal Factorial id. Null clears the vendor on template-versioned purchase orders.
+    attr_accessor :vendor_id
+
+    # Purchase order date. Omit or send null to keep the current one.
+    attr_accessor :date
+
+    # Deadline date for the purchase order delivery or completion. Omitted or null keeps the current deadline (clearing a deadline through this endpoint is not supported).
+    attr_accessor :deadline
+
+    # Header field values of the purchase order's template version, as an array of `{field_key, value}` pairs — the same shape the read returns. Replaced as sent: send the complete set; an empty array deletes all custom header values, and omitting the field leaves them untouched. Only custom field keys are accepted; predefined fields (vendor, order_date, currency, due_date, payment_method, legal_entity) come from the corresponding top-level parameters. Reference fields take the referenced id as the value. If a field_key appears more than once, the last occurrence wins.
+    attr_accessor :header_field_values_by_key
+
+    # Line items of the purchase order, replaced as sent — the same shape the read returns. Rows with an id update the matching line item, rows without an id create new ones, and persisted rows missing from the set are deleted. Send an empty array to remove all line items, or omit the field to leave them untouched. Values travel as `{field_key, value}` pairs; computed keys (subtotal, tax_amount, total, discount_amount) are derived server-side and rejected as input.
+    attr_accessor :line_items_by_key
+
+    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',
+        :'company_id' => :'company_id',
+        :'formatted_po_number' => :'formatted_po_number',
+        :'description' => :'description',
+        :'preferred_payment_method' => :'preferred_payment_method',
+        :'status' => :'status',
+        :'legal_entity_id' => :'legal_entity_id',
+        :'cost' => :'cost',
+        :'vendor_id' => :'vendor_id',
+        :'date' => :'date',
+        :'deadline' => :'deadline',
+        :'header_field_values_by_key' => :'header_field_values_by_key',
+        :'line_items_by_key' => :'line_items_by_key'
+      }
+    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',
+        :'company_id' => :'String',
+        :'formatted_po_number' => :'String',
+        :'description' => :'String',
+        :'preferred_payment_method' => :'String',
+        :'status' => :'String',
+        :'legal_entity_id' => :'String',
+        :'cost' => :'ProcurementPurchaseOrdersIdPutRequestCost',
+        :'vendor_id' => :'String',
+        :'date' => :'String',
+        :'deadline' => :'String',
+        :'header_field_values_by_key' => :'Array<ProcurementPurchaseOrdersPostRequestHeaderFieldValuesInner>',
+        :'line_items_by_key' => :'Array<ProcurementPurchaseOrdersIdPutRequestLineItemsByKeyInner>'
+      }
+    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 `F::Api::ProcurementPurchaseOrdersIdPutRequest` 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 `F::Api::ProcurementPurchaseOrdersIdPutRequest`. 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?(:'company_id')
+        self.company_id = attributes[:'company_id']
+      else
+        self.company_id = nil
+      end
+
+      if attributes.key?(:'formatted_po_number')
+        self.formatted_po_number = attributes[:'formatted_po_number']
+      else
+        self.formatted_po_number = nil
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      else
+        self.description = nil
+      end
+
+      if attributes.key?(:'preferred_payment_method')
+        self.preferred_payment_method = attributes[:'preferred_payment_method']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'legal_entity_id')
+        self.legal_entity_id = attributes[:'legal_entity_id']
+      else
+        self.legal_entity_id = nil
+      end
+
+      if attributes.key?(:'cost')
+        self.cost = attributes[:'cost']
+      else
+        self.cost = nil
+      end
+
+      if attributes.key?(:'vendor_id')
+        self.vendor_id = attributes[:'vendor_id']
+      end
+
+      if attributes.key?(:'date')
+        self.date = attributes[:'date']
+      end
+
+      if attributes.key?(:'deadline')
+        self.deadline = attributes[:'deadline']
+      end
+
+      if attributes.key?(:'header_field_values_by_key')
+        if (value = attributes[:'header_field_values_by_key']).is_a?(Array)
+          self.header_field_values_by_key = value
+        end
+      end
+
+      if attributes.key?(:'line_items_by_key')
+        if (value = attributes[:'line_items_by_key']).is_a?(Array)
+          self.line_items_by_key = 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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @company_id.nil?
+        invalid_properties.push('invalid value for "company_id", company_id cannot be nil.')
+      end
+
+      if @formatted_po_number.nil?
+        invalid_properties.push('invalid value for "formatted_po_number", formatted_po_number cannot be nil.')
+      end
+
+      if @description.nil?
+        invalid_properties.push('invalid value for "description", description cannot be nil.')
+      end
+
+      if @legal_entity_id.nil?
+        invalid_properties.push('invalid value for "legal_entity_id", legal_entity_id cannot be nil.')
+      end
+
+      if @cost.nil?
+        invalid_properties.push('invalid value for "cost", cost 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 @company_id.nil?
+      return false if @formatted_po_number.nil?
+      return false if @description.nil?
+      preferred_payment_method_validator = EnumAttributeValidator.new('String', ["banktransfer", "cash", "virtualcard"])
+      return false unless preferred_payment_method_validator.valid?(@preferred_payment_method)
+      status_validator = EnumAttributeValidator.new('String', ["draft", "pending", "ordered", "partial", "received", "closed"])
+      return false unless status_validator.valid?(@status)
+      return false if @legal_entity_id.nil?
+      return false if @cost.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        @id = nil
+        return
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] company_id Value to be assigned
+    def company_id=(company_id)
+      if company_id.nil?
+        @company_id = nil
+        return
+      end
+
+      @company_id = company_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] formatted_po_number Value to be assigned
+    def formatted_po_number=(formatted_po_number)
+      if formatted_po_number.nil?
+        @formatted_po_number = nil
+        return
+      end
+
+      @formatted_po_number = formatted_po_number
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if description.nil?
+        @description = nil
+        return
+      end
+
+      @description = description
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] preferred_payment_method Object to be assigned
+    def preferred_payment_method=(preferred_payment_method)
+      validator = EnumAttributeValidator.new('String', ["banktransfer", "cash", "virtualcard"])
+      unless validator.valid?(preferred_payment_method)
+        fail ArgumentError, "invalid value for \"preferred_payment_method\", must be one of #{validator.allowable_values}."
+      end
+      @preferred_payment_method = preferred_payment_method
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["draft", "pending", "ordered", "partial", "received", "closed"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] legal_entity_id Value to be assigned
+    def legal_entity_id=(legal_entity_id)
+      if legal_entity_id.nil?
+        @legal_entity_id = nil
+        return
+      end
+
+      @legal_entity_id = legal_entity_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] cost Value to be assigned
+    def cost=(cost)
+      if cost.nil?
+        @cost = nil
+        return
+      end
+
+      @cost = cost
+    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 &&
+          company_id == o.company_id &&
+          formatted_po_number == o.formatted_po_number &&
+          description == o.description &&
+          preferred_payment_method == o.preferred_payment_method &&
+          status == o.status &&
+          legal_entity_id == o.legal_entity_id &&
+          cost == o.cost &&
+          vendor_id == o.vendor_id &&
+          date == o.date &&
+          deadline == o.deadline &&
+          header_field_values_by_key == o.header_field_values_by_key &&
+          line_items_by_key == o.line_items_by_key
+    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, company_id, formatted_po_number, description, preferred_payment_method, status, legal_entity_id, cost, vendor_id, date, deadline, header_field_values_by_key, line_items_by_key].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/factorial_api/models/procurement_purchase_orders_id_put_request_cost.rb

@@ -0,0 +1,195 @@
+=begin
+#Factorial API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 2026-10-01
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module F::Api
+  # Total cost of the purchase order, as returned by the read endpoint — send back what you read. The currency is applied as sent; on template-versioned purchase orders the amounts are owned by the line items and recomputed server-side.
+  class ProcurementPurchaseOrdersIdPutRequestCost < ApiModelBase
+    # Total cost in cents (smallest currency unit).
+    attr_accessor :cents
+
+    # Currency code in ISO 4217 format.
+    attr_accessor :currency
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'cents' => :'cents',
+        :'currency' => :'currency'
+      }
+    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
+      {
+        :'cents' => :'Integer',
+        :'currency' => :'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 `F::Api::ProcurementPurchaseOrdersIdPutRequestCost` 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 `F::Api::ProcurementPurchaseOrdersIdPutRequestCost`. 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?(:'cents')
+        self.cents = attributes[:'cents']
+      else
+        self.cents = nil
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      else
+        self.currency = 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 @cents.nil?
+        invalid_properties.push('invalid value for "cents", cents cannot be nil.')
+      end
+
+      if @currency.nil?
+        invalid_properties.push('invalid value for "currency", currency 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 @cents.nil?
+      return false if @currency.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] cents Value to be assigned
+    def cents=(cents)
+      if cents.nil?
+        @cents = nil
+        return
+      end
+
+      @cents = cents
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] currency Value to be assigned
+    def currency=(currency)
+      if currency.nil?
+        @currency = nil
+        return
+      end
+
+      @currency = currency
+    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 &&
+          cents == o.cents &&
+          currency == o.currency
+    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
+      [cents, currency].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