license_manager 0.1.0

data/lib/license_manager/models/create_license.rb

@@ -0,0 +1,361 @@
+=begin
+#LicenseManager API
+
+#Public API. Authenticate with an organization API key, or with a token scoped to a customer, license or machine on the endpoints that accept one.  ## Conventions  - **Errors** answer `{ \"error\": { \"code\", \"message\" } }`. Branch on `code`, which is stable, not on `message`. Each response lists the codes it can return, except `404`, which answers `not_found` unless it says otherwise. Unexpected errors answer `500` with `internal_error`. - **Validation** errors answer `422`, not `400`, with the `validation_error` code and an `issues` array giving the `path` and `message` of each invalid value. - **Unknown body fields are ignored**, not rejected: sending a field an endpoint doesn't accept, like `policyId` to `updateLicense`, changes nothing and doesn't fail. - **Strings** are trimmed before they're validated and stored. Emails are stored lower cased. - **Updates** only change the fields that are sent. A field sent as `null` is cleared, when it can be. - **Dates** can be sent with any offset, and are always returned in UTC, like `2026-01-15T09:30:00.000Z`. Calendar months and days are counted in UTC. - **Ids** are 8 letters and digits, after `test_` for test products and their resources. - **Lists** are paginated with `page` and `pageSize`. Items with the same value for the `sort` field are ordered by id, so pages are stable, but items created or deleted between two requests shift the pages. Items without a value for the `sort` field come last in ascending order, and first in descending order, unless the endpoint says otherwise. - **Test products** are sandboxes of a live product. Test API keys only reach test products, live API keys only live ones: the others answer `404`, as if they didn't exist. Sessions and tokens reach both.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.26.0
+
+=end
+
+require 'date'
+require 'time'
+
+module LicenseManager
+  class CreateLicense < ApiModelBase
+    # Email of the customer the license belongs to. The product's customer with this email, compared regardless of case, or a new one when there's none.
+    attr_accessor :email
+
+    # Unique within the product. Case sensitive: `validateKey` compares keys exactly. Defaults to a random key of 5 groups of 5 characters separated by dashes, each character an upper case letter or a digit other than `O`, `0`, `I` and `1`, for 125 random bits. Starts with `TEST-` in test products, which is added when missing, and removed in live products.
+    attr_accessor :key
+
+    # Policy of the product the license follows. Defaults to the product's default policy.
+    attr_accessor :policy_id
+
+    # `null` makes the license never expire. Defaults to the creation date plus the duration of the policy, or `null` when the policy has none.
+    attr_accessor :expires_at
+
+    # Free-form JSON object.
+    attr_accessor :meta
+
+    # Maximum number of active machines the license can be used on. `null` for no limit. Defaults to the one of the policy.
+    attr_accessor :max_machines
+
+    # Longest the applications can run offline with the license, in seconds. At least one hour (`3600`). Defaults to the one of the policy.
+    attr_accessor :max_offline_duration_seconds
+
+    attr_accessor :price
+
+    attr_accessor :max_version
+
+    # `true` emails the key to the customer once the license is created, like `sendLicenseKeys`. Sent in the background: a failed email doesn't fail the creation. In test products, it's only sent when the customer's email is a member's of the organization. Defaults to `false`.
+    attr_accessor :send_key
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'email' => :'email',
+        :'key' => :'key',
+        :'policy_id' => :'policyId',
+        :'expires_at' => :'expiresAt',
+        :'meta' => :'meta',
+        :'max_machines' => :'maxMachines',
+        :'max_offline_duration_seconds' => :'maxOfflineDurationSeconds',
+        :'price' => :'price',
+        :'max_version' => :'maxVersion',
+        :'send_key' => :'sendKey'
+      }
+    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
+      {
+        :'email' => :'String',
+        :'key' => :'String',
+        :'policy_id' => :'String',
+        :'expires_at' => :'Time',
+        :'meta' => :'Hash<String, Object>',
+        :'max_machines' => :'Integer',
+        :'max_offline_duration_seconds' => :'Integer',
+        :'price' => :'PriceInput',
+        :'max_version' => :'LicenseMaxVersionInput',
+        :'send_key' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'expires_at',
+        :'meta',
+        :'max_machines',
+        :'price',
+      ])
+    end
+
+    # Returns attribute type mapping
+    def self.acceptable_openapi_types
+      openapi_types
+    end
+
+    # Returns the nullable attributes
+    def self.acceptable_openapi_nullable
+      openapi_nullable
+    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 `LicenseManager::CreateLicense` 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 `LicenseManager::CreateLicense`. 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?(:'email')
+        self.email = attributes[:'email']
+      else
+        self.email = nil
+      end
+
+      if attributes.key?(:'key')
+        self.key = attributes[:'key']
+      end
+
+      if attributes.key?(:'policy_id')
+        self.policy_id = attributes[:'policy_id']
+      end
+
+      if attributes.key?(:'expires_at')
+        self.expires_at = attributes[:'expires_at']
+      end
+
+      if attributes.key?(:'meta')
+        if (value = attributes[:'meta']).is_a?(Hash)
+          self.meta = value
+        end
+      end
+
+      if attributes.key?(:'max_machines')
+        self.max_machines = attributes[:'max_machines']
+      end
+
+      if attributes.key?(:'max_offline_duration_seconds')
+        self.max_offline_duration_seconds = attributes[:'max_offline_duration_seconds']
+      end
+
+      if attributes.key?(:'price')
+        self.price = attributes[:'price']
+      end
+
+      if attributes.key?(:'max_version')
+        self.max_version = attributes[:'max_version']
+      end
+
+      if attributes.key?(:'send_key')
+        self.send_key = attributes[:'send_key']
+      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 @email.nil?
+        invalid_properties.push('invalid value for "email", email cannot be nil.')
+      end
+
+      if @email.to_s.length > 320
+        invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 320.')
+      end
+
+      if !@key.nil? && @key.to_s.length > 255
+        invalid_properties.push('invalid value for "key", the character length must be smaller than or equal to 255.')
+      end
+
+      if !@key.nil? && @key.to_s.length < 1
+        invalid_properties.push('invalid value for "key", the character length must be greater than or equal to 1.')
+      end
+
+      if !@max_machines.nil? && @max_machines > 2147483647
+        invalid_properties.push('invalid value for "max_machines", must be smaller than or equal to 2147483647.')
+      end
+
+      if !@max_machines.nil? && @max_machines <= 0
+        invalid_properties.push('invalid value for "max_machines", must be greater than 0.')
+      end
+
+      if !@max_offline_duration_seconds.nil? && @max_offline_duration_seconds > 2147483647
+        invalid_properties.push('invalid value for "max_offline_duration_seconds", must be smaller than or equal to 2147483647.')
+      end
+
+      if !@max_offline_duration_seconds.nil? && @max_offline_duration_seconds < 3600
+        invalid_properties.push('invalid value for "max_offline_duration_seconds", must be greater than or equal to 3600.')
+      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 @email.nil?
+      return false if @email.to_s.length > 320
+      return false if !@key.nil? && @key.to_s.length > 255
+      return false if !@key.nil? && @key.to_s.length < 1
+      return false if !@max_machines.nil? && @max_machines > 2147483647
+      return false if !@max_machines.nil? && @max_machines <= 0
+      return false if !@max_offline_duration_seconds.nil? && @max_offline_duration_seconds > 2147483647
+      return false if !@max_offline_duration_seconds.nil? && @max_offline_duration_seconds < 3600
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] email Value to be assigned
+    def email=(email)
+      if email.nil?
+        fail ArgumentError, 'email cannot be nil'
+      end
+
+      if email.to_s.length > 320
+        fail ArgumentError, 'invalid value for "email", the character length must be smaller than or equal to 320.'
+      end
+
+      @email = email
+    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
+
+      if key.to_s.length > 255
+        fail ArgumentError, 'invalid value for "key", the character length must be smaller than or equal to 255.'
+      end
+
+      if key.to_s.length < 1
+        fail ArgumentError, 'invalid value for "key", the character length must be greater than or equal to 1.'
+      end
+
+      @key = key
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_machines Value to be assigned
+    def max_machines=(max_machines)
+      if !max_machines.nil? && max_machines > 2147483647
+        fail ArgumentError, 'invalid value for "max_machines", must be smaller than or equal to 2147483647.'
+      end
+
+      if !max_machines.nil? && max_machines <= 0
+        fail ArgumentError, 'invalid value for "max_machines", must be greater than 0.'
+      end
+
+      @max_machines = max_machines
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_offline_duration_seconds Value to be assigned
+    def max_offline_duration_seconds=(max_offline_duration_seconds)
+      if max_offline_duration_seconds.nil?
+        fail ArgumentError, 'max_offline_duration_seconds cannot be nil'
+      end
+
+      if max_offline_duration_seconds > 2147483647
+        fail ArgumentError, 'invalid value for "max_offline_duration_seconds", must be smaller than or equal to 2147483647.'
+      end
+
+      if max_offline_duration_seconds < 3600
+        fail ArgumentError, 'invalid value for "max_offline_duration_seconds", must be greater than or equal to 3600.'
+      end
+
+      @max_offline_duration_seconds = max_offline_duration_seconds
+    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 &&
+          email == o.email &&
+          key == o.key &&
+          policy_id == o.policy_id &&
+          expires_at == o.expires_at &&
+          meta == o.meta &&
+          max_machines == o.max_machines &&
+          max_offline_duration_seconds == o.max_offline_duration_seconds &&
+          price == o.price &&
+          max_version == o.max_version &&
+          send_key == o.send_key
+    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
+      [email, key, policy_id, expires_at, meta, max_machines, max_offline_duration_seconds, price, max_version, send_key].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)
+      # include attributes inherited from allOf parents (the nearest declaration wins)
+      map = acceptable_attribute_map
+      transformed_hash = {}
+      acceptable_openapi_types.each_pair do |key, type|
+        if attributes.key?(map[key]) && attributes[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[map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[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 = {}
+      # include attributes inherited from allOf parents (the nearest declaration wins)
+      self.class.acceptable_attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.acceptable_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