pescheck 0.0.1

data/lib/pescheck/models/division_write.rb

@@ -0,0 +1,436 @@
+=begin
+#Pescheck API
+
+#API for Pescheck  ## Authentication This API supports three authentication methods: 1. **OAuth2** (recommended for API clients) - Use client credentials flow 2. **JWT Bearer** (for user-based access) - Obtain tokens via /api/jwt/ endpoint 3. **Cookie** (for browser-based access) - Session authentication via web login  ## Quick Start for API Clients 1. Select your environment from the servers dropdown 2. Use OAuth2 with client credentials flow 3. Scopes are automatically included: read:api, create:api, update:api
+
+The version of the OpenAPI document: 2.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Pescheck
+  class DivisionWrite < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :name
+
+    attr_accessor :city
+
+    attr_accessor :address
+
+    attr_accessor :postal
+
+    attr_accessor :phone
+
+    attr_accessor :contact_name
+
+    attr_accessor :contact_email
+
+    attr_accessor :invoice_email
+
+    attr_accessor :use_parent_on_email
+
+    attr_accessor :use_parent_on_billing
+
+    attr_accessor :use_parent_on_report
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'name' => :'name',
+        :'city' => :'city',
+        :'address' => :'address',
+        :'postal' => :'postal',
+        :'phone' => :'phone',
+        :'contact_name' => :'contact_name',
+        :'contact_email' => :'contact_email',
+        :'invoice_email' => :'invoice_email',
+        :'use_parent_on_email' => :'use_parent_on_email',
+        :'use_parent_on_billing' => :'use_parent_on_billing',
+        :'use_parent_on_report' => :'use_parent_on_report'
+      }
+    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',
+        :'name' => :'String',
+        :'city' => :'String',
+        :'address' => :'String',
+        :'postal' => :'String',
+        :'phone' => :'String',
+        :'contact_name' => :'String',
+        :'contact_email' => :'String',
+        :'invoice_email' => :'String',
+        :'use_parent_on_email' => :'Boolean',
+        :'use_parent_on_billing' => :'Boolean',
+        :'use_parent_on_report' => :'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 `Pescheck::DivisionWrite` 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 `Pescheck::DivisionWrite`. 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']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      else
+        self.city = nil
+      end
+
+      if attributes.key?(:'address')
+        self.address = attributes[:'address']
+      else
+        self.address = nil
+      end
+
+      if attributes.key?(:'postal')
+        self.postal = attributes[:'postal']
+      else
+        self.postal = nil
+      end
+
+      if attributes.key?(:'phone')
+        self.phone = attributes[:'phone']
+      else
+        self.phone = nil
+      end
+
+      if attributes.key?(:'contact_name')
+        self.contact_name = attributes[:'contact_name']
+      else
+        self.contact_name = nil
+      end
+
+      if attributes.key?(:'contact_email')
+        self.contact_email = attributes[:'contact_email']
+      else
+        self.contact_email = nil
+      end
+
+      if attributes.key?(:'invoice_email')
+        self.invoice_email = attributes[:'invoice_email']
+      else
+        self.invoice_email = nil
+      end
+
+      if attributes.key?(:'use_parent_on_email')
+        self.use_parent_on_email = attributes[:'use_parent_on_email']
+      end
+
+      if attributes.key?(:'use_parent_on_billing')
+        self.use_parent_on_billing = attributes[:'use_parent_on_billing']
+      end
+
+      if attributes.key?(:'use_parent_on_report')
+        self.use_parent_on_report = attributes[:'use_parent_on_report']
+      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
+
+      if @name.to_s.length > 255
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
+      end
+
+      if @city.nil?
+        invalid_properties.push('invalid value for "city", city cannot be nil.')
+      end
+
+      if @city.to_s.length > 255
+        invalid_properties.push('invalid value for "city", the character length must be smaller than or equal to 255.')
+      end
+
+      if @address.nil?
+        invalid_properties.push('invalid value for "address", address cannot be nil.')
+      end
+
+      if @address.to_s.length > 255
+        invalid_properties.push('invalid value for "address", the character length must be smaller than or equal to 255.')
+      end
+
+      if @postal.nil?
+        invalid_properties.push('invalid value for "postal", postal cannot be nil.')
+      end
+
+      if @postal.to_s.length > 20
+        invalid_properties.push('invalid value for "postal", the character length must be smaller than or equal to 20.')
+      end
+
+      if @phone.nil?
+        invalid_properties.push('invalid value for "phone", phone cannot be nil.')
+      end
+
+      if @phone.to_s.length > 20
+        invalid_properties.push('invalid value for "phone", the character length must be smaller than or equal to 20.')
+      end
+
+      if @contact_name.nil?
+        invalid_properties.push('invalid value for "contact_name", contact_name cannot be nil.')
+      end
+
+      if @contact_name.to_s.length > 255
+        invalid_properties.push('invalid value for "contact_name", the character length must be smaller than or equal to 255.')
+      end
+
+      if @contact_email.nil?
+        invalid_properties.push('invalid value for "contact_email", contact_email cannot be nil.')
+      end
+
+      if @invoice_email.nil?
+        invalid_properties.push('invalid value for "invoice_email", invoice_email 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?
+      return false if @name.to_s.length > 255
+      return false if @city.nil?
+      return false if @city.to_s.length > 255
+      return false if @address.nil?
+      return false if @address.to_s.length > 255
+      return false if @postal.nil?
+      return false if @postal.to_s.length > 20
+      return false if @phone.nil?
+      return false if @phone.to_s.length > 20
+      return false if @contact_name.nil?
+      return false if @contact_name.to_s.length > 255
+      return false if @contact_email.nil?
+      return false if @invoice_email.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 255
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 255.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] city Value to be assigned
+    def city=(city)
+      if city.nil?
+        fail ArgumentError, 'city cannot be nil'
+      end
+
+      if city.to_s.length > 255
+        fail ArgumentError, 'invalid value for "city", the character length must be smaller than or equal to 255.'
+      end
+
+      @city = city
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] address Value to be assigned
+    def address=(address)
+      if address.nil?
+        fail ArgumentError, 'address cannot be nil'
+      end
+
+      if address.to_s.length > 255
+        fail ArgumentError, 'invalid value for "address", the character length must be smaller than or equal to 255.'
+      end
+
+      @address = address
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] postal Value to be assigned
+    def postal=(postal)
+      if postal.nil?
+        fail ArgumentError, 'postal cannot be nil'
+      end
+
+      if postal.to_s.length > 20
+        fail ArgumentError, 'invalid value for "postal", the character length must be smaller than or equal to 20.'
+      end
+
+      @postal = postal
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] phone Value to be assigned
+    def phone=(phone)
+      if phone.nil?
+        fail ArgumentError, 'phone cannot be nil'
+      end
+
+      if phone.to_s.length > 20
+        fail ArgumentError, 'invalid value for "phone", the character length must be smaller than or equal to 20.'
+      end
+
+      @phone = phone
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] contact_name Value to be assigned
+    def contact_name=(contact_name)
+      if contact_name.nil?
+        fail ArgumentError, 'contact_name cannot be nil'
+      end
+
+      if contact_name.to_s.length > 255
+        fail ArgumentError, 'invalid value for "contact_name", the character length must be smaller than or equal to 255.'
+      end
+
+      @contact_name = contact_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] contact_email Value to be assigned
+    def contact_email=(contact_email)
+      if contact_email.nil?
+        fail ArgumentError, 'contact_email cannot be nil'
+      end
+
+      @contact_email = contact_email
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] invoice_email Value to be assigned
+    def invoice_email=(invoice_email)
+      if invoice_email.nil?
+        fail ArgumentError, 'invoice_email cannot be nil'
+      end
+
+      @invoice_email = invoice_email
+    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 &&
+          name == o.name &&
+          city == o.city &&
+          address == o.address &&
+          postal == o.postal &&
+          phone == o.phone &&
+          contact_name == o.contact_name &&
+          contact_email == o.contact_email &&
+          invoice_email == o.invoice_email &&
+          use_parent_on_email == o.use_parent_on_email &&
+          use_parent_on_billing == o.use_parent_on_billing &&
+          use_parent_on_report == o.use_parent_on_report
+    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, name, city, address, postal, phone, contact_name, contact_email, invoice_email, use_parent_on_email, use_parent_on_billing, use_parent_on_report].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/pescheck/models/jwt_generation.rb

