pescheck 0.0.1

data/lib/pescheck/models/jwt_response.rb

@@ -0,0 +1,285 @@
+=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 response
+  class JWTResponse < ApiModelBase
+    # JWT access token
+    attr_accessor :access_token
+
+    # JWT refresh token
+    attr_accessor :refresh_token
+
+    attr_accessor :token_type
+
+    # Access token expiration in seconds
+    attr_accessor :expires_in
+
+    # Organization name
+    attr_accessor :organisation
+
+    # Organization ID
+    attr_accessor :organisation_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'access_token' => :'access_token',
+        :'refresh_token' => :'refresh_token',
+        :'token_type' => :'token_type',
+        :'expires_in' => :'expires_in',
+        :'organisation' => :'organisation',
+        :'organisation_id' => :'organisation_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
+      {
+        :'access_token' => :'String',
+        :'refresh_token' => :'String',
+        :'token_type' => :'String',
+        :'expires_in' => :'Integer',
+        :'organisation' => :'String',
+        :'organisation_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::JWTResponse` 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::JWTResponse`. 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?(:'access_token')
+        self.access_token = attributes[:'access_token']
+      else
+        self.access_token = nil
+      end
+
+      if attributes.key?(:'refresh_token')
+        self.refresh_token = attributes[:'refresh_token']
+      else
+        self.refresh_token = nil
+      end
+
+      if attributes.key?(:'token_type')
+        self.token_type = attributes[:'token_type']
+      else
+        self.token_type = 'Bearer'
+      end
+
+      if attributes.key?(:'expires_in')
+        self.expires_in = attributes[:'expires_in']
+      else
+        self.expires_in = nil
+      end
+
+      if attributes.key?(:'organisation')
+        self.organisation = attributes[:'organisation']
+      else
+        self.organisation = nil
+      end
+
+      if attributes.key?(:'organisation_id')
+        self.organisation_id = attributes[:'organisation_id']
+      else
+        self.organisation_id = 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 @access_token.nil?
+        invalid_properties.push('invalid value for "access_token", access_token cannot be nil.')
+      end
+
+      if @refresh_token.nil?
+        invalid_properties.push('invalid value for "refresh_token", refresh_token cannot be nil.')
+      end
+
+      if @expires_in.nil?
+        invalid_properties.push('invalid value for "expires_in", expires_in cannot be nil.')
+      end
+
+      if @organisation.nil?
+        invalid_properties.push('invalid value for "organisation", organisation cannot be nil.')
+      end
+
+      if @organisation_id.nil?
+        invalid_properties.push('invalid value for "organisation_id", organisation_id 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 @access_token.nil?
+      return false if @refresh_token.nil?
+      return false if @expires_in.nil?
+      return false if @organisation.nil?
+      return false if @organisation_id.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] access_token Value to be assigned
+    def access_token=(access_token)
+      if access_token.nil?
+        fail ArgumentError, 'access_token cannot be nil'
+      end
+
+      @access_token = access_token
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] refresh_token Value to be assigned
+    def refresh_token=(refresh_token)
+      if refresh_token.nil?
+        fail ArgumentError, 'refresh_token cannot be nil'
+      end
+
+      @refresh_token = refresh_token
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] expires_in Value to be assigned
+    def expires_in=(expires_in)
+      if expires_in.nil?
+        fail ArgumentError, 'expires_in cannot be nil'
+      end
+
+      @expires_in = expires_in
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] organisation Value to be assigned
+    def organisation=(organisation)
+      if organisation.nil?
+        fail ArgumentError, 'organisation cannot be nil'
+      end
+
+      @organisation = organisation
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] organisation_id Value to be assigned
+    def organisation_id=(organisation_id)
+      if organisation_id.nil?
+        fail ArgumentError, 'organisation_id cannot be nil'
+      end
+
+      @organisation_id = organisation_id
+    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 &&
+          access_token == o.access_token &&
+          refresh_token == o.refresh_token &&
+          token_type == o.token_type &&
+          expires_in == o.expires_in &&
+          organisation == o.organisation &&
+          organisation_id == o.organisation_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
+      [access_token, refresh_token, token_type, expires_in, organisation, organisation_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

data/lib/pescheck/models/o_auth_application.rb

@@ -0,0 +1,265 @@
+=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 OAuth application creation requests
+  class OAuthApplication < ApiModelBase
+    # Name for the OAuth application
+    attr_accessor :name
+
+    # Client type (confidential recommended for server-to-server)  * `confidential` - Confidential * `public` - Public
+    attr_accessor :client_type
+
+    # Grant type (client_credentials for API access)  * `authorization-code` - Authorization code * `implicit` - Implicit * `password` - Resource owner password-based * `client-credentials` - Client credentials * `openid-hybrid` - OpenID connect hybrid
+    attr_accessor :authorization_grant_type
+
+    # Space-separated redirect URIs (optional for client_credentials)
+    attr_accessor :redirect_uris
+
+    # Division ID to create application for (optional)
+    attr_accessor :division_id
+
+    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
+      {
+        :'name' => :'name',
+        :'client_type' => :'client_type',
+        :'authorization_grant_type' => :'authorization_grant_type',
+        :'redirect_uris' => :'redirect_uris',
+        :'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
+      {
+        :'name' => :'String',
+        :'client_type' => :'String',
+        :'authorization_grant_type' => :'String',
+        :'redirect_uris' => :'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::OAuthApplication` 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::OAuthApplication`. 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?(:'client_type')
+        self.client_type = attributes[:'client_type']
+      else
+        self.client_type = 'confidential'
+      end
+
+      if attributes.key?(:'authorization_grant_type')
+        self.authorization_grant_type = attributes[:'authorization_grant_type']
+      else
+        self.authorization_grant_type = 'client-credentials'
+      end
+
+      if attributes.key?(:'redirect_uris')
+        self.redirect_uris = attributes[:'redirect_uris']
+      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 @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
+
+      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
+      client_type_validator = EnumAttributeValidator.new('String', ["confidential", "public"])
+      return false unless client_type_validator.valid?(@client_type)
+      authorization_grant_type_validator = EnumAttributeValidator.new('String', ["authorization-code", "implicit", "password", "client-credentials", "openid-hybrid"])
+      return false unless authorization_grant_type_validator.valid?(@authorization_grant_type)
+      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 checking allowed values (enum).
+    # @param [Object] client_type Object to be assigned
+    def client_type=(client_type)
+      validator = EnumAttributeValidator.new('String', ["confidential", "public"])
+      unless validator.valid?(client_type)
+        fail ArgumentError, "invalid value for \"client_type\", must be one of #{validator.allowable_values}."
+      end
+      @client_type = client_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] authorization_grant_type Object to be assigned
+    def authorization_grant_type=(authorization_grant_type)
+      validator = EnumAttributeValidator.new('String', ["authorization-code", "implicit", "password", "client-credentials", "openid-hybrid"])
+      unless validator.valid?(authorization_grant_type)
+        fail ArgumentError, "invalid value for \"authorization_grant_type\", must be one of #{validator.allowable_values}."
+      end
+      @authorization_grant_type = authorization_grant_type
+    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 &&
+          client_type == o.client_type &&
+          authorization_grant_type == o.authorization_grant_type &&
+          redirect_uris == o.redirect_uris &&
+          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
+      [name, client_type, authorization_grant_type, redirect_uris, 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