late-sdk 0.0.871 → 0.0.873
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 +17 -8
- data/docs/AccountGroupsApi.md +1 -1
- data/docs/AccountWithFollowerStatsAllOfAccountStats.md +2 -2
- data/docs/AccountsApi.md +5 -5
- data/docs/Ad.md +4 -4
- data/docs/AdAccountsApi.md +9 -9
- data/docs/AdAudiencesApi.md +4 -4
- data/docs/AdCampaignsApi.md +46 -46
- data/docs/AdCreative.md +6 -6
- data/docs/AdCreativesApi.md +12 -12
- data/docs/AdDailyMetrics.md +4 -4
- data/docs/AdFunnelCounts.md +3 -3
- data/docs/AdInsightsApi.md +3 -3
- data/docs/AdKeyword.md +1 -1
- data/docs/AdLibraryApi.md +2 -2
- data/docs/AdMetrics.md +4 -4
- data/docs/AdTargetingApi.md +5 -5
- data/docs/AdTreeAdSet.md +1 -1
- data/docs/AdTreeCampaign.md +4 -4
- data/docs/AddAdKeywordsRequest.md +1 -1
- data/docs/AddMessageReactionRequest.md +1 -1
- data/docs/AdjustConversionsRequestAdjustmentsInner.md +4 -4
- data/docs/AdsTimelineResponseRowsInner.md +1 -1
- data/docs/AnalyticsApi.md +22 -22
- data/docs/AnalyticsDeltaEntry.md +1 -1
- data/docs/AnalyticsListResponse.md +1 -1
- data/docs/ApiKey.md +1 -1
- data/docs/AppealSmsRegistrationRequest.md +1 -1
- data/docs/AssignGoogleBusinessLocation200ResponseAccount.md +1 -1
- data/docs/AssignGoogleBusinessLocationRequest.md +2 -2
- data/docs/AttachCampaignAssetsRequest.md +2 -2
- data/docs/BillingSnapshotPlan.md +1 -1
- data/docs/BlockWhatsAppUsersRequest.md +1 -1
- data/docs/BookmarkPostRequest.md +1 -1
- data/docs/BoostPostRequest.md +5 -5
- data/docs/BusinessCenter.md +1 -1
- data/docs/CallRecord.md +2 -2
- data/docs/CampaignAnalyticsResponseAnalyticsDailyInner.md +4 -4
- data/docs/CheckPhoneNumberAvailability200Response.md +1 -1
- data/docs/CheckPhoneNumberPortability200ResponseResultsInner.md +2 -2
- data/docs/CommentsApi.md +11 -11
- data/docs/ConnectApi.md +102 -35
- data/docs/ConnectWhatsAppEmbeddedSignupRequest.md +4 -4
- data/docs/Conversation.md +34 -0
- data/docs/ConversionEvent.md +1 -1
- data/docs/ConversionsApi.md +6 -6
- data/docs/CreateAdCampaignRequest.md +1 -1
- data/docs/CreateAdCreativeRequest.md +1 -1
- data/docs/CreateApiKeyRequest.md +1 -1
- data/docs/CreateInboxConversation201ResponseData.md +2 -2
- data/docs/CreateInboxConversationRequest.md +3 -3
- data/docs/CreatePhoneNumberPortInRequestEndUser.md +2 -2
- data/docs/CreateStandaloneAdRequest.md +22 -22
- data/docs/CreateStandaloneAdRequestVideo.md +2 -2
- data/docs/CreateWhatsAppFlowRequest.md +1 -1
- data/docs/CreateWhatsAppGroupChatRequest.md +1 -1
- data/docs/CreateWhatsAppTemplateRequest.md +1 -1
- data/docs/CtwaAdRequestBodyVideo.md +1 -1
- data/docs/CustomConversion.md +1 -1
- data/docs/DeleteWhatsappBusinessUsernameRequest.md +1 -1
- data/docs/DiscordApi.md +9 -9
- data/docs/DiscordScheduledEvent.md +1 -1
- data/docs/EditInboxCommentRequest.md +1 -1
- data/docs/EditInboxMessageRequest.md +1 -1
- data/docs/EnableSmsOnNumber200Response.md +1 -1
- data/docs/ErrorResponse.md +1 -1
- data/docs/EstimateAdReachRequest.md +1 -1
- data/docs/ExternalPostWebhookPost.md +2 -2
- data/docs/FollowUserRequest.md +2 -2
- data/docs/GMBAttributesApi.md +3 -3
- data/docs/GMBFoodMenusApi.md +2 -2
- data/docs/GMBLocationDetailsApi.md +2 -2
- data/docs/GMBMediaApi.md +1 -1
- data/docs/GMBPlaceActionsApi.md +1 -1
- data/docs/GMBReviewsApi.md +4 -4
- data/docs/GetAdComments200ResponseMeta.md +4 -4
- data/docs/GetAdMedia200Response.md +1 -1
- data/docs/GetAdMedia200ResponseMediaInner.md +1 -1
- data/docs/GetAdsSearchTerms200ResponseDataInner.md +1 -1
- data/docs/GetGoogleBusinessLocationDetails200ResponseLocation.md +1 -1
- data/docs/GetInboxConversation200ResponseData.md +1 -1
- data/docs/GetInboxConversationMessages200ResponseMessagesInner.md +1 -1
- data/docs/GetInboxPostComments200ResponseCommentsInner.md +2 -2
- data/docs/GetInboxPostComments200ResponseCommentsInnerFrom.md +1 -1
- data/docs/GetInboxTopAccounts200ResponseAccountsInner.md +1 -1
- data/docs/GetLinkedInBidPricingRequest.md +1 -1
- data/docs/GetPhoneNumber200ResponsePhoneNumber.md +1 -1
- data/docs/GetPhoneNumberKycForm200ResponseReusable.md +1 -1
- data/docs/GetPhoneNumberKycForm200ResponseReusableOptionsInner.md +2 -2
- data/docs/GetPhoneNumberKycForm200ResponseReusableOptionsInnerDetailsInner.md +1 -1
- data/docs/GetPhoneNumberPortInRequirements200Response.md +1 -1
- data/docs/GetWhatsAppNumberKycForm200ResponseFieldsInner.md +1 -1
- data/docs/GetWhatsAppSdkConfig200Response.md +22 -0
- data/docs/GoogleBusinessPlatformData.md +1 -1
- data/docs/HideInboxCommentRequest.md +1 -1
- data/docs/InboxAnalyticsApi.md +5 -5
- data/docs/InboxWebhookAccount.md +3 -3
- data/docs/InboxWebhookConversation.md +1 -1
- data/docs/InboxWebhookMessageSender.md +3 -3
- data/docs/InstagramApi.md +1 -1
- data/docs/LeadGenApi.md +2 -2
- data/docs/LikeInboxCommentRequest.md +1 -1
- data/docs/LikePostRequest.md +1 -1
- data/docs/LinkedInMentionsApi.md +1 -1
- data/docs/LinkedInPlatformData.md +1 -1
- data/docs/ListAdAudiences200ResponseAudiencesInner.md +1 -1
- data/docs/ListCalls200ResponseCallsInner.md +2 -2
- data/docs/ListGoogleBusinessLocations200ResponseLocationsInner.md +1 -1
- data/docs/ListInboxComments200ResponseDataInner.md +3 -3
- data/docs/ListInboxConversations200ResponseDataInner.md +3 -1
- data/docs/ListInboxReviews200ResponseDataInner.md +6 -6
- data/docs/ListPhoneNumbers200Response.md +1 -1
- data/docs/ListPhoneNumbers200ResponseNumbersInner.md +3 -3
- data/docs/ListSipTrunks200Response.md +1 -1
- data/docs/ListWhatsAppAccountEvents200ResponseEventsInner.md +1 -1
- data/docs/LogsApi.md +2 -2
- data/docs/MediaItem.md +1 -1
- data/docs/MentionsApi.md +3 -3
- data/docs/MessagesApi.md +95 -23
- data/docs/MessagingAdsApi.md +1 -1
- data/docs/PhoneNumbersApi.md +14 -14
- data/docs/PinterestPlatformData.md +1 -1
- data/docs/PostAnalytics.md +1 -1
- data/docs/PostsApi.md +5 -5
- data/docs/ProfilesApi.md +1 -1
- data/docs/PurchasePhoneNumberRequest.md +1 -1
- data/docs/PurchaseWhatsAppPhoneNumberRequest.md +1 -1
- data/docs/ReachAndFrequencyApi.md +2 -2
- data/docs/RecyclingConfig.md +1 -1
- data/docs/ReplyToMentionRequest.md +1 -1
- data/docs/RetweetPostRequest.md +1 -1
- data/docs/ReviewWebhookReview.md +1 -1
- data/docs/ReviewWebhookReviewReviewer.md +1 -1
- data/docs/ReviewsApi.md +6 -6
- data/docs/SMSApi.md +11 -11
- data/docs/SavedTargetingAudience.md +1 -1
- data/docs/SelectGoogleBusinessLocation200ResponseAccount.md +1 -1
- data/docs/SelectGoogleBusinessLocationRequest.md +2 -2
- data/docs/SendDiscordDirectMessage200Response.md +1 -1
- data/docs/SendInboxMessage200ResponseData.md +1 -1
- data/docs/SendInboxMessageRequest.md +3 -3
- data/docs/SendPrivateReplyToCommentRequest.md +2 -2
- data/docs/SendTypingIndicatorRequest.md +1 -1
- data/docs/SendWhatsAppFlowMessageRequest.md +1 -1
- data/docs/SetCommentModerationRequest.md +1 -1
- data/docs/SetConversationThreadControl200Response.md +20 -0
- data/docs/SetConversationThreadControl200ResponseControl.md +18 -0
- data/docs/SetConversationThreadControlRequest.md +24 -0
- data/docs/SetWhatsAppFlowsEncryptionKeyRequest.md +1 -1
- data/docs/SetWhatsappBusinessUsernameRequest.md +1 -1
- data/docs/StartSmsRegistrationRequest.md +1 -1
- data/docs/StartSmsRegistrationRequestCampaign.md +1 -1
- data/docs/SubmitPhoneNumberKycRequest.md +1 -1
- data/docs/SubmitWhatsAppNumberKycRequest.md +1 -1
- data/docs/SyncExternalPosts200Response.md +1 -1
- data/docs/SyncExternalPostsRequest.md +1 -1
- data/docs/TrackingTag.md +2 -2
- data/docs/TrackingTagsApi.md +6 -6
- data/docs/TwitterEngagementApi.md +9 -9
- data/docs/UnblockWhatsAppUsersRequest.md +1 -1
- data/docs/UpdateAccountRequestXCapabilities.md +1 -1
- data/docs/UpdateAdAccountRequest.md +1 -1
- data/docs/UpdateAdSetRequestPlatformSpecificData.md +1 -1
- data/docs/UpdateConversionDestinationRequest.md +1 -1
- data/docs/UpdateGmbLocationRequest.md +1 -1
- data/docs/UpdateInboxConversationRequest.md +1 -1
- data/docs/UpdatePostMetadataRequest.md +1 -1
- data/docs/UpdateWhatsAppBusinessProfileRequest.md +1 -1
- data/docs/UpdateWhatsAppDisplayNameRequest.md +1 -1
- data/docs/UpdateWhatsAppFlowRequest.md +1 -1
- data/docs/UpdateWhatsAppTemplateByIdRequest.md +1 -1
- data/docs/UpdateWhatsAppTemplateRequest.md +1 -1
- data/docs/UpdateWorkflowRequest.md +1 -1
- data/docs/UploadWhatsAppFlowJsonRequest.md +1 -1
- data/docs/UploadWhatsAppProfilePhotoRequest1.md +1 -1
- data/docs/UploadedOrDerivedAudience.md +2 -2
- data/docs/UsageApi.md +12 -12
- data/docs/UsageMetering.md +1 -1
- data/docs/UsageStats.md +1 -1
- data/docs/UsageStatsSpend.md +1 -1
- data/docs/UsageStatsUsage.md +2 -2
- data/docs/UsersApi.md +1 -1
- data/docs/ValidateApi.md +3 -3
- data/docs/VerifyApi.md +1 -1
- data/docs/VoiceApi.md +2 -2
- data/docs/WebhookEventsApi.md +76 -7
- data/docs/WebhookPayloadAdStatusChangedError.md +3 -3
- data/docs/WebhookPayloadAdStatusChangedStatus.md +1 -1
- data/docs/WebhookPayloadCommentAccount.md +2 -2
- data/docs/WebhookPayloadCommentPost.md +1 -1
- data/docs/WebhookPayloadConversationControlChanged.md +30 -0
- data/docs/WebhookPayloadConversationControlChangedControl.md +22 -0
- data/docs/WebhookPayloadLeadAccount.md +2 -2
- data/docs/WebhookPayloadMessageMessageSender.md +3 -3
- data/docs/WebhookPayloadMessageMetadata.md +3 -1
- data/docs/WebhookPayloadMessageSentMessage.md +1 -1
- data/docs/WebhookPayloadReviewNewAccount.md +1 -1
- data/docs/WhatsAppApi.md +51 -51
- data/docs/WhatsAppCallingApi.md +3 -3
- data/docs/WhatsAppFlowsApi.md +18 -18
- data/docs/WhatsAppPhoneNumbersApi.md +12 -12
- data/docs/WhatsAppSandboxApi.md +2 -2
- data/docs/WhatsAppTemplatesApi.md +2 -2
- data/docs/WorkflowEdge.md +1 -1
- data/docs/WorkflowExecutionEvent.md +1 -1
- data/docs/WorkflowsApi.md +3 -3
- data/docs/XApiOperation.md +2 -2
- data/docs/XApiOperationTriggeredByInner.md +1 -1
- data/docs/XApiPricing.md +1 -1
- data/lib/zernio-sdk/api/account_groups_api.rb +2 -2
- data/lib/zernio-sdk/api/accounts_api.rb +10 -10
- data/lib/zernio-sdk/api/ad_accounts_api.rb +12 -12
- data/lib/zernio-sdk/api/ad_audiences_api.rb +6 -6
- data/lib/zernio-sdk/api/ad_campaigns_api.rb +60 -60
- data/lib/zernio-sdk/api/ad_creatives_api.rb +20 -20
- data/lib/zernio-sdk/api/ad_insights_api.rb +4 -4
- data/lib/zernio-sdk/api/ad_library_api.rb +2 -2
- data/lib/zernio-sdk/api/ad_targeting_api.rb +6 -6
- data/lib/zernio-sdk/api/analytics_api.rb +22 -22
- data/lib/zernio-sdk/api/comments_api.rb +20 -20
- data/lib/zernio-sdk/api/connect_api.rb +91 -34
- data/lib/zernio-sdk/api/conversions_api.rb +12 -12
- data/lib/zernio-sdk/api/discord_api.rb +18 -18
- data/lib/zernio-sdk/api/gmb_attributes_api.rb +4 -4
- data/lib/zernio-sdk/api/gmb_food_menus_api.rb +4 -4
- data/lib/zernio-sdk/api/gmb_location_details_api.rb +4 -4
- data/lib/zernio-sdk/api/gmb_media_api.rb +2 -2
- data/lib/zernio-sdk/api/gmb_place_actions_api.rb +2 -2
- data/lib/zernio-sdk/api/gmb_reviews_api.rb +8 -8
- data/lib/zernio-sdk/api/inbox_analytics_api.rb +10 -10
- data/lib/zernio-sdk/api/instagram_api.rb +2 -2
- data/lib/zernio-sdk/api/lead_gen_api.rb +4 -4
- data/lib/zernio-sdk/api/linked_in_mentions_api.rb +2 -2
- data/lib/zernio-sdk/api/logs_api.rb +2 -2
- data/lib/zernio-sdk/api/mentions_api.rb +4 -4
- data/lib/zernio-sdk/api/messages_api.rb +104 -30
- data/lib/zernio-sdk/api/messaging_ads_api.rb +2 -2
- data/lib/zernio-sdk/api/phone_numbers_api.rb +24 -24
- data/lib/zernio-sdk/api/posts_api.rb +8 -8
- data/lib/zernio-sdk/api/profiles_api.rb +2 -2
- data/lib/zernio-sdk/api/reach_and_frequency_api.rb +4 -4
- data/lib/zernio-sdk/api/reviews_api.rb +8 -8
- data/lib/zernio-sdk/api/sms_api.rb +20 -20
- data/lib/zernio-sdk/api/tracking_tags_api.rb +12 -12
- data/lib/zernio-sdk/api/twitter_engagement_api.rb +12 -12
- data/lib/zernio-sdk/api/usage_api.rb +14 -14
- data/lib/zernio-sdk/api/users_api.rb +2 -2
- data/lib/zernio-sdk/api/validate_api.rb +4 -4
- data/lib/zernio-sdk/api/verify_api.rb +2 -2
- data/lib/zernio-sdk/api/voice_api.rb +4 -4
- data/lib/zernio-sdk/api/webhook_events_api.rb +80 -14
- data/lib/zernio-sdk/api/whats_app_api.rb +54 -54
- data/lib/zernio-sdk/api/whats_app_calling_api.rb +4 -4
- data/lib/zernio-sdk/api/whats_app_flows_api.rb +20 -20
- data/lib/zernio-sdk/api/whats_app_phone_numbers_api.rb +20 -20
- data/lib/zernio-sdk/api/whats_app_sandbox_api.rb +4 -4
- data/lib/zernio-sdk/api/whats_app_templates_api.rb +2 -2
- data/lib/zernio-sdk/api/workflows_api.rb +6 -6
- data/lib/zernio-sdk/models/account_with_follower_stats_all_of_account_stats.rb +2 -2
- data/lib/zernio-sdk/models/ad.rb +4 -4
- data/lib/zernio-sdk/models/ad_creative.rb +6 -6
- data/lib/zernio-sdk/models/ad_daily_metrics.rb +4 -4
- data/lib/zernio-sdk/models/ad_engagement_counts.rb +1 -1
- data/lib/zernio-sdk/models/ad_funnel_counts.rb +4 -4
- data/lib/zernio-sdk/models/ad_keyword.rb +1 -1
- data/lib/zernio-sdk/models/ad_metrics.rb +4 -4
- data/lib/zernio-sdk/models/ad_tree_ad_set.rb +1 -1
- data/lib/zernio-sdk/models/ad_tree_campaign.rb +4 -4
- data/lib/zernio-sdk/models/add_ad_keywords_request.rb +1 -1
- data/lib/zernio-sdk/models/add_message_reaction_request.rb +1 -1
- data/lib/zernio-sdk/models/adjust_conversions_request_adjustments_inner.rb +4 -4
- data/lib/zernio-sdk/models/adjust_conversions_request_adjustments_inner_user.rb +1 -1
- data/lib/zernio-sdk/models/ads_timeline_response_rows_inner.rb +1 -1
- data/lib/zernio-sdk/models/analytics_delta_entry.rb +1 -1
- data/lib/zernio-sdk/models/analytics_list_response.rb +1 -1
- data/lib/zernio-sdk/models/api_key.rb +1 -1
- data/lib/zernio-sdk/models/appeal_sms_registration_request.rb +1 -1
- data/lib/zernio-sdk/models/assign_google_business_location200_response_account.rb +1 -1
- data/lib/zernio-sdk/models/assign_google_business_location_request.rb +2 -2
- data/lib/zernio-sdk/models/attach_campaign_assets_request.rb +2 -2
- data/lib/zernio-sdk/models/billing_snapshot.rb +1 -1
- data/lib/zernio-sdk/models/billing_snapshot_plan.rb +1 -1
- data/lib/zernio-sdk/models/block_whats_app_users_request.rb +1 -1
- data/lib/zernio-sdk/models/bookmark_post_request.rb +1 -1
- data/lib/zernio-sdk/models/boost_post_request.rb +5 -5
- data/lib/zernio-sdk/models/boost_post_request_platform_specific_data.rb +1 -1
- data/lib/zernio-sdk/models/business_center.rb +2 -2
- data/lib/zernio-sdk/models/call_record.rb +2 -2
- data/lib/zernio-sdk/models/campaign_analytics_response_analytics_daily_inner.rb +4 -4
- data/lib/zernio-sdk/models/check_phone_number_availability200_response.rb +1 -1
- data/lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb +2 -2
- data/lib/zernio-sdk/models/connect_whats_app_embedded_signup_request.rb +4 -3
- data/lib/zernio-sdk/models/conversation.rb +334 -0
- data/lib/zernio-sdk/models/conversion_destination.rb +1 -1
- data/lib/zernio-sdk/models/conversion_event.rb +1 -1
- data/lib/zernio-sdk/models/create_ad_campaign_request.rb +1 -1
- data/lib/zernio-sdk/models/create_ad_creative_request.rb +1 -1
- data/lib/zernio-sdk/models/create_api_key_request.rb +1 -1
- data/lib/zernio-sdk/models/create_inbox_conversation201_response_data.rb +2 -2
- data/lib/zernio-sdk/models/create_inbox_conversation_request.rb +3 -3
- data/lib/zernio-sdk/models/create_phone_number_port_in_request_end_user.rb +3 -3
- data/lib/zernio-sdk/models/create_standalone_ad201_response_one_of.rb +1 -1
- data/lib/zernio-sdk/models/create_standalone_ad201_response_one_of1.rb +1 -1
- data/lib/zernio-sdk/models/create_standalone_ad_request.rb +22 -22
- data/lib/zernio-sdk/models/create_standalone_ad_request_placement_assets.rb +1 -1
- data/lib/zernio-sdk/models/create_standalone_ad_request_placement_assets_rules_inner_placements.rb +1 -1
- data/lib/zernio-sdk/models/create_standalone_ad_request_placements.rb +1 -1
- data/lib/zernio-sdk/models/create_standalone_ad_request_platform_specific_data.rb +1 -1
- data/lib/zernio-sdk/models/create_standalone_ad_request_video.rb +3 -3
- data/lib/zernio-sdk/models/create_whats_app_flow_request.rb +1 -1
- data/lib/zernio-sdk/models/create_whats_app_group_chat_request.rb +1 -1
- data/lib/zernio-sdk/models/create_whats_app_template_request.rb +1 -1
- data/lib/zernio-sdk/models/ctwa_ad_request_body_video.rb +1 -1
- data/lib/zernio-sdk/models/custom_conversion.rb +1 -1
- data/lib/zernio-sdk/models/delete_whatsapp_business_username_request.rb +1 -1
- data/lib/zernio-sdk/models/discord_scheduled_event.rb +2 -2
- data/lib/zernio-sdk/models/edit_inbox_comment_request.rb +1 -1
- data/lib/zernio-sdk/models/edit_inbox_message_request.rb +1 -1
- data/lib/zernio-sdk/models/enable_sms_on_number200_response.rb +1 -1
- data/lib/zernio-sdk/models/error_response.rb +1 -1
- data/lib/zernio-sdk/models/estimate_ad_reach_request.rb +1 -1
- data/lib/zernio-sdk/models/external_post_webhook_post.rb +2 -2
- data/lib/zernio-sdk/models/follow_user_request.rb +2 -2
- data/lib/zernio-sdk/models/geo_restriction.rb +1 -1
- data/lib/zernio-sdk/models/get_ad_comments200_response_meta.rb +4 -4
- data/lib/zernio-sdk/models/get_ad_media200_response.rb +1 -1
- data/lib/zernio-sdk/models/get_ad_media200_response_media_inner.rb +1 -1
- data/lib/zernio-sdk/models/get_ads_search_terms200_response_data_inner.rb +1 -1
- data/lib/zernio-sdk/models/get_google_business_location_details200_response_location.rb +1 -1
- data/lib/zernio-sdk/models/get_inbox_conversation200_response_data.rb +1 -1
- data/lib/zernio-sdk/models/get_inbox_conversation_messages200_response_messages_inner.rb +1 -1
- data/lib/zernio-sdk/models/get_inbox_post_comments200_response_comments_inner.rb +2 -2
- data/lib/zernio-sdk/models/get_inbox_post_comments200_response_comments_inner_from.rb +1 -1
- data/lib/zernio-sdk/models/get_inbox_post_comments200_response_meta_ad_comments.rb +1 -1
- data/lib/zernio-sdk/models/get_inbox_top_accounts200_response_accounts_inner.rb +1 -1
- data/lib/zernio-sdk/models/get_linked_in_bid_pricing_request.rb +1 -1
- data/lib/zernio-sdk/models/get_phone_number200_response_phone_number.rb +1 -1
- data/lib/zernio-sdk/models/get_phone_number_kyc_form200_response_reusable.rb +1 -1
- data/lib/zernio-sdk/models/get_phone_number_kyc_form200_response_reusable_options_inner.rb +2 -2
- data/lib/zernio-sdk/models/get_phone_number_kyc_form200_response_reusable_options_inner_details_inner.rb +1 -1
- data/lib/zernio-sdk/models/get_phone_number_port_in_requirements200_response.rb +1 -1
- data/lib/zernio-sdk/models/get_whats_app_number_kyc_form200_response_fields_inner.rb +1 -1
- data/lib/zernio-sdk/models/get_whats_app_sdk_config200_response.rb +219 -0
- data/lib/zernio-sdk/models/google_business_platform_data.rb +2 -2
- data/lib/zernio-sdk/models/hide_inbox_comment_request.rb +1 -1
- data/lib/zernio-sdk/models/inbox_webhook_account.rb +3 -3
- data/lib/zernio-sdk/models/inbox_webhook_conversation.rb +1 -1
- data/lib/zernio-sdk/models/inbox_webhook_message_sender.rb +3 -3
- data/lib/zernio-sdk/models/like_inbox_comment_request.rb +1 -1
- data/lib/zernio-sdk/models/like_post_request.rb +1 -1
- data/lib/zernio-sdk/models/linked_in_ads_platform_data_thought_leader.rb +1 -1
- data/lib/zernio-sdk/models/linked_in_platform_data.rb +1 -1
- data/lib/zernio-sdk/models/list_ad_audiences200_response_audiences_inner.rb +1 -1
- data/lib/zernio-sdk/models/list_calls200_response_calls_inner.rb +2 -2
- data/lib/zernio-sdk/models/list_discord_pinned_messages200_response_data_inner.rb +1 -1
- data/lib/zernio-sdk/models/list_google_business_locations200_response_locations_inner.rb +1 -1
- data/lib/zernio-sdk/models/list_inbox_comments200_response_data_inner.rb +3 -3
- data/lib/zernio-sdk/models/list_inbox_conversations200_response_data_inner.rb +24 -2
- data/lib/zernio-sdk/models/list_inbox_reviews200_response_data_inner.rb +6 -6
- data/lib/zernio-sdk/models/list_phone_numbers200_response.rb +1 -1
- data/lib/zernio-sdk/models/list_phone_numbers200_response_numbers_inner.rb +3 -3
- data/lib/zernio-sdk/models/list_sip_trunks200_response.rb +1 -1
- data/lib/zernio-sdk/models/list_sms_sender_ids200_response_budget.rb +1 -1
- data/lib/zernio-sdk/models/list_whats_app_account_events200_response_events_inner.rb +1 -1
- data/lib/zernio-sdk/models/media_item.rb +1 -1
- data/lib/zernio-sdk/models/pinterest_platform_data.rb +1 -1
- data/lib/zernio-sdk/models/post_analytics.rb +1 -1
- data/lib/zernio-sdk/models/purchase_phone_number_request.rb +1 -1
- data/lib/zernio-sdk/models/purchase_whats_app_phone_number_request.rb +1 -1
- data/lib/zernio-sdk/models/recycling_config.rb +2 -2
- data/lib/zernio-sdk/models/reply_to_mention_request.rb +1 -1
- data/lib/zernio-sdk/models/retweet_post_request.rb +1 -1
- data/lib/zernio-sdk/models/review_webhook_review.rb +1 -1
- data/lib/zernio-sdk/models/review_webhook_review_reviewer.rb +1 -1
- data/lib/zernio-sdk/models/saved_targeting_audience.rb +1 -1
- data/lib/zernio-sdk/models/select_google_business_location200_response_account.rb +1 -1
- data/lib/zernio-sdk/models/select_google_business_location_request.rb +2 -2
- data/lib/zernio-sdk/models/send_discord_direct_message200_response.rb +1 -1
- data/lib/zernio-sdk/models/send_inbox_message200_response_data.rb +1 -1
- data/lib/zernio-sdk/models/send_inbox_message_request.rb +3 -3
- data/lib/zernio-sdk/models/send_private_reply_to_comment_request.rb +2 -2
- data/lib/zernio-sdk/models/send_typing_indicator_request.rb +1 -1
- data/lib/zernio-sdk/models/send_whats_app_flow_message_request.rb +1 -1
- data/lib/zernio-sdk/models/set_comment_moderation_request.rb +1 -1
- data/lib/zernio-sdk/models/set_conversation_thread_control200_response.rb +156 -0
- data/lib/zernio-sdk/models/set_conversation_thread_control200_response_control.rb +181 -0
- data/lib/zernio-sdk/models/set_conversation_thread_control_request.rb +266 -0
- data/lib/zernio-sdk/models/set_whats_app_flows_encryption_key_request.rb +1 -1
- data/lib/zernio-sdk/models/set_whatsapp_business_username_request.rb +1 -1
- data/lib/zernio-sdk/models/slack_platform_data.rb +1 -1
- data/lib/zernio-sdk/models/start_sms_registration_request.rb +1 -1
- data/lib/zernio-sdk/models/start_sms_registration_request_campaign.rb +2 -2
- data/lib/zernio-sdk/models/submit_phone_number_kyc_request.rb +1 -1
- data/lib/zernio-sdk/models/submit_whats_app_number_kyc_request.rb +1 -1
- data/lib/zernio-sdk/models/sync_external_posts200_response.rb +1 -1
- data/lib/zernio-sdk/models/sync_external_posts_request.rb +1 -1
- data/lib/zernio-sdk/models/tracking_tag.rb +3 -3
- data/lib/zernio-sdk/models/unblock_whats_app_users_request.rb +1 -1
- data/lib/zernio-sdk/models/update_account_request_x_capabilities.rb +2 -2
- data/lib/zernio-sdk/models/update_ad_account_request.rb +1 -1
- data/lib/zernio-sdk/models/update_ad_request_creative.rb +1 -1
- data/lib/zernio-sdk/models/update_ad_set_request_platform_specific_data.rb +1 -1
- data/lib/zernio-sdk/models/update_ad_tracking_tags_request_creative.rb +1 -1
- data/lib/zernio-sdk/models/update_conversion_destination_request.rb +1 -1
- data/lib/zernio-sdk/models/update_gmb_location_request.rb +1 -1
- data/lib/zernio-sdk/models/update_inbox_conversation_request.rb +1 -1
- data/lib/zernio-sdk/models/update_post_metadata_request.rb +1 -1
- data/lib/zernio-sdk/models/update_whats_app_business_profile_request.rb +1 -1
- data/lib/zernio-sdk/models/update_whats_app_display_name_request.rb +1 -1
- data/lib/zernio-sdk/models/update_whats_app_flow_request.rb +1 -1
- data/lib/zernio-sdk/models/update_whats_app_template_by_id_request.rb +1 -1
- data/lib/zernio-sdk/models/update_whats_app_template_request.rb +1 -1
- data/lib/zernio-sdk/models/update_workflow_request.rb +1 -1
- data/lib/zernio-sdk/models/upload_whats_app_flow_json_request.rb +1 -1
- data/lib/zernio-sdk/models/upload_whats_app_profile_photo_request1.rb +1 -1
- data/lib/zernio-sdk/models/uploaded_or_derived_audience.rb +2 -2
- data/lib/zernio-sdk/models/usage_metering.rb +2 -2
- data/lib/zernio-sdk/models/usage_metering_peaks.rb +1 -1
- data/lib/zernio-sdk/models/usage_stats.rb +2 -2
- data/lib/zernio-sdk/models/usage_stats_limits.rb +1 -1
- data/lib/zernio-sdk/models/usage_stats_spend.rb +2 -2
- data/lib/zernio-sdk/models/usage_stats_usage.rb +3 -3
- data/lib/zernio-sdk/models/usage_stats_usage_x_api_calls.rb +1 -1
- data/lib/zernio-sdk/models/webhook_payload_ad_status_changed_error.rb +3 -3
- data/lib/zernio-sdk/models/webhook_payload_ad_status_changed_status.rb +1 -1
- data/lib/zernio-sdk/models/webhook_payload_analytics_synced.rb +1 -1
- data/lib/zernio-sdk/models/webhook_payload_analytics_synced_sync.rb +1 -1
- data/lib/zernio-sdk/models/webhook_payload_comment.rb +1 -1
- data/lib/zernio-sdk/models/webhook_payload_comment_account.rb +2 -2
- data/lib/zernio-sdk/models/webhook_payload_comment_post.rb +1 -1
- data/lib/zernio-sdk/models/webhook_payload_conversation_control_changed.rb +347 -0
- data/lib/zernio-sdk/models/webhook_payload_conversation_control_changed_control.rb +224 -0
- data/lib/zernio-sdk/models/webhook_payload_conversation_started.rb +1 -1
- data/lib/zernio-sdk/models/webhook_payload_lead_account.rb +2 -2
- data/lib/zernio-sdk/models/webhook_payload_message_message_sender.rb +3 -3
- data/lib/zernio-sdk/models/webhook_payload_message_metadata.rb +13 -3
- data/lib/zernio-sdk/models/webhook_payload_message_sent_message.rb +3 -3
- data/lib/zernio-sdk/models/webhook_payload_post_platform.rb +1 -1
- data/lib/zernio-sdk/models/webhook_payload_post_platform_account.rb +1 -1
- data/lib/zernio-sdk/models/webhook_payload_post_platform_platform.rb +1 -1
- data/lib/zernio-sdk/models/webhook_payload_review_new_account.rb +1 -1
- data/lib/zernio-sdk/models/workflow_edge.rb +1 -1
- data/lib/zernio-sdk/models/workflow_execution_event.rb +1 -1
- data/lib/zernio-sdk/models/x_api_operation.rb +2 -2
- data/lib/zernio-sdk/models/x_api_operation_triggered_by_inner.rb +1 -1
- data/lib/zernio-sdk/models/x_api_pricing.rb +2 -2
- data/lib/zernio-sdk/version.rb +1 -1
- data/lib/zernio-sdk.rb +7 -0
- data/openapi.yaml +1073 -853
- data/spec/api/account_groups_api_spec.rb +1 -1
- data/spec/api/accounts_api_spec.rb +5 -5
- data/spec/api/ad_accounts_api_spec.rb +6 -6
- data/spec/api/ad_audiences_api_spec.rb +3 -3
- data/spec/api/ad_campaigns_api_spec.rb +30 -30
- data/spec/api/ad_creatives_api_spec.rb +10 -10
- data/spec/api/ad_insights_api_spec.rb +2 -2
- data/spec/api/ad_library_api_spec.rb +1 -1
- data/spec/api/ad_targeting_api_spec.rb +3 -3
- data/spec/api/analytics_api_spec.rb +11 -11
- data/spec/api/comments_api_spec.rb +10 -10
- data/spec/api/connect_api_spec.rb +28 -17
- data/spec/api/conversions_api_spec.rb +6 -6
- data/spec/api/discord_api_spec.rb +9 -9
- data/spec/api/gmb_attributes_api_spec.rb +2 -2
- data/spec/api/gmb_food_menus_api_spec.rb +2 -2
- data/spec/api/gmb_location_details_api_spec.rb +2 -2
- data/spec/api/gmb_media_api_spec.rb +1 -1
- data/spec/api/gmb_place_actions_api_spec.rb +1 -1
- data/spec/api/gmb_reviews_api_spec.rb +4 -4
- data/spec/api/inbox_analytics_api_spec.rb +5 -5
- data/spec/api/instagram_api_spec.rb +1 -1
- data/spec/api/lead_gen_api_spec.rb +2 -2
- data/spec/api/linked_in_mentions_api_spec.rb +1 -1
- data/spec/api/logs_api_spec.rb +1 -1
- data/spec/api/mentions_api_spec.rb +2 -2
- data/spec/api/messages_api_spec.rb +28 -15
- data/spec/api/messaging_ads_api_spec.rb +1 -1
- data/spec/api/phone_numbers_api_spec.rb +12 -12
- data/spec/api/posts_api_spec.rb +4 -4
- data/spec/api/profiles_api_spec.rb +1 -1
- data/spec/api/reach_and_frequency_api_spec.rb +2 -2
- data/spec/api/reviews_api_spec.rb +4 -4
- data/spec/api/sms_api_spec.rb +10 -10
- data/spec/api/tracking_tags_api_spec.rb +6 -6
- data/spec/api/twitter_engagement_api_spec.rb +6 -6
- data/spec/api/usage_api_spec.rb +7 -7
- data/spec/api/users_api_spec.rb +1 -1
- data/spec/api/validate_api_spec.rb +2 -2
- data/spec/api/verify_api_spec.rb +1 -1
- data/spec/api/voice_api_spec.rb +2 -2
- data/spec/api/whats_app_api_spec.rb +27 -27
- data/spec/api/whats_app_calling_api_spec.rb +2 -2
- data/spec/api/whats_app_flows_api_spec.rb +10 -10
- data/spec/api/whats_app_phone_numbers_api_spec.rb +10 -10
- data/spec/api/whats_app_sandbox_api_spec.rb +2 -2
- data/spec/api/whats_app_templates_api_spec.rb +1 -1
- data/spec/api/workflows_api_spec.rb +3 -3
- data/spec/models/conversation_spec.rb +92 -0
- data/spec/models/create_webhook_settings_request_spec.rb +1 -1
- data/spec/models/get_whats_app_sdk_config200_response_spec.rb +48 -0
- data/spec/models/list_inbox_conversations200_response_data_inner_spec.rb +10 -0
- data/spec/models/set_conversation_thread_control200_response_control_spec.rb +40 -0
- data/spec/models/set_conversation_thread_control200_response_spec.rb +42 -0
- data/spec/models/set_conversation_thread_control_request_spec.rb +62 -0
- data/spec/models/update_webhook_settings_request_spec.rb +1 -1
- data/spec/models/webhook_payload_conversation_control_changed_control_spec.rb +56 -0
- data/spec/models/webhook_payload_conversation_control_changed_spec.rb +76 -0
- data/spec/models/webhook_payload_message_metadata_spec.rb +6 -0
- data/spec/models/webhook_payload_message_sent_message_spec.rb +1 -1
- data/spec/models/webhook_spec.rb +1 -1
- data/zernio-sdk-0.0.873.gem +0 -0
- metadata +30 -2
- data/zernio-sdk-0.0.871.gem +0 -0
data/spec/api/voice_api_spec.rb
CHANGED
|
@@ -47,7 +47,7 @@ describe 'VoiceApi' do
|
|
|
47
47
|
|
|
48
48
|
# unit tests for create_sip_trunk
|
|
49
49
|
# Create a SIP trunk
|
|
50
|
-
# Creates a SIP trunk an external voice platform (Retell, ElevenLabs, Vapi, or any SIP endpoint) can import your Zernio numbers into. The trunk carries both directions: inbound calls on attached numbers are delivered to `sipHost`, and the platform originates outbound calls through `termination.uri` with the digest credentials. The `digestPassword` is returned only by this call (and by rotate-credentials); store it immediately. Attach any number of numbers to a trunk. Several trunks may point at the same host
|
|
50
|
+
# Creates a SIP trunk an external voice platform (Retell, ElevenLabs, Vapi, or any SIP endpoint) can import your Zernio numbers into. The trunk carries both directions: inbound calls on attached numbers are delivered to `sipHost`, and the platform originates outbound calls through `termination.uri` with the digest credentials. The `digestPassword` is returned only by this call (and by rotate-credentials); store it immediately. Attach any number of numbers to a trunk. Several trunks may point at the same host. Each carries its own credentials and spend cap, so separate destinations (e.g. an agency's clients) stay isolated.
|
|
51
51
|
# @param create_sip_trunk_request
|
|
52
52
|
# @param [Hash] opts the optional parameters
|
|
53
53
|
# @return [CreateSipTrunk201Response]
|
|
@@ -72,7 +72,7 @@ describe 'VoiceApi' do
|
|
|
72
72
|
|
|
73
73
|
# unit tests for create_voice_web_session
|
|
74
74
|
# Mint a browser softphone session
|
|
75
|
-
# Step 1 of the two-step browser softphone handshake. Mints a WebRTC session (token + credential) the browser registers with the `@telnyx/webrtc` SDK. Once registered, call `POST /v1/voice/calls/web/dial` with the returned `credentialId` to place the call. The split avoids bridging to a browser that has not finished registering. The token lives ~1 hour (it must outlive the whole call, not
|
|
75
|
+
# Step 1 of the two-step browser softphone handshake. Mints a WebRTC session (token + credential) the browser registers with the `@telnyx/webrtc` SDK. Once registered, call `POST /v1/voice/calls/web/dial` with the returned `credentialId` to place the call. The split avoids bridging to a browser that has not finished registering. The token lives ~1 hour (it must outlive the whole call, not only the handshake).
|
|
76
76
|
# @param [Hash] opts the optional parameters
|
|
77
77
|
# @return [CreateVoiceWebSession200Response]
|
|
78
78
|
describe 'create_voice_web_session test' do
|
|
@@ -36,7 +36,7 @@ describe 'WhatsAppApi' do
|
|
|
36
36
|
# Add participants
|
|
37
37
|
# Add participants to a WhatsApp group. Maximum 8 participants per request. Not available on [Coexistence](/platforms/whatsapp/connection#whatsapp-business-app-coexistence) numbers. Requires a Cloud API-only number.
|
|
38
38
|
# @param group_id Group ID
|
|
39
|
-
# @param account_id WhatsApp
|
|
39
|
+
# @param account_id WhatsApp account ID
|
|
40
40
|
# @param add_whats_app_group_participants_request
|
|
41
41
|
# @param [Hash] opts the optional parameters
|
|
42
42
|
# @return [UnpublishPost200Response]
|
|
@@ -50,7 +50,7 @@ describe 'WhatsAppApi' do
|
|
|
50
50
|
# Approve join requests
|
|
51
51
|
# Approve pending join requests for a WhatsApp group. Not available on [Coexistence](/platforms/whatsapp/connection#whatsapp-business-app-coexistence) numbers. Requires a Cloud API-only number.
|
|
52
52
|
# @param group_id Group ID
|
|
53
|
-
# @param account_id WhatsApp
|
|
53
|
+
# @param account_id WhatsApp account ID
|
|
54
54
|
# @param approve_whats_app_group_join_requests_request
|
|
55
55
|
# @param [Hash] opts the optional parameters
|
|
56
56
|
# @return [UnpublishPost200Response]
|
|
@@ -74,7 +74,7 @@ describe 'WhatsAppApi' do
|
|
|
74
74
|
|
|
75
75
|
# unit tests for create_whats_app_dataset
|
|
76
76
|
# Provision CTWA dataset
|
|
77
|
-
# Creates (or fetches, if one already exists) the Meta dataset that Click-to-WhatsApp ad events are reported against via the Conversions API, and persists its ID on the account as `metadata.metaCapiDatasetId`. The call is GET-first idempotent
|
|
77
|
+
# Creates (or fetches, if one already exists) the Meta dataset that Click-to-WhatsApp ad events are reported against via the Conversions API, and persists its ID on the account as `metadata.metaCapiDatasetId`. The call is GET-first idempotent: a WABA can only own one CTWA dataset, so a second call after a successful provision is a safe no-op that returns the same ID with `created: false`. Requires the connected WhatsApp account's token to carry the `whatsapp_business_manage_events` permission. If the permission is missing the endpoint returns 422 with a message asking the user to reconnect the account.
|
|
78
78
|
# @param delete_whatsapp_business_username_request
|
|
79
79
|
# @param [Hash] opts the optional parameters
|
|
80
80
|
# @return [CreateWhatsAppDataset200Response]
|
|
@@ -100,7 +100,7 @@ describe 'WhatsAppApi' do
|
|
|
100
100
|
# Create invite link
|
|
101
101
|
# Create a new invite link for a WhatsApp group. The previous link is revoked. Not available on [Coexistence](/platforms/whatsapp/connection#whatsapp-business-app-coexistence) numbers. Requires a Cloud API-only number.
|
|
102
102
|
# @param group_id Group ID
|
|
103
|
-
# @param account_id WhatsApp
|
|
103
|
+
# @param account_id WhatsApp account ID
|
|
104
104
|
# @param [Hash] opts the optional parameters
|
|
105
105
|
# @return [CreateWhatsAppGroupInviteLink200Response]
|
|
106
106
|
describe 'create_whats_app_group_invite_link test' do
|
|
@@ -125,7 +125,7 @@ describe 'WhatsAppApi' do
|
|
|
125
125
|
# Delete group
|
|
126
126
|
# Delete a WhatsApp group and remove all participants. Not available on [Coexistence](/platforms/whatsapp/connection#whatsapp-business-app-coexistence) numbers. Requires a Cloud API-only number.
|
|
127
127
|
# @param group_id Group ID
|
|
128
|
-
# @param account_id WhatsApp
|
|
128
|
+
# @param account_id WhatsApp account ID
|
|
129
129
|
# @param [Hash] opts the optional parameters
|
|
130
130
|
# @return [UnpublishPost200Response]
|
|
131
131
|
describe 'delete_whats_app_group_chat test' do
|
|
@@ -138,7 +138,7 @@ describe 'WhatsAppApi' do
|
|
|
138
138
|
# Delete template
|
|
139
139
|
# Permanently delete a message template. **Without `language` this deletes every language variant of the name** (Meta's own contract for deletion by name). Pass `language` to delete one variant only; the response `scope` says which happened. Meta keeps a deleted approved template in `PENDING_DELETION` for a while and the name cannot be reused for 30 days.
|
|
140
140
|
# @param template_name Template name (the family).
|
|
141
|
-
# @param account_id WhatsApp
|
|
141
|
+
# @param account_id WhatsApp account ID
|
|
142
142
|
# @param [Hash] opts the optional parameters
|
|
143
143
|
# @option opts [String] :language Delete only this language variant (e.g. es). Omit to delete the whole family.
|
|
144
144
|
# @return [DeleteWhatsAppTemplate200Response]
|
|
@@ -152,7 +152,7 @@ describe 'WhatsAppApi' do
|
|
|
152
152
|
# Delete template by id
|
|
153
153
|
# Delete one language variant by its Meta id. Other languages of the same name are untouched. The name cannot be reused for 30 days once its last variant is deleted.
|
|
154
154
|
# @param template_id Meta template id (numeric).
|
|
155
|
-
# @param account_id WhatsApp
|
|
155
|
+
# @param account_id WhatsApp account ID
|
|
156
156
|
# @param [Hash] opts the optional parameters
|
|
157
157
|
# @return [DeleteWhatsAppTemplateById200Response]
|
|
158
158
|
describe 'delete_whats_app_template_by_id test' do
|
|
@@ -189,7 +189,7 @@ describe 'WhatsAppApi' do
|
|
|
189
189
|
# unit tests for get_whats_app_blocked_users
|
|
190
190
|
# List blocked users
|
|
191
191
|
# List the WhatsApp users blocked on this number. Cursor-paginated; pass `nextCursor` back as `after` to fetch the next page. The blocklist holds up to 64,000 users.
|
|
192
|
-
# @param account_id WhatsApp
|
|
192
|
+
# @param account_id WhatsApp account ID
|
|
193
193
|
# @param [Hash] opts the optional parameters
|
|
194
194
|
# @option opts [Integer] :limit Page size.
|
|
195
195
|
# @option opts [String] :after Cursor from a previous response's `nextCursor`.
|
|
@@ -203,7 +203,7 @@ describe 'WhatsAppApi' do
|
|
|
203
203
|
# unit tests for get_whats_app_business_profile
|
|
204
204
|
# Get business profile
|
|
205
205
|
# Retrieve the WhatsApp Business profile for the account (about, address, description, email, websites, etc.).
|
|
206
|
-
# @param account_id WhatsApp
|
|
206
|
+
# @param account_id WhatsApp account ID
|
|
207
207
|
# @param [Hash] opts the optional parameters
|
|
208
208
|
# @return [GetWhatsAppBusinessProfile200Response]
|
|
209
209
|
describe 'get_whats_app_business_profile test' do
|
|
@@ -214,8 +214,8 @@ describe 'WhatsAppApi' do
|
|
|
214
214
|
|
|
215
215
|
# unit tests for get_whats_app_dataset
|
|
216
216
|
# Get CTWA conversions dataset
|
|
217
|
-
# Returns the Meta Click-to-WhatsApp conversions dataset currently linked to the WhatsApp account, if one has been provisioned. Reads only from the stored `metadata.metaCapiDatasetId`
|
|
218
|
-
# @param account_id WhatsApp
|
|
217
|
+
# Returns the Meta Click-to-WhatsApp conversions dataset currently linked to the WhatsApp account, if one has been provisioned. Reads only from the stored `metadata.metaCapiDatasetId`, never hits Meta, never creates a dataset. Use this to detect whether `POST /v1/whatsapp/conversions` is configured for an account.
|
|
218
|
+
# @param account_id WhatsApp account ID
|
|
219
219
|
# @param [Hash] opts the optional parameters
|
|
220
220
|
# @return [GetWhatsAppDataset200Response]
|
|
221
221
|
describe 'get_whats_app_dataset test' do
|
|
@@ -227,7 +227,7 @@ describe 'WhatsAppApi' do
|
|
|
227
227
|
# unit tests for get_whats_app_display_name
|
|
228
228
|
# Get display name status
|
|
229
229
|
# Fetch the current display name and its Meta review status for a WhatsApp Business account. Display name changes require Meta approval and can take 1-3 business days.
|
|
230
|
-
# @param account_id WhatsApp
|
|
230
|
+
# @param account_id WhatsApp account ID
|
|
231
231
|
# @param [Hash] opts the optional parameters
|
|
232
232
|
# @return [GetWhatsAppDisplayName200Response]
|
|
233
233
|
describe 'get_whats_app_display_name test' do
|
|
@@ -240,7 +240,7 @@ describe 'WhatsAppApi' do
|
|
|
240
240
|
# Get group info
|
|
241
241
|
# Retrieve metadata about a WhatsApp group including subject, description, participants, and settings. Not available on [Coexistence](/platforms/whatsapp/connection#whatsapp-business-app-coexistence) numbers. Requires a Cloud API-only number.
|
|
242
242
|
# @param group_id Group ID
|
|
243
|
-
# @param account_id WhatsApp
|
|
243
|
+
# @param account_id WhatsApp account ID
|
|
244
244
|
# @param [Hash] opts the optional parameters
|
|
245
245
|
# @return [GetWhatsAppGroupChat200Response]
|
|
246
246
|
describe 'get_whats_app_group_chat test' do
|
|
@@ -266,7 +266,7 @@ describe 'WhatsAppApi' do
|
|
|
266
266
|
# Get template
|
|
267
267
|
# Retrieve one message template variant by name. Meta stores one template per **name + language**, so a name identifies a family of variants, each with its own Meta id. Pass `language` to address one variant. Without it, a name with a single variant resolves to that variant; a name with several returns `409 ambiguous_template` with `details.languages`. A bare language (`es`) matches a single regional variant (`es_ES`); if the family has several regional variants for it, that is also a 409. A full code (`es_ES`) must match exactly. Variants in `PENDING_DELETION` are not part of the family.
|
|
268
268
|
# @param template_name Template name (the family).
|
|
269
|
-
# @param account_id WhatsApp
|
|
269
|
+
# @param account_id WhatsApp account ID
|
|
270
270
|
# @param [Hash] opts the optional parameters
|
|
271
271
|
# @option opts [String] :language Language code of the variant (e.g. en_US, es, pt_BR). Required when the family has several languages.
|
|
272
272
|
# @return [GetWhatsAppTemplate200Response]
|
|
@@ -280,7 +280,7 @@ describe 'WhatsAppApi' do
|
|
|
280
280
|
# Get template by id
|
|
281
281
|
# Retrieve one template variant by its Meta id, the id every variant of a family has on its own and the one the `whatsapp.template.status_updated` webhook carries.
|
|
282
282
|
# @param template_id Meta template id (numeric).
|
|
283
|
-
# @param account_id WhatsApp
|
|
283
|
+
# @param account_id WhatsApp account ID
|
|
284
284
|
# @param [Hash] opts the optional parameters
|
|
285
285
|
# @return [GetWhatsAppTemplate200Response]
|
|
286
286
|
describe 'get_whats_app_template_by_id test' do
|
|
@@ -292,7 +292,7 @@ describe 'WhatsAppApi' do
|
|
|
292
292
|
# unit tests for get_whats_app_templates
|
|
293
293
|
# List templates
|
|
294
294
|
# List message templates for the WhatsApp Business Account (WABA) associated with the given account. Templates are fetched directly from the WhatsApp Cloud API. One entry per **name + language**: a multi-language template appears once per language, each with its own Meta `id`.
|
|
295
|
-
# @param account_id WhatsApp
|
|
295
|
+
# @param account_id WhatsApp account ID
|
|
296
296
|
# @param [Hash] opts the optional parameters
|
|
297
297
|
# @option opts [String] :name Exact template name; returns every language variant of that family.
|
|
298
298
|
# @option opts [String] :language Exact language code (e.g. en_US).
|
|
@@ -307,7 +307,7 @@ describe 'WhatsAppApi' do
|
|
|
307
307
|
# unit tests for get_whatsapp_business_username
|
|
308
308
|
# Get business username
|
|
309
309
|
# Fetch the current WhatsApp Business username and its approval status. Username status can be `approved` (active), `reserved` (pending activation), or `none` (no username set).
|
|
310
|
-
# @param account_id WhatsApp
|
|
310
|
+
# @param account_id WhatsApp account ID
|
|
311
311
|
# @param [Hash] opts the optional parameters
|
|
312
312
|
# @return [GetWhatsappBusinessUsername200Response]
|
|
313
313
|
describe 'get_whatsapp_business_username test' do
|
|
@@ -319,7 +319,7 @@ describe 'WhatsAppApi' do
|
|
|
319
319
|
# unit tests for get_whatsapp_business_username_suggestions
|
|
320
320
|
# Get username suggestions
|
|
321
321
|
# Retrieve a list of available WhatsApp Business username suggestions based on the account's business profile name. Use these to help users discover valid, unclaimed usernames.
|
|
322
|
-
# @param account_id WhatsApp
|
|
322
|
+
# @param account_id WhatsApp account ID
|
|
323
323
|
# @param [Hash] opts the optional parameters
|
|
324
324
|
# @return [GetWhatsappBusinessUsernameSuggestions200Response]
|
|
325
325
|
describe 'get_whatsapp_business_username_suggestions test' do
|
|
@@ -331,7 +331,7 @@ describe 'WhatsAppApi' do
|
|
|
331
331
|
# unit tests for list_whats_app_account_events
|
|
332
332
|
# List account notifications
|
|
333
333
|
# Returns Meta-originated events recorded for a WhatsApp account, newest first: template review outcomes (approved, rejected, paused, category changes) and WABA status changes (restricted, disabled, reinstated, disconnected). Events are captured from Meta webhooks as they happen; the feed starts at the account's first recorded event and is not backfilled. Complements the push events `whatsapp.template.status_updated` and `account.disconnected` with a pollable history.
|
|
334
|
-
# @param account_id WhatsApp
|
|
334
|
+
# @param account_id WhatsApp account ID
|
|
335
335
|
# @param [Hash] opts the optional parameters
|
|
336
336
|
# @option opts [Integer] :limit Maximum events to return
|
|
337
337
|
# @return [ListWhatsAppAccountEvents200Response]
|
|
@@ -344,7 +344,7 @@ describe 'WhatsAppApi' do
|
|
|
344
344
|
# unit tests for list_whats_app_conversions
|
|
345
345
|
# List conversion events
|
|
346
346
|
# Returns the most recent conversion events sent through `POST /v1/whatsapp/conversions` for the given WhatsApp account. Sourced from delivery logs (Axiom `late` dataset), so the visible window is bounded by log retention (about 30 days). Useful for rendering a \"recent activity\" panel on the conversions setup tab without standing up a parallel persistence layer. Per-event payload mirrors the structured log we write on every successful send: `eventName`, `conversationId`, `eventsReceived`, `eventsFailed`, `traceId`, `durationMs`, and the wall-clock `timestamp`.
|
|
347
|
-
# @param account_id WhatsApp
|
|
347
|
+
# @param account_id WhatsApp account ID
|
|
348
348
|
# @param [Hash] opts the optional parameters
|
|
349
349
|
# @option opts [Integer] :limit Max events to return (1-200, default 50).
|
|
350
350
|
# @return [ListWhatsAppConversions200Response]
|
|
@@ -357,7 +357,7 @@ describe 'WhatsAppApi' do
|
|
|
357
357
|
# unit tests for list_whats_app_group_chats
|
|
358
358
|
# List active groups
|
|
359
359
|
# List active WhatsApp group chats for a business phone number. These are actual WhatsApp group conversations on the platform. Not available on [Coexistence](/platforms/whatsapp/connection#whatsapp-business-app-coexistence) numbers. Requires a Cloud API-only number.
|
|
360
|
-
# @param account_id WhatsApp
|
|
360
|
+
# @param account_id WhatsApp account ID
|
|
361
361
|
# @param [Hash] opts the optional parameters
|
|
362
362
|
# @option opts [Integer] :limit Max groups to return
|
|
363
363
|
# @option opts [String] :after Pagination cursor
|
|
@@ -372,7 +372,7 @@ describe 'WhatsAppApi' do
|
|
|
372
372
|
# List join requests
|
|
373
373
|
# List pending join requests for a WhatsApp group (only for groups with approval_required mode). Not available on [Coexistence](/platforms/whatsapp/connection#whatsapp-business-app-coexistence) numbers. Requires a Cloud API-only number.
|
|
374
374
|
# @param group_id Group ID
|
|
375
|
-
# @param account_id WhatsApp
|
|
375
|
+
# @param account_id WhatsApp account ID
|
|
376
376
|
# @param [Hash] opts the optional parameters
|
|
377
377
|
# @return [ListWhatsAppGroupJoinRequests200Response]
|
|
378
378
|
describe 'list_whats_app_group_join_requests test' do
|
|
@@ -398,7 +398,7 @@ describe 'WhatsAppApi' do
|
|
|
398
398
|
# Reject join requests
|
|
399
399
|
# Reject pending join requests for a WhatsApp group. Not available on [Coexistence](/platforms/whatsapp/connection#whatsapp-business-app-coexistence) numbers. Requires a Cloud API-only number.
|
|
400
400
|
# @param group_id Group ID
|
|
401
|
-
# @param account_id WhatsApp
|
|
401
|
+
# @param account_id WhatsApp account ID
|
|
402
402
|
# @param reject_whats_app_group_join_requests_request
|
|
403
403
|
# @param [Hash] opts the optional parameters
|
|
404
404
|
# @return [UnpublishPost200Response]
|
|
@@ -412,7 +412,7 @@ describe 'WhatsAppApi' do
|
|
|
412
412
|
# Remove participants
|
|
413
413
|
# Remove participants from a WhatsApp group. Not available on [Coexistence](/platforms/whatsapp/connection#whatsapp-business-app-coexistence) numbers. Requires a Cloud API-only number.
|
|
414
414
|
# @param group_id Group ID
|
|
415
|
-
# @param account_id WhatsApp
|
|
415
|
+
# @param account_id WhatsApp account ID
|
|
416
416
|
# @param remove_whats_app_group_participants_request
|
|
417
417
|
# @param [Hash] opts the optional parameters
|
|
418
418
|
# @return [UnpublishPost200Response]
|
|
@@ -486,7 +486,7 @@ describe 'WhatsAppApi' do
|
|
|
486
486
|
# Update group settings
|
|
487
487
|
# Update the subject, description, or join approval mode of a WhatsApp group. Not available on [Coexistence](/platforms/whatsapp/connection#whatsapp-business-app-coexistence) numbers. Requires a Cloud API-only number.
|
|
488
488
|
# @param group_id Group ID
|
|
489
|
-
# @param account_id WhatsApp
|
|
489
|
+
# @param account_id WhatsApp account ID
|
|
490
490
|
# @param update_whats_app_group_chat_request
|
|
491
491
|
# @param [Hash] opts the optional parameters
|
|
492
492
|
# @return [UnpublishPost200Response]
|
|
@@ -524,8 +524,8 @@ describe 'WhatsAppApi' do
|
|
|
524
524
|
|
|
525
525
|
# unit tests for upload_whats_app_profile_photo
|
|
526
526
|
# Upload profile picture
|
|
527
|
-
# Upload a new profile picture for the WhatsApp Business Profile. Uses Meta's resumable upload API under the hood: creates an upload session, uploads the image bytes, then updates the business profile with the resulting handle. Provide the image either as a binary upload (`multipart/form-data` with `file`) or as a download URL (`application/json` with `url`)
|
|
528
|
-
# @param account_id WhatsApp
|
|
527
|
+
# Upload a new profile picture for the WhatsApp Business Profile. Uses Meta's resumable upload API under the hood: creates an upload session, uploads the image bytes, then updates the business profile with the resulting handle. Provide the image either as a binary upload (`multipart/form-data` with `file`) or as a download URL (`application/json` with `url`). With a URL we fetch the image server-side and upload the bytes for you. Meta's profile-photo API is bytes-only, so there is no direct URL passthrough. JPEG/PNG, max 5MB either way.
|
|
528
|
+
# @param account_id WhatsApp account ID
|
|
529
529
|
# @param file Image file (JPEG or PNG, max 5MB, recommended 640x640)
|
|
530
530
|
# @param [Hash] opts the optional parameters
|
|
531
531
|
# @return [UnpublishPost200Response]
|
|
@@ -140,7 +140,7 @@ describe 'WhatsAppCallingApi' do
|
|
|
140
140
|
|
|
141
141
|
# unit tests for get_whats_app_calling
|
|
142
142
|
# Get calling config for a number
|
|
143
|
-
# The WhatsApp Business Calling configuration of this number, keyed the same way as the POST/PATCH/DELETE below (full read-write on one sub-resource). Encrypted secrets are never returned; only a boolean saying whether a SIP password is stored. The account-scoped read (`GET /v1/whatsapp/calling?accountId=`) remains for callers that only know the
|
|
143
|
+
# The WhatsApp Business Calling configuration of this number, keyed the same way as the POST/PATCH/DELETE below (full read-write on one sub-resource). Encrypted secrets are never returned; only a boolean saying whether a SIP password is stored. The account-scoped read (`GET /v1/whatsapp/calling?accountId=`) remains for callers that only know the account id, and additionally carries account-level extras (billing eligibility, current-period spend).
|
|
144
144
|
# @param id Phone number record ID (from GET /v1/phone-numbers).
|
|
145
145
|
# @param [Hash] opts the optional parameters
|
|
146
146
|
# @return [GetWhatsAppCalling200Response]
|
|
@@ -153,7 +153,7 @@ describe 'WhatsAppCallingApi' do
|
|
|
153
153
|
# unit tests for get_whats_app_calling_config
|
|
154
154
|
# Get calling config for an account
|
|
155
155
|
# Returns the local calling configuration snapshot for the connected WhatsApp account: whether calling is enabled, the forward-to destination URI, recording opt-in state, the phone number record id (use as `{id}` on the read-write calling sub-resource at /v1/phone-numbers/{id}/whatsapp/calling) and whether SIP digest credentials are stored (the encrypted password itself is never returned). Also carries account-level extras (billing eligibility, current-period spend) that the number-keyed GET does not.
|
|
156
|
-
# @param account_id WhatsApp
|
|
156
|
+
# @param account_id WhatsApp account ID
|
|
157
157
|
# @param [Hash] opts the optional parameters
|
|
158
158
|
# @return [GetWhatsAppCallingConfig200Response]
|
|
159
159
|
describe 'get_whats_app_calling_config test' do
|
|
@@ -48,7 +48,7 @@ describe 'WhatsAppFlowsApi' do
|
|
|
48
48
|
# Delete flow
|
|
49
49
|
# Delete a DRAFT flow. This is irreversible. Only flows in DRAFT status can be deleted.
|
|
50
50
|
# @param flow_id Flow ID
|
|
51
|
-
# @param account_id WhatsApp
|
|
51
|
+
# @param account_id WhatsApp account ID
|
|
52
52
|
# @param [Hash] opts the optional parameters
|
|
53
53
|
# @return [UpdateYoutubeDefaultPlaylist200Response]
|
|
54
54
|
describe 'delete_whats_app_flow test' do
|
|
@@ -74,7 +74,7 @@ describe 'WhatsAppFlowsApi' do
|
|
|
74
74
|
# Get flow
|
|
75
75
|
# Get details for a specific flow, including status, categories, validation errors, and preview URL.
|
|
76
76
|
# @param flow_id Flow ID
|
|
77
|
-
# @param account_id WhatsApp
|
|
77
|
+
# @param account_id WhatsApp account ID
|
|
78
78
|
# @param [Hash] opts the optional parameters
|
|
79
79
|
# @option opts [String] :fields Comma-separated fields to return (default: id,name,status,categories,validation_errors,json_version,preview,data_api_version,endpoint_uri)
|
|
80
80
|
# @return [GetWhatsAppFlow200Response]
|
|
@@ -88,7 +88,7 @@ describe 'WhatsAppFlowsApi' do
|
|
|
88
88
|
# Get flow JSON asset
|
|
89
89
|
# Get the flow JSON asset metadata, including a temporary download URL for the Flow JSON file.
|
|
90
90
|
# @param flow_id Flow ID
|
|
91
|
-
# @param account_id WhatsApp
|
|
91
|
+
# @param account_id WhatsApp account ID
|
|
92
92
|
# @param [Hash] opts the optional parameters
|
|
93
93
|
# @return [GetWhatsAppFlowJson200Response]
|
|
94
94
|
describe 'get_whats_app_flow_json test' do
|
|
@@ -101,7 +101,7 @@ describe 'WhatsAppFlowsApi' do
|
|
|
101
101
|
# Get flow preview URL
|
|
102
102
|
# Get Meta's public web-preview URL for a flow (drafts included), embeddable as an interactive iframe. The link is reused across calls (valid ~30 days); pass invalidate=true to mint a fresh one (the previous link stops working).
|
|
103
103
|
# @param flow_id Flow ID
|
|
104
|
-
# @param account_id WhatsApp
|
|
104
|
+
# @param account_id WhatsApp account ID
|
|
105
105
|
# @param [Hash] opts the optional parameters
|
|
106
106
|
# @option opts [Boolean] :invalidate Mint a fresh preview link (default false)
|
|
107
107
|
# @return [GetWhatsAppFlowPreview200Response]
|
|
@@ -114,7 +114,7 @@ describe 'WhatsAppFlowsApi' do
|
|
|
114
114
|
# unit tests for get_whats_app_flows_encryption_key
|
|
115
115
|
# Get Flows encryption key status
|
|
116
116
|
# Read the RSA business public key registered on the phone number for WhatsApp Flows endpoint encryption. Only one key is active per phone number at a time. Flows that use flow_action: data_exchange (an endpoint-backed flow) stop working at runtime until the endpoint serves the matching private key, and Meta rejects publish with error code 139002 (\"Missing Flows Signed Public Key\") when no key is registered. `registered` reflects whether a key is present, never `signatureStatus` alone: Meta reports an unregistered key as MISMATCH rather than a null/absent value.
|
|
117
|
-
# @param account_id WhatsApp
|
|
117
|
+
# @param account_id WhatsApp account ID
|
|
118
118
|
# @param [Hash] opts the optional parameters
|
|
119
119
|
# @return [GetWhatsAppFlowsEncryptionKey200Response]
|
|
120
120
|
describe 'get_whats_app_flows_encryption_key test' do
|
|
@@ -125,8 +125,8 @@ describe 'WhatsAppFlowsApi' do
|
|
|
125
125
|
|
|
126
126
|
# unit tests for list_whats_app_flow_responses
|
|
127
127
|
# List flow responses
|
|
128
|
-
# List the responses customers submitted when completing a flow (parsed from the nfm_reply messages received via webhook), newest first. Scope to a single flow with `flowId`
|
|
129
|
-
# @param account_id WhatsApp
|
|
128
|
+
# List the responses customers submitted when completing a flow (parsed from the nfm_reply messages received via webhook), newest first. Scope to a single flow with `flowId`, which matches responses whose flow_token carries the `<flowId>:` prefix that Zernio stamps on auto-generated tokens at send time. Responses sent with a custom integrator-supplied flow_token are not attributed to a flow.
|
|
129
|
+
# @param account_id WhatsApp account ID
|
|
130
130
|
# @param [Hash] opts the optional parameters
|
|
131
131
|
# @option opts [String] :flow_id Scope to responses for this flow
|
|
132
132
|
# @option opts [Integer] :limit Max responses to return
|
|
@@ -139,9 +139,9 @@ describe 'WhatsAppFlowsApi' do
|
|
|
139
139
|
|
|
140
140
|
# unit tests for list_whats_app_flow_versions
|
|
141
141
|
# List flow versions
|
|
142
|
-
# List the flow's version history (the clone lineage Zernio tracks, since Meta has no native versioning), newest version first. Each entry is enriched with the version's live name and status from Meta. A flow with no lineage returns
|
|
142
|
+
# List the flow's version history (the clone lineage Zernio tracks, since Meta has no native versioning), newest version first. Each entry is enriched with the version's live name and status from Meta. A flow with no lineage returns only itself as version 1.
|
|
143
143
|
# @param flow_id Flow ID
|
|
144
|
-
# @param account_id WhatsApp
|
|
144
|
+
# @param account_id WhatsApp account ID
|
|
145
145
|
# @param [Hash] opts the optional parameters
|
|
146
146
|
# @return [ListWhatsAppFlowVersions200Response]
|
|
147
147
|
describe 'list_whats_app_flow_versions test' do
|
|
@@ -153,7 +153,7 @@ describe 'WhatsAppFlowsApi' do
|
|
|
153
153
|
# unit tests for list_whats_app_flows
|
|
154
154
|
# List flows
|
|
155
155
|
# List all WhatsApp Flows for the Business Account (WABA) associated with the given account.
|
|
156
|
-
# @param account_id WhatsApp
|
|
156
|
+
# @param account_id WhatsApp account ID
|
|
157
157
|
# @param [Hash] opts the optional parameters
|
|
158
158
|
# @return [ListWhatsAppFlows200Response]
|
|
159
159
|
describe 'list_whats_app_flows test' do
|
|
@@ -48,7 +48,7 @@ describe 'WhatsAppPhoneNumbersApi' do
|
|
|
48
48
|
|
|
49
49
|
# unit tests for create_whats_app_number_kyc_link
|
|
50
50
|
# Create a hosted KYC link
|
|
51
|
-
# Deprecated alias of `/v1/phone-numbers/kyc/share`; same contract. New integrations should use that path. Create a single-use, 7-day hosted KYC link that your end customer completes WITHOUT a Zernio login
|
|
51
|
+
# Deprecated alias of `/v1/phone-numbers/kyc/share`; same contract. New integrations should use that path. Create a single-use, 7-day hosted KYC link that your end customer completes WITHOUT a Zernio login. Useful when the person who holds the ID and address is not your team. They fill the regulated verification on a Zernio-hosted page; the number provisions under YOUR account once they submit. Only regulated (KYC) countries are valid: a country that does not require KYC returns 400. White-label the page with `branding` (your company name, logo, brand color). Supply `redirect_url` to send the end customer back to your own site after a successful submit (completion params are appended; see below). Listen for the `whatsapp.number.kyc_submitted` webhook to react when the form is completed.
|
|
52
52
|
# @param create_phone_number_kyc_link_request
|
|
53
53
|
# @param [Hash] opts the optional parameters
|
|
54
54
|
# @return [CreatePhoneNumberKycLink200Response]
|
|
@@ -61,7 +61,7 @@ describe 'WhatsAppPhoneNumbersApi' do
|
|
|
61
61
|
# unit tests for get_whats_app_number_info
|
|
62
62
|
# Get number status
|
|
63
63
|
# Live snapshot of a connected number straight from Meta: the phone-number node (display number, display name + approval, quality rating, messaging-limit tier, throughput, official-business badge, connection status, health_status) and its owning WhatsApp Business Account (name, business verification, timezone, health_status). Fetched live because Meta updates quality/tier/name/health over time; the call also refreshes the cached values shown on the connection card.
|
|
64
|
-
# @param account_id WhatsApp
|
|
64
|
+
# @param account_id WhatsApp account ID
|
|
65
65
|
# @param [Hash] opts the optional parameters
|
|
66
66
|
# @return [GetWhatsAppNumberInfo200Response]
|
|
67
67
|
describe 'get_whats_app_number_info test' do
|
|
@@ -85,7 +85,7 @@ describe 'WhatsAppPhoneNumbersApi' do
|
|
|
85
85
|
|
|
86
86
|
# unit tests for get_whats_app_number_remediation
|
|
87
87
|
# Get declined requirements
|
|
88
|
-
# Deprecated alias of `/v1/phone-numbers/{id}/remediate`; same contract. New integrations should use that path. For a number in `regulatory_declined`, returns ONLY the requirements the reviewer flagged declined, as a form spec (same shape as the KYC form GET). The customer fixes
|
|
88
|
+
# Deprecated alias of `/v1/phone-numbers/{id}/remediate`; same contract. New integrations should use that path. For a number in `regulatory_declined`, returns ONLY the requirements the reviewer flagged declined, as a form spec (same shape as the KYC form GET). The customer fixes only those, because Telnyx supports correcting a declined requirement group and re-submitting it (no new number/group). Falls back to the full spec if the provider exposes no per-requirement flags.
|
|
89
89
|
# @param id WhatsAppPhoneNumber id.
|
|
90
90
|
# @param [Hash] opts the optional parameters
|
|
91
91
|
# @return [GetWhatsAppNumberRemediation200Response]
|
|
@@ -97,7 +97,7 @@ describe 'WhatsAppPhoneNumbersApi' do
|
|
|
97
97
|
|
|
98
98
|
# unit tests for get_whats_app_phone_number
|
|
99
99
|
# Get phone number
|
|
100
|
-
# Deprecated alias of `/v1/phone-numbers/{id}`; same contract. New integrations should use that path. Retrieve the current status of a purchased phone number. Poll this to track Meta pre-verification (US sync path) and, for regulated (Tier 3/4) numbers, the async lifecycle: pending_regulatory → active (or regulatory_declined). When a regulated number has an Onfido ID step, `onfidoVerificationUrl` appears here once the order is placed
|
|
100
|
+
# Deprecated alias of `/v1/phone-numbers/{id}`; same contract. New integrations should use that path. Retrieve the current status of a purchased phone number. Poll this to track Meta pre-verification (US sync path) and, for regulated (Tier 3/4) numbers, the async lifecycle: pending_regulatory → active (or regulatory_declined). When a regulated number has an Onfido ID step, `onfidoVerificationUrl` appears here once the order is placed. Forward it to the end user. (Or subscribe to the whatsapp.number.* webhooks instead of polling.)
|
|
101
101
|
# @param phone_number_id Phone number record ID
|
|
102
102
|
# @param [Hash] opts the optional parameters
|
|
103
103
|
# @return [GetPhoneNumber200Response]
|
|
@@ -109,9 +109,9 @@ describe 'WhatsAppPhoneNumbersApi' do
|
|
|
109
109
|
|
|
110
110
|
# unit tests for get_whats_app_phone_numbers
|
|
111
111
|
# List phone numbers
|
|
112
|
-
# Deprecated alias of `/v1/phone-numbers`; same contract. New integrations should use that path. List all WhatsApp phone numbers purchased by the authenticated user. By default, released numbers are excluded. Connected (bring-your-own) numbers are returned in the separate `connected` array
|
|
112
|
+
# Deprecated alias of `/v1/phone-numbers`; same contract. New integrations should use that path. List all WhatsApp phone numbers purchased by the authenticated user. By default, released numbers are excluded. Connected (bring-your-own) numbers are returned in the separate `connected` array. They are not billed and have no provisioning lifecycle.
|
|
113
113
|
# @param [Hash] opts the optional parameters
|
|
114
|
-
# @option opts [String] :status Filter by status (by default excludes released numbers). NOTE: `status=pending_regulatory` returns the \"provisioning\" view
|
|
114
|
+
# @option opts [String] :status Filter by status (by default excludes released numbers). NOTE: `status=pending_regulatory` returns the \"provisioning\" view: numbers still in review PLUS recently-declined (last 30 days) ones, so a failed registration surfaces (with `regulatoryDeclineReason`) instead of silently disappearing. Declined numbers can be re-submitted via POST /v1/whatsapp/phone-numbers/{id}/remediate. `verifying` is the short-lived state after the number is provisioned on our side while WhatsApp confirms the activation code; the number is not billed until it reaches `active`.
|
|
115
115
|
# @option opts [String] :profile_id Filter by profile
|
|
116
116
|
# @return [ListPhoneNumbers200Response]
|
|
117
117
|
describe 'get_whats_app_phone_numbers test' do
|
|
@@ -133,7 +133,7 @@ describe 'WhatsAppPhoneNumbersApi' do
|
|
|
133
133
|
|
|
134
134
|
# unit tests for move_whats_app_number_to_profile
|
|
135
135
|
# Move a number to another profile
|
|
136
|
-
# Move a provisioned number to a different profile. A number is not a single record. Alongside the number itself there are hidden telephony owner accounts (platform `phone`, plus `sms` when SMS is enabled) and, once WhatsApp is connected, the `whatsapp` account. They all carry a profileId and this endpoint moves them together. Use this instead of `PATCH /v1/accounts/{accountId}`: that one moves the
|
|
136
|
+
# Move a provisioned number to a different profile. A number is not a single record. Alongside the number itself there are hidden telephony owner accounts (platform `phone`, plus `sms` when SMS is enabled) and, once WhatsApp is connected, the `whatsapp` account. They all carry a profileId and this endpoint moves them together. Use this instead of `PATCH /v1/accounts/{accountId}`: that one moves the account only and leaves the number itself pinned to its original profile, which splits the number across two profiles. Connecting a Zernio-provisioned number from any profile but its own is rejected with a `409` (`WHATSAPP_NUMBER_PINNED_TO_PROFILE`). This endpoint is how you re-home the number first, so it can then be connected from the new profile. `id` is the number record id from `GET /v1/phone-numbers`, not an account id. A profile holds at most one account per platform, so the destination must be free of every platform this number occupies.
|
|
137
137
|
# @param id WhatsAppPhoneNumber id.
|
|
138
138
|
# @param move_whats_app_number_to_profile_request
|
|
139
139
|
# @param [Hash] opts the optional parameters
|
|
@@ -158,7 +158,7 @@ describe 'WhatsAppPhoneNumbersApi' do
|
|
|
158
158
|
|
|
159
159
|
# unit tests for release_whats_app_phone_number
|
|
160
160
|
# Release phone number
|
|
161
|
-
# Deprecated alias of `/v1/phone-numbers/{id}`; same contract. New integrations should use that path. Release a purchased phone number. This will: 1. Disconnect any linked WhatsApp
|
|
161
|
+
# Deprecated alias of `/v1/phone-numbers/{id}`; same contract. New integrations should use that path. Release a purchased phone number. This will: 1. Disconnect any linked WhatsApp account 2. Decrement the Stripe subscription quantity (or cancel if last number) 3. Release the number from Telnyx 4. Mark the number as released
|
|
162
162
|
# @param phone_number_id Phone number record ID
|
|
163
163
|
# @param [Hash] opts the optional parameters
|
|
164
164
|
# @return [ReleasePhoneNumber200Response]
|
|
@@ -170,7 +170,7 @@ describe 'WhatsAppPhoneNumbersApi' do
|
|
|
170
170
|
|
|
171
171
|
# unit tests for remediate_whats_app_number
|
|
172
172
|
# Resubmit a declined number
|
|
173
|
-
# Deprecated alias of `/v1/phone-numbers/{id}/remediate`; same contract. New integrations should use that path. Submit corrected values/documents for the declined requirement(s). We PATCH them onto the SAME requirement group and re-submit it for approval; the number goes `regulatory_declined` → `pending_regulatory`. No new number and no new billing. Body shape matches the KYC submit (values / documents / address)
|
|
173
|
+
# Deprecated alias of `/v1/phone-numbers/{id}/remediate`; same contract. New integrations should use that path. Submit corrected values/documents for the declined requirement(s). We PATCH them onto the SAME requirement group and re-submit it for approval; the number goes `regulatory_declined` → `pending_regulatory`. No new number and no new billing. Body shape matches the KYC submit (values / documents / address). Send only the corrected fields.
|
|
174
174
|
# @param id
|
|
175
175
|
# @param remediate_phone_number_request
|
|
176
176
|
# @param [Hash] opts the optional parameters
|
|
@@ -200,7 +200,7 @@ describe 'WhatsAppPhoneNumbersApi' do
|
|
|
200
200
|
|
|
201
201
|
# unit tests for submit_whats_app_number_kyc
|
|
202
202
|
# Submit KYC
|
|
203
|
-
# Deprecated alias of `/v1/phone-numbers/kyc`; same contract. New integrations should use that path. Submit the end customer's KYC (textual values, uploaded documents, address) for a Tier 3/4 country. Documents are streamed straight to the number provider and are not stored by Zernio. Builds + submits a regulatory requirement group and claims a pending_regulatory slot; the number is ordered + activated once the provider approves (asynchronous). A customer may hold several same-country numbers in review at once; a double-submit of the SAME attempt is deduped via `submissionId`. For an ID-card document requirement, carriers commonly require BOTH sides: combine the front and back into a single file before uploading (the dashboard does this automatically). A one-sided ID is a common decline reason; fix it via POST /v1/whatsapp/phone-numbers/{id}/remediate. Before submitting, call GET /v1/whatsapp/phone-numbers/availability to check the country has deliverable inventory and, for geographic-match countries, which area the address must be in
|
|
203
|
+
# Deprecated alias of `/v1/phone-numbers/kyc`; same contract. New integrations should use that path. Submit the end customer's KYC (textual values, uploaded documents, address) for a Tier 3/4 country. Documents are streamed straight to the number provider and are not stored by Zernio. Builds + submits a regulatory requirement group and claims a pending_regulatory slot; the number is ordered + activated once the provider approves (asynchronous). A customer may hold several same-country numbers in review at once; a double-submit of the SAME attempt is deduped via `submissionId`. For an ID-card document requirement, carriers commonly require BOTH sides: combine the front and back into a single file before uploading (the dashboard does this automatically). A one-sided ID is a common decline reason; fix it via POST /v1/whatsapp/phone-numbers/{id}/remediate. Before submitting, call GET /v1/whatsapp/phone-numbers/availability to check the country has deliverable inventory and, for geographic-match countries, which area the address must be in. Otherwise the submission can pass review yet never be assignable a number.
|
|
204
204
|
# @param submit_whats_app_number_kyc_request
|
|
205
205
|
# @param [Hash] opts the optional parameters
|
|
206
206
|
# @return [SubmitPhoneNumberKyc200Response]
|
|
@@ -34,7 +34,7 @@ describe 'WhatsAppSandboxApi' do
|
|
|
34
34
|
|
|
35
35
|
# unit tests for create_whats_app_sandbox_session
|
|
36
36
|
# Start a sandbox activation
|
|
37
|
-
# Creates (or refreshes) a pending sandbox session for the given phone and immediately fires the verified sandbox template from the shared sandbox number to that phone. The session activates when the phone owner replies to that WhatsApp message
|
|
37
|
+
# Creates (or refreshes) a pending sandbox session for the given phone and immediately fires the verified sandbox template from the shared sandbox number to that phone. The session activates when the phone owner replies to that WhatsApp message: the reply itself is proof of ownership. One phone per user: if the caller already has a non-expired session for a DIFFERENT phone, the request is rejected with `invalid_field_value` (the message names the existing phone so it can be revoked first). Re-creating a session for the SAME phone is idempotent and refreshes the verification template. If Meta rejects the template send (not a WhatsApp number, paused WABA, token issue), the pending row is rolled back and the Meta error message is returned in `error` so the caller knows why.
|
|
38
38
|
# @param create_whats_app_sandbox_session_request
|
|
39
39
|
# @param [Hash] opts the optional parameters
|
|
40
40
|
# @return [CreateWhatsAppSandboxSession200Response]
|
|
@@ -46,7 +46,7 @@ describe 'WhatsAppSandboxApi' do
|
|
|
46
46
|
|
|
47
47
|
# unit tests for delete_whats_app_sandbox_session
|
|
48
48
|
# Revoke a sandbox session
|
|
49
|
-
# Hard-deletes the session. The user loses the ability to send to that phone via the sandbox until they re-activate it. Existing conversations and messages already exchanged with that phone are untouched
|
|
49
|
+
# Hard-deletes the session. The user loses the ability to send to that phone via the sandbox until they re-activate it. Existing conversations and messages already exchanged with that phone are untouched. Revocation only blocks FUTURE sends. Sessions belonging to other users cannot be revoked; the response is the same 400 as \"session not found\" so existence isn't leaked.
|
|
50
50
|
# @param session_id The session id returned by POST /v1/whatsapp/sandbox/sessions.
|
|
51
51
|
# @param [Hash] opts the optional parameters
|
|
52
52
|
# @return [UpdateYoutubeDefaultPlaylist200Response]
|
|
@@ -35,7 +35,7 @@ describe 'WhatsAppTemplatesApi' do
|
|
|
35
35
|
# unit tests for get_whats_app_library_template
|
|
36
36
|
# Look up a library template
|
|
37
37
|
# Look up a single pre-approved Template Library template by its exact name, to introspect its structure before importing it. Most importantly it returns the template's `buttons`: a library template with `URL` / `PHONE_NUMBER` buttons must be created with a matching `library_template_button_inputs` array (see Create Template), or Meta rejects it. Use this to discover which inputs to collect.
|
|
38
|
-
# @param account_id WhatsApp
|
|
38
|
+
# @param account_id WhatsApp account ID
|
|
39
39
|
# @param name Exact library template name
|
|
40
40
|
# @param [Hash] opts the optional parameters
|
|
41
41
|
# @option opts [String] :language Desired language variant (e.g. es, en_US). If the template is not offered in it, the first available variant is returned and named in the response language field.
|
|
@@ -70,7 +70,7 @@ describe 'WorkflowsApi' do
|
|
|
70
70
|
|
|
71
71
|
# unit tests for duplicate_workflow
|
|
72
72
|
# Duplicate a workflow
|
|
73
|
-
# Create an independent copy of a workflow's graph, name, description, and account binding. The copy is created in `draft` status with fresh execution counters and a new id
|
|
73
|
+
# Create an independent copy of a workflow's graph, name, description, and account binding. The copy is created in `draft` status with fresh execution counters and a new id. Execution history is NOT copied. Useful for branching off a known-good workflow before making experimental edits.
|
|
74
74
|
# @param workflow_id
|
|
75
75
|
# @param [Hash] opts the optional parameters
|
|
76
76
|
# @return [DuplicateWorkflow201Response]
|
|
@@ -135,7 +135,7 @@ describe 'WorkflowsApi' do
|
|
|
135
135
|
|
|
136
136
|
# unit tests for list_workflow_versions
|
|
137
137
|
# List a workflow's version history
|
|
138
|
-
# Returns the snapshot history. A new version is recorded automatically before every PATCH to `nodes` / `edges` / `entryNodeId`, and explicitly when a previous version is restored. Lightweight list
|
|
138
|
+
# Returns the snapshot history. A new version is recorded automatically before every PATCH to `nodes` / `edges` / `entryNodeId`, and explicitly when a previous version is restored. Lightweight list. Call `getWorkflowVersion` for the full snapshot graph.
|
|
139
139
|
# @param workflow_id
|
|
140
140
|
# @param [Hash] opts the optional parameters
|
|
141
141
|
# @return [ListWorkflowVersions200Response]
|
|
@@ -187,7 +187,7 @@ describe 'WorkflowsApi' do
|
|
|
187
187
|
|
|
188
188
|
# unit tests for trigger_workflow
|
|
189
189
|
# Manually start a workflow run
|
|
190
|
-
# Kick off a run without waiting for an inbound message (useful for testing). Target an existing conversation by `conversationId`, or
|
|
190
|
+
# Kick off a run without waiting for an inbound message (useful for testing). Target an existing conversation by `conversationId`, or (WhatsApp only) a phone number via `to` (a conversation is found or created). `text` seeds the run's `lastMessage` variable. The graph must be runnable.
|
|
191
191
|
# @param workflow_id
|
|
192
192
|
# @param trigger_workflow_request
|
|
193
193
|
# @param [Hash] opts the optional parameters
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Zernio API
|
|
3
|
+
|
|
4
|
+
#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api Versioning and deprecation: all endpoints are versioned in the URL path (current version: /v1). Breaking changes only ship in a new path version; existing versions keep working. Deprecated operations are marked 'deprecated: true' in this spec and announced in the changelog (https://zernio.com/changelog) before removal. Errors: every 4xx/5xx response is application/json with a machine-readable 'code' and a human-readable 'error' message (see the ErrorResponse schema).
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.0.4
|
|
7
|
+
Contact: support@zernio.com
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.19.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'spec_helper'
|
|
14
|
+
require 'json'
|
|
15
|
+
require 'date'
|
|
16
|
+
|
|
17
|
+
# Unit tests for Zernio::Conversation
|
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
|
19
|
+
# Please update as you see appropriate
|
|
20
|
+
describe Zernio::Conversation do
|
|
21
|
+
#let(:instance) { Zernio::Conversation.new }
|
|
22
|
+
|
|
23
|
+
describe 'test an instance of Conversation' do
|
|
24
|
+
it 'should create an instance of Conversation' do
|
|
25
|
+
# uncomment below to test the instance creation
|
|
26
|
+
#expect(instance).to be_instance_of(Zernio::Conversation)
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
describe 'test attribute "id"' do
|
|
31
|
+
it 'should work' do
|
|
32
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
describe 'test attribute "platform"' do
|
|
37
|
+
it 'should work' do
|
|
38
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
39
|
+
# validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["instagram", "facebook", "telegram", "whatsapp", "twitter", "reddit", "bluesky", "sms", "slack"])
|
|
40
|
+
# validator.allowable_values.each do |value|
|
|
41
|
+
# expect { instance.platform = value }.not_to raise_error
|
|
42
|
+
# end
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
describe 'test attribute "platform_conversation_id"' do
|
|
47
|
+
it 'should work' do
|
|
48
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
49
|
+
end
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
describe 'test attribute "participant_id"' do
|
|
53
|
+
it 'should work' do
|
|
54
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
55
|
+
end
|
|
56
|
+
end
|
|
57
|
+
|
|
58
|
+
describe 'test attribute "participant_name"' do
|
|
59
|
+
it 'should work' do
|
|
60
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
61
|
+
end
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
describe 'test attribute "participant_username"' do
|
|
65
|
+
it 'should work' do
|
|
66
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
67
|
+
end
|
|
68
|
+
end
|
|
69
|
+
|
|
70
|
+
describe 'test attribute "participant_picture"' do
|
|
71
|
+
it 'should work' do
|
|
72
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
73
|
+
end
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
describe 'test attribute "status"' do
|
|
77
|
+
it 'should work' do
|
|
78
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
79
|
+
# validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["active", "archived"])
|
|
80
|
+
# validator.allowable_values.each do |value|
|
|
81
|
+
# expect { instance.status = value }.not_to raise_error
|
|
82
|
+
# end
|
|
83
|
+
end
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
describe 'test attribute "contact_id"' do
|
|
87
|
+
it 'should work' do
|
|
88
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
89
|
+
end
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
end
|
|
@@ -48,7 +48,7 @@ describe Zernio::CreateWebhookSettingsRequest do
|
|
|
48
48
|
describe 'test attribute "events"' do
|
|
49
49
|
it 'should work' do
|
|
50
50
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
|
51
|
-
# validator = Petstore::EnumTest::EnumAttributeValidator.new('Array<String>', ["post.scheduled", "post.published", "post.failed", "post.partial", "post.cancelled", "post.recycled", "post.platform.published", "post.platform.failed", "post.platform.deleted", "post.tiktok.url_resolved", "post.external.created", "post.external.updated", "post.external.deleted", "account.connected", "account.disconnected", "account.ads.initial_sync_completed", "analytics.synced", "message.received", "conversation.started", "call.received", "call.ended", "call.failed", "call.permission_request", "message.sent", "message.edited", "message.deleted", "message.delivered", "message.read", "message.failed", "reaction.received", "referral.received", "comment.received", "review.new", "review.updated", "lead.received", "ad.status_changed", "whatsapp.template.status_updated", "whatsapp.template.category_updated", "whatsapp.account.name_status_updated", "whatsapp.automatic_event", "whatsapp.number.activated", "whatsapp.number.declined", "whatsapp.number.action_required", "whatsapp.number.verification_required", "whatsapp.number.suspended", "whatsapp.number.reactivated", "whatsapp.number.released", "whatsapp.number.kyc_submitted", "phone_number.stock_available", "verification.approved", "verification.failed"])
|
|
51
|
+
# validator = Petstore::EnumTest::EnumAttributeValidator.new('Array<String>', ["post.scheduled", "post.published", "post.failed", "post.partial", "post.cancelled", "post.recycled", "post.platform.published", "post.platform.failed", "post.platform.deleted", "post.tiktok.url_resolved", "post.external.created", "post.external.updated", "post.external.deleted", "account.connected", "account.disconnected", "account.ads.initial_sync_completed", "analytics.synced", "message.received", "conversation.started", "conversation.control_changed", "call.received", "call.ended", "call.failed", "call.permission_request", "message.sent", "message.edited", "message.deleted", "message.delivered", "message.read", "message.failed", "reaction.received", "referral.received", "comment.received", "review.new", "review.updated", "lead.received", "ad.status_changed", "whatsapp.template.status_updated", "whatsapp.template.category_updated", "whatsapp.account.name_status_updated", "whatsapp.automatic_event", "whatsapp.number.activated", "whatsapp.number.declined", "whatsapp.number.action_required", "whatsapp.number.verification_required", "whatsapp.number.suspended", "whatsapp.number.reactivated", "whatsapp.number.released", "whatsapp.number.kyc_submitted", "phone_number.stock_available", "verification.approved", "verification.failed"])
|
|
52
52
|
# validator.allowable_values.each do |value|
|
|
53
53
|
# expect { instance.events = value }.not_to raise_error
|
|
54
54
|
# end
|