@@ -0,0 +1,213 @@
+=begin
+#Pescheck API
+
+#API for Pescheck  ## Authentication This API supports three authentication methods: 1. **OAuth2** (recommended for API clients) - Use client credentials flow 2. **JWT Bearer** (for user-based access) - Obtain tokens via /api/jwt/ endpoint 3. **Cookie** (for browser-based access) - Session authentication via web login  ## Quick Start for API Clients 1. Select your environment from the servers dropdown 2. Use OAuth2 with client credentials flow 3. Scopes are automatically included: read:api, create:api, update:api
+
+The version of the OpenAPI document: 2.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Pescheck
+  # Serializer for JWT token generation for API users
+  class JWTGeneration < ApiModelBase
+    # Email address of the API user
+    attr_accessor :email
+
+    # Password for the API user
+    attr_accessor :password
+
+    # Organization ID to generate token for
+    attr_accessor :organisation_id
+
+    # Division ID to generate token for (optional)
+    attr_accessor :division_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'email' => :'email',
+        :'password' => :'password',
+        :'organisation_id' => :'organisation_id',
+        :'division_id' => :'division_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
+      {
+        :'email' => :'String',
+        :'password' => :'String',
+        :'organisation_id' => :'String',
+        :'division_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 `Pescheck::JWTGeneration` 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 `Pescheck::JWTGeneration`. 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?(:'email')
+        self.email = attributes[:'email']
+      else
+        self.email = nil
+      end
+
+      if attributes.key?(:'password')
+        self.password = attributes[:'password']
+      else
+        self.password = nil
+      end
+
+      if attributes.key?(:'organisation_id')
+        self.organisation_id = attributes[:'organisation_id']
+      end
+
+      if attributes.key?(:'division_id')
+        self.division_id = attributes[:'division_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 @email.nil?
+        invalid_properties.push('invalid value for "email", email cannot be nil.')
+      end
+
+      if @password.nil?
+        invalid_properties.push('invalid value for "password", password 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 @email.nil?
+      return false if @password.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] email Value to be assigned
+    def email=(email)
+      if email.nil?
+        fail ArgumentError, 'email cannot be nil'
+      end
+
+      @email = email
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] password Value to be assigned
+    def password=(password)
+      if password.nil?
+        fail ArgumentError, 'password cannot be nil'
+      end
+
+      @password = password
+    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 &&
+          email == o.email &&
+          password == o.password &&
+          organisation_id == o.organisation_id &&
+          division_id == o.division_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
+      [email, password, organisation_id, division_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