sentdm 0.5.0 → 0.8.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 +41 -0
- data/README.md +31 -1
- data/lib/sentdm/internal/type/base_model.rb +5 -5
- data/lib/sentdm/models/api_response_of_contact.rb +9 -6
- data/lib/sentdm/models/api_response_of_profile_detail.rb +6 -6
- data/lib/sentdm/models/api_response_of_user.rb +6 -6
- data/lib/sentdm/models/api_response_template.rb +6 -6
- data/lib/sentdm/models/api_response_webhook.rb +4 -4
- data/lib/sentdm/models/brands_brand_data.rb +16 -252
- data/lib/sentdm/models/contact_delete_params.rb +1 -1
- data/lib/sentdm/models/contact_list_response.rb +9 -9
- data/lib/sentdm/models/me_retrieve_response.rb +35 -21
- data/lib/sentdm/models/message_retrieve_activities_response.rb +7 -7
- data/lib/sentdm/models/message_retrieve_status_response.rb +7 -7
- data/lib/sentdm/models/message_send_params.rb +5 -3
- data/lib/sentdm/models/message_send_response.rb +7 -7
- data/lib/sentdm/models/{mutation_request_base.rb → mutation_request.rb} +2 -2
- data/lib/sentdm/models/number_lookup_response.rb +4 -4
- data/lib/sentdm/models/pagination_meta.rb +3 -3
- data/lib/sentdm/models/{profile_complete_setup_params.rb → profile_complete_params.rb} +3 -3
- data/lib/sentdm/models/{profile_complete_setup_response.rb → profile_complete_response.rb} +1 -1
- data/lib/sentdm/models/profile_create_params.rb +20 -23
- data/lib/sentdm/models/profile_delete_params.rb +1 -1
- data/lib/sentdm/models/profile_detail.rb +12 -22
- data/lib/sentdm/models/profile_list_response.rb +7 -7
- data/lib/sentdm/models/profile_update_params.rb +9 -13
- data/lib/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rb +4 -4
- data/lib/sentdm/models/profiles/base_dto.rb +32 -0
- data/lib/sentdm/models/profiles/campaign_create_params.rb +2 -2
- data/lib/sentdm/models/profiles/campaign_data.rb +5 -26
- data/lib/sentdm/models/profiles/campaign_delete_params.rb +1 -1
- data/lib/sentdm/models/profiles/campaign_list_response.rb +4 -4
- data/lib/sentdm/models/profiles/campaign_update_params.rb +2 -2
- data/lib/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rb +29 -0
- data/lib/sentdm/models/profiles/tcr_campaign_with_use_cases.rb +2 -2
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rb +34 -0
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rb +40 -0
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rb +38 -0
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rb +81 -0
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rb +34 -0
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rb +39 -0
- data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rb +116 -0
- data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rb +75 -0
- data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info.rb +58 -0
- data/lib/sentdm/models/template_create_params.rb +3 -2
- data/lib/sentdm/models/template_definition.rb +19 -263
- data/lib/sentdm/models/template_list_response.rb +9 -9
- data/lib/sentdm/models/template_update_params.rb +3 -2
- data/lib/sentdm/models/user_list_response.rb +7 -7
- data/lib/sentdm/models/user_remove_params.rb +1 -1
- data/lib/sentdm/models/webhook_list_event_types_response.rb +4 -4
- data/lib/sentdm/models/webhook_list_events_response.rb +4 -4
- data/lib/sentdm/models/webhook_list_response.rb +4 -4
- data/lib/sentdm/models/webhook_rotate_secret_params.rb +1 -1
- data/lib/sentdm/models/webhook_rotate_secret_response.rb +4 -4
- data/lib/sentdm/models/webhook_test_response.rb +4 -4
- data/lib/sentdm/models.rb +29 -4
- data/lib/sentdm/resources/messages.rb +1 -1
- data/lib/sentdm/resources/profiles/campaigns.rb +2 -2
- data/lib/sentdm/resources/profiles.rb +12 -12
- data/lib/sentdm/resources/templates.rb +2 -2
- data/lib/sentdm/version.rb +1 -1
- data/lib/sentdm.rb +14 -4
- data/rbi/sentdm/models/api_response_of_contact.rbi +6 -6
- data/rbi/sentdm/models/api_response_of_profile_detail.rbi +6 -6
- data/rbi/sentdm/models/api_response_of_user.rbi +6 -6
- data/rbi/sentdm/models/api_response_template.rbi +6 -6
- data/rbi/sentdm/models/api_response_webhook.rbi +4 -4
- data/rbi/sentdm/models/brands_brand_data.rbi +53 -355
- data/rbi/sentdm/models/contact_delete_params.rbi +1 -1
- data/rbi/sentdm/models/contact_list_response.rbi +9 -9
- data/rbi/sentdm/models/me_retrieve_response.rbi +33 -21
- data/rbi/sentdm/models/message_retrieve_activities_response.rbi +7 -7
- data/rbi/sentdm/models/message_retrieve_status_response.rbi +7 -7
- data/rbi/sentdm/models/message_send_params.rbi +6 -3
- data/rbi/sentdm/models/message_send_response.rbi +7 -7
- data/rbi/sentdm/models/{mutation_request_base.rbi → mutation_request.rbi} +2 -2
- data/rbi/sentdm/models/number_lookup_response.rbi +4 -4
- data/rbi/sentdm/models/pagination_meta.rbi +3 -3
- data/rbi/sentdm/models/{profile_complete_setup_params.rbi → profile_complete_params.rbi} +2 -2
- data/rbi/sentdm/models/{profile_complete_setup_response.rbi → profile_complete_response.rbi} +1 -1
- data/rbi/sentdm/models/profile_create_params.rbi +27 -33
- data/rbi/sentdm/models/profile_delete_params.rbi +1 -1
- data/rbi/sentdm/models/profile_detail.rbi +9 -22
- data/rbi/sentdm/models/profile_list_response.rbi +7 -7
- data/rbi/sentdm/models/profile_update_params.rbi +12 -20
- data/rbi/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rbi +4 -4
- data/rbi/sentdm/models/profiles/base_dto.rbi +53 -0
- data/rbi/sentdm/models/profiles/campaign_create_params.rbi +2 -2
- data/rbi/sentdm/models/profiles/campaign_data.rbi +14 -49
- data/rbi/sentdm/models/profiles/campaign_delete_params.rbi +1 -1
- data/rbi/sentdm/models/profiles/campaign_list_response.rbi +4 -4
- data/rbi/sentdm/models/profiles/campaign_update_params.rbi +2 -2
- data/rbi/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbi +51 -0
- data/rbi/sentdm/models/profiles/tcr_campaign_with_use_cases.rbi +2 -2
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rbi +56 -0
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rbi +76 -0
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rbi +79 -0
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rbi +104 -0
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rbi +60 -0
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rbi +62 -0
- data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rbi +180 -0
- data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rbi +95 -0
- data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info.rbi +81 -0
- data/rbi/sentdm/models/template_create_params.rbi +4 -2
- data/rbi/sentdm/models/template_definition.rbi +82 -415
- data/rbi/sentdm/models/template_list_response.rbi +9 -9
- data/rbi/sentdm/models/template_update_params.rbi +4 -2
- data/rbi/sentdm/models/user_list_response.rbi +7 -7
- data/rbi/sentdm/models/user_remove_params.rbi +1 -1
- data/rbi/sentdm/models/webhook_list_event_types_response.rbi +4 -4
- data/rbi/sentdm/models/webhook_list_events_response.rbi +4 -4
- data/rbi/sentdm/models/webhook_list_response.rbi +4 -4
- data/rbi/sentdm/models/webhook_rotate_secret_params.rbi +1 -1
- data/rbi/sentdm/models/webhook_rotate_secret_response.rbi +4 -4
- data/rbi/sentdm/models/webhook_test_response.rbi +4 -4
- data/rbi/sentdm/models.rbi +29 -4
- data/rbi/sentdm/resources/messages.rbi +2 -1
- data/rbi/sentdm/resources/profiles/campaigns.rbi +2 -2
- data/rbi/sentdm/resources/profiles.rbi +20 -26
- data/rbi/sentdm/resources/templates.rbi +4 -2
- data/sig/sentdm/models/brands_brand_data.rbs +12 -192
- data/sig/sentdm/models/contact_delete_params.rbs +1 -1
- data/sig/sentdm/models/{mutation_request_base.rbs → mutation_request.rbs} +2 -2
- data/sig/sentdm/models/{profile_complete_setup_params.rbs → profile_complete_params.rbs} +2 -2
- data/sig/sentdm/models/profile_complete_response.rbs +5 -0
- data/sig/sentdm/models/profile_delete_params.rbs +1 -1
- data/sig/sentdm/models/profiles/base_dto.rbs +27 -0
- data/sig/sentdm/models/profiles/campaign_data.rbs +4 -26
- data/sig/sentdm/models/profiles/campaign_delete_params.rbs +1 -1
- data/sig/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbs +27 -0
- data/sig/sentdm/models/profiles/tcr_campaign_with_use_cases.rbs +2 -2
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rbs +24 -0
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rbs +30 -0
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rbs +38 -0
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rbs +75 -0
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rbs +32 -0
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rbs +32 -0
- data/sig/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rbs +89 -0
- data/sig/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rbs +55 -0
- data/sig/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info.rbs +45 -0
- data/sig/sentdm/models/template_definition.rbs +20 -233
- data/sig/sentdm/models/user_remove_params.rbs +1 -1
- data/sig/sentdm/models/webhook_rotate_secret_params.rbs +1 -1
- data/sig/sentdm/models.rbs +20 -4
- data/sig/sentdm/resources/profiles.rbs +1 -1
- metadata +44 -14
- data/lib/sentdm/models/base_dto.rb +0 -30
- data/rbi/sentdm/models/base_dto.rbi +0 -49
- data/sig/sentdm/models/base_dto.rbs +0 -25
- data/sig/sentdm/models/profile_complete_setup_response.rbs +0 -5
|
@@ -4,28 +4,27 @@ module Sentdm
|
|
|
4
4
|
module Models
|
|
5
5
|
class TemplateDefinition < Sentdm::Internal::Type::BaseModel
|
|
6
6
|
# @!attribute body
|
|
7
|
-
#
|
|
8
|
-
# SMS-specific, or WhatsApp-specific)
|
|
7
|
+
# Body section of a message template with channel-specific content
|
|
9
8
|
#
|
|
10
|
-
# @return [Sentdm::Models::
|
|
11
|
-
required :body, -> { Sentdm::
|
|
9
|
+
# @return [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateBody]
|
|
10
|
+
required :body, -> { Sentdm::SentDmServicesCommonContractsPocOsTemplateBody }
|
|
12
11
|
|
|
13
12
|
# @!attribute authentication_config
|
|
14
|
-
# Configuration
|
|
13
|
+
# Configuration for AUTHENTICATION category templates
|
|
15
14
|
#
|
|
16
|
-
# @return [Sentdm::Models::
|
|
15
|
+
# @return [Sentdm::Models::SentDmServicesCommonContractsPocOsAuthenticationConfig, nil]
|
|
17
16
|
optional :authentication_config,
|
|
18
|
-
-> { Sentdm::
|
|
17
|
+
-> { Sentdm::SentDmServicesCommonContractsPocOsAuthenticationConfig },
|
|
19
18
|
api_name: :authenticationConfig,
|
|
20
19
|
nil?: true
|
|
21
20
|
|
|
22
21
|
# @!attribute buttons
|
|
23
22
|
# Optional list of interactive buttons (e.g., quick replies, URLs, phone numbers)
|
|
24
23
|
#
|
|
25
|
-
# @return [Array<Sentdm::Models::
|
|
24
|
+
# @return [Array<Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButton>, nil]
|
|
26
25
|
optional :buttons,
|
|
27
26
|
-> {
|
|
28
|
-
Sentdm::Internal::Type::ArrayOf[Sentdm::
|
|
27
|
+
Sentdm::Internal::Type::ArrayOf[Sentdm::SentDmServicesCommonContractsPocOsTemplateButton]
|
|
29
28
|
},
|
|
30
29
|
nil?: true
|
|
31
30
|
|
|
@@ -36,275 +35,32 @@ module Sentdm
|
|
|
36
35
|
optional :definition_version, String, api_name: :definitionVersion, nil?: true
|
|
37
36
|
|
|
38
37
|
# @!attribute footer
|
|
39
|
-
#
|
|
38
|
+
# Footer section of a message template
|
|
40
39
|
#
|
|
41
|
-
# @return [Sentdm::Models::
|
|
42
|
-
optional :footer, -> { Sentdm::
|
|
40
|
+
# @return [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateFooter, nil]
|
|
41
|
+
optional :footer, -> { Sentdm::SentDmServicesCommonContractsPocOsTemplateFooter }, nil?: true
|
|
43
42
|
|
|
44
43
|
# @!attribute header
|
|
45
|
-
#
|
|
44
|
+
# Header section of a message template
|
|
46
45
|
#
|
|
47
|
-
# @return [Sentdm::Models::
|
|
48
|
-
optional :header, -> { Sentdm::
|
|
46
|
+
# @return [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateHeader, nil]
|
|
47
|
+
optional :header, -> { Sentdm::SentDmServicesCommonContractsPocOsTemplateHeader }, nil?: true
|
|
49
48
|
|
|
50
49
|
# @!method initialize(body:, authentication_config: nil, buttons: nil, definition_version: nil, footer: nil, header: nil)
|
|
51
|
-
# Some parameter documentations has been truncated, see
|
|
52
|
-
# {Sentdm::Models::TemplateDefinition} for more details.
|
|
53
|
-
#
|
|
54
50
|
# Complete definition of a message template including header, body, footer, and
|
|
55
51
|
# buttons
|
|
56
52
|
#
|
|
57
|
-
# @param body [Sentdm::Models::
|
|
53
|
+
# @param body [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateBody] Body section of a message template with channel-specific content
|
|
58
54
|
#
|
|
59
|
-
# @param authentication_config [Sentdm::Models::
|
|
55
|
+
# @param authentication_config [Sentdm::Models::SentDmServicesCommonContractsPocOsAuthenticationConfig, nil] Configuration for AUTHENTICATION category templates
|
|
60
56
|
#
|
|
61
|
-
# @param buttons [Array<Sentdm::Models::
|
|
57
|
+
# @param buttons [Array<Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButton>, nil] Optional list of interactive buttons (e.g., quick replies, URLs, phone numbers)
|
|
62
58
|
#
|
|
63
59
|
# @param definition_version [String, nil] The version of the template definition format
|
|
64
60
|
#
|
|
65
|
-
# @param footer [Sentdm::Models::
|
|
61
|
+
# @param footer [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateFooter, nil] Footer section of a message template
|
|
66
62
|
#
|
|
67
|
-
# @param header [Sentdm::Models::
|
|
68
|
-
|
|
69
|
-
# @see Sentdm::Models::TemplateDefinition#body
|
|
70
|
-
class Body < Sentdm::Internal::Type::BaseModel
|
|
71
|
-
# @!attribute multi_channel
|
|
72
|
-
# Content that will be used for all channels (SMS and WhatsApp) unless
|
|
73
|
-
# channel-specific content is provided
|
|
74
|
-
#
|
|
75
|
-
# @return [Sentdm::Models::TemplateBodyContent, nil]
|
|
76
|
-
optional :multi_channel, -> { Sentdm::TemplateBodyContent }, api_name: :multiChannel, nil?: true
|
|
77
|
-
|
|
78
|
-
# @!attribute sms
|
|
79
|
-
# SMS-specific content that overrides multi-channel content for SMS messages
|
|
80
|
-
#
|
|
81
|
-
# @return [Sentdm::Models::TemplateBodyContent, nil]
|
|
82
|
-
optional :sms, -> { Sentdm::TemplateBodyContent }, nil?: true
|
|
83
|
-
|
|
84
|
-
# @!attribute whatsapp
|
|
85
|
-
# WhatsApp-specific content that overrides multi-channel content for WhatsApp
|
|
86
|
-
# messages
|
|
87
|
-
#
|
|
88
|
-
# @return [Sentdm::Models::TemplateBodyContent, nil]
|
|
89
|
-
optional :whatsapp, -> { Sentdm::TemplateBodyContent }, nil?: true
|
|
90
|
-
|
|
91
|
-
# @!method initialize(multi_channel: nil, sms: nil, whatsapp: nil)
|
|
92
|
-
# Some parameter documentations has been truncated, see
|
|
93
|
-
# {Sentdm::Models::TemplateDefinition::Body} for more details.
|
|
94
|
-
#
|
|
95
|
-
# Required template body with content for different channels (multi-channel,
|
|
96
|
-
# SMS-specific, or WhatsApp-specific)
|
|
97
|
-
#
|
|
98
|
-
# @param multi_channel [Sentdm::Models::TemplateBodyContent, nil] Content that will be used for all channels (SMS and WhatsApp) unless channel-spe
|
|
99
|
-
#
|
|
100
|
-
# @param sms [Sentdm::Models::TemplateBodyContent, nil] SMS-specific content that overrides multi-channel content for SMS messages
|
|
101
|
-
#
|
|
102
|
-
# @param whatsapp [Sentdm::Models::TemplateBodyContent, nil] WhatsApp-specific content that overrides multi-channel content for WhatsApp mess
|
|
103
|
-
end
|
|
104
|
-
|
|
105
|
-
# @see Sentdm::Models::TemplateDefinition#authentication_config
|
|
106
|
-
class AuthenticationConfig < Sentdm::Internal::Type::BaseModel
|
|
107
|
-
# @!attribute add_security_recommendation
|
|
108
|
-
# Whether to add the security recommendation text: "For your security, do not
|
|
109
|
-
# share this code."
|
|
110
|
-
#
|
|
111
|
-
# @return [Boolean, nil]
|
|
112
|
-
optional :add_security_recommendation,
|
|
113
|
-
Sentdm::Internal::Type::Boolean,
|
|
114
|
-
api_name: :addSecurityRecommendation
|
|
115
|
-
|
|
116
|
-
# @!attribute code_expiration_minutes
|
|
117
|
-
# Code expiration time in minutes (1-90). If set, adds footer: "This code expires
|
|
118
|
-
# in X minutes."
|
|
119
|
-
#
|
|
120
|
-
# @return [Integer, nil]
|
|
121
|
-
optional :code_expiration_minutes, Integer, api_name: :codeExpirationMinutes, nil?: true
|
|
122
|
-
|
|
123
|
-
# @!method initialize(add_security_recommendation: nil, code_expiration_minutes: nil)
|
|
124
|
-
# Some parameter documentations has been truncated, see
|
|
125
|
-
# {Sentdm::Models::TemplateDefinition::AuthenticationConfig} for more details.
|
|
126
|
-
#
|
|
127
|
-
# Configuration specific to AUTHENTICATION category templates (optional)
|
|
128
|
-
#
|
|
129
|
-
# @param add_security_recommendation [Boolean] Whether to add the security recommendation text: "For your security, do not shar
|
|
130
|
-
#
|
|
131
|
-
# @param code_expiration_minutes [Integer, nil] Code expiration time in minutes (1-90). If set, adds footer: "This code expires
|
|
132
|
-
end
|
|
133
|
-
|
|
134
|
-
class Button < Sentdm::Internal::Type::BaseModel
|
|
135
|
-
# @!attribute id
|
|
136
|
-
# The unique identifier of the button (1-based index)
|
|
137
|
-
#
|
|
138
|
-
# @return [Integer, nil]
|
|
139
|
-
optional :id, Integer
|
|
140
|
-
|
|
141
|
-
# @!attribute props
|
|
142
|
-
# Properties specific to the button type
|
|
143
|
-
#
|
|
144
|
-
# @return [Sentdm::Models::TemplateDefinition::Button::Props, nil]
|
|
145
|
-
optional :props, -> { Sentdm::TemplateDefinition::Button::Props }
|
|
146
|
-
|
|
147
|
-
# @!attribute type
|
|
148
|
-
# The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
|
|
149
|
-
#
|
|
150
|
-
# @return [String, nil]
|
|
151
|
-
optional :type, String
|
|
152
|
-
|
|
153
|
-
# @!method initialize(id: nil, props: nil, type: nil)
|
|
154
|
-
# Some parameter documentations has been truncated, see
|
|
155
|
-
# {Sentdm::Models::TemplateDefinition::Button} for more details.
|
|
156
|
-
#
|
|
157
|
-
# Interactive button in a message template
|
|
158
|
-
#
|
|
159
|
-
# @param id [Integer] The unique identifier of the button (1-based index)
|
|
160
|
-
#
|
|
161
|
-
# @param props [Sentdm::Models::TemplateDefinition::Button::Props] Properties specific to the button type
|
|
162
|
-
#
|
|
163
|
-
# @param type [String] The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
|
|
164
|
-
|
|
165
|
-
# @see Sentdm::Models::TemplateDefinition::Button#props
|
|
166
|
-
class Props < Sentdm::Internal::Type::BaseModel
|
|
167
|
-
# @!attribute active_for
|
|
168
|
-
#
|
|
169
|
-
# @return [Integer, nil]
|
|
170
|
-
optional :active_for, Integer, api_name: :activeFor, nil?: true
|
|
171
|
-
|
|
172
|
-
# @!attribute autofill_text
|
|
173
|
-
#
|
|
174
|
-
# @return [String, nil]
|
|
175
|
-
optional :autofill_text, String, api_name: :autofillText, nil?: true
|
|
176
|
-
|
|
177
|
-
# @!attribute country_code
|
|
178
|
-
#
|
|
179
|
-
# @return [String, nil]
|
|
180
|
-
optional :country_code, String, api_name: :countryCode, nil?: true
|
|
181
|
-
|
|
182
|
-
# @!attribute offer_code
|
|
183
|
-
#
|
|
184
|
-
# @return [String, nil]
|
|
185
|
-
optional :offer_code, String, api_name: :offerCode, nil?: true
|
|
186
|
-
|
|
187
|
-
# @!attribute otp_type
|
|
188
|
-
#
|
|
189
|
-
# @return [String, nil]
|
|
190
|
-
optional :otp_type, String, api_name: :otpType, nil?: true
|
|
191
|
-
|
|
192
|
-
# @!attribute package_name
|
|
193
|
-
#
|
|
194
|
-
# @return [String, nil]
|
|
195
|
-
optional :package_name, String, api_name: :packageName, nil?: true
|
|
196
|
-
|
|
197
|
-
# @!attribute phone_number
|
|
198
|
-
#
|
|
199
|
-
# @return [String, nil]
|
|
200
|
-
optional :phone_number, String, api_name: :phoneNumber, nil?: true
|
|
201
|
-
|
|
202
|
-
# @!attribute quick_reply_type
|
|
203
|
-
#
|
|
204
|
-
# @return [String, nil]
|
|
205
|
-
optional :quick_reply_type, String, api_name: :quickReplyType, nil?: true
|
|
206
|
-
|
|
207
|
-
# @!attribute signature_hash
|
|
208
|
-
#
|
|
209
|
-
# @return [String, nil]
|
|
210
|
-
optional :signature_hash, String, api_name: :signatureHash, nil?: true
|
|
211
|
-
|
|
212
|
-
# @!attribute text
|
|
213
|
-
#
|
|
214
|
-
# @return [String, nil]
|
|
215
|
-
optional :text, String, nil?: true
|
|
216
|
-
|
|
217
|
-
# @!attribute url
|
|
218
|
-
#
|
|
219
|
-
# @return [String, nil]
|
|
220
|
-
optional :url, String, nil?: true
|
|
221
|
-
|
|
222
|
-
# @!attribute url_type
|
|
223
|
-
#
|
|
224
|
-
# @return [String, nil]
|
|
225
|
-
optional :url_type, String, api_name: :urlType, nil?: true
|
|
226
|
-
|
|
227
|
-
# @!method initialize(active_for: nil, autofill_text: nil, country_code: nil, offer_code: nil, otp_type: nil, package_name: nil, phone_number: nil, quick_reply_type: nil, signature_hash: nil, text: nil, url: nil, url_type: nil)
|
|
228
|
-
# Properties specific to the button type
|
|
229
|
-
#
|
|
230
|
-
# @param active_for [Integer, nil]
|
|
231
|
-
# @param autofill_text [String, nil]
|
|
232
|
-
# @param country_code [String, nil]
|
|
233
|
-
# @param offer_code [String, nil]
|
|
234
|
-
# @param otp_type [String, nil]
|
|
235
|
-
# @param package_name [String, nil]
|
|
236
|
-
# @param phone_number [String, nil]
|
|
237
|
-
# @param quick_reply_type [String, nil]
|
|
238
|
-
# @param signature_hash [String, nil]
|
|
239
|
-
# @param text [String, nil]
|
|
240
|
-
# @param url [String, nil]
|
|
241
|
-
# @param url_type [String, nil]
|
|
242
|
-
end
|
|
243
|
-
end
|
|
244
|
-
|
|
245
|
-
# @see Sentdm::Models::TemplateDefinition#footer
|
|
246
|
-
class Footer < Sentdm::Internal::Type::BaseModel
|
|
247
|
-
# @!attribute template
|
|
248
|
-
# The footer template text with optional variable placeholders
|
|
249
|
-
#
|
|
250
|
-
# @return [String, nil]
|
|
251
|
-
optional :template, String
|
|
252
|
-
|
|
253
|
-
# @!attribute type
|
|
254
|
-
# The type of footer (typically "text")
|
|
255
|
-
#
|
|
256
|
-
# @return [String, nil]
|
|
257
|
-
optional :type, String, nil?: true
|
|
258
|
-
|
|
259
|
-
# @!attribute variables
|
|
260
|
-
# List of variables used in the footer template
|
|
261
|
-
#
|
|
262
|
-
# @return [Array<Sentdm::Models::TemplateVariable>, nil]
|
|
263
|
-
optional :variables, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateVariable] }, nil?: true
|
|
264
|
-
|
|
265
|
-
# @!method initialize(template: nil, type: nil, variables: nil)
|
|
266
|
-
# Optional template footer with optional variables
|
|
267
|
-
#
|
|
268
|
-
# @param template [String] The footer template text with optional variable placeholders
|
|
269
|
-
#
|
|
270
|
-
# @param type [String, nil] The type of footer (typically "text")
|
|
271
|
-
#
|
|
272
|
-
# @param variables [Array<Sentdm::Models::TemplateVariable>, nil] List of variables used in the footer template
|
|
273
|
-
end
|
|
274
|
-
|
|
275
|
-
# @see Sentdm::Models::TemplateDefinition#header
|
|
276
|
-
class Header < Sentdm::Internal::Type::BaseModel
|
|
277
|
-
# @!attribute template
|
|
278
|
-
# The header template text with optional variable placeholders (e.g., "Welcome to
|
|
279
|
-
# {{0:variable}}")
|
|
280
|
-
#
|
|
281
|
-
# @return [String, nil]
|
|
282
|
-
optional :template, String
|
|
283
|
-
|
|
284
|
-
# @!attribute type
|
|
285
|
-
# The type of header (e.g., "text", "image", "video", "document")
|
|
286
|
-
#
|
|
287
|
-
# @return [String, nil]
|
|
288
|
-
optional :type, String, nil?: true
|
|
289
|
-
|
|
290
|
-
# @!attribute variables
|
|
291
|
-
# List of variables used in the header template
|
|
292
|
-
#
|
|
293
|
-
# @return [Array<Sentdm::Models::TemplateVariable>, nil]
|
|
294
|
-
optional :variables, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateVariable] }, nil?: true
|
|
295
|
-
|
|
296
|
-
# @!method initialize(template: nil, type: nil, variables: nil)
|
|
297
|
-
# Some parameter documentations has been truncated, see
|
|
298
|
-
# {Sentdm::Models::TemplateDefinition::Header} for more details.
|
|
299
|
-
#
|
|
300
|
-
# Optional template header with optional variables
|
|
301
|
-
#
|
|
302
|
-
# @param template [String] The header template text with optional variable placeholders (e.g., "Welcome to
|
|
303
|
-
#
|
|
304
|
-
# @param type [String, nil] The type of header (e.g., "text", "image", "video", "document")
|
|
305
|
-
#
|
|
306
|
-
# @param variables [Array<Sentdm::Models::TemplateVariable>, nil] List of variables used in the header template
|
|
307
|
-
end
|
|
63
|
+
# @param header [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateHeader, nil] Header section of a message template
|
|
308
64
|
end
|
|
309
65
|
end
|
|
310
66
|
end
|
|
@@ -5,19 +5,19 @@ module Sentdm
|
|
|
5
5
|
# @see Sentdm::Resources::Templates#list
|
|
6
6
|
class TemplateListResponse < Sentdm::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute data
|
|
8
|
-
#
|
|
8
|
+
# Paginated list of templates
|
|
9
9
|
#
|
|
10
10
|
# @return [Sentdm::Models::TemplateListResponse::Data, nil]
|
|
11
11
|
optional :data, -> { Sentdm::Models::TemplateListResponse::Data }, nil?: true
|
|
12
12
|
|
|
13
13
|
# @!attribute error
|
|
14
|
-
# Error
|
|
14
|
+
# Error information
|
|
15
15
|
#
|
|
16
16
|
# @return [Sentdm::Models::APIError, nil]
|
|
17
17
|
optional :error, -> { Sentdm::APIError }, nil?: true
|
|
18
18
|
|
|
19
19
|
# @!attribute meta
|
|
20
|
-
#
|
|
20
|
+
# Request and response metadata
|
|
21
21
|
#
|
|
22
22
|
# @return [Sentdm::Models::APIMeta, nil]
|
|
23
23
|
optional :meta, -> { Sentdm::APIMeta }
|
|
@@ -31,18 +31,18 @@ module Sentdm
|
|
|
31
31
|
# @!method initialize(data: nil, error: nil, meta: nil, success: nil)
|
|
32
32
|
# Standard API response envelope for all v3 endpoints
|
|
33
33
|
#
|
|
34
|
-
# @param data [Sentdm::Models::TemplateListResponse::Data, nil]
|
|
34
|
+
# @param data [Sentdm::Models::TemplateListResponse::Data, nil] Paginated list of templates
|
|
35
35
|
#
|
|
36
|
-
# @param error [Sentdm::Models::APIError, nil] Error
|
|
36
|
+
# @param error [Sentdm::Models::APIError, nil] Error information
|
|
37
37
|
#
|
|
38
|
-
# @param meta [Sentdm::Models::APIMeta]
|
|
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
|
|
|
42
42
|
# @see Sentdm::Models::TemplateListResponse#data
|
|
43
43
|
class Data < Sentdm::Internal::Type::BaseModel
|
|
44
44
|
# @!attribute pagination
|
|
45
|
-
# Pagination metadata
|
|
45
|
+
# Pagination metadata for list responses
|
|
46
46
|
#
|
|
47
47
|
# @return [Sentdm::Models::PaginationMeta, nil]
|
|
48
48
|
optional :pagination, -> { Sentdm::PaginationMeta }
|
|
@@ -54,9 +54,9 @@ module Sentdm
|
|
|
54
54
|
optional :templates, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Template] }
|
|
55
55
|
|
|
56
56
|
# @!method initialize(pagination: nil, templates: nil)
|
|
57
|
-
#
|
|
57
|
+
# Paginated list of templates
|
|
58
58
|
#
|
|
59
|
-
# @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata
|
|
59
|
+
# @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
|
|
60
60
|
#
|
|
61
61
|
# @param templates [Array<Sentdm::Models::Template>] List of templates
|
|
62
62
|
end
|
|
@@ -19,7 +19,8 @@ module Sentdm
|
|
|
19
19
|
optional :category, String, nil?: true
|
|
20
20
|
|
|
21
21
|
# @!attribute definition
|
|
22
|
-
#
|
|
22
|
+
# Complete definition of a message template including header, body, footer, and
|
|
23
|
+
# buttons
|
|
23
24
|
#
|
|
24
25
|
# @return [Sentdm::Models::TemplateDefinition, nil]
|
|
25
26
|
optional :definition, -> { Sentdm::TemplateDefinition }, nil?: true
|
|
@@ -67,7 +68,7 @@ module Sentdm
|
|
|
67
68
|
#
|
|
68
69
|
# @param category [String, nil] Template category: MARKETING, UTILITY, AUTHENTICATION
|
|
69
70
|
#
|
|
70
|
-
# @param definition [Sentdm::Models::TemplateDefinition, nil]
|
|
71
|
+
# @param definition [Sentdm::Models::TemplateDefinition, nil] Complete definition of a message template including header, body, footer, and bu
|
|
71
72
|
#
|
|
72
73
|
# @param language [String, nil] Template language code (e.g., en_US)
|
|
73
74
|
#
|
|
@@ -5,19 +5,19 @@ module Sentdm
|
|
|
5
5
|
# @see Sentdm::Resources::Users#list
|
|
6
6
|
class UserListResponse < Sentdm::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute data
|
|
8
|
-
#
|
|
8
|
+
# List of users response
|
|
9
9
|
#
|
|
10
10
|
# @return [Sentdm::Models::UserListResponse::Data, nil]
|
|
11
11
|
optional :data, -> { Sentdm::Models::UserListResponse::Data }, nil?: true
|
|
12
12
|
|
|
13
13
|
# @!attribute error
|
|
14
|
-
# Error
|
|
14
|
+
# Error information
|
|
15
15
|
#
|
|
16
16
|
# @return [Sentdm::Models::APIError, nil]
|
|
17
17
|
optional :error, -> { Sentdm::APIError }, nil?: true
|
|
18
18
|
|
|
19
19
|
# @!attribute meta
|
|
20
|
-
#
|
|
20
|
+
# Request and response metadata
|
|
21
21
|
#
|
|
22
22
|
# @return [Sentdm::Models::APIMeta, nil]
|
|
23
23
|
optional :meta, -> { Sentdm::APIMeta }
|
|
@@ -31,11 +31,11 @@ module Sentdm
|
|
|
31
31
|
# @!method initialize(data: nil, error: nil, meta: nil, success: nil)
|
|
32
32
|
# Standard API response envelope for all v3 endpoints
|
|
33
33
|
#
|
|
34
|
-
# @param data [Sentdm::Models::UserListResponse::Data, nil]
|
|
34
|
+
# @param data [Sentdm::Models::UserListResponse::Data, nil] List of users response
|
|
35
35
|
#
|
|
36
|
-
# @param error [Sentdm::Models::APIError, nil] Error
|
|
36
|
+
# @param error [Sentdm::Models::APIError, nil] Error information
|
|
37
37
|
#
|
|
38
|
-
# @param meta [Sentdm::Models::APIMeta]
|
|
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
|
|
|
@@ -48,7 +48,7 @@ module Sentdm
|
|
|
48
48
|
optional :users, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::UserResponse] }
|
|
49
49
|
|
|
50
50
|
# @!method initialize(users: nil)
|
|
51
|
-
#
|
|
51
|
+
# List of users response
|
|
52
52
|
#
|
|
53
53
|
# @param users [Array<Sentdm::Models::UserResponse>] List of users in the organization
|
|
54
54
|
end
|
|
@@ -32,7 +32,7 @@ module Sentdm
|
|
|
32
32
|
#
|
|
33
33
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
|
|
34
34
|
|
|
35
|
-
class Body < Sentdm::Models::
|
|
35
|
+
class Body < Sentdm::Models::MutationRequest
|
|
36
36
|
# @!method initialize
|
|
37
37
|
# Request to remove a user from an organization
|
|
38
38
|
end
|
|
@@ -11,13 +11,13 @@ module Sentdm
|
|
|
11
11
|
optional :data, -> { Sentdm::Models::WebhookListEventTypesResponse::Data }, nil?: true
|
|
12
12
|
|
|
13
13
|
# @!attribute error
|
|
14
|
-
# Error
|
|
14
|
+
# Error information
|
|
15
15
|
#
|
|
16
16
|
# @return [Sentdm::Models::APIError, nil]
|
|
17
17
|
optional :error, -> { Sentdm::APIError }, nil?: true
|
|
18
18
|
|
|
19
19
|
# @!attribute meta
|
|
20
|
-
#
|
|
20
|
+
# Request and response metadata
|
|
21
21
|
#
|
|
22
22
|
# @return [Sentdm::Models::APIMeta, nil]
|
|
23
23
|
optional :meta, -> { Sentdm::APIMeta }
|
|
@@ -33,9 +33,9 @@ module Sentdm
|
|
|
33
33
|
#
|
|
34
34
|
# @param data [Sentdm::Models::WebhookListEventTypesResponse::Data, nil] The response data (null if error)
|
|
35
35
|
#
|
|
36
|
-
# @param error [Sentdm::Models::APIError, nil] Error
|
|
36
|
+
# @param error [Sentdm::Models::APIError, nil] Error information
|
|
37
37
|
#
|
|
38
|
-
# @param meta [Sentdm::Models::APIMeta]
|
|
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
|
|
|
@@ -11,13 +11,13 @@ module Sentdm
|
|
|
11
11
|
optional :data, -> { Sentdm::Models::WebhookListEventsResponse::Data }, nil?: true
|
|
12
12
|
|
|
13
13
|
# @!attribute error
|
|
14
|
-
# Error
|
|
14
|
+
# Error information
|
|
15
15
|
#
|
|
16
16
|
# @return [Sentdm::Models::APIError, nil]
|
|
17
17
|
optional :error, -> { Sentdm::APIError }, nil?: true
|
|
18
18
|
|
|
19
19
|
# @!attribute meta
|
|
20
|
-
#
|
|
20
|
+
# Request and response metadata
|
|
21
21
|
#
|
|
22
22
|
# @return [Sentdm::Models::APIMeta, nil]
|
|
23
23
|
optional :meta, -> { Sentdm::APIMeta }
|
|
@@ -33,9 +33,9 @@ module Sentdm
|
|
|
33
33
|
#
|
|
34
34
|
# @param data [Sentdm::Models::WebhookListEventsResponse::Data, nil] The response data (null if error)
|
|
35
35
|
#
|
|
36
|
-
# @param error [Sentdm::Models::APIError, nil] Error
|
|
36
|
+
# @param error [Sentdm::Models::APIError, nil] Error information
|
|
37
37
|
#
|
|
38
|
-
# @param meta [Sentdm::Models::APIMeta]
|
|
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
|
|
|
@@ -11,13 +11,13 @@ module Sentdm
|
|
|
11
11
|
optional :data, -> { Sentdm::Models::WebhookListResponse::Data }, nil?: true
|
|
12
12
|
|
|
13
13
|
# @!attribute error
|
|
14
|
-
# Error
|
|
14
|
+
# Error information
|
|
15
15
|
#
|
|
16
16
|
# @return [Sentdm::Models::APIError, nil]
|
|
17
17
|
optional :error, -> { Sentdm::APIError }, nil?: true
|
|
18
18
|
|
|
19
19
|
# @!attribute meta
|
|
20
|
-
#
|
|
20
|
+
# Request and response metadata
|
|
21
21
|
#
|
|
22
22
|
# @return [Sentdm::Models::APIMeta, nil]
|
|
23
23
|
optional :meta, -> { Sentdm::APIMeta }
|
|
@@ -33,9 +33,9 @@ module Sentdm
|
|
|
33
33
|
#
|
|
34
34
|
# @param data [Sentdm::Models::WebhookListResponse::Data, nil] The response data (null if error)
|
|
35
35
|
#
|
|
36
|
-
# @param error [Sentdm::Models::APIError, nil] Error
|
|
36
|
+
# @param error [Sentdm::Models::APIError, nil] Error information
|
|
37
37
|
#
|
|
38
|
-
# @param meta [Sentdm::Models::APIMeta]
|
|
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
|
|
|
@@ -34,7 +34,7 @@ module Sentdm
|
|
|
34
34
|
# @param x_profile_id [String]
|
|
35
35
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
|
|
36
36
|
|
|
37
|
-
class Body < Sentdm::Models::
|
|
37
|
+
class Body < Sentdm::Models::MutationRequest
|
|
38
38
|
# @!method initialize
|
|
39
39
|
end
|
|
40
40
|
end
|
|
@@ -11,13 +11,13 @@ module Sentdm
|
|
|
11
11
|
optional :data, -> { Sentdm::Models::WebhookRotateSecretResponse::Data }, nil?: true
|
|
12
12
|
|
|
13
13
|
# @!attribute error
|
|
14
|
-
# Error
|
|
14
|
+
# Error information
|
|
15
15
|
#
|
|
16
16
|
# @return [Sentdm::Models::APIError, nil]
|
|
17
17
|
optional :error, -> { Sentdm::APIError }, nil?: true
|
|
18
18
|
|
|
19
19
|
# @!attribute meta
|
|
20
|
-
#
|
|
20
|
+
# Request and response metadata
|
|
21
21
|
#
|
|
22
22
|
# @return [Sentdm::Models::APIMeta, nil]
|
|
23
23
|
optional :meta, -> { Sentdm::APIMeta }
|
|
@@ -33,9 +33,9 @@ module Sentdm
|
|
|
33
33
|
#
|
|
34
34
|
# @param data [Sentdm::Models::WebhookRotateSecretResponse::Data, nil] The response data (null if error)
|
|
35
35
|
#
|
|
36
|
-
# @param error [Sentdm::Models::APIError, nil] Error
|
|
36
|
+
# @param error [Sentdm::Models::APIError, nil] Error information
|
|
37
37
|
#
|
|
38
|
-
# @param meta [Sentdm::Models::APIMeta]
|
|
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
|
|
|
@@ -11,13 +11,13 @@ module Sentdm
|
|
|
11
11
|
optional :data, -> { Sentdm::Models::WebhookTestResponse::Data }, nil?: true
|
|
12
12
|
|
|
13
13
|
# @!attribute error
|
|
14
|
-
# Error
|
|
14
|
+
# Error information
|
|
15
15
|
#
|
|
16
16
|
# @return [Sentdm::Models::APIError, nil]
|
|
17
17
|
optional :error, -> { Sentdm::APIError }, nil?: true
|
|
18
18
|
|
|
19
19
|
# @!attribute meta
|
|
20
|
-
#
|
|
20
|
+
# Request and response metadata
|
|
21
21
|
#
|
|
22
22
|
# @return [Sentdm::Models::APIMeta, nil]
|
|
23
23
|
optional :meta, -> { Sentdm::APIMeta }
|
|
@@ -33,9 +33,9 @@ module Sentdm
|
|
|
33
33
|
#
|
|
34
34
|
# @param data [Sentdm::Models::WebhookTestResponse::Data, nil] The response data (null if error)
|
|
35
35
|
#
|
|
36
|
-
# @param error [Sentdm::Models::APIError, nil] Error
|
|
36
|
+
# @param error [Sentdm::Models::APIError, nil] Error information
|
|
37
37
|
#
|
|
38
|
-
# @param meta [Sentdm::Models::APIMeta]
|
|
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
|
|