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
|
@@ -0,0 +1,350 @@
|
|
|
1
|
+
# Solifyn::BusinessesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost:8000*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**businesses_billing_history**](BusinessesApi.md#businesses_billing_history) | **GET** /v1/user/billing/history | Get Platform Billing History |
|
|
8
|
+
| [**merchants_generate_api_keys**](BusinessesApi.md#merchants_generate_api_keys) | **POST** /v1/user/whop-api-keys | Rotate Whop API Keys |
|
|
9
|
+
| [**merchants_update_page**](BusinessesApi.md#merchants_update_page) | **PATCH** /v1/user/page | Update Page configuration |
|
|
10
|
+
| [**merchants_update_settings**](BusinessesApi.md#merchants_update_settings) | **PATCH** /v1/user/settings | Update Merchant Settings |
|
|
11
|
+
| [**merchants_update_theme**](BusinessesApi.md#merchants_update_theme) | **PATCH** /v1/user/theme | Update Theme |
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## businesses_billing_history
|
|
15
|
+
|
|
16
|
+
> businesses_billing_history
|
|
17
|
+
|
|
18
|
+
Get Platform Billing History
|
|
19
|
+
|
|
20
|
+
Retrieve history of SaaS subscription payments paid by this business to the platform.
|
|
21
|
+
|
|
22
|
+
### Examples
|
|
23
|
+
|
|
24
|
+
```ruby
|
|
25
|
+
require 'time'
|
|
26
|
+
require 'solifyn'
|
|
27
|
+
# setup authorization
|
|
28
|
+
Solifyn.configure do |config|
|
|
29
|
+
# Configure Bearer authorization (API Key): ApiKeyAuth
|
|
30
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
api_instance = Solifyn::BusinessesApi.new
|
|
34
|
+
|
|
35
|
+
begin
|
|
36
|
+
# Get Platform Billing History
|
|
37
|
+
api_instance.businesses_billing_history
|
|
38
|
+
rescue Solifyn::ApiError => e
|
|
39
|
+
puts "Error when calling BusinessesApi->businesses_billing_history: #{e}"
|
|
40
|
+
end
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
#### Using the businesses_billing_history_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)> businesses_billing_history_with_http_info
|
|
48
|
+
|
|
49
|
+
```ruby
|
|
50
|
+
begin
|
|
51
|
+
# Get Platform Billing History
|
|
52
|
+
data, status_code, headers = api_instance.businesses_billing_history_with_http_info
|
|
53
|
+
p status_code # => 2xx
|
|
54
|
+
p headers # => { ... }
|
|
55
|
+
p data # => nil
|
|
56
|
+
rescue Solifyn::ApiError => e
|
|
57
|
+
puts "Error when calling BusinessesApi->businesses_billing_history_with_http_info: #{e}"
|
|
58
|
+
end
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### Parameters
|
|
62
|
+
|
|
63
|
+
This endpoint does not need any parameter.
|
|
64
|
+
|
|
65
|
+
### Return type
|
|
66
|
+
|
|
67
|
+
nil (empty response body)
|
|
68
|
+
|
|
69
|
+
### Authorization
|
|
70
|
+
|
|
71
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
72
|
+
|
|
73
|
+
### HTTP request headers
|
|
74
|
+
|
|
75
|
+
- **Content-Type**: Not defined
|
|
76
|
+
- **Accept**: Not defined
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
## merchants_generate_api_keys
|
|
80
|
+
|
|
81
|
+
> <WhopApiKeysRotation> merchants_generate_api_keys
|
|
82
|
+
|
|
83
|
+
Rotate Whop API Keys
|
|
84
|
+
|
|
85
|
+
Generate and sync a new Whop Child Company API key (restricted to business owners).
|
|
86
|
+
|
|
87
|
+
### Examples
|
|
88
|
+
|
|
89
|
+
```ruby
|
|
90
|
+
require 'time'
|
|
91
|
+
require 'solifyn'
|
|
92
|
+
# setup authorization
|
|
93
|
+
Solifyn.configure do |config|
|
|
94
|
+
# Configure Bearer authorization (API Key): ApiKeyAuth
|
|
95
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
api_instance = Solifyn::BusinessesApi.new
|
|
99
|
+
|
|
100
|
+
begin
|
|
101
|
+
# Rotate Whop API Keys
|
|
102
|
+
result = api_instance.merchants_generate_api_keys
|
|
103
|
+
p result
|
|
104
|
+
rescue Solifyn::ApiError => e
|
|
105
|
+
puts "Error when calling BusinessesApi->merchants_generate_api_keys: #{e}"
|
|
106
|
+
end
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
#### Using the merchants_generate_api_keys_with_http_info variant
|
|
110
|
+
|
|
111
|
+
This returns an Array which contains the response data, status code and headers.
|
|
112
|
+
|
|
113
|
+
> <Array(<WhopApiKeysRotation>, Integer, Hash)> merchants_generate_api_keys_with_http_info
|
|
114
|
+
|
|
115
|
+
```ruby
|
|
116
|
+
begin
|
|
117
|
+
# Rotate Whop API Keys
|
|
118
|
+
data, status_code, headers = api_instance.merchants_generate_api_keys_with_http_info
|
|
119
|
+
p status_code # => 2xx
|
|
120
|
+
p headers # => { ... }
|
|
121
|
+
p data # => <WhopApiKeysRotation>
|
|
122
|
+
rescue Solifyn::ApiError => e
|
|
123
|
+
puts "Error when calling BusinessesApi->merchants_generate_api_keys_with_http_info: #{e}"
|
|
124
|
+
end
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
### Parameters
|
|
128
|
+
|
|
129
|
+
This endpoint does not need any parameter.
|
|
130
|
+
|
|
131
|
+
### Return type
|
|
132
|
+
|
|
133
|
+
[**WhopApiKeysRotation**](WhopApiKeysRotation.md)
|
|
134
|
+
|
|
135
|
+
### Authorization
|
|
136
|
+
|
|
137
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
138
|
+
|
|
139
|
+
### HTTP request headers
|
|
140
|
+
|
|
141
|
+
- **Content-Type**: Not defined
|
|
142
|
+
- **Accept**: application/json
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
## merchants_update_page
|
|
146
|
+
|
|
147
|
+
> <UserPage> merchants_update_page(user_theme_update)
|
|
148
|
+
|
|
149
|
+
Update Page configuration
|
|
150
|
+
|
|
151
|
+
Modify store page content configs, banner images, or avatar details.
|
|
152
|
+
|
|
153
|
+
### Examples
|
|
154
|
+
|
|
155
|
+
```ruby
|
|
156
|
+
require 'time'
|
|
157
|
+
require 'solifyn'
|
|
158
|
+
# setup authorization
|
|
159
|
+
Solifyn.configure do |config|
|
|
160
|
+
# Configure Bearer authorization (API Key): ApiKeyAuth
|
|
161
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
162
|
+
end
|
|
163
|
+
|
|
164
|
+
api_instance = Solifyn::BusinessesApi.new
|
|
165
|
+
user_theme_update = Solifyn::UserThemeUpdate.new # UserThemeUpdate |
|
|
166
|
+
|
|
167
|
+
begin
|
|
168
|
+
# Update Page configuration
|
|
169
|
+
result = api_instance.merchants_update_page(user_theme_update)
|
|
170
|
+
p result
|
|
171
|
+
rescue Solifyn::ApiError => e
|
|
172
|
+
puts "Error when calling BusinessesApi->merchants_update_page: #{e}"
|
|
173
|
+
end
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
#### Using the merchants_update_page_with_http_info variant
|
|
177
|
+
|
|
178
|
+
This returns an Array which contains the response data, status code and headers.
|
|
179
|
+
|
|
180
|
+
> <Array(<UserPage>, Integer, Hash)> merchants_update_page_with_http_info(user_theme_update)
|
|
181
|
+
|
|
182
|
+
```ruby
|
|
183
|
+
begin
|
|
184
|
+
# Update Page configuration
|
|
185
|
+
data, status_code, headers = api_instance.merchants_update_page_with_http_info(user_theme_update)
|
|
186
|
+
p status_code # => 2xx
|
|
187
|
+
p headers # => { ... }
|
|
188
|
+
p data # => <UserPage>
|
|
189
|
+
rescue Solifyn::ApiError => e
|
|
190
|
+
puts "Error when calling BusinessesApi->merchants_update_page_with_http_info: #{e}"
|
|
191
|
+
end
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
### Parameters
|
|
195
|
+
|
|
196
|
+
| Name | Type | Description | Notes |
|
|
197
|
+
| ---- | ---- | ----------- | ----- |
|
|
198
|
+
| **user_theme_update** | [**UserThemeUpdate**](UserThemeUpdate.md) | | |
|
|
199
|
+
|
|
200
|
+
### Return type
|
|
201
|
+
|
|
202
|
+
[**UserPage**](UserPage.md)
|
|
203
|
+
|
|
204
|
+
### Authorization
|
|
205
|
+
|
|
206
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
207
|
+
|
|
208
|
+
### HTTP request headers
|
|
209
|
+
|
|
210
|
+
- **Content-Type**: application/json
|
|
211
|
+
- **Accept**: application/json
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
## merchants_update_settings
|
|
215
|
+
|
|
216
|
+
> <UserSettings> merchants_update_settings(user_settings_update)
|
|
217
|
+
|
|
218
|
+
Update Merchant Settings
|
|
219
|
+
|
|
220
|
+
Update profile parameters, SEO, Google analytics, and email notification properties.
|
|
221
|
+
|
|
222
|
+
### Examples
|
|
223
|
+
|
|
224
|
+
```ruby
|
|
225
|
+
require 'time'
|
|
226
|
+
require 'solifyn'
|
|
227
|
+
# setup authorization
|
|
228
|
+
Solifyn.configure do |config|
|
|
229
|
+
# Configure Bearer authorization (API Key): ApiKeyAuth
|
|
230
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
231
|
+
end
|
|
232
|
+
|
|
233
|
+
api_instance = Solifyn::BusinessesApi.new
|
|
234
|
+
user_settings_update = Solifyn::UserSettingsUpdate.new # UserSettingsUpdate |
|
|
235
|
+
|
|
236
|
+
begin
|
|
237
|
+
# Update Merchant Settings
|
|
238
|
+
result = api_instance.merchants_update_settings(user_settings_update)
|
|
239
|
+
p result
|
|
240
|
+
rescue Solifyn::ApiError => e
|
|
241
|
+
puts "Error when calling BusinessesApi->merchants_update_settings: #{e}"
|
|
242
|
+
end
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
#### Using the merchants_update_settings_with_http_info variant
|
|
246
|
+
|
|
247
|
+
This returns an Array which contains the response data, status code and headers.
|
|
248
|
+
|
|
249
|
+
> <Array(<UserSettings>, Integer, Hash)> merchants_update_settings_with_http_info(user_settings_update)
|
|
250
|
+
|
|
251
|
+
```ruby
|
|
252
|
+
begin
|
|
253
|
+
# Update Merchant Settings
|
|
254
|
+
data, status_code, headers = api_instance.merchants_update_settings_with_http_info(user_settings_update)
|
|
255
|
+
p status_code # => 2xx
|
|
256
|
+
p headers # => { ... }
|
|
257
|
+
p data # => <UserSettings>
|
|
258
|
+
rescue Solifyn::ApiError => e
|
|
259
|
+
puts "Error when calling BusinessesApi->merchants_update_settings_with_http_info: #{e}"
|
|
260
|
+
end
|
|
261
|
+
```
|
|
262
|
+
|
|
263
|
+
### Parameters
|
|
264
|
+
|
|
265
|
+
| Name | Type | Description | Notes |
|
|
266
|
+
| ---- | ---- | ----------- | ----- |
|
|
267
|
+
| **user_settings_update** | [**UserSettingsUpdate**](UserSettingsUpdate.md) | | |
|
|
268
|
+
|
|
269
|
+
### Return type
|
|
270
|
+
|
|
271
|
+
[**UserSettings**](UserSettings.md)
|
|
272
|
+
|
|
273
|
+
### Authorization
|
|
274
|
+
|
|
275
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
276
|
+
|
|
277
|
+
### HTTP request headers
|
|
278
|
+
|
|
279
|
+
- **Content-Type**: application/json
|
|
280
|
+
- **Accept**: application/json
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
## merchants_update_theme
|
|
284
|
+
|
|
285
|
+
> <UserTheme> merchants_update_theme(user_theme_update)
|
|
286
|
+
|
|
287
|
+
Update Theme
|
|
288
|
+
|
|
289
|
+
Update colors, fonts, avatar, or banner settings for the store.
|
|
290
|
+
|
|
291
|
+
### Examples
|
|
292
|
+
|
|
293
|
+
```ruby
|
|
294
|
+
require 'time'
|
|
295
|
+
require 'solifyn'
|
|
296
|
+
# setup authorization
|
|
297
|
+
Solifyn.configure do |config|
|
|
298
|
+
# Configure Bearer authorization (API Key): ApiKeyAuth
|
|
299
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
300
|
+
end
|
|
301
|
+
|
|
302
|
+
api_instance = Solifyn::BusinessesApi.new
|
|
303
|
+
user_theme_update = Solifyn::UserThemeUpdate.new # UserThemeUpdate |
|
|
304
|
+
|
|
305
|
+
begin
|
|
306
|
+
# Update Theme
|
|
307
|
+
result = api_instance.merchants_update_theme(user_theme_update)
|
|
308
|
+
p result
|
|
309
|
+
rescue Solifyn::ApiError => e
|
|
310
|
+
puts "Error when calling BusinessesApi->merchants_update_theme: #{e}"
|
|
311
|
+
end
|
|
312
|
+
```
|
|
313
|
+
|
|
314
|
+
#### Using the merchants_update_theme_with_http_info variant
|
|
315
|
+
|
|
316
|
+
This returns an Array which contains the response data, status code and headers.
|
|
317
|
+
|
|
318
|
+
> <Array(<UserTheme>, Integer, Hash)> merchants_update_theme_with_http_info(user_theme_update)
|
|
319
|
+
|
|
320
|
+
```ruby
|
|
321
|
+
begin
|
|
322
|
+
# Update Theme
|
|
323
|
+
data, status_code, headers = api_instance.merchants_update_theme_with_http_info(user_theme_update)
|
|
324
|
+
p status_code # => 2xx
|
|
325
|
+
p headers # => { ... }
|
|
326
|
+
p data # => <UserTheme>
|
|
327
|
+
rescue Solifyn::ApiError => e
|
|
328
|
+
puts "Error when calling BusinessesApi->merchants_update_theme_with_http_info: #{e}"
|
|
329
|
+
end
|
|
330
|
+
```
|
|
331
|
+
|
|
332
|
+
### Parameters
|
|
333
|
+
|
|
334
|
+
| Name | Type | Description | Notes |
|
|
335
|
+
| ---- | ---- | ----------- | ----- |
|
|
336
|
+
| **user_theme_update** | [**UserThemeUpdate**](UserThemeUpdate.md) | | |
|
|
337
|
+
|
|
338
|
+
### Return type
|
|
339
|
+
|
|
340
|
+
[**UserTheme**](UserTheme.md)
|
|
341
|
+
|
|
342
|
+
### Authorization
|
|
343
|
+
|
|
344
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
345
|
+
|
|
346
|
+
### HTTP request headers
|
|
347
|
+
|
|
348
|
+
- **Content-Type**: application/json
|
|
349
|
+
- **Accept**: application/json
|
|
350
|
+
|
data/docs/ChatApi.md
ADDED
|
@@ -0,0 +1,246 @@
|
|
|
1
|
+
# Solifyn::ChatApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost:8000*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**chat_controller_get_merchant_messages**](ChatApi.md#chat_controller_get_merchant_messages) | **GET** /v1/chat/merchant/messages/{customerId} | |
|
|
8
|
+
| [**chat_controller_get_merchant_sessions**](ChatApi.md#chat_controller_get_merchant_sessions) | **GET** /v1/chat/merchant/sessions | |
|
|
9
|
+
| [**chat_controller_send_customer_message**](ChatApi.md#chat_controller_send_customer_message) | **POST** /v1/chat/customer/message | |
|
|
10
|
+
| [**chat_controller_send_merchant_message**](ChatApi.md#chat_controller_send_merchant_message) | **POST** /v1/chat/merchant/message | |
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
## chat_controller_get_merchant_messages
|
|
14
|
+
|
|
15
|
+
> chat_controller_get_merchant_messages(customer_id)
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
### Examples
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'time'
|
|
23
|
+
require 'solifyn'
|
|
24
|
+
|
|
25
|
+
api_instance = Solifyn::ChatApi.new
|
|
26
|
+
customer_id = 'customer_id_example' # String |
|
|
27
|
+
|
|
28
|
+
begin
|
|
29
|
+
|
|
30
|
+
api_instance.chat_controller_get_merchant_messages(customer_id)
|
|
31
|
+
rescue Solifyn::ApiError => e
|
|
32
|
+
puts "Error when calling ChatApi->chat_controller_get_merchant_messages: #{e}"
|
|
33
|
+
end
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
#### Using the chat_controller_get_merchant_messages_with_http_info variant
|
|
37
|
+
|
|
38
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
39
|
+
|
|
40
|
+
> <Array(nil, Integer, Hash)> chat_controller_get_merchant_messages_with_http_info(customer_id)
|
|
41
|
+
|
|
42
|
+
```ruby
|
|
43
|
+
begin
|
|
44
|
+
|
|
45
|
+
data, status_code, headers = api_instance.chat_controller_get_merchant_messages_with_http_info(customer_id)
|
|
46
|
+
p status_code # => 2xx
|
|
47
|
+
p headers # => { ... }
|
|
48
|
+
p data # => nil
|
|
49
|
+
rescue Solifyn::ApiError => e
|
|
50
|
+
puts "Error when calling ChatApi->chat_controller_get_merchant_messages_with_http_info: #{e}"
|
|
51
|
+
end
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Parameters
|
|
55
|
+
|
|
56
|
+
| Name | Type | Description | Notes |
|
|
57
|
+
| ---- | ---- | ----------- | ----- |
|
|
58
|
+
| **customer_id** | **String** | | |
|
|
59
|
+
|
|
60
|
+
### Return type
|
|
61
|
+
|
|
62
|
+
nil (empty response body)
|
|
63
|
+
|
|
64
|
+
### Authorization
|
|
65
|
+
|
|
66
|
+
No authorization required
|
|
67
|
+
|
|
68
|
+
### HTTP request headers
|
|
69
|
+
|
|
70
|
+
- **Content-Type**: Not defined
|
|
71
|
+
- **Accept**: Not defined
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
## chat_controller_get_merchant_sessions
|
|
75
|
+
|
|
76
|
+
> chat_controller_get_merchant_sessions
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
### Examples
|
|
81
|
+
|
|
82
|
+
```ruby
|
|
83
|
+
require 'time'
|
|
84
|
+
require 'solifyn'
|
|
85
|
+
|
|
86
|
+
api_instance = Solifyn::ChatApi.new
|
|
87
|
+
|
|
88
|
+
begin
|
|
89
|
+
|
|
90
|
+
api_instance.chat_controller_get_merchant_sessions
|
|
91
|
+
rescue Solifyn::ApiError => e
|
|
92
|
+
puts "Error when calling ChatApi->chat_controller_get_merchant_sessions: #{e}"
|
|
93
|
+
end
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
#### Using the chat_controller_get_merchant_sessions_with_http_info variant
|
|
97
|
+
|
|
98
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
99
|
+
|
|
100
|
+
> <Array(nil, Integer, Hash)> chat_controller_get_merchant_sessions_with_http_info
|
|
101
|
+
|
|
102
|
+
```ruby
|
|
103
|
+
begin
|
|
104
|
+
|
|
105
|
+
data, status_code, headers = api_instance.chat_controller_get_merchant_sessions_with_http_info
|
|
106
|
+
p status_code # => 2xx
|
|
107
|
+
p headers # => { ... }
|
|
108
|
+
p data # => nil
|
|
109
|
+
rescue Solifyn::ApiError => e
|
|
110
|
+
puts "Error when calling ChatApi->chat_controller_get_merchant_sessions_with_http_info: #{e}"
|
|
111
|
+
end
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### Parameters
|
|
115
|
+
|
|
116
|
+
This endpoint does not need any parameter.
|
|
117
|
+
|
|
118
|
+
### Return type
|
|
119
|
+
|
|
120
|
+
nil (empty response body)
|
|
121
|
+
|
|
122
|
+
### Authorization
|
|
123
|
+
|
|
124
|
+
No authorization required
|
|
125
|
+
|
|
126
|
+
### HTTP request headers
|
|
127
|
+
|
|
128
|
+
- **Content-Type**: Not defined
|
|
129
|
+
- **Accept**: Not defined
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
## chat_controller_send_customer_message
|
|
133
|
+
|
|
134
|
+
> chat_controller_send_customer_message
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
### Examples
|
|
139
|
+
|
|
140
|
+
```ruby
|
|
141
|
+
require 'time'
|
|
142
|
+
require 'solifyn'
|
|
143
|
+
|
|
144
|
+
api_instance = Solifyn::ChatApi.new
|
|
145
|
+
|
|
146
|
+
begin
|
|
147
|
+
|
|
148
|
+
api_instance.chat_controller_send_customer_message
|
|
149
|
+
rescue Solifyn::ApiError => e
|
|
150
|
+
puts "Error when calling ChatApi->chat_controller_send_customer_message: #{e}"
|
|
151
|
+
end
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
#### Using the chat_controller_send_customer_message_with_http_info variant
|
|
155
|
+
|
|
156
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
157
|
+
|
|
158
|
+
> <Array(nil, Integer, Hash)> chat_controller_send_customer_message_with_http_info
|
|
159
|
+
|
|
160
|
+
```ruby
|
|
161
|
+
begin
|
|
162
|
+
|
|
163
|
+
data, status_code, headers = api_instance.chat_controller_send_customer_message_with_http_info
|
|
164
|
+
p status_code # => 2xx
|
|
165
|
+
p headers # => { ... }
|
|
166
|
+
p data # => nil
|
|
167
|
+
rescue Solifyn::ApiError => e
|
|
168
|
+
puts "Error when calling ChatApi->chat_controller_send_customer_message_with_http_info: #{e}"
|
|
169
|
+
end
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
### Parameters
|
|
173
|
+
|
|
174
|
+
This endpoint does not need any parameter.
|
|
175
|
+
|
|
176
|
+
### Return type
|
|
177
|
+
|
|
178
|
+
nil (empty response body)
|
|
179
|
+
|
|
180
|
+
### Authorization
|
|
181
|
+
|
|
182
|
+
No authorization required
|
|
183
|
+
|
|
184
|
+
### HTTP request headers
|
|
185
|
+
|
|
186
|
+
- **Content-Type**: Not defined
|
|
187
|
+
- **Accept**: Not defined
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
## chat_controller_send_merchant_message
|
|
191
|
+
|
|
192
|
+
> chat_controller_send_merchant_message
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
### Examples
|
|
197
|
+
|
|
198
|
+
```ruby
|
|
199
|
+
require 'time'
|
|
200
|
+
require 'solifyn'
|
|
201
|
+
|
|
202
|
+
api_instance = Solifyn::ChatApi.new
|
|
203
|
+
|
|
204
|
+
begin
|
|
205
|
+
|
|
206
|
+
api_instance.chat_controller_send_merchant_message
|
|
207
|
+
rescue Solifyn::ApiError => e
|
|
208
|
+
puts "Error when calling ChatApi->chat_controller_send_merchant_message: #{e}"
|
|
209
|
+
end
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
#### Using the chat_controller_send_merchant_message_with_http_info variant
|
|
213
|
+
|
|
214
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
215
|
+
|
|
216
|
+
> <Array(nil, Integer, Hash)> chat_controller_send_merchant_message_with_http_info
|
|
217
|
+
|
|
218
|
+
```ruby
|
|
219
|
+
begin
|
|
220
|
+
|
|
221
|
+
data, status_code, headers = api_instance.chat_controller_send_merchant_message_with_http_info
|
|
222
|
+
p status_code # => 2xx
|
|
223
|
+
p headers # => { ... }
|
|
224
|
+
p data # => nil
|
|
225
|
+
rescue Solifyn::ApiError => e
|
|
226
|
+
puts "Error when calling ChatApi->chat_controller_send_merchant_message_with_http_info: #{e}"
|
|
227
|
+
end
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
### Parameters
|
|
231
|
+
|
|
232
|
+
This endpoint does not need any parameter.
|
|
233
|
+
|
|
234
|
+
### Return type
|
|
235
|
+
|
|
236
|
+
nil (empty response body)
|
|
237
|
+
|
|
238
|
+
### Authorization
|
|
239
|
+
|
|
240
|
+
No authorization required
|
|
241
|
+
|
|
242
|
+
### HTTP request headers
|
|
243
|
+
|
|
244
|
+
- **Content-Type**: Not defined
|
|
245
|
+
- **Accept**: Not defined
|
|
246
|
+
|
|
@@ -19,9 +19,6 @@
|
|
|
19
19
|
| **has_github_access** | **Boolean** | Whether the product includes GitHub repository access. | |
|
|
20
20
|
| **github_repo** | **String** | GitHub repository to grant access to (format: owner/repo). | |
|
|
21
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. | |
|
|
25
22
|
| **is_tax_inclusive** | **Boolean** | Whether the product price already includes applicable sales taxes. | |
|
|
26
23
|
| **billing_period** | **Integer** | The subscription billing cycle interval in days (for subscription products). | |
|
|
27
24
|
| **trial_period_days** | **Integer** | Trial duration in days for subscription products. | |
|
|
@@ -66,9 +63,6 @@ instance = Solifyn::CollectionProductDto.new(
|
|
|
66
63
|
has_github_access: false,
|
|
67
64
|
github_repo: solifyn/premium-app,
|
|
68
65
|
github_permission: pull,
|
|
69
|
-
has_discord_access: false,
|
|
70
|
-
discord_guild_id: 123456789012345678,
|
|
71
|
-
discord_role_id: 876543210987654321,
|
|
72
66
|
is_tax_inclusive: false,
|
|
73
67
|
billing_period: null,
|
|
74
68
|
trial_period_days: null,
|