sentdm 0.45.0 → 0.46.0
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/CHANGELOG.md +11 -0
- data/README.md +11 -11
- data/lib/sentdm/client.rb +66 -0
- data/lib/sentdm/internal/sender_profiles_page.rb +140 -0
- data/lib/sentdm/internal/type/enum.rb +11 -11
- data/lib/sentdm/models/account.rb +173 -0
- data/lib/sentdm/models/account_channels.rb +39 -0
- data/lib/sentdm/models/account_profile.rb +86 -0
- data/lib/sentdm/models/account_rcs_channel.rb +26 -0
- data/lib/sentdm/models/account_sms_channel.rb +26 -0
- data/lib/sentdm/models/account_whatsapp_channel.rb +35 -0
- data/lib/sentdm/models/api_response_of_account.rb +48 -0
- data/lib/sentdm/models/api_response_of_cancelled_message.rb +43 -0
- data/lib/sentdm/models/api_response_of_channels_state.rb +48 -0
- data/lib/sentdm/models/api_response_of_compliance_requirements.rb +47 -0
- data/lib/sentdm/models/api_response_of_contacts_list.rb +42 -0
- data/lib/sentdm/models/api_response_of_message.rb +51 -0
- data/lib/sentdm/models/api_response_of_message_activities.rb +43 -0
- data/lib/sentdm/models/api_response_of_number_lookup_result.rb +43 -0
- data/lib/sentdm/models/api_response_of_profile_completion_accepted.rb +47 -0
- data/lib/sentdm/models/api_response_of_profile_completion_result.rb +47 -0
- data/lib/sentdm/models/api_response_of_profiles_list.rb +43 -0
- data/lib/sentdm/models/api_response_of_sender_profile.rb +54 -0
- data/lib/sentdm/models/api_response_of_sender_profiles_list.rb +42 -0
- data/lib/sentdm/models/api_response_of_templates_list.rb +42 -0
- data/lib/sentdm/models/api_response_of_users_list.rb +43 -0
- data/lib/sentdm/models/api_response_of_webhook_event_types_list.rb +43 -0
- data/lib/sentdm/models/api_response_of_webhook_events_list.rb +42 -0
- data/lib/sentdm/models/{webhook_rotate_secret_response.rb → api_response_of_webhook_secret.rb} +4 -17
- data/lib/sentdm/models/{webhook_test_response.rb → api_response_of_webhook_test.rb} +4 -23
- data/lib/sentdm/models/api_response_of_webhooks_list.rb +42 -0
- data/lib/sentdm/models/billing_contact.rb +35 -0
- data/lib/sentdm/models/brand_business.rb +96 -0
- data/lib/sentdm/models/brand_business_info.rb +3 -20
- data/lib/sentdm/models/brand_compliance.rb +75 -0
- data/lib/sentdm/models/brand_contact.rb +56 -0
- data/lib/sentdm/models/brand_with_kyc.rb +129 -0
- data/lib/sentdm/models/cancelled_message.rb +28 -0
- data/lib/sentdm/models/channel_event_payload.rb +3 -114
- data/lib/sentdm/models/channel_list_params.rb +20 -0
- data/lib/sentdm/models/channel_score.rb +35 -0
- data/lib/sentdm/models/channels/api_response_of_list_of_sms_market.rb +45 -0
- data/lib/sentdm/models/channels/api_response_of_rcs_agent.rb +60 -0
- data/lib/sentdm/models/channels/api_response_of_sms_market.rb +54 -0
- data/lib/sentdm/models/channels/api_response_of_whatsapp_channel.rb +47 -0
- data/lib/sentdm/models/channels/market_compliance.rb +409 -0
- data/lib/sentdm/models/channels/rc_create_params.rb +260 -0
- data/lib/sentdm/models/channels/rcs_address.rb +43 -0
- data/lib/sentdm/models/channels/rcs_agent.rb +278 -0
- data/lib/sentdm/models/channels/sms_create_params.rb +173 -0
- data/lib/sentdm/models/channels/sms_list_params.rb +22 -0
- data/lib/sentdm/models/channels/sms_market.rb +158 -0
- data/lib/sentdm/models/channels/sms_number.rb +41 -0
- data/lib/sentdm/models/channels/sms_number_request.rb +33 -0
- data/lib/sentdm/models/channels/sms_retrieve_params.rb +34 -0
- data/lib/sentdm/models/channels/sms_update_params.rb +64 -0
- data/lib/sentdm/models/channels/supplied_compliance.rb +89 -0
- data/lib/sentdm/models/channels/supplied_document.rb +35 -0
- data/lib/sentdm/models/channels/whatsapp_channel.rb +109 -0
- data/lib/sentdm/models/channels/whatsapp_create_params.rb +65 -0
- data/lib/sentdm/models/channels_state.rb +89 -0
- data/lib/sentdm/models/compliance_attachment_template.rb +36 -0
- data/lib/sentdm/models/compliance_requirement.rb +112 -0
- data/lib/sentdm/models/compliance_requirements.rb +98 -0
- data/lib/sentdm/models/compliance_retrieve_requirements_params.rb +52 -0
- data/lib/sentdm/models/compliance_setup_step.rb +78 -0
- data/lib/sentdm/models/contact_message_summary.rb +3 -34
- data/lib/sentdm/models/contacts_list.rb +26 -0
- data/lib/sentdm/models/conversation_messages_list.rb +3 -430
- data/lib/sentdm/models/entity_type.rb +18 -0
- data/lib/sentdm/models/inbound_media.rb +53 -0
- data/lib/sentdm/models/inbound_message_event_payload.rb +3 -53
- data/lib/sentdm/models/link_event.rb +79 -0
- data/lib/sentdm/models/link_event_payload.rb +211 -0
- data/lib/sentdm/models/message.rb +168 -0
- data/lib/sentdm/models/message_activities.rb +34 -0
- data/lib/sentdm/models/message_activity.rb +105 -0
- data/lib/sentdm/models/message_body.rb +79 -0
- data/lib/sentdm/models/message_button.rb +33 -0
- data/lib/sentdm/models/message_cancel_params.rb +32 -0
- data/lib/sentdm/models/message_channel_options.rb +43 -0
- data/lib/sentdm/models/message_header_media.rb +31 -0
- data/lib/sentdm/models/message_media.rb +74 -0
- data/lib/sentdm/models/message_recipient.rb +46 -0
- data/lib/sentdm/models/message_send_params.rb +6 -90
- data/lib/sentdm/models/message_send_response.rb +3 -95
- data/lib/sentdm/models/message_send_result.rb +55 -0
- data/lib/sentdm/models/message_status_event.rb +54 -0
- data/lib/sentdm/models/mms_market.rb +48 -0
- data/lib/sentdm/models/number_lookup_result.rb +63 -0
- data/lib/sentdm/models/pagination_cursors.rb +27 -0
- data/lib/sentdm/models/pagination_meta.rb +3 -27
- data/lib/sentdm/models/profile_completion_accepted.rb +20 -0
- data/lib/sentdm/models/profile_completion_result.rb +31 -0
- data/lib/sentdm/models/profile_detail.rb +6 -408
- data/lib/sentdm/models/profiles/brand_campaign.rb +3 -15
- data/lib/sentdm/models/profiles_list.rb +26 -0
- data/lib/sentdm/models/sender_profile.rb +138 -0
- data/lib/sentdm/models/sender_profile_billing.rb +21 -0
- data/lib/sentdm/models/sender_profile_billing_request.rb +33 -0
- data/lib/sentdm/models/sender_profile_channels.rb +90 -0
- data/lib/sentdm/models/sender_profile_create_params.rb +116 -0
- data/lib/sentdm/models/sender_profile_delete_params.rb +20 -0
- data/lib/sentdm/models/sender_profile_list_params.rb +30 -0
- data/lib/sentdm/models/sender_profile_rcs.rb +209 -0
- data/lib/sentdm/models/sender_profile_retrieve_params.rb +20 -0
- data/lib/sentdm/models/sender_profile_sms.rb +106 -0
- data/lib/sentdm/models/sender_profile_update_params.rb +71 -0
- data/lib/sentdm/models/sender_profile_whatsapp.rb +61 -0
- data/lib/sentdm/models/sender_profiles_list.rb +26 -0
- data/lib/sentdm/models/tcr_brand_identity_status.rb +17 -0
- data/lib/sentdm/models/tcr_brand_status.rb +16 -0
- data/lib/sentdm/models/tcr_campaign_status.rb +16 -0
- data/lib/sentdm/models/template_body.rb +3 -70
- data/lib/sentdm/models/template_header.rb +3 -37
- data/lib/sentdm/models/template_header_location.rb +38 -0
- data/lib/sentdm/models/template_media_item.rb +34 -0
- data/lib/sentdm/models/template_mms_body_content.rb +49 -0
- data/lib/sentdm/models/template_ref.rb +51 -0
- data/lib/sentdm/models/template_variable.rb +3 -64
- data/lib/sentdm/models/template_variable_props.rb +65 -0
- data/lib/sentdm/models/templates_list.rb +26 -0
- data/lib/sentdm/models/users_list.rb +26 -0
- data/lib/sentdm/models/voice/call.rb +3 -54
- data/lib/sentdm/models/voice/call_leg.rb +58 -0
- data/lib/sentdm/models/webhook_create_params.rb +3 -25
- data/lib/sentdm/models/webhook_delivery.rb +160 -0
- data/lib/sentdm/models/webhook_event_types_list.rb +26 -0
- data/lib/sentdm/models/webhook_events_list.rb +26 -0
- data/lib/sentdm/models/webhook_response.rb +3 -28
- data/lib/sentdm/models/webhook_secret.rb +15 -0
- data/lib/sentdm/models/webhook_sender_profile.rb +29 -0
- data/lib/sentdm/models/webhook_sender_profile_config.rb +27 -0
- data/lib/sentdm/models/webhook_test.rb +21 -0
- data/lib/sentdm/models/webhook_update_params.rb +3 -25
- data/lib/sentdm/models/webhooks_list.rb +26 -0
- data/lib/sentdm/models.rb +188 -0
- data/lib/sentdm/resources/channels/rcs.rb +177 -0
- data/lib/sentdm/resources/channels/sms.rb +417 -0
- data/lib/sentdm/resources/channels/whatsapp.rb +106 -0
- data/lib/sentdm/resources/channels.rb +162 -0
- data/lib/sentdm/resources/compliance.rb +127 -0
- data/lib/sentdm/resources/conversations.rb +4 -4
- data/lib/sentdm/resources/me.rb +2 -2
- data/lib/sentdm/resources/messages.rb +71 -6
- data/lib/sentdm/resources/numbers.rb +2 -2
- data/lib/sentdm/resources/profiles.rb +4 -4
- data/lib/sentdm/resources/sender_profiles.rb +463 -0
- data/lib/sentdm/resources/users.rb +2 -2
- data/lib/sentdm/resources/webhooks.rb +10 -10
- data/lib/sentdm/version.rb +1 -1
- data/lib/sentdm.rb +120 -11
- data/rbi/sentdm/client.rbi +64 -0
- data/rbi/sentdm/internal/sender_profiles_page.rbi +122 -0
- data/rbi/sentdm/models/account.rbi +242 -0
- data/rbi/sentdm/models/account_channels.rbi +66 -0
- data/rbi/sentdm/models/account_profile.rbi +116 -0
- data/rbi/sentdm/models/account_rcs_channel.rbi +45 -0
- data/rbi/sentdm/models/account_sms_channel.rbi +45 -0
- data/rbi/sentdm/models/account_whatsapp_channel.rbi +58 -0
- data/rbi/sentdm/models/api_response_of_account.rbi +78 -0
- data/rbi/sentdm/models/{webhook_rotate_secret_response.rbi → api_response_of_cancelled_message.rbi} +6 -41
- data/rbi/sentdm/models/api_response_of_channels_state.rbi +78 -0
- data/rbi/sentdm/models/api_response_of_compliance_requirements.rbi +81 -0
- data/rbi/sentdm/models/api_response_of_contacts_list.rbi +74 -0
- data/rbi/sentdm/models/api_response_of_message.rbi +84 -0
- data/rbi/sentdm/models/api_response_of_message_activities.rbi +77 -0
- data/rbi/sentdm/models/{webhook_test_response.rbi → api_response_of_number_lookup_result.rbi} +9 -43
- data/rbi/sentdm/models/api_response_of_profile_completion_accepted.rbi +83 -0
- data/rbi/sentdm/models/{profile_complete_response.rbi → api_response_of_profile_completion_result.rbi} +6 -52
- data/rbi/sentdm/models/api_response_of_profiles_list.rbi +74 -0
- data/rbi/sentdm/models/api_response_of_sender_profile.rbi +90 -0
- data/rbi/sentdm/models/api_response_of_sender_profiles_list.rbi +77 -0
- data/rbi/sentdm/models/api_response_of_templates_list.rbi +74 -0
- data/rbi/sentdm/models/api_response_of_users_list.rbi +74 -0
- data/rbi/sentdm/models/api_response_of_webhook_event_types_list.rbi +79 -0
- data/rbi/sentdm/models/api_response_of_webhook_events_list.rbi +77 -0
- data/rbi/sentdm/models/api_response_of_webhook_secret.rbi +74 -0
- data/rbi/sentdm/models/api_response_of_webhook_test.rbi +74 -0
- data/rbi/sentdm/models/api_response_of_webhooks_list.rbi +74 -0
- data/rbi/sentdm/models/billing_contact.rbi +49 -0
- data/rbi/sentdm/models/brand_business.rbi +115 -0
- data/rbi/sentdm/models/brand_business_info.rbi +3 -49
- data/rbi/sentdm/models/brand_compliance.rbi +108 -0
- data/rbi/sentdm/models/brand_contact.rbi +78 -0
- data/rbi/sentdm/models/brand_with_kyc.rbi +167 -0
- data/rbi/sentdm/models/cancelled_message.rbi +37 -0
- data/rbi/sentdm/models/channel_event_payload.rbi +4 -204
- data/rbi/sentdm/models/channel_list_params.rbi +38 -0
- data/rbi/sentdm/models/channel_score.rbi +56 -0
- data/rbi/sentdm/models/channels/api_response_of_list_of_sms_market.rbi +76 -0
- data/rbi/sentdm/models/channels/api_response_of_rcs_agent.rbi +103 -0
- data/rbi/sentdm/models/channels/api_response_of_sms_market.rbi +93 -0
- data/rbi/sentdm/models/channels/api_response_of_whatsapp_channel.rbi +85 -0
- data/rbi/sentdm/models/channels/market_compliance.rbi +770 -0
- data/rbi/sentdm/models/channels/rc_create_params.rbi +397 -0
- data/rbi/sentdm/models/channels/rcs_address.rbi +62 -0
- data/rbi/sentdm/models/channels/rcs_agent.rbi +320 -0
- data/rbi/sentdm/models/channels/sms_create_params.rbi +291 -0
- data/rbi/sentdm/models/channels/sms_list_params.rbi +40 -0
- data/rbi/sentdm/models/channels/sms_market.rbi +247 -0
- data/rbi/sentdm/models/channels/sms_number.rbi +60 -0
- data/rbi/sentdm/models/channels/sms_number_request.rbi +48 -0
- data/rbi/sentdm/models/channels/sms_retrieve_params.rbi +56 -0
- data/rbi/sentdm/models/channels/sms_update_params.rbi +93 -0
- data/rbi/sentdm/models/channels/supplied_compliance.rbi +140 -0
- data/rbi/sentdm/models/channels/supplied_document.rbi +57 -0
- data/rbi/sentdm/models/channels/whatsapp_channel.rbi +172 -0
- data/rbi/sentdm/models/channels/whatsapp_create_params.rbi +104 -0
- data/rbi/sentdm/models/channels_state.rbi +151 -0
- data/rbi/sentdm/models/compliance_attachment_template.rbi +56 -0
- data/rbi/sentdm/models/compliance_requirement.rbi +149 -0
- data/rbi/sentdm/models/compliance_requirements.rbi +165 -0
- data/rbi/sentdm/models/compliance_retrieve_requirements_params.rbi +79 -0
- data/rbi/sentdm/models/compliance_setup_step.rbi +115 -0
- data/rbi/sentdm/models/contact_message_summary.rbi +4 -69
- data/rbi/sentdm/models/contacts_list.rbi +50 -0
- data/rbi/sentdm/models/conversation_messages_list.rbi +4 -669
- data/rbi/sentdm/models/entity_type.rbi +23 -0
- data/rbi/sentdm/models/inbound_media.rbi +76 -0
- data/rbi/sentdm/models/inbound_message_event_payload.rbi +3 -85
- data/rbi/sentdm/models/link_event.rbi +128 -0
- data/rbi/sentdm/models/link_event_payload.rbi +279 -0
- data/rbi/sentdm/models/message.rbi +214 -0
- data/rbi/sentdm/models/message_activities.rbi +63 -0
- data/rbi/sentdm/models/message_activity.rbi +145 -0
- data/rbi/sentdm/models/message_body.rbi +104 -0
- data/rbi/sentdm/models/message_button.rbi +52 -0
- data/rbi/sentdm/models/message_cancel_params.rbi +59 -0
- data/rbi/sentdm/models/message_channel_options.rbi +65 -0
- data/rbi/sentdm/models/message_header_media.rbi +44 -0
- data/rbi/sentdm/models/message_media.rbi +95 -0
- data/rbi/sentdm/models/message_recipient.rbi +70 -0
- data/rbi/sentdm/models/message_send_params.rbi +7 -155
- data/rbi/sentdm/models/message_send_response.rbi +4 -163
- data/rbi/sentdm/models/message_send_result.rbi +85 -0
- data/rbi/sentdm/models/message_status_event.rbi +70 -0
- data/rbi/sentdm/models/mms_market.rbi +66 -0
- data/rbi/sentdm/models/number_lookup_result.rbi +89 -0
- data/rbi/sentdm/models/pagination_cursors.rbi +42 -0
- data/rbi/sentdm/models/pagination_meta.rbi +4 -43
- data/rbi/sentdm/models/profile_completion_accepted.rbi +33 -0
- data/rbi/sentdm/models/profile_completion_result.rbi +43 -0
- data/rbi/sentdm/models/profile_detail.rbi +8 -621
- data/rbi/sentdm/models/profiles/brand_campaign.rbi +3 -45
- data/rbi/sentdm/models/profiles_list.rbi +50 -0
- data/rbi/sentdm/models/sender_profile.rbi +204 -0
- data/rbi/sentdm/models/sender_profile_billing.rbi +34 -0
- data/rbi/sentdm/models/sender_profile_billing_request.rbi +46 -0
- data/rbi/sentdm/models/sender_profile_channels.rbi +163 -0
- data/rbi/sentdm/models/sender_profile_create_params.rbi +190 -0
- data/rbi/sentdm/models/sender_profile_delete_params.rbi +35 -0
- data/rbi/sentdm/models/sender_profile_list_params.rbi +57 -0
- data/rbi/sentdm/models/sender_profile_rcs.rbi +211 -0
- data/rbi/sentdm/models/sender_profile_retrieve_params.rbi +35 -0
- data/rbi/sentdm/models/sender_profile_sms.rbi +156 -0
- data/rbi/sentdm/models/sender_profile_update_params.rbi +96 -0
- data/rbi/sentdm/models/sender_profile_whatsapp.rbi +83 -0
- data/rbi/sentdm/models/sender_profiles_list.rbi +54 -0
- data/rbi/sentdm/models/tcr_brand_identity_status.rbi +27 -0
- data/rbi/sentdm/models/tcr_brand_status.rbi +20 -0
- data/rbi/sentdm/models/tcr_campaign_status.rbi +23 -0
- data/rbi/sentdm/models/template_body.rbi +6 -114
- data/rbi/sentdm/models/template_header.rbi +4 -53
- data/rbi/sentdm/models/template_header_location.rbi +47 -0
- data/rbi/sentdm/models/template_media_item.rbi +51 -0
- data/rbi/sentdm/models/template_mms_body_content.rbi +73 -0
- data/rbi/sentdm/models/template_ref.rbi +79 -0
- data/rbi/sentdm/models/template_variable.rbi +4 -80
- data/rbi/sentdm/models/template_variable_props.rbi +81 -0
- data/rbi/sentdm/models/templates_list.rbi +50 -0
- data/rbi/sentdm/models/users_list.rbi +50 -0
- data/rbi/sentdm/models/voice/call.rbi +3 -86
- data/rbi/sentdm/models/voice/call_leg.rbi +90 -0
- data/rbi/sentdm/models/webhook_create_params.rbi +4 -49
- data/rbi/sentdm/models/webhook_delivery.rbi +211 -0
- data/rbi/sentdm/models/webhook_event_types_list.rbi +54 -0
- data/rbi/sentdm/models/webhook_events_list.rbi +52 -0
- data/rbi/sentdm/models/webhook_response.rbi +4 -50
- data/rbi/sentdm/models/webhook_secret.rbi +24 -0
- data/rbi/sentdm/models/webhook_sender_profile.rbi +46 -0
- data/rbi/sentdm/models/webhook_sender_profile_config.rbi +44 -0
- data/rbi/sentdm/models/webhook_test.rbi +32 -0
- data/rbi/sentdm/models/webhook_update_params.rbi +4 -49
- data/rbi/sentdm/models/webhooks_list.rbi +50 -0
- data/rbi/sentdm/models.rbi +197 -0
- data/rbi/sentdm/resources/channels/rcs.rbi +208 -0
- data/rbi/sentdm/resources/channels/sms.rbi +437 -0
- data/rbi/sentdm/resources/channels/whatsapp.rbi +108 -0
- data/rbi/sentdm/resources/channels.rbi +149 -0
- data/rbi/sentdm/resources/compliance.rbi +121 -0
- data/rbi/sentdm/resources/conversations.rbi +2 -10
- data/rbi/sentdm/resources/me.rbi +1 -1
- data/rbi/sentdm/resources/messages.rbi +64 -7
- data/rbi/sentdm/resources/numbers.rbi +1 -1
- data/rbi/sentdm/resources/profiles.rbi +2 -2
- data/rbi/sentdm/resources/sender_profiles.rbi +461 -0
- data/rbi/sentdm/resources/users.rbi +1 -1
- data/rbi/sentdm/resources/webhooks.rbi +6 -12
- data/sig/sentdm/client.rbs +4 -0
- data/sig/sentdm/internal/sender_profiles_page.rbs +80 -0
- data/sig/sentdm/models/account.rbs +111 -0
- data/sig/sentdm/models/account_channels.rbs +38 -0
- data/sig/sentdm/models/account_profile.rbs +68 -0
- data/sig/sentdm/models/account_rcs_channel.rbs +17 -0
- data/sig/sentdm/models/account_sms_channel.rbs +17 -0
- data/sig/sentdm/models/account_whatsapp_channel.rbs +28 -0
- data/sig/sentdm/models/api_response_of_account.rbs +39 -0
- data/sig/sentdm/models/api_response_of_cancelled_message.rbs +39 -0
- data/sig/sentdm/models/api_response_of_channels_state.rbs +39 -0
- data/sig/sentdm/models/api_response_of_compliance_requirements.rbs +39 -0
- data/sig/sentdm/models/api_response_of_contacts_list.rbs +39 -0
- data/sig/sentdm/models/api_response_of_message.rbs +39 -0
- data/sig/sentdm/models/api_response_of_message_activities.rbs +39 -0
- data/sig/sentdm/models/api_response_of_number_lookup_result.rbs +39 -0
- data/sig/sentdm/models/api_response_of_profile_completion_accepted.rbs +39 -0
- data/sig/sentdm/models/api_response_of_profile_completion_result.rbs +39 -0
- data/sig/sentdm/models/api_response_of_profiles_list.rbs +39 -0
- data/sig/sentdm/models/api_response_of_sender_profile.rbs +39 -0
- data/sig/sentdm/models/api_response_of_sender_profiles_list.rbs +39 -0
- data/sig/sentdm/models/api_response_of_templates_list.rbs +39 -0
- data/sig/sentdm/models/api_response_of_users_list.rbs +39 -0
- data/sig/sentdm/models/api_response_of_webhook_event_types_list.rbs +39 -0
- data/sig/sentdm/models/api_response_of_webhook_events_list.rbs +39 -0
- data/sig/sentdm/models/api_response_of_webhook_secret.rbs +39 -0
- data/sig/sentdm/models/api_response_of_webhook_test.rbs +39 -0
- data/sig/sentdm/models/api_response_of_webhooks_list.rbs +39 -0
- data/sig/sentdm/models/billing_contact.rbs +30 -0
- data/sig/sentdm/models/brand_business.rbs +70 -0
- data/sig/sentdm/models/brand_business_info.rbs +4 -23
- data/sig/sentdm/models/brand_compliance.rbs +56 -0
- data/sig/sentdm/models/brand_contact.rbs +47 -0
- data/sig/sentdm/models/brand_with_kyc.rbs +93 -0
- data/sig/sentdm/models/cancelled_message.rbs +15 -0
- data/sig/sentdm/models/channel_event_payload.rbs +4 -56
- data/sig/sentdm/models/channel_list_params.rbs +25 -0
- data/sig/sentdm/models/channel_score.rbs +32 -0
- data/sig/sentdm/models/channels/api_response_of_list_of_sms_market.rbs +41 -0
- data/sig/sentdm/models/channels/api_response_of_rcs_agent.rbs +41 -0
- data/sig/sentdm/models/channels/api_response_of_sms_market.rbs +41 -0
- data/sig/sentdm/models/channels/api_response_of_whatsapp_channel.rbs +43 -0
- data/sig/sentdm/models/channels/market_compliance.rbs +338 -0
- data/sig/sentdm/models/channels/rc_create_params.rbs +242 -0
- data/sig/sentdm/models/channels/rcs_address.rbs +42 -0
- data/sig/sentdm/models/channels/rcs_agent.rbs +181 -0
- data/sig/sentdm/models/channels/sms_create_params.rbs +116 -0
- data/sig/sentdm/models/channels/sms_list_params.rbs +27 -0
- data/sig/sentdm/models/channels/sms_market.rbs +85 -0
- data/sig/sentdm/models/channels/sms_number.rbs +28 -0
- data/sig/sentdm/models/channels/sms_number_request.rbs +17 -0
- data/sig/sentdm/models/channels/sms_retrieve_params.rbs +36 -0
- data/sig/sentdm/models/channels/sms_update_params.rbs +63 -0
- data/sig/sentdm/models/channels/supplied_compliance.rbs +32 -0
- data/sig/sentdm/models/channels/supplied_document.rbs +30 -0
- data/sig/sentdm/models/channels/whatsapp_channel.rbs +78 -0
- data/sig/sentdm/models/channels/whatsapp_create_params.rbs +56 -0
- data/sig/sentdm/models/channels_state.rbs +55 -0
- data/sig/sentdm/models/compliance_attachment_template.rbs +26 -0
- data/sig/sentdm/models/compliance_requirement.rbs +76 -0
- data/sig/sentdm/models/compliance_requirements.rbs +66 -0
- data/sig/sentdm/models/compliance_retrieve_requirements_params.rbs +43 -0
- data/sig/sentdm/models/compliance_setup_step.rbs +62 -0
- data/sig/sentdm/models/contact_message_summary.rbs +6 -35
- data/sig/sentdm/models/contacts_list.rbs +31 -0
- data/sig/sentdm/models/conversation_messages_list.rbs +5 -312
- data/sig/sentdm/models/entity_type.rbs +22 -0
- data/sig/sentdm/models/inbound_media.rbs +35 -0
- data/sig/sentdm/models/inbound_message_event_payload.rbs +4 -36
- data/sig/sentdm/models/link_event.rbs +44 -0
- data/sig/sentdm/models/link_event_payload.rbs +106 -0
- data/sig/sentdm/models/message.rbs +130 -0
- data/sig/sentdm/models/message_activities.rbs +38 -0
- data/sig/sentdm/models/message_activity.rbs +66 -0
- data/sig/sentdm/models/message_body.rbs +52 -0
- data/sig/sentdm/models/message_button.rbs +34 -0
- data/sig/sentdm/models/message_cancel_params.rbs +38 -0
- data/sig/sentdm/models/message_channel_options.rbs +26 -0
- data/sig/sentdm/models/message_header_media.rbs +19 -0
- data/sig/sentdm/models/message_media.rbs +40 -0
- data/sig/sentdm/models/message_recipient.rbs +34 -0
- data/sig/sentdm/models/message_send_params.rbs +8 -54
- data/sig/sentdm/models/message_send_response.rbs +4 -77
- data/sig/sentdm/models/message_send_result.rbs +45 -0
- data/sig/sentdm/models/message_status_event.rbs +40 -0
- data/sig/sentdm/models/mms_market.rbs +35 -0
- data/sig/sentdm/models/number_lookup_result.rbs +64 -0
- data/sig/sentdm/models/pagination_cursors.rbs +15 -0
- data/sig/sentdm/models/pagination_meta.rbs +4 -16
- data/sig/sentdm/models/profile_completion_accepted.rbs +15 -0
- data/sig/sentdm/models/profile_completion_result.rbs +19 -0
- data/sig/sentdm/models/profile_detail.rbs +8 -315
- data/sig/sentdm/models/profiles/brand_campaign.rbs +4 -16
- data/sig/sentdm/models/profiles_list.rbs +31 -0
- data/sig/sentdm/models/sender_profile.rbs +76 -0
- data/sig/sentdm/models/sender_profile_billing.rbs +15 -0
- data/sig/sentdm/models/sender_profile_billing_request.rbs +15 -0
- data/sig/sentdm/models/sender_profile_channels.rbs +30 -0
- data/sig/sentdm/models/sender_profile_create_params.rbs +78 -0
- data/sig/sentdm/models/sender_profile_delete_params.rbs +20 -0
- data/sig/sentdm/models/sender_profile_list_params.rbs +32 -0
- data/sig/sentdm/models/sender_profile_rcs.rbs +150 -0
- data/sig/sentdm/models/sender_profile_retrieve_params.rbs +20 -0
- data/sig/sentdm/models/sender_profile_sms.rbs +40 -0
- data/sig/sentdm/models/sender_profile_update_params.rbs +62 -0
- data/sig/sentdm/models/sender_profile_whatsapp.rbs +16 -0
- data/sig/sentdm/models/sender_profiles_list.rbs +31 -0
- data/sig/sentdm/models/tcr_brand_identity_status.rbs +17 -0
- data/sig/sentdm/models/tcr_brand_status.rbs +15 -0
- data/sig/sentdm/models/tcr_campaign_status.rbs +15 -0
- data/sig/sentdm/models/template_body.rbs +4 -43
- data/sig/sentdm/models/template_header.rbs +4 -31
- data/sig/sentdm/models/template_header_location.rbs +30 -0
- data/sig/sentdm/models/template_media_item.rbs +17 -0
- data/sig/sentdm/models/template_mms_body_content.rbs +28 -0
- data/sig/sentdm/models/template_ref.rbs +26 -0
- data/sig/sentdm/models/template_variable.rbs +4 -51
- data/sig/sentdm/models/template_variable_props.rbs +50 -0
- data/sig/sentdm/models/templates_list.rbs +29 -0
- data/sig/sentdm/models/users_list.rbs +31 -0
- data/sig/sentdm/models/voice/call.rbs +4 -49
- data/sig/sentdm/models/voice/call_leg.rbs +50 -0
- data/sig/sentdm/models/webhook_create_params.rbs +4 -28
- data/sig/sentdm/models/webhook_delivery.rbs +99 -0
- data/sig/sentdm/models/webhook_event_types_list.rbs +31 -0
- data/sig/sentdm/models/webhook_events_list.rbs +31 -0
- data/sig/sentdm/models/webhook_response.rbs +4 -28
- data/sig/sentdm/models/webhook_secret.rbs +15 -0
- data/sig/sentdm/models/webhook_sender_profile.rbs +27 -0
- data/sig/sentdm/models/webhook_sender_profile_config.rbs +27 -0
- data/sig/sentdm/models/webhook_test.rbs +19 -0
- data/sig/sentdm/models/webhook_update_params.rbs +4 -28
- data/sig/sentdm/models/webhooks_list.rbs +31 -0
- data/sig/sentdm/models.rbs +188 -0
- data/sig/sentdm/resources/channels/rcs.rbs +41 -0
- data/sig/sentdm/resources/channels/sms.rbs +44 -0
- data/sig/sentdm/resources/channels/whatsapp.rbs +18 -0
- data/sig/sentdm/resources/channels.rbs +11 -0
- data/sig/sentdm/resources/compliance.rbs +15 -0
- data/sig/sentdm/resources/conversations.rbs +2 -2
- data/sig/sentdm/resources/me.rbs +1 -1
- data/sig/sentdm/resources/messages.rbs +12 -4
- data/sig/sentdm/resources/numbers.rbs +1 -1
- data/sig/sentdm/resources/profiles.rbs +2 -2
- data/sig/sentdm/resources/sender_profiles.rbs +44 -0
- data/sig/sentdm/resources/users.rbs +1 -1
- data/sig/sentdm/resources/webhooks.rbs +6 -6
- metadata +362 -35
- data/lib/sentdm/models/me_retrieve_response.rb +0 -409
- data/lib/sentdm/models/message_retrieve_activities_response.rb +0 -175
- data/lib/sentdm/models/message_retrieve_status_response.rb +0 -477
- data/lib/sentdm/models/number_lookup_response.rb +0 -104
- data/lib/sentdm/models/profile_complete_response.rb +0 -74
- data/lib/sentdm/models/profile_list_response.rb +0 -65
- data/lib/sentdm/models/user_list_response.rb +0 -65
- data/lib/sentdm/models/webhook_list_event_types_response.rb +0 -65
- data/lib/sentdm/models/webhook_list_events_response.rb +0 -445
- data/rbi/sentdm/models/me_retrieve_response.rbi +0 -705
- data/rbi/sentdm/models/message_retrieve_activities_response.rbi +0 -319
- data/rbi/sentdm/models/message_retrieve_status_response.rbi +0 -765
- data/rbi/sentdm/models/number_lookup_response.rbi +0 -166
- data/rbi/sentdm/models/profile_list_response.rbi +0 -128
- data/rbi/sentdm/models/user_list_response.rbi +0 -128
- data/rbi/sentdm/models/webhook_list_event_types_response.rbi +0 -142
- data/rbi/sentdm/models/webhook_list_events_response.rbi +0 -647
- data/sig/sentdm/models/me_retrieve_response.rbs +0 -306
- data/sig/sentdm/models/message_retrieve_activities_response.rbs +0 -137
- data/sig/sentdm/models/message_retrieve_status_response.rbs +0 -341
- data/sig/sentdm/models/number_lookup_response.rbs +0 -100
- data/sig/sentdm/models/profile_complete_response.rbs +0 -55
- data/sig/sentdm/models/profile_list_response.rbs +0 -67
- data/sig/sentdm/models/user_list_response.rbs +0 -67
- data/sig/sentdm/models/webhook_list_event_types_response.rbs +0 -67
- data/sig/sentdm/models/webhook_list_events_response.rbs +0 -243
- data/sig/sentdm/models/webhook_rotate_secret_response.rbs +0 -51
- data/sig/sentdm/models/webhook_test_response.rbs +0 -55
|
@@ -13,8 +13,8 @@ module Sentdm
|
|
|
13
13
|
|
|
14
14
|
# @!attribute props
|
|
15
15
|
#
|
|
16
|
-
# @return [Sentdm::Models::
|
|
17
|
-
required :props, -> { Sentdm::
|
|
16
|
+
# @return [Sentdm::Models::TemplateVariableProps]
|
|
17
|
+
required :props, -> { Sentdm::TemplateVariableProps }
|
|
18
18
|
|
|
19
19
|
# @!attribute type
|
|
20
20
|
# One of variable, link or media. Decides which Props fields are required.
|
|
@@ -40,72 +40,11 @@ module Sentdm
|
|
|
40
40
|
#
|
|
41
41
|
# @param name [String] The variable's name, and the key callers use for it in a send request's paramete
|
|
42
42
|
#
|
|
43
|
-
# @param props [Sentdm::Models::
|
|
43
|
+
# @param props [Sentdm::Models::TemplateVariableProps]
|
|
44
44
|
#
|
|
45
45
|
# @param type [String] One of variable, link or media. Decides which Props fields
|
|
46
46
|
#
|
|
47
47
|
# @param id [Integer] The variable's index, and the number its {{index:variable}} placeholder refers t
|
|
48
|
-
|
|
49
|
-
# @see Sentdm::Models::TemplateVariable#props
|
|
50
|
-
class Props < Sentdm::Internal::Type::BaseModel
|
|
51
|
-
# @!attribute media_type
|
|
52
|
-
#
|
|
53
|
-
# @return [String]
|
|
54
|
-
required :media_type, String, api_name: :mediaType
|
|
55
|
-
|
|
56
|
-
# @!attribute sample
|
|
57
|
-
# Example value substituted into the template when previewing it and when
|
|
58
|
-
# submitting it to Meta for review. Free text by nature, so the converter accepts
|
|
59
|
-
# a JSON number or boolean here and normalizes it — see
|
|
60
|
-
# JsonScalarToStringConverter for why — and guarantees it is always serialized
|
|
61
|
-
# back out as a JSON string.
|
|
62
|
-
#
|
|
63
|
-
# @return [String]
|
|
64
|
-
required :sample, String
|
|
65
|
-
|
|
66
|
-
# @!attribute url
|
|
67
|
-
#
|
|
68
|
-
# @return [String]
|
|
69
|
-
required :url, String
|
|
70
|
-
|
|
71
|
-
# @!attribute variable_type
|
|
72
|
-
#
|
|
73
|
-
# @return [String]
|
|
74
|
-
required :variable_type, String, api_name: :variableType
|
|
75
|
-
|
|
76
|
-
# @!attribute alt
|
|
77
|
-
#
|
|
78
|
-
# @return [String, nil]
|
|
79
|
-
optional :alt, String, nil?: true
|
|
80
|
-
|
|
81
|
-
# @!attribute regex
|
|
82
|
-
#
|
|
83
|
-
# @return [String, nil]
|
|
84
|
-
optional :regex, String, nil?: true
|
|
85
|
-
|
|
86
|
-
# @!attribute short_url
|
|
87
|
-
#
|
|
88
|
-
# @return [String, nil]
|
|
89
|
-
optional :short_url, String, api_name: :shortUrl, nil?: true
|
|
90
|
-
|
|
91
|
-
# @!method initialize(media_type:, sample:, url:, variable_type:, alt: nil, regex: nil, short_url: nil)
|
|
92
|
-
# Some parameter documentations has been truncated, see
|
|
93
|
-
# {Sentdm::Models::TemplateVariable::Props} for more details.
|
|
94
|
-
#
|
|
95
|
-
# @param media_type [String]
|
|
96
|
-
#
|
|
97
|
-
# @param sample [String] Example value substituted into the template when previewing it and when submitti
|
|
98
|
-
#
|
|
99
|
-
# @param url [String]
|
|
100
|
-
#
|
|
101
|
-
# @param variable_type [String]
|
|
102
|
-
#
|
|
103
|
-
# @param alt [String, nil]
|
|
104
|
-
#
|
|
105
|
-
# @param regex [String, nil]
|
|
106
|
-
#
|
|
107
|
-
# @param short_url [String, nil]
|
|
108
|
-
end
|
|
109
48
|
end
|
|
110
49
|
end
|
|
111
50
|
end
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
class TemplateVariableProps < Sentdm::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute media_type
|
|
7
|
+
#
|
|
8
|
+
# @return [String]
|
|
9
|
+
required :media_type, String, api_name: :mediaType
|
|
10
|
+
|
|
11
|
+
# @!attribute sample
|
|
12
|
+
# Example value substituted into the template when previewing it and when
|
|
13
|
+
# submitting it to Meta for review. Free text by nature, so the converter accepts
|
|
14
|
+
# a JSON number or boolean here and normalizes it — see
|
|
15
|
+
# JsonScalarToStringConverter for why — and guarantees it is always serialized
|
|
16
|
+
# back out as a JSON string.
|
|
17
|
+
#
|
|
18
|
+
# @return [String]
|
|
19
|
+
required :sample, String
|
|
20
|
+
|
|
21
|
+
# @!attribute url
|
|
22
|
+
#
|
|
23
|
+
# @return [String]
|
|
24
|
+
required :url, String
|
|
25
|
+
|
|
26
|
+
# @!attribute variable_type
|
|
27
|
+
#
|
|
28
|
+
# @return [String]
|
|
29
|
+
required :variable_type, String, api_name: :variableType
|
|
30
|
+
|
|
31
|
+
# @!attribute alt
|
|
32
|
+
#
|
|
33
|
+
# @return [String, nil]
|
|
34
|
+
optional :alt, String, nil?: true
|
|
35
|
+
|
|
36
|
+
# @!attribute regex
|
|
37
|
+
#
|
|
38
|
+
# @return [String, nil]
|
|
39
|
+
optional :regex, String, nil?: true
|
|
40
|
+
|
|
41
|
+
# @!attribute short_url
|
|
42
|
+
#
|
|
43
|
+
# @return [String, nil]
|
|
44
|
+
optional :short_url, String, api_name: :shortUrl, nil?: true
|
|
45
|
+
|
|
46
|
+
# @!method initialize(media_type:, sample:, url:, variable_type:, alt: nil, regex: nil, short_url: nil)
|
|
47
|
+
# Some parameter documentations has been truncated, see
|
|
48
|
+
# {Sentdm::Models::TemplateVariableProps} for more details.
|
|
49
|
+
#
|
|
50
|
+
# @param media_type [String]
|
|
51
|
+
#
|
|
52
|
+
# @param sample [String] Example value substituted into the template when previewing it and when submitti
|
|
53
|
+
#
|
|
54
|
+
# @param url [String]
|
|
55
|
+
#
|
|
56
|
+
# @param variable_type [String]
|
|
57
|
+
#
|
|
58
|
+
# @param alt [String, nil]
|
|
59
|
+
#
|
|
60
|
+
# @param regex [String, nil]
|
|
61
|
+
#
|
|
62
|
+
# @param short_url [String, nil]
|
|
63
|
+
end
|
|
64
|
+
end
|
|
65
|
+
end
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
class TemplatesList < Sentdm::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute pagination
|
|
7
|
+
# Pagination metadata for list responses
|
|
8
|
+
#
|
|
9
|
+
# @return [Sentdm::Models::PaginationMeta, nil]
|
|
10
|
+
optional :pagination, -> { Sentdm::PaginationMeta }
|
|
11
|
+
|
|
12
|
+
# @!attribute templates
|
|
13
|
+
# The templates on this page.
|
|
14
|
+
#
|
|
15
|
+
# @return [Array<Sentdm::Models::Template>, nil]
|
|
16
|
+
optional :templates, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Template] }
|
|
17
|
+
|
|
18
|
+
# @!method initialize(pagination: nil, templates: nil)
|
|
19
|
+
# A paginated list of templates.
|
|
20
|
+
#
|
|
21
|
+
# @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
|
|
22
|
+
#
|
|
23
|
+
# @param templates [Array<Sentdm::Models::Template>] The templates on this page.
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
end
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
class UsersList < Sentdm::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute pagination
|
|
7
|
+
# Pagination metadata for list responses
|
|
8
|
+
#
|
|
9
|
+
# @return [Sentdm::Models::PaginationMeta, nil]
|
|
10
|
+
optional :pagination, -> { Sentdm::PaginationMeta }
|
|
11
|
+
|
|
12
|
+
# @!attribute users
|
|
13
|
+
# The users on this page.
|
|
14
|
+
#
|
|
15
|
+
# @return [Array<Sentdm::Models::UserResponse>, nil]
|
|
16
|
+
optional :users, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::UserResponse] }
|
|
17
|
+
|
|
18
|
+
# @!method initialize(pagination: nil, users: nil)
|
|
19
|
+
# The users in the organization.
|
|
20
|
+
#
|
|
21
|
+
# @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
|
|
22
|
+
#
|
|
23
|
+
# @param users [Array<Sentdm::Models::UserResponse>] The users on this page.
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
end
|
|
@@ -82,8 +82,8 @@ module Sentdm
|
|
|
82
82
|
# and the leg to the connected number at once, and both are billed. Null until the
|
|
83
83
|
# call has been priced
|
|
84
84
|
#
|
|
85
|
-
# @return [Array<Sentdm::Models::Voice::
|
|
86
|
-
optional :legs, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Voice::
|
|
85
|
+
# @return [Array<Sentdm::Models::Voice::CallLeg>, nil]
|
|
86
|
+
optional :legs, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Voice::CallLeg] }, nil?: true
|
|
87
87
|
|
|
88
88
|
# @!attribute mode
|
|
89
89
|
# The calling mode: inapp for a call between people in your app and phone numbers,
|
|
@@ -167,7 +167,7 @@ module Sentdm
|
|
|
167
167
|
#
|
|
168
168
|
# @param from [Sentdm::Models::Voice::CallParty] One end of a call
|
|
169
169
|
#
|
|
170
|
-
# @param legs [Array<Sentdm::Models::Voice::
|
|
170
|
+
# @param legs [Array<Sentdm::Models::Voice::CallLeg>, nil] The legs the price covers, one entry per billed leg, each with its own cost: a c
|
|
171
171
|
#
|
|
172
172
|
# @param mode [String] The calling mode: inapp for a call between people in your app and phone numbers,
|
|
173
173
|
#
|
|
@@ -184,57 +184,6 @@ module Sentdm
|
|
|
184
184
|
# @param timeline [Array<Sentdm::Models::Voice::CallTimelineEntry>, nil] When the call entered each status, oldest first. Only returned when reading one
|
|
185
185
|
#
|
|
186
186
|
# @param to [Sentdm::Models::Voice::CallParty] One end of a call
|
|
187
|
-
|
|
188
|
-
class Leg < Sentdm::Internal::Type::BaseModel
|
|
189
|
-
# @!attribute billed_minutes
|
|
190
|
-
# The whole minutes the leg was billed for
|
|
191
|
-
#
|
|
192
|
-
# @return [Integer, nil]
|
|
193
|
-
optional :billed_minutes, Integer
|
|
194
|
-
|
|
195
|
-
# @!attribute cost
|
|
196
|
-
# What the leg cost, in the same unit as the call's price
|
|
197
|
-
#
|
|
198
|
-
# @return [Float, nil]
|
|
199
|
-
optional :cost, Float
|
|
200
|
-
|
|
201
|
-
# @!attribute currency
|
|
202
|
-
# The currency of the cost: USD
|
|
203
|
-
#
|
|
204
|
-
# @return [String, nil]
|
|
205
|
-
optional :currency, String
|
|
206
|
-
|
|
207
|
-
# @!attribute direction
|
|
208
|
-
# inbound for the caller's leg to your number, outbound for a leg placed on your
|
|
209
|
-
# behalf
|
|
210
|
-
#
|
|
211
|
-
# @return [String, nil]
|
|
212
|
-
optional :direction, String
|
|
213
|
-
|
|
214
|
-
# @!attribute number
|
|
215
|
-
# The phone number the leg reached, in E.164 format: your number for the inbound
|
|
216
|
-
# leg, the number dialed for an outbound one. Null for a leg to one of your app
|
|
217
|
-
# users or a room
|
|
218
|
-
#
|
|
219
|
-
# @return [String, nil]
|
|
220
|
-
optional :number, String, nil?: true
|
|
221
|
-
|
|
222
|
-
# @!method initialize(billed_minutes: nil, cost: nil, currency: nil, direction: nil, number: nil)
|
|
223
|
-
# Some parameter documentations has been truncated, see
|
|
224
|
-
# {Sentdm::Models::Voice::Call::Leg} for more details.
|
|
225
|
-
#
|
|
226
|
-
# One leg of a call the price covers
|
|
227
|
-
#
|
|
228
|
-
# @param billed_minutes [Integer] The whole minutes the leg was billed for
|
|
229
|
-
#
|
|
230
|
-
# @param cost [Float] What the leg cost, in the same unit as the call's price
|
|
231
|
-
#
|
|
232
|
-
# @param currency [String] The currency of the cost: USD
|
|
233
|
-
#
|
|
234
|
-
# @param direction [String] inbound for the caller's leg to your number, outbound for a leg placed on your b
|
|
235
|
-
#
|
|
236
|
-
# @param number [String, nil] The phone number the leg reached, in E.164 format: your number for the inbound l
|
|
237
|
-
end
|
|
238
187
|
end
|
|
239
188
|
end
|
|
240
189
|
end
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
module Voice
|
|
6
|
+
class CallLeg < Sentdm::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute billed_minutes
|
|
8
|
+
# The whole minutes the leg was billed for
|
|
9
|
+
#
|
|
10
|
+
# @return [Integer, nil]
|
|
11
|
+
optional :billed_minutes, Integer
|
|
12
|
+
|
|
13
|
+
# @!attribute cost
|
|
14
|
+
# What the leg cost, in the same unit as the call's price
|
|
15
|
+
#
|
|
16
|
+
# @return [Float, nil]
|
|
17
|
+
optional :cost, Float
|
|
18
|
+
|
|
19
|
+
# @!attribute currency
|
|
20
|
+
# The currency of the cost: USD
|
|
21
|
+
#
|
|
22
|
+
# @return [String, nil]
|
|
23
|
+
optional :currency, String
|
|
24
|
+
|
|
25
|
+
# @!attribute direction
|
|
26
|
+
# inbound for the caller's leg to your number, outbound for a leg placed on your
|
|
27
|
+
# behalf
|
|
28
|
+
#
|
|
29
|
+
# @return [String, nil]
|
|
30
|
+
optional :direction, String
|
|
31
|
+
|
|
32
|
+
# @!attribute number
|
|
33
|
+
# The phone number the leg reached, in E.164 format: your number for the inbound
|
|
34
|
+
# leg, the number dialed for an outbound one. Null for a leg to one of your app
|
|
35
|
+
# users or a room
|
|
36
|
+
#
|
|
37
|
+
# @return [String, nil]
|
|
38
|
+
optional :number, String, nil?: true
|
|
39
|
+
|
|
40
|
+
# @!method initialize(billed_minutes: nil, cost: nil, currency: nil, direction: nil, number: nil)
|
|
41
|
+
# Some parameter documentations has been truncated, see
|
|
42
|
+
# {Sentdm::Models::Voice::CallLeg} for more details.
|
|
43
|
+
#
|
|
44
|
+
# One leg of a call the price covers
|
|
45
|
+
#
|
|
46
|
+
# @param billed_minutes [Integer] The whole minutes the leg was billed for
|
|
47
|
+
#
|
|
48
|
+
# @param cost [Float] What the leg cost, in the same unit as the call's price
|
|
49
|
+
#
|
|
50
|
+
# @param currency [String] The currency of the cost: USD
|
|
51
|
+
#
|
|
52
|
+
# @param direction [String] inbound for the caller's leg to your number, outbound for a leg placed on your b
|
|
53
|
+
#
|
|
54
|
+
# @param number [String, nil] The phone number the leg reached, in E.164 format: your number for the inbound l
|
|
55
|
+
end
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
end
|
|
@@ -57,8 +57,8 @@ module Sentdm
|
|
|
57
57
|
# receive, one clone per existing and future profile. A version 1 webhook's
|
|
58
58
|
# responses report it as WebhookSenderProfileV3Response.
|
|
59
59
|
#
|
|
60
|
-
# @return [Sentdm::Models::
|
|
61
|
-
optional :sender_profile, -> { Sentdm::
|
|
60
|
+
# @return [Sentdm::Models::WebhookSenderProfileConfig, nil]
|
|
61
|
+
optional :sender_profile, -> { Sentdm::WebhookSenderProfileConfig }, nil?: true
|
|
62
62
|
|
|
63
63
|
# @!attribute timeout_seconds
|
|
64
64
|
# Delivery timeout. Applies to version 1 only.
|
|
@@ -102,7 +102,7 @@ module Sentdm
|
|
|
102
102
|
#
|
|
103
103
|
# @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
|
|
104
104
|
#
|
|
105
|
-
# @param sender_profile [Sentdm::Models::
|
|
105
|
+
# @param sender_profile [Sentdm::Models::WebhookSenderProfileConfig, nil] Request-only: the events an organization webhook's sender profile clones receive
|
|
106
106
|
#
|
|
107
107
|
# @param timeout_seconds [Integer] Delivery timeout. Applies to version 1 only.
|
|
108
108
|
#
|
|
@@ -113,28 +113,6 @@ module Sentdm
|
|
|
113
113
|
# @param x_profile_id [String]
|
|
114
114
|
#
|
|
115
115
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
|
|
116
|
-
|
|
117
|
-
class SenderProfile < Sentdm::Internal::Type::BaseModel
|
|
118
|
-
# @!attribute event_filters
|
|
119
|
-
#
|
|
120
|
-
# @return [Hash{Symbol=>Array<String>}, nil]
|
|
121
|
-
optional :event_filters,
|
|
122
|
-
Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]],
|
|
123
|
-
nil?: true
|
|
124
|
-
|
|
125
|
-
# @!attribute event_types
|
|
126
|
-
#
|
|
127
|
-
# @return [Array<String>, nil]
|
|
128
|
-
optional :event_types, Sentdm::Internal::Type::ArrayOf[String]
|
|
129
|
-
|
|
130
|
-
# @!method initialize(event_filters: nil, event_types: nil)
|
|
131
|
-
# Request-only: the events an organization webhook's sender profile clones
|
|
132
|
-
# receive, one clone per existing and future profile. A version 1 webhook's
|
|
133
|
-
# responses report it as WebhookSenderProfileV3Response.
|
|
134
|
-
#
|
|
135
|
-
# @param event_filters [Hash{Symbol=>Array<String>}, nil]
|
|
136
|
-
# @param event_types [Array<String>]
|
|
137
|
-
end
|
|
138
116
|
end
|
|
139
117
|
end
|
|
140
118
|
end
|
|
@@ -0,0 +1,160 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
# @see Sentdm::Resources::Webhooks#list_events
|
|
6
|
+
class WebhookDelivery < Sentdm::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
#
|
|
9
|
+
# @return [String, nil]
|
|
10
|
+
optional :id, String
|
|
11
|
+
|
|
12
|
+
# @!attribute created_at
|
|
13
|
+
#
|
|
14
|
+
# @return [Time, nil]
|
|
15
|
+
optional :created_at, Time
|
|
16
|
+
|
|
17
|
+
# @!attribute delivery_attempts
|
|
18
|
+
#
|
|
19
|
+
# @return [Integer, nil]
|
|
20
|
+
optional :delivery_attempts, Integer
|
|
21
|
+
|
|
22
|
+
# @!attribute delivery_status
|
|
23
|
+
#
|
|
24
|
+
# @return [String, nil]
|
|
25
|
+
optional :delivery_status, String
|
|
26
|
+
|
|
27
|
+
# @!attribute error_message
|
|
28
|
+
#
|
|
29
|
+
# @return [String, nil]
|
|
30
|
+
optional :error_message, String, nil?: true
|
|
31
|
+
|
|
32
|
+
# @!attribute event_data
|
|
33
|
+
# The exact event body that was delivered, or attempted, for this record. One of
|
|
34
|
+
# the six webhook envelopes:
|
|
35
|
+
#
|
|
36
|
+
# message — an outbound message changed status. message with event:
|
|
37
|
+
# message.received — someone replied to you. templates — a template was approved,
|
|
38
|
+
# rejected, paused or similar. channel — one of your markets moved in provisioning
|
|
39
|
+
# or compliance. contact — a consent signal: opt-in, opt-out or help. link — a
|
|
40
|
+
# tracked short link was clicked or a hosted file downloaded, or one expired or
|
|
41
|
+
# was revoked.
|
|
42
|
+
#
|
|
43
|
+
# Read field and event to tell which, the same way your endpoint does. The two
|
|
44
|
+
# message envelopes are the reason that is two fields and not one: they share a
|
|
45
|
+
# field and differ by event.
|
|
46
|
+
#
|
|
47
|
+
# Treat the list as open. It has grown twice — channel and then link — and a
|
|
48
|
+
# handler that rejects an envelope it does not recognise will break on the next
|
|
49
|
+
# addition rather than ignore it.
|
|
50
|
+
#
|
|
51
|
+
# @return [Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent, Sentdm::Models::ChannelEvent, Sentdm::Models::ContactEvent, Sentdm::Models::LinkEvent, Sentdm::Models::CallEvent, nil]
|
|
52
|
+
optional :event_data, union: -> { Sentdm::WebhookDelivery::EventData }
|
|
53
|
+
|
|
54
|
+
# @!attribute event_type
|
|
55
|
+
#
|
|
56
|
+
# @return [String, nil]
|
|
57
|
+
optional :event_type, String
|
|
58
|
+
|
|
59
|
+
# @!attribute http_status_code
|
|
60
|
+
#
|
|
61
|
+
# @return [Integer, nil]
|
|
62
|
+
optional :http_status_code, Integer, nil?: true
|
|
63
|
+
|
|
64
|
+
# @!attribute processing_completed_at
|
|
65
|
+
#
|
|
66
|
+
# @return [Time, nil]
|
|
67
|
+
optional :processing_completed_at, Time, nil?: true
|
|
68
|
+
|
|
69
|
+
# @!attribute processing_started_at
|
|
70
|
+
#
|
|
71
|
+
# @return [Time, nil]
|
|
72
|
+
optional :processing_started_at, Time, nil?: true
|
|
73
|
+
|
|
74
|
+
# @!attribute response_body
|
|
75
|
+
#
|
|
76
|
+
# @return [String, nil]
|
|
77
|
+
optional :response_body, String, nil?: true
|
|
78
|
+
|
|
79
|
+
# @!method initialize(id: nil, created_at: nil, delivery_attempts: nil, delivery_status: nil, error_message: nil, event_data: nil, event_type: nil, http_status_code: nil, processing_completed_at: nil, processing_started_at: nil, response_body: nil)
|
|
80
|
+
# Some parameter documentations has been truncated, see
|
|
81
|
+
# {Sentdm::Models::WebhookDelivery} for more details.
|
|
82
|
+
#
|
|
83
|
+
# @param id [String]
|
|
84
|
+
#
|
|
85
|
+
# @param created_at [Time]
|
|
86
|
+
#
|
|
87
|
+
# @param delivery_attempts [Integer]
|
|
88
|
+
#
|
|
89
|
+
# @param delivery_status [String]
|
|
90
|
+
#
|
|
91
|
+
# @param error_message [String, nil]
|
|
92
|
+
#
|
|
93
|
+
# @param event_data [Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent, Sentdm::Models::ChannelEvent, Sentdm::Models::ContactEvent, Sentdm::Models::LinkEvent, Sentdm::Models::CallEvent] The exact event body that was delivered, or attempted, for this record. One of t
|
|
94
|
+
#
|
|
95
|
+
# @param event_type [String]
|
|
96
|
+
#
|
|
97
|
+
# @param http_status_code [Integer, nil]
|
|
98
|
+
#
|
|
99
|
+
# @param processing_completed_at [Time, nil]
|
|
100
|
+
#
|
|
101
|
+
# @param processing_started_at [Time, nil]
|
|
102
|
+
#
|
|
103
|
+
# @param response_body [String, nil]
|
|
104
|
+
|
|
105
|
+
# The exact event body that was delivered, or attempted, for this record. One of
|
|
106
|
+
# the six webhook envelopes:
|
|
107
|
+
#
|
|
108
|
+
# message — an outbound message changed status. message with event:
|
|
109
|
+
# message.received — someone replied to you. templates — a template was approved,
|
|
110
|
+
# rejected, paused or similar. channel — one of your markets moved in provisioning
|
|
111
|
+
# or compliance. contact — a consent signal: opt-in, opt-out or help. link — a
|
|
112
|
+
# tracked short link was clicked or a hosted file downloaded, or one expired or
|
|
113
|
+
# was revoked.
|
|
114
|
+
#
|
|
115
|
+
# Read field and event to tell which, the same way your endpoint does. The two
|
|
116
|
+
# message envelopes are the reason that is two fields and not one: they share a
|
|
117
|
+
# field and differ by event.
|
|
118
|
+
#
|
|
119
|
+
# Treat the list as open. It has grown twice — channel and then link — and a
|
|
120
|
+
# handler that rejects an envelope it does not recognise will break on the next
|
|
121
|
+
# addition rather than ignore it.
|
|
122
|
+
#
|
|
123
|
+
# @see Sentdm::Models::WebhookDelivery#event_data
|
|
124
|
+
module EventData
|
|
125
|
+
extend Sentdm::Internal::Type::Union
|
|
126
|
+
|
|
127
|
+
# The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
|
|
128
|
+
# varies only in Payload.
|
|
129
|
+
variant -> { Sentdm::MessageEvent }
|
|
130
|
+
|
|
131
|
+
# The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
|
|
132
|
+
# varies only in Payload.
|
|
133
|
+
variant -> { Sentdm::InboundMessageEvent }
|
|
134
|
+
|
|
135
|
+
# The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
|
|
136
|
+
# varies only in Payload.
|
|
137
|
+
variant -> { Sentdm::TemplateEvent }
|
|
138
|
+
|
|
139
|
+
# The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
|
|
140
|
+
# varies only in Payload.
|
|
141
|
+
variant -> { Sentdm::ChannelEvent }
|
|
142
|
+
|
|
143
|
+
# The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
|
|
144
|
+
# varies only in Payload.
|
|
145
|
+
variant -> { Sentdm::ContactEvent }
|
|
146
|
+
|
|
147
|
+
# The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
|
|
148
|
+
# varies only in Payload.
|
|
149
|
+
variant -> { Sentdm::LinkEvent }
|
|
150
|
+
|
|
151
|
+
# The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
|
|
152
|
+
# varies only in Payload.
|
|
153
|
+
variant -> { Sentdm::CallEvent }
|
|
154
|
+
|
|
155
|
+
# @!method self.variants
|
|
156
|
+
# @return [Array(Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent, Sentdm::Models::ChannelEvent, Sentdm::Models::ContactEvent, Sentdm::Models::LinkEvent, Sentdm::Models::CallEvent)]
|
|
157
|
+
end
|
|
158
|
+
end
|
|
159
|
+
end
|
|
160
|
+
end
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
class WebhookEventTypesList < Sentdm::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute event_types
|
|
7
|
+
# The event_types on this page.
|
|
8
|
+
#
|
|
9
|
+
# @return [Array<Sentdm::Models::WebhookEventType>, nil]
|
|
10
|
+
optional :event_types, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::WebhookEventType] }
|
|
11
|
+
|
|
12
|
+
# @!attribute pagination
|
|
13
|
+
# Pagination metadata for list responses
|
|
14
|
+
#
|
|
15
|
+
# @return [Sentdm::Models::PaginationMeta, nil]
|
|
16
|
+
optional :pagination, -> { Sentdm::PaginationMeta }
|
|
17
|
+
|
|
18
|
+
# @!method initialize(event_types: nil, pagination: nil)
|
|
19
|
+
# The webhook event types a customer can subscribe to.
|
|
20
|
+
#
|
|
21
|
+
# @param event_types [Array<Sentdm::Models::WebhookEventType>] The event_types on this page.
|
|
22
|
+
#
|
|
23
|
+
# @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
end
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
class WebhookEventsList < Sentdm::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute events
|
|
7
|
+
# The events on this page.
|
|
8
|
+
#
|
|
9
|
+
# @return [Array<Sentdm::Models::WebhookDelivery>, nil]
|
|
10
|
+
optional :events, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::WebhookDelivery] }
|
|
11
|
+
|
|
12
|
+
# @!attribute pagination
|
|
13
|
+
# Pagination metadata for list responses
|
|
14
|
+
#
|
|
15
|
+
# @return [Sentdm::Models::PaginationMeta, nil]
|
|
16
|
+
optional :pagination, -> { Sentdm::PaginationMeta }
|
|
17
|
+
|
|
18
|
+
# @!method initialize(events: nil, pagination: nil)
|
|
19
|
+
# A paginated list of webhook delivery records.
|
|
20
|
+
#
|
|
21
|
+
# @param events [Array<Sentdm::Models::WebhookDelivery>] The events on this page.
|
|
22
|
+
#
|
|
23
|
+
# @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
end
|
|
@@ -89,8 +89,8 @@ module Sentdm
|
|
|
89
89
|
# Its own type, field for field the same as the request's sender_profile. A
|
|
90
90
|
# response is not a request, whatever it carries.
|
|
91
91
|
#
|
|
92
|
-
# @return [Sentdm::Models::
|
|
93
|
-
optional :sender_profile, -> { Sentdm::
|
|
92
|
+
# @return [Sentdm::Models::WebhookSenderProfile, nil]
|
|
93
|
+
optional :sender_profile, -> { Sentdm::WebhookSenderProfile }, nil?: true
|
|
94
94
|
|
|
95
95
|
# @!attribute signing_secret
|
|
96
96
|
#
|
|
@@ -144,7 +144,7 @@ module Sentdm
|
|
|
144
144
|
#
|
|
145
145
|
# @param retry_count [Integer]
|
|
146
146
|
#
|
|
147
|
-
# @param sender_profile [Sentdm::Models::
|
|
147
|
+
# @param sender_profile [Sentdm::Models::WebhookSenderProfile, nil] The events a version 1 webhook's sender profile clones receive, as a response re
|
|
148
148
|
#
|
|
149
149
|
# @param signing_secret [String, nil]
|
|
150
150
|
#
|
|
@@ -153,31 +153,6 @@ module Sentdm
|
|
|
153
153
|
# @param updated_at [Time, nil]
|
|
154
154
|
#
|
|
155
155
|
# @param webhook_version [Integer] Who delivers the webhook: 1 the older delivery, which will be retired, or 2 Svix
|
|
156
|
-
|
|
157
|
-
# @see Sentdm::Models::WebhookResponse#sender_profile
|
|
158
|
-
class SenderProfile < Sentdm::Internal::Type::BaseModel
|
|
159
|
-
# @!attribute event_filters
|
|
160
|
-
#
|
|
161
|
-
# @return [Hash{Symbol=>Array<String>}, nil]
|
|
162
|
-
optional :event_filters,
|
|
163
|
-
Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]],
|
|
164
|
-
nil?: true
|
|
165
|
-
|
|
166
|
-
# @!attribute event_types
|
|
167
|
-
#
|
|
168
|
-
# @return [Array<String>, nil]
|
|
169
|
-
optional :event_types, Sentdm::Internal::Type::ArrayOf[String]
|
|
170
|
-
|
|
171
|
-
# @!method initialize(event_filters: nil, event_types: nil)
|
|
172
|
-
# The events a version 1 webhook's sender profile clones receive, as a response
|
|
173
|
-
# reports them.
|
|
174
|
-
#
|
|
175
|
-
# Its own type, field for field the same as the request's sender_profile. A
|
|
176
|
-
# response is not a request, whatever it carries.
|
|
177
|
-
#
|
|
178
|
-
# @param event_filters [Hash{Symbol=>Array<String>}, nil]
|
|
179
|
-
# @param event_types [Array<String>]
|
|
180
|
-
end
|
|
181
156
|
end
|
|
182
157
|
end
|
|
183
158
|
end
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
class WebhookSecret < Sentdm::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute signing_secret
|
|
7
|
+
#
|
|
8
|
+
# @return [String, nil]
|
|
9
|
+
optional :signing_secret, String
|
|
10
|
+
|
|
11
|
+
# @!method initialize(signing_secret: nil)
|
|
12
|
+
# @param signing_secret [String]
|
|
13
|
+
end
|
|
14
|
+
end
|
|
15
|
+
end
|