sentdm 0.3.1 → 0.5.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 +16 -0
- data/README.md +1 -27
- data/lib/sentdm/client.rb +5 -9
- data/lib/sentdm/internal/type/base_model.rb +5 -5
- data/lib/sentdm/models/api_meta.rb +1 -9
- data/lib/sentdm/models/{api_response_contact.rb → api_response_of_contact.rb} +4 -4
- data/lib/sentdm/models/base_dto.rb +30 -0
- data/lib/sentdm/models/billing_contact_info.rb +47 -0
- data/lib/sentdm/models/brands_brand_data.rb +274 -0
- data/lib/sentdm/models/contact_create_params.rb +13 -6
- data/lib/sentdm/models/contact_delete_params.rb +9 -2
- data/lib/sentdm/models/contact_list_params.rb +10 -2
- data/lib/sentdm/models/contact_list_response.rb +3 -3
- data/lib/sentdm/models/{contact.rb → contact_response.rb} +1 -1
- data/lib/sentdm/models/contact_retrieve_params.rb +7 -1
- data/lib/sentdm/models/contact_update_params.rb +13 -6
- data/lib/sentdm/models/me_retrieve_params.rb +7 -1
- data/lib/sentdm/models/me_retrieve_response.rb +152 -7
- data/lib/sentdm/models/message_retrieve_activities_params.rb +7 -1
- data/lib/sentdm/models/message_retrieve_activities_response.rb +19 -5
- data/lib/sentdm/models/message_retrieve_status_params.rb +7 -1
- data/lib/sentdm/models/message_retrieve_status_response.rb +8 -1
- data/lib/sentdm/models/message_send_params.rb +17 -10
- data/lib/sentdm/models/mutation_request_base.rb +20 -0
- data/lib/sentdm/models/{lookup_retrieve_phone_info_params.rb → number_lookup_params.rb} +9 -3
- data/lib/sentdm/models/{lookup_retrieve_phone_info_response.rb → number_lookup_response.rb} +21 -21
- data/lib/sentdm/models/payment_details.rb +44 -0
- data/lib/sentdm/models/{profile_complete_params.rb → profile_complete_setup_params.rb} +16 -9
- data/lib/sentdm/models/{profile_complete_response.rb → profile_complete_setup_response.rb} +1 -1
- data/lib/sentdm/models/profile_create_params.rb +111 -11
- data/lib/sentdm/models/profile_delete_params.rb +18 -18
- data/lib/sentdm/models/profile_detail.rb +483 -68
- data/lib/sentdm/models/profile_list_params.rb +7 -1
- data/lib/sentdm/models/profile_retrieve_params.rb +7 -1
- data/lib/sentdm/models/profile_update_params.rb +60 -22
- data/lib/sentdm/models/{brands/api_response_tcr_campaign_with_use_cases.rb → profiles/api_response_of_tcr_campaign_with_use_cases.rb} +6 -6
- data/lib/sentdm/models/profiles/campaign_create_params.rb +57 -0
- data/lib/sentdm/models/{brands → profiles}/campaign_data.rb +28 -7
- data/lib/sentdm/models/profiles/campaign_delete_params.rb +50 -0
- data/lib/sentdm/models/profiles/campaign_list_params.rb +28 -0
- data/lib/sentdm/models/{brands → profiles}/campaign_list_response.rb +5 -5
- data/lib/sentdm/models/profiles/campaign_update_params.rb +64 -0
- data/lib/sentdm/models/{brands → profiles}/messaging_use_case_us.rb +1 -1
- data/lib/sentdm/models/{brands → profiles}/tcr_campaign_with_use_cases.rb +15 -15
- data/lib/sentdm/models/template_create_params.rb +17 -10
- data/lib/sentdm/models/template_definition.rb +255 -15
- data/lib/sentdm/models/template_delete_params.rb +13 -6
- data/lib/sentdm/models/template_list_params.rb +18 -2
- data/lib/sentdm/models/template_retrieve_params.rb +7 -1
- data/lib/sentdm/models/template_update_params.rb +17 -10
- data/lib/sentdm/models/template_variable.rb +7 -1
- data/lib/sentdm/models/user_invite_params.rb +13 -6
- data/lib/sentdm/models/user_list_params.rb +7 -1
- data/lib/sentdm/models/user_remove_params.rb +17 -17
- data/lib/sentdm/models/user_retrieve_params.rb +7 -1
- data/lib/sentdm/models/user_update_role_params.rb +15 -16
- data/lib/sentdm/models/webhook_create_params.rb +13 -6
- data/lib/sentdm/models/webhook_delete_params.rb +7 -1
- data/lib/sentdm/models/webhook_list_event_types_params.rb +7 -1
- data/lib/sentdm/models/webhook_list_events_params.rb +7 -1
- data/lib/sentdm/models/webhook_list_params.rb +7 -1
- data/lib/sentdm/models/webhook_retrieve_params.rb +7 -1
- data/lib/sentdm/models/webhook_rotate_secret_params.rb +8 -2
- data/lib/sentdm/models/webhook_test_params.rb +13 -6
- data/lib/sentdm/models/webhook_toggle_status_params.rb +13 -6
- data/lib/sentdm/models/webhook_update_params.rb +13 -6
- data/lib/sentdm/models.rb +14 -38
- data/lib/sentdm/resources/contacts.rb +49 -26
- data/lib/sentdm/resources/me.rb +24 -5
- data/lib/sentdm/resources/messages.rb +24 -8
- data/lib/sentdm/resources/numbers.rb +44 -0
- data/lib/sentdm/resources/profiles/campaigns.rb +160 -0
- data/lib/sentdm/resources/profiles.rb +125 -36
- data/lib/sentdm/resources/templates.rb +47 -24
- data/lib/sentdm/resources/users.rb +40 -23
- data/lib/sentdm/resources/webhooks.rb +92 -34
- data/lib/sentdm/version.rb +1 -1
- data/lib/sentdm.rb +22 -35
- data/rbi/sentdm/client.rbi +4 -7
- data/rbi/sentdm/models/api_meta.rbi +4 -18
- data/rbi/sentdm/models/{api_response_brand_with_kyc.rbi → api_response_of_contact.rbi} +6 -6
- data/rbi/sentdm/models/base_dto.rbi +49 -0
- data/rbi/sentdm/models/billing_contact_info.rbi +65 -0
- data/rbi/sentdm/models/brands_brand_data.rbi +406 -0
- data/rbi/sentdm/models/contact_create_params.rbi +19 -10
- data/rbi/sentdm/models/contact_delete_params.rbi +10 -1
- data/rbi/sentdm/models/contact_list_params.rbi +11 -0
- data/rbi/sentdm/models/contact_list_response.rbi +4 -4
- data/rbi/sentdm/models/{contact.rbi → contact_response.rbi} +4 -2
- data/rbi/sentdm/models/contact_retrieve_params.rbi +13 -2
- data/rbi/sentdm/models/contact_update_params.rbi +19 -10
- data/rbi/sentdm/models/me_retrieve_params.rbi +16 -5
- data/rbi/sentdm/models/me_retrieve_response.rbi +316 -16
- data/rbi/sentdm/models/message_retrieve_activities_params.rbi +13 -2
- data/rbi/sentdm/models/message_retrieve_activities_response.rbi +18 -6
- data/rbi/sentdm/models/message_retrieve_status_params.rbi +13 -2
- data/rbi/sentdm/models/message_retrieve_status_response.rbi +6 -0
- data/rbi/sentdm/models/message_send_params.rbi +22 -13
- data/rbi/sentdm/models/mutation_request_base.rbi +32 -0
- data/rbi/sentdm/models/{lookup_retrieve_phone_info_params.rbi → number_lookup_params.rbi} +15 -7
- data/rbi/sentdm/models/{lookup_retrieve_phone_info_response.rbi → number_lookup_response.rbi} +16 -33
- data/rbi/sentdm/models/payment_details.rbi +59 -0
- data/rbi/sentdm/models/{profile_complete_params.rbi → profile_complete_setup_params.rbi} +21 -12
- data/rbi/sentdm/models/{profile_complete_response.rbi → profile_complete_setup_response.rbi} +1 -1
- data/rbi/sentdm/models/profile_create_params.rbi +189 -15
- data/rbi/sentdm/models/profile_delete_params.rbi +36 -24
- data/rbi/sentdm/models/profile_detail.rbi +725 -111
- data/rbi/sentdm/models/profile_list_params.rbi +16 -5
- data/rbi/sentdm/models/profile_retrieve_params.rbi +13 -2
- data/rbi/sentdm/models/profile_update_params.rbi +97 -30
- data/rbi/sentdm/models/{brands/api_response_tcr_campaign_with_use_cases.rbi → profiles/api_response_of_tcr_campaign_with_use_cases.rbi} +7 -7
- data/rbi/sentdm/models/{brands → profiles}/campaign_create_params.rbi +29 -20
- data/rbi/sentdm/models/{brands → profiles}/campaign_data.rbi +51 -16
- data/rbi/sentdm/models/{brands → profiles}/campaign_delete_params.rbi +23 -12
- data/rbi/sentdm/models/profiles/campaign_list_params.rbi +51 -0
- data/rbi/sentdm/models/{brands → profiles}/campaign_list_response.rbi +7 -5
- data/rbi/sentdm/models/{brands → profiles}/campaign_update_params.rbi +29 -20
- data/rbi/sentdm/models/{brands → profiles}/messaging_use_case_us.rbi +20 -16
- data/rbi/sentdm/models/{brands → profiles}/tcr_campaign_with_use_cases.rbi +35 -29
- data/rbi/sentdm/models/template_create_params.rbi +22 -13
- data/rbi/sentdm/models/template_definition.rbi +405 -74
- data/rbi/sentdm/models/template_delete_params.rbi +19 -10
- data/rbi/sentdm/models/template_list_params.rbi +19 -0
- data/rbi/sentdm/models/template_retrieve_params.rbi +13 -2
- data/rbi/sentdm/models/template_update_params.rbi +22 -13
- data/rbi/sentdm/models/template_variable.rbi +6 -0
- data/rbi/sentdm/models/user_invite_params.rbi +19 -10
- data/rbi/sentdm/models/user_list_params.rbi +16 -5
- data/rbi/sentdm/models/user_remove_params.rbi +35 -23
- data/rbi/sentdm/models/user_retrieve_params.rbi +13 -2
- data/rbi/sentdm/models/user_update_role_params.rbi +23 -25
- data/rbi/sentdm/models/webhook_create_params.rbi +19 -10
- data/rbi/sentdm/models/webhook_delete_params.rbi +13 -2
- data/rbi/sentdm/models/webhook_list_event_types_params.rbi +16 -5
- data/rbi/sentdm/models/webhook_list_events_params.rbi +16 -1
- data/rbi/sentdm/models/webhook_list_params.rbi +9 -0
- data/rbi/sentdm/models/webhook_retrieve_params.rbi +13 -2
- data/rbi/sentdm/models/webhook_rotate_secret_params.rbi +16 -2
- data/rbi/sentdm/models/webhook_test_params.rbi +19 -10
- data/rbi/sentdm/models/webhook_toggle_status_params.rbi +19 -10
- data/rbi/sentdm/models/webhook_update_params.rbi +19 -10
- data/rbi/sentdm/models.rbi +14 -38
- data/rbi/sentdm/resources/contacts.rbi +40 -15
- data/rbi/sentdm/resources/me.rbi +25 -7
- data/rbi/sentdm/resources/messages.rbi +17 -4
- data/rbi/sentdm/resources/numbers.rbi +32 -0
- data/rbi/sentdm/resources/profiles/campaigns.rbi +127 -0
- data/rbi/sentdm/resources/profiles.rbi +179 -39
- data/rbi/sentdm/resources/templates.rbi +47 -19
- data/rbi/sentdm/resources/users.rbi +47 -25
- data/rbi/sentdm/resources/webhooks.rbi +92 -20
- data/sig/sentdm/client.rbs +2 -4
- data/sig/sentdm/models/api_meta.rbs +2 -16
- data/sig/sentdm/models/{api_response_contact.rbs → api_response_of_contact.rbs} +6 -6
- data/sig/sentdm/models/base_dto.rbs +25 -0
- data/sig/sentdm/models/billing_contact_info.rbs +30 -0
- data/sig/sentdm/models/brands_brand_data.rbs +210 -0
- data/sig/sentdm/models/contact_create_params.rbs +16 -5
- data/sig/sentdm/models/contact_delete_params.rbs +12 -2
- data/sig/sentdm/models/contact_list_params.rbs +8 -1
- data/sig/sentdm/models/contact_list_response.rbs +7 -5
- data/sig/sentdm/models/{contact.rbs → contact_response.rbs} +2 -2
- data/sig/sentdm/models/contact_retrieve_params.rbs +12 -2
- data/sig/sentdm/models/contact_update_params.rbs +13 -6
- data/sig/sentdm/models/me_retrieve_params.rbs +14 -3
- data/sig/sentdm/models/me_retrieve_response.rbs +134 -7
- data/sig/sentdm/models/message_retrieve_activities_params.rbs +12 -2
- data/sig/sentdm/models/message_retrieve_activities_response.rbs +9 -4
- data/sig/sentdm/models/message_retrieve_status_params.rbs +12 -2
- data/sig/sentdm/models/message_retrieve_status_response.rbs +5 -0
- data/sig/sentdm/models/message_send_params.rbs +15 -8
- data/sig/sentdm/models/mutation_request_base.rbs +15 -0
- data/sig/sentdm/models/{lookup_retrieve_phone_info_params.rbs → number_lookup_params.rbs} +10 -3
- data/sig/sentdm/models/{lookup_retrieve_phone_info_response.rbs → number_lookup_response.rbs} +14 -16
- data/sig/sentdm/models/payment_details.rbs +30 -0
- data/sig/sentdm/models/{profile_complete_params.rbs → profile_complete_setup_params.rbs} +15 -8
- data/sig/sentdm/models/profile_complete_setup_response.rbs +5 -0
- data/sig/sentdm/models/profile_create_params.rbs +57 -7
- data/sig/sentdm/models/profile_delete_params.rbs +23 -13
- data/sig/sentdm/models/profile_detail.rbs +374 -68
- data/sig/sentdm/models/profile_list_params.rbs +14 -3
- data/sig/sentdm/models/profile_retrieve_params.rbs +8 -1
- data/sig/sentdm/models/profile_update_params.rbs +32 -17
- data/sig/sentdm/models/{brands/api_response_tcr_campaign_with_use_cases.rbs → profiles/api_response_of_tcr_campaign_with_use_cases.rbs} +7 -7
- data/sig/sentdm/models/profiles/campaign_create_params.rbs +54 -0
- data/sig/sentdm/models/{brands → profiles}/campaign_data.rbs +27 -5
- data/sig/sentdm/models/{brands → profiles}/campaign_delete_params.rbs +17 -10
- data/sig/sentdm/models/{brands → profiles}/campaign_list_params.rbs +12 -5
- data/sig/sentdm/models/{brands → profiles}/campaign_list_response.rbs +5 -5
- data/sig/sentdm/models/{brands → profiles}/campaign_update_params.rbs +22 -15
- data/sig/sentdm/models/{brands → profiles}/messaging_use_case_us.rbs +2 -2
- data/sig/sentdm/models/{brands → profiles}/tcr_campaign_with_use_cases.rbs +29 -29
- data/sig/sentdm/models/template_create_params.rbs +15 -8
- data/sig/sentdm/models/template_definition.rbs +233 -20
- data/sig/sentdm/models/template_delete_params.rbs +16 -5
- data/sig/sentdm/models/template_list_params.rbs +13 -1
- data/sig/sentdm/models/template_retrieve_params.rbs +12 -2
- data/sig/sentdm/models/template_update_params.rbs +15 -8
- data/sig/sentdm/models/template_variable.rbs +5 -0
- data/sig/sentdm/models/user_invite_params.rbs +13 -6
- data/sig/sentdm/models/user_list_params.rbs +14 -3
- data/sig/sentdm/models/user_remove_params.rbs +23 -13
- data/sig/sentdm/models/user_retrieve_params.rbs +8 -1
- data/sig/sentdm/models/user_update_role_params.rbs +17 -17
- data/sig/sentdm/models/webhook_create_params.rbs +13 -6
- data/sig/sentdm/models/webhook_delete_params.rbs +12 -2
- data/sig/sentdm/models/webhook_list_event_types_params.rbs +13 -3
- data/sig/sentdm/models/webhook_list_events_params.rbs +13 -1
- data/sig/sentdm/models/webhook_list_params.rbs +13 -1
- data/sig/sentdm/models/webhook_retrieve_params.rbs +12 -2
- data/sig/sentdm/models/webhook_rotate_secret_params.rbs +9 -2
- data/sig/sentdm/models/webhook_test_params.rbs +13 -6
- data/sig/sentdm/models/webhook_toggle_status_params.rbs +17 -5
- data/sig/sentdm/models/webhook_update_params.rbs +13 -6
- data/sig/sentdm/models.rbs +14 -32
- data/sig/sentdm/resources/contacts.rbs +10 -5
- data/sig/sentdm/resources/me.rbs +1 -0
- data/sig/sentdm/resources/messages.rbs +4 -1
- data/sig/sentdm/resources/{lookup.rbs → numbers.rbs} +4 -3
- data/sig/sentdm/resources/profiles/campaigns.rbs +42 -0
- data/sig/sentdm/resources/profiles.rbs +22 -9
- data/sig/sentdm/resources/templates.rbs +9 -3
- data/sig/sentdm/resources/users.rbs +10 -7
- data/sig/sentdm/resources/webhooks.rbs +18 -5
- metadata +67 -106
- data/lib/sentdm/models/api_response_brand_with_kyc.rb +0 -43
- data/lib/sentdm/models/brand_create_params.rb +0 -41
- data/lib/sentdm/models/brand_data.rb +0 -237
- data/lib/sentdm/models/brand_delete_params.rb +0 -34
- data/lib/sentdm/models/brand_list_params.rb +0 -14
- data/lib/sentdm/models/brand_list_response.rb +0 -43
- data/lib/sentdm/models/brand_update_params.rb +0 -48
- data/lib/sentdm/models/brand_with_kyc.rb +0 -335
- data/lib/sentdm/models/brands/base_dto.rb +0 -32
- data/lib/sentdm/models/brands/campaign_create_params.rb +0 -50
- data/lib/sentdm/models/brands/campaign_delete_params.rb +0 -43
- data/lib/sentdm/models/brands/campaign_list_params.rb +0 -22
- data/lib/sentdm/models/brands/campaign_update_params.rb +0 -57
- data/lib/sentdm/models/brands/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rb +0 -30
- data/lib/sentdm/models/mutation_request.rb +0 -20
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rb +0 -34
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rb +0 -40
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rb +0 -38
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rb +0 -81
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rb +0 -34
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rb +0 -39
- data/lib/sentdm/resources/brands/campaigns.rb +0 -145
- data/lib/sentdm/resources/brands.rb +0 -130
- data/lib/sentdm/resources/lookup.rb +0 -35
- data/rbi/sentdm/models/api_response_contact.rbi +0 -74
- data/rbi/sentdm/models/brand_create_params.rbi +0 -68
- data/rbi/sentdm/models/brand_data.rbi +0 -266
- data/rbi/sentdm/models/brand_delete_params.rbi +0 -68
- data/rbi/sentdm/models/brand_list_params.rbi +0 -27
- data/rbi/sentdm/models/brand_list_response.rbi +0 -71
- data/rbi/sentdm/models/brand_update_params.rbi +0 -74
- data/rbi/sentdm/models/brand_with_kyc.rbi +0 -398
- data/rbi/sentdm/models/brands/base_dto.rbi +0 -53
- data/rbi/sentdm/models/brands/campaign_list_params.rbi +0 -37
- data/rbi/sentdm/models/brands/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbi +0 -52
- data/rbi/sentdm/models/mutation_request.rbi +0 -32
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rbi +0 -56
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rbi +0 -76
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rbi +0 -79
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rbi +0 -104
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rbi +0 -60
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rbi +0 -62
- data/rbi/sentdm/resources/brands/campaigns.rbi +0 -109
- data/rbi/sentdm/resources/brands.rbi +0 -95
- data/rbi/sentdm/resources/lookup.rbi +0 -24
- data/sig/sentdm/models/api_response_brand_with_kyc.rbs +0 -39
- data/sig/sentdm/models/brand_create_params.rbs +0 -36
- data/sig/sentdm/models/brand_data.rbs +0 -164
- data/sig/sentdm/models/brand_delete_params.rbs +0 -36
- data/sig/sentdm/models/brand_list_params.rbs +0 -14
- data/sig/sentdm/models/brand_list_response.rbs +0 -39
- data/sig/sentdm/models/brand_update_params.rbs +0 -45
- data/sig/sentdm/models/brand_with_kyc.rbs +0 -237
- data/sig/sentdm/models/brands/base_dto.rbs +0 -27
- data/sig/sentdm/models/brands/campaign_create_params.rbs +0 -47
- data/sig/sentdm/models/brands/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbs +0 -27
- data/sig/sentdm/models/mutation_request.rbs +0 -15
- data/sig/sentdm/models/profile_complete_response.rbs +0 -5
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rbs +0 -24
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rbs +0 -30
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rbs +0 -38
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rbs +0 -75
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rbs +0 -32
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rbs +0 -32
- data/sig/sentdm/resources/brands/campaigns.rbs +0 -38
- data/sig/sentdm/resources/brands.rbs +0 -34
|
@@ -7,25 +7,25 @@ module Sentdm
|
|
|
7
7
|
# Required template body with content for different channels (multi-channel,
|
|
8
8
|
# SMS-specific, or WhatsApp-specific)
|
|
9
9
|
#
|
|
10
|
-
# @return [Sentdm::Models::
|
|
11
|
-
required :body, -> { Sentdm::
|
|
10
|
+
# @return [Sentdm::Models::TemplateDefinition::Body]
|
|
11
|
+
required :body, -> { Sentdm::TemplateDefinition::Body }
|
|
12
12
|
|
|
13
13
|
# @!attribute authentication_config
|
|
14
14
|
# Configuration specific to AUTHENTICATION category templates (optional)
|
|
15
15
|
#
|
|
16
|
-
# @return [Sentdm::Models::
|
|
16
|
+
# @return [Sentdm::Models::TemplateDefinition::AuthenticationConfig, nil]
|
|
17
17
|
optional :authentication_config,
|
|
18
|
-
-> { Sentdm::
|
|
18
|
+
-> { Sentdm::TemplateDefinition::AuthenticationConfig },
|
|
19
19
|
api_name: :authenticationConfig,
|
|
20
20
|
nil?: true
|
|
21
21
|
|
|
22
22
|
# @!attribute buttons
|
|
23
23
|
# Optional list of interactive buttons (e.g., quick replies, URLs, phone numbers)
|
|
24
24
|
#
|
|
25
|
-
# @return [Array<Sentdm::Models::
|
|
25
|
+
# @return [Array<Sentdm::Models::TemplateDefinition::Button>, nil]
|
|
26
26
|
optional :buttons,
|
|
27
27
|
-> {
|
|
28
|
-
Sentdm::Internal::Type::ArrayOf[Sentdm::
|
|
28
|
+
Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateDefinition::Button]
|
|
29
29
|
},
|
|
30
30
|
nil?: true
|
|
31
31
|
|
|
@@ -38,14 +38,14 @@ module Sentdm
|
|
|
38
38
|
# @!attribute footer
|
|
39
39
|
# Optional template footer with optional variables
|
|
40
40
|
#
|
|
41
|
-
# @return [Sentdm::Models::
|
|
42
|
-
optional :footer, -> { Sentdm::
|
|
41
|
+
# @return [Sentdm::Models::TemplateDefinition::Footer, nil]
|
|
42
|
+
optional :footer, -> { Sentdm::TemplateDefinition::Footer }, nil?: true
|
|
43
43
|
|
|
44
44
|
# @!attribute header
|
|
45
45
|
# Optional template header with optional variables
|
|
46
46
|
#
|
|
47
|
-
# @return [Sentdm::Models::
|
|
48
|
-
optional :header, -> { Sentdm::
|
|
47
|
+
# @return [Sentdm::Models::TemplateDefinition::Header, nil]
|
|
48
|
+
optional :header, -> { Sentdm::TemplateDefinition::Header }, nil?: true
|
|
49
49
|
|
|
50
50
|
# @!method initialize(body:, authentication_config: nil, buttons: nil, definition_version: nil, footer: nil, header: nil)
|
|
51
51
|
# Some parameter documentations has been truncated, see
|
|
@@ -54,17 +54,257 @@ module Sentdm
|
|
|
54
54
|
# Complete definition of a message template including header, body, footer, and
|
|
55
55
|
# buttons
|
|
56
56
|
#
|
|
57
|
-
# @param body [Sentdm::Models::
|
|
57
|
+
# @param body [Sentdm::Models::TemplateDefinition::Body] Required template body with content for different channels (multi-channel, SMS-s
|
|
58
58
|
#
|
|
59
|
-
# @param authentication_config [Sentdm::Models::
|
|
59
|
+
# @param authentication_config [Sentdm::Models::TemplateDefinition::AuthenticationConfig, nil] Configuration specific to AUTHENTICATION category templates (optional)
|
|
60
60
|
#
|
|
61
|
-
# @param buttons [Array<Sentdm::Models::
|
|
61
|
+
# @param buttons [Array<Sentdm::Models::TemplateDefinition::Button>, nil] Optional list of interactive buttons (e.g., quick replies, URLs, phone numbers)
|
|
62
62
|
#
|
|
63
63
|
# @param definition_version [String, nil] The version of the template definition format
|
|
64
64
|
#
|
|
65
|
-
# @param footer [Sentdm::Models::
|
|
65
|
+
# @param footer [Sentdm::Models::TemplateDefinition::Footer, nil] Optional template footer with optional variables
|
|
66
66
|
#
|
|
67
|
-
# @param header [Sentdm::Models::
|
|
67
|
+
# @param header [Sentdm::Models::TemplateDefinition::Header, nil] Optional template header with optional variables
|
|
68
|
+
|
|
69
|
+
# @see Sentdm::Models::TemplateDefinition#body
|
|
70
|
+
class Body < Sentdm::Internal::Type::BaseModel
|
|
71
|
+
# @!attribute multi_channel
|
|
72
|
+
# Content that will be used for all channels (SMS and WhatsApp) unless
|
|
73
|
+
# channel-specific content is provided
|
|
74
|
+
#
|
|
75
|
+
# @return [Sentdm::Models::TemplateBodyContent, nil]
|
|
76
|
+
optional :multi_channel, -> { Sentdm::TemplateBodyContent }, api_name: :multiChannel, nil?: true
|
|
77
|
+
|
|
78
|
+
# @!attribute sms
|
|
79
|
+
# SMS-specific content that overrides multi-channel content for SMS messages
|
|
80
|
+
#
|
|
81
|
+
# @return [Sentdm::Models::TemplateBodyContent, nil]
|
|
82
|
+
optional :sms, -> { Sentdm::TemplateBodyContent }, nil?: true
|
|
83
|
+
|
|
84
|
+
# @!attribute whatsapp
|
|
85
|
+
# WhatsApp-specific content that overrides multi-channel content for WhatsApp
|
|
86
|
+
# messages
|
|
87
|
+
#
|
|
88
|
+
# @return [Sentdm::Models::TemplateBodyContent, nil]
|
|
89
|
+
optional :whatsapp, -> { Sentdm::TemplateBodyContent }, nil?: true
|
|
90
|
+
|
|
91
|
+
# @!method initialize(multi_channel: nil, sms: nil, whatsapp: nil)
|
|
92
|
+
# Some parameter documentations has been truncated, see
|
|
93
|
+
# {Sentdm::Models::TemplateDefinition::Body} for more details.
|
|
94
|
+
#
|
|
95
|
+
# Required template body with content for different channels (multi-channel,
|
|
96
|
+
# SMS-specific, or WhatsApp-specific)
|
|
97
|
+
#
|
|
98
|
+
# @param multi_channel [Sentdm::Models::TemplateBodyContent, nil] Content that will be used for all channels (SMS and WhatsApp) unless channel-spe
|
|
99
|
+
#
|
|
100
|
+
# @param sms [Sentdm::Models::TemplateBodyContent, nil] SMS-specific content that overrides multi-channel content for SMS messages
|
|
101
|
+
#
|
|
102
|
+
# @param whatsapp [Sentdm::Models::TemplateBodyContent, nil] WhatsApp-specific content that overrides multi-channel content for WhatsApp mess
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
# @see Sentdm::Models::TemplateDefinition#authentication_config
|
|
106
|
+
class AuthenticationConfig < Sentdm::Internal::Type::BaseModel
|
|
107
|
+
# @!attribute add_security_recommendation
|
|
108
|
+
# Whether to add the security recommendation text: "For your security, do not
|
|
109
|
+
# share this code."
|
|
110
|
+
#
|
|
111
|
+
# @return [Boolean, nil]
|
|
112
|
+
optional :add_security_recommendation,
|
|
113
|
+
Sentdm::Internal::Type::Boolean,
|
|
114
|
+
api_name: :addSecurityRecommendation
|
|
115
|
+
|
|
116
|
+
# @!attribute code_expiration_minutes
|
|
117
|
+
# Code expiration time in minutes (1-90). If set, adds footer: "This code expires
|
|
118
|
+
# in X minutes."
|
|
119
|
+
#
|
|
120
|
+
# @return [Integer, nil]
|
|
121
|
+
optional :code_expiration_minutes, Integer, api_name: :codeExpirationMinutes, nil?: true
|
|
122
|
+
|
|
123
|
+
# @!method initialize(add_security_recommendation: nil, code_expiration_minutes: nil)
|
|
124
|
+
# Some parameter documentations has been truncated, see
|
|
125
|
+
# {Sentdm::Models::TemplateDefinition::AuthenticationConfig} for more details.
|
|
126
|
+
#
|
|
127
|
+
# Configuration specific to AUTHENTICATION category templates (optional)
|
|
128
|
+
#
|
|
129
|
+
# @param add_security_recommendation [Boolean] Whether to add the security recommendation text: "For your security, do not shar
|
|
130
|
+
#
|
|
131
|
+
# @param code_expiration_minutes [Integer, nil] Code expiration time in minutes (1-90). If set, adds footer: "This code expires
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
class Button < Sentdm::Internal::Type::BaseModel
|
|
135
|
+
# @!attribute id
|
|
136
|
+
# The unique identifier of the button (1-based index)
|
|
137
|
+
#
|
|
138
|
+
# @return [Integer, nil]
|
|
139
|
+
optional :id, Integer
|
|
140
|
+
|
|
141
|
+
# @!attribute props
|
|
142
|
+
# Properties specific to the button type
|
|
143
|
+
#
|
|
144
|
+
# @return [Sentdm::Models::TemplateDefinition::Button::Props, nil]
|
|
145
|
+
optional :props, -> { Sentdm::TemplateDefinition::Button::Props }
|
|
146
|
+
|
|
147
|
+
# @!attribute type
|
|
148
|
+
# The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
|
|
149
|
+
#
|
|
150
|
+
# @return [String, nil]
|
|
151
|
+
optional :type, String
|
|
152
|
+
|
|
153
|
+
# @!method initialize(id: nil, props: nil, type: nil)
|
|
154
|
+
# Some parameter documentations has been truncated, see
|
|
155
|
+
# {Sentdm::Models::TemplateDefinition::Button} for more details.
|
|
156
|
+
#
|
|
157
|
+
# Interactive button in a message template
|
|
158
|
+
#
|
|
159
|
+
# @param id [Integer] The unique identifier of the button (1-based index)
|
|
160
|
+
#
|
|
161
|
+
# @param props [Sentdm::Models::TemplateDefinition::Button::Props] Properties specific to the button type
|
|
162
|
+
#
|
|
163
|
+
# @param type [String] The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
|
|
164
|
+
|
|
165
|
+
# @see Sentdm::Models::TemplateDefinition::Button#props
|
|
166
|
+
class Props < Sentdm::Internal::Type::BaseModel
|
|
167
|
+
# @!attribute active_for
|
|
168
|
+
#
|
|
169
|
+
# @return [Integer, nil]
|
|
170
|
+
optional :active_for, Integer, api_name: :activeFor, nil?: true
|
|
171
|
+
|
|
172
|
+
# @!attribute autofill_text
|
|
173
|
+
#
|
|
174
|
+
# @return [String, nil]
|
|
175
|
+
optional :autofill_text, String, api_name: :autofillText, nil?: true
|
|
176
|
+
|
|
177
|
+
# @!attribute country_code
|
|
178
|
+
#
|
|
179
|
+
# @return [String, nil]
|
|
180
|
+
optional :country_code, String, api_name: :countryCode, nil?: true
|
|
181
|
+
|
|
182
|
+
# @!attribute offer_code
|
|
183
|
+
#
|
|
184
|
+
# @return [String, nil]
|
|
185
|
+
optional :offer_code, String, api_name: :offerCode, nil?: true
|
|
186
|
+
|
|
187
|
+
# @!attribute otp_type
|
|
188
|
+
#
|
|
189
|
+
# @return [String, nil]
|
|
190
|
+
optional :otp_type, String, api_name: :otpType, nil?: true
|
|
191
|
+
|
|
192
|
+
# @!attribute package_name
|
|
193
|
+
#
|
|
194
|
+
# @return [String, nil]
|
|
195
|
+
optional :package_name, String, api_name: :packageName, nil?: true
|
|
196
|
+
|
|
197
|
+
# @!attribute phone_number
|
|
198
|
+
#
|
|
199
|
+
# @return [String, nil]
|
|
200
|
+
optional :phone_number, String, api_name: :phoneNumber, nil?: true
|
|
201
|
+
|
|
202
|
+
# @!attribute quick_reply_type
|
|
203
|
+
#
|
|
204
|
+
# @return [String, nil]
|
|
205
|
+
optional :quick_reply_type, String, api_name: :quickReplyType, nil?: true
|
|
206
|
+
|
|
207
|
+
# @!attribute signature_hash
|
|
208
|
+
#
|
|
209
|
+
# @return [String, nil]
|
|
210
|
+
optional :signature_hash, String, api_name: :signatureHash, nil?: true
|
|
211
|
+
|
|
212
|
+
# @!attribute text
|
|
213
|
+
#
|
|
214
|
+
# @return [String, nil]
|
|
215
|
+
optional :text, String, nil?: true
|
|
216
|
+
|
|
217
|
+
# @!attribute url
|
|
218
|
+
#
|
|
219
|
+
# @return [String, nil]
|
|
220
|
+
optional :url, String, nil?: true
|
|
221
|
+
|
|
222
|
+
# @!attribute url_type
|
|
223
|
+
#
|
|
224
|
+
# @return [String, nil]
|
|
225
|
+
optional :url_type, String, api_name: :urlType, nil?: true
|
|
226
|
+
|
|
227
|
+
# @!method initialize(active_for: nil, autofill_text: nil, country_code: nil, offer_code: nil, otp_type: nil, package_name: nil, phone_number: nil, quick_reply_type: nil, signature_hash: nil, text: nil, url: nil, url_type: nil)
|
|
228
|
+
# Properties specific to the button type
|
|
229
|
+
#
|
|
230
|
+
# @param active_for [Integer, nil]
|
|
231
|
+
# @param autofill_text [String, nil]
|
|
232
|
+
# @param country_code [String, nil]
|
|
233
|
+
# @param offer_code [String, nil]
|
|
234
|
+
# @param otp_type [String, nil]
|
|
235
|
+
# @param package_name [String, nil]
|
|
236
|
+
# @param phone_number [String, nil]
|
|
237
|
+
# @param quick_reply_type [String, nil]
|
|
238
|
+
# @param signature_hash [String, nil]
|
|
239
|
+
# @param text [String, nil]
|
|
240
|
+
# @param url [String, nil]
|
|
241
|
+
# @param url_type [String, nil]
|
|
242
|
+
end
|
|
243
|
+
end
|
|
244
|
+
|
|
245
|
+
# @see Sentdm::Models::TemplateDefinition#footer
|
|
246
|
+
class Footer < Sentdm::Internal::Type::BaseModel
|
|
247
|
+
# @!attribute template
|
|
248
|
+
# The footer template text with optional variable placeholders
|
|
249
|
+
#
|
|
250
|
+
# @return [String, nil]
|
|
251
|
+
optional :template, String
|
|
252
|
+
|
|
253
|
+
# @!attribute type
|
|
254
|
+
# The type of footer (typically "text")
|
|
255
|
+
#
|
|
256
|
+
# @return [String, nil]
|
|
257
|
+
optional :type, String, nil?: true
|
|
258
|
+
|
|
259
|
+
# @!attribute variables
|
|
260
|
+
# List of variables used in the footer template
|
|
261
|
+
#
|
|
262
|
+
# @return [Array<Sentdm::Models::TemplateVariable>, nil]
|
|
263
|
+
optional :variables, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateVariable] }, nil?: true
|
|
264
|
+
|
|
265
|
+
# @!method initialize(template: nil, type: nil, variables: nil)
|
|
266
|
+
# Optional template footer with optional variables
|
|
267
|
+
#
|
|
268
|
+
# @param template [String] The footer template text with optional variable placeholders
|
|
269
|
+
#
|
|
270
|
+
# @param type [String, nil] The type of footer (typically "text")
|
|
271
|
+
#
|
|
272
|
+
# @param variables [Array<Sentdm::Models::TemplateVariable>, nil] List of variables used in the footer template
|
|
273
|
+
end
|
|
274
|
+
|
|
275
|
+
# @see Sentdm::Models::TemplateDefinition#header
|
|
276
|
+
class Header < Sentdm::Internal::Type::BaseModel
|
|
277
|
+
# @!attribute template
|
|
278
|
+
# The header template text with optional variable placeholders (e.g., "Welcome to
|
|
279
|
+
# {{0:variable}}")
|
|
280
|
+
#
|
|
281
|
+
# @return [String, nil]
|
|
282
|
+
optional :template, String
|
|
283
|
+
|
|
284
|
+
# @!attribute type
|
|
285
|
+
# The type of header (e.g., "text", "image", "video", "document")
|
|
286
|
+
#
|
|
287
|
+
# @return [String, nil]
|
|
288
|
+
optional :type, String, nil?: true
|
|
289
|
+
|
|
290
|
+
# @!attribute variables
|
|
291
|
+
# List of variables used in the header template
|
|
292
|
+
#
|
|
293
|
+
# @return [Array<Sentdm::Models::TemplateVariable>, nil]
|
|
294
|
+
optional :variables, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateVariable] }, nil?: true
|
|
295
|
+
|
|
296
|
+
# @!method initialize(template: nil, type: nil, variables: nil)
|
|
297
|
+
# Some parameter documentations has been truncated, see
|
|
298
|
+
# {Sentdm::Models::TemplateDefinition::Header} for more details.
|
|
299
|
+
#
|
|
300
|
+
# Optional template header with optional variables
|
|
301
|
+
#
|
|
302
|
+
# @param template [String] The header template text with optional variable placeholders (e.g., "Welcome to
|
|
303
|
+
#
|
|
304
|
+
# @param type [String, nil] The type of header (e.g., "text", "image", "video", "document")
|
|
305
|
+
#
|
|
306
|
+
# @param variables [Array<Sentdm::Models::TemplateVariable>, nil] List of variables used in the header template
|
|
307
|
+
end
|
|
68
308
|
end
|
|
69
309
|
end
|
|
70
310
|
end
|
|
@@ -19,14 +19,19 @@ module Sentdm
|
|
|
19
19
|
# @return [Boolean, nil]
|
|
20
20
|
optional :delete_from_meta, Sentdm::Internal::Type::Boolean, nil?: true
|
|
21
21
|
|
|
22
|
-
# @!attribute
|
|
23
|
-
#
|
|
24
|
-
#
|
|
22
|
+
# @!attribute sandbox
|
|
23
|
+
# Sandbox flag - when true, the operation is simulated without side effects Useful
|
|
24
|
+
# for testing integrations without actual execution
|
|
25
25
|
#
|
|
26
26
|
# @return [Boolean, nil]
|
|
27
|
-
optional :
|
|
27
|
+
optional :sandbox, Sentdm::Internal::Type::Boolean
|
|
28
28
|
|
|
29
|
-
# @!
|
|
29
|
+
# @!attribute x_profile_id
|
|
30
|
+
#
|
|
31
|
+
# @return [String, nil]
|
|
32
|
+
optional :x_profile_id, String
|
|
33
|
+
|
|
34
|
+
# @!method initialize(id:, delete_from_meta: nil, sandbox: nil, x_profile_id: nil, request_options: {})
|
|
30
35
|
# Some parameter documentations has been truncated, see
|
|
31
36
|
# {Sentdm::Models::TemplateDeleteParams} for more details.
|
|
32
37
|
#
|
|
@@ -34,7 +39,9 @@ module Sentdm
|
|
|
34
39
|
#
|
|
35
40
|
# @param delete_from_meta [Boolean, nil] Whether to also delete the template from WhatsApp/Meta (optional, defaults to fa
|
|
36
41
|
#
|
|
37
|
-
# @param
|
|
42
|
+
# @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
|
|
43
|
+
#
|
|
44
|
+
# @param x_profile_id [String]
|
|
38
45
|
#
|
|
39
46
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
|
|
40
47
|
end
|
|
@@ -14,6 +14,7 @@ module Sentdm
|
|
|
14
14
|
required :page, Integer
|
|
15
15
|
|
|
16
16
|
# @!attribute page_size
|
|
17
|
+
# Number of items per page
|
|
17
18
|
#
|
|
18
19
|
# @return [Integer]
|
|
19
20
|
required :page_size, Integer
|
|
@@ -24,6 +25,12 @@ module Sentdm
|
|
|
24
25
|
# @return [String, nil]
|
|
25
26
|
optional :category, String, nil?: true
|
|
26
27
|
|
|
28
|
+
# @!attribute is_welcome_playground
|
|
29
|
+
# Optional filter by welcome playground flag
|
|
30
|
+
#
|
|
31
|
+
# @return [Boolean, nil]
|
|
32
|
+
optional :is_welcome_playground, Sentdm::Internal::Type::Boolean, nil?: true
|
|
33
|
+
|
|
27
34
|
# @!attribute search
|
|
28
35
|
# Optional search term for filtering templates
|
|
29
36
|
#
|
|
@@ -36,17 +43,26 @@ module Sentdm
|
|
|
36
43
|
# @return [String, nil]
|
|
37
44
|
optional :status, String, nil?: true
|
|
38
45
|
|
|
39
|
-
# @!
|
|
46
|
+
# @!attribute x_profile_id
|
|
47
|
+
#
|
|
48
|
+
# @return [String, nil]
|
|
49
|
+
optional :x_profile_id, String
|
|
50
|
+
|
|
51
|
+
# @!method initialize(page:, page_size:, category: nil, is_welcome_playground: nil, search: nil, status: nil, x_profile_id: nil, request_options: {})
|
|
40
52
|
# @param page [Integer] Page number (1-indexed)
|
|
41
53
|
#
|
|
42
|
-
# @param page_size [Integer]
|
|
54
|
+
# @param page_size [Integer] Number of items per page
|
|
43
55
|
#
|
|
44
56
|
# @param category [String, nil] Optional category filter: MARKETING, UTILITY, AUTHENTICATION
|
|
45
57
|
#
|
|
58
|
+
# @param is_welcome_playground [Boolean, nil] Optional filter by welcome playground flag
|
|
59
|
+
#
|
|
46
60
|
# @param search [String, nil] Optional search term for filtering templates
|
|
47
61
|
#
|
|
48
62
|
# @param status [String, nil] Optional status filter: APPROVED, PENDING, REJECTED
|
|
49
63
|
#
|
|
64
|
+
# @param x_profile_id [String]
|
|
65
|
+
#
|
|
50
66
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
|
|
51
67
|
end
|
|
52
68
|
end
|
|
@@ -12,8 +12,14 @@ module Sentdm
|
|
|
12
12
|
# @return [String]
|
|
13
13
|
required :id, String
|
|
14
14
|
|
|
15
|
-
# @!
|
|
15
|
+
# @!attribute x_profile_id
|
|
16
|
+
#
|
|
17
|
+
# @return [String, nil]
|
|
18
|
+
optional :x_profile_id, String
|
|
19
|
+
|
|
20
|
+
# @!method initialize(id:, x_profile_id: nil, request_options: {})
|
|
16
21
|
# @param id [String]
|
|
22
|
+
# @param x_profile_id [String]
|
|
17
23
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
|
|
18
24
|
end
|
|
19
25
|
end
|
|
@@ -36,25 +36,30 @@ module Sentdm
|
|
|
36
36
|
# @return [String, nil]
|
|
37
37
|
optional :name, String, nil?: true
|
|
38
38
|
|
|
39
|
-
# @!attribute
|
|
40
|
-
#
|
|
39
|
+
# @!attribute sandbox
|
|
40
|
+
# Sandbox flag - when true, the operation is simulated without side effects Useful
|
|
41
|
+
# for testing integrations without actual execution
|
|
41
42
|
#
|
|
42
43
|
# @return [Boolean, nil]
|
|
43
|
-
optional :
|
|
44
|
+
optional :sandbox, Sentdm::Internal::Type::Boolean
|
|
44
45
|
|
|
45
|
-
# @!attribute
|
|
46
|
-
#
|
|
47
|
-
# Useful for testing integrations without actual execution
|
|
46
|
+
# @!attribute submit_for_review
|
|
47
|
+
# Whether to submit the template for review after updating (default: false)
|
|
48
48
|
#
|
|
49
49
|
# @return [Boolean, nil]
|
|
50
|
-
optional :
|
|
50
|
+
optional :submit_for_review, Sentdm::Internal::Type::Boolean
|
|
51
51
|
|
|
52
52
|
# @!attribute idempotency_key
|
|
53
53
|
#
|
|
54
54
|
# @return [String, nil]
|
|
55
55
|
optional :idempotency_key, String
|
|
56
56
|
|
|
57
|
-
# @!
|
|
57
|
+
# @!attribute x_profile_id
|
|
58
|
+
#
|
|
59
|
+
# @return [String, nil]
|
|
60
|
+
optional :x_profile_id, String
|
|
61
|
+
|
|
62
|
+
# @!method initialize(id:, category: nil, definition: nil, language: nil, name: nil, sandbox: nil, submit_for_review: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
|
|
58
63
|
# Some parameter documentations has been truncated, see
|
|
59
64
|
# {Sentdm::Models::TemplateUpdateParams} for more details.
|
|
60
65
|
#
|
|
@@ -68,12 +73,14 @@ module Sentdm
|
|
|
68
73
|
#
|
|
69
74
|
# @param name [String, nil] Template display name
|
|
70
75
|
#
|
|
71
|
-
# @param
|
|
76
|
+
# @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
|
|
72
77
|
#
|
|
73
|
-
# @param
|
|
78
|
+
# @param submit_for_review [Boolean] Whether to submit the template for review after updating (default: false)
|
|
74
79
|
#
|
|
75
80
|
# @param idempotency_key [String]
|
|
76
81
|
#
|
|
82
|
+
# @param x_profile_id [String]
|
|
83
|
+
#
|
|
77
84
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
|
|
78
85
|
end
|
|
79
86
|
end
|
|
@@ -41,6 +41,11 @@ module Sentdm
|
|
|
41
41
|
# @return [String, nil]
|
|
42
42
|
optional :media_type, String, api_name: :mediaType, nil?: true
|
|
43
43
|
|
|
44
|
+
# @!attribute regex
|
|
45
|
+
#
|
|
46
|
+
# @return [String, nil]
|
|
47
|
+
optional :regex, String, nil?: true
|
|
48
|
+
|
|
44
49
|
# @!attribute sample
|
|
45
50
|
#
|
|
46
51
|
# @return [String, nil]
|
|
@@ -61,9 +66,10 @@ module Sentdm
|
|
|
61
66
|
# @return [String, nil]
|
|
62
67
|
optional :variable_type, String, api_name: :variableType, nil?: true
|
|
63
68
|
|
|
64
|
-
# @!method initialize(alt: nil, media_type: nil, sample: nil, short_url: nil, url: nil, variable_type: nil)
|
|
69
|
+
# @!method initialize(alt: nil, media_type: nil, regex: nil, sample: nil, short_url: nil, url: nil, variable_type: nil)
|
|
65
70
|
# @param alt [String, nil]
|
|
66
71
|
# @param media_type [String, nil]
|
|
72
|
+
# @param regex [String, nil]
|
|
67
73
|
# @param sample [String, nil]
|
|
68
74
|
# @param short_url [String, nil]
|
|
69
75
|
# @param url [String, nil]
|
|
@@ -25,19 +25,24 @@ module Sentdm
|
|
|
25
25
|
# @return [String, nil]
|
|
26
26
|
optional :role, String
|
|
27
27
|
|
|
28
|
-
# @!attribute
|
|
29
|
-
#
|
|
30
|
-
#
|
|
28
|
+
# @!attribute sandbox
|
|
29
|
+
# Sandbox flag - when true, the operation is simulated without side effects Useful
|
|
30
|
+
# for testing integrations without actual execution
|
|
31
31
|
#
|
|
32
32
|
# @return [Boolean, nil]
|
|
33
|
-
optional :
|
|
33
|
+
optional :sandbox, Sentdm::Internal::Type::Boolean
|
|
34
34
|
|
|
35
35
|
# @!attribute idempotency_key
|
|
36
36
|
#
|
|
37
37
|
# @return [String, nil]
|
|
38
38
|
optional :idempotency_key, String
|
|
39
39
|
|
|
40
|
-
# @!
|
|
40
|
+
# @!attribute x_profile_id
|
|
41
|
+
#
|
|
42
|
+
# @return [String, nil]
|
|
43
|
+
optional :x_profile_id, String
|
|
44
|
+
|
|
45
|
+
# @!method initialize(email: nil, name: nil, role: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
|
|
41
46
|
# Some parameter documentations has been truncated, see
|
|
42
47
|
# {Sentdm::Models::UserInviteParams} for more details.
|
|
43
48
|
#
|
|
@@ -47,10 +52,12 @@ module Sentdm
|
|
|
47
52
|
#
|
|
48
53
|
# @param role [String] User role: admin, billing, or developer (required)
|
|
49
54
|
#
|
|
50
|
-
# @param
|
|
55
|
+
# @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
|
|
51
56
|
#
|
|
52
57
|
# @param idempotency_key [String]
|
|
53
58
|
#
|
|
59
|
+
# @param x_profile_id [String]
|
|
60
|
+
#
|
|
54
61
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
|
|
55
62
|
end
|
|
56
63
|
end
|
|
@@ -7,7 +7,13 @@ module Sentdm
|
|
|
7
7
|
extend Sentdm::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Sentdm::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute x_profile_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String, nil]
|
|
13
|
+
optional :x_profile_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(x_profile_id: nil, request_options: {})
|
|
16
|
+
# @param x_profile_id [String]
|
|
11
17
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
|
|
12
18
|
end
|
|
13
19
|
end
|
|
@@ -7,35 +7,35 @@ module Sentdm
|
|
|
7
7
|
extend Sentdm::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Sentdm::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!attribute
|
|
10
|
+
# @!attribute user_id
|
|
11
11
|
#
|
|
12
12
|
# @return [String]
|
|
13
|
-
required :
|
|
13
|
+
required :user_id, String
|
|
14
14
|
|
|
15
|
-
# @!attribute
|
|
16
|
-
#
|
|
17
|
-
# Useful for testing integrations without actual execution
|
|
15
|
+
# @!attribute body
|
|
16
|
+
# Request to remove a user from an organization
|
|
18
17
|
#
|
|
19
|
-
# @return [
|
|
20
|
-
|
|
18
|
+
# @return [Sentdm::Models::UserRemoveParams::Body]
|
|
19
|
+
required :body, -> { Sentdm::UserRemoveParams::Body }
|
|
21
20
|
|
|
22
|
-
# @!attribute
|
|
23
|
-
# User ID from route parameter
|
|
21
|
+
# @!attribute x_profile_id
|
|
24
22
|
#
|
|
25
23
|
# @return [String, nil]
|
|
26
|
-
optional :
|
|
24
|
+
optional :x_profile_id, String
|
|
27
25
|
|
|
28
|
-
# @!method initialize(
|
|
29
|
-
#
|
|
30
|
-
# {Sentdm::Models::UserRemoveParams} for more details.
|
|
26
|
+
# @!method initialize(user_id:, body:, x_profile_id: nil, request_options: {})
|
|
27
|
+
# @param user_id [String]
|
|
31
28
|
#
|
|
32
|
-
# @param
|
|
29
|
+
# @param body [Sentdm::Models::UserRemoveParams::Body] Request to remove a user from an organization
|
|
33
30
|
#
|
|
34
|
-
# @param
|
|
35
|
-
#
|
|
36
|
-
# @param body_user_id [String] User ID from route parameter
|
|
31
|
+
# @param x_profile_id [String]
|
|
37
32
|
#
|
|
38
33
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
|
|
34
|
+
|
|
35
|
+
class Body < Sentdm::Models::MutationRequestBase
|
|
36
|
+
# @!method initialize
|
|
37
|
+
# Request to remove a user from an organization
|
|
38
|
+
end
|
|
39
39
|
end
|
|
40
40
|
end
|
|
41
41
|
end
|
|
@@ -12,8 +12,14 @@ module Sentdm
|
|
|
12
12
|
# @return [String]
|
|
13
13
|
required :user_id, String
|
|
14
14
|
|
|
15
|
-
# @!
|
|
15
|
+
# @!attribute x_profile_id
|
|
16
|
+
#
|
|
17
|
+
# @return [String, nil]
|
|
18
|
+
optional :x_profile_id, String
|
|
19
|
+
|
|
20
|
+
# @!method initialize(user_id:, x_profile_id: nil, request_options: {})
|
|
16
21
|
# @param user_id [String]
|
|
22
|
+
# @param x_profile_id [String]
|
|
17
23
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
|
|
18
24
|
end
|
|
19
25
|
end
|