zernio-sdk 0.0.741 → 0.0.742
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 +2 -0
- data/docs/CreateCallAdRequest.md +2 -0
- data/docs/CreateMessagingAdRequest.md +2 -0
- data/docs/CtwaAdRequestBody.md +2 -0
- data/docs/CtwaAdRequestBodyCreativesInner.md +3 -1
- data/docs/CtwaAdRequestBodyCreativesInnerWelcomeMessage.md +20 -0
- data/docs/CtwaAdRequestBodyWelcomeMessage.md +20 -0
- data/lib/zernio-sdk/models/create_call_ad_request.rb +10 -1
- data/lib/zernio-sdk/models/create_messaging_ad_request.rb +10 -1
- data/lib/zernio-sdk/models/ctwa_ad_request_body.rb +10 -1
- data/lib/zernio-sdk/models/ctwa_ad_request_body_creatives_inner.rb +13 -4
- data/lib/zernio-sdk/models/ctwa_ad_request_body_creatives_inner_welcome_message.rb +211 -0
- data/lib/zernio-sdk/models/ctwa_ad_request_body_welcome_message.rb +211 -0
- data/lib/zernio-sdk/version.rb +1 -1
- data/lib/zernio-sdk.rb +2 -0
- data/openapi.yaml +17 -0
- data/spec/models/create_call_ad_request_spec.rb +6 -0
- data/spec/models/create_messaging_ad_request_spec.rb +6 -0
- data/spec/models/ctwa_ad_request_body_creatives_inner_spec.rb +6 -0
- data/spec/models/ctwa_ad_request_body_creatives_inner_welcome_message_spec.rb +42 -0
- data/spec/models/ctwa_ad_request_body_spec.rb +6 -0
- data/spec/models/ctwa_ad_request_body_welcome_message_spec.rb +42 -0
- metadata +10 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 1d94730c10a6d40e92cb3a7a9e77d341c177a132e226e4f16b4c95dd88edd9aa
|
|
4
|
+
data.tar.gz: 9043886a7138023c7c26ac7585010f9d4496ca79c51379047406eae7ac5c00fa
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c35894c0219b677086c009adc63a403ada33497c816906bd05c73a09c80520676a1dbc64853c1e91c6b8d4f284e5c17dec00dda2c4c9e6d8374e9b0db177ecc4
|
|
7
|
+
data.tar.gz: f791fe76ffa586d3b4331dc97e9a37d57c6a214e58f397a1bc605f4da26e31a6396c00180fe2908150e36475748a1eee6a4e8b92e19087832e4fe21765a7d314
|
data/README.md
CHANGED
|
@@ -1000,9 +1000,11 @@ Class | Method | HTTP request | Description
|
|
|
1000
1000
|
- [Zernio::CtwaAdRequestBodyCitiesInner](docs/CtwaAdRequestBodyCitiesInner.md)
|
|
1001
1001
|
- [Zernio::CtwaAdRequestBodyCreativesInner](docs/CtwaAdRequestBodyCreativesInner.md)
|
|
1002
1002
|
- [Zernio::CtwaAdRequestBodyCreativesInnerVideo](docs/CtwaAdRequestBodyCreativesInnerVideo.md)
|
|
1003
|
+
- [Zernio::CtwaAdRequestBodyCreativesInnerWelcomeMessage](docs/CtwaAdRequestBodyCreativesInnerWelcomeMessage.md)
|
|
1003
1004
|
- [Zernio::CtwaAdRequestBodyPlacements](docs/CtwaAdRequestBodyPlacements.md)
|
|
1004
1005
|
- [Zernio::CtwaAdRequestBodyRegionsInner](docs/CtwaAdRequestBodyRegionsInner.md)
|
|
1005
1006
|
- [Zernio::CtwaAdRequestBodyVideo](docs/CtwaAdRequestBodyVideo.md)
|
|
1007
|
+
- [Zernio::CtwaAdRequestBodyWelcomeMessage](docs/CtwaAdRequestBodyWelcomeMessage.md)
|
|
1006
1008
|
- [Zernio::CtwaAdRequestBodyZipsInner](docs/CtwaAdRequestBodyZipsInner.md)
|
|
1007
1009
|
- [Zernio::CtwaMultiResponse](docs/CtwaMultiResponse.md)
|
|
1008
1010
|
- [Zernio::CtwaSingleResponse](docs/CtwaSingleResponse.md)
|
data/docs/CreateCallAdRequest.md
CHANGED
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
| **body** | **String** | Primary text shown above the image / video. Single-creative shape only. Mutually exclusive with `creatives[]`. | [optional] |
|
|
12
12
|
| **image_url** | **String** | Image asset for single-creative shape. Mutually exclusive with `video` and with `creatives[]`. Required on the single-creative shape if `video` is not supplied. | [optional] |
|
|
13
13
|
| **video** | [**CtwaAdRequestBodyVideo**](CtwaAdRequestBodyVideo.md) | | [optional] |
|
|
14
|
+
| **welcome_message** | [**CtwaAdRequestBodyWelcomeMessage**](CtwaAdRequestBodyWelcomeMessage.md) | | [optional] |
|
|
14
15
|
| **creatives** | [**Array<CtwaAdRequestBodyCreativesInner>**](CtwaAdRequestBodyCreativesInner.md) | Multi-creative shape: N CTWA ads under one campaign + one ad set, sharing budget and targeting. Mutually exclusive with the top-level single-creative fields (`headline` / `body` / `imageUrl` / `video`): setting both is a 400, unlike `POST /v1/ads/create` where the top-level fields are silently ignored in multi-creative mode. Each entry must supply its own headline, body, and exactly one of `imageUrl` / `video`. | [optional] |
|
|
15
16
|
| **ad_set_id** | **String** | Attach the creatives to this EXISTING messaging ad set instead of building a campaign, so the ad set keeps its learning phase. It then owns budget, targeting and schedule, so `budgetAmount`, `budgetType`, `endDate`, `objective`, `countries`, `interests`, `audienceId` and `campaignStatus` are rejected with a 400 alongside it. Its `destination_type` must match the ad's destination. | [optional] |
|
|
16
17
|
| **budget_amount** | **Float** | Budget amount in the ad account's currency major units (e.g. dollars for USD, not cents). Must be > 0. Required unless `adSetId` is set, where the ad set owns it. | [optional] |
|
|
@@ -53,6 +54,7 @@ instance = Zernio::CreateCallAdRequest.new(
|
|
|
53
54
|
body: null,
|
|
54
55
|
image_url: null,
|
|
55
56
|
video: null,
|
|
57
|
+
welcome_message: null,
|
|
56
58
|
creatives: null,
|
|
57
59
|
ad_set_id: null,
|
|
58
60
|
budget_amount: null,
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
| **body** | **String** | Primary text shown above the image / video. Single-creative shape only. Mutually exclusive with `creatives[]`. | [optional] |
|
|
12
12
|
| **image_url** | **String** | Image asset for single-creative shape. Mutually exclusive with `video` and with `creatives[]`. Required on the single-creative shape if `video` is not supplied. | [optional] |
|
|
13
13
|
| **video** | [**CtwaAdRequestBodyVideo**](CtwaAdRequestBodyVideo.md) | | [optional] |
|
|
14
|
+
| **welcome_message** | [**CtwaAdRequestBodyWelcomeMessage**](CtwaAdRequestBodyWelcomeMessage.md) | | [optional] |
|
|
14
15
|
| **creatives** | [**Array<CtwaAdRequestBodyCreativesInner>**](CtwaAdRequestBodyCreativesInner.md) | Multi-creative shape: N CTWA ads under one campaign + one ad set, sharing budget and targeting. Mutually exclusive with the top-level single-creative fields (`headline` / `body` / `imageUrl` / `video`): setting both is a 400, unlike `POST /v1/ads/create` where the top-level fields are silently ignored in multi-creative mode. Each entry must supply its own headline, body, and exactly one of `imageUrl` / `video`. | [optional] |
|
|
15
16
|
| **ad_set_id** | **String** | Attach the creatives to this EXISTING messaging ad set instead of building a campaign, so the ad set keeps its learning phase. It then owns budget, targeting and schedule, so `budgetAmount`, `budgetType`, `endDate`, `objective`, `countries`, `interests`, `audienceId` and `campaignStatus` are rejected with a 400 alongside it. Its `destination_type` must match the ad's destination. | [optional] |
|
|
16
17
|
| **budget_amount** | **Float** | Budget amount in the ad account's currency major units (e.g. dollars for USD, not cents). Must be > 0. Required unless `adSetId` is set, where the ad set owns it. | [optional] |
|
|
@@ -52,6 +53,7 @@ instance = Zernio::CreateMessagingAdRequest.new(
|
|
|
52
53
|
body: null,
|
|
53
54
|
image_url: null,
|
|
54
55
|
video: null,
|
|
56
|
+
welcome_message: null,
|
|
55
57
|
creatives: null,
|
|
56
58
|
ad_set_id: null,
|
|
57
59
|
budget_amount: null,
|
data/docs/CtwaAdRequestBody.md
CHANGED
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
| **body** | **String** | Primary text shown above the image / video. Single-creative shape only. Mutually exclusive with `creatives[]`. | [optional] |
|
|
12
12
|
| **image_url** | **String** | Image asset for single-creative shape. Mutually exclusive with `video` and with `creatives[]`. Required on the single-creative shape if `video` is not supplied. | [optional] |
|
|
13
13
|
| **video** | [**CtwaAdRequestBodyVideo**](CtwaAdRequestBodyVideo.md) | | [optional] |
|
|
14
|
+
| **welcome_message** | [**CtwaAdRequestBodyWelcomeMessage**](CtwaAdRequestBodyWelcomeMessage.md) | | [optional] |
|
|
14
15
|
| **creatives** | [**Array<CtwaAdRequestBodyCreativesInner>**](CtwaAdRequestBodyCreativesInner.md) | Multi-creative shape: N CTWA ads under one campaign + one ad set, sharing budget and targeting. Mutually exclusive with the top-level single-creative fields (`headline` / `body` / `imageUrl` / `video`): setting both is a 400, unlike `POST /v1/ads/create` where the top-level fields are silently ignored in multi-creative mode. Each entry must supply its own headline, body, and exactly one of `imageUrl` / `video`. | [optional] |
|
|
15
16
|
| **ad_set_id** | **String** | Attach the creatives to this EXISTING messaging ad set instead of building a campaign, so the ad set keeps its learning phase. It then owns budget, targeting and schedule, so `budgetAmount`, `budgetType`, `endDate`, `objective`, `countries`, `interests`, `audienceId` and `campaignStatus` are rejected with a 400 alongside it. Its `destination_type` must match the ad's destination. | [optional] |
|
|
16
17
|
| **budget_amount** | **Float** | Budget amount in the ad account's currency major units (e.g. dollars for USD, not cents). Must be > 0. Required unless `adSetId` is set, where the ad set owns it. | [optional] |
|
|
@@ -51,6 +52,7 @@ instance = Zernio::CtwaAdRequestBody.new(
|
|
|
51
52
|
body: null,
|
|
52
53
|
image_url: null,
|
|
53
54
|
video: null,
|
|
55
|
+
welcome_message: null,
|
|
54
56
|
creatives: null,
|
|
55
57
|
ad_set_id: null,
|
|
56
58
|
budget_amount: null,
|
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
| **body** | **String** | Primary text shown above the image / video. | |
|
|
9
9
|
| **image_url** | **String** | Image asset. Mutually exclusive with this entry's `video`. Required if `video` is not supplied. | [optional] |
|
|
10
10
|
| **video** | [**CtwaAdRequestBodyCreativesInnerVideo**](CtwaAdRequestBodyCreativesInnerVideo.md) | | [optional] |
|
|
11
|
+
| **welcome_message** | [**CtwaAdRequestBodyCreativesInnerWelcomeMessage**](CtwaAdRequestBodyCreativesInnerWelcomeMessage.md) | | [optional] |
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -18,7 +19,8 @@ instance = Zernio::CtwaAdRequestBodyCreativesInner.new(
|
|
|
18
19
|
headline: null,
|
|
19
20
|
body: null,
|
|
20
21
|
image_url: null,
|
|
21
|
-
video: null
|
|
22
|
+
video: null,
|
|
23
|
+
welcome_message: null
|
|
22
24
|
)
|
|
23
25
|
```
|
|
24
26
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::CtwaAdRequestBodyCreativesInnerWelcomeMessage
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **text** | **String** | Greeting shown when the chat opens. Replaces Meta's default. | |
|
|
8
|
+
| **prefill_text** | **String** | Message put into the user's text input, ready to send. Replaces Meta's default. | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::CtwaAdRequestBodyCreativesInnerWelcomeMessage.new(
|
|
16
|
+
text: null,
|
|
17
|
+
prefill_text: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::CtwaAdRequestBodyWelcomeMessage
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **text** | **String** | Greeting shown when the chat opens. Replaces Meta's default (\"Hi! Can we help you?\"). | |
|
|
8
|
+
| **prefill_text** | **String** | Message put into the user's text input, ready to send. Replaces Meta's default (\"Hi! I want more info.\"). Lets one ad steer the opening message toward what it promotes (e.g. a specific product). | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::CtwaAdRequestBodyWelcomeMessage.new(
|
|
16
|
+
text: null,
|
|
17
|
+
prefill_text: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -35,6 +35,8 @@ module Zernio
|
|
|
35
35
|
|
|
36
36
|
attr_accessor :video
|
|
37
37
|
|
|
38
|
+
attr_accessor :welcome_message
|
|
39
|
+
|
|
38
40
|
# Multi-creative shape: N CTWA ads under one campaign + one ad set, sharing budget and targeting. Mutually exclusive with the top-level single-creative fields (`headline` / `body` / `imageUrl` / `video`): setting both is a 400, unlike `POST /v1/ads/create` where the top-level fields are silently ignored in multi-creative mode. Each entry must supply its own headline, body, and exactly one of `imageUrl` / `video`.
|
|
39
41
|
attr_accessor :creatives
|
|
40
42
|
|
|
@@ -147,6 +149,7 @@ module Zernio
|
|
|
147
149
|
:'body' => :'body',
|
|
148
150
|
:'image_url' => :'imageUrl',
|
|
149
151
|
:'video' => :'video',
|
|
152
|
+
:'welcome_message' => :'welcomeMessage',
|
|
150
153
|
:'creatives' => :'creatives',
|
|
151
154
|
:'ad_set_id' => :'adSetId',
|
|
152
155
|
:'budget_amount' => :'budgetAmount',
|
|
@@ -198,6 +201,7 @@ module Zernio
|
|
|
198
201
|
:'body' => :'String',
|
|
199
202
|
:'image_url' => :'String',
|
|
200
203
|
:'video' => :'CtwaAdRequestBodyVideo',
|
|
204
|
+
:'welcome_message' => :'CtwaAdRequestBodyWelcomeMessage',
|
|
201
205
|
:'creatives' => :'Array<CtwaAdRequestBodyCreativesInner>',
|
|
202
206
|
:'ad_set_id' => :'String',
|
|
203
207
|
:'budget_amount' => :'Float',
|
|
@@ -292,6 +296,10 @@ module Zernio
|
|
|
292
296
|
self.video = attributes[:'video']
|
|
293
297
|
end
|
|
294
298
|
|
|
299
|
+
if attributes.key?(:'welcome_message')
|
|
300
|
+
self.welcome_message = attributes[:'welcome_message']
|
|
301
|
+
end
|
|
302
|
+
|
|
295
303
|
if attributes.key?(:'creatives')
|
|
296
304
|
if (value = attributes[:'creatives']).is_a?(Array)
|
|
297
305
|
self.creatives = value
|
|
@@ -814,6 +822,7 @@ module Zernio
|
|
|
814
822
|
body == o.body &&
|
|
815
823
|
image_url == o.image_url &&
|
|
816
824
|
video == o.video &&
|
|
825
|
+
welcome_message == o.welcome_message &&
|
|
817
826
|
creatives == o.creatives &&
|
|
818
827
|
ad_set_id == o.ad_set_id &&
|
|
819
828
|
budget_amount == o.budget_amount &&
|
|
@@ -853,7 +862,7 @@ module Zernio
|
|
|
853
862
|
# Calculates hash code according to all attributes.
|
|
854
863
|
# @return [Integer] Hash code
|
|
855
864
|
def hash
|
|
856
|
-
[account_id, ad_account_id, name, headline, body, image_url, video, creatives, ad_set_id, budget_amount, budget_type, currency, end_date, countries, cities, regions, zips, metros, custom_locations, age_min, age_max, interests, audience_id, placements, advantage_audience, objective, status, campaign_status, bid_strategy, bid_amount, roas_average_floor, dsa_beneficiary, dsa_payor, phone_number, link_url].hash
|
|
865
|
+
[account_id, ad_account_id, name, headline, body, image_url, video, welcome_message, creatives, ad_set_id, budget_amount, budget_type, currency, end_date, countries, cities, regions, zips, metros, custom_locations, age_min, age_max, interests, audience_id, placements, advantage_audience, objective, status, campaign_status, bid_strategy, bid_amount, roas_average_floor, dsa_beneficiary, dsa_payor, phone_number, link_url].hash
|
|
857
866
|
end
|
|
858
867
|
|
|
859
868
|
# Builds the object from hash
|
|
@@ -35,6 +35,8 @@ module Zernio
|
|
|
35
35
|
|
|
36
36
|
attr_accessor :video
|
|
37
37
|
|
|
38
|
+
attr_accessor :welcome_message
|
|
39
|
+
|
|
38
40
|
# Multi-creative shape: N CTWA ads under one campaign + one ad set, sharing budget and targeting. Mutually exclusive with the top-level single-creative fields (`headline` / `body` / `imageUrl` / `video`): setting both is a 400, unlike `POST /v1/ads/create` where the top-level fields are silently ignored in multi-creative mode. Each entry must supply its own headline, body, and exactly one of `imageUrl` / `video`.
|
|
39
41
|
attr_accessor :creatives
|
|
40
42
|
|
|
@@ -144,6 +146,7 @@ module Zernio
|
|
|
144
146
|
:'body' => :'body',
|
|
145
147
|
:'image_url' => :'imageUrl',
|
|
146
148
|
:'video' => :'video',
|
|
149
|
+
:'welcome_message' => :'welcomeMessage',
|
|
147
150
|
:'creatives' => :'creatives',
|
|
148
151
|
:'ad_set_id' => :'adSetId',
|
|
149
152
|
:'budget_amount' => :'budgetAmount',
|
|
@@ -194,6 +197,7 @@ module Zernio
|
|
|
194
197
|
:'body' => :'String',
|
|
195
198
|
:'image_url' => :'String',
|
|
196
199
|
:'video' => :'CtwaAdRequestBodyVideo',
|
|
200
|
+
:'welcome_message' => :'CtwaAdRequestBodyWelcomeMessage',
|
|
197
201
|
:'creatives' => :'Array<CtwaAdRequestBodyCreativesInner>',
|
|
198
202
|
:'ad_set_id' => :'String',
|
|
199
203
|
:'budget_amount' => :'Float',
|
|
@@ -287,6 +291,10 @@ module Zernio
|
|
|
287
291
|
self.video = attributes[:'video']
|
|
288
292
|
end
|
|
289
293
|
|
|
294
|
+
if attributes.key?(:'welcome_message')
|
|
295
|
+
self.welcome_message = attributes[:'welcome_message']
|
|
296
|
+
end
|
|
297
|
+
|
|
290
298
|
if attributes.key?(:'creatives')
|
|
291
299
|
if (value = attributes[:'creatives']).is_a?(Array)
|
|
292
300
|
self.creatives = value
|
|
@@ -790,6 +798,7 @@ module Zernio
|
|
|
790
798
|
body == o.body &&
|
|
791
799
|
image_url == o.image_url &&
|
|
792
800
|
video == o.video &&
|
|
801
|
+
welcome_message == o.welcome_message &&
|
|
793
802
|
creatives == o.creatives &&
|
|
794
803
|
ad_set_id == o.ad_set_id &&
|
|
795
804
|
budget_amount == o.budget_amount &&
|
|
@@ -828,7 +837,7 @@ module Zernio
|
|
|
828
837
|
# Calculates hash code according to all attributes.
|
|
829
838
|
# @return [Integer] Hash code
|
|
830
839
|
def hash
|
|
831
|
-
[account_id, ad_account_id, name, headline, body, image_url, video, creatives, ad_set_id, budget_amount, budget_type, currency, end_date, countries, cities, regions, zips, metros, custom_locations, age_min, age_max, interests, audience_id, placements, advantage_audience, objective, status, campaign_status, bid_strategy, bid_amount, roas_average_floor, dsa_beneficiary, dsa_payor, destination].hash
|
|
840
|
+
[account_id, ad_account_id, name, headline, body, image_url, video, welcome_message, creatives, ad_set_id, budget_amount, budget_type, currency, end_date, countries, cities, regions, zips, metros, custom_locations, age_min, age_max, interests, audience_id, placements, advantage_audience, objective, status, campaign_status, bid_strategy, bid_amount, roas_average_floor, dsa_beneficiary, dsa_payor, destination].hash
|
|
832
841
|
end
|
|
833
842
|
|
|
834
843
|
# Builds the object from hash
|
|
@@ -36,6 +36,8 @@ module Zernio
|
|
|
36
36
|
|
|
37
37
|
attr_accessor :video
|
|
38
38
|
|
|
39
|
+
attr_accessor :welcome_message
|
|
40
|
+
|
|
39
41
|
# Multi-creative shape: N CTWA ads under one campaign + one ad set, sharing budget and targeting. Mutually exclusive with the top-level single-creative fields (`headline` / `body` / `imageUrl` / `video`): setting both is a 400, unlike `POST /v1/ads/create` where the top-level fields are silently ignored in multi-creative mode. Each entry must supply its own headline, body, and exactly one of `imageUrl` / `video`.
|
|
40
42
|
attr_accessor :creatives
|
|
41
43
|
|
|
@@ -142,6 +144,7 @@ module Zernio
|
|
|
142
144
|
:'body' => :'body',
|
|
143
145
|
:'image_url' => :'imageUrl',
|
|
144
146
|
:'video' => :'video',
|
|
147
|
+
:'welcome_message' => :'welcomeMessage',
|
|
145
148
|
:'creatives' => :'creatives',
|
|
146
149
|
:'ad_set_id' => :'adSetId',
|
|
147
150
|
:'budget_amount' => :'budgetAmount',
|
|
@@ -191,6 +194,7 @@ module Zernio
|
|
|
191
194
|
:'body' => :'String',
|
|
192
195
|
:'image_url' => :'String',
|
|
193
196
|
:'video' => :'CtwaAdRequestBodyVideo',
|
|
197
|
+
:'welcome_message' => :'CtwaAdRequestBodyWelcomeMessage',
|
|
194
198
|
:'creatives' => :'Array<CtwaAdRequestBodyCreativesInner>',
|
|
195
199
|
:'ad_set_id' => :'String',
|
|
196
200
|
:'budget_amount' => :'Float',
|
|
@@ -276,6 +280,10 @@ module Zernio
|
|
|
276
280
|
self.video = attributes[:'video']
|
|
277
281
|
end
|
|
278
282
|
|
|
283
|
+
if attributes.key?(:'welcome_message')
|
|
284
|
+
self.welcome_message = attributes[:'welcome_message']
|
|
285
|
+
end
|
|
286
|
+
|
|
279
287
|
if attributes.key?(:'creatives')
|
|
280
288
|
if (value = attributes[:'creatives']).is_a?(Array)
|
|
281
289
|
self.creatives = value
|
|
@@ -756,6 +764,7 @@ module Zernio
|
|
|
756
764
|
body == o.body &&
|
|
757
765
|
image_url == o.image_url &&
|
|
758
766
|
video == o.video &&
|
|
767
|
+
welcome_message == o.welcome_message &&
|
|
759
768
|
creatives == o.creatives &&
|
|
760
769
|
ad_set_id == o.ad_set_id &&
|
|
761
770
|
budget_amount == o.budget_amount &&
|
|
@@ -793,7 +802,7 @@ module Zernio
|
|
|
793
802
|
# Calculates hash code according to all attributes.
|
|
794
803
|
# @return [Integer] Hash code
|
|
795
804
|
def hash
|
|
796
|
-
[account_id, ad_account_id, name, headline, body, image_url, video, creatives, ad_set_id, budget_amount, budget_type, currency, end_date, countries, cities, regions, zips, metros, custom_locations, age_min, age_max, interests, audience_id, placements, advantage_audience, objective, status, campaign_status, bid_strategy, bid_amount, roas_average_floor, dsa_beneficiary, dsa_payor].hash
|
|
805
|
+
[account_id, ad_account_id, name, headline, body, image_url, video, welcome_message, creatives, ad_set_id, budget_amount, budget_type, currency, end_date, countries, cities, regions, zips, metros, custom_locations, age_min, age_max, interests, audience_id, placements, advantage_audience, objective, status, campaign_status, bid_strategy, bid_amount, roas_average_floor, dsa_beneficiary, dsa_payor].hash
|
|
797
806
|
end
|
|
798
807
|
|
|
799
808
|
# Builds the object from hash
|
|
@@ -26,13 +26,16 @@ module Zernio
|
|
|
26
26
|
|
|
27
27
|
attr_accessor :video
|
|
28
28
|
|
|
29
|
+
attr_accessor :welcome_message
|
|
30
|
+
|
|
29
31
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
30
32
|
def self.attribute_map
|
|
31
33
|
{
|
|
32
34
|
:'headline' => :'headline',
|
|
33
35
|
:'body' => :'body',
|
|
34
36
|
:'image_url' => :'imageUrl',
|
|
35
|
-
:'video' => :'video'
|
|
37
|
+
:'video' => :'video',
|
|
38
|
+
:'welcome_message' => :'welcomeMessage'
|
|
36
39
|
}
|
|
37
40
|
end
|
|
38
41
|
|
|
@@ -52,7 +55,8 @@ module Zernio
|
|
|
52
55
|
:'headline' => :'String',
|
|
53
56
|
:'body' => :'String',
|
|
54
57
|
:'image_url' => :'String',
|
|
55
|
-
:'video' => :'CtwaAdRequestBodyCreativesInnerVideo'
|
|
58
|
+
:'video' => :'CtwaAdRequestBodyCreativesInnerVideo',
|
|
59
|
+
:'welcome_message' => :'CtwaAdRequestBodyCreativesInnerWelcomeMessage'
|
|
56
60
|
}
|
|
57
61
|
end
|
|
58
62
|
|
|
@@ -97,6 +101,10 @@ module Zernio
|
|
|
97
101
|
if attributes.key?(:'video')
|
|
98
102
|
self.video = attributes[:'video']
|
|
99
103
|
end
|
|
104
|
+
|
|
105
|
+
if attributes.key?(:'welcome_message')
|
|
106
|
+
self.welcome_message = attributes[:'welcome_message']
|
|
107
|
+
end
|
|
100
108
|
end
|
|
101
109
|
|
|
102
110
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -179,7 +187,8 @@ module Zernio
|
|
|
179
187
|
headline == o.headline &&
|
|
180
188
|
body == o.body &&
|
|
181
189
|
image_url == o.image_url &&
|
|
182
|
-
video == o.video
|
|
190
|
+
video == o.video &&
|
|
191
|
+
welcome_message == o.welcome_message
|
|
183
192
|
end
|
|
184
193
|
|
|
185
194
|
# @see the `==` method
|
|
@@ -191,7 +200,7 @@ module Zernio
|
|
|
191
200
|
# Calculates hash code according to all attributes.
|
|
192
201
|
# @return [Integer] Hash code
|
|
193
202
|
def hash
|
|
194
|
-
[headline, body, image_url, video].hash
|
|
203
|
+
[headline, body, image_url, video, welcome_message].hash
|
|
195
204
|
end
|
|
196
205
|
|
|
197
206
|
# Builds the object from hash
|
|
@@ -0,0 +1,211 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Zernio API
|
|
3
|
+
|
|
4
|
+
#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api Versioning and deprecation: all endpoints are versioned in the URL path (current version: /v1). Breaking changes only ship in a new path version; existing versions keep working. Deprecated operations are marked 'deprecated: true' in this spec and announced in the changelog (https://zernio.com/changelog) before removal. Errors: every 4xx/5xx response is application/json with a machine-readable 'code' and a human-readable 'error' message (see the ErrorResponse schema).
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.0.4
|
|
7
|
+
Contact: support@zernio.com
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.19.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'date'
|
|
14
|
+
require 'time'
|
|
15
|
+
|
|
16
|
+
module Zernio
|
|
17
|
+
# Custom chat welcome message for this entry. See the top-level `welcomeMessage` for the single-creative shape.
|
|
18
|
+
class CtwaAdRequestBodyCreativesInnerWelcomeMessage < ApiModelBase
|
|
19
|
+
# Greeting shown when the chat opens. Replaces Meta's default.
|
|
20
|
+
attr_accessor :text
|
|
21
|
+
|
|
22
|
+
# Message put into the user's text input, ready to send. Replaces Meta's default.
|
|
23
|
+
attr_accessor :prefill_text
|
|
24
|
+
|
|
25
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
26
|
+
def self.attribute_map
|
|
27
|
+
{
|
|
28
|
+
:'text' => :'text',
|
|
29
|
+
:'prefill_text' => :'prefillText'
|
|
30
|
+
}
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
# Returns attribute mapping this model knows about
|
|
34
|
+
def self.acceptable_attribute_map
|
|
35
|
+
attribute_map
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
# Returns all the JSON keys this model knows about
|
|
39
|
+
def self.acceptable_attributes
|
|
40
|
+
acceptable_attribute_map.values
|
|
41
|
+
end
|
|
42
|
+
|
|
43
|
+
# Attribute type mapping.
|
|
44
|
+
def self.openapi_types
|
|
45
|
+
{
|
|
46
|
+
:'text' => :'String',
|
|
47
|
+
:'prefill_text' => :'String'
|
|
48
|
+
}
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
# List of attributes with nullable: true
|
|
52
|
+
def self.openapi_nullable
|
|
53
|
+
Set.new([
|
|
54
|
+
])
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# Initializes the object
|
|
58
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
59
|
+
def initialize(attributes = {})
|
|
60
|
+
if (!attributes.is_a?(Hash))
|
|
61
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::CtwaAdRequestBodyCreativesInnerWelcomeMessage` initialize method"
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
65
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
66
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
67
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
68
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::CtwaAdRequestBodyCreativesInnerWelcomeMessage`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
69
|
+
end
|
|
70
|
+
h[k.to_sym] = v
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
if attributes.key?(:'text')
|
|
74
|
+
self.text = attributes[:'text']
|
|
75
|
+
else
|
|
76
|
+
self.text = nil
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
if attributes.key?(:'prefill_text')
|
|
80
|
+
self.prefill_text = attributes[:'prefill_text']
|
|
81
|
+
else
|
|
82
|
+
self.prefill_text = nil
|
|
83
|
+
end
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
87
|
+
# @return Array for valid properties with the reasons
|
|
88
|
+
def list_invalid_properties
|
|
89
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
90
|
+
invalid_properties = Array.new
|
|
91
|
+
if @text.nil?
|
|
92
|
+
invalid_properties.push('invalid value for "text", text cannot be nil.')
|
|
93
|
+
end
|
|
94
|
+
|
|
95
|
+
if @text.to_s.length < 1
|
|
96
|
+
invalid_properties.push('invalid value for "text", the character length must be greater than or equal to 1.')
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
if @prefill_text.nil?
|
|
100
|
+
invalid_properties.push('invalid value for "prefill_text", prefill_text cannot be nil.')
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
if @prefill_text.to_s.length < 1
|
|
104
|
+
invalid_properties.push('invalid value for "prefill_text", the character length must be greater than or equal to 1.')
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
invalid_properties
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
# Check to see if the all the properties in the model are valid
|
|
111
|
+
# @return true if the model is valid
|
|
112
|
+
def valid?
|
|
113
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
114
|
+
return false if @text.nil?
|
|
115
|
+
return false if @text.to_s.length < 1
|
|
116
|
+
return false if @prefill_text.nil?
|
|
117
|
+
return false if @prefill_text.to_s.length < 1
|
|
118
|
+
true
|
|
119
|
+
end
|
|
120
|
+
|
|
121
|
+
# Custom attribute writer method with validation
|
|
122
|
+
# @param [Object] text Value to be assigned
|
|
123
|
+
def text=(text)
|
|
124
|
+
if text.nil?
|
|
125
|
+
fail ArgumentError, 'text cannot be nil'
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
if text.to_s.length < 1
|
|
129
|
+
fail ArgumentError, 'invalid value for "text", the character length must be greater than or equal to 1.'
|
|
130
|
+
end
|
|
131
|
+
|
|
132
|
+
@text = text
|
|
133
|
+
end
|
|
134
|
+
|
|
135
|
+
# Custom attribute writer method with validation
|
|
136
|
+
# @param [Object] prefill_text Value to be assigned
|
|
137
|
+
def prefill_text=(prefill_text)
|
|
138
|
+
if prefill_text.nil?
|
|
139
|
+
fail ArgumentError, 'prefill_text cannot be nil'
|
|
140
|
+
end
|
|
141
|
+
|
|
142
|
+
if prefill_text.to_s.length < 1
|
|
143
|
+
fail ArgumentError, 'invalid value for "prefill_text", the character length must be greater than or equal to 1.'
|
|
144
|
+
end
|
|
145
|
+
|
|
146
|
+
@prefill_text = prefill_text
|
|
147
|
+
end
|
|
148
|
+
|
|
149
|
+
# Checks equality by comparing each attribute.
|
|
150
|
+
# @param [Object] Object to be compared
|
|
151
|
+
def ==(o)
|
|
152
|
+
return true if self.equal?(o)
|
|
153
|
+
self.class == o.class &&
|
|
154
|
+
text == o.text &&
|
|
155
|
+
prefill_text == o.prefill_text
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
# @see the `==` method
|
|
159
|
+
# @param [Object] Object to be compared
|
|
160
|
+
def eql?(o)
|
|
161
|
+
self == o
|
|
162
|
+
end
|
|
163
|
+
|
|
164
|
+
# Calculates hash code according to all attributes.
|
|
165
|
+
# @return [Integer] Hash code
|
|
166
|
+
def hash
|
|
167
|
+
[text, prefill_text].hash
|
|
168
|
+
end
|
|
169
|
+
|
|
170
|
+
# Builds the object from hash
|
|
171
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
172
|
+
# @return [Object] Returns the model itself
|
|
173
|
+
def self.build_from_hash(attributes)
|
|
174
|
+
return nil unless attributes.is_a?(Hash)
|
|
175
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
176
|
+
transformed_hash = {}
|
|
177
|
+
openapi_types.each_pair do |key, type|
|
|
178
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
179
|
+
transformed_hash["#{key}"] = nil
|
|
180
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
181
|
+
# check to ensure the input is an array given that the attribute
|
|
182
|
+
# is documented as an array but the input is not
|
|
183
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
184
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
185
|
+
end
|
|
186
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
187
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
188
|
+
end
|
|
189
|
+
end
|
|
190
|
+
new(transformed_hash)
|
|
191
|
+
end
|
|
192
|
+
|
|
193
|
+
# Returns the object in the form of hash
|
|
194
|
+
# @return [Hash] Returns the object in the form of hash
|
|
195
|
+
def to_hash
|
|
196
|
+
hash = {}
|
|
197
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
198
|
+
value = self.send(attr)
|
|
199
|
+
if value.nil?
|
|
200
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
201
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
202
|
+
end
|
|
203
|
+
|
|
204
|
+
hash[param] = _to_hash(value)
|
|
205
|
+
end
|
|
206
|
+
hash
|
|
207
|
+
end
|
|
208
|
+
|
|
209
|
+
end
|
|
210
|
+
|
|
211
|
+
end
|
|
@@ -0,0 +1,211 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Zernio API
|
|
3
|
+
|
|
4
|
+
#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api Versioning and deprecation: all endpoints are versioned in the URL path (current version: /v1). Breaking changes only ship in a new path version; existing versions keep working. Deprecated operations are marked 'deprecated: true' in this spec and announced in the changelog (https://zernio.com/changelog) before removal. Errors: every 4xx/5xx response is application/json with a machine-readable 'code' and a human-readable 'error' message (see the ErrorResponse schema).
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.0.4
|
|
7
|
+
Contact: support@zernio.com
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.19.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'date'
|
|
14
|
+
require 'time'
|
|
15
|
+
|
|
16
|
+
module Zernio
|
|
17
|
+
# Custom chat welcome message (Meta's `page_welcome_message`, \"Mensaje de bienvenida\" / \"Mensaje predefinido\" in Ads Manager). Single-creative shape only; for `creatives[]` set it per entry.
|
|
18
|
+
class CtwaAdRequestBodyWelcomeMessage < ApiModelBase
|
|
19
|
+
# Greeting shown when the chat opens. Replaces Meta's default (\"Hi! Can we help you?\").
|
|
20
|
+
attr_accessor :text
|
|
21
|
+
|
|
22
|
+
# Message put into the user's text input, ready to send. Replaces Meta's default (\"Hi! I want more info.\"). Lets one ad steer the opening message toward what it promotes (e.g. a specific product).
|
|
23
|
+
attr_accessor :prefill_text
|
|
24
|
+
|
|
25
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
26
|
+
def self.attribute_map
|
|
27
|
+
{
|
|
28
|
+
:'text' => :'text',
|
|
29
|
+
:'prefill_text' => :'prefillText'
|
|
30
|
+
}
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
# Returns attribute mapping this model knows about
|
|
34
|
+
def self.acceptable_attribute_map
|
|
35
|
+
attribute_map
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
# Returns all the JSON keys this model knows about
|
|
39
|
+
def self.acceptable_attributes
|
|
40
|
+
acceptable_attribute_map.values
|
|
41
|
+
end
|
|
42
|
+
|
|
43
|
+
# Attribute type mapping.
|
|
44
|
+
def self.openapi_types
|
|
45
|
+
{
|
|
46
|
+
:'text' => :'String',
|
|
47
|
+
:'prefill_text' => :'String'
|
|
48
|
+
}
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
# List of attributes with nullable: true
|
|
52
|
+
def self.openapi_nullable
|
|
53
|
+
Set.new([
|
|
54
|
+
])
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# Initializes the object
|
|
58
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
59
|
+
def initialize(attributes = {})
|
|
60
|
+
if (!attributes.is_a?(Hash))
|
|
61
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::CtwaAdRequestBodyWelcomeMessage` initialize method"
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
65
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
66
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
67
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
68
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::CtwaAdRequestBodyWelcomeMessage`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
69
|
+
end
|
|
70
|
+
h[k.to_sym] = v
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
if attributes.key?(:'text')
|
|
74
|
+
self.text = attributes[:'text']
|
|
75
|
+
else
|
|
76
|
+
self.text = nil
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
if attributes.key?(:'prefill_text')
|
|
80
|
+
self.prefill_text = attributes[:'prefill_text']
|
|
81
|
+
else
|
|
82
|
+
self.prefill_text = nil
|
|
83
|
+
end
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
87
|
+
# @return Array for valid properties with the reasons
|
|
88
|
+
def list_invalid_properties
|
|
89
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
90
|
+
invalid_properties = Array.new
|
|
91
|
+
if @text.nil?
|
|
92
|
+
invalid_properties.push('invalid value for "text", text cannot be nil.')
|
|
93
|
+
end
|
|
94
|
+
|
|
95
|
+
if @text.to_s.length < 1
|
|
96
|
+
invalid_properties.push('invalid value for "text", the character length must be greater than or equal to 1.')
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
if @prefill_text.nil?
|
|
100
|
+
invalid_properties.push('invalid value for "prefill_text", prefill_text cannot be nil.')
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
if @prefill_text.to_s.length < 1
|
|
104
|
+
invalid_properties.push('invalid value for "prefill_text", the character length must be greater than or equal to 1.')
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
invalid_properties
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
# Check to see if the all the properties in the model are valid
|
|
111
|
+
# @return true if the model is valid
|
|
112
|
+
def valid?
|
|
113
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
114
|
+
return false if @text.nil?
|
|
115
|
+
return false if @text.to_s.length < 1
|
|
116
|
+
return false if @prefill_text.nil?
|
|
117
|
+
return false if @prefill_text.to_s.length < 1
|
|
118
|
+
true
|
|
119
|
+
end
|
|
120
|
+
|
|
121
|
+
# Custom attribute writer method with validation
|
|
122
|
+
# @param [Object] text Value to be assigned
|
|
123
|
+
def text=(text)
|
|
124
|
+
if text.nil?
|
|
125
|
+
fail ArgumentError, 'text cannot be nil'
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
if text.to_s.length < 1
|
|
129
|
+
fail ArgumentError, 'invalid value for "text", the character length must be greater than or equal to 1.'
|
|
130
|
+
end
|
|
131
|
+
|
|
132
|
+
@text = text
|
|
133
|
+
end
|
|
134
|
+
|
|
135
|
+
# Custom attribute writer method with validation
|
|
136
|
+
# @param [Object] prefill_text Value to be assigned
|
|
137
|
+
def prefill_text=(prefill_text)
|
|
138
|
+
if prefill_text.nil?
|
|
139
|
+
fail ArgumentError, 'prefill_text cannot be nil'
|
|
140
|
+
end
|
|
141
|
+
|
|
142
|
+
if prefill_text.to_s.length < 1
|
|
143
|
+
fail ArgumentError, 'invalid value for "prefill_text", the character length must be greater than or equal to 1.'
|
|
144
|
+
end
|
|
145
|
+
|
|
146
|
+
@prefill_text = prefill_text
|
|
147
|
+
end
|
|
148
|
+
|
|
149
|
+
# Checks equality by comparing each attribute.
|
|
150
|
+
# @param [Object] Object to be compared
|
|
151
|
+
def ==(o)
|
|
152
|
+
return true if self.equal?(o)
|
|
153
|
+
self.class == o.class &&
|
|
154
|
+
text == o.text &&
|
|
155
|
+
prefill_text == o.prefill_text
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
# @see the `==` method
|
|
159
|
+
# @param [Object] Object to be compared
|
|
160
|
+
def eql?(o)
|
|
161
|
+
self == o
|
|
162
|
+
end
|
|
163
|
+
|
|
164
|
+
# Calculates hash code according to all attributes.
|
|
165
|
+
# @return [Integer] Hash code
|
|
166
|
+
def hash
|
|
167
|
+
[text, prefill_text].hash
|
|
168
|
+
end
|
|
169
|
+
|
|
170
|
+
# Builds the object from hash
|
|
171
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
172
|
+
# @return [Object] Returns the model itself
|
|
173
|
+
def self.build_from_hash(attributes)
|
|
174
|
+
return nil unless attributes.is_a?(Hash)
|
|
175
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
176
|
+
transformed_hash = {}
|
|
177
|
+
openapi_types.each_pair do |key, type|
|
|
178
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
179
|
+
transformed_hash["#{key}"] = nil
|
|
180
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
181
|
+
# check to ensure the input is an array given that the attribute
|
|
182
|
+
# is documented as an array but the input is not
|
|
183
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
184
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
185
|
+
end
|
|
186
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
187
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
188
|
+
end
|
|
189
|
+
end
|
|
190
|
+
new(transformed_hash)
|
|
191
|
+
end
|
|
192
|
+
|
|
193
|
+
# Returns the object in the form of hash
|
|
194
|
+
# @return [Hash] Returns the object in the form of hash
|
|
195
|
+
def to_hash
|
|
196
|
+
hash = {}
|
|
197
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
198
|
+
value = self.send(attr)
|
|
199
|
+
if value.nil?
|
|
200
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
201
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
202
|
+
end
|
|
203
|
+
|
|
204
|
+
hash[param] = _to_hash(value)
|
|
205
|
+
end
|
|
206
|
+
hash
|
|
207
|
+
end
|
|
208
|
+
|
|
209
|
+
end
|
|
210
|
+
|
|
211
|
+
end
|
data/lib/zernio-sdk/version.rb
CHANGED
data/lib/zernio-sdk.rb
CHANGED
|
@@ -357,9 +357,11 @@ require 'zernio-sdk/models/ctwa_ad_request_body'
|
|
|
357
357
|
require 'zernio-sdk/models/ctwa_ad_request_body_cities_inner'
|
|
358
358
|
require 'zernio-sdk/models/ctwa_ad_request_body_creatives_inner'
|
|
359
359
|
require 'zernio-sdk/models/ctwa_ad_request_body_creatives_inner_video'
|
|
360
|
+
require 'zernio-sdk/models/ctwa_ad_request_body_creatives_inner_welcome_message'
|
|
360
361
|
require 'zernio-sdk/models/ctwa_ad_request_body_placements'
|
|
361
362
|
require 'zernio-sdk/models/ctwa_ad_request_body_regions_inner'
|
|
362
363
|
require 'zernio-sdk/models/ctwa_ad_request_body_video'
|
|
364
|
+
require 'zernio-sdk/models/ctwa_ad_request_body_welcome_message'
|
|
363
365
|
require 'zernio-sdk/models/ctwa_ad_request_body_zips_inner'
|
|
364
366
|
require 'zernio-sdk/models/ctwa_multi_response'
|
|
365
367
|
require 'zernio-sdk/models/ctwa_single_response'
|
data/openapi.yaml
CHANGED
|
@@ -841,6 +841,16 @@ components:
|
|
|
841
841
|
Video creative for single-creative shape. Mutually
|
|
842
842
|
exclusive with `imageUrl` and with `creatives[]`. Required
|
|
843
843
|
on the single-creative shape if `imageUrl` is not supplied.
|
|
844
|
+
welcomeMessage:
|
|
845
|
+
type: object
|
|
846
|
+
required: [text, prefillText]
|
|
847
|
+
properties:
|
|
848
|
+
text: { type: string, minLength: 1, description: "Greeting shown when the chat opens. Replaces Meta's default (\"Hi! Can we help you?\")." }
|
|
849
|
+
prefillText: { type: string, minLength: 1, description: "Message put into the user's text input, ready to send. Replaces Meta's default (\"Hi! I want more info.\"). Lets one ad steer the opening message toward what it promotes (e.g. a specific product)." }
|
|
850
|
+
description: |
|
|
851
|
+
Custom chat welcome message (Meta's `page_welcome_message`,
|
|
852
|
+
"Mensaje de bienvenida" / "Mensaje predefinido" in Ads Manager).
|
|
853
|
+
Single-creative shape only; for `creatives[]` set it per entry.
|
|
844
854
|
creatives:
|
|
845
855
|
type: array
|
|
846
856
|
minItems: 1
|
|
@@ -890,6 +900,13 @@ components:
|
|
|
890
900
|
description: |
|
|
891
901
|
Video creative. Mutually exclusive with this entry's
|
|
892
902
|
`imageUrl`. Required if `imageUrl` is not supplied.
|
|
903
|
+
welcomeMessage:
|
|
904
|
+
type: object
|
|
905
|
+
required: [text, prefillText]
|
|
906
|
+
properties:
|
|
907
|
+
text: { type: string, minLength: 1, description: "Greeting shown when the chat opens. Replaces Meta's default." }
|
|
908
|
+
prefillText: { type: string, minLength: 1, description: "Message put into the user's text input, ready to send. Replaces Meta's default." }
|
|
909
|
+
description: Custom chat welcome message for this entry. See the top-level `welcomeMessage` for the single-creative shape.
|
|
893
910
|
adSetId:
|
|
894
911
|
type: string
|
|
895
912
|
description: |
|
|
@@ -69,6 +69,12 @@ describe Zernio::CreateCallAdRequest do
|
|
|
69
69
|
end
|
|
70
70
|
end
|
|
71
71
|
|
|
72
|
+
describe 'test attribute "welcome_message"' do
|
|
73
|
+
it 'should work' do
|
|
74
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
75
|
+
end
|
|
76
|
+
end
|
|
77
|
+
|
|
72
78
|
describe 'test attribute "creatives"' do
|
|
73
79
|
it 'should work' do
|
|
74
80
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -69,6 +69,12 @@ describe Zernio::CreateMessagingAdRequest do
|
|
|
69
69
|
end
|
|
70
70
|
end
|
|
71
71
|
|
|
72
|
+
describe 'test attribute "welcome_message"' do
|
|
73
|
+
it 'should work' do
|
|
74
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
75
|
+
end
|
|
76
|
+
end
|
|
77
|
+
|
|
72
78
|
describe 'test attribute "creatives"' do
|
|
73
79
|
it 'should work' do
|
|
74
80
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -51,4 +51,10 @@ describe Zernio::CtwaAdRequestBodyCreativesInner do
|
|
|
51
51
|
end
|
|
52
52
|
end
|
|
53
53
|
|
|
54
|
+
describe 'test attribute "welcome_message"' do
|
|
55
|
+
it 'should work' do
|
|
56
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
57
|
+
end
|
|
58
|
+
end
|
|
59
|
+
|
|
54
60
|
end
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Zernio API
|
|
3
|
+
|
|
4
|
+
#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api Versioning and deprecation: all endpoints are versioned in the URL path (current version: /v1). Breaking changes only ship in a new path version; existing versions keep working. Deprecated operations are marked 'deprecated: true' in this spec and announced in the changelog (https://zernio.com/changelog) before removal. Errors: every 4xx/5xx response is application/json with a machine-readable 'code' and a human-readable 'error' message (see the ErrorResponse schema).
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.0.4
|
|
7
|
+
Contact: support@zernio.com
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.19.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'spec_helper'
|
|
14
|
+
require 'json'
|
|
15
|
+
require 'date'
|
|
16
|
+
|
|
17
|
+
# Unit tests for Zernio::CtwaAdRequestBodyCreativesInnerWelcomeMessage
|
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
19
|
+
# Please update as you see appropriate
|
|
20
|
+
describe Zernio::CtwaAdRequestBodyCreativesInnerWelcomeMessage do
|
|
21
|
+
#let(:instance) { Zernio::CtwaAdRequestBodyCreativesInnerWelcomeMessage.new }
|
|
22
|
+
|
|
23
|
+
describe 'test an instance of CtwaAdRequestBodyCreativesInnerWelcomeMessage' do
|
|
24
|
+
it 'should create an instance of CtwaAdRequestBodyCreativesInnerWelcomeMessage' do
|
|
25
|
+
# uncomment below to test the instance creation
|
|
26
|
+
#expect(instance).to be_instance_of(Zernio::CtwaAdRequestBodyCreativesInnerWelcomeMessage)
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
describe 'test attribute "text"' do
|
|
31
|
+
it 'should work' do
|
|
32
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
describe 'test attribute "prefill_text"' do
|
|
37
|
+
it 'should work' do
|
|
38
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
39
|
+
end
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
end
|
|
@@ -69,6 +69,12 @@ describe Zernio::CtwaAdRequestBody do
|
|
|
69
69
|
end
|
|
70
70
|
end
|
|
71
71
|
|
|
72
|
+
describe 'test attribute "welcome_message"' do
|
|
73
|
+
it 'should work' do
|
|
74
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
75
|
+
end
|
|
76
|
+
end
|
|
77
|
+
|
|
72
78
|
describe 'test attribute "creatives"' do
|
|
73
79
|
it 'should work' do
|
|
74
80
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Zernio API
|
|
3
|
+
|
|
4
|
+
#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api Versioning and deprecation: all endpoints are versioned in the URL path (current version: /v1). Breaking changes only ship in a new path version; existing versions keep working. Deprecated operations are marked 'deprecated: true' in this spec and announced in the changelog (https://zernio.com/changelog) before removal. Errors: every 4xx/5xx response is application/json with a machine-readable 'code' and a human-readable 'error' message (see the ErrorResponse schema).
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.0.4
|
|
7
|
+
Contact: support@zernio.com
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.19.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'spec_helper'
|
|
14
|
+
require 'json'
|
|
15
|
+
require 'date'
|
|
16
|
+
|
|
17
|
+
# Unit tests for Zernio::CtwaAdRequestBodyWelcomeMessage
|
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
19
|
+
# Please update as you see appropriate
|
|
20
|
+
describe Zernio::CtwaAdRequestBodyWelcomeMessage do
|
|
21
|
+
#let(:instance) { Zernio::CtwaAdRequestBodyWelcomeMessage.new }
|
|
22
|
+
|
|
23
|
+
describe 'test an instance of CtwaAdRequestBodyWelcomeMessage' do
|
|
24
|
+
it 'should create an instance of CtwaAdRequestBodyWelcomeMessage' do
|
|
25
|
+
# uncomment below to test the instance creation
|
|
26
|
+
#expect(instance).to be_instance_of(Zernio::CtwaAdRequestBodyWelcomeMessage)
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
describe 'test attribute "text"' do
|
|
31
|
+
it 'should work' do
|
|
32
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
describe 'test attribute "prefill_text"' do
|
|
37
|
+
it 'should work' do
|
|
38
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
39
|
+
end
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: zernio-sdk
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.742
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- OpenAPI-Generator
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-08-
|
|
11
|
+
date: 2026-08-25 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: typhoeus
|
|
@@ -427,9 +427,11 @@ files:
|
|
|
427
427
|
- docs/CtwaAdRequestBodyCitiesInner.md
|
|
428
428
|
- docs/CtwaAdRequestBodyCreativesInner.md
|
|
429
429
|
- docs/CtwaAdRequestBodyCreativesInnerVideo.md
|
|
430
|
+
- docs/CtwaAdRequestBodyCreativesInnerWelcomeMessage.md
|
|
430
431
|
- docs/CtwaAdRequestBodyPlacements.md
|
|
431
432
|
- docs/CtwaAdRequestBodyRegionsInner.md
|
|
432
433
|
- docs/CtwaAdRequestBodyVideo.md
|
|
434
|
+
- docs/CtwaAdRequestBodyWelcomeMessage.md
|
|
433
435
|
- docs/CtwaAdRequestBodyZipsInner.md
|
|
434
436
|
- docs/CtwaMultiResponse.md
|
|
435
437
|
- docs/CtwaSingleResponse.md
|
|
@@ -2253,9 +2255,11 @@ files:
|
|
|
2253
2255
|
- lib/zernio-sdk/models/ctwa_ad_request_body_cities_inner.rb
|
|
2254
2256
|
- lib/zernio-sdk/models/ctwa_ad_request_body_creatives_inner.rb
|
|
2255
2257
|
- lib/zernio-sdk/models/ctwa_ad_request_body_creatives_inner_video.rb
|
|
2258
|
+
- lib/zernio-sdk/models/ctwa_ad_request_body_creatives_inner_welcome_message.rb
|
|
2256
2259
|
- lib/zernio-sdk/models/ctwa_ad_request_body_placements.rb
|
|
2257
2260
|
- lib/zernio-sdk/models/ctwa_ad_request_body_regions_inner.rb
|
|
2258
2261
|
- lib/zernio-sdk/models/ctwa_ad_request_body_video.rb
|
|
2262
|
+
- lib/zernio-sdk/models/ctwa_ad_request_body_welcome_message.rb
|
|
2259
2263
|
- lib/zernio-sdk/models/ctwa_ad_request_body_zips_inner.rb
|
|
2260
2264
|
- lib/zernio-sdk/models/ctwa_multi_response.rb
|
|
2261
2265
|
- lib/zernio-sdk/models/ctwa_single_response.rb
|
|
@@ -4027,10 +4031,12 @@ files:
|
|
|
4027
4031
|
- spec/models/ctwa_ad_request_body_cities_inner_spec.rb
|
|
4028
4032
|
- spec/models/ctwa_ad_request_body_creatives_inner_spec.rb
|
|
4029
4033
|
- spec/models/ctwa_ad_request_body_creatives_inner_video_spec.rb
|
|
4034
|
+
- spec/models/ctwa_ad_request_body_creatives_inner_welcome_message_spec.rb
|
|
4030
4035
|
- spec/models/ctwa_ad_request_body_placements_spec.rb
|
|
4031
4036
|
- spec/models/ctwa_ad_request_body_regions_inner_spec.rb
|
|
4032
4037
|
- spec/models/ctwa_ad_request_body_spec.rb
|
|
4033
4038
|
- spec/models/ctwa_ad_request_body_video_spec.rb
|
|
4039
|
+
- spec/models/ctwa_ad_request_body_welcome_message_spec.rb
|
|
4034
4040
|
- spec/models/ctwa_ad_request_body_zips_inner_spec.rb
|
|
4035
4041
|
- spec/models/ctwa_multi_response_spec.rb
|
|
4036
4042
|
- spec/models/ctwa_single_response_spec.rb
|
|
@@ -6793,6 +6799,7 @@ test_files:
|
|
|
6793
6799
|
- spec/models/sync_external_posts_request_spec.rb
|
|
6794
6800
|
- spec/models/validate_post200_response_one_of_warnings_inner_spec.rb
|
|
6795
6801
|
- spec/models/food_menu_item_spec.rb
|
|
6802
|
+
- spec/models/ctwa_ad_request_body_creatives_inner_welcome_message_spec.rb
|
|
6796
6803
|
- spec/models/update_broadcast_request_message_spec.rb
|
|
6797
6804
|
- spec/models/select_facebook_page409_response_spec.rb
|
|
6798
6805
|
- spec/models/create_verification_request_spec.rb
|
|
@@ -7086,6 +7093,7 @@ test_files:
|
|
|
7086
7093
|
- spec/models/gbp_free_form_service_item_label_spec.rb
|
|
7087
7094
|
- spec/models/generate_keyword_ideas200_response_paging_spec.rb
|
|
7088
7095
|
- spec/models/create_inbox_conversation_request_spec.rb
|
|
7096
|
+
- spec/models/ctwa_ad_request_body_welcome_message_spec.rb
|
|
7089
7097
|
- spec/models/send_inbox_message_request_interactive_action_one_of_spec.rb
|
|
7090
7098
|
- spec/models/edit_inbox_comment_request_spec.rb
|
|
7091
7099
|
- spec/models/search_available_phone_numbers200_response_numbers_inner_spec.rb
|