solifyn 1.1.4 → 1.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +21 -4
  3. data/docs/CreateEntitlementDto.md +42 -0
  4. data/docs/CreateFramerTemplateDto.md +22 -0
  5. data/docs/EntitlementDetailResponseDto.md +56 -0
  6. data/docs/EntitlementGrantResponseDto.md +4 -0
  7. data/docs/EntitlementGrantsApi.md +5 -1
  8. data/docs/EntitlementsApi.md +331 -0
  9. data/docs/FramerIntegrationApi.md +355 -0
  10. data/docs/FramerTemplateResponseDto.md +30 -0
  11. data/docs/LinkedProductDto.md +20 -0
  12. data/docs/ProductCreate.md +7 -1
  13. data/docs/ProductUpdate.md +7 -1
  14. data/docs/UpdateEntitlementDto.md +42 -0
  15. data/docs/UpdateFramerTemplateDto.md +22 -0
  16. data/lib/solifyn/api/entitlement_grants_api.rb +6 -0
  17. data/lib/solifyn/api/entitlements_api.rb +347 -0
  18. data/lib/solifyn/api/framer_integration_api.rb +345 -0
  19. data/lib/solifyn/models/create_entitlement_dto.rb +385 -0
  20. data/lib/solifyn/models/create_framer_template_dto.rb +249 -0
  21. data/lib/solifyn/models/entitlement_detail_response_dto.rb +470 -0
  22. data/lib/solifyn/models/entitlement_grant_response_dto.rb +21 -1
  23. data/lib/solifyn/models/framer_template_response_dto.rb +317 -0
  24. data/lib/solifyn/models/linked_product_dto.rb +239 -0
  25. data/lib/solifyn/models/product_create.rb +38 -4
  26. data/lib/solifyn/models/product_update.rb +38 -4
  27. data/lib/solifyn/models/update_entitlement_dto.rb +371 -0
  28. data/lib/solifyn/models/update_framer_template_dto.rb +235 -0
  29. data/lib/solifyn/version.rb +1 -1
  30. data/lib/solifyn.rb +9 -0
  31. data/spec/api/entitlements_api_spec.rb +95 -0
  32. data/spec/api/framer_integration_api_spec.rb +95 -0
  33. data/spec/models/create_entitlement_dto_spec.rb +112 -0
  34. data/spec/models/create_framer_template_dto_spec.rb +48 -0
  35. data/spec/models/entitlement_detail_response_dto_spec.rb +150 -0
  36. data/spec/models/framer_template_response_dto_spec.rb +72 -0
  37. data/spec/models/linked_product_dto_spec.rb +42 -0
  38. data/spec/models/update_entitlement_dto_spec.rb +112 -0
  39. data/spec/models/update_framer_template_dto_spec.rb +48 -0
  40. metadata +172 -136
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c7870b8c127836aa17122a74ecd6602f7fbdb52143be164a4e15828f3cad8b0b
4
- data.tar.gz: 2f6156e0e5be91272016efc52d3e4c95e19fca99e3ef9987b85a125cd9121050
3
+ metadata.gz: e58cfaa2e5e9e374c656c743cc6d75c1e95e424149a9793e1915f8304a812216
4
+ data.tar.gz: be2239bcda39836b6cd7b867d995e99a968e4f9ba0c5261371b3da4b30eb6635
5
5
  SHA512:
6
- metadata.gz: 5598ceb0e69213b8c5a8a3556e0c46537b1f85d34694a3986386ebf090bd209d55ca8cad97611a11c6f74c5c9228c0d935d24c532d7f65a7deaefc0869e527ef
7
- data.tar.gz: a0a5a944159ab3543a203b0c7c669327bc1a105ecda621dc33a8e4d6809a3753d87946e4d774359cd9a5a805a5e48d567ceb4228739f3eeecf4e2d4578c6278b
6
+ metadata.gz: 51113b9cde82175bd8f6af20b8a90a89aa009f4ef5ebe9567efa93dd8221e8132efca71d32876a198b95bf22bbdad982edcebcaaf1a5c92e249d381fd468d8d5
7
+ data.tar.gz: 78a9727737a2a1d07763aebff3e630a612ec2342da5f16c28e661610658da25c00cccd5a584e3161b99a2311326ea4881bb08a277280b77d6d2d8f39b782e0fc
data/README.md CHANGED
@@ -7,7 +7,7 @@ Welcome to the Solifyn API Reference. Leverage our secure endpoints to manage pr
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 1.0.0
10
- - Package version: 1.1.4
10
+ - Package version: 1.1.6
11
11
  - Generator version: 7.10.0
