solifyn 1.0.5 → 1.0.7
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/LICENSE +202 -0
- data/README.md +6 -10
- data/docs/AffiliateApi.md +845 -0
- data/docs/BillingApi.md +68 -0
- data/docs/BrandsApi.md +286 -0
- data/docs/Business.md +56 -0
- data/docs/BusinessCreate.md +18 -0
- data/docs/BusinessFullCreate.md +26 -0
- data/docs/BusinessFullCreateResponse.md +20 -0
- data/docs/BusinessesApi.md +350 -0
- data/docs/ChatApi.md +246 -0
- data/docs/CollectionProductDto.md +0 -6
- data/docs/CommunityApi.md +497 -0
- data/docs/DefaultApi.md +0 -284
- data/docs/EntitlementGrantResponseDto.md +0 -8
- data/docs/PartnerApi.md +125 -0
- data/docs/PayoutAccessToken.md +20 -0
- data/docs/PayoutAccount.md +22 -0
- data/docs/PayoutAccountLink.md +20 -0
- data/docs/PayoutMethod.md +24 -0
- data/docs/PayoutMethodList.md +18 -0
- data/docs/PayoutVerification.md +24 -0
- data/docs/PayoutVerificationList.md +18 -0
- data/docs/PayoutsApi.md +579 -0
- data/docs/Product.md +0 -6
- data/docs/ProductCreate.md +0 -6
- data/docs/ProductUpdate.md +0 -6
- data/docs/TicketApi.md +318 -0
- data/docs/UserPage.md +26 -0
- data/docs/UserProfileThemesApi.md +345 -0
- data/docs/UserSettings.md +34 -0
- data/docs/UserSettingsUpdate.md +76 -0
- data/docs/UserStats.md +20 -0
- data/docs/UserTheme.md +26 -0
- data/docs/UserThemeUpdate.md +22 -0
- data/docs/WhopApiKeysRotation.md +18 -0
- data/docs/Withdrawal.md +46 -0
- data/docs/WithdrawalCreate.md +22 -0
- data/docs/WithdrawalList.md +20 -0
- data/git_push.sh +2 -2
- data/lib/solifyn/api/affiliate_api.rb +760 -0
- data/lib/solifyn/api/billing_api.rb +77 -0
- data/lib/solifyn/api/brands_api.rb +284 -0
- data/lib/solifyn/api/businesses_api.rb +338 -0
- data/lib/solifyn/api/chat_api.rb +232 -0
- data/lib/solifyn/api/community_api.rb +466 -0
- data/lib/solifyn/api/default_api.rb +0 -248
- data/lib/solifyn/api/{discord_integration_api.rb → partner_api.rb} +19 -32
- data/lib/solifyn/api/payouts_api.rb +520 -0
- data/lib/solifyn/api/ticket_api.rb +328 -0
- data/lib/solifyn/api/user_profile_themes_api.rb +313 -0
- data/lib/solifyn/models/business.rb +482 -0
- data/lib/solifyn/models/business_create.rb +241 -0
- data/lib/solifyn/models/business_full_create.rb +288 -0
- data/lib/solifyn/models/business_full_create_response.rb +239 -0
- data/lib/solifyn/models/collection_product_dto.rb +1 -52
- data/lib/solifyn/models/entitlement_grant_response_dto.rb +1 -41
- data/lib/solifyn/models/payout_access_token.rb +239 -0
- data/lib/solifyn/models/payout_account.rb +249 -0
- data/lib/solifyn/models/payout_account_link.rb +239 -0
- data/lib/solifyn/models/{discord_roles_response_dto.rb → payout_method.rb} +34 -41
- data/lib/solifyn/models/payout_method_list.rb +224 -0
- data/lib/solifyn/models/{webhook_entitlement_grant_payload.rb → payout_verification.rb} +41 -118
- data/lib/solifyn/models/payout_verification_list.rb +224 -0
- data/lib/solifyn/models/product.rb +1 -52
- data/lib/solifyn/models/product_create.rb +1 -33
- data/lib/solifyn/models/product_update.rb +1 -33
- data/lib/solifyn/models/user_page.rb +290 -0
- data/lib/solifyn/models/user_settings.rb +337 -0
- data/lib/solifyn/models/user_settings_update.rb +505 -0
- data/lib/solifyn/models/user_stats.rb +241 -0
- data/lib/solifyn/models/user_theme.rb +276 -0
- data/lib/solifyn/models/user_theme_update.rb +235 -0
- data/lib/solifyn/models/whop_api_keys_rotation.rb +222 -0
- data/lib/solifyn/models/withdrawal.rb +411 -0
- data/lib/solifyn/models/withdrawal_create.rb +249 -0
- data/lib/solifyn/models/withdrawal_list.rb +241 -0
- data/lib/solifyn/version.rb +1 -1
- data/lib/solifyn.rb +0 -3
- data/spec/api/affiliate_api_spec.rb +165 -0
- data/spec/api/billing_api_spec.rb +46 -0
- data/spec/api/brands_api_spec.rb +83 -0
- data/spec/api/businesses_api_spec.rb +93 -0
- data/spec/api/chat_api_spec.rb +72 -0
- data/spec/api/checkout_api_spec.rb +0 -12
- data/spec/api/community_api_spec.rb +113 -0
- data/spec/api/default_api_spec.rb +11 -59
- data/spec/api/developer_api_spec.rb +29 -52
- data/spec/api/{discord_integration_api_spec.rb → partner_api_spec.rb} +11 -16
- data/spec/api/payouts_api_spec.rb +133 -0
- data/spec/api/ticket_api_spec.rb +86 -0
- data/spec/api/user_profile_themes_api_spec.rb +91 -0
- data/spec/models/business_create_spec.rb +36 -0
- data/spec/models/business_full_create_response_spec.rb +42 -0
- data/spec/models/business_full_create_spec.rb +60 -0
- data/spec/models/business_spec.rb +150 -0
- data/spec/models/checkout_session_details_dto_spec.rb +0 -6
- data/spec/models/collection_product_dto_spec.rb +0 -28
- data/spec/models/order_spec.rb +0 -6
- data/spec/models/payout_access_token_spec.rb +42 -0
- data/spec/models/payout_account_link_spec.rb +42 -0
- data/spec/models/payout_account_spec.rb +48 -0
- data/spec/models/payout_method_list_spec.rb +36 -0
- data/spec/models/{discord_roles_response_dto_spec.rb → payout_method_spec.rb} +9 -9
- data/spec/models/payout_verification_list_spec.rb +36 -0
- data/spec/models/payout_verification_spec.rb +54 -0
- data/spec/models/product_create_spec.rb +0 -28
- data/spec/models/product_spec.rb +0 -28
- data/spec/models/product_update_spec.rb +0 -28
- data/spec/models/user_page_spec.rb +60 -0
- data/spec/models/user_settings_spec.rb +84 -0
- data/spec/models/user_settings_update_spec.rb +210 -0
- data/spec/models/user_stats_spec.rb +42 -0
- data/spec/models/user_theme_spec.rb +60 -0
- data/spec/models/user_theme_update_spec.rb +48 -0
- data/spec/models/whop_api_keys_rotation_spec.rb +36 -0
- data/spec/models/withdrawal_create_spec.rb +48 -0
- data/spec/models/withdrawal_list_spec.rb +42 -0
- data/spec/models/{webhook_entitlement_grant_payload_spec.rb → withdrawal_spec.rb} +23 -17
- metadata +258 -145
- data/docs/DiscordIntegrationApi.md +0 -135
- data/docs/DiscordRolesResponseDto.md +0 -24
- data/docs/WebhookEntitlementGrantPayload.md +0 -44
data/docs/DefaultApi.md
CHANGED
|
@@ -7,10 +7,6 @@ All URIs are relative to *https://api.solifyn.com*
|
|
|
7
7
|
| [**dispute_created_post**](DefaultApi.md#dispute_created_post) | **POST** /dispute.created | Dispute Created |
|
|
8
8
|
| [**dispute_lost_post**](DefaultApi.md#dispute_lost_post) | **POST** /dispute.lost | Dispute Lost |
|
|
9
9
|
| [**dispute_won_post**](DefaultApi.md#dispute_won_post) | **POST** /dispute.won | Dispute Won |
|
|
10
|
-
| [**entitlement_grant_created_post**](DefaultApi.md#entitlement_grant_created_post) | **POST** /entitlement_grant.created | Entitlement Grant Created |
|
|
11
|
-
| [**entitlement_grant_delivered_post**](DefaultApi.md#entitlement_grant_delivered_post) | **POST** /entitlement_grant.delivered | Entitlement Grant Delivered |
|
|
12
|
-
| [**entitlement_grant_failed_post**](DefaultApi.md#entitlement_grant_failed_post) | **POST** /entitlement_grant.failed | Entitlement Grant Failed |
|
|
13
|
-
| [**entitlement_grant_revoked_post**](DefaultApi.md#entitlement_grant_revoked_post) | **POST** /entitlement_grant.revoked | Entitlement Grant Revoked |
|
|
14
10
|
| [**license_created_post**](DefaultApi.md#license_created_post) | **POST** /license.created | License Created |
|
|
15
11
|
| [**license_revoked_post**](DefaultApi.md#license_revoked_post) | **POST** /license.revoked | License Revoked |
|
|
16
12
|
| [**payment_created_post**](DefaultApi.md#payment_created_post) | **POST** /payment.created | Payment Created |
|
|
@@ -233,286 +229,6 @@ nil (empty response body)
|
|
|
233
229
|
- **Accept**: Not defined
|
|
234
230
|
|
|
235
231
|
|
|
236
|
-
## entitlement_grant_created_post
|
|
237
|
-
|
|
238
|
-
> entitlement_grant_created_post(opts)
|
|
239
|
-
|
|
240
|
-
Entitlement Grant Created
|
|
241
|
-
|
|
242
|
-
Occurs when a new entitlement grant is created (e.g., at checkout completion if the product has GitHub access). The collaborator invitation is pending.
|
|
243
|
-
|
|
244
|
-
### Examples
|
|
245
|
-
|
|
246
|
-
```ruby
|
|
247
|
-
require 'time'
|
|
248
|
-
require 'solifyn'
|
|
249
|
-
# setup authorization
|
|
250
|
-
Solifyn.configure do |config|
|
|
251
|
-
# Configure Bearer authorization (API Key): ApiKeyAuth
|
|
252
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
253
|
-
end
|
|
254
|
-
|
|
255
|
-
api_instance = Solifyn::DefaultApi.new
|
|
256
|
-
opts = {
|
|
257
|
-
webhook_entitlement_grant_payload: # WebhookEntitlementGrantPayload |
|
|
258
|
-
}
|
|
259
|
-
|
|
260
|
-
begin
|
|
261
|
-
# Entitlement Grant Created
|
|
262
|
-
api_instance.entitlement_grant_created_post(opts)
|
|
263
|
-
rescue Solifyn::ApiError => e
|
|
264
|
-
puts "Error when calling DefaultApi->entitlement_grant_created_post: #{e}"
|
|
265
|
-
end
|
|
266
|
-
```
|
|
267
|
-
|
|
268
|
-
#### Using the entitlement_grant_created_post_with_http_info variant
|
|
269
|
-
|
|
270
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
271
|
-
|
|
272
|
-
> <Array(nil, Integer, Hash)> entitlement_grant_created_post_with_http_info(opts)
|
|
273
|
-
|
|
274
|
-
```ruby
|
|
275
|
-
begin
|
|
276
|
-
# Entitlement Grant Created
|
|
277
|
-
data, status_code, headers = api_instance.entitlement_grant_created_post_with_http_info(opts)
|
|
278
|
-
p status_code # => 2xx
|
|
279
|
-
p headers # => { ... }
|
|
280
|
-
p data # => nil
|
|
281
|
-
rescue Solifyn::ApiError => e
|
|
282
|
-
puts "Error when calling DefaultApi->entitlement_grant_created_post_with_http_info: #{e}"
|
|
283
|
-
end
|
|
284
|
-
```
|
|
285
|
-
|
|
286
|
-
### Parameters
|
|
287
|
-
|
|
288
|
-
| Name | Type | Description | Notes |
|
|
289
|
-
| ---- | ---- | ----------- | ----- |
|
|
290
|
-
| **webhook_entitlement_grant_payload** | [**WebhookEntitlementGrantPayload**](WebhookEntitlementGrantPayload.md) | | [optional] |
|
|
291
|
-
|
|
292
|
-
### Return type
|
|
293
|
-
|
|
294
|
-
nil (empty response body)
|
|
295
|
-
|
|
296
|
-
### Authorization
|
|
297
|
-
|
|
298
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
299
|
-
|
|
300
|
-
### HTTP request headers
|
|
301
|
-
|
|
302
|
-
- **Content-Type**: application/json
|
|
303
|
-
- **Accept**: Not defined
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
## entitlement_grant_delivered_post
|
|
307
|
-
|
|
308
|
-
> entitlement_grant_delivered_post(opts)
|
|
309
|
-
|
|
310
|
-
Entitlement Grant Delivered
|
|
311
|
-
|
|
312
|
-
Occurs when the customer successfully connects their GitHub account and the collaborator invitation is successfully delivered.
|
|
313
|
-
|
|
314
|
-
### Examples
|
|
315
|
-
|
|
316
|
-
```ruby
|
|
317
|
-
require 'time'
|
|
318
|
-
require 'solifyn'
|
|
319
|
-
# setup authorization
|
|
320
|
-
Solifyn.configure do |config|
|
|
321
|
-
# Configure Bearer authorization (API Key): ApiKeyAuth
|
|
322
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
323
|
-
end
|
|
324
|
-
|
|
325
|
-
api_instance = Solifyn::DefaultApi.new
|
|
326
|
-
opts = {
|
|
327
|
-
webhook_entitlement_grant_payload: # WebhookEntitlementGrantPayload |
|
|
328
|
-
}
|
|
329
|
-
|
|
330
|
-
begin
|
|
331
|
-
# Entitlement Grant Delivered
|
|
332
|
-
api_instance.entitlement_grant_delivered_post(opts)
|
|
333
|
-
rescue Solifyn::ApiError => e
|
|
334
|
-
puts "Error when calling DefaultApi->entitlement_grant_delivered_post: #{e}"
|
|
335
|
-
end
|
|
336
|
-
```
|
|
337
|
-
|
|
338
|
-
#### Using the entitlement_grant_delivered_post_with_http_info variant
|
|
339
|
-
|
|
340
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
341
|
-
|
|
342
|
-
> <Array(nil, Integer, Hash)> entitlement_grant_delivered_post_with_http_info(opts)
|
|
343
|
-
|
|
344
|
-
```ruby
|
|
345
|
-
begin
|
|
346
|
-
# Entitlement Grant Delivered
|
|
347
|
-
data, status_code, headers = api_instance.entitlement_grant_delivered_post_with_http_info(opts)
|
|
348
|
-
p status_code # => 2xx
|
|
349
|
-
p headers # => { ... }
|
|
350
|
-
p data # => nil
|
|
351
|
-
rescue Solifyn::ApiError => e
|
|
352
|
-
puts "Error when calling DefaultApi->entitlement_grant_delivered_post_with_http_info: #{e}"
|
|
353
|
-
end
|
|
354
|
-
```
|
|
355
|
-
|
|
356
|
-
### Parameters
|
|
357
|
-
|
|
358
|
-
| Name | Type | Description | Notes |
|
|
359
|
-
| ---- | ---- | ----------- | ----- |
|
|
360
|
-
| **webhook_entitlement_grant_payload** | [**WebhookEntitlementGrantPayload**](WebhookEntitlementGrantPayload.md) | | [optional] |
|
|
361
|
-
|
|
362
|
-
### Return type
|
|
363
|
-
|
|
364
|
-
nil (empty response body)
|
|
365
|
-
|
|
366
|
-
### Authorization
|
|
367
|
-
|
|
368
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
369
|
-
|
|
370
|
-
### HTTP request headers
|
|
371
|
-
|
|
372
|
-
- **Content-Type**: application/json
|
|
373
|
-
- **Accept**: Not defined
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
## entitlement_grant_failed_post
|
|
377
|
-
|
|
378
|
-
> entitlement_grant_failed_post(opts)
|
|
379
|
-
|
|
380
|
-
Entitlement Grant Failed
|
|
381
|
-
|
|
382
|
-
Occurs when invitation delivery fails (e.g., if the user GitHub account is flagged or invitation limit is reached).
|
|
383
|
-
|
|
384
|
-
### Examples
|
|
385
|
-
|
|
386
|
-
```ruby
|
|
387
|
-
require 'time'
|
|
388
|
-
require 'solifyn'
|
|
389
|
-
# setup authorization
|
|
390
|
-
Solifyn.configure do |config|
|
|
391
|
-
# Configure Bearer authorization (API Key): ApiKeyAuth
|
|
392
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
393
|
-
end
|
|
394
|
-
|
|
395
|
-
api_instance = Solifyn::DefaultApi.new
|
|
396
|
-
opts = {
|
|
397
|
-
webhook_entitlement_grant_payload: # WebhookEntitlementGrantPayload |
|
|
398
|
-
}
|
|
399
|
-
|
|
400
|
-
begin
|
|
401
|
-
# Entitlement Grant Failed
|
|
402
|
-
api_instance.entitlement_grant_failed_post(opts)
|
|
403
|
-
rescue Solifyn::ApiError => e
|
|
404
|
-
puts "Error when calling DefaultApi->entitlement_grant_failed_post: #{e}"
|
|
405
|
-
end
|
|
406
|
-
```
|
|
407
|
-
|
|
408
|
-
#### Using the entitlement_grant_failed_post_with_http_info variant
|
|
409
|
-
|
|
410
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
411
|
-
|
|
412
|
-
> <Array(nil, Integer, Hash)> entitlement_grant_failed_post_with_http_info(opts)
|
|
413
|
-
|
|
414
|
-
```ruby
|
|
415
|
-
begin
|
|
416
|
-
# Entitlement Grant Failed
|
|
417
|
-
data, status_code, headers = api_instance.entitlement_grant_failed_post_with_http_info(opts)
|
|
418
|
-
p status_code # => 2xx
|
|
419
|
-
p headers # => { ... }
|
|
420
|
-
p data # => nil
|
|
421
|
-
rescue Solifyn::ApiError => e
|
|
422
|
-
puts "Error when calling DefaultApi->entitlement_grant_failed_post_with_http_info: #{e}"
|
|
423
|
-
end
|
|
424
|
-
```
|
|
425
|
-
|
|
426
|
-
### Parameters
|
|
427
|
-
|
|
428
|
-
| Name | Type | Description | Notes |
|
|
429
|
-
| ---- | ---- | ----------- | ----- |
|
|
430
|
-
| **webhook_entitlement_grant_payload** | [**WebhookEntitlementGrantPayload**](WebhookEntitlementGrantPayload.md) | | [optional] |
|
|
431
|
-
|
|
432
|
-
### Return type
|
|
433
|
-
|
|
434
|
-
nil (empty response body)
|
|
435
|
-
|
|
436
|
-
### Authorization
|
|
437
|
-
|
|
438
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
439
|
-
|
|
440
|
-
### HTTP request headers
|
|
441
|
-
|
|
442
|
-
- **Content-Type**: application/json
|
|
443
|
-
- **Accept**: Not defined
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
## entitlement_grant_revoked_post
|
|
447
|
-
|
|
448
|
-
> entitlement_grant_revoked_post(opts)
|
|
449
|
-
|
|
450
|
-
Entitlement Grant Revoked
|
|
451
|
-
|
|
452
|
-
Occurs when the customer access is removed from the repository (manually or automatically via subscription cancel/refund).
|
|
453
|
-
|
|
454
|
-
### Examples
|
|
455
|
-
|
|
456
|
-
```ruby
|
|
457
|
-
require 'time'
|
|
458
|
-
require 'solifyn'
|
|
459
|
-
# setup authorization
|
|
460
|
-
Solifyn.configure do |config|
|
|
461
|
-
# Configure Bearer authorization (API Key): ApiKeyAuth
|
|
462
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
463
|
-
end
|
|
464
|
-
|
|
465
|
-
api_instance = Solifyn::DefaultApi.new
|
|
466
|
-
opts = {
|
|
467
|
-
webhook_entitlement_grant_payload: # WebhookEntitlementGrantPayload |
|
|
468
|
-
}
|
|
469
|
-
|
|
470
|
-
begin
|
|
471
|
-
# Entitlement Grant Revoked
|
|
472
|
-
api_instance.entitlement_grant_revoked_post(opts)
|
|
473
|
-
rescue Solifyn::ApiError => e
|
|
474
|
-
puts "Error when calling DefaultApi->entitlement_grant_revoked_post: #{e}"
|
|
475
|
-
end
|
|
476
|
-
```
|
|
477
|
-
|
|
478
|
-
#### Using the entitlement_grant_revoked_post_with_http_info variant
|
|
479
|
-
|
|
480
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
481
|
-
|
|
482
|
-
> <Array(nil, Integer, Hash)> entitlement_grant_revoked_post_with_http_info(opts)
|
|
483
|
-
|
|
484
|
-
```ruby
|
|
485
|
-
begin
|
|
486
|
-
# Entitlement Grant Revoked
|
|
487
|
-
data, status_code, headers = api_instance.entitlement_grant_revoked_post_with_http_info(opts)
|
|
488
|
-
p status_code # => 2xx
|
|
489
|
-
p headers # => { ... }
|
|
490
|
-
p data # => nil
|
|
491
|
-
rescue Solifyn::ApiError => e
|
|
492
|
-
puts "Error when calling DefaultApi->entitlement_grant_revoked_post_with_http_info: #{e}"
|
|
493
|
-
end
|
|
494
|
-
```
|
|
495
|
-
|
|
496
|
-
### Parameters
|
|
497
|
-
|
|
498
|
-
| Name | Type | Description | Notes |
|
|
499
|
-
| ---- | ---- | ----------- | ----- |
|
|
500
|
-
| **webhook_entitlement_grant_payload** | [**WebhookEntitlementGrantPayload**](WebhookEntitlementGrantPayload.md) | | [optional] |
|
|
501
|
-
|
|
502
|
-
### Return type
|
|
503
|
-
|
|
504
|
-
nil (empty response body)
|
|
505
|
-
|
|
506
|
-
### Authorization
|
|
507
|
-
|
|
508
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
509
|
-
|
|
510
|
-
### HTTP request headers
|
|
511
|
-
|
|
512
|
-
- **Content-Type**: application/json
|
|
513
|
-
- **Accept**: Not defined
|
|
514
|
-
|
|
515
|
-
|
|
516
232
|
## license_created_post
|
|
517
233
|
|
|
518
234
|
> license_created_post(opts)
|
|
@@ -13,10 +13,6 @@
|
|
|
13
13
|
| **github_repo** | **String** | Target GitHub repository (owner/repo) if type is GITHUB. | [optional] |
|
|
14
14
|
| **github_permission** | **String** | GitHub access permission level if type is GITHUB. | [optional] |
|
|
15
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
16
|
| **status** | **String** | Delivery status of the collaborator invite (PENDING, DELIVERED, FAILED, REVOKED). | |
|
|
21
17
|
| **oauth_url** | **String** | OAuth URL to redirect the customer to. | [optional] |
|
|
22
18
|
| **error_details** | **String** | Error message if invitation delivery failed. | [optional] |
|
|
@@ -39,10 +35,6 @@ instance = Solifyn::EntitlementGrantResponseDto.new(
|
|
|
39
35
|
github_repo: solifyn/premium-app,
|
|
40
36
|
github_permission: pull,
|
|
41
37
|
github_username: octocat,
|
|
42
|
-
discord_guild_id: 123456789012345678,
|
|
43
|
-
discord_role_id: 876543210987654321,
|
|
44
|
-
discord_username: discorduser#1234,
|
|
45
|
-
discord_user_id: 112233445566778899,
|
|
46
38
|
status: PENDING,
|
|
47
39
|
oauth_url: https://github.com/login/oauth/authorize...,
|
|
48
40
|
error_details: Permission denied,
|
data/docs/PartnerApi.md
ADDED
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
# Solifyn::PartnerApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost:8000*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**partner_controller_get_partner_commissions**](PartnerApi.md#partner_controller_get_partner_commissions) | **GET** /v1/partner/commissions | |
|
|
8
|
+
| [**partner_controller_get_partner_stats**](PartnerApi.md#partner_controller_get_partner_stats) | **GET** /v1/partner/stats | |
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## partner_controller_get_partner_commissions
|
|
12
|
+
|
|
13
|
+
> partner_controller_get_partner_commissions
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
### Examples
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'time'
|
|
21
|
+
require 'solifyn'
|
|
22
|
+
|
|
23
|
+
api_instance = Solifyn::PartnerApi.new
|
|
24
|
+
|
|
25
|
+
begin
|
|
26
|
+
|
|
27
|
+
api_instance.partner_controller_get_partner_commissions
|
|
28
|
+
rescue Solifyn::ApiError => e
|
|
29
|
+
puts "Error when calling PartnerApi->partner_controller_get_partner_commissions: #{e}"
|
|
30
|
+
end
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
#### Using the partner_controller_get_partner_commissions_with_http_info variant
|
|
34
|
+
|
|
35
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
36
|
+
|
|
37
|
+
> <Array(nil, Integer, Hash)> partner_controller_get_partner_commissions_with_http_info
|
|
38
|
+
|
|
39
|
+
```ruby
|
|
40
|
+
begin
|
|
41
|
+
|
|
42
|
+
data, status_code, headers = api_instance.partner_controller_get_partner_commissions_with_http_info
|
|
43
|
+
p status_code # => 2xx
|
|
44
|
+
p headers # => { ... }
|
|
45
|
+
p data # => nil
|
|
46
|
+
rescue Solifyn::ApiError => e
|
|
47
|
+
puts "Error when calling PartnerApi->partner_controller_get_partner_commissions_with_http_info: #{e}"
|
|
48
|
+
end
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Parameters
|
|
52
|
+
|
|
53
|
+
This endpoint does not need any parameter.
|
|
54
|
+
|
|
55
|
+
### Return type
|
|
56
|
+
|
|
57
|
+
nil (empty response body)
|
|
58
|
+
|
|
59
|
+
### Authorization
|
|
60
|
+
|
|
61
|
+
No authorization required
|
|
62
|
+
|
|
63
|
+
### HTTP request headers
|
|
64
|
+
|
|
65
|
+
- **Content-Type**: Not defined
|
|
66
|
+
- **Accept**: Not defined
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
## partner_controller_get_partner_stats
|
|
70
|
+
|
|
71
|
+
> partner_controller_get_partner_stats
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
### Examples
|
|
76
|
+
|
|
77
|
+
```ruby
|
|
78
|
+
require 'time'
|
|
79
|
+
require 'solifyn'
|
|
80
|
+
|
|
81
|
+
api_instance = Solifyn::PartnerApi.new
|
|
82
|
+
|
|
83
|
+
begin
|
|
84
|
+
|
|
85
|
+
api_instance.partner_controller_get_partner_stats
|
|
86
|
+
rescue Solifyn::ApiError => e
|
|
87
|
+
puts "Error when calling PartnerApi->partner_controller_get_partner_stats: #{e}"
|
|
88
|
+
end
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
#### Using the partner_controller_get_partner_stats_with_http_info variant
|
|
92
|
+
|
|
93
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
94
|
+
|
|
95
|
+
> <Array(nil, Integer, Hash)> partner_controller_get_partner_stats_with_http_info
|
|
96
|
+
|
|
97
|
+
```ruby
|
|
98
|
+
begin
|
|
99
|
+
|
|
100
|
+
data, status_code, headers = api_instance.partner_controller_get_partner_stats_with_http_info
|
|
101
|
+
p status_code # => 2xx
|
|
102
|
+
p headers # => { ... }
|
|
103
|
+
p data # => nil
|
|
104
|
+
rescue Solifyn::ApiError => e
|
|
105
|
+
puts "Error when calling PartnerApi->partner_controller_get_partner_stats_with_http_info: #{e}"
|
|
106
|
+
end
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
### Parameters
|
|
110
|
+
|
|
111
|
+
This endpoint does not need any parameter.
|
|
112
|
+
|
|
113
|
+
### Return type
|
|
114
|
+
|
|
115
|
+
nil (empty response body)
|
|
116
|
+
|
|
117
|
+
### Authorization
|
|
118
|
+
|
|
119
|
+
No authorization required
|
|
120
|
+
|
|
121
|
+
### HTTP request headers
|
|
122
|
+
|
|
123
|
+
- **Content-Type**: Not defined
|
|
124
|
+
- **Accept**: Not defined
|
|
125
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Solifyn::PayoutAccessToken
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **access_token** | **String** | The temporary access token for embed portals | |
|
|
8
|
+
| **expires_at** | **Time** | Expiration timestamp of the access token | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'solifyn'
|
|
14
|
+
|
|
15
|
+
instance = Solifyn::PayoutAccessToken.new(
|
|
16
|
+
access_token: token_abc123,
|
|
17
|
+
expires_at: 2025-01-01T13:00:00Z
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Solifyn::PayoutAccount
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | The payout account ID | |
|
|
8
|
+
| **status** | **String** | Status of the payout account onboarding | |
|
|
9
|
+
| **capabilities** | **Object** | Onboarding capability status flags (e.g., transfers, payouts) | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'solifyn'
|
|
15
|
+
|
|
16
|
+
instance = Solifyn::PayoutAccount.new(
|
|
17
|
+
id: acct_123,
|
|
18
|
+
status: active,
|
|
19
|
+
capabilities: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Solifyn::PayoutAccountLink
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **url** | **String** | The URL redirecting to the Stripe Express onboarding/portal | |
|
|
8
|
+
| **expires_at** | **Time** | Expiration timestamp of the link | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'solifyn'
|
|
14
|
+
|
|
15
|
+
instance = Solifyn::PayoutAccountLink.new(
|
|
16
|
+
url: https://connect.stripe.com/express/oauth/authorize...,
|
|
17
|
+
expires_at: 2025-01-01T12:30:00Z
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Solifyn::PayoutMethod
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | The payout method ID | |
|
|
8
|
+
| **type** | **String** | Type of payout method (e.g. bank_account, stripe) | |
|
|
9
|
+
| **status** | **String** | Status of the payout method | |
|
|
10
|
+
| **details** | **Object** | Metadata and details of the bank/card associated | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'solifyn'
|
|
16
|
+
|
|
17
|
+
instance = Solifyn::PayoutMethod.new(
|
|
18
|
+
id: pm_123,
|
|
19
|
+
type: bank_account,
|
|
20
|
+
status: active,
|
|
21
|
+
details: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Solifyn::PayoutMethodList
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<PayoutMethod>**](PayoutMethod.md) | List of payout methods available for the business | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'solifyn'
|
|
13
|
+
|
|
14
|
+
instance = Solifyn::PayoutMethodList.new(
|
|
15
|
+
data: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Solifyn::PayoutVerification
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | The verification check ID | |
|
|
8
|
+
| **status** | **String** | Status of verification (pending, verified, rejected) | |
|
|
9
|
+
| **type** | **String** | Verification type (identity, business, address) | |
|
|
10
|
+
| **details** | **Object** | Details and requirements of the verification check | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'solifyn'
|
|
16
|
+
|
|
17
|
+
instance = Solifyn::PayoutVerification.new(
|
|
18
|
+
id: ver_123,
|
|
19
|
+
status: verified,
|
|
20
|
+
type: identity,
|
|
21
|
+
details: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Solifyn::PayoutVerificationList
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<PayoutVerification>**](PayoutVerification.md) | List of verifications for the payout account | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'solifyn'
|
|
13
|
+
|
|
14
|
+
instance = Solifyn::PayoutVerificationList.new(
|
|
15
|
+
data: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|