lockally 0.1.0

data/lib/lockally/models/dns_record.rb

@@ -0,0 +1,304 @@
+=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 DNSRecord < ApiModelBase
+    attr_accessor :type
+
+    attr_accessor :name
+
+    attr_accessor :value
+
+    attr_accessor :ttl
+
+    # MX records only.
+    attr_accessor :priority
+
+    attr_accessor :purpose
+
+    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
+      {
+        :'type' => :'type',
+        :'name' => :'name',
+        :'value' => :'value',
+        :'ttl' => :'ttl',
+        :'priority' => :'priority',
+        :'purpose' => :'purpose'
+      }
+    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
+      {
+        :'type' => :'String',
+        :'name' => :'String',
+        :'value' => :'String',
+        :'ttl' => :'Integer',
+        :'priority' => :'Integer',
+        :'purpose' => :'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::DNSRecord` 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::DNSRecord`. 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?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      else
+        self.value = nil
+      end
+
+      if attributes.key?(:'ttl')
+        self.ttl = attributes[:'ttl']
+      else
+        self.ttl = nil
+      end
+
+      if attributes.key?(:'priority')
+        self.priority = attributes[:'priority']
+      end
+
+      if attributes.key?(:'purpose')
+        self.purpose = attributes[:'purpose']
+      else
+        self.purpose = 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 @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @value.nil?
+        invalid_properties.push('invalid value for "value", value cannot be nil.')
+      end
+
+      if @ttl.nil?
+        invalid_properties.push('invalid value for "ttl", ttl cannot be nil.')
+      end
+
+      if @purpose.nil?
+        invalid_properties.push('invalid value for "purpose", purpose 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 @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["TXT", "MX"])
+      return false unless type_validator.valid?(@type)
+      return false if @name.nil?
+      return false if @value.nil?
+      return false if @ttl.nil?
+      return false if @purpose.nil?
+      purpose_validator = EnumAttributeValidator.new('String', ["verification", "spf", "dkim", "mx-primary", "mx-backup", "dmarc"])
+      return false unless purpose_validator.valid?(@purpose)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["TXT", "MX"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    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
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] value Value to be assigned
+    def value=(value)
+      if value.nil?
+        fail ArgumentError, 'value cannot be nil'
+      end
+
+      @value = value
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ttl Value to be assigned
+    def ttl=(ttl)
+      if ttl.nil?
+        fail ArgumentError, 'ttl cannot be nil'
+      end
+
+      @ttl = ttl
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] purpose Object to be assigned
+    def purpose=(purpose)
+      validator = EnumAttributeValidator.new('String', ["verification", "spf", "dkim", "mx-primary", "mx-backup", "dmarc"])
+      unless validator.valid?(purpose)
+        fail ArgumentError, "invalid value for \"purpose\", must be one of #{validator.allowable_values}."
+      end
+      @purpose = purpose
+    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 &&
+          type == o.type &&
+          name == o.name &&
+          value == o.value &&
+          ttl == o.ttl &&
+          priority == o.priority &&
+          purpose == o.purpose
+    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
+      [type, name, value, ttl, priority, purpose].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/domain.rb

@@ -0,0 +1,367 @@
+=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 Domain < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :tenant_id
+
+    attr_accessor :domain
+
+    attr_accessor :verification_token
+
+    attr_accessor :verified
+
+    attr_accessor :verified_at
+
+    attr_accessor :dkim_selector
+
+    attr_accessor :dkim_public_record
+
+    attr_accessor :created_at
+
+    # DNS records the tenant must publish under their own DNS.
+    attr_accessor :records
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'tenant_id' => :'tenant_id',
+        :'domain' => :'domain',
+        :'verification_token' => :'verification_token',
+        :'verified' => :'verified',
+        :'verified_at' => :'verified_at',
+        :'dkim_selector' => :'dkim_selector',
+        :'dkim_public_record' => :'dkim_public_record',
+        :'created_at' => :'created_at',
+        :'records' => :'records'
+      }
+    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',
+        :'domain' => :'String',
+        :'verification_token' => :'String',
+        :'verified' => :'Boolean',
+        :'verified_at' => :'Time',
+        :'dkim_selector' => :'String',
+        :'dkim_public_record' => :'String',
+        :'created_at' => :'Time',
+        :'records' => :'Array<DNSRecord>'
+      }
+    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::Domain` 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::Domain`. 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?(:'domain')
+        self.domain = attributes[:'domain']
+      else
+        self.domain = nil
+      end
+
+      if attributes.key?(:'verification_token')
+        self.verification_token = attributes[:'verification_token']
+      else
+        self.verification_token = nil
+      end
+
+      if attributes.key?(:'verified')
+        self.verified = attributes[:'verified']
+      else
+        self.verified = nil
+      end
+
+      if attributes.key?(:'verified_at')
+        self.verified_at = attributes[:'verified_at']
+      end
+
+      if attributes.key?(:'dkim_selector')
+        self.dkim_selector = attributes[:'dkim_selector']
+      else
+        self.dkim_selector = nil
+      end
+
+      if attributes.key?(:'dkim_public_record')
+        self.dkim_public_record = attributes[:'dkim_public_record']
+      else
+        self.dkim_public_record = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'records')
+        if (value = attributes[:'records']).is_a?(Array)
+          self.records = value
+        end
+      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 @domain.nil?
+        invalid_properties.push('invalid value for "domain", domain cannot be nil.')
+      end
+
+      if @verification_token.nil?
+        invalid_properties.push('invalid value for "verification_token", verification_token cannot be nil.')
+      end
+
+      if @verified.nil?
+        invalid_properties.push('invalid value for "verified", verified cannot be nil.')
+      end
+
+      if @dkim_selector.nil?
+        invalid_properties.push('invalid value for "dkim_selector", dkim_selector cannot be nil.')
+      end
+
+      if @dkim_public_record.nil?
+        invalid_properties.push('invalid value for "dkim_public_record", dkim_public_record 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 @tenant_id.nil?
+      return false if @domain.nil?
+      return false if @verification_token.nil?
+      return false if @verified.nil?
+      return false if @dkim_selector.nil?
+      return false if @dkim_public_record.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] 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] domain Value to be assigned
+    def domain=(domain)
+      if domain.nil?
+        fail ArgumentError, 'domain cannot be nil'
+      end
+
+      @domain = domain
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] verification_token Value to be assigned
+    def verification_token=(verification_token)
+      if verification_token.nil?
+        fail ArgumentError, 'verification_token cannot be nil'
+      end
+
+      @verification_token = verification_token
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] verified Value to be assigned
+    def verified=(verified)
+      if verified.nil?
+        fail ArgumentError, 'verified cannot be nil'
+      end
+
+      @verified = verified
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] dkim_selector Value to be assigned
+    def dkim_selector=(dkim_selector)
+      if dkim_selector.nil?
+        fail ArgumentError, 'dkim_selector cannot be nil'
+      end
+
+      @dkim_selector = dkim_selector
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] dkim_public_record Value to be assigned
+    def dkim_public_record=(dkim_public_record)
+      if dkim_public_record.nil?
+        fail ArgumentError, 'dkim_public_record cannot be nil'
+      end
+
+      @dkim_public_record = dkim_public_record
+    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 &&
+          tenant_id == o.tenant_id &&
+          domain == o.domain &&
+          verification_token == o.verification_token &&
+          verified == o.verified &&
+          verified_at == o.verified_at &&
+          dkim_selector == o.dkim_selector &&
+          dkim_public_record == o.dkim_public_record &&
+          created_at == o.created_at &&
+          records == o.records
+    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, domain, verification_token, verified, verified_at, dkim_selector, dkim_public_record, created_at, records].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