sentdm 0.18.0 → 0.19.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 +13 -0
- data/README.md +1 -31
- data/lib/sentdm/internal/transport/base_client.rb +2 -0
- data/lib/sentdm/internal/type/base_model.rb +5 -5
- data/lib/sentdm/internal/type/enum.rb +0 -25
- data/lib/sentdm/models/contact_create_response.rb +236 -0
- data/lib/sentdm/models/contact_delete_params.rb +16 -2
- data/lib/sentdm/models/contact_list_response.rb +278 -12
- data/lib/sentdm/models/contact_retrieve_response.rb +236 -0
- data/lib/sentdm/models/contact_update_params.rb +4 -16
- data/lib/sentdm/models/contact_update_response.rb +236 -0
- data/lib/sentdm/models/me_retrieve_response.rb +204 -12
- data/lib/sentdm/models/message_retrieve_activities_response.rb +74 -6
- data/lib/sentdm/models/message_retrieve_status_response.rb +87 -7
- data/lib/sentdm/models/message_send_params.rb +2 -2
- data/lib/sentdm/models/message_send_response.rb +74 -6
- data/lib/sentdm/models/number_lookup_response.rb +74 -6
- data/lib/sentdm/models/profile_complete_response.rb +74 -6
- data/lib/sentdm/models/profile_create_params.rb +423 -9
- data/lib/sentdm/models/profile_create_response.rb +781 -0
- data/lib/sentdm/models/profile_delete_params.rb +16 -2
- data/lib/sentdm/models/profile_list_response.rb +753 -9
- data/lib/sentdm/models/profile_retrieve_response.rb +783 -0
- data/lib/sentdm/models/profile_update_params.rb +423 -9
- data/lib/sentdm/models/profile_update_response.rb +781 -0
- data/lib/sentdm/models/profiles/campaign_create_params.rb +165 -3
- data/lib/sentdm/models/profiles/campaign_create_response.rb +459 -0
- data/lib/sentdm/models/profiles/campaign_delete_params.rb +17 -2
- data/lib/sentdm/models/profiles/campaign_list_response.rb +420 -9
- data/lib/sentdm/models/profiles/campaign_update_params.rb +165 -3
- data/lib/sentdm/models/profiles/campaign_update_response.rb +459 -0
- data/lib/sentdm/models/template_create_params.rb +889 -3
- data/lib/sentdm/models/template_create_response.rb +197 -0
- data/lib/sentdm/models/template_list_response.rb +242 -12
- data/lib/sentdm/models/template_retrieve_response.rb +197 -0
- data/lib/sentdm/models/template_update_params.rb +889 -3
- data/lib/sentdm/models/template_update_response.rb +197 -0
- data/lib/sentdm/models/user_invite_response.rb +189 -0
- data/lib/sentdm/models/user_list_response.rb +154 -9
- data/lib/sentdm/models/user_remove_params.rb +16 -2
- data/lib/sentdm/models/user_retrieve_response.rb +189 -0
- data/lib/sentdm/models/user_update_role_response.rb +189 -0
- data/lib/sentdm/models/webhook_create_response.rb +204 -0
- data/lib/sentdm/models/webhook_list_event_types_response.rb +118 -9
- data/lib/sentdm/models/webhook_list_events_response.rb +153 -9
- data/lib/sentdm/models/webhook_list_response.rb +247 -12
- data/lib/sentdm/models/webhook_retrieve_response.rb +204 -0
- data/lib/sentdm/models/webhook_rotate_secret_params.rb +17 -2
- data/lib/sentdm/models/webhook_rotate_secret_response.rb +74 -6
- data/lib/sentdm/models/webhook_test_response.rb +74 -6
- data/lib/sentdm/models/webhook_toggle_status_response.rb +204 -0
- data/lib/sentdm/models/webhook_update_response.rb +204 -0
- data/lib/sentdm/models.rb +0 -77
- data/lib/sentdm/resources/contacts.rb +8 -10
- 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 +18 -40
- data/rbi/sentdm/models/contact_create_response.rbi +390 -0
- data/rbi/sentdm/models/contact_delete_params.rbi +19 -2
- data/rbi/sentdm/models/contact_list_response.rbi +505 -16
- data/rbi/sentdm/models/contact_retrieve_response.rbi +392 -0
- data/rbi/sentdm/models/contact_update_params.rbi +4 -20
- data/rbi/sentdm/models/contact_update_response.rbi +390 -0
- data/rbi/sentdm/models/me_retrieve_response.rbi +335 -16
- data/rbi/sentdm/models/message_retrieve_activities_response.rbi +154 -8
- data/rbi/sentdm/models/message_retrieve_status_response.rbi +171 -11
- data/rbi/sentdm/models/message_send_params.rbi +4 -4
- data/rbi/sentdm/models/message_send_response.rbi +135 -8
- data/rbi/sentdm/models/number_lookup_response.rbi +135 -8
- data/rbi/sentdm/models/profile_complete_response.rbi +137 -8
- data/rbi/sentdm/models/profile_create_params.rbi +810 -12
- data/rbi/sentdm/models/profile_create_response.rbi +1439 -0
- data/rbi/sentdm/models/profile_delete_params.rbi +19 -2
- data/rbi/sentdm/models/profile_list_response.rbi +1400 -14
- data/rbi/sentdm/models/profile_retrieve_response.rbi +1443 -0
- data/rbi/sentdm/models/profile_update_params.rbi +810 -12
- data/rbi/sentdm/models/profile_update_response.rbi +1439 -0
- data/rbi/sentdm/models/profiles/campaign_create_params.rbi +289 -4
- data/rbi/sentdm/models/profiles/campaign_create_response.rbi +814 -0
- data/rbi/sentdm/models/profiles/campaign_delete_params.rbi +14 -1
- data/rbi/sentdm/models/profiles/campaign_list_response.rbi +733 -11
- data/rbi/sentdm/models/profiles/campaign_update_params.rbi +289 -4
- data/rbi/sentdm/models/profiles/campaign_update_response.rbi +814 -0
- data/rbi/sentdm/models/template_create_params.rbi +1701 -4
- data/rbi/sentdm/models/template_create_response.rbi +339 -0
- data/rbi/sentdm/models/template_list_response.rbi +454 -16
- data/rbi/sentdm/models/template_retrieve_response.rbi +345 -0
- data/rbi/sentdm/models/template_update_params.rbi +1701 -4
- data/rbi/sentdm/models/template_update_response.rbi +339 -0
- data/rbi/sentdm/models/user_invite_response.rbi +323 -0
- data/rbi/sentdm/models/user_list_response.rbi +271 -14
- data/rbi/sentdm/models/user_remove_params.rbi +19 -2
- data/rbi/sentdm/models/user_retrieve_response.rbi +323 -0
- data/rbi/sentdm/models/user_update_role_response.rbi +328 -0
- data/rbi/sentdm/models/webhook_create_response.rbi +348 -0
- data/rbi/sentdm/models/webhook_list_event_types_response.rbi +247 -12
- data/rbi/sentdm/models/webhook_list_events_response.rbi +314 -12
- data/rbi/sentdm/models/webhook_list_response.rbi +462 -16
- data/rbi/sentdm/models/webhook_retrieve_response.rbi +350 -0
- data/rbi/sentdm/models/webhook_rotate_secret_params.rbi +14 -1
- data/rbi/sentdm/models/webhook_rotate_secret_response.rbi +148 -8
- data/rbi/sentdm/models/webhook_test_response.rbi +135 -8
- data/rbi/sentdm/models/webhook_toggle_status_response.rbi +366 -0
- data/rbi/sentdm/models/webhook_update_response.rbi +348 -0
- data/rbi/sentdm/models.rbi +0 -77
- data/rbi/sentdm/resources/contacts.rbi +5 -12
- data/rbi/sentdm/resources/messages.rbi +2 -2
- data/rbi/sentdm/resources/profiles/campaigns.rbi +4 -4
- data/rbi/sentdm/resources/profiles.rbi +13 -9
- data/rbi/sentdm/resources/templates.rbi +6 -5
- data/rbi/sentdm/resources/users.rbi +3 -3
- data/rbi/sentdm/resources/webhooks.rbi +4 -4
- data/sig/sentdm/models/contact_create_response.rbs +209 -0
- data/sig/sentdm/models/contact_delete_params.rbs +10 -6
- data/sig/sentdm/models/contact_list_response.rbs +256 -20
- data/sig/sentdm/models/contact_retrieve_response.rbs +209 -0
- data/sig/sentdm/models/contact_update_params.rbs +0 -5
- data/sig/sentdm/models/contact_update_response.rbs +209 -0
- data/sig/sentdm/models/me_retrieve_response.rbs +176 -18
- data/sig/sentdm/models/message_retrieve_activities_response.rbs +71 -9
- data/sig/sentdm/models/message_retrieve_status_response.rbs +95 -13
- data/sig/sentdm/models/message_send_response.rbs +71 -9
- data/sig/sentdm/models/number_lookup_response.rbs +71 -9
- data/sig/sentdm/models/profile_complete_response.rbs +71 -9
- data/sig/sentdm/models/profile_create_params.rbs +363 -12
- data/sig/sentdm/models/profile_create_response.rbs +662 -0
- data/sig/sentdm/models/profile_delete_params.rbs +10 -6
- data/sig/sentdm/models/profile_list_response.rbs +645 -15
- data/sig/sentdm/models/profile_retrieve_response.rbs +662 -0
- data/sig/sentdm/models/profile_update_params.rbs +363 -12
- data/sig/sentdm/models/profile_update_response.rbs +662 -0
- data/sig/sentdm/models/profiles/campaign_create_params.rbs +138 -4
- data/sig/sentdm/models/profiles/campaign_create_response.rbs +424 -0
- data/sig/sentdm/models/profiles/campaign_delete_params.rbs +15 -8
- data/sig/sentdm/models/profiles/campaign_list_response.rbs +396 -13
- data/sig/sentdm/models/profiles/campaign_update_params.rbs +138 -4
- data/sig/sentdm/models/profiles/campaign_update_response.rbs +424 -0
- data/sig/sentdm/models/template_create_params.rbs +853 -6
- data/sig/sentdm/models/template_create_response.rbs +177 -0
- data/sig/sentdm/models/template_list_response.rbs +225 -19
- data/sig/sentdm/models/template_retrieve_response.rbs +177 -0
- data/sig/sentdm/models/template_update_params.rbs +851 -4
- data/sig/sentdm/models/template_update_response.rbs +177 -0
- data/sig/sentdm/models/user_invite_response.rbs +170 -0
- data/sig/sentdm/models/user_list_response.rbs +151 -15
- data/sig/sentdm/models/user_remove_params.rbs +10 -6
- data/sig/sentdm/models/user_retrieve_response.rbs +170 -0
- data/sig/sentdm/models/user_update_role_response.rbs +170 -0
- data/sig/sentdm/models/webhook_create_response.rbs +201 -0
- data/sig/sentdm/models/webhook_list_event_types_response.rbs +130 -15
- data/sig/sentdm/models/webhook_list_events_response.rbs +142 -14
- data/sig/sentdm/models/webhook_list_response.rbs +248 -20
- data/sig/sentdm/models/webhook_retrieve_response.rbs +201 -0
- data/sig/sentdm/models/webhook_rotate_secret_params.rbs +17 -8
- data/sig/sentdm/models/webhook_rotate_secret_response.rbs +71 -9
- data/sig/sentdm/models/webhook_test_response.rbs +71 -9
- data/sig/sentdm/models/webhook_toggle_status_response.rbs +201 -0
- data/sig/sentdm/models/webhook_update_response.rbs +201 -0
- data/sig/sentdm/models.rbs +0 -68
- data/sig/sentdm/resources/contacts.rbs +3 -4
- 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 +56 -122
- data/lib/sentdm/models/api_meta.rb +0 -34
- data/lib/sentdm/models/api_response_of_contact.rb +0 -46
- data/lib/sentdm/models/api_response_of_profile_detail.rb +0 -43
- data/lib/sentdm/models/api_response_of_user.rb +0 -43
- data/lib/sentdm/models/api_response_template.rb +0 -43
- data/lib/sentdm/models/api_response_webhook.rb +0 -43
- data/lib/sentdm/models/billing_contact_info.rb +0 -47
- data/lib/sentdm/models/brands_brand_data.rb +0 -38
- data/lib/sentdm/models/contact_response.rb +0 -136
- data/lib/sentdm/models/destination_country.rb +0 -21
- data/lib/sentdm/models/error_detail.rb +0 -42
- data/lib/sentdm/models/mutation_request.rb +0 -20
- data/lib/sentdm/models/pagination_meta.rb +0 -80
- data/lib/sentdm/models/payment_details.rb +0 -44
- data/lib/sentdm/models/profile_detail.rb +0 -605
- data/lib/sentdm/models/profile_settings.rb +0 -66
- data/lib/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rb +0 -45
- data/lib/sentdm/models/profiles/base_dto.rb +0 -32
- data/lib/sentdm/models/profiles/campaign_data.rb +0 -123
- data/lib/sentdm/models/profiles/messaging_use_case_us.rb +0 -28
- data/lib/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rb +0 -29
- data/lib/sentdm/models/profiles/tcr_campaign_with_use_cases.rb +0 -236
- 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/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rb +0 -116
- data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rb +0 -75
- data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info.rb +0 -58
- data/lib/sentdm/models/tcr_brand_relationship.rb +0 -18
- data/lib/sentdm/models/tcr_vertical.rb +0 -36
- data/lib/sentdm/models/template.rb +0 -90
- data/lib/sentdm/models/template_body_content.rb +0 -27
- data/lib/sentdm/models/template_definition.rb +0 -66
- data/lib/sentdm/models/template_variable.rb +0 -80
- data/lib/sentdm/models/user_response.rb +0 -82
- data/lib/sentdm/models/webhook_event_type.rb +0 -45
- data/lib/sentdm/models/webhook_response.rb +0 -95
- data/rbi/sentdm/models/api_meta.rbi +0 -55
- data/rbi/sentdm/models/api_response_of_contact.rbi +0 -74
- data/rbi/sentdm/models/api_response_of_profile_detail.rbi +0 -74
- data/rbi/sentdm/models/api_response_of_user.rbi +0 -74
- data/rbi/sentdm/models/api_response_template.rbi +0 -74
- data/rbi/sentdm/models/api_response_webhook.rbi +0 -74
- data/rbi/sentdm/models/billing_contact_info.rbi +0 -65
- data/rbi/sentdm/models/brands_brand_data.rbi +0 -104
- data/rbi/sentdm/models/contact_response.rbi +0 -195
- data/rbi/sentdm/models/destination_country.rbi +0 -32
- data/rbi/sentdm/models/error_detail.rbi +0 -66
- data/rbi/sentdm/models/mutation_request.rbi +0 -32
- data/rbi/sentdm/models/pagination_meta.rbi +0 -135
- data/rbi/sentdm/models/payment_details.rbi +0 -59
- data/rbi/sentdm/models/profile_detail.rbi +0 -874
- data/rbi/sentdm/models/profile_settings.rbi +0 -86
- data/rbi/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rbi +0 -83
- data/rbi/sentdm/models/profiles/base_dto.rbi +0 -53
- data/rbi/sentdm/models/profiles/campaign_data.rbi +0 -148
- data/rbi/sentdm/models/profiles/messaging_use_case_us.rbi +0 -73
- data/rbi/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbi +0 -51
- data/rbi/sentdm/models/profiles/tcr_campaign_with_use_cases.rbi +0 -410
- 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 -72
- 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 -57
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rbi +0 -59
- data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rbi +0 -180
- data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rbi +0 -95
- data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info.rbi +0 -81
- data/rbi/sentdm/models/tcr_brand_relationship.rbi +0 -30
- data/rbi/sentdm/models/tcr_vertical.rbi +0 -41
- data/rbi/sentdm/models/template.rbi +0 -129
- data/rbi/sentdm/models/template_body_content.rbi +0 -43
- data/rbi/sentdm/models/template_definition.rbi +0 -164
- data/rbi/sentdm/models/template_variable.rbi +0 -120
- data/rbi/sentdm/models/user_response.rbi +0 -118
- data/rbi/sentdm/models/webhook_event_type.rbi +0 -74
- data/rbi/sentdm/models/webhook_response.rbi +0 -140
- data/sig/sentdm/models/api_meta.rbs +0 -27
- data/sig/sentdm/models/api_response_of_contact.rbs +0 -39
- data/sig/sentdm/models/api_response_of_profile_detail.rbs +0 -39
- data/sig/sentdm/models/api_response_of_user.rbs +0 -39
- data/sig/sentdm/models/api_response_template.rbs +0 -39
- data/sig/sentdm/models/api_response_webhook.rbs +0 -39
- data/sig/sentdm/models/billing_contact_info.rbs +0 -30
- data/sig/sentdm/models/brands_brand_data.rbs +0 -30
- data/sig/sentdm/models/contact_response.rbs +0 -116
- data/sig/sentdm/models/destination_country.rbs +0 -19
- data/sig/sentdm/models/error_detail.rbs +0 -39
- data/sig/sentdm/models/mutation_request.rbs +0 -15
- data/sig/sentdm/models/pagination_meta.rbs +0 -67
- data/sig/sentdm/models/payment_details.rbs +0 -30
- data/sig/sentdm/models/profile_detail.rbs +0 -474
- data/sig/sentdm/models/profile_settings.rbs +0 -50
- data/sig/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rbs +0 -41
- data/sig/sentdm/models/profiles/base_dto.rbs +0 -27
- data/sig/sentdm/models/profiles/campaign_data.rbs +0 -82
- data/sig/sentdm/models/profiles/messaging_use_case_us.rbs +0 -40
- data/sig/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbs +0 -27
- data/sig/sentdm/models/profiles/tcr_campaign_with_use_cases.rbs +0 -285
- 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 -32
- 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 -30
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rbs +0 -30
- data/sig/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rbs +0 -89
- data/sig/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rbs +0 -55
- data/sig/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info.rbs +0 -45
- data/sig/sentdm/models/tcr_brand_relationship.rbs +0 -22
- data/sig/sentdm/models/tcr_vertical.rbs +0 -58
- data/sig/sentdm/models/template.rbs +0 -79
- data/sig/sentdm/models/template_body_content.rbs +0 -30
- data/sig/sentdm/models/template_definition.rbs +0 -45
- data/sig/sentdm/models/template_variable.rbs +0 -84
- data/sig/sentdm/models/user_response.rbs +0 -72
- data/sig/sentdm/models/webhook_event_type.rbs +0 -51
- data/sig/sentdm/models/webhook_response.rbs +0 -103
|
@@ -1,45 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Sentdm
|
|
4
|
-
module Models
|
|
5
|
-
module Profiles
|
|
6
|
-
# @see Sentdm::Resources::Profiles::Campaigns#create
|
|
7
|
-
class APIResponseOfTcrCampaignWithUseCases < Sentdm::Internal::Type::BaseModel
|
|
8
|
-
# @!attribute data
|
|
9
|
-
# The response data (null if error)
|
|
10
|
-
#
|
|
11
|
-
# @return [Sentdm::Models::Profiles::TcrCampaignWithUseCases, nil]
|
|
12
|
-
optional :data, -> { Sentdm::Profiles::TcrCampaignWithUseCases }, nil?: true
|
|
13
|
-
|
|
14
|
-
# @!attribute error
|
|
15
|
-
# Error information
|
|
16
|
-
#
|
|
17
|
-
# @return [Sentdm::Models::ErrorDetail, nil]
|
|
18
|
-
optional :error, -> { Sentdm::ErrorDetail }, nil?: true
|
|
19
|
-
|
|
20
|
-
# @!attribute meta
|
|
21
|
-
# Request and response metadata
|
|
22
|
-
#
|
|
23
|
-
# @return [Sentdm::Models::APIMeta, nil]
|
|
24
|
-
optional :meta, -> { Sentdm::APIMeta }
|
|
25
|
-
|
|
26
|
-
# @!attribute success
|
|
27
|
-
# Indicates whether the request was successful
|
|
28
|
-
#
|
|
29
|
-
# @return [Boolean, nil]
|
|
30
|
-
optional :success, Sentdm::Internal::Type::Boolean
|
|
31
|
-
|
|
32
|
-
# @!method initialize(data: nil, error: nil, meta: nil, success: nil)
|
|
33
|
-
# Standard API response envelope for all v3 endpoints
|
|
34
|
-
#
|
|
35
|
-
# @param data [Sentdm::Models::Profiles::TcrCampaignWithUseCases, nil] The response data (null if error)
|
|
36
|
-
#
|
|
37
|
-
# @param error [Sentdm::Models::ErrorDetail, nil] Error information
|
|
38
|
-
#
|
|
39
|
-
# @param meta [Sentdm::Models::APIMeta] Request and response metadata
|
|
40
|
-
#
|
|
41
|
-
# @param success [Boolean] Indicates whether the request was successful
|
|
42
|
-
end
|
|
43
|
-
end
|
|
44
|
-
end
|
|
45
|
-
end
|
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Sentdm
|
|
4
|
-
module Models
|
|
5
|
-
module Profiles
|
|
6
|
-
class BaseDto < Sentdm::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute id
|
|
8
|
-
# Unique identifier
|
|
9
|
-
#
|
|
10
|
-
# @return [String, nil]
|
|
11
|
-
optional :id, String
|
|
12
|
-
|
|
13
|
-
# @!attribute created_at
|
|
14
|
-
#
|
|
15
|
-
# @return [Time, nil]
|
|
16
|
-
optional :created_at, Time, api_name: :createdAt
|
|
17
|
-
|
|
18
|
-
# @!attribute updated_at
|
|
19
|
-
#
|
|
20
|
-
# @return [Time, nil]
|
|
21
|
-
optional :updated_at, Time, api_name: :updatedAt, nil?: true
|
|
22
|
-
|
|
23
|
-
# @!method initialize(id: nil, created_at: nil, updated_at: nil)
|
|
24
|
-
# @param id [String] Unique identifier
|
|
25
|
-
#
|
|
26
|
-
# @param created_at [Time]
|
|
27
|
-
#
|
|
28
|
-
# @param updated_at [Time, nil]
|
|
29
|
-
end
|
|
30
|
-
end
|
|
31
|
-
end
|
|
32
|
-
end
|
|
@@ -1,123 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Sentdm
|
|
4
|
-
module Models
|
|
5
|
-
module Profiles
|
|
6
|
-
class CampaignData < Sentdm::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute description
|
|
8
|
-
# Campaign description
|
|
9
|
-
#
|
|
10
|
-
# @return [String]
|
|
11
|
-
required :description, String
|
|
12
|
-
|
|
13
|
-
# @!attribute name
|
|
14
|
-
# Campaign name
|
|
15
|
-
#
|
|
16
|
-
# @return [String]
|
|
17
|
-
required :name, String
|
|
18
|
-
|
|
19
|
-
# @!attribute type
|
|
20
|
-
# Campaign type (e.g., "KYC", "App")
|
|
21
|
-
#
|
|
22
|
-
# @return [String]
|
|
23
|
-
required :type, String
|
|
24
|
-
|
|
25
|
-
# @!attribute use_cases
|
|
26
|
-
# List of use cases with sample messages
|
|
27
|
-
#
|
|
28
|
-
# @return [Array<Sentdm::Models::Profiles::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData>]
|
|
29
|
-
required :use_cases,
|
|
30
|
-
-> {
|
|
31
|
-
Sentdm::Internal::Type::ArrayOf[Sentdm::Profiles::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData]
|
|
32
|
-
},
|
|
33
|
-
api_name: :useCases
|
|
34
|
-
|
|
35
|
-
# @!attribute help_keywords
|
|
36
|
-
# Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")
|
|
37
|
-
#
|
|
38
|
-
# @return [String, nil]
|
|
39
|
-
optional :help_keywords, String, api_name: :helpKeywords, nil?: true
|
|
40
|
-
|
|
41
|
-
# @!attribute help_message
|
|
42
|
-
# Message sent when user requests help
|
|
43
|
-
#
|
|
44
|
-
# @return [String, nil]
|
|
45
|
-
optional :help_message, String, api_name: :helpMessage, nil?: true
|
|
46
|
-
|
|
47
|
-
# @!attribute message_flow
|
|
48
|
-
# Description of how messages flow in the campaign
|
|
49
|
-
#
|
|
50
|
-
# @return [String, nil]
|
|
51
|
-
optional :message_flow, String, api_name: :messageFlow, nil?: true
|
|
52
|
-
|
|
53
|
-
# @!attribute optin_keywords
|
|
54
|
-
# Comma-separated keywords that trigger opt-in (e.g., "YES, START, SUBSCRIBE")
|
|
55
|
-
#
|
|
56
|
-
# @return [String, nil]
|
|
57
|
-
optional :optin_keywords, String, api_name: :optinKeywords, nil?: true
|
|
58
|
-
|
|
59
|
-
# @!attribute optin_message
|
|
60
|
-
# Message sent when user opts in
|
|
61
|
-
#
|
|
62
|
-
# @return [String, nil]
|
|
63
|
-
optional :optin_message, String, api_name: :optinMessage, nil?: true
|
|
64
|
-
|
|
65
|
-
# @!attribute optout_keywords
|
|
66
|
-
# Comma-separated keywords that trigger opt-out (e.g., "STOP, UNSUBSCRIBE, END")
|
|
67
|
-
#
|
|
68
|
-
# @return [String, nil]
|
|
69
|
-
optional :optout_keywords, String, api_name: :optoutKeywords, nil?: true
|
|
70
|
-
|
|
71
|
-
# @!attribute optout_message
|
|
72
|
-
# Message sent when user opts out
|
|
73
|
-
#
|
|
74
|
-
# @return [String, nil]
|
|
75
|
-
optional :optout_message, String, api_name: :optoutMessage, nil?: true
|
|
76
|
-
|
|
77
|
-
# @!attribute privacy_policy_link
|
|
78
|
-
# URL to privacy policy
|
|
79
|
-
#
|
|
80
|
-
# @return [String, nil]
|
|
81
|
-
optional :privacy_policy_link, String, api_name: :privacyPolicyLink, nil?: true
|
|
82
|
-
|
|
83
|
-
# @!attribute terms_and_conditions_link
|
|
84
|
-
# URL to terms and conditions
|
|
85
|
-
#
|
|
86
|
-
# @return [String, nil]
|
|
87
|
-
optional :terms_and_conditions_link, String, api_name: :termsAndConditionsLink, nil?: true
|
|
88
|
-
|
|
89
|
-
# @!method initialize(description:, name:, type:, use_cases:, help_keywords: nil, help_message: nil, message_flow: nil, optin_keywords: nil, optin_message: nil, optout_keywords: nil, optout_message: nil, privacy_policy_link: nil, terms_and_conditions_link: nil)
|
|
90
|
-
# Some parameter documentations has been truncated, see
|
|
91
|
-
# {Sentdm::Models::Profiles::CampaignData} for more details.
|
|
92
|
-
#
|
|
93
|
-
# Campaign data for create or update operation
|
|
94
|
-
#
|
|
95
|
-
# @param description [String] Campaign description
|
|
96
|
-
#
|
|
97
|
-
# @param name [String] Campaign name
|
|
98
|
-
#
|
|
99
|
-
# @param type [String] Campaign type (e.g., "KYC", "App")
|
|
100
|
-
#
|
|
101
|
-
# @param use_cases [Array<Sentdm::Models::Profiles::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData>] List of use cases with sample messages
|
|
102
|
-
#
|
|
103
|
-
# @param help_keywords [String, nil] Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")
|
|
104
|
-
#
|
|
105
|
-
# @param help_message [String, nil] Message sent when user requests help
|
|
106
|
-
#
|
|
107
|
-
# @param message_flow [String, nil] Description of how messages flow in the campaign
|
|
108
|
-
#
|
|
109
|
-
# @param optin_keywords [String, nil] Comma-separated keywords that trigger opt-in (e.g., "YES, START, SUBSCRIBE")
|
|
110
|
-
#
|
|
111
|
-
# @param optin_message [String, nil] Message sent when user opts in
|
|
112
|
-
#
|
|
113
|
-
# @param optout_keywords [String, nil] Comma-separated keywords that trigger opt-out (e.g., "STOP, UNSUBSCRIBE, END")
|
|
114
|
-
#
|
|
115
|
-
# @param optout_message [String, nil] Message sent when user opts out
|
|
116
|
-
#
|
|
117
|
-
# @param privacy_policy_link [String, nil] URL to privacy policy
|
|
118
|
-
#
|
|
119
|
-
# @param terms_and_conditions_link [String, nil] URL to terms and conditions
|
|
120
|
-
end
|
|
121
|
-
end
|
|
122
|
-
end
|
|
123
|
-
end
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Sentdm
|
|
4
|
-
module Models
|
|
5
|
-
module Profiles
|
|
6
|
-
module MessagingUseCaseUs
|
|
7
|
-
extend Sentdm::Internal::Type::Enum
|
|
8
|
-
|
|
9
|
-
MARKETING = :MARKETING
|
|
10
|
-
ACCOUNT_NOTIFICATION = :ACCOUNT_NOTIFICATION
|
|
11
|
-
CUSTOMER_CARE = :CUSTOMER_CARE
|
|
12
|
-
FRAUD_ALERT = :FRAUD_ALERT
|
|
13
|
-
TWO_FA = :TWO_FA
|
|
14
|
-
DELIVERY_NOTIFICATION = :DELIVERY_NOTIFICATION
|
|
15
|
-
SECURITY_ALERT = :SECURITY_ALERT
|
|
16
|
-
M2_M = :M2M
|
|
17
|
-
MIXED = :MIXED
|
|
18
|
-
HIGHER_EDUCATION = :HIGHER_EDUCATION
|
|
19
|
-
POLLING_VOTING = :POLLING_VOTING
|
|
20
|
-
PUBLIC_SERVICE_ANNOUNCEMENT = :PUBLIC_SERVICE_ANNOUNCEMENT
|
|
21
|
-
LOW_VOLUME = :LOW_VOLUME
|
|
22
|
-
|
|
23
|
-
# @!method self.values
|
|
24
|
-
# @return [Array<Symbol>]
|
|
25
|
-
end
|
|
26
|
-
end
|
|
27
|
-
end
|
|
28
|
-
end
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Sentdm
|
|
4
|
-
module Models
|
|
5
|
-
module Profiles
|
|
6
|
-
class SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData < Sentdm::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute messaging_use_case_us
|
|
8
|
-
#
|
|
9
|
-
# @return [Symbol, Sentdm::Models::Profiles::MessagingUseCaseUs]
|
|
10
|
-
required :messaging_use_case_us,
|
|
11
|
-
enum: -> { Sentdm::Profiles::MessagingUseCaseUs },
|
|
12
|
-
api_name: :messagingUseCaseUs
|
|
13
|
-
|
|
14
|
-
# @!attribute sample_messages
|
|
15
|
-
# Sample messages for this use case (1-5 messages, max 1024 characters each)
|
|
16
|
-
#
|
|
17
|
-
# @return [Array<String>]
|
|
18
|
-
required :sample_messages, Sentdm::Internal::Type::ArrayOf[String], api_name: :sampleMessages
|
|
19
|
-
|
|
20
|
-
# @!method initialize(messaging_use_case_us:, sample_messages:)
|
|
21
|
-
# Campaign use case with sample messages
|
|
22
|
-
#
|
|
23
|
-
# @param messaging_use_case_us [Symbol, Sentdm::Models::Profiles::MessagingUseCaseUs]
|
|
24
|
-
#
|
|
25
|
-
# @param sample_messages [Array<String>] Sample messages for this use case (1-5 messages, max 1024 characters each)
|
|
26
|
-
end
|
|
27
|
-
end
|
|
28
|
-
end
|
|
29
|
-
end
|
|
@@ -1,236 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Sentdm
|
|
4
|
-
module Models
|
|
5
|
-
module Profiles
|
|
6
|
-
class TcrCampaignWithUseCases < Sentdm::Models::Profiles::BaseDto
|
|
7
|
-
# @!attribute billed_date
|
|
8
|
-
#
|
|
9
|
-
# @return [Time, nil]
|
|
10
|
-
optional :billed_date, Time, api_name: :billedDate, nil?: true
|
|
11
|
-
|
|
12
|
-
# @!attribute brand_id
|
|
13
|
-
#
|
|
14
|
-
# @return [String, nil]
|
|
15
|
-
optional :brand_id, String, api_name: :brandId, nil?: true
|
|
16
|
-
|
|
17
|
-
# @!attribute cost
|
|
18
|
-
#
|
|
19
|
-
# @return [Float, nil]
|
|
20
|
-
optional :cost, Float, nil?: true
|
|
21
|
-
|
|
22
|
-
# @!attribute csp_id
|
|
23
|
-
#
|
|
24
|
-
# @return [String, nil]
|
|
25
|
-
optional :csp_id, String, api_name: :cspId, nil?: true
|
|
26
|
-
|
|
27
|
-
# @!attribute customer_id
|
|
28
|
-
#
|
|
29
|
-
# @return [String, nil]
|
|
30
|
-
optional :customer_id, String, api_name: :customerId
|
|
31
|
-
|
|
32
|
-
# @!attribute description
|
|
33
|
-
#
|
|
34
|
-
# @return [String, nil]
|
|
35
|
-
optional :description, String
|
|
36
|
-
|
|
37
|
-
# @!attribute help_keywords
|
|
38
|
-
#
|
|
39
|
-
# @return [String, nil]
|
|
40
|
-
optional :help_keywords, String, api_name: :helpKeywords, nil?: true
|
|
41
|
-
|
|
42
|
-
# @!attribute help_message
|
|
43
|
-
#
|
|
44
|
-
# @return [String, nil]
|
|
45
|
-
optional :help_message, String, api_name: :helpMessage, nil?: true
|
|
46
|
-
|
|
47
|
-
# @!attribute kyc_submission_form_id
|
|
48
|
-
#
|
|
49
|
-
# @return [String, nil]
|
|
50
|
-
optional :kyc_submission_form_id, String, api_name: :kycSubmissionFormId, nil?: true
|
|
51
|
-
|
|
52
|
-
# @!attribute message_flow
|
|
53
|
-
#
|
|
54
|
-
# @return [String, nil]
|
|
55
|
-
optional :message_flow, String, api_name: :messageFlow, nil?: true
|
|
56
|
-
|
|
57
|
-
# @!attribute name
|
|
58
|
-
#
|
|
59
|
-
# @return [String, nil]
|
|
60
|
-
optional :name, String
|
|
61
|
-
|
|
62
|
-
# @!attribute optin_keywords
|
|
63
|
-
#
|
|
64
|
-
# @return [String, nil]
|
|
65
|
-
optional :optin_keywords, String, api_name: :optinKeywords, nil?: true
|
|
66
|
-
|
|
67
|
-
# @!attribute optin_message
|
|
68
|
-
#
|
|
69
|
-
# @return [String, nil]
|
|
70
|
-
optional :optin_message, String, api_name: :optinMessage, nil?: true
|
|
71
|
-
|
|
72
|
-
# @!attribute optout_keywords
|
|
73
|
-
#
|
|
74
|
-
# @return [String, nil]
|
|
75
|
-
optional :optout_keywords, String, api_name: :optoutKeywords, nil?: true
|
|
76
|
-
|
|
77
|
-
# @!attribute optout_message
|
|
78
|
-
#
|
|
79
|
-
# @return [String, nil]
|
|
80
|
-
optional :optout_message, String, api_name: :optoutMessage, nil?: true
|
|
81
|
-
|
|
82
|
-
# @!attribute privacy_policy_link
|
|
83
|
-
#
|
|
84
|
-
# @return [String, nil]
|
|
85
|
-
optional :privacy_policy_link, String, api_name: :privacyPolicyLink, nil?: true
|
|
86
|
-
|
|
87
|
-
# @!attribute reseller_id
|
|
88
|
-
#
|
|
89
|
-
# @return [String, nil]
|
|
90
|
-
optional :reseller_id, String, api_name: :resellerId, nil?: true
|
|
91
|
-
|
|
92
|
-
# @!attribute sharing_status
|
|
93
|
-
#
|
|
94
|
-
# @return [Symbol, Sentdm::Models::Profiles::TcrCampaignWithUseCases::SharingStatus, nil]
|
|
95
|
-
optional :sharing_status,
|
|
96
|
-
enum: -> { Sentdm::Profiles::TcrCampaignWithUseCases::SharingStatus },
|
|
97
|
-
api_name: :sharingStatus,
|
|
98
|
-
nil?: true
|
|
99
|
-
|
|
100
|
-
# @!attribute status
|
|
101
|
-
#
|
|
102
|
-
# @return [Symbol, Sentdm::Models::Profiles::TcrCampaignWithUseCases::Status, nil]
|
|
103
|
-
optional :status, enum: -> { Sentdm::Profiles::TcrCampaignWithUseCases::Status }, nil?: true
|
|
104
|
-
|
|
105
|
-
# @!attribute submitted_at
|
|
106
|
-
#
|
|
107
|
-
# @return [Time, nil]
|
|
108
|
-
optional :submitted_at, Time, api_name: :submittedAt, nil?: true
|
|
109
|
-
|
|
110
|
-
# @!attribute submitted_to_tcr
|
|
111
|
-
#
|
|
112
|
-
# @return [Boolean, nil]
|
|
113
|
-
optional :submitted_to_tcr, Sentdm::Internal::Type::Boolean, api_name: :submittedToTCR
|
|
114
|
-
|
|
115
|
-
# @!attribute tcr_campaign_id
|
|
116
|
-
#
|
|
117
|
-
# @return [String, nil]
|
|
118
|
-
optional :tcr_campaign_id, String, api_name: :tcrCampaignId, nil?: true
|
|
119
|
-
|
|
120
|
-
# @!attribute tcr_sync_error
|
|
121
|
-
#
|
|
122
|
-
# @return [String, nil]
|
|
123
|
-
optional :tcr_sync_error, String, api_name: :tcrSyncError, nil?: true
|
|
124
|
-
|
|
125
|
-
# @!attribute telnyx_campaign_id
|
|
126
|
-
#
|
|
127
|
-
# @return [String, nil]
|
|
128
|
-
optional :telnyx_campaign_id, String, api_name: :telnyxCampaignId, nil?: true
|
|
129
|
-
|
|
130
|
-
# @!attribute terms_and_conditions_link
|
|
131
|
-
#
|
|
132
|
-
# @return [String, nil]
|
|
133
|
-
optional :terms_and_conditions_link, String, api_name: :termsAndConditionsLink, nil?: true
|
|
134
|
-
|
|
135
|
-
# @!attribute type
|
|
136
|
-
#
|
|
137
|
-
# @return [String, nil]
|
|
138
|
-
optional :type, String
|
|
139
|
-
|
|
140
|
-
# @!attribute upstream_cnp_id
|
|
141
|
-
#
|
|
142
|
-
# @return [String, nil]
|
|
143
|
-
optional :upstream_cnp_id, String, api_name: :upstreamCnpId, nil?: true
|
|
144
|
-
|
|
145
|
-
# @!attribute use_cases
|
|
146
|
-
#
|
|
147
|
-
# @return [Array<Sentdm::Models::Profiles::TcrCampaignWithUseCases::UseCase>, nil]
|
|
148
|
-
optional :use_cases,
|
|
149
|
-
-> { Sentdm::Internal::Type::ArrayOf[Sentdm::Profiles::TcrCampaignWithUseCases::UseCase] },
|
|
150
|
-
api_name: :useCases
|
|
151
|
-
|
|
152
|
-
# @!method initialize(billed_date: nil, brand_id: nil, cost: nil, csp_id: nil, customer_id: nil, description: nil, help_keywords: nil, help_message: nil, kyc_submission_form_id: nil, message_flow: nil, name: nil, optin_keywords: nil, optin_message: nil, optout_keywords: nil, optout_message: nil, privacy_policy_link: nil, reseller_id: nil, sharing_status: nil, status: nil, submitted_at: nil, submitted_to_tcr: nil, tcr_campaign_id: nil, tcr_sync_error: nil, telnyx_campaign_id: nil, terms_and_conditions_link: nil, type: nil, upstream_cnp_id: nil, use_cases: nil)
|
|
153
|
-
# @param billed_date [Time, nil]
|
|
154
|
-
# @param brand_id [String, nil]
|
|
155
|
-
# @param cost [Float, nil]
|
|
156
|
-
# @param csp_id [String, nil]
|
|
157
|
-
# @param customer_id [String]
|
|
158
|
-
# @param description [String]
|
|
159
|
-
# @param help_keywords [String, nil]
|
|
160
|
-
# @param help_message [String, nil]
|
|
161
|
-
# @param kyc_submission_form_id [String, nil]
|
|
162
|
-
# @param message_flow [String, nil]
|
|
163
|
-
# @param name [String]
|
|
164
|
-
# @param optin_keywords [String, nil]
|
|
165
|
-
# @param optin_message [String, nil]
|
|
166
|
-
# @param optout_keywords [String, nil]
|
|
167
|
-
# @param optout_message [String, nil]
|
|
168
|
-
# @param privacy_policy_link [String, nil]
|
|
169
|
-
# @param reseller_id [String, nil]
|
|
170
|
-
# @param sharing_status [Symbol, Sentdm::Models::Profiles::TcrCampaignWithUseCases::SharingStatus, nil]
|
|
171
|
-
# @param status [Symbol, Sentdm::Models::Profiles::TcrCampaignWithUseCases::Status, nil]
|
|
172
|
-
# @param submitted_at [Time, nil]
|
|
173
|
-
# @param submitted_to_tcr [Boolean]
|
|
174
|
-
# @param tcr_campaign_id [String, nil]
|
|
175
|
-
# @param tcr_sync_error [String, nil]
|
|
176
|
-
# @param telnyx_campaign_id [String, nil]
|
|
177
|
-
# @param terms_and_conditions_link [String, nil]
|
|
178
|
-
# @param type [String]
|
|
179
|
-
# @param upstream_cnp_id [String, nil]
|
|
180
|
-
# @param use_cases [Array<Sentdm::Models::Profiles::TcrCampaignWithUseCases::UseCase>]
|
|
181
|
-
|
|
182
|
-
module SharingStatus
|
|
183
|
-
extend Sentdm::Internal::Type::Enum
|
|
184
|
-
|
|
185
|
-
PENDING = :PENDING
|
|
186
|
-
ACCEPTED = :ACCEPTED
|
|
187
|
-
DECLINED = :DECLINED
|
|
188
|
-
|
|
189
|
-
# @!method self.values
|
|
190
|
-
# @return [Array<Symbol>]
|
|
191
|
-
end
|
|
192
|
-
|
|
193
|
-
module Status
|
|
194
|
-
extend Sentdm::Internal::Type::Enum
|
|
195
|
-
|
|
196
|
-
SENT_CREATED = :SENT_CREATED
|
|
197
|
-
ACTIVE = :ACTIVE
|
|
198
|
-
EXPIRED = :EXPIRED
|
|
199
|
-
|
|
200
|
-
# @!method self.values
|
|
201
|
-
# @return [Array<Symbol>]
|
|
202
|
-
end
|
|
203
|
-
|
|
204
|
-
class UseCase < Sentdm::Models::Profiles::BaseDto
|
|
205
|
-
# @!attribute campaign_id
|
|
206
|
-
#
|
|
207
|
-
# @return [String, nil]
|
|
208
|
-
optional :campaign_id, String, api_name: :campaignId
|
|
209
|
-
|
|
210
|
-
# @!attribute customer_id
|
|
211
|
-
#
|
|
212
|
-
# @return [String, nil]
|
|
213
|
-
optional :customer_id, String, api_name: :customerId
|
|
214
|
-
|
|
215
|
-
# @!attribute messaging_use_case_us
|
|
216
|
-
#
|
|
217
|
-
# @return [Symbol, Sentdm::Models::Profiles::MessagingUseCaseUs, nil]
|
|
218
|
-
optional :messaging_use_case_us,
|
|
219
|
-
enum: -> { Sentdm::Profiles::MessagingUseCaseUs },
|
|
220
|
-
api_name: :messagingUseCaseUs
|
|
221
|
-
|
|
222
|
-
# @!attribute sample_messages
|
|
223
|
-
#
|
|
224
|
-
# @return [Array<String>, nil]
|
|
225
|
-
optional :sample_messages, Sentdm::Internal::Type::ArrayOf[String], api_name: :sampleMessages
|
|
226
|
-
|
|
227
|
-
# @!method initialize(campaign_id: nil, customer_id: nil, messaging_use_case_us: nil, sample_messages: nil)
|
|
228
|
-
# @param campaign_id [String]
|
|
229
|
-
# @param customer_id [String]
|
|
230
|
-
# @param messaging_use_case_us [Symbol, Sentdm::Models::Profiles::MessagingUseCaseUs]
|
|
231
|
-
# @param sample_messages [Array<String>]
|
|
232
|
-
end
|
|
233
|
-
end
|
|
234
|
-
end
|
|
235
|
-
end
|
|
236
|
-
end
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Sentdm
|
|
4
|
-
module Models
|
|
5
|
-
class SentDmServicesCommonContractsPocOsAuthenticationConfig < Sentdm::Internal::Type::BaseModel
|
|
6
|
-
# @!attribute add_security_recommendation
|
|
7
|
-
# Whether to add the security recommendation text: "For your security, do not
|
|
8
|
-
# share this code."
|
|
9
|
-
#
|
|
10
|
-
# @return [Boolean, nil]
|
|
11
|
-
optional :add_security_recommendation,
|
|
12
|
-
Sentdm::Internal::Type::Boolean,
|
|
13
|
-
api_name: :addSecurityRecommendation
|
|
14
|
-
|
|
15
|
-
# @!attribute code_expiration_minutes
|
|
16
|
-
# Code expiration time in minutes (1-90). If set, adds footer: "This code expires
|
|
17
|
-
# in X minutes."
|
|
18
|
-
#
|
|
19
|
-
# @return [Integer, nil]
|
|
20
|
-
optional :code_expiration_minutes, Integer, api_name: :codeExpirationMinutes, nil?: true
|
|
21
|
-
|
|
22
|
-
# @!method initialize(add_security_recommendation: nil, code_expiration_minutes: nil)
|
|
23
|
-
# Some parameter documentations has been truncated, see
|
|
24
|
-
# {Sentdm::Models::SentDmServicesCommonContractsPocOsAuthenticationConfig} for
|
|
25
|
-
# more details.
|
|
26
|
-
#
|
|
27
|
-
# Configuration for AUTHENTICATION category templates
|
|
28
|
-
#
|
|
29
|
-
# @param add_security_recommendation [Boolean] Whether to add the security recommendation text: "For your security, do not shar
|
|
30
|
-
#
|
|
31
|
-
# @param code_expiration_minutes [Integer, nil] Code expiration time in minutes (1-90). If set, adds footer: "This code expires
|
|
32
|
-
end
|
|
33
|
-
end
|
|
34
|
-
end
|
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Sentdm
|
|
4
|
-
module Models
|
|
5
|
-
class SentDmServicesCommonContractsPocOsTemplateBody < Sentdm::Internal::Type::BaseModel
|
|
6
|
-
# @!attribute multi_channel
|
|
7
|
-
# Content that will be used for all channels (SMS and WhatsApp) unless
|
|
8
|
-
# channel-specific content is provided
|
|
9
|
-
#
|
|
10
|
-
# @return [Sentdm::Models::TemplateBodyContent, nil]
|
|
11
|
-
optional :multi_channel, -> { Sentdm::TemplateBodyContent }, api_name: :multiChannel, nil?: true
|
|
12
|
-
|
|
13
|
-
# @!attribute sms
|
|
14
|
-
# SMS-specific content that overrides multi-channel content for SMS messages
|
|
15
|
-
#
|
|
16
|
-
# @return [Sentdm::Models::TemplateBodyContent, nil]
|
|
17
|
-
optional :sms, -> { Sentdm::TemplateBodyContent }, nil?: true
|
|
18
|
-
|
|
19
|
-
# @!attribute whatsapp
|
|
20
|
-
# WhatsApp-specific content that overrides multi-channel content for WhatsApp
|
|
21
|
-
# messages
|
|
22
|
-
#
|
|
23
|
-
# @return [Sentdm::Models::TemplateBodyContent, nil]
|
|
24
|
-
optional :whatsapp, -> { Sentdm::TemplateBodyContent }, nil?: true
|
|
25
|
-
|
|
26
|
-
# @!method initialize(multi_channel: nil, sms: nil, whatsapp: nil)
|
|
27
|
-
# Some parameter documentations has been truncated, see
|
|
28
|
-
# {Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateBody} for more
|
|
29
|
-
# details.
|
|
30
|
-
#
|
|
31
|
-
# Body section of a message template with channel-specific content
|
|
32
|
-
#
|
|
33
|
-
# @param multi_channel [Sentdm::Models::TemplateBodyContent, nil] Content that will be used for all channels (SMS and WhatsApp) unless channel-spe
|
|
34
|
-
#
|
|
35
|
-
# @param sms [Sentdm::Models::TemplateBodyContent, nil] SMS-specific content that overrides multi-channel content for SMS messages
|
|
36
|
-
#
|
|
37
|
-
# @param whatsapp [Sentdm::Models::TemplateBodyContent, nil] WhatsApp-specific content that overrides multi-channel content for WhatsApp mess
|
|
38
|
-
end
|
|
39
|
-
end
|
|
40
|
-
end
|
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Sentdm
|
|
4
|
-
module Models
|
|
5
|
-
class SentDmServicesCommonContractsPocOsTemplateButton < Sentdm::Internal::Type::BaseModel
|
|
6
|
-
# @!attribute props
|
|
7
|
-
# Properties specific to the button type
|
|
8
|
-
#
|
|
9
|
-
# @return [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButtonProps]
|
|
10
|
-
required :props, -> { Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps }
|
|
11
|
-
|
|
12
|
-
# @!attribute type
|
|
13
|
-
# The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
|
|
14
|
-
#
|
|
15
|
-
# @return [String]
|
|
16
|
-
required :type, String
|
|
17
|
-
|
|
18
|
-
# @!attribute id
|
|
19
|
-
# The unique identifier of the button (1-based index)
|
|
20
|
-
#
|
|
21
|
-
# @return [Integer, nil]
|
|
22
|
-
optional :id, Integer
|
|
23
|
-
|
|
24
|
-
# @!method initialize(props:, type:, id: nil)
|
|
25
|
-
# Some parameter documentations has been truncated, see
|
|
26
|
-
# {Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButton} for more
|
|
27
|
-
# details.
|
|
28
|
-
#
|
|
29
|
-
# Interactive button in a message template
|
|
30
|
-
#
|
|
31
|
-
# @param props [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButtonProps] Properties specific to the button type
|
|
32
|
-
#
|
|
33
|
-
# @param type [String] The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
|
|
34
|
-
#
|
|
35
|
-
# @param id [Integer] The unique identifier of the button (1-based index)
|
|
36
|
-
end
|
|
37
|
-
end
|
|
38
|
-
end
|
|
@@ -1,81 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Sentdm
|
|
4
|
-
module Models
|
|
5
|
-
class SentDmServicesCommonContractsPocOsTemplateButtonProps < Sentdm::Internal::Type::BaseModel
|
|
6
|
-
# @!attribute active_for
|
|
7
|
-
#
|
|
8
|
-
# @return [Integer]
|
|
9
|
-
required :active_for, Integer, api_name: :activeFor
|
|
10
|
-
|
|
11
|
-
# @!attribute country_code
|
|
12
|
-
#
|
|
13
|
-
# @return [String]
|
|
14
|
-
required :country_code, String, api_name: :countryCode
|
|
15
|
-
|
|
16
|
-
# @!attribute offer_code
|
|
17
|
-
#
|
|
18
|
-
# @return [String]
|
|
19
|
-
required :offer_code, String, api_name: :offerCode
|
|
20
|
-
|
|
21
|
-
# @!attribute phone_number
|
|
22
|
-
#
|
|
23
|
-
# @return [String]
|
|
24
|
-
required :phone_number, String, api_name: :phoneNumber
|
|
25
|
-
|
|
26
|
-
# @!attribute quick_reply_type
|
|
27
|
-
#
|
|
28
|
-
# @return [String]
|
|
29
|
-
required :quick_reply_type, String, api_name: :quickReplyType
|
|
30
|
-
|
|
31
|
-
# @!attribute text
|
|
32
|
-
#
|
|
33
|
-
# @return [String]
|
|
34
|
-
required :text, String
|
|
35
|
-
|
|
36
|
-
# @!attribute url
|
|
37
|
-
#
|
|
38
|
-
# @return [String]
|
|
39
|
-
required :url, String
|
|
40
|
-
|
|
41
|
-
# @!attribute url_type
|
|
42
|
-
#
|
|
43
|
-
# @return [String]
|
|
44
|
-
required :url_type, String, api_name: :urlType
|
|
45
|
-
|
|
46
|
-
# @!attribute autofill_text
|
|
47
|
-
#
|
|
48
|
-
# @return [String, nil]
|
|
49
|
-
optional :autofill_text, String, api_name: :autofillText, nil?: true
|
|
50
|
-
|
|
51
|
-
# @!attribute otp_type
|
|
52
|
-
#
|
|
53
|
-
# @return [String, nil]
|
|
54
|
-
optional :otp_type, String, api_name: :otpType, nil?: true
|
|
55
|
-
|
|
56
|
-
# @!attribute package_name
|
|
57
|
-
#
|
|
58
|
-
# @return [String, nil]
|
|
59
|
-
optional :package_name, String, api_name: :packageName, nil?: true
|
|
60
|
-
|
|
61
|
-
# @!attribute signature_hash
|
|
62
|
-
#
|
|
63
|
-
# @return [String, nil]
|
|
64
|
-
optional :signature_hash, String, api_name: :signatureHash, nil?: true
|
|
65
|
-
|
|
66
|
-
# @!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)
|
|
67
|
-
# @param active_for [Integer]
|
|
68
|
-
# @param country_code [String]
|
|
69
|
-
# @param offer_code [String]
|
|
70
|
-
# @param phone_number [String]
|
|
71
|
-
# @param quick_reply_type [String]
|
|
72
|
-
# @param text [String]
|
|
73
|
-
# @param url [String]
|
|
74
|
-
# @param url_type [String]
|
|
75
|
-
# @param autofill_text [String, nil]
|
|
76
|
-
# @param otp_type [String, nil]
|
|
77
|
-
# @param package_name [String, nil]
|
|
78
|
-
# @param signature_hash [String, nil]
|
|
79
|
-
end
|
|
80
|
-
end
|
|
81
|
-
end
|