sentdm 0.29.0 → 0.31.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 +24 -0
- data/README.md +55 -1
- data/lib/sentdm/internal/contacts_page.rb +115 -0
- data/lib/sentdm/internal/conversations_page.rb +115 -0
- data/lib/sentdm/internal/templates_page.rb +115 -0
- data/lib/sentdm/internal/type/base_model.rb +5 -5
- data/lib/sentdm/internal/webhook_events_page.rb +115 -0
- data/lib/sentdm/internal/webhooks_page.rb +115 -0
- 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 +42 -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_params.rb +13 -13
- data/lib/sentdm/models/contact_message_summary.rb +76 -0
- data/lib/sentdm/models/contact_response.rb +140 -0
- data/lib/sentdm/models/conversation_list_messages_params.rb +5 -5
- data/lib/sentdm/models/conversation_list_params.rb +5 -5
- data/lib/sentdm/models/conversation_messages_list.rb +245 -0
- data/lib/sentdm/models/error_detail.rb +42 -0
- data/lib/sentdm/models/me_retrieve_response.rb +12 -242
- 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 +103 -0
- data/lib/sentdm/models/template_list_params.rb +17 -17
- 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_params.rb +5 -5
- data/lib/sentdm/models/webhook_list_events_response.rb +87 -295
- data/lib/sentdm/models/webhook_list_params.rb +11 -11
- data/lib/sentdm/models/webhook_response.rb +121 -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 +16 -15
- data/lib/sentdm/resources/conversations.rb +10 -8
- data/lib/sentdm/resources/profiles/campaigns.rb +8 -8
- data/lib/sentdm/resources/profiles.rb +12 -12
- data/lib/sentdm/resources/templates.rb +16 -15
- data/lib/sentdm/resources/users.rb +6 -6
- data/lib/sentdm/resources/webhooks.rb +20 -18
- data/lib/sentdm/version.rb +1 -1
- data/lib/sentdm.rb +37 -25
- data/rbi/sentdm/internal/contacts_page.rbi +71 -0
- data/rbi/sentdm/internal/conversations_page.rbi +71 -0
- data/rbi/sentdm/internal/templates_page.rbi +71 -0
- data/rbi/sentdm/internal/webhook_events_page.rbi +71 -0
- data/rbi/sentdm/internal/webhooks_page.rbi +71 -0
- 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_params.rbi +19 -13
- data/rbi/sentdm/models/contact_message_summary.rbi +144 -0
- data/rbi/sentdm/models/contact_response.rbi +200 -0
- data/rbi/sentdm/models/conversation_list_messages_params.rbi +12 -6
- data/rbi/sentdm/models/conversation_list_params.rbi +16 -5
- data/rbi/sentdm/models/conversation_messages_list.rbi +419 -0
- data/rbi/sentdm/models/error_detail.rbi +66 -0
- data/rbi/sentdm/models/me_retrieve_response.rbi +16 -367
- 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_list_params.rbi +22 -16
- 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_params.rbi +12 -6
- data/rbi/sentdm/models/webhook_list_events_response.rbi +113 -564
- data/rbi/sentdm/models/webhook_list_params.rbi +16 -10
- 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 +10 -10
- data/rbi/sentdm/resources/conversations.rbi +14 -6
- data/rbi/sentdm/resources/profiles/campaigns.rbi +5 -5
- data/rbi/sentdm/resources/profiles.rbi +9 -13
- data/rbi/sentdm/resources/templates.rbi +10 -10
- data/rbi/sentdm/resources/users.rbi +3 -3
- data/rbi/sentdm/resources/webhooks.rbi +16 -12
- data/sig/sentdm/internal/contacts_page.rbs +41 -0
- data/sig/sentdm/internal/conversations_page.rbs +41 -0
- data/sig/sentdm/internal/templates_page.rbs +44 -0
- data/sig/sentdm/internal/webhook_events_page.rbs +41 -0
- data/sig/sentdm/internal/webhooks_page.rbs +41 -0
- 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_params.rbs +11 -7
- data/sig/sentdm/models/contact_message_summary.rbs +84 -0
- data/sig/sentdm/models/contact_response.rbs +118 -0
- data/sig/sentdm/models/conversation_list_messages_params.rbs +8 -4
- data/sig/sentdm/models/conversation_list_params.rbs +8 -4
- data/sig/sentdm/models/conversation_messages_list.rbs +240 -0
- data/sig/sentdm/models/error_detail.rbs +39 -0
- data/sig/sentdm/models/me_retrieve_response.rbs +18 -176
- 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_list_params.rbs +14 -10
- 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_params.rbs +8 -4
- data/sig/sentdm/models/webhook_list_events_response.rbs +63 -255
- data/sig/sentdm/models/webhook_list_params.rbs +11 -7
- 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 +7 -7
- data/sig/sentdm/resources/conversations.rbs +6 -6
- data/sig/sentdm/resources/profiles/campaigns.rbs +5 -5
- data/sig/sentdm/resources/profiles.rbs +9 -9
- data/sig/sentdm/resources/templates.rbs +6 -6
- data/sig/sentdm/resources/users.rbs +3 -3
- data/sig/sentdm/resources/webhooks.rbs +10 -10
- metadata +113 -77
- data/lib/sentdm/models/contact_create_response.rb +0 -249
- data/lib/sentdm/models/contact_list_response.rb +0 -348
- 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_list_response.rb +0 -311
- 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_list_response.rb +0 -329
- 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_list_response.rbi +0 -634
- 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_list_response.rbi +0 -576
- 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_list_response.rbi +0 -587
- 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_list_response.rbs +0 -310
- 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_list_response.rbs +0 -276
- 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_list_response.rbs +0 -302
- 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
|
@@ -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::WebhookListEventTypesResponse::Data, nil] The webhook event types a customer can subscribe to.
|
|
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
|
|
|
@@ -44,212 +44,21 @@ module Sentdm
|
|
|
44
44
|
# @!attribute event_types
|
|
45
45
|
# The event_types on this page.
|
|
46
46
|
#
|
|
47
|
-
# @return [Array<Sentdm::Models::
|
|
48
|
-
optional :event_types,
|
|
49
|
-
-> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::WebhookListEventTypesResponse::Data::EventType] }
|
|
47
|
+
# @return [Array<Sentdm::Models::WebhookEventType>, nil]
|
|
48
|
+
optional :event_types, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::WebhookEventType] }
|
|
50
49
|
|
|
51
50
|
# @!attribute pagination
|
|
52
51
|
# Pagination metadata for list responses
|
|
53
52
|
#
|
|
54
|
-
# @return [Sentdm::Models::
|
|
55
|
-
optional :pagination, -> { Sentdm::
|
|
53
|
+
# @return [Sentdm::Models::PaginationMeta, nil]
|
|
54
|
+
optional :pagination, -> { Sentdm::PaginationMeta }
|
|
56
55
|
|
|
57
56
|
# @!method initialize(event_types: nil, pagination: nil)
|
|
58
57
|
# The webhook event types a customer can subscribe to.
|
|
59
58
|
#
|
|
60
|
-
# @param event_types [Array<Sentdm::Models::
|
|
59
|
+
# @param event_types [Array<Sentdm::Models::WebhookEventType>] The event_types on this page.
|
|
61
60
|
#
|
|
62
|
-
# @param pagination [Sentdm::Models::
|
|
63
|
-
|
|
64
|
-
class EventType < Sentdm::Internal::Type::BaseModel
|
|
65
|
-
# @!attribute description
|
|
66
|
-
#
|
|
67
|
-
# @return [String, nil]
|
|
68
|
-
optional :description, String, nil?: true
|
|
69
|
-
|
|
70
|
-
# @!attribute display_name
|
|
71
|
-
#
|
|
72
|
-
# @return [String, nil]
|
|
73
|
-
optional :display_name, String
|
|
74
|
-
|
|
75
|
-
# @!attribute event_type
|
|
76
|
-
#
|
|
77
|
-
# @return [String, nil]
|
|
78
|
-
optional :event_type, String, nil?: true
|
|
79
|
-
|
|
80
|
-
# @!attribute is_active
|
|
81
|
-
#
|
|
82
|
-
# @return [Boolean, nil]
|
|
83
|
-
optional :is_active, Sentdm::Internal::Type::Boolean
|
|
84
|
-
|
|
85
|
-
# @!attribute name
|
|
86
|
-
#
|
|
87
|
-
# @return [String, nil]
|
|
88
|
-
optional :name, String
|
|
89
|
-
|
|
90
|
-
# @!attribute sub_types
|
|
91
|
-
#
|
|
92
|
-
# @return [Array<Object>, nil]
|
|
93
|
-
optional :sub_types, Sentdm::Internal::Type::ArrayOf[Sentdm::Internal::Type::Unknown], nil?: true
|
|
94
|
-
|
|
95
|
-
# @!method initialize(description: nil, display_name: nil, event_type: nil, is_active: nil, name: nil, sub_types: nil)
|
|
96
|
-
# @param description [String, nil]
|
|
97
|
-
# @param display_name [String]
|
|
98
|
-
# @param event_type [String, nil]
|
|
99
|
-
# @param is_active [Boolean]
|
|
100
|
-
# @param name [String]
|
|
101
|
-
# @param sub_types [Array<Object>, nil]
|
|
102
|
-
end
|
|
103
|
-
|
|
104
|
-
# @see Sentdm::Models::WebhookListEventTypesResponse::Data#pagination
|
|
105
|
-
class Pagination < Sentdm::Internal::Type::BaseModel
|
|
106
|
-
# @!attribute cursors
|
|
107
|
-
# @deprecated
|
|
108
|
-
#
|
|
109
|
-
# Cursor-based pagination. Never populated — see Cursors.
|
|
110
|
-
#
|
|
111
|
-
# @return [Sentdm::Models::WebhookListEventTypesResponse::Data::Pagination::Cursors, nil]
|
|
112
|
-
optional :cursors,
|
|
113
|
-
-> { Sentdm::Models::WebhookListEventTypesResponse::Data::Pagination::Cursors },
|
|
114
|
-
nil?: true
|
|
115
|
-
|
|
116
|
-
# @!attribute has_more
|
|
117
|
-
# Whether there are more pages after this one
|
|
118
|
-
#
|
|
119
|
-
# @return [Boolean, nil]
|
|
120
|
-
optional :has_more, Sentdm::Internal::Type::Boolean
|
|
121
|
-
|
|
122
|
-
# @!attribute page
|
|
123
|
-
# Current page number (1-indexed)
|
|
124
|
-
#
|
|
125
|
-
# @return [Integer, nil]
|
|
126
|
-
optional :page, Integer
|
|
127
|
-
|
|
128
|
-
# @!attribute page_size
|
|
129
|
-
# Number of items per page
|
|
130
|
-
#
|
|
131
|
-
# @return [Integer, nil]
|
|
132
|
-
optional :page_size, Integer
|
|
133
|
-
|
|
134
|
-
# @!attribute total_count
|
|
135
|
-
# Total number of items across all pages
|
|
136
|
-
#
|
|
137
|
-
# @return [Integer, nil]
|
|
138
|
-
optional :total_count, Integer
|
|
139
|
-
|
|
140
|
-
# @!attribute total_pages
|
|
141
|
-
# Total number of pages
|
|
142
|
-
#
|
|
143
|
-
# @return [Integer, nil]
|
|
144
|
-
optional :total_pages, Integer
|
|
145
|
-
|
|
146
|
-
# @!method initialize(cursors: nil, has_more: nil, page: nil, page_size: nil, total_count: nil, total_pages: nil)
|
|
147
|
-
# Pagination metadata for list responses
|
|
148
|
-
#
|
|
149
|
-
# @param cursors [Sentdm::Models::WebhookListEventTypesResponse::Data::Pagination::Cursors, nil] Cursor-based pagination. Never populated — see Cursors.
|
|
150
|
-
#
|
|
151
|
-
# @param has_more [Boolean] Whether there are more pages after this one
|
|
152
|
-
#
|
|
153
|
-
# @param page [Integer] Current page number (1-indexed)
|
|
154
|
-
#
|
|
155
|
-
# @param page_size [Integer] Number of items per page
|
|
156
|
-
#
|
|
157
|
-
# @param total_count [Integer] Total number of items across all pages
|
|
158
|
-
#
|
|
159
|
-
# @param total_pages [Integer] Total number of pages
|
|
160
|
-
|
|
161
|
-
# @deprecated
|
|
162
|
-
#
|
|
163
|
-
# @see Sentdm::Models::WebhookListEventTypesResponse::Data::Pagination#cursors
|
|
164
|
-
class Cursors < Sentdm::Internal::Type::BaseModel
|
|
165
|
-
# @!attribute after
|
|
166
|
-
# Cursor to fetch the next page.
|
|
167
|
-
#
|
|
168
|
-
# @return [String, nil]
|
|
169
|
-
optional :after, String, nil?: true
|
|
170
|
-
|
|
171
|
-
# @!attribute before
|
|
172
|
-
# Cursor to fetch the previous page.
|
|
173
|
-
#
|
|
174
|
-
# @return [String, nil]
|
|
175
|
-
optional :before, String, nil?: true
|
|
176
|
-
|
|
177
|
-
# @!method initialize(after: nil, before: nil)
|
|
178
|
-
# Cursor-based pagination. Never populated — see Cursors.
|
|
179
|
-
#
|
|
180
|
-
# @param after [String, nil] Cursor to fetch the next page.
|
|
181
|
-
#
|
|
182
|
-
# @param before [String, nil] Cursor to fetch the previous page.
|
|
183
|
-
end
|
|
184
|
-
end
|
|
185
|
-
end
|
|
186
|
-
|
|
187
|
-
# @see Sentdm::Models::WebhookListEventTypesResponse#error
|
|
188
|
-
class Error < Sentdm::Internal::Type::BaseModel
|
|
189
|
-
# @!attribute code
|
|
190
|
-
# Machine-readable error code (e.g., "RESOURCE_001")
|
|
191
|
-
#
|
|
192
|
-
# @return [String, nil]
|
|
193
|
-
optional :code, String
|
|
194
|
-
|
|
195
|
-
# @!attribute details
|
|
196
|
-
# Additional validation error details (field-level errors)
|
|
197
|
-
#
|
|
198
|
-
# @return [Hash{Symbol=>Array<String>}, nil]
|
|
199
|
-
optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
|
|
200
|
-
|
|
201
|
-
# @!attribute doc_url
|
|
202
|
-
# URL to documentation about this error
|
|
203
|
-
#
|
|
204
|
-
# @return [String, nil]
|
|
205
|
-
optional :doc_url, String, nil?: true
|
|
206
|
-
|
|
207
|
-
# @!attribute message
|
|
208
|
-
# Human-readable error message
|
|
209
|
-
#
|
|
210
|
-
# @return [String, nil]
|
|
211
|
-
optional :message, String
|
|
212
|
-
|
|
213
|
-
# @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
|
|
214
|
-
# Error information
|
|
215
|
-
#
|
|
216
|
-
# @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
|
|
217
|
-
#
|
|
218
|
-
# @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
|
|
219
|
-
#
|
|
220
|
-
# @param doc_url [String, nil] URL to documentation about this error
|
|
221
|
-
#
|
|
222
|
-
# @param message [String] Human-readable error message
|
|
223
|
-
end
|
|
224
|
-
|
|
225
|
-
# @see Sentdm::Models::WebhookListEventTypesResponse#meta
|
|
226
|
-
class Meta < Sentdm::Internal::Type::BaseModel
|
|
227
|
-
# @!attribute request_id
|
|
228
|
-
# Unique identifier for this request (for tracing and support)
|
|
229
|
-
#
|
|
230
|
-
# @return [String, nil]
|
|
231
|
-
optional :request_id, String
|
|
232
|
-
|
|
233
|
-
# @!attribute timestamp
|
|
234
|
-
# Server timestamp when the response was generated
|
|
235
|
-
#
|
|
236
|
-
# @return [Time, nil]
|
|
237
|
-
optional :timestamp, Time
|
|
238
|
-
|
|
239
|
-
# @!attribute version
|
|
240
|
-
# API version used for this request
|
|
241
|
-
#
|
|
242
|
-
# @return [String, nil]
|
|
243
|
-
optional :version, String
|
|
244
|
-
|
|
245
|
-
# @!method initialize(request_id: nil, timestamp: nil, version: nil)
|
|
246
|
-
# Request and response metadata
|
|
247
|
-
#
|
|
248
|
-
# @param request_id [String] Unique identifier for this request (for tracing and support)
|
|
249
|
-
#
|
|
250
|
-
# @param timestamp [Time] Server timestamp when the response was generated
|
|
251
|
-
#
|
|
252
|
-
# @param version [String] API version used for this request
|
|
61
|
+
# @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
|
|
253
62
|
end
|
|
254
63
|
end
|
|
255
64
|
end
|
|
@@ -14,13 +14,13 @@ module Sentdm
|
|
|
14
14
|
|
|
15
15
|
# @!attribute page
|
|
16
16
|
#
|
|
17
|
-
# @return [Integer]
|
|
18
|
-
|
|
17
|
+
# @return [Integer, nil]
|
|
18
|
+
optional :page, Integer
|
|
19
19
|
|
|
20
20
|
# @!attribute page_size
|
|
21
21
|
#
|
|
22
|
-
# @return [Integer]
|
|
23
|
-
|
|
22
|
+
# @return [Integer, nil]
|
|
23
|
+
optional :page_size, Integer
|
|
24
24
|
|
|
25
25
|
# @!attribute search
|
|
26
26
|
#
|
|
@@ -32,7 +32,7 @@ module Sentdm
|
|
|
32
32
|
# @return [String, nil]
|
|
33
33
|
optional :x_profile_id, String
|
|
34
34
|
|
|
35
|
-
# @!method initialize(id:, page
|
|
35
|
+
# @!method initialize(id:, page: nil, page_size: nil, search: nil, x_profile_id: nil, request_options: {})
|
|
36
36
|
# @param id [String]
|
|
37
37
|
# @param page [Integer]
|
|
38
38
|
# @param page_size [Integer]
|
|
@@ -4,322 +4,114 @@ module Sentdm
|
|
|
4
4
|
module Models
|
|
5
5
|
# @see Sentdm::Resources::Webhooks#list_events
|
|
6
6
|
class WebhookListEventsResponse < Sentdm::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute
|
|
8
|
-
# A paginated list of webhook delivery records.
|
|
7
|
+
# @!attribute id
|
|
9
8
|
#
|
|
10
|
-
# @return [
|
|
11
|
-
optional :
|
|
9
|
+
# @return [String, nil]
|
|
10
|
+
optional :id, String
|
|
12
11
|
|
|
13
|
-
# @!attribute
|
|
14
|
-
# Error information
|
|
12
|
+
# @!attribute created_at
|
|
15
13
|
#
|
|
16
|
-
# @return [
|
|
17
|
-
optional :
|
|
14
|
+
# @return [Time, nil]
|
|
15
|
+
optional :created_at, Time
|
|
18
16
|
|
|
19
|
-
# @!attribute
|
|
20
|
-
# Request and response metadata
|
|
17
|
+
# @!attribute delivery_attempts
|
|
21
18
|
#
|
|
22
|
-
# @return [
|
|
23
|
-
optional :
|
|
19
|
+
# @return [Integer, nil]
|
|
20
|
+
optional :delivery_attempts, Integer
|
|
24
21
|
|
|
25
|
-
# @!attribute
|
|
26
|
-
# Indicates whether the request was successful
|
|
22
|
+
# @!attribute delivery_status
|
|
27
23
|
#
|
|
28
|
-
# @return [
|
|
29
|
-
optional :
|
|
24
|
+
# @return [String, nil]
|
|
25
|
+
optional :delivery_status, String
|
|
30
26
|
|
|
31
|
-
# @!
|
|
32
|
-
# Standard API response envelope for all v3 endpoints
|
|
27
|
+
# @!attribute error_message
|
|
33
28
|
#
|
|
34
|
-
# @
|
|
29
|
+
# @return [String, nil]
|
|
30
|
+
optional :error_message, String, nil?: true
|
|
31
|
+
|
|
32
|
+
# @!attribute event_data
|
|
33
|
+
# The exact event body that was delivered, or attempted, for this record. One of
|
|
34
|
+
# the three webhook envelopes: a message status change, an inbound message, or a
|
|
35
|
+
# template status change. Read field and event to tell which, the same way your
|
|
36
|
+
# endpoint does.
|
|
35
37
|
#
|
|
36
|
-
# @
|
|
37
|
-
|
|
38
|
-
# @param meta [Sentdm::Models::WebhookListEventsResponse::Meta] Request and response metadata
|
|
39
|
-
#
|
|
40
|
-
# @param success [Boolean] Indicates whether the request was successful
|
|
41
|
-
|
|
42
|
-
# @see Sentdm::Models::WebhookListEventsResponse#data
|
|
43
|
-
class Data < Sentdm::Internal::Type::BaseModel
|
|
44
|
-
# @!attribute events
|
|
45
|
-
# The events on this page.
|
|
46
|
-
#
|
|
47
|
-
# @return [Array<Sentdm::Models::WebhookListEventsResponse::Data::Event>, nil]
|
|
48
|
-
optional :events,
|
|
49
|
-
-> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::WebhookListEventsResponse::Data::Event] }
|
|
50
|
-
|
|
51
|
-
# @!attribute pagination
|
|
52
|
-
# Pagination metadata for list responses
|
|
53
|
-
#
|
|
54
|
-
# @return [Sentdm::Models::WebhookListEventsResponse::Data::Pagination, nil]
|
|
55
|
-
optional :pagination, -> { Sentdm::Models::WebhookListEventsResponse::Data::Pagination }
|
|
56
|
-
|
|
57
|
-
# @!method initialize(events: nil, pagination: nil)
|
|
58
|
-
# A paginated list of webhook delivery records.
|
|
59
|
-
#
|
|
60
|
-
# @param events [Array<Sentdm::Models::WebhookListEventsResponse::Data::Event>] The events on this page.
|
|
61
|
-
#
|
|
62
|
-
# @param pagination [Sentdm::Models::WebhookListEventsResponse::Data::Pagination] Pagination metadata for list responses
|
|
63
|
-
|
|
64
|
-
class Event < Sentdm::Internal::Type::BaseModel
|
|
65
|
-
# @!attribute id
|
|
66
|
-
#
|
|
67
|
-
# @return [String, nil]
|
|
68
|
-
optional :id, String
|
|
69
|
-
|
|
70
|
-
# @!attribute created_at
|
|
71
|
-
#
|
|
72
|
-
# @return [Time, nil]
|
|
73
|
-
optional :created_at, Time
|
|
74
|
-
|
|
75
|
-
# @!attribute delivery_attempts
|
|
76
|
-
#
|
|
77
|
-
# @return [Integer, nil]
|
|
78
|
-
optional :delivery_attempts, Integer
|
|
79
|
-
|
|
80
|
-
# @!attribute delivery_status
|
|
81
|
-
#
|
|
82
|
-
# @return [String, nil]
|
|
83
|
-
optional :delivery_status, String
|
|
84
|
-
|
|
85
|
-
# @!attribute error_message
|
|
86
|
-
#
|
|
87
|
-
# @return [String, nil]
|
|
88
|
-
optional :error_message, String, nil?: true
|
|
89
|
-
|
|
90
|
-
# @!attribute event_data
|
|
91
|
-
# The exact event body that was delivered, or attempted, for this record. One of
|
|
92
|
-
# the three webhook envelopes: a message status change, an inbound message, or a
|
|
93
|
-
# template status change. Read field and event to tell which, the same way your
|
|
94
|
-
# endpoint does.
|
|
95
|
-
#
|
|
96
|
-
# @return [Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent, nil]
|
|
97
|
-
optional :event_data, union: -> { Sentdm::Models::WebhookListEventsResponse::Data::Event::EventData }
|
|
98
|
-
|
|
99
|
-
# @!attribute event_type
|
|
100
|
-
#
|
|
101
|
-
# @return [String, nil]
|
|
102
|
-
optional :event_type, String
|
|
103
|
-
|
|
104
|
-
# @!attribute http_status_code
|
|
105
|
-
#
|
|
106
|
-
# @return [Integer, nil]
|
|
107
|
-
optional :http_status_code, Integer, nil?: true
|
|
108
|
-
|
|
109
|
-
# @!attribute processing_completed_at
|
|
110
|
-
#
|
|
111
|
-
# @return [Time, nil]
|
|
112
|
-
optional :processing_completed_at, Time, nil?: true
|
|
113
|
-
|
|
114
|
-
# @!attribute processing_started_at
|
|
115
|
-
#
|
|
116
|
-
# @return [Time, nil]
|
|
117
|
-
optional :processing_started_at, Time, nil?: true
|
|
118
|
-
|
|
119
|
-
# @!attribute response_body
|
|
120
|
-
#
|
|
121
|
-
# @return [String, nil]
|
|
122
|
-
optional :response_body, String, nil?: true
|
|
123
|
-
|
|
124
|
-
# @!method initialize(id: nil, created_at: nil, delivery_attempts: nil, delivery_status: nil, error_message: nil, event_data: nil, event_type: nil, http_status_code: nil, processing_completed_at: nil, processing_started_at: nil, response_body: nil)
|
|
125
|
-
# Some parameter documentations has been truncated, see
|
|
126
|
-
# {Sentdm::Models::WebhookListEventsResponse::Data::Event} for more details.
|
|
127
|
-
#
|
|
128
|
-
# @param id [String]
|
|
129
|
-
#
|
|
130
|
-
# @param created_at [Time]
|
|
131
|
-
#
|
|
132
|
-
# @param delivery_attempts [Integer]
|
|
133
|
-
#
|
|
134
|
-
# @param delivery_status [String]
|
|
135
|
-
#
|
|
136
|
-
# @param error_message [String, nil]
|
|
137
|
-
#
|
|
138
|
-
# @param event_data [Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent] The exact event body that was delivered, or attempted, for this record. One of t
|
|
139
|
-
#
|
|
140
|
-
# @param event_type [String]
|
|
141
|
-
#
|
|
142
|
-
# @param http_status_code [Integer, nil]
|
|
143
|
-
#
|
|
144
|
-
# @param processing_completed_at [Time, nil]
|
|
145
|
-
#
|
|
146
|
-
# @param processing_started_at [Time, nil]
|
|
147
|
-
#
|
|
148
|
-
# @param response_body [String, nil]
|
|
149
|
-
|
|
150
|
-
# The exact event body that was delivered, or attempted, for this record. One of
|
|
151
|
-
# the three webhook envelopes: a message status change, an inbound message, or a
|
|
152
|
-
# template status change. Read field and event to tell which, the same way your
|
|
153
|
-
# endpoint does.
|
|
154
|
-
#
|
|
155
|
-
# @see Sentdm::Models::WebhookListEventsResponse::Data::Event#event_data
|
|
156
|
-
module EventData
|
|
157
|
-
extend Sentdm::Internal::Type::Union
|
|
158
|
-
|
|
159
|
-
# The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
|
|
160
|
-
# varies only in Payload.
|
|
161
|
-
variant -> { Sentdm::MessageEvent }
|
|
162
|
-
|
|
163
|
-
# The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
|
|
164
|
-
# varies only in Payload.
|
|
165
|
-
variant -> { Sentdm::InboundMessageEvent }
|
|
166
|
-
|
|
167
|
-
# The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
|
|
168
|
-
# varies only in Payload.
|
|
169
|
-
variant -> { Sentdm::TemplateEvent }
|
|
170
|
-
|
|
171
|
-
# @!method self.variants
|
|
172
|
-
# @return [Array(Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent)]
|
|
173
|
-
end
|
|
174
|
-
end
|
|
175
|
-
|
|
176
|
-
# @see Sentdm::Models::WebhookListEventsResponse::Data#pagination
|
|
177
|
-
class Pagination < Sentdm::Internal::Type::BaseModel
|
|
178
|
-
# @!attribute cursors
|
|
179
|
-
# @deprecated
|
|
180
|
-
#
|
|
181
|
-
# Cursor-based pagination. Never populated — see Cursors.
|
|
182
|
-
#
|
|
183
|
-
# @return [Sentdm::Models::WebhookListEventsResponse::Data::Pagination::Cursors, nil]
|
|
184
|
-
optional :cursors, -> { Sentdm::Models::WebhookListEventsResponse::Data::Pagination::Cursors }, nil?: true
|
|
185
|
-
|
|
186
|
-
# @!attribute has_more
|
|
187
|
-
# Whether there are more pages after this one
|
|
188
|
-
#
|
|
189
|
-
# @return [Boolean, nil]
|
|
190
|
-
optional :has_more, Sentdm::Internal::Type::Boolean
|
|
191
|
-
|
|
192
|
-
# @!attribute page
|
|
193
|
-
# Current page number (1-indexed)
|
|
194
|
-
#
|
|
195
|
-
# @return [Integer, nil]
|
|
196
|
-
optional :page, Integer
|
|
38
|
+
# @return [Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent, nil]
|
|
39
|
+
optional :event_data, union: -> { Sentdm::Models::WebhookListEventsResponse::EventData }
|
|
197
40
|
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
optional :page_size, Integer
|
|
203
|
-
|
|
204
|
-
# @!attribute total_count
|
|
205
|
-
# Total number of items across all pages
|
|
206
|
-
#
|
|
207
|
-
# @return [Integer, nil]
|
|
208
|
-
optional :total_count, Integer
|
|
209
|
-
|
|
210
|
-
# @!attribute total_pages
|
|
211
|
-
# Total number of pages
|
|
212
|
-
#
|
|
213
|
-
# @return [Integer, nil]
|
|
214
|
-
optional :total_pages, Integer
|
|
215
|
-
|
|
216
|
-
# @!method initialize(cursors: nil, has_more: nil, page: nil, page_size: nil, total_count: nil, total_pages: nil)
|
|
217
|
-
# Pagination metadata for list responses
|
|
218
|
-
#
|
|
219
|
-
# @param cursors [Sentdm::Models::WebhookListEventsResponse::Data::Pagination::Cursors, nil] Cursor-based pagination. Never populated — see Cursors.
|
|
220
|
-
#
|
|
221
|
-
# @param has_more [Boolean] Whether there are more pages after this one
|
|
222
|
-
#
|
|
223
|
-
# @param page [Integer] Current page number (1-indexed)
|
|
224
|
-
#
|
|
225
|
-
# @param page_size [Integer] Number of items per page
|
|
226
|
-
#
|
|
227
|
-
# @param total_count [Integer] Total number of items across all pages
|
|
228
|
-
#
|
|
229
|
-
# @param total_pages [Integer] Total number of pages
|
|
230
|
-
|
|
231
|
-
# @deprecated
|
|
232
|
-
#
|
|
233
|
-
# @see Sentdm::Models::WebhookListEventsResponse::Data::Pagination#cursors
|
|
234
|
-
class Cursors < Sentdm::Internal::Type::BaseModel
|
|
235
|
-
# @!attribute after
|
|
236
|
-
# Cursor to fetch the next page.
|
|
237
|
-
#
|
|
238
|
-
# @return [String, nil]
|
|
239
|
-
optional :after, String, nil?: true
|
|
240
|
-
|
|
241
|
-
# @!attribute before
|
|
242
|
-
# Cursor to fetch the previous page.
|
|
243
|
-
#
|
|
244
|
-
# @return [String, nil]
|
|
245
|
-
optional :before, String, nil?: true
|
|
41
|
+
# @!attribute event_type
|
|
42
|
+
#
|
|
43
|
+
# @return [String, nil]
|
|
44
|
+
optional :event_type, String
|
|
246
45
|
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
#
|
|
252
|
-
# @param before [String, nil] Cursor to fetch the previous page.
|
|
253
|
-
end
|
|
254
|
-
end
|
|
255
|
-
end
|
|
46
|
+
# @!attribute http_status_code
|
|
47
|
+
#
|
|
48
|
+
# @return [Integer, nil]
|
|
49
|
+
optional :http_status_code, Integer, nil?: true
|
|
256
50
|
|
|
257
|
-
#
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
#
|
|
262
|
-
# @return [String, nil]
|
|
263
|
-
optional :code, String
|
|
51
|
+
# @!attribute processing_completed_at
|
|
52
|
+
#
|
|
53
|
+
# @return [Time, nil]
|
|
54
|
+
optional :processing_completed_at, Time, nil?: true
|
|
264
55
|
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
|
|
56
|
+
# @!attribute processing_started_at
|
|
57
|
+
#
|
|
58
|
+
# @return [Time, nil]
|
|
59
|
+
optional :processing_started_at, Time, nil?: true
|
|
270
60
|
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
optional :doc_url, String, nil?: true
|
|
61
|
+
# @!attribute response_body
|
|
62
|
+
#
|
|
63
|
+
# @return [String, nil]
|
|
64
|
+
optional :response_body, String, nil?: true
|
|
276
65
|
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
66
|
+
# @!method initialize(id: nil, created_at: nil, delivery_attempts: nil, delivery_status: nil, error_message: nil, event_data: nil, event_type: nil, http_status_code: nil, processing_completed_at: nil, processing_started_at: nil, response_body: nil)
|
|
67
|
+
# Some parameter documentations has been truncated, see
|
|
68
|
+
# {Sentdm::Models::WebhookListEventsResponse} for more details.
|
|
69
|
+
#
|
|
70
|
+
# @param id [String]
|
|
71
|
+
#
|
|
72
|
+
# @param created_at [Time]
|
|
73
|
+
#
|
|
74
|
+
# @param delivery_attempts [Integer]
|
|
75
|
+
#
|
|
76
|
+
# @param delivery_status [String]
|
|
77
|
+
#
|
|
78
|
+
# @param error_message [String, nil]
|
|
79
|
+
#
|
|
80
|
+
# @param event_data [Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent] The exact event body that was delivered, or attempted, for this record. One of t
|
|
81
|
+
#
|
|
82
|
+
# @param event_type [String]
|
|
83
|
+
#
|
|
84
|
+
# @param http_status_code [Integer, nil]
|
|
85
|
+
#
|
|
86
|
+
# @param processing_completed_at [Time, nil]
|
|
87
|
+
#
|
|
88
|
+
# @param processing_started_at [Time, nil]
|
|
89
|
+
#
|
|
90
|
+
# @param response_body [String, nil]
|
|
282
91
|
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
#
|
|
292
|
-
# @param message [String] Human-readable error message
|
|
293
|
-
end
|
|
92
|
+
# The exact event body that was delivered, or attempted, for this record. One of
|
|
93
|
+
# the three webhook envelopes: a message status change, an inbound message, or a
|
|
94
|
+
# template status change. Read field and event to tell which, the same way your
|
|
95
|
+
# endpoint does.
|
|
96
|
+
#
|
|
97
|
+
# @see Sentdm::Models::WebhookListEventsResponse#event_data
|
|
98
|
+
module EventData
|
|
99
|
+
extend Sentdm::Internal::Type::Union
|
|
294
100
|
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
# Unique identifier for this request (for tracing and support)
|
|
299
|
-
#
|
|
300
|
-
# @return [String, nil]
|
|
301
|
-
optional :request_id, String
|
|
101
|
+
# The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
|
|
102
|
+
# varies only in Payload.
|
|
103
|
+
variant -> { Sentdm::MessageEvent }
|
|
302
104
|
|
|
303
|
-
#
|
|
304
|
-
#
|
|
305
|
-
|
|
306
|
-
# @return [Time, nil]
|
|
307
|
-
optional :timestamp, Time
|
|
105
|
+
# The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
|
|
106
|
+
# varies only in Payload.
|
|
107
|
+
variant -> { Sentdm::InboundMessageEvent }
|
|
308
108
|
|
|
309
|
-
#
|
|
310
|
-
#
|
|
311
|
-
|
|
312
|
-
# @return [String, nil]
|
|
313
|
-
optional :version, String
|
|
109
|
+
# The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
|
|
110
|
+
# varies only in Payload.
|
|
111
|
+
variant -> { Sentdm::TemplateEvent }
|
|
314
112
|
|
|
315
|
-
# @!method
|
|
316
|
-
#
|
|
317
|
-
#
|
|
318
|
-
# @param request_id [String] Unique identifier for this request (for tracing and support)
|
|
319
|
-
#
|
|
320
|
-
# @param timestamp [Time] Server timestamp when the response was generated
|
|
321
|
-
#
|
|
322
|
-
# @param version [String] API version used for this request
|
|
113
|
+
# @!method self.variants
|
|
114
|
+
# @return [Array(Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent)]
|
|
323
115
|
end
|
|
324
116
|
end
|
|
325
117
|
end
|