lockally 0.1.0

data/lib/lockally/models/tenant.rb

@@ -0,0 +1,424 @@
+=begin
+#lockally control plane
+
+#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
+
+The version of the OpenAPI document: 0.1.0
+Contact: support@lockally.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Lockally
+  class Tenant < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :slug
+
+    attr_accessor :display_name
+
+    attr_accessor :status
+
+    attr_accessor :plan
+
+    # Per-tenant share of the per-VPS 5/min outbound cap (L6).
+    attr_accessor :rate_cap_per_min
+
+    attr_accessor :daily_msg_quota
+
+    attr_accessor :admin_email
+
+    attr_accessor :created_at
+
+    attr_accessor :suspended_at
+
+    attr_accessor :closed_at
+
+    attr_accessor :hard_delete_after
+
+    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',
+        :'slug' => :'slug',
+        :'display_name' => :'display_name',
+        :'status' => :'status',
+        :'plan' => :'plan',
+        :'rate_cap_per_min' => :'rate_cap_per_min',
+        :'daily_msg_quota' => :'daily_msg_quota',
+        :'admin_email' => :'admin_email',
+        :'created_at' => :'created_at',
+        :'suspended_at' => :'suspended_at',
+        :'closed_at' => :'closed_at',
+        :'hard_delete_after' => :'hard_delete_after'
+      }
+    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',
+        :'slug' => :'String',
+        :'display_name' => :'String',
+        :'status' => :'String',
+        :'plan' => :'String',
+        :'rate_cap_per_min' => :'Integer',
+        :'daily_msg_quota' => :'Integer',
+        :'admin_email' => :'String',
+        :'created_at' => :'Time',
+        :'suspended_at' => :'Time',
+        :'closed_at' => :'Time',
+        :'hard_delete_after' => :'Time'
+      }
+    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 `Lockally::Tenant` 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 `Lockally::Tenant`. 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?(:'slug')
+        self.slug = attributes[:'slug']
+      else
+        self.slug = nil
+      end
+
+      if attributes.key?(:'display_name')
+        self.display_name = attributes[:'display_name']
+      else
+        self.display_name = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'plan')
+        self.plan = attributes[:'plan']
+      else
+        self.plan = nil
+      end
+
+      if attributes.key?(:'rate_cap_per_min')
+        self.rate_cap_per_min = attributes[:'rate_cap_per_min']
+      else
+        self.rate_cap_per_min = nil
+      end
+
+      if attributes.key?(:'daily_msg_quota')
+        self.daily_msg_quota = attributes[:'daily_msg_quota']
+      else
+        self.daily_msg_quota = nil
+      end
+
+      if attributes.key?(:'admin_email')
+        self.admin_email = attributes[:'admin_email']
+      else
+        self.admin_email = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'suspended_at')
+        self.suspended_at = attributes[:'suspended_at']
+      end
+
+      if attributes.key?(:'closed_at')
+        self.closed_at = attributes[:'closed_at']
+      end
+
+      if attributes.key?(:'hard_delete_after')
+        self.hard_delete_after = attributes[:'hard_delete_after']
+      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 @slug.nil?
+        invalid_properties.push('invalid value for "slug", slug cannot be nil.')
+      end
+
+      if @display_name.nil?
+        invalid_properties.push('invalid value for "display_name", display_name cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @plan.nil?
+        invalid_properties.push('invalid value for "plan", plan cannot be nil.')
+      end
+
+      if @rate_cap_per_min.nil?
+        invalid_properties.push('invalid value for "rate_cap_per_min", rate_cap_per_min cannot be nil.')
+      end
+
+      if @daily_msg_quota.nil?
+        invalid_properties.push('invalid value for "daily_msg_quota", daily_msg_quota cannot be nil.')
+      end
+
+      if @admin_email.nil?
+        invalid_properties.push('invalid value for "admin_email", admin_email cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at 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 @slug.nil?
+      return false if @display_name.nil?
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["active", "suspended", "closing", "closed"])
+      return false unless status_validator.valid?(@status)
+      return false if @plan.nil?
+      return false if @rate_cap_per_min.nil?
+      return false if @daily_msg_quota.nil?
+      return false if @admin_email.nil?
+      return false if @created_at.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] slug Value to be assigned
+    def slug=(slug)
+      if slug.nil?
+        fail ArgumentError, 'slug cannot be nil'
+      end
+
+      @slug = slug
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] display_name Value to be assigned
+    def display_name=(display_name)
+      if display_name.nil?
+        fail ArgumentError, 'display_name cannot be nil'
+      end
+
+      @display_name = display_name
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["active", "suspended", "closing", "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] plan Value to be assigned
+    def plan=(plan)
+      if plan.nil?
+        fail ArgumentError, 'plan cannot be nil'
+      end
+
+      @plan = plan
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] rate_cap_per_min Value to be assigned
+    def rate_cap_per_min=(rate_cap_per_min)
+      if rate_cap_per_min.nil?
+        fail ArgumentError, 'rate_cap_per_min cannot be nil'
+      end
+
+      @rate_cap_per_min = rate_cap_per_min
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] daily_msg_quota Value to be assigned
+    def daily_msg_quota=(daily_msg_quota)
+      if daily_msg_quota.nil?
+        fail ArgumentError, 'daily_msg_quota cannot be nil'
+      end
+
+      @daily_msg_quota = daily_msg_quota
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] admin_email Value to be assigned
+    def admin_email=(admin_email)
+      if admin_email.nil?
+        fail ArgumentError, 'admin_email cannot be nil'
+      end
+
+      @admin_email = admin_email
+    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
+
+    # 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 &&
+          slug == o.slug &&
+          display_name == o.display_name &&
+          status == o.status &&
+          plan == o.plan &&
+          rate_cap_per_min == o.rate_cap_per_min &&
+          daily_msg_quota == o.daily_msg_quota &&
+          admin_email == o.admin_email &&
+          created_at == o.created_at &&
+          suspended_at == o.suspended_at &&
+          closed_at == o.closed_at &&
+          hard_delete_after == o.hard_delete_after
+    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, slug, display_name, status, plan, rate_cap_per_min, daily_msg_quota, admin_email, created_at, suspended_at, closed_at, hard_delete_after].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/lockally/models/unit_bundle.rb

