license_manager 0.3.2 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20647dd29895350d4dadc4bab710756eb748a814c67e08a7c8a9e0661b472caa
-  data.tar.gz: '004191f59667807fb23c21aaf7548ca7fa6c821254603a285fb51bde85d511ab'
+  metadata.gz: 03c5c21351e34cf5e63df9e2174a9a7662ca4c3eb78a9957de394668cc8b892e
+  data.tar.gz: c34d07e1b6f9cc1763aa38276de44aebff9b6f89fcb65833fe4ab9259c4fa8ef
 SHA512:
-  metadata.gz: 446e1c8285486571af235bdd1f162ba2d8fd2b44788051b019249f5b2e0c75a78146a107c2182d76eb01db4cf4b4147748e6a642740b53f9e0673158702ccb20
-  data.tar.gz: '093cdc1dee0f7f4dbdcf7039996b9a9ae76377dd347df40f6315114d35d84544aba352e2d7d15e3442ed7012c61ba3f025d1f15ef3aad3cdabd44025a300f303'
+  metadata.gz: d3f3a6b680ecfac3c20b68471de625d2bc037d4b940f843f4eac5855c978cb2ebb2d85b47d1d9891fbe7325e19719d75ddb463ae5cbd5e96040ef51682752da4
+  data.tar.gz: cf18c4abde11dc326ad13f95ea853cf89fa831a4ca4c5ce1cf0a6e8315b0ffbdfd4ce3376e3c51d27eae1792924b11749cfabe4d57aae426b6af3f61efc3e181

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## 0.3.4 (2026-11-11)
+
+### Changes
+
+- `GET /v1/customers/{customerId}/licenses`: added the new optional `query` request parameter `machinePlatform`
+- `GET /v1/products/{productId}/licenses`: added the new optional `query` request parameter `machinePlatform`
+
+## 0.3.3 (2026-11-06)
+
+### Potentially breaking changes
+
+- `GET /v1/customers/{customerId}/licenses`: removed `#/components/schemas/CancellationReason, subschema #2` from the `data/items/cancellationReason` response property `allOf` list for the response status `200`
+- `GET /v1/customers/{customerId}/licenses`: added `#/components/schemas/CancellationReason, subschema #2` to the `data/items/cancellationReason` response property `anyOf` list for the response status `200`
+- `GET /v1/licenses/{id}`: removed `#/components/schemas/CancellationReason, subschema #2` from the `cancellationReason` response property `allOf` list for the response status `200`
+- `GET /v1/licenses/{id}`: added `#/components/schemas/CancellationReason, subschema #2` to the `cancellationReason` response property `anyOf` list for the response status `200`
+- `PATCH /v1/licenses/{id}`: removed `#/components/schemas/CancellationReason, subschema #2` from the `cancellationReason` response property `allOf` list for the response status `200`
+- `PATCH /v1/licenses/{id}`: added `#/components/schemas/CancellationReason, subschema #2` to the `cancellationReason` response property `anyOf` list for the response status `200`
+- `POST /v1/licenses/{id}/cancel`: removed `#/components/schemas/CancellationReason, subschema #2` from the `cancellationReason` response property `allOf` list for the response status `200`
+- `POST /v1/licenses/{id}/cancel`: added `#/components/schemas/CancellationReason, subschema #2` to the `cancellationReason` response property `anyOf` list for the response status `200`
+- `GET /v1/products/{productId}/licenses`: removed `#/components/schemas/CancellationReason, subschema #2` from the `data/items/cancellationReason` response property `allOf` list for the response status `200`
+- `GET /v1/products/{productId}/licenses`: added `#/components/schemas/CancellationReason, subschema #2` to the `data/items/cancellationReason` response property `anyOf` list for the response status `200`
+- `POST /v1/products/{productId}/licenses`: removed `#/components/schemas/CancellationReason, subschema #2` from the `cancellationReason` response property `allOf` list for the response status `201`
+- `POST /v1/products/{productId}/licenses`: added `#/components/schemas/CancellationReason, subschema #2` to the `cancellationReason` response property `anyOf` list for the response status `201`
+
 ## 0.3.2 (2026-11-05)
 
 ### Changes

data/docs/License.md

@@ -23,7 +23,7 @@
 | **status** | [**LicenseStatus**](LicenseStatus.md) |  |  |
 | **cancellable_until** | **Time** | 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. |  |
 | **canceled_at** | **Time** | When the license was canceled: validating its key fails since. `null` when it wasn't. |  |
