license_manager 0.1.1 → 0.2.0

data/lib/license_manager/models/cancel_license.rb

@@ -0,0 +1,238 @@
+=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 CancelLicense < ApiModelBase
+    attr_accessor :reason
+
+    # What the customer said about the cancellation.
+    attr_accessor :comment
+
+    # Whether to refund the license's Stripe payment, when it was bought through the Stripe integration. Defaults to the integration's `autoRefund`. Ignored for tokens, which always follow `autoRefund`, and when the integration's `canRefund` is false: its API key can't create refunds.
+    attr_accessor :refund
+
+    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
+      {
+        :'reason' => :'reason',
+        :'comment' => :'comment',
+        :'refund' => :'refund'
+      }
+    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
+      {
+        :'reason' => :'CancellationReason',
+        :'comment' => :'String',
+        :'refund' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::CancelLicense` 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::CancelLicense`. 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?(:'reason')
+        self.reason = attributes[:'reason']
+      else
+        self.reason = nil
+      end
+
+      if attributes.key?(:'comment')
+        self.comment = attributes[:'comment']
+      end
+
+      if attributes.key?(:'refund')
+        self.refund = attributes[:'refund']
+      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 @reason.nil?
+        invalid_properties.push('invalid value for "reason", reason cannot be nil.')
+      end
+
+      if !@comment.nil? && @comment.to_s.length > 2000
+        invalid_properties.push('invalid value for "comment", the character length must be smaller than or equal to 2000.')
+      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 @reason.nil?
+      return false if !@comment.nil? && @comment.to_s.length > 2000
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reason Value to be assigned
+    def reason=(reason)
+      if reason.nil?
+        fail ArgumentError, 'reason cannot be nil'
+      end
+
+      @reason = reason
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] comment Value to be assigned
+    def comment=(comment)
+      if comment.nil?
+        fail ArgumentError, 'comment cannot be nil'
+      end
+
+      if comment.to_s.length > 2000
+        fail ArgumentError, 'invalid value for "comment", the character length must be smaller than or equal to 2000.'
+      end
+
+      @comment = comment
+    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 &&
+          reason == o.reason &&
+          comment == o.comment &&
+          refund == o.refund
+    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
+      [reason, comment, refund].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

data/lib/license_manager/models/cancellation_reason.rb

@@ -0,0 +1,45 @@
+=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 CancellationReason
+    TOO_EXPENSIVE = "too_expensive".freeze
+    MISSING_FEATURES = "missing_features".freeze
+    NOT_WORKING = "not_working".freeze
+    SWITCHED = "switched".freeze
+    UNUSED = "unused".freeze
+    OTHER = "other".freeze
+    UNKNOWN_DEFAULT_OPEN_API = "unknown_default_open_api".freeze
+
+    def self.all_vars
+      @all_vars ||= [TOO_EXPENSIVE, MISSING_FEATURES, NOT_WORKING, SWITCHED, UNUSED, OTHER, UNKNOWN_DEFAULT_OPEN_API].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if CancellationReason.all_vars.include?(value)
+      UNKNOWN_DEFAULT_OPEN_API
+    end
+  end
+end

data/lib/license_manager/models/cancellation_stats.rb

