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,10 +7,10 @@ module Sentdm
|
|
|
7
7
|
extend Sentdm::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Sentdm::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!attribute
|
|
10
|
+
# @!attribute profile_id
|
|
11
11
|
#
|
|
12
12
|
# @return [String]
|
|
13
|
-
required :
|
|
13
|
+
required :profile_id, String
|
|
14
14
|
|
|
15
15
|
# @!attribute allow_contact_sharing
|
|
16
16
|
# Whether contacts are shared across profiles (optional)
|
|
@@ -30,12 +30,35 @@ module Sentdm
|
|
|
30
30
|
# @return [Boolean, nil]
|
|
31
31
|
optional :allow_template_sharing, Sentdm::Internal::Type::Boolean, nil?: true
|
|
32
32
|
|
|
33
|
+
# @!attribute billing_contact
|
|
34
|
+
# Billing contact for this profile. Required when billing_model is "profile" or
|
|
35
|
+
# "profile_and_organization" and no billing contact has been configured yet.
|
|
36
|
+
# Identifies who receives invoices and who is responsible for payment.
|
|
37
|
+
#
|
|
38
|
+
# @return [Sentdm::Models::BillingContactInfo, nil]
|
|
39
|
+
optional :billing_contact, -> { Sentdm::BillingContactInfo }, nil?: true
|
|
40
|
+
|
|
33
41
|
# @!attribute billing_model
|
|
34
|
-
# Billing model: profile, organization, or profile_and_organization (optional)
|
|
42
|
+
# Billing model: profile, organization, or profile_and_organization (optional).
|
|
43
|
+
#
|
|
44
|
+
# - "organization": the organization's billing details are used; no profile-level
|
|
45
|
+
# billing info needed.
|
|
46
|
+
# - "profile": the profile is billed independently; billing_contact is required.
|
|
47
|
+
# - "profile_and_organization": the profile is billed first with the organization
|
|
48
|
+
# as fallback; billing_contact is required.
|
|
35
49
|
#
|
|
36
50
|
# @return [String, nil]
|
|
37
51
|
optional :billing_model, String, nil?: true
|
|
38
52
|
|
|
53
|
+
# @!attribute brand
|
|
54
|
+
# Brand and KYC information for this profile (optional). When provided, creates or
|
|
55
|
+
# updates the brand associated with this profile. Cannot be set when
|
|
56
|
+
# inherit_tcr_brand is true. Once a brand has been submitted to TCR it cannot be
|
|
57
|
+
# modified.
|
|
58
|
+
#
|
|
59
|
+
# @return [Sentdm::Models::BrandsBrandData, nil]
|
|
60
|
+
optional :brand, -> { Sentdm::BrandsBrandData }, nil?: true
|
|
61
|
+
|
|
39
62
|
# @!attribute description
|
|
40
63
|
# Profile description (optional)
|
|
41
64
|
#
|
|
@@ -78,11 +101,20 @@ module Sentdm
|
|
|
78
101
|
# @return [String, nil]
|
|
79
102
|
optional :name, String, nil?: true
|
|
80
103
|
|
|
81
|
-
# @!attribute
|
|
82
|
-
#
|
|
104
|
+
# @!attribute payment_details
|
|
105
|
+
# Payment card details for this profile (optional). Accepted when billing_model is
|
|
106
|
+
# "profile" or "profile_and_organization". Not persisted on our servers —
|
|
107
|
+
# forwarded to the payment processor.
|
|
83
108
|
#
|
|
84
|
-
# @return [
|
|
85
|
-
optional :
|
|
109
|
+
# @return [Sentdm::Models::PaymentDetails, nil]
|
|
110
|
+
optional :payment_details, -> { Sentdm::PaymentDetails }, nil?: true
|
|
111
|
+
|
|
112
|
+
# @!attribute sandbox
|
|
113
|
+
# Sandbox flag - when true, the operation is simulated without side effects Useful
|
|
114
|
+
# for testing integrations without actual execution
|
|
115
|
+
#
|
|
116
|
+
# @return [Boolean, nil]
|
|
117
|
+
optional :sandbox, Sentdm::Internal::Type::Boolean
|
|
86
118
|
|
|
87
119
|
# @!attribute sending_phone_number
|
|
88
120
|
# Direct phone number for SMS sending (optional)
|
|
@@ -103,18 +135,13 @@ module Sentdm
|
|
|
103
135
|
optional :sending_whatsapp_number_profile_id, String, nil?: true
|
|
104
136
|
|
|
105
137
|
# @!attribute short_name
|
|
106
|
-
# Profile short name/abbreviation (optional)
|
|
138
|
+
# Profile short name/abbreviation (optional). Must be 3–11 characters, contain
|
|
139
|
+
# only letters, numbers, and spaces, and include at least one letter. Example:
|
|
140
|
+
# "SALES", "Mkt 2", "Support1".
|
|
107
141
|
#
|
|
108
142
|
# @return [String, nil]
|
|
109
143
|
optional :short_name, String, nil?: true
|
|
110
144
|
|
|
111
|
-
# @!attribute test_mode
|
|
112
|
-
# Test mode flag - when true, the operation is simulated without side effects
|
|
113
|
-
# Useful for testing integrations without actual execution
|
|
114
|
-
#
|
|
115
|
-
# @return [Boolean, nil]
|
|
116
|
-
optional :test_mode, Sentdm::Internal::Type::Boolean
|
|
117
|
-
|
|
118
145
|
# @!attribute whatsapp_phone_number
|
|
119
146
|
# Direct phone number for WhatsApp sending (optional)
|
|
120
147
|
#
|
|
@@ -126,11 +153,16 @@ module Sentdm
|
|
|
126
153
|
# @return [String, nil]
|
|
127
154
|
optional :idempotency_key, String
|
|
128
155
|
|
|
129
|
-
# @!
|
|
156
|
+
# @!attribute x_profile_id
|
|
157
|
+
#
|
|
158
|
+
# @return [String, nil]
|
|
159
|
+
optional :x_profile_id, String
|
|
160
|
+
|
|
161
|
+
# @!method initialize(profile_id:, allow_contact_sharing: nil, allow_number_change_during_onboarding: nil, allow_template_sharing: nil, billing_contact: nil, billing_model: nil, brand: nil, description: nil, icon: nil, inherit_contacts: nil, inherit_tcr_brand: nil, inherit_tcr_campaign: nil, inherit_templates: nil, name: nil, payment_details: nil, sandbox: nil, sending_phone_number: nil, sending_phone_number_profile_id: nil, sending_whatsapp_number_profile_id: nil, short_name: nil, whatsapp_phone_number: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
|
|
130
162
|
# Some parameter documentations has been truncated, see
|
|
131
163
|
# {Sentdm::Models::ProfileUpdateParams} for more details.
|
|
132
164
|
#
|
|
133
|
-
# @param
|
|
165
|
+
# @param profile_id [String]
|
|
134
166
|
#
|
|
135
167
|
# @param allow_contact_sharing [Boolean, nil] Whether contacts are shared across profiles (optional)
|
|
136
168
|
#
|
|
@@ -138,7 +170,11 @@ module Sentdm
|
|
|
138
170
|
#
|
|
139
171
|
# @param allow_template_sharing [Boolean, nil] Whether templates are shared across profiles (optional)
|
|
140
172
|
#
|
|
141
|
-
# @param
|
|
173
|
+
# @param billing_contact [Sentdm::Models::BillingContactInfo, nil] Billing contact for this profile. Required when billing_model is "profile" or "p
|
|
174
|
+
#
|
|
175
|
+
# @param billing_model [String, nil] Billing model: profile, organization, or profile_and_organization (optional).
|
|
176
|
+
#
|
|
177
|
+
# @param brand [Sentdm::Models::BrandsBrandData, nil] Brand and KYC information for this profile (optional).
|
|
142
178
|
#
|
|
143
179
|
# @param description [String, nil] Profile description (optional)
|
|
144
180
|
#
|
|
@@ -154,7 +190,9 @@ module Sentdm
|
|
|
154
190
|
#
|
|
155
191
|
# @param name [String, nil] Profile name (optional)
|
|
156
192
|
#
|
|
157
|
-
# @param
|
|
193
|
+
# @param payment_details [Sentdm::Models::PaymentDetails, nil] Payment card details for this profile (optional).
|
|
194
|
+
#
|
|
195
|
+
# @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
|
|
158
196
|
#
|
|
159
197
|
# @param sending_phone_number [String, nil] Direct phone number for SMS sending (optional)
|
|
160
198
|
#
|
|
@@ -162,14 +200,14 @@ module Sentdm
|
|
|
162
200
|
#
|
|
163
201
|
# @param sending_whatsapp_number_profile_id [String, nil] Reference to another profile to use for WhatsApp configuration (optional)
|
|
164
202
|
#
|
|
165
|
-
# @param short_name [String, nil] Profile short name/abbreviation (optional)
|
|
166
|
-
#
|
|
167
|
-
# @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
|
|
203
|
+
# @param short_name [String, nil] Profile short name/abbreviation (optional). Must be 3–11 characters, contain onl
|
|
168
204
|
#
|
|
169
205
|
# @param whatsapp_phone_number [String, nil] Direct phone number for WhatsApp sending (optional)
|
|
170
206
|
#
|
|
171
207
|
# @param idempotency_key [String]
|
|
172
208
|
#
|
|
209
|
+
# @param x_profile_id [String]
|
|
210
|
+
#
|
|
173
211
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
|
|
174
212
|
end
|
|
175
213
|
end
|
|
@@ -2,14 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
module Sentdm
|
|
4
4
|
module Models
|
|
5
|
-
module
|
|
6
|
-
# @see Sentdm::Resources::
|
|
7
|
-
class
|
|
5
|
+
module Profiles
|
|
6
|
+
# @see Sentdm::Resources::Profiles::Campaigns#create
|
|
7
|
+
class APIResponseOfTcrCampaignWithUseCases < Sentdm::Internal::Type::BaseModel
|
|
8
8
|
# @!attribute data
|
|
9
9
|
# The response data (null if error)
|
|
10
10
|
#
|
|
11
|
-
# @return [Sentdm::Models::
|
|
12
|
-
optional :data, -> { Sentdm::
|
|
11
|
+
# @return [Sentdm::Models::Profiles::TcrCampaignWithUseCases, nil]
|
|
12
|
+
optional :data, -> { Sentdm::Profiles::TcrCampaignWithUseCases }, nil?: true
|
|
13
13
|
|
|
14
14
|
# @!attribute error
|
|
15
15
|
# Error details (null if successful)
|
|
@@ -32,7 +32,7 @@ module Sentdm
|
|
|
32
32
|
# @!method initialize(data: nil, error: nil, meta: nil, success: nil)
|
|
33
33
|
# Standard API response envelope for all v3 endpoints
|
|
34
34
|
#
|
|
35
|
-
# @param data [Sentdm::Models::
|
|
35
|
+
# @param data [Sentdm::Models::Profiles::TcrCampaignWithUseCases, nil] The response data (null if error)
|
|
36
36
|
#
|
|
37
37
|
# @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
|
|
38
38
|
#
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
module Profiles
|
|
6
|
+
# @see Sentdm::Resources::Profiles::Campaigns#create
|
|
7
|
+
class CampaignCreateParams < Sentdm::Internal::Type::BaseModel
|
|
8
|
+
extend Sentdm::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Sentdm::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute profile_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :profile_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute campaign
|
|
17
|
+
# Campaign data
|
|
18
|
+
#
|
|
19
|
+
# @return [Sentdm::Models::Profiles::CampaignData]
|
|
20
|
+
required :campaign, -> { Sentdm::Profiles::CampaignData }
|
|
21
|
+
|
|
22
|
+
# @!attribute sandbox
|
|
23
|
+
# Sandbox flag - when true, the operation is simulated without side effects Useful
|
|
24
|
+
# for testing integrations without actual execution
|
|
25
|
+
#
|
|
26
|
+
# @return [Boolean, nil]
|
|
27
|
+
optional :sandbox, Sentdm::Internal::Type::Boolean
|
|
28
|
+
|
|
29
|
+
# @!attribute idempotency_key
|
|
30
|
+
#
|
|
31
|
+
# @return [String, nil]
|
|
32
|
+
optional :idempotency_key, String
|
|
33
|
+
|
|
34
|
+
# @!attribute x_profile_id
|
|
35
|
+
#
|
|
36
|
+
# @return [String, nil]
|
|
37
|
+
optional :x_profile_id, String
|
|
38
|
+
|
|
39
|
+
# @!method initialize(profile_id:, campaign:, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
|
|
40
|
+
# Some parameter documentations has been truncated, see
|
|
41
|
+
# {Sentdm::Models::Profiles::CampaignCreateParams} for more details.
|
|
42
|
+
#
|
|
43
|
+
# @param profile_id [String]
|
|
44
|
+
#
|
|
45
|
+
# @param campaign [Sentdm::Models::Profiles::CampaignData] Campaign data
|
|
46
|
+
#
|
|
47
|
+
# @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
|
|
48
|
+
#
|
|
49
|
+
# @param idempotency_key [String]
|
|
50
|
+
#
|
|
51
|
+
# @param x_profile_id [String]
|
|
52
|
+
#
|
|
53
|
+
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
|
|
54
|
+
end
|
|
55
|
+
end
|
|
56
|
+
end
|
|
57
|
+
end
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
module Sentdm
|
|
4
4
|
module Models
|
|
5
|
-
module
|
|
5
|
+
module Profiles
|
|
6
6
|
class CampaignData < Sentdm::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute description
|
|
8
8
|
# Campaign description
|
|
@@ -25,11 +25,9 @@ module Sentdm
|
|
|
25
25
|
# @!attribute use_cases
|
|
26
26
|
# List of use cases with sample messages
|
|
27
27
|
#
|
|
28
|
-
# @return [Array<Sentdm::Models::
|
|
28
|
+
# @return [Array<Sentdm::Models::Profiles::CampaignData::UseCase>]
|
|
29
29
|
required :use_cases,
|
|
30
|
-
-> {
|
|
31
|
-
Sentdm::Internal::Type::ArrayOf[Sentdm::Brands::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData]
|
|
32
|
-
},
|
|
30
|
+
-> { Sentdm::Internal::Type::ArrayOf[Sentdm::Profiles::CampaignData::UseCase] },
|
|
33
31
|
api_name: :useCases
|
|
34
32
|
|
|
35
33
|
# @!attribute help_keywords
|
|
@@ -88,7 +86,7 @@ module Sentdm
|
|
|
88
86
|
|
|
89
87
|
# @!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
88
|
# Some parameter documentations has been truncated, see
|
|
91
|
-
# {Sentdm::Models::
|
|
89
|
+
# {Sentdm::Models::Profiles::CampaignData} for more details.
|
|
92
90
|
#
|
|
93
91
|
# Campaign data for create or update operation
|
|
94
92
|
#
|
|
@@ -98,7 +96,7 @@ module Sentdm
|
|
|
98
96
|
#
|
|
99
97
|
# @param type [String] Campaign type (e.g., "KYC", "App")
|
|
100
98
|
#
|
|
101
|
-
# @param use_cases [Array<Sentdm::Models::
|
|
99
|
+
# @param use_cases [Array<Sentdm::Models::Profiles::CampaignData::UseCase>] List of use cases with sample messages
|
|
102
100
|
#
|
|
103
101
|
# @param help_keywords [String, nil] Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")
|
|
104
102
|
#
|
|
@@ -117,6 +115,29 @@ module Sentdm
|
|
|
117
115
|
# @param privacy_policy_link [String, nil] URL to privacy policy
|
|
118
116
|
#
|
|
119
117
|
# @param terms_and_conditions_link [String, nil] URL to terms and conditions
|
|
118
|
+
|
|
119
|
+
class UseCase < Sentdm::Internal::Type::BaseModel
|
|
120
|
+
# @!attribute messaging_use_case_us
|
|
121
|
+
# US messaging use case category
|
|
122
|
+
#
|
|
123
|
+
# @return [Symbol, Sentdm::Models::Profiles::MessagingUseCaseUs]
|
|
124
|
+
required :messaging_use_case_us,
|
|
125
|
+
enum: -> { Sentdm::Profiles::MessagingUseCaseUs },
|
|
126
|
+
api_name: :messagingUseCaseUs
|
|
127
|
+
|
|
128
|
+
# @!attribute sample_messages
|
|
129
|
+
# Sample messages for this use case (1-5 messages, max 1024 characters each)
|
|
130
|
+
#
|
|
131
|
+
# @return [Array<String>]
|
|
132
|
+
required :sample_messages, Sentdm::Internal::Type::ArrayOf[String], api_name: :sampleMessages
|
|
133
|
+
|
|
134
|
+
# @!method initialize(messaging_use_case_us:, sample_messages:)
|
|
135
|
+
# Campaign use case with sample messages
|
|
136
|
+
#
|
|
137
|
+
# @param messaging_use_case_us [Symbol, Sentdm::Models::Profiles::MessagingUseCaseUs] US messaging use case category
|
|
138
|
+
#
|
|
139
|
+
# @param sample_messages [Array<String>] Sample messages for this use case (1-5 messages, max 1024 characters each)
|
|
140
|
+
end
|
|
120
141
|
end
|
|
121
142
|
end
|
|
122
143
|
end
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
module Profiles
|
|
6
|
+
# @see Sentdm::Resources::Profiles::Campaigns#delete
|
|
7
|
+
class CampaignDeleteParams < Sentdm::Internal::Type::BaseModel
|
|
8
|
+
extend Sentdm::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Sentdm::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute profile_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :profile_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute campaign_id
|
|
17
|
+
#
|
|
18
|
+
# @return [String]
|
|
19
|
+
required :campaign_id, String
|
|
20
|
+
|
|
21
|
+
# @!attribute body
|
|
22
|
+
# Request to delete a campaign from a brand
|
|
23
|
+
#
|
|
24
|
+
# @return [Sentdm::Models::Profiles::CampaignDeleteParams::Body]
|
|
25
|
+
required :body, -> { Sentdm::Profiles::CampaignDeleteParams::Body }
|
|
26
|
+
|
|
27
|
+
# @!attribute x_profile_id
|
|
28
|
+
#
|
|
29
|
+
# @return [String, nil]
|
|
30
|
+
optional :x_profile_id, String
|
|
31
|
+
|
|
32
|
+
# @!method initialize(profile_id:, campaign_id:, body:, x_profile_id: nil, request_options: {})
|
|
33
|
+
# @param profile_id [String]
|
|
34
|
+
#
|
|
35
|
+
# @param campaign_id [String]
|
|
36
|
+
#
|
|
37
|
+
# @param body [Sentdm::Models::Profiles::CampaignDeleteParams::Body] Request to delete a campaign from a brand
|
|
38
|
+
#
|
|
39
|
+
# @param x_profile_id [String]
|
|
40
|
+
#
|
|
41
|
+
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
|
|
42
|
+
|
|
43
|
+
class Body < Sentdm::Models::MutationRequestBase
|
|
44
|
+
# @!method initialize
|
|
45
|
+
# Request to delete a campaign from a brand
|
|
46
|
+
end
|
|
47
|
+
end
|
|
48
|
+
end
|
|
49
|
+
end
|
|
50
|
+
end
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
module Profiles
|
|
6
|
+
# @see Sentdm::Resources::Profiles::Campaigns#list
|
|
7
|
+
class CampaignListParams < Sentdm::Internal::Type::BaseModel
|
|
8
|
+
extend Sentdm::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Sentdm::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute profile_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :profile_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute x_profile_id
|
|
17
|
+
#
|
|
18
|
+
# @return [String, nil]
|
|
19
|
+
optional :x_profile_id, String
|
|
20
|
+
|
|
21
|
+
# @!method initialize(profile_id:, x_profile_id: nil, request_options: {})
|
|
22
|
+
# @param profile_id [String]
|
|
23
|
+
# @param x_profile_id [String]
|
|
24
|
+
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
end
|
|
@@ -2,15 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
module Sentdm
|
|
4
4
|
module Models
|
|
5
|
-
module
|
|
6
|
-
# @see Sentdm::Resources::
|
|
5
|
+
module Profiles
|
|
6
|
+
# @see Sentdm::Resources::Profiles::Campaigns#list
|
|
7
7
|
class CampaignListResponse < Sentdm::Internal::Type::BaseModel
|
|
8
8
|
# @!attribute data
|
|
9
9
|
# The response data (null if error)
|
|
10
10
|
#
|
|
11
|
-
# @return [Array<Sentdm::Models::
|
|
11
|
+
# @return [Array<Sentdm::Models::Profiles::TcrCampaignWithUseCases>, nil]
|
|
12
12
|
optional :data,
|
|
13
|
-
-> { Sentdm::Internal::Type::ArrayOf[Sentdm::
|
|
13
|
+
-> { Sentdm::Internal::Type::ArrayOf[Sentdm::Profiles::TcrCampaignWithUseCases] },
|
|
14
14
|
nil?: true
|
|
15
15
|
|
|
16
16
|
# @!attribute error
|
|
@@ -34,7 +34,7 @@ module Sentdm
|
|
|
34
34
|
# @!method initialize(data: nil, error: nil, meta: nil, success: nil)
|
|
35
35
|
# Standard API response envelope for all v3 endpoints
|
|
36
36
|
#
|
|
37
|
-
# @param data [Array<Sentdm::Models::
|
|
37
|
+
# @param data [Array<Sentdm::Models::Profiles::TcrCampaignWithUseCases>, nil] The response data (null if error)
|
|
38
38
|
#
|
|
39
39
|
# @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
|
|
40
40
|
#
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
module Profiles
|
|
6
|
+
# @see Sentdm::Resources::Profiles::Campaigns#update
|
|
7
|
+
class CampaignUpdateParams < Sentdm::Internal::Type::BaseModel
|
|
8
|
+
extend Sentdm::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Sentdm::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute profile_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :profile_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute campaign_id
|
|
17
|
+
#
|
|
18
|
+
# @return [String]
|
|
19
|
+
required :campaign_id, String
|
|
20
|
+
|
|
21
|
+
# @!attribute campaign
|
|
22
|
+
# Campaign data
|
|
23
|
+
#
|
|
24
|
+
# @return [Sentdm::Models::Profiles::CampaignData]
|
|
25
|
+
required :campaign, -> { Sentdm::Profiles::CampaignData }
|
|
26
|
+
|
|
27
|
+
# @!attribute sandbox
|
|
28
|
+
# Sandbox flag - when true, the operation is simulated without side effects Useful
|
|
29
|
+
# for testing integrations without actual execution
|
|
30
|
+
#
|
|
31
|
+
# @return [Boolean, nil]
|
|
32
|
+
optional :sandbox, Sentdm::Internal::Type::Boolean
|
|
33
|
+
|
|
34
|
+
# @!attribute idempotency_key
|
|
35
|
+
#
|
|
36
|
+
# @return [String, nil]
|
|
37
|
+
optional :idempotency_key, String
|
|
38
|
+
|
|
39
|
+
# @!attribute x_profile_id
|
|
40
|
+
#
|
|
41
|
+
# @return [String, nil]
|
|
42
|
+
optional :x_profile_id, String
|
|
43
|
+
|
|
44
|
+
# @!method initialize(profile_id:, campaign_id:, campaign:, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
|
|
45
|
+
# Some parameter documentations has been truncated, see
|
|
46
|
+
# {Sentdm::Models::Profiles::CampaignUpdateParams} for more details.
|
|
47
|
+
#
|
|
48
|
+
# @param profile_id [String]
|
|
49
|
+
#
|
|
50
|
+
# @param campaign_id [String]
|
|
51
|
+
#
|
|
52
|
+
# @param campaign [Sentdm::Models::Profiles::CampaignData] Campaign data
|
|
53
|
+
#
|
|
54
|
+
# @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
|
|
55
|
+
#
|
|
56
|
+
# @param idempotency_key [String]
|
|
57
|
+
#
|
|
58
|
+
# @param x_profile_id [String]
|
|
59
|
+
#
|
|
60
|
+
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
|
|
61
|
+
end
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
end
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
module Sentdm
|
|
4
4
|
module Models
|
|
5
|
-
module
|
|
6
|
-
class TcrCampaignWithUseCases < Sentdm::Models::
|
|
5
|
+
module Profiles
|
|
6
|
+
class TcrCampaignWithUseCases < Sentdm::Models::BaseDto
|
|
7
7
|
# @!attribute billed_date
|
|
8
8
|
#
|
|
9
9
|
# @return [Time, nil]
|
|
@@ -91,16 +91,16 @@ module Sentdm
|
|
|
91
91
|
|
|
92
92
|
# @!attribute sharing_status
|
|
93
93
|
#
|
|
94
|
-
# @return [Symbol, Sentdm::Models::
|
|
94
|
+
# @return [Symbol, Sentdm::Models::Profiles::TcrCampaignWithUseCases::SharingStatus, nil]
|
|
95
95
|
optional :sharing_status,
|
|
96
|
-
enum: -> { Sentdm::
|
|
96
|
+
enum: -> { Sentdm::Profiles::TcrCampaignWithUseCases::SharingStatus },
|
|
97
97
|
api_name: :sharingStatus,
|
|
98
98
|
nil?: true
|
|
99
99
|
|
|
100
100
|
# @!attribute status
|
|
101
101
|
#
|
|
102
|
-
# @return [Symbol, Sentdm::Models::
|
|
103
|
-
optional :status, enum: -> { Sentdm::
|
|
102
|
+
# @return [Symbol, Sentdm::Models::Profiles::TcrCampaignWithUseCases::Status, nil]
|
|
103
|
+
optional :status, enum: -> { Sentdm::Profiles::TcrCampaignWithUseCases::Status }, nil?: true
|
|
104
104
|
|
|
105
105
|
# @!attribute submitted_at
|
|
106
106
|
#
|
|
@@ -144,9 +144,9 @@ module Sentdm
|
|
|
144
144
|
|
|
145
145
|
# @!attribute use_cases
|
|
146
146
|
#
|
|
147
|
-
# @return [Array<Sentdm::Models::
|
|
147
|
+
# @return [Array<Sentdm::Models::Profiles::TcrCampaignWithUseCases::UseCase>, nil]
|
|
148
148
|
optional :use_cases,
|
|
149
|
-
-> { Sentdm::Internal::Type::ArrayOf[Sentdm::
|
|
149
|
+
-> { Sentdm::Internal::Type::ArrayOf[Sentdm::Profiles::TcrCampaignWithUseCases::UseCase] },
|
|
150
150
|
api_name: :useCases
|
|
151
151
|
|
|
152
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)
|
|
@@ -167,8 +167,8 @@ module Sentdm
|
|
|
167
167
|
# @param optout_message [String, nil]
|
|
168
168
|
# @param privacy_policy_link [String, nil]
|
|
169
169
|
# @param reseller_id [String, nil]
|
|
170
|
-
# @param sharing_status [Symbol, Sentdm::Models::
|
|
171
|
-
# @param status [Symbol, Sentdm::Models::
|
|
170
|
+
# @param sharing_status [Symbol, Sentdm::Models::Profiles::TcrCampaignWithUseCases::SharingStatus, nil]
|
|
171
|
+
# @param status [Symbol, Sentdm::Models::Profiles::TcrCampaignWithUseCases::Status, nil]
|
|
172
172
|
# @param submitted_at [Time, nil]
|
|
173
173
|
# @param submitted_to_tcr [Boolean]
|
|
174
174
|
# @param tcr_campaign_id [String, nil]
|
|
@@ -177,7 +177,7 @@ module Sentdm
|
|
|
177
177
|
# @param terms_and_conditions_link [String, nil]
|
|
178
178
|
# @param type [String]
|
|
179
179
|
# @param upstream_cnp_id [String, nil]
|
|
180
|
-
# @param use_cases [Array<Sentdm::Models::
|
|
180
|
+
# @param use_cases [Array<Sentdm::Models::Profiles::TcrCampaignWithUseCases::UseCase>]
|
|
181
181
|
|
|
182
182
|
module SharingStatus
|
|
183
183
|
extend Sentdm::Internal::Type::Enum
|
|
@@ -201,7 +201,7 @@ module Sentdm
|
|
|
201
201
|
# @return [Array<Symbol>]
|
|
202
202
|
end
|
|
203
203
|
|
|
204
|
-
class UseCase < Sentdm::Models::
|
|
204
|
+
class UseCase < Sentdm::Models::BaseDto
|
|
205
205
|
# @!attribute campaign_id
|
|
206
206
|
#
|
|
207
207
|
# @return [String, nil]
|
|
@@ -214,9 +214,9 @@ module Sentdm
|
|
|
214
214
|
|
|
215
215
|
# @!attribute messaging_use_case_us
|
|
216
216
|
#
|
|
217
|
-
# @return [Symbol, Sentdm::Models::
|
|
217
|
+
# @return [Symbol, Sentdm::Models::Profiles::MessagingUseCaseUs, nil]
|
|
218
218
|
optional :messaging_use_case_us,
|
|
219
|
-
enum: -> { Sentdm::
|
|
219
|
+
enum: -> { Sentdm::Profiles::MessagingUseCaseUs },
|
|
220
220
|
api_name: :messagingUseCaseUs
|
|
221
221
|
|
|
222
222
|
# @!attribute sample_messages
|
|
@@ -227,7 +227,7 @@ module Sentdm
|
|
|
227
227
|
# @!method initialize(campaign_id: nil, customer_id: nil, messaging_use_case_us: nil, sample_messages: nil)
|
|
228
228
|
# @param campaign_id [String]
|
|
229
229
|
# @param customer_id [String]
|
|
230
|
-
# @param messaging_use_case_us [Symbol, Sentdm::Models::
|
|
230
|
+
# @param messaging_use_case_us [Symbol, Sentdm::Models::Profiles::MessagingUseCaseUs]
|
|
231
231
|
# @param sample_messages [Array<String>]
|
|
232
232
|
end
|
|
233
233
|
end
|
|
@@ -32,25 +32,30 @@ module Sentdm
|
|
|
32
32
|
# @return [String, nil]
|
|
33
33
|
optional :language, String, nil?: true
|
|
34
34
|
|
|
35
|
-
# @!attribute
|
|
36
|
-
#
|
|
35
|
+
# @!attribute sandbox
|
|
36
|
+
# Sandbox flag - when true, the operation is simulated without side effects Useful
|
|
37
|
+
# for testing integrations without actual execution
|
|
37
38
|
#
|
|
38
39
|
# @return [Boolean, nil]
|
|
39
|
-
optional :
|
|
40
|
+
optional :sandbox, Sentdm::Internal::Type::Boolean
|
|
40
41
|
|
|
41
|
-
# @!attribute
|
|
42
|
-
#
|
|
43
|
-
# Useful for testing integrations without actual execution
|
|
42
|
+
# @!attribute submit_for_review
|
|
43
|
+
# Whether to submit the template for review after creation (default: false)
|
|
44
44
|
#
|
|
45
45
|
# @return [Boolean, nil]
|
|
46
|
-
optional :
|
|
46
|
+
optional :submit_for_review, Sentdm::Internal::Type::Boolean
|
|
47
47
|
|
|
48
48
|
# @!attribute idempotency_key
|
|
49
49
|
#
|
|
50
50
|
# @return [String, nil]
|
|
51
51
|
optional :idempotency_key, String
|
|
52
52
|
|
|
53
|
-
# @!
|
|
53
|
+
# @!attribute x_profile_id
|
|
54
|
+
#
|
|
55
|
+
# @return [String, nil]
|
|
56
|
+
optional :x_profile_id, String
|
|
57
|
+
|
|
58
|
+
# @!method initialize(category: nil, creation_source: nil, definition: nil, language: nil, sandbox: nil, submit_for_review: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
|
|
54
59
|
# Some parameter documentations has been truncated, see
|
|
55
60
|
# {Sentdm::Models::TemplateCreateParams} for more details.
|
|
56
61
|
#
|
|
@@ -62,12 +67,14 @@ module Sentdm
|
|
|
62
67
|
#
|
|
63
68
|
# @param language [String, nil] Template language code (e.g., en_US) (optional, auto-detected if not provided)
|
|
64
69
|
#
|
|
65
|
-
# @param
|
|
70
|
+
# @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
|
|
66
71
|
#
|
|
67
|
-
# @param
|
|
72
|
+
# @param submit_for_review [Boolean] Whether to submit the template for review after creation (default: false)
|
|
68
73
|
#
|
|
69
74
|
# @param idempotency_key [String]
|
|
70
75
|
#
|
|
76
|
+
# @param x_profile_id [String]
|
|
77
|
+
#
|
|
71
78
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
|
|
72
79
|
end
|
|
73
80
|
end
|