factorial_api 3.0.1

data/lib/factorial_api/models/project_management_projects_post_request.rb

@@ -0,0 +1,332 @@
+=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 ProjectManagementProjectsPostRequest < ApiModelBase
+    # Mandatory to pass a name of the project.
+    attr_accessor :name
+
+    # Optional unique code for the project to be identifiable and searchable.
+    attr_accessor :code
+
+    # Description of the project.
+    attr_accessor :description
+
+    # Optional start date for the project. If given must be in iso-8601 format (YYYY-MM-DD).
+    attr_accessor :start_date
+
+    # Optional due date for the project. If given must be in iso-8601 format (YYYY-MM-DD).
+    attr_accessor :due_date
+
+    # Project status. Can be `active` or `closed`
+    attr_accessor :status
+
+    # Optional param to define the kind of assignation the project has. Can be `manual` or `company`
+    attr_accessor :employees_assignment
+
+    # Array of employee IDs who are project administrators
+    attr_accessor :project_admins
+
+    # Array of employee IDs who are project managers
+    attr_accessor :project_managers
+
+    # Array of employee IDs who are project viewers
+    attr_accessor :project_viewers
+
+    # Whether the project is billable to clients
+    attr_accessor :is_billable
+
+    # Fixed cost of the project in cents
+    attr_accessor :fixed_cost_cents
+
+    # Budget allocation in minutes for the project, it's exclusive of the budget_allocation_cents
+    attr_accessor :budget_allocation
+
+    # The legal entity ID associated with the project
+    attr_accessor :legal_entity_id
+
+    # Budget allocation amount in cents, it's exclusive of the budget_allocation
+    attr_accessor :budget_allocation_cents
+
+    # Fee amount in cents for the project
+    attr_accessor :fee_amount_cents
+
+    # Client associated to the project, refers to finance/contacts.
+    attr_accessor :client_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'code' => :'code',
+        :'description' => :'description',
+        :'start_date' => :'start_date',
+        :'due_date' => :'due_date',
+        :'status' => :'status',
+        :'employees_assignment' => :'employees_assignment',
+        :'project_admins' => :'project_admins',
+        :'project_managers' => :'project_managers',
+        :'project_viewers' => :'project_viewers',
+        :'is_billable' => :'is_billable',
+        :'fixed_cost_cents' => :'fixed_cost_cents',
+        :'budget_allocation' => :'budget_allocation',
+        :'legal_entity_id' => :'legal_entity_id',
+        :'budget_allocation_cents' => :'budget_allocation_cents',
+        :'fee_amount_cents' => :'fee_amount_cents',
+        :'client_id' => :'client_id'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'code' => :'String',
+        :'description' => :'String',
+        :'start_date' => :'String',
+        :'due_date' => :'String',
+        :'status' => :'String',
+        :'employees_assignment' => :'String',
+        :'project_admins' => :'Array<String>',
+        :'project_managers' => :'Array<String>',
+        :'project_viewers' => :'Array<String>',
+        :'is_billable' => :'Boolean',
+        :'fixed_cost_cents' => :'Integer',
+        :'budget_allocation' => :'Integer',
+        :'legal_entity_id' => :'String',
+        :'budget_allocation_cents' => :'Integer',
+        :'fee_amount_cents' => :'Integer',
+        :'client_id' => :'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::ProjectManagementProjectsPostRequest` 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::ProjectManagementProjectsPostRequest`. 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?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'code')
+        self.code = attributes[:'code']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
+      if attributes.key?(:'due_date')
+        self.due_date = attributes[:'due_date']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'employees_assignment')
+        self.employees_assignment = attributes[:'employees_assignment']
+      end
+
+      if attributes.key?(:'project_admins')
+        if (value = attributes[:'project_admins']).is_a?(Array)
+          self.project_admins = value
+        end
+      end
+
+      if attributes.key?(:'project_managers')
+        if (value = attributes[:'project_managers']).is_a?(Array)
+          self.project_managers = value
+        end
+      end
+
+      if attributes.key?(:'project_viewers')
+        if (value = attributes[:'project_viewers']).is_a?(Array)
+          self.project_viewers = value
+        end
+      end
+
+      if attributes.key?(:'is_billable')
+        self.is_billable = attributes[:'is_billable']
+      end
+
+      if attributes.key?(:'fixed_cost_cents')
+        self.fixed_cost_cents = attributes[:'fixed_cost_cents']
+      end
+
+      if attributes.key?(:'budget_allocation')
+        self.budget_allocation = attributes[:'budget_allocation']
+      end
+
+      if attributes.key?(:'legal_entity_id')
+        self.legal_entity_id = attributes[:'legal_entity_id']
+      end
+
+      if attributes.key?(:'budget_allocation_cents')
+        self.budget_allocation_cents = attributes[:'budget_allocation_cents']
+      end
+
+      if attributes.key?(:'fee_amount_cents')
+        self.fee_amount_cents = attributes[:'fee_amount_cents']
+      end
+
+      if attributes.key?(:'client_id')
+        self.client_id = attributes[:'client_id']
+      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 @name.nil?
+        invalid_properties.push('invalid value for "name", name 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 @name.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        @name = nil
+        return
+      end
+
+      @name = name
+    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 &&
+          name == o.name &&
+          code == o.code &&
+          description == o.description &&
+          start_date == o.start_date &&
+          due_date == o.due_date &&
+          status == o.status &&
+          employees_assignment == o.employees_assignment &&
+          project_admins == o.project_admins &&
+          project_managers == o.project_managers &&
+          project_viewers == o.project_viewers &&
+          is_billable == o.is_billable &&
+          fixed_cost_cents == o.fixed_cost_cents &&
+          budget_allocation == o.budget_allocation &&
+          legal_entity_id == o.legal_entity_id &&
+          budget_allocation_cents == o.budget_allocation_cents &&
+          fee_amount_cents == o.fee_amount_cents &&
+          client_id == o.client_id
+    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
+      [name, code, description, start_date, due_date, status, employees_assignment, project_admins, project_managers, project_viewers, is_billable, fixed_cost_cents, budget_allocation, legal_entity_id, budget_allocation_cents, fee_amount_cents, client_id].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