@@ -0,0 +1,347 @@
+=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
+  # Cancellations of the licenses with a money back guarantee. Licenses canceled without one are left out.
+  class CancellationStats < ApiModelBase
+    # Number of licenses with a money back guarantee: a `cancellableUntil`.
+    attr_accessor :license_count
+
+    # Number of them that were canceled.
+    attr_accessor :canceled_license_count
+
+    # Number of them whose money back guarantee hasn't ended, and that weren't canceled: they can still be.
+    attr_accessor :cancellable_license_count
+
+    # Share of them that were canceled, from 0 to 1: `canceledLicenseCount` over `licenseCount`.
+    attr_accessor :rate
+
+    # Number of them canceled each day, aligned on `days`, on the day of their cancellation.
+    attr_accessor :canceled_by_day
+
+    # Number of them canceled each month, aligned on `months`, on the month of their cancellation.
+    attr_accessor :canceled_by_month
+
+    # Number of them canceled for each reason, from the most given one. Reasons never given are left out.
+    attr_accessor :by_reason
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'license_count' => :'licenseCount',
+        :'canceled_license_count' => :'canceledLicenseCount',
+        :'cancellable_license_count' => :'cancellableLicenseCount',
+        :'rate' => :'rate',
+        :'canceled_by_day' => :'canceledByDay',
+        :'canceled_by_month' => :'canceledByMonth',
+        :'by_reason' => :'byReason'
+      }
+    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
+      {
+        :'license_count' => :'Integer',
+        :'canceled_license_count' => :'Integer',
+        :'cancellable_license_count' => :'Integer',
+        :'rate' => :'Float',
+        :'canceled_by_day' => :'Array<Integer>',
+        :'canceled_by_month' => :'Array<Integer>',
+        :'by_reason' => :'Array<CancellationStatsByReasonInner>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::CancellationStats` 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::CancellationStats`. 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?(:'license_count')
+        self.license_count = attributes[:'license_count']
+      else
+        self.license_count = nil
+      end
+
+      if attributes.key?(:'canceled_license_count')
+        self.canceled_license_count = attributes[:'canceled_license_count']
+      else
+        self.canceled_license_count = nil
+      end
+
+      if attributes.key?(:'cancellable_license_count')
+        self.cancellable_license_count = attributes[:'cancellable_license_count']
+      else
+        self.cancellable_license_count = nil
+      end
+
+      if attributes.key?(:'rate')
+        self.rate = attributes[:'rate']
+      else
+        self.rate = nil
+      end
+
+      if attributes.key?(:'canceled_by_day')
+        if (value = attributes[:'canceled_by_day']).is_a?(Array)
+          self.canceled_by_day = value
+        end
+      else
+        self.canceled_by_day = nil
+      end
+
+      if attributes.key?(:'canceled_by_month')
+        if (value = attributes[:'canceled_by_month']).is_a?(Array)
+          self.canceled_by_month = value
+        end
+      else
+        self.canceled_by_month = nil
+      end
+
+      if attributes.key?(:'by_reason')
+        if (value = attributes[:'by_reason']).is_a?(Array)
+          self.by_reason = value
+        end
+      else
+        self.by_reason = 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 @license_count.nil?
+        invalid_properties.push('invalid value for "license_count", license_count cannot be nil.')
+      end
+
+      if @canceled_license_count.nil?
+        invalid_properties.push('invalid value for "canceled_license_count", canceled_license_count cannot be nil.')
+      end
+
+      if @cancellable_license_count.nil?
+        invalid_properties.push('invalid value for "cancellable_license_count", cancellable_license_count cannot be nil.')
+      end
+
+      if @rate.nil?
+        invalid_properties.push('invalid value for "rate", rate cannot be nil.')
+      end
+
+      if @canceled_by_day.nil?
+        invalid_properties.push('invalid value for "canceled_by_day", canceled_by_day cannot be nil.')
+      end
+
+      if @canceled_by_month.nil?
+        invalid_properties.push('invalid value for "canceled_by_month", canceled_by_month cannot be nil.')
+      end
+
+      if @by_reason.nil?
+        invalid_properties.push('invalid value for "by_reason", by_reason 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 @license_count.nil?
+      return false if @canceled_license_count.nil?
+      return false if @cancellable_license_count.nil?
+      return false if @rate.nil?
+      return false if @canceled_by_day.nil?
+      return false if @canceled_by_month.nil?
+      return false if @by_reason.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] license_count Value to be assigned
+    def license_count=(license_count)
+      if license_count.nil?
+        fail ArgumentError, 'license_count cannot be nil'
+      end
+
+      @license_count = license_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] canceled_license_count Value to be assigned
+    def canceled_license_count=(canceled_license_count)
+      if canceled_license_count.nil?
+        fail ArgumentError, 'canceled_license_count cannot be nil'
+      end
+
+      @canceled_license_count = canceled_license_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] cancellable_license_count Value to be assigned
+    def cancellable_license_count=(cancellable_license_count)
+      if cancellable_license_count.nil?
+        fail ArgumentError, 'cancellable_license_count cannot be nil'
+      end
+
+      @cancellable_license_count = cancellable_license_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] rate Value to be assigned
+    def rate=(rate)
+      if rate.nil?
+        fail ArgumentError, 'rate cannot be nil'
+      end
+
+      @rate = rate
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] canceled_by_day Value to be assigned
+    def canceled_by_day=(canceled_by_day)
+      if canceled_by_day.nil?
+        fail ArgumentError, 'canceled_by_day cannot be nil'
+      end
+
+      @canceled_by_day = canceled_by_day
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] canceled_by_month Value to be assigned
+    def canceled_by_month=(canceled_by_month)
+      if canceled_by_month.nil?
+        fail ArgumentError, 'canceled_by_month cannot be nil'
+      end
+
+      @canceled_by_month = canceled_by_month
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] by_reason Value to be assigned
+    def by_reason=(by_reason)
+      if by_reason.nil?
+        fail ArgumentError, 'by_reason cannot be nil'
+      end
+
+      @by_reason = by_reason
+    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 &&
+          license_count == o.license_count &&
+          canceled_license_count == o.canceled_license_count &&
+          cancellable_license_count == o.cancellable_license_count &&
+          rate == o.rate &&
+          canceled_by_day == o.canceled_by_day &&
+          canceled_by_month == o.canceled_by_month &&
+          by_reason == o.by_reason
+    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
+      [license_count, canceled_license_count, cancellable_license_count, rate, canceled_by_day, canceled_by_month, by_reason].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