license_manager 0.1.1 → 0.3.0

data/lib/license_manager/models/integration_mapping_recurring.rb

@@ -0,0 +1,228 @@
+=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
+  # Billing period of a recurring price, `null` for a one-time price. Subscribing to a recurring price creates one subscription license, valid while it's paid.
+  class IntegrationMappingRecurring < ApiModelBase
+    attr_accessor :interval
+
+    attr_accessor :interval_count
+
+    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
+      {
+        :'interval' => :'interval',
+        :'interval_count' => :'intervalCount'
+      }
+    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
+      {
+        :'interval' => :'String',
+        :'interval_count' => :'Integer'
+      }
+    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::IntegrationMappingRecurring` 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::IntegrationMappingRecurring`. 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?(:'interval')
+        self.interval = attributes[:'interval']
+      else
+        self.interval = nil
+      end
+
+      if attributes.key?(:'interval_count')
+        self.interval_count = attributes[:'interval_count']
+      else
+        self.interval_count = 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 @interval.nil?
+        invalid_properties.push('invalid value for "interval", interval cannot be nil.')
+      end
+
+      if @interval_count.nil?
+        invalid_properties.push('invalid value for "interval_count", interval_count 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 @interval.nil?
+      interval_validator = EnumAttributeValidator.new('String', ["day", "week", "month", "year", "unknown_default_open_api"])
+      return false unless interval_validator.valid?(@interval)
+      return false if @interval_count.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] interval Object to be assigned
+    def interval=(interval)
+      validator = EnumAttributeValidator.new('String', ["day", "week", "month", "year", "unknown_default_open_api"])
+      unless validator.valid?(interval)
+        fail ArgumentError, "invalid value for \"interval\", must be one of #{validator.allowable_values}."
+      end
+      @interval = interval
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] interval_count Value to be assigned
+    def interval_count=(interval_count)
+      if interval_count.nil?
+        fail ArgumentError, 'interval_count cannot be nil'
+      end
+
+      @interval_count = interval_count
+    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 &&
+          interval == o.interval &&
+          interval_count == o.interval_count
+    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
+      [interval, interval_count].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/license.rb

@@ -55,6 +55,22 @@ module LicenseManager
 
     attr_accessor :status
 
+    # End of the money back guarantee: until then, the customer can cancel the license from the customer portal, or with a token. Set from the policy's `moneyBackGuaranteeDays` when the license is created. `null` when the customer can't cancel it.
+    attr_accessor :cancellable_until
+
+    # When the license was canceled: validating its key fails since. `null` when it wasn't.
+    attr_accessor :canceled_at
+
+    attr_accessor :cancellation_reason
+
+    attr_accessor :subscription
+
+    # Comment given when the license was canceled. `null` when there's none.
+    attr_accessor :cancellation_comment
+
+    # Id of the Stripe refund of the license's payment once it was canceled, through the Stripe integration. `null` otherwise.
+    attr_accessor :stripe_refund_id
+
     # Last time the license's settings were edited, not when its key was validated.
     attr_accessor :updated_at
 
@@ -99,6 +115,12 @@ module LicenseManager
         :'max_version' => :'maxVersion',
         :'price' => :'price',
         :'status' => :'status',
+        :'cancellable_until' => :'cancellableUntil',
+        :'canceled_at' => :'canceledAt',
+        :'cancellation_reason' => :'cancellationReason',
+        :'subscription' => :'subscription',
+        :'cancellation_comment' => :'cancellationComment',
+        :'stripe_refund_id' => :'stripeRefundId',
         :'updated_at' => :'updatedAt'
       }
     end
@@ -132,6 +154,12 @@ module LicenseManager
         :'max_version' => :'LicenseMaxVersion',
         :'price' => :'Price',
         :'status' => :'LicenseStatus',
+        :'cancellable_until' => :'Time',
+        :'canceled_at' => :'Time',
+        :'cancellation_reason' => :'CancellationReason',
+        :'subscription' => :'LicenseSubscription',
+        :'cancellation_comment' => :'String',
+        :'stripe_refund_id' => :'String',
         :'updated_at' => :'Time'
       }
     end
@@ -145,6 +173,11 @@ module LicenseManager
         :'max_machines',
         :'last_activated_at',
         :'price',
