late-sdk 0.0.716 → 0.0.718
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 +81 -0
- data/docs/AccountsApi.md +142 -1
- data/docs/AdCampaignsApi.md +22 -10
- data/docs/AdCreative.md +2 -0
- data/docs/AdDailyMetrics.md +1 -1
- data/docs/AdEngagementCounts.md +4 -4
- data/docs/AdInsightsApi.md +164 -0
- data/docs/AdMetrics.md +1 -1
- data/docs/AdTargetingApi.md +3 -3
- data/docs/AdTreeCampaign.md +1 -1
- data/docs/AddBroadcastRecipientsRequest.md +1 -1
- data/docs/AnalyticsListResponsePostsInner.md +1 -1
- data/docs/AnalyticsListResponsePostsInnerMediaItemsInner.md +24 -0
- data/docs/AnalyticsSinglePostResponseMediaItemsInner.md +7 -3
- data/docs/BillingSnapshot.md +2 -0
- data/docs/BillingSnapshotPlan.md +3 -1
- data/docs/Blog.md +24 -0
- data/docs/BlogArticle.md +44 -0
- data/docs/BlogArticleImage.md +20 -0
- data/docs/BlogsApi.md +747 -0
- data/docs/BlueskyPlatformData.md +2 -0
- data/docs/BoostPostRequest.md +2 -2
- data/docs/CampaignAnalyticsResponseAnalyticsDailyInner.md +1 -1
- data/docs/CommentsApi.md +8 -8
- data/docs/ConnectApi.md +149 -1
- data/docs/ConnectShopifyWithToken200Response.md +18 -0
- data/docs/ConnectShopifyWithToken200ResponseAccount.md +26 -0
- data/docs/ConnectShopifyWithTokenRequest.md +22 -0
- data/docs/CreateBlog201Response.md +20 -0
- data/docs/CreateBlogArticle201Response.md +20 -0
- data/docs/CreateBlogArticleRequest.md +36 -0
- data/docs/CreateBlogArticleRequestImage.md +20 -0
- data/docs/CreateBlogArticleRequestSeo.md +20 -0
- data/docs/CreateBlogRequest.md +20 -0
- data/docs/CreateCallAdRequest.md +1 -1
- data/docs/CreateInboxConversationRequest.md +2 -0
- data/docs/CreateMessagingAdRequest.md +1 -1
- data/docs/CreatePostRequest.md +1 -1
- data/docs/CreateStandaloneAdRequest.md +10 -6
- data/docs/CreateStandaloneAdRequestPromotedObject.md +2 -2
- data/docs/CreateStandaloneAdRequestVideo.md +1 -1
- data/docs/CtwaAdRequestBody.md +1 -1
- data/docs/ExternalPostMediaItem.md +7 -3
- data/docs/ExternalPostSummary.md +0 -2
- data/docs/ExternalPostSummaryAnalytics.md +1 -1
- data/docs/GetAccountHealth200Response.md +3 -1
- data/docs/GetAccountHealth200ResponsePlatformConnection.md +24 -0
- data/docs/GetAccountHealth200ResponsePlatformConnectionMetaError.md +22 -0
- data/docs/GetAdAnalytics202Response.md +1 -1
- data/docs/GetAdTree202Response.md +1 -1
- data/docs/GetAdsTimeline202Response.md +1 -1
- data/docs/GetBlueskySettings200Response.md +18 -0
- data/docs/GetCampaignAnalytics202Response.md +1 -1
- data/docs/GetInboxPostComments200ResponseCommentsInner.md +4 -2
- data/docs/GetLinkedInPostAnalytics200ResponseAnalytics.md +1 -1
- data/docs/GetPhoneNumberKycForm200Response.md +3 -1
- data/docs/GetWhatsAppNumberKycForm200Response.md +3 -1
- data/docs/LinkedInAggregateAnalyticsTotalResponseAnalytics.md +1 -1
- data/docs/LinkedInPlatformData.md +4 -2
- data/docs/LinkedInPlatformDataPoll.md +22 -0
- data/docs/ListAds202Response.md +1 -1
- data/docs/ListBlogArticles200Response.md +22 -0
- data/docs/ListBlogs200Response.md +22 -0
- data/docs/ListInboxConversations200ResponseDataInnerMetadata.md +3 -3
- data/docs/ListLeads200ResponseLeadsInner.md +3 -3
- data/docs/ListLocalServicesLeadConversations200Response.md +22 -0
- data/docs/ListLocalServicesLeadConversations200ResponseDataInner.md +28 -0
- data/docs/ListLocalServicesLeadConversations200ResponseDataInnerMessage.md +20 -0
- data/docs/ListLocalServicesLeadConversations200ResponseDataInnerPhoneCall.md +20 -0
- data/docs/ListLocalServicesLeads200Response.md +22 -0
- data/docs/ListLocalServicesLeads200ResponseDataInner.md +38 -0
- data/docs/ListLocalServicesLeads200ResponseDataInnerContact.md +22 -0
- data/docs/ListPhoneNumbers200ResponseConnectedInner.md +3 -1
- data/docs/ListPhoneNumbers200ResponseNumbersInner.md +2 -0
- data/docs/ListWhatsAppAccountEvents200Response.md +18 -0
- data/docs/ListWhatsAppAccountEvents200ResponseEventsInner.md +28 -0
- data/docs/MessagesApi.md +4 -4
- data/docs/OnVerificationApprovedRequest.md +1 -1
- data/docs/OnVerificationFailedRequest.md +1 -1
- data/docs/OnWhatsAppAutomaticEventRequest.md +1 -1
- data/docs/OnWhatsAppNumberActionRequiredRequest.md +1 -1
- data/docs/OnWhatsAppNumberActivatedRequest.md +1 -1
- data/docs/OnWhatsAppNumberDeclinedRequest.md +1 -1
- data/docs/OnWhatsAppNumberKycSubmittedRequest.md +1 -1
- data/docs/OnWhatsAppNumberReactivatedRequest.md +1 -1
- data/docs/OnWhatsAppNumberReleasedRequest.md +1 -1
- data/docs/OnWhatsAppNumberSuspendedRequest.md +1 -1
- data/docs/OnWhatsAppNumberVerificationRequiredRequest.md +1 -1
- data/docs/PlatformTarget.md +2 -2
- data/docs/PostAnalytics.md +3 -3
- data/docs/PostsApi.md +1 -1
- data/docs/SMSApi.md +1 -1
- data/docs/SearchAdTargeting200ResponseResultsInner.md +1 -1
- data/docs/SendInboxMessageRequest.md +4 -2
- data/docs/SubmitPhoneNumberKycRequest.md +1 -1
- data/docs/SubmitPhoneNumberKycRequestAddress.md +2 -0
- data/docs/SubmitWhatsAppNumberKycRequest.md +1 -1
- data/docs/TwitterPlatformData.md +2 -0
- data/docs/UpdateAdCampaignStatus200Response.md +6 -6
- data/docs/UpdateAdSet200Response.md +7 -3
- data/docs/UpdateAdSetRequest.md +1 -1
- data/docs/UpdateAdSetStatus200Response.md +9 -3
- data/docs/UpdateBlogArticleRequest.md +36 -0
- data/docs/UpdateBlogRequest.md +20 -0
- data/docs/UpdateBlueskySettingsRequest.md +18 -0
- data/docs/ValidatePhoneNumberKycAddressRequest.md +2 -0
- data/docs/WebhookEventsApi.md +138 -0
- data/docs/WebhookPayloadAccountAdsInitialSyncCompleted.md +1 -1
- data/docs/WebhookPayloadAccountConnected.md +1 -1
- data/docs/WebhookPayloadAccountDisconnected.md +1 -1
- data/docs/WebhookPayloadAdStatusChanged.md +1 -1
- data/docs/WebhookPayloadCallEnded.md +1 -1
- data/docs/WebhookPayloadCallEndedCall.md +4 -0
- data/docs/WebhookPayloadCallFailed.md +1 -1
- data/docs/WebhookPayloadCallPermissionRequest.md +1 -1
- data/docs/WebhookPayloadCallReceived.md +1 -1
- data/docs/WebhookPayloadComment.md +1 -1
- data/docs/WebhookPayloadCommentCommentAuthor.md +2 -0
- data/docs/WebhookPayloadConversationStarted.md +1 -1
- data/docs/WebhookPayloadExternalPost.md +1 -1
- data/docs/WebhookPayloadLead.md +1 -1
- data/docs/WebhookPayloadMessage.md +1 -1
- data/docs/WebhookPayloadMessageDeleted.md +1 -1
- data/docs/WebhookPayloadMessageDeliveryStatus.md +1 -1
- data/docs/WebhookPayloadMessageEdited.md +1 -1
- data/docs/WebhookPayloadMessageMetadata.md +5 -1
- data/docs/WebhookPayloadMessageMetadataReferral.md +5 -3
- data/docs/WebhookPayloadMessageMetadataUnsupported.md +22 -0
- data/docs/WebhookPayloadMessageSent.md +1 -1
- data/docs/WebhookPayloadPost.md +1 -1
- data/docs/WebhookPayloadPostPlatform.md +1 -1
- data/docs/WebhookPayloadReaction.md +1 -1
- data/docs/WebhookPayloadReferral.md +30 -0
- data/docs/WebhookPayloadReferralReferral.md +28 -0
- data/docs/WebhookPayloadReferralReferralAdsContextData.md +28 -0
- data/docs/WebhookPayloadReferralSender.md +20 -0
- data/docs/WebhookPayloadReviewNew.md +1 -1
- data/docs/WebhookPayloadReviewUpdated.md +1 -1
- data/docs/WebhookPayloadTest.md +1 -1
- data/docs/WebhookPayloadWhatsAppTemplateCategoryUpdated.md +26 -0
- data/docs/WebhookPayloadWhatsAppTemplateCategoryUpdatedTemplate.md +32 -0
- data/docs/WebhookPayloadWhatsAppTemplateStatusUpdated.md +1 -1
- data/docs/WhatsAppApi.md +74 -0
- data/docs/WorkflowNode.md +3 -1
- data/docs/XArticle.md +24 -0
- data/docs/XArticleBlock.md +28 -0
- data/docs/XArticleBlockData.md +24 -0
- data/docs/XArticleContentState.md +20 -0
- data/docs/XArticleCover.md +20 -0
- data/docs/XArticleEntity.md +57 -0
- data/docs/XArticleEntityOneOf.md +20 -0
- data/docs/XArticleEntityOneOf1.md +20 -0
- data/docs/XArticleEntityOneOf1Value.md +22 -0
- data/docs/XArticleEntityOneOf1ValueData.md +18 -0
- data/docs/XArticleEntityOneOf2.md +20 -0
- data/docs/XArticleEntityOneOf2Value.md +22 -0
- data/docs/XArticleEntityOneOf2ValueData.md +22 -0
- data/docs/XArticleEntityOneOf3.md +20 -0
- data/docs/XArticleEntityOneOf3Value.md +22 -0
- data/docs/XArticleEntityOneOf3ValueData.md +18 -0
- data/docs/XArticleEntityOneOf4.md +20 -0
- data/docs/XArticleEntityOneOf4Value.md +22 -0
- data/docs/XArticleEntityOneOf4ValueData.md +18 -0
- data/docs/XArticleEntityOneOf5.md +20 -0
- data/docs/XArticleEntityOneOf5Value.md +22 -0
- data/docs/XArticleEntityOneOfValue.md +22 -0
- data/docs/XArticleEntityOneOfValueData.md +18 -0
- data/docs/XArticleEntityRange.md +22 -0
- data/docs/XArticleInlineStyleRange.md +22 -0
- data/docs/XArticleTextRange.md +22 -0
- data/docs/YouTubeVideoRetentionResponse.md +1 -1
- data/docs/YouTubeVideoRetentionResponseRetentionCurveInner.md +2 -2
- data/lib/zernio-sdk/api/accounts_api.rb +139 -2
- data/lib/zernio-sdk/api/ad_campaigns_api.rb +35 -8
- data/lib/zernio-sdk/api/ad_insights_api.rb +165 -0
- data/lib/zernio-sdk/api/ad_targeting_api.rb +5 -5
- data/lib/zernio-sdk/api/blogs_api.rb +845 -0
- data/lib/zernio-sdk/api/comments_api.rb +10 -10
- data/lib/zernio-sdk/api/connect_api.rb +149 -0
- data/lib/zernio-sdk/api/messages_api.rb +4 -4
- data/lib/zernio-sdk/api/posts_api.rb +2 -2
- data/lib/zernio-sdk/api/sms_api.rb +2 -2
- data/lib/zernio-sdk/api/webhook_events_api.rb +132 -0
- data/lib/zernio-sdk/api/whats_app_api.rb +75 -0
- data/lib/zernio-sdk/models/account_with_follower_stats.rb +2 -2
- data/lib/zernio-sdk/models/ad_creative.rb +12 -1
- data/lib/zernio-sdk/models/ad_daily_metrics.rb +1 -1
- data/lib/zernio-sdk/models/ad_engagement_counts.rb +5 -5
- data/lib/zernio-sdk/models/ad_metrics.rb +1 -1
- data/lib/zernio-sdk/models/ad_tree_campaign.rb +1 -1
- data/lib/zernio-sdk/models/add_broadcast_recipients_request.rb +1 -1
- data/lib/zernio-sdk/models/analytics_list_response_posts_inner.rb +1 -1
- data/lib/zernio-sdk/models/analytics_list_response_posts_inner_media_items_inner.rb +211 -0
- data/lib/zernio-sdk/models/analytics_single_post_response_media_items_inner.rb +52 -6
- data/lib/zernio-sdk/models/billing_snapshot.rb +14 -3
- data/lib/zernio-sdk/models/billing_snapshot_plan.rb +14 -4
- data/lib/zernio-sdk/models/blog.rb +211 -0
- data/lib/zernio-sdk/models/blog_article.rb +315 -0
- data/lib/zernio-sdk/models/blog_article_image.rb +158 -0
- data/lib/zernio-sdk/models/bluesky_platform_data.rb +42 -2
- data/lib/zernio-sdk/models/boost_post_request.rb +30 -1
- data/lib/zernio-sdk/models/campaign_analytics_response_analytics_daily_inner.rb +1 -1
- data/lib/zernio-sdk/models/connect_shopify_with_token200_response.rb +147 -0
- data/lib/zernio-sdk/models/connect_shopify_with_token200_response_account.rb +218 -0
- data/lib/zernio-sdk/models/connect_shopify_with_token_request.rb +219 -0
- data/lib/zernio-sdk/models/create_blog201_response.rb +190 -0
- data/lib/zernio-sdk/models/create_blog_article201_response.rb +190 -0
- data/lib/zernio-sdk/models/create_blog_article_request.rb +262 -0
- data/lib/zernio-sdk/models/create_blog_article_request_image.rb +174 -0
- data/lib/zernio-sdk/models/create_blog_article_request_seo.rb +157 -0
- data/lib/zernio-sdk/models/create_blog_request.rb +202 -0
- data/lib/zernio-sdk/models/create_call_ad_request.rb +1 -1
- data/lib/zernio-sdk/models/create_inbox_conversation_request.rb +13 -1
- data/lib/zernio-sdk/models/create_messaging_ad_request.rb +1 -1
- data/lib/zernio-sdk/models/create_post_request.rb +1 -1
- data/lib/zernio-sdk/models/create_standalone_ad_request.rb +67 -6
- data/lib/zernio-sdk/models/create_standalone_ad_request_creatives_inner_video.rb +1 -1
- data/lib/zernio-sdk/models/create_standalone_ad_request_promoted_object.rb +3 -3
- data/lib/zernio-sdk/models/create_standalone_ad_request_video.rb +1 -1
- data/lib/zernio-sdk/models/ctwa_ad_request_body.rb +1 -1
- data/lib/zernio-sdk/models/external_post_media_item.rb +48 -16
- data/lib/zernio-sdk/models/external_post_summary.rb +1 -11
- data/lib/zernio-sdk/models/external_post_summary_analytics.rb +1 -0
- data/lib/zernio-sdk/models/facebook_settings.rb +5 -5
- data/lib/zernio-sdk/models/get_account_health200_response.rb +13 -4
- data/lib/zernio-sdk/models/get_account_health200_response_platform_connection.rb +213 -0
- data/lib/zernio-sdk/models/get_account_health200_response_platform_connection_meta_error.rb +168 -0
- data/lib/zernio-sdk/models/get_ad_analytics202_response.rb +6 -29
- data/lib/zernio-sdk/models/get_ad_tree202_response.rb +6 -29
- data/lib/zernio-sdk/models/get_ads_timeline202_response.rb +6 -29
- data/lib/zernio-sdk/models/get_bluesky_settings200_response.rb +150 -0
- data/lib/zernio-sdk/models/get_campaign_analytics202_response.rb +6 -29
- data/lib/zernio-sdk/models/get_inbox_post_comments200_response_comments_inner.rb +13 -2
- data/lib/zernio-sdk/models/get_linked_in_post_analytics200_response_analytics.rb +1 -1
- data/lib/zernio-sdk/models/get_phone_number_kyc_form200_response.rb +14 -4
- data/lib/zernio-sdk/models/get_whats_app_number_kyc_form200_response.rb +14 -4
- data/lib/zernio-sdk/models/inbox_webhook_message.rb +2 -2
- data/lib/zernio-sdk/models/linked_in_aggregate_analytics_total_response_analytics.rb +1 -1
- data/lib/zernio-sdk/models/linked_in_platform_data.rb +15 -6
- data/lib/zernio-sdk/models/linked_in_platform_data_poll.rb +277 -0
- data/lib/zernio-sdk/models/list_ads202_response.rb +6 -29
- data/lib/zernio-sdk/models/list_blog_articles200_response.rb +203 -0
- data/lib/zernio-sdk/models/list_blogs200_response.rb +203 -0
- data/lib/zernio-sdk/models/list_broadcast_recipients200_response_recipients_inner.rb +1 -0
- data/lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner_metadata.rb +4 -4
- data/lib/zernio-sdk/models/list_leads200_response_leads_inner.rb +3 -2
- data/lib/zernio-sdk/models/list_local_services_lead_conversations200_response.rb +167 -0
- data/lib/zernio-sdk/models/list_local_services_lead_conversations200_response_data_inner.rb +198 -0
- data/lib/zernio-sdk/models/list_local_services_lead_conversations200_response_data_inner_message.rb +160 -0
- data/lib/zernio-sdk/models/list_local_services_lead_conversations200_response_data_inner_phone_call.rb +159 -0
- data/lib/zernio-sdk/models/list_local_services_leads200_response.rb +167 -0
- data/lib/zernio-sdk/models/list_local_services_leads200_response_data_inner.rb +249 -0
- data/lib/zernio-sdk/models/list_local_services_leads200_response_data_inner_contact.rb +169 -0
- data/lib/zernio-sdk/models/list_phone_numbers200_response_connected_inner.rb +15 -5
- data/lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb +11 -1
- data/lib/zernio-sdk/models/list_sequence_enrollments200_response_enrollments_inner.rb +3 -0
- data/lib/zernio-sdk/models/list_whats_app_account_events200_response.rb +149 -0
- data/lib/zernio-sdk/models/list_whats_app_account_events200_response_events_inner.rb +228 -0
- data/lib/zernio-sdk/models/on_verification_approved_request.rb +1 -0
- data/lib/zernio-sdk/models/on_verification_failed_request.rb +1 -0
- data/lib/zernio-sdk/models/on_whats_app_automatic_event_request.rb +1 -0
- data/lib/zernio-sdk/models/on_whats_app_number_action_required_request.rb +1 -0
- data/lib/zernio-sdk/models/on_whats_app_number_activated_request.rb +1 -0
- data/lib/zernio-sdk/models/on_whats_app_number_declined_request.rb +1 -0
- data/lib/zernio-sdk/models/on_whats_app_number_kyc_submitted_request.rb +1 -0
- data/lib/zernio-sdk/models/on_whats_app_number_reactivated_request.rb +1 -0
- data/lib/zernio-sdk/models/on_whats_app_number_released_request.rb +1 -0
- data/lib/zernio-sdk/models/on_whats_app_number_suspended_request.rb +1 -0
- data/lib/zernio-sdk/models/on_whats_app_number_verification_required_request.rb +1 -0
- data/lib/zernio-sdk/models/platform_target.rb +5 -4
- data/lib/zernio-sdk/models/post_analytics.rb +2 -1
- data/lib/zernio-sdk/models/search_ad_targeting200_response_results_inner.rb +1 -1
- data/lib/zernio-sdk/models/send_inbox_message_request.rb +15 -3
- data/lib/zernio-sdk/models/social_account.rb +2 -2
- data/lib/zernio-sdk/models/submit_phone_number_kyc_request.rb +1 -1
- data/lib/zernio-sdk/models/submit_phone_number_kyc_request_address.rb +11 -1
- data/lib/zernio-sdk/models/submit_whats_app_number_kyc_request.rb +1 -1
- data/lib/zernio-sdk/models/twitter_platform_data.rb +11 -2
- data/lib/zernio-sdk/models/update_ad_campaign_status200_response.rb +50 -15
- data/lib/zernio-sdk/models/update_ad_set200_response.rb +26 -1
- data/lib/zernio-sdk/models/update_ad_set_request.rb +1 -1
- data/lib/zernio-sdk/models/update_ad_set_status200_response.rb +72 -4
- data/lib/zernio-sdk/models/update_blog_article_request.rb +257 -0
- data/lib/zernio-sdk/models/update_blog_request.rb +196 -0
- data/lib/zernio-sdk/models/update_bluesky_settings_request.rb +176 -0
- data/lib/zernio-sdk/models/validate_phone_number_kyc_address_request.rb +11 -1
- data/lib/zernio-sdk/models/webhook_payload_account_ads_initial_sync_completed.rb +1 -0
- data/lib/zernio-sdk/models/webhook_payload_account_connected.rb +1 -0
- data/lib/zernio-sdk/models/webhook_payload_account_disconnected.rb +1 -0
- data/lib/zernio-sdk/models/webhook_payload_ad_status_changed.rb +1 -1
- data/lib/zernio-sdk/models/webhook_payload_call_ended.rb +1 -0
- data/lib/zernio-sdk/models/webhook_payload_call_ended_call.rb +23 -1
- data/lib/zernio-sdk/models/webhook_payload_call_failed.rb +1 -0
- data/lib/zernio-sdk/models/webhook_payload_call_permission_request.rb +1 -0
- data/lib/zernio-sdk/models/webhook_payload_call_received.rb +1 -0
- data/lib/zernio-sdk/models/webhook_payload_comment.rb +1 -0
- data/lib/zernio-sdk/models/webhook_payload_comment_comment_author.rb +11 -1
- data/lib/zernio-sdk/models/webhook_payload_conversation_started.rb +1 -0
- data/lib/zernio-sdk/models/webhook_payload_external_post.rb +1 -0
- data/lib/zernio-sdk/models/webhook_payload_lead.rb +1 -0
- data/lib/zernio-sdk/models/webhook_payload_message.rb +1 -0
- data/lib/zernio-sdk/models/webhook_payload_message_deleted.rb +1 -0
- data/lib/zernio-sdk/models/webhook_payload_message_delivery_status.rb +2 -1
- data/lib/zernio-sdk/models/webhook_payload_message_edited.rb +1 -0
- data/lib/zernio-sdk/models/webhook_payload_message_message.rb +2 -2
- data/lib/zernio-sdk/models/webhook_payload_message_metadata.rb +23 -4
- data/lib/zernio-sdk/models/webhook_payload_message_metadata_referral.rb +15 -5
- data/lib/zernio-sdk/models/webhook_payload_message_metadata_unsupported.rb +169 -0
- data/lib/zernio-sdk/models/webhook_payload_message_sent.rb +1 -0
- data/lib/zernio-sdk/models/webhook_payload_post.rb +1 -0
- data/lib/zernio-sdk/models/webhook_payload_post_platform.rb +1 -0
- data/lib/zernio-sdk/models/webhook_payload_reaction.rb +1 -0
- data/lib/zernio-sdk/models/webhook_payload_reaction_reaction_sender.rb +1 -1
- data/lib/zernio-sdk/models/webhook_payload_referral.rb +347 -0
- data/lib/zernio-sdk/models/webhook_payload_referral_referral.rb +198 -0
- data/lib/zernio-sdk/models/webhook_payload_referral_referral_ads_context_data.rb +193 -0
- data/lib/zernio-sdk/models/webhook_payload_referral_sender.rb +176 -0
- data/lib/zernio-sdk/models/webhook_payload_review_new.rb +1 -0
- data/lib/zernio-sdk/models/webhook_payload_review_updated.rb +1 -0
- data/lib/zernio-sdk/models/webhook_payload_test.rb +1 -0
- data/lib/zernio-sdk/models/webhook_payload_whats_app_template_category_updated.rb +295 -0
- data/lib/zernio-sdk/models/webhook_payload_whats_app_template_category_updated_template.rb +353 -0
- data/lib/zernio-sdk/models/webhook_payload_whats_app_template_status_updated.rb +1 -1
- data/lib/zernio-sdk/models/workflow_node.rb +42 -4
- data/lib/zernio-sdk/models/x_article.rb +255 -0
- data/lib/zernio-sdk/models/x_article_block.rb +273 -0
- data/lib/zernio-sdk/models/x_article_block_data.rb +182 -0
- data/lib/zernio-sdk/models/x_article_content_state.rb +204 -0
- data/lib/zernio-sdk/models/x_article_cover.rb +204 -0
- data/lib/zernio-sdk/models/x_article_entity.rb +109 -0
- data/lib/zernio-sdk/models/x_article_entity_one_of.rb +199 -0
- data/lib/zernio-sdk/models/x_article_entity_one_of1.rb +199 -0
- data/lib/zernio-sdk/models/x_article_entity_one_of1_value.rb +242 -0
- data/lib/zernio-sdk/models/x_article_entity_one_of1_value_data.rb +164 -0
- data/lib/zernio-sdk/models/x_article_entity_one_of2.rb +199 -0
- data/lib/zernio-sdk/models/x_article_entity_one_of2_value.rb +242 -0
- data/lib/zernio-sdk/models/x_article_entity_one_of2_value_data.rb +214 -0
- data/lib/zernio-sdk/models/x_article_entity_one_of3.rb +199 -0
- data/lib/zernio-sdk/models/x_article_entity_one_of3_value.rb +242 -0
- data/lib/zernio-sdk/models/x_article_entity_one_of3_value_data.rb +173 -0
- data/lib/zernio-sdk/models/x_article_entity_one_of4.rb +199 -0
- data/lib/zernio-sdk/models/x_article_entity_one_of4_value.rb +242 -0
- data/lib/zernio-sdk/models/x_article_entity_one_of4_value_data.rb +164 -0
- data/lib/zernio-sdk/models/x_article_entity_one_of5.rb +199 -0
- data/lib/zernio-sdk/models/x_article_entity_one_of5_value.rb +242 -0
- data/lib/zernio-sdk/models/x_article_entity_one_of_value.rb +242 -0
- data/lib/zernio-sdk/models/x_article_entity_one_of_value_data.rb +173 -0
- data/lib/zernio-sdk/models/x_article_entity_range.rb +245 -0
- data/lib/zernio-sdk/models/x_article_inline_style_range.rb +259 -0
- data/lib/zernio-sdk/models/x_article_text_range.rb +237 -0
- data/lib/zernio-sdk/models/you_tube_video_retention_response.rb +1 -1
- data/lib/zernio-sdk/models/you_tube_video_retention_response_retention_curve_inner.rb +2 -2
- data/lib/zernio-sdk/version.rb +1 -1
- data/lib/zernio-sdk.rb +65 -0
- data/openapi.yaml +1956 -165
- data/spec/api/accounts_api_spec.rb +26 -1
- data/spec/api/ad_campaigns_api_spec.rb +9 -4
- data/spec/api/ad_insights_api_spec.rb +34 -0
- data/spec/api/ad_targeting_api_spec.rb +2 -2
- data/spec/api/blogs_api_spec.rb +174 -0
- data/spec/api/comments_api_spec.rb +5 -5
- data/spec/api/connect_api_spec.rb +27 -0
- data/spec/api/messages_api_spec.rb +2 -2
- data/spec/api/posts_api_spec.rb +1 -1
- data/spec/api/sms_api_spec.rb +1 -1
- data/spec/api/whats_app_api_spec.rb +13 -0
- data/spec/models/account_with_follower_stats_spec.rb +1 -1
- data/spec/models/ad_creative_spec.rb +6 -0
- data/spec/models/analytics_list_response_posts_inner_media_items_inner_spec.rb +58 -0
- data/spec/models/analytics_single_post_response_media_items_inner_spec.rb +20 -0
- data/spec/models/billing_snapshot_plan_spec.rb +6 -0
- data/spec/models/billing_snapshot_spec.rb +7 -1
- data/spec/models/blog_article_image_spec.rb +42 -0
- data/spec/models/blog_article_spec.rb +118 -0
- data/spec/models/blog_spec.rb +58 -0
- data/spec/models/bluesky_platform_data_spec.rb +6 -0
- data/spec/models/connect_shopify_with_token200_response_account_spec.rb +64 -0
- data/spec/models/connect_shopify_with_token200_response_spec.rb +36 -0
- data/spec/models/connect_shopify_with_token_request_spec.rb +48 -0
- data/spec/models/create_blog201_response_spec.rb +46 -0
- data/spec/models/create_blog_article201_response_spec.rb +46 -0
- data/spec/models/create_blog_article_request_image_spec.rb +42 -0
- data/spec/models/create_blog_article_request_seo_spec.rb +42 -0
- data/spec/models/create_blog_article_request_spec.rb +90 -0
- data/spec/models/create_blog_request_spec.rb +42 -0
- data/spec/models/create_inbox_conversation_request_spec.rb +6 -0
- data/spec/models/create_standalone_ad_request_spec.rb +16 -0
- data/spec/models/create_webhook_settings_request_spec.rb +1 -1
- data/spec/models/external_post_media_item_spec.rb +20 -0
- data/spec/models/external_post_summary_spec.rb +0 -6
- data/spec/models/get_account_health200_response_platform_connection_meta_error_spec.rb +48 -0
- data/spec/models/get_account_health200_response_platform_connection_spec.rb +58 -0
- data/spec/models/get_account_health200_response_spec.rb +6 -0
- data/spec/models/get_ad_analytics202_response_spec.rb +0 -4
- data/spec/models/get_ad_tree202_response_spec.rb +0 -4
- data/spec/models/get_ads_timeline202_response_spec.rb +0 -4
- data/spec/models/get_bluesky_settings200_response_spec.rb +36 -0
- data/spec/models/get_campaign_analytics202_response_spec.rb +0 -4
- data/spec/models/get_inbox_post_comments200_response_comments_inner_spec.rb +6 -0
- data/spec/models/get_phone_number_kyc_form200_response_spec.rb +6 -0
- data/spec/models/get_whats_app_number_kyc_form200_response_spec.rb +6 -0
- data/spec/models/inbox_webhook_message_spec.rb +1 -1
- data/spec/models/linked_in_platform_data_poll_spec.rb +52 -0
- data/spec/models/linked_in_platform_data_spec.rb +6 -0
- data/spec/models/list_ads202_response_spec.rb +0 -4
- data/spec/models/list_blog_articles200_response_spec.rb +52 -0
- data/spec/models/list_blogs200_response_spec.rb +52 -0
- data/spec/models/list_local_services_lead_conversations200_response_data_inner_message_spec.rb +42 -0
- data/spec/models/list_local_services_lead_conversations200_response_data_inner_phone_call_spec.rb +42 -0
- data/spec/models/list_local_services_lead_conversations200_response_data_inner_spec.rb +66 -0
- data/spec/models/list_local_services_lead_conversations200_response_spec.rb +48 -0
- data/spec/models/list_local_services_leads200_response_data_inner_contact_spec.rb +48 -0
- data/spec/models/list_local_services_leads200_response_data_inner_spec.rb +96 -0
- data/spec/models/list_local_services_leads200_response_spec.rb +48 -0
- data/spec/models/list_phone_numbers200_response_connected_inner_spec.rb +6 -0
- data/spec/models/list_phone_numbers200_response_numbers_inner_spec.rb +6 -0
- data/spec/models/list_whats_app_account_events200_response_events_inner_spec.rb +70 -0
- data/spec/models/list_whats_app_account_events200_response_spec.rb +36 -0
- data/spec/models/platform_target_spec.rb +1 -1
- data/spec/models/send_inbox_message_request_spec.rb +6 -0
- data/spec/models/social_account_spec.rb +1 -1
- data/spec/models/submit_phone_number_kyc_request_address_spec.rb +6 -0
- data/spec/models/twitter_platform_data_spec.rb +6 -0
- data/spec/models/update_ad_campaign_status200_response_spec.rb +8 -4
- data/spec/models/update_ad_set200_response_spec.rb +12 -0
- data/spec/models/update_ad_set_status200_response_spec.rb +22 -0
- data/spec/models/update_blog_article_request_spec.rb +90 -0
- data/spec/models/update_blog_request_spec.rb +42 -0
- data/spec/models/update_bluesky_settings_request_spec.rb +36 -0
- data/spec/models/update_webhook_settings_request_spec.rb +1 -1
- data/spec/models/validate_phone_number_kyc_address_request_spec.rb +6 -0
- data/spec/models/webhook_payload_call_ended_call_spec.rb +12 -0
- data/spec/models/webhook_payload_comment_comment_author_spec.rb +6 -0
- data/spec/models/webhook_payload_message_message_spec.rb +1 -1
- data/spec/models/webhook_payload_message_metadata_referral_spec.rb +6 -0
- data/spec/models/webhook_payload_message_metadata_spec.rb +12 -0
- data/spec/models/webhook_payload_message_metadata_unsupported_spec.rb +48 -0
- data/spec/models/webhook_payload_referral_referral_ads_context_data_spec.rb +66 -0
- data/spec/models/webhook_payload_referral_referral_spec.rb +66 -0
- data/spec/models/webhook_payload_referral_sender_spec.rb +42 -0
- data/spec/models/webhook_payload_referral_spec.rb +76 -0
- data/spec/models/webhook_payload_whats_app_template_category_updated_spec.rb +64 -0
- data/spec/models/webhook_payload_whats_app_template_category_updated_template_spec.rb +94 -0
- data/spec/models/webhook_spec.rb +1 -1
- data/spec/models/workflow_node_spec.rb +6 -0
- data/spec/models/x_article_block_data_spec.rb +54 -0
- data/spec/models/x_article_block_spec.rb +70 -0
- data/spec/models/x_article_content_state_spec.rb +42 -0
- data/spec/models/x_article_cover_spec.rb +42 -0
- data/spec/models/x_article_entity_one_of1_spec.rb +42 -0
- data/spec/models/x_article_entity_one_of1_value_data_spec.rb +36 -0
- data/spec/models/x_article_entity_one_of1_value_spec.rb +56 -0
- data/spec/models/x_article_entity_one_of2_spec.rb +42 -0
- data/spec/models/x_article_entity_one_of2_value_data_spec.rb +48 -0
- data/spec/models/x_article_entity_one_of2_value_spec.rb +56 -0
- data/spec/models/x_article_entity_one_of3_spec.rb +42 -0
- data/spec/models/x_article_entity_one_of3_value_data_spec.rb +36 -0
- data/spec/models/x_article_entity_one_of3_value_spec.rb +56 -0
- data/spec/models/x_article_entity_one_of4_spec.rb +42 -0
- data/spec/models/x_article_entity_one_of4_value_data_spec.rb +36 -0
- data/spec/models/x_article_entity_one_of4_value_spec.rb +56 -0
- data/spec/models/x_article_entity_one_of5_spec.rb +42 -0
- data/spec/models/x_article_entity_one_of5_value_spec.rb +56 -0
- data/spec/models/x_article_entity_one_of_spec.rb +42 -0
- data/spec/models/x_article_entity_one_of_value_data_spec.rb +36 -0
- data/spec/models/x_article_entity_one_of_value_spec.rb +56 -0
- data/spec/models/x_article_entity_range_spec.rb +48 -0
- data/spec/models/x_article_entity_spec.rb +32 -0
- data/spec/models/x_article_inline_style_range_spec.rb +52 -0
- data/spec/models/x_article_spec.rb +58 -0
- data/spec/models/x_article_text_range_spec.rb +48 -0
- data/zernio-sdk-0.0.718.gem +0 -0
- metadata +1867 -1607
- data/zernio-sdk-0.0.716.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: cd22055bc590e01ff23ae8698497bc3222c759e231d33de786e684ca11c5e775
|
|
4
|
+
data.tar.gz: 4707bfe07c0cb3408f98852251a0602f43cf71b65bcb6b19280bd899424e0337
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 4367a665e3a13b3d977b234e0e99d4de66ee352a77a2bf02095132016f3ce777fb618abd1584bd4bec7b2f35d3bf6865e213f63d6964cac01d54c41a44a94deb
|
|
7
|
+
data.tar.gz: a78175473e3c2880b9cdf6bc5edc9b1590f19022fab3dca90422d92e57055c224edc503cbc3f7b263c780c186a4cde74cf10c5a3ce845f1d1848d299eabadda9
|
data/README.md
CHANGED
|
@@ -86,6 +86,7 @@ Class | Method | HTTP request | Description
|
|
|
86
86
|
*Zernio::AccountsApi* | [**delete_account**](docs/AccountsApi.md#delete_account) | **DELETE** /v1/accounts/{accountId} | Disconnect account
|
|
87
87
|
*Zernio::AccountsApi* | [**get_account_health**](docs/AccountsApi.md#get_account_health) | **GET** /v1/accounts/{accountId}/health | Check account health
|
|
88
88
|
*Zernio::AccountsApi* | [**get_all_accounts_health**](docs/AccountsApi.md#get_all_accounts_health) | **GET** /v1/accounts/health | Check accounts health
|
|
89
|
+
*Zernio::AccountsApi* | [**get_bluesky_settings**](docs/AccountsApi.md#get_bluesky_settings) | **GET** /v1/accounts/{accountId}/bluesky-settings | Get Bluesky account settings
|
|
89
90
|
*Zernio::AccountsApi* | [**get_follower_stats**](docs/AccountsApi.md#get_follower_stats) | **GET** /v1/accounts/follower-stats | Get follower stats
|
|
90
91
|
*Zernio::AccountsApi* | [**get_instagram_follow_status**](docs/AccountsApi.md#get_instagram_follow_status) | **GET** /v1/accounts/{accountId}/follow-status/{userId} | Check whether an Instagram user follows the account
|
|
91
92
|
*Zernio::AccountsApi* | [**get_slack_settings**](docs/AccountsApi.md#get_slack_settings) | **GET** /v1/accounts/{accountId}/slack-settings | Get Slack account settings
|
|
@@ -93,6 +94,7 @@ Class | Method | HTTP request | Description
|
|
|
93
94
|
*Zernio::AccountsApi* | [**list_accounts**](docs/AccountsApi.md#list_accounts) | **GET** /v1/accounts | List accounts
|
|
94
95
|
*Zernio::AccountsApi* | [**move_account_to_profile**](docs/AccountsApi.md#move_account_to_profile) | **PATCH** /v1/accounts/{accountId} | Move account to another profile
|
|
95
96
|
*Zernio::AccountsApi* | [**update_account**](docs/AccountsApi.md#update_account) | **PUT** /v1/accounts/{accountId} | Update account
|
|
97
|
+
*Zernio::AccountsApi* | [**update_bluesky_settings**](docs/AccountsApi.md#update_bluesky_settings) | **PATCH** /v1/accounts/{accountId}/bluesky-settings | Update Bluesky account settings
|
|
96
98
|
*Zernio::AccountsApi* | [**update_slack_settings**](docs/AccountsApi.md#update_slack_settings) | **PATCH** /v1/accounts/{accountId}/slack-settings | Update Slack account settings
|
|
97
99
|
*Zernio::AdAccountsApi* | [**create_custom_conversion**](docs/AdAccountsApi.md#create_custom_conversion) | **POST** /v1/accounts/{accountId}/custom-conversions | Create or reuse a custom conversion
|
|
98
100
|
*Zernio::AdAccountsApi* | [**create_high_demand_period**](docs/AdAccountsApi.md#create_high_demand_period) | **POST** /v1/ads/high-demand-periods | Schedule a budget increase
|
|
@@ -160,6 +162,8 @@ Class | Method | HTTP request | Description
|
|
|
160
162
|
*Zernio::AdInsightsApi* | [**get_ad_insights_report**](docs/AdInsightsApi.md#get_ad_insights_report) | **GET** /v1/ads/insights/reports/{reportRunId} | Poll an async insights report run
|
|
161
163
|
*Zernio::AdInsightsApi* | [**get_ads_search_terms**](docs/AdInsightsApi.md#get_ads_search_terms) | **GET** /v1/ads/search-terms | Google Ads search terms report
|
|
162
164
|
*Zernio::AdInsightsApi* | [**get_campaign_analytics**](docs/AdInsightsApi.md#get_campaign_analytics) | **GET** /v1/ads/campaigns/{campaignId}/analytics | Get campaign analytics
|
|
165
|
+
*Zernio::AdInsightsApi* | [**list_local_services_lead_conversations**](docs/AdInsightsApi.md#list_local_services_lead_conversations) | **GET** /v1/ads/local-services/leads/{leadId}/conversations | Conversations of a Local Services lead
|
|
166
|
+
*Zernio::AdInsightsApi* | [**list_local_services_leads**](docs/AdInsightsApi.md#list_local_services_leads) | **GET** /v1/ads/local-services/leads | Google Local Services Ads leads
|
|
163
167
|
*Zernio::AdInsightsApi* | [**query_ad_insights**](docs/AdInsightsApi.md#query_ad_insights) | **GET** /v1/ads/insights | Flexible live insights query
|
|
164
168
|
*Zernio::AdTargetingApi* | [**estimate_ad_reach**](docs/AdTargetingApi.md#estimate_ad_reach) | **POST** /v1/ads/targeting/reach-estimate | Estimate audience reach
|
|
165
169
|
*Zernio::AdTargetingApi* | [**get_linked_in_bid_pricing**](docs/AdTargetingApi.md#get_linked_in_bid_pricing) | **POST** /v1/ads/targeting/bid-pricing | Suggested bid and budget bounds
|
|
@@ -191,6 +195,16 @@ Class | Method | HTTP request | Description
|
|
|
191
195
|
*Zernio::AnalyticsApi* | [**get_you_tube_demographics**](docs/AnalyticsApi.md#get_you_tube_demographics) | **GET** /v1/analytics/youtube/demographics | Get YouTube demographics
|
|
192
196
|
*Zernio::AnalyticsApi* | [**get_you_tube_video_retention**](docs/AnalyticsApi.md#get_you_tube_video_retention) | **GET** /v1/analytics/youtube/video-retention | Get YouTube video retention curve
|
|
193
197
|
*Zernio::AnalyticsApi* | [**sync_external_posts**](docs/AnalyticsApi.md#sync_external_posts) | **POST** /v1/posts/sync-external | Sync an external post
|
|
198
|
+
*Zernio::BlogsApi* | [**create_blog**](docs/BlogsApi.md#create_blog) | **POST** /v1/accounts/{accountId}/blogs | Create a blog
|
|
199
|
+
*Zernio::BlogsApi* | [**create_blog_article**](docs/BlogsApi.md#create_blog_article) | **POST** /v1/accounts/{accountId}/blogs/{blogId}/articles | Create a blog article
|
|
200
|
+
*Zernio::BlogsApi* | [**delete_blog**](docs/BlogsApi.md#delete_blog) | **DELETE** /v1/accounts/{accountId}/blogs/{blogId} | Delete a blog
|
|
201
|
+
*Zernio::BlogsApi* | [**delete_blog_article**](docs/BlogsApi.md#delete_blog_article) | **DELETE** /v1/accounts/{accountId}/blogs/{blogId}/articles/{articleId} | Delete a blog article
|
|
202
|
+
*Zernio::BlogsApi* | [**get_blog**](docs/BlogsApi.md#get_blog) | **GET** /v1/accounts/{accountId}/blogs/{blogId} | Get a blog
|
|
203
|
+
*Zernio::BlogsApi* | [**get_blog_article**](docs/BlogsApi.md#get_blog_article) | **GET** /v1/accounts/{accountId}/blogs/{blogId}/articles/{articleId} | Get a blog article
|
|
204
|
+
*Zernio::BlogsApi* | [**list_blog_articles**](docs/BlogsApi.md#list_blog_articles) | **GET** /v1/accounts/{accountId}/blogs/{blogId}/articles | List blog articles
|
|
205
|
+
*Zernio::BlogsApi* | [**list_blogs**](docs/BlogsApi.md#list_blogs) | **GET** /v1/accounts/{accountId}/blogs | List blogs
|
|
206
|
+
*Zernio::BlogsApi* | [**update_blog**](docs/BlogsApi.md#update_blog) | **PATCH** /v1/accounts/{accountId}/blogs/{blogId} | Update a blog
|
|
207
|
+
*Zernio::BlogsApi* | [**update_blog_article**](docs/BlogsApi.md#update_blog_article) | **PATCH** /v1/accounts/{accountId}/blogs/{blogId}/articles/{articleId} | Update a blog article
|
|
194
208
|
*Zernio::BroadcastsApi* | [**add_broadcast_recipients**](docs/BroadcastsApi.md#add_broadcast_recipients) | **POST** /v1/broadcasts/{broadcastId}/recipients | Add recipients to a broadcast
|
|
195
209
|
*Zernio::BroadcastsApi* | [**cancel_broadcast**](docs/BroadcastsApi.md#cancel_broadcast) | **POST** /v1/broadcasts/{broadcastId}/cancel | Cancel broadcast
|
|
196
210
|
*Zernio::BroadcastsApi* | [**create_broadcast**](docs/BroadcastsApi.md#create_broadcast) | **POST** /v1/broadcasts | Create broadcast draft
|
|
@@ -230,6 +244,7 @@ Class | Method | HTTP request | Description
|
|
|
230
244
|
*Zernio::ConnectApi* | [**connect_ads**](docs/ConnectApi.md#connect_ads) | **GET** /v1/connect/{platform}/ads | Connect ads for a platform
|
|
231
245
|
*Zernio::ConnectApi* | [**connect_bluesky_credentials**](docs/ConnectApi.md#connect_bluesky_credentials) | **POST** /v1/connect/bluesky/credentials | Connect Bluesky account
|
|
232
246
|
*Zernio::ConnectApi* | [**connect_open_ai_ads_credentials**](docs/ConnectApi.md#connect_open_ai_ads_credentials) | **POST** /v1/connect/openai-ads/credentials | Connect an OpenAI Ads account
|
|
247
|
+
*Zernio::ConnectApi* | [**connect_shopify_with_token**](docs/ConnectApi.md#connect_shopify_with_token) | **POST** /v1/connect/shopify/token | Connect a Shopify store with a custom-app Admin token
|
|
233
248
|
*Zernio::ConnectApi* | [**connect_whats_app_credentials**](docs/ConnectApi.md#connect_whats_app_credentials) | **POST** /v1/connect/whatsapp/credentials | Connect WhatsApp via credentials
|
|
234
249
|
*Zernio::ConnectApi* | [**create_pinterest_board**](docs/ConnectApi.md#create_pinterest_board) | **POST** /v1/accounts/{accountId}/pinterest-boards | Create Pinterest board
|
|
235
250
|
*Zernio::ConnectApi* | [**get_connect_url**](docs/ConnectApi.md#get_connect_url) | **GET** /v1/connect/{platform} | Get OAuth connect URL
|
|
@@ -240,6 +255,7 @@ Class | Method | HTTP request | Description
|
|
|
240
255
|
*Zernio::ConnectApi* | [**get_pinterest_boards**](docs/ConnectApi.md#get_pinterest_boards) | **GET** /v1/accounts/{accountId}/pinterest-boards | List Pinterest boards
|
|
241
256
|
*Zernio::ConnectApi* | [**get_reddit_flairs**](docs/ConnectApi.md#get_reddit_flairs) | **GET** /v1/accounts/{accountId}/reddit-flairs | List subreddit flairs
|
|
242
257
|
*Zernio::ConnectApi* | [**get_reddit_subreddits**](docs/ConnectApi.md#get_reddit_subreddits) | **GET** /v1/accounts/{accountId}/reddit-subreddits | List Reddit subreddits
|
|
258
|
+
*Zernio::ConnectApi* | [**get_shopify_connect_url**](docs/ConnectApi.md#get_shopify_connect_url) | **GET** /v1/connect/shopify | Get Shopify OAuth connect URL
|
|
243
259
|
*Zernio::ConnectApi* | [**get_subreddit_rules**](docs/ConnectApi.md#get_subreddit_rules) | **GET** /v1/accounts/{accountId}/reddit-subreddits/{subreddit}/rules | Get subreddit rules
|
|
244
260
|
*Zernio::ConnectApi* | [**get_telegram_connect_status**](docs/ConnectApi.md#get_telegram_connect_status) | **GET** /v1/connect/telegram | Generate Telegram code
|
|
245
261
|
*Zernio::ConnectApi* | [**get_youtube_playlists**](docs/ConnectApi.md#get_youtube_playlists) | **GET** /v1/accounts/{accountId}/youtube-playlists | List YouTube playlists
|
|
@@ -543,6 +559,7 @@ Class | Method | HTTP request | Description
|
|
|
543
559
|
*Zernio::WhatsAppApi* | [**get_whats_app_templates**](docs/WhatsAppApi.md#get_whats_app_templates) | **GET** /v1/whatsapp/templates | List templates
|
|
544
560
|
*Zernio::WhatsAppApi* | [**get_whatsapp_business_username**](docs/WhatsAppApi.md#get_whatsapp_business_username) | **GET** /v1/whatsapp/business-profile/username | Get business username
|
|
545
561
|
*Zernio::WhatsAppApi* | [**get_whatsapp_business_username_suggestions**](docs/WhatsAppApi.md#get_whatsapp_business_username_suggestions) | **GET** /v1/whatsapp/business-profile/username/suggestions | Get username suggestions
|
|
562
|
+
*Zernio::WhatsAppApi* | [**list_whats_app_account_events**](docs/WhatsAppApi.md#list_whats_app_account_events) | **GET** /v1/whatsapp/account-events | List account notifications
|
|
546
563
|
*Zernio::WhatsAppApi* | [**list_whats_app_conversions**](docs/WhatsAppApi.md#list_whats_app_conversions) | **GET** /v1/whatsapp/conversions | List conversion events
|
|
547
564
|
*Zernio::WhatsAppApi* | [**list_whats_app_group_chats**](docs/WhatsAppApi.md#list_whats_app_group_chats) | **GET** /v1/whatsapp/wa-groups | List active groups
|
|
548
565
|
*Zernio::WhatsAppApi* | [**list_whats_app_group_join_requests**](docs/WhatsAppApi.md#list_whats_app_group_join_requests) | **GET** /v1/whatsapp/wa-groups/{groupId}/join-requests | List join requests
|
|
@@ -678,6 +695,7 @@ Class | Method | HTTP request | Description
|
|
|
678
695
|
- [Zernio::AdsTimelineResponseRowsInner](docs/AdsTimelineResponseRowsInner.md)
|
|
679
696
|
- [Zernio::AnalyticsListResponse](docs/AnalyticsListResponse.md)
|
|
680
697
|
- [Zernio::AnalyticsListResponsePostsInner](docs/AnalyticsListResponsePostsInner.md)
|
|
698
|
+
- [Zernio::AnalyticsListResponsePostsInnerMediaItemsInner](docs/AnalyticsListResponsePostsInnerMediaItemsInner.md)
|
|
681
699
|
- [Zernio::AnalyticsOverview](docs/AnalyticsOverview.md)
|
|
682
700
|
- [Zernio::AnalyticsOverviewDataStaleness](docs/AnalyticsOverviewDataStaleness.md)
|
|
683
701
|
- [Zernio::AnalyticsSinglePostResponse](docs/AnalyticsSinglePostResponse.md)
|
|
@@ -707,6 +725,9 @@ Class | Method | HTTP request | Description
|
|
|
707
725
|
- [Zernio::BlockWhatsAppUsers200ResponseBlockedInner](docs/BlockWhatsAppUsers200ResponseBlockedInner.md)
|
|
708
726
|
- [Zernio::BlockWhatsAppUsers200ResponseFailedInner](docs/BlockWhatsAppUsers200ResponseFailedInner.md)
|
|
709
727
|
- [Zernio::BlockWhatsAppUsersRequest](docs/BlockWhatsAppUsersRequest.md)
|
|
728
|
+
- [Zernio::Blog](docs/Blog.md)
|
|
729
|
+
- [Zernio::BlogArticle](docs/BlogArticle.md)
|
|
730
|
+
- [Zernio::BlogArticleImage](docs/BlogArticleImage.md)
|
|
710
731
|
- [Zernio::BlueskyPlatformData](docs/BlueskyPlatformData.md)
|
|
711
732
|
- [Zernio::BookmarkPost200Response](docs/BookmarkPost200Response.md)
|
|
712
733
|
- [Zernio::BookmarkPostRequest](docs/BookmarkPostRequest.md)
|
|
@@ -768,6 +789,9 @@ Class | Method | HTTP request | Description
|
|
|
768
789
|
- [Zernio::ConnectBlueskyCredentialsRequest](docs/ConnectBlueskyCredentialsRequest.md)
|
|
769
790
|
- [Zernio::ConnectOpenAIAdsCredentials200Response](docs/ConnectOpenAIAdsCredentials200Response.md)
|
|
770
791
|
- [Zernio::ConnectOpenAIAdsCredentialsRequest](docs/ConnectOpenAIAdsCredentialsRequest.md)
|
|
792
|
+
- [Zernio::ConnectShopifyWithToken200Response](docs/ConnectShopifyWithToken200Response.md)
|
|
793
|
+
- [Zernio::ConnectShopifyWithToken200ResponseAccount](docs/ConnectShopifyWithToken200ResponseAccount.md)
|
|
794
|
+
- [Zernio::ConnectShopifyWithTokenRequest](docs/ConnectShopifyWithTokenRequest.md)
|
|
771
795
|
- [Zernio::ConnectWhatsAppCredentials200Response](docs/ConnectWhatsAppCredentials200Response.md)
|
|
772
796
|
- [Zernio::ConnectWhatsAppCredentials200ResponseAccount](docs/ConnectWhatsAppCredentials200ResponseAccount.md)
|
|
773
797
|
- [Zernio::ConnectWhatsAppCredentialsRequest](docs/ConnectWhatsAppCredentialsRequest.md)
|
|
@@ -795,6 +819,12 @@ Class | Method | HTTP request | Description
|
|
|
795
819
|
- [Zernio::CreateAdInsightsReportRequestTimeIncrement](docs/CreateAdInsightsReportRequestTimeIncrement.md)
|
|
796
820
|
- [Zernio::CreateApiKey201Response](docs/CreateApiKey201Response.md)
|
|
797
821
|
- [Zernio::CreateApiKeyRequest](docs/CreateApiKeyRequest.md)
|
|
822
|
+
- [Zernio::CreateBlog201Response](docs/CreateBlog201Response.md)
|
|
823
|
+
- [Zernio::CreateBlogArticle201Response](docs/CreateBlogArticle201Response.md)
|
|
824
|
+
- [Zernio::CreateBlogArticleRequest](docs/CreateBlogArticleRequest.md)
|
|
825
|
+
- [Zernio::CreateBlogArticleRequestImage](docs/CreateBlogArticleRequestImage.md)
|
|
826
|
+
- [Zernio::CreateBlogArticleRequestSeo](docs/CreateBlogArticleRequestSeo.md)
|
|
827
|
+
- [Zernio::CreateBlogRequest](docs/CreateBlogRequest.md)
|
|
798
828
|
- [Zernio::CreateBroadcast200Response](docs/CreateBroadcast200Response.md)
|
|
799
829
|
- [Zernio::CreateBroadcast200ResponseBroadcast](docs/CreateBroadcast200ResponseBroadcast.md)
|
|
800
830
|
- [Zernio::CreateBroadcastRequest](docs/CreateBroadcastRequest.md)
|
|
@@ -1061,6 +1091,8 @@ Class | Method | HTTP request | Description
|
|
|
1061
1091
|
- [Zernio::GetAccountHealth200Response](docs/GetAccountHealth200Response.md)
|
|
1062
1092
|
- [Zernio::GetAccountHealth200ResponsePermissions](docs/GetAccountHealth200ResponsePermissions.md)
|
|
1063
1093
|
- [Zernio::GetAccountHealth200ResponsePermissionsPostingInner](docs/GetAccountHealth200ResponsePermissionsPostingInner.md)
|
|
1094
|
+
- [Zernio::GetAccountHealth200ResponsePlatformConnection](docs/GetAccountHealth200ResponsePlatformConnection.md)
|
|
1095
|
+
- [Zernio::GetAccountHealth200ResponsePlatformConnectionMetaError](docs/GetAccountHealth200ResponsePlatformConnectionMetaError.md)
|
|
1064
1096
|
- [Zernio::GetAccountHealth200ResponseTokenStatus](docs/GetAccountHealth200ResponseTokenStatus.md)
|
|
1065
1097
|
- [Zernio::GetAd200Response](docs/GetAd200Response.md)
|
|
1066
1098
|
- [Zernio::GetAdAccountFinance200Response](docs/GetAdAccountFinance200Response.md)
|
|
@@ -1092,6 +1124,7 @@ Class | Method | HTTP request | Description
|
|
|
1092
1124
|
- [Zernio::GetBestTimeToPost200Response](docs/GetBestTimeToPost200Response.md)
|
|
1093
1125
|
- [Zernio::GetBestTimeToPost200ResponseSlotsInner](docs/GetBestTimeToPost200ResponseSlotsInner.md)
|
|
1094
1126
|
- [Zernio::GetBestTimeToPost403Response](docs/GetBestTimeToPost403Response.md)
|
|
1127
|
+
- [Zernio::GetBlueskySettings200Response](docs/GetBlueskySettings200Response.md)
|
|
1095
1128
|
- [Zernio::GetBroadcast200Response](docs/GetBroadcast200Response.md)
|
|
1096
1129
|
- [Zernio::GetBroadcast200ResponseBroadcast](docs/GetBroadcast200ResponseBroadcast.md)
|
|
1097
1130
|
- [Zernio::GetBroadcast200ResponseBroadcastMessage](docs/GetBroadcast200ResponseBroadcastMessage.md)
|
|
@@ -1448,6 +1481,7 @@ Class | Method | HTTP request | Description
|
|
|
1448
1481
|
- [Zernio::LinkedInLeadFormPlatformDataQuestionsInnerOneOf1](docs/LinkedInLeadFormPlatformDataQuestionsInnerOneOf1.md)
|
|
1449
1482
|
- [Zernio::LinkedInLeadFormPlatformDataQuestionsInnerOneOf1ChoicesInner](docs/LinkedInLeadFormPlatformDataQuestionsInnerOneOf1ChoicesInner.md)
|
|
1450
1483
|
- [Zernio::LinkedInPlatformData](docs/LinkedInPlatformData.md)
|
|
1484
|
+
- [Zernio::LinkedInPlatformDataPoll](docs/LinkedInPlatformDataPoll.md)
|
|
1451
1485
|
- [Zernio::ListAccountGroups200Response](docs/ListAccountGroups200Response.md)
|
|
1452
1486
|
- [Zernio::ListAccountGroups200ResponseGroupsInner](docs/ListAccountGroups200ResponseGroupsInner.md)
|
|
1453
1487
|
- [Zernio::ListAdAccounts200Response](docs/ListAdAccounts200Response.md)
|
|
@@ -1468,6 +1502,8 @@ Class | Method | HTTP request | Description
|
|
|
1468
1502
|
- [Zernio::ListAds202Response](docs/ListAds202Response.md)
|
|
1469
1503
|
- [Zernio::ListAdsBusinessCenters200Response](docs/ListAdsBusinessCenters200Response.md)
|
|
1470
1504
|
- [Zernio::ListApiKeys200Response](docs/ListApiKeys200Response.md)
|
|
1505
|
+
- [Zernio::ListBlogArticles200Response](docs/ListBlogArticles200Response.md)
|
|
1506
|
+
- [Zernio::ListBlogs200Response](docs/ListBlogs200Response.md)
|
|
1471
1507
|
- [Zernio::ListBroadcastRecipients200Response](docs/ListBroadcastRecipients200Response.md)
|
|
1472
1508
|
- [Zernio::ListBroadcastRecipients200ResponseRecipientsInner](docs/ListBroadcastRecipients200ResponseRecipientsInner.md)
|
|
1473
1509
|
- [Zernio::ListBroadcasts200Response](docs/ListBroadcasts200Response.md)
|
|
@@ -1541,6 +1577,13 @@ Class | Method | HTTP request | Description
|
|
|
1541
1577
|
- [Zernio::ListLeads200ResponseLeadsInner](docs/ListLeads200ResponseLeadsInner.md)
|
|
1542
1578
|
- [Zernio::ListLinkedInOrganizations200Response](docs/ListLinkedInOrganizations200Response.md)
|
|
1543
1579
|
- [Zernio::ListLinkedInOrganizations200ResponseOrganizationsInner](docs/ListLinkedInOrganizations200ResponseOrganizationsInner.md)
|
|
1580
|
+
- [Zernio::ListLocalServicesLeadConversations200Response](docs/ListLocalServicesLeadConversations200Response.md)
|
|
1581
|
+
- [Zernio::ListLocalServicesLeadConversations200ResponseDataInner](docs/ListLocalServicesLeadConversations200ResponseDataInner.md)
|
|
1582
|
+
- [Zernio::ListLocalServicesLeadConversations200ResponseDataInnerMessage](docs/ListLocalServicesLeadConversations200ResponseDataInnerMessage.md)
|
|
1583
|
+
- [Zernio::ListLocalServicesLeadConversations200ResponseDataInnerPhoneCall](docs/ListLocalServicesLeadConversations200ResponseDataInnerPhoneCall.md)
|
|
1584
|
+
- [Zernio::ListLocalServicesLeads200Response](docs/ListLocalServicesLeads200Response.md)
|
|
1585
|
+
- [Zernio::ListLocalServicesLeads200ResponseDataInner](docs/ListLocalServicesLeads200ResponseDataInner.md)
|
|
1586
|
+
- [Zernio::ListLocalServicesLeads200ResponseDataInnerContact](docs/ListLocalServicesLeads200ResponseDataInnerContact.md)
|
|
1544
1587
|
- [Zernio::ListLogs200Response](docs/ListLogs200Response.md)
|
|
1545
1588
|
- [Zernio::ListLogs200ResponseLogsInner](docs/ListLogs200ResponseLogsInner.md)
|
|
1546
1589
|
- [Zernio::ListLogs200ResponsePagination](docs/ListLogs200ResponsePagination.md)
|
|
@@ -1583,6 +1626,8 @@ Class | Method | HTTP request | Description
|
|
|
1583
1626
|
- [Zernio::ListValueRuleSets200Response](docs/ListValueRuleSets200Response.md)
|
|
1584
1627
|
- [Zernio::ListValueRuleSets200ResponsePaging](docs/ListValueRuleSets200ResponsePaging.md)
|
|
1585
1628
|
- [Zernio::ListVoiceCalls200Response](docs/ListVoiceCalls200Response.md)
|
|
1629
|
+
- [Zernio::ListWhatsAppAccountEvents200Response](docs/ListWhatsAppAccountEvents200Response.md)
|
|
1630
|
+
- [Zernio::ListWhatsAppAccountEvents200ResponseEventsInner](docs/ListWhatsAppAccountEvents200ResponseEventsInner.md)
|
|
1586
1631
|
- [Zernio::ListWhatsAppCalls200Response](docs/ListWhatsAppCalls200Response.md)
|
|
1587
1632
|
- [Zernio::ListWhatsAppCalls200ResponseCallsInner](docs/ListWhatsAppCalls200ResponseCallsInner.md)
|
|
1588
1633
|
- [Zernio::ListWhatsAppCalls200ResponseCallsInnerBilling](docs/ListWhatsAppCalls200ResponseCallsInnerBilling.md)
|
|
@@ -1974,6 +2019,9 @@ Class | Method | HTTP request | Description
|
|
|
1974
2019
|
- [Zernio::UpdateAdTrackingTagsRequest](docs/UpdateAdTrackingTagsRequest.md)
|
|
1975
2020
|
- [Zernio::UpdateAdTrackingTagsRequestCreative](docs/UpdateAdTrackingTagsRequestCreative.md)
|
|
1976
2021
|
- [Zernio::UpdateAdTrackingTagsRequestUrlTagsInner](docs/UpdateAdTrackingTagsRequestUrlTagsInner.md)
|
|
2022
|
+
- [Zernio::UpdateBlogArticleRequest](docs/UpdateBlogArticleRequest.md)
|
|
2023
|
+
- [Zernio::UpdateBlogRequest](docs/UpdateBlogRequest.md)
|
|
2024
|
+
- [Zernio::UpdateBlueskySettingsRequest](docs/UpdateBlueskySettingsRequest.md)
|
|
1977
2025
|
- [Zernio::UpdateBroadcast200Response](docs/UpdateBroadcast200Response.md)
|
|
1978
2026
|
- [Zernio::UpdateBroadcast200ResponseBroadcast](docs/UpdateBroadcast200ResponseBroadcast.md)
|
|
1979
2027
|
- [Zernio::UpdateBroadcastRequest](docs/UpdateBroadcastRequest.md)
|
|
@@ -2185,6 +2233,7 @@ Class | Method | HTTP request | Description
|
|
|
2185
2233
|
- [Zernio::WebhookPayloadMessageMetadataReferralAdsContextData](docs/WebhookPayloadMessageMetadataReferralAdsContextData.md)
|
|
2186
2234
|
- [Zernio::WebhookPayloadMessageMetadataReferredProduct](docs/WebhookPayloadMessageMetadataReferredProduct.md)
|
|
2187
2235
|
- [Zernio::WebhookPayloadMessageMetadataStoryReply](docs/WebhookPayloadMessageMetadataStoryReply.md)
|
|
2236
|
+
- [Zernio::WebhookPayloadMessageMetadataUnsupported](docs/WebhookPayloadMessageMetadataUnsupported.md)
|
|
2188
2237
|
- [Zernio::WebhookPayloadMessageSent](docs/WebhookPayloadMessageSent.md)
|
|
2189
2238
|
- [Zernio::WebhookPayloadMessageSentMessage](docs/WebhookPayloadMessageSentMessage.md)
|
|
2190
2239
|
- [Zernio::WebhookPayloadMessageSentMessageAttachmentsInner](docs/WebhookPayloadMessageSentMessageAttachmentsInner.md)
|
|
@@ -2200,10 +2249,16 @@ Class | Method | HTTP request | Description
|
|
|
2200
2249
|
- [Zernio::WebhookPayloadReaction](docs/WebhookPayloadReaction.md)
|
|
2201
2250
|
- [Zernio::WebhookPayloadReactionReaction](docs/WebhookPayloadReactionReaction.md)
|
|
2202
2251
|
- [Zernio::WebhookPayloadReactionReactionSender](docs/WebhookPayloadReactionReactionSender.md)
|
|
2252
|
+
- [Zernio::WebhookPayloadReferral](docs/WebhookPayloadReferral.md)
|
|
2253
|
+
- [Zernio::WebhookPayloadReferralReferral](docs/WebhookPayloadReferralReferral.md)
|
|
2254
|
+
- [Zernio::WebhookPayloadReferralReferralAdsContextData](docs/WebhookPayloadReferralReferralAdsContextData.md)
|
|
2255
|
+
- [Zernio::WebhookPayloadReferralSender](docs/WebhookPayloadReferralSender.md)
|
|
2203
2256
|
- [Zernio::WebhookPayloadReviewNew](docs/WebhookPayloadReviewNew.md)
|
|
2204
2257
|
- [Zernio::WebhookPayloadReviewNewAccount](docs/WebhookPayloadReviewNewAccount.md)
|
|
2205
2258
|
- [Zernio::WebhookPayloadReviewUpdated](docs/WebhookPayloadReviewUpdated.md)
|
|
2206
2259
|
- [Zernio::WebhookPayloadTest](docs/WebhookPayloadTest.md)
|
|
2260
|
+
- [Zernio::WebhookPayloadWhatsAppTemplateCategoryUpdated](docs/WebhookPayloadWhatsAppTemplateCategoryUpdated.md)
|
|
2261
|
+
- [Zernio::WebhookPayloadWhatsAppTemplateCategoryUpdatedTemplate](docs/WebhookPayloadWhatsAppTemplateCategoryUpdatedTemplate.md)
|
|
2207
2262
|
- [Zernio::WebhookPayloadWhatsAppTemplateStatusUpdated](docs/WebhookPayloadWhatsAppTemplateStatusUpdated.md)
|
|
2208
2263
|
- [Zernio::WebhookPayloadWhatsAppTemplateStatusUpdatedAccount](docs/WebhookPayloadWhatsAppTemplateStatusUpdatedAccount.md)
|
|
2209
2264
|
- [Zernio::WebhookPayloadWhatsAppTemplateStatusUpdatedTemplate](docs/WebhookPayloadWhatsAppTemplateStatusUpdatedTemplate.md)
|
|
@@ -2230,6 +2285,32 @@ Class | Method | HTTP request | Description
|
|
|
2230
2285
|
- [Zernio::XApiOperationTriggeredByInner](docs/XApiOperationTriggeredByInner.md)
|
|
2231
2286
|
- [Zernio::XApiPricing](docs/XApiPricing.md)
|
|
2232
2287
|
- [Zernio::XApiPricingTiersInner](docs/XApiPricingTiersInner.md)
|
|
2288
|
+
- [Zernio::XArticle](docs/XArticle.md)
|
|
2289
|
+
- [Zernio::XArticleBlock](docs/XArticleBlock.md)
|
|
2290
|
+
- [Zernio::XArticleBlockData](docs/XArticleBlockData.md)
|
|
2291
|
+
- [Zernio::XArticleContentState](docs/XArticleContentState.md)
|
|
2292
|
+
- [Zernio::XArticleCover](docs/XArticleCover.md)
|
|
2293
|
+
- [Zernio::XArticleEntity](docs/XArticleEntity.md)
|
|
2294
|
+
- [Zernio::XArticleEntityOneOf](docs/XArticleEntityOneOf.md)
|
|
2295
|
+
- [Zernio::XArticleEntityOneOf1](docs/XArticleEntityOneOf1.md)
|
|
2296
|
+
- [Zernio::XArticleEntityOneOf1Value](docs/XArticleEntityOneOf1Value.md)
|
|
2297
|
+
- [Zernio::XArticleEntityOneOf1ValueData](docs/XArticleEntityOneOf1ValueData.md)
|
|
2298
|
+
- [Zernio::XArticleEntityOneOf2](docs/XArticleEntityOneOf2.md)
|
|
2299
|
+
- [Zernio::XArticleEntityOneOf2Value](docs/XArticleEntityOneOf2Value.md)
|
|
2300
|
+
- [Zernio::XArticleEntityOneOf2ValueData](docs/XArticleEntityOneOf2ValueData.md)
|
|
2301
|
+
- [Zernio::XArticleEntityOneOf3](docs/XArticleEntityOneOf3.md)
|
|
2302
|
+
- [Zernio::XArticleEntityOneOf3Value](docs/XArticleEntityOneOf3Value.md)
|
|
2303
|
+
- [Zernio::XArticleEntityOneOf3ValueData](docs/XArticleEntityOneOf3ValueData.md)
|
|
2304
|
+
- [Zernio::XArticleEntityOneOf4](docs/XArticleEntityOneOf4.md)
|
|
2305
|
+
- [Zernio::XArticleEntityOneOf4Value](docs/XArticleEntityOneOf4Value.md)
|
|
2306
|
+
- [Zernio::XArticleEntityOneOf4ValueData](docs/XArticleEntityOneOf4ValueData.md)
|
|
2307
|
+
- [Zernio::XArticleEntityOneOf5](docs/XArticleEntityOneOf5.md)
|
|
2308
|
+
- [Zernio::XArticleEntityOneOf5Value](docs/XArticleEntityOneOf5Value.md)
|
|
2309
|
+
- [Zernio::XArticleEntityOneOfValue](docs/XArticleEntityOneOfValue.md)
|
|
2310
|
+
- [Zernio::XArticleEntityOneOfValueData](docs/XArticleEntityOneOfValueData.md)
|
|
2311
|
+
- [Zernio::XArticleEntityRange](docs/XArticleEntityRange.md)
|
|
2312
|
+
- [Zernio::XArticleInlineStyleRange](docs/XArticleInlineStyleRange.md)
|
|
2313
|
+
- [Zernio::XArticleTextRange](docs/XArticleTextRange.md)
|
|
2233
2314
|
- [Zernio::YouTubeDailyViewsResponse](docs/YouTubeDailyViewsResponse.md)
|
|
2234
2315
|
- [Zernio::YouTubeDailyViewsResponseDailyViewsInner](docs/YouTubeDailyViewsResponseDailyViewsInner.md)
|
|
2235
2316
|
- [Zernio::YouTubeDailyViewsResponseDateRange](docs/YouTubeDailyViewsResponseDateRange.md)
|
data/docs/AccountsApi.md
CHANGED
|
@@ -7,6 +7,7 @@ All URIs are relative to *https://zernio.com/api*
|
|
|
7
7
|
| [**delete_account**](AccountsApi.md#delete_account) | **DELETE** /v1/accounts/{accountId} | Disconnect account |
|
|
8
8
|
| [**get_account_health**](AccountsApi.md#get_account_health) | **GET** /v1/accounts/{accountId}/health | Check account health |
|
|
9
9
|
| [**get_all_accounts_health**](AccountsApi.md#get_all_accounts_health) | **GET** /v1/accounts/health | Check accounts health |
|
|
10
|
+
| [**get_bluesky_settings**](AccountsApi.md#get_bluesky_settings) | **GET** /v1/accounts/{accountId}/bluesky-settings | Get Bluesky account settings |
|
|
10
11
|
| [**get_follower_stats**](AccountsApi.md#get_follower_stats) | **GET** /v1/accounts/follower-stats | Get follower stats |
|
|
11
12
|
| [**get_instagram_follow_status**](AccountsApi.md#get_instagram_follow_status) | **GET** /v1/accounts/{accountId}/follow-status/{userId} | Check whether an Instagram user follows the account |
|
|
12
13
|
| [**get_slack_settings**](AccountsApi.md#get_slack_settings) | **GET** /v1/accounts/{accountId}/slack-settings | Get Slack account settings |
|
|
@@ -14,6 +15,7 @@ All URIs are relative to *https://zernio.com/api*
|
|
|
14
15
|
| [**list_accounts**](AccountsApi.md#list_accounts) | **GET** /v1/accounts | List accounts |
|
|
15
16
|
| [**move_account_to_profile**](AccountsApi.md#move_account_to_profile) | **PATCH** /v1/accounts/{accountId} | Move account to another profile |
|
|
16
17
|
| [**update_account**](AccountsApi.md#update_account) | **PUT** /v1/accounts/{accountId} | Update account |
|
|
18
|
+
| [**update_bluesky_settings**](AccountsApi.md#update_bluesky_settings) | **PATCH** /v1/accounts/{accountId}/bluesky-settings | Update Bluesky account settings |
|
|
17
19
|
| [**update_slack_settings**](AccountsApi.md#update_slack_settings) | **PATCH** /v1/accounts/{accountId}/slack-settings | Update Slack account settings |
|
|
18
20
|
|
|
19
21
|
|
|
@@ -92,7 +94,7 @@ end
|
|
|
92
94
|
|
|
93
95
|
Check account health
|
|
94
96
|
|
|
95
|
-
Returns detailed health info for a specific account including token status, permissions, and recommendations.
|
|
97
|
+
Returns detailed health info for a specific account including token status, permissions, and recommendations. For WhatsApp accounts the response also includes `platformConnection`, a live probe of the Meta link behind the channel (the same read as `GET /v1/whatsapp/number-info`). The OAuth token can be perfectly valid while Meta refuses to serve the phone-number object (for example after a phone-side coexistence disconnect), so `tokenStatus` alone is not a liveness signal for WhatsApp. When the Meta link is dead, `platformConnection.status` is `disconnected` and the overall `status` is `error`.
|
|
96
98
|
|
|
97
99
|
### Examples
|
|
98
100
|
|
|
@@ -230,6 +232,75 @@ end
|
|
|
230
232
|
- **Accept**: application/json
|
|
231
233
|
|
|
232
234
|
|
|
235
|
+
## get_bluesky_settings
|
|
236
|
+
|
|
237
|
+
> <GetBlueskySettings200Response> get_bluesky_settings(account_id)
|
|
238
|
+
|
|
239
|
+
Get Bluesky account settings
|
|
240
|
+
|
|
241
|
+
Returns the account's default post languages (defaultLangs), applied at publish time whenever a post's platformSpecificData.langs is absent. Null when no default is set.
|
|
242
|
+
|
|
243
|
+
### Examples
|
|
244
|
+
|
|
245
|
+
```ruby
|
|
246
|
+
require 'time'
|
|
247
|
+
require 'zernio-sdk'
|
|
248
|
+
# setup authorization
|
|
249
|
+
Zernio.configure do |config|
|
|
250
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
251
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
252
|
+
end
|
|
253
|
+
|
|
254
|
+
api_instance = Zernio::AccountsApi.new
|
|
255
|
+
account_id = 'account_id_example' # String |
|
|
256
|
+
|
|
257
|
+
begin
|
|
258
|
+
# Get Bluesky account settings
|
|
259
|
+
result = api_instance.get_bluesky_settings(account_id)
|
|
260
|
+
p result
|
|
261
|
+
rescue Zernio::ApiError => e
|
|
262
|
+
puts "Error when calling AccountsApi->get_bluesky_settings: #{e}"
|
|
263
|
+
end
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
#### Using the get_bluesky_settings_with_http_info variant
|
|
267
|
+
|
|
268
|
+
This returns an Array which contains the response data, status code and headers.
|
|
269
|
+
|
|
270
|
+
> <Array(<GetBlueskySettings200Response>, Integer, Hash)> get_bluesky_settings_with_http_info(account_id)
|
|
271
|
+
|
|
272
|
+
```ruby
|
|
273
|
+
begin
|
|
274
|
+
# Get Bluesky account settings
|
|
275
|
+
data, status_code, headers = api_instance.get_bluesky_settings_with_http_info(account_id)
|
|
276
|
+
p status_code # => 2xx
|
|
277
|
+
p headers # => { ... }
|
|
278
|
+
p data # => <GetBlueskySettings200Response>
|
|
279
|
+
rescue Zernio::ApiError => e
|
|
280
|
+
puts "Error when calling AccountsApi->get_bluesky_settings_with_http_info: #{e}"
|
|
281
|
+
end
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
### Parameters
|
|
285
|
+
|
|
286
|
+
| Name | Type | Description | Notes |
|
|
287
|
+
| ---- | ---- | ----------- | ----- |
|
|
288
|
+
| **account_id** | **String** | | |
|
|
289
|
+
|
|
290
|
+
### Return type
|
|
291
|
+
|
|
292
|
+
[**GetBlueskySettings200Response**](GetBlueskySettings200Response.md)
|
|
293
|
+
|
|
294
|
+
### Authorization
|
|
295
|
+
|
|
296
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
297
|
+
|
|
298
|
+
### HTTP request headers
|
|
299
|
+
|
|
300
|
+
- **Content-Type**: Not defined
|
|
301
|
+
- **Accept**: application/json
|
|
302
|
+
|
|
303
|
+
|
|
233
304
|
## get_follower_stats
|
|
234
305
|
|
|
235
306
|
> <FollowerStatsResponse> get_follower_stats(opts)
|
|
@@ -749,6 +820,76 @@ end
|
|
|
749
820
|
- **Accept**: application/json
|
|
750
821
|
|
|
751
822
|
|
|
823
|
+
## update_bluesky_settings
|
|
824
|
+
|
|
825
|
+
> update_bluesky_settings(account_id, update_bluesky_settings_request)
|
|
826
|
+
|
|
827
|
+
Update Bluesky account settings
|
|
828
|
+
|
|
829
|
+
Set or clear the account's default post languages. 1-3 BCP-47 codes (e.g. \"pt\", \"en-US\"), the same validation as per-post langs; explicit null clears the default. Per-post platformSpecificData.langs always overrides this default. Applies to posts published after the change; already-published posts cannot be retagged (Bluesky has no post edit).
|
|
830
|
+
|
|
831
|
+
### Examples
|
|
832
|
+
|
|
833
|
+
```ruby
|
|
834
|
+
require 'time'
|
|
835
|
+
require 'zernio-sdk'
|
|
836
|
+
# setup authorization
|
|
837
|
+
Zernio.configure do |config|
|
|
838
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
839
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
840
|
+
end
|
|
841
|
+
|
|
842
|
+
api_instance = Zernio::AccountsApi.new
|
|
843
|
+
account_id = 'account_id_example' # String |
|
|
844
|
+
update_bluesky_settings_request = Zernio::UpdateBlueskySettingsRequest.new({default_langs: ["pt"]}) # UpdateBlueskySettingsRequest |
|
|
845
|
+
|
|
846
|
+
begin
|
|
847
|
+
# Update Bluesky account settings
|
|
848
|
+
api_instance.update_bluesky_settings(account_id, update_bluesky_settings_request)
|
|
849
|
+
rescue Zernio::ApiError => e
|
|
850
|
+
puts "Error when calling AccountsApi->update_bluesky_settings: #{e}"
|
|
851
|
+
end
|
|
852
|
+
```
|
|
853
|
+
|
|
854
|
+
#### Using the update_bluesky_settings_with_http_info variant
|
|
855
|
+
|
|
856
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
857
|
+
|
|
858
|
+
> <Array(nil, Integer, Hash)> update_bluesky_settings_with_http_info(account_id, update_bluesky_settings_request)
|
|
859
|
+
|
|
860
|
+
```ruby
|
|
861
|
+
begin
|
|
862
|
+
# Update Bluesky account settings
|
|
863
|
+
data, status_code, headers = api_instance.update_bluesky_settings_with_http_info(account_id, update_bluesky_settings_request)
|
|
864
|
+
p status_code # => 2xx
|
|
865
|
+
p headers # => { ... }
|
|
866
|
+
p data # => nil
|
|
867
|
+
rescue Zernio::ApiError => e
|
|
868
|
+
puts "Error when calling AccountsApi->update_bluesky_settings_with_http_info: #{e}"
|
|
869
|
+
end
|
|
870
|
+
```
|
|
871
|
+
|
|
872
|
+
### Parameters
|
|
873
|
+
|
|
874
|
+
| Name | Type | Description | Notes |
|
|
875
|
+
| ---- | ---- | ----------- | ----- |
|
|
876
|
+
| **account_id** | **String** | | |
|
|
877
|
+
| **update_bluesky_settings_request** | [**UpdateBlueskySettingsRequest**](UpdateBlueskySettingsRequest.md) | | |
|
|
878
|
+
|
|
879
|
+
### Return type
|
|
880
|
+
|
|
881
|
+
nil (empty response body)
|
|
882
|
+
|
|
883
|
+
### Authorization
|
|
884
|
+
|
|
885
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
886
|
+
|
|
887
|
+
### HTTP request headers
|
|
888
|
+
|
|
889
|
+
- **Content-Type**: application/json
|
|
890
|
+
- **Accept**: application/json
|
|
891
|
+
|
|
892
|
+
|
|
752
893
|
## update_slack_settings
|
|
753
894
|
|
|
754
895
|
> update_slack_settings(account_id, update_slack_settings_request)
|
data/docs/AdCampaignsApi.md
CHANGED
|
@@ -30,11 +30,11 @@ All URIs are relative to *https://zernio.com/api*
|
|
|
30
30
|
|
|
31
31
|
## boost_post
|
|
32
32
|
|
|
33
|
-
> <UpdateAd200Response> boost_post(boost_post_request)
|
|
33
|
+
> <UpdateAd200Response> boost_post(boost_post_request, opts)
|
|
34
34
|
|
|
35
35
|
Boost post as ad
|
|
36
36
|
|
|
37
|
-
Creates a paid ad from an existing published post, keeping the post's engagement. By default it provisions the whole hierarchy (campaign, ad set, ad). **Attach shape (Meta).** Send `adSetId` to put the ad under an EXISTING ad set instead, so that ad set keeps its learning phase. It then owns `budget`, `schedule` and `targeting`, and sending any of those alongside `adSetId` is a 400 rather than a silent drop. `budget` is required only without `adSetId`. `instagramAccountId`, `destinationType` and `adSetId` are Meta-only and return 400 on other platforms.
|
|
37
|
+
Creates a paid ad from an existing published post, keeping the post's engagement. By default it provisions the whole hierarchy (campaign, ad set, ad). **Attach shape (Meta).** Send `adSetId` to put the ad under an EXISTING ad set instead, so that ad set keeps its learning phase. It then owns `budget`, `schedule` and `targeting`, and sending any of those alongside `adSetId` is a 400 rather than a silent drop. `budget` is required only without `adSetId`. `instagramAccountId`, `destinationType` and `adSetId` are Meta-only and return 400 on other platforms. **Retries.** Boosts are NOT idempotent and can take minutes when Meta requires re-hosting an Instagram video, so do not retry on client timeout. Send an Idempotency-Key header to make retries safe: same key and body replays the original 201, and distinct keys always create distinct ads. Without the header, an identical request is treated as a retry: while one is in flight it returns 409, and within 10 minutes of a completed boost it returns the already-created ad instead of creating another. To intentionally duplicate an ad, send distinct Idempotency-Keys (or vary the body, e.g. the name).
|
|
38
38
|
|
|
39
39
|
### Examples
|
|
40
40
|
|
|
@@ -49,10 +49,13 @@ end
|
|
|
49
49
|
|
|
50
50
|
api_instance = Zernio::AdCampaignsApi.new
|
|
51
51
|
boost_post_request = Zernio::BoostPostRequest.new({account_id: 'account_id_example', ad_account_id: 'ad_account_id_example', name: 'name_example', goal: 'engagement'}) # BoostPostRequest |
|
|
52
|
+
opts = {
|
|
53
|
+
idempotency_key: 'idempotency_key_example' # String | Optional client-generated unique key (e.g. a UUID) that makes retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409.
|
|
54
|
+
}
|
|
52
55
|
|
|
53
56
|
begin
|
|
54
57
|
# Boost post as ad
|
|
55
|
-
result = api_instance.boost_post(boost_post_request)
|
|
58
|
+
result = api_instance.boost_post(boost_post_request, opts)
|
|
56
59
|
p result
|
|
57
60
|
rescue Zernio::ApiError => e
|
|
58
61
|
puts "Error when calling AdCampaignsApi->boost_post: #{e}"
|
|
@@ -63,12 +66,12 @@ end
|
|
|
63
66
|
|
|
64
67
|
This returns an Array which contains the response data, status code and headers.
|
|
65
68
|
|
|
66
|
-
> <Array(<UpdateAd200Response>, Integer, Hash)> boost_post_with_http_info(boost_post_request)
|
|
69
|
+
> <Array(<UpdateAd200Response>, Integer, Hash)> boost_post_with_http_info(boost_post_request, opts)
|
|
67
70
|
|
|
68
71
|
```ruby
|
|
69
72
|
begin
|
|
70
73
|
# Boost post as ad
|
|
71
|
-
data, status_code, headers = api_instance.boost_post_with_http_info(boost_post_request)
|
|
74
|
+
data, status_code, headers = api_instance.boost_post_with_http_info(boost_post_request, opts)
|
|
72
75
|
p status_code # => 2xx
|
|
73
76
|
p headers # => { ... }
|
|
74
77
|
p data # => <UpdateAd200Response>
|
|
@@ -82,6 +85,7 @@ end
|
|
|
82
85
|
| Name | Type | Description | Notes |
|
|
83
86
|
| ---- | ---- | ----------- | ----- |
|
|
84
87
|
| **boost_post_request** | [**BoostPostRequest**](BoostPostRequest.md) | | |
|
|
88
|
+
| **idempotency_key** | **String** | Optional client-generated unique key (e.g. a UUID) that makes retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409. | [optional] |
|
|
85
89
|
|
|
86
90
|
### Return type
|
|
87
91
|
|
|
@@ -852,8 +856,10 @@ opts = {
|
|
|
852
856
|
account_id: 'account_id_example', # String | Social account ID
|
|
853
857
|
profile_id: 'profile_id_example', # String | Profile ID
|
|
854
858
|
campaign_id: 'campaign_id_example', # String | Restrict the tree to a single campaign by its platform campaign id (the id the platform assigns, e.g. Meta's numeric campaign id). Filters the campaign set itself, so it works regardless of account size and pagination — pass this when you already hold a campaign id instead of paging the tree to find it. Mirrors the `campaignId` filter on GET /v1/ads.
|
|
855
|
-
from_date: Date.parse('2013-10-20'), # Date | Start of the METRICS date range (YYYY-MM-DD).
|
|
859
|
+
from_date: Date.parse('2013-10-20'), # Date | Start of the METRICS date range (YYYY-MM-DD). On its own it affects only the spend/impression numbers overlaid on each node, not which campaigns are returned — pass `hasDelivery` or `minSpend` to also filter the campaign set to this window. Defaults to 90 days ago.
|
|
856
860
|
to_date: Date.parse('2013-10-20'), # Date | End of metrics date range (YYYY-MM-DD). Defaults to today. Max 730-day range.
|
|
861
|
+
has_delivery: true, # Boolean | Return only campaigns that delivered between `fromDate` and `toDate` — spend above zero, or impressions served at zero spend. Unlike `status`, which reads a campaign's CURRENT state, this filters on what happened inside the window, so a campaign that spent then and is paused today is still returned. Filters the campaign set itself, so `pagination.total` counts only matching campaigns.
|
|
862
|
+
min_spend: 8.14, # Float | Return only campaigns whose spend between `fromDate` and `toDate` reaches this amount. Expressed in each campaign's OWN currency (the `currency` field on the campaign node): spend is stored per ad account in its native currency and one response can span several. Implies `hasDelivery`; `minSpend=0` applies no filter.
|
|
857
863
|
sort: 'newest', # String | Campaign-level sort order. `newest` (default) / `oldest` order by the campaign's newest-ad createdAt. `spend_desc` / `spend_asc` order by aggregated spend in the requested date range; campaigns with no spend land at the end.
|
|
858
864
|
time_increment: 1, # Integer | Set to `1` to also return a daily breakdown. Mirrors Meta Insights' `time_increment=1`: each node gains a `daily[]` array of per-day metrics (same fields as the aggregated `metrics`) alongside the range total, so you get per-entity daily trends in ONE call instead of calling the tree once per day. Only `1` (daily) is supported. The daily series covers the same date range and uses the same source data as `metrics`, except `reach` on Meta and TikTok: the range total is the platform's de-duplicated value, so daily reach does not sum to it. See `dailyLevel` to control which levels carry it.
|
|
859
865
|
daily_level: 'campaign' # String | Which tree levels get the `daily[]` series when `timeIncrement=1`. `campaign` (default) attaches it on campaign nodes only — the common per-campaign-trend case, and the smallest payload. `adset` adds it on ad sets too; `ad` adds it on every ad in `ads[]` as well (heaviest — a long range × up to 100 ads per ad set). Scope with `campaignId` to keep `ad`-level responses small. Ignored when `timeIncrement` is unset.
|
|
@@ -900,8 +906,10 @@ end
|
|
|
900
906
|
| **account_id** | **String** | Social account ID | [optional] |
|
|
901
907
|
| **profile_id** | **String** | Profile ID | [optional] |
|
|
902
908
|
| **campaign_id** | **String** | Restrict the tree to a single campaign by its platform campaign id (the id the platform assigns, e.g. Meta's numeric campaign id). Filters the campaign set itself, so it works regardless of account size and pagination — pass this when you already hold a campaign id instead of paging the tree to find it. Mirrors the `campaignId` filter on GET /v1/ads. | [optional] |
|
|
903
|
-
| **from_date** | **Date** | Start of the METRICS date range (YYYY-MM-DD).
|
|
909
|
+
| **from_date** | **Date** | Start of the METRICS date range (YYYY-MM-DD). On its own it affects only the spend/impression numbers overlaid on each node, not which campaigns are returned — pass `hasDelivery` or `minSpend` to also filter the campaign set to this window. Defaults to 90 days ago. | [optional] |
|
|
904
910
|
| **to_date** | **Date** | End of metrics date range (YYYY-MM-DD). Defaults to today. Max 730-day range. | [optional] |
|
|
911
|
+
| **has_delivery** | **Boolean** | Return only campaigns that delivered between `fromDate` and `toDate` — spend above zero, or impressions served at zero spend. Unlike `status`, which reads a campaign's CURRENT state, this filters on what happened inside the window, so a campaign that spent then and is paused today is still returned. Filters the campaign set itself, so `pagination.total` counts only matching campaigns. | [optional] |
|
|
912
|
+
| **min_spend** | **Float** | Return only campaigns whose spend between `fromDate` and `toDate` reaches this amount. Expressed in each campaign's OWN currency (the `currency` field on the campaign node): spend is stored per ad account in its native currency and one response can span several. Implies `hasDelivery`; `minSpend=0` applies no filter. | [optional] |
|
|
905
913
|
| **sort** | **String** | Campaign-level sort order. `newest` (default) / `oldest` order by the campaign's newest-ad createdAt. `spend_desc` / `spend_asc` order by aggregated spend in the requested date range; campaigns with no spend land at the end. | [optional][default to 'newest'] |
|
|
906
914
|
| **time_increment** | **Integer** | Set to `1` to also return a daily breakdown. Mirrors Meta Insights' `time_increment=1`: each node gains a `daily[]` array of per-day metrics (same fields as the aggregated `metrics`) alongside the range total, so you get per-entity daily trends in ONE call instead of calling the tree once per day. Only `1` (daily) is supported. The daily series covers the same date range and uses the same source data as `metrics`, except `reach` on Meta and TikTok: the range total is the platform's de-duplicated value, so daily reach does not sum to it. See `dailyLevel` to control which levels carry it. | [optional] |
|
|
907
915
|
| **daily_level** | **String** | Which tree levels get the `daily[]` series when `timeIncrement=1`. `campaign` (default) attaches it on campaign nodes only — the common per-campaign-trend case, and the smallest payload. `adset` adds it on ad sets too; `ad` adds it on every ad in `ads[]` as well (heaviest — a long range × up to 100 ads per ad set). Scope with `campaignId` to keep `ad`-level responses small. Ignored when `timeIncrement` is unset. | [optional][default to 'campaign'] |
|
|
@@ -1031,7 +1039,9 @@ opts = {
|
|
|
1031
1039
|
account_id: 'account_id_example', # String | Social account ID
|
|
1032
1040
|
profile_id: 'profile_id_example', # String | Profile ID
|
|
1033
1041
|
from_date: Date.parse('2013-10-20'), # Date | Start of metrics date range (YYYY-MM-DD, inclusive). Defaults to 90 days ago when both date params are omitted.
|
|
1034
|
-
to_date: Date.parse('2013-10-20') # Date | End of metrics date range (YYYY-MM-DD, inclusive). Defaults to today. Max 730-day range.
|
|
1042
|
+
to_date: Date.parse('2013-10-20'), # Date | End of metrics date range (YYYY-MM-DD, inclusive). Defaults to today. Max 730-day range.
|
|
1043
|
+
has_delivery: true, # Boolean | Return only campaigns that delivered between `fromDate` and `toDate` — spend above zero, or impressions served at zero spend. Unlike `status`, which reads a campaign's CURRENT state, this filters on what happened inside the window. Filters the campaign set itself, so `pagination.total` counts only matching campaigns. Mirrors the same filter on /v1/ads/tree.
|
|
1044
|
+
min_spend: 8.14 # Float | Return only campaigns whose spend between `fromDate` and `toDate` reaches this amount, in each campaign's OWN currency (the `currency` field on the campaign). Implies `hasDelivery`; `minSpend=0` applies no filter. Mirrors the same filter on /v1/ads/tree.
|
|
1035
1045
|
}
|
|
1036
1046
|
|
|
1037
1047
|
begin
|
|
@@ -1077,6 +1087,8 @@ end
|
|
|
1077
1087
|
| **profile_id** | **String** | Profile ID | [optional] |
|
|
1078
1088
|
| **from_date** | **Date** | Start of metrics date range (YYYY-MM-DD, inclusive). Defaults to 90 days ago when both date params are omitted. | [optional] |
|
|
1079
1089
|
| **to_date** | **Date** | End of metrics date range (YYYY-MM-DD, inclusive). Defaults to today. Max 730-day range. | [optional] |
|
|
1090
|
+
| **has_delivery** | **Boolean** | Return only campaigns that delivered between `fromDate` and `toDate` — spend above zero, or impressions served at zero spend. Unlike `status`, which reads a campaign's CURRENT state, this filters on what happened inside the window. Filters the campaign set itself, so `pagination.total` counts only matching campaigns. Mirrors the same filter on /v1/ads/tree. | [optional] |
|
|
1091
|
+
| **min_spend** | **Float** | Return only campaigns whose spend between `fromDate` and `toDate` reaches this amount, in each campaign's OWN currency (the `currency` field on the campaign). Implies `hasDelivery`; `minSpend=0` applies no filter. Mirrors the same filter on /v1/ads/tree. | [optional] |
|
|
1080
1092
|
|
|
1081
1093
|
### Return type
|
|
1082
1094
|
|
|
@@ -1430,7 +1442,7 @@ end
|
|
|
1430
1442
|
|
|
1431
1443
|
Pause or resume a campaign
|
|
1432
1444
|
|
|
1433
|
-
|
|
1445
|
+
Writes the campaign's own on/off switch, then lets the platform cascade delivery to its ad sets and ads. Makes one platform API call, not one per ad. The switch is always written, whatever delivery status the ads underneath report: an ad still in review does not block resuming its campaign. The echoed `status` is the confirmation that it landed. `updated` / `skipped` describe only the ads whose own stored status CHANGED alongside it, so `updated: 0` is a normal successful response, not a no-op. Ads are skipped when they are in a terminal status (rejected, completed, cancelled), already in the target state, or switched on but not yet delivering — the last group keeps its `pending_review` / `error` status until the platform reports what it became. `skippedReasons` names which case applies. On Meta this flips the campaign only. An ad set paused in its own right stays paused, so pair this with PUT /v1/ads/ad-sets/{adSetId}/status when you also need the ad set switched back on.
|
|
1434
1446
|
|
|
1435
1447
|
### Examples
|
|
1436
1448
|
|
|
@@ -1572,7 +1584,7 @@ end
|
|
|
1572
1584
|
|
|
1573
1585
|
Pause or resume a single ad set
|
|
1574
1586
|
|
|
1575
|
-
Ad-set-scoped pause/resume (doesn't touch sibling ad sets). Thin wrapper over PUT /v1/ads/ad-sets/{adSetId} for callers that only want the status toggle and prefer a symmetric URL to /v1/ads/campaigns/{campaignId}/status.
|
|
1587
|
+
Ad-set-scoped pause/resume (doesn't touch sibling ad sets). Thin wrapper over PUT /v1/ads/ad-sets/{adSetId} for callers that only want the status toggle and prefer a symmetric URL to /v1/ads/campaigns/{campaignId}/status. On Meta and LinkedIn this writes the ad set's own on/off switch (Meta: `configured_status`), whatever delivery status its ads report — an ad still in review does not block resuming its ad set. The echoed `status` is the confirmation that it landed. Where the platform has no ad-set switch (TikTok and others) the toggle is emulated by flipping the child ads; a call with no actionable ad then writes nothing and returns a `message` with no `status`. `updated` / `skipped` describe only the ads whose own stored status CHANGED alongside the switch, so `updated: 0` is a normal successful response. See `skippedReasons` for which of the three cases applies (terminal, already in the target state, or switched on but not yet delivering). A campaign created paused needs its campaign resumed as well: pair this with PUT /v1/ads/campaigns/{campaignId}/status.
|
|
1576
1588
|
|
|
1577
1589
|
### Examples
|
|
1578
1590
|
|
data/docs/AdCreative.md
CHANGED
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
| **image_url** | **String** | Alternative image URL | [optional] |
|
|
9
9
|
| **video_id** | **String** | Meta video ID for VIDEO-type ads. Null for non-video ads. Callers that need an embeddable MP4 can call GET /{videoId}?fields=source with the page access token. | [optional] |
|
|
10
10
|
| **video_url** | **String** | Public Facebook watch URL for VIDEO-type ads (https://www.facebook.com/watch/?v={videoId}). Null for non-video ads. | [optional] |
|
|
11
|
+
| **creative_id** | **String** | Meta ad creative id backing this ad. Reusable via existingCreativeId on POST /v1/ads/create. | [optional] |
|
|
11
12
|
| **object_type** | **String** | Meta creative object_type (e.g. SHARE, VIDEO, PRIVACY_CHECK_FAIL, POST_DELETED). Use this to render state-aware previews — when Meta moderation strips image/video fields, only thumbnailUrl at 64x64 is available. | [optional] |
|
|
12
13
|
| **object_story_id** | **String** | Meta creative `object_story_id` (the SHARE reference). Frequently absent — Meta omits it for SHARE creatives. Use effectiveObjectStoryId instead. | [optional] |
|
|
13
14
|
| **effective_object_story_id** | **String** | Meta `effective_object_story_id` — `{pageId}_{postId}` of the Facebook post the ad's engagement (comments) lives on. Pass to GET /v1/ads?effectiveObjectStoryId= to map a Business-Manager-visible post back to this ad; GET /v1/ads/{adId}/comments resolves comments against it. | [optional] |
|
|
@@ -36,6 +37,7 @@ instance = Zernio::AdCreative.new(
|
|
|
36
37
|
image_url: null,
|
|
37
38
|
video_id: null,
|
|
38
39
|
video_url: null,
|
|
40
|
+
creative_id: null,
|
|
39
41
|
object_type: null,
|
|
40
42
|
object_story_id: null,
|
|
41
43
|
effective_object_story_id: null,
|
data/docs/AdDailyMetrics.md
CHANGED
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
| **engagement** | **Integer** | | [optional] |
|
|
15
15
|
| **conversions** | **Float** | Count of conversion events over the requested date range. FRACTIONAL: attribution splits one conversion across touchpoints and Google additionally reports modeled conversions, so values like 0.347 are normal. Meta: events matching the campaign's promoted_object.custom_event_type (PURCHASE, LEAD, etc.). Google: the account's tracked conversions. X and LinkedIn: their reported website/lead conversions (added 2026-07). 0 for non-conversion campaigns or when no events have fired. | [optional] |
|
|
16
16
|
| **cost_per_conversion** | **Float** | Derived spend / conversions in the same currency as spend. 0 when conversions is 0. | [optional] |
|
|
17
|
-
| **actions** | **Hash<String, Integer>** | Per-action-type counts summed over the date range, keyed by the platform's action-type names. Meta: raw Insights action_type keys (link_click, offsite_conversion.fb_pixel_purchase, onsite_conversion.lead_grouped, ...) — both engagement and conversion events. X: conversion types (purchase, sign_up, site_visit, download, custom). LinkedIn: conversion types (post_click, post_view, lead_gen). Google returns {} (its per-action names aren't synced per ad). Empty object when no actions are reported. NOTE: keys differ by platform, so branch on the ad's platform when interpreting them. | [optional] |
|
|
17
|
+
| **actions** | **Hash<String, Integer>** | Per-action-type counts summed over the date range, keyed by the platform's action-type names. Meta: raw Insights action_type keys (link_click, offsite_conversion.fb_pixel_purchase, onsite_conversion.lead_grouped, ...) — both engagement and conversion events. TikTok: pixel conversions (purchase, add_to_cart, initiate_checkout, view_content, complete_payment, lead) plus the paid-engagement family (follow, post_reaction for paid likes, comment, share) — follow is how FOLLOWERS-goal campaigns report their result. X: conversion types (purchase, sign_up, site_visit, download, custom). LinkedIn: conversion types (post_click, post_view, lead_gen). Google returns {} (its per-action names aren't synced per ad). Empty object when no actions are reported. NOTE: keys differ by platform, so branch on the ad's platform when interpreting them. | [optional] |
|
|
18
18
|
| **action_values** | **Hash<String, Float>** | Monetary mirror of `actions`, from Meta's Insights `action_values[]` array. Same keying — values are the revenue attributed to each action_type, in ad-account native currency (same unit as `spend`; see the campaign node's `currency` field). Use this to compute revenue-per-event (e.g. avg purchase value). Meta-only; other platforms return {}. | [optional] |
|
|
19
19
|
| **purchase_value** | **Float** | Convenience sum of purchase-type action values — picked from `actionValues` via the same priority list as `conversions` so both fields describe the same events. In ad-account native currency. 0 when the campaign has no purchase event configured. Meta-only. | [optional] |
|
|
20
20
|
| **roas** | **Float** | Return on ad spend — derived as `purchaseValue / spend`. 0 when `spend` is 0. Equivalent to Meta's `purchase_roas` under default attribution. At ad-set and campaign levels this is recomputed from summed purchaseValue + spend (NOT averaged across children) so it's mathematically correct at every rollup level. | [optional] |
|
data/docs/AdEngagementCounts.md
CHANGED
|
@@ -4,11 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **post_engagement** | **Integer** | Meta's own post-engagement total (`post_engagement`). | [optional] |
|
|
8
|
-
| **page_engagement** | **Integer** | Meta's own page-engagement total (`page_engagement`). | [optional] |
|
|
9
|
-
| **reactions** | **Integer** | Reactions on the ad's post (`post_reaction`). | [optional] |
|
|
7
|
+
| **post_engagement** | **Integer** | Meta's own post-engagement total (`post_engagement`). Meta-only. | [optional] |
|
|
8
|
+
| **page_engagement** | **Integer** | Meta's own page-engagement total (`page_engagement`). Meta-only. | [optional] |
|
|
9
|
+
| **reactions** | **Integer** | Reactions on the ad's post (`post_reaction`). For TikTok these are its paid likes. | [optional] |
|
|
10
10
|
| **comments** | **Integer** | Comments on the ad's post. | [optional] |
|
|
11
|
-
| **shares** | **Integer** | Shares of the ad's post. Meta reports these under the action type literally named `post`. | [optional] |
|
|
11
|
+
| **shares** | **Integer** | Shares of the ad's post. Meta reports these under the action type literally named `post`; TikTok under `share`. | [optional] |
|
|
12
12
|
| **saves** | **Integer** | Saves of the ad's post (`onsite_conversion.post_save`). | [optional] |
|
|
13
13
|
| **page_likes** | **Integer** | New Page likes attributed to the ad (`like`). | [optional] |
|
|
14
14
|
| **video_views** | **Integer** | 3-second video views (`video_view`). For completion-based counts use `videoThruplayWatchedActions`. | [optional] |
|