@@ -0,0 +1,268 @@
+=begin
+#lockally control plane
+
+#The lockally control plane lets integrators and direct customers manage everything except actual mail data flow (which uses standard JMAP / IMAP / SMTP-submission against the data plane endpoints).  **Authentication.** All `/v1/*` endpoints require a Bearer API key in the `Authorization` header. Keys are formatted `lk_live_<8-char-prefix>_<32-char-secret>`. Generate the first key for a tenant via `cmd/seed`; subsequent keys via `POST /v1/api-keys`.  **Errors.** Failures return [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) `application/problem+json` documents.  **Scopes.** Each endpoint requires a specific scope on the presented key. Insufficient scope returns `403` with the required scope name in `detail`. 
+
+The version of the OpenAPI document: 0.1.0
+Contact: support@lockally.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Lockally
+  class UnitBundle < ApiModelBase
+    attr_accessor :key
+
+    attr_accessor :units
+
+    attr_accessor :display_name
+
+    attr_accessor :price_naira
+
+    attr_accessor :display_price
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'key' => :'key',
+        :'units' => :'units',
+        :'display_name' => :'display_name',
+        :'price_naira' => :'price_naira',
+        :'display_price' => :'display_price'
+      }
+    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
+      {
+        :'key' => :'String',
+        :'units' => :'Integer',
+        :'display_name' => :'String',
+        :'price_naira' => :'Integer',
+        :'display_price' => :'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 `Lockally::UnitBundle` 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 `Lockally::UnitBundle`. 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?(:'key')
+        self.key = attributes[:'key']
+      else
+        self.key = nil
+      end
+
+      if attributes.key?(:'units')
+        self.units = attributes[:'units']
+      else
+        self.units = nil
+      end
+
+      if attributes.key?(:'display_name')
+        self.display_name = attributes[:'display_name']
+      else
+        self.display_name = nil
+      end
+
+      if attributes.key?(:'price_naira')
+        self.price_naira = attributes[:'price_naira']
+      else
+        self.price_naira = nil
+      end
+
+      if attributes.key?(:'display_price')
+        self.display_price = attributes[:'display_price']
+      else
+        self.display_price = 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 @key.nil?
+        invalid_properties.push('invalid value for "key", key cannot be nil.')
+      end
+
+      if @units.nil?
+        invalid_properties.push('invalid value for "units", units cannot be nil.')
+      end
+
+      if @display_name.nil?
+        invalid_properties.push('invalid value for "display_name", display_name cannot be nil.')
+      end
+
+      if @price_naira.nil?
+        invalid_properties.push('invalid value for "price_naira", price_naira cannot be nil.')
+      end
+
+      if @display_price.nil?
+        invalid_properties.push('invalid value for "display_price", display_price 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 @key.nil?
+      return false if @units.nil?
+      return false if @display_name.nil?
+      return false if @price_naira.nil?
+      return false if @display_price.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] key Value to be assigned
+    def key=(key)
+      if key.nil?
+        fail ArgumentError, 'key cannot be nil'
+      end
+
+      @key = key
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] units Value to be assigned
+    def units=(units)
+      if units.nil?
+        fail ArgumentError, 'units cannot be nil'
+      end
+
+      @units = units
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] display_name Value to be assigned
+    def display_name=(display_name)
+      if display_name.nil?
+        fail ArgumentError, 'display_name cannot be nil'
+      end
+
+      @display_name = display_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] price_naira Value to be assigned
+    def price_naira=(price_naira)
+      if price_naira.nil?
+        fail ArgumentError, 'price_naira cannot be nil'
+      end
+
+      @price_naira = price_naira
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] display_price Value to be assigned
+    def display_price=(display_price)
+      if display_price.nil?
+        fail ArgumentError, 'display_price cannot be nil'
+      end
+
+      @display_price = display_price
+    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 &&
+          key == o.key &&
+          units == o.units &&
+          display_name == o.display_name &&
+          price_naira == o.price_naira &&
+          display_price == o.display_price
+    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
+      [key, units, display_name, price_naira, display_price].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