lockally 0.1.0

data/lib/lockally/models/migration.rb

@@ -0,0 +1,441 @@
+=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 Migration < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :tenant_id
+
+    attr_accessor :credential_id
+
+    attr_accessor :name
+
+    attr_accessor :status
+
+    attr_accessor :source_provider
+
+    attr_accessor :source_summary
+
+    attr_accessor :settings
+
+    attr_accessor :error_message
+
+    attr_accessor :started_at
+
+    attr_accessor :completed_at
+
+    attr_accessor :mailbox_count
+
+    attr_accessor :created_at
+
+    attr_accessor :updated_at
+
+    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',
+        :'tenant_id' => :'tenant_id',
+        :'credential_id' => :'credential_id',
+        :'name' => :'name',
+        :'status' => :'status',
+        :'source_provider' => :'source_provider',
+        :'source_summary' => :'source_summary',
+        :'settings' => :'settings',
+        :'error_message' => :'error_message',
+        :'started_at' => :'started_at',
+        :'completed_at' => :'completed_at',
+        :'mailbox_count' => :'mailbox_count',
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at'
+      }
+    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',
+        :'credential_id' => :'String',
+        :'name' => :'String',
+        :'status' => :'String',
+        :'source_provider' => :'String',
+        :'source_summary' => :'String',
+        :'settings' => :'MigrationSettings',
+        :'error_message' => :'String',
+        :'started_at' => :'Time',
+        :'completed_at' => :'Time',
+        :'mailbox_count' => :'Integer',
+        :'created_at' => :'Time',
+        :'updated_at' => :'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::Migration` 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::Migration`. 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?(:'credential_id')
+        self.credential_id = attributes[:'credential_id']
+      else
+        self.credential_id = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'source_provider')
+        self.source_provider = attributes[:'source_provider']
+      else
+        self.source_provider = nil
+      end
+
+      if attributes.key?(:'source_summary')
+        self.source_summary = attributes[:'source_summary']
+      end
+
+      if attributes.key?(:'settings')
+        self.settings = attributes[:'settings']
+      end
+
+      if attributes.key?(:'error_message')
+        self.error_message = attributes[:'error_message']
+      end
+
+      if attributes.key?(:'started_at')
+        self.started_at = attributes[:'started_at']
+      end
+
+      if attributes.key?(:'completed_at')
+        self.completed_at = attributes[:'completed_at']
+      end
+
+      if attributes.key?(:'mailbox_count')
+        self.mailbox_count = attributes[:'mailbox_count']
+      else
+        self.mailbox_count = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      else
+        self.updated_at = 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 @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 @credential_id.nil?
+        invalid_properties.push('invalid value for "credential_id", credential_id cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @source_provider.nil?
+        invalid_properties.push('invalid value for "source_provider", source_provider cannot be nil.')
+      end
+
+      if @mailbox_count.nil?
+        invalid_properties.push('invalid value for "mailbox_count", mailbox_count cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_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 @credential_id.nil?
+      return false if @name.nil?
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["draft", "discovering", "discovered", "mapped", "pilot_running", "pilot_complete", "running", "staged", "cutover_pending", "final_syncing", "validating", "completed", "failed", "cancelled"])
+      return false unless status_validator.valid?(@status)
+      return false if @source_provider.nil?
+      return false if @mailbox_count.nil?
+      return false if @created_at.nil?
+      return false if @updated_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] credential_id Value to be assigned
+    def credential_id=(credential_id)
+      if credential_id.nil?
+        fail ArgumentError, 'credential_id cannot be nil'
+      end
+
+      @credential_id = credential_id
+    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 checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["draft", "discovering", "discovered", "mapped", "pilot_running", "pilot_complete", "running", "staged", "cutover_pending", "final_syncing", "validating", "completed", "failed", "cancelled"])
+      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] source_provider Value to be assigned
+    def source_provider=(source_provider)
+      if source_provider.nil?
+        fail ArgumentError, 'source_provider cannot be nil'
+      end
+
+      @source_provider = source_provider
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] mailbox_count Value to be assigned
+    def mailbox_count=(mailbox_count)
+      if mailbox_count.nil?
+        fail ArgumentError, 'mailbox_count cannot be nil'
+      end
+
+      @mailbox_count = mailbox_count
+    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] updated_at Value to be assigned
+    def updated_at=(updated_at)
+      if updated_at.nil?
+        fail ArgumentError, 'updated_at cannot be nil'
+      end
+
+      @updated_at = updated_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 &&
+          credential_id == o.credential_id &&
+          name == o.name &&
+          status == o.status &&
+          source_provider == o.source_provider &&
+          source_summary == o.source_summary &&
+          settings == o.settings &&
+          error_message == o.error_message &&
+          started_at == o.started_at &&
+          completed_at == o.completed_at &&
+          mailbox_count == o.mailbox_count &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at
+    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, credential_id, name, status, source_provider, source_summary, settings, error_message, started_at, completed_at, mailbox_count, created_at, updated_at].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