tachain-sdk 0.1.0

data/lib/tachain-sdk/models/company_utility_declaration.rb

@@ -0,0 +1,592 @@
+=begin
+#Tactic Chain Public API
+
+#Public integration endpoints. Set your own base URL and credential before calling.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TachainSdk
+  # Annual or monthly electricity/water declarations for PEFCR organization and facility scopes.
+  class CompanyUtilityDeclaration < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :tenant_id
+
+    attr_accessor :company_id
+
+    attr_accessor :scope_type
+
+    attr_accessor :scope_id
+
+    attr_accessor :facility_id
+
+    attr_accessor :granularity
+
+    attr_accessor :reporting_year
+
+    attr_accessor :reporting_month
+
+    attr_accessor :period_start
+
+    attr_accessor :period_end
+
+    attr_accessor :electricity_kwh
+
+    attr_accessor :water_m3
+
+    attr_accessor :notes
+
+    attr_accessor :evidence_url
+
+    attr_accessor :row_version
+
+    attr_accessor :created_by
+
+    attr_accessor :created_at
+
+    attr_accessor :updated_by
+
+    attr_accessor :updated_at
+
+    attr_accessor :status
+
+    attr_accessor :company
+
+    attr_accessor :facility
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'tenant_id' => :'tenantId',
+        :'company_id' => :'companyId',
+        :'scope_type' => :'scopeType',
+        :'scope_id' => :'scopeId',
+        :'facility_id' => :'facilityId',
+        :'granularity' => :'granularity',
+        :'reporting_year' => :'reportingYear',
+        :'reporting_month' => :'reportingMonth',
+        :'period_start' => :'periodStart',
+        :'period_end' => :'periodEnd',
+        :'electricity_kwh' => :'electricityKwh',
+        :'water_m3' => :'waterM3',
+        :'notes' => :'notes',
+        :'evidence_url' => :'evidenceUrl',
+        :'row_version' => :'rowVersion',
+        :'created_by' => :'createdBy',
+        :'created_at' => :'createdAt',
+        :'updated_by' => :'updatedBy',
+        :'updated_at' => :'updatedAt',
+        :'status' => :'status',
+        :'company' => :'company',
+        :'facility' => :'facility'
+      }
+    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',
+        :'tenant_id' => :'String',
+        :'company_id' => :'String',
+        :'scope_type' => :'String',
+        :'scope_id' => :'String',
+        :'facility_id' => :'String',
+        :'granularity' => :'String',
+        :'reporting_year' => :'Integer',
+        :'reporting_month' => :'Integer',
+        :'period_start' => :'Date',
+        :'period_end' => :'Date',
+        :'electricity_kwh' => :'Float',
+        :'water_m3' => :'Float',
+        :'notes' => :'String',
+        :'evidence_url' => :'String',
+        :'row_version' => :'Integer',
+        :'created_by' => :'String',
+        :'created_at' => :'Time',
+        :'updated_by' => :'String',
+        :'updated_at' => :'Time',
+        :'status' => :'Integer',
+        :'company' => :'Company',
+        :'facility' => :'Factory'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'facility_id',
+        :'reporting_month',
+        :'electricity_kwh',
+        :'water_m3',
+        :'notes',
+        :'evidence_url',
+        :'updated_by',
+        :'updated_at',
+      ])
+    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 `TachainSdk::CompanyUtilityDeclaration` 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 `TachainSdk::CompanyUtilityDeclaration`. 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?(:'tenant_id')
+        self.tenant_id = attributes[:'tenant_id']
+      else
+        self.tenant_id = nil
+      end
+
+      if attributes.key?(:'company_id')
+        self.company_id = attributes[:'company_id']
+      else
+        self.company_id = nil
+      end
+
+      if attributes.key?(:'scope_type')
+        self.scope_type = attributes[:'scope_type']
+      else
+        self.scope_type = nil
+      end
+
+      if attributes.key?(:'scope_id')
+        self.scope_id = attributes[:'scope_id']
+      else
+        self.scope_id = nil
+      end
+
+      if attributes.key?(:'facility_id')
+        self.facility_id = attributes[:'facility_id']
+      end
+
+      if attributes.key?(:'granularity')
+        self.granularity = attributes[:'granularity']
+      else
+        self.granularity = nil
+      end
+
+      if attributes.key?(:'reporting_year')
+        self.reporting_year = attributes[:'reporting_year']
+      else
+        self.reporting_year = nil
+      end
+
+      if attributes.key?(:'reporting_month')
+        self.reporting_month = attributes[:'reporting_month']
+      end
+
+      if attributes.key?(:'period_start')
+        self.period_start = attributes[:'period_start']
+      else
+        self.period_start = nil
+      end
+
+      if attributes.key?(:'period_end')
+        self.period_end = attributes[:'period_end']
+      else
+        self.period_end = nil
+      end
+
+      if attributes.key?(:'electricity_kwh')
+        self.electricity_kwh = attributes[:'electricity_kwh']
+      end
+
+      if attributes.key?(:'water_m3')
+        self.water_m3 = attributes[:'water_m3']
+      end
+
+      if attributes.key?(:'notes')
+        self.notes = attributes[:'notes']
+      end
+
+      if attributes.key?(:'evidence_url')
+        self.evidence_url = attributes[:'evidence_url']
+      end
+
+      if attributes.key?(:'row_version')
+        self.row_version = attributes[:'row_version']
+      else
+        self.row_version = nil
+      end
+
+      if attributes.key?(:'created_by')
+        self.created_by = attributes[:'created_by']
+      else
+        self.created_by = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'updated_by')
+        self.updated_by = attributes[:'updated_by']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'company')
+        self.company = attributes[:'company']
+      else
+        self.company = nil
+      end
+
+      if attributes.key?(:'facility')
+        self.facility = attributes[:'facility']
+      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 @tenant_id.nil?
+        invalid_properties.push('invalid value for "tenant_id", tenant_id cannot be nil.')
+      end
+
+      if @company_id.nil?
+        invalid_properties.push('invalid value for "company_id", company_id cannot be nil.')
+      end
+
+      if @scope_type.nil?
+        invalid_properties.push('invalid value for "scope_type", scope_type cannot be nil.')
+      end
+
+      if @scope_id.nil?
+        invalid_properties.push('invalid value for "scope_id", scope_id cannot be nil.')
+      end
+
+      if @granularity.nil?
+        invalid_properties.push('invalid value for "granularity", granularity cannot be nil.')
+      end
+
+      if @reporting_year.nil?
+        invalid_properties.push('invalid value for "reporting_year", reporting_year cannot be nil.')
+      end
+
+      if @period_start.nil?
+        invalid_properties.push('invalid value for "period_start", period_start cannot be nil.')
+      end
+
+      if @period_end.nil?
+        invalid_properties.push('invalid value for "period_end", period_end cannot be nil.')
+      end
+
+      if @row_version.nil?
+        invalid_properties.push('invalid value for "row_version", row_version cannot be nil.')
+      end
+
+      if @created_by.nil?
+        invalid_properties.push('invalid value for "created_by", created_by cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @company.nil?
+        invalid_properties.push('invalid value for "company", company 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 @tenant_id.nil?
+      return false if @company_id.nil?
+      return false if @scope_type.nil?
+      return false if @scope_id.nil?
+      return false if @granularity.nil?
+      return false if @reporting_year.nil?
+      return false if @period_start.nil?
+      return false if @period_end.nil?
+      return false if @row_version.nil?
+      return false if @created_by.nil?
+      return false if @created_at.nil?
+      return false if @status.nil?
+      return false if @company.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] tenant_id Value to be assigned
+    def tenant_id=(tenant_id)
+      if tenant_id.nil?
+        fail ArgumentError, 'tenant_id cannot be nil'
+      end
+
+      @tenant_id = tenant_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?
+        fail ArgumentError, 'company_id cannot be nil'
+      end
+
+      @company_id = company_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] scope_type Value to be assigned
+    def scope_type=(scope_type)
+      if scope_type.nil?
+        fail ArgumentError, 'scope_type cannot be nil'
+      end
+
+      @scope_type = scope_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] scope_id Value to be assigned
+    def scope_id=(scope_id)
+      if scope_id.nil?
+        fail ArgumentError, 'scope_id cannot be nil'
+      end
+
+      @scope_id = scope_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] granularity Value to be assigned
+    def granularity=(granularity)
+      if granularity.nil?
+        fail ArgumentError, 'granularity cannot be nil'
+      end
+
+      @granularity = granularity
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reporting_year Value to be assigned
+    def reporting_year=(reporting_year)
+      if reporting_year.nil?
+        fail ArgumentError, 'reporting_year cannot be nil'
+      end
+
+      @reporting_year = reporting_year
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] period_start Value to be assigned
+    def period_start=(period_start)
+      if period_start.nil?
+        fail ArgumentError, 'period_start cannot be nil'
+      end
+
+      @period_start = period_start
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] period_end Value to be assigned
+    def period_end=(period_end)
+      if period_end.nil?
+        fail ArgumentError, 'period_end cannot be nil'
+      end
+
+      @period_end = period_end
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] row_version Value to be assigned
+    def row_version=(row_version)
+      if row_version.nil?
+        fail ArgumentError, 'row_version cannot be nil'
+      end
+
+      @row_version = row_version
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created_by Value to be assigned
+    def created_by=(created_by)
+      if created_by.nil?
+        fail ArgumentError, 'created_by cannot be nil'
+      end
+
+      @created_by = created_by
+    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] status Value to be assigned
+    def status=(status)
+      if status.nil?
+        fail ArgumentError, 'status cannot be nil'
+      end
+
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] company Value to be assigned
+    def company=(company)
+      if company.nil?
+        fail ArgumentError, 'company cannot be nil'
+      end
+
+      @company = company
+    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 &&
+          tenant_id == o.tenant_id &&
+          company_id == o.company_id &&
+          scope_type == o.scope_type &&
+          scope_id == o.scope_id &&
+          facility_id == o.facility_id &&
+          granularity == o.granularity &&
+          reporting_year == o.reporting_year &&
+          reporting_month == o.reporting_month &&
+          period_start == o.period_start &&
+          period_end == o.period_end &&
+          electricity_kwh == o.electricity_kwh &&
+          water_m3 == o.water_m3 &&
+          notes == o.notes &&
+          evidence_url == o.evidence_url &&
+          row_version == o.row_version &&
+          created_by == o.created_by &&
+          created_at == o.created_at &&
+          updated_by == o.updated_by &&
+          updated_at == o.updated_at &&
+          status == o.status &&
+          company == o.company &&
+          facility == o.facility
+    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, tenant_id, company_id, scope_type, scope_id, facility_id, granularity, reporting_year, reporting_month, period_start, period_end, electricity_kwh, water_m3, notes, evidence_url, row_version, created_by, created_at, updated_by, updated_at, status, company, facility].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