sentdm 0.27.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 +13 -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/me_retrieve_response.rb +242 -12
- 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_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 +162 -13
- 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 +0 -52
- 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 +11 -1
- data/lib/sentdm/resources/numbers.rb +6 -1
- data/lib/sentdm/resources/profiles/campaigns.rb +47 -9
- data/lib/sentdm/resources/profiles.rb +134 -58
- data/lib/sentdm/resources/templates.rb +14 -8
- data/lib/sentdm/resources/users.rb +12 -7
- data/lib/sentdm/resources/webhooks.rb +19 -9
- data/lib/sentdm/version.rb +1 -1
- data/lib/sentdm.rb +22 -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/me_retrieve_response.rbi +367 -16
- 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_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 +319 -15
- 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 +0 -54
- 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 +11 -1
- data/rbi/sentdm/resources/numbers.rbi +6 -1
- data/rbi/sentdm/resources/profiles/campaigns.rbi +36 -6
- data/rbi/sentdm/resources/profiles.rbi +174 -66
- data/rbi/sentdm/resources/templates.rbi +15 -5
- data/rbi/sentdm/resources/users.rbi +9 -4
- 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/me_retrieve_response.rbs +176 -18
- 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_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 +142 -14
- 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 +0 -52
- 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 +68 -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 -605
- 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 -872
- 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
|
@@ -0,0 +1,229 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
# @see Sentdm::Resources::Webhooks#toggle_status
|
|
6
|
+
class WebhookToggleStatusResponse < Sentdm::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute data
|
|
8
|
+
# The response data (null if error)
|
|
9
|
+
#
|
|
10
|
+
# @return [Sentdm::Models::WebhookToggleStatusResponse::Data, nil]
|
|
11
|
+
optional :data, -> { Sentdm::Models::WebhookToggleStatusResponse::Data }, nil?: true
|
|
12
|
+
|
|
13
|
+
# @!attribute error
|
|
14
|
+
# Error information
|
|
15
|
+
#
|
|
16
|
+
# @return [Sentdm::Models::WebhookToggleStatusResponse::Error, nil]
|
|
17
|
+
optional :error, -> { Sentdm::Models::WebhookToggleStatusResponse::Error }, nil?: true
|
|
18
|
+
|
|
19
|
+
# @!attribute meta
|
|
20
|
+
# Request and response metadata
|
|
21
|
+
#
|
|
22
|
+
# @return [Sentdm::Models::WebhookToggleStatusResponse::Meta, nil]
|
|
23
|
+
optional :meta, -> { Sentdm::Models::WebhookToggleStatusResponse::Meta }
|
|
24
|
+
|
|
25
|
+
# @!attribute success
|
|
26
|
+
# Indicates whether the request was successful
|
|
27
|
+
#
|
|
28
|
+
# @return [Boolean, nil]
|
|
29
|
+
optional :success, Sentdm::Internal::Type::Boolean
|
|
30
|
+
|
|
31
|
+
# @!method initialize(data: nil, error: nil, meta: nil, success: nil)
|
|
32
|
+
# Standard API response envelope for all v3 endpoints
|
|
33
|
+
#
|
|
34
|
+
# @param data [Sentdm::Models::WebhookToggleStatusResponse::Data, nil] The response data (null if error)
|
|
35
|
+
#
|
|
36
|
+
# @param error [Sentdm::Models::WebhookToggleStatusResponse::Error, nil] Error information
|
|
37
|
+
#
|
|
38
|
+
# @param meta [Sentdm::Models::WebhookToggleStatusResponse::Meta] Request and response metadata
|
|
39
|
+
#
|
|
40
|
+
# @param success [Boolean] Indicates whether the request was successful
|
|
41
|
+
|
|
42
|
+
# @see Sentdm::Models::WebhookToggleStatusResponse#data
|
|
43
|
+
class Data < Sentdm::Internal::Type::BaseModel
|
|
44
|
+
# @!attribute id
|
|
45
|
+
#
|
|
46
|
+
# @return [String, nil]
|
|
47
|
+
optional :id, String
|
|
48
|
+
|
|
49
|
+
# @!attribute consecutive_failures
|
|
50
|
+
#
|
|
51
|
+
# @return [Integer, nil]
|
|
52
|
+
optional :consecutive_failures, Integer
|
|
53
|
+
|
|
54
|
+
# @!attribute created_at
|
|
55
|
+
#
|
|
56
|
+
# @return [Time, nil]
|
|
57
|
+
optional :created_at, Time
|
|
58
|
+
|
|
59
|
+
# @!attribute customer_id
|
|
60
|
+
# Which customer owns this — the key's own, or the profile named in x-profile-id.
|
|
61
|
+
# Says whose resource this is, which the resource's own id does not.
|
|
62
|
+
#
|
|
63
|
+
# @return [String, nil]
|
|
64
|
+
optional :customer_id, String
|
|
65
|
+
|
|
66
|
+
# @!attribute display_name
|
|
67
|
+
#
|
|
68
|
+
# @return [String, nil]
|
|
69
|
+
optional :display_name, String
|
|
70
|
+
|
|
71
|
+
# @!attribute endpoint_url
|
|
72
|
+
#
|
|
73
|
+
# @return [String, nil]
|
|
74
|
+
optional :endpoint_url, String
|
|
75
|
+
|
|
76
|
+
# @!attribute event_filters
|
|
77
|
+
#
|
|
78
|
+
# @return [Hash{Symbol=>Array<String>}, nil]
|
|
79
|
+
optional :event_filters,
|
|
80
|
+
Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]],
|
|
81
|
+
nil?: true
|
|
82
|
+
|
|
83
|
+
# @!attribute event_types
|
|
84
|
+
#
|
|
85
|
+
# @return [Array<String>, nil]
|
|
86
|
+
optional :event_types, Sentdm::Internal::Type::ArrayOf[String]
|
|
87
|
+
|
|
88
|
+
# @!attribute is_active
|
|
89
|
+
#
|
|
90
|
+
# @return [Boolean, nil]
|
|
91
|
+
optional :is_active, Sentdm::Internal::Type::Boolean
|
|
92
|
+
|
|
93
|
+
# @!attribute last_delivery_attempt_at
|
|
94
|
+
#
|
|
95
|
+
# @return [Time, nil]
|
|
96
|
+
optional :last_delivery_attempt_at, Time, nil?: true
|
|
97
|
+
|
|
98
|
+
# @!attribute last_successful_delivery_at
|
|
99
|
+
#
|
|
100
|
+
# @return [Time, nil]
|
|
101
|
+
optional :last_successful_delivery_at, Time, nil?: true
|
|
102
|
+
|
|
103
|
+
# @!attribute retry_count
|
|
104
|
+
#
|
|
105
|
+
# @return [Integer, nil]
|
|
106
|
+
optional :retry_count, Integer
|
|
107
|
+
|
|
108
|
+
# @!attribute signing_secret
|
|
109
|
+
#
|
|
110
|
+
# @return [String, nil]
|
|
111
|
+
optional :signing_secret, String, nil?: true
|
|
112
|
+
|
|
113
|
+
# @!attribute timeout_seconds
|
|
114
|
+
#
|
|
115
|
+
# @return [Integer, nil]
|
|
116
|
+
optional :timeout_seconds, Integer
|
|
117
|
+
|
|
118
|
+
# @!attribute updated_at
|
|
119
|
+
#
|
|
120
|
+
# @return [Time, nil]
|
|
121
|
+
optional :updated_at, Time, nil?: true
|
|
122
|
+
|
|
123
|
+
# @!method initialize(id: nil, consecutive_failures: nil, created_at: nil, customer_id: nil, display_name: nil, endpoint_url: nil, event_filters: nil, event_types: nil, is_active: nil, last_delivery_attempt_at: nil, last_successful_delivery_at: nil, retry_count: nil, signing_secret: nil, timeout_seconds: nil, updated_at: nil)
|
|
124
|
+
# Some parameter documentations has been truncated, see
|
|
125
|
+
# {Sentdm::Models::WebhookToggleStatusResponse::Data} for more details.
|
|
126
|
+
#
|
|
127
|
+
# The response data (null if error)
|
|
128
|
+
#
|
|
129
|
+
# @param id [String]
|
|
130
|
+
#
|
|
131
|
+
# @param consecutive_failures [Integer]
|
|
132
|
+
#
|
|
133
|
+
# @param created_at [Time]
|
|
134
|
+
#
|
|
135
|
+
# @param customer_id [String] Which customer owns this — the key's own, or the profile named in x-profile-id.
|
|
136
|
+
#
|
|
137
|
+
# @param display_name [String]
|
|
138
|
+
#
|
|
139
|
+
# @param endpoint_url [String]
|
|
140
|
+
#
|
|
141
|
+
# @param event_filters [Hash{Symbol=>Array<String>}, nil]
|
|
142
|
+
#
|
|
143
|
+
# @param event_types [Array<String>]
|
|
144
|
+
#
|
|
145
|
+
# @param is_active [Boolean]
|
|
146
|
+
#
|
|
147
|
+
# @param last_delivery_attempt_at [Time, nil]
|
|
148
|
+
#
|
|
149
|
+
# @param last_successful_delivery_at [Time, nil]
|
|
150
|
+
#
|
|
151
|
+
# @param retry_count [Integer]
|
|
152
|
+
#
|
|
153
|
+
# @param signing_secret [String, nil]
|
|
154
|
+
#
|
|
155
|
+
# @param timeout_seconds [Integer]
|
|
156
|
+
#
|
|
157
|
+
# @param updated_at [Time, nil]
|
|
158
|
+
end
|
|
159
|
+
|
|
160
|
+
# @see Sentdm::Models::WebhookToggleStatusResponse#error
|
|
161
|
+
class Error < Sentdm::Internal::Type::BaseModel
|
|
162
|
+
# @!attribute code
|
|
163
|
+
# Machine-readable error code (e.g., "RESOURCE_001")
|
|
164
|
+
#
|
|
165
|
+
# @return [String, nil]
|
|
166
|
+
optional :code, String
|
|
167
|
+
|
|
168
|
+
# @!attribute details
|
|
169
|
+
# Additional validation error details (field-level errors)
|
|
170
|
+
#
|
|
171
|
+
# @return [Hash{Symbol=>Array<String>}, nil]
|
|
172
|
+
optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
|
|
173
|
+
|
|
174
|
+
# @!attribute doc_url
|
|
175
|
+
# URL to documentation about this error
|
|
176
|
+
#
|
|
177
|
+
# @return [String, nil]
|
|
178
|
+
optional :doc_url, String, nil?: true
|
|
179
|
+
|
|
180
|
+
# @!attribute message
|
|
181
|
+
# Human-readable error message
|
|
182
|
+
#
|
|
183
|
+
# @return [String, nil]
|
|
184
|
+
optional :message, String
|
|
185
|
+
|
|
186
|
+
# @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
|
|
187
|
+
# Error information
|
|
188
|
+
#
|
|
189
|
+
# @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
|
|
190
|
+
#
|
|
191
|
+
# @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
|
|
192
|
+
#
|
|
193
|
+
# @param doc_url [String, nil] URL to documentation about this error
|
|
194
|
+
#
|
|
195
|
+
# @param message [String] Human-readable error message
|
|
196
|
+
end
|
|
197
|
+
|
|
198
|
+
# @see Sentdm::Models::WebhookToggleStatusResponse#meta
|
|
199
|
+
class Meta < Sentdm::Internal::Type::BaseModel
|
|
200
|
+
# @!attribute request_id
|
|
201
|
+
# Unique identifier for this request (for tracing and support)
|
|
202
|
+
#
|
|
203
|
+
# @return [String, nil]
|
|
204
|
+
optional :request_id, String
|
|
205
|
+
|
|
206
|
+
# @!attribute timestamp
|
|
207
|
+
# Server timestamp when the response was generated
|
|
208
|
+
#
|
|
209
|
+
# @return [Time, nil]
|
|
210
|
+
optional :timestamp, Time
|
|
211
|
+
|
|
212
|
+
# @!attribute version
|
|
213
|
+
# API version used for this request
|
|
214
|
+
#
|
|
215
|
+
# @return [String, nil]
|
|
216
|
+
optional :version, String
|
|
217
|
+
|
|
218
|
+
# @!method initialize(request_id: nil, timestamp: nil, version: nil)
|
|
219
|
+
# Request and response metadata
|
|
220
|
+
#
|
|
221
|
+
# @param request_id [String] Unique identifier for this request (for tracing and support)
|
|
222
|
+
#
|
|
223
|
+
# @param timestamp [Time] Server timestamp when the response was generated
|
|
224
|
+
#
|
|
225
|
+
# @param version [String] API version used for this request
|
|
226
|
+
end
|
|
227
|
+
end
|
|
228
|
+
end
|
|
229
|
+
end
|
|
@@ -0,0 +1,229 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
# @see Sentdm::Resources::Webhooks#update
|
|
6
|
+
class WebhookUpdateResponse < Sentdm::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute data
|
|
8
|
+
# The response data (null if error)
|
|
9
|
+
#
|
|
10
|
+
# @return [Sentdm::Models::WebhookUpdateResponse::Data, nil]
|
|
11
|
+
optional :data, -> { Sentdm::Models::WebhookUpdateResponse::Data }, nil?: true
|
|
12
|
+
|
|
13
|
+
# @!attribute error
|
|
14
|
+
# Error information
|
|
15
|
+
#
|
|
16
|
+
# @return [Sentdm::Models::WebhookUpdateResponse::Error, nil]
|
|
17
|
+
optional :error, -> { Sentdm::Models::WebhookUpdateResponse::Error }, nil?: true
|
|
18
|
+
|
|
19
|
+
# @!attribute meta
|
|
20
|
+
# Request and response metadata
|
|
21
|
+
#
|
|
22
|
+
# @return [Sentdm::Models::WebhookUpdateResponse::Meta, nil]
|
|
23
|
+
optional :meta, -> { Sentdm::Models::WebhookUpdateResponse::Meta }
|
|
24
|
+
|
|
25
|
+
# @!attribute success
|
|
26
|
+
# Indicates whether the request was successful
|
|
27
|
+
#
|
|
28
|
+
# @return [Boolean, nil]
|
|
29
|
+
optional :success, Sentdm::Internal::Type::Boolean
|
|
30
|
+
|
|
31
|
+
# @!method initialize(data: nil, error: nil, meta: nil, success: nil)
|
|
32
|
+
# Standard API response envelope for all v3 endpoints
|
|
33
|
+
#
|
|
34
|
+
# @param data [Sentdm::Models::WebhookUpdateResponse::Data, nil] The response data (null if error)
|
|
35
|
+
#
|
|
36
|
+
# @param error [Sentdm::Models::WebhookUpdateResponse::Error, nil] Error information
|
|
37
|
+
#
|
|
38
|
+
# @param meta [Sentdm::Models::WebhookUpdateResponse::Meta] Request and response metadata
|
|
39
|
+
#
|
|
40
|
+
# @param success [Boolean] Indicates whether the request was successful
|
|
41
|
+
|
|
42
|
+
# @see Sentdm::Models::WebhookUpdateResponse#data
|
|
43
|
+
class Data < Sentdm::Internal::Type::BaseModel
|
|
44
|
+
# @!attribute id
|
|
45
|
+
#
|
|
46
|
+
# @return [String, nil]
|
|
47
|
+
optional :id, String
|
|
48
|
+
|
|
49
|
+
# @!attribute consecutive_failures
|
|
50
|
+
#
|
|
51
|
+
# @return [Integer, nil]
|
|
52
|
+
optional :consecutive_failures, Integer
|
|
53
|
+
|
|
54
|
+
# @!attribute created_at
|
|
55
|
+
#
|
|
56
|
+
# @return [Time, nil]
|
|
57
|
+
optional :created_at, Time
|
|
58
|
+
|
|
59
|
+
# @!attribute customer_id
|
|
60
|
+
# Which customer owns this — the key's own, or the profile named in x-profile-id.
|
|
61
|
+
# Says whose resource this is, which the resource's own id does not.
|
|
62
|
+
#
|
|
63
|
+
# @return [String, nil]
|
|
64
|
+
optional :customer_id, String
|
|
65
|
+
|
|
66
|
+
# @!attribute display_name
|
|
67
|
+
#
|
|
68
|
+
# @return [String, nil]
|
|
69
|
+
optional :display_name, String
|
|
70
|
+
|
|
71
|
+
# @!attribute endpoint_url
|
|
72
|
+
#
|
|
73
|
+
# @return [String, nil]
|
|
74
|
+
optional :endpoint_url, String
|
|
75
|
+
|
|
76
|
+
# @!attribute event_filters
|
|
77
|
+
#
|
|
78
|
+
# @return [Hash{Symbol=>Array<String>}, nil]
|
|
79
|
+
optional :event_filters,
|
|
80
|
+
Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]],
|
|
81
|
+
nil?: true
|
|
82
|
+
|
|
83
|
+
# @!attribute event_types
|
|
84
|
+
#
|
|
85
|
+
# @return [Array<String>, nil]
|
|
86
|
+
optional :event_types, Sentdm::Internal::Type::ArrayOf[String]
|
|
87
|
+
|
|
88
|
+
# @!attribute is_active
|
|
89
|
+
#
|
|
90
|
+
# @return [Boolean, nil]
|
|
91
|
+
optional :is_active, Sentdm::Internal::Type::Boolean
|
|
92
|
+
|
|
93
|
+
# @!attribute last_delivery_attempt_at
|
|
94
|
+
#
|
|
95
|
+
# @return [Time, nil]
|
|
96
|
+
optional :last_delivery_attempt_at, Time, nil?: true
|
|
97
|
+
|
|
98
|
+
# @!attribute last_successful_delivery_at
|
|
99
|
+
#
|
|
100
|
+
# @return [Time, nil]
|
|
101
|
+
optional :last_successful_delivery_at, Time, nil?: true
|
|
102
|
+
|
|
103
|
+
# @!attribute retry_count
|
|
104
|
+
#
|
|
105
|
+
# @return [Integer, nil]
|
|
106
|
+
optional :retry_count, Integer
|
|
107
|
+
|
|
108
|
+
# @!attribute signing_secret
|
|
109
|
+
#
|
|
110
|
+
# @return [String, nil]
|
|
111
|
+
optional :signing_secret, String, nil?: true
|
|
112
|
+
|
|
113
|
+
# @!attribute timeout_seconds
|
|
114
|
+
#
|
|
115
|
+
# @return [Integer, nil]
|
|
116
|
+
optional :timeout_seconds, Integer
|
|
117
|
+
|
|
118
|
+
# @!attribute updated_at
|
|
119
|
+
#
|
|
120
|
+
# @return [Time, nil]
|
|
121
|
+
optional :updated_at, Time, nil?: true
|
|
122
|
+
|
|
123
|
+
# @!method initialize(id: nil, consecutive_failures: nil, created_at: nil, customer_id: nil, display_name: nil, endpoint_url: nil, event_filters: nil, event_types: nil, is_active: nil, last_delivery_attempt_at: nil, last_successful_delivery_at: nil, retry_count: nil, signing_secret: nil, timeout_seconds: nil, updated_at: nil)
|
|
124
|
+
# Some parameter documentations has been truncated, see
|
|
125
|
+
# {Sentdm::Models::WebhookUpdateResponse::Data} for more details.
|
|
126
|
+
#
|
|
127
|
+
# The response data (null if error)
|
|
128
|
+
#
|
|
129
|
+
# @param id [String]
|
|
130
|
+
#
|
|
131
|
+
# @param consecutive_failures [Integer]
|
|
132
|
+
#
|
|
133
|
+
# @param created_at [Time]
|
|
134
|
+
#
|
|
135
|
+
# @param customer_id [String] Which customer owns this — the key's own, or the profile named in x-profile-id.
|
|
136
|
+
#
|
|
137
|
+
# @param display_name [String]
|
|
138
|
+
#
|
|
139
|
+
# @param endpoint_url [String]
|
|
140
|
+
#
|
|
141
|
+
# @param event_filters [Hash{Symbol=>Array<String>}, nil]
|
|
142
|
+
#
|
|
143
|
+
# @param event_types [Array<String>]
|
|
144
|
+
#
|
|
145
|
+
# @param is_active [Boolean]
|
|
146
|
+
#
|
|
147
|
+
# @param last_delivery_attempt_at [Time, nil]
|
|
148
|
+
#
|
|
149
|
+
# @param last_successful_delivery_at [Time, nil]
|
|
150
|
+
#
|
|
151
|
+
# @param retry_count [Integer]
|
|
152
|
+
#
|
|
153
|
+
# @param signing_secret [String, nil]
|
|
154
|
+
#
|
|
155
|
+
# @param timeout_seconds [Integer]
|
|
156
|
+
#
|
|
157
|
+
# @param updated_at [Time, nil]
|
|
158
|
+
end
|
|
159
|
+
|
|
160
|
+
# @see Sentdm::Models::WebhookUpdateResponse#error
|
|
161
|
+
class Error < Sentdm::Internal::Type::BaseModel
|
|
162
|
+
# @!attribute code
|
|
163
|
+
# Machine-readable error code (e.g., "RESOURCE_001")
|
|
164
|
+
#
|
|
165
|
+
# @return [String, nil]
|
|
166
|
+
optional :code, String
|
|
167
|
+
|
|
168
|
+
# @!attribute details
|
|
169
|
+
# Additional validation error details (field-level errors)
|
|
170
|
+
#
|
|
171
|
+
# @return [Hash{Symbol=>Array<String>}, nil]
|
|
172
|
+
optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
|
|
173
|
+
|
|
174
|
+
# @!attribute doc_url
|
|
175
|
+
# URL to documentation about this error
|
|
176
|
+
#
|
|
177
|
+
# @return [String, nil]
|
|
178
|
+
optional :doc_url, String, nil?: true
|
|
179
|
+
|
|
180
|
+
# @!attribute message
|
|
181
|
+
# Human-readable error message
|
|
182
|
+
#
|
|
183
|
+
# @return [String, nil]
|
|
184
|
+
optional :message, String
|
|
185
|
+
|
|
186
|
+
# @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
|
|
187
|
+
# Error information
|
|
188
|
+
#
|
|
189
|
+
# @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
|
|
190
|
+
#
|
|
191
|
+
# @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
|
|
192
|
+
#
|
|
193
|
+
# @param doc_url [String, nil] URL to documentation about this error
|
|
194
|
+
#
|
|
195
|
+
# @param message [String] Human-readable error message
|
|
196
|
+
end
|
|
197
|
+
|
|
198
|
+
# @see Sentdm::Models::WebhookUpdateResponse#meta
|
|
199
|
+
class Meta < Sentdm::Internal::Type::BaseModel
|
|
200
|
+
# @!attribute request_id
|
|
201
|
+
# Unique identifier for this request (for tracing and support)
|
|
202
|
+
#
|
|
203
|
+
# @return [String, nil]
|
|
204
|
+
optional :request_id, String
|
|
205
|
+
|
|
206
|
+
# @!attribute timestamp
|
|
207
|
+
# Server timestamp when the response was generated
|
|
208
|
+
#
|
|
209
|
+
# @return [Time, nil]
|
|
210
|
+
optional :timestamp, Time
|
|
211
|
+
|
|
212
|
+
# @!attribute version
|
|
213
|
+
# API version used for this request
|
|
214
|
+
#
|
|
215
|
+
# @return [String, nil]
|
|
216
|
+
optional :version, String
|
|
217
|
+
|
|
218
|
+
# @!method initialize(request_id: nil, timestamp: nil, version: nil)
|
|
219
|
+
# Request and response metadata
|
|
220
|
+
#
|
|
221
|
+
# @param request_id [String] Unique identifier for this request (for tracing and support)
|
|
222
|
+
#
|
|
223
|
+
# @param timestamp [Time] Server timestamp when the response was generated
|
|
224
|
+
#
|
|
225
|
+
# @param version [String] API version used for this request
|
|
226
|
+
end
|
|
227
|
+
end
|
|
228
|
+
end
|
|
229
|
+
end
|
data/lib/sentdm/models.rb
CHANGED
|
@@ -39,44 +39,14 @@ module Sentdm
|
|
|
39
39
|
mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
|
|
40
40
|
end
|
|
41
41
|
|
|
42
|
-
APIMeta = Sentdm::Models::APIMeta
|
|
43
|
-
|
|
44
|
-
APIResponseOfContact = Sentdm::Models::APIResponseOfContact
|
|
45
|
-
|
|
46
|
-
APIResponseOfContactMessageSummary = Sentdm::Models::APIResponseOfContactMessageSummary
|
|
47
|
-
|
|
48
|
-
APIResponseOfConversationMessagesList = Sentdm::Models::APIResponseOfConversationMessagesList
|
|
49
|
-
|
|
50
|
-
APIResponseOfProfileDetail = Sentdm::Models::APIResponseOfProfileDetail
|
|
51
|
-
|
|
52
|
-
APIResponseOfUser = Sentdm::Models::APIResponseOfUser
|
|
53
|
-
|
|
54
|
-
APIResponseTemplate = Sentdm::Models::APIResponseTemplate
|
|
55
|
-
|
|
56
|
-
APIResponseWebhook = Sentdm::Models::APIResponseWebhook
|
|
57
|
-
|
|
58
42
|
AuthenticationConfig = Sentdm::Models::AuthenticationConfig
|
|
59
43
|
|
|
60
|
-
BillingContactInfo = Sentdm::Models::BillingContactInfo
|
|
61
|
-
|
|
62
|
-
BrandBusinessInfo = Sentdm::Models::BrandBusinessInfo
|
|
63
|
-
|
|
64
|
-
BrandComplianceInfo = Sentdm::Models::BrandComplianceInfo
|
|
65
|
-
|
|
66
|
-
BrandContactInfo = Sentdm::Models::BrandContactInfo
|
|
67
|
-
|
|
68
|
-
BrandsBrandData = Sentdm::Models::BrandsBrandData
|
|
69
|
-
|
|
70
44
|
ContactCreateParams = Sentdm::Models::ContactCreateParams
|
|
71
45
|
|
|
72
46
|
ContactDeleteParams = Sentdm::Models::ContactDeleteParams
|
|
73
47
|
|
|
74
48
|
ContactListParams = Sentdm::Models::ContactListParams
|
|
75
49
|
|
|
76
|
-
ContactMessageSummary = Sentdm::Models::ContactMessageSummary
|
|
77
|
-
|
|
78
|
-
ContactResponse = Sentdm::Models::ContactResponse
|
|
79
|
-
|
|
80
50
|
ContactRetrieveMessageSummaryParams = Sentdm::Models::ContactRetrieveMessageSummaryParams
|
|
81
51
|
|
|
82
52
|
ContactRetrieveParams = Sentdm::Models::ContactRetrieveParams
|
|
@@ -87,12 +57,8 @@ module Sentdm
|
|
|
87
57
|
|
|
88
58
|
ConversationListParams = Sentdm::Models::ConversationListParams
|
|
89
59
|
|
|
90
|
-
ConversationMessagesList = Sentdm::Models::ConversationMessagesList
|
|
91
|
-
|
|
92
60
|
DestinationCountry = Sentdm::Models::DestinationCountry
|
|
93
61
|
|
|
94
|
-
ErrorDetail = Sentdm::Models::ErrorDetail
|
|
95
|
-
|
|
96
62
|
InboundMessageEvent = Sentdm::Models::InboundMessageEvent
|
|
97
63
|
|
|
98
64
|
InboundMessageEventPayload = Sentdm::Models::InboundMessageEventPayload
|
|
@@ -109,38 +75,26 @@ module Sentdm
|
|
|
109
75
|
|
|
110
76
|
MessageSendParams = Sentdm::Models::MessageSendParams
|
|
111
77
|
|
|
112
|
-
MutationRequest = Sentdm::Models::MutationRequest
|
|
113
|
-
|
|
114
78
|
NumberLookupParams = Sentdm::Models::NumberLookupParams
|
|
115
79
|
|
|
116
|
-
PaginationMeta = Sentdm::Models::PaginationMeta
|
|
117
|
-
|
|
118
|
-
PaymentDetails = Sentdm::Models::PaymentDetails
|
|
119
|
-
|
|
120
80
|
ProfileCompleteParams = Sentdm::Models::ProfileCompleteParams
|
|
121
81
|
|
|
122
82
|
ProfileCreateParams = Sentdm::Models::ProfileCreateParams
|
|
123
83
|
|
|
124
84
|
ProfileDeleteParams = Sentdm::Models::ProfileDeleteParams
|
|
125
85
|
|
|
126
|
-
ProfileDetail = Sentdm::Models::ProfileDetail
|
|
127
|
-
|
|
128
86
|
ProfileListParams = Sentdm::Models::ProfileListParams
|
|
129
87
|
|
|
130
88
|
ProfileRetrieveParams = Sentdm::Models::ProfileRetrieveParams
|
|
131
89
|
|
|
132
90
|
Profiles = Sentdm::Models::Profiles
|
|
133
91
|
|
|
134
|
-
ProfileSettings = Sentdm::Models::ProfileSettings
|
|
135
|
-
|
|
136
92
|
ProfileUpdateParams = Sentdm::Models::ProfileUpdateParams
|
|
137
93
|
|
|
138
94
|
TcrBrandRelationship = Sentdm::Models::TcrBrandRelationship
|
|
139
95
|
|
|
140
96
|
TcrVertical = Sentdm::Models::TcrVertical
|
|
141
97
|
|
|
142
|
-
Template = Sentdm::Models::Template
|
|
143
|
-
|
|
144
98
|
TemplateBody = Sentdm::Models::TemplateBody
|
|
145
99
|
|
|
146
100
|
TemplateBodyContent = Sentdm::Models::TemplateBodyContent
|
|
@@ -177,8 +131,6 @@ module Sentdm
|
|
|
177
131
|
|
|
178
132
|
UserRemoveParams = Sentdm::Models::UserRemoveParams
|
|
179
133
|
|
|
180
|
-
UserResponse = Sentdm::Models::UserResponse
|
|
181
|
-
|
|
182
134
|
UserRetrieveParams = Sentdm::Models::UserRetrieveParams
|
|
183
135
|
|
|
184
136
|
UserUpdateRoleParams = Sentdm::Models::UserUpdateRoleParams
|
|
@@ -187,16 +139,12 @@ module Sentdm
|
|
|
187
139
|
|
|
188
140
|
WebhookDeleteParams = Sentdm::Models::WebhookDeleteParams
|
|
189
141
|
|
|
190
|
-
WebhookEventType = Sentdm::Models::WebhookEventType
|
|
191
|
-
|
|
192
142
|
WebhookListEventsParams = Sentdm::Models::WebhookListEventsParams
|
|
193
143
|
|
|
194
144
|
WebhookListEventTypesParams = Sentdm::Models::WebhookListEventTypesParams
|
|
195
145
|
|
|
196
146
|
WebhookListParams = Sentdm::Models::WebhookListParams
|
|
197
147
|
|
|
198
|
-
WebhookResponse = Sentdm::Models::WebhookResponse
|
|
199
|
-
|
|
200
148
|
WebhookRetrieveParams = Sentdm::Models::WebhookRetrieveParams
|
|
201
149
|
|
|
202
150
|
WebhookRotateSecretParams = Sentdm::Models::WebhookRotateSecretParams
|
|
@@ -2,7 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
module Sentdm
|
|
4
4
|
module Resources
|
|
5
|
-
#
|
|
5
|
+
# The people you message, and their channel identities.
|
|
6
|
+
#
|
|
7
|
+
# A contact holds one identity per channel — a phone number, a WhatsApp number —
|
|
8
|
+
# so routing can choose between them for the same person. Opt-out is recorded
|
|
9
|
+
# against the contact and honoured on every send, whichever channel it came
|
|
10
|
+
# through.
|
|
11
|
+
#
|
|
12
|
+
# `GET /v3/contacts/{id}/message-summary` is the per-contact view of what you have
|
|
13
|
+
# sent and what happened to it.
|
|
6
14
|
class Contacts
|
|
7
15
|
# Some parameter documentations has been truncated, see
|
|
8
16
|
# {Sentdm::Models::ContactCreateParams} for more details.
|
|
@@ -22,7 +30,7 @@ module Sentdm
|
|
|
22
30
|
#
|
|
23
31
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
24
32
|
#
|
|
25
|
-
# @return [Sentdm::Models::
|
|
33
|
+
# @return [Sentdm::Models::ContactCreateResponse]
|
|
26
34
|
#
|
|
27
35
|
# @see Sentdm::Models::ContactCreateParams
|
|
28
36
|
def create(params)
|
|
@@ -33,7 +41,7 @@ module Sentdm
|
|
|
33
41
|
path: "v3/contacts",
|
|
34
42
|
headers: parsed.slice(*header_params.keys).transform_keys(header_params),
|
|
35
43
|
body: parsed.except(*header_params.keys),
|
|
36
|
-
model: Sentdm::
|
|
44
|
+
model: Sentdm::Models::ContactCreateResponse,
|
|
37
45
|
options: options
|
|
38
46
|
)
|
|
39
47
|
end
|
|
@@ -53,7 +61,7 @@ module Sentdm
|
|
|
53
61
|
#
|
|
54
62
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
55
63
|
#
|
|
56
|
-
# @return [Sentdm::Models::
|
|
64
|
+
# @return [Sentdm::Models::ContactRetrieveResponse]
|
|
57
65
|
#
|
|
58
66
|
# @see Sentdm::Models::ContactRetrieveParams
|
|
59
67
|
def retrieve(id, params = {})
|
|
@@ -62,7 +70,7 @@ module Sentdm
|
|
|
62
70
|
method: :get,
|
|
63
71
|
path: ["v3/contacts/%1$s", id],
|
|
64
72
|
headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
|
|
65
|
-
model: Sentdm::
|
|
73
|
+
model: Sentdm::Models::ContactRetrieveResponse,
|
|
66
74
|
options: options
|
|
67
75
|
)
|
|
68
76
|
end
|
|
@@ -70,8 +78,7 @@ module Sentdm
|
|
|
70
78
|
# Some parameter documentations has been truncated, see
|
|
71
79
|
# {Sentdm::Models::ContactUpdateParams} for more details.
|
|
72
80
|
#
|
|
73
|
-
# Updates a contact's default channel and/or opt-out status.
|
|
74
|
-
# cannot be updated.
|
|
81
|
+
# Updates a contact's default channel and/or opt-out status.
|
|
75
82
|
#
|
|
76
83
|
# @overload update(id, default_channel: nil, opt_out: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
|
|
77
84
|
#
|
|
@@ -89,7 +96,7 @@ module Sentdm
|
|
|
89
96
|
#
|
|
90
97
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
91
98
|
#
|
|
92
|
-
# @return [Sentdm::Models::
|
|
99
|
+
# @return [Sentdm::Models::ContactUpdateResponse]
|
|
93
100
|
#
|
|
94
101
|
# @see Sentdm::Models::ContactUpdateParams
|
|
95
102
|
def update(id, params = {})
|
|
@@ -100,7 +107,7 @@ module Sentdm
|
|
|
100
107
|
path: ["v3/contacts/%1$s", id],
|
|
101
108
|
headers: parsed.slice(*header_params.keys).transform_keys(header_params),
|
|
102
109
|
body: parsed.except(*header_params.keys),
|
|
103
|
-
model: Sentdm::
|
|
110
|
+
model: Sentdm::Models::ContactUpdateResponse,
|
|
104
111
|
options: options
|
|
105
112
|
)
|
|
106
113
|
end
|
|
@@ -144,11 +151,21 @@ module Sentdm
|
|
|
144
151
|
)
|
|
145
152
|
end
|
|
146
153
|
|
|
154
|
+
# @deprecated
|
|
155
|
+
#
|
|
147
156
|
# Some parameter documentations has been truncated, see
|
|
148
157
|
# {Sentdm::Models::ContactDeleteParams} for more details.
|
|
149
158
|
#
|
|
150
|
-
#
|
|
151
|
-
# be
|
|
159
|
+
# **Deprecated.** Use `PATCH /v3/contacts/{id}` with `{"opt_out": true}` instead,
|
|
160
|
+
# and expect this to be removed in a future release. It still behaves exactly as
|
|
161
|
+
# before, so nothing needs to change today.
|
|
162
|
+
#
|
|
163
|
+
# Opting a contact out stops every send to them, which is what deleting one was
|
|
164
|
+
# mostly used for — and it keeps the record of who they were and that they asked.
|
|
165
|
+
# A delete discards the consent history along with the contact, which is the part
|
|
166
|
+
# you need if anyone ever asks why you stopped, or why you started again.
|
|
167
|
+
#
|
|
168
|
+
# Dissociates a contact from the authenticated customer.
|
|
152
169
|
#
|
|
153
170
|
# @overload delete(id, sandbox: nil, x_profile_id: nil, request_options: {})
|
|
154
171
|
#
|
|
@@ -192,7 +209,7 @@ module Sentdm
|
|
|
192
209
|
#
|
|
193
210
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
194
211
|
#
|
|
195
|
-
# @return [Sentdm::Models::
|
|
212
|
+
# @return [Sentdm::Models::ContactRetrieveMessageSummaryResponse]
|
|
196
213
|
#
|
|
197
214
|
# @see Sentdm::Models::ContactRetrieveMessageSummaryParams
|
|
198
215
|
def retrieve_message_summary(contact_id, params = {})
|
|
@@ -201,7 +218,7 @@ module Sentdm
|
|
|
201
218
|
method: :get,
|
|
202
219
|
path: ["v3/contacts/%1$s/message-summary", contact_id],
|
|
203
220
|
headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
|
|
204
|
-
model: Sentdm::
|
|
221
|
+
model: Sentdm::Models::ContactRetrieveMessageSummaryResponse,
|
|
205
222
|
options: options
|
|
206
223
|
)
|
|
207
224
|
end
|