lockally 0.2.0 → 0.3.0

data/lib/lockally/models/create_ai_units_checkout200_response.rb

@@ -0,0 +1,199 @@
+=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>`, or `lk_test_<...>` for a test key. Create keys in the dashboard, or with `POST /v1/api-keys` using a key that holds `tenant:admin`.  The key's plan is checked on every request, so a key stops working if the account moves to a plan without API access, and works again if it moves back.  **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 CreateAiUnitsCheckout200Response < ApiModelBase
+    attr_accessor :authorization_url
+
+    attr_accessor :reference
+
+    attr_accessor :units
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'authorization_url' => :'authorization_url',
+        :'reference' => :'reference',
+        :'units' => :'units'
+      }
+    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
+      {
+        :'authorization_url' => :'String',
+        :'reference' => :'String',
+        :'units' => :'Integer'
+      }
+    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::CreateAiUnitsCheckout200Response` 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::CreateAiUnitsCheckout200Response`. 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?(:'authorization_url')
+        self.authorization_url = attributes[:'authorization_url']
+      else
+        self.authorization_url = nil
+      end
+
+      if attributes.key?(:'reference')
+        self.reference = attributes[:'reference']
+      else
+        self.reference = nil
+      end
+
+      if attributes.key?(:'units')
+        self.units = attributes[:'units']
+      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 @authorization_url.nil?
+        invalid_properties.push('invalid value for "authorization_url", authorization_url cannot be nil.')
+      end
+
+      if @reference.nil?
+        invalid_properties.push('invalid value for "reference", reference 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 @authorization_url.nil?
+      return false if @reference.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] authorization_url Value to be assigned
+    def authorization_url=(authorization_url)
+      if authorization_url.nil?
+        fail ArgumentError, 'authorization_url cannot be nil'
+      end
+
+      @authorization_url = authorization_url
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reference Value to be assigned
+    def reference=(reference)
+      if reference.nil?
+        fail ArgumentError, 'reference cannot be nil'
+      end
+
+      @reference = reference
+    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 &&
+          authorization_url == o.authorization_url &&
+          reference == o.reference &&
+          units == o.units
+    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
+      [authorization_url, reference, units].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/{v1_aliases_post_request.rb → create_alias_request.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Lockally
-  class V1AliasesPostRequest < ApiModelBase
+  class CreateAliasRequest < ApiModelBase
     attr_accessor :alias_address
 
     attr_accessor :alias_target
@@ -55,14 +55,14 @@ module Lockally
     # @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::V1AliasesPostRequest` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Lockally::CreateAliasRequest` 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::V1AliasesPostRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Lockally::CreateAliasRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }

data/lib/lockally/models/{v1_api_keys_post201_response.rb → create_api_key201_response.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Lockally
-  class V1ApiKeysPost201Response < ApiModelBase
+  class CreateApiKey201Response < ApiModelBase
     attr_accessor :id
 
     attr_accessor :tenant_id
@@ -92,14 +92,14 @@ module Lockally
     # @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::V1ApiKeysPost201Response` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Lockally::CreateApiKey201Response` 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::V1ApiKeysPost201Response`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Lockally::CreateApiKey201Response`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }

data/lib/lockally/models/{v1_api_keys_post_request.rb → create_api_key_request.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Lockally
-  class V1ApiKeysPostRequest < ApiModelBase
+  class CreateApiKeyRequest < ApiModelBase
     # Free-text identifier shown in the dashboard.
     attr_accessor :label
 
@@ -84,14 +84,14 @@ module Lockally
     # @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::V1ApiKeysPostRequest` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Lockally::CreateApiKeyRequest` 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::V1ApiKeysPostRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Lockally::CreateApiKeyRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }

data/lib/lockally/models/{v1_domains_post_request.rb → create_domain_request.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Lockally
-  class V1DomainsPostRequest < ApiModelBase
+  class CreateDomainRequest < ApiModelBase
     attr_accessor :domain
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -51,14 +51,14 @@ module Lockally
     # @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::V1DomainsPostRequest` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Lockally::CreateDomainRequest` 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::V1DomainsPostRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Lockally::CreateDomainRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }

data/lib/lockally/models/{v1_mailboxes_post_request.rb → create_mailbox_request.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Lockally
-  class V1MailboxesPostRequest < ApiModelBase
+  class CreateMailboxRequest < ApiModelBase
     attr_accessor :email
 
     # Optional; lockally generates if absent.
@@ -61,14 +61,14 @@ module Lockally
     # @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::V1MailboxesPostRequest` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Lockally::CreateMailboxRequest` 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::V1MailboxesPostRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Lockally::CreateMailboxRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }

data/lib/lockally/models/{v1_suppressions_post_request.rb → create_suppression_request.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Lockally
-  class V1SuppressionsPostRequest < ApiModelBase
+  class CreateSuppressionRequest < ApiModelBase
     attr_accessor :email
 
     attr_accessor :reason
@@ -77,14 +77,14 @@ module Lockally
     # @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::V1SuppressionsPostRequest` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Lockally::CreateSuppressionRequest` 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::V1SuppressionsPostRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Lockally::CreateSuppressionRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }

data/lib/lockally/models/{v1_webhooks_post_request.rb → create_webhook_request.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Lockally
-  class V1WebhooksPostRequest < ApiModelBase
+  class CreateWebhookRequest < ApiModelBase
     # HTTPS recommended (HTTP allowed for local development).
     attr_accessor :url
 
@@ -56,14 +56,14 @@ module Lockally
     # @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::V1WebhooksPostRequest` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Lockally::CreateWebhookRequest` 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::V1WebhooksPostRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Lockally::CreateWebhookRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }