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
data/docs/UpdateAdSetRequest.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **platform** | **String** | | |
|
|
8
8
|
| **budget** | [**UpdateAdSetRequestBudget**](UpdateAdSetRequestBudget.md) | | [optional] |
|
|
9
|
-
| **status** | **String** | Omit if not toggling delivery state | [optional] |
|
|
9
|
+
| **status** | **String** | Writes the ad set's own on/off switch (Meta: `configured_status`) on Meta and LinkedIn, whatever delivery status its ads report. Omit if not toggling delivery state. | [optional] |
|
|
10
10
|
| **name** | **String** | Rename the ad set (Meta only; other platforms return 501). At least one of budget/status/bidStrategy/name is required. | [optional] |
|
|
11
11
|
| **bid_strategy** | [**BidStrategy**](BidStrategy.md) | Ad-set-level bid strategy. Overrides the campaign-level default. Supported on Meta (facebook, instagram), TikTok, and OpenAI. On TikTok the Meta-style enum is mapped to bid_type / bid_price / deep_bid_type automatically. On OpenAI, LOWEST_COST_WITH_BID_CAP and COST_CAP both map to the ad group's `bidding_config.max_bid_micros` (one knob covers both); LOWEST_COST_WITH_MIN_ROAS is rejected with 422 (OpenAI has no ROAS-based bidding). Other platforms (linkedin, pinterest, google, twitter) return 501 Not Implemented when bidStrategy is set. | [optional] |
|
|
12
12
|
| **bid_amount** | **Float** | Bid cap in WHOLE currency units (USD: 5 = $5.00; JPY: 100 = ¥100). Required when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. Internally converted to Meta's smallest-denomination integer, or (on OpenAI) to micros (× 1,000,000). Meta only: may be sent alone, WITHOUT bidStrategy, to update the cap amount on an ad set whose parent campaign is COST_CAP or LOWEST_COST_WITH_BID_CAP (the strategy is inherited from the campaign and is left untouched). | [optional] |
|
|
@@ -4,8 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **
|
|
8
|
-
| **
|
|
7
|
+
| **status** | **String** | The status written to the ad set. Absent when nothing was written (see message). | [optional] |
|
|
8
|
+
| **updated** | **Integer** | Number of ads whose own stored status changed too. 0 is normal on a resume whose ads are all awaiting the platform. | [optional] |
|
|
9
|
+
| **skipped** | **Integer** | Number of ads whose own status was left as it was | [optional] |
|
|
10
|
+
| **skipped_reasons** | **Array<String>** | Why each group of ads was skipped | [optional] |
|
|
11
|
+
| **message** | **String** | Present only where the platform has no ad-set switch and no child ad was actionable | [optional] |
|
|
9
12
|
|
|
10
13
|
## Example
|
|
11
14
|
|
|
@@ -13,8 +16,11 @@
|
|
|
13
16
|
require 'zernio-sdk'
|
|
14
17
|
|
|
15
18
|
instance = Zernio::UpdateAdSetStatus200Response.new(
|
|
19
|
+
status: null,
|
|
16
20
|
updated: null,
|
|
17
|
-
skipped: null
|
|
21
|
+
skipped: null,
|
|
22
|
+
skipped_reasons: null,
|
|
23
|
+
message: null
|
|
18
24
|
)
|
|
19
25
|
```
|
|
20
26
|
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Zernio::UpdateBlogArticleRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **title** | **String** | | [optional] |
|
|
8
|
+
| **body_html** | **String** | Article body as HTML. | [optional] |
|
|
9
|
+
| **handle** | **String** | URL slug of the article. | [optional] |
|
|
10
|
+
| **tags** | **Array<String>** | Replaces the full tag list. | [optional] |
|
|
11
|
+
| **author** | **String** | Display name of the article author. | [optional] |
|
|
12
|
+
| **excerpt** | **String** | Short summary shown in blog listings. | [optional] |
|
|
13
|
+
| **image** | [**CreateBlogArticleRequestImage**](CreateBlogArticleRequestImage.md) | | [optional] |
|
|
14
|
+
| **seo** | [**CreateBlogArticleRequestSeo**](CreateBlogArticleRequestSeo.md) | | [optional] |
|
|
15
|
+
| **is_published** | **Boolean** | Set false to unpublish the article back to a draft. | [optional] |
|
|
16
|
+
| **publish_date** | **Time** | ISO 8601 datetime with offset (or Z). A future date schedules publication natively on the platform. | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'zernio-sdk'
|
|
22
|
+
|
|
23
|
+
instance = Zernio::UpdateBlogArticleRequest.new(
|
|
24
|
+
title: null,
|
|
25
|
+
body_html: null,
|
|
26
|
+
handle: null,
|
|
27
|
+
tags: null,
|
|
28
|
+
author: null,
|
|
29
|
+
excerpt: null,
|
|
30
|
+
image: null,
|
|
31
|
+
seo: null,
|
|
32
|
+
is_published: null,
|
|
33
|
+
publish_date: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Zernio::UpdateBlogRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **title** | **String** | | [optional] |
|
|
8
|
+
| **handle** | **String** | URL slug. Changing it changes the blog URL on the store. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'zernio-sdk'
|
|
14
|
+
|
|
15
|
+
instance = Zernio::UpdateBlogRequest.new(
|
|
16
|
+
title: null,
|
|
17
|
+
handle: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Zernio::UpdateBlueskySettingsRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **default_langs** | **Array<String>** | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'zernio-sdk'
|
|
13
|
+
|
|
14
|
+
instance = Zernio::UpdateBlueskySettingsRequest.new(
|
|
15
|
+
default_langs: ["pt"]
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **country** | **String** | ISO 3166-1 alpha-2 country code. | |
|
|
8
8
|
| **street_address** | **String** | | |
|
|
9
|
+
| **extended_address** | **String** | Address complement: apartment, suite, unit, or the quadra/lote used in some countries. Optional. Does not substitute for a building number on street_address. | [optional] |
|
|
9
10
|
| **locality** | **String** | City / town. | |
|
|
10
11
|
| **administrative_area** | **String** | State / province / region. When omitted, the pre-check is skipped (the final submit still validates). | [optional] |
|
|
11
12
|
| **postal_code** | **String** | | |
|
|
@@ -18,6 +19,7 @@ require 'zernio-sdk'
|
|
|
18
19
|
instance = Zernio::ValidatePhoneNumberKycAddressRequest.new(
|
|
19
20
|
country: null,
|
|
20
21
|
street_address: null,
|
|
22
|
+
extended_address: null,
|
|
21
23
|
locality: null,
|
|
22
24
|
administrative_area: null,
|
|
23
25
|
postal_code: null
|
data/docs/WebhookEventsApi.md
CHANGED
|
@@ -36,6 +36,7 @@ All URIs are relative to *https://zernio.com/api*
|
|
|
36
36
|
| [**on_post_scheduled**](WebhookEventsApi.md#on_post_scheduled) | **POST** /post.scheduled | Post scheduled event |
|
|
37
37
|
| [**on_post_tik_tok_url_resolved**](WebhookEventsApi.md#on_post_tik_tok_url_resolved) | **POST** /post.tiktok.url_resolved | TikTok post URL resolved event |
|
|
38
38
|
| [**on_reaction_received**](WebhookEventsApi.md#on_reaction_received) | **POST** /reaction.received | Reaction received event |
|
|
39
|
+
| [**on_referral_received**](WebhookEventsApi.md#on_referral_received) | **POST** /referral.received | Referral received event |
|
|
39
40
|
| [**on_review_new**](WebhookEventsApi.md#on_review_new) | **POST** /review.new | Review new event |
|
|
40
41
|
| [**on_review_updated**](WebhookEventsApi.md#on_review_updated) | **POST** /review.updated | Review updated event |
|
|
41
42
|
| [**on_verification_approved**](WebhookEventsApi.md#on_verification_approved) | **POST** /verification.approved | Verification approved event |
|
|
@@ -50,6 +51,7 @@ All URIs are relative to *https://zernio.com/api*
|
|
|
50
51
|
| [**on_whats_app_number_released**](WebhookEventsApi.md#on_whats_app_number_released) | **POST** /whatsapp.number.released | WhatsApp number released event |
|
|
51
52
|
| [**on_whats_app_number_suspended**](WebhookEventsApi.md#on_whats_app_number_suspended) | **POST** /whatsapp.number.suspended | WhatsApp number suspended event |
|
|
52
53
|
| [**on_whats_app_number_verification_required**](WebhookEventsApi.md#on_whats_app_number_verification_required) | **POST** /whatsapp.number.verification_required | WhatsApp number verification-required event |
|
|
54
|
+
| [**on_whats_app_template_category_updated**](WebhookEventsApi.md#on_whats_app_template_category_updated) | **POST** /whatsapp.template.category_updated | WhatsApp template category updated event |
|
|
53
55
|
| [**on_whats_app_template_status_updated**](WebhookEventsApi.md#on_whats_app_template_status_updated) | **POST** /whatsapp.template.status_updated | WhatsApp template status updated event |
|
|
54
56
|
|
|
55
57
|
|
|
@@ -2229,6 +2231,74 @@ nil (empty response body)
|
|
|
2229
2231
|
- **Accept**: Not defined
|
|
2230
2232
|
|
|
2231
2233
|
|
|
2234
|
+
## on_referral_received
|
|
2235
|
+
|
|
2236
|
+
> on_referral_received(webhook_payload_referral)
|
|
2237
|
+
|
|
2238
|
+
Referral received event
|
|
2239
|
+
|
|
2240
|
+
Fired when someone opens an EXISTING Instagram or Messenger thread through an attributable entry point - an ig.me / m.me link with a `ref` parameter, or (Messenger) a returning Click-to-Message ad click - which Meta delivers as a standalone referral with no message attached. A referral that rides an inbound message (first message of a thread, icebreaker taps, returning ad clicks on Instagram) arrives on `message.received` under `metadata.referral` instead; the two never fire for the same click. The first referral captured on a conversation is also persisted on it (see `metadata` on `GET /v1/inbox/conversations`). Requires the Inbox add-on.
|
|
2241
|
+
|
|
2242
|
+
### Examples
|
|
2243
|
+
|
|
2244
|
+
```ruby
|
|
2245
|
+
require 'time'
|
|
2246
|
+
require 'zernio-sdk'
|
|
2247
|
+
# setup authorization
|
|
2248
|
+
Zernio.configure do |config|
|
|
2249
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
2250
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2251
|
+
end
|
|
2252
|
+
|
|
2253
|
+
api_instance = Zernio::WebhookEventsApi.new
|
|
2254
|
+
webhook_payload_referral = # WebhookPayloadReferral |
|
|
2255
|
+
|
|
2256
|
+
begin
|
|
2257
|
+
# Referral received event
|
|
2258
|
+
api_instance.on_referral_received(webhook_payload_referral)
|
|
2259
|
+
rescue Zernio::ApiError => e
|
|
2260
|
+
puts "Error when calling WebhookEventsApi->on_referral_received: #{e}"
|
|
2261
|
+
end
|
|
2262
|
+
```
|
|
2263
|
+
|
|
2264
|
+
#### Using the on_referral_received_with_http_info variant
|
|
2265
|
+
|
|
2266
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
2267
|
+
|
|
2268
|
+
> <Array(nil, Integer, Hash)> on_referral_received_with_http_info(webhook_payload_referral)
|
|
2269
|
+
|
|
2270
|
+
```ruby
|
|
2271
|
+
begin
|
|
2272
|
+
# Referral received event
|
|
2273
|
+
data, status_code, headers = api_instance.on_referral_received_with_http_info(webhook_payload_referral)
|
|
2274
|
+
p status_code # => 2xx
|
|
2275
|
+
p headers # => { ... }
|
|
2276
|
+
p data # => nil
|
|
2277
|
+
rescue Zernio::ApiError => e
|
|
2278
|
+
puts "Error when calling WebhookEventsApi->on_referral_received_with_http_info: #{e}"
|
|
2279
|
+
end
|
|
2280
|
+
```
|
|
2281
|
+
|
|
2282
|
+
### Parameters
|
|
2283
|
+
|
|
2284
|
+
| Name | Type | Description | Notes |
|
|
2285
|
+
| ---- | ---- | ----------- | ----- |
|
|
2286
|
+
| **webhook_payload_referral** | [**WebhookPayloadReferral**](WebhookPayloadReferral.md) | | |
|
|
2287
|
+
|
|
2288
|
+
### Return type
|
|
2289
|
+
|
|
2290
|
+
nil (empty response body)
|
|
2291
|
+
|
|
2292
|
+
### Authorization
|
|
2293
|
+
|
|
2294
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2295
|
+
|
|
2296
|
+
### HTTP request headers
|
|
2297
|
+
|
|
2298
|
+
- **Content-Type**: application/json
|
|
2299
|
+
- **Accept**: Not defined
|
|
2300
|
+
|
|
2301
|
+
|
|
2232
2302
|
## on_review_new
|
|
2233
2303
|
|
|
2234
2304
|
> on_review_new(webhook_payload_review_new)
|
|
@@ -3181,6 +3251,74 @@ nil (empty response body)
|
|
|
3181
3251
|
- **Accept**: Not defined
|
|
3182
3252
|
|
|
3183
3253
|
|
|
3254
|
+
## on_whats_app_template_category_updated
|
|
3255
|
+
|
|
3256
|
+
> on_whats_app_template_category_updated(webhook_payload_whats_app_template_category_updated)
|
|
3257
|
+
|
|
3258
|
+
WhatsApp template category updated event
|
|
3259
|
+
|
|
3260
|
+
Fired when Meta reclassifies a WhatsApp Business template's category after approval. Forwarded from Meta's `template_category_update` webhook field on the WhatsApp Business Account. Category drives Meta's per-conversation tariff and whether the template is subject to the recipient's marketing opt-out. `template.changeType` is `scheduled` (24h advance notice) or `applied`; `template.category` is always the category right now.
|
|
3261
|
+
|
|
3262
|
+
### Examples
|
|
3263
|
+
|
|
3264
|
+
```ruby
|
|
3265
|
+
require 'time'
|
|
3266
|
+
require 'zernio-sdk'
|
|
3267
|
+
# setup authorization
|
|
3268
|
+
Zernio.configure do |config|
|
|
3269
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
3270
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
3271
|
+
end
|
|
3272
|
+
|
|
3273
|
+
api_instance = Zernio::WebhookEventsApi.new
|
|
3274
|
+
webhook_payload_whats_app_template_category_updated = # WebhookPayloadWhatsAppTemplateCategoryUpdated |
|
|
3275
|
+
|
|
3276
|
+
begin
|
|
3277
|
+
# WhatsApp template category updated event
|
|
3278
|
+
api_instance.on_whats_app_template_category_updated(webhook_payload_whats_app_template_category_updated)
|
|
3279
|
+
rescue Zernio::ApiError => e
|
|
3280
|
+
puts "Error when calling WebhookEventsApi->on_whats_app_template_category_updated: #{e}"
|
|
3281
|
+
end
|
|
3282
|
+
```
|
|
3283
|
+
|
|
3284
|
+
#### Using the on_whats_app_template_category_updated_with_http_info variant
|
|
3285
|
+
|
|
3286
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
3287
|
+
|
|
3288
|
+
> <Array(nil, Integer, Hash)> on_whats_app_template_category_updated_with_http_info(webhook_payload_whats_app_template_category_updated)
|
|
3289
|
+
|
|
3290
|
+
```ruby
|
|
3291
|
+
begin
|
|
3292
|
+
# WhatsApp template category updated event
|
|
3293
|
+
data, status_code, headers = api_instance.on_whats_app_template_category_updated_with_http_info(webhook_payload_whats_app_template_category_updated)
|
|
3294
|
+
p status_code # => 2xx
|
|
3295
|
+
p headers # => { ... }
|
|
3296
|
+
p data # => nil
|
|
3297
|
+
rescue Zernio::ApiError => e
|
|
3298
|
+
puts "Error when calling WebhookEventsApi->on_whats_app_template_category_updated_with_http_info: #{e}"
|
|
3299
|
+
end
|
|
3300
|
+
```
|
|
3301
|
+
|
|
3302
|
+
### Parameters
|
|
3303
|
+
|
|
3304
|
+
| Name | Type | Description | Notes |
|
|
3305
|
+
| ---- | ---- | ----------- | ----- |
|
|
3306
|
+
| **webhook_payload_whats_app_template_category_updated** | [**WebhookPayloadWhatsAppTemplateCategoryUpdated**](WebhookPayloadWhatsAppTemplateCategoryUpdated.md) | | |
|
|
3307
|
+
|
|
3308
|
+
### Return type
|
|
3309
|
+
|
|
3310
|
+
nil (empty response body)
|
|
3311
|
+
|
|
3312
|
+
### Authorization
|
|
3313
|
+
|
|
3314
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
3315
|
+
|
|
3316
|
+
### HTTP request headers
|
|
3317
|
+
|
|
3318
|
+
- **Content-Type**: application/json
|
|
3319
|
+
- **Accept**: Not defined
|
|
3320
|
+
|
|
3321
|
+
|
|
3184
3322
|
## on_whats_app_template_status_updated
|
|
3185
3323
|
|
|
3186
3324
|
> on_whats_app_template_status_updated(webhook_payload_whats_app_template_status_updated)
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
| **event** | **String** | | |
|
|
9
9
|
| **account** | [**WebhookPayloadAccountAdsInitialSyncCompletedAccount**](WebhookPayloadAccountAdsInitialSyncCompletedAccount.md) | | |
|
|
10
10
|
| **sync** | [**WebhookPayloadAccountAdsInitialSyncCompletedSync**](WebhookPayloadAccountAdsInitialSyncCompletedSync.md) | | |
|
|
11
|
-
| **timestamp** | **Time** |
|
|
11
|
+
| **timestamp** | **Time** | UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt. | |
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
| **id** | **String** | Stable webhook event ID | |
|
|
8
8
|
| **event** | **String** | | |
|
|
9
9
|
| **account** | [**WebhookPayloadAccountConnectedAccount**](WebhookPayloadAccountConnectedAccount.md) | | |
|
|
10
|
-
| **timestamp** | **Time** |
|
|
10
|
+
| **timestamp** | **Time** | UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt. | |
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
| **id** | **String** | Stable webhook event ID | |
|
|
8
8
|
| **event** | **String** | | |
|
|
9
9
|
| **account** | [**WebhookPayloadAccountDisconnectedAccount**](WebhookPayloadAccountDisconnectedAccount.md) | | |
|
|
10
|
-
| **timestamp** | **Time** |
|
|
10
|
+
| **timestamp** | **Time** | UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt. | |
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **ad_object** | [**WebhookPayloadAdStatusChangedAdObject**](WebhookPayloadAdStatusChangedAdObject.md) | | |
|
|
11
11
|
| **status** | [**WebhookPayloadAdStatusChangedStatus**](WebhookPayloadAdStatusChangedStatus.md) | | |
|
|
12
12
|
| **error** | [**WebhookPayloadAdStatusChangedError**](WebhookPayloadAdStatusChangedError.md) | | [optional] |
|
|
13
|
-
| **timestamp** | **Time** |
|
|
13
|
+
| **timestamp** | **Time** | UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt. | |
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
| **event** | **String** | | |
|
|
9
9
|
| **call** | [**WebhookPayloadCallEndedCall**](WebhookPayloadCallEndedCall.md) | | |
|
|
10
10
|
| **account** | [**InboxWebhookAccount**](InboxWebhookAccount.md) | | |
|
|
11
|
-
| **timestamp** | **Time** |
|
|
11
|
+
| **timestamp** | **Time** | UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt. | |
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -15,6 +15,8 @@
|
|
|
15
15
|
| **ended_at** | **Time** | | [optional] |
|
|
16
16
|
| **duration_seconds** | **Integer** | | [optional] |
|
|
17
17
|
| **end_reason** | **String** | | [optional] |
|
|
18
|
+
| **hangup_cause** | **String** | Raw carrier hangup cause behind endReason (e.g. normal_clearing, call_rejected, not_found). Null when the carrier reported none. | [optional] |
|
|
19
|
+
| **sip_hangup_cause** | **String** | SIP response code that ended the call when SIP-signalled (e.g. '403', '486', '603'). endReason collapses all three to 'rejected', so this is what separates a refused destination from a busy line. Null on non-SIP legs. | [optional] |
|
|
18
20
|
| **recording_url** | **String** | | [optional] |
|
|
19
21
|
| **recording_expires_at** | **Time** | | [optional] |
|
|
20
22
|
| **billing** | [**WebhookPayloadCallEndedCallBilling**](WebhookPayloadCallEndedCallBilling.md) | | [optional] |
|
|
@@ -36,6 +38,8 @@ instance = Zernio::WebhookPayloadCallEndedCall.new(
|
|
|
36
38
|
ended_at: null,
|
|
37
39
|
duration_seconds: null,
|
|
38
40
|
end_reason: null,
|
|
41
|
+
hangup_cause: null,
|
|
42
|
+
sip_hangup_cause: null,
|
|
39
43
|
recording_url: null,
|
|
40
44
|
recording_expires_at: null,
|
|
41
45
|
billing: null
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
| **event** | **String** | | |
|
|
9
9
|
| **call** | [**WebhookPayloadCallFailedCall**](WebhookPayloadCallFailedCall.md) | | |
|
|
10
10
|
| **account** | [**InboxWebhookAccount**](InboxWebhookAccount.md) | | |
|
|
11
|
-
| **timestamp** | **Time** |
|
|
11
|
+
| **timestamp** | **Time** | UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt. | |
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
| **event** | **String** | | |
|
|
9
9
|
| **permission** | [**WebhookPayloadCallPermissionRequestPermission**](WebhookPayloadCallPermissionRequestPermission.md) | | |
|
|
10
10
|
| **account** | [**InboxWebhookAccount**](InboxWebhookAccount.md) | | |
|
|
11
|
-
| **timestamp** | **Time** |
|
|
11
|
+
| **timestamp** | **Time** | UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt. | |
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
| **event** | **String** | | |
|
|
9
9
|
| **call** | [**WebhookPayloadCallReceivedCall**](WebhookPayloadCallReceivedCall.md) | | |
|
|
10
10
|
| **account** | [**InboxWebhookAccount**](InboxWebhookAccount.md) | | |
|
|
11
|
-
| **timestamp** | **Time** |
|
|
11
|
+
| **timestamp** | **Time** | UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt. | |
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
| **comment** | [**WebhookPayloadCommentComment**](WebhookPayloadCommentComment.md) | | |
|
|
10
10
|
| **post** | [**WebhookPayloadCommentPost**](WebhookPayloadCommentPost.md) | | |
|
|
11
11
|
| **account** | [**WebhookPayloadCommentAccount**](WebhookPayloadCommentAccount.md) | | |
|
|
12
|
-
| **timestamp** | **Time** |
|
|
12
|
+
| **timestamp** | **Time** | UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt. | |
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
| **username** | **String** | | [optional] |
|
|
9
9
|
| **name** | **String** | | [optional] |
|
|
10
10
|
| **picture** | **String** | | [optional] |
|
|
11
|
+
| **is_own_account** | **Boolean** | True when this comment was authored by the connected account itself (Meta re-delivers the account's own replies as comments events). Populated on the Instagram and Facebook realtime webhooks only; absent means not evaluated, never \"not the account\". | [optional] |
|
|
11
12
|
| **instagram_profile** | [**WebhookPayloadCommentCommentAuthorInstagramProfile**](WebhookPayloadCommentCommentAuthorInstagramProfile.md) | | [optional] |
|
|
12
13
|
|
|
13
14
|
## Example
|
|
@@ -20,6 +21,7 @@ instance = Zernio::WebhookPayloadCommentCommentAuthor.new(
|
|
|
20
21
|
username: null,
|
|
21
22
|
name: null,
|
|
22
23
|
picture: null,
|
|
24
|
+
is_own_account: null,
|
|
23
25
|
instagram_profile: null
|
|
24
26
|
)
|
|
25
27
|
```
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
| **conversation** | [**WebhookPayloadConversationStartedConversation**](WebhookPayloadConversationStartedConversation.md) | | |
|
|
10
10
|
| **account** | [**InboxWebhookAccount**](InboxWebhookAccount.md) | | |
|
|
11
11
|
| **started_at** | **Time** | When the conversation document was created. | |
|
|
12
|
-
| **timestamp** | **Time** |
|
|
12
|
+
| **timestamp** | **Time** | UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt. | |
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
| **event** | **String** | | |
|
|
9
9
|
| **post** | [**ExternalPostWebhookPost**](ExternalPostWebhookPost.md) | | |
|
|
10
10
|
| **account** | [**WebhookPayloadReviewNewAccount**](WebhookPayloadReviewNewAccount.md) | | |
|
|
11
|
-
| **timestamp** | **Time** |
|
|
11
|
+
| **timestamp** | **Time** | UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt. | |
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
data/docs/WebhookPayloadLead.md
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
| **event** | **String** | | |
|
|
9
9
|
| **lead** | [**WebhookPayloadLeadLead**](WebhookPayloadLeadLead.md) | | |
|
|
10
10
|
| **account** | [**WebhookPayloadLeadAccount**](WebhookPayloadLeadAccount.md) | | |
|
|
11
|
-
| **timestamp** | **Time** |
|
|
11
|
+
| **timestamp** | **Time** | UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt. | |
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **conversation** | [**InboxWebhookConversation**](InboxWebhookConversation.md) | | |
|
|
11
11
|
| **account** | [**InboxWebhookAccount**](InboxWebhookAccount.md) | | |
|
|
12
12
|
| **metadata** | [**WebhookPayloadMessageMetadata**](WebhookPayloadMessageMetadata.md) | | [optional] |
|
|
13
|
-
| **timestamp** | **Time** |
|
|
13
|
+
| **timestamp** | **Time** | UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt. | |
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **deleted_at** | **Time** | | |
|
|
11
11
|
| **conversation** | [**InboxWebhookConversation**](InboxWebhookConversation.md) | | |
|
|
12
12
|
| **account** | [**InboxWebhookAccount**](InboxWebhookAccount.md) | | |
|
|
13
|
-
| **timestamp** | **Time** |
|
|
13
|
+
| **timestamp** | **Time** | UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt. | |
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
| **error** | [**WebhookPayloadMessageDeliveryStatusError**](WebhookPayloadMessageDeliveryStatusError.md) | | [optional] |
|
|
12
12
|
| **conversation** | [**InboxWebhookConversation**](InboxWebhookConversation.md) | | |
|
|
13
13
|
| **account** | [**InboxWebhookAccount**](InboxWebhookAccount.md) | | |
|
|
14
|
-
| **timestamp** | **Time** |
|
|
14
|
+
| **timestamp** | **Time** | UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt. | |
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
| **edited_at** | **Time** | When the most recent edit happened. | |
|
|
13
13
|
| **conversation** | [**InboxWebhookConversation**](InboxWebhookConversation.md) | | |
|
|
14
14
|
| **account** | [**InboxWebhookAccount**](InboxWebhookAccount.md) | | |
|
|
15
|
-
| **timestamp** | **Time** |
|
|
15
|
+
| **timestamp** | **Time** | UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt. | |
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
|
@@ -21,6 +21,8 @@
|
|
|
21
21
|
| **story_reply** | [**WebhookPayloadMessageMetadataStoryReply**](WebhookPayloadMessageMetadataStoryReply.md) | | [optional] |
|
|
22
22
|
| **is_story_mention** | **Boolean** | Instagram only. True when the message was generated by an IG user mentioning the account in their own story (`story_mention` attachment type). Mutually exclusive in practice with `storyReply`. | [optional] |
|
|
23
23
|
| **referral** | [**WebhookPayloadMessageMetadataReferral**](WebhookPayloadMessageMetadataReferral.md) | | [optional] |
|
|
24
|
+
| **unsupported** | [**WebhookPayloadMessageMetadataUnsupported**](WebhookPayloadMessageMetadataUnsupported.md) | | [optional] |
|
|
25
|
+
| **no_renderable_content** | **Boolean** | Instagram / Facebook Messenger only. Set when the message carries nothing an integrator can render (a `template` attachment with no text and no parseable content, or Meta's own `is_unsupported` flag). Sibling of `unsupported` above (WhatsApp only, carries Meta's error code/title/details): this field has no error envelope, just the boolean. Absence means \"not flagged\", never \"checked and renderable\". | [optional] |
|
|
24
26
|
|
|
25
27
|
## Example
|
|
26
28
|
|
|
@@ -44,7 +46,9 @@ instance = Zernio::WebhookPayloadMessageMetadata.new(
|
|
|
44
46
|
contacts_origin: null,
|
|
45
47
|
story_reply: null,
|
|
46
48
|
is_story_mention: null,
|
|
47
|
-
referral: null
|
|
49
|
+
referral: null,
|
|
50
|
+
unsupported: null,
|
|
51
|
+
no_renderable_content: null
|
|
48
52
|
)
|
|
49
53
|
```
|
|
50
54
|
|
|
@@ -15,9 +15,10 @@
|
|
|
15
15
|
| **video_url** | **String** | | [optional] |
|
|
16
16
|
| **thumbnail_url** | **String** | | [optional] |
|
|
17
17
|
| **ad_id** | **String** | Facebook Messenger CTM / Instagram CTD only. The Meta ad ID the user clicked to start the conversation. | [optional] |
|
|
18
|
-
| **ref** | **String** |
|
|
19
|
-
| **source** | **String** | Meta-supplied source identifier (
|
|
20
|
-
| **type** | **String** | Meta-supplied referral type (e.g. `OPEN_THREAD`).
|
|
18
|
+
| **ref** | **String** | The `ref` parameter passed through from the Meta ad creative or from an ig.me / m.me link. Instagram / Facebook Messenger only. | [optional] |
|
|
19
|
+
| **source** | **String** | Meta-supplied source identifier (`ADS` for ad clicks; `SHORTLINK`, `SHORTLINKS` or `IGME-SOURCE-LINK` for ref links). Instagram / Facebook Messenger only. | [optional] |
|
|
20
|
+
| **type** | **String** | Meta-supplied referral type (e.g. `OPEN_THREAD`). Instagram / Facebook Messenger only. | [optional] |
|
|
21
|
+
| **referer_uri** | **String** | URI of the originating site, when Meta supplies one (m.me links opened from the web). Facebook Messenger only. | [optional] |
|
|
21
22
|
| **ads_context_data** | [**WebhookPayloadMessageMetadataReferralAdsContextData**](WebhookPayloadMessageMetadataReferralAdsContextData.md) | | [optional] |
|
|
22
23
|
|
|
23
24
|
## Example
|
|
@@ -40,6 +41,7 @@ instance = Zernio::WebhookPayloadMessageMetadataReferral.new(
|
|
|
40
41
|
ref: null,
|
|
41
42
|
source: null,
|
|
42
43
|
type: null,
|
|
44
|
+
referer_uri: null,
|
|
43
45
|
ads_context_data: null
|
|
44
46
|
)
|
|
45
47
|
```
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Zernio::WebhookPayloadMessageMetadataUnsupported
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **code** | **Integer** | Meta's numeric error code (e.g. 131051). | [optional] |
|
|
8
|
+
| **title** | **String** | Meta's short error title. | [optional] |
|
|
9
|
+
| **details** | **String** | Meta's human-readable error detail string. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'zernio-sdk'
|
|
15
|
+
|
|
16
|
+
instance = Zernio::WebhookPayloadMessageMetadataUnsupported.new(
|
|
17
|
+
code: null,
|
|
18
|
+
title: null,
|
|
19
|
+
details: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
| **message** | [**WebhookPayloadMessageSentMessage**](WebhookPayloadMessageSentMessage.md) | | |
|
|
10
10
|
| **conversation** | [**InboxWebhookConversation**](InboxWebhookConversation.md) | | |
|
|
11
11
|
| **account** | [**InboxWebhookAccount**](InboxWebhookAccount.md) | | |
|
|
12
|
-
| **timestamp** | **Time** |
|
|
12
|
+
| **timestamp** | **Time** | UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt. | |
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
data/docs/WebhookPayloadPost.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
| **id** | **String** | Stable webhook event ID | |
|
|
8
8
|
| **event** | **String** | | |
|
|
9
9
|
| **post** | [**WebhookPayloadPostPost**](WebhookPayloadPostPost.md) | | |
|
|
10
|
-
| **timestamp** | **Time** |
|
|
10
|
+
| **timestamp** | **Time** | UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt. | |
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
| **post** | [**WebhookPayloadPostPlatformPost**](WebhookPayloadPostPlatformPost.md) | | |
|
|
10
10
|
| **platform** | [**WebhookPayloadPostPlatformPlatform**](WebhookPayloadPostPlatformPlatform.md) | | |
|
|
11
11
|
| **account** | [**WebhookPayloadPostPlatformAccount**](WebhookPayloadPostPlatformAccount.md) | | |
|
|
12
|
-
| **timestamp** | **Time** |
|
|
12
|
+
| **timestamp** | **Time** | UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt. | |
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
| **reaction** | [**WebhookPayloadReactionReaction**](WebhookPayloadReactionReaction.md) | | |
|
|
10
10
|
| **conversation** | [**InboxWebhookConversation**](InboxWebhookConversation.md) | | |
|
|
11
11
|
| **account** | [**InboxWebhookAccount**](InboxWebhookAccount.md) | | |
|
|
12
|
-
| **timestamp** | **Time** |
|
|
12
|
+
| **timestamp** | **Time** | UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt. | |
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Zernio::WebhookPayloadReferral
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Stable webhook event ID | |
|
|
8
|
+
| **event** | **String** | | |
|
|
9
|
+
| **referral** | [**WebhookPayloadReferralReferral**](WebhookPayloadReferralReferral.md) | | |
|
|
10
|
+
| **sender** | [**WebhookPayloadReferralSender**](WebhookPayloadReferralSender.md) | | |
|
|
11
|
+
| **conversation** | [**InboxWebhookConversation**](InboxWebhookConversation.md) | | |
|
|
12
|
+
| **account** | [**InboxWebhookAccount**](InboxWebhookAccount.md) | | |
|
|
13
|
+
| **timestamp** | **Time** | UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt. | |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'zernio-sdk'
|
|
19
|
+
|
|
20
|
+
instance = Zernio::WebhookPayloadReferral.new(
|
|
21
|
+
id: null,
|
|
22
|
+
event: null,
|
|
23
|
+
referral: null,
|
|
24
|
+
sender: null,
|
|
25
|
+
conversation: null,
|
|
26
|
+
account: null,
|
|
27
|
+
timestamp: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|