sentdm 0.19.0 → 0.20.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 +8 -0
- data/README.md +31 -1
- data/lib/sentdm/internal/type/base_model.rb +5 -5
- data/lib/sentdm/internal/type/enum.rb +25 -0
- data/lib/sentdm/models/api_meta.rb +34 -0
- data/lib/sentdm/models/api_response_of_contact.rb +46 -0
- data/lib/sentdm/models/api_response_of_profile_detail.rb +43 -0
- data/lib/sentdm/models/api_response_of_user.rb +43 -0
- data/lib/sentdm/models/api_response_template.rb +43 -0
- data/lib/sentdm/models/api_response_webhook.rb +43 -0
- data/lib/sentdm/models/billing_contact_info.rb +47 -0
- data/lib/sentdm/models/brands_brand_data.rb +38 -0
- data/lib/sentdm/models/contact_delete_params.rb +2 -16
- data/lib/sentdm/models/contact_list_response.rb +12 -278
- data/lib/sentdm/models/contact_response.rb +126 -0
- data/lib/sentdm/models/destination_country.rb +21 -0
- data/lib/sentdm/models/error_detail.rb +42 -0
- data/lib/sentdm/models/me_retrieve_response.rb +12 -204
- data/lib/sentdm/models/message_retrieve_activities_response.rb +6 -74
- data/lib/sentdm/models/message_retrieve_status_response.rb +6 -74
- data/lib/sentdm/models/message_send_response.rb +6 -74
- data/lib/sentdm/models/mutation_request.rb +20 -0
- data/lib/sentdm/models/number_lookup_response.rb +6 -74
- data/lib/sentdm/models/pagination_meta.rb +80 -0
- data/lib/sentdm/models/payment_details.rb +44 -0
- data/lib/sentdm/models/profile_complete_response.rb +6 -74
- data/lib/sentdm/models/profile_create_params.rb +9 -423
- data/lib/sentdm/models/profile_delete_params.rb +2 -16
- data/lib/sentdm/models/profile_detail.rb +605 -0
- data/lib/sentdm/models/profile_list_response.rb +9 -753
- data/lib/sentdm/models/profile_settings.rb +66 -0
- data/lib/sentdm/models/profile_update_params.rb +9 -423
- data/lib/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rb +45 -0
- data/lib/sentdm/models/profiles/base_dto.rb +32 -0
- data/lib/sentdm/models/profiles/campaign_create_params.rb +3 -165
- data/lib/sentdm/models/profiles/campaign_data.rb +123 -0
- data/lib/sentdm/models/profiles/campaign_delete_params.rb +2 -17
- data/lib/sentdm/models/profiles/campaign_list_response.rb +9 -420
- data/lib/sentdm/models/profiles/campaign_update_params.rb +3 -165
- data/lib/sentdm/models/profiles/messaging_use_case_us.rb +28 -0
- data/lib/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rb +29 -0
- data/lib/sentdm/models/profiles/tcr_campaign_with_use_cases.rb +248 -0
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rb +34 -0
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rb +48 -0
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rb +38 -0
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rb +81 -0
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rb +34 -0
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rb +39 -0
- data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rb +116 -0
- data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rb +75 -0
- data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info.rb +58 -0
- data/lib/sentdm/models/tcr_brand_relationship.rb +18 -0
- data/lib/sentdm/models/tcr_vertical.rb +36 -0
- data/lib/sentdm/models/template.rb +90 -0
- data/lib/sentdm/models/template_body_content.rb +27 -0
- data/lib/sentdm/models/template_create_params.rb +3 -889
- data/lib/sentdm/models/template_definition.rb +66 -0
- data/lib/sentdm/models/template_list_response.rb +12 -242
- data/lib/sentdm/models/template_update_params.rb +3 -889
- data/lib/sentdm/models/template_variable.rb +80 -0
- data/lib/sentdm/models/user_list_response.rb +9 -154
- data/lib/sentdm/models/user_remove_params.rb +2 -16
- data/lib/sentdm/models/user_response.rb +82 -0
- data/lib/sentdm/models/webhook_event_type.rb +45 -0
- data/lib/sentdm/models/webhook_list_event_types_response.rb +9 -118
- data/lib/sentdm/models/webhook_list_events_response.rb +9 -153
- data/lib/sentdm/models/webhook_list_response.rb +12 -247
- data/lib/sentdm/models/webhook_response.rb +95 -0
- data/lib/sentdm/models/webhook_rotate_secret_params.rb +2 -17
- data/lib/sentdm/models/webhook_rotate_secret_response.rb +6 -74
- data/lib/sentdm/models/webhook_test_response.rb +6 -74
- data/lib/sentdm/models.rb +77 -0
- data/lib/sentdm/resources/contacts.rb +6 -6
- data/lib/sentdm/resources/profiles/campaigns.rb +6 -6
- data/lib/sentdm/resources/profiles.rb +12 -12
- data/lib/sentdm/resources/templates.rb +8 -8
- data/lib/sentdm/resources/users.rb +6 -6
- data/lib/sentdm/resources/webhooks.rb +8 -8
- data/lib/sentdm/version.rb +1 -1
- data/lib/sentdm.rb +40 -18
- data/rbi/sentdm/models/api_meta.rbi +55 -0
- data/rbi/sentdm/models/api_response_of_contact.rbi +74 -0
- data/rbi/sentdm/models/api_response_of_profile_detail.rbi +74 -0
- data/rbi/sentdm/models/api_response_of_user.rbi +74 -0
- data/rbi/sentdm/models/api_response_template.rbi +74 -0
- data/rbi/sentdm/models/api_response_webhook.rbi +74 -0
- data/rbi/sentdm/models/billing_contact_info.rbi +65 -0
- data/rbi/sentdm/models/brands_brand_data.rbi +104 -0
- data/rbi/sentdm/models/contact_delete_params.rbi +2 -19
- data/rbi/sentdm/models/contact_list_response.rbi +16 -505
- data/rbi/sentdm/models/contact_response.rbi +183 -0
- data/rbi/sentdm/models/destination_country.rbi +32 -0
- data/rbi/sentdm/models/error_detail.rbi +66 -0
- data/rbi/sentdm/models/me_retrieve_response.rbi +16 -335
- data/rbi/sentdm/models/message_retrieve_activities_response.rbi +8 -154
- data/rbi/sentdm/models/message_retrieve_status_response.rbi +8 -148
- data/rbi/sentdm/models/message_send_response.rbi +8 -135
- data/rbi/sentdm/models/mutation_request.rbi +32 -0
- data/rbi/sentdm/models/number_lookup_response.rbi +8 -135
- data/rbi/sentdm/models/pagination_meta.rbi +135 -0
- data/rbi/sentdm/models/payment_details.rbi +59 -0
- data/rbi/sentdm/models/profile_complete_response.rbi +8 -137
- data/rbi/sentdm/models/profile_create_params.rbi +12 -810
- data/rbi/sentdm/models/profile_delete_params.rbi +2 -19
- data/rbi/sentdm/models/profile_detail.rbi +874 -0
- data/rbi/sentdm/models/profile_list_response.rbi +14 -1400
- data/rbi/sentdm/models/profile_settings.rbi +86 -0
- data/rbi/sentdm/models/profile_update_params.rbi +12 -810
- data/rbi/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rbi +83 -0
- data/rbi/sentdm/models/profiles/base_dto.rbi +53 -0
- data/rbi/sentdm/models/profiles/campaign_create_params.rbi +4 -289
- data/rbi/sentdm/models/profiles/campaign_data.rbi +148 -0
- data/rbi/sentdm/models/profiles/campaign_delete_params.rbi +1 -14
- data/rbi/sentdm/models/profiles/campaign_list_response.rbi +11 -733
- data/rbi/sentdm/models/profiles/campaign_update_params.rbi +4 -289
- data/rbi/sentdm/models/profiles/messaging_use_case_us.rbi +73 -0
- data/rbi/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbi +51 -0
- data/rbi/sentdm/models/profiles/tcr_campaign_with_use_cases.rbi +425 -0
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rbi +56 -0
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rbi +87 -0
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rbi +72 -0
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rbi +104 -0
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rbi +57 -0
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rbi +59 -0
- data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rbi +180 -0
- data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rbi +95 -0
- data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info.rbi +81 -0
- data/rbi/sentdm/models/tcr_brand_relationship.rbi +30 -0
- data/rbi/sentdm/models/tcr_vertical.rbi +41 -0
- data/rbi/sentdm/models/template.rbi +129 -0
- data/rbi/sentdm/models/template_body_content.rbi +43 -0
- data/rbi/sentdm/models/template_create_params.rbi +4 -1701
- data/rbi/sentdm/models/template_definition.rbi +164 -0
- data/rbi/sentdm/models/template_list_response.rbi +16 -454
- data/rbi/sentdm/models/template_update_params.rbi +4 -1701
- data/rbi/sentdm/models/template_variable.rbi +120 -0
- data/rbi/sentdm/models/user_list_response.rbi +14 -271
- data/rbi/sentdm/models/user_remove_params.rbi +2 -19
- data/rbi/sentdm/models/user_response.rbi +118 -0
- data/rbi/sentdm/models/webhook_event_type.rbi +74 -0
- data/rbi/sentdm/models/webhook_list_event_types_response.rbi +12 -247
- data/rbi/sentdm/models/webhook_list_events_response.rbi +12 -314
- data/rbi/sentdm/models/webhook_list_response.rbi +16 -462
- data/rbi/sentdm/models/webhook_response.rbi +140 -0
- data/rbi/sentdm/models/webhook_rotate_secret_params.rbi +1 -14
- data/rbi/sentdm/models/webhook_rotate_secret_response.rbi +8 -148
- data/rbi/sentdm/models/webhook_test_response.rbi +8 -135
- data/rbi/sentdm/models.rbi +77 -0
- data/rbi/sentdm/resources/contacts.rbi +3 -3
- data/rbi/sentdm/resources/profiles/campaigns.rbi +4 -4
- data/rbi/sentdm/resources/profiles.rbi +9 -13
- data/rbi/sentdm/resources/templates.rbi +5 -6
- data/rbi/sentdm/resources/users.rbi +3 -3
- data/rbi/sentdm/resources/webhooks.rbi +4 -4
- data/sig/sentdm/models/api_meta.rbs +27 -0
- data/sig/sentdm/models/api_response_of_contact.rbs +39 -0
- data/sig/sentdm/models/api_response_of_profile_detail.rbs +39 -0
- data/sig/sentdm/models/api_response_of_user.rbs +39 -0
- data/sig/sentdm/models/api_response_template.rbs +39 -0
- data/sig/sentdm/models/api_response_webhook.rbs +39 -0
- data/sig/sentdm/models/billing_contact_info.rbs +30 -0
- data/sig/sentdm/models/brands_brand_data.rbs +30 -0
- data/sig/sentdm/models/contact_delete_params.rbs +6 -10
- data/sig/sentdm/models/contact_list_response.rbs +20 -256
- data/sig/sentdm/models/contact_response.rbs +111 -0
- data/sig/sentdm/models/destination_country.rbs +19 -0
- data/sig/sentdm/models/error_detail.rbs +39 -0
- data/sig/sentdm/models/me_retrieve_response.rbs +18 -176
- data/sig/sentdm/models/message_retrieve_activities_response.rbs +9 -71
- data/sig/sentdm/models/message_retrieve_status_response.rbs +9 -71
- data/sig/sentdm/models/message_send_response.rbs +9 -71
- data/sig/sentdm/models/mutation_request.rbs +15 -0
- data/sig/sentdm/models/number_lookup_response.rbs +9 -71
- data/sig/sentdm/models/pagination_meta.rbs +67 -0
- data/sig/sentdm/models/payment_details.rbs +30 -0
- data/sig/sentdm/models/profile_complete_response.rbs +9 -71
- data/sig/sentdm/models/profile_create_params.rbs +12 -363
- data/sig/sentdm/models/profile_delete_params.rbs +6 -10
- data/sig/sentdm/models/profile_detail.rbs +474 -0
- data/sig/sentdm/models/profile_list_response.rbs +15 -645
- data/sig/sentdm/models/profile_settings.rbs +50 -0
- data/sig/sentdm/models/profile_update_params.rbs +12 -363
- data/sig/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rbs +41 -0
- data/sig/sentdm/models/profiles/base_dto.rbs +27 -0
- data/sig/sentdm/models/profiles/campaign_create_params.rbs +4 -138
- data/sig/sentdm/models/profiles/campaign_data.rbs +82 -0
- data/sig/sentdm/models/profiles/campaign_delete_params.rbs +8 -15
- data/sig/sentdm/models/profiles/campaign_list_response.rbs +13 -396
- data/sig/sentdm/models/profiles/campaign_update_params.rbs +4 -138
- data/sig/sentdm/models/profiles/messaging_use_case_us.rbs +40 -0
- data/sig/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbs +27 -0
- data/sig/sentdm/models/profiles/tcr_campaign_with_use_cases.rbs +299 -0
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rbs +24 -0
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rbs +35 -0
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rbs +32 -0
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rbs +75 -0
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rbs +30 -0
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rbs +30 -0
- data/sig/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rbs +89 -0
- data/sig/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rbs +55 -0
- data/sig/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info.rbs +45 -0
- data/sig/sentdm/models/tcr_brand_relationship.rbs +22 -0
- data/sig/sentdm/models/tcr_vertical.rbs +58 -0
- data/sig/sentdm/models/template.rbs +79 -0
- data/sig/sentdm/models/template_body_content.rbs +30 -0
- data/sig/sentdm/models/template_create_params.rbs +6 -853
- data/sig/sentdm/models/template_definition.rbs +45 -0
- data/sig/sentdm/models/template_list_response.rbs +19 -225
- data/sig/sentdm/models/template_update_params.rbs +4 -851
- data/sig/sentdm/models/template_variable.rbs +84 -0
- data/sig/sentdm/models/user_list_response.rbs +15 -151
- data/sig/sentdm/models/user_remove_params.rbs +6 -10
- data/sig/sentdm/models/user_response.rbs +72 -0
- data/sig/sentdm/models/webhook_event_type.rbs +51 -0
- data/sig/sentdm/models/webhook_list_event_types_response.rbs +15 -130
- data/sig/sentdm/models/webhook_list_events_response.rbs +14 -142
- data/sig/sentdm/models/webhook_list_response.rbs +20 -248
- data/sig/sentdm/models/webhook_response.rbs +103 -0
- data/sig/sentdm/models/webhook_rotate_secret_params.rbs +8 -17
- data/sig/sentdm/models/webhook_rotate_secret_response.rbs +9 -71
- data/sig/sentdm/models/webhook_test_response.rbs +9 -71
- data/sig/sentdm/models.rbs +68 -0
- data/sig/sentdm/resources/contacts.rbs +3 -3
- data/sig/sentdm/resources/profiles/campaigns.rbs +4 -4
- data/sig/sentdm/resources/profiles.rbs +9 -9
- data/sig/sentdm/resources/templates.rbs +5 -5
- data/sig/sentdm/resources/users.rbs +3 -3
- data/sig/sentdm/resources/webhooks.rbs +4 -4
- metadata +121 -55
- data/lib/sentdm/models/contact_create_response.rb +0 -236
- data/lib/sentdm/models/contact_retrieve_response.rb +0 -236
- data/lib/sentdm/models/contact_update_response.rb +0 -236
- data/lib/sentdm/models/profile_create_response.rb +0 -781
- data/lib/sentdm/models/profile_retrieve_response.rb +0 -783
- data/lib/sentdm/models/profile_update_response.rb +0 -781
- data/lib/sentdm/models/profiles/campaign_create_response.rb +0 -459
- data/lib/sentdm/models/profiles/campaign_update_response.rb +0 -459
- data/lib/sentdm/models/template_create_response.rb +0 -197
- data/lib/sentdm/models/template_retrieve_response.rb +0 -197
- data/lib/sentdm/models/template_update_response.rb +0 -197
- data/lib/sentdm/models/user_invite_response.rb +0 -189
- data/lib/sentdm/models/user_retrieve_response.rb +0 -189
- data/lib/sentdm/models/user_update_role_response.rb +0 -189
- data/lib/sentdm/models/webhook_create_response.rb +0 -204
- data/lib/sentdm/models/webhook_retrieve_response.rb +0 -204
- data/lib/sentdm/models/webhook_toggle_status_response.rb +0 -204
- data/lib/sentdm/models/webhook_update_response.rb +0 -204
- data/rbi/sentdm/models/contact_create_response.rbi +0 -390
- data/rbi/sentdm/models/contact_retrieve_response.rbi +0 -392
- data/rbi/sentdm/models/contact_update_response.rbi +0 -390
- data/rbi/sentdm/models/profile_create_response.rbi +0 -1439
- data/rbi/sentdm/models/profile_retrieve_response.rbi +0 -1443
- data/rbi/sentdm/models/profile_update_response.rbi +0 -1439
- data/rbi/sentdm/models/profiles/campaign_create_response.rbi +0 -814
- data/rbi/sentdm/models/profiles/campaign_update_response.rbi +0 -814
- data/rbi/sentdm/models/template_create_response.rbi +0 -339
- data/rbi/sentdm/models/template_retrieve_response.rbi +0 -345
- data/rbi/sentdm/models/template_update_response.rbi +0 -339
- data/rbi/sentdm/models/user_invite_response.rbi +0 -323
- data/rbi/sentdm/models/user_retrieve_response.rbi +0 -323
- data/rbi/sentdm/models/user_update_role_response.rbi +0 -328
- data/rbi/sentdm/models/webhook_create_response.rbi +0 -348
- data/rbi/sentdm/models/webhook_retrieve_response.rbi +0 -350
- data/rbi/sentdm/models/webhook_toggle_status_response.rbi +0 -366
- data/rbi/sentdm/models/webhook_update_response.rbi +0 -348
- data/sig/sentdm/models/contact_create_response.rbs +0 -209
- data/sig/sentdm/models/contact_retrieve_response.rbs +0 -209
- data/sig/sentdm/models/contact_update_response.rbs +0 -209
- data/sig/sentdm/models/profile_create_response.rbs +0 -662
- data/sig/sentdm/models/profile_retrieve_response.rbs +0 -662
- data/sig/sentdm/models/profile_update_response.rbs +0 -662
- data/sig/sentdm/models/profiles/campaign_create_response.rbs +0 -424
- data/sig/sentdm/models/profiles/campaign_update_response.rbs +0 -424
- data/sig/sentdm/models/template_create_response.rbs +0 -177
- data/sig/sentdm/models/template_retrieve_response.rbs +0 -177
- data/sig/sentdm/models/template_update_response.rbs +0 -177
- data/sig/sentdm/models/user_invite_response.rbs +0 -170
- data/sig/sentdm/models/user_retrieve_response.rbs +0 -170
- data/sig/sentdm/models/user_update_role_response.rbs +0 -170
- data/sig/sentdm/models/webhook_create_response.rbs +0 -201
- data/sig/sentdm/models/webhook_retrieve_response.rbs +0 -201
- data/sig/sentdm/models/webhook_toggle_status_response.rbs +0 -201
- data/sig/sentdm/models/webhook_update_response.rbs +0 -201
|
@@ -22,8 +22,8 @@ module Sentdm
|
|
|
22
22
|
# Complete definition of a message template including header, body, footer, and
|
|
23
23
|
# buttons
|
|
24
24
|
#
|
|
25
|
-
# @return [Sentdm::Models::
|
|
26
|
-
optional :definition, -> { Sentdm::
|
|
25
|
+
# @return [Sentdm::Models::TemplateDefinition, nil]
|
|
26
|
+
optional :definition, -> { Sentdm::TemplateDefinition }, nil?: true
|
|
27
27
|
|
|
28
28
|
# @!attribute language
|
|
29
29
|
# Template language code (e.g., en_US)
|
|
@@ -68,7 +68,7 @@ module Sentdm
|
|
|
68
68
|
#
|
|
69
69
|
# @param category [String, nil] Template category: MARKETING, UTILITY, AUTHENTICATION
|
|
70
70
|
#
|
|
71
|
-
# @param definition [Sentdm::Models::
|
|
71
|
+
# @param definition [Sentdm::Models::TemplateDefinition, nil] Complete definition of a message template including header, body, footer, and bu
|
|
72
72
|
#
|
|
73
73
|
# @param language [String, nil] Template language code (e.g., en_US)
|
|
74
74
|
#
|
|
@@ -83,892 +83,6 @@ module Sentdm
|
|
|
83
83
|
# @param x_profile_id [String]
|
|
84
84
|
#
|
|
85
85
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
|
|
86
|
-
|
|
87
|
-
class Definition < Sentdm::Internal::Type::BaseModel
|
|
88
|
-
# @!attribute body
|
|
89
|
-
# Body section of a message template with channel-specific content
|
|
90
|
-
#
|
|
91
|
-
# @return [Sentdm::Models::TemplateUpdateParams::Definition::Body]
|
|
92
|
-
required :body, -> { Sentdm::TemplateUpdateParams::Definition::Body }
|
|
93
|
-
|
|
94
|
-
# @!attribute authentication_config
|
|
95
|
-
# Configuration for AUTHENTICATION category templates
|
|
96
|
-
#
|
|
97
|
-
# @return [Sentdm::Models::TemplateUpdateParams::Definition::AuthenticationConfig, nil]
|
|
98
|
-
optional :authentication_config,
|
|
99
|
-
-> { Sentdm::TemplateUpdateParams::Definition::AuthenticationConfig },
|
|
100
|
-
api_name: :authenticationConfig,
|
|
101
|
-
nil?: true
|
|
102
|
-
|
|
103
|
-
# @!attribute buttons
|
|
104
|
-
# Optional list of interactive buttons (e.g., quick replies, URLs, phone numbers)
|
|
105
|
-
#
|
|
106
|
-
# @return [Array<Sentdm::Models::TemplateUpdateParams::Definition::Button>, nil]
|
|
107
|
-
optional :buttons,
|
|
108
|
-
-> { Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateUpdateParams::Definition::Button] },
|
|
109
|
-
nil?: true
|
|
110
|
-
|
|
111
|
-
# @!attribute definition_version
|
|
112
|
-
# The version of the template definition format
|
|
113
|
-
#
|
|
114
|
-
# @return [String, nil]
|
|
115
|
-
optional :definition_version, String, api_name: :definitionVersion, nil?: true
|
|
116
|
-
|
|
117
|
-
# @!attribute footer
|
|
118
|
-
# Footer section of a message template
|
|
119
|
-
#
|
|
120
|
-
# @return [Sentdm::Models::TemplateUpdateParams::Definition::Footer, nil]
|
|
121
|
-
optional :footer, -> { Sentdm::TemplateUpdateParams::Definition::Footer }, nil?: true
|
|
122
|
-
|
|
123
|
-
# @!attribute header
|
|
124
|
-
# Header section of a message template
|
|
125
|
-
#
|
|
126
|
-
# @return [Sentdm::Models::TemplateUpdateParams::Definition::Header, nil]
|
|
127
|
-
optional :header, -> { Sentdm::TemplateUpdateParams::Definition::Header }, nil?: true
|
|
128
|
-
|
|
129
|
-
# @!method initialize(body:, authentication_config: nil, buttons: nil, definition_version: nil, footer: nil, header: nil)
|
|
130
|
-
# Complete definition of a message template including header, body, footer, and
|
|
131
|
-
# buttons
|
|
132
|
-
#
|
|
133
|
-
# @param body [Sentdm::Models::TemplateUpdateParams::Definition::Body] Body section of a message template with channel-specific content
|
|
134
|
-
#
|
|
135
|
-
# @param authentication_config [Sentdm::Models::TemplateUpdateParams::Definition::AuthenticationConfig, nil] Configuration for AUTHENTICATION category templates
|
|
136
|
-
#
|
|
137
|
-
# @param buttons [Array<Sentdm::Models::TemplateUpdateParams::Definition::Button>, nil] Optional list of interactive buttons (e.g., quick replies, URLs, phone numbers)
|
|
138
|
-
#
|
|
139
|
-
# @param definition_version [String, nil] The version of the template definition format
|
|
140
|
-
#
|
|
141
|
-
# @param footer [Sentdm::Models::TemplateUpdateParams::Definition::Footer, nil] Footer section of a message template
|
|
142
|
-
#
|
|
143
|
-
# @param header [Sentdm::Models::TemplateUpdateParams::Definition::Header, nil] Header section of a message template
|
|
144
|
-
|
|
145
|
-
# @see Sentdm::Models::TemplateUpdateParams::Definition#body
|
|
146
|
-
class Body < Sentdm::Internal::Type::BaseModel
|
|
147
|
-
# @!attribute multi_channel
|
|
148
|
-
# Content that will be used for all channels (SMS and WhatsApp) unless
|
|
149
|
-
# channel-specific content is provided
|
|
150
|
-
#
|
|
151
|
-
# @return [Sentdm::Models::TemplateUpdateParams::Definition::Body::MultiChannel, nil]
|
|
152
|
-
optional :multi_channel,
|
|
153
|
-
-> { Sentdm::TemplateUpdateParams::Definition::Body::MultiChannel },
|
|
154
|
-
api_name: :multiChannel,
|
|
155
|
-
nil?: true
|
|
156
|
-
|
|
157
|
-
# @!attribute rcs
|
|
158
|
-
# RCS-specific content that overrides multi-channel content for RCS messages
|
|
159
|
-
#
|
|
160
|
-
# @return [Sentdm::Models::TemplateUpdateParams::Definition::Body::Rcs, nil]
|
|
161
|
-
optional :rcs, -> { Sentdm::TemplateUpdateParams::Definition::Body::Rcs }, nil?: true
|
|
162
|
-
|
|
163
|
-
# @!attribute sms
|
|
164
|
-
# SMS-specific content that overrides multi-channel content for SMS messages
|
|
165
|
-
#
|
|
166
|
-
# @return [Sentdm::Models::TemplateUpdateParams::Definition::Body::SMS, nil]
|
|
167
|
-
optional :sms, -> { Sentdm::TemplateUpdateParams::Definition::Body::SMS }, nil?: true
|
|
168
|
-
|
|
169
|
-
# @!attribute whatsapp
|
|
170
|
-
# WhatsApp-specific content that overrides multi-channel content for WhatsApp
|
|
171
|
-
# messages
|
|
172
|
-
#
|
|
173
|
-
# @return [Sentdm::Models::TemplateUpdateParams::Definition::Body::Whatsapp, nil]
|
|
174
|
-
optional :whatsapp, -> { Sentdm::TemplateUpdateParams::Definition::Body::Whatsapp }, nil?: true
|
|
175
|
-
|
|
176
|
-
# @!method initialize(multi_channel: nil, rcs: nil, sms: nil, whatsapp: nil)
|
|
177
|
-
# Some parameter documentations has been truncated, see
|
|
178
|
-
# {Sentdm::Models::TemplateUpdateParams::Definition::Body} for more details.
|
|
179
|
-
#
|
|
180
|
-
# Body section of a message template with channel-specific content
|
|
181
|
-
#
|
|
182
|
-
# @param multi_channel [Sentdm::Models::TemplateUpdateParams::Definition::Body::MultiChannel, nil] Content that will be used for all channels (SMS and WhatsApp) unless channel-spe
|
|
183
|
-
#
|
|
184
|
-
# @param rcs [Sentdm::Models::TemplateUpdateParams::Definition::Body::Rcs, nil] RCS-specific content that overrides multi-channel content for RCS messages
|
|
185
|
-
#
|
|
186
|
-
# @param sms [Sentdm::Models::TemplateUpdateParams::Definition::Body::SMS, nil] SMS-specific content that overrides multi-channel content for SMS messages
|
|
187
|
-
#
|
|
188
|
-
# @param whatsapp [Sentdm::Models::TemplateUpdateParams::Definition::Body::Whatsapp, nil] WhatsApp-specific content that overrides multi-channel content for WhatsApp mess
|
|
189
|
-
|
|
190
|
-
# @see Sentdm::Models::TemplateUpdateParams::Definition::Body#multi_channel
|
|
191
|
-
class MultiChannel < Sentdm::Internal::Type::BaseModel
|
|
192
|
-
# @!attribute template
|
|
193
|
-
#
|
|
194
|
-
# @return [String]
|
|
195
|
-
required :template, String
|
|
196
|
-
|
|
197
|
-
# @!attribute type
|
|
198
|
-
#
|
|
199
|
-
# @return [String, nil]
|
|
200
|
-
optional :type, String, nil?: true
|
|
201
|
-
|
|
202
|
-
# @!attribute variables
|
|
203
|
-
#
|
|
204
|
-
# @return [Array<Sentdm::Models::TemplateUpdateParams::Definition::Body::MultiChannel::Variable>, nil]
|
|
205
|
-
optional :variables,
|
|
206
|
-
-> {
|
|
207
|
-
Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateUpdateParams::Definition::Body::MultiChannel::Variable]
|
|
208
|
-
},
|
|
209
|
-
nil?: true
|
|
210
|
-
|
|
211
|
-
# @!method initialize(template:, type: nil, variables: nil)
|
|
212
|
-
# Content that will be used for all channels (SMS and WhatsApp) unless
|
|
213
|
-
# channel-specific content is provided
|
|
214
|
-
#
|
|
215
|
-
# @param template [String]
|
|
216
|
-
# @param type [String, nil]
|
|
217
|
-
# @param variables [Array<Sentdm::Models::TemplateUpdateParams::Definition::Body::MultiChannel::Variable>, nil]
|
|
218
|
-
|
|
219
|
-
class Variable < Sentdm::Internal::Type::BaseModel
|
|
220
|
-
# @!attribute name
|
|
221
|
-
#
|
|
222
|
-
# @return [String]
|
|
223
|
-
required :name, String
|
|
224
|
-
|
|
225
|
-
# @!attribute props
|
|
226
|
-
#
|
|
227
|
-
# @return [Sentdm::Models::TemplateUpdateParams::Definition::Body::MultiChannel::Variable::Props]
|
|
228
|
-
required :props, -> { Sentdm::TemplateUpdateParams::Definition::Body::MultiChannel::Variable::Props }
|
|
229
|
-
|
|
230
|
-
# @!attribute type
|
|
231
|
-
#
|
|
232
|
-
# @return [String]
|
|
233
|
-
required :type, String
|
|
234
|
-
|
|
235
|
-
# @!attribute id
|
|
236
|
-
#
|
|
237
|
-
# @return [Integer, nil]
|
|
238
|
-
optional :id, Integer
|
|
239
|
-
|
|
240
|
-
# @!method initialize(name:, props:, type:, id: nil)
|
|
241
|
-
# @param name [String]
|
|
242
|
-
# @param props [Sentdm::Models::TemplateUpdateParams::Definition::Body::MultiChannel::Variable::Props]
|
|
243
|
-
# @param type [String]
|
|
244
|
-
# @param id [Integer]
|
|
245
|
-
|
|
246
|
-
# @see Sentdm::Models::TemplateUpdateParams::Definition::Body::MultiChannel::Variable#props
|
|
247
|
-
class Props < Sentdm::Internal::Type::BaseModel
|
|
248
|
-
# @!attribute media_type
|
|
249
|
-
#
|
|
250
|
-
# @return [String]
|
|
251
|
-
required :media_type, String, api_name: :mediaType
|
|
252
|
-
|
|
253
|
-
# @!attribute sample
|
|
254
|
-
#
|
|
255
|
-
# @return [String]
|
|
256
|
-
required :sample, String
|
|
257
|
-
|
|
258
|
-
# @!attribute url
|
|
259
|
-
#
|
|
260
|
-
# @return [String]
|
|
261
|
-
required :url, String
|
|
262
|
-
|
|
263
|
-
# @!attribute variable_type
|
|
264
|
-
#
|
|
265
|
-
# @return [String]
|
|
266
|
-
required :variable_type, String, api_name: :variableType
|
|
267
|
-
|
|
268
|
-
# @!attribute alt
|
|
269
|
-
#
|
|
270
|
-
# @return [String, nil]
|
|
271
|
-
optional :alt, String, nil?: true
|
|
272
|
-
|
|
273
|
-
# @!attribute regex
|
|
274
|
-
#
|
|
275
|
-
# @return [String, nil]
|
|
276
|
-
optional :regex, String, nil?: true
|
|
277
|
-
|
|
278
|
-
# @!attribute short_url
|
|
279
|
-
#
|
|
280
|
-
# @return [String, nil]
|
|
281
|
-
optional :short_url, String, api_name: :shortUrl, nil?: true
|
|
282
|
-
|
|
283
|
-
# @!method initialize(media_type:, sample:, url:, variable_type:, alt: nil, regex: nil, short_url: nil)
|
|
284
|
-
# @param media_type [String]
|
|
285
|
-
# @param sample [String]
|
|
286
|
-
# @param url [String]
|
|
287
|
-
# @param variable_type [String]
|
|
288
|
-
# @param alt [String, nil]
|
|
289
|
-
# @param regex [String, nil]
|
|
290
|
-
# @param short_url [String, nil]
|
|
291
|
-
end
|
|
292
|
-
end
|
|
293
|
-
end
|
|
294
|
-
|
|
295
|
-
# @see Sentdm::Models::TemplateUpdateParams::Definition::Body#rcs
|
|
296
|
-
class Rcs < Sentdm::Internal::Type::BaseModel
|
|
297
|
-
# @!attribute template
|
|
298
|
-
#
|
|
299
|
-
# @return [String]
|
|
300
|
-
required :template, String
|
|
301
|
-
|
|
302
|
-
# @!attribute type
|
|
303
|
-
#
|
|
304
|
-
# @return [String, nil]
|
|
305
|
-
optional :type, String, nil?: true
|
|
306
|
-
|
|
307
|
-
# @!attribute variables
|
|
308
|
-
#
|
|
309
|
-
# @return [Array<Sentdm::Models::TemplateUpdateParams::Definition::Body::Rcs::Variable>, nil]
|
|
310
|
-
optional :variables,
|
|
311
|
-
-> {
|
|
312
|
-
Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateUpdateParams::Definition::Body::Rcs::Variable]
|
|
313
|
-
},
|
|
314
|
-
nil?: true
|
|
315
|
-
|
|
316
|
-
# @!method initialize(template:, type: nil, variables: nil)
|
|
317
|
-
# RCS-specific content that overrides multi-channel content for RCS messages
|
|
318
|
-
#
|
|
319
|
-
# @param template [String]
|
|
320
|
-
# @param type [String, nil]
|
|
321
|
-
# @param variables [Array<Sentdm::Models::TemplateUpdateParams::Definition::Body::Rcs::Variable>, nil]
|
|
322
|
-
|
|
323
|
-
class Variable < Sentdm::Internal::Type::BaseModel
|
|
324
|
-
# @!attribute name
|
|
325
|
-
#
|
|
326
|
-
# @return [String]
|
|
327
|
-
required :name, String
|
|
328
|
-
|
|
329
|
-
# @!attribute props
|
|
330
|
-
#
|
|
331
|
-
# @return [Sentdm::Models::TemplateUpdateParams::Definition::Body::Rcs::Variable::Props]
|
|
332
|
-
required :props, -> { Sentdm::TemplateUpdateParams::Definition::Body::Rcs::Variable::Props }
|
|
333
|
-
|
|
334
|
-
# @!attribute type
|
|
335
|
-
#
|
|
336
|
-
# @return [String]
|
|
337
|
-
required :type, String
|
|
338
|
-
|
|
339
|
-
# @!attribute id
|
|
340
|
-
#
|
|
341
|
-
# @return [Integer, nil]
|
|
342
|
-
optional :id, Integer
|
|
343
|
-
|
|
344
|
-
# @!method initialize(name:, props:, type:, id: nil)
|
|
345
|
-
# @param name [String]
|
|
346
|
-
# @param props [Sentdm::Models::TemplateUpdateParams::Definition::Body::Rcs::Variable::Props]
|
|
347
|
-
# @param type [String]
|
|
348
|
-
# @param id [Integer]
|
|
349
|
-
|
|
350
|
-
# @see Sentdm::Models::TemplateUpdateParams::Definition::Body::Rcs::Variable#props
|
|
351
|
-
class Props < Sentdm::Internal::Type::BaseModel
|
|
352
|
-
# @!attribute media_type
|
|
353
|
-
#
|
|
354
|
-
# @return [String]
|
|
355
|
-
required :media_type, String, api_name: :mediaType
|
|
356
|
-
|
|
357
|
-
# @!attribute sample
|
|
358
|
-
#
|
|
359
|
-
# @return [String]
|
|
360
|
-
required :sample, String
|
|
361
|
-
|
|
362
|
-
# @!attribute url
|
|
363
|
-
#
|
|
364
|
-
# @return [String]
|
|
365
|
-
required :url, String
|
|
366
|
-
|
|
367
|
-
# @!attribute variable_type
|
|
368
|
-
#
|
|
369
|
-
# @return [String]
|
|
370
|
-
required :variable_type, String, api_name: :variableType
|
|
371
|
-
|
|
372
|
-
# @!attribute alt
|
|
373
|
-
#
|
|
374
|
-
# @return [String, nil]
|
|
375
|
-
optional :alt, String, nil?: true
|
|
376
|
-
|
|
377
|
-
# @!attribute regex
|
|
378
|
-
#
|
|
379
|
-
# @return [String, nil]
|
|
380
|
-
optional :regex, String, nil?: true
|
|
381
|
-
|
|
382
|
-
# @!attribute short_url
|
|
383
|
-
#
|
|
384
|
-
# @return [String, nil]
|
|
385
|
-
optional :short_url, String, api_name: :shortUrl, nil?: true
|
|
386
|
-
|
|
387
|
-
# @!method initialize(media_type:, sample:, url:, variable_type:, alt: nil, regex: nil, short_url: nil)
|
|
388
|
-
# @param media_type [String]
|
|
389
|
-
# @param sample [String]
|
|
390
|
-
# @param url [String]
|
|
391
|
-
# @param variable_type [String]
|
|
392
|
-
# @param alt [String, nil]
|
|
393
|
-
# @param regex [String, nil]
|
|
394
|
-
# @param short_url [String, nil]
|
|
395
|
-
end
|
|
396
|
-
end
|
|
397
|
-
end
|
|
398
|
-
|
|
399
|
-
# @see Sentdm::Models::TemplateUpdateParams::Definition::Body#sms
|
|
400
|
-
class SMS < Sentdm::Internal::Type::BaseModel
|
|
401
|
-
# @!attribute template
|
|
402
|
-
#
|
|
403
|
-
# @return [String]
|
|
404
|
-
required :template, String
|
|
405
|
-
|
|
406
|
-
# @!attribute type
|
|
407
|
-
#
|
|
408
|
-
# @return [String, nil]
|
|
409
|
-
optional :type, String, nil?: true
|
|
410
|
-
|
|
411
|
-
# @!attribute variables
|
|
412
|
-
#
|
|
413
|
-
# @return [Array<Sentdm::Models::TemplateUpdateParams::Definition::Body::SMS::Variable>, nil]
|
|
414
|
-
optional :variables,
|
|
415
|
-
-> {
|
|
416
|
-
Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateUpdateParams::Definition::Body::SMS::Variable]
|
|
417
|
-
},
|
|
418
|
-
nil?: true
|
|
419
|
-
|
|
420
|
-
# @!method initialize(template:, type: nil, variables: nil)
|
|
421
|
-
# SMS-specific content that overrides multi-channel content for SMS messages
|
|
422
|
-
#
|
|
423
|
-
# @param template [String]
|
|
424
|
-
# @param type [String, nil]
|
|
425
|
-
# @param variables [Array<Sentdm::Models::TemplateUpdateParams::Definition::Body::SMS::Variable>, nil]
|
|
426
|
-
|
|
427
|
-
class Variable < Sentdm::Internal::Type::BaseModel
|
|
428
|
-
# @!attribute name
|
|
429
|
-
#
|
|
430
|
-
# @return [String]
|
|
431
|
-
required :name, String
|
|
432
|
-
|
|
433
|
-
# @!attribute props
|
|
434
|
-
#
|
|
435
|
-
# @return [Sentdm::Models::TemplateUpdateParams::Definition::Body::SMS::Variable::Props]
|
|
436
|
-
required :props, -> { Sentdm::TemplateUpdateParams::Definition::Body::SMS::Variable::Props }
|
|
437
|
-
|
|
438
|
-
# @!attribute type
|
|
439
|
-
#
|
|
440
|
-
# @return [String]
|
|
441
|
-
required :type, String
|
|
442
|
-
|
|
443
|
-
# @!attribute id
|
|
444
|
-
#
|
|
445
|
-
# @return [Integer, nil]
|
|
446
|
-
optional :id, Integer
|
|
447
|
-
|
|
448
|
-
# @!method initialize(name:, props:, type:, id: nil)
|
|
449
|
-
# @param name [String]
|
|
450
|
-
# @param props [Sentdm::Models::TemplateUpdateParams::Definition::Body::SMS::Variable::Props]
|
|
451
|
-
# @param type [String]
|
|
452
|
-
# @param id [Integer]
|
|
453
|
-
|
|
454
|
-
# @see Sentdm::Models::TemplateUpdateParams::Definition::Body::SMS::Variable#props
|
|
455
|
-
class Props < Sentdm::Internal::Type::BaseModel
|
|
456
|
-
# @!attribute media_type
|
|
457
|
-
#
|
|
458
|
-
# @return [String]
|
|
459
|
-
required :media_type, String, api_name: :mediaType
|
|
460
|
-
|
|
461
|
-
# @!attribute sample
|
|
462
|
-
#
|
|
463
|
-
# @return [String]
|
|
464
|
-
required :sample, String
|
|
465
|
-
|
|
466
|
-
# @!attribute url
|
|
467
|
-
#
|
|
468
|
-
# @return [String]
|
|
469
|
-
required :url, String
|
|
470
|
-
|
|
471
|
-
# @!attribute variable_type
|
|
472
|
-
#
|
|
473
|
-
# @return [String]
|
|
474
|
-
required :variable_type, String, api_name: :variableType
|
|
475
|
-
|
|
476
|
-
# @!attribute alt
|
|
477
|
-
#
|
|
478
|
-
# @return [String, nil]
|
|
479
|
-
optional :alt, String, nil?: true
|
|
480
|
-
|
|
481
|
-
# @!attribute regex
|
|
482
|
-
#
|
|
483
|
-
# @return [String, nil]
|
|
484
|
-
optional :regex, String, nil?: true
|
|
485
|
-
|
|
486
|
-
# @!attribute short_url
|
|
487
|
-
#
|
|
488
|
-
# @return [String, nil]
|
|
489
|
-
optional :short_url, String, api_name: :shortUrl, nil?: true
|
|
490
|
-
|
|
491
|
-
# @!method initialize(media_type:, sample:, url:, variable_type:, alt: nil, regex: nil, short_url: nil)
|
|
492
|
-
# @param media_type [String]
|
|
493
|
-
# @param sample [String]
|
|
494
|
-
# @param url [String]
|
|
495
|
-
# @param variable_type [String]
|
|
496
|
-
# @param alt [String, nil]
|
|
497
|
-
# @param regex [String, nil]
|
|
498
|
-
# @param short_url [String, nil]
|
|
499
|
-
end
|
|
500
|
-
end
|
|
501
|
-
end
|
|
502
|
-
|
|
503
|
-
# @see Sentdm::Models::TemplateUpdateParams::Definition::Body#whatsapp
|
|
504
|
-
class Whatsapp < Sentdm::Internal::Type::BaseModel
|
|
505
|
-
# @!attribute template
|
|
506
|
-
#
|
|
507
|
-
# @return [String]
|
|
508
|
-
required :template, String
|
|
509
|
-
|
|
510
|
-
# @!attribute type
|
|
511
|
-
#
|
|
512
|
-
# @return [String, nil]
|
|
513
|
-
optional :type, String, nil?: true
|
|
514
|
-
|
|
515
|
-
# @!attribute variables
|
|
516
|
-
#
|
|
517
|
-
# @return [Array<Sentdm::Models::TemplateUpdateParams::Definition::Body::Whatsapp::Variable>, nil]
|
|
518
|
-
optional :variables,
|
|
519
|
-
-> {
|
|
520
|
-
Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateUpdateParams::Definition::Body::Whatsapp::Variable]
|
|
521
|
-
},
|
|
522
|
-
nil?: true
|
|
523
|
-
|
|
524
|
-
# @!method initialize(template:, type: nil, variables: nil)
|
|
525
|
-
# WhatsApp-specific content that overrides multi-channel content for WhatsApp
|
|
526
|
-
# messages
|
|
527
|
-
#
|
|
528
|
-
# @param template [String]
|
|
529
|
-
# @param type [String, nil]
|
|
530
|
-
# @param variables [Array<Sentdm::Models::TemplateUpdateParams::Definition::Body::Whatsapp::Variable>, nil]
|
|
531
|
-
|
|
532
|
-
class Variable < Sentdm::Internal::Type::BaseModel
|
|
533
|
-
# @!attribute name
|
|
534
|
-
#
|
|
535
|
-
# @return [String]
|
|
536
|
-
required :name, String
|
|
537
|
-
|
|
538
|
-
# @!attribute props
|
|
539
|
-
#
|
|
540
|
-
# @return [Sentdm::Models::TemplateUpdateParams::Definition::Body::Whatsapp::Variable::Props]
|
|
541
|
-
required :props, -> { Sentdm::TemplateUpdateParams::Definition::Body::Whatsapp::Variable::Props }
|
|
542
|
-
|
|
543
|
-
# @!attribute type
|
|
544
|
-
#
|
|
545
|
-
# @return [String]
|
|
546
|
-
required :type, String
|
|
547
|
-
|
|
548
|
-
# @!attribute id
|
|
549
|
-
#
|
|
550
|
-
# @return [Integer, nil]
|
|
551
|
-
optional :id, Integer
|
|
552
|
-
|
|
553
|
-
# @!method initialize(name:, props:, type:, id: nil)
|
|
554
|
-
# @param name [String]
|
|
555
|
-
# @param props [Sentdm::Models::TemplateUpdateParams::Definition::Body::Whatsapp::Variable::Props]
|
|
556
|
-
# @param type [String]
|
|
557
|
-
# @param id [Integer]
|
|
558
|
-
|
|
559
|
-
# @see Sentdm::Models::TemplateUpdateParams::Definition::Body::Whatsapp::Variable#props
|
|
560
|
-
class Props < Sentdm::Internal::Type::BaseModel
|
|
561
|
-
# @!attribute media_type
|
|
562
|
-
#
|
|
563
|
-
# @return [String]
|
|
564
|
-
required :media_type, String, api_name: :mediaType
|
|
565
|
-
|
|
566
|
-
# @!attribute sample
|
|
567
|
-
#
|
|
568
|
-
# @return [String]
|
|
569
|
-
required :sample, String
|
|
570
|
-
|
|
571
|
-
# @!attribute url
|
|
572
|
-
#
|
|
573
|
-
# @return [String]
|
|
574
|
-
required :url, String
|
|
575
|
-
|
|
576
|
-
# @!attribute variable_type
|
|
577
|
-
#
|
|
578
|
-
# @return [String]
|
|
579
|
-
required :variable_type, String, api_name: :variableType
|
|
580
|
-
|
|
581
|
-
# @!attribute alt
|
|
582
|
-
#
|
|
583
|
-
# @return [String, nil]
|
|
584
|
-
optional :alt, String, nil?: true
|
|
585
|
-
|
|
586
|
-
# @!attribute regex
|
|
587
|
-
#
|
|
588
|
-
# @return [String, nil]
|
|
589
|
-
optional :regex, String, nil?: true
|
|
590
|
-
|
|
591
|
-
# @!attribute short_url
|
|
592
|
-
#
|
|
593
|
-
# @return [String, nil]
|
|
594
|
-
optional :short_url, String, api_name: :shortUrl, nil?: true
|
|
595
|
-
|
|
596
|
-
# @!method initialize(media_type:, sample:, url:, variable_type:, alt: nil, regex: nil, short_url: nil)
|
|
597
|
-
# @param media_type [String]
|
|
598
|
-
# @param sample [String]
|
|
599
|
-
# @param url [String]
|
|
600
|
-
# @param variable_type [String]
|
|
601
|
-
# @param alt [String, nil]
|
|
602
|
-
# @param regex [String, nil]
|
|
603
|
-
# @param short_url [String, nil]
|
|
604
|
-
end
|
|
605
|
-
end
|
|
606
|
-
end
|
|
607
|
-
end
|
|
608
|
-
|
|
609
|
-
# @see Sentdm::Models::TemplateUpdateParams::Definition#authentication_config
|
|
610
|
-
class AuthenticationConfig < Sentdm::Internal::Type::BaseModel
|
|
611
|
-
# @!attribute add_security_recommendation
|
|
612
|
-
# Whether to add the security recommendation text: "For your security, do not
|
|
613
|
-
# share this code."
|
|
614
|
-
#
|
|
615
|
-
# @return [Boolean, nil]
|
|
616
|
-
optional :add_security_recommendation,
|
|
617
|
-
Sentdm::Internal::Type::Boolean,
|
|
618
|
-
api_name: :addSecurityRecommendation
|
|
619
|
-
|
|
620
|
-
# @!attribute code_expiration_minutes
|
|
621
|
-
# Code expiration time in minutes (1-90). If set, adds footer: "This code expires
|
|
622
|
-
# in X minutes."
|
|
623
|
-
#
|
|
624
|
-
# @return [Integer, nil]
|
|
625
|
-
optional :code_expiration_minutes, Integer, api_name: :codeExpirationMinutes, nil?: true
|
|
626
|
-
|
|
627
|
-
# @!method initialize(add_security_recommendation: nil, code_expiration_minutes: nil)
|
|
628
|
-
# Some parameter documentations has been truncated, see
|
|
629
|
-
# {Sentdm::Models::TemplateUpdateParams::Definition::AuthenticationConfig} for
|
|
630
|
-
# more details.
|
|
631
|
-
#
|
|
632
|
-
# Configuration for AUTHENTICATION category templates
|
|
633
|
-
#
|
|
634
|
-
# @param add_security_recommendation [Boolean] Whether to add the security recommendation text: "For your security, do not shar
|
|
635
|
-
#
|
|
636
|
-
# @param code_expiration_minutes [Integer, nil] Code expiration time in minutes (1-90). If set, adds footer: "This code expires
|
|
637
|
-
end
|
|
638
|
-
|
|
639
|
-
class Button < Sentdm::Internal::Type::BaseModel
|
|
640
|
-
# @!attribute props
|
|
641
|
-
# Properties specific to the button type
|
|
642
|
-
#
|
|
643
|
-
# @return [Sentdm::Models::TemplateUpdateParams::Definition::Button::Props]
|
|
644
|
-
required :props, -> { Sentdm::TemplateUpdateParams::Definition::Button::Props }
|
|
645
|
-
|
|
646
|
-
# @!attribute type
|
|
647
|
-
# The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
|
|
648
|
-
#
|
|
649
|
-
# @return [String]
|
|
650
|
-
required :type, String
|
|
651
|
-
|
|
652
|
-
# @!attribute id
|
|
653
|
-
# The unique identifier of the button (1-based index)
|
|
654
|
-
#
|
|
655
|
-
# @return [Integer, nil]
|
|
656
|
-
optional :id, Integer
|
|
657
|
-
|
|
658
|
-
# @!method initialize(props:, type:, id: nil)
|
|
659
|
-
# Some parameter documentations has been truncated, see
|
|
660
|
-
# {Sentdm::Models::TemplateUpdateParams::Definition::Button} for more details.
|
|
661
|
-
#
|
|
662
|
-
# Interactive button in a message template
|
|
663
|
-
#
|
|
664
|
-
# @param props [Sentdm::Models::TemplateUpdateParams::Definition::Button::Props] Properties specific to the button type
|
|
665
|
-
#
|
|
666
|
-
# @param type [String] The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
|
|
667
|
-
#
|
|
668
|
-
# @param id [Integer] The unique identifier of the button (1-based index)
|
|
669
|
-
|
|
670
|
-
# @see Sentdm::Models::TemplateUpdateParams::Definition::Button#props
|
|
671
|
-
class Props < Sentdm::Internal::Type::BaseModel
|
|
672
|
-
# @!attribute active_for
|
|
673
|
-
#
|
|
674
|
-
# @return [Integer]
|
|
675
|
-
required :active_for, Integer, api_name: :activeFor
|
|
676
|
-
|
|
677
|
-
# @!attribute country_code
|
|
678
|
-
#
|
|
679
|
-
# @return [String]
|
|
680
|
-
required :country_code, String, api_name: :countryCode
|
|
681
|
-
|
|
682
|
-
# @!attribute offer_code
|
|
683
|
-
#
|
|
684
|
-
# @return [String]
|
|
685
|
-
required :offer_code, String, api_name: :offerCode
|
|
686
|
-
|
|
687
|
-
# @!attribute phone_number
|
|
688
|
-
#
|
|
689
|
-
# @return [String]
|
|
690
|
-
required :phone_number, String, api_name: :phoneNumber
|
|
691
|
-
|
|
692
|
-
# @!attribute quick_reply_type
|
|
693
|
-
#
|
|
694
|
-
# @return [String]
|
|
695
|
-
required :quick_reply_type, String, api_name: :quickReplyType
|
|
696
|
-
|
|
697
|
-
# @!attribute text
|
|
698
|
-
#
|
|
699
|
-
# @return [String]
|
|
700
|
-
required :text, String
|
|
701
|
-
|
|
702
|
-
# @!attribute url
|
|
703
|
-
#
|
|
704
|
-
# @return [String]
|
|
705
|
-
required :url, String
|
|
706
|
-
|
|
707
|
-
# @!attribute url_type
|
|
708
|
-
#
|
|
709
|
-
# @return [String]
|
|
710
|
-
required :url_type, String, api_name: :urlType
|
|
711
|
-
|
|
712
|
-
# @!attribute autofill_text
|
|
713
|
-
#
|
|
714
|
-
# @return [String, nil]
|
|
715
|
-
optional :autofill_text, String, api_name: :autofillText, nil?: true
|
|
716
|
-
|
|
717
|
-
# @!attribute otp_type
|
|
718
|
-
#
|
|
719
|
-
# @return [String, nil]
|
|
720
|
-
optional :otp_type, String, api_name: :otpType, nil?: true
|
|
721
|
-
|
|
722
|
-
# @!attribute package_name
|
|
723
|
-
#
|
|
724
|
-
# @return [String, nil]
|
|
725
|
-
optional :package_name, String, api_name: :packageName, nil?: true
|
|
726
|
-
|
|
727
|
-
# @!attribute signature_hash
|
|
728
|
-
#
|
|
729
|
-
# @return [String, nil]
|
|
730
|
-
optional :signature_hash, String, api_name: :signatureHash, nil?: true
|
|
731
|
-
|
|
732
|
-
# @!method initialize(active_for:, country_code:, offer_code:, phone_number:, quick_reply_type:, text:, url:, url_type:, autofill_text: nil, otp_type: nil, package_name: nil, signature_hash: nil)
|
|
733
|
-
# Properties specific to the button type
|
|
734
|
-
#
|
|
735
|
-
# @param active_for [Integer]
|
|
736
|
-
# @param country_code [String]
|
|
737
|
-
# @param offer_code [String]
|
|
738
|
-
# @param phone_number [String]
|
|
739
|
-
# @param quick_reply_type [String]
|
|
740
|
-
# @param text [String]
|
|
741
|
-
# @param url [String]
|
|
742
|
-
# @param url_type [String]
|
|
743
|
-
# @param autofill_text [String, nil]
|
|
744
|
-
# @param otp_type [String, nil]
|
|
745
|
-
# @param package_name [String, nil]
|
|
746
|
-
# @param signature_hash [String, nil]
|
|
747
|
-
end
|
|
748
|
-
end
|
|
749
|
-
|
|
750
|
-
# @see Sentdm::Models::TemplateUpdateParams::Definition#footer
|
|
751
|
-
class Footer < Sentdm::Internal::Type::BaseModel
|
|
752
|
-
# @!attribute template
|
|
753
|
-
# The footer template text with optional variable placeholders
|
|
754
|
-
#
|
|
755
|
-
# @return [String]
|
|
756
|
-
required :template, String
|
|
757
|
-
|
|
758
|
-
# @!attribute type
|
|
759
|
-
# The type of footer (typically "text")
|
|
760
|
-
#
|
|
761
|
-
# @return [String, nil]
|
|
762
|
-
optional :type, String, nil?: true
|
|
763
|
-
|
|
764
|
-
# @!attribute variables
|
|
765
|
-
# List of variables used in the footer template
|
|
766
|
-
#
|
|
767
|
-
# @return [Array<Sentdm::Models::TemplateUpdateParams::Definition::Footer::Variable>, nil]
|
|
768
|
-
optional :variables,
|
|
769
|
-
-> {
|
|
770
|
-
Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateUpdateParams::Definition::Footer::Variable]
|
|
771
|
-
},
|
|
772
|
-
nil?: true
|
|
773
|
-
|
|
774
|
-
# @!method initialize(template:, type: nil, variables: nil)
|
|
775
|
-
# Footer section of a message template
|
|
776
|
-
#
|
|
777
|
-
# @param template [String] The footer template text with optional variable placeholders
|
|
778
|
-
#
|
|
779
|
-
# @param type [String, nil] The type of footer (typically "text")
|
|
780
|
-
#
|
|
781
|
-
# @param variables [Array<Sentdm::Models::TemplateUpdateParams::Definition::Footer::Variable>, nil] List of variables used in the footer template
|
|
782
|
-
|
|
783
|
-
class Variable < Sentdm::Internal::Type::BaseModel
|
|
784
|
-
# @!attribute name
|
|
785
|
-
#
|
|
786
|
-
# @return [String]
|
|
787
|
-
required :name, String
|
|
788
|
-
|
|
789
|
-
# @!attribute props
|
|
790
|
-
#
|
|
791
|
-
# @return [Sentdm::Models::TemplateUpdateParams::Definition::Footer::Variable::Props]
|
|
792
|
-
required :props, -> { Sentdm::TemplateUpdateParams::Definition::Footer::Variable::Props }
|
|
793
|
-
|
|
794
|
-
# @!attribute type
|
|
795
|
-
#
|
|
796
|
-
# @return [String]
|
|
797
|
-
required :type, String
|
|
798
|
-
|
|
799
|
-
# @!attribute id
|
|
800
|
-
#
|
|
801
|
-
# @return [Integer, nil]
|
|
802
|
-
optional :id, Integer
|
|
803
|
-
|
|
804
|
-
# @!method initialize(name:, props:, type:, id: nil)
|
|
805
|
-
# @param name [String]
|
|
806
|
-
# @param props [Sentdm::Models::TemplateUpdateParams::Definition::Footer::Variable::Props]
|
|
807
|
-
# @param type [String]
|
|
808
|
-
# @param id [Integer]
|
|
809
|
-
|
|
810
|
-
# @see Sentdm::Models::TemplateUpdateParams::Definition::Footer::Variable#props
|
|
811
|
-
class Props < Sentdm::Internal::Type::BaseModel
|
|
812
|
-
# @!attribute media_type
|
|
813
|
-
#
|
|
814
|
-
# @return [String]
|
|
815
|
-
required :media_type, String, api_name: :mediaType
|
|
816
|
-
|
|
817
|
-
# @!attribute sample
|
|
818
|
-
#
|
|
819
|
-
# @return [String]
|
|
820
|
-
required :sample, String
|
|
821
|
-
|
|
822
|
-
# @!attribute url
|
|
823
|
-
#
|
|
824
|
-
# @return [String]
|
|
825
|
-
required :url, String
|
|
826
|
-
|
|
827
|
-
# @!attribute variable_type
|
|
828
|
-
#
|
|
829
|
-
# @return [String]
|
|
830
|
-
required :variable_type, String, api_name: :variableType
|
|
831
|
-
|
|
832
|
-
# @!attribute alt
|
|
833
|
-
#
|
|
834
|
-
# @return [String, nil]
|
|
835
|
-
optional :alt, String, nil?: true
|
|
836
|
-
|
|
837
|
-
# @!attribute regex
|
|
838
|
-
#
|
|
839
|
-
# @return [String, nil]
|
|
840
|
-
optional :regex, String, nil?: true
|
|
841
|
-
|
|
842
|
-
# @!attribute short_url
|
|
843
|
-
#
|
|
844
|
-
# @return [String, nil]
|
|
845
|
-
optional :short_url, String, api_name: :shortUrl, nil?: true
|
|
846
|
-
|
|
847
|
-
# @!method initialize(media_type:, sample:, url:, variable_type:, alt: nil, regex: nil, short_url: nil)
|
|
848
|
-
# @param media_type [String]
|
|
849
|
-
# @param sample [String]
|
|
850
|
-
# @param url [String]
|
|
851
|
-
# @param variable_type [String]
|
|
852
|
-
# @param alt [String, nil]
|
|
853
|
-
# @param regex [String, nil]
|
|
854
|
-
# @param short_url [String, nil]
|
|
855
|
-
end
|
|
856
|
-
end
|
|
857
|
-
end
|
|
858
|
-
|
|
859
|
-
# @see Sentdm::Models::TemplateUpdateParams::Definition#header
|
|
860
|
-
class Header < Sentdm::Internal::Type::BaseModel
|
|
861
|
-
# @!attribute template
|
|
862
|
-
# The header template text with optional variable placeholders (e.g., "Welcome to
|
|
863
|
-
# {{0:variable}}")
|
|
864
|
-
#
|
|
865
|
-
# @return [String]
|
|
866
|
-
required :template, String
|
|
867
|
-
|
|
868
|
-
# @!attribute type
|
|
869
|
-
# The type of header (e.g., "text", "image", "video", "document")
|
|
870
|
-
#
|
|
871
|
-
# @return [String, nil]
|
|
872
|
-
optional :type, String, nil?: true
|
|
873
|
-
|
|
874
|
-
# @!attribute variables
|
|
875
|
-
# List of variables used in the header template
|
|
876
|
-
#
|
|
877
|
-
# @return [Array<Sentdm::Models::TemplateUpdateParams::Definition::Header::Variable>, nil]
|
|
878
|
-
optional :variables,
|
|
879
|
-
-> {
|
|
880
|
-
Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateUpdateParams::Definition::Header::Variable]
|
|
881
|
-
},
|
|
882
|
-
nil?: true
|
|
883
|
-
|
|
884
|
-
# @!method initialize(template:, type: nil, variables: nil)
|
|
885
|
-
# Some parameter documentations has been truncated, see
|
|
886
|
-
# {Sentdm::Models::TemplateUpdateParams::Definition::Header} for more details.
|
|
887
|
-
#
|
|
888
|
-
# Header section of a message template
|
|
889
|
-
#
|
|
890
|
-
# @param template [String] The header template text with optional variable placeholders (e.g., "Welcome to
|
|
891
|
-
#
|
|
892
|
-
# @param type [String, nil] The type of header (e.g., "text", "image", "video", "document")
|
|
893
|
-
#
|
|
894
|
-
# @param variables [Array<Sentdm::Models::TemplateUpdateParams::Definition::Header::Variable>, nil] List of variables used in the header template
|
|
895
|
-
|
|
896
|
-
class Variable < Sentdm::Internal::Type::BaseModel
|
|
897
|
-
# @!attribute name
|
|
898
|
-
#
|
|
899
|
-
# @return [String]
|
|
900
|
-
required :name, String
|
|
901
|
-
|
|
902
|
-
# @!attribute props
|
|
903
|
-
#
|
|
904
|
-
# @return [Sentdm::Models::TemplateUpdateParams::Definition::Header::Variable::Props]
|
|
905
|
-
required :props, -> { Sentdm::TemplateUpdateParams::Definition::Header::Variable::Props }
|
|
906
|
-
|
|
907
|
-
# @!attribute type
|
|
908
|
-
#
|
|
909
|
-
# @return [String]
|
|
910
|
-
required :type, String
|
|
911
|
-
|
|
912
|
-
# @!attribute id
|
|
913
|
-
#
|
|
914
|
-
# @return [Integer, nil]
|
|
915
|
-
optional :id, Integer
|
|
916
|
-
|
|
917
|
-
# @!method initialize(name:, props:, type:, id: nil)
|
|
918
|
-
# @param name [String]
|
|
919
|
-
# @param props [Sentdm::Models::TemplateUpdateParams::Definition::Header::Variable::Props]
|
|
920
|
-
# @param type [String]
|
|
921
|
-
# @param id [Integer]
|
|
922
|
-
|
|
923
|
-
# @see Sentdm::Models::TemplateUpdateParams::Definition::Header::Variable#props
|
|
924
|
-
class Props < Sentdm::Internal::Type::BaseModel
|
|
925
|
-
# @!attribute media_type
|
|
926
|
-
#
|
|
927
|
-
# @return [String]
|
|
928
|
-
required :media_type, String, api_name: :mediaType
|
|
929
|
-
|
|
930
|
-
# @!attribute sample
|
|
931
|
-
#
|
|
932
|
-
# @return [String]
|
|
933
|
-
required :sample, String
|
|
934
|
-
|
|
935
|
-
# @!attribute url
|
|
936
|
-
#
|
|
937
|
-
# @return [String]
|
|
938
|
-
required :url, String
|
|
939
|
-
|
|
940
|
-
# @!attribute variable_type
|
|
941
|
-
#
|
|
942
|
-
# @return [String]
|
|
943
|
-
required :variable_type, String, api_name: :variableType
|
|
944
|
-
|
|
945
|
-
# @!attribute alt
|
|
946
|
-
#
|
|
947
|
-
# @return [String, nil]
|
|
948
|
-
optional :alt, String, nil?: true
|
|
949
|
-
|
|
950
|
-
# @!attribute regex
|
|
951
|
-
#
|
|
952
|
-
# @return [String, nil]
|
|
953
|
-
optional :regex, String, nil?: true
|
|
954
|
-
|
|
955
|
-
# @!attribute short_url
|
|
956
|
-
#
|
|
957
|
-
# @return [String, nil]
|
|
958
|
-
optional :short_url, String, api_name: :shortUrl, nil?: true
|
|
959
|
-
|
|
960
|
-
# @!method initialize(media_type:, sample:, url:, variable_type:, alt: nil, regex: nil, short_url: nil)
|
|
961
|
-
# @param media_type [String]
|
|
962
|
-
# @param sample [String]
|
|
963
|
-
# @param url [String]
|
|
964
|
-
# @param variable_type [String]
|
|
965
|
-
# @param alt [String, nil]
|
|
966
|
-
# @param regex [String, nil]
|
|
967
|
-
# @param short_url [String, nil]
|
|
968
|
-
end
|
|
969
|
-
end
|
|
970
|
-
end
|
|
971
|
-
end
|
|
972
86
|
end
|
|
973
87
|
end
|
|
974
88
|
end
|