factorial_api 3.0.1

data/lib/factorial_api/models/procurement_po_templates_get200_response.rb

@@ -0,0 +1,158 @@
+=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 ProcurementPoTemplatesGet200Response < ApiModelBase
+    attr_accessor :data
+
+    attr_accessor :meta
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data',
+        :'meta' => :'meta'
+      }
+    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
+      {
+        :'data' => :'Array<ProcurementPoTemplate>',
+        :'meta' => :'PagedIndexMeta'
+      }
+    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::ProcurementPoTemplatesGet200Response` 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::ProcurementPoTemplatesGet200Response`. 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?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      end
+
+      if attributes.key?(:'meta')
+        self.meta = attributes[:'meta']
+      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
+      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'
+      true
+    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 &&
+          data == o.data &&
+          meta == o.meta
+    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
+      [data, meta].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_order.rb

@@ -0,0 +1,498 @@
+=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 ProcurementPurchaseOrder < ApiModelBase
+    # Unique identifier of the purchase order
+    attr_accessor :id
+
+    # Purchase order number assigned to this order
+    attr_accessor :po_number
+
+    # Description or notes about the purchase order
+    attr_accessor :description
+
+    # Current status of the purchase order
+    attr_accessor :status
+
+    attr_accessor :cost
+
+    # Date when the purchase order was created
+    attr_accessor :date
+
+    # Deadline date for the purchase order delivery or completion. Writable through the update endpoint (omitted or null keeps it); readable here so the GET -> modify -> PUT roundtrip is complete.
+    attr_accessor :deadline
+
+    # Identifier of the vendor (contact) associated with this purchase order
+    attr_accessor :vendor_id
+
+    # Identifier of the purchase request that generated this purchase order, if any. Externally-created purchase orders (e.g. synced from an ERP) have no purchase request.
+    attr_accessor :purchase_request_id
+
+    # Identifier of the legal entity that owns this purchase order
+    attr_accessor :legal_entity_id
+
+    # Identifier of the company that owns this purchase order
+    attr_accessor :company_id
+
+    # Formatted purchase order number with prefix (e.g., PO-00001)
+    attr_accessor :formatted_po_number
+
+    # Preferred payment method for this purchase order
+    attr_accessor :preferred_payment_method
+
+    # Identifier of the pinned PO template version this purchase order uses. Fetch that version (and its field definitions) to interpret the purchase order's header and line-item field keys. Null for legacy purchase orders created without a template.
+    attr_accessor :po_template_version_id
+
+    # Custom header field values, addressed by the field_key of the purchase order's PINNED template version, as an array of `{field_key, value}` pairs — exactly the shape the update endpoint accepts, so a GET -> modify -> PUT roundtrip works verbatim. Predefined fields (vendor, order_date, currency, due_date, payment_method, legal_entity) surface as top-level parameters instead, and computed or hidden values never appear (they are preserved server-side on update). Null for purchase orders without a template version.
+    attr_accessor :header_field_values_by_key
+
+    # Line items with their field values addressed by the field_key of the purchase order's PINNED template version — the same shape the update endpoint accepts: modify and send the whole set back. Rows are addressed by id (rows without an id are created, persisted rows missing from the set are deleted). Null for purchase orders without a template version.
+    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',
+        :'po_number' => :'po_number',
+        :'description' => :'description',
+        :'status' => :'status',
+        :'cost' => :'cost',
+        :'date' => :'date',
+        :'deadline' => :'deadline',
+        :'vendor_id' => :'vendor_id',
+        :'purchase_request_id' => :'purchase_request_id',
+        :'legal_entity_id' => :'legal_entity_id',
+        :'company_id' => :'company_id',
+        :'formatted_po_number' => :'formatted_po_number',
+        :'preferred_payment_method' => :'preferred_payment_method',
+        :'po_template_version_id' => :'po_template_version_id',
+        :'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',
+        :'po_number' => :'Integer',
+        :'description' => :'String',
+        :'status' => :'String',
+        :'cost' => :'ProcurementPurchaseOrdersIdPutRequestCost',
+        :'date' => :'String',
+        :'deadline' => :'String',
+        :'vendor_id' => :'String',
+        :'purchase_request_id' => :'String',
+        :'legal_entity_id' => :'String',
+        :'company_id' => :'String',
+        :'formatted_po_number' => :'String',
+        :'preferred_payment_method' => :'String',
+        :'po_template_version_id' => :'String',
+        :'header_field_values_by_key' => :'Array<ProcurementPurchaseOrdersPostRequestHeaderFieldValuesInner>',
+        :'line_items_by_key' => :'Array<ProcurementPurchaseOrderLineItemsByKeyInner>'
+      }
+    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::ProcurementPurchaseOrder` 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::ProcurementPurchaseOrder`. 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?(:'po_number')
+        self.po_number = attributes[:'po_number']
+      else
+        self.po_number = nil
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      else
+        self.description = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'cost')
+        self.cost = attributes[:'cost']
+      else
+        self.cost = nil
+      end
+
+      if attributes.key?(:'date')
+        self.date = attributes[:'date']
+      else
+        self.date = nil
+      end
+
+      if attributes.key?(:'deadline')
+        self.deadline = attributes[:'deadline']
+      end
+
+      if attributes.key?(:'vendor_id')
+        self.vendor_id = attributes[:'vendor_id']
+      end
+
+      if attributes.key?(:'purchase_request_id')
+        self.purchase_request_id = attributes[:'purchase_request_id']
+      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?(:'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?(:'preferred_payment_method')
+        self.preferred_payment_method = attributes[:'preferred_payment_method']
+      end
+
+      if attributes.key?(:'po_template_version_id')
+        self.po_template_version_id = attributes[:'po_template_version_id']
+      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 @po_number.nil?
+        invalid_properties.push('invalid value for "po_number", po_number cannot be nil.')
+      end
+
+      if @description.nil?
+        invalid_properties.push('invalid value for "description", description cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @cost.nil?
+        invalid_properties.push('invalid value for "cost", cost cannot be nil.')
+      end
+
+      if @date.nil?
+        invalid_properties.push('invalid value for "date", date 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 @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
+
+      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 @po_number.nil?
+      return false if @description.nil?
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["processing", "draft", "pending", "ordered", "partial", "received", "closed"])
+      return false unless status_validator.valid?(@status)
+      return false if @cost.nil?
+      return false if @date.nil?
+      return false if @legal_entity_id.nil?
+      return false if @company_id.nil?
+      return false if @formatted_po_number.nil?
+      preferred_payment_method_validator = EnumAttributeValidator.new('String', ["banktransfer", "cash", "virtualcard"])
+      return false unless preferred_payment_method_validator.valid?(@preferred_payment_method)
+      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] po_number Value to be assigned
+    def po_number=(po_number)
+      if po_number.nil?
+        @po_number = nil
+        return
+      end
+
+      @po_number = 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] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["processing", "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] cost Value to be assigned
+    def cost=(cost)
+      if cost.nil?
+        @cost = nil
+        return
+      end
+
+      @cost = cost
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] date Value to be assigned
+    def date=(date)
+      if date.nil?
+        @date = nil
+        return
+      end
+
+      @date = date
+    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] 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 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
+
+    # 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 &&
+          po_number == o.po_number &&
+          description == o.description &&
+          status == o.status &&
+          cost == o.cost &&
+          date == o.date &&
+          deadline == o.deadline &&
+          vendor_id == o.vendor_id &&
+          purchase_request_id == o.purchase_request_id &&
+          legal_entity_id == o.legal_entity_id &&
+          company_id == o.company_id &&
+          formatted_po_number == o.formatted_po_number &&
+          preferred_payment_method == o.preferred_payment_method &&
+          po_template_version_id == o.po_template_version_id &&
+          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, po_number, description, status, cost, date, deadline, vendor_id, purchase_request_id, legal_entity_id, company_id, formatted_po_number, preferred_payment_method, po_template_version_id, 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