+        :'cancellable_until',
+        :'canceled_at',
+        :'subscription',
+        :'cancellation_comment',
+        :'stripe_refund_id',
       ])
     end
 
@@ -272,6 +305,42 @@ module LicenseManager
         self.status = nil
       end
 
+      if attributes.key?(:'cancellable_until')
+        self.cancellable_until = attributes[:'cancellable_until']
+      else
+        self.cancellable_until = nil
+      end
+
+      if attributes.key?(:'canceled_at')
+        self.canceled_at = attributes[:'canceled_at']
+      else
+        self.canceled_at = nil
+      end
+
+      if attributes.key?(:'cancellation_reason')
+        self.cancellation_reason = attributes[:'cancellation_reason']
+      else
+        self.cancellation_reason = nil
+      end
+
+      if attributes.key?(:'subscription')
+        self.subscription = attributes[:'subscription']
+      else
+        self.subscription = nil
+      end
+
+      if attributes.key?(:'cancellation_comment')
+        self.cancellation_comment = attributes[:'cancellation_comment']
+      else
+        self.cancellation_comment = nil
+      end
+
+      if attributes.key?(:'stripe_refund_id')
+        self.stripe_refund_id = attributes[:'stripe_refund_id']
+      else
+        self.stripe_refund_id = nil
+      end
+
       if attributes.key?(:'updated_at')
         self.updated_at = attributes[:'updated_at']
       else
@@ -324,6 +393,10 @@ module LicenseManager
         invalid_properties.push('invalid value for "status", status cannot be nil.')
       end
 
+      if @cancellation_reason.nil?
+        invalid_properties.push('invalid value for "cancellation_reason", cancellation_reason cannot be nil.')
+      end
+
       if @updated_at.nil?
         invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
       end
@@ -345,6 +418,7 @@ module LicenseManager
       return false if @active_machine_count.nil?
       return false if @max_version.nil?
       return false if @status.nil?
+      return false if @cancellation_reason.nil?
       return false if @updated_at.nil?
       true
     end
@@ -449,6 +523,16 @@ module LicenseManager
       @status = status
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] cancellation_reason Value to be assigned
+    def cancellation_reason=(cancellation_reason)
+      if cancellation_reason.nil?
+        fail ArgumentError, 'cancellation_reason cannot be nil'
+      end
+
+      @cancellation_reason = cancellation_reason
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] updated_at Value to be assigned
     def updated_at=(updated_at)
@@ -480,6 +564,12 @@ module LicenseManager
           max_version == o.max_version &&
           price == o.price &&
           status == o.status &&
+          cancellable_until == o.cancellable_until &&
+          canceled_at == o.canceled_at &&
+          cancellation_reason == o.cancellation_reason &&
+          subscription == o.subscription &&
+          cancellation_comment == o.cancellation_comment &&
+          stripe_refund_id == o.stripe_refund_id &&
           updated_at == o.updated_at
     end
 
@@ -492,7 +582,7 @@ module LicenseManager
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, product_id, policy_id, customer_id, key, created_at, expires_at, meta, stripe_payment_intent_id, max_machines, max_offline_duration_seconds, active_machine_count, last_activated_at, max_version, price, status, updated_at].hash
+      [id, product_id, policy_id, customer_id, key, created_at, expires_at, meta, stripe_payment_intent_id, max_machines, max_offline_duration_seconds, active_machine_count, last_activated_at, max_version, price, status, cancellable_until, canceled_at, cancellation_reason, subscription, cancellation_comment, stripe_refund_id, updated_at].hash
     end
 
     # Builds the object from hash

data/lib/license_manager/models/license_status.rb

@@ -18,10 +18,11 @@ module LicenseManager
     ACTIVE = "active".freeze
     INACTIVE = "inactive".freeze
     EXPIRED = "expired".freeze
+    CANCELED = "canceled".freeze
     UNKNOWN_DEFAULT_OPEN_API = "unknown_default_open_api".freeze
 
     def self.all_vars
-      @all_vars ||= [ACTIVE, INACTIVE, EXPIRED, UNKNOWN_DEFAULT_OPEN_API].freeze
+      @all_vars ||= [ACTIVE, INACTIVE, EXPIRED, CANCELED, UNKNOWN_DEFAULT_OPEN_API].freeze
     end
 
     # Builds the enum from string