license_manager 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68a828b5a78c2e840be0a77b50d429b1e59e88714cbbe50436934eaffaf73435
-  data.tar.gz: 41bee49be6e3419467fc60612ed97e70c6888d579882a2422a9835ca75b87719
+  metadata.gz: 84013ac7d9c28271647dd18819bc70dd898cfb1288da389456fc1235f7a51906
+  data.tar.gz: 95ab30ee9f61fe92885cbe869040e5a84d69c0fbb932fed51e524a927c3caf9b
 SHA512:
-  metadata.gz: 0b825e5dbe10c69b2ffbf8961e8d060a467612d1c12ccbcf23e078d9403ee5306bd388121fdebdb0c3d309c3adbc470c86c0183c4c62a2352078df2c83349648
-  data.tar.gz: f077da231328da5cb860b63972bd9508ef959373ff91d4cc83a77cbc626fdc8bdfe4a56b1978729bf5366384a08c53647059e0a9bb6b429102352eb8f2ffc960
+  metadata.gz: 0c5ebe6ffa873d4c46ce31fb4d63dc4a46da24c49688fbaeebdfe4de5d39d75c338eb7822cc45c378ded4c24b2c0142644c95dc413697399a2f77ef9713ce57a
+  data.tar.gz: d73a8a3a5b929f6c8c404452ae0230e242da223cf1501fb0aac0164286195c98000e8b45ca1af9b66bb5d018cafa6d03abeff9aee5850831b657420b049d039b

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 # Changelog
 
+## 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
+
+- `GET /v1/products/{productId}/integrations/slack`: endpoint added
+- `POST /v1/products/{productId}/integrations/slack/authorize`: endpoint added
+- `DELETE /v1/slack-connections/{id}`: endpoint added
+- `PATCH /v1/slack-connections/{id}`: endpoint added
+- `POST /v1/slack-connections/{id}/test`: endpoint added
+
 ## 0.3.1 (2026-11-04)
 
 ### Changes

data/README.md

