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/BlogsApi.md
ADDED
|
@@ -0,0 +1,747 @@
|
|
|
1
|
+
# Zernio::BlogsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://zernio.com/api*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**create_blog**](BlogsApi.md#create_blog) | **POST** /v1/accounts/{accountId}/blogs | Create a blog |
|
|
8
|
+
| [**create_blog_article**](BlogsApi.md#create_blog_article) | **POST** /v1/accounts/{accountId}/blogs/{blogId}/articles | Create a blog article |
|
|
9
|
+
| [**delete_blog**](BlogsApi.md#delete_blog) | **DELETE** /v1/accounts/{accountId}/blogs/{blogId} | Delete a blog |
|
|
10
|
+
| [**delete_blog_article**](BlogsApi.md#delete_blog_article) | **DELETE** /v1/accounts/{accountId}/blogs/{blogId}/articles/{articleId} | Delete a blog article |
|
|
11
|
+
| [**get_blog**](BlogsApi.md#get_blog) | **GET** /v1/accounts/{accountId}/blogs/{blogId} | Get a blog |
|
|
12
|
+
| [**get_blog_article**](BlogsApi.md#get_blog_article) | **GET** /v1/accounts/{accountId}/blogs/{blogId}/articles/{articleId} | Get a blog article |
|
|
13
|
+
| [**list_blog_articles**](BlogsApi.md#list_blog_articles) | **GET** /v1/accounts/{accountId}/blogs/{blogId}/articles | List blog articles |
|
|
14
|
+
| [**list_blogs**](BlogsApi.md#list_blogs) | **GET** /v1/accounts/{accountId}/blogs | List blogs |
|
|
15
|
+
| [**update_blog**](BlogsApi.md#update_blog) | **PATCH** /v1/accounts/{accountId}/blogs/{blogId} | Update a blog |
|
|
16
|
+
| [**update_blog_article**](BlogsApi.md#update_blog_article) | **PATCH** /v1/accounts/{accountId}/blogs/{blogId}/articles/{articleId} | Update a blog article |
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
## create_blog
|
|
20
|
+
|
|
21
|
+
> <CreateBlog201Response> create_blog(account_id, create_blog_request)
|
|
22
|
+
|
|
23
|
+
Create a blog
|
|
24
|
+
|
|
25
|
+
Creates a blog on the connected store. The platform generates the URL `handle` from the title when omitted. Supported on Shopify (platform `shopify`). Accounts on platforms without blogs support return 400; a blogs-capable platform that lacks this specific operation returns 405.
|
|
26
|
+
|
|
27
|
+
### Examples
|
|
28
|
+
|
|
29
|
+
```ruby
|
|
30
|
+
require 'time'
|
|
31
|
+
require 'zernio-sdk'
|
|
32
|
+
# setup authorization
|
|
33
|
+
Zernio.configure do |config|
|
|
34
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
35
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
api_instance = Zernio::BlogsApi.new
|
|
39
|
+
account_id = 'account_id_example' # String | Connected Shopify SocialAccount id.
|
|
40
|
+
create_blog_request = Zernio::CreateBlogRequest.new({title: 'title_example'}) # CreateBlogRequest |
|
|
41
|
+
|
|
42
|
+
begin
|
|
43
|
+
# Create a blog
|
|
44
|
+
result = api_instance.create_blog(account_id, create_blog_request)
|
|
45
|
+
p result
|
|
46
|
+
rescue Zernio::ApiError => e
|
|
47
|
+
puts "Error when calling BlogsApi->create_blog: #{e}"
|
|
48
|
+
end
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
#### Using the create_blog_with_http_info variant
|
|
52
|
+
|
|
53
|
+
This returns an Array which contains the response data, status code and headers.
|
|
54
|
+
|
|
55
|
+
> <Array(<CreateBlog201Response>, Integer, Hash)> create_blog_with_http_info(account_id, create_blog_request)
|
|
56
|
+
|
|
57
|
+
```ruby
|
|
58
|
+
begin
|
|
59
|
+
# Create a blog
|
|
60
|
+
data, status_code, headers = api_instance.create_blog_with_http_info(account_id, create_blog_request)
|
|
61
|
+
p status_code # => 2xx
|
|
62
|
+
p headers # => { ... }
|
|
63
|
+
p data # => <CreateBlog201Response>
|
|
64
|
+
rescue Zernio::ApiError => e
|
|
65
|
+
puts "Error when calling BlogsApi->create_blog_with_http_info: #{e}"
|
|
66
|
+
end
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Parameters
|
|
70
|
+
|
|
71
|
+
| Name | Type | Description | Notes |
|
|
72
|
+
| ---- | ---- | ----------- | ----- |
|
|
73
|
+
| **account_id** | **String** | Connected Shopify SocialAccount id. | |
|
|
74
|
+
| **create_blog_request** | [**CreateBlogRequest**](CreateBlogRequest.md) | | |
|
|
75
|
+
|
|
76
|
+
### Return type
|
|
77
|
+
|
|
78
|
+
[**CreateBlog201Response**](CreateBlog201Response.md)
|
|
79
|
+
|
|
80
|
+
### Authorization
|
|
81
|
+
|
|
82
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
83
|
+
|
|
84
|
+
### HTTP request headers
|
|
85
|
+
|
|
86
|
+
- **Content-Type**: application/json
|
|
87
|
+
- **Accept**: application/json
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
## create_blog_article
|
|
91
|
+
|
|
92
|
+
> <CreateBlogArticle201Response> create_blog_article(account_id, blog_id, create_blog_article_request)
|
|
93
|
+
|
|
94
|
+
Create a blog article
|
|
95
|
+
|
|
96
|
+
Creates an article on the blog. Publishing behavior: - `isPublished: false` keeps the article as a draft. - A future `publishDate` schedules publication natively on the platform; the platform publishes it at that time with no Zernio queue involved. - `seo.title` / `seo.description` map to Shopify's global `title_tag` and `description_tag` metafields (the fields Shopify themes read for the page title and meta description). Supported on Shopify (platform `shopify`). Accounts on platforms without blogs support return 400; a blogs-capable platform that lacks this specific operation returns 405.
|
|
97
|
+
|
|
98
|
+
### Examples
|
|
99
|
+
|
|
100
|
+
```ruby
|
|
101
|
+
require 'time'
|
|
102
|
+
require 'zernio-sdk'
|
|
103
|
+
# setup authorization
|
|
104
|
+
Zernio.configure do |config|
|
|
105
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
106
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
api_instance = Zernio::BlogsApi.new
|
|
110
|
+
account_id = 'account_id_example' # String | Connected Shopify SocialAccount id.
|
|
111
|
+
blog_id = 'blog_id_example' # String | Platform-native numeric blog id. Non-numeric values return 400.
|
|
112
|
+
create_blog_article_request = Zernio::CreateBlogArticleRequest.new({title: 'title_example'}) # CreateBlogArticleRequest |
|
|
113
|
+
|
|
114
|
+
begin
|
|
115
|
+
# Create a blog article
|
|
116
|
+
result = api_instance.create_blog_article(account_id, blog_id, create_blog_article_request)
|
|
117
|
+
p result
|
|
118
|
+
rescue Zernio::ApiError => e
|
|
119
|
+
puts "Error when calling BlogsApi->create_blog_article: #{e}"
|
|
120
|
+
end
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
#### Using the create_blog_article_with_http_info variant
|
|
124
|
+
|
|
125
|
+
This returns an Array which contains the response data, status code and headers.
|
|
126
|
+
|
|
127
|
+
> <Array(<CreateBlogArticle201Response>, Integer, Hash)> create_blog_article_with_http_info(account_id, blog_id, create_blog_article_request)
|
|
128
|
+
|
|
129
|
+
```ruby
|
|
130
|
+
begin
|
|
131
|
+
# Create a blog article
|
|
132
|
+
data, status_code, headers = api_instance.create_blog_article_with_http_info(account_id, blog_id, create_blog_article_request)
|
|
133
|
+
p status_code # => 2xx
|
|
134
|
+
p headers # => { ... }
|
|
135
|
+
p data # => <CreateBlogArticle201Response>
|
|
136
|
+
rescue Zernio::ApiError => e
|
|
137
|
+
puts "Error when calling BlogsApi->create_blog_article_with_http_info: #{e}"
|
|
138
|
+
end
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
### Parameters
|
|
142
|
+
|
|
143
|
+
| Name | Type | Description | Notes |
|
|
144
|
+
| ---- | ---- | ----------- | ----- |
|
|
145
|
+
| **account_id** | **String** | Connected Shopify SocialAccount id. | |
|
|
146
|
+
| **blog_id** | **String** | Platform-native numeric blog id. Non-numeric values return 400. | |
|
|
147
|
+
| **create_blog_article_request** | [**CreateBlogArticleRequest**](CreateBlogArticleRequest.md) | | |
|
|
148
|
+
|
|
149
|
+
### Return type
|
|
150
|
+
|
|
151
|
+
[**CreateBlogArticle201Response**](CreateBlogArticle201Response.md)
|
|
152
|
+
|
|
153
|
+
### Authorization
|
|
154
|
+
|
|
155
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
156
|
+
|
|
157
|
+
### HTTP request headers
|
|
158
|
+
|
|
159
|
+
- **Content-Type**: application/json
|
|
160
|
+
- **Accept**: application/json
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
## delete_blog
|
|
164
|
+
|
|
165
|
+
> delete_blog(account_id, blog_id)
|
|
166
|
+
|
|
167
|
+
Delete a blog
|
|
168
|
+
|
|
169
|
+
Deletes the blog AND every article in it. The delete happens on the platform and is permanent; Zernio stores nothing to restore it from. Supported on Shopify (platform `shopify`). Accounts on platforms without blogs support return 400; a blogs-capable platform that lacks this specific operation returns 405.
|
|
170
|
+
|
|
171
|
+
### Examples
|
|
172
|
+
|
|
173
|
+
```ruby
|
|
174
|
+
require 'time'
|
|
175
|
+
require 'zernio-sdk'
|
|
176
|
+
# setup authorization
|
|
177
|
+
Zernio.configure do |config|
|
|
178
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
179
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
180
|
+
end
|
|
181
|
+
|
|
182
|
+
api_instance = Zernio::BlogsApi.new
|
|
183
|
+
account_id = 'account_id_example' # String | Connected Shopify SocialAccount id.
|
|
184
|
+
blog_id = 'blog_id_example' # String | Platform-native numeric blog id. Non-numeric values return 400.
|
|
185
|
+
|
|
186
|
+
begin
|
|
187
|
+
# Delete a blog
|
|
188
|
+
api_instance.delete_blog(account_id, blog_id)
|
|
189
|
+
rescue Zernio::ApiError => e
|
|
190
|
+
puts "Error when calling BlogsApi->delete_blog: #{e}"
|
|
191
|
+
end
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
#### Using the delete_blog_with_http_info variant
|
|
195
|
+
|
|
196
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
197
|
+
|
|
198
|
+
> <Array(nil, Integer, Hash)> delete_blog_with_http_info(account_id, blog_id)
|
|
199
|
+
|
|
200
|
+
```ruby
|
|
201
|
+
begin
|
|
202
|
+
# Delete a blog
|
|
203
|
+
data, status_code, headers = api_instance.delete_blog_with_http_info(account_id, blog_id)
|
|
204
|
+
p status_code # => 2xx
|
|
205
|
+
p headers # => { ... }
|
|
206
|
+
p data # => nil
|
|
207
|
+
rescue Zernio::ApiError => e
|
|
208
|
+
puts "Error when calling BlogsApi->delete_blog_with_http_info: #{e}"
|
|
209
|
+
end
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
### Parameters
|
|
213
|
+
|
|
214
|
+
| Name | Type | Description | Notes |
|
|
215
|
+
| ---- | ---- | ----------- | ----- |
|
|
216
|
+
| **account_id** | **String** | Connected Shopify SocialAccount id. | |
|
|
217
|
+
| **blog_id** | **String** | Platform-native numeric blog id. Non-numeric values return 400. | |
|
|
218
|
+
|
|
219
|
+
### Return type
|
|
220
|
+
|
|
221
|
+
nil (empty response body)
|
|
222
|
+
|
|
223
|
+
### Authorization
|
|
224
|
+
|
|
225
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
226
|
+
|
|
227
|
+
### HTTP request headers
|
|
228
|
+
|
|
229
|
+
- **Content-Type**: Not defined
|
|
230
|
+
- **Accept**: application/json
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
## delete_blog_article
|
|
234
|
+
|
|
235
|
+
> delete_blog_article(account_id, blog_id, article_id)
|
|
236
|
+
|
|
237
|
+
Delete a blog article
|
|
238
|
+
|
|
239
|
+
Deletes the article. The delete happens on the platform and is permanent; Zernio stores nothing to restore it from. Supported on Shopify (platform `shopify`). Accounts on platforms without blogs support return 400; a blogs-capable platform that lacks this specific operation returns 405.
|
|
240
|
+
|
|
241
|
+
### Examples
|
|
242
|
+
|
|
243
|
+
```ruby
|
|
244
|
+
require 'time'
|
|
245
|
+
require 'zernio-sdk'
|
|
246
|
+
# setup authorization
|
|
247
|
+
Zernio.configure do |config|
|
|
248
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
249
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
250
|
+
end
|
|
251
|
+
|
|
252
|
+
api_instance = Zernio::BlogsApi.new
|
|
253
|
+
account_id = 'account_id_example' # String | Connected Shopify SocialAccount id.
|
|
254
|
+
blog_id = 'blog_id_example' # String | Platform-native numeric blog id. Non-numeric values return 400.
|
|
255
|
+
article_id = 'article_id_example' # String | Platform-native numeric article id. Non-numeric values return 400.
|
|
256
|
+
|
|
257
|
+
begin
|
|
258
|
+
# Delete a blog article
|
|
259
|
+
api_instance.delete_blog_article(account_id, blog_id, article_id)
|
|
260
|
+
rescue Zernio::ApiError => e
|
|
261
|
+
puts "Error when calling BlogsApi->delete_blog_article: #{e}"
|
|
262
|
+
end
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
#### Using the delete_blog_article_with_http_info variant
|
|
266
|
+
|
|
267
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
268
|
+
|
|
269
|
+
> <Array(nil, Integer, Hash)> delete_blog_article_with_http_info(account_id, blog_id, article_id)
|
|
270
|
+
|
|
271
|
+
```ruby
|
|
272
|
+
begin
|
|
273
|
+
# Delete a blog article
|
|
274
|
+
data, status_code, headers = api_instance.delete_blog_article_with_http_info(account_id, blog_id, article_id)
|
|
275
|
+
p status_code # => 2xx
|
|
276
|
+
p headers # => { ... }
|
|
277
|
+
p data # => nil
|
|
278
|
+
rescue Zernio::ApiError => e
|
|
279
|
+
puts "Error when calling BlogsApi->delete_blog_article_with_http_info: #{e}"
|
|
280
|
+
end
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
### Parameters
|
|
284
|
+
|
|
285
|
+
| Name | Type | Description | Notes |
|
|
286
|
+
| ---- | ---- | ----------- | ----- |
|
|
287
|
+
| **account_id** | **String** | Connected Shopify SocialAccount id. | |
|
|
288
|
+
| **blog_id** | **String** | Platform-native numeric blog id. Non-numeric values return 400. | |
|
|
289
|
+
| **article_id** | **String** | Platform-native numeric article id. Non-numeric values return 400. | |
|
|
290
|
+
|
|
291
|
+
### Return type
|
|
292
|
+
|
|
293
|
+
nil (empty response body)
|
|
294
|
+
|
|
295
|
+
### Authorization
|
|
296
|
+
|
|
297
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
298
|
+
|
|
299
|
+
### HTTP request headers
|
|
300
|
+
|
|
301
|
+
- **Content-Type**: Not defined
|
|
302
|
+
- **Accept**: application/json
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
## get_blog
|
|
306
|
+
|
|
307
|
+
> <CreateBlog201Response> get_blog(account_id, blog_id)
|
|
308
|
+
|
|
309
|
+
Get a blog
|
|
310
|
+
|
|
311
|
+
Fetches a single blog. `blogId` is the platform's numeric blog id from `GET /v1/accounts/{accountId}/blogs`, not a Zernio id. Supported on Shopify (platform `shopify`). Accounts on platforms without blogs support return 400; a blogs-capable platform that lacks this specific operation returns 405.
|
|
312
|
+
|
|
313
|
+
### Examples
|
|
314
|
+
|
|
315
|
+
```ruby
|
|
316
|
+
require 'time'
|
|
317
|
+
require 'zernio-sdk'
|
|
318
|
+
# setup authorization
|
|
319
|
+
Zernio.configure do |config|
|
|
320
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
321
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
322
|
+
end
|
|
323
|
+
|
|
324
|
+
api_instance = Zernio::BlogsApi.new
|
|
325
|
+
account_id = 'account_id_example' # String | Connected Shopify SocialAccount id.
|
|
326
|
+
blog_id = 'blog_id_example' # String | Platform-native numeric blog id. Non-numeric values return 400.
|
|
327
|
+
|
|
328
|
+
begin
|
|
329
|
+
# Get a blog
|
|
330
|
+
result = api_instance.get_blog(account_id, blog_id)
|
|
331
|
+
p result
|
|
332
|
+
rescue Zernio::ApiError => e
|
|
333
|
+
puts "Error when calling BlogsApi->get_blog: #{e}"
|
|
334
|
+
end
|
|
335
|
+
```
|
|
336
|
+
|
|
337
|
+
#### Using the get_blog_with_http_info variant
|
|
338
|
+
|
|
339
|
+
This returns an Array which contains the response data, status code and headers.
|
|
340
|
+
|
|
341
|
+
> <Array(<CreateBlog201Response>, Integer, Hash)> get_blog_with_http_info(account_id, blog_id)
|
|
342
|
+
|
|
343
|
+
```ruby
|
|
344
|
+
begin
|
|
345
|
+
# Get a blog
|
|
346
|
+
data, status_code, headers = api_instance.get_blog_with_http_info(account_id, blog_id)
|
|
347
|
+
p status_code # => 2xx
|
|
348
|
+
p headers # => { ... }
|
|
349
|
+
p data # => <CreateBlog201Response>
|
|
350
|
+
rescue Zernio::ApiError => e
|
|
351
|
+
puts "Error when calling BlogsApi->get_blog_with_http_info: #{e}"
|
|
352
|
+
end
|
|
353
|
+
```
|
|
354
|
+
|
|
355
|
+
### Parameters
|
|
356
|
+
|
|
357
|
+
| Name | Type | Description | Notes |
|
|
358
|
+
| ---- | ---- | ----------- | ----- |
|
|
359
|
+
| **account_id** | **String** | Connected Shopify SocialAccount id. | |
|
|
360
|
+
| **blog_id** | **String** | Platform-native numeric blog id. Non-numeric values return 400. | |
|
|
361
|
+
|
|
362
|
+
### Return type
|
|
363
|
+
|
|
364
|
+
[**CreateBlog201Response**](CreateBlog201Response.md)
|
|
365
|
+
|
|
366
|
+
### Authorization
|
|
367
|
+
|
|
368
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
369
|
+
|
|
370
|
+
### HTTP request headers
|
|
371
|
+
|
|
372
|
+
- **Content-Type**: Not defined
|
|
373
|
+
- **Accept**: application/json
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
## get_blog_article
|
|
377
|
+
|
|
378
|
+
> <CreateBlogArticle201Response> get_blog_article(account_id, blog_id, article_id)
|
|
379
|
+
|
|
380
|
+
Get a blog article
|
|
381
|
+
|
|
382
|
+
Fetches a single article. An article addressed through a blog it does not belong to is a 404 (code blog_article_not_found). Supported on Shopify (platform `shopify`). Accounts on platforms without blogs support return 400; a blogs-capable platform that lacks this specific operation returns 405.
|
|
383
|
+
|
|
384
|
+
### Examples
|
|
385
|
+
|
|
386
|
+
```ruby
|
|
387
|
+
require 'time'
|
|
388
|
+
require 'zernio-sdk'
|
|
389
|
+
# setup authorization
|
|
390
|
+
Zernio.configure do |config|
|
|
391
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
392
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
393
|
+
end
|
|
394
|
+
|
|
395
|
+
api_instance = Zernio::BlogsApi.new
|
|
396
|
+
account_id = 'account_id_example' # String | Connected Shopify SocialAccount id.
|
|
397
|
+
blog_id = 'blog_id_example' # String | Platform-native numeric blog id. Non-numeric values return 400.
|
|
398
|
+
article_id = 'article_id_example' # String | Platform-native numeric article id. Non-numeric values return 400.
|
|
399
|
+
|
|
400
|
+
begin
|
|
401
|
+
# Get a blog article
|
|
402
|
+
result = api_instance.get_blog_article(account_id, blog_id, article_id)
|
|
403
|
+
p result
|
|
404
|
+
rescue Zernio::ApiError => e
|
|
405
|
+
puts "Error when calling BlogsApi->get_blog_article: #{e}"
|
|
406
|
+
end
|
|
407
|
+
```
|
|
408
|
+
|
|
409
|
+
#### Using the get_blog_article_with_http_info variant
|
|
410
|
+
|
|
411
|
+
This returns an Array which contains the response data, status code and headers.
|
|
412
|
+
|
|
413
|
+
> <Array(<CreateBlogArticle201Response>, Integer, Hash)> get_blog_article_with_http_info(account_id, blog_id, article_id)
|
|
414
|
+
|
|
415
|
+
```ruby
|
|
416
|
+
begin
|
|
417
|
+
# Get a blog article
|
|
418
|
+
data, status_code, headers = api_instance.get_blog_article_with_http_info(account_id, blog_id, article_id)
|
|
419
|
+
p status_code # => 2xx
|
|
420
|
+
p headers # => { ... }
|
|
421
|
+
p data # => <CreateBlogArticle201Response>
|
|
422
|
+
rescue Zernio::ApiError => e
|
|
423
|
+
puts "Error when calling BlogsApi->get_blog_article_with_http_info: #{e}"
|
|
424
|
+
end
|
|
425
|
+
```
|
|
426
|
+
|
|
427
|
+
### Parameters
|
|
428
|
+
|
|
429
|
+
| Name | Type | Description | Notes |
|
|
430
|
+
| ---- | ---- | ----------- | ----- |
|
|
431
|
+
| **account_id** | **String** | Connected Shopify SocialAccount id. | |
|
|
432
|
+
| **blog_id** | **String** | Platform-native numeric blog id. Non-numeric values return 400. | |
|
|
433
|
+
| **article_id** | **String** | Platform-native numeric article id. Non-numeric values return 400. | |
|
|
434
|
+
|
|
435
|
+
### Return type
|
|
436
|
+
|
|
437
|
+
[**CreateBlogArticle201Response**](CreateBlogArticle201Response.md)
|
|
438
|
+
|
|
439
|
+
### Authorization
|
|
440
|
+
|
|
441
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
442
|
+
|
|
443
|
+
### HTTP request headers
|
|
444
|
+
|
|
445
|
+
- **Content-Type**: Not defined
|
|
446
|
+
- **Accept**: application/json
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
## list_blog_articles
|
|
450
|
+
|
|
451
|
+
> <ListBlogArticles200Response> list_blog_articles(account_id, blog_id, opts)
|
|
452
|
+
|
|
453
|
+
List blog articles
|
|
454
|
+
|
|
455
|
+
Lists the articles of a blog. Cursor-paginated: pass `limit` (1-50, default 20) and the `cursor` from a previous response's `nextCursor`; `nextCursor` is null when there are no more pages. Supported on Shopify (platform `shopify`). Accounts on platforms without blogs support return 400; a blogs-capable platform that lacks this specific operation returns 405.
|
|
456
|
+
|
|
457
|
+
### Examples
|
|
458
|
+
|
|
459
|
+
```ruby
|
|
460
|
+
require 'time'
|
|
461
|
+
require 'zernio-sdk'
|
|
462
|
+
# setup authorization
|
|
463
|
+
Zernio.configure do |config|
|
|
464
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
465
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
466
|
+
end
|
|
467
|
+
|
|
468
|
+
api_instance = Zernio::BlogsApi.new
|
|
469
|
+
account_id = 'account_id_example' # String | Connected Shopify SocialAccount id.
|
|
470
|
+
blog_id = 'blog_id_example' # String | Platform-native numeric blog id. Non-numeric values return 400.
|
|
471
|
+
opts = {
|
|
472
|
+
limit: 56, # Integer | Page size (1-50).
|
|
473
|
+
cursor: 'cursor_example' # String | Opaque cursor from a previous response. Omit for the first page.
|
|
474
|
+
}
|
|
475
|
+
|
|
476
|
+
begin
|
|
477
|
+
# List blog articles
|
|
478
|
+
result = api_instance.list_blog_articles(account_id, blog_id, opts)
|
|
479
|
+
p result
|
|
480
|
+
rescue Zernio::ApiError => e
|
|
481
|
+
puts "Error when calling BlogsApi->list_blog_articles: #{e}"
|
|
482
|
+
end
|
|
483
|
+
```
|
|
484
|
+
|
|
485
|
+
#### Using the list_blog_articles_with_http_info variant
|
|
486
|
+
|
|
487
|
+
This returns an Array which contains the response data, status code and headers.
|
|
488
|
+
|
|
489
|
+
> <Array(<ListBlogArticles200Response>, Integer, Hash)> list_blog_articles_with_http_info(account_id, blog_id, opts)
|
|
490
|
+
|
|
491
|
+
```ruby
|
|
492
|
+
begin
|
|
493
|
+
# List blog articles
|
|
494
|
+
data, status_code, headers = api_instance.list_blog_articles_with_http_info(account_id, blog_id, opts)
|
|
495
|
+
p status_code # => 2xx
|
|
496
|
+
p headers # => { ... }
|
|
497
|
+
p data # => <ListBlogArticles200Response>
|
|
498
|
+
rescue Zernio::ApiError => e
|
|
499
|
+
puts "Error when calling BlogsApi->list_blog_articles_with_http_info: #{e}"
|
|
500
|
+
end
|
|
501
|
+
```
|
|
502
|
+
|
|
503
|
+
### Parameters
|
|
504
|
+
|
|
505
|
+
| Name | Type | Description | Notes |
|
|
506
|
+
| ---- | ---- | ----------- | ----- |
|
|
507
|
+
| **account_id** | **String** | Connected Shopify SocialAccount id. | |
|
|
508
|
+
| **blog_id** | **String** | Platform-native numeric blog id. Non-numeric values return 400. | |
|
|
509
|
+
| **limit** | **Integer** | Page size (1-50). | [optional][default to 20] |
|
|
510
|
+
| **cursor** | **String** | Opaque cursor from a previous response. Omit for the first page. | [optional] |
|
|
511
|
+
|
|
512
|
+
### Return type
|
|
513
|
+
|
|
514
|
+
[**ListBlogArticles200Response**](ListBlogArticles200Response.md)
|
|
515
|
+
|
|
516
|
+
### Authorization
|
|
517
|
+
|
|
518
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
519
|
+
|
|
520
|
+
### HTTP request headers
|
|
521
|
+
|
|
522
|
+
- **Content-Type**: Not defined
|
|
523
|
+
- **Accept**: application/json
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
## list_blogs
|
|
527
|
+
|
|
528
|
+
> <ListBlogs200Response> list_blogs(account_id, opts)
|
|
529
|
+
|
|
530
|
+
List blogs
|
|
531
|
+
|
|
532
|
+
Lists the blogs on the connected store, newest-first as the platform returns them. Cursor-paginated: pass `limit` (1-50, default 20) and the `cursor` from a previous response's `nextCursor`; `nextCursor` is null when there are no more pages. Supported on Shopify (platform `shopify`). Accounts on platforms without blogs support return 400; a blogs-capable platform that lacks this specific operation returns 405.
|
|
533
|
+
|
|
534
|
+
### Examples
|
|
535
|
+
|
|
536
|
+
```ruby
|
|
537
|
+
require 'time'
|
|
538
|
+
require 'zernio-sdk'
|
|
539
|
+
# setup authorization
|
|
540
|
+
Zernio.configure do |config|
|
|
541
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
542
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
543
|
+
end
|
|
544
|
+
|
|
545
|
+
api_instance = Zernio::BlogsApi.new
|
|
546
|
+
account_id = 'account_id_example' # String | Connected Shopify SocialAccount id.
|
|
547
|
+
opts = {
|
|
548
|
+
limit: 56, # Integer | Page size (1-50).
|
|
549
|
+
cursor: 'cursor_example' # String | Opaque cursor from a previous response. Omit for the first page.
|
|
550
|
+
}
|
|
551
|
+
|
|
552
|
+
begin
|
|
553
|
+
# List blogs
|
|
554
|
+
result = api_instance.list_blogs(account_id, opts)
|
|
555
|
+
p result
|
|
556
|
+
rescue Zernio::ApiError => e
|
|
557
|
+
puts "Error when calling BlogsApi->list_blogs: #{e}"
|
|
558
|
+
end
|
|
559
|
+
```
|
|
560
|
+
|
|
561
|
+
#### Using the list_blogs_with_http_info variant
|
|
562
|
+
|
|
563
|
+
This returns an Array which contains the response data, status code and headers.
|
|
564
|
+
|
|
565
|
+
> <Array(<ListBlogs200Response>, Integer, Hash)> list_blogs_with_http_info(account_id, opts)
|
|
566
|
+
|
|
567
|
+
```ruby
|
|
568
|
+
begin
|
|
569
|
+
# List blogs
|
|
570
|
+
data, status_code, headers = api_instance.list_blogs_with_http_info(account_id, opts)
|
|
571
|
+
p status_code # => 2xx
|
|
572
|
+
p headers # => { ... }
|
|
573
|
+
p data # => <ListBlogs200Response>
|
|
574
|
+
rescue Zernio::ApiError => e
|
|
575
|
+
puts "Error when calling BlogsApi->list_blogs_with_http_info: #{e}"
|
|
576
|
+
end
|
|
577
|
+
```
|
|
578
|
+
|
|
579
|
+
### Parameters
|
|
580
|
+
|
|
581
|
+
| Name | Type | Description | Notes |
|
|
582
|
+
| ---- | ---- | ----------- | ----- |
|
|
583
|
+
| **account_id** | **String** | Connected Shopify SocialAccount id. | |
|
|
584
|
+
| **limit** | **Integer** | Page size (1-50). | [optional][default to 20] |
|
|
585
|
+
| **cursor** | **String** | Opaque cursor from a previous response. Omit for the first page. | [optional] |
|
|
586
|
+
|
|
587
|
+
### Return type
|
|
588
|
+
|
|
589
|
+
[**ListBlogs200Response**](ListBlogs200Response.md)
|
|
590
|
+
|
|
591
|
+
### Authorization
|
|
592
|
+
|
|
593
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
594
|
+
|
|
595
|
+
### HTTP request headers
|
|
596
|
+
|
|
597
|
+
- **Content-Type**: Not defined
|
|
598
|
+
- **Accept**: application/json
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
## update_blog
|
|
602
|
+
|
|
603
|
+
> <CreateBlog201Response> update_blog(account_id, blog_id, update_blog_request)
|
|
604
|
+
|
|
605
|
+
Update a blog
|
|
606
|
+
|
|
607
|
+
Partial-updates a blog. Send any subset of `title` and `handle`; at least one field is required (an empty body returns 400). Supported on Shopify (platform `shopify`). Accounts on platforms without blogs support return 400; a blogs-capable platform that lacks this specific operation returns 405.
|
|
608
|
+
|
|
609
|
+
### Examples
|
|
610
|
+
|
|
611
|
+
```ruby
|
|
612
|
+
require 'time'
|
|
613
|
+
require 'zernio-sdk'
|
|
614
|
+
# setup authorization
|
|
615
|
+
Zernio.configure do |config|
|
|
616
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
617
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
618
|
+
end
|
|
619
|
+
|
|
620
|
+
api_instance = Zernio::BlogsApi.new
|
|
621
|
+
account_id = 'account_id_example' # String | Connected Shopify SocialAccount id.
|
|
622
|
+
blog_id = 'blog_id_example' # String | Platform-native numeric blog id. Non-numeric values return 400.
|
|
623
|
+
update_blog_request = Zernio::UpdateBlogRequest.new # UpdateBlogRequest |
|
|
624
|
+
|
|
625
|
+
begin
|
|
626
|
+
# Update a blog
|
|
627
|
+
result = api_instance.update_blog(account_id, blog_id, update_blog_request)
|
|
628
|
+
p result
|
|
629
|
+
rescue Zernio::ApiError => e
|
|
630
|
+
puts "Error when calling BlogsApi->update_blog: #{e}"
|
|
631
|
+
end
|
|
632
|
+
```
|
|
633
|
+
|
|
634
|
+
#### Using the update_blog_with_http_info variant
|
|
635
|
+
|
|
636
|
+
This returns an Array which contains the response data, status code and headers.
|
|
637
|
+
|
|
638
|
+
> <Array(<CreateBlog201Response>, Integer, Hash)> update_blog_with_http_info(account_id, blog_id, update_blog_request)
|
|
639
|
+
|
|
640
|
+
```ruby
|
|
641
|
+
begin
|
|
642
|
+
# Update a blog
|
|
643
|
+
data, status_code, headers = api_instance.update_blog_with_http_info(account_id, blog_id, update_blog_request)
|
|
644
|
+
p status_code # => 2xx
|
|
645
|
+
p headers # => { ... }
|
|
646
|
+
p data # => <CreateBlog201Response>
|
|
647
|
+
rescue Zernio::ApiError => e
|
|
648
|
+
puts "Error when calling BlogsApi->update_blog_with_http_info: #{e}"
|
|
649
|
+
end
|
|
650
|
+
```
|
|
651
|
+
|
|
652
|
+
### Parameters
|
|
653
|
+
|
|
654
|
+
| Name | Type | Description | Notes |
|
|
655
|
+
| ---- | ---- | ----------- | ----- |
|
|
656
|
+
| **account_id** | **String** | Connected Shopify SocialAccount id. | |
|
|
657
|
+
| **blog_id** | **String** | Platform-native numeric blog id. Non-numeric values return 400. | |
|
|
658
|
+
| **update_blog_request** | [**UpdateBlogRequest**](UpdateBlogRequest.md) | | |
|
|
659
|
+
|
|
660
|
+
### Return type
|
|
661
|
+
|
|
662
|
+
[**CreateBlog201Response**](CreateBlog201Response.md)
|
|
663
|
+
|
|
664
|
+
### Authorization
|
|
665
|
+
|
|
666
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
667
|
+
|
|
668
|
+
### HTTP request headers
|
|
669
|
+
|
|
670
|
+
- **Content-Type**: application/json
|
|
671
|
+
- **Accept**: application/json
|
|
672
|
+
|
|
673
|
+
|
|
674
|
+
## update_blog_article
|
|
675
|
+
|
|
676
|
+
> <CreateBlogArticle201Response> update_blog_article(account_id, blog_id, article_id, update_blog_article_request)
|
|
677
|
+
|
|
678
|
+
Update a blog article
|
|
679
|
+
|
|
680
|
+
Partial-updates an article. Send any subset of the create fields (`title`, `bodyHtml`, `handle`, `tags`, `author`, `excerpt`, `image`, `seo`, `isPublished`, `publishDate`); at least one field is required (an empty body returns 400). `isPublished` and `publishDate` behave as on create: `isPublished: false` unpublishes back to a draft and a future `publishDate` schedules publication natively on the platform. Supported on Shopify (platform `shopify`). Accounts on platforms without blogs support return 400; a blogs-capable platform that lacks this specific operation returns 405.
|
|
681
|
+
|
|
682
|
+
### Examples
|
|
683
|
+
|
|
684
|
+
```ruby
|
|
685
|
+
require 'time'
|
|
686
|
+
require 'zernio-sdk'
|
|
687
|
+
# setup authorization
|
|
688
|
+
Zernio.configure do |config|
|
|
689
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
690
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
691
|
+
end
|
|
692
|
+
|
|
693
|
+
api_instance = Zernio::BlogsApi.new
|
|
694
|
+
account_id = 'account_id_example' # String | Connected Shopify SocialAccount id.
|
|
695
|
+
blog_id = 'blog_id_example' # String | Platform-native numeric blog id. Non-numeric values return 400.
|
|
696
|
+
article_id = 'article_id_example' # String | Platform-native numeric article id. Non-numeric values return 400.
|
|
697
|
+
update_blog_article_request = Zernio::UpdateBlogArticleRequest.new # UpdateBlogArticleRequest |
|
|
698
|
+
|
|
699
|
+
begin
|
|
700
|
+
# Update a blog article
|
|
701
|
+
result = api_instance.update_blog_article(account_id, blog_id, article_id, update_blog_article_request)
|
|
702
|
+
p result
|
|
703
|
+
rescue Zernio::ApiError => e
|
|
704
|
+
puts "Error when calling BlogsApi->update_blog_article: #{e}"
|
|
705
|
+
end
|
|
706
|
+
```
|
|
707
|
+
|
|
708
|
+
#### Using the update_blog_article_with_http_info variant
|
|
709
|
+
|
|
710
|
+
This returns an Array which contains the response data, status code and headers.
|
|
711
|
+
|
|
712
|
+
> <Array(<CreateBlogArticle201Response>, Integer, Hash)> update_blog_article_with_http_info(account_id, blog_id, article_id, update_blog_article_request)
|
|
713
|
+
|
|
714
|
+
```ruby
|
|
715
|
+
begin
|
|
716
|
+
# Update a blog article
|
|
717
|
+
data, status_code, headers = api_instance.update_blog_article_with_http_info(account_id, blog_id, article_id, update_blog_article_request)
|
|
718
|
+
p status_code # => 2xx
|
|
719
|
+
p headers # => { ... }
|
|
720
|
+
p data # => <CreateBlogArticle201Response>
|
|
721
|
+
rescue Zernio::ApiError => e
|
|
722
|
+
puts "Error when calling BlogsApi->update_blog_article_with_http_info: #{e}"
|
|
723
|
+
end
|
|
724
|
+
```
|
|
725
|
+
|
|
726
|
+
### Parameters
|
|
727
|
+
|
|
728
|
+
| Name | Type | Description | Notes |
|
|
729
|
+
| ---- | ---- | ----------- | ----- |
|
|
730
|
+
| **account_id** | **String** | Connected Shopify SocialAccount id. | |
|
|
731
|
+
| **blog_id** | **String** | Platform-native numeric blog id. Non-numeric values return 400. | |
|
|
732
|
+
| **article_id** | **String** | Platform-native numeric article id. Non-numeric values return 400. | |
|
|
733
|
+
| **update_blog_article_request** | [**UpdateBlogArticleRequest**](UpdateBlogArticleRequest.md) | | |
|
|
734
|
+
|
|
735
|
+
### Return type
|
|
736
|
+
|
|
737
|
+
[**CreateBlogArticle201Response**](CreateBlogArticle201Response.md)
|
|
738
|
+
|
|
739
|
+
### Authorization
|
|
740
|
+
|
|
741
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
742
|
+
|
|
743
|
+
### HTTP request headers
|
|
744
|
+
|
|
745
|
+
- **Content-Type**: application/json
|
|
746
|
+
- **Accept**: application/json
|
|
747
|
+
|