sentdm 0.28.0 → 0.30.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 +19 -0
- data/README.md +27 -1
- data/lib/sentdm/internal/type/base_model.rb +5 -5
- data/lib/sentdm/models/api_meta.rb +34 -0
- data/lib/sentdm/models/api_response_of_contact.rb +46 -0
- data/lib/sentdm/models/api_response_of_contact_message_summary.rb +43 -0
- data/lib/sentdm/models/api_response_of_conversation_messages_list.rb +43 -0
- data/lib/sentdm/models/api_response_of_profile_detail.rb +43 -0
- data/lib/sentdm/models/api_response_of_user.rb +43 -0
- data/lib/sentdm/models/api_response_template.rb +43 -0
- data/lib/sentdm/models/api_response_webhook.rb +43 -0
- data/lib/sentdm/models/billing_contact_info.rb +47 -0
- data/lib/sentdm/models/brand_business_info.rb +114 -0
- data/lib/sentdm/models/brand_compliance_info.rb +59 -0
- data/lib/sentdm/models/brand_contact_info.rb +58 -0
- data/lib/sentdm/models/brands_brand_data.rb +34 -0
- data/lib/sentdm/models/contact_delete_params.rb +2 -16
- data/lib/sentdm/models/contact_list_response.rb +12 -295
- data/lib/sentdm/models/contact_message_summary.rb +76 -0
- data/lib/sentdm/models/contact_response.rb +139 -0
- data/lib/sentdm/models/conversation_messages_list.rb +245 -0
- data/lib/sentdm/models/error_detail.rb +42 -0
- data/lib/sentdm/models/inbound_message_event_payload.rb +17 -17
- data/lib/sentdm/models/me_retrieve_response.rb +43 -243
- data/lib/sentdm/models/message_event_payload.rb +11 -11
- data/lib/sentdm/models/message_retrieve_activities_response.rb +9 -159
- data/lib/sentdm/models/message_retrieve_status_response.rb +6 -74
- data/lib/sentdm/models/message_send_response.rb +6 -74
- data/lib/sentdm/models/mutation_request.rb +20 -0
- data/lib/sentdm/models/number_lookup_response.rb +6 -74
- data/lib/sentdm/models/pagination_meta.rb +84 -0
- data/lib/sentdm/models/payment_details.rb +40 -0
- data/lib/sentdm/models/profile_complete_response.rb +6 -74
- data/lib/sentdm/models/profile_create_params.rb +9 -345
- data/lib/sentdm/models/profile_delete_params.rb +2 -16
- data/lib/sentdm/models/profile_detail.rb +650 -0
- data/lib/sentdm/models/profile_list_response.rb +12 -815
- data/lib/sentdm/models/profile_settings.rb +85 -0
- data/lib/sentdm/models/profile_update_params.rb +9 -345
- data/lib/sentdm/models/profiles/api_response_of_brand_campaign.rb +45 -0
- data/lib/sentdm/models/profiles/api_response_of_list_of_brand_campaign.rb +45 -0
- data/lib/sentdm/models/profiles/brand_campaign.rb +247 -0
- data/lib/sentdm/models/profiles/campaign_create_params.rb +3 -156
- data/lib/sentdm/models/profiles/campaign_data.rb +136 -0
- data/lib/sentdm/models/profiles/campaign_delete_params.rb +2 -17
- data/lib/sentdm/models/profiles/campaign_update_params.rb +3 -156
- data/lib/sentdm/models/profiles/campaign_use_case.rb +71 -0
- data/lib/sentdm/models/profiles/campaign_use_case_data.rb +29 -0
- data/lib/sentdm/models/template.rb +102 -0
- data/lib/sentdm/models/template_event_payload.rb +18 -18
- data/lib/sentdm/models/template_list_response.rb +12 -258
- data/lib/sentdm/models/user_list_response.rb +12 -249
- data/lib/sentdm/models/user_remove_params.rb +2 -16
- data/lib/sentdm/models/user_response.rb +94 -0
- data/lib/sentdm/models/webhook_event_type.rb +45 -0
- data/lib/sentdm/models/webhook_list_event_types_response.rb +12 -203
- data/lib/sentdm/models/webhook_list_events_response.rb +9 -157
- data/lib/sentdm/models/webhook_list_response.rb +12 -276
- data/lib/sentdm/models/webhook_response.rb +120 -0
- data/lib/sentdm/models/webhook_rotate_secret_params.rb +2 -17
- data/lib/sentdm/models/webhook_rotate_secret_response.rb +6 -74
- data/lib/sentdm/models/webhook_test_response.rb +6 -74
- data/lib/sentdm/models.rb +52 -0
- data/lib/sentdm/resources/contacts.rb +8 -8
- data/lib/sentdm/resources/conversations.rb +4 -4
- data/lib/sentdm/resources/me.rb +11 -0
- data/lib/sentdm/resources/profiles/campaigns.rb +8 -8
- data/lib/sentdm/resources/profiles.rb +12 -12
- data/lib/sentdm/resources/templates.rb +6 -6
- 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 +32 -22
- data/rbi/sentdm/models/api_meta.rbi +55 -0
- data/rbi/sentdm/models/api_response_of_contact.rbi +74 -0
- data/rbi/sentdm/models/api_response_of_contact_message_summary.rbi +79 -0
- data/rbi/sentdm/models/api_response_of_conversation_messages_list.rbi +79 -0
- data/rbi/sentdm/models/api_response_of_profile_detail.rbi +74 -0
- data/rbi/sentdm/models/api_response_of_user.rbi +74 -0
- data/rbi/sentdm/models/api_response_template.rbi +74 -0
- data/rbi/sentdm/models/api_response_webhook.rbi +74 -0
- data/rbi/sentdm/models/billing_contact_info.rbi +65 -0
- data/rbi/sentdm/models/brand_business_info.rbi +162 -0
- data/rbi/sentdm/models/brand_compliance_info.rbi +76 -0
- data/rbi/sentdm/models/brand_contact_info.rbi +78 -0
- data/rbi/sentdm/models/brands_brand_data.rbi +65 -0
- data/rbi/sentdm/models/contact_delete_params.rbi +2 -19
- data/rbi/sentdm/models/contact_list_response.rbi +16 -522
- data/rbi/sentdm/models/contact_message_summary.rbi +144 -0
- data/rbi/sentdm/models/contact_response.rbi +200 -0
- data/rbi/sentdm/models/conversation_messages_list.rbi +419 -0
- data/rbi/sentdm/models/error_detail.rbi +66 -0
- data/rbi/sentdm/models/inbound_message_event_payload.rbi +16 -22
- data/rbi/sentdm/models/me_retrieve_response.rbi +60 -367
- data/rbi/sentdm/models/message_event_payload.rbi +12 -15
- data/rbi/sentdm/models/message_retrieve_activities_response.rbi +12 -325
- data/rbi/sentdm/models/message_retrieve_status_response.rbi +8 -148
- data/rbi/sentdm/models/message_send_response.rbi +8 -135
- data/rbi/sentdm/models/mutation_request.rbi +32 -0
- data/rbi/sentdm/models/number_lookup_response.rbi +8 -135
- data/rbi/sentdm/models/pagination_meta.rbi +135 -0
- data/rbi/sentdm/models/payment_details.rbi +56 -0
- data/rbi/sentdm/models/profile_complete_response.rbi +8 -137
- data/rbi/sentdm/models/profile_create_params.rbi +12 -546
- data/rbi/sentdm/models/profile_delete_params.rbi +2 -19
- data/rbi/sentdm/models/profile_detail.rbi +918 -0
- data/rbi/sentdm/models/profile_list_response.rbi +16 -1347
- data/rbi/sentdm/models/profile_settings.rbi +102 -0
- data/rbi/sentdm/models/profile_update_params.rbi +12 -546
- data/rbi/sentdm/models/profiles/api_response_of_brand_campaign.rbi +81 -0
- data/rbi/sentdm/models/profiles/api_response_of_list_of_brand_campaign.rbi +76 -0
- data/rbi/sentdm/models/profiles/brand_campaign.rbi +299 -0
- data/rbi/sentdm/models/profiles/campaign_create_params.rbi +4 -218
- data/rbi/sentdm/models/profiles/campaign_data.rbi +158 -0
- data/rbi/sentdm/models/profiles/campaign_delete_params.rbi +1 -14
- data/rbi/sentdm/models/profiles/campaign_update_params.rbi +4 -218
- data/rbi/sentdm/models/profiles/campaign_use_case.rbi +110 -0
- data/rbi/sentdm/models/profiles/campaign_use_case_data.rbi +51 -0
- data/rbi/sentdm/models/template.rbi +139 -0
- data/rbi/sentdm/models/template_event_payload.rbi +21 -27
- data/rbi/sentdm/models/template_list_response.rbi +16 -464
- data/rbi/sentdm/models/user_list_response.rbi +16 -444
- data/rbi/sentdm/models/user_remove_params.rbi +2 -19
- data/rbi/sentdm/models/user_response.rbi +131 -0
- data/rbi/sentdm/models/webhook_event_type.rbi +74 -0
- data/rbi/sentdm/models/webhook_list_event_types_response.rbi +16 -414
- data/rbi/sentdm/models/webhook_list_events_response.rbi +12 -314
- data/rbi/sentdm/models/webhook_list_response.rbi +16 -475
- data/rbi/sentdm/models/webhook_response.rbi +153 -0
- data/rbi/sentdm/models/webhook_rotate_secret_params.rbi +1 -14
- data/rbi/sentdm/models/webhook_rotate_secret_response.rbi +8 -148
- data/rbi/sentdm/models/webhook_test_response.rbi +8 -135
- data/rbi/sentdm/models.rbi +54 -0
- data/rbi/sentdm/resources/contacts.rbi +4 -4
- data/rbi/sentdm/resources/conversations.rbi +2 -2
- data/rbi/sentdm/resources/me.rbi +11 -0
- data/rbi/sentdm/resources/profiles/campaigns.rbi +5 -5
- data/rbi/sentdm/resources/profiles.rbi +9 -13
- data/rbi/sentdm/resources/templates.rbi +3 -3
- data/rbi/sentdm/resources/users.rbi +3 -3
- data/rbi/sentdm/resources/webhooks.rbi +4 -4
- data/sig/sentdm/models/api_meta.rbs +27 -0
- data/sig/sentdm/models/api_response_of_contact.rbs +39 -0
- data/sig/sentdm/models/api_response_of_contact_message_summary.rbs +39 -0
- data/sig/sentdm/models/api_response_of_conversation_messages_list.rbs +39 -0
- data/sig/sentdm/models/api_response_of_profile_detail.rbs +39 -0
- data/sig/sentdm/models/api_response_of_user.rbs +39 -0
- data/sig/sentdm/models/api_response_template.rbs +39 -0
- data/sig/sentdm/models/api_response_webhook.rbs +39 -0
- data/sig/sentdm/models/billing_contact_info.rbs +30 -0
- data/sig/sentdm/models/brand_business_info.rbs +89 -0
- data/sig/sentdm/models/brand_compliance_info.rbs +45 -0
- data/sig/sentdm/models/brand_contact_info.rbs +45 -0
- data/sig/sentdm/models/brands_brand_data.rbs +30 -0
- data/sig/sentdm/models/contact_delete_params.rbs +6 -10
- data/sig/sentdm/models/contact_list_response.rbs +20 -263
- data/sig/sentdm/models/contact_message_summary.rbs +84 -0
- data/sig/sentdm/models/contact_response.rbs +118 -0
- data/sig/sentdm/models/conversation_messages_list.rbs +240 -0
- data/sig/sentdm/models/error_detail.rbs +39 -0
- data/sig/sentdm/models/inbound_message_event_payload.rbs +10 -14
- data/sig/sentdm/models/me_retrieve_response.rbs +28 -176
- data/sig/sentdm/models/message_event_payload.rbs +5 -7
- data/sig/sentdm/models/message_retrieve_activities_response.rbs +14 -142
- data/sig/sentdm/models/message_retrieve_status_response.rbs +9 -71
- data/sig/sentdm/models/message_send_response.rbs +9 -71
- data/sig/sentdm/models/mutation_request.rbs +15 -0
- data/sig/sentdm/models/number_lookup_response.rbs +9 -71
- data/sig/sentdm/models/pagination_meta.rbs +67 -0
- data/sig/sentdm/models/payment_details.rbs +30 -0
- data/sig/sentdm/models/profile_complete_response.rbs +9 -71
- data/sig/sentdm/models/profile_create_params.rbs +12 -263
- data/sig/sentdm/models/profile_delete_params.rbs +6 -10
- data/sig/sentdm/models/profile_detail.rbs +461 -0
- data/sig/sentdm/models/profile_list_response.rbs +20 -606
- data/sig/sentdm/models/profile_settings.rbs +50 -0
- data/sig/sentdm/models/profile_update_params.rbs +12 -263
- data/sig/sentdm/models/profiles/api_response_of_brand_campaign.rbs +41 -0
- data/sig/sentdm/models/profiles/api_response_of_list_of_brand_campaign.rbs +41 -0
- data/sig/sentdm/models/profiles/brand_campaign.rbs +194 -0
- data/sig/sentdm/models/profiles/campaign_create_params.rbs +4 -108
- data/sig/sentdm/models/profiles/campaign_data.rbs +87 -0
- data/sig/sentdm/models/profiles/campaign_delete_params.rbs +8 -15
- data/sig/sentdm/models/profiles/campaign_update_params.rbs +4 -108
- data/sig/sentdm/models/profiles/campaign_use_case.rbs +66 -0
- data/sig/sentdm/models/profiles/campaign_use_case_data.rbs +27 -0
- data/sig/sentdm/models/template.rbs +84 -0
- data/sig/sentdm/models/template_event_payload.rbs +13 -17
- data/sig/sentdm/models/template_list_response.rbs +19 -230
- data/sig/sentdm/models/user_list_response.rbs +20 -224
- data/sig/sentdm/models/user_remove_params.rbs +6 -10
- data/sig/sentdm/models/user_response.rbs +79 -0
- data/sig/sentdm/models/webhook_event_type.rbs +51 -0
- data/sig/sentdm/models/webhook_list_event_types_response.rbs +20 -196
- data/sig/sentdm/models/webhook_list_events_response.rbs +14 -142
- data/sig/sentdm/models/webhook_list_response.rbs +20 -255
- data/sig/sentdm/models/webhook_response.rbs +110 -0
- data/sig/sentdm/models/webhook_rotate_secret_params.rbs +8 -17
- data/sig/sentdm/models/webhook_rotate_secret_response.rbs +9 -71
- data/sig/sentdm/models/webhook_test_response.rbs +9 -71
- data/sig/sentdm/models.rbs +52 -0
- 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 +9 -9
- 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 +98 -68
- data/lib/sentdm/models/contact_create_response.rb +0 -249
- data/lib/sentdm/models/contact_retrieve_message_summary_response.rb +0 -186
- data/lib/sentdm/models/contact_retrieve_response.rb +0 -249
- data/lib/sentdm/models/contact_update_response.rb +0 -249
- data/lib/sentdm/models/conversation_list_messages_response.rb +0 -436
- data/lib/sentdm/models/conversation_list_response.rb +0 -433
- data/lib/sentdm/models/profile_create_response.rb +0 -760
- data/lib/sentdm/models/profile_retrieve_response.rb +0 -762
- data/lib/sentdm/models/profile_update_response.rb +0 -760
- data/lib/sentdm/models/profiles/campaign_create_response.rb +0 -420
- data/lib/sentdm/models/profiles/campaign_list_response.rb +0 -421
- data/lib/sentdm/models/profiles/campaign_update_response.rb +0 -420
- data/lib/sentdm/models/template_create_response.rb +0 -209
- data/lib/sentdm/models/template_retrieve_response.rb +0 -209
- data/lib/sentdm/models/template_update_response.rb +0 -209
- data/lib/sentdm/models/user_invite_response.rb +0 -201
- data/lib/sentdm/models/user_retrieve_response.rb +0 -201
- data/lib/sentdm/models/user_update_role_response.rb +0 -201
- data/lib/sentdm/models/webhook_create_response.rb +0 -229
- data/lib/sentdm/models/webhook_retrieve_response.rb +0 -229
- data/lib/sentdm/models/webhook_toggle_status_response.rb +0 -229
- data/lib/sentdm/models/webhook_update_response.rb +0 -229
- data/rbi/sentdm/models/contact_create_response.rbi +0 -407
- data/rbi/sentdm/models/contact_retrieve_message_summary_response.rbi +0 -397
- data/rbi/sentdm/models/contact_retrieve_response.rbi +0 -409
- data/rbi/sentdm/models/contact_update_response.rbi +0 -407
- data/rbi/sentdm/models/conversation_list_messages_response.rbi +0 -843
- data/rbi/sentdm/models/conversation_list_response.rbi +0 -819
- data/rbi/sentdm/models/profile_create_response.rbi +0 -1226
- data/rbi/sentdm/models/profile_retrieve_response.rbi +0 -1230
- data/rbi/sentdm/models/profile_update_response.rbi +0 -1226
- data/rbi/sentdm/models/profiles/campaign_create_response.rbi +0 -674
- data/rbi/sentdm/models/profiles/campaign_list_response.rbi +0 -667
- data/rbi/sentdm/models/profiles/campaign_update_response.rbi +0 -674
- data/rbi/sentdm/models/template_create_response.rbi +0 -349
- data/rbi/sentdm/models/template_retrieve_response.rbi +0 -355
- data/rbi/sentdm/models/template_update_response.rbi +0 -349
- data/rbi/sentdm/models/user_invite_response.rbi +0 -336
- data/rbi/sentdm/models/user_retrieve_response.rbi +0 -336
- data/rbi/sentdm/models/user_update_role_response.rbi +0 -341
- data/rbi/sentdm/models/webhook_create_response.rbi +0 -361
- data/rbi/sentdm/models/webhook_retrieve_response.rbi +0 -363
- data/rbi/sentdm/models/webhook_toggle_status_response.rbi +0 -379
- data/rbi/sentdm/models/webhook_update_response.rbi +0 -361
- data/sig/sentdm/models/contact_create_response.rbs +0 -216
- data/sig/sentdm/models/contact_retrieve_message_summary_response.rbs +0 -182
- data/sig/sentdm/models/contact_retrieve_response.rbs +0 -216
- data/sig/sentdm/models/contact_update_response.rbs +0 -216
- data/sig/sentdm/models/conversation_list_messages_response.rbs +0 -404
- data/sig/sentdm/models/conversation_list_response.rbs +0 -404
- data/sig/sentdm/models/profile_create_response.rbs +0 -559
- data/sig/sentdm/models/profile_retrieve_response.rbs +0 -559
- data/sig/sentdm/models/profile_update_response.rbs +0 -559
- data/sig/sentdm/models/profiles/campaign_create_response.rbs +0 -357
- data/sig/sentdm/models/profiles/campaign_list_response.rbs +0 -357
- data/sig/sentdm/models/profiles/campaign_update_response.rbs +0 -357
- data/sig/sentdm/models/template_create_response.rbs +0 -182
- data/sig/sentdm/models/template_retrieve_response.rbs +0 -182
- data/sig/sentdm/models/template_update_response.rbs +0 -182
- data/sig/sentdm/models/user_invite_response.rbs +0 -177
- data/sig/sentdm/models/user_retrieve_response.rbs +0 -177
- data/sig/sentdm/models/user_update_role_response.rbs +0 -177
- data/sig/sentdm/models/webhook_create_response.rbs +0 -208
- data/sig/sentdm/models/webhook_retrieve_response.rbs +0 -208
- data/sig/sentdm/models/webhook_toggle_status_response.rbs +0 -208
- data/sig/sentdm/models/webhook_update_response.rbs +0 -208
|
@@ -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::ErrorDetail, nil]
|
|
19
|
+
optional :error, -> { Sentdm::ErrorDetail }, 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::APIMeta, nil]
|
|
25
|
+
optional :meta, -> { Sentdm::APIMeta }
|
|
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::ErrorDetail, nil] Error information
|
|
42
42
|
#
|
|
43
|
-
# @param meta [Sentdm::Models::
|
|
43
|
+
# @param meta [Sentdm::Models::APIMeta] Request and response metadata
|
|
44
44
|
#
|
|
45
45
|
# @param success [Boolean] Indicates whether the request was successful
|
|
46
46
|
|
|
@@ -103,11 +103,37 @@ module Sentdm
|
|
|
103
103
|
optional :profiles,
|
|
104
104
|
-> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::MeRetrieveResponse::Data::Profile] }
|
|
105
105
|
|
|
106
|
+
# @!attribute sending_phone_number
|
|
107
|
+
# The SMS sender this account sends from in the United States, in E.164 form. Null
|
|
108
|
+
# when the account has no US SMS sender.
|
|
109
|
+
#
|
|
110
|
+
# The same value as channels.sms.phone_number, published under both names on
|
|
111
|
+
# purpose: sending_phone_number is what this value is already called on GET
|
|
112
|
+
# /v3/profiles, so the same key answers the same question whichever of the two
|
|
113
|
+
# endpoints you ask. Neither name is preferred over the other and neither is
|
|
114
|
+
# deprecated.
|
|
115
|
+
#
|
|
116
|
+
# The same value, not the same presence: this key is always written, including as
|
|
117
|
+
# null, whereas channels.sms.phone_number is left out entirely when there is no
|
|
118
|
+
# sender.
|
|
119
|
+
#
|
|
120
|
+
# @return [String, nil]
|
|
121
|
+
optional :sending_phone_number, String, nil?: true
|
|
122
|
+
|
|
123
|
+
# @!attribute sending_phone_number_profile_id
|
|
124
|
+
# The account that holds sending_phone_number in number inventory: normally this
|
|
125
|
+
# account itself, and a different account when the number is held elsewhere. Null
|
|
126
|
+
# when there is no US sender, or when the sender is not a number drawn from
|
|
127
|
+
# inventory — an alphanumeric sender ID or a short code.
|
|
128
|
+
#
|
|
129
|
+
# @return [String, nil]
|
|
130
|
+
optional :sending_phone_number_profile_id, String, nil?: true
|
|
131
|
+
|
|
106
132
|
# @!attribute settings
|
|
107
133
|
# Profile configuration settings
|
|
108
134
|
#
|
|
109
|
-
# @return [Sentdm::Models::
|
|
110
|
-
optional :settings, -> { Sentdm::
|
|
135
|
+
# @return [Sentdm::Models::ProfileSettings, nil]
|
|
136
|
+
optional :settings, -> { Sentdm::ProfileSettings }, nil?: true
|
|
111
137
|
|
|
112
138
|
# @!attribute short_name
|
|
113
139
|
# Short name / abbreviation (only for profile type)
|
|
@@ -129,7 +155,7 @@ module Sentdm
|
|
|
129
155
|
# @return [String, nil]
|
|
130
156
|
optional :type, String
|
|
131
157
|
|
|
132
|
-
# @!method initialize(id: nil, channels: nil, created_at: nil, description: nil, email: nil, icon: nil, name: nil, organization_id: nil, profiles: nil, settings: nil, short_name: nil, status: nil, type: nil)
|
|
158
|
+
# @!method initialize(id: nil, channels: nil, created_at: nil, description: nil, email: nil, icon: nil, name: nil, organization_id: nil, profiles: nil, sending_phone_number: nil, sending_phone_number_profile_id: nil, settings: nil, short_name: nil, status: nil, type: nil)
|
|
133
159
|
# Some parameter documentations has been truncated, see
|
|
134
160
|
# {Sentdm::Models::MeRetrieveResponse::Data} for more details.
|
|
135
161
|
#
|
|
@@ -155,7 +181,11 @@ module Sentdm
|
|
|
155
181
|
#
|
|
156
182
|
# @param profiles [Array<Sentdm::Models::MeRetrieveResponse::Data::Profile>] List of profiles (populated for organization type, empty for user and profile ty
|
|
157
183
|
#
|
|
158
|
-
# @param
|
|
184
|
+
# @param sending_phone_number [String, nil] The SMS sender this account sends from in the United States, in E.164 form. Null
|
|
185
|
+
#
|
|
186
|
+
# @param sending_phone_number_profile_id [String, nil] The account that holds sending_phone_number in number inventory: normally this a
|
|
187
|
+
#
|
|
188
|
+
# @param settings [Sentdm::Models::ProfileSettings, nil] Profile configuration settings
|
|
159
189
|
#
|
|
160
190
|
# @param short_name [String, nil] Short name / abbreviation (only for profile type)
|
|
161
191
|
#
|
|
@@ -314,8 +344,8 @@ module Sentdm
|
|
|
314
344
|
# @!attribute settings
|
|
315
345
|
# Profile configuration settings
|
|
316
346
|
#
|
|
317
|
-
# @return [Sentdm::Models::
|
|
318
|
-
optional :settings, -> { Sentdm::
|
|
347
|
+
# @return [Sentdm::Models::ProfileSettings, nil]
|
|
348
|
+
optional :settings, -> { Sentdm::ProfileSettings }
|
|
319
349
|
|
|
320
350
|
# @!attribute short_name
|
|
321
351
|
# Profile short name (abbreviation)
|
|
@@ -347,242 +377,12 @@ module Sentdm
|
|
|
347
377
|
#
|
|
348
378
|
# @param role [String, nil] User's role in this profile: admin, billing, developer (inherited from organizat
|
|
349
379
|
#
|
|
350
|
-
# @param settings [Sentdm::Models::
|
|
380
|
+
# @param settings [Sentdm::Models::ProfileSettings] Profile configuration settings
|
|
351
381
|
#
|
|
352
382
|
# @param short_name [String, nil] Profile short name (abbreviation)
|
|
353
383
|
#
|
|
354
384
|
# @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
|
|
436
385
|
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
|
|
586
386
|
end
|
|
587
387
|
end
|
|
588
388
|
end
|
|
@@ -3,6 +3,14 @@
|
|
|
3
3
|
module Sentdm
|
|
4
4
|
module Models
|
|
5
5
|
class MessageEventPayload < Sentdm::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute message_status
|
|
7
|
+
# The status the message just reached, for example SENT, DELIVERED, or FAILED.
|
|
8
|
+
# Sent means dispatched and delivered means confirmed, so treat them as distinct
|
|
9
|
+
# outcomes.
|
|
10
|
+
#
|
|
11
|
+
# @return [String]
|
|
12
|
+
required :message_status, String
|
|
13
|
+
|
|
6
14
|
# @!attribute account_id
|
|
7
15
|
# The account the message belongs to.
|
|
8
16
|
#
|
|
@@ -29,14 +37,6 @@ module Sentdm
|
|
|
29
37
|
# @return [String, nil]
|
|
30
38
|
optional :message_id, String
|
|
31
39
|
|
|
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
40
|
# @!attribute outbound_number
|
|
41
41
|
# The recipient's number in E.164 format.
|
|
42
42
|
#
|
|
@@ -62,7 +62,7 @@ module Sentdm
|
|
|
62
62
|
# @return [String, nil]
|
|
63
63
|
optional :updated_at, String
|
|
64
64
|
|
|
65
|
-
# @!method initialize(account_id: nil, agent_id: nil, channel: nil, message_id: nil,
|
|
65
|
+
# @!method initialize(message_status:, account_id: nil, agent_id: nil, channel: nil, message_id: nil, outbound_number: nil, template_id: nil, template_name: nil, updated_at: nil)
|
|
66
66
|
# Some parameter documentations has been truncated, see
|
|
67
67
|
# {Sentdm::Models::MessageEventPayload} for more details.
|
|
68
68
|
#
|
|
@@ -70,6 +70,8 @@ module Sentdm
|
|
|
70
70
|
# so a single message produces several of these as it moves toward a terminal
|
|
71
71
|
# status.
|
|
72
72
|
#
|
|
73
|
+
# @param message_status [String] The status the message just reached, for example SENT, DELIVERED, or
|
|
74
|
+
#
|
|
73
75
|
# @param account_id [String] The account the message belongs to.
|
|
74
76
|
#
|
|
75
77
|
# @param agent_id [String, nil] The agent attributed to the send, when the send was attributed to one.
|
|
@@ -78,8 +80,6 @@ module Sentdm
|
|
|
78
80
|
#
|
|
79
81
|
# @param message_id [String] The message this event describes. Stable across every event in the message's lif
|
|
80
82
|
#
|
|
81
|
-
# @param message_status [String] The status the message just reached, for example SENT, DELIVERED, or
|
|
82
|
-
#
|
|
83
83
|
# @param outbound_number [String] The recipient's number in E.164 format.
|
|
84
84
|
#
|
|
85
85
|
# @param template_id [String, nil] The template the message was sent from, when it was sent from one.
|
|
@@ -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::ErrorDetail, nil]
|
|
17
|
+
optional :error, -> { Sentdm::ErrorDetail }, 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::APIMeta, nil]
|
|
23
|
+
optional :meta, -> { Sentdm::APIMeta }
|
|
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::ErrorDetail, nil] Error information
|
|
37
37
|
#
|
|
38
|
-
# @param meta [Sentdm::Models::
|
|
38
|
+
# @param meta [Sentdm::Models::APIMeta] Request and response metadata
|
|
39
39
|
#
|
|
40
40
|
# @param success [Boolean] Indicates whether the request was successful
|
|
41
41
|
|
|
@@ -57,8 +57,8 @@ module Sentdm
|
|
|
57
57
|
# @!attribute pagination
|
|
58
58
|
# Pagination metadata for list responses
|
|
59
59
|
#
|
|
60
|
-
# @return [Sentdm::Models::
|
|
61
|
-
optional :pagination, -> { Sentdm::
|
|
60
|
+
# @return [Sentdm::Models::PaginationMeta, nil]
|
|
61
|
+
optional :pagination, -> { Sentdm::PaginationMeta }
|
|
62
62
|
|
|
63
63
|
# @!method initialize(activities: nil, message_id: nil, pagination: nil)
|
|
64
64
|
# Response for GET /messages/{id}/activities
|
|
@@ -67,7 +67,7 @@ module Sentdm
|
|
|
67
67
|
#
|
|
68
68
|
# @param message_id [String] The message ID these activities belong to
|
|
69
69
|
#
|
|
70
|
-
# @param pagination [Sentdm::Models::
|
|
70
|
+
# @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
|
|
71
71
|
|
|
72
72
|
class Activity < Sentdm::Internal::Type::BaseModel
|
|
73
73
|
# @!attribute active_contact_price
|
|
@@ -130,156 +130,6 @@ module Sentdm
|
|
|
130
130
|
#
|
|
131
131
|
# @param timestamp [Time] When this activity occurred
|
|
132
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
|
|
283
133
|
end
|
|
284
134
|
end
|
|
285
135
|
end
|