solifyn 1.0.0 → 1.0.5
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.
- checksums.yaml +4 -4
- data/README.md +20 -7
- data/docs/BalanceApi.md +1 -1
- data/docs/CheckoutApi.md +1 -1
- data/docs/CheckoutLinksApi.md +1 -1
- data/docs/CheckoutSessionDetailsDto.md +3 -1
- data/docs/CollectionProductDto.md +12 -0
- data/docs/CollectionsApi.md +1 -1
- data/docs/CustomersApi.md +1 -1
- data/docs/DefaultApi.md +285 -1
- data/docs/DeveloperApi.md +1 -1
- data/docs/DigitalFileApi.md +1 -1
- data/docs/DiscordIntegrationApi.md +135 -0
- data/docs/DiscordRolesResponseDto.md +24 -0
- data/docs/DiscountsApi.md +1 -1
- data/docs/DisputesApi.md +1 -1
- data/docs/EntitlementGrantResponseDto.md +54 -0
- data/docs/EntitlementGrantsApi.md +289 -0
- data/docs/GitHubIntegrationApi.md +145 -0
- data/docs/GithubReposResponseDto.md +22 -0
- data/docs/LicenseApi.md +1 -1
- data/docs/LicenseKeysApi.md +1 -1
- data/docs/LicenseKeysClientApi.md +1 -1
- data/docs/MetersApi.md +1 -1
- data/docs/OrdersApi.md +1 -1
- data/docs/Product.md +12 -0
- data/docs/ProductAddOnsApi.md +1 -1
- data/docs/ProductCreate.md +12 -0
- data/docs/ProductUpdate.md +12 -0
- data/docs/ProductsApi.md +1 -1
- data/docs/RefundRequestsApi.md +1 -1
- data/docs/RefundsChargebacksApi.md +1 -1
- data/docs/SubscriptionsApi.md +1 -1
- data/docs/SyncLoginDto.md +18 -0
- data/docs/WebhookApi.md +1 -1
- data/docs/WebhookEndpointApi.md +55 -10
- data/docs/WebhookEntitlementGrantPayload.md +44 -0
- data/git_push.sh +2 -2
- data/lib/solifyn/api/default_api.rb +248 -0
- data/lib/solifyn/api/{partner_api.rb → discord_integration_api.rb} +32 -19
- data/lib/solifyn/api/entitlement_grants_api.rb +271 -0
- data/lib/solifyn/api/git_hub_integration_api.rb +137 -0
- data/lib/solifyn/api/webhook_endpoint_api.rb +9 -9
- data/lib/solifyn/configuration.rb +4 -4
- data/lib/solifyn/models/checkout_session_details_dto.rb +16 -4
- data/lib/solifyn/models/collection_product_dto.rb +115 -1
- data/lib/solifyn/models/{payout_method.rb → discord_roles_response_dto.rb} +41 -34
- data/lib/solifyn/models/{withdrawal.rb → entitlement_grant_response_dto.rb} +149 -109
- data/lib/solifyn/models/{payout_account.rb → github_repos_response_dto.rb} +31 -24
- data/lib/solifyn/models/product.rb +115 -1
- data/lib/solifyn/models/product_create.rb +77 -1
- data/lib/solifyn/models/product_update.rb +77 -1
- data/lib/solifyn/models/{payout_method_list.rb → sync_login_dto.rb} +15 -17
- data/lib/solifyn/models/{payout_verification.rb → webhook_entitlement_grant_payload.rb} +118 -41
- data/lib/solifyn/version.rb +1 -1
- data/lib/solifyn.rb +8 -0
- data/spec/api/checkout_api_spec.rb +12 -0
- data/spec/api/default_api_spec.rb +59 -11
- data/spec/api/developer_api_spec.rb +52 -29
- data/spec/api/{partner_api_spec.rb → discord_integration_api_spec.rb} +16 -11
- data/spec/api/entitlement_grants_api_spec.rb +83 -0
- data/spec/api/git_hub_integration_api_spec.rb +58 -0
- data/spec/models/checkout_session_details_dto_spec.rb +6 -0
- data/spec/models/collection_product_dto_spec.rb +28 -0
- data/spec/models/{payout_method_spec.rb → discord_roles_response_dto_spec.rb} +9 -9
- data/spec/models/{withdrawal_spec.rb → entitlement_grant_response_dto_spec.rb} +18 -18
- data/spec/models/{payout_account_spec.rb → github_repos_response_dto_spec.rb} +8 -8
- data/spec/models/order_spec.rb +6 -0
- data/spec/models/product_create_spec.rb +28 -0
- data/spec/models/product_spec.rb +28 -0
- data/spec/models/product_update_spec.rb +28 -0
- data/spec/models/{business_create_spec.rb → sync_login_dto_spec.rb} +7 -7
- data/spec/models/{business_spec.rb → webhook_entitlement_grant_payload_spec.rb} +17 -53
- metadata +162 -254
- data/docs/AffiliateApi.md +0 -845
- data/docs/BillingApi.md +0 -68
- data/docs/BrandsApi.md +0 -286
- data/docs/Business.md +0 -56
- data/docs/BusinessCreate.md +0 -18
- data/docs/BusinessFullCreate.md +0 -26
- data/docs/BusinessFullCreateResponse.md +0 -20
- data/docs/BusinessesApi.md +0 -350
- data/docs/ChatApi.md +0 -246
- data/docs/CommunityApi.md +0 -497
- data/docs/PartnerApi.md +0 -125
- data/docs/PayoutAccessToken.md +0 -20
- data/docs/PayoutAccount.md +0 -22
- data/docs/PayoutAccountLink.md +0 -20
- data/docs/PayoutMethod.md +0 -24
- data/docs/PayoutMethodList.md +0 -18
- data/docs/PayoutVerification.md +0 -24
- data/docs/PayoutVerificationList.md +0 -18
- data/docs/PayoutsApi.md +0 -579
- data/docs/TicketApi.md +0 -318
- data/docs/UserPage.md +0 -26
- data/docs/UserProfileThemesApi.md +0 -345
- data/docs/UserSettings.md +0 -34
- data/docs/UserSettingsUpdate.md +0 -76
- data/docs/UserStats.md +0 -20
- data/docs/UserTheme.md +0 -26
- data/docs/UserThemeUpdate.md +0 -22
- data/docs/WhopApiKeysRotation.md +0 -18
- data/docs/Withdrawal.md +0 -46
- data/docs/WithdrawalCreate.md +0 -22
- data/docs/WithdrawalList.md +0 -20
- data/lib/solifyn/api/affiliate_api.rb +0 -760
- data/lib/solifyn/api/billing_api.rb +0 -77
- data/lib/solifyn/api/brands_api.rb +0 -284
- data/lib/solifyn/api/businesses_api.rb +0 -338
- data/lib/solifyn/api/chat_api.rb +0 -232
- data/lib/solifyn/api/community_api.rb +0 -466
- data/lib/solifyn/api/payouts_api.rb +0 -520
- data/lib/solifyn/api/ticket_api.rb +0 -328
- data/lib/solifyn/api/user_profile_themes_api.rb +0 -313
- data/lib/solifyn/models/business.rb +0 -482
- data/lib/solifyn/models/business_create.rb +0 -241
- data/lib/solifyn/models/business_full_create.rb +0 -288
- data/lib/solifyn/models/business_full_create_response.rb +0 -239
- data/lib/solifyn/models/payout_access_token.rb +0 -239
- data/lib/solifyn/models/payout_account_link.rb +0 -239
- data/lib/solifyn/models/payout_verification_list.rb +0 -224
- data/lib/solifyn/models/user_page.rb +0 -290
- data/lib/solifyn/models/user_settings.rb +0 -337
- data/lib/solifyn/models/user_settings_update.rb +0 -505
- data/lib/solifyn/models/user_stats.rb +0 -241
- data/lib/solifyn/models/user_theme.rb +0 -276
- data/lib/solifyn/models/user_theme_update.rb +0 -235
- data/lib/solifyn/models/whop_api_keys_rotation.rb +0 -222
- data/lib/solifyn/models/withdrawal_create.rb +0 -249
- data/lib/solifyn/models/withdrawal_list.rb +0 -241
- data/spec/api/affiliate_api_spec.rb +0 -165
- data/spec/api/billing_api_spec.rb +0 -46
- data/spec/api/brands_api_spec.rb +0 -83
- data/spec/api/businesses_api_spec.rb +0 -93
- data/spec/api/chat_api_spec.rb +0 -72
- data/spec/api/community_api_spec.rb +0 -113
- data/spec/api/payouts_api_spec.rb +0 -133
- data/spec/api/ticket_api_spec.rb +0 -86
- data/spec/api/user_profile_themes_api_spec.rb +0 -91
- data/spec/models/business_full_create_response_spec.rb +0 -42
- data/spec/models/business_full_create_spec.rb +0 -60
- data/spec/models/payout_access_token_spec.rb +0 -42
- data/spec/models/payout_account_link_spec.rb +0 -42
- data/spec/models/payout_method_list_spec.rb +0 -36
- data/spec/models/payout_verification_list_spec.rb +0 -36
- data/spec/models/payout_verification_spec.rb +0 -54
- data/spec/models/user_page_spec.rb +0 -60
- data/spec/models/user_settings_spec.rb +0 -84
- data/spec/models/user_settings_update_spec.rb +0 -210
- data/spec/models/user_stats_spec.rb +0 -42
- data/spec/models/user_theme_spec.rb +0 -60
- data/spec/models/user_theme_update_spec.rb +0 -48
- data/spec/models/whop_api_keys_rotation_spec.rb +0 -36
- data/spec/models/withdrawal_create_spec.rb +0 -48
- data/spec/models/withdrawal_list_spec.rb +0 -42
data/docs/DiscountsApi.md
CHANGED
data/docs/DisputesApi.md
CHANGED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# Solifyn::EntitlementGrantResponseDto
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | The unique entitlement grant ID. | |
|
|
8
|
+
| **business_id** | **String** | The business ID context. | |
|
|
9
|
+
| **customer_id** | **String** | The customer ID. | |
|
|
10
|
+
| **payment_id** | **String** | Associated payment transaction ID. | [optional] |
|
|
11
|
+
| **product_id** | **String** | The purchased product ID. | |
|
|
12
|
+
| **type** | **String** | The type of entitlement (e.g. GITHUB, DISCORD, TELEGRAM). | |
|
|
13
|
+
| **github_repo** | **String** | Target GitHub repository (owner/repo) if type is GITHUB. | [optional] |
|
|
14
|
+
| **github_permission** | **String** | GitHub access permission level if type is GITHUB. | [optional] |
|
|
15
|
+
| **github_username** | **String** | The connected customer GitHub username. | [optional] |
|
|
16
|
+
| **discord_guild_id** | **String** | Target Discord Guild ID if type is DISCORD. | [optional] |
|
|
17
|
+
| **discord_role_id** | **String** | Target Discord Role ID if type is DISCORD. | [optional] |
|
|
18
|
+
| **discord_username** | **String** | The connected customer Discord username. | [optional] |
|
|
19
|
+
| **discord_user_id** | **String** | The connected customer Discord user ID. | [optional] |
|
|
20
|
+
| **status** | **String** | Delivery status of the collaborator invite (PENDING, DELIVERED, FAILED, REVOKED). | |
|
|
21
|
+
| **oauth_url** | **String** | OAuth URL to redirect the customer to. | [optional] |
|
|
22
|
+
| **error_details** | **String** | Error message if invitation delivery failed. | [optional] |
|
|
23
|
+
| **metadata** | **Object** | Platform-specific metadata. | [optional] |
|
|
24
|
+
| **created_at** | **String** | Creation timestamp. | |
|
|
25
|
+
| **updated_at** | **String** | Modification timestamp. | |
|
|
26
|
+
|
|
27
|
+
## Example
|
|
28
|
+
|
|
29
|
+
```ruby
|
|
30
|
+
require 'solifyn'
|
|
31
|
+
|
|
32
|
+
instance = Solifyn::EntitlementGrantResponseDto.new(
|
|
33
|
+
id: grant_123456,
|
|
34
|
+
business_id: biz_123456,
|
|
35
|
+
customer_id: cust_123456,
|
|
36
|
+
payment_id: pay_123456,
|
|
37
|
+
product_id: prod_123456,
|
|
38
|
+
type: GITHUB,
|
|
39
|
+
github_repo: solifyn/premium-app,
|
|
40
|
+
github_permission: pull,
|
|
41
|
+
github_username: octocat,
|
|
42
|
+
discord_guild_id: 123456789012345678,
|
|
43
|
+
discord_role_id: 876543210987654321,
|
|
44
|
+
discord_username: discorduser#1234,
|
|
45
|
+
discord_user_id: 112233445566778899,
|
|
46
|
+
status: PENDING,
|
|
47
|
+
oauth_url: https://github.com/login/oauth/authorize...,
|
|
48
|
+
error_details: Permission denied,
|
|
49
|
+
metadata: null,
|
|
50
|
+
created_at: null,
|
|
51
|
+
updated_at: null
|
|
52
|
+
)
|
|
53
|
+
```
|
|
54
|
+
|
|
@@ -0,0 +1,289 @@
|
|
|
1
|
+
# Solifyn::EntitlementGrantsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.solifyn.com*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**entitlement_grants_get**](EntitlementGrantsApi.md#entitlement_grants_get) | **GET** /v1/entitlement-grants/{id} | Retrieve Entitlement Grant |
|
|
8
|
+
| [**entitlement_grants_list**](EntitlementGrantsApi.md#entitlement_grants_list) | **GET** /v1/entitlement-grants | List Entitlement Grants |
|
|
9
|
+
| [**entitlement_grants_retry**](EntitlementGrantsApi.md#entitlement_grants_retry) | **POST** /v1/entitlement-grants/{id}/retry | Retry Entitlement Grant Delivery |
|
|
10
|
+
| [**entitlement_grants_revoke**](EntitlementGrantsApi.md#entitlement_grants_revoke) | **POST** /v1/entitlement-grants/{id}/revoke | Manually Revoke Entitlement Grant |
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
## entitlement_grants_get
|
|
14
|
+
|
|
15
|
+
> <EntitlementGrantResponseDto> entitlement_grants_get(id)
|
|
16
|
+
|
|
17
|
+
Retrieve Entitlement Grant
|
|
18
|
+
|
|
19
|
+
Retrieve details of a specific entitlement grant.
|
|
20
|
+
|
|
21
|
+
### Examples
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'time'
|
|
25
|
+
require 'solifyn'
|
|
26
|
+
# setup authorization
|
|
27
|
+
Solifyn.configure do |config|
|
|
28
|
+
# Configure Bearer authorization (API Key): ApiKeyAuth
|
|
29
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
api_instance = Solifyn::EntitlementGrantsApi.new
|
|
33
|
+
id = 'id_example' # String | The unique grant ID
|
|
34
|
+
|
|
35
|
+
begin
|
|
36
|
+
# Retrieve Entitlement Grant
|
|
37
|
+
result = api_instance.entitlement_grants_get(id)
|
|
38
|
+
p result
|
|
39
|
+
rescue Solifyn::ApiError => e
|
|
40
|
+
puts "Error when calling EntitlementGrantsApi->entitlement_grants_get: #{e}"
|
|
41
|
+
end
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
#### Using the entitlement_grants_get_with_http_info variant
|
|
45
|
+
|
|
46
|
+
This returns an Array which contains the response data, status code and headers.
|
|
47
|
+
|
|
48
|
+
> <Array(<EntitlementGrantResponseDto>, Integer, Hash)> entitlement_grants_get_with_http_info(id)
|
|
49
|
+
|
|
50
|
+
```ruby
|
|
51
|
+
begin
|
|
52
|
+
# Retrieve Entitlement Grant
|
|
53
|
+
data, status_code, headers = api_instance.entitlement_grants_get_with_http_info(id)
|
|
54
|
+
p status_code # => 2xx
|
|
55
|
+
p headers # => { ... }
|
|
56
|
+
p data # => <EntitlementGrantResponseDto>
|
|
57
|
+
rescue Solifyn::ApiError => e
|
|
58
|
+
puts "Error when calling EntitlementGrantsApi->entitlement_grants_get_with_http_info: #{e}"
|
|
59
|
+
end
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Parameters
|
|
63
|
+
|
|
64
|
+
| Name | Type | Description | Notes |
|
|
65
|
+
| ---- | ---- | ----------- | ----- |
|
|
66
|
+
| **id** | **String** | The unique grant ID | |
|
|
67
|
+
|
|
68
|
+
### Return type
|
|
69
|
+
|
|
70
|
+
[**EntitlementGrantResponseDto**](EntitlementGrantResponseDto.md)
|
|
71
|
+
|
|
72
|
+
### Authorization
|
|
73
|
+
|
|
74
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
75
|
+
|
|
76
|
+
### HTTP request headers
|
|
77
|
+
|
|
78
|
+
- **Content-Type**: Not defined
|
|
79
|
+
- **Accept**: application/json
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
## entitlement_grants_list
|
|
83
|
+
|
|
84
|
+
> <Array<EntitlementGrantResponseDto>> entitlement_grants_list(opts)
|
|
85
|
+
|
|
86
|
+
List Entitlement Grants
|
|
87
|
+
|
|
88
|
+
Retrieve all GitHub repository entitlement grants for the active business.
|
|
89
|
+
|
|
90
|
+
### Examples
|
|
91
|
+
|
|
92
|
+
```ruby
|
|
93
|
+
require 'time'
|
|
94
|
+
require 'solifyn'
|
|
95
|
+
# setup authorization
|
|
96
|
+
Solifyn.configure do |config|
|
|
97
|
+
# Configure Bearer authorization (API Key): ApiKeyAuth
|
|
98
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
api_instance = Solifyn::EntitlementGrantsApi.new
|
|
102
|
+
opts = {
|
|
103
|
+
status: 'status_example' # String | Filter by status (PENDING, DELIVERED, FAILED, REVOKED)
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
begin
|
|
107
|
+
# List Entitlement Grants
|
|
108
|
+
result = api_instance.entitlement_grants_list(opts)
|
|
109
|
+
p result
|
|
110
|
+
rescue Solifyn::ApiError => e
|
|
111
|
+
puts "Error when calling EntitlementGrantsApi->entitlement_grants_list: #{e}"
|
|
112
|
+
end
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
#### Using the entitlement_grants_list_with_http_info variant
|
|
116
|
+
|
|
117
|
+
This returns an Array which contains the response data, status code and headers.
|
|
118
|
+
|
|
119
|
+
> <Array(<Array<EntitlementGrantResponseDto>>, Integer, Hash)> entitlement_grants_list_with_http_info(opts)
|
|
120
|
+
|
|
121
|
+
```ruby
|
|
122
|
+
begin
|
|
123
|
+
# List Entitlement Grants
|
|
124
|
+
data, status_code, headers = api_instance.entitlement_grants_list_with_http_info(opts)
|
|
125
|
+
p status_code # => 2xx
|
|
126
|
+
p headers # => { ... }
|
|
127
|
+
p data # => <Array<EntitlementGrantResponseDto>>
|
|
128
|
+
rescue Solifyn::ApiError => e
|
|
129
|
+
puts "Error when calling EntitlementGrantsApi->entitlement_grants_list_with_http_info: #{e}"
|
|
130
|
+
end
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### Parameters
|
|
134
|
+
|
|
135
|
+
| Name | Type | Description | Notes |
|
|
136
|
+
| ---- | ---- | ----------- | ----- |
|
|
137
|
+
| **status** | **String** | Filter by status (PENDING, DELIVERED, FAILED, REVOKED) | [optional] |
|
|
138
|
+
|
|
139
|
+
### Return type
|
|
140
|
+
|
|
141
|
+
[**Array<EntitlementGrantResponseDto>**](EntitlementGrantResponseDto.md)
|
|
142
|
+
|
|
143
|
+
### Authorization
|
|
144
|
+
|
|
145
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
146
|
+
|
|
147
|
+
### HTTP request headers
|
|
148
|
+
|
|
149
|
+
- **Content-Type**: Not defined
|
|
150
|
+
- **Accept**: application/json
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
## entitlement_grants_retry
|
|
154
|
+
|
|
155
|
+
> <EntitlementGrantResponseDto> entitlement_grants_retry(id)
|
|
156
|
+
|
|
157
|
+
Retry Entitlement Grant Delivery
|
|
158
|
+
|
|
159
|
+
Attempts to re-invite the collaborator if GitHub username is already connected, or resets the OAuth URL redirect.
|
|
160
|
+
|
|
161
|
+
### Examples
|
|
162
|
+
|
|
163
|
+
```ruby
|
|
164
|
+
require 'time'
|
|
165
|
+
require 'solifyn'
|
|
166
|
+
# setup authorization
|
|
167
|
+
Solifyn.configure do |config|
|
|
168
|
+
# Configure Bearer authorization (API Key): ApiKeyAuth
|
|
169
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
170
|
+
end
|
|
171
|
+
|
|
172
|
+
api_instance = Solifyn::EntitlementGrantsApi.new
|
|
173
|
+
id = 'id_example' # String | The unique grant ID
|
|
174
|
+
|
|
175
|
+
begin
|
|
176
|
+
# Retry Entitlement Grant Delivery
|
|
177
|
+
result = api_instance.entitlement_grants_retry(id)
|
|
178
|
+
p result
|
|
179
|
+
rescue Solifyn::ApiError => e
|
|
180
|
+
puts "Error when calling EntitlementGrantsApi->entitlement_grants_retry: #{e}"
|
|
181
|
+
end
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
#### Using the entitlement_grants_retry_with_http_info variant
|
|
185
|
+
|
|
186
|
+
This returns an Array which contains the response data, status code and headers.
|
|
187
|
+
|
|
188
|
+
> <Array(<EntitlementGrantResponseDto>, Integer, Hash)> entitlement_grants_retry_with_http_info(id)
|
|
189
|
+
|
|
190
|
+
```ruby
|
|
191
|
+
begin
|
|
192
|
+
# Retry Entitlement Grant Delivery
|
|
193
|
+
data, status_code, headers = api_instance.entitlement_grants_retry_with_http_info(id)
|
|
194
|
+
p status_code # => 2xx
|
|
195
|
+
p headers # => { ... }
|
|
196
|
+
p data # => <EntitlementGrantResponseDto>
|
|
197
|
+
rescue Solifyn::ApiError => e
|
|
198
|
+
puts "Error when calling EntitlementGrantsApi->entitlement_grants_retry_with_http_info: #{e}"
|
|
199
|
+
end
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
### Parameters
|
|
203
|
+
|
|
204
|
+
| Name | Type | Description | Notes |
|
|
205
|
+
| ---- | ---- | ----------- | ----- |
|
|
206
|
+
| **id** | **String** | The unique grant ID | |
|
|
207
|
+
|
|
208
|
+
### Return type
|
|
209
|
+
|
|
210
|
+
[**EntitlementGrantResponseDto**](EntitlementGrantResponseDto.md)
|
|
211
|
+
|
|
212
|
+
### Authorization
|
|
213
|
+
|
|
214
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
215
|
+
|
|
216
|
+
### HTTP request headers
|
|
217
|
+
|
|
218
|
+
- **Content-Type**: Not defined
|
|
219
|
+
- **Accept**: application/json
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
## entitlement_grants_revoke
|
|
223
|
+
|
|
224
|
+
> <EntitlementGrantResponseDto> entitlement_grants_revoke(id)
|
|
225
|
+
|
|
226
|
+
Manually Revoke Entitlement Grant
|
|
227
|
+
|
|
228
|
+
Manually remove the customer collaborator access from the repository and revoke the grant.
|
|
229
|
+
|
|
230
|
+
### Examples
|
|
231
|
+
|
|
232
|
+
```ruby
|
|
233
|
+
require 'time'
|
|
234
|
+
require 'solifyn'
|
|
235
|
+
# setup authorization
|
|
236
|
+
Solifyn.configure do |config|
|
|
237
|
+
# Configure Bearer authorization (API Key): ApiKeyAuth
|
|
238
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
239
|
+
end
|
|
240
|
+
|
|
241
|
+
api_instance = Solifyn::EntitlementGrantsApi.new
|
|
242
|
+
id = 'id_example' # String | The unique grant ID
|
|
243
|
+
|
|
244
|
+
begin
|
|
245
|
+
# Manually Revoke Entitlement Grant
|
|
246
|
+
result = api_instance.entitlement_grants_revoke(id)
|
|
247
|
+
p result
|
|
248
|
+
rescue Solifyn::ApiError => e
|
|
249
|
+
puts "Error when calling EntitlementGrantsApi->entitlement_grants_revoke: #{e}"
|
|
250
|
+
end
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
#### Using the entitlement_grants_revoke_with_http_info variant
|
|
254
|
+
|
|
255
|
+
This returns an Array which contains the response data, status code and headers.
|
|
256
|
+
|
|
257
|
+
> <Array(<EntitlementGrantResponseDto>, Integer, Hash)> entitlement_grants_revoke_with_http_info(id)
|
|
258
|
+
|
|
259
|
+
```ruby
|
|
260
|
+
begin
|
|
261
|
+
# Manually Revoke Entitlement Grant
|
|
262
|
+
data, status_code, headers = api_instance.entitlement_grants_revoke_with_http_info(id)
|
|
263
|
+
p status_code # => 2xx
|
|
264
|
+
p headers # => { ... }
|
|
265
|
+
p data # => <EntitlementGrantResponseDto>
|
|
266
|
+
rescue Solifyn::ApiError => e
|
|
267
|
+
puts "Error when calling EntitlementGrantsApi->entitlement_grants_revoke_with_http_info: #{e}"
|
|
268
|
+
end
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
### Parameters
|
|
272
|
+
|
|
273
|
+
| Name | Type | Description | Notes |
|
|
274
|
+
| ---- | ---- | ----------- | ----- |
|
|
275
|
+
| **id** | **String** | The unique grant ID | |
|
|
276
|
+
|
|
277
|
+
### Return type
|
|
278
|
+
|
|
279
|
+
[**EntitlementGrantResponseDto**](EntitlementGrantResponseDto.md)
|
|
280
|
+
|
|
281
|
+
### Authorization
|
|
282
|
+
|
|
283
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
284
|
+
|
|
285
|
+
### HTTP request headers
|
|
286
|
+
|
|
287
|
+
- **Content-Type**: Not defined
|
|
288
|
+
- **Accept**: application/json
|
|
289
|
+
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
# Solifyn::GitHubIntegrationApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.solifyn.com*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**github_get_install_url**](GitHubIntegrationApi.md#github_get_install_url) | **GET** /v1/github/install | Get GitHub App Installation URL |
|
|
8
|
+
| [**github_list_repos**](GitHubIntegrationApi.md#github_list_repos) | **GET** /v1/github/repos | List Available GitHub Repositories |
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## github_get_install_url
|
|
12
|
+
|
|
13
|
+
> github_get_install_url(opts)
|
|
14
|
+
|
|
15
|
+
Get GitHub App Installation URL
|
|
16
|
+
|
|
17
|
+
Generates the URL to install the system-wide GitHub App onto the merchant's GitHub account/org.
|
|
18
|
+
|
|
19
|
+
### Examples
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'time'
|
|
23
|
+
require 'solifyn'
|
|
24
|
+
# setup authorization
|
|
25
|
+
Solifyn.configure do |config|
|
|
26
|
+
# Configure Bearer authorization (API Key): ApiKeyAuth
|
|
27
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
api_instance = Solifyn::GitHubIntegrationApi.new
|
|
31
|
+
opts = {
|
|
32
|
+
product_id: 'product_id_example' # String | Optional Product ID to redirect back to after installation
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
begin
|
|
36
|
+
# Get GitHub App Installation URL
|
|
37
|
+
api_instance.github_get_install_url(opts)
|
|
38
|
+
rescue Solifyn::ApiError => e
|
|
39
|
+
puts "Error when calling GitHubIntegrationApi->github_get_install_url: #{e}"
|
|
40
|
+
end
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
#### Using the github_get_install_url_with_http_info variant
|
|
44
|
+
|
|
45
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
46
|
+
|
|
47
|
+
> <Array(nil, Integer, Hash)> github_get_install_url_with_http_info(opts)
|
|
48
|
+
|
|
49
|
+
```ruby
|
|
50
|
+
begin
|
|
51
|
+
# Get GitHub App Installation URL
|
|
52
|
+
data, status_code, headers = api_instance.github_get_install_url_with_http_info(opts)
|
|
53
|
+
p status_code # => 2xx
|
|
54
|
+
p headers # => { ... }
|
|
55
|
+
p data # => nil
|
|
56
|
+
rescue Solifyn::ApiError => e
|
|
57
|
+
puts "Error when calling GitHubIntegrationApi->github_get_install_url_with_http_info: #{e}"
|
|
58
|
+
end
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### Parameters
|
|
62
|
+
|
|
63
|
+
| Name | Type | Description | Notes |
|
|
64
|
+
| ---- | ---- | ----------- | ----- |
|
|
65
|
+
| **product_id** | **String** | Optional Product ID to redirect back to after installation | [optional] |
|
|
66
|
+
|
|
67
|
+
### Return type
|
|
68
|
+
|
|
69
|
+
nil (empty response body)
|
|
70
|
+
|
|
71
|
+
### Authorization
|
|
72
|
+
|
|
73
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
74
|
+
|
|
75
|
+
### HTTP request headers
|
|
76
|
+
|
|
77
|
+
- **Content-Type**: Not defined
|
|
78
|
+
- **Accept**: Not defined
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
## github_list_repos
|
|
82
|
+
|
|
83
|
+
> <Array<GithubReposResponseDto>> github_list_repos
|
|
84
|
+
|
|
85
|
+
List Available GitHub Repositories
|
|
86
|
+
|
|
87
|
+
Retrieves all repositories accessible by the merchant's installed GitHub App.
|
|
88
|
+
|
|
89
|
+
### Examples
|
|
90
|
+
|
|
91
|
+
```ruby
|
|
92
|
+
require 'time'
|
|
93
|
+
require 'solifyn'
|
|
94
|
+
# setup authorization
|
|
95
|
+
Solifyn.configure do |config|
|
|
96
|
+
# Configure Bearer authorization (API Key): ApiKeyAuth
|
|
97
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
98
|
+
end
|
|
99
|
+
|
|
100
|
+
api_instance = Solifyn::GitHubIntegrationApi.new
|
|
101
|
+
|
|
102
|
+
begin
|
|
103
|
+
# List Available GitHub Repositories
|
|
104
|
+
result = api_instance.github_list_repos
|
|
105
|
+
p result
|
|
106
|
+
rescue Solifyn::ApiError => e
|
|
107
|
+
puts "Error when calling GitHubIntegrationApi->github_list_repos: #{e}"
|
|
108
|
+
end
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
#### Using the github_list_repos_with_http_info variant
|
|
112
|
+
|
|
113
|
+
This returns an Array which contains the response data, status code and headers.
|
|
114
|
+
|
|
115
|
+
> <Array(<Array<GithubReposResponseDto>>, Integer, Hash)> github_list_repos_with_http_info
|
|
116
|
+
|
|
117
|
+
```ruby
|
|
118
|
+
begin
|
|
119
|
+
# List Available GitHub Repositories
|
|
120
|
+
data, status_code, headers = api_instance.github_list_repos_with_http_info
|
|
121
|
+
p status_code # => 2xx
|
|
122
|
+
p headers # => { ... }
|
|
123
|
+
p data # => <Array<GithubReposResponseDto>>
|
|
124
|
+
rescue Solifyn::ApiError => e
|
|
125
|
+
puts "Error when calling GitHubIntegrationApi->github_list_repos_with_http_info: #{e}"
|
|
126
|
+
end
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### Parameters
|
|
130
|
+
|
|
131
|
+
This endpoint does not need any parameter.
|
|
132
|
+
|
|
133
|
+
### Return type
|
|
134
|
+
|
|
135
|
+
[**Array<GithubReposResponseDto>**](GithubReposResponseDto.md)
|
|
136
|
+
|
|
137
|
+
### Authorization
|
|
138
|
+
|
|
139
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
140
|
+
|
|
141
|
+
### HTTP request headers
|
|
142
|
+
|
|
143
|
+
- **Content-Type**: Not defined
|
|
144
|
+
- **Accept**: application/json
|
|
145
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Solifyn::GithubReposResponseDto
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **Float** | The GitHub repository ID | |
|
|
8
|
+
| **full_name** | **String** | The repository full name (owner/repo) | |
|
|
9
|
+
| **name** | **String** | The repository name | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'solifyn'
|
|
15
|
+
|
|
16
|
+
instance = Solifyn::GithubReposResponseDto.new(
|
|
17
|
+
id: 12345678,
|
|
18
|
+
full_name: solifyn/premium-app,
|
|
19
|
+
name: premium-app
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/LicenseApi.md
CHANGED
data/docs/LicenseKeysApi.md
CHANGED
data/docs/MetersApi.md
CHANGED
data/docs/OrdersApi.md
CHANGED
data/docs/Product.md
CHANGED
|
@@ -16,6 +16,12 @@
|
|
|
16
16
|
| **discount** | **Float** | Discount value as a percentage or fixed amount. | |
|
|
17
17
|
| **has_license_key** | **Boolean** | Indicates if the product issues a cryptographically secure software license key upon checkout completion. | |
|
|
18
18
|
| **has_digital_delivery** | **Boolean** | Whether the product includes digital file downloads upon purchase. | |
|
|
19
|
+
| **has_github_access** | **Boolean** | Whether the product includes GitHub repository access. | |
|
|
20
|
+
| **github_repo** | **String** | GitHub repository to grant access to (format: owner/repo). | |
|
|
21
|
+
| **github_permission** | **String** | GitHub collaborator permission level. | |
|
|
22
|
+
| **has_discord_access** | **Boolean** | Whether the product includes Discord role access. | |
|
|
23
|
+
| **discord_guild_id** | **String** | Discord Guild (Server) ID to grant access to. | |
|
|
24
|
+
| **discord_role_id** | **String** | Discord Role ID to assign to the user. | |
|
|
19
25
|
| **is_tax_inclusive** | **Boolean** | Whether the product price already includes applicable sales taxes. | |
|
|
20
26
|
| **billing_period** | **Integer** | The subscription billing cycle interval in days (for subscription products). | |
|
|
21
27
|
| **trial_period_days** | **Integer** | Trial duration in days for subscription products. | |
|
|
@@ -56,6 +62,12 @@ instance = Solifyn::Product.new(
|
|
|
56
62
|
discount: 0,
|
|
57
63
|
has_license_key: true,
|
|
58
64
|
has_digital_delivery: false,
|
|
65
|
+
has_github_access: false,
|
|
66
|
+
github_repo: solifyn/premium-app,
|
|
67
|
+
github_permission: pull,
|
|
68
|
+
has_discord_access: false,
|
|
69
|
+
discord_guild_id: 123456789012345678,
|
|
70
|
+
discord_role_id: 876543210987654321,
|
|
59
71
|
is_tax_inclusive: false,
|
|
60
72
|
billing_period: null,
|
|
61
73
|
trial_period_days: null,
|
data/docs/ProductAddOnsApi.md
CHANGED
data/docs/ProductCreate.md
CHANGED
|
@@ -13,6 +13,12 @@
|
|
|
13
13
|
| **discount** | **Float** | Percentage or flat rate discount. | [optional] |
|
|
14
14
|
| **has_license_key** | **Boolean** | Whether to automatically issue license keys upon successful orders. | [optional][default to false] |
|
|
15
15
|
| **has_digital_delivery** | **Boolean** | Whether the purchase includes downloadable files. | [optional][default to false] |
|
|
16
|
+
| **has_github_access** | **Boolean** | Whether the purchase includes GitHub repository access. | [optional][default to false] |
|
|
17
|
+
| **github_repo** | **String** | GitHub repository to grant access to (format: owner/repo). | [optional] |
|
|
18
|
+
| **github_permission** | **String** | GitHub collaborator permission level. | [optional] |
|
|
19
|
+
| **has_discord_access** | **Boolean** | Whether the purchase includes Discord server role access. | [optional][default to false] |
|
|
20
|
+
| **discord_guild_id** | **String** | Discord Guild (Server) ID to grant access to. | [optional] |
|
|
21
|
+
| **discord_role_id** | **String** | Discord Role ID to assign to the user. | [optional] |
|
|
16
22
|
| **is_tax_inclusive** | **Boolean** | Whether tax is included in the base price. | [optional][default to false] |
|
|
17
23
|
| **activation_limit** | **Integer** | Maximum concurrent activated instances allowed per license key. | [optional] |
|
|
18
24
|
| **brand_id** | **String** | Brand id for the product, if not provided will default to primary brand. | [optional] |
|
|
@@ -43,6 +49,12 @@ instance = Solifyn::ProductCreate.new(
|
|
|
43
49
|
discount: 0,
|
|
44
50
|
has_license_key: false,
|
|
45
51
|
has_digital_delivery: false,
|
|
52
|
+
has_github_access: false,
|
|
53
|
+
github_repo: solifyn/premium-app,
|
|
54
|
+
github_permission: pull,
|
|
55
|
+
has_discord_access: false,
|
|
56
|
+
discord_guild_id: 123456789012345678,
|
|
57
|
+
discord_role_id: 876543210987654321,
|
|
46
58
|
is_tax_inclusive: false,
|
|
47
59
|
activation_limit: null,
|
|
48
60
|
brand_id: brd_4e29285b8sdf34ff51e07d4,
|
data/docs/ProductUpdate.md
CHANGED
|
@@ -13,6 +13,12 @@
|
|
|
13
13
|
| **discount** | **Float** | Percentage or flat rate discount. | [optional] |
|
|
14
14
|
| **has_license_key** | **Boolean** | Whether to automatically issue license keys upon successful orders. | [optional][default to false] |
|
|
15
15
|
| **has_digital_delivery** | **Boolean** | Whether the purchase includes downloadable files. | [optional][default to false] |
|
|
16
|
+
| **has_github_access** | **Boolean** | Whether the purchase includes GitHub repository access. | [optional][default to false] |
|
|
17
|
+
| **github_repo** | **String** | GitHub repository to grant access to (format: owner/repo). | [optional] |
|
|
18
|
+
| **github_permission** | **String** | GitHub collaborator permission level. | [optional] |
|
|
19
|
+
| **has_discord_access** | **Boolean** | Whether the purchase includes Discord server role access. | [optional][default to false] |
|
|
20
|
+
| **discord_guild_id** | **String** | Discord Guild (Server) ID to grant access to. | [optional] |
|
|
21
|
+
| **discord_role_id** | **String** | Discord Role ID to assign to the user. | [optional] |
|
|
16
22
|
| **is_tax_inclusive** | **Boolean** | Whether tax is included in the base price. | [optional][default to false] |
|
|
17
23
|
| **activation_limit** | **Integer** | Maximum concurrent activated instances allowed per license key. | [optional] |
|
|
18
24
|
| **brand_id** | **String** | Brand id for the product, if not provided will default to primary brand. | [optional] |
|
|
@@ -43,6 +49,12 @@ instance = Solifyn::ProductUpdate.new(
|
|
|
43
49
|
discount: 0,
|
|
44
50
|
has_license_key: false,
|
|
45
51
|
has_digital_delivery: false,
|
|
52
|
+
has_github_access: false,
|
|
53
|
+
github_repo: solifyn/premium-app,
|
|
54
|
+
github_permission: pull,
|
|
55
|
+
has_discord_access: false,
|
|
56
|
+
discord_guild_id: 123456789012345678,
|
|
57
|
+
discord_role_id: 876543210987654321,
|
|
46
58
|
is_tax_inclusive: false,
|
|
47
59
|
activation_limit: null,
|
|
48
60
|
brand_id: brd_4e29285b8sdf34ff51e07d4,
|
data/docs/ProductsApi.md
CHANGED
data/docs/RefundRequestsApi.md
CHANGED