12
12
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
13
13
 
@@ -24,16 +24,16 @@ gem build solifyn.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./solifyn-1.1.4.gem
27
+ gem install ./solifyn-1.1.6.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./solifyn-1.1.4.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./solifyn-1.1.6.gem` to install the development dependencies)
31
31
 
32
32
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
33
33
 
34
34
  Finally add this to the Gemfile:
35
35
 
36
- gem 'solifyn', '~> 1.1.4'
36
+ gem 'solifyn', '~> 1.1.6'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -133,6 +133,16 @@ Class | Method | HTTP request | Description
133
133
  *Solifyn::EntitlementGrantsApi* | [**entitlement_grants_list**](docs/EntitlementGrantsApi.md#entitlement_grants_list) | **GET** /v1/entitlement-grants | List Entitlement Grants
134
134
  *Solifyn::EntitlementGrantsApi* | [**entitlement_grants_retry**](docs/EntitlementGrantsApi.md#entitlement_grants_retry) | **POST** /v1/entitlement-grants/{id}/retry | Retry Entitlement Grant Delivery
135
135
  *Solifyn::EntitlementGrantsApi* | [**entitlement_grants_revoke**](docs/EntitlementGrantsApi.md#entitlement_grants_revoke) | **POST** /v1/entitlement-grants/{id}/revoke | Manually Revoke Entitlement Grant
136
+ *Solifyn::EntitlementsApi* | [**entitlements_create**](docs/EntitlementsApi.md#entitlements_create) | **POST** /v1/entitlements | Create Entitlement
137
+ *Solifyn::EntitlementsApi* | [**entitlements_delete**](docs/EntitlementsApi.md#entitlements_delete) | **DELETE** /v1/entitlements/{id} | Delete Entitlement
138
+ *Solifyn::EntitlementsApi* | [**entitlements_get**](docs/EntitlementsApi.md#entitlements_get) | **GET** /v1/entitlements/{id} | Retrieve Entitlement
139
+ *Solifyn::EntitlementsApi* | [**entitlements_list**](docs/EntitlementsApi.md#entitlements_list) | **GET** /v1/entitlements | List Entitlements
140
+ *Solifyn::EntitlementsApi* | [**entitlements_update**](docs/EntitlementsApi.md#entitlements_update) | **PATCH** /v1/entitlements/{id} | Update Entitlement
141
+ *Solifyn::FramerIntegrationApi* | [**framer_create_template**](docs/FramerIntegrationApi.md#framer_create_template) | **POST** /v1/framer/templates | Create Framer Template
142
+ *Solifyn::FramerIntegrationApi* | [**framer_delete_template**](docs/FramerIntegrationApi.md#framer_delete_template) | **DELETE** /v1/framer/templates/{id} | Delete Framer Template
143
+ *Solifyn::FramerIntegrationApi* | [**framer_get_template**](docs/FramerIntegrationApi.md#framer_get_template) | **GET** /v1/framer/templates/{id} | Retrieve Framer Template
144
+ *Solifyn::FramerIntegrationApi* | [**framer_list_templates**](docs/FramerIntegrationApi.md#framer_list_templates) | **GET** /v1/framer/templates | List Framer Templates
145
+ *Solifyn::FramerIntegrationApi* | [**framer_update_template**](docs/FramerIntegrationApi.md#framer_update_template) | **PUT** /v1/framer/templates/{id} | Update Framer Template
136
146
  *Solifyn::GitHubIntegrationApi* | [**github_get_install_url**](docs/GitHubIntegrationApi.md#github_get_install_url) | **GET** /v1/github/install | Get GitHub App Installation URL
137
147
  *Solifyn::GitHubIntegrationApi* | [**github_list_repos**](docs/GitHubIntegrationApi.md#github_list_repos) | **GET** /v1/github/repos | List Available GitHub Repositories
138
148
  *Solifyn::LicenseApi* | [**licenses_create**](docs/LicenseApi.md#licenses_create) | **POST** /v1/licenses | Create License Key
@@ -238,6 +248,8 @@ Class | Method | HTTP request | Description
238
248
  - [Solifyn::CreateCollectionCheckoutDto](docs/CreateCollectionCheckoutDto.md)
239
249
  - [Solifyn::CreateCollectionDto](docs/CreateCollectionDto.md)
240
250
  - [Solifyn::CreateCustomerDto](docs/CreateCustomerDto.md)
251
+ - [Solifyn::CreateEntitlementDto](docs/CreateEntitlementDto.md)
252
+ - [Solifyn::CreateFramerTemplateDto](docs/CreateFramerTemplateDto.md)
241
253
  - [Solifyn::CreateMeterDto](docs/CreateMeterDto.md)
242
254
  - [Solifyn::CreateSetupCheckoutDto](docs/CreateSetupCheckoutDto.md)
243
255
  - [Solifyn::CreateWebhookEndpointDto](docs/CreateWebhookEndpointDto.md)
@@ -259,7 +271,9 @@ Class | Method | HTTP request | Description
259
271
  - [Solifyn::DisputeFileUpload](docs/DisputeFileUpload.md)
260
272
  - [Solifyn::DisputeList](docs/DisputeList.md)
261
273
  - [Solifyn::DisputeListMetaDto](docs/DisputeListMetaDto.md)
274
+ - [Solifyn::EntitlementDetailResponseDto](docs/EntitlementDetailResponseDto.md)
262
275
  - [Solifyn::EntitlementGrantResponseDto](docs/EntitlementGrantResponseDto.md)
276
+ - [Solifyn::FramerTemplateResponseDto](docs/FramerTemplateResponseDto.md)
263
277
  - [Solifyn::GithubReposResponseDto](docs/GithubReposResponseDto.md)
264
278
  - [Solifyn::Instance](docs/Instance.md)
265
279
  - [Solifyn::Invoice](docs/Invoice.md)
@@ -273,6 +287,7 @@ Class | Method | HTTP request | Description
273
287
  - [Solifyn::LicensesUpdateInstancePostRequest](docs/LicensesUpdateInstancePostRequest.md)
274
288
  - [Solifyn::LicensesUpdateRequest](docs/LicensesUpdateRequest.md)
275
289
  - [Solifyn::LicensesVerifyRequest](docs/LicensesVerifyRequest.md)
290
+ - [Solifyn::LinkedProductDto](docs/LinkedProductDto.md)
276
291
  - [Solifyn::MeterDetailResponseDto](docs/MeterDetailResponseDto.md)
277
292
  - [Solifyn::MeterEventsResponseDto](docs/MeterEventsResponseDto.md)
278
293
  - [Solifyn::MeterIngestEventDto](docs/MeterIngestEventDto.md)
@@ -333,6 +348,8 @@ Class | Method | HTTP request | Description
333
348
  - [Solifyn::UpdateCollectionDto](docs/UpdateCollectionDto.md)
334
349
  - [Solifyn::UpdateCollectionProductDto](docs/UpdateCollectionProductDto.md)
335
350
  - [Solifyn::UpdateCustomerDto](docs/UpdateCustomerDto.md)
351
+ - [Solifyn::UpdateEntitlementDto](docs/UpdateEntitlementDto.md)
352
+ - [Solifyn::UpdateFramerTemplateDto](docs/UpdateFramerTemplateDto.md)
336
353
  - [Solifyn::UpdateInstanceDto](docs/UpdateInstanceDto.md)
337
354
  - [Solifyn::UpdateMeterDto](docs/UpdateMeterDto.md)
338
355
  - [Solifyn::UpdateWebhookEndpointDto](docs/UpdateWebhookEndpointDto.md)
@@ -0,0 +1,42 @@
1
+ # Solifyn::CreateEntitlementDto
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | The user-friendly name of the entitlement | |
8
+ | **type** | **String** | The type of access to grant | |
9
+ | **github_repo** | **String** | The GitHub repository (e.g., owner/repo) | [optional] |
10
+ | **github_permission** | **String** | The GitHub repository permission level | [optional][default to 'pull'] |
11
+ | **discord_guild_id** | **String** | The Discord Guild/Server ID | [optional] |
12
+ | **discord_role_id** | **String** | The Discord Role ID to assign | [optional] |
13
+ | **framer_template_id** | **String** | The associated Framer Template ID | [optional] |
14
+ | **license_key** | **String** | The static License Key (if not dynamically generated) | [optional] |
15
+ | **activation_limit** | **Float** | The maximum activation limit for licenses | [optional] |
16
+ | **activation_message** | **String** | A message shown to the user upon license activation | [optional] |
17
+ | **expiry_hours** | **Float** | The number of hours until the entitlement expires | [optional] |
18
+ | **digital_link** | **String** | The digital download URL or redirect link | [optional] |
19
+ | **instructions** | **String** | Custom setup instructions for the user | [optional] |
20
+
21
+ ## Example
22
+
23
+ ```ruby
24
+ require 'solifyn'
25
+
26
+ instance = Solifyn::CreateEntitlementDto.new(
27
+ name: Premium GitHub Access,
28
+ type: GITHUB,
29
+ github_repo: solifyn/premium-repo,
30
+ github_permission: pull,
31
+ discord_guild_id: 123456789012345678,
32
+ discord_role_id: 876543210987654321,
33
+ framer_template_id: framer_tmpl_123,
34
+ license_key: whsec_license_key_123,
35
+ activation_limit: 3,
36
+ activation_message: Thank you for activating your software license!,
37
+ expiry_hours: 720,
38
+ digital_link: https://downloads.solifyn.com/file.zip,
39
+ instructions: Clone the repository and run npm install.
40
+ )
41
+ ```
42
+
@@ -0,0 +1,22 @@
1
+ # Solifyn::CreateFramerTemplateDto
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | The name of the Framer template. | |
8
+ | **remix_link** | **String** | The public Framer remix link. | |
9
+ | **description** | **String** | A brief description of the template. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'solifyn'
15
+
16
+ instance = Solifyn::CreateFramerTemplateDto.new(
17
+ name: Portfolio Template,
18
+ remix_link: https://framer.com/projects/xyz,
19
+ description: Premium dark-mode portfolio.
20
+ )
21
+ ```
22
+
@@ -0,0 +1,56 @@
1
+ # Solifyn::EntitlementDetailResponseDto
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | The unique entitlement ID | |
8
+ | **business_id** | **String** | The owning business ID | |
9
+ | **name** | **String** | The name of the entitlement | |
10
+ | **type** | **String** | The type of access to grant | |
11
+ | **status** | **String** | Status of the entitlement | |
12
+ | **created_at** | **Time** | When the entitlement was created | |
13
+ | **updated_at** | **Time** | When the entitlement was last updated | |
14
+ | **github_repo** | **String** | The GitHub repository (e.g., owner/repo) | [optional] |
15
+ | **github_permission** | **String** | The GitHub repository permission level | [optional] |
16
+ | **discord_guild_id** | **String** | The Discord Guild/Server ID | [optional] |
17
+ | **discord_role_id** | **String** | The Discord Role ID to assign | [optional] |
18
+ | **framer_template_id** | **String** | The associated Framer Template ID | [optional] |
19
+ | **license_key** | **String** | The static License Key (if not dynamically generated) | [optional] |
20
+ | **activation_limit** | **Float** | The maximum activation limit for licenses | [optional] |
21
+ | **activation_message** | **String** | A message shown to the user upon license activation | [optional] |
22
+ | **expiry_hours** | **Float** | The number of hours until the entitlement expires | [optional] |
23
+ | **digital_link** | **String** | The digital download URL or redirect link | [optional] |
24
+ | **instructions** | **String** | Custom setup instructions for the user | [optional] |
25
+ | **grants_count** | **Float** | Number of active customer grants issued from this entitlement | |
26
+ | **products** | [**Array<LinkedProductDto>**](LinkedProductDto.md) | Products that are currently linked to this entitlement | |
27
+
28
+ ## Example
29
+
30
+ ```ruby
31
+ require 'solifyn'
32
+
33
+ instance = Solifyn::EntitlementDetailResponseDto.new(
34
+ id: ent_8Z1aB2cD3eF4gH5iJ6kL7m,
35
+ business_id: bus_12345,
36
+ name: Premium GitHub Access,
37
+ type: GITHUB,
38
+ status: ACTIVE,
39
+ created_at: 2026-06-10T12:00:00.000Z,
40
+ updated_at: 2026-06-10T12:00:00.000Z,
41
+ github_repo: solifyn/premium-repo,
42
+ github_permission: pull,
43
+ discord_guild_id: 123456789012345678,
44
+ discord_role_id: 876543210987654321,
45
+ framer_template_id: framer_tmpl_123,
46
+ license_key: whsec_license_key_123,
47
+ activation_limit: 3,
48
+ activation_message: Thank you for activating your software license!,
49
+ expiry_hours: 720,
50
+ digital_link: https://downloads.solifyn.com/file.zip,
51
+ instructions: Clone the repository and run npm install.,
52
+ grants_count: 42,
53
+ products: null
54
+ )
55
+ ```
56
+
@@ -17,6 +17,8 @@
17
17
  | **discord_role_id** | **String** | Target Discord Role ID if type is DISCORD. | [optional] |
