late-sdk 0.0.1615 → 0.0.1617
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 +9 -9
- data/docs/CreateCreatorCampaignRequest.md +1 -1
- data/docs/{CreatorPortalPublicApi.md → CreatorPortalApi.md} +37 -37
- data/lib/zernio-sdk/api/{creator_portal_public_api.rb → creator_portal_api.rb} +52 -52
- data/lib/zernio-sdk/models/create_creator_campaign_request.rb +1 -0
- data/lib/zernio-sdk/version.rb +1 -1
- data/lib/zernio-sdk.rb +1 -1
- data/openapi.yaml +1 -1
- data/spec/api/{creator_portal_public_api_spec.rb → creator_portal_api_spec.rb} +6 -6
- data/zernio-sdk-0.0.1617.gem +0 -0
- metadata +6 -6
- data/zernio-sdk-0.0.1615.gem +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 4f02f0f7c8dfb18b2ef5fee9305d9eb97b0720d1190388781766e18741011cdd
|
|
4
|
+
data.tar.gz: 0730ada950c727c8b41fce7584540ae5a724043759ed9e14f301d013150f1671
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 47eaf275d6a1511156275583883083122fc34b82c0f73a2c22e28d7d30bf8e302f9d6d079ae11d5551d4f5817f7c31eedd08abe3c9e54ef33c9f49f3e2e7d4e6
|
|
7
|
+
data.tar.gz: e8a75f354084020d3886b9d1e1eec41d52f1df83aa6affd00734ab5e140bf428859ac7486b662fd886eb801c2185fd039dea0c1a9a790300096136df05784082
|
data/README.md
CHANGED
|
@@ -701,15 +701,15 @@ Class | Method | HTTP request | Description
|
|
|
701
701
|
*Zernio::CreatorCampaignsApi* | [**settle_campaign_participant**](docs/CreatorCampaignsApi.md#settle_campaign_participant) | **POST** /v1/creator-campaigns/{campaignId}/participants/{participantId}/settle | Settle campaign participant
|
|
702
702
|
*Zernio::CreatorCampaignsApi* | [**suspend_campaign_participant**](docs/CreatorCampaignsApi.md#suspend_campaign_participant) | **POST** /v1/creator-campaigns/{campaignId}/participants/{participantId}/suspend | Suspend campaign participant
|
|
703
703
|
*Zernio::CreatorCampaignsApi* | [**update_creator_campaign**](docs/CreatorCampaignsApi.md#update_creator_campaign) | **PATCH** /v1/creator-campaigns/{campaignId} | Update creator campaign
|
|
704
|
-
*Zernio::
|
|
705
|
-
*Zernio::
|
|
706
|
-
*Zernio::
|
|
707
|
-
*Zernio::
|
|
708
|
-
*Zernio::
|
|
709
|
-
*Zernio::
|
|
710
|
-
*Zernio::
|
|
711
|
-
*Zernio::
|
|
712
|
-
*Zernio::
|
|
704
|
+
*Zernio::CreatorPortalApi* | [**create_creator_payout_login**](docs/CreatorPortalApi.md#create_creator_payout_login) | **POST** /public/creator-campaigns/{token}/payout-login | Open the creator's Stripe dashboard
|
|
705
|
+
*Zernio::CreatorPortalApi* | [**get_creator_payout_statement**](docs/CreatorPortalApi.md#get_creator_payout_statement) | **GET** /public/creator-campaigns/{token}/payouts/{transferId}/statement | Download a payout statement
|
|
706
|
+
*Zernio::CreatorPortalApi* | [**get_creator_payouts**](docs/CreatorPortalApi.md#get_creator_payouts) | **GET** /public/creator-campaigns/{token}/payouts | List a creator's earnings history
|
|
707
|
+
*Zernio::CreatorPortalApi* | [**get_creator_portal**](docs/CreatorPortalApi.md#get_creator_portal) | **GET** /public/creator-campaigns/{token} | Read a creator invite or participant page
|
|
708
|
+
*Zernio::CreatorPortalApi* | [**join_creator_campaign**](docs/CreatorPortalApi.md#join_creator_campaign) | **POST** /public/creator-campaigns/{token} | Join a campaign
|
|
709
|
+
*Zernio::CreatorPortalApi* | [**recover_creator_portal_links**](docs/CreatorPortalApi.md#recover_creator_portal_links) | **POST** /public/creator-campaigns/recover-link | Email a creator their campaign links
|
|
710
|
+
*Zernio::CreatorPortalApi* | [**start_creator_connect**](docs/CreatorPortalApi.md#start_creator_connect) | **POST** /public/creator-campaigns/{token}/connect | Start connecting a creator account
|
|
711
|
+
*Zernio::CreatorPortalApi* | [**start_creator_payouts**](docs/CreatorPortalApi.md#start_creator_payouts) | **POST** /public/creator-campaigns/{token}/payouts | Start payout onboarding
|
|
712
|
+
*Zernio::CreatorPortalApi* | [**submit_creator_post**](docs/CreatorPortalApi.md#submit_creator_post) | **POST** /public/creator-campaigns/{token}/submissions | Submit a post
|
|
713
713
|
*Zernio::CustomFieldsApi* | [**clear_contact_field_value**](docs/CustomFieldsApi.md#clear_contact_field_value) | **DELETE** /v1/contacts/{contactId}/fields/{slug} | Clear custom field value
|
|
714
714
|
*Zernio::CustomFieldsApi* | [**create_custom_field**](docs/CustomFieldsApi.md#create_custom_field) | **POST** /v1/custom-fields | Create custom field
|
|
715
715
|
*Zernio::CustomFieldsApi* | [**delete_custom_field**](docs/CustomFieldsApi.md#delete_custom_field) | **DELETE** /v1/custom-fields/{fieldId} | Delete custom field
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
| **name** | **String** | | |
|
|
9
9
|
| **brand_name** | **String** | | |
|
|
10
10
|
| **economics** | [**CreatorCampaignEconomics**](CreatorCampaignEconomics.md) | | |
|
|
11
|
-
| **caps** | [**CreatorCampaignCaps**](CreatorCampaignCaps.md) |
|
|
11
|
+
| **caps** | [**CreatorCampaignCaps**](CreatorCampaignCaps.md) | Omitted, the campaign starts with authenticityThreshold 40 and no other caps. | [optional] |
|
|
12
12
|
| **platforms** | **Array<String>** | Platforms creators may post on. At least one is needed to activate. | [optional] |
|
|
13
13
|
| **content_rules** | **String** | | [optional] |
|
|
14
14
|
| **starts_at** | **Time** | | [optional] |
|
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
# Zernio::
|
|
1
|
+
# Zernio::CreatorPortalApi
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://zernio.com/api*
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**create_creator_payout_login**](
|
|
8
|
-
| [**get_creator_payout_statement**](
|
|
9
|
-
| [**get_creator_payouts**](
|
|
10
|
-
| [**get_creator_portal**](
|
|
11
|
-
| [**join_creator_campaign**](
|
|
12
|
-
| [**recover_creator_portal_links**](
|
|
13
|
-
| [**start_creator_connect**](
|
|
14
|
-
| [**start_creator_payouts**](
|
|
15
|
-
| [**submit_creator_post**](
|
|
7
|
+
| [**create_creator_payout_login**](CreatorPortalApi.md#create_creator_payout_login) | **POST** /public/creator-campaigns/{token}/payout-login | Open the creator's Stripe dashboard |
|
|
8
|
+
| [**get_creator_payout_statement**](CreatorPortalApi.md#get_creator_payout_statement) | **GET** /public/creator-campaigns/{token}/payouts/{transferId}/statement | Download a payout statement |
|
|
9
|
+
| [**get_creator_payouts**](CreatorPortalApi.md#get_creator_payouts) | **GET** /public/creator-campaigns/{token}/payouts | List a creator's earnings history |
|
|
10
|
+
| [**get_creator_portal**](CreatorPortalApi.md#get_creator_portal) | **GET** /public/creator-campaigns/{token} | Read a creator invite or participant page |
|
|
11
|
+
| [**join_creator_campaign**](CreatorPortalApi.md#join_creator_campaign) | **POST** /public/creator-campaigns/{token} | Join a campaign |
|
|
12
|
+
| [**recover_creator_portal_links**](CreatorPortalApi.md#recover_creator_portal_links) | **POST** /public/creator-campaigns/recover-link | Email a creator their campaign links |
|
|
13
|
+
| [**start_creator_connect**](CreatorPortalApi.md#start_creator_connect) | **POST** /public/creator-campaigns/{token}/connect | Start connecting a creator account |
|
|
14
|
+
| [**start_creator_payouts**](CreatorPortalApi.md#start_creator_payouts) | **POST** /public/creator-campaigns/{token}/payouts | Start payout onboarding |
|
|
15
|
+
| [**submit_creator_post**](CreatorPortalApi.md#submit_creator_post) | **POST** /public/creator-campaigns/{token}/submissions | Submit a post |
|
|
16
16
|
|
|
17
17
|
|
|
18
18
|
## create_creator_payout_login
|
|
@@ -29,7 +29,7 @@ Returns a one-time link into the creator's Stripe Express dashboard, where they
|
|
|
29
29
|
require 'time'
|
|
30
30
|
require 'zernio-sdk'
|
|
31
31
|
|
|
32
|
-
api_instance = Zernio::
|
|
32
|
+
api_instance = Zernio::CreatorPortalApi.new
|
|
33
33
|
token = 'token_example' # String | A participant token or an open invite token. A malformed token answers 404 like an unknown one.
|
|
34
34
|
|
|
35
35
|
begin
|
|
@@ -37,7 +37,7 @@ begin
|
|
|
37
37
|
result = api_instance.create_creator_payout_login(token)
|
|
38
38
|
p result
|
|
39
39
|
rescue Zernio::ApiError => e
|
|
40
|
-
puts "Error when calling
|
|
40
|
+
puts "Error when calling CreatorPortalApi->create_creator_payout_login: #{e}"
|
|
41
41
|
end
|
|
42
42
|
```
|
|
43
43
|
|
|
@@ -55,7 +55,7 @@ begin
|
|
|
55
55
|
p headers # => { ... }
|
|
56
56
|
p data # => <StartCreatorPayouts200Response>
|
|
57
57
|
rescue Zernio::ApiError => e
|
|
58
|
-
puts "Error when calling
|
|
58
|
+
puts "Error when calling CreatorPortalApi->create_creator_payout_login_with_http_info: #{e}"
|
|
59
59
|
end
|
|
60
60
|
```
|
|
61
61
|
|
|
@@ -93,7 +93,7 @@ A PDF statement of one paid payout to this creator: who paid, the campaign, the
|
|
|
93
93
|
require 'time'
|
|
94
94
|
require 'zernio-sdk'
|
|
95
95
|
|
|
96
|
-
api_instance = Zernio::
|
|
96
|
+
api_instance = Zernio::CreatorPortalApi.new
|
|
97
97
|
token = 'token_example' # String | A participant token or an open invite token. A malformed token answers 404 like an unknown one.
|
|
98
98
|
transfer_id = 'transfer_id_example' # String |
|
|
99
99
|
|
|
@@ -102,7 +102,7 @@ begin
|
|
|
102
102
|
result = api_instance.get_creator_payout_statement(token, transfer_id)
|
|
103
103
|
p result
|
|
104
104
|
rescue Zernio::ApiError => e
|
|
105
|
-
puts "Error when calling
|
|
105
|
+
puts "Error when calling CreatorPortalApi->get_creator_payout_statement: #{e}"
|
|
106
106
|
end
|
|
107
107
|
```
|
|
108
108
|
|
|
@@ -120,7 +120,7 @@ begin
|
|
|
120
120
|
p headers # => { ... }
|
|
121
121
|
p data # => File
|
|
122
122
|
rescue Zernio::ApiError => e
|
|
123
|
-
puts "Error when calling
|
|
123
|
+
puts "Error when calling CreatorPortalApi->get_creator_payout_statement_with_http_info: #{e}"
|
|
124
124
|
end
|
|
125
125
|
```
|
|
126
126
|
|
|
@@ -159,7 +159,7 @@ The participant's ledger entries, newest first, with the bucket each one moved m
|
|
|
159
159
|
require 'time'
|
|
160
160
|
require 'zernio-sdk'
|
|
161
161
|
|
|
162
|
-
api_instance = Zernio::
|
|
162
|
+
api_instance = Zernio::CreatorPortalApi.new
|
|
163
163
|
token = 'token_example' # String | A participant token or an open invite token. A malformed token answers 404 like an unknown one.
|
|
164
164
|
opts = {
|
|
165
165
|
limit: 56, # Integer |
|
|
@@ -171,7 +171,7 @@ begin
|
|
|
171
171
|
result = api_instance.get_creator_payouts(token, opts)
|
|
172
172
|
p result
|
|
173
173
|
rescue Zernio::ApiError => e
|
|
174
|
-
puts "Error when calling
|
|
174
|
+
puts "Error when calling CreatorPortalApi->get_creator_payouts: #{e}"
|
|
175
175
|
end
|
|
176
176
|
```
|
|
177
177
|
|
|
@@ -189,7 +189,7 @@ begin
|
|
|
189
189
|
p headers # => { ... }
|
|
190
190
|
p data # => <GetCreatorPayouts200Response>
|
|
191
191
|
rescue Zernio::ApiError => e
|
|
192
|
-
puts "Error when calling
|
|
192
|
+
puts "Error when calling CreatorPortalApi->get_creator_payouts_with_http_info: #{e}"
|
|
193
193
|
end
|
|
194
194
|
```
|
|
195
195
|
|
|
@@ -229,7 +229,7 @@ What a creator sees behind a campaign link, with no API key. `token` is either a
|
|
|
229
229
|
require 'time'
|
|
230
230
|
require 'zernio-sdk'
|
|
231
231
|
|
|
232
|
-
api_instance = Zernio::
|
|
232
|
+
api_instance = Zernio::CreatorPortalApi.new
|
|
233
233
|
token = 'token_example' # String | A participant token or an open invite token. A malformed token answers 404 like an unknown one.
|
|
234
234
|
|
|
235
235
|
begin
|
|
@@ -237,7 +237,7 @@ begin
|
|
|
237
237
|
result = api_instance.get_creator_portal(token)
|
|
238
238
|
p result
|
|
239
239
|
rescue Zernio::ApiError => e
|
|
240
|
-
puts "Error when calling
|
|
240
|
+
puts "Error when calling CreatorPortalApi->get_creator_portal: #{e}"
|
|
241
241
|
end
|
|
242
242
|
```
|
|
243
243
|
|
|
@@ -255,7 +255,7 @@ begin
|
|
|
255
255
|
p headers # => { ... }
|
|
256
256
|
p data # => <GetCreatorPortal200Response>
|
|
257
257
|
rescue Zernio::ApiError => e
|
|
258
|
-
puts "Error when calling
|
|
258
|
+
puts "Error when calling CreatorPortalApi->get_creator_portal_with_http_info: #{e}"
|
|
259
259
|
end
|
|
260
260
|
```
|
|
261
261
|
|
|
@@ -293,7 +293,7 @@ Accepts a participant invite, or joins through an open invite link. With a parti
|
|
|
293
293
|
require 'time'
|
|
294
294
|
require 'zernio-sdk'
|
|
295
295
|
|
|
296
|
-
api_instance = Zernio::
|
|
296
|
+
api_instance = Zernio::CreatorPortalApi.new
|
|
297
297
|
token = 'token_example' # String | A participant token or an open invite token. A malformed token answers 404 like an unknown one.
|
|
298
298
|
opts = {
|
|
299
299
|
join_creator_campaign_request: Zernio::JoinCreatorCampaignRequest.new # JoinCreatorCampaignRequest |
|
|
@@ -304,7 +304,7 @@ begin
|
|
|
304
304
|
result = api_instance.join_creator_campaign(token, opts)
|
|
305
305
|
p result
|
|
306
306
|
rescue Zernio::ApiError => e
|
|
307
|
-
puts "Error when calling
|
|
307
|
+
puts "Error when calling CreatorPortalApi->join_creator_campaign: #{e}"
|
|
308
308
|
end
|
|
309
309
|
```
|
|
310
310
|
|
|
@@ -322,7 +322,7 @@ begin
|
|
|
322
322
|
p headers # => { ... }
|
|
323
323
|
p data # => <JoinCreatorCampaign201Response>
|
|
324
324
|
rescue Zernio::ApiError => e
|
|
325
|
-
puts "Error when calling
|
|
325
|
+
puts "Error when calling CreatorPortalApi->join_creator_campaign_with_http_info: #{e}"
|
|
326
326
|
end
|
|
327
327
|
```
|
|
328
328
|
|
|
@@ -361,7 +361,7 @@ For a creator who lost their link. Emails every personal participant link held b
|
|
|
361
361
|
require 'time'
|
|
362
362
|
require 'zernio-sdk'
|
|
363
363
|
|
|
364
|
-
api_instance = Zernio::
|
|
364
|
+
api_instance = Zernio::CreatorPortalApi.new
|
|
365
365
|
recover_creator_portal_links_request = Zernio::RecoverCreatorPortalLinksRequest.new({email: 'email_example'}) # RecoverCreatorPortalLinksRequest |
|
|
366
366
|
|
|
367
367
|
begin
|
|
@@ -369,7 +369,7 @@ begin
|
|
|
369
369
|
result = api_instance.recover_creator_portal_links(recover_creator_portal_links_request)
|
|
370
370
|
p result
|
|
371
371
|
rescue Zernio::ApiError => e
|
|
372
|
-
puts "Error when calling
|
|
372
|
+
puts "Error when calling CreatorPortalApi->recover_creator_portal_links: #{e}"
|
|
373
373
|
end
|
|
374
374
|
```
|
|
375
375
|
|
|
@@ -387,7 +387,7 @@ begin
|
|
|
387
387
|
p headers # => { ... }
|
|
388
388
|
p data # => <RecoverCreatorPortalLinks202Response>
|
|
389
389
|
rescue Zernio::ApiError => e
|
|
390
|
-
puts "Error when calling
|
|
390
|
+
puts "Error when calling CreatorPortalApi->recover_creator_portal_links_with_http_info: #{e}"
|
|
391
391
|
end
|
|
392
392
|
```
|
|
393
393
|
|
|
@@ -425,7 +425,7 @@ Returns the authorization URL that connects one of the creator's own social acco
|
|
|
425
425
|
require 'time'
|
|
426
426
|
require 'zernio-sdk'
|
|
427
427
|
|
|
428
|
-
api_instance = Zernio::
|
|
428
|
+
api_instance = Zernio::CreatorPortalApi.new
|
|
429
429
|
token = 'token_example' # String | A participant token or an open invite token. A malformed token answers 404 like an unknown one.
|
|
430
430
|
start_creator_connect_request = Zernio::StartCreatorConnectRequest.new({platform: 'platform_example'}) # StartCreatorConnectRequest |
|
|
431
431
|
|
|
@@ -434,7 +434,7 @@ begin
|
|
|
434
434
|
result = api_instance.start_creator_connect(token, start_creator_connect_request)
|
|
435
435
|
p result
|
|
436
436
|
rescue Zernio::ApiError => e
|
|
437
|
-
puts "Error when calling
|
|
437
|
+
puts "Error when calling CreatorPortalApi->start_creator_connect: #{e}"
|
|
438
438
|
end
|
|
439
439
|
```
|
|
440
440
|
|
|
@@ -452,7 +452,7 @@ begin
|
|
|
452
452
|
p headers # => { ... }
|
|
453
453
|
p data # => <StartCreatorConnect200Response>
|
|
454
454
|
rescue Zernio::ApiError => e
|
|
455
|
-
puts "Error when calling
|
|
455
|
+
puts "Error when calling CreatorPortalApi->start_creator_connect_with_http_info: #{e}"
|
|
456
456
|
end
|
|
457
457
|
```
|
|
458
458
|
|
|
@@ -491,7 +491,7 @@ For a campaign that pays through the Zernio treasury: creates the creator's paye
|
|
|
491
491
|
require 'time'
|
|
492
492
|
require 'zernio-sdk'
|
|
493
493
|
|
|
494
|
-
api_instance = Zernio::
|
|
494
|
+
api_instance = Zernio::CreatorPortalApi.new
|
|
495
495
|
token = 'token_example' # String | A participant token or an open invite token. A malformed token answers 404 like an unknown one.
|
|
496
496
|
start_creator_payouts_request = Zernio::StartCreatorPayoutsRequest.new({action: 'onboard'}) # StartCreatorPayoutsRequest |
|
|
497
497
|
|
|
@@ -500,7 +500,7 @@ begin
|
|
|
500
500
|
result = api_instance.start_creator_payouts(token, start_creator_payouts_request)
|
|
501
501
|
p result
|
|
502
502
|
rescue Zernio::ApiError => e
|
|
503
|
-
puts "Error when calling
|
|
503
|
+
puts "Error when calling CreatorPortalApi->start_creator_payouts: #{e}"
|
|
504
504
|
end
|
|
505
505
|
```
|
|
506
506
|
|
|
@@ -518,7 +518,7 @@ begin
|
|
|
518
518
|
p headers # => { ... }
|
|
519
519
|
p data # => <StartCreatorPayouts200Response>
|
|
520
520
|
rescue Zernio::ApiError => e
|
|
521
|
-
puts "Error when calling
|
|
521
|
+
puts "Error when calling CreatorPortalApi->start_creator_payouts_with_http_info: #{e}"
|
|
522
522
|
end
|
|
523
523
|
```
|
|
524
524
|
|
|
@@ -557,7 +557,7 @@ Submits the link to a post the creator published from a connected account. The p
|
|
|
557
557
|
require 'time'
|
|
558
558
|
require 'zernio-sdk'
|
|
559
559
|
|
|
560
|
-
api_instance = Zernio::
|
|
560
|
+
api_instance = Zernio::CreatorPortalApi.new
|
|
561
561
|
token = 'token_example' # String | A participant token or an open invite token. A malformed token answers 404 like an unknown one.
|
|
562
562
|
submit_creator_post_request = Zernio::SubmitCreatorPostRequest.new({url: 'url_example'}) # SubmitCreatorPostRequest |
|
|
563
563
|
|
|
@@ -566,7 +566,7 @@ begin
|
|
|
566
566
|
result = api_instance.submit_creator_post(token, submit_creator_post_request)
|
|
567
567
|
p result
|
|
568
568
|
rescue Zernio::ApiError => e
|
|
569
|
-
puts "Error when calling
|
|
569
|
+
puts "Error when calling CreatorPortalApi->submit_creator_post: #{e}"
|
|
570
570
|
end
|
|
571
571
|
```
|
|
572
572
|
|
|
@@ -584,7 +584,7 @@ begin
|
|
|
584
584
|
p headers # => { ... }
|
|
585
585
|
p data # => <SubmitCreatorPost201Response>
|
|
586
586
|
rescue Zernio::ApiError => e
|
|
587
|
-
puts "Error when calling
|
|
587
|
+
puts "Error when calling CreatorPortalApi->submit_creator_post_with_http_info: #{e}"
|
|
588
588
|
end
|
|
589
589
|
```
|
|
590
590
|
|