-| **cancellation_reason** | [**CancellationReason**](CancellationReason.md) |  |  |
+| **cancellation_reason** | [**CancellationReason**](CancellationReason.md) | Why the license was canceled. `null` when it wasn't. |  |
 | **subscription** | [**LicenseSubscription**](LicenseSubscription.md) |  |  |
 | **cancellation_comment** | **String** | Comment given when the license was canceled. `null` when there's none. |  |
 | **stripe_refund_id** | **String** | Id of the Stripe refund of the license's payment once it was canceled, through the Stripe integration. `null` otherwise. |  |

data/docs/LicensesApi.md

@@ -483,6 +483,7 @@ opts = {
   key: '7KQ2M-X9ZPA-H4TRC-WN6EY-B3JDF', # String | Only returns the license with this exact key, case included. Keys of test products start with `TEST-`.
   policy_id: 'p4Rt8LmQ', # String | Only returns the licenses following this policy.
   machine_version: '2.3.1', # String | Only returns the licenses with at least one active machine running this version of the product.
+  machine_platform: 'macOS 15.1', # String | Only returns the licenses with at least one active machine on this platform.
   status: LicenseManager::LicenseStatus::ACTIVE, # LicenseStatus | Only returns the licenses with this status.
   created_from: Time.parse('2026-01-01T00:00:00.000Z'), # Time | Only returns the licenses created at or after this date.
   created_to: Time.parse('2026-02-01T00:00:00.000Z'), # Time | Only returns the licenses created at or before this date.
@@ -538,6 +539,7 @@ end
 | **key** | **String** | Only returns the license with this exact key, case included. Keys of test products start with `TEST-`. | [optional] |
 | **policy_id** | **String** | Only returns the licenses following this policy. | [optional] |
 | **machine_version** | **String** | Only returns the licenses with at least one active machine running this version of the product. | [optional] |
+| **machine_platform** | **String** | Only returns the licenses with at least one active machine on this platform. | [optional] |
 | **status** | [**LicenseStatus**](.md) | Only returns the licenses with this status. | [optional] |
 | **created_from** | **Time** | Only returns the licenses created at or after this date. | [optional] |
 | **created_to** | **Time** | Only returns the licenses created at or before this date. | [optional] |
@@ -599,6 +601,7 @@ opts = {
   policy_id: 'p4Rt8LmQ', # String | Only returns the licenses following this policy.
   customer_id: 'c9Wd3RtE', # String | Only returns the licenses of this customer.
   machine_version: '2.3.1', # String | Only returns the licenses with at least one active machine running this version of the product.
+  machine_platform: 'macOS 15.1', # String | Only returns the licenses with at least one active machine on this platform.
   status: LicenseManager::LicenseStatus::ACTIVE, # LicenseStatus | Only returns the licenses with this status.
   created_from: Time.parse('2026-01-01T00:00:00.000Z'), # Time | Only returns the licenses created at or after this date.
   created_to: Time.parse('2026-02-01T00:00:00.000Z'), # Time | Only returns the licenses created at or before this date.
@@ -655,6 +658,7 @@ end
 | **policy_id** | **String** | Only returns the licenses following this policy. | [optional] |
 | **customer_id** | **String** | Only returns the licenses of this customer. | [optional] |
 | **machine_version** | **String** | Only returns the licenses with at least one active machine running this version of the product. | [optional] |
+| **machine_platform** | **String** | Only returns the licenses with at least one active machine on this platform. | [optional] |
 | **status** | [**LicenseStatus**](.md) | Only returns the licenses with this status. | [optional] |
 | **created_from** | **Time** | Only returns the licenses created at or after this date. | [optional] |
 | **created_to** | **Time** | Only returns the licenses created at or before this date. | [optional] |

data/lib/license_manager/api/licenses_api.rb

@@ -424,6 +424,7 @@ module LicenseManager
     # @option opts [String] :key Only returns the license with this exact key, case included. Keys of test products start with `TEST-`.
     # @option opts [String] :policy_id Only returns the licenses following this policy.
     # @option opts [String] :machine_version Only returns the licenses with at least one active machine running this version of the product.
+    # @option opts [String] :machine_platform Only returns the licenses with at least one active machine on this platform.
     # @option opts [LicenseStatus] :status Only returns the licenses with this status.
     # @option opts [Time] :created_from Only returns the licenses created at or after this date.
     # @option opts [Time] :created_to Only returns the licenses created at or before this date.
@@ -455,6 +456,7 @@ module LicenseManager
     # @option opts [String] :key Only returns the license with this exact key, case included. Keys of test products start with `TEST-`.
     # @option opts [String] :policy_id Only returns the licenses following this policy.
     # @option opts [String] :machine_version Only returns the licenses with at least one active machine running this version of the product.
+    # @option opts [String] :machine_platform Only returns the licenses with at least one active machine on this platform.
     # @option opts [LicenseStatus] :status Only returns the licenses with this status.
     # @option opts [Time] :created_from Only returns the licenses created at or after this date.
     # @option opts [Time] :created_to Only returns the licenses created at or before this date.
@@ -526,6 +528,7 @@ module LicenseManager
       query_params[:'key'] = opts[:'key'] if !opts[:'key'].nil?
       query_params[:'policyId'] = opts[:'policy_id'] if !opts[:'policy_id'].nil?
       query_params[:'machineVersion'] = opts[:'machine_version'] if !opts[:'machine_version'].nil?
+      query_params[:'machinePlatform'] = opts[:'machine_platform'] if !opts[:'machine_platform'].nil?
       query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
       query_params[:'createdFrom'] = opts[:'created_from'] if !opts[:'created_from'].nil?
       query_params[:'createdTo'] = opts[:'created_to'] if !opts[:'created_to'].nil?
@@ -587,6 +590,7 @@ module LicenseManager
     # @option opts [String] :policy_id Only returns the licenses following this policy.
     # @option opts [String] :customer_id Only returns the licenses of this customer.
     # @option opts [String] :machine_version Only returns the licenses with at least one active machine running this version of the product.
+    # @option opts [String] :machine_platform Only returns the licenses with at least one active machine on this platform.
     # @option opts [LicenseStatus] :status Only returns the licenses with this status.
     # @option opts [Time] :created_from Only returns the licenses created at or after this date.
     # @option opts [Time] :created_to Only returns the licenses created at or before this date.
@@ -619,6 +623,7 @@ module LicenseManager
     # @option opts [String] :policy_id Only returns the licenses following this policy.
     # @option opts [String] :customer_id Only returns the licenses of this customer.
     # @option opts [String] :machine_version Only returns the licenses with at least one active machine running this version of the product.
+    # @option opts [String] :machine_platform Only returns the licenses with at least one active machine on this platform.
     # @option opts [LicenseStatus] :status Only returns the licenses with this status.
     # @option opts [Time] :created_from Only returns the licenses created at or after this date.
     # @option opts [Time] :created_to Only returns the licenses created at or before this date.
@@ -691,6 +696,7 @@ module LicenseManager
       query_params[:'policyId'] = opts[:'policy_id'] if !opts[:'policy_id'].nil?
       query_params[:'customerId'] = opts[:'customer_id'] if !opts[:'customer_id'].nil?
       query_params[:'machineVersion'] = opts[:'machine_version'] if !opts[:'machine_version'].nil?
+      query_params[:'machinePlatform'] = opts[:'machine_platform'] if !opts[:'machine_platform'].nil?
       query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
       query_params[:'createdFrom'] = opts[:'created_from'] if !opts[:'created_from'].nil?
       query_params[:'createdTo'] = opts[:'created_to'] if !opts[:'created_to'].nil?

data/lib/license_manager/models/license.rb

@@ -63,6 +63,7 @@ module LicenseManager
     # When the license was canceled: validating its key fails since. `null` when it wasn't.
     attr_accessor :canceled_at
 
+    # Why the license was canceled. `null` when it wasn't.
     attr_accessor :cancellation_reason
 
     attr_accessor :subscription
@@ -179,6 +180,7 @@ module LicenseManager
         :'price',
         :'cancellable_until',
         :'canceled_at',
+        :'cancellation_reason',
         :'subscription',
         :'cancellation_comment',
         :'stripe_refund_id',
@@ -407,10 +409,6 @@ 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
@@ -433,7 +431,6 @@ 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
@@ -548,16 +545,6 @@ 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)

data/lib/license_manager/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.26.0
 =end
 
 module LicenseManager
-  VERSION = '0.3.2'
+  VERSION = '0.3.4'
 end

data/license_manager.gemspec

@@ -21,12 +21,18 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["LicenseManager"]
   s.email       = ["bot@licensemanager.dev"]
-  s.homepage    = "https://licensemanager.dev"
+  s.homepage    = "https://licensemanager.dev/docs/sdks/ruby"
   s.summary     = "Ruby client for the LicenseManager API"
   s.description = "Ruby client for the LicenseManager API: products, policies, customers, licenses, machines and releases."
-  s.license     = "Unlicense"
+  s.license     = "Apache-2.0"
   s.required_ruby_version = ">= 3.1"
-  s.metadata    = {}
+  s.metadata    = {
+    "homepage_uri" => "https://licensemanager.dev/docs/sdks/ruby",
+    "documentation_uri" => "https://licensemanager.dev/docs/sdks/ruby",
+    "source_code_uri" => "https://github.com/licenseman/licensemanager-ruby",
+    "changelog_uri" => "https://github.com/licenseman/licensemanager-ruby/blob/main/CHANGELOG.md",
+    "bug_tracker_uri" => "https://github.com/licenseman/licensemanager-ruby/issues",
+  }
 
   s.add_runtime_dependency 'faraday', '>= 1.0.1', '< 3.0'
   s.add_runtime_dependency 'faraday-multipart'

data/openapi.json

@@ -2199,18 +2199,15 @@
             "example": "2026-01-20T16:12:00.000Z"
           },
           "cancellationReason": {
-            "allOf": [
+            "anyOf": [
               {
                 "$ref": "#/components/schemas/CancellationReason"
               },
               {
-                "type": [
-                  "string",
-                  "null"
-                ],
-                "description": "Why the license was canceled. `null` when it wasn't."
+                "type": "null"
               }
-            ]
+            ],
+            "description": "Why the license was canceled. `null` when it wasn't."
           },
           "subscription": {
             "$ref": "#/components/schemas/LicenseSubscription"
@@ -6634,6 +6631,17 @@
             "name": "machineVersion",
             "in": "query"
           },