@@ -85,7 +85,7 @@ Every method is documented, with its parameters and responses, in the [`docs`](d
 | [`ReleasesApi`](docs/ReleasesApi.md) | `list_releases`, `create_release`, `get_release`, `delete_release`, `update_release` |
 | [`TokensApi`](docs/TokensApi.md) | `create_customer_token`, `create_license_token`, `create_machine_token` |
 | [`EventsApi`](docs/EventsApi.md) | `list_policy_events`, `list_license_events` |
-| [`IntegrationsApi`](docs/IntegrationsApi.md) | `get_stripe_integration`, `connect_stripe`, `disconnect_integration`, `update_integration`, `check_integration`, `list_stripe_prices`, `create_stripe_mapping`, `delete_stripe_mapping`, `update_stripe_mapping` |
+| [`IntegrationsApi`](docs/IntegrationsApi.md) | `get_stripe_integration`, `connect_stripe`, `disconnect_integration`, `update_integration`, `check_integration`, `list_stripe_prices`, `create_stripe_mapping`, `delete_stripe_mapping`, `update_stripe_mapping`, `get_slack_integration`, `authorize_slack`, `delete_slack_connection`, `update_slack_connection`, `test_slack_connection` |
 
 ## Versioning
 

data/docs/IntegrationsApi.md

@@ -4,17 +4,93 @@ All URIs are relative to *https://api.licensemanager.dev*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**authorize_slack**](IntegrationsApi.md#authorize_slack) | **POST** /v1/products/{productId}/integrations/slack/authorize | Start connecting a Slack channel |
 | [**check_integration**](IntegrationsApi.md#check_integration) | **POST** /v1/integrations/{id}/check | Check an integration |
 | [**connect_stripe**](IntegrationsApi.md#connect_stripe) | **PUT** /v1/products/{productId}/integrations/stripe | Connect Stripe |
 | [**create_stripe_mapping**](IntegrationsApi.md#create_stripe_mapping) | **POST** /v1/products/{productId}/integrations/stripe/mappings | Map a Stripe price to a policy |
+| [**delete_slack_connection**](IntegrationsApi.md#delete_slack_connection) | **DELETE** /v1/slack-connections/{id} | Remove a Slack connection |
 | [**delete_stripe_mapping**](IntegrationsApi.md#delete_stripe_mapping) | **DELETE** /v1/integration-mappings/{id} | Delete a mapping |
 | [**disconnect_integration**](IntegrationsApi.md#disconnect_integration) | **DELETE** /v1/integrations/{id} | Disconnect an integration |
+| [**get_slack_integration**](IntegrationsApi.md#get_slack_integration) | **GET** /v1/products/{productId}/integrations/slack | Get the Slack integration of a product |
 | [**get_stripe_integration**](IntegrationsApi.md#get_stripe_integration) | **GET** /v1/products/{productId}/integrations/stripe | Get the Stripe integration of a product |
 | [**list_stripe_prices**](IntegrationsApi.md#list_stripe_prices) | **GET** /v1/integrations/{id}/stripe/prices | List the Stripe prices of an integration |
+| [**test_slack_connection**](IntegrationsApi.md#test_slack_connection) | **POST** /v1/slack-connections/{id}/test | Send a test message to a Slack channel |
 | [**update_integration**](IntegrationsApi.md#update_integration) | **PATCH** /v1/integrations/{id} | Update an integration |
+| [**update_slack_connection**](IntegrationsApi.md#update_slack_connection) | **PATCH** /v1/slack-connections/{id} | Update a Slack connection |
 | [**update_stripe_mapping**](IntegrationsApi.md#update_stripe_mapping) | **PATCH** /v1/integration-mappings/{id} | Change the policy of a mapping |
 
 
+## authorize_slack
+
+> <SlackAuthorize> authorize_slack(product_id)
+
+Start connecting a Slack channel
+
+Returns the URL of Slack's consent screen, where the user picks the channel getting the product's notifications. Slack then redirects to the app's integrations page. Doesn't accept tokens: only API keys and sessions.  **Required role permission**: `integration:create` when called with a session, granted by the member's role. API keys aren't limited by roles.
+
+### Examples
+
+```ruby
+require 'time'
+require 'license_manager'
+# setup authorization
+LicenseManager.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = LicenseManager::IntegrationsApi.new
+product_id = 'x7Kp2QaZ' # String | 
+
+begin
+  # Start connecting a Slack channel
+  result = api_instance.authorize_slack(product_id)
+  p result
+rescue LicenseManager::ApiError => e
+  puts "Error when calling IntegrationsApi->authorize_slack: #{e}"
+end
+```
+
+#### Using the authorize_slack_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SlackAuthorize>, Integer, Hash)> authorize_slack_with_http_info(product_id)
+
+```ruby
+begin
+  # Start connecting a Slack channel
+  data, status_code, headers = api_instance.authorize_slack_with_http_info(product_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SlackAuthorize>
+rescue LicenseManager::ApiError => e
+  puts "Error when calling IntegrationsApi->authorize_slack_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product_id** | **String** |  |  |
+
+### Return type
+
+[**SlackAuthorize**](SlackAuthorize.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## check_integration
 
 > <Integration> check_integration(id)
@@ -232,6 +308,76 @@ end
 - **Accept**: application/json
 
 
+## delete_slack_connection
+
+> delete_slack_connection(id)
+
+Remove a Slack connection
+
+Stops posting to the channel and revokes the installation's token in Slack. Doesn't accept tokens: only API keys and sessions.  **Required role permission**: `integration:delete` when called with a session, granted by the member's role. API keys aren't limited by roles.
+
+### Examples
+
+```ruby
+require 'time'
+require 'license_manager'
+# setup authorization
+LicenseManager.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = LicenseManager::IntegrationsApi.new
+id = 's4Hq8ZpLm' # String | 
+
+begin
+  # Remove a Slack connection
+  api_instance.delete_slack_connection(id)
+rescue LicenseManager::ApiError => e
+  puts "Error when calling IntegrationsApi->delete_slack_connection: #{e}"
+end
+```
+
+#### Using the delete_slack_connection_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_slack_connection_with_http_info(id)
+
+```ruby
+begin
+  # Remove a Slack connection
+  data, status_code, headers = api_instance.delete_slack_connection_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue LicenseManager::ApiError => e
+  puts "Error when calling IntegrationsApi->delete_slack_connection_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## delete_stripe_mapping
 
 > delete_stripe_mapping(id)
@@ -372,6 +518,77 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## get_slack_integration
+
+> <SlackIntegration> get_slack_integration(product_id)
+
+Get the Slack integration of a product
+
+Slack channels getting notifications about the product's licenses: purchases, renewals, failed payments and cancellations. Doesn't accept tokens: only API keys and sessions.
+
+### Examples
+
+```ruby
+require 'time'
+require 'license_manager'
+# setup authorization
+LicenseManager.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = LicenseManager::IntegrationsApi.new
+product_id = 'x7Kp2QaZ' # String | 
+
+begin
+  # Get the Slack integration of a product
+  result = api_instance.get_slack_integration(product_id)
+  p result
+rescue LicenseManager::ApiError => e
+  puts "Error when calling IntegrationsApi->get_slack_integration: #{e}"
+end
+```
+
+#### Using the get_slack_integration_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SlackIntegration>, Integer, Hash)> get_slack_integration_with_http_info(product_id)
+
+```ruby
+begin
+  # Get the Slack integration of a product
+  data, status_code, headers = api_instance.get_slack_integration_with_http_info(product_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SlackIntegration>
+rescue LicenseManager::ApiError => e
+  puts "Error when calling IntegrationsApi->get_slack_integration_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product_id** | **String** |  |  |
+
+### Return type
+
+[**SlackIntegration**](SlackIntegration.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_stripe_integration
 
 > <StripeIntegration> get_stripe_integration(product_id)
@@ -514,6 +731,77 @@ end
 - **Accept**: application/json
 
 
+## test_slack_connection
+
+> <SlackConnection> test_slack_connection(id)
+
+Send a test message to a Slack channel
+
+Posts a message to the channel, to check it gets the notifications. Marks the connection `revoked` when Slack says it won't work again. Doesn't accept tokens: only API keys and sessions.  **Required role permission**: `integration:update` when called with a session, granted by the member's role. API keys aren't limited by roles.
+
+### Examples
+
+```ruby
+require 'time'
+require 'license_manager'
+# setup authorization
+LicenseManager.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = LicenseManager::IntegrationsApi.new
+id = 's4Hq8ZpLm' # String | 
+
+begin
+  # Send a test message to a Slack channel
+  result = api_instance.test_slack_connection(id)
+  p result
+rescue LicenseManager::ApiError => e
+  puts "Error when calling IntegrationsApi->test_slack_connection: #{e}"
+end
+```
+
+#### Using the test_slack_connection_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SlackConnection>, Integer, Hash)> test_slack_connection_with_http_info(id)
+
+```ruby
+begin
+  # Send a test message to a Slack channel
+  data, status_code, headers = api_instance.test_slack_connection_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SlackConnection>
+rescue LicenseManager::ApiError => e
+  puts "Error when calling IntegrationsApi->test_slack_connection_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**SlackConnection**](SlackConnection.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## update_integration
 
 > <Integration> update_integration(id, update_integration)
@@ -587,6 +875,79 @@ end
 - **Accept**: application/json
 
 
+## update_slack_connection
+
+> <SlackConnection> update_slack_connection(id, update_slack_connection)
+
+Update a Slack connection
+
+Changes the notifications the channel gets. Doesn't accept tokens: only API keys and sessions.  **Required role permission**: `integration:update` when called with a session, granted by the member's role. API keys aren't limited by roles.
+
+### Examples
+
+```ruby
+require 'time'
+require 'license_manager'
+# setup authorization
+LicenseManager.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = LicenseManager::IntegrationsApi.new
+id = 's4Hq8ZpLm' # String | 
+update_slack_connection = LicenseManager::UpdateSlackConnection.new({events: [purchased,  canceled]}) # UpdateSlackConnection | 
+
+begin
+  # Update a Slack connection
+  result = api_instance.update_slack_connection(id, update_slack_connection)
+  p result
+rescue LicenseManager::ApiError => e
+  puts "Error when calling IntegrationsApi->update_slack_connection: #{e}"
+end
+```
+
+#### Using the update_slack_connection_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SlackConnection>, Integer, Hash)> update_slack_connection_with_http_info(id, update_slack_connection)
+
+```ruby
+begin
+  # Update a Slack connection
+  data, status_code, headers = api_instance.update_slack_connection_with_http_info(id, update_slack_connection)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SlackConnection>
+rescue LicenseManager::ApiError => e
+  puts "Error when calling IntegrationsApi->update_slack_connection_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **update_slack_connection** | [**UpdateSlackConnection**](UpdateSlackConnection.md) |  |  |
+
+### Return type
+
+[**SlackConnection**](SlackConnection.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## update_stripe_mapping
 
 > <IntegrationMapping> update_stripe_mapping(id, update_integration_mapping)

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/SlackAuthorize.md

@@ -0,0 +1,18 @@
+# LicenseManager::SlackAuthorize
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | Slack's consent screen: open it in the browser to pick the channel. Valid 10 minutes. |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::SlackAuthorize.new(
+  url: https://slack.com/oauth/v2/authorize?client_id=…
+)
+```
+

data/docs/SlackConnection.md

@@ -0,0 +1,38 @@
+# LicenseManager::SlackConnection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **team_id** | **String** |  |  |
+| **team_name** | **String** |  |  |
+| **channel_id** | **String** |  |  |
+| **channel_name** | **String** | Name of the channel when it was connected, with its `#`. |  |
+| **configuration_url** | **String** | Page of the installation in Slack. |  |
+| **events** | **Array<String>** | Notifications the channel gets: `purchased` (a license bought through Stripe), `renewed` (a subscription renewal paid), `payment_failed` (a subscription payment failed) and `canceled` (a license canceled, or its subscription ended). |  |
+| **status** | **String** | `revoked` once Slack refuses the messages, like when the app was removed from the workspace or the channel deleted: remove it and add it again. |  |
+| **status_reason** | **String** |  |  |
+| **last_sent_at** | **Time** |  |  |
+| **created_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::SlackConnection.new(
+  id: s4Hq8ZpLm,
+  team_id: T0123ABCD,
+  team_name: Acme,
+  channel_id: C0456EFGH,
+  channel_name: #sales,
+  configuration_url: null,
+  events: null,
+  status: null,
+  status_reason: null,
+  last_sent_at: null,
+  created_at: null
+)
+```
+

data/docs/SlackIntegration.md

@@ -0,0 +1,20 @@
+# LicenseManager::SlackIntegration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **configured** | **Boolean** | Whether the server has a Slack app to connect channels with: `SLACK_CLIENT_ID` and `SLACK_CLIENT_SECRET` are set. |  |
+| **connections** | [**Array<SlackConnection>**](SlackConnection.md) | Slack channels getting the product's notifications. |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::SlackIntegration.new(
+  configured: null,
+  connections: null
+)
+```
+

data/docs/UpdateSlackConnection.md

@@ -0,0 +1,18 @@
+# LicenseManager::UpdateSlackConnection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **events** | **Array<String>** | Notifications the channel gets. |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::UpdateSlackConnection.new(
+  events: [purchased, canceled]
+)
+```
+