late-sdk 0.0.571 → 0.0.573
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 +10 -0
- data/docs/CheckPhoneNumberAvailability200Response.md +1 -1
- data/docs/CheckPhoneNumberAvailability200ResponseAreaOptionsInner.md +2 -2
- data/docs/CreateLeadFormRequest.md +13 -11
- data/docs/CreateLeadFormRequestPlatformSpecificData.md +49 -0
- data/docs/LeadGenApi.md +25 -21
- data/docs/LinkedInLeadFormPlatformData.md +30 -0
- data/docs/LinkedInLeadFormPlatformDataConsentsInner.md +20 -0
- data/docs/LinkedInLeadFormPlatformDataLocale.md +20 -0
- data/docs/LinkedInLeadFormPlatformDataQuestionsInner.md +49 -0
- data/docs/LinkedInLeadFormPlatformDataQuestionsInnerOneOf.md +28 -0
- data/docs/LinkedInLeadFormPlatformDataQuestionsInnerOneOf1.md +28 -0
- data/docs/LinkedInLeadFormPlatformDataQuestionsInnerOneOf1ChoicesInner.md +20 -0
- data/docs/MetaLeadFormPlatformData.md +46 -0
- data/docs/MetaLeadFormPlatformDataContextCard.md +26 -0
- data/lib/zernio-sdk/api/lead_gen_api.rb +30 -24
- data/lib/zernio-sdk/models/check_phone_number_availability200_response.rb +1 -1
- data/lib/zernio-sdk/models/check_phone_number_availability200_response_area_options_inner.rb +2 -2
- data/lib/zernio-sdk/models/create_lead_form_request.rb +25 -13
- data/lib/zernio-sdk/models/create_lead_form_request_platform_specific_data.rb +105 -0
- data/lib/zernio-sdk/models/linked_in_lead_form_platform_data.rb +336 -0
- data/lib/zernio-sdk/models/linked_in_lead_form_platform_data_consents_inner.rb +176 -0
- data/lib/zernio-sdk/models/linked_in_lead_form_platform_data_locale.rb +156 -0
- data/lib/zernio-sdk/models/linked_in_lead_form_platform_data_questions_inner.rb +104 -0
- data/lib/zernio-sdk/models/linked_in_lead_form_platform_data_questions_inner_one_of.rb +268 -0
- data/lib/zernio-sdk/models/linked_in_lead_form_platform_data_questions_inner_one_of1.rb +295 -0
- data/lib/zernio-sdk/models/linked_in_lead_form_platform_data_questions_inner_one_of1_choices_inner.rb +190 -0
- data/lib/zernio-sdk/models/meta_lead_form_platform_data.rb +354 -0
- data/lib/zernio-sdk/models/meta_lead_form_platform_data_context_card.rb +219 -0
- data/lib/zernio-sdk/version.rb +1 -1
- data/lib/zernio-sdk.rb +10 -0
- data/openapi.yaml +158 -40
- data/spec/api/lead_gen_api_spec.rb +14 -12
- data/spec/models/create_lead_form_request_platform_specific_data_spec.rb +32 -0
- data/spec/models/create_lead_form_request_spec.rb +6 -0
- data/spec/models/linked_in_lead_form_platform_data_consents_inner_spec.rb +42 -0
- data/spec/models/linked_in_lead_form_platform_data_locale_spec.rb +42 -0
- data/spec/models/linked_in_lead_form_platform_data_questions_inner_one_of1_choices_inner_spec.rb +42 -0
- data/spec/models/linked_in_lead_form_platform_data_questions_inner_one_of1_spec.rb +70 -0
- data/spec/models/linked_in_lead_form_platform_data_questions_inner_one_of_spec.rb +70 -0
- data/spec/models/linked_in_lead_form_platform_data_questions_inner_spec.rb +32 -0
- data/spec/models/linked_in_lead_form_platform_data_spec.rb +76 -0
- data/spec/models/meta_lead_form_platform_data_context_card_spec.rb +64 -0
- data/spec/models/meta_lead_form_platform_data_spec.rb +124 -0
- data/zernio-sdk-0.0.573.gem +0 -0
- metadata +42 -2
- data/zernio-sdk-0.0.571.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: 3da1fa551bb44d45961b17e7589dae1c0a66f0b5ec0a8e9a611623cd3ad04218
|
|
4
|
+
data.tar.gz: 6fba2cd45fa53877d47b50c73cf037299b91df852d4cb57427b9cb98e00dc0bb
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9fd4d7a7b0d175b9aac2eb878784e01e2bfeea33b3b6c6ed03d75f55d9481d95a3c9351cab7f9239afe773e2db58f0da9d0d325157266a35275427b5cba97c14
|
|
7
|
+
data.tar.gz: 65b8d897685e6fe062d99b896173cd757d9891137f093db4a8f1573764d3c92b8766af2757ab47a3481a5ebbd623cbf95b041211564d4b127451cbbccce3c9fa
|
data/README.md
CHANGED
|
@@ -790,6 +790,7 @@ Class | Method | HTTP request | Description
|
|
|
790
790
|
- [Zernio::CreateInviteTokenRequest](docs/CreateInviteTokenRequest.md)
|
|
791
791
|
- [Zernio::CreateLeadForm200Response](docs/CreateLeadForm200Response.md)
|
|
792
792
|
- [Zernio::CreateLeadFormRequest](docs/CreateLeadFormRequest.md)
|
|
793
|
+
- [Zernio::CreateLeadFormRequestPlatformSpecificData](docs/CreateLeadFormRequestPlatformSpecificData.md)
|
|
793
794
|
- [Zernio::CreateLeadFormRequestQuestionsInner](docs/CreateLeadFormRequestQuestionsInner.md)
|
|
794
795
|
- [Zernio::CreateMessagingAdRequest](docs/CreateMessagingAdRequest.md)
|
|
795
796
|
- [Zernio::CreatePhoneNumberKycLink200Response](docs/CreatePhoneNumberKycLink200Response.md)
|
|
@@ -1353,6 +1354,13 @@ Class | Method | HTTP request | Description
|
|
|
1353
1354
|
- [Zernio::LinkedInAggregateAnalyticsDailyResponseAnalyticsImpressionsInner](docs/LinkedInAggregateAnalyticsDailyResponseAnalyticsImpressionsInner.md)
|
|
1354
1355
|
- [Zernio::LinkedInAggregateAnalyticsTotalResponse](docs/LinkedInAggregateAnalyticsTotalResponse.md)
|
|
1355
1356
|
- [Zernio::LinkedInAggregateAnalyticsTotalResponseAnalytics](docs/LinkedInAggregateAnalyticsTotalResponseAnalytics.md)
|
|
1357
|
+
- [Zernio::LinkedInLeadFormPlatformData](docs/LinkedInLeadFormPlatformData.md)
|
|
1358
|
+
- [Zernio::LinkedInLeadFormPlatformDataConsentsInner](docs/LinkedInLeadFormPlatformDataConsentsInner.md)
|
|
1359
|
+
- [Zernio::LinkedInLeadFormPlatformDataLocale](docs/LinkedInLeadFormPlatformDataLocale.md)
|
|
1360
|
+
- [Zernio::LinkedInLeadFormPlatformDataQuestionsInner](docs/LinkedInLeadFormPlatformDataQuestionsInner.md)
|
|
1361
|
+
- [Zernio::LinkedInLeadFormPlatformDataQuestionsInnerOneOf](docs/LinkedInLeadFormPlatformDataQuestionsInnerOneOf.md)
|
|
1362
|
+
- [Zernio::LinkedInLeadFormPlatformDataQuestionsInnerOneOf1](docs/LinkedInLeadFormPlatformDataQuestionsInnerOneOf1.md)
|
|
1363
|
+
- [Zernio::LinkedInLeadFormPlatformDataQuestionsInnerOneOf1ChoicesInner](docs/LinkedInLeadFormPlatformDataQuestionsInnerOneOf1ChoicesInner.md)
|
|
1356
1364
|
- [Zernio::LinkedInPlatformData](docs/LinkedInPlatformData.md)
|
|
1357
1365
|
- [Zernio::ListAccountGroups200Response](docs/ListAccountGroups200Response.md)
|
|
1358
1366
|
- [Zernio::ListAccountGroups200ResponseGroupsInner](docs/ListAccountGroups200ResponseGroupsInner.md)
|
|
@@ -1512,6 +1520,8 @@ Class | Method | HTTP request | Description
|
|
|
1512
1520
|
- [Zernio::MarkConversationRead200Response](docs/MarkConversationRead200Response.md)
|
|
1513
1521
|
- [Zernio::MediaItem](docs/MediaItem.md)
|
|
1514
1522
|
- [Zernio::MediaUploadResponse](docs/MediaUploadResponse.md)
|
|
1523
|
+
- [Zernio::MetaLeadFormPlatformData](docs/MetaLeadFormPlatformData.md)
|
|
1524
|
+
- [Zernio::MetaLeadFormPlatformDataContextCard](docs/MetaLeadFormPlatformDataContextCard.md)
|
|
1515
1525
|
- [Zernio::Money](docs/Money.md)
|
|
1516
1526
|
- [Zernio::MoneyAmount](docs/MoneyAmount.md)
|
|
1517
1527
|
- [Zernio::MoveAccountToProfile200Response](docs/MoveAccountToProfile200Response.md)
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
| **available** | **Boolean** | Whether deliverable voice inventory exists right now. | [optional] |
|
|
10
10
|
| **address_constraint** | **String** | | [optional] |
|
|
11
11
|
| **areas** | **Array<String>** | For `geo` only — the area(s) the registered address must be in. | [optional] |
|
|
12
|
-
| **area_options** | [**Array<CheckPhoneNumberAvailability200ResponseAreaOptionsInner>**](CheckPhoneNumberAvailability200ResponseAreaOptionsInner.md) | Live inventory grouped by area code, largest stock first. Empty when out of stock (or the area lookup failed). Pass a chosen `ndc` as `areaCode` on POST /v1/phone-numbers/purchase (or on the KYC submit for regulated countries) to require that area. | [optional] |
|
|
12
|
+
| **area_options** | [**Array<CheckPhoneNumberAvailability200ResponseAreaOptionsInner>**](CheckPhoneNumberAvailability200ResponseAreaOptionsInner.md) | Live inventory grouped by area code, largest stock first. For US and CA this is the full country inventory (every area code with stock, named by state/province); other countries list the areas in the latest inventory page (up to 500 numbers, which for most countries is the entire pool). Empty when out of stock (or the area lookup failed). Pass a chosen `ndc` as `areaCode` on POST /v1/phone-numbers/purchase (or on the KYC submit for regulated countries) to require that area. | [optional] |
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -5,8 +5,8 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **ndc** | **String** | Area code (national destination code), e.g. \"11\". | [optional] |
|
|
8
|
-
| **name** | **String** |
|
|
9
|
-
| **count** | **Integer** |
|
|
8
|
+
| **name** | **String** | Area name: state/province for US/CA (e.g. \"Minnesota\"), city otherwise (e.g. \"Sao Paulo\"). | [optional] |
|
|
9
|
+
| **count** | **Integer** | Numbers available in this area: country-wide count for US/CA, numbers seen on the latest inventory page otherwise. | [optional] |
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
@@ -6,17 +6,18 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **account_id** | **String** | | |
|
|
8
8
|
| **name** | **String** | | |
|
|
9
|
-
| **questions** | [**Array<CreateLeadFormRequestQuestionsInner>**](CreateLeadFormRequestQuestionsInner.md) |
|
|
9
|
+
| **questions** | [**Array<CreateLeadFormRequestQuestionsInner>**](CreateLeadFormRequestQuestionsInner.md) | Deprecated (Meta legacy shape): use platformSpecificData.questions. | [optional] |
|
|
10
10
|
| **privacy_policy_url** | **String** | | |
|
|
11
|
-
| **privacy_policy_link_text** | **String** |
|
|
12
|
-
| **follow_up_action_url** | **String** |
|
|
13
|
-
| **locale** | **String** |
|
|
14
|
-
| **thank_you_title** | **String** |
|
|
15
|
-
| **thank_you_body** | **String** |
|
|
16
|
-
| **thank_you_button_text** | **String** |
|
|
17
|
-
| **thank_you_button_type** | **String** |
|
|
18
|
-
| **thank_you_website_url** | **String** |
|
|
19
|
-
| **is_optimized_for_quality** | **Boolean** |
|
|
11
|
+
| **privacy_policy_link_text** | **String** | Deprecated: use platformSpecificData.privacyPolicyLinkText. | [optional] |
|
|
12
|
+
| **follow_up_action_url** | **String** | Deprecated: use platformSpecificData.followUpActionUrl. | [optional] |
|
|
13
|
+
| **locale** | **String** | Deprecated: use platformSpecificData.locale. | [optional] |
|
|
14
|
+
| **thank_you_title** | **String** | Deprecated: use platformSpecificData.thankYouTitle. | [optional] |
|
|
15
|
+
| **thank_you_body** | **String** | Deprecated: use platformSpecificData.thankYouBody. | [optional] |
|
|
16
|
+
| **thank_you_button_text** | **String** | Deprecated: use platformSpecificData.thankYouButtonText. | [optional] |
|
|
17
|
+
| **thank_you_button_type** | **String** | Deprecated: use platformSpecificData.thankYouButtonType. | [optional] |
|
|
18
|
+
| **thank_you_website_url** | **String** | Deprecated: use platformSpecificData.thankYouWebsiteUrl. | [optional] |
|
|
19
|
+
| **is_optimized_for_quality** | **Boolean** | Deprecated: use platformSpecificData.isOptimizedForQuality. | [optional] |
|
|
20
|
+
| **platform_specific_data** | [**CreateLeadFormRequestPlatformSpecificData**](CreateLeadFormRequestPlatformSpecificData.md) | | [optional] |
|
|
20
21
|
|
|
21
22
|
## Example
|
|
22
23
|
|
|
@@ -36,7 +37,8 @@ instance = Zernio::CreateLeadFormRequest.new(
|
|
|
36
37
|
thank_you_button_text: null,
|
|
37
38
|
thank_you_button_type: VIEW_WEBSITE,
|
|
38
39
|
thank_you_website_url: null,
|
|
39
|
-
is_optimized_for_quality: null
|
|
40
|
+
is_optimized_for_quality: null,
|
|
41
|
+
platform_specific_data: null
|
|
40
42
|
)
|
|
41
43
|
```
|
|
42
44
|
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# Zernio::CreateLeadFormRequestPlatformSpecificData
|
|
2
|
+
|
|
3
|
+
## Class instance methods
|
|
4
|
+
|
|
5
|
+
### `openapi_one_of`
|
|
6
|
+
|
|
7
|
+
Returns the list of classes defined in oneOf.
|
|
8
|
+
|
|
9
|
+
#### Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zernio-sdk'
|
|
13
|
+
|
|
14
|
+
Zernio::CreateLeadFormRequestPlatformSpecificData.openapi_one_of
|
|
15
|
+
# =>
|
|
16
|
+
# [
|
|
17
|
+
# :'LinkedInLeadFormPlatformData',
|
|
18
|
+
# :'MetaLeadFormPlatformData'
|
|
19
|
+
# ]
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### build
|
|
23
|
+
|
|
24
|
+
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
|
25
|
+
|
|
26
|
+
#### Example
|
|
27
|
+
|
|
28
|
+
```ruby
|
|
29
|
+
require 'zernio-sdk'
|
|
30
|
+
|
|
31
|
+
Zernio::CreateLeadFormRequestPlatformSpecificData.build(data)
|
|
32
|
+
# => #<LinkedInLeadFormPlatformData:0x00007fdd4aab02a0>
|
|
33
|
+
|
|
34
|
+
Zernio::CreateLeadFormRequestPlatformSpecificData.build(data_that_doesnt_match)
|
|
35
|
+
# => nil
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
#### Parameters
|
|
39
|
+
|
|
40
|
+
| Name | Type | Description |
|
|
41
|
+
| ---- | ---- | ----------- |
|
|
42
|
+
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
|
43
|
+
|
|
44
|
+
#### Return type
|
|
45
|
+
|
|
46
|
+
- `LinkedInLeadFormPlatformData`
|
|
47
|
+
- `MetaLeadFormPlatformData`
|
|
48
|
+
- `nil` (if no type matches)
|
|
49
|
+
|
data/docs/LeadGenApi.md
CHANGED
|
@@ -19,7 +19,7 @@ All URIs are relative to *https://zernio.com/api*
|
|
|
19
19
|
|
|
20
20
|
Archive a lead form
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
Neither platform hard-deletes a form; this archives it (Meta status=ARCHIVED; LinkedIn state=ARCHIVED via PARTIAL_UPDATE).
|
|
23
23
|
|
|
24
24
|
### Examples
|
|
25
25
|
|
|
@@ -33,8 +33,8 @@ Zernio.configure do |config|
|
|
|
33
33
|
end
|
|
34
34
|
|
|
35
35
|
api_instance = Zernio::LeadGenApi.new
|
|
36
|
-
form_id = 'form_id_example' # String |
|
|
37
|
-
account_id = 'account_id_example' # String |
|
|
36
|
+
form_id = 'form_id_example' # String | Numeric form id (Meta leadgen_form id or LinkedIn leadForm id).
|
|
37
|
+
account_id = 'account_id_example' # String | Connected facebook or linkedin ads account id (selects the platform).
|
|
38
38
|
|
|
39
39
|
begin
|
|
40
40
|
# Archive a lead form
|
|
@@ -67,8 +67,8 @@ end
|
|
|
67
67
|
|
|
68
68
|
| Name | Type | Description | Notes |
|
|
69
69
|
| ---- | ---- | ----------- | ----- |
|
|
70
|
-
| **form_id** | **String** |
|
|
71
|
-
| **account_id** | **String** |
|
|
70
|
+
| **form_id** | **String** | Numeric form id (Meta leadgen_form id or LinkedIn leadForm id). | |
|
|
71
|
+
| **account_id** | **String** | Connected facebook or linkedin ads account id (selects the platform). | |
|
|
72
72
|
|
|
73
73
|
### Return type
|
|
74
74
|
|
|
@@ -90,7 +90,7 @@ end
|
|
|
90
90
|
|
|
91
91
|
Create a lead form
|
|
92
92
|
|
|
93
|
-
Creates a Lead Gen form on the connected Facebook Page (POST /{page-id}/leadgen_forms). NOT idempotent — a retry creates a second form.
|
|
93
|
+
Creates a Lead Gen form. The form content goes inside `platformSpecificData` for both platforms (the shape is selected by the accountId's platform). Meta: created on the connected Facebook Page (POST /{page-id}/leadgen_forms); the old top-level Meta fields (questions, thankYou*, contextCard, …) are DEPRECATED but still accepted while platformSpecificData is absent — mixing both shapes is a 400. LinkedIn: created on the ad account's Company Page. NOT idempotent — a retry creates a second form. Meta prefilled question types (EMAIL, PHONE, FULL_NAME, …) must omit label/key; CUSTOM questions require both. LinkedIn exposes only free-text and multiple-choice questions via API (prefilled-from-profile fields are Campaign Manager UI-only). Requires the Ads add-on.
|
|
94
94
|
|
|
95
95
|
### Examples
|
|
96
96
|
|
|
@@ -104,7 +104,7 @@ Zernio.configure do |config|
|
|
|
104
104
|
end
|
|
105
105
|
|
|
106
106
|
api_instance = Zernio::LeadGenApi.new
|
|
107
|
-
create_lead_form_request = Zernio::CreateLeadFormRequest.new({account_id: 'account_id_example', name: 'name_example',
|
|
107
|
+
create_lead_form_request = Zernio::CreateLeadFormRequest.new({account_id: 'account_id_example', name: 'name_example', privacy_policy_url: 'privacy_policy_url_example'}) # CreateLeadFormRequest |
|
|
108
108
|
|
|
109
109
|
begin
|
|
110
110
|
# Create a lead form
|
|
@@ -242,8 +242,8 @@ Zernio.configure do |config|
|
|
|
242
242
|
end
|
|
243
243
|
|
|
244
244
|
api_instance = Zernio::LeadGenApi.new
|
|
245
|
-
form_id = 'form_id_example' # String |
|
|
246
|
-
account_id = 'account_id_example' # String |
|
|
245
|
+
form_id = 'form_id_example' # String | Numeric form id (Meta leadgen_form id or LinkedIn leadForm id).
|
|
246
|
+
account_id = 'account_id_example' # String | Connected facebook or linkedin ads account id (selects the platform).
|
|
247
247
|
|
|
248
248
|
begin
|
|
249
249
|
# Get a lead form
|
|
@@ -276,8 +276,8 @@ end
|
|
|
276
276
|
|
|
277
277
|
| Name | Type | Description | Notes |
|
|
278
278
|
| ---- | ---- | ----------- | ----- |
|
|
279
|
-
| **form_id** | **String** |
|
|
280
|
-
| **account_id** | **String** |
|
|
279
|
+
| **form_id** | **String** | Numeric form id (Meta leadgen_form id or LinkedIn leadForm id). | |
|
|
280
|
+
| **account_id** | **String** | Connected facebook or linkedin ads account id (selects the platform). | |
|
|
281
281
|
|
|
282
282
|
### Return type
|
|
283
283
|
|
|
@@ -378,7 +378,7 @@ end
|
|
|
378
378
|
|
|
379
379
|
List lead forms
|
|
380
380
|
|
|
381
|
-
Lists the Lead Gen forms owned by the connected Facebook Page. Requires the Ads add-on.
|
|
381
|
+
Lists the Lead Gen forms owned by the account. Meta: forms on the connected Facebook Page. LinkedIn: forms owned by the ad account's Company Page — pass `adAccountId` (LinkedIn forms are org-owned). Requires the Ads add-on.
|
|
382
382
|
|
|
383
383
|
### Examples
|
|
384
384
|
|
|
@@ -392,8 +392,9 @@ Zernio.configure do |config|
|
|
|
392
392
|
end
|
|
393
393
|
|
|
394
394
|
api_instance = Zernio::LeadGenApi.new
|
|
395
|
-
account_id = 'account_id_example' # String | Connected facebook account id.
|
|
395
|
+
account_id = 'account_id_example' # String | Connected facebook or linkedin ads account id.
|
|
396
396
|
opts = {
|
|
397
|
+
ad_account_id: 'ad_account_id_example', # String | LinkedIn only: the LinkedIn ad account id (used to resolve the owning organization). Required for LinkedIn.
|
|
397
398
|
limit: 56, # Integer |
|
|
398
399
|
cursor: 'cursor_example' # String |
|
|
399
400
|
}
|
|
@@ -429,7 +430,8 @@ end
|
|
|
429
430
|
|
|
430
431
|
| Name | Type | Description | Notes |
|
|
431
432
|
| ---- | ---- | ----------- | ----- |
|
|
432
|
-
| **account_id** | **String** | Connected facebook account id. | |
|
|
433
|
+
| **account_id** | **String** | Connected facebook or linkedin ads account id. | |
|
|
434
|
+
| **ad_account_id** | **String** | LinkedIn only: the LinkedIn ad account id (used to resolve the owning organization). Required for LinkedIn. | [optional] |
|
|
433
435
|
| **limit** | **Integer** | | [optional][default to 25] |
|
|
434
436
|
| **cursor** | **String** | | [optional] |
|
|
435
437
|
|
|
@@ -453,7 +455,7 @@ end
|
|
|
453
455
|
|
|
454
456
|
List submitted leads
|
|
455
457
|
|
|
456
|
-
Returns
|
|
458
|
+
Returns submitted Lead Gen leads for your team, newest-first, with keyset pagination on `cursor`. For Meta (default) leads are served from the persisted cache, ingested in real time from the `leadgen` webhook. When `accountId` is a LinkedIn ads account, leads are fetched live from LinkedIn's `leadFormResponses` (LinkedIn has no webhook and enforces 90-day retention, so nothing is persisted) and `adAccountId` is required. Reading LinkedIn responses needs the `r_marketing_leadgen_automation` permission; accounts connected before it was added must reconnect. Requires the Ads add-on.
|
|
457
459
|
|
|
458
460
|
### Examples
|
|
459
461
|
|
|
@@ -469,10 +471,11 @@ end
|
|
|
469
471
|
api_instance = Zernio::LeadGenApi.new
|
|
470
472
|
opts = {
|
|
471
473
|
form_id: 'form_id_example', # String | Filter to a single lead form.
|
|
472
|
-
account_id: 'account_id_example', # String | Filter to a single connected account.
|
|
474
|
+
account_id: 'account_id_example', # String | Filter to a single connected account. LinkedIn ads accounts switch to the live fetch.
|
|
475
|
+
ad_account_id: 'ad_account_id_example', # String | LinkedIn only: the LinkedIn ad account id whose responses to read (owner-scoped finder).
|
|
473
476
|
limit: 56, # Integer |
|
|
474
|
-
since: 56, # Integer | Unix seconds; only leads created at/after this
|
|
475
|
-
cursor: 'cursor_example' # String | Keyset cursor from a previous response's pagination.cursor.
|
|
477
|
+
since: 56, # Integer | Unix seconds; only leads created at/after this timestamp.
|
|
478
|
+
cursor: 'cursor_example' # String | Keyset cursor from a previous response's pagination.cursor (Meta: AdLead id; LinkedIn: numeric start offset).
|
|
476
479
|
}
|
|
477
480
|
|
|
478
481
|
begin
|
|
@@ -507,10 +510,11 @@ end
|
|
|
507
510
|
| Name | Type | Description | Notes |
|
|
508
511
|
| ---- | ---- | ----------- | ----- |
|
|
509
512
|
| **form_id** | **String** | Filter to a single lead form. | [optional] |
|
|
510
|
-
| **account_id** | **String** | Filter to a single connected account. | [optional] |
|
|
513
|
+
| **account_id** | **String** | Filter to a single connected account. LinkedIn ads accounts switch to the live fetch. | [optional] |
|
|
514
|
+
| **ad_account_id** | **String** | LinkedIn only: the LinkedIn ad account id whose responses to read (owner-scoped finder). | [optional] |
|
|
511
515
|
| **limit** | **Integer** | | [optional][default to 25] |
|
|
512
|
-
| **since** | **Integer** | Unix seconds; only leads created at/after this
|
|
513
|
-
| **cursor** | **String** | Keyset cursor from a previous response's pagination.cursor. | [optional] |
|
|
516
|
+
| **since** | **Integer** | Unix seconds; only leads created at/after this timestamp. | [optional] |
|
|
517
|
+
| **cursor** | **String** | Keyset cursor from a previous response's pagination.cursor (Meta: AdLead id; LinkedIn: numeric start offset). | [optional] |
|
|
514
518
|
|
|
515
519
|
### Return type
|
|
516
520
|
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Zernio::LinkedInLeadFormPlatformData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **ad_account_id** | **String** | LinkedIn ad account id (resolves the owning organization). | |
|
|
8
|
+
| **headline** | **String** | | |
|
|
9
|
+
| **description** | **String** | | |
|
|
10
|
+
| **state** | **String** | Defaults to DRAFT. | [optional] |
|
|
11
|
+
| **locale** | [**LinkedInLeadFormPlatformDataLocale**](LinkedInLeadFormPlatformDataLocale.md) | | [optional] |
|
|
12
|
+
| **consents** | [**Array<LinkedInLeadFormPlatformDataConsentsInner>**](LinkedInLeadFormPlatformDataConsentsInner.md) | | [optional] |
|
|
13
|
+
| **questions** | [**Array<LinkedInLeadFormPlatformDataQuestionsInner>**](LinkedInLeadFormPlatformDataQuestionsInner.md) | | |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'zernio-sdk'
|
|
19
|
+
|
|
20
|
+
instance = Zernio::LinkedInLeadFormPlatformData.new(
|
|
21
|
+
ad_account_id: null,
|
|
22
|
+
headline: null,
|
|
23
|
+
description: null,
|
|
24
|
+
state: null,
|
|
25
|
+
locale: null,
|
|
26
|
+
consents: null,
|
|
27
|
+
questions: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::LinkedInLeadFormPlatformDataConsentsInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **description** | **String** | | |
|
|
8
|
+
| **required** | **Boolean** | Whether the viewer must tick this consent to submit. Defaults to false. | [optional][default to false] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::LinkedInLeadFormPlatformDataConsentsInner.new(
|
|
16
|
+
description: null,
|
|
17
|
+
required: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::LinkedInLeadFormPlatformDataLocale
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **country** | **String** | | [optional] |
|
|
8
|
+
| **language** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::LinkedInLeadFormPlatformDataLocale.new(
|
|
16
|
+
country: null,
|
|
17
|
+
language: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# Zernio::LinkedInLeadFormPlatformDataQuestionsInner
|
|
2
|
+
|
|
3
|
+
## Class instance methods
|
|
4
|
+
|
|
5
|
+
### `openapi_one_of`
|
|
6
|
+
|
|
7
|
+
Returns the list of classes defined in oneOf.
|
|
8
|
+
|
|
9
|
+
#### Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zernio-sdk'
|
|
13
|
+
|
|
14
|
+
Zernio::LinkedInLeadFormPlatformDataQuestionsInner.openapi_one_of
|
|
15
|
+
# =>
|
|
16
|
+
# [
|
|
17
|
+
# :'LinkedInLeadFormPlatformDataQuestionsInnerOneOf',
|
|
18
|
+
# :'LinkedInLeadFormPlatformDataQuestionsInnerOneOf1'
|
|
19
|
+
# ]
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### build
|
|
23
|
+
|
|
24
|
+
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
|
25
|
+
|
|
26
|
+
#### Example
|
|
27
|
+
|
|
28
|
+
```ruby
|
|
29
|
+
require 'zernio-sdk'
|
|
30
|
+
|
|
31
|
+
Zernio::LinkedInLeadFormPlatformDataQuestionsInner.build(data)
|
|
32
|
+
# => #<LinkedInLeadFormPlatformDataQuestionsInnerOneOf:0x00007fdd4aab02a0>
|
|
33
|
+
|
|
34
|
+
Zernio::LinkedInLeadFormPlatformDataQuestionsInner.build(data_that_doesnt_match)
|
|
35
|
+
# => nil
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
#### Parameters
|
|
39
|
+
|
|
40
|
+
| Name | Type | Description |
|
|
41
|
+
| ---- | ---- | ----------- |
|
|
42
|
+
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
|
43
|
+
|
|
44
|
+
#### Return type
|
|
45
|
+
|
|
46
|
+
- `LinkedInLeadFormPlatformDataQuestionsInnerOneOf`
|
|
47
|
+
- `LinkedInLeadFormPlatformDataQuestionsInnerOneOf1`
|
|
48
|
+
- `nil` (if no type matches)
|
|
49
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Zernio::LinkedInLeadFormPlatformDataQuestionsInnerOneOf
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **kind** | **String** | | |
|
|
8
|
+
| **name** | **String** | | |
|
|
9
|
+
| **question** | **String** | | |
|
|
10
|
+
| **required** | **Boolean** | | [optional] |
|
|
11
|
+
| **response_editable** | **Boolean** | | [optional] |
|
|
12
|
+
| **max_response_length** | **Integer** | Defaults to 300 on LinkedIn's side. | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'zernio-sdk'
|
|
18
|
+
|
|
19
|
+
instance = Zernio::LinkedInLeadFormPlatformDataQuestionsInnerOneOf.new(
|
|
20
|
+
kind: null,
|
|
21
|
+
name: null,
|
|
22
|
+
question: null,
|
|
23
|
+
required: null,
|
|
24
|
+
response_editable: null,
|
|
25
|
+
max_response_length: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Zernio::LinkedInLeadFormPlatformDataQuestionsInnerOneOf1
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **kind** | **String** | | |
|
|
8
|
+
| **name** | **String** | | |
|
|
9
|
+
| **question** | **String** | | |
|
|
10
|
+
| **required** | **Boolean** | | [optional] |
|
|
11
|
+
| **response_editable** | **Boolean** | | [optional] |
|
|
12
|
+
| **choices** | [**Array<LinkedInLeadFormPlatformDataQuestionsInnerOneOf1ChoicesInner>**](LinkedInLeadFormPlatformDataQuestionsInnerOneOf1ChoicesInner.md) | | |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'zernio-sdk'
|
|
18
|
+
|
|
19
|
+
instance = Zernio::LinkedInLeadFormPlatformDataQuestionsInnerOneOf1.new(
|
|
20
|
+
kind: null,
|
|
21
|
+
name: null,
|
|
22
|
+
question: null,
|
|
23
|
+
required: null,
|
|
24
|
+
response_editable: null,
|
|
25
|
+
choices: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::LinkedInLeadFormPlatformDataQuestionsInnerOneOf1ChoicesInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **Integer** | | |
|
|
8
|
+
| **text** | **String** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::LinkedInLeadFormPlatformDataQuestionsInnerOneOf1ChoicesInner.new(
|
|
16
|
+
id: null,
|
|
17
|
+
text: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Zernio::MetaLeadFormPlatformData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **questions** | [**Array<CreateLeadFormRequestQuestionsInner>**](CreateLeadFormRequestQuestionsInner.md) | | |
|
|
8
|
+
| **privacy_policy_link_text** | **String** | | [optional] |
|
|
9
|
+
| **follow_up_action_url** | **String** | | [optional] |
|
|
10
|
+
| **locale** | **String** | | [optional] |
|
|
11
|
+
| **thank_you_title** | **String** | | [optional] |
|
|
12
|
+
| **thank_you_body** | **String** | | [optional] |
|
|
13
|
+
| **thank_you_button_text** | **String** | | [optional] |
|
|
14
|
+
| **thank_you_button_type** | **String** | | [optional] |
|
|
15
|
+
| **thank_you_website_url** | **String** | | [optional] |
|
|
16
|
+
| **is_optimized_for_quality** | **Boolean** | | [optional] |
|
|
17
|
+
| **form_type** | **String** | | [optional] |
|
|
18
|
+
| **block_display_for_non_targeted_viewer** | **Boolean** | | [optional] |
|
|
19
|
+
| **allow_organic_lead_gen** | **Boolean** | | [optional] |
|
|
20
|
+
| **question_page_custom_headline** | **String** | | [optional] |
|
|
21
|
+
| **context_card** | [**MetaLeadFormPlatformDataContextCard**](MetaLeadFormPlatformDataContextCard.md) | | [optional] |
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
require 'zernio-sdk'
|
|
27
|
+
|
|
28
|
+
instance = Zernio::MetaLeadFormPlatformData.new(
|
|
29
|
+
questions: null,
|
|
30
|
+
privacy_policy_link_text: null,
|
|
31
|
+
follow_up_action_url: null,
|
|
32
|
+
locale: EN_US,
|
|
33
|
+
thank_you_title: null,
|
|
34
|
+
thank_you_body: null,
|
|
35
|
+
thank_you_button_text: null,
|
|
36
|
+
thank_you_button_type: VIEW_WEBSITE,
|
|
37
|
+
thank_you_website_url: null,
|
|
38
|
+
is_optimized_for_quality: null,
|
|
39
|
+
form_type: null,
|
|
40
|
+
block_display_for_non_targeted_viewer: null,
|
|
41
|
+
allow_organic_lead_gen: null,
|
|
42
|
+
question_page_custom_headline: null,
|
|
43
|
+
context_card: null
|
|
44
|
+
)
|
|
45
|
+
```
|
|
46
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Zernio::MetaLeadFormPlatformDataContextCard
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **title** | **String** | | [optional] |
|
|
8
|
+
| **content** | **Array<String>** | | [optional] |
|
|
9
|
+
| **style** | **String** | | [optional] |
|
|
10
|
+
| **button_text** | **String** | | [optional] |
|
|
11
|
+
| **cover_photo** | **String** | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'zernio-sdk'
|
|
17
|
+
|
|
18
|
+
instance = Zernio::MetaLeadFormPlatformDataContextCard.new(
|
|
19
|
+
title: null,
|
|
20
|
+
content: null,
|
|
21
|
+
style: null,
|
|
22
|
+
button_text: null,
|
|
23
|
+
cover_photo: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|