+          {
+            "schema": {
+              "type": "string",
+              "description": "Only returns the licenses with at least one active machine on this platform.",
+              "example": "macOS 15.1"
+            },
+            "required": false,
+            "description": "Only returns the licenses with at least one active machine on this platform.",
+            "name": "machinePlatform",
+            "in": "query"
+          },
           {
             "schema": {
               "allOf": [
@@ -7135,6 +7143,17 @@
             "name": "machineVersion",
             "in": "query"
           },
+          {
+            "schema": {
+              "type": "string",
+              "description": "Only returns the licenses with at least one active machine on this platform.",
+              "example": "macOS 15.1"
+            },
+            "required": false,
+            "description": "Only returns the licenses with at least one active machine on this platform.",
+            "name": "machinePlatform",
+            "in": "query"
+          },
           {
             "schema": {
               "allOf": [

data/spec/api/licenses_api_spec.rb

@@ -117,6 +117,7 @@ describe 'LicensesApi' do
   # @option opts [String] :key Only returns the license with this exact key, case included. Keys of test products start with `TEST-`.
   # @option opts [String] :policy_id Only returns the licenses following this policy.
   # @option opts [String] :machine_version Only returns the licenses with at least one active machine running this version of the product.
+  # @option opts [String] :machine_platform Only returns the licenses with at least one active machine on this platform.
   # @option opts [LicenseStatus] :status Only returns the licenses with this status.
   # @option opts [Time] :created_from Only returns the licenses created at or after this date.
   # @option opts [Time] :created_to Only returns the licenses created at or before this date.
@@ -151,6 +152,7 @@ describe 'LicensesApi' do
   # @option opts [String] :policy_id Only returns the licenses following this policy.
   # @option opts [String] :customer_id Only returns the licenses of this customer.
   # @option opts [String] :machine_version Only returns the licenses with at least one active machine running this version of the product.
+  # @option opts [String] :machine_platform Only returns the licenses with at least one active machine on this platform.
   # @option opts [LicenseStatus] :status Only returns the licenses with this status.
   # @option opts [Time] :created_from Only returns the licenses created at or after this date.
   # @option opts [Time] :created_to Only returns the licenses created at or before this date.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: license_manager
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.4
 platform: ruby
 authors:
 - LicenseManager
@@ -463,10 +463,15 @@ files:
 - spec/models/validate_key_error_spec.rb
 - spec/models/validate_key_spec.rb
 - spec/spec_helper.rb
-homepage: https://licensemanager.dev
+homepage: https://licensemanager.dev/docs/sdks/ruby
 licenses:
-- Unlicense
-metadata: {}
+- Apache-2.0
+metadata:
+  homepage_uri: https://licensemanager.dev/docs/sdks/ruby
+  documentation_uri: https://licensemanager.dev/docs/sdks/ruby
+  source_code_uri: https://github.com/licenseman/licensemanager-ruby
+  changelog_uri: https://github.com/licenseman/licensemanager-ruby/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/licenseman/licensemanager-ruby/issues
 rdoc_options: []
 require_paths:
 - lib