zernio-sdk 0.0.539 → 0.0.541
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 +4 -42
- data/docs/AdAudiencesApi.md +5 -5
- data/docs/AdCampaignsApi.md +0 -142
- data/docs/AdsApi.md +18 -700
- data/docs/InboxApi.md +79 -0
- data/docs/InboxWebhookMessageAttachmentsInner.md +1 -1
- data/docs/SMSApi.md +1 -276
- data/docs/SendSmsRequest.md +1 -1
- data/docs/WebhookPayloadMessageMessage.md +1 -1
- data/docs/WebhookPayloadMessageMessageAttachmentsInner.md +22 -0
- data/docs/WebhookPayloadMessageSentMessage.md +1 -1
- data/docs/WebhookPayloadMessageSentMessageAttachmentsInner.md +22 -0
- data/lib/zernio-sdk/api/ad_audiences_api.rb +4 -4
- data/lib/zernio-sdk/api/ad_campaigns_api.rb +0 -142
- data/lib/zernio-sdk/api/ads_api.rb +39 -739
- data/lib/zernio-sdk/api/inbox_api.rb +92 -0
- data/lib/zernio-sdk/api/sms_api.rb +2 -256
- data/lib/zernio-sdk/models/inbox_webhook_message_attachments_inner.rb +1 -1
- data/lib/zernio-sdk/models/send_sms_request.rb +1 -1
- data/lib/zernio-sdk/models/webhook_payload_message_message.rb +1 -1
- data/lib/zernio-sdk/models/{create_sms_sender_id_request.rb → webhook_payload_message_message_attachments_inner.rb} +52 -33
- data/lib/zernio-sdk/models/webhook_payload_message_sent_message.rb +1 -1
- data/lib/zernio-sdk/models/{update_ad_creative_request.rb → webhook_payload_message_sent_message_attachments_inner.rb} +46 -44
- data/lib/zernio-sdk/version.rb +1 -1
- data/lib/zernio-sdk.rb +3 -26
- data/openapi.yaml +87 -624
- data/spec/api/ad_audiences_api_spec.rb +2 -2
- data/spec/api/ad_campaigns_api_spec.rb +0 -25
- data/spec/api/ads_api_spec.rb +0 -128
- data/spec/api/inbox_api_spec.rb +48 -0
- data/spec/api/sms_api_spec.rb +1 -47
- data/spec/models/{list_ad_images200_response_spec.rb → webhook_payload_message_message_attachments_inner_spec.rb} +9 -9
- data/spec/models/{list_ad_creatives200_response_spec.rb → webhook_payload_message_sent_message_attachments_inner_spec.rb} +9 -9
- metadata +13 -105
- data/docs/CreateAdCampaign201Response.md +0 -24
- data/docs/CreateAdCampaignRequest.md +0 -32
- data/docs/CreateAdCreative201Response.md +0 -20
- data/docs/CreateAdCreativeRequest.md +0 -38
- data/docs/CreateAdCreativeRequestCarouselCardsInner.md +0 -26
- data/docs/CreateSmsSenderId200Response.md +0 -22
- data/docs/CreateSmsSenderIdRequest.md +0 -18
- data/docs/DeleteAdCreative200Response.md +0 -20
- data/docs/DeleteSmsSenderId200Response.md +0 -18
- data/docs/DuplicateAd200Response.md +0 -22
- data/docs/DuplicateAdRequest.md +0 -28
- data/docs/DuplicateAdSet200Response.md +0 -22
- data/docs/DuplicateAdSetRequest.md +0 -36
- data/docs/GetAdCreative200Response.md +0 -18
- data/docs/ListAdCreatives200Response.md +0 -22
- data/docs/ListAdImages200Response.md +0 -22
- data/docs/ListAdLabels200Response.md +0 -22
- data/docs/ListHighDemandPeriods200Response.md +0 -22
- data/docs/ListSmsSenderIds200Response.md +0 -20
- data/docs/ListSmsSenderIds200ResponseBudget.md +0 -24
- data/docs/ListSmsSenderIds200ResponseBudgetPendingRequest.md +0 -22
- data/docs/ListSmsSenderIds200ResponseSenderIdsInner.md +0 -24
- data/docs/RequestSmsSenderIdLimitIncrease200Response.md +0 -20
- data/docs/RequestSmsSenderIdLimitIncreaseRequest.md +0 -20
- data/docs/UpdateAdCreative200Response.md +0 -22
- data/docs/UpdateAdCreativeRequest.md +0 -20
- data/lib/zernio-sdk/models/create_ad_campaign201_response.rb +0 -210
- data/lib/zernio-sdk/models/create_ad_campaign_request.rb +0 -343
- data/lib/zernio-sdk/models/create_ad_creative201_response.rb +0 -157
- data/lib/zernio-sdk/models/create_ad_creative_request.rb +0 -390
- data/lib/zernio-sdk/models/create_ad_creative_request_carousel_cards_inner.rb +0 -255
- data/lib/zernio-sdk/models/create_sms_sender_id200_response.rb +0 -166
- data/lib/zernio-sdk/models/delete_ad_creative200_response.rb +0 -156
- data/lib/zernio-sdk/models/delete_sms_sender_id200_response.rb +0 -147
- data/lib/zernio-sdk/models/duplicate_ad200_response.rb +0 -200
- data/lib/zernio-sdk/models/duplicate_ad_request.rb +0 -243
- data/lib/zernio-sdk/models/duplicate_ad_set200_response.rb +0 -201
- data/lib/zernio-sdk/models/duplicate_ad_set_request.rb +0 -302
- data/lib/zernio-sdk/models/get_ad_creative200_response.rb +0 -148
- data/lib/zernio-sdk/models/list_ad_creatives200_response.rb +0 -167
- data/lib/zernio-sdk/models/list_ad_images200_response.rb +0 -167
- data/lib/zernio-sdk/models/list_ad_labels200_response.rb +0 -167
- data/lib/zernio-sdk/models/list_high_demand_periods200_response.rb +0 -168
- data/lib/zernio-sdk/models/list_sms_sender_ids200_response.rb +0 -158
- data/lib/zernio-sdk/models/list_sms_sender_ids200_response_budget.rb +0 -178
- data/lib/zernio-sdk/models/list_sms_sender_ids200_response_budget_pending_request.rb +0 -167
- data/lib/zernio-sdk/models/list_sms_sender_ids200_response_sender_ids_inner.rb +0 -175
- data/lib/zernio-sdk/models/request_sms_sender_id_limit_increase200_response.rb +0 -156
- data/lib/zernio-sdk/models/request_sms_sender_id_limit_increase_request.rb +0 -210
- data/lib/zernio-sdk/models/update_ad_creative200_response.rb +0 -165
- data/spec/models/create_ad_campaign201_response_spec.rb +0 -58
- data/spec/models/create_ad_campaign_request_spec.rb +0 -94
- data/spec/models/create_ad_creative201_response_spec.rb +0 -42
- data/spec/models/create_ad_creative_request_carousel_cards_inner_spec.rb +0 -60
- data/spec/models/create_ad_creative_request_spec.rb +0 -96
- data/spec/models/create_sms_sender_id200_response_spec.rb +0 -48
- data/spec/models/create_sms_sender_id_request_spec.rb +0 -36
- data/spec/models/delete_ad_creative200_response_spec.rb +0 -42
- data/spec/models/delete_sms_sender_id200_response_spec.rb +0 -36
- data/spec/models/duplicate_ad200_response_spec.rb +0 -52
- data/spec/models/duplicate_ad_request_spec.rb +0 -74
- data/spec/models/duplicate_ad_set200_response_spec.rb +0 -52
- data/spec/models/duplicate_ad_set_request_spec.rb +0 -102
- data/spec/models/get_ad_creative200_response_spec.rb +0 -36
- data/spec/models/list_ad_labels200_response_spec.rb +0 -48
- data/spec/models/list_high_demand_periods200_response_spec.rb +0 -48
- data/spec/models/list_sms_sender_ids200_response_budget_pending_request_spec.rb +0 -48
- data/spec/models/list_sms_sender_ids200_response_budget_spec.rb +0 -54
- data/spec/models/list_sms_sender_ids200_response_sender_ids_inner_spec.rb +0 -54
- data/spec/models/list_sms_sender_ids200_response_spec.rb +0 -42
- data/spec/models/request_sms_sender_id_limit_increase200_response_spec.rb +0 -42
- data/spec/models/request_sms_sender_id_limit_increase_request_spec.rb +0 -42
- data/spec/models/update_ad_creative200_response_spec.rb +0 -48
- data/spec/models/update_ad_creative_request_spec.rb +0 -42
|
@@ -87,74 +87,6 @@ module Zernio
|
|
|
87
87
|
return data, status_code, headers
|
|
88
88
|
end
|
|
89
89
|
|
|
90
|
-
# Create a standalone campaign (Meta)
|
|
91
|
-
# Creates a campaign WITHOUT its first ad set / ad (the ODAX shell only). Ad sets join it later via `existingCampaignId` on the create endpoints. A budget here is campaign-level (CBO) by definition; omit it for ABO (each ad set carries its own budget). Created `PAUSED` unless `status: ACTIVE`. The campaign materializes in `/v1/ads/tree` via the next sync discovery pass. Meta only.
|
|
92
|
-
# @param create_ad_campaign_request [CreateAdCampaignRequest]
|
|
93
|
-
# @param [Hash] opts the optional parameters
|
|
94
|
-
# @return [CreateAdCampaign201Response]
|
|
95
|
-
def create_ad_campaign(create_ad_campaign_request, opts = {})
|
|
96
|
-
data, _status_code, _headers = create_ad_campaign_with_http_info(create_ad_campaign_request, opts)
|
|
97
|
-
data
|
|
98
|
-
end
|
|
99
|
-
|
|
100
|
-
# Create a standalone campaign (Meta)
|
|
101
|
-
# Creates a campaign WITHOUT its first ad set / ad (the ODAX shell only). Ad sets join it later via `existingCampaignId` on the create endpoints. A budget here is campaign-level (CBO) by definition; omit it for ABO (each ad set carries its own budget). Created `PAUSED` unless `status: ACTIVE`. The campaign materializes in `/v1/ads/tree` via the next sync discovery pass. Meta only.
|
|
102
|
-
# @param create_ad_campaign_request [CreateAdCampaignRequest]
|
|
103
|
-
# @param [Hash] opts the optional parameters
|
|
104
|
-
# @return [Array<(CreateAdCampaign201Response, Integer, Hash)>] CreateAdCampaign201Response data, response status code and response headers
|
|
105
|
-
def create_ad_campaign_with_http_info(create_ad_campaign_request, opts = {})
|
|
106
|
-
if @api_client.config.debugging
|
|
107
|
-
@api_client.config.logger.debug 'Calling API: AdCampaignsApi.create_ad_campaign ...'
|
|
108
|
-
end
|
|
109
|
-
# verify the required parameter 'create_ad_campaign_request' is set
|
|
110
|
-
if @api_client.config.client_side_validation && create_ad_campaign_request.nil?
|
|
111
|
-
fail ArgumentError, "Missing the required parameter 'create_ad_campaign_request' when calling AdCampaignsApi.create_ad_campaign"
|
|
112
|
-
end
|
|
113
|
-
# resource path
|
|
114
|
-
local_var_path = '/v1/ads/campaigns'
|
|
115
|
-
|
|
116
|
-
# query parameters
|
|
117
|
-
query_params = opts[:query_params] || {}
|
|
118
|
-
|
|
119
|
-
# header parameters
|
|
120
|
-
header_params = opts[:header_params] || {}
|
|
121
|
-
# HTTP header 'Accept' (if needed)
|
|
122
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
123
|
-
# HTTP header 'Content-Type'
|
|
124
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
|
125
|
-
if !content_type.nil?
|
|
126
|
-
header_params['Content-Type'] = content_type
|
|
127
|
-
end
|
|
128
|
-
|
|
129
|
-
# form parameters
|
|
130
|
-
form_params = opts[:form_params] || {}
|
|
131
|
-
|
|
132
|
-
# http body (model)
|
|
133
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_ad_campaign_request)
|
|
134
|
-
|
|
135
|
-
# return_type
|
|
136
|
-
return_type = opts[:debug_return_type] || 'CreateAdCampaign201Response'
|
|
137
|
-
|
|
138
|
-
# auth_names
|
|
139
|
-
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
140
|
-
|
|
141
|
-
new_options = opts.merge(
|
|
142
|
-
:operation => :"AdCampaignsApi.create_ad_campaign",
|
|
143
|
-
:header_params => header_params,
|
|
144
|
-
:query_params => query_params,
|
|
145
|
-
:form_params => form_params,
|
|
146
|
-
:body => post_body,
|
|
147
|
-
:auth_names => auth_names,
|
|
148
|
-
:return_type => return_type
|
|
149
|
-
)
|
|
150
|
-
|
|
151
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
152
|
-
if @api_client.config.debugging
|
|
153
|
-
@api_client.config.logger.debug "API called: AdCampaignsApi#create_ad_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
154
|
-
end
|
|
155
|
-
return data, status_code, headers
|
|
156
|
-
end
|
|
157
|
-
|
|
158
90
|
# Delete a campaign
|
|
159
91
|
# Deletes the whole campaign on the platform, cascading to its ad sets and ads. Locally, all Ad documents for this campaign are marked `status: cancelled`. Meta-only for now. Other platforms return 501 Not Implemented — fall back to DELETE /v1/ads/{adId} per ad in the meantime.
|
|
160
92
|
# @param campaign_id [String] Platform campaign ID
|
|
@@ -303,80 +235,6 @@ module Zernio
|
|
|
303
235
|
return data, status_code, headers
|
|
304
236
|
end
|
|
305
237
|
|
|
306
|
-
# Duplicate an ad set (Meta)
|
|
307
|
-
# Duplicates an ad set, including its ads and creatives by default (`deepCopy: true`), via Meta's native `POST /{adset-id}/copies`. The copy is created paused so callers can review before launching. `campaignId` retargets the copy into another campaign; omitted = the source's own campaign. The new hierarchy materializes asynchronously — sync discovery is triggered automatically (`syncAfter: false` to skip). Meta only.
|
|
308
|
-
# @param ad_set_id [String] Source platform ad set ID
|
|
309
|
-
# @param duplicate_ad_set_request [DuplicateAdSetRequest]
|
|
310
|
-
# @param [Hash] opts the optional parameters
|
|
311
|
-
# @return [DuplicateAdSet200Response]
|
|
312
|
-
def duplicate_ad_set(ad_set_id, duplicate_ad_set_request, opts = {})
|
|
313
|
-
data, _status_code, _headers = duplicate_ad_set_with_http_info(ad_set_id, duplicate_ad_set_request, opts)
|
|
314
|
-
data
|
|
315
|
-
end
|
|
316
|
-
|
|
317
|
-
# Duplicate an ad set (Meta)
|
|
318
|
-
# Duplicates an ad set, including its ads and creatives by default (`deepCopy: true`), via Meta's native `POST /{adset-id}/copies`. The copy is created paused so callers can review before launching. `campaignId` retargets the copy into another campaign; omitted = the source's own campaign. The new hierarchy materializes asynchronously — sync discovery is triggered automatically (`syncAfter: false` to skip). Meta only.
|
|
319
|
-
# @param ad_set_id [String] Source platform ad set ID
|
|
320
|
-
# @param duplicate_ad_set_request [DuplicateAdSetRequest]
|
|
321
|
-
# @param [Hash] opts the optional parameters
|
|
322
|
-
# @return [Array<(DuplicateAdSet200Response, Integer, Hash)>] DuplicateAdSet200Response data, response status code and response headers
|
|
323
|
-
def duplicate_ad_set_with_http_info(ad_set_id, duplicate_ad_set_request, opts = {})
|
|
324
|
-
if @api_client.config.debugging
|
|
325
|
-
@api_client.config.logger.debug 'Calling API: AdCampaignsApi.duplicate_ad_set ...'
|
|
326
|
-
end
|
|
327
|
-
# verify the required parameter 'ad_set_id' is set
|
|
328
|
-
if @api_client.config.client_side_validation && ad_set_id.nil?
|
|
329
|
-
fail ArgumentError, "Missing the required parameter 'ad_set_id' when calling AdCampaignsApi.duplicate_ad_set"
|
|
330
|
-
end
|
|
331
|
-
# verify the required parameter 'duplicate_ad_set_request' is set
|
|
332
|
-
if @api_client.config.client_side_validation && duplicate_ad_set_request.nil?
|
|
333
|
-
fail ArgumentError, "Missing the required parameter 'duplicate_ad_set_request' when calling AdCampaignsApi.duplicate_ad_set"
|
|
334
|
-
end
|
|
335
|
-
# resource path
|
|
336
|
-
local_var_path = '/v1/ads/ad-sets/{adSetId}/duplicate'.sub('{' + 'adSetId' + '}', CGI.escape(ad_set_id.to_s))
|
|
337
|
-
|
|
338
|
-
# query parameters
|
|
339
|
-
query_params = opts[:query_params] || {}
|
|
340
|
-
|
|
341
|
-
# header parameters
|
|
342
|
-
header_params = opts[:header_params] || {}
|
|
343
|
-
# HTTP header 'Accept' (if needed)
|
|
344
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
345
|
-
# HTTP header 'Content-Type'
|
|
346
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
|
347
|
-
if !content_type.nil?
|
|
348
|
-
header_params['Content-Type'] = content_type
|
|
349
|
-
end
|
|
350
|
-
|
|
351
|
-
# form parameters
|
|
352
|
-
form_params = opts[:form_params] || {}
|
|
353
|
-
|
|
354
|
-
# http body (model)
|
|
355
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(duplicate_ad_set_request)
|
|
356
|
-
|
|
357
|
-
# return_type
|
|
358
|
-
return_type = opts[:debug_return_type] || 'DuplicateAdSet200Response'
|
|
359
|
-
|
|
360
|
-
# auth_names
|
|
361
|
-
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
362
|
-
|
|
363
|
-
new_options = opts.merge(
|
|
364
|
-
:operation => :"AdCampaignsApi.duplicate_ad_set",
|
|
365
|
-
:header_params => header_params,
|
|
366
|
-
:query_params => query_params,
|
|
367
|
-
:form_params => form_params,
|
|
368
|
-
:body => post_body,
|
|
369
|
-
:auth_names => auth_names,
|
|
370
|
-
:return_type => return_type
|
|
371
|
-
)
|
|
372
|
-
|
|
373
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
374
|
-
if @api_client.config.debugging
|
|
375
|
-
@api_client.config.logger.debug "API called: AdCampaignsApi#duplicate_ad_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
376
|
-
end
|
|
377
|
-
return data, status_code, headers
|
|
378
|
-
end
|
|
379
|
-
|
|
380
238
|
# Live ad-set details incl. learning phase (Meta)
|
|
381
239
|
# Reads the ad set live from Meta, returned verbatim. The default projection includes `learning_stage_info` (learning-phase status: LEARNING / SUCCESS / FAIL / WAIVING — Meta omits its `status` key on paused ad sets), delivery settings, budgets, schedule and targeting. `fields` is a raw-passthrough override; unknown fields return Meta's 400 verbatim. Meta only.
|
|
382
240
|
# @param ad_set_id [String] Meta ad set id (platformAdSetId).
|