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
|
@@ -0,0 +1,204 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
# @see Sentdm::Resources::Webhooks#update
|
|
6
|
+
class WebhookUpdateResponse < Sentdm::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute data
|
|
8
|
+
# The response data (null if error)
|
|
9
|
+
#
|
|
10
|
+
# @return [Sentdm::Models::WebhookUpdateResponse::Data, nil]
|
|
11
|
+
optional :data, -> { Sentdm::Models::WebhookUpdateResponse::Data }, nil?: true
|
|
12
|
+
|
|
13
|
+
# @!attribute error
|
|
14
|
+
# Error information
|
|
15
|
+
#
|
|
16
|
+
# @return [Sentdm::Models::WebhookUpdateResponse::Error, nil]
|
|
17
|
+
optional :error, -> { Sentdm::Models::WebhookUpdateResponse::Error }, nil?: true
|
|
18
|
+
|
|
19
|
+
# @!attribute meta
|
|
20
|
+
# Request and response metadata
|
|
21
|
+
#
|
|
22
|
+
# @return [Sentdm::Models::WebhookUpdateResponse::Meta, nil]
|
|
23
|
+
optional :meta, -> { Sentdm::Models::WebhookUpdateResponse::Meta }
|
|
24
|
+
|
|
25
|
+
# @!attribute success
|
|
26
|
+
# Indicates whether the request was successful
|
|
27
|
+
#
|
|
28
|
+
# @return [Boolean, nil]
|
|
29
|
+
optional :success, Sentdm::Internal::Type::Boolean
|
|
30
|
+
|
|
31
|
+
# @!method initialize(data: nil, error: nil, meta: nil, success: nil)
|
|
32
|
+
# Standard API response envelope for all v3 endpoints
|
|
33
|
+
#
|
|
34
|
+
# @param data [Sentdm::Models::WebhookUpdateResponse::Data, nil] The response data (null if error)
|
|
35
|
+
#
|
|
36
|
+
# @param error [Sentdm::Models::WebhookUpdateResponse::Error, nil] Error information
|
|
37
|
+
#
|
|
38
|
+
# @param meta [Sentdm::Models::WebhookUpdateResponse::Meta] Request and response metadata
|
|
39
|
+
#
|
|
40
|
+
# @param success [Boolean] Indicates whether the request was successful
|
|
41
|
+
|
|
42
|
+
# @see Sentdm::Models::WebhookUpdateResponse#data
|
|
43
|
+
class Data < Sentdm::Internal::Type::BaseModel
|
|
44
|
+
# @!attribute id
|
|
45
|
+
#
|
|
46
|
+
# @return [String, nil]
|
|
47
|
+
optional :id, String
|
|
48
|
+
|
|
49
|
+
# @!attribute consecutive_failures
|
|
50
|
+
#
|
|
51
|
+
# @return [Integer, nil]
|
|
52
|
+
optional :consecutive_failures, Integer
|
|
53
|
+
|
|
54
|
+
# @!attribute created_at
|
|
55
|
+
#
|
|
56
|
+
# @return [Time, nil]
|
|
57
|
+
optional :created_at, Time
|
|
58
|
+
|
|
59
|
+
# @!attribute display_name
|
|
60
|
+
#
|
|
61
|
+
# @return [String, nil]
|
|
62
|
+
optional :display_name, String
|
|
63
|
+
|
|
64
|
+
# @!attribute endpoint_url
|
|
65
|
+
#
|
|
66
|
+
# @return [String, nil]
|
|
67
|
+
optional :endpoint_url, String
|
|
68
|
+
|
|
69
|
+
# @!attribute event_filters
|
|
70
|
+
#
|
|
71
|
+
# @return [Hash{Symbol=>Array<String>}, nil]
|
|
72
|
+
optional :event_filters,
|
|
73
|
+
Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]],
|
|
74
|
+
nil?: true
|
|
75
|
+
|
|
76
|
+
# @!attribute event_types
|
|
77
|
+
#
|
|
78
|
+
# @return [Array<String>, nil]
|
|
79
|
+
optional :event_types, Sentdm::Internal::Type::ArrayOf[String]
|
|
80
|
+
|
|
81
|
+
# @!attribute is_active
|
|
82
|
+
#
|
|
83
|
+
# @return [Boolean, nil]
|
|
84
|
+
optional :is_active, Sentdm::Internal::Type::Boolean
|
|
85
|
+
|
|
86
|
+
# @!attribute last_delivery_attempt_at
|
|
87
|
+
#
|
|
88
|
+
# @return [Time, nil]
|
|
89
|
+
optional :last_delivery_attempt_at, Time, nil?: true
|
|
90
|
+
|
|
91
|
+
# @!attribute last_successful_delivery_at
|
|
92
|
+
#
|
|
93
|
+
# @return [Time, nil]
|
|
94
|
+
optional :last_successful_delivery_at, Time, nil?: true
|
|
95
|
+
|
|
96
|
+
# @!attribute retry_count
|
|
97
|
+
#
|
|
98
|
+
# @return [Integer, nil]
|
|
99
|
+
optional :retry_count, Integer
|
|
100
|
+
|
|
101
|
+
# @!attribute signing_secret
|
|
102
|
+
#
|
|
103
|
+
# @return [String, nil]
|
|
104
|
+
optional :signing_secret, String, nil?: true
|
|
105
|
+
|
|
106
|
+
# @!attribute timeout_seconds
|
|
107
|
+
#
|
|
108
|
+
# @return [Integer, nil]
|
|
109
|
+
optional :timeout_seconds, Integer
|
|
110
|
+
|
|
111
|
+
# @!attribute updated_at
|
|
112
|
+
#
|
|
113
|
+
# @return [Time, nil]
|
|
114
|
+
optional :updated_at, Time, nil?: true
|
|
115
|
+
|
|
116
|
+
# @!method initialize(id: nil, consecutive_failures: nil, created_at: nil, display_name: nil, endpoint_url: nil, event_filters: nil, event_types: nil, is_active: nil, last_delivery_attempt_at: nil, last_successful_delivery_at: nil, retry_count: nil, signing_secret: nil, timeout_seconds: nil, updated_at: nil)
|
|
117
|
+
# The response data (null if error)
|
|
118
|
+
#
|
|
119
|
+
# @param id [String]
|
|
120
|
+
# @param consecutive_failures [Integer]
|
|
121
|
+
# @param created_at [Time]
|
|
122
|
+
# @param display_name [String]
|
|
123
|
+
# @param endpoint_url [String]
|
|
124
|
+
# @param event_filters [Hash{Symbol=>Array<String>}, nil]
|
|
125
|
+
# @param event_types [Array<String>]
|
|
126
|
+
# @param is_active [Boolean]
|
|
127
|
+
# @param last_delivery_attempt_at [Time, nil]
|
|
128
|
+
# @param last_successful_delivery_at [Time, nil]
|
|
129
|
+
# @param retry_count [Integer]
|
|
130
|
+
# @param signing_secret [String, nil]
|
|
131
|
+
# @param timeout_seconds [Integer]
|
|
132
|
+
# @param updated_at [Time, nil]
|
|
133
|
+
end
|
|
134
|
+
|
|
135
|
+
# @see Sentdm::Models::WebhookUpdateResponse#error
|
|
136
|
+
class Error < Sentdm::Internal::Type::BaseModel
|
|
137
|
+
# @!attribute code
|
|
138
|
+
# Machine-readable error code (e.g., "RESOURCE_001")
|
|
139
|
+
#
|
|
140
|
+
# @return [String, nil]
|
|
141
|
+
optional :code, String
|
|
142
|
+
|
|
143
|
+
# @!attribute details
|
|
144
|
+
# Additional validation error details (field-level errors)
|
|
145
|
+
#
|
|
146
|
+
# @return [Hash{Symbol=>Array<String>}, nil]
|
|
147
|
+
optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
|
|
148
|
+
|
|
149
|
+
# @!attribute doc_url
|
|
150
|
+
# URL to documentation about this error
|
|
151
|
+
#
|
|
152
|
+
# @return [String, nil]
|
|
153
|
+
optional :doc_url, String, nil?: true
|
|
154
|
+
|
|
155
|
+
# @!attribute message
|
|
156
|
+
# Human-readable error message
|
|
157
|
+
#
|
|
158
|
+
# @return [String, nil]
|
|
159
|
+
optional :message, String
|
|
160
|
+
|
|
161
|
+
# @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
|
|
162
|
+
# Error information
|
|
163
|
+
#
|
|
164
|
+
# @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
|
|
165
|
+
#
|
|
166
|
+
# @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
|
|
167
|
+
#
|
|
168
|
+
# @param doc_url [String, nil] URL to documentation about this error
|
|
169
|
+
#
|
|
170
|
+
# @param message [String] Human-readable error message
|
|
171
|
+
end
|
|
172
|
+
|
|
173
|
+
# @see Sentdm::Models::WebhookUpdateResponse#meta
|
|
174
|
+
class Meta < Sentdm::Internal::Type::BaseModel
|
|
175
|
+
# @!attribute request_id
|
|
176
|
+
# Unique identifier for this request (for tracing and support)
|
|
177
|
+
#
|
|
178
|
+
# @return [String, nil]
|
|
179
|
+
optional :request_id, String
|
|
180
|
+
|
|
181
|
+
# @!attribute timestamp
|
|
182
|
+
# Server timestamp when the response was generated
|
|
183
|
+
#
|
|
184
|
+
# @return [Time, nil]
|
|
185
|
+
optional :timestamp, Time
|
|
186
|
+
|
|
187
|
+
# @!attribute version
|
|
188
|
+
# API version used for this request
|
|
189
|
+
#
|
|
190
|
+
# @return [String, nil]
|
|
191
|
+
optional :version, String
|
|
192
|
+
|
|
193
|
+
# @!method initialize(request_id: nil, timestamp: nil, version: nil)
|
|
194
|
+
# Request and response metadata
|
|
195
|
+
#
|
|
196
|
+
# @param request_id [String] Unique identifier for this request (for tracing and support)
|
|
197
|
+
#
|
|
198
|
+
# @param timestamp [Time] Server timestamp when the response was generated
|
|
199
|
+
#
|
|
200
|
+
# @param version [String] API version used for this request
|
|
201
|
+
end
|
|
202
|
+
end
|
|
203
|
+
end
|
|
204
|
+
end
|
data/lib/sentdm/models.rb
CHANGED
|
@@ -39,38 +39,16 @@ module Sentdm
|
|
|
39
39
|
mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
|
|
40
40
|
end
|
|
41
41
|
|
|
42
|
-
APIMeta = Sentdm::Models::APIMeta
|
|
43
|
-
|
|
44
|
-
APIResponseOfContact = Sentdm::Models::APIResponseOfContact
|
|
45
|
-
|
|
46
|
-
APIResponseOfProfileDetail = Sentdm::Models::APIResponseOfProfileDetail
|
|
47
|
-
|
|
48
|
-
APIResponseOfUser = Sentdm::Models::APIResponseOfUser
|
|
49
|
-
|
|
50
|
-
APIResponseTemplate = Sentdm::Models::APIResponseTemplate
|
|
51
|
-
|
|
52
|
-
APIResponseWebhook = Sentdm::Models::APIResponseWebhook
|
|
53
|
-
|
|
54
|
-
BillingContactInfo = Sentdm::Models::BillingContactInfo
|
|
55
|
-
|
|
56
|
-
BrandsBrandData = Sentdm::Models::BrandsBrandData
|
|
57
|
-
|
|
58
42
|
ContactCreateParams = Sentdm::Models::ContactCreateParams
|
|
59
43
|
|
|
60
44
|
ContactDeleteParams = Sentdm::Models::ContactDeleteParams
|
|
61
45
|
|
|
62
46
|
ContactListParams = Sentdm::Models::ContactListParams
|
|
63
47
|
|
|
64
|
-
ContactResponse = Sentdm::Models::ContactResponse
|
|
65
|
-
|
|
66
48
|
ContactRetrieveParams = Sentdm::Models::ContactRetrieveParams
|
|
67
49
|
|
|
68
50
|
ContactUpdateParams = Sentdm::Models::ContactUpdateParams
|
|
69
51
|
|
|
70
|
-
DestinationCountry = Sentdm::Models::DestinationCountry
|
|
71
|
-
|
|
72
|
-
ErrorDetail = Sentdm::Models::ErrorDetail
|
|
73
|
-
|
|
74
52
|
MeRetrieveParams = Sentdm::Models::MeRetrieveParams
|
|
75
53
|
|
|
76
54
|
MessageRetrieveActivitiesParams = Sentdm::Models::MessageRetrieveActivitiesParams
|
|
@@ -79,71 +57,24 @@ module Sentdm
|
|
|
79
57
|
|
|
80
58
|
MessageSendParams = Sentdm::Models::MessageSendParams
|
|
81
59
|
|
|
82
|
-
MutationRequest = Sentdm::Models::MutationRequest
|
|
83
|
-
|
|
84
60
|
NumberLookupParams = Sentdm::Models::NumberLookupParams
|
|
85
61
|
|
|
86
|
-
PaginationMeta = Sentdm::Models::PaginationMeta
|
|
87
|
-
|
|
88
|
-
PaymentDetails = Sentdm::Models::PaymentDetails
|
|
89
|
-
|
|
90
62
|
ProfileCompleteParams = Sentdm::Models::ProfileCompleteParams
|
|
91
63
|
|
|
92
64
|
ProfileCreateParams = Sentdm::Models::ProfileCreateParams
|
|
93
65
|
|
|
94
66
|
ProfileDeleteParams = Sentdm::Models::ProfileDeleteParams
|
|
95
67
|
|
|
96
|
-
ProfileDetail = Sentdm::Models::ProfileDetail
|
|
97
|
-
|
|
98
68
|
ProfileListParams = Sentdm::Models::ProfileListParams
|
|
99
69
|
|
|
100
70
|
ProfileRetrieveParams = Sentdm::Models::ProfileRetrieveParams
|
|
101
71
|
|
|
102
72
|
Profiles = Sentdm::Models::Profiles
|
|
103
73
|
|
|
104
|
-
ProfileSettings = Sentdm::Models::ProfileSettings
|
|
105
|
-
|
|
106
74
|
ProfileUpdateParams = Sentdm::Models::ProfileUpdateParams
|
|
107
75
|
|
|
108
|
-
SentDmServicesCommonContractsPocOsAuthenticationConfig =
|
|
109
|
-
Sentdm::Models::SentDmServicesCommonContractsPocOsAuthenticationConfig
|
|
110
|
-
|
|
111
|
-
SentDmServicesCommonContractsPocOsTemplateBody =
|
|
112
|
-
Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateBody
|
|
113
|
-
|
|
114
|
-
SentDmServicesCommonContractsPocOsTemplateButton =
|
|
115
|
-
Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButton
|
|
116
|
-
|
|
117
|
-
SentDmServicesCommonContractsPocOsTemplateButtonProps =
|
|
118
|
-
Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButtonProps
|
|
119
|
-
|
|
120
|
-
SentDmServicesCommonContractsPocOsTemplateFooter =
|
|
121
|
-
Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateFooter
|
|
122
|
-
|
|
123
|
-
SentDmServicesCommonContractsPocOsTemplateHeader =
|
|
124
|
-
Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateHeader
|
|
125
|
-
|
|
126
|
-
SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo =
|
|
127
|
-
Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo
|
|
128
|
-
|
|
129
|
-
SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo =
|
|
130
|
-
Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo
|
|
131
|
-
|
|
132
|
-
SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo =
|
|
133
|
-
Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo
|
|
134
|
-
|
|
135
|
-
TcrBrandRelationship = Sentdm::Models::TcrBrandRelationship
|
|
136
|
-
|
|
137
|
-
TcrVertical = Sentdm::Models::TcrVertical
|
|
138
|
-
|
|
139
|
-
Template = Sentdm::Models::Template
|
|
140
|
-
|
|
141
|
-
TemplateBodyContent = Sentdm::Models::TemplateBodyContent
|
|
142
|
-
|
|
143
76
|
TemplateCreateParams = Sentdm::Models::TemplateCreateParams
|
|
144
77
|
|
|
145
|
-
TemplateDefinition = Sentdm::Models::TemplateDefinition
|
|
146
|
-
|
|
147
78
|
TemplateDeleteParams = Sentdm::Models::TemplateDeleteParams
|
|
148
79
|
|
|
149
80
|
TemplateListParams = Sentdm::Models::TemplateListParams
|
|
@@ -152,16 +83,12 @@ module Sentdm
|
|
|
152
83
|
|
|
153
84
|
TemplateUpdateParams = Sentdm::Models::TemplateUpdateParams
|
|
154
85
|
|
|
155
|
-
TemplateVariable = Sentdm::Models::TemplateVariable
|
|
156
|
-
|
|
157
86
|
UserInviteParams = Sentdm::Models::UserInviteParams
|
|
158
87
|
|
|
159
88
|
UserListParams = Sentdm::Models::UserListParams
|
|
160
89
|
|
|
161
90
|
UserRemoveParams = Sentdm::Models::UserRemoveParams
|
|
162
91
|
|
|
163
|
-
UserResponse = Sentdm::Models::UserResponse
|
|
164
|
-
|
|
165
92
|
UserRetrieveParams = Sentdm::Models::UserRetrieveParams
|
|
166
93
|
|
|
167
94
|
UserUpdateRoleParams = Sentdm::Models::UserUpdateRoleParams
|
|
@@ -170,16 +97,12 @@ module Sentdm
|
|
|
170
97
|
|
|
171
98
|
WebhookDeleteParams = Sentdm::Models::WebhookDeleteParams
|
|
172
99
|
|
|
173
|
-
WebhookEventType = Sentdm::Models::WebhookEventType
|
|
174
|
-
|
|
175
100
|
WebhookListEventsParams = Sentdm::Models::WebhookListEventsParams
|
|
176
101
|
|
|
177
102
|
WebhookListEventTypesParams = Sentdm::Models::WebhookListEventTypesParams
|
|
178
103
|
|
|
179
104
|
WebhookListParams = Sentdm::Models::WebhookListParams
|
|
180
105
|
|
|
181
|
-
WebhookResponse = Sentdm::Models::WebhookResponse
|
|
182
|
-
|
|
183
106
|
WebhookRetrieveParams = Sentdm::Models::WebhookRetrieveParams
|
|
184
107
|
|
|
185
108
|
WebhookRotateSecretParams = Sentdm::Models::WebhookRotateSecretParams
|
|
@@ -22,7 +22,7 @@ module Sentdm
|
|
|
22
22
|
#
|
|
23
23
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
24
24
|
#
|
|
25
|
-
# @return [Sentdm::Models::
|
|
25
|
+
# @return [Sentdm::Models::ContactCreateResponse]
|
|
26
26
|
#
|
|
27
27
|
# @see Sentdm::Models::ContactCreateParams
|
|
28
28
|
def create(params = {})
|
|
@@ -33,7 +33,7 @@ module Sentdm
|
|
|
33
33
|
path: "v3/contacts",
|
|
34
34
|
headers: parsed.slice(*header_params.keys).transform_keys(header_params),
|
|
35
35
|
body: parsed.except(*header_params.keys),
|
|
36
|
-
model: Sentdm::
|
|
36
|
+
model: Sentdm::Models::ContactCreateResponse,
|
|
37
37
|
options: options
|
|
38
38
|
)
|
|
39
39
|
end
|
|
@@ -53,7 +53,7 @@ module Sentdm
|
|
|
53
53
|
#
|
|
54
54
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
55
55
|
#
|
|
56
|
-
# @return [Sentdm::Models::
|
|
56
|
+
# @return [Sentdm::Models::ContactRetrieveResponse]
|
|
57
57
|
#
|
|
58
58
|
# @see Sentdm::Models::ContactRetrieveParams
|
|
59
59
|
def retrieve(id, params = {})
|
|
@@ -62,7 +62,7 @@ module Sentdm
|
|
|
62
62
|
method: :get,
|
|
63
63
|
path: ["v3/contacts/%1$s", id],
|
|
64
64
|
headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
|
|
65
|
-
model: Sentdm::
|
|
65
|
+
model: Sentdm::Models::ContactRetrieveResponse,
|
|
66
66
|
options: options
|
|
67
67
|
)
|
|
68
68
|
end
|
|
@@ -73,15 +73,13 @@ module Sentdm
|
|
|
73
73
|
# Updates a contact's default channel and/or opt-out status. Inherited contacts
|
|
74
74
|
# cannot be updated.
|
|
75
75
|
#
|
|
76
|
-
# @overload update(id,
|
|
76
|
+
# @overload update(id, default_channel: nil, opt_out: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
|
|
77
77
|
#
|
|
78
78
|
# @param id [String] Path param: Contact ID from route parameter
|
|
79
79
|
#
|
|
80
|
-
# @param channel_consent [Hash{Symbol=>String}, nil] Body param: Consent status by channel. Keys: "sms", "whatsapp". Values: "opted_i
|
|
81
|
-
#
|
|
82
80
|
# @param default_channel [String, nil] Body param: Default messaging channel: "sms" or "whatsapp"
|
|
83
81
|
#
|
|
84
|
-
# @param opt_out [Boolean, nil] Body param: Whether the contact has opted out of messaging
|
|
82
|
+
# @param opt_out [Boolean, nil] Body param: Whether the contact has opted out of messaging. Single source of tru
|
|
85
83
|
#
|
|
86
84
|
# @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
|
|
87
85
|
#
|
|
@@ -91,7 +89,7 @@ module Sentdm
|
|
|
91
89
|
#
|
|
92
90
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
93
91
|
#
|
|
94
|
-
# @return [Sentdm::Models::
|
|
92
|
+
# @return [Sentdm::Models::ContactUpdateResponse]
|
|
95
93
|
#
|
|
96
94
|
# @see Sentdm::Models::ContactUpdateParams
|
|
97
95
|
def update(id, params = {})
|
|
@@ -102,7 +100,7 @@ module Sentdm
|
|
|
102
100
|
path: ["v3/contacts/%1$s", id],
|
|
103
101
|
headers: parsed.slice(*header_params.keys).transform_keys(header_params),
|
|
104
102
|
body: parsed.except(*header_params.keys),
|
|
105
|
-
model: Sentdm::
|
|
103
|
+
model: Sentdm::Models::ContactUpdateResponse,
|
|
106
104
|
options: options
|
|
107
105
|
)
|
|
108
106
|
end
|
|
@@ -15,7 +15,7 @@ module Sentdm
|
|
|
15
15
|
#
|
|
16
16
|
# @param profile_id [String] Path param: Profile ID from route
|
|
17
17
|
#
|
|
18
|
-
# @param campaign [Sentdm::Models::Profiles::
|
|
18
|
+
# @param campaign [Sentdm::Models::Profiles::CampaignCreateParams::Campaign] Body param: Campaign data for create or update operation
|
|
19
19
|
#
|
|
20
20
|
# @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
|
|
21
21
|
#
|
|
@@ -25,7 +25,7 @@ module Sentdm
|
|
|
25
25
|
#
|
|
26
26
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
27
27
|
#
|
|
28
|
-
# @return [Sentdm::Models::Profiles::
|
|
28
|
+
# @return [Sentdm::Models::Profiles::CampaignCreateResponse]
|
|
29
29
|
#
|
|
30
30
|
# @see Sentdm::Models::Profiles::CampaignCreateParams
|
|
31
31
|
def create(profile_id, params)
|
|
@@ -36,7 +36,7 @@ module Sentdm
|
|
|
36
36
|
path: ["v3/profiles/%1$s/campaigns", profile_id],
|
|
37
37
|
headers: parsed.slice(*header_params.keys).transform_keys(header_params),
|
|
38
38
|
body: parsed.except(*header_params.keys),
|
|
39
|
-
model: Sentdm::Profiles::
|
|
39
|
+
model: Sentdm::Models::Profiles::CampaignCreateResponse,
|
|
40
40
|
options: options
|
|
41
41
|
)
|
|
42
42
|
end
|
|
@@ -53,7 +53,7 @@ module Sentdm
|
|
|
53
53
|
#
|
|
54
54
|
# @param profile_id [String] Path param: Profile ID from route
|
|
55
55
|
#
|
|
56
|
-
# @param campaign [Sentdm::Models::Profiles::
|
|
56
|
+
# @param campaign [Sentdm::Models::Profiles::CampaignUpdateParams::Campaign] Body param: Campaign data for create or update operation
|
|
57
57
|
#
|
|
58
58
|
# @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
|
|
59
59
|
#
|
|
@@ -63,7 +63,7 @@ module Sentdm
|
|
|
63
63
|
#
|
|
64
64
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
65
65
|
#
|
|
66
|
-
# @return [Sentdm::Models::Profiles::
|
|
66
|
+
# @return [Sentdm::Models::Profiles::CampaignUpdateResponse]
|
|
67
67
|
#
|
|
68
68
|
# @see Sentdm::Models::Profiles::CampaignUpdateParams
|
|
69
69
|
def update(campaign_id, params)
|
|
@@ -78,7 +78,7 @@ module Sentdm
|
|
|
78
78
|
path: ["v3/profiles/%1$s/campaigns/%2$s", profile_id, campaign_id],
|
|
79
79
|
headers: parsed.slice(*header_params.keys).transform_keys(header_params),
|
|
80
80
|
body: parsed.except(*header_params.keys),
|
|
81
|
-
model: Sentdm::Profiles::
|
|
81
|
+
model: Sentdm::Models::Profiles::CampaignUpdateResponse,
|
|
82
82
|
options: options
|
|
83
83
|
)
|
|
84
84
|
end
|
|
@@ -54,11 +54,11 @@ module Sentdm
|
|
|
54
54
|
#
|
|
55
55
|
# @param allow_template_sharing [Boolean] Body param: Whether templates are shared across profiles (default: false)
|
|
56
56
|
#
|
|
57
|
-
# @param billing_contact [Sentdm::Models::
|
|
57
|
+
# @param billing_contact [Sentdm::Models::ProfileCreateParams::BillingContact, nil] Body param: Billing contact information for a profile.
|
|
58
58
|
#
|
|
59
59
|
# @param billing_model [String, nil] Body param: Billing model: profile, organization, or profile_and_organization (d
|
|
60
60
|
#
|
|
61
|
-
# @param brand [Sentdm::Models::
|
|
61
|
+
# @param brand [Sentdm::Models::ProfileCreateParams::Brand, nil] Body param: Brand and KYC data grouped into contact, business, and compliance se
|
|
62
62
|
#
|
|
63
63
|
# @param description [String, nil] Body param: Profile description (optional)
|
|
64
64
|
#
|
|
@@ -74,7 +74,7 @@ module Sentdm
|
|
|
74
74
|
#
|
|
75
75
|
# @param name [String] Body param: Profile name (required)
|
|
76
76
|
#
|
|
77
|
-
# @param payment_details [Sentdm::Models::PaymentDetails, nil] Body param: Payment card details for a profile.
|
|
77
|
+
# @param payment_details [Sentdm::Models::ProfileCreateParams::PaymentDetails, nil] Body param: Payment card details for a profile.
|
|
78
78
|
#
|
|
79
79
|
# @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
|
|
80
80
|
#
|
|
@@ -88,7 +88,7 @@ module Sentdm
|
|
|
88
88
|
#
|
|
89
89
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
90
90
|
#
|
|
91
|
-
# @return [Sentdm::Models::
|
|
91
|
+
# @return [Sentdm::Models::ProfileCreateResponse]
|
|
92
92
|
#
|
|
93
93
|
# @see Sentdm::Models::ProfileCreateParams
|
|
94
94
|
def create(params = {})
|
|
@@ -99,7 +99,7 @@ module Sentdm
|
|
|
99
99
|
path: "v3/profiles",
|
|
100
100
|
headers: parsed.slice(*header_params.keys).transform_keys(header_params),
|
|
101
101
|
body: parsed.except(*header_params.keys),
|
|
102
|
-
model: Sentdm::
|
|
102
|
+
model: Sentdm::Models::ProfileCreateResponse,
|
|
103
103
|
options: options
|
|
104
104
|
)
|
|
105
105
|
end
|
|
@@ -119,7 +119,7 @@ module Sentdm
|
|
|
119
119
|
#
|
|
120
120
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
121
121
|
#
|
|
122
|
-
# @return [Sentdm::Models::
|
|
122
|
+
# @return [Sentdm::Models::ProfileRetrieveResponse]
|
|
123
123
|
#
|
|
124
124
|
# @see Sentdm::Models::ProfileRetrieveParams
|
|
125
125
|
def retrieve(profile_id, params = {})
|
|
@@ -128,7 +128,7 @@ module Sentdm
|
|
|
128
128
|
method: :get,
|
|
129
129
|
path: ["v3/profiles/%1$s", profile_id],
|
|
130
130
|
headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
|
|
131
|
-
model: Sentdm::
|
|
131
|
+
model: Sentdm::Models::ProfileRetrieveResponse,
|
|
132
132
|
options: options
|
|
133
133
|
)
|
|
134
134
|
end
|
|
@@ -165,11 +165,11 @@ module Sentdm
|
|
|
165
165
|
#
|
|
166
166
|
# @param allow_template_sharing [Boolean, nil] Body param: Whether templates are shared across profiles (optional)
|
|
167
167
|
#
|
|
168
|
-
# @param billing_contact [Sentdm::Models::
|
|
168
|
+
# @param billing_contact [Sentdm::Models::ProfileUpdateParams::BillingContact, nil] Body param: Billing contact information for a profile.
|
|
169
169
|
#
|
|
170
170
|
# @param billing_model [String, nil] Body param: Billing model: profile, organization, or profile_and_organization (o
|
|
171
171
|
#
|
|
172
|
-
# @param brand [Sentdm::Models::
|
|
172
|
+
# @param brand [Sentdm::Models::ProfileUpdateParams::Brand, nil] Body param: Brand and KYC data grouped into contact, business, and compliance se
|
|
173
173
|
#
|
|
174
174
|
# @param description [String, nil] Body param: Profile description (optional)
|
|
175
175
|
#
|
|
@@ -185,7 +185,7 @@ module Sentdm
|
|
|
185
185
|
#
|
|
186
186
|
# @param name [String, nil] Body param: Profile name (optional)
|
|
187
187
|
#
|
|
188
|
-
# @param payment_details [Sentdm::Models::PaymentDetails, nil] Body param: Payment card details for a profile.
|
|
188
|
+
# @param payment_details [Sentdm::Models::ProfileUpdateParams::PaymentDetails, nil] Body param: Payment card details for a profile.
|
|
189
189
|
#
|
|
190
190
|
# @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
|
|
191
191
|
#
|
|
@@ -205,7 +205,7 @@ module Sentdm
|
|
|
205
205
|
#
|
|
206
206
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
207
207
|
#
|
|
208
|
-
# @return [Sentdm::Models::
|
|
208
|
+
# @return [Sentdm::Models::ProfileUpdateResponse]
|
|
209
209
|
#
|
|
210
210
|
# @see Sentdm::Models::ProfileUpdateParams
|
|
211
211
|
def update(profile_id, params = {})
|
|
@@ -216,7 +216,7 @@ module Sentdm
|
|
|
216
216
|
path: ["v3/profiles/%1$s", profile_id],
|
|
217
217
|
headers: parsed.slice(*header_params.keys).transform_keys(header_params),
|
|
218
218
|
body: parsed.except(*header_params.keys),
|
|
219
|
-
model: Sentdm::
|
|
219
|
+
model: Sentdm::Models::ProfileUpdateResponse,
|
|
220
220
|
options: options
|
|
221
221
|
)
|
|
222
222
|
end
|
|
@@ -17,7 +17,7 @@ module Sentdm
|
|
|
17
17
|
#
|
|
18
18
|
# @param creation_source [String, nil] Body param: Source of template creation (default: from-api)
|
|
19
19
|
#
|
|
20
|
-
# @param definition [Sentdm::Models::
|
|
20
|
+
# @param definition [Sentdm::Models::TemplateCreateParams::Definition] Body param: Complete definition of a message template including header, body, fo
|
|
21
21
|
#
|
|
22
22
|
# @param language [String, nil] Body param: Template language code (e.g., en_US) (optional, auto-detected if not
|
|
23
23
|
#
|
|
@@ -31,7 +31,7 @@ module Sentdm
|
|
|
31
31
|
#
|
|
32
32
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
33
33
|
#
|
|
34
|
-
# @return [Sentdm::Models::
|
|
34
|
+
# @return [Sentdm::Models::TemplateCreateResponse]
|
|
35
35
|
#
|
|
36
36
|
# @see Sentdm::Models::TemplateCreateParams
|
|
37
37
|
def create(params = {})
|
|
@@ -42,7 +42,7 @@ module Sentdm
|
|
|
42
42
|
path: "v3/templates",
|
|
43
43
|
headers: parsed.slice(*header_params.keys).transform_keys(header_params),
|
|
44
44
|
body: parsed.except(*header_params.keys),
|
|
45
|
-
model: Sentdm::
|
|
45
|
+
model: Sentdm::Models::TemplateCreateResponse,
|
|
46
46
|
options: options
|
|
47
47
|
)
|
|
48
48
|
end
|
|
@@ -61,7 +61,7 @@ module Sentdm
|
|
|
61
61
|
#
|
|
62
62
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
63
63
|
#
|
|
64
|
-
# @return [Sentdm::Models::
|
|
64
|
+
# @return [Sentdm::Models::TemplateRetrieveResponse]
|
|
65
65
|
#
|
|
66
66
|
# @see Sentdm::Models::TemplateRetrieveParams
|
|
67
67
|
def retrieve(id, params = {})
|
|
@@ -70,7 +70,7 @@ module Sentdm
|
|
|
70
70
|
method: :get,
|
|
71
71
|
path: ["v3/templates/%1$s", id],
|
|
72
72
|
headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
|
|
73
|
-
model: Sentdm::
|
|
73
|
+
model: Sentdm::Models::TemplateRetrieveResponse,
|
|
74
74
|
options: options
|
|
75
75
|
)
|
|
76
76
|
end
|
|
@@ -87,7 +87,7 @@ module Sentdm
|
|
|
87
87
|
#
|
|
88
88
|
# @param category [String, nil] Body param: Template category: MARKETING, UTILITY, AUTHENTICATION
|
|
89
89
|
#
|
|
90
|
-
# @param definition [Sentdm::Models::
|
|
90
|
+
# @param definition [Sentdm::Models::TemplateUpdateParams::Definition, nil] Body param: Complete definition of a message template including header, body, fo
|
|
91
91
|
#
|
|
92
92
|
# @param language [String, nil] Body param: Template language code (e.g., en_US)
|
|
93
93
|
#
|
|
@@ -103,7 +103,7 @@ module Sentdm
|
|
|
103
103
|
#
|
|
104
104
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
105
105
|
#
|
|
106
|
-
# @return [Sentdm::Models::
|
|
106
|
+
# @return [Sentdm::Models::TemplateUpdateResponse]
|
|
107
107
|
#
|
|
108
108
|
# @see Sentdm::Models::TemplateUpdateParams
|
|
109
109
|
def update(id, params = {})
|
|
@@ -114,7 +114,7 @@ module Sentdm
|
|
|
114
114
|
path: ["v3/templates/%1$s", id],
|
|
115
115
|
headers: parsed.slice(*header_params.keys).transform_keys(header_params),
|
|
116
116
|
body: parsed.except(*header_params.keys),
|
|
117
|
-
model: Sentdm::
|
|
117
|
+
model: Sentdm::Models::TemplateUpdateResponse,
|
|
118
118
|
options: options
|
|
119
119
|
)
|
|
120
120
|
end
|