solifyn 1.0.0 → 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +20 -7
- data/docs/BalanceApi.md +1 -1
- data/docs/CheckoutApi.md +1 -1
- data/docs/CheckoutLinksApi.md +1 -1
- data/docs/CheckoutSessionDetailsDto.md +3 -1
- data/docs/CollectionProductDto.md +12 -0
- data/docs/CollectionsApi.md +1 -1
- data/docs/CustomersApi.md +1 -1
- data/docs/DefaultApi.md +285 -1
- data/docs/DeveloperApi.md +1 -1
- data/docs/DigitalFileApi.md +1 -1
- data/docs/DiscordIntegrationApi.md +135 -0
- data/docs/DiscordRolesResponseDto.md +24 -0
- data/docs/DiscountsApi.md +1 -1
- data/docs/DisputesApi.md +1 -1
- data/docs/EntitlementGrantResponseDto.md +54 -0
- data/docs/EntitlementGrantsApi.md +289 -0
- data/docs/GitHubIntegrationApi.md +145 -0
- data/docs/GithubReposResponseDto.md +22 -0
- data/docs/LicenseApi.md +1 -1
- data/docs/LicenseKeysApi.md +1 -1
- data/docs/LicenseKeysClientApi.md +1 -1
- data/docs/MetersApi.md +1 -1
- data/docs/OrdersApi.md +1 -1
- data/docs/Product.md +12 -0
- data/docs/ProductAddOnsApi.md +1 -1
- data/docs/ProductCreate.md +12 -0
- data/docs/ProductUpdate.md +12 -0
- data/docs/ProductsApi.md +1 -1
- data/docs/RefundRequestsApi.md +1 -1
- data/docs/RefundsChargebacksApi.md +1 -1
- data/docs/SubscriptionsApi.md +1 -1
- data/docs/SyncLoginDto.md +18 -0
- data/docs/WebhookApi.md +1 -1
- data/docs/WebhookEndpointApi.md +55 -10
- data/docs/WebhookEntitlementGrantPayload.md +44 -0
- data/git_push.sh +2 -2
- data/lib/solifyn/api/default_api.rb +248 -0
- data/lib/solifyn/api/{partner_api.rb → discord_integration_api.rb} +32 -19
- data/lib/solifyn/api/entitlement_grants_api.rb +271 -0
- data/lib/solifyn/api/git_hub_integration_api.rb +137 -0
- data/lib/solifyn/api/webhook_endpoint_api.rb +9 -9
- data/lib/solifyn/configuration.rb +4 -4
- data/lib/solifyn/models/checkout_session_details_dto.rb +16 -4
- data/lib/solifyn/models/collection_product_dto.rb +115 -1
- data/lib/solifyn/models/{payout_method.rb → discord_roles_response_dto.rb} +41 -34
- data/lib/solifyn/models/{withdrawal.rb → entitlement_grant_response_dto.rb} +149 -109
- data/lib/solifyn/models/{payout_account.rb → github_repos_response_dto.rb} +31 -24
- data/lib/solifyn/models/product.rb +115 -1
- data/lib/solifyn/models/product_create.rb +77 -1
- data/lib/solifyn/models/product_update.rb +77 -1
- data/lib/solifyn/models/{payout_method_list.rb → sync_login_dto.rb} +15 -17
- data/lib/solifyn/models/{payout_verification.rb → webhook_entitlement_grant_payload.rb} +118 -41
- data/lib/solifyn/version.rb +1 -1
- data/lib/solifyn.rb +8 -0
- data/spec/api/checkout_api_spec.rb +12 -0
- data/spec/api/default_api_spec.rb +59 -11
- data/spec/api/developer_api_spec.rb +52 -29
- data/spec/api/{partner_api_spec.rb → discord_integration_api_spec.rb} +16 -11
- data/spec/api/entitlement_grants_api_spec.rb +83 -0
- data/spec/api/git_hub_integration_api_spec.rb +58 -0
- data/spec/models/checkout_session_details_dto_spec.rb +6 -0
- data/spec/models/collection_product_dto_spec.rb +28 -0
- data/spec/models/{payout_method_spec.rb → discord_roles_response_dto_spec.rb} +9 -9
- data/spec/models/{withdrawal_spec.rb → entitlement_grant_response_dto_spec.rb} +18 -18
- data/spec/models/{payout_account_spec.rb → github_repos_response_dto_spec.rb} +8 -8
- data/spec/models/order_spec.rb +6 -0
- data/spec/models/product_create_spec.rb +28 -0
- data/spec/models/product_spec.rb +28 -0
- data/spec/models/product_update_spec.rb +28 -0
- data/spec/models/{business_create_spec.rb → sync_login_dto_spec.rb} +7 -7
- data/spec/models/{business_spec.rb → webhook_entitlement_grant_payload_spec.rb} +17 -53
- metadata +162 -254
- data/docs/AffiliateApi.md +0 -845
- data/docs/BillingApi.md +0 -68
- data/docs/BrandsApi.md +0 -286
- data/docs/Business.md +0 -56
- data/docs/BusinessCreate.md +0 -18
- data/docs/BusinessFullCreate.md +0 -26
- data/docs/BusinessFullCreateResponse.md +0 -20
- data/docs/BusinessesApi.md +0 -350
- data/docs/ChatApi.md +0 -246
- data/docs/CommunityApi.md +0 -497
- data/docs/PartnerApi.md +0 -125
- data/docs/PayoutAccessToken.md +0 -20
- data/docs/PayoutAccount.md +0 -22
- data/docs/PayoutAccountLink.md +0 -20
- data/docs/PayoutMethod.md +0 -24
- data/docs/PayoutMethodList.md +0 -18
- data/docs/PayoutVerification.md +0 -24
- data/docs/PayoutVerificationList.md +0 -18
- data/docs/PayoutsApi.md +0 -579
- data/docs/TicketApi.md +0 -318
- data/docs/UserPage.md +0 -26
- data/docs/UserProfileThemesApi.md +0 -345
- data/docs/UserSettings.md +0 -34
- data/docs/UserSettingsUpdate.md +0 -76
- data/docs/UserStats.md +0 -20
- data/docs/UserTheme.md +0 -26
- data/docs/UserThemeUpdate.md +0 -22
- data/docs/WhopApiKeysRotation.md +0 -18
- data/docs/Withdrawal.md +0 -46
- data/docs/WithdrawalCreate.md +0 -22
- data/docs/WithdrawalList.md +0 -20
- data/lib/solifyn/api/affiliate_api.rb +0 -760
- data/lib/solifyn/api/billing_api.rb +0 -77
- data/lib/solifyn/api/brands_api.rb +0 -284
- data/lib/solifyn/api/businesses_api.rb +0 -338
- data/lib/solifyn/api/chat_api.rb +0 -232
- data/lib/solifyn/api/community_api.rb +0 -466
- data/lib/solifyn/api/payouts_api.rb +0 -520
- data/lib/solifyn/api/ticket_api.rb +0 -328
- data/lib/solifyn/api/user_profile_themes_api.rb +0 -313
- data/lib/solifyn/models/business.rb +0 -482
- data/lib/solifyn/models/business_create.rb +0 -241
- data/lib/solifyn/models/business_full_create.rb +0 -288
- data/lib/solifyn/models/business_full_create_response.rb +0 -239
- data/lib/solifyn/models/payout_access_token.rb +0 -239
- data/lib/solifyn/models/payout_account_link.rb +0 -239
- data/lib/solifyn/models/payout_verification_list.rb +0 -224
- data/lib/solifyn/models/user_page.rb +0 -290
- data/lib/solifyn/models/user_settings.rb +0 -337
- data/lib/solifyn/models/user_settings_update.rb +0 -505
- data/lib/solifyn/models/user_stats.rb +0 -241
- data/lib/solifyn/models/user_theme.rb +0 -276
- data/lib/solifyn/models/user_theme_update.rb +0 -235
- data/lib/solifyn/models/whop_api_keys_rotation.rb +0 -222
- data/lib/solifyn/models/withdrawal_create.rb +0 -249
- data/lib/solifyn/models/withdrawal_list.rb +0 -241
- data/spec/api/affiliate_api_spec.rb +0 -165
- data/spec/api/billing_api_spec.rb +0 -46
- data/spec/api/brands_api_spec.rb +0 -83
- data/spec/api/businesses_api_spec.rb +0 -93
- data/spec/api/chat_api_spec.rb +0 -72
- data/spec/api/community_api_spec.rb +0 -113
- data/spec/api/payouts_api_spec.rb +0 -133
- data/spec/api/ticket_api_spec.rb +0 -86
- data/spec/api/user_profile_themes_api_spec.rb +0 -91
- data/spec/models/business_full_create_response_spec.rb +0 -42
- data/spec/models/business_full_create_spec.rb +0 -60
- data/spec/models/payout_access_token_spec.rb +0 -42
- data/spec/models/payout_account_link_spec.rb +0 -42
- data/spec/models/payout_method_list_spec.rb +0 -36
- data/spec/models/payout_verification_list_spec.rb +0 -36
- data/spec/models/payout_verification_spec.rb +0 -54
- data/spec/models/user_page_spec.rb +0 -60
- data/spec/models/user_settings_spec.rb +0 -84
- data/spec/models/user_settings_update_spec.rb +0 -210
- data/spec/models/user_stats_spec.rb +0 -42
- data/spec/models/user_theme_spec.rb +0 -60
- data/spec/models/user_theme_update_spec.rb +0 -48
- data/spec/models/whop_api_keys_rotation_spec.rb +0 -36
- data/spec/models/withdrawal_create_spec.rb +0 -48
- data/spec/models/withdrawal_list_spec.rb +0 -42
data/docs/TicketApi.md
DELETED
|
@@ -1,318 +0,0 @@
|
|
|
1
|
-
# Solifyn::TicketApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *http://localhost:8000*
|
|
4
|
-
|
|
5
|
-
| Method | HTTP request | Description |
|
|
6
|
-
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**ticket_controller_create_ticket**](TicketApi.md#ticket_controller_create_ticket) | **POST** /v1/tickets | |
|
|
8
|
-
| [**ticket_controller_get_ticket_details**](TicketApi.md#ticket_controller_get_ticket_details) | **GET** /v1/tickets/{id} | |
|
|
9
|
-
| [**ticket_controller_get_tickets**](TicketApi.md#ticket_controller_get_tickets) | **GET** /v1/tickets | |
|
|
10
|
-
| [**ticket_controller_reply_ticket**](TicketApi.md#ticket_controller_reply_ticket) | **POST** /v1/tickets/{id}/replies | |
|
|
11
|
-
| [**ticket_controller_update_ticket**](TicketApi.md#ticket_controller_update_ticket) | **PATCH** /v1/tickets/{id} | |
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
## ticket_controller_create_ticket
|
|
15
|
-
|
|
16
|
-
> ticket_controller_create_ticket(body)
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
### Examples
|
|
21
|
-
|
|
22
|
-
```ruby
|
|
23
|
-
require 'time'
|
|
24
|
-
require 'solifyn'
|
|
25
|
-
|
|
26
|
-
api_instance = Solifyn::TicketApi.new
|
|
27
|
-
body = { ... } # Object |
|
|
28
|
-
|
|
29
|
-
begin
|
|
30
|
-
|
|
31
|
-
api_instance.ticket_controller_create_ticket(body)
|
|
32
|
-
rescue Solifyn::ApiError => e
|
|
33
|
-
puts "Error when calling TicketApi->ticket_controller_create_ticket: #{e}"
|
|
34
|
-
end
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
#### Using the ticket_controller_create_ticket_with_http_info variant
|
|
38
|
-
|
|
39
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
40
|
-
|
|
41
|
-
> <Array(nil, Integer, Hash)> ticket_controller_create_ticket_with_http_info(body)
|
|
42
|
-
|
|
43
|
-
```ruby
|
|
44
|
-
begin
|
|
45
|
-
|
|
46
|
-
data, status_code, headers = api_instance.ticket_controller_create_ticket_with_http_info(body)
|
|
47
|
-
p status_code # => 2xx
|
|
48
|
-
p headers # => { ... }
|
|
49
|
-
p data # => nil
|
|
50
|
-
rescue Solifyn::ApiError => e
|
|
51
|
-
puts "Error when calling TicketApi->ticket_controller_create_ticket_with_http_info: #{e}"
|
|
52
|
-
end
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
### Parameters
|
|
56
|
-
|
|
57
|
-
| Name | Type | Description | Notes |
|
|
58
|
-
| ---- | ---- | ----------- | ----- |
|
|
59
|
-
| **body** | **Object** | | |
|
|
60
|
-
|
|
61
|
-
### Return type
|
|
62
|
-
|
|
63
|
-
nil (empty response body)
|
|
64
|
-
|
|
65
|
-
### Authorization
|
|
66
|
-
|
|
67
|
-
No authorization required
|
|
68
|
-
|
|
69
|
-
### HTTP request headers
|
|
70
|
-
|
|
71
|
-
- **Content-Type**: application/json
|
|
72
|
-
- **Accept**: Not defined
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
## ticket_controller_get_ticket_details
|
|
76
|
-
|
|
77
|
-
> ticket_controller_get_ticket_details(id)
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
### Examples
|
|
82
|
-
|
|
83
|
-
```ruby
|
|
84
|
-
require 'time'
|
|
85
|
-
require 'solifyn'
|
|
86
|
-
|
|
87
|
-
api_instance = Solifyn::TicketApi.new
|
|
88
|
-
id = 'id_example' # String |
|
|
89
|
-
|
|
90
|
-
begin
|
|
91
|
-
|
|
92
|
-
api_instance.ticket_controller_get_ticket_details(id)
|
|
93
|
-
rescue Solifyn::ApiError => e
|
|
94
|
-
puts "Error when calling TicketApi->ticket_controller_get_ticket_details: #{e}"
|
|
95
|
-
end
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
#### Using the ticket_controller_get_ticket_details_with_http_info variant
|
|
99
|
-
|
|
100
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
101
|
-
|
|
102
|
-
> <Array(nil, Integer, Hash)> ticket_controller_get_ticket_details_with_http_info(id)
|
|
103
|
-
|
|
104
|
-
```ruby
|
|
105
|
-
begin
|
|
106
|
-
|
|
107
|
-
data, status_code, headers = api_instance.ticket_controller_get_ticket_details_with_http_info(id)
|
|
108
|
-
p status_code # => 2xx
|
|
109
|
-
p headers # => { ... }
|
|
110
|
-
p data # => nil
|
|
111
|
-
rescue Solifyn::ApiError => e
|
|
112
|
-
puts "Error when calling TicketApi->ticket_controller_get_ticket_details_with_http_info: #{e}"
|
|
113
|
-
end
|
|
114
|
-
```
|
|
115
|
-
|
|
116
|
-
### Parameters
|
|
117
|
-
|
|
118
|
-
| Name | Type | Description | Notes |
|
|
119
|
-
| ---- | ---- | ----------- | ----- |
|
|
120
|
-
| **id** | **String** | | |
|
|
121
|
-
|
|
122
|
-
### Return type
|
|
123
|
-
|
|
124
|
-
nil (empty response body)
|
|
125
|
-
|
|
126
|
-
### Authorization
|
|
127
|
-
|
|
128
|
-
No authorization required
|
|
129
|
-
|
|
130
|
-
### HTTP request headers
|
|
131
|
-
|
|
132
|
-
- **Content-Type**: Not defined
|
|
133
|
-
- **Accept**: Not defined
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
## ticket_controller_get_tickets
|
|
137
|
-
|
|
138
|
-
> ticket_controller_get_tickets
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
### Examples
|
|
143
|
-
|
|
144
|
-
```ruby
|
|
145
|
-
require 'time'
|
|
146
|
-
require 'solifyn'
|
|
147
|
-
|
|
148
|
-
api_instance = Solifyn::TicketApi.new
|
|
149
|
-
|
|
150
|
-
begin
|
|
151
|
-
|
|
152
|
-
api_instance.ticket_controller_get_tickets
|
|
153
|
-
rescue Solifyn::ApiError => e
|
|
154
|
-
puts "Error when calling TicketApi->ticket_controller_get_tickets: #{e}"
|
|
155
|
-
end
|
|
156
|
-
```
|
|
157
|
-
|
|
158
|
-
#### Using the ticket_controller_get_tickets_with_http_info variant
|
|
159
|
-
|
|
160
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
161
|
-
|
|
162
|
-
> <Array(nil, Integer, Hash)> ticket_controller_get_tickets_with_http_info
|
|
163
|
-
|
|
164
|
-
```ruby
|
|
165
|
-
begin
|
|
166
|
-
|
|
167
|
-
data, status_code, headers = api_instance.ticket_controller_get_tickets_with_http_info
|
|
168
|
-
p status_code # => 2xx
|
|
169
|
-
p headers # => { ... }
|
|
170
|
-
p data # => nil
|
|
171
|
-
rescue Solifyn::ApiError => e
|
|
172
|
-
puts "Error when calling TicketApi->ticket_controller_get_tickets_with_http_info: #{e}"
|
|
173
|
-
end
|
|
174
|
-
```
|
|
175
|
-
|
|
176
|
-
### Parameters
|
|
177
|
-
|
|
178
|
-
This endpoint does not need any parameter.
|
|
179
|
-
|
|
180
|
-
### Return type
|
|
181
|
-
|
|
182
|
-
nil (empty response body)
|
|
183
|
-
|
|
184
|
-
### Authorization
|
|
185
|
-
|
|
186
|
-
No authorization required
|
|
187
|
-
|
|
188
|
-
### HTTP request headers
|
|
189
|
-
|
|
190
|
-
- **Content-Type**: Not defined
|
|
191
|
-
- **Accept**: Not defined
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
## ticket_controller_reply_ticket
|
|
195
|
-
|
|
196
|
-
> ticket_controller_reply_ticket(id, body)
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
### Examples
|
|
201
|
-
|
|
202
|
-
```ruby
|
|
203
|
-
require 'time'
|
|
204
|
-
require 'solifyn'
|
|
205
|
-
|
|
206
|
-
api_instance = Solifyn::TicketApi.new
|
|
207
|
-
id = 'id_example' # String |
|
|
208
|
-
body = { ... } # Object |
|
|
209
|
-
|
|
210
|
-
begin
|
|
211
|
-
|
|
212
|
-
api_instance.ticket_controller_reply_ticket(id, body)
|
|
213
|
-
rescue Solifyn::ApiError => e
|
|
214
|
-
puts "Error when calling TicketApi->ticket_controller_reply_ticket: #{e}"
|
|
215
|
-
end
|
|
216
|
-
```
|
|
217
|
-
|
|
218
|
-
#### Using the ticket_controller_reply_ticket_with_http_info variant
|
|
219
|
-
|
|
220
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
221
|
-
|
|
222
|
-
> <Array(nil, Integer, Hash)> ticket_controller_reply_ticket_with_http_info(id, body)
|
|
223
|
-
|
|
224
|
-
```ruby
|
|
225
|
-
begin
|
|
226
|
-
|
|
227
|
-
data, status_code, headers = api_instance.ticket_controller_reply_ticket_with_http_info(id, body)
|
|
228
|
-
p status_code # => 2xx
|
|
229
|
-
p headers # => { ... }
|
|
230
|
-
p data # => nil
|
|
231
|
-
rescue Solifyn::ApiError => e
|
|
232
|
-
puts "Error when calling TicketApi->ticket_controller_reply_ticket_with_http_info: #{e}"
|
|
233
|
-
end
|
|
234
|
-
```
|
|
235
|
-
|
|
236
|
-
### Parameters
|
|
237
|
-
|
|
238
|
-
| Name | Type | Description | Notes |
|
|
239
|
-
| ---- | ---- | ----------- | ----- |
|
|
240
|
-
| **id** | **String** | | |
|
|
241
|
-
| **body** | **Object** | | |
|
|
242
|
-
|
|
243
|
-
### Return type
|
|
244
|
-
|
|
245
|
-
nil (empty response body)
|
|
246
|
-
|
|
247
|
-
### Authorization
|
|
248
|
-
|
|
249
|
-
No authorization required
|
|
250
|
-
|
|
251
|
-
### HTTP request headers
|
|
252
|
-
|
|
253
|
-
- **Content-Type**: application/json
|
|
254
|
-
- **Accept**: Not defined
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
## ticket_controller_update_ticket
|
|
258
|
-
|
|
259
|
-
> ticket_controller_update_ticket(id, body)
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
### Examples
|
|
264
|
-
|
|
265
|
-
```ruby
|
|
266
|
-
require 'time'
|
|
267
|
-
require 'solifyn'
|
|
268
|
-
|
|
269
|
-
api_instance = Solifyn::TicketApi.new
|
|
270
|
-
id = 'id_example' # String |
|
|
271
|
-
body = { ... } # Object |
|
|
272
|
-
|
|
273
|
-
begin
|
|
274
|
-
|
|
275
|
-
api_instance.ticket_controller_update_ticket(id, body)
|
|
276
|
-
rescue Solifyn::ApiError => e
|
|
277
|
-
puts "Error when calling TicketApi->ticket_controller_update_ticket: #{e}"
|
|
278
|
-
end
|
|
279
|
-
```
|
|
280
|
-
|
|
281
|
-
#### Using the ticket_controller_update_ticket_with_http_info variant
|
|
282
|
-
|
|
283
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
284
|
-
|
|
285
|
-
> <Array(nil, Integer, Hash)> ticket_controller_update_ticket_with_http_info(id, body)
|
|
286
|
-
|
|
287
|
-
```ruby
|
|
288
|
-
begin
|
|
289
|
-
|
|
290
|
-
data, status_code, headers = api_instance.ticket_controller_update_ticket_with_http_info(id, body)
|
|
291
|
-
p status_code # => 2xx
|
|
292
|
-
p headers # => { ... }
|
|
293
|
-
p data # => nil
|
|
294
|
-
rescue Solifyn::ApiError => e
|
|
295
|
-
puts "Error when calling TicketApi->ticket_controller_update_ticket_with_http_info: #{e}"
|
|
296
|
-
end
|
|
297
|
-
```
|
|
298
|
-
|
|
299
|
-
### Parameters
|
|
300
|
-
|
|
301
|
-
| Name | Type | Description | Notes |
|
|
302
|
-
| ---- | ---- | ----------- | ----- |
|
|
303
|
-
| **id** | **String** | | |
|
|
304
|
-
| **body** | **Object** | | |
|
|
305
|
-
|
|
306
|
-
### Return type
|
|
307
|
-
|
|
308
|
-
nil (empty response body)
|
|
309
|
-
|
|
310
|
-
### Authorization
|
|
311
|
-
|
|
312
|
-
No authorization required
|
|
313
|
-
|
|
314
|
-
### HTTP request headers
|
|
315
|
-
|
|
316
|
-
- **Content-Type**: application/json
|
|
317
|
-
- **Accept**: Not defined
|
|
318
|
-
|
data/docs/UserPage.md
DELETED
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
# Solifyn::UserPage
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **id** | **String** | Store page record ID | |
|
|
8
|
-
| **subdomain** | **String** | Unique subdomain | |
|
|
9
|
-
| **store_name** | **String** | Friendly store name | |
|
|
10
|
-
| **config** | **Object** | Styling config JSON | |
|
|
11
|
-
| **business_id** | **String** | Linked business ID | |
|
|
12
|
-
|
|
13
|
-
## Example
|
|
14
|
-
|
|
15
|
-
```ruby
|
|
16
|
-
require 'solifyn'
|
|
17
|
-
|
|
18
|
-
instance = Solifyn::UserPage.new(
|
|
19
|
-
id: page_123,
|
|
20
|
-
subdomain: acme,
|
|
21
|
-
store_name: Acme Shop,
|
|
22
|
-
config: {"theme":{"primaryColor":"#0f172a"}},
|
|
23
|
-
business_id: biz_123
|
|
24
|
-
)
|
|
25
|
-
```
|
|
26
|
-
|
|
@@ -1,345 +0,0 @@
|
|
|
1
|
-
# Solifyn::UserProfileThemesApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *http://localhost:8000*
|
|
4
|
-
|
|
5
|
-
| Method | HTTP request | Description |
|
|
6
|
-
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**users_get_my_page**](UserProfileThemesApi.md#users_get_my_page) | **GET** /v1/user/my-page | Get My Page details |
|
|
8
|
-
| [**users_get_my_theme**](UserProfileThemesApi.md#users_get_my_theme) | **GET** /v1/user/my-theme | Get My Theme |
|
|
9
|
-
| [**users_get_settings**](UserProfileThemesApi.md#users_get_settings) | **GET** /v1/user/settings | Retrieve User Settings |
|
|
10
|
-
| [**users_get_stats**](UserProfileThemesApi.md#users_get_stats) | **GET** /v1/user/dashboard-stats | Get Dashboard Statistics |
|
|
11
|
-
| [**users_get_theme_by_subdomain**](UserProfileThemesApi.md#users_get_theme_by_subdomain) | **GET** /v1/user/theme/{subdomain} | Get Theme by Subdomain |
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
## users_get_my_page
|
|
15
|
-
|
|
16
|
-
> <UserPage> users_get_my_page
|
|
17
|
-
|
|
18
|
-
Get My Page details
|
|
19
|
-
|
|
20
|
-
Retrieve page settings and custom content configured for the store.
|
|
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::UserProfileThemesApi.new
|
|
34
|
-
|
|
35
|
-
begin
|
|
36
|
-
# Get My Page details
|
|
37
|
-
result = api_instance.users_get_my_page
|
|
38
|
-
p result
|
|
39
|
-
rescue Solifyn::ApiError => e
|
|
40
|
-
puts "Error when calling UserProfileThemesApi->users_get_my_page: #{e}"
|
|
41
|
-
end
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
#### Using the users_get_my_page_with_http_info variant
|
|
45
|
-
|
|
46
|
-
This returns an Array which contains the response data, status code and headers.
|
|
47
|
-
|
|
48
|
-
> <Array(<UserPage>, Integer, Hash)> users_get_my_page_with_http_info
|
|
49
|
-
|
|
50
|
-
```ruby
|
|
51
|
-
begin
|
|
52
|
-
# Get My Page details
|
|
53
|
-
data, status_code, headers = api_instance.users_get_my_page_with_http_info
|
|
54
|
-
p status_code # => 2xx
|
|
55
|
-
p headers # => { ... }
|
|
56
|
-
p data # => <UserPage>
|
|
57
|
-
rescue Solifyn::ApiError => e
|
|
58
|
-
puts "Error when calling UserProfileThemesApi->users_get_my_page_with_http_info: #{e}"
|
|
59
|
-
end
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
### Parameters
|
|
63
|
-
|
|
64
|
-
This endpoint does not need any parameter.
|
|
65
|
-
|
|
66
|
-
### Return type
|
|
67
|
-
|
|
68
|
-
[**UserPage**](UserPage.md)
|
|
69
|
-
|
|
70
|
-
### Authorization
|
|
71
|
-
|
|
72
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
73
|
-
|
|
74
|
-
### HTTP request headers
|
|
75
|
-
|
|
76
|
-
- **Content-Type**: Not defined
|
|
77
|
-
- **Accept**: application/json
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
## users_get_my_theme
|
|
81
|
-
|
|
82
|
-
> <UserTheme> users_get_my_theme
|
|
83
|
-
|
|
84
|
-
Get My Theme
|
|
85
|
-
|
|
86
|
-
Retrieve theme configurations for the active business context.
|
|
87
|
-
|
|
88
|
-
### Examples
|
|
89
|
-
|
|
90
|
-
```ruby
|
|
91
|
-
require 'time'
|
|
92
|
-
require 'solifyn'
|
|
93
|
-
# setup authorization
|
|
94
|
-
Solifyn.configure do |config|
|
|
95
|
-
# Configure Bearer authorization (API Key): ApiKeyAuth
|
|
96
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
97
|
-
end
|
|
98
|
-
|
|
99
|
-
api_instance = Solifyn::UserProfileThemesApi.new
|
|
100
|
-
|
|
101
|
-
begin
|
|
102
|
-
# Get My Theme
|
|
103
|
-
result = api_instance.users_get_my_theme
|
|
104
|
-
p result
|
|
105
|
-
rescue Solifyn::ApiError => e
|
|
106
|
-
puts "Error when calling UserProfileThemesApi->users_get_my_theme: #{e}"
|
|
107
|
-
end
|
|
108
|
-
```
|
|
109
|
-
|
|
110
|
-
#### Using the users_get_my_theme_with_http_info variant
|
|
111
|
-
|
|
112
|
-
This returns an Array which contains the response data, status code and headers.
|
|
113
|
-
|
|
114
|
-
> <Array(<UserTheme>, Integer, Hash)> users_get_my_theme_with_http_info
|
|
115
|
-
|
|
116
|
-
```ruby
|
|
117
|
-
begin
|
|
118
|
-
# Get My Theme
|
|
119
|
-
data, status_code, headers = api_instance.users_get_my_theme_with_http_info
|
|
120
|
-
p status_code # => 2xx
|
|
121
|
-
p headers # => { ... }
|
|
122
|
-
p data # => <UserTheme>
|
|
123
|
-
rescue Solifyn::ApiError => e
|
|
124
|
-
puts "Error when calling UserProfileThemesApi->users_get_my_theme_with_http_info: #{e}"
|
|
125
|
-
end
|
|
126
|
-
```
|
|
127
|
-
|
|
128
|
-
### Parameters
|
|
129
|
-
|
|
130
|
-
This endpoint does not need any parameter.
|
|
131
|
-
|
|
132
|
-
### Return type
|
|
133
|
-
|
|
134
|
-
[**UserTheme**](UserTheme.md)
|
|
135
|
-
|
|
136
|
-
### Authorization
|
|
137
|
-
|
|
138
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
139
|
-
|
|
140
|
-
### HTTP request headers
|
|
141
|
-
|
|
142
|
-
- **Content-Type**: Not defined
|
|
143
|
-
- **Accept**: application/json
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
## users_get_settings
|
|
147
|
-
|
|
148
|
-
> <UserSettings> users_get_settings
|
|
149
|
-
|
|
150
|
-
Retrieve User Settings
|
|
151
|
-
|
|
152
|
-
Retrieve profile settings and notification preferences for the user.
|
|
153
|
-
|
|
154
|
-
### Examples
|
|
155
|
-
|
|
156
|
-
```ruby
|
|
157
|
-
require 'time'
|
|
158
|
-
require 'solifyn'
|
|
159
|
-
# setup authorization
|
|
160
|
-
Solifyn.configure do |config|
|
|
161
|
-
# Configure Bearer authorization (API Key): ApiKeyAuth
|
|
162
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
163
|
-
end
|
|
164
|
-
|
|
165
|
-
api_instance = Solifyn::UserProfileThemesApi.new
|
|
166
|
-
|
|
167
|
-
begin
|
|
168
|
-
# Retrieve User Settings
|
|
169
|
-
result = api_instance.users_get_settings
|
|
170
|
-
p result
|
|
171
|
-
rescue Solifyn::ApiError => e
|
|
172
|
-
puts "Error when calling UserProfileThemesApi->users_get_settings: #{e}"
|
|
173
|
-
end
|
|
174
|
-
```
|
|
175
|
-
|
|
176
|
-
#### Using the users_get_settings_with_http_info variant
|
|
177
|
-
|
|
178
|
-
This returns an Array which contains the response data, status code and headers.
|
|
179
|
-
|
|
180
|
-
> <Array(<UserSettings>, Integer, Hash)> users_get_settings_with_http_info
|
|
181
|
-
|
|
182
|
-
```ruby
|
|
183
|
-
begin
|
|
184
|
-
# Retrieve User Settings
|
|
185
|
-
data, status_code, headers = api_instance.users_get_settings_with_http_info
|
|
186
|
-
p status_code # => 2xx
|
|
187
|
-
p headers # => { ... }
|
|
188
|
-
p data # => <UserSettings>
|
|
189
|
-
rescue Solifyn::ApiError => e
|
|
190
|
-
puts "Error when calling UserProfileThemesApi->users_get_settings_with_http_info: #{e}"
|
|
191
|
-
end
|
|
192
|
-
```
|
|
193
|
-
|
|
194
|
-
### Parameters
|
|
195
|
-
|
|
196
|
-
This endpoint does not need any parameter.
|
|
197
|
-
|
|
198
|
-
### Return type
|
|
199
|
-
|
|
200
|
-
[**UserSettings**](UserSettings.md)
|
|
201
|
-
|
|
202
|
-
### Authorization
|
|
203
|
-
|
|
204
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
205
|
-
|
|
206
|
-
### HTTP request headers
|
|
207
|
-
|
|
208
|
-
- **Content-Type**: Not defined
|
|
209
|
-
- **Accept**: application/json
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
## users_get_stats
|
|
213
|
-
|
|
214
|
-
> <UserStats> users_get_stats
|
|
215
|
-
|
|
216
|
-
Get Dashboard Statistics
|
|
217
|
-
|
|
218
|
-
Retrieve general analytics stats (revenue, order counts, etc.) for dashboard graphs.
|
|
219
|
-
|
|
220
|
-
### Examples
|
|
221
|
-
|
|
222
|
-
```ruby
|
|
223
|
-
require 'time'
|
|
224
|
-
require 'solifyn'
|
|
225
|
-
# setup authorization
|
|
226
|
-
Solifyn.configure do |config|
|
|
227
|
-
# Configure Bearer authorization (API Key): ApiKeyAuth
|
|
228
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
229
|
-
end
|
|
230
|
-
|
|
231
|
-
api_instance = Solifyn::UserProfileThemesApi.new
|
|
232
|
-
|
|
233
|
-
begin
|
|
234
|
-
# Get Dashboard Statistics
|
|
235
|
-
result = api_instance.users_get_stats
|
|
236
|
-
p result
|
|
237
|
-
rescue Solifyn::ApiError => e
|
|
238
|
-
puts "Error when calling UserProfileThemesApi->users_get_stats: #{e}"
|
|
239
|
-
end
|
|
240
|
-
```
|
|
241
|
-
|
|
242
|
-
#### Using the users_get_stats_with_http_info variant
|
|
243
|
-
|
|
244
|
-
This returns an Array which contains the response data, status code and headers.
|
|
245
|
-
|
|
246
|
-
> <Array(<UserStats>, Integer, Hash)> users_get_stats_with_http_info
|
|
247
|
-
|
|
248
|
-
```ruby
|
|
249
|
-
begin
|
|
250
|
-
# Get Dashboard Statistics
|
|
251
|
-
data, status_code, headers = api_instance.users_get_stats_with_http_info
|
|
252
|
-
p status_code # => 2xx
|
|
253
|
-
p headers # => { ... }
|
|
254
|
-
p data # => <UserStats>
|
|
255
|
-
rescue Solifyn::ApiError => e
|
|
256
|
-
puts "Error when calling UserProfileThemesApi->users_get_stats_with_http_info: #{e}"
|
|
257
|
-
end
|
|
258
|
-
```
|
|
259
|
-
|
|
260
|
-
### Parameters
|
|
261
|
-
|
|
262
|
-
This endpoint does not need any parameter.
|
|
263
|
-
|
|
264
|
-
### Return type
|
|
265
|
-
|
|
266
|
-
[**UserStats**](UserStats.md)
|
|
267
|
-
|
|
268
|
-
### Authorization
|
|
269
|
-
|
|
270
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
271
|
-
|
|
272
|
-
### HTTP request headers
|
|
273
|
-
|
|
274
|
-
- **Content-Type**: Not defined
|
|
275
|
-
- **Accept**: application/json
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
## users_get_theme_by_subdomain
|
|
279
|
-
|
|
280
|
-
> <UserTheme> users_get_theme_by_subdomain(subdomain)
|
|
281
|
-
|
|
282
|
-
Get Theme by Subdomain
|
|
283
|
-
|
|
284
|
-
Retrieve public theme configuration details by store subdomain.
|
|
285
|
-
|
|
286
|
-
### Examples
|
|
287
|
-
|
|
288
|
-
```ruby
|
|
289
|
-
require 'time'
|
|
290
|
-
require 'solifyn'
|
|
291
|
-
# setup authorization
|
|
292
|
-
Solifyn.configure do |config|
|
|
293
|
-
# Configure Bearer authorization (API Key): ApiKeyAuth
|
|
294
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
295
|
-
end
|
|
296
|
-
|
|
297
|
-
api_instance = Solifyn::UserProfileThemesApi.new
|
|
298
|
-
subdomain = 'acme' # String | The subdomain of the store
|
|
299
|
-
|
|
300
|
-
begin
|
|
301
|
-
# Get Theme by Subdomain
|
|
302
|
-
result = api_instance.users_get_theme_by_subdomain(subdomain)
|
|
303
|
-
p result
|
|
304
|
-
rescue Solifyn::ApiError => e
|
|
305
|
-
puts "Error when calling UserProfileThemesApi->users_get_theme_by_subdomain: #{e}"
|
|
306
|
-
end
|
|
307
|
-
```
|
|
308
|
-
|
|
309
|
-
#### Using the users_get_theme_by_subdomain_with_http_info variant
|
|
310
|
-
|
|
311
|
-
This returns an Array which contains the response data, status code and headers.
|
|
312
|
-
|
|
313
|
-
> <Array(<UserTheme>, Integer, Hash)> users_get_theme_by_subdomain_with_http_info(subdomain)
|
|
314
|
-
|
|
315
|
-
```ruby
|
|
316
|
-
begin
|
|
317
|
-
# Get Theme by Subdomain
|
|
318
|
-
data, status_code, headers = api_instance.users_get_theme_by_subdomain_with_http_info(subdomain)
|
|
319
|
-
p status_code # => 2xx
|
|
320
|
-
p headers # => { ... }
|
|
321
|
-
p data # => <UserTheme>
|
|
322
|
-
rescue Solifyn::ApiError => e
|
|
323
|
-
puts "Error when calling UserProfileThemesApi->users_get_theme_by_subdomain_with_http_info: #{e}"
|
|
324
|
-
end
|
|
325
|
-
```
|
|
326
|
-
|
|
327
|
-
### Parameters
|
|
328
|
-
|
|
329
|
-
| Name | Type | Description | Notes |
|
|
330
|
-
| ---- | ---- | ----------- | ----- |
|
|
331
|
-
| **subdomain** | **String** | The subdomain of the store | |
|
|
332
|
-
|
|
333
|
-
### Return type
|
|
334
|
-
|
|
335
|
-
[**UserTheme**](UserTheme.md)
|
|
336
|
-
|
|
337
|
-
### Authorization
|
|
338
|
-
|
|
339
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
340
|
-
|
|
341
|
-
### HTTP request headers
|
|
342
|
-
|
|
343
|
-
- **Content-Type**: Not defined
|
|
344
|
-
- **Accept**: application/json
|
|
345
|
-
|
data/docs/UserSettings.md
DELETED
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
# Solifyn::UserSettings
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **id** | **String** | User ID | |
|
|
8
|
-
| **email** | **String** | Primary email address | |
|
|
9
|
-
| **first_name** | **String** | First name | [optional] |
|
|
10
|
-
| **last_name** | **String** | Last name | [optional] |
|
|
11
|
-
| **avatar_url** | **String** | Profile avatar image URL | [optional] |
|
|
12
|
-
| **payout_threshold** | **Float** | Auto-payout minimum threshold limit in cents | |
|
|
13
|
-
| **notify_on_success** | **Boolean** | Auto-email receipt toggled | |
|
|
14
|
-
| **send_license_key_email** | **Boolean** | Send license keys email automatically | |
|
|
15
|
-
| **send_digital_file_email** | **Boolean** | Send digital delivery download link emails automatically | |
|
|
16
|
-
|
|
17
|
-
## Example
|
|
18
|
-
|
|
19
|
-
```ruby
|
|
20
|
-
require 'solifyn'
|
|
21
|
-
|
|
22
|
-
instance = Solifyn::UserSettings.new(
|
|
23
|
-
id: usr_123,
|
|
24
|
-
email: contact@acme.com,
|
|
25
|
-
first_name: John,
|
|
26
|
-
last_name: Doe,
|
|
27
|
-
avatar_url: https://acme.com/avatar.png,
|
|
28
|
-
payout_threshold: 5000,
|
|
29
|
-
notify_on_success: true,
|
|
30
|
-
send_license_key_email: true,
|
|
31
|
-
send_digital_file_email: true
|
|
32
|
-
)
|
|
33
|
-
```
|
|
34
|
-
|