solifyn 1.1.3 → 1.1.4

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 (88) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +7 -4
  3. data/docs/Brand.md +2 -2
  4. data/docs/CheckoutLinkResponseDto.md +3 -3
  5. data/docs/CollectionDetailResponseDto.md +3 -3
  6. data/docs/CollectionProductDto.md +11 -5
  7. data/docs/CollectionResponseDto.md +3 -3
  8. data/docs/CreateCustomerDto.md +1 -1
  9. data/docs/CreateMeterDto.md +1 -1
  10. data/docs/CreateWebhookEndpointDto.md +1 -1
  11. data/docs/CustomerResponseDto.md +3 -3
  12. data/docs/CustomerSharedInviteResponseDto.md +1 -1
  13. data/docs/DefaultApi.md +1214 -0
  14. data/docs/DeveloperApi.md +1 -1
  15. data/docs/DiscordIntegrationApi.md +135 -0
  16. data/docs/DiscordRolesResponseDto.md +24 -0
  17. data/docs/Dispute.md +3 -3
  18. data/docs/EntitlementGrantResponseDto.md +13 -5
  19. data/docs/Invoice.md +1 -1
  20. data/docs/MeterDetailResponseDto.md +3 -3
  21. data/docs/MeterIngestEventDto.md +1 -1
  22. data/docs/MeterIngestResponseDto.md +1 -1
  23. data/docs/MeterResponseDto.md +3 -3
  24. data/docs/MeterUsageEventDto.md +3 -3
  25. data/docs/OperationalWebhookEndpointHeadersInDto.md +1 -1
  26. data/docs/OperationalWebhookEndpointHeadersResponseDto.md +2 -2
  27. data/docs/OperationalWebhookEndpointInDto.md +2 -2
  28. data/docs/OperationalWebhookEndpointResponseDto.md +2 -2
  29. data/docs/OperationalWebhookEndpointUpdateDto.md +2 -2
  30. data/docs/Order.md +2 -2
  31. data/docs/OrderRefund.md +1 -1
  32. data/docs/Product.md +11 -5
  33. data/docs/ProductCreate.md +8 -2
  34. data/docs/ProductUpdate.md +8 -2
  35. data/docs/Refund.md +5 -5
  36. data/docs/Subscription.md +4 -4
  37. data/docs/UpdateCustomerDto.md +1 -1
  38. data/docs/UpdateMeterDto.md +1 -1
  39. data/docs/UpdateWebhookEndpointDto.md +1 -1
  40. data/docs/WebhookDeliveryResponseDto.md +1 -1
  41. data/docs/WebhookEndpointApi.md +1 -1
  42. data/docs/WebhookEndpointResponseDto.md +1 -1
  43. data/docs/WebhookEntitlementGrantPayload.md +5 -5
  44. data/lib/solifyn/api/default_api.rb +1076 -0
  45. data/lib/solifyn/api/discord_integration_api.rb +137 -0
  46. data/lib/solifyn/models/addon.rb +10 -2
  47. data/lib/solifyn/models/brand.rb +0 -6
  48. data/lib/solifyn/models/brand_create.rb +5 -6
  49. data/lib/solifyn/models/brand_update.rb +5 -6
  50. data/lib/solifyn/models/checkout_link_response_dto.rb +0 -12
  51. data/lib/solifyn/models/checkout_session_details_dto.rb +0 -1
  52. data/lib/solifyn/models/collection_detail_response_dto.rb +0 -2
  53. data/lib/solifyn/models/collection_product_dto.rb +132 -18
  54. data/lib/solifyn/models/collection_response_dto.rb +0 -2
  55. data/lib/solifyn/models/customer_response_dto.rb +0 -6
  56. data/lib/solifyn/models/discord_roles_response_dto.rb +273 -0
  57. data/lib/solifyn/models/discount.rb +10 -2
  58. data/lib/solifyn/models/discount_create.rb +0 -3
  59. data/lib/solifyn/models/discount_update.rb +0 -3
  60. data/lib/solifyn/models/dispute.rb +0 -10
  61. data/lib/solifyn/models/dispute_evidence_dto.rb +0 -4
  62. data/lib/solifyn/models/entitlement_grant_response_dto.rb +41 -1
  63. data/lib/solifyn/models/instance.rb +20 -4
  64. data/lib/solifyn/models/license.rb +40 -8
  65. data/lib/solifyn/models/license_sub_dto.rb +15 -3
  66. data/lib/solifyn/models/meter_detail_response_dto.rb +0 -4
  67. data/lib/solifyn/models/meter_response_dto.rb +0 -4
  68. data/lib/solifyn/models/meter_usage_event_dto.rb +0 -1
  69. data/lib/solifyn/models/product.rb +132 -18
  70. data/lib/solifyn/models/product_create.rb +33 -3
  71. data/lib/solifyn/models/product_sub_dto.rb +5 -1
  72. data/lib/solifyn/models/product_update.rb +33 -3
  73. data/lib/solifyn/models/refund.rb +0 -5
  74. data/lib/solifyn/models/resolved_addon.rb +5 -1
  75. data/lib/solifyn/models/subscription.rb +35 -10
  76. data/lib/solifyn/models/subscription_detail.rb +5 -1
  77. data/lib/solifyn/models/webhook_dispute_payload.rb +0 -5
  78. data/lib/solifyn/models/webhook_entitlement_grant_payload.rb +0 -6
  79. data/lib/solifyn/models/webhook_license_payload.rb +40 -8
  80. data/lib/solifyn/models/webhook_payment_payload.rb +0 -40
  81. data/lib/solifyn/models/webhook_refund_payload.rb +0 -4
  82. data/lib/solifyn/models/webhook_subscription_payload.rb +0 -9
  83. data/lib/solifyn/version.rb +1 -1
  84. data/lib/solifyn.rb +2 -0
  85. data/spec/api/default_api_spec.rb +239 -0
  86. data/spec/api/discord_integration_api_spec.rb +58 -0
  87. data/spec/models/discord_roles_response_dto_spec.rb +54 -0
  88. metadata +145 -133