18
18
  | **discord_username** | **String** | The connected customer Discord username. | [optional] |
19
19
  | **discord_user_id** | **String** | The connected customer Discord user ID. | [optional] |
20
+ | **framer_template_id** | **String** | The Framer template ID if type is FRAMER. | [optional] |
21
+ | **framer_remix_link** | **String** | The single-use remix link generated for the customer if type is FRAMER. | [optional] |
20
22
  | **status** | **String** | Delivery status of the collaborator invite (PENDING, DELIVERED, FAILED, REVOKED). | |
21
23
  | **oauth_url** | **String** | OAuth URL to redirect the customer to. | [optional] |
22
24
  | **error_details** | **String** | Error message if invitation delivery failed. | [optional] |
@@ -43,6 +45,8 @@ instance = Solifyn::EntitlementGrantResponseDto.new(
43
45
  discord_role_id: 876543210987654321,
44
46
  discord_username: discorduser#1234,
45
47
  discord_user_id: 112233445566778899,
48
+ framer_template_id: tmpl_123456,
49
+ framer_remix_link: https://api.solifyn.com/v1/framer/remix/grant_123456,
46
50
  status: PENDING,
47
51
  oauth_url: https://github.com/login/oauth/authorize...,
48
52
  error_details: Permission denied,
@@ -100,7 +100,9 @@ end
100
100
 
101
101
  api_instance = Solifyn::EntitlementGrantsApi.new
102
102
  opts = {
103
- status: 'status_example' # String | Filter by status (PENDING, DELIVERED, FAILED, REVOKED)
103
+ status: 'status_example', # String | Filter by status (PENDING, DELIVERED, FAILED, REVOKED)
104
+ entitlement_id: 'entitlement_id_example', # String | Filter by entitlement config ID
105
+ product_id: 'product_id_example' # String | Filter by product ID
104
106
  }
105
107
 
106
108
  begin
@@ -135,6 +137,8 @@ end
135
137
  | Name | Type | Description | Notes |
136
138
  | ---- | ---- | ----------- | ----- |
137
139
  | **status** | **String** | Filter by status (PENDING, DELIVERED, FAILED, REVOKED) | [optional] |
140
+ | **entitlement_id** | **String** | Filter by entitlement config ID | [optional] |
141
+ | **product_id** | **String** | Filter by product ID | [optional] |
138
142
 
139
143
  ### Return type
140
144
 
@@ -0,0 +1,331 @@
1
+ # Solifyn::EntitlementsApi
2
+
3
+ All URIs are relative to *https://api.solifyn.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**entitlements_create**](EntitlementsApi.md#entitlements_create) | **POST** /v1/entitlements | Create Entitlement |
8
+ | [**entitlements_delete**](EntitlementsApi.md#entitlements_delete) | **DELETE** /v1/entitlements/{id} | Delete Entitlement |
9
+ | [**entitlements_get**](EntitlementsApi.md#entitlements_get) | **GET** /v1/entitlements/{id} | Retrieve Entitlement |
10
+ | [**entitlements_list**](EntitlementsApi.md#entitlements_list) | **GET** /v1/entitlements | List Entitlements |
11
+ | [**entitlements_update**](EntitlementsApi.md#entitlements_update) | **PATCH** /v1/entitlements/{id} | Update Entitlement |
12
+
13
+
14
+ ## entitlements_create
15
+
16
+ > <EntitlementDetailResponseDto> entitlements_create(create_entitlement_dto)
17
+
18
+ Create Entitlement
19
+
20
+ Create a new independent access entitlement.
21
+
22
+ ### Examples
23
+
24
+ ```ruby
25
+ require 'time'
26
+ require 'solifyn'
27
+
28
+ api_instance = Solifyn::EntitlementsApi.new
29
+ create_entitlement_dto = Solifyn::CreateEntitlementDto.new({name: 'Premium GitHub Access', type: 'GITHUB'}) # CreateEntitlementDto |
30
+
31
+ begin
32
+ # Create Entitlement
33
+ result = api_instance.entitlements_create(create_entitlement_dto)
34
+ p result
35
+ rescue Solifyn::ApiError => e
36
+ puts "Error when calling EntitlementsApi->entitlements_create: #{e}"
37
+ end
38
+ ```
39
+
40
+ #### Using the entitlements_create_with_http_info variant
41
+
42
+ This returns an Array which contains the response data, status code and headers.
43
+
44
+ > <Array(<EntitlementDetailResponseDto>, Integer, Hash)> entitlements_create_with_http_info(create_entitlement_dto)
45
+
46
+ ```ruby
47
+ begin
48
+ # Create Entitlement
49
+ data, status_code, headers = api_instance.entitlements_create_with_http_info(create_entitlement_dto)
50
+ p status_code # => 2xx
51
+ p headers # => { ... }
52
+ p data # => <EntitlementDetailResponseDto>
53
+ rescue Solifyn::ApiError => e
54
+ puts "Error when calling EntitlementsApi->entitlements_create_with_http_info: #{e}"
55
+ end
56
+ ```
57
+
58
+ ### Parameters
59
+
60
+ | Name | Type | Description | Notes |
61
+ | ---- | ---- | ----------- | ----- |
62
+ | **create_entitlement_dto** | [**CreateEntitlementDto**](CreateEntitlementDto.md) | | |
63
+
64
+ ### Return type
65
+
66
+ [**EntitlementDetailResponseDto**](EntitlementDetailResponseDto.md)
67
+
68
+ ### Authorization
69
+
70
+ No authorization required
71
+
72
+ ### HTTP request headers
73
+
74
+ - **Content-Type**: application/json
75
+ - **Accept**: application/json
76
+
77
+
78
+ ## entitlements_delete
79
+
80
+ > <EntitlementDetailResponseDto> entitlements_delete(id)
81
+
82
+ Delete Entitlement
83
+
84
+ Delete an independent entitlement and unlink all mapped products.
85
+
86
+ ### Examples
87
+
88
+ ```ruby
89
+ require 'time'
90
+ require 'solifyn'
91
+
92
+ api_instance = Solifyn::EntitlementsApi.new
93
+ id = 'ent_8Z1aB2cD3eF4gH5iJ6kL7m' # String | The unique entitlement ID.
94
+
95
+ begin
96
+ # Delete Entitlement
97
+ result = api_instance.entitlements_delete(id)
98
+ p result
99
+ rescue Solifyn::ApiError => e
100
+ puts "Error when calling EntitlementsApi->entitlements_delete: #{e}"
101
+ end
102
+ ```
103
+
104
+ #### Using the entitlements_delete_with_http_info variant
105
+
106
+ This returns an Array which contains the response data, status code and headers.
107
+
108
+ > <Array(<EntitlementDetailResponseDto>, Integer, Hash)> entitlements_delete_with_http_info(id)
109
+
110
+ ```ruby
111
+ begin
112
+ # Delete Entitlement
113
+ data, status_code, headers = api_instance.entitlements_delete_with_http_info(id)
114
+ p status_code # => 2xx
115
+ p headers # => { ... }
116
+ p data # => <EntitlementDetailResponseDto>
117
+ rescue Solifyn::ApiError => e
118
+ puts "Error when calling EntitlementsApi->entitlements_delete_with_http_info: #{e}"
119
+ end
120
+ ```
121
+
122
+ ### Parameters
123
+
124
+ | Name | Type | Description | Notes |
125
+ | ---- | ---- | ----------- | ----- |
126
+ | **id** | **String** | The unique entitlement ID. | |
127
+
128
+ ### Return type
129
+
130
+ [**EntitlementDetailResponseDto**](EntitlementDetailResponseDto.md)
131
+
132
+ ### Authorization
133
+
134
+ No authorization required
135
+
136
+ ### HTTP request headers
137
+
138
+ - **Content-Type**: Not defined
139
+ - **Accept**: application/json
140
+
141
+
142
+ ## entitlements_get
143
+
144
+ > <EntitlementDetailResponseDto> entitlements_get(id)
145
+
146
+ Retrieve Entitlement
147
+
148
+ Retrieve a specific entitlement definition by ID.
149
+
150
+ ### Examples
151
+
152
+ ```ruby
153
+ require 'time'
154
+ require 'solifyn'
155
+
156
+ api_instance = Solifyn::EntitlementsApi.new
157
+ id = 'ent_8Z1aB2cD3eF4gH5iJ6kL7m' # String | The unique entitlement ID.
158
+
159
+ begin
160
+ # Retrieve Entitlement
161
+ result = api_instance.entitlements_get(id)
162
+ p result
163
+ rescue Solifyn::ApiError => e
164
+ puts "Error when calling EntitlementsApi->entitlements_get: #{e}"
165
+ end
166
+ ```
167
+
168
+ #### Using the entitlements_get_with_http_info variant
169
+
170
+ This returns an Array which contains the response data, status code and headers.
171
+
172
+ > <Array(<EntitlementDetailResponseDto>, Integer, Hash)> entitlements_get_with_http_info(id)
173
+
174
+ ```ruby
175
+ begin
176
+ # Retrieve Entitlement
177
+ data, status_code, headers = api_instance.entitlements_get_with_http_info(id)
178
+ p status_code # => 2xx
179
+ p headers # => { ... }
180
+ p data # => <EntitlementDetailResponseDto>
181
+ rescue Solifyn::ApiError => e
182
+ puts "Error when calling EntitlementsApi->entitlements_get_with_http_info: #{e}"
183
+ end
184
+ ```
185
+
186
+ ### Parameters
187
+
188
+ | Name | Type | Description | Notes |
189
+ | ---- | ---- | ----------- | ----- |
190
+ | **id** | **String** | The unique entitlement ID. | |
191
+
192
+ ### Return type
193
+
194
+ [**EntitlementDetailResponseDto**](EntitlementDetailResponseDto.md)
195
+
196
+ ### Authorization
197
+
198
+ No authorization required
199
+
200
+ ### HTTP request headers
201
+
202
+ - **Content-Type**: Not defined
203
+ - **Accept**: application/json
204
+
205
+
206
+ ## entitlements_list
207
+
208
+ > <Array<EntitlementDetailResponseDto>> entitlements_list
209
+
210
+ List Entitlements
211
+
212
+ List all independent entitlements for the active business.
213
+
214
+ ### Examples
215
+
216
+ ```ruby
217
+ require 'time'
218
+ require 'solifyn'
219
+
220
+ api_instance = Solifyn::EntitlementsApi.new
221
+
222
+ begin
223
+ # List Entitlements
224
+ result = api_instance.entitlements_list
225
+ p result
226
+ rescue Solifyn::ApiError => e
227
+ puts "Error when calling EntitlementsApi->entitlements_list: #{e}"
228
+ end
229
+ ```
230
+
231
+ #### Using the entitlements_list_with_http_info variant
232
+
233
+ This returns an Array which contains the response data, status code and headers.
234
+
235
+ > <Array(<Array<EntitlementDetailResponseDto>>, Integer, Hash)> entitlements_list_with_http_info
236
+
237
+ ```ruby
238
+ begin
239
+ # List Entitlements
240
+ data, status_code, headers = api_instance.entitlements_list_with_http_info
241
+ p status_code # => 2xx
242
+ p headers # => { ... }
243
+ p data # => <Array<EntitlementDetailResponseDto>>
244
+ rescue Solifyn::ApiError => e
245
+ puts "Error when calling EntitlementsApi->entitlements_list_with_http_info: #{e}"
246
+ end
247
+ ```
248
+
249
+ ### Parameters
250
+
251
+ This endpoint does not need any parameter.
252
+
253
+ ### Return type
254
+
255
+ [**Array&lt;EntitlementDetailResponseDto&gt;**](EntitlementDetailResponseDto.md)
256
+
257
+ ### Authorization
258
+
259
+ No authorization required
260
+
261
+ ### HTTP request headers
262
+
263
+ - **Content-Type**: Not defined
264
+ - **Accept**: application/json
265
+
266
+
267
+ ## entitlements_update
268
+
269
+ > <EntitlementDetailResponseDto> entitlements_update(id, update_entitlement_dto)
270
+
271
+ Update Entitlement
272
+
273
+ Update details of an existing independent entitlement.
274
+
275
+ ### Examples
276
+
277
+ ```ruby
278
+ require 'time'
279
+ require 'solifyn'
280
+
281
+ api_instance = Solifyn::EntitlementsApi.new
282
+ id = 'ent_8Z1aB2cD3eF4gH5iJ6kL7m' # String | The unique entitlement ID.
283
+ update_entitlement_dto = Solifyn::UpdateEntitlementDto.new # UpdateEntitlementDto |
284
+
285
+ begin
286
+ # Update Entitlement
287
+ result = api_instance.entitlements_update(id, update_entitlement_dto)
288
+ p result
289
+ rescue Solifyn::ApiError => e
290
+ puts "Error when calling EntitlementsApi->entitlements_update: #{e}"
291
+ end
292
+ ```
293
+
294
+ #### Using the entitlements_update_with_http_info variant
295
+
296
+ This returns an Array which contains the response data, status code and headers.
297
+
298
+ > <Array(<EntitlementDetailResponseDto>, Integer, Hash)> entitlements_update_with_http_info(id, update_entitlement_dto)
299
+
300
+ ```ruby
301
+ begin
302
+ # Update Entitlement
303
+ data, status_code, headers = api_instance.entitlements_update_with_http_info(id, update_entitlement_dto)
304
+ p status_code # => 2xx
305
+ p headers # => { ... }
306
+ p data # => <EntitlementDetailResponseDto>
307
+ rescue Solifyn::ApiError => e
308
+ puts "Error when calling EntitlementsApi->entitlements_update_with_http_info: #{e}"
309
+ end
310
+ ```
311
+
312
+ ### Parameters
313
+
314
+ | Name | Type | Description | Notes |
315
+ | ---- | ---- | ----------- | ----- |
316
+ | **id** | **String** | The unique entitlement ID. | |
317
+ | **update_entitlement_dto** | [**UpdateEntitlementDto**](UpdateEntitlementDto.md) | | |
318
+
319
+ ### Return type
320
+
321
+ [**EntitlementDetailResponseDto**](EntitlementDetailResponseDto.md)
322
+
323
+ ### Authorization
324
+
325
+ No authorization required
326
+
327
+ ### HTTP request headers
328
+
329
+ - **Content-Type**: application/json
330
+ - **Accept**: application/json
331
+