sentdm 0.26.0 → 0.28.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 +40 -0
- data/README.md +1 -27
- data/lib/sentdm/client.rb +71 -8
- data/lib/sentdm/internal/type/base_model.rb +5 -5
- data/lib/sentdm/models/contact_create_response.rb +249 -0
- data/lib/sentdm/models/contact_delete_params.rb +16 -2
- data/lib/sentdm/models/contact_list_response.rb +299 -16
- data/lib/sentdm/models/contact_retrieve_message_summary_response.rb +186 -0
- data/lib/sentdm/models/contact_retrieve_response.rb +249 -0
- data/lib/sentdm/models/contact_update_response.rb +249 -0
- data/lib/sentdm/models/conversation_list_messages_response.rb +436 -0
- data/lib/sentdm/models/conversation_list_response.rb +433 -0
- data/lib/sentdm/models/inbound_message_event.rb +52 -0
- data/lib/sentdm/models/inbound_message_event_payload.rb +81 -0
- data/lib/sentdm/models/me_retrieve_response.rb +242 -12
- data/lib/sentdm/models/message_event.rb +53 -0
- data/lib/sentdm/models/message_event_payload.rb +92 -0
- data/lib/sentdm/models/message_retrieve_activities_response.rb +165 -7
- data/lib/sentdm/models/message_retrieve_status_response.rb +74 -6
- data/lib/sentdm/models/message_send_response.rb +113 -28
- 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 +378 -26
- data/lib/sentdm/models/profile_create_response.rb +760 -0
- data/lib/sentdm/models/profile_delete_params.rb +16 -2
- data/lib/sentdm/models/profile_list_response.rb +825 -14
- data/lib/sentdm/models/profile_retrieve_response.rb +762 -0
- data/lib/sentdm/models/profile_update_params.rb +391 -24
- data/lib/sentdm/models/profile_update_response.rb +760 -0
- data/lib/sentdm/models/profiles/campaign_create_params.rb +156 -3
- data/lib/sentdm/models/profiles/campaign_create_response.rb +420 -0
- data/lib/sentdm/models/profiles/campaign_delete_params.rb +17 -2
- data/lib/sentdm/models/profiles/campaign_list_response.rb +421 -0
- data/lib/sentdm/models/profiles/campaign_update_params.rb +156 -3
- data/lib/sentdm/models/profiles/campaign_update_response.rb +420 -0
- data/lib/sentdm/models/template_create_response.rb +209 -0
- data/lib/sentdm/models/template_event.rb +52 -0
- data/lib/sentdm/models/template_event_payload.rb +88 -0
- data/lib/sentdm/models/template_list_params.rb +9 -2
- data/lib/sentdm/models/template_list_response.rb +262 -16
- data/lib/sentdm/models/template_retrieve_response.rb +209 -0
- data/lib/sentdm/models/template_update_response.rb +209 -0
- data/lib/sentdm/models/user_invite_response.rb +201 -0
- data/lib/sentdm/models/user_list_response.rb +259 -14
- data/lib/sentdm/models/user_remove_params.rb +16 -2
- data/lib/sentdm/models/user_retrieve_response.rb +201 -0
- data/lib/sentdm/models/user_update_role_response.rb +201 -0
- data/lib/sentdm/models/webhook_create_response.rb +229 -0
- data/lib/sentdm/models/webhook_list_event_types_response.rb +213 -13
- data/lib/sentdm/models/webhook_list_events_response.rb +207 -16
- data/lib/sentdm/models/webhook_list_response.rb +280 -15
- data/lib/sentdm/models/webhook_retrieve_response.rb +229 -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 +229 -0
- data/lib/sentdm/models/webhook_update_response.rb +229 -0
- data/lib/sentdm/models.rb +11 -51
- data/lib/sentdm/resources/contacts.rb +30 -13
- data/lib/sentdm/resources/conversations.rb +12 -4
- data/lib/sentdm/resources/me.rb +6 -1
- data/lib/sentdm/resources/messages.rb +17 -5
- data/lib/sentdm/resources/numbers.rb +6 -1
- data/lib/sentdm/resources/profiles/campaigns.rb +47 -9
- data/lib/sentdm/resources/profiles.rb +137 -61
- data/lib/sentdm/resources/templates.rb +14 -8
- data/lib/sentdm/resources/users.rb +15 -10
- data/lib/sentdm/resources/webhooks.rb +19 -9
- data/lib/sentdm/version.rb +1 -1
- data/lib/sentdm.rb +28 -32
- data/rbi/sentdm/client.rbi +71 -8
- data/rbi/sentdm/models/contact_create_response.rbi +407 -0
- data/rbi/sentdm/models/contact_delete_params.rbi +19 -2
- data/rbi/sentdm/models/contact_list_response.rbi +527 -21
- data/rbi/sentdm/models/contact_retrieve_message_summary_response.rbi +397 -0
- data/rbi/sentdm/models/contact_retrieve_response.rbi +409 -0
- data/rbi/sentdm/models/contact_update_response.rbi +407 -0
- data/rbi/sentdm/models/conversation_list_messages_response.rbi +843 -0
- data/rbi/sentdm/models/conversation_list_response.rbi +819 -0
- data/rbi/sentdm/models/inbound_message_event.rbi +88 -0
- data/rbi/sentdm/models/inbound_message_event_payload.rbi +122 -0
- data/rbi/sentdm/models/me_retrieve_response.rbi +367 -16
- data/rbi/sentdm/models/message_event.rbi +86 -0
- data/rbi/sentdm/models/message_event_payload.rbi +132 -0
- data/rbi/sentdm/models/message_retrieve_activities_response.rbi +335 -11
- data/rbi/sentdm/models/message_retrieve_status_response.rbi +148 -8
- data/rbi/sentdm/models/message_send_response.rbi +178 -32
- 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 +592 -42
- data/rbi/sentdm/models/profile_create_response.rbi +1226 -0
- data/rbi/sentdm/models/profile_delete_params.rbi +19 -2
- data/rbi/sentdm/models/profile_list_response.rbi +1366 -18
- data/rbi/sentdm/models/profile_retrieve_response.rbi +1230 -0
- data/rbi/sentdm/models/profile_update_params.rbi +610 -30
- data/rbi/sentdm/models/profile_update_response.rbi +1226 -0
- data/rbi/sentdm/models/profiles/campaign_create_params.rbi +218 -4
- data/rbi/sentdm/models/profiles/campaign_create_response.rbi +674 -0
- data/rbi/sentdm/models/profiles/campaign_delete_params.rbi +14 -1
- data/rbi/sentdm/models/profiles/campaign_list_response.rbi +667 -0
- data/rbi/sentdm/models/profiles/campaign_update_params.rbi +218 -4
- data/rbi/sentdm/models/profiles/campaign_update_response.rbi +674 -0
- data/rbi/sentdm/models/template_create_response.rbi +349 -0
- data/rbi/sentdm/models/template_event.rbi +84 -0
- data/rbi/sentdm/models/template_event_payload.rbi +131 -0
- data/rbi/sentdm/models/template_list_params.rbi +10 -2
- data/rbi/sentdm/models/template_list_response.rbi +469 -21
- data/rbi/sentdm/models/template_retrieve_response.rbi +355 -0
- data/rbi/sentdm/models/template_update_response.rbi +349 -0
- data/rbi/sentdm/models/user_invite_response.rbi +336 -0
- data/rbi/sentdm/models/user_list_response.rbi +463 -18
- data/rbi/sentdm/models/user_remove_params.rbi +19 -2
- data/rbi/sentdm/models/user_retrieve_response.rbi +336 -0
- data/rbi/sentdm/models/user_update_role_response.rbi +341 -0
- data/rbi/sentdm/models/webhook_create_response.rbi +361 -0
- data/rbi/sentdm/models/webhook_list_event_types_response.rbi +433 -16
- data/rbi/sentdm/models/webhook_list_events_response.rbi +379 -19
- data/rbi/sentdm/models/webhook_list_response.rbi +480 -19
- data/rbi/sentdm/models/webhook_retrieve_response.rbi +363 -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 +379 -0
- data/rbi/sentdm/models/webhook_update_response.rbi +361 -0
- data/rbi/sentdm/models.rbi +11 -53
- data/rbi/sentdm/resources/contacts.rbi +24 -9
- data/rbi/sentdm/resources/conversations.rbi +10 -2
- data/rbi/sentdm/resources/me.rbi +6 -1
- data/rbi/sentdm/resources/messages.rbi +17 -5
- data/rbi/sentdm/resources/numbers.rbi +6 -1
- data/rbi/sentdm/resources/profiles/campaigns.rbi +36 -6
- data/rbi/sentdm/resources/profiles.rbi +177 -68
- data/rbi/sentdm/resources/templates.rbi +15 -5
- data/rbi/sentdm/resources/users.rbi +12 -6
- data/rbi/sentdm/resources/webhooks.rbi +15 -5
- data/sig/sentdm/models/contact_create_response.rbs +216 -0
- data/sig/sentdm/models/contact_delete_params.rbs +10 -6
- data/sig/sentdm/models/contact_list_response.rbs +263 -20
- data/sig/sentdm/models/contact_retrieve_message_summary_response.rbs +182 -0
- data/sig/sentdm/models/contact_retrieve_response.rbs +216 -0
- data/sig/sentdm/models/contact_update_response.rbs +216 -0
- data/sig/sentdm/models/conversation_list_messages_response.rbs +404 -0
- data/sig/sentdm/models/conversation_list_response.rbs +404 -0
- data/sig/sentdm/models/inbound_message_event.rbs +39 -0
- data/sig/sentdm/models/inbound_message_event_payload.rbs +69 -0
- data/sig/sentdm/models/me_retrieve_response.rbs +176 -18
- data/sig/sentdm/models/message_event.rbs +39 -0
- data/sig/sentdm/models/message_event_payload.rbs +72 -0
- data/sig/sentdm/models/message_retrieve_activities_response.rbs +147 -12
- data/sig/sentdm/models/message_retrieve_status_response.rbs +71 -9
- 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 +271 -24
- data/sig/sentdm/models/profile_create_response.rbs +559 -0
- data/sig/sentdm/models/profile_delete_params.rbs +10 -6
- data/sig/sentdm/models/profile_list_response.rbs +615 -15
- data/sig/sentdm/models/profile_retrieve_response.rbs +559 -0
- data/sig/sentdm/models/profile_update_params.rbs +263 -12
- data/sig/sentdm/models/profile_update_response.rbs +559 -0
- data/sig/sentdm/models/profiles/campaign_create_params.rbs +108 -4
- data/sig/sentdm/models/profiles/campaign_create_response.rbs +357 -0
- data/sig/sentdm/models/profiles/campaign_delete_params.rbs +15 -8
- data/sig/sentdm/models/profiles/campaign_list_response.rbs +357 -0
- data/sig/sentdm/models/profiles/campaign_update_params.rbs +108 -4
- data/sig/sentdm/models/profiles/campaign_update_response.rbs +357 -0
- data/sig/sentdm/models/template_create_response.rbs +182 -0
- data/sig/sentdm/models/template_event.rbs +39 -0
- data/sig/sentdm/models/template_event_payload.rbs +76 -0
- data/sig/sentdm/models/template_list_response.rbs +230 -19
- data/sig/sentdm/models/template_retrieve_response.rbs +182 -0
- data/sig/sentdm/models/template_update_response.rbs +182 -0
- data/sig/sentdm/models/user_invite_response.rbs +177 -0
- data/sig/sentdm/models/user_list_response.rbs +233 -15
- data/sig/sentdm/models/user_remove_params.rbs +10 -6
- data/sig/sentdm/models/user_retrieve_response.rbs +177 -0
- data/sig/sentdm/models/user_update_role_response.rbs +177 -0
- data/sig/sentdm/models/webhook_create_response.rbs +208 -0
- data/sig/sentdm/models/webhook_list_event_types_response.rbs +203 -15
- data/sig/sentdm/models/webhook_list_events_response.rbs +160 -19
- data/sig/sentdm/models/webhook_list_response.rbs +255 -20
- data/sig/sentdm/models/webhook_retrieve_response.rbs +208 -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 +208 -0
- data/sig/sentdm/models/webhook_update_response.rbs +208 -0
- data/sig/sentdm/models.rbs +11 -51
- data/sig/sentdm/resources/contacts.rbs +4 -4
- data/sig/sentdm/resources/conversations.rbs +2 -2
- data/sig/sentdm/resources/profiles/campaigns.rbs +5 -5
- data/sig/sentdm/resources/profiles.rbs +11 -11
- data/sig/sentdm/resources/templates.rbs +3 -3
- data/sig/sentdm/resources/users.rbs +3 -3
- data/sig/sentdm/resources/webhooks.rbs +4 -4
- metadata +86 -98
- 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_contact_message_summary.rb +0 -43
- data/lib/sentdm/models/api_response_of_conversation_messages_list.rb +0 -43
- 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/brand_business_info.rb +0 -114
- data/lib/sentdm/models/brand_compliance_info.rb +0 -67
- data/lib/sentdm/models/brand_contact_info.rb +0 -58
- data/lib/sentdm/models/brands_brand_data.rb +0 -34
- data/lib/sentdm/models/contact_message_summary.rb +0 -76
- data/lib/sentdm/models/contact_response.rb +0 -126
- data/lib/sentdm/models/conversation_messages_list.rb +0 -245
- 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 -597
- data/lib/sentdm/models/profile_settings.rb +0 -66
- data/lib/sentdm/models/profiles/api_response_of_brand_campaign.rb +0 -45
- data/lib/sentdm/models/profiles/api_response_of_list_of_brand_campaign.rb +0 -45
- data/lib/sentdm/models/profiles/brand_campaign.rb +0 -247
- data/lib/sentdm/models/profiles/campaign_data.rb +0 -130
- data/lib/sentdm/models/profiles/campaign_use_case.rb +0 -71
- data/lib/sentdm/models/profiles/campaign_use_case_data.rb +0 -29
- data/lib/sentdm/models/template.rb +0 -90
- 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_contact_message_summary.rbi +0 -79
- data/rbi/sentdm/models/api_response_of_conversation_messages_list.rbi +0 -79
- 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/brand_business_info.rbi +0 -162
- data/rbi/sentdm/models/brand_compliance_info.rbi +0 -84
- data/rbi/sentdm/models/brand_contact_info.rbi +0 -78
- data/rbi/sentdm/models/brands_brand_data.rbi +0 -65
- data/rbi/sentdm/models/contact_message_summary.rbi +0 -144
- data/rbi/sentdm/models/contact_response.rbi +0 -183
- data/rbi/sentdm/models/conversation_messages_list.rbi +0 -419
- 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 -866
- data/rbi/sentdm/models/profile_settings.rbi +0 -86
- data/rbi/sentdm/models/profiles/api_response_of_brand_campaign.rbi +0 -81
- data/rbi/sentdm/models/profiles/api_response_of_list_of_brand_campaign.rbi +0 -76
- data/rbi/sentdm/models/profiles/brand_campaign.rbi +0 -299
- data/rbi/sentdm/models/profiles/campaign_data.rbi +0 -146
- data/rbi/sentdm/models/profiles/campaign_use_case.rbi +0 -110
- data/rbi/sentdm/models/profiles/campaign_use_case_data.rbi +0 -51
- data/rbi/sentdm/models/template.rbi +0 -129
- 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_contact_message_summary.rbs +0 -39
- data/sig/sentdm/models/api_response_of_conversation_messages_list.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/brand_business_info.rbs +0 -89
- data/sig/sentdm/models/brand_compliance_info.rbs +0 -50
- data/sig/sentdm/models/brand_contact_info.rbs +0 -45
- data/sig/sentdm/models/brands_brand_data.rbs +0 -30
- data/sig/sentdm/models/contact_message_summary.rbs +0 -84
- data/sig/sentdm/models/contact_response.rbs +0 -111
- data/sig/sentdm/models/conversation_messages_list.rbs +0 -240
- 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 -469
- data/sig/sentdm/models/profile_settings.rbs +0 -50
- data/sig/sentdm/models/profiles/api_response_of_brand_campaign.rbs +0 -41
- data/sig/sentdm/models/profiles/api_response_of_list_of_brand_campaign.rbs +0 -41
- data/sig/sentdm/models/profiles/brand_campaign.rbs +0 -194
- data/sig/sentdm/models/profiles/campaign_data.rbs +0 -87
- data/sig/sentdm/models/profiles/campaign_use_case.rbs +0 -66
- data/sig/sentdm/models/profiles/campaign_use_case_data.rbs +0 -27
- data/sig/sentdm/models/template.rbs +0 -79
- 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
|
@@ -15,14 +15,14 @@ module Sentdm
|
|
|
15
15
|
# @!attribute error
|
|
16
16
|
# Error information
|
|
17
17
|
#
|
|
18
|
-
# @return [Sentdm::Models::
|
|
19
|
-
optional :error, -> { Sentdm::
|
|
18
|
+
# @return [Sentdm::Models::MeRetrieveResponse::Error, nil]
|
|
19
|
+
optional :error, -> { Sentdm::Models::MeRetrieveResponse::Error }, nil?: true
|
|
20
20
|
|
|
21
21
|
# @!attribute meta
|
|
22
22
|
# Request and response metadata
|
|
23
23
|
#
|
|
24
|
-
# @return [Sentdm::Models::
|
|
25
|
-
optional :meta, -> { Sentdm::
|
|
24
|
+
# @return [Sentdm::Models::MeRetrieveResponse::Meta, nil]
|
|
25
|
+
optional :meta, -> { Sentdm::Models::MeRetrieveResponse::Meta }
|
|
26
26
|
|
|
27
27
|
# @!attribute success
|
|
28
28
|
# Indicates whether the request was successful
|
|
@@ -38,9 +38,9 @@ module Sentdm
|
|
|
38
38
|
#
|
|
39
39
|
# @param data [Sentdm::Models::MeRetrieveResponse::Data, nil] Account response for GET /v3/me endpoint.
|
|
40
40
|
#
|
|
41
|
-
# @param error [Sentdm::Models::
|
|
41
|
+
# @param error [Sentdm::Models::MeRetrieveResponse::Error, nil] Error information
|
|
42
42
|
#
|
|
43
|
-
# @param meta [Sentdm::Models::
|
|
43
|
+
# @param meta [Sentdm::Models::MeRetrieveResponse::Meta] Request and response metadata
|
|
44
44
|
#
|
|
45
45
|
# @param success [Boolean] Indicates whether the request was successful
|
|
46
46
|
|
|
@@ -106,8 +106,8 @@ module Sentdm
|
|
|
106
106
|
# @!attribute settings
|
|
107
107
|
# Profile configuration settings
|
|
108
108
|
#
|
|
109
|
-
# @return [Sentdm::Models::
|
|
110
|
-
optional :settings, -> { Sentdm::
|
|
109
|
+
# @return [Sentdm::Models::MeRetrieveResponse::Data::Settings, nil]
|
|
110
|
+
optional :settings, -> { Sentdm::Models::MeRetrieveResponse::Data::Settings }, nil?: true
|
|
111
111
|
|
|
112
112
|
# @!attribute short_name
|
|
113
113
|
# Short name / abbreviation (only for profile type)
|
|
@@ -155,7 +155,7 @@ module Sentdm
|
|
|
155
155
|
#
|
|
156
156
|
# @param profiles [Array<Sentdm::Models::MeRetrieveResponse::Data::Profile>] List of profiles (populated for organization type, empty for user and profile ty
|
|
157
157
|
#
|
|
158
|
-
# @param settings [Sentdm::Models::
|
|
158
|
+
# @param settings [Sentdm::Models::MeRetrieveResponse::Data::Settings, nil] Profile configuration settings
|
|
159
159
|
#
|
|
160
160
|
# @param short_name [String, nil] Short name / abbreviation (only for profile type)
|
|
161
161
|
#
|
|
@@ -314,8 +314,8 @@ module Sentdm
|
|
|
314
314
|
# @!attribute settings
|
|
315
315
|
# Profile configuration settings
|
|
316
316
|
#
|
|
317
|
-
# @return [Sentdm::Models::
|
|
318
|
-
optional :settings, -> { Sentdm::
|
|
317
|
+
# @return [Sentdm::Models::MeRetrieveResponse::Data::Profile::Settings, nil]
|
|
318
|
+
optional :settings, -> { Sentdm::Models::MeRetrieveResponse::Data::Profile::Settings }
|
|
319
319
|
|
|
320
320
|
# @!attribute short_name
|
|
321
321
|
# Profile short name (abbreviation)
|
|
@@ -347,12 +347,242 @@ module Sentdm
|
|
|
347
347
|
#
|
|
348
348
|
# @param role [String, nil] User's role in this profile: admin, billing, developer (inherited from organizat
|
|
349
349
|
#
|
|
350
|
-
# @param settings [Sentdm::Models::
|
|
350
|
+
# @param settings [Sentdm::Models::MeRetrieveResponse::Data::Profile::Settings] Profile configuration settings
|
|
351
351
|
#
|
|
352
352
|
# @param short_name [String, nil] Profile short name (abbreviation)
|
|
353
353
|
#
|
|
354
354
|
# @param status [String, nil] Profile setup status: incomplete, pending_review, approved, rejected
|
|
355
|
+
|
|
356
|
+
# @see Sentdm::Models::MeRetrieveResponse::Data::Profile#settings
|
|
357
|
+
class Settings < Sentdm::Internal::Type::BaseModel
|
|
358
|
+
# @!attribute allow_contact_sharing
|
|
359
|
+
# @deprecated
|
|
360
|
+
#
|
|
361
|
+
# Always false. A profile no longer shares contacts with sibling profiles — it
|
|
362
|
+
# sees only what it owns. Retained so existing v3 clients reading
|
|
363
|
+
# allow_contact_sharing keep deserializing; it carries no information.
|
|
364
|
+
#
|
|
365
|
+
# @return [Boolean, nil]
|
|
366
|
+
optional :allow_contact_sharing, Sentdm::Internal::Type::Boolean, nil?: true
|
|
367
|
+
|
|
368
|
+
# @!attribute allow_template_sharing
|
|
369
|
+
# @deprecated
|
|
370
|
+
#
|
|
371
|
+
# Always false. A profile no longer shares templates with sibling profiles.
|
|
372
|
+
# Retained so existing v3 clients reading allow_template_sharing keep
|
|
373
|
+
# deserializing; it carries no information.
|
|
374
|
+
#
|
|
375
|
+
# @return [Boolean, nil]
|
|
376
|
+
optional :allow_template_sharing, Sentdm::Internal::Type::Boolean, nil?: true
|
|
377
|
+
|
|
378
|
+
# @!attribute billing_model
|
|
379
|
+
# Billing model: profile, organization, or profile_and_organization
|
|
380
|
+
#
|
|
381
|
+
# @return [String, nil]
|
|
382
|
+
optional :billing_model, String, nil?: true
|
|
383
|
+
|
|
384
|
+
# @!attribute inherit_contacts
|
|
385
|
+
# @deprecated
|
|
386
|
+
#
|
|
387
|
+
# Always false. A profile no longer inherits its organization's contacts. Retained
|
|
388
|
+
# so existing v3 clients reading inherit_contacts keep deserializing; it carries
|
|
389
|
+
# no information.
|
|
390
|
+
#
|
|
391
|
+
# @return [Boolean, nil]
|
|
392
|
+
optional :inherit_contacts, Sentdm::Internal::Type::Boolean, nil?: true
|
|
393
|
+
|
|
394
|
+
# @!attribute inherit_tcr_brand
|
|
395
|
+
# Whether this profile inherits TCR brand from the organization
|
|
396
|
+
#
|
|
397
|
+
# @return [Boolean, nil]
|
|
398
|
+
optional :inherit_tcr_brand, Sentdm::Internal::Type::Boolean, nil?: true
|
|
399
|
+
|
|
400
|
+
# @!attribute inherit_tcr_campaign
|
|
401
|
+
# Whether this profile inherits TCR campaign from the organization
|
|
402
|
+
#
|
|
403
|
+
# @return [Boolean, nil]
|
|
404
|
+
optional :inherit_tcr_campaign, Sentdm::Internal::Type::Boolean, nil?: true
|
|
405
|
+
|
|
406
|
+
# @!attribute inherit_templates
|
|
407
|
+
# @deprecated
|
|
408
|
+
#
|
|
409
|
+
# Always false. A profile no longer inherits its organization's templates.
|
|
410
|
+
# Retained so existing v3 clients reading inherit_templates keep deserializing; it
|
|
411
|
+
# carries no information.
|
|
412
|
+
#
|
|
413
|
+
# @return [Boolean, nil]
|
|
414
|
+
optional :inherit_templates, Sentdm::Internal::Type::Boolean, nil?: true
|
|
415
|
+
|
|
416
|
+
# @!method initialize(allow_contact_sharing: nil, allow_template_sharing: nil, billing_model: nil, inherit_contacts: nil, inherit_tcr_brand: nil, inherit_tcr_campaign: nil, inherit_templates: nil)
|
|
417
|
+
# Some parameter documentations has been truncated, see
|
|
418
|
+
# {Sentdm::Models::MeRetrieveResponse::Data::Profile::Settings} for more details.
|
|
419
|
+
#
|
|
420
|
+
# Profile configuration settings
|
|
421
|
+
#
|
|
422
|
+
# @param allow_contact_sharing [Boolean, nil] Always false. A profile no longer shares contacts with sibling profiles — it see
|
|
423
|
+
#
|
|
424
|
+
# @param allow_template_sharing [Boolean, nil] Always false. A profile no longer shares templates with sibling profiles. Retain
|
|
425
|
+
#
|
|
426
|
+
# @param billing_model [String, nil] Billing model: profile, organization, or profile_and_organization
|
|
427
|
+
#
|
|
428
|
+
# @param inherit_contacts [Boolean, nil] Always false. A profile no longer inherits its organization's contacts. Retained
|
|
429
|
+
#
|
|
430
|
+
# @param inherit_tcr_brand [Boolean, nil] Whether this profile inherits TCR brand from the organization
|
|
431
|
+
#
|
|
432
|
+
# @param inherit_tcr_campaign [Boolean, nil] Whether this profile inherits TCR campaign from the organization
|
|
433
|
+
#
|
|
434
|
+
# @param inherit_templates [Boolean, nil] Always false. A profile no longer inherits its organization's templates. Retaine
|
|
435
|
+
end
|
|
355
436
|
end
|
|
437
|
+
|
|
438
|
+
# @see Sentdm::Models::MeRetrieveResponse::Data#settings
|
|
439
|
+
class Settings < Sentdm::Internal::Type::BaseModel
|
|
440
|
+
# @!attribute allow_contact_sharing
|
|
441
|
+
# @deprecated
|
|
442
|
+
#
|
|
443
|
+
# Always false. A profile no longer shares contacts with sibling profiles — it
|
|
444
|
+
# sees only what it owns. Retained so existing v3 clients reading
|
|
445
|
+
# allow_contact_sharing keep deserializing; it carries no information.
|
|
446
|
+
#
|
|
447
|
+
# @return [Boolean, nil]
|
|
448
|
+
optional :allow_contact_sharing, Sentdm::Internal::Type::Boolean, nil?: true
|
|
449
|
+
|
|
450
|
+
# @!attribute allow_template_sharing
|
|
451
|
+
# @deprecated
|
|
452
|
+
#
|
|
453
|
+
# Always false. A profile no longer shares templates with sibling profiles.
|
|
454
|
+
# Retained so existing v3 clients reading allow_template_sharing keep
|
|
455
|
+
# deserializing; it carries no information.
|
|
456
|
+
#
|
|
457
|
+
# @return [Boolean, nil]
|
|
458
|
+
optional :allow_template_sharing, Sentdm::Internal::Type::Boolean, nil?: true
|
|
459
|
+
|
|
460
|
+
# @!attribute billing_model
|
|
461
|
+
# Billing model: profile, organization, or profile_and_organization
|
|
462
|
+
#
|
|
463
|
+
# @return [String, nil]
|
|
464
|
+
optional :billing_model, String, nil?: true
|
|
465
|
+
|
|
466
|
+
# @!attribute inherit_contacts
|
|
467
|
+
# @deprecated
|
|
468
|
+
#
|
|
469
|
+
# Always false. A profile no longer inherits its organization's contacts. Retained
|
|
470
|
+
# so existing v3 clients reading inherit_contacts keep deserializing; it carries
|
|
471
|
+
# no information.
|
|
472
|
+
#
|
|
473
|
+
# @return [Boolean, nil]
|
|
474
|
+
optional :inherit_contacts, Sentdm::Internal::Type::Boolean, nil?: true
|
|
475
|
+
|
|
476
|
+
# @!attribute inherit_tcr_brand
|
|
477
|
+
# Whether this profile inherits TCR brand from the organization
|
|
478
|
+
#
|
|
479
|
+
# @return [Boolean, nil]
|
|
480
|
+
optional :inherit_tcr_brand, Sentdm::Internal::Type::Boolean, nil?: true
|
|
481
|
+
|
|
482
|
+
# @!attribute inherit_tcr_campaign
|
|
483
|
+
# Whether this profile inherits TCR campaign from the organization
|
|
484
|
+
#
|
|
485
|
+
# @return [Boolean, nil]
|
|
486
|
+
optional :inherit_tcr_campaign, Sentdm::Internal::Type::Boolean, nil?: true
|
|
487
|
+
|
|
488
|
+
# @!attribute inherit_templates
|
|
489
|
+
# @deprecated
|
|
490
|
+
#
|
|
491
|
+
# Always false. A profile no longer inherits its organization's templates.
|
|
492
|
+
# Retained so existing v3 clients reading inherit_templates keep deserializing; it
|
|
493
|
+
# carries no information.
|
|
494
|
+
#
|
|
495
|
+
# @return [Boolean, nil]
|
|
496
|
+
optional :inherit_templates, Sentdm::Internal::Type::Boolean, nil?: true
|
|
497
|
+
|
|
498
|
+
# @!method initialize(allow_contact_sharing: nil, allow_template_sharing: nil, billing_model: nil, inherit_contacts: nil, inherit_tcr_brand: nil, inherit_tcr_campaign: nil, inherit_templates: nil)
|
|
499
|
+
# Some parameter documentations has been truncated, see
|
|
500
|
+
# {Sentdm::Models::MeRetrieveResponse::Data::Settings} for more details.
|
|
501
|
+
#
|
|
502
|
+
# Profile configuration settings
|
|
503
|
+
#
|
|
504
|
+
# @param allow_contact_sharing [Boolean, nil] Always false. A profile no longer shares contacts with sibling profiles — it see
|
|
505
|
+
#
|
|
506
|
+
# @param allow_template_sharing [Boolean, nil] Always false. A profile no longer shares templates with sibling profiles. Retain
|
|
507
|
+
#
|
|
508
|
+
# @param billing_model [String, nil] Billing model: profile, organization, or profile_and_organization
|
|
509
|
+
#
|
|
510
|
+
# @param inherit_contacts [Boolean, nil] Always false. A profile no longer inherits its organization's contacts. Retained
|
|
511
|
+
#
|
|
512
|
+
# @param inherit_tcr_brand [Boolean, nil] Whether this profile inherits TCR brand from the organization
|
|
513
|
+
#
|
|
514
|
+
# @param inherit_tcr_campaign [Boolean, nil] Whether this profile inherits TCR campaign from the organization
|
|
515
|
+
#
|
|
516
|
+
# @param inherit_templates [Boolean, nil] Always false. A profile no longer inherits its organization's templates. Retaine
|
|
517
|
+
end
|
|
518
|
+
end
|
|
519
|
+
|
|
520
|
+
# @see Sentdm::Models::MeRetrieveResponse#error
|
|
521
|
+
class Error < Sentdm::Internal::Type::BaseModel
|
|
522
|
+
# @!attribute code
|
|
523
|
+
# Machine-readable error code (e.g., "RESOURCE_001")
|
|
524
|
+
#
|
|
525
|
+
# @return [String, nil]
|
|
526
|
+
optional :code, String
|
|
527
|
+
|
|
528
|
+
# @!attribute details
|
|
529
|
+
# Additional validation error details (field-level errors)
|
|
530
|
+
#
|
|
531
|
+
# @return [Hash{Symbol=>Array<String>}, nil]
|
|
532
|
+
optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
|
|
533
|
+
|
|
534
|
+
# @!attribute doc_url
|
|
535
|
+
# URL to documentation about this error
|
|
536
|
+
#
|
|
537
|
+
# @return [String, nil]
|
|
538
|
+
optional :doc_url, String, nil?: true
|
|
539
|
+
|
|
540
|
+
# @!attribute message
|
|
541
|
+
# Human-readable error message
|
|
542
|
+
#
|
|
543
|
+
# @return [String, nil]
|
|
544
|
+
optional :message, String
|
|
545
|
+
|
|
546
|
+
# @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
|
|
547
|
+
# Error information
|
|
548
|
+
#
|
|
549
|
+
# @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
|
|
550
|
+
#
|
|
551
|
+
# @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
|
|
552
|
+
#
|
|
553
|
+
# @param doc_url [String, nil] URL to documentation about this error
|
|
554
|
+
#
|
|
555
|
+
# @param message [String] Human-readable error message
|
|
556
|
+
end
|
|
557
|
+
|
|
558
|
+
# @see Sentdm::Models::MeRetrieveResponse#meta
|
|
559
|
+
class Meta < Sentdm::Internal::Type::BaseModel
|
|
560
|
+
# @!attribute request_id
|
|
561
|
+
# Unique identifier for this request (for tracing and support)
|
|
562
|
+
#
|
|
563
|
+
# @return [String, nil]
|
|
564
|
+
optional :request_id, String
|
|
565
|
+
|
|
566
|
+
# @!attribute timestamp
|
|
567
|
+
# Server timestamp when the response was generated
|
|
568
|
+
#
|
|
569
|
+
# @return [Time, nil]
|
|
570
|
+
optional :timestamp, Time
|
|
571
|
+
|
|
572
|
+
# @!attribute version
|
|
573
|
+
# API version used for this request
|
|
574
|
+
#
|
|
575
|
+
# @return [String, nil]
|
|
576
|
+
optional :version, String
|
|
577
|
+
|
|
578
|
+
# @!method initialize(request_id: nil, timestamp: nil, version: nil)
|
|
579
|
+
# Request and response metadata
|
|
580
|
+
#
|
|
581
|
+
# @param request_id [String] Unique identifier for this request (for tracing and support)
|
|
582
|
+
#
|
|
583
|
+
# @param timestamp [Time] Server timestamp when the response was generated
|
|
584
|
+
#
|
|
585
|
+
# @param version [String] API version used for this request
|
|
356
586
|
end
|
|
357
587
|
end
|
|
358
588
|
end
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
class MessageEvent < Sentdm::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute event
|
|
7
|
+
# The specific event within the family, for example message.delivered or
|
|
8
|
+
# message.received. Absent on events that have no subtype, so treat it as
|
|
9
|
+
# optional.
|
|
10
|
+
#
|
|
11
|
+
# @return [String, nil]
|
|
12
|
+
optional :event, String, nil?: true
|
|
13
|
+
|
|
14
|
+
# @!attribute field
|
|
15
|
+
# The event family, for example message or templates. Route on this first, then on
|
|
16
|
+
# event for the specific change.
|
|
17
|
+
#
|
|
18
|
+
# @return [String, nil]
|
|
19
|
+
optional :field, String
|
|
20
|
+
|
|
21
|
+
# @!attribute payload
|
|
22
|
+
# Body of an outbound message lifecycle event. Delivered once per status change,
|
|
23
|
+
# so a single message produces several of these as it moves toward a terminal
|
|
24
|
+
# status.
|
|
25
|
+
#
|
|
26
|
+
# @return [Sentdm::Models::MessageEventPayload, nil]
|
|
27
|
+
optional :payload, -> { Sentdm::MessageEventPayload }, nil?: true
|
|
28
|
+
|
|
29
|
+
# @!attribute timestamp
|
|
30
|
+
# When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ). This is the emission
|
|
31
|
+
# time, not the time the underlying change happened. Use the timestamp inside the
|
|
32
|
+
# payload for the latter.
|
|
33
|
+
#
|
|
34
|
+
# @return [String, nil]
|
|
35
|
+
optional :timestamp, String
|
|
36
|
+
|
|
37
|
+
# @!method initialize(event: nil, field: nil, payload: nil, timestamp: nil)
|
|
38
|
+
# Some parameter documentations has been truncated, see
|
|
39
|
+
# {Sentdm::Models::MessageEvent} for more details.
|
|
40
|
+
#
|
|
41
|
+
# The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
|
|
42
|
+
# this shape and varies only in Payload.
|
|
43
|
+
#
|
|
44
|
+
# @param event [String, nil] The specific event within the family, for example message.delivered or
|
|
45
|
+
#
|
|
46
|
+
# @param field [String] The event family, for example message or templates. Route on this first, then
|
|
47
|
+
#
|
|
48
|
+
# @param payload [Sentdm::Models::MessageEventPayload, nil] Body of an outbound message lifecycle event. Delivered once per status change, s
|
|
49
|
+
#
|
|
50
|
+
# @param timestamp [String] When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ). This is the emission
|
|
51
|
+
end
|
|
52
|
+
end
|
|
53
|
+
end
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
class MessageEventPayload < Sentdm::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute account_id
|
|
7
|
+
# The account the message belongs to.
|
|
8
|
+
#
|
|
9
|
+
# @return [String, nil]
|
|
10
|
+
optional :account_id, String
|
|
11
|
+
|
|
12
|
+
# @!attribute agent_id
|
|
13
|
+
# The agent attributed to the send, when the send was attributed to one.
|
|
14
|
+
#
|
|
15
|
+
# @return [String, nil]
|
|
16
|
+
optional :agent_id, String, nil?: true
|
|
17
|
+
|
|
18
|
+
# @!attribute channel
|
|
19
|
+
# The channel the message went out on, for example sms or whatsapp. A message that
|
|
20
|
+
# falls back to another channel reports the channel actually used.
|
|
21
|
+
#
|
|
22
|
+
# @return [String, nil]
|
|
23
|
+
optional :channel, String
|
|
24
|
+
|
|
25
|
+
# @!attribute message_id
|
|
26
|
+
# The message this event describes. Stable across every event in the message's
|
|
27
|
+
# lifecycle, so use it to correlate them.
|
|
28
|
+
#
|
|
29
|
+
# @return [String, nil]
|
|
30
|
+
optional :message_id, String
|
|
31
|
+
|
|
32
|
+
# @!attribute message_status
|
|
33
|
+
# The status the message just reached, for example SENT, DELIVERED, or FAILED.
|
|
34
|
+
# Sent means dispatched and delivered means confirmed, so treat them as distinct
|
|
35
|
+
# outcomes.
|
|
36
|
+
#
|
|
37
|
+
# @return [String, nil]
|
|
38
|
+
optional :message_status, String
|
|
39
|
+
|
|
40
|
+
# @!attribute outbound_number
|
|
41
|
+
# The recipient's number in E.164 format.
|
|
42
|
+
#
|
|
43
|
+
# @return [String, nil]
|
|
44
|
+
optional :outbound_number, String
|
|
45
|
+
|
|
46
|
+
# @!attribute template_id
|
|
47
|
+
# The template the message was sent from, when it was sent from one.
|
|
48
|
+
#
|
|
49
|
+
# @return [String, nil]
|
|
50
|
+
optional :template_id, String, nil?: true
|
|
51
|
+
|
|
52
|
+
# @!attribute template_name
|
|
53
|
+
# Name of the template the message was sent from. Omitted when the message wasn't
|
|
54
|
+
# template-based.
|
|
55
|
+
#
|
|
56
|
+
# @return [String, nil]
|
|
57
|
+
optional :template_name, String, nil?: true
|
|
58
|
+
|
|
59
|
+
# @!attribute updated_at
|
|
60
|
+
# When the message reached MessageStatus, in UTC (yyyy-MM-ddTHH:mm:ssZ).
|
|
61
|
+
#
|
|
62
|
+
# @return [String, nil]
|
|
63
|
+
optional :updated_at, String
|
|
64
|
+
|
|
65
|
+
# @!method initialize(account_id: nil, agent_id: nil, channel: nil, message_id: nil, message_status: nil, outbound_number: nil, template_id: nil, template_name: nil, updated_at: nil)
|
|
66
|
+
# Some parameter documentations has been truncated, see
|
|
67
|
+
# {Sentdm::Models::MessageEventPayload} for more details.
|
|
68
|
+
#
|
|
69
|
+
# Body of an outbound message lifecycle event. Delivered once per status change,
|
|
70
|
+
# so a single message produces several of these as it moves toward a terminal
|
|
71
|
+
# status.
|
|
72
|
+
#
|
|
73
|
+
# @param account_id [String] The account the message belongs to.
|
|
74
|
+
#
|
|
75
|
+
# @param agent_id [String, nil] The agent attributed to the send, when the send was attributed to one.
|
|
76
|
+
#
|
|
77
|
+
# @param channel [String] The channel the message went out on, for example sms or whatsapp. A message
|
|
78
|
+
#
|
|
79
|
+
# @param message_id [String] The message this event describes. Stable across every event in the message's lif
|
|
80
|
+
#
|
|
81
|
+
# @param message_status [String] The status the message just reached, for example SENT, DELIVERED, or
|
|
82
|
+
#
|
|
83
|
+
# @param outbound_number [String] The recipient's number in E.164 format.
|
|
84
|
+
#
|
|
85
|
+
# @param template_id [String, nil] The template the message was sent from, when it was sent from one.
|
|
86
|
+
#
|
|
87
|
+
# @param template_name [String, nil] Name of the template the message was sent from. Omitted when the message wasn't
|
|
88
|
+
#
|
|
89
|
+
# @param updated_at [String] When the message reached MessageStatus, in UTC
|
|
90
|
+
end
|
|
91
|
+
end
|
|
92
|
+
end
|
|
@@ -13,14 +13,14 @@ module Sentdm
|
|
|
13
13
|
# @!attribute error
|
|
14
14
|
# Error information
|
|
15
15
|
#
|
|
16
|
-
# @return [Sentdm::Models::
|
|
17
|
-
optional :error, -> { Sentdm::
|
|
16
|
+
# @return [Sentdm::Models::MessageRetrieveActivitiesResponse::Error, nil]
|
|
17
|
+
optional :error, -> { Sentdm::Models::MessageRetrieveActivitiesResponse::Error }, nil?: true
|
|
18
18
|
|
|
19
19
|
# @!attribute meta
|
|
20
20
|
# Request and response metadata
|
|
21
21
|
#
|
|
22
|
-
# @return [Sentdm::Models::
|
|
23
|
-
optional :meta, -> { Sentdm::
|
|
22
|
+
# @return [Sentdm::Models::MessageRetrieveActivitiesResponse::Meta, nil]
|
|
23
|
+
optional :meta, -> { Sentdm::Models::MessageRetrieveActivitiesResponse::Meta }
|
|
24
24
|
|
|
25
25
|
# @!attribute success
|
|
26
26
|
# Indicates whether the request was successful
|
|
@@ -33,9 +33,9 @@ module Sentdm
|
|
|
33
33
|
#
|
|
34
34
|
# @param data [Sentdm::Models::MessageRetrieveActivitiesResponse::Data, nil] Response for GET /messages/{id}/activities
|
|
35
35
|
#
|
|
36
|
-
# @param error [Sentdm::Models::
|
|
36
|
+
# @param error [Sentdm::Models::MessageRetrieveActivitiesResponse::Error, nil] Error information
|
|
37
37
|
#
|
|
38
|
-
# @param meta [Sentdm::Models::
|
|
38
|
+
# @param meta [Sentdm::Models::MessageRetrieveActivitiesResponse::Meta] Request and response metadata
|
|
39
39
|
#
|
|
40
40
|
# @param success [Boolean] Indicates whether the request was successful
|
|
41
41
|
|
|
@@ -54,12 +54,20 @@ module Sentdm
|
|
|
54
54
|
# @return [String, nil]
|
|
55
55
|
optional :message_id, String
|
|
56
56
|
|
|
57
|
-
# @!
|
|
57
|
+
# @!attribute pagination
|
|
58
|
+
# Pagination metadata for list responses
|
|
59
|
+
#
|
|
60
|
+
# @return [Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Pagination, nil]
|
|
61
|
+
optional :pagination, -> { Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Pagination }
|
|
62
|
+
|
|
63
|
+
# @!method initialize(activities: nil, message_id: nil, pagination: nil)
|
|
58
64
|
# Response for GET /messages/{id}/activities
|
|
59
65
|
#
|
|
60
66
|
# @param activities [Array<Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Activity>] List of activity events ordered by most recent first
|
|
61
67
|
#
|
|
62
68
|
# @param message_id [String] The message ID these activities belong to
|
|
69
|
+
#
|
|
70
|
+
# @param pagination [Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Pagination] Pagination metadata for list responses
|
|
63
71
|
|
|
64
72
|
class Activity < Sentdm::Internal::Type::BaseModel
|
|
65
73
|
# @!attribute active_contact_price
|
|
@@ -122,6 +130,156 @@ module Sentdm
|
|
|
122
130
|
#
|
|
123
131
|
# @param timestamp [Time] When this activity occurred
|
|
124
132
|
end
|
|
133
|
+
|
|
134
|
+
# @see Sentdm::Models::MessageRetrieveActivitiesResponse::Data#pagination
|
|
135
|
+
class Pagination < Sentdm::Internal::Type::BaseModel
|
|
136
|
+
# @!attribute cursors
|
|
137
|
+
# @deprecated
|
|
138
|
+
#
|
|
139
|
+
# Cursor-based pagination. Never populated — see Cursors.
|
|
140
|
+
#
|
|
141
|
+
# @return [Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Pagination::Cursors, nil]
|
|
142
|
+
optional :cursors,
|
|
143
|
+
-> { Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Pagination::Cursors },
|
|
144
|
+
nil?: true
|
|
145
|
+
|
|
146
|
+
# @!attribute has_more
|
|
147
|
+
# Whether there are more pages after this one
|
|
148
|
+
#
|
|
149
|
+
# @return [Boolean, nil]
|
|
150
|
+
optional :has_more, Sentdm::Internal::Type::Boolean
|
|
151
|
+
|
|
152
|
+
# @!attribute page
|
|
153
|
+
# Current page number (1-indexed)
|
|
154
|
+
#
|
|
155
|
+
# @return [Integer, nil]
|
|
156
|
+
optional :page, Integer
|
|
157
|
+
|
|
158
|
+
# @!attribute page_size
|
|
159
|
+
# Number of items per page
|
|
160
|
+
#
|
|
161
|
+
# @return [Integer, nil]
|
|
162
|
+
optional :page_size, Integer
|
|
163
|
+
|
|
164
|
+
# @!attribute total_count
|
|
165
|
+
# Total number of items across all pages
|
|
166
|
+
#
|
|
167
|
+
# @return [Integer, nil]
|
|
168
|
+
optional :total_count, Integer
|
|
169
|
+
|
|
170
|
+
# @!attribute total_pages
|
|
171
|
+
# Total number of pages
|
|
172
|
+
#
|
|
173
|
+
# @return [Integer, nil]
|
|
174
|
+
optional :total_pages, Integer
|
|
175
|
+
|
|
176
|
+
# @!method initialize(cursors: nil, has_more: nil, page: nil, page_size: nil, total_count: nil, total_pages: nil)
|
|
177
|
+
# Pagination metadata for list responses
|
|
178
|
+
#
|
|
179
|
+
# @param cursors [Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Pagination::Cursors, nil] Cursor-based pagination. Never populated — see Cursors.
|
|
180
|
+
#
|
|
181
|
+
# @param has_more [Boolean] Whether there are more pages after this one
|
|
182
|
+
#
|
|
183
|
+
# @param page [Integer] Current page number (1-indexed)
|
|
184
|
+
#
|
|
185
|
+
# @param page_size [Integer] Number of items per page
|
|
186
|
+
#
|
|
187
|
+
# @param total_count [Integer] Total number of items across all pages
|
|
188
|
+
#
|
|
189
|
+
# @param total_pages [Integer] Total number of pages
|
|
190
|
+
|
|
191
|
+
# @deprecated
|
|
192
|
+
#
|
|
193
|
+
# @see Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Pagination#cursors
|
|
194
|
+
class Cursors < Sentdm::Internal::Type::BaseModel
|
|
195
|
+
# @!attribute after
|
|
196
|
+
# Cursor to fetch the next page.
|
|
197
|
+
#
|
|
198
|
+
# @return [String, nil]
|
|
199
|
+
optional :after, String, nil?: true
|
|
200
|
+
|
|
201
|
+
# @!attribute before
|
|
202
|
+
# Cursor to fetch the previous page.
|
|
203
|
+
#
|
|
204
|
+
# @return [String, nil]
|
|
205
|
+
optional :before, String, nil?: true
|
|
206
|
+
|
|
207
|
+
# @!method initialize(after: nil, before: nil)
|
|
208
|
+
# Cursor-based pagination. Never populated — see Cursors.
|
|
209
|
+
#
|
|
210
|
+
# @param after [String, nil] Cursor to fetch the next page.
|
|
211
|
+
#
|
|
212
|
+
# @param before [String, nil] Cursor to fetch the previous page.
|
|
213
|
+
end
|
|
214
|
+
end
|
|
215
|
+
end
|
|
216
|
+
|
|
217
|
+
# @see Sentdm::Models::MessageRetrieveActivitiesResponse#error
|
|
218
|
+
class Error < Sentdm::Internal::Type::BaseModel
|
|
219
|
+
# @!attribute code
|
|
220
|
+
# Machine-readable error code (e.g., "RESOURCE_001")
|
|
221
|
+
#
|
|
222
|
+
# @return [String, nil]
|
|
223
|
+
optional :code, String
|
|
224
|
+
|
|
225
|
+
# @!attribute details
|
|
226
|
+
# Additional validation error details (field-level errors)
|
|
227
|
+
#
|
|
228
|
+
# @return [Hash{Symbol=>Array<String>}, nil]
|
|
229
|
+
optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
|
|
230
|
+
|
|
231
|
+
# @!attribute doc_url
|
|
232
|
+
# URL to documentation about this error
|
|
233
|
+
#
|
|
234
|
+
# @return [String, nil]
|
|
235
|
+
optional :doc_url, String, nil?: true
|
|
236
|
+
|
|
237
|
+
# @!attribute message
|
|
238
|
+
# Human-readable error message
|
|
239
|
+
#
|
|
240
|
+
# @return [String, nil]
|
|
241
|
+
optional :message, String
|
|
242
|
+
|
|
243
|
+
# @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
|
|
244
|
+
# Error information
|
|
245
|
+
#
|
|
246
|
+
# @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
|
|
247
|
+
#
|
|
248
|
+
# @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
|
|
249
|
+
#
|
|
250
|
+
# @param doc_url [String, nil] URL to documentation about this error
|
|
251
|
+
#
|
|
252
|
+
# @param message [String] Human-readable error message
|
|
253
|
+
end
|
|
254
|
+
|
|
255
|
+
# @see Sentdm::Models::MessageRetrieveActivitiesResponse#meta
|
|
256
|
+
class Meta < Sentdm::Internal::Type::BaseModel
|
|
257
|
+
# @!attribute request_id
|
|
258
|
+
# Unique identifier for this request (for tracing and support)
|
|
259
|
+
#
|
|
260
|
+
# @return [String, nil]
|
|
261
|
+
optional :request_id, String
|
|
262
|
+
|
|
263
|
+
# @!attribute timestamp
|
|
264
|
+
# Server timestamp when the response was generated
|
|
265
|
+
#
|
|
266
|
+
# @return [Time, nil]
|
|
267
|
+
optional :timestamp, Time
|
|
268
|
+
|
|
269
|
+
# @!attribute version
|
|
270
|
+
# API version used for this request
|
|
271
|
+
#
|
|
272
|
+
# @return [String, nil]
|
|
273
|
+
optional :version, String
|
|
274
|
+
|
|
275
|
+
# @!method initialize(request_id: nil, timestamp: nil, version: nil)
|
|
276
|
+
# Request and response metadata
|
|
277
|
+
#
|
|
278
|
+
# @param request_id [String] Unique identifier for this request (for tracing and support)
|
|
279
|
+
#
|
|
280
|
+
# @param timestamp [Time] Server timestamp when the response was generated
|
|
281
|
+
#
|
|
282
|
+
# @param version [String] API version used for this request
|
|
125
283
|
end
|
|
126
284
|
end
|
|
127
285
|
end
|