@@ -0,0 +1,1214 @@
1
+ # Solifyn::DefaultApi
2
+
3
+ All URIs are relative to *https://api.solifyn.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**dispute_created_post**](DefaultApi.md#dispute_created_post) | **POST** /dispute.created | Dispute Created |
8
+ | [**dispute_lost_post**](DefaultApi.md#dispute_lost_post) | **POST** /dispute.lost | Dispute Lost |
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
+ | [**license_created_post**](DefaultApi.md#license_created_post) | **POST** /license.created | License Created |
15
+ | [**license_revoked_post**](DefaultApi.md#license_revoked_post) | **POST** /license.revoked | License Revoked |
16
+ | [**payment_created_post**](DefaultApi.md#payment_created_post) | **POST** /payment.created | Payment Created |
17
+ | [**payment_failed_post**](DefaultApi.md#payment_failed_post) | **POST** /payment.failed | Payment Failed |
18
+ | [**payment_succeeded_post**](DefaultApi.md#payment_succeeded_post) | **POST** /payment.succeeded | Payment Succeeded |
19
+ | [**refund_failed_post**](DefaultApi.md#refund_failed_post) | **POST** /refund.failed | Refund Failed |
20
+ | [**refund_succeeded_post**](DefaultApi.md#refund_succeeded_post) | **POST** /refund.succeeded | Refund Succeeded |
21
+ | [**subscription_created_post**](DefaultApi.md#subscription_created_post) | **POST** /subscription.created | Subscription Created |
22
+ | [**subscription_deactivated_post**](DefaultApi.md#subscription_deactivated_post) | **POST** /subscription.deactivated | Subscription Deactivated |
23
+ | [**subscription_updated_post**](DefaultApi.md#subscription_updated_post) | **POST** /subscription.updated | Subscription Updated |
24
+
25
+
26
+ ## dispute_created_post
27
+
28
+ > dispute_created_post(opts)
29
+
30
+ Dispute Created
31
+
32
+ Occurs when a payment charge is disputed by the customer (chargeback initiated).
33
+
34
+ ### Examples
35
+
36
+ ```ruby
37
+ require 'time'
38
+ require 'solifyn'
39
+ # setup authorization
40
+ Solifyn.configure do |config|
41
+ # Configure Bearer authorization (API Key): ApiKeyAuth
42
+ config.access_token = 'YOUR_BEARER_TOKEN'
43
+ end
44
+
45
+ api_instance = Solifyn::DefaultApi.new
46
+ opts = {
47
+ webhook_dispute_payload: # WebhookDisputePayload |
48
+ }
49
+
50
+ begin
51
+ # Dispute Created
52
+ api_instance.dispute_created_post(opts)
53
+ rescue Solifyn::ApiError => e
54
+ puts "Error when calling DefaultApi->dispute_created_post: #{e}"
55
+ end
56
+ ```
57
+
58
+ #### Using the dispute_created_post_with_http_info variant
59
+
60
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
61
+
62
+ > <Array(nil, Integer, Hash)> dispute_created_post_with_http_info(opts)
63
+
64
+ ```ruby
65
+ begin
66
+ # Dispute Created
67
+ data, status_code, headers = api_instance.dispute_created_post_with_http_info(opts)
68
+ p status_code # => 2xx
69
+ p headers # => { ... }
70
+ p data # => nil
71
+ rescue Solifyn::ApiError => e
72
+ puts "Error when calling DefaultApi->dispute_created_post_with_http_info: #{e}"
73
+ end
74
+ ```
75
+
76
+ ### Parameters
77
+
78
+ | Name | Type | Description | Notes |
79
+ | ---- | ---- | ----------- | ----- |
80
+ | **webhook_dispute_payload** | [**WebhookDisputePayload**](WebhookDisputePayload.md) | | [optional] |
81
+
82
+ ### Return type
83
+
84
+ nil (empty response body)
85
+
86
+ ### Authorization
87
+
88
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
89
+
90
+ ### HTTP request headers
91
+
92
+ - **Content-Type**: application/json
93
+ - **Accept**: Not defined
94
+
95
+
96
+ ## dispute_lost_post
97
+
98
+ > dispute_lost_post(opts)
99
+
100
+ Dispute Lost
101
+
102
+ Occurs when a dispute challenge is lost and the funds are returned to the cardholder.
103
+
104
+ ### Examples
105
+
106
+ ```ruby
107
+ require 'time'
108
+ require 'solifyn'
109
+ # setup authorization
110
+ Solifyn.configure do |config|
111
+ # Configure Bearer authorization (API Key): ApiKeyAuth
112
+ config.access_token = 'YOUR_BEARER_TOKEN'
113
+ end
114
+
115
+ api_instance = Solifyn::DefaultApi.new
116
+ opts = {
117
+ webhook_dispute_payload: # WebhookDisputePayload |
118
+ }
119
+
120
+ begin
121
+ # Dispute Lost
122
+ api_instance.dispute_lost_post(opts)
123
+ rescue Solifyn::ApiError => e
124
+ puts "Error when calling DefaultApi->dispute_lost_post: #{e}"
125
+ end
126
+ ```
127
+
128
+ #### Using the dispute_lost_post_with_http_info variant
129
+
130
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
131
+
132
+ > <Array(nil, Integer, Hash)> dispute_lost_post_with_http_info(opts)
133
+
134
+ ```ruby
135
+ begin
136
+ # Dispute Lost
137
+ data, status_code, headers = api_instance.dispute_lost_post_with_http_info(opts)
138
+ p status_code # => 2xx
139
+ p headers # => { ... }
140
+ p data # => nil
141
+ rescue Solifyn::ApiError => e
142
+ puts "Error when calling DefaultApi->dispute_lost_post_with_http_info: #{e}"
143
+ end
144
+ ```
145
+
146
+ ### Parameters
147
+
148
+ | Name | Type | Description | Notes |
149
+ | ---- | ---- | ----------- | ----- |
150
+ | **webhook_dispute_payload** | [**WebhookDisputePayload**](WebhookDisputePayload.md) | | [optional] |
151
+
152
+ ### Return type
153
+
154
+ nil (empty response body)
155
+
156
+ ### Authorization
157
+
158
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
159
+
160
+ ### HTTP request headers
161
+
162
+ - **Content-Type**: application/json
163
+ - **Accept**: Not defined
164
+
165
+
166
+ ## dispute_won_post
167
+
168
+ > dispute_won_post(opts)
169
+
170
+ Dispute Won
171
+
172
+ Occurs when a dispute challenge is won by the merchant.
173
+
174
+ ### Examples
175
+
176
+ ```ruby
177
+ require 'time'
178
+ require 'solifyn'
179
+ # setup authorization
180
+ Solifyn.configure do |config|
181
+ # Configure Bearer authorization (API Key): ApiKeyAuth
182
+ config.access_token = 'YOUR_BEARER_TOKEN'
183
+ end
184
+
185
+ api_instance = Solifyn::DefaultApi.new
186
+ opts = {
187
+ webhook_dispute_payload: # WebhookDisputePayload |
188
+ }
189
+
190
+ begin
191
+ # Dispute Won
192
+ api_instance.dispute_won_post(opts)
193
+ rescue Solifyn::ApiError => e
194
+ puts "Error when calling DefaultApi->dispute_won_post: #{e}"
195
+ end
196
+ ```
197
+
198
+ #### Using the dispute_won_post_with_http_info variant
199
+
200
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
201
+
202
+ > <Array(nil, Integer, Hash)> dispute_won_post_with_http_info(opts)
203
+
204
+ ```ruby
205
+ begin
206
+ # Dispute Won
207
+ data, status_code, headers = api_instance.dispute_won_post_with_http_info(opts)
208
+ p status_code # => 2xx
209
+ p headers # => { ... }
210
+ p data # => nil
211
+ rescue Solifyn::ApiError => e
212
+ puts "Error when calling DefaultApi->dispute_won_post_with_http_info: #{e}"
213
+ end
214
+ ```
215
+
216
+ ### Parameters
217
+
218
+ | Name | Type | Description | Notes |
219
+ | ---- | ---- | ----------- | ----- |
220
+ | **webhook_dispute_payload** | [**WebhookDisputePayload**](WebhookDisputePayload.md) | | [optional] |
221
+
222
+ ### Return type
223
+
224
+ nil (empty response body)
225
+
226
+ ### Authorization
227
+
228
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
229
+
230
+ ### HTTP request headers
231
+
232
+ - **Content-Type**: application/json
233
+ - **Accept**: Not defined
234
+
235
+
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
+ ## license_created_post
517
+
518
+ > license_created_post(opts)
519
+
520
+ License Created
521
+
522
+ Occurs when a new software license key is created or assigned to a customer purchase.
523
+
524
+ ### Examples
525
+
526
+ ```ruby
527
+ require 'time'
528
+ require 'solifyn'
529
+ # setup authorization
530
+ Solifyn.configure do |config|
531
+ # Configure Bearer authorization (API Key): ApiKeyAuth
532
+ config.access_token = 'YOUR_BEARER_TOKEN'
533
+ end
534
+
535
+ api_instance = Solifyn::DefaultApi.new
536
+ opts = {
537
+ webhook_license_payload: # WebhookLicensePayload |
538
+ }
539
+
540
+ begin
541
+ # License Created
542
+ api_instance.license_created_post(opts)
543
+ rescue Solifyn::ApiError => e
544
+ puts "Error when calling DefaultApi->license_created_post: #{e}"
545
+ end
546
+ ```
547
+
548
+ #### Using the license_created_post_with_http_info variant
549
+
550
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
551
+
552
+ > <Array(nil, Integer, Hash)> license_created_post_with_http_info(opts)
553
+
554
+ ```ruby
555
+ begin
556
+ # License Created
557
+ data, status_code, headers = api_instance.license_created_post_with_http_info(opts)
558
+ p status_code # => 2xx
559
+ p headers # => { ... }
560
+ p data # => nil
561
+ rescue Solifyn::ApiError => e
562
+ puts "Error when calling DefaultApi->license_created_post_with_http_info: #{e}"
563
+ end
564
+ ```
565
+
566
+ ### Parameters
567
+
568
+ | Name | Type | Description | Notes |
569
+ | ---- | ---- | ----------- | ----- |
570
+ | **webhook_license_payload** | [**WebhookLicensePayload**](WebhookLicensePayload.md) | | [optional] |
571
+
572
+ ### Return type
573
+
574
+ nil (empty response body)
575
+
576
+ ### Authorization
577
+
578
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
579
+
580
+ ### HTTP request headers
581
+
582
+ - **Content-Type**: application/json
583
+ - **Accept**: Not defined
584
+
585
+
586
+ ## license_revoked_post
587
+
588
+ > license_revoked_post(opts)
589
+
590
+ License Revoked
591
+
592
+ Occurs when a software license key is revoked (e.g., due to subscription cancellation, refund, or dispute).
593
+
594
+ ### Examples
595
+
596
+ ```ruby
597
+ require 'time'
598
+ require 'solifyn'
599
+ # setup authorization
600
+ Solifyn.configure do |config|
601
+ # Configure Bearer authorization (API Key): ApiKeyAuth
602
+ config.access_token = 'YOUR_BEARER_TOKEN'
603
+ end
604
+
605
+ api_instance = Solifyn::DefaultApi.new
606
+ opts = {
607
+ webhook_license_payload: # WebhookLicensePayload |
608
+ }
609
+
610
+ begin
611
+ # License Revoked
612
+ api_instance.license_revoked_post(opts)
613
+ rescue Solifyn::ApiError => e
614
+ puts "Error when calling DefaultApi->license_revoked_post: #{e}"
615
+ end
616
+ ```
617
+
618
+ #### Using the license_revoked_post_with_http_info variant
619
+
620
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
621
+
622
+ > <Array(nil, Integer, Hash)> license_revoked_post_with_http_info(opts)
623
+
624
+ ```ruby
625
+ begin
626
+ # License Revoked
627
+ data, status_code, headers = api_instance.license_revoked_post_with_http_info(opts)
628
+ p status_code # => 2xx
629
+ p headers # => { ... }
630
+ p data # => nil
631
+ rescue Solifyn::ApiError => e
632
+ puts "Error when calling DefaultApi->license_revoked_post_with_http_info: #{e}"
633
+ end
634
+ ```
635
+
636
+ ### Parameters
637
+
638
+ | Name | Type | Description | Notes |
639
+ | ---- | ---- | ----------- | ----- |
640
+ | **webhook_license_payload** | [**WebhookLicensePayload**](WebhookLicensePayload.md) | | [optional] |
641
+
642
+ ### Return type
643
+
644
+ nil (empty response body)
645
+
646
+ ### Authorization
647
+
648
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
649
+
650
+ ### HTTP request headers
651
+
652
+ - **Content-Type**: application/json
653
+ - **Accept**: Not defined
654
+
655
+
656
+ ## payment_created_post
657
+
658
+ > payment_created_post(opts)
659
+
660
+ Payment Created
661
+
662
+ Occurs when a new payment is initiated (e.g., at checkout start or subscription creation). The payment may still be in an incomplete or pending state.
663
+
664
+ ### Examples
665
+
666
+ ```ruby
667
+ require 'time'
668
+ require 'solifyn'
669
+ # setup authorization
670
+ Solifyn.configure do |config|
671
+ # Configure Bearer authorization (API Key): ApiKeyAuth
672
+ config.access_token = 'YOUR_BEARER_TOKEN'
673
+ end
674
+
675
+ api_instance = Solifyn::DefaultApi.new
676
+ opts = {
677
+ webhook_payment_payload: # WebhookPaymentPayload |
678
+ }
679
+
680
+ begin
681
+ # Payment Created
682
+ api_instance.payment_created_post(opts)
683
+ rescue Solifyn::ApiError => e
684
+ puts "Error when calling DefaultApi->payment_created_post: #{e}"
685
+ end
686
+ ```
687
+
688
+ #### Using the payment_created_post_with_http_info variant
689
+
690
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
691
+
692
+ > <Array(nil, Integer, Hash)> payment_created_post_with_http_info(opts)
693
+
694
+ ```ruby
695
+ begin
696
+ # Payment Created
697
+ data, status_code, headers = api_instance.payment_created_post_with_http_info(opts)
698
+ p status_code # => 2xx
699
+ p headers # => { ... }
700
+ p data # => nil
701
+ rescue Solifyn::ApiError => e
702
+ puts "Error when calling DefaultApi->payment_created_post_with_http_info: #{e}"
703
+ end
704
+ ```
705
+
706
+ ### Parameters
707
+
708
+ | Name | Type | Description | Notes |
709
+ | ---- | ---- | ----------- | ----- |
710
+ | **webhook_payment_payload** | [**WebhookPaymentPayload**](WebhookPaymentPayload.md) | | [optional] |
711
+
712
+ ### Return type
713
+
714
+ nil (empty response body)
715
+
716
+ ### Authorization
717
+
718
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
719
+
720
+ ### HTTP request headers
721
+
722
+ - **Content-Type**: application/json
723
+ - **Accept**: Not defined
724
+
725
+
726
+ ## payment_failed_post
727
+
728
+ > payment_failed_post(opts)
729
+
730
+ Payment Failed
731
+
732
+ Occurs when a customer payment attempt fails.
733
+
734
+ ### Examples
735
+
736
+ ```ruby
737
+ require 'time'
738
+ require 'solifyn'
739
+ # setup authorization
740
+ Solifyn.configure do |config|
741
+ # Configure Bearer authorization (API Key): ApiKeyAuth
742
+ config.access_token = 'YOUR_BEARER_TOKEN'
743
+ end
744
+
745
+ api_instance = Solifyn::DefaultApi.new
746
+ opts = {
747
+ order: # Order |
748
+ }
749
+
750
+ begin
751
+ # Payment Failed
752
+ api_instance.payment_failed_post(opts)
753
+ rescue Solifyn::ApiError => e
754
+ puts "Error when calling DefaultApi->payment_failed_post: #{e}"
755
+ end
756
+ ```
757
+
758
+ #### Using the payment_failed_post_with_http_info variant
759
+
760
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
761
+
762
+ > <Array(nil, Integer, Hash)> payment_failed_post_with_http_info(opts)
763
+
764
+ ```ruby
765
+ begin
766
+ # Payment Failed
767
+ data, status_code, headers = api_instance.payment_failed_post_with_http_info(opts)
768
+ p status_code # => 2xx
769
+ p headers # => { ... }
770
+ p data # => nil
771
+ rescue Solifyn::ApiError => e
772
+ puts "Error when calling DefaultApi->payment_failed_post_with_http_info: #{e}"
773
+ end
774
+ ```
775
+
776
+ ### Parameters
777
+
778
+ | Name | Type | Description | Notes |
779
+ | ---- | ---- | ----------- | ----- |
780
+ | **order** | [**Order**](Order.md) | | [optional] |
781
+
782
+ ### Return type
783
+
784
+ nil (empty response body)
785
+
786
+ ### Authorization
787
+
788
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
789
+
790
+ ### HTTP request headers
791
+
792
+ - **Content-Type**: application/json
793
+ - **Accept**: Not defined
794
+
795
+
796
+ ## payment_succeeded_post
797
+
798
+ > payment_succeeded_post(opts)
799
+
800
+ Payment Succeeded
801
+
802
+ Occurs when a customer payment is confirmed as succeeded.
803
+
804
+ ### Examples
805
+
806
+ ```ruby
807
+ require 'time'
808
+ require 'solifyn'
809
+ # setup authorization
810
+ Solifyn.configure do |config|
811
+ # Configure Bearer authorization (API Key): ApiKeyAuth
812
+ config.access_token = 'YOUR_BEARER_TOKEN'
813
+ end
814
+
815
+ api_instance = Solifyn::DefaultApi.new
816
+ opts = {
817
+ order: # Order |
818
+ }
819
+
820
+ begin
821
+ # Payment Succeeded
822
+ api_instance.payment_succeeded_post(opts)
823
+ rescue Solifyn::ApiError => e
824
+ puts "Error when calling DefaultApi->payment_succeeded_post: #{e}"
825
+ end
826
+ ```
827
+
828
+ #### Using the payment_succeeded_post_with_http_info variant
829
+
830
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
831
+
832
+ > <Array(nil, Integer, Hash)> payment_succeeded_post_with_http_info(opts)
833
+
834
+ ```ruby
835
+ begin
836
+ # Payment Succeeded
837
+ data, status_code, headers = api_instance.payment_succeeded_post_with_http_info(opts)
838
+ p status_code # => 2xx
839
+ p headers # => { ... }
840
+ p data # => nil
841
+ rescue Solifyn::ApiError => e
842
+ puts "Error when calling DefaultApi->payment_succeeded_post_with_http_info: #{e}"
843
+ end
844
+ ```
845
+
846
+ ### Parameters
847
+
848
+ | Name | Type | Description | Notes |
849
+ | ---- | ---- | ----------- | ----- |
850
+ | **order** | [**Order**](Order.md) | | [optional] |
851
+
852
+ ### Return type
853
+
854
+ nil (empty response body)
855
+
856
+ ### Authorization
857
+
858
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
859
+
860
+ ### HTTP request headers
861
+
862
+ - **Content-Type**: application/json
863
+ - **Accept**: Not defined
864
+
865
+
866
+ ## refund_failed_post
867
+
868
+ > refund_failed_post(opts)
869
+
870
+ Refund Failed
871
+
872
+ Occurs when a payment refund fails.
873
+
874
+ ### Examples
875
+
876
+ ```ruby
877
+ require 'time'
878
+ require 'solifyn'
879
+ # setup authorization
880
+ Solifyn.configure do |config|
881
+ # Configure Bearer authorization (API Key): ApiKeyAuth
882
+ config.access_token = 'YOUR_BEARER_TOKEN'
883
+ end
884
+
885
+ api_instance = Solifyn::DefaultApi.new
886
+ opts = {
887
+ webhook_refund_payload: # WebhookRefundPayload |
888
+ }
889
+
890
+ begin
891
+ # Refund Failed
892
+ api_instance.refund_failed_post(opts)
893
+ rescue Solifyn::ApiError => e
894
+ puts "Error when calling DefaultApi->refund_failed_post: #{e}"
895
+ end
896
+ ```
897
+
898
+ #### Using the refund_failed_post_with_http_info variant
899
+
900
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
901
+
902
+ > <Array(nil, Integer, Hash)> refund_failed_post_with_http_info(opts)
903
+
904
+ ```ruby
905
+ begin
906
+ # Refund Failed
907
+ data, status_code, headers = api_instance.refund_failed_post_with_http_info(opts)
908
+ p status_code # => 2xx
909
+ p headers # => { ... }
910
+ p data # => nil
911
+ rescue Solifyn::ApiError => e
912
+ puts "Error when calling DefaultApi->refund_failed_post_with_http_info: #{e}"
913
+ end
914
+ ```
915
+
916
+ ### Parameters
917
+
918
+ | Name | Type | Description | Notes |
919
+ | ---- | ---- | ----------- | ----- |
920
+ | **webhook_refund_payload** | [**WebhookRefundPayload**](WebhookRefundPayload.md) | | [optional] |
921
+
922
+ ### Return type
923
+
924
+ nil (empty response body)
925
+
926
+ ### Authorization
927
+
928
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
929
+
930
+ ### HTTP request headers
931
+
932
+ - **Content-Type**: application/json
933
+ - **Accept**: Not defined
934
+
935
+
936
+ ## refund_succeeded_post
937
+
938
+ > refund_succeeded_post(opts)
939
+
940
+ Refund Succeeded
941
+
942
+ Occurs when a payment refund is confirmed as succeeded.
943
+
944
+ ### Examples
945
+
946
+ ```ruby
947
+ require 'time'
948
+ require 'solifyn'
949
+ # setup authorization
950
+ Solifyn.configure do |config|
951
+ # Configure Bearer authorization (API Key): ApiKeyAuth
952
+ config.access_token = 'YOUR_BEARER_TOKEN'
953
+ end
954
+
955
+ api_instance = Solifyn::DefaultApi.new
956
+ opts = {
957
+ webhook_refund_payload: # WebhookRefundPayload |
958
+ }
959
+
960
+ begin
961
+ # Refund Succeeded
962
+ api_instance.refund_succeeded_post(opts)
963
+ rescue Solifyn::ApiError => e
964
+ puts "Error when calling DefaultApi->refund_succeeded_post: #{e}"
965
+ end
966
+ ```
967
+
968
+ #### Using the refund_succeeded_post_with_http_info variant
969
+
970
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
971
+
972
+ > <Array(nil, Integer, Hash)> refund_succeeded_post_with_http_info(opts)
973
+
974
+ ```ruby
975
+ begin
976
+ # Refund Succeeded
977
+ data, status_code, headers = api_instance.refund_succeeded_post_with_http_info(opts)
978
+ p status_code # => 2xx
979
+ p headers # => { ... }
980
+ p data # => nil
981
+ rescue Solifyn::ApiError => e
982
+ puts "Error when calling DefaultApi->refund_succeeded_post_with_http_info: #{e}"
983
+ end
984
+ ```
985
+
986
+ ### Parameters
987
+
988
+ | Name | Type | Description | Notes |
989
+ | ---- | ---- | ----------- | ----- |
990
+ | **webhook_refund_payload** | [**WebhookRefundPayload**](WebhookRefundPayload.md) | | [optional] |
991
+
992
+ ### Return type
993
+
994
+ nil (empty response body)
995
+
996
+ ### Authorization
997
+
998
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
999
+
1000
+ ### HTTP request headers
1001
+
1002
+ - **Content-Type**: application/json
1003
+ - **Accept**: Not defined
1004
+
1005
+
1006
+ ## subscription_created_post
1007
+
1008
+ > subscription_created_post(opts)
1009
+
1010
+ Subscription Created
1011
+
1012
+ Occurs when a customer subscription is successfully started.
1013
+
1014
+ ### Examples
1015
+
1016
+ ```ruby
1017
+ require 'time'
1018
+ require 'solifyn'
1019
+ # setup authorization
1020
+ Solifyn.configure do |config|
1021
+ # Configure Bearer authorization (API Key): ApiKeyAuth
1022
+ config.access_token = 'YOUR_BEARER_TOKEN'
1023
+ end
1024
+
1025
+ api_instance = Solifyn::DefaultApi.new
1026
+ opts = {
1027
+ webhook_subscription_payload: # WebhookSubscriptionPayload |
1028
+ }
1029
+
1030
+ begin
1031
+ # Subscription Created
1032
+ api_instance.subscription_created_post(opts)
1033
+ rescue Solifyn::ApiError => e
1034
+ puts "Error when calling DefaultApi->subscription_created_post: #{e}"
1035
+ end
1036
+ ```
1037
+
1038
+ #### Using the subscription_created_post_with_http_info variant
1039
+
1040
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1041
+
1042
+ > <Array(nil, Integer, Hash)> subscription_created_post_with_http_info(opts)
1043
+
1044
+ ```ruby
1045
+ begin
1046
+ # Subscription Created
1047
+ data, status_code, headers = api_instance.subscription_created_post_with_http_info(opts)
1048
+ p status_code # => 2xx
1049
+ p headers # => { ... }
1050
+ p data # => nil
1051
+ rescue Solifyn::ApiError => e
1052
+ puts "Error when calling DefaultApi->subscription_created_post_with_http_info: #{e}"
1053
+ end
1054
+ ```
1055
+
1056
+ ### Parameters
1057
+
1058
+ | Name | Type | Description | Notes |
1059
+ | ---- | ---- | ----------- | ----- |
1060
+ | **webhook_subscription_payload** | [**WebhookSubscriptionPayload**](WebhookSubscriptionPayload.md) | | [optional] |
1061
+
1062
+ ### Return type
1063
+
1064
+ nil (empty response body)
1065
+
1066
+ ### Authorization
1067
+
1068
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
1069
+
1070
+ ### HTTP request headers
1071
+
1072
+ - **Content-Type**: application/json
1073
+ - **Accept**: Not defined
1074
+
1075
+
1076
+ ## subscription_deactivated_post
1077
+
1078
+ > subscription_deactivated_post(opts)
1079
+
1080
+ Subscription Deactivated
1081
+
1082
+ Occurs when a customer subscription is deactivated or expired.
1083
+
1084
+ ### Examples
1085
+
1086
+ ```ruby
1087
+ require 'time'
1088
+ require 'solifyn'
1089
+ # setup authorization
1090
+ Solifyn.configure do |config|
1091
+ # Configure Bearer authorization (API Key): ApiKeyAuth
1092
+ config.access_token = 'YOUR_BEARER_TOKEN'
1093
+ end
1094
+
1095
+ api_instance = Solifyn::DefaultApi.new
1096
+ opts = {
1097
+ webhook_subscription_payload: # WebhookSubscriptionPayload |
1098
+ }
1099
+
1100
+ begin
1101
+ # Subscription Deactivated
1102
+ api_instance.subscription_deactivated_post(opts)
1103
+ rescue Solifyn::ApiError => e
1104
+ puts "Error when calling DefaultApi->subscription_deactivated_post: #{e}"
1105
+ end
1106
+ ```
1107
+
1108
+ #### Using the subscription_deactivated_post_with_http_info variant
1109
+
1110
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1111
+
1112
+ > <Array(nil, Integer, Hash)> subscription_deactivated_post_with_http_info(opts)
1113
+
1114
+ ```ruby
1115
+ begin
1116
+ # Subscription Deactivated
1117
+ data, status_code, headers = api_instance.subscription_deactivated_post_with_http_info(opts)
1118
+ p status_code # => 2xx
1119
+ p headers # => { ... }
1120
+ p data # => nil
1121
+ rescue Solifyn::ApiError => e
1122
+ puts "Error when calling DefaultApi->subscription_deactivated_post_with_http_info: #{e}"
1123
+ end
1124
+ ```
1125
+
1126
+ ### Parameters
1127
+
1128
+ | Name | Type | Description | Notes |
1129
+ | ---- | ---- | ----------- | ----- |
1130
+ | **webhook_subscription_payload** | [**WebhookSubscriptionPayload**](WebhookSubscriptionPayload.md) | | [optional] |
1131
+
1132
+ ### Return type
1133
+
1134
+ nil (empty response body)
1135
+
1136
+ ### Authorization
1137
+
1138
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
1139
+
1140
+ ### HTTP request headers
1141
+
1142
+ - **Content-Type**: application/json
1143
+ - **Accept**: Not defined
1144
+
1145
+
1146
+ ## subscription_updated_post
1147
+
1148
+ > subscription_updated_post(opts)
1149
+
1150
+ Subscription Updated
1151
+
1152
+ Occurs when a customer subscription is updated (e.g., cancel at period end changes).
1153
+
1154
+ ### Examples
1155
+
1156
+ ```ruby
1157
+ require 'time'
1158
+ require 'solifyn'
1159
+ # setup authorization
1160
+ Solifyn.configure do |config|
1161
+ # Configure Bearer authorization (API Key): ApiKeyAuth
1162
+ config.access_token = 'YOUR_BEARER_TOKEN'
1163
+ end
1164
+
1165
+ api_instance = Solifyn::DefaultApi.new
1166
+ opts = {
1167
+ webhook_subscription_payload: # WebhookSubscriptionPayload |
1168
+ }
1169
+
1170
+ begin
1171
+ # Subscription Updated
1172
+ api_instance.subscription_updated_post(opts)
1173
+ rescue Solifyn::ApiError => e
1174
+ puts "Error when calling DefaultApi->subscription_updated_post: #{e}"
1175
+ end
1176
+ ```
1177
+
1178
+ #### Using the subscription_updated_post_with_http_info variant
1179
+
1180
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1181
+
1182
+ > <Array(nil, Integer, Hash)> subscription_updated_post_with_http_info(opts)
1183
+
1184
+ ```ruby
1185
+ begin
1186
+ # Subscription Updated
1187
+ data, status_code, headers = api_instance.subscription_updated_post_with_http_info(opts)
1188
+ p status_code # => 2xx
1189
+ p headers # => { ... }
1190
+ p data # => nil
1191
+ rescue Solifyn::ApiError => e
1192
+ puts "Error when calling DefaultApi->subscription_updated_post_with_http_info: #{e}"
1193
+ end
1194
+ ```
1195
+
1196
+ ### Parameters
1197
+
1198
+ | Name | Type | Description | Notes |
1199
+ | ---- | ---- | ----------- | ----- |
1200
+ | **webhook_subscription_payload** | [**WebhookSubscriptionPayload**](WebhookSubscriptionPayload.md) | | [optional] |
1201
+
1202
+ ### Return type
1203
+
1204
+ nil (empty response body)
1205
+
1206
+ ### Authorization
1207
+
1208
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
1209
+
1210
+ ### HTTP request headers
1211
+
1212
+ - **Content-Type**: application/json
1213
+ - **Accept**: Not defined
1214
+