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
|
@@ -5,19 +5,21 @@ module Sentdm
|
|
|
5
5
|
# @see Sentdm::Resources::Me#retrieve
|
|
6
6
|
class MeRetrieveResponse < Sentdm::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute data
|
|
8
|
-
#
|
|
8
|
+
# Account response for GET /v3/me endpoint. Returns organization (with profiles),
|
|
9
|
+
# user (standalone), or profile (child of an organization) data depending on the
|
|
10
|
+
# API key type. Always includes messaging channel configuration.
|
|
9
11
|
#
|
|
10
12
|
# @return [Sentdm::Models::MeRetrieveResponse::Data, nil]
|
|
11
13
|
optional :data, -> { Sentdm::Models::MeRetrieveResponse::Data }, nil?: true
|
|
12
14
|
|
|
13
15
|
# @!attribute error
|
|
14
|
-
# Error
|
|
16
|
+
# Error information
|
|
15
17
|
#
|
|
16
18
|
# @return [Sentdm::Models::APIError, nil]
|
|
17
19
|
optional :error, -> { Sentdm::APIError }, nil?: true
|
|
18
20
|
|
|
19
21
|
# @!attribute meta
|
|
20
|
-
#
|
|
22
|
+
# Request and response metadata
|
|
21
23
|
#
|
|
22
24
|
# @return [Sentdm::Models::APIMeta, nil]
|
|
23
25
|
optional :meta, -> { Sentdm::APIMeta }
|
|
@@ -29,13 +31,16 @@ module Sentdm
|
|
|
29
31
|
optional :success, Sentdm::Internal::Type::Boolean
|
|
30
32
|
|
|
31
33
|
# @!method initialize(data: nil, error: nil, meta: nil, success: nil)
|
|
34
|
+
# Some parameter documentations has been truncated, see
|
|
35
|
+
# {Sentdm::Models::MeRetrieveResponse} for more details.
|
|
36
|
+
#
|
|
32
37
|
# Standard API response envelope for all v3 endpoints
|
|
33
38
|
#
|
|
34
|
-
# @param data [Sentdm::Models::MeRetrieveResponse::Data, nil]
|
|
39
|
+
# @param data [Sentdm::Models::MeRetrieveResponse::Data, nil] Account response for GET /v3/me endpoint.
|
|
35
40
|
#
|
|
36
|
-
# @param error [Sentdm::Models::APIError, nil] Error
|
|
41
|
+
# @param error [Sentdm::Models::APIError, nil] Error information
|
|
37
42
|
#
|
|
38
|
-
# @param meta [Sentdm::Models::APIMeta]
|
|
43
|
+
# @param meta [Sentdm::Models::APIMeta] Request and response metadata
|
|
39
44
|
#
|
|
40
45
|
# @param success [Boolean] Indicates whether the request was successful
|
|
41
46
|
|
|
@@ -48,7 +53,8 @@ module Sentdm
|
|
|
48
53
|
optional :id, String
|
|
49
54
|
|
|
50
55
|
# @!attribute channels
|
|
51
|
-
# Messaging channel configuration
|
|
56
|
+
# Messaging channel configuration. All three channels are always present. Each
|
|
57
|
+
# channel has a "configured" flag; configured channels expose additional details.
|
|
52
58
|
#
|
|
53
59
|
# @return [Sentdm::Models::MeRetrieveResponse::Data::Channels, nil]
|
|
54
60
|
optional :channels, -> { Sentdm::Models::MeRetrieveResponse::Data::Channels }
|
|
@@ -98,7 +104,7 @@ module Sentdm
|
|
|
98
104
|
-> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::MeRetrieveResponse::Data::Profile] }
|
|
99
105
|
|
|
100
106
|
# @!attribute settings
|
|
101
|
-
# Profile settings
|
|
107
|
+
# Profile configuration settings
|
|
102
108
|
#
|
|
103
109
|
# @return [Sentdm::Models::ProfileSettings, nil]
|
|
104
110
|
optional :settings, -> { Sentdm::ProfileSettings }, nil?: true
|
|
@@ -127,11 +133,13 @@ module Sentdm
|
|
|
127
133
|
# Some parameter documentations has been truncated, see
|
|
128
134
|
# {Sentdm::Models::MeRetrieveResponse::Data} for more details.
|
|
129
135
|
#
|
|
130
|
-
#
|
|
136
|
+
# Account response for GET /v3/me endpoint. Returns organization (with profiles),
|
|
137
|
+
# user (standalone), or profile (child of an organization) data depending on the
|
|
138
|
+
# API key type. Always includes messaging channel configuration.
|
|
131
139
|
#
|
|
132
140
|
# @param id [String] Customer ID (organization, account, or profile)
|
|
133
141
|
#
|
|
134
|
-
# @param channels [Sentdm::Models::MeRetrieveResponse::Data::Channels] Messaging channel configuration
|
|
142
|
+
# @param channels [Sentdm::Models::MeRetrieveResponse::Data::Channels] Messaging channel configuration. All three channels are always present.
|
|
135
143
|
#
|
|
136
144
|
# @param created_at [Time] When the account was created
|
|
137
145
|
#
|
|
@@ -147,7 +155,7 @@ module Sentdm
|
|
|
147
155
|
#
|
|
148
156
|
# @param profiles [Array<Sentdm::Models::MeRetrieveResponse::Data::Profile>] List of profiles (populated for organization type, empty for user and profile ty
|
|
149
157
|
#
|
|
150
|
-
# @param settings [Sentdm::Models::ProfileSettings, nil] Profile settings
|
|
158
|
+
# @param settings [Sentdm::Models::ProfileSettings, nil] Profile configuration settings
|
|
151
159
|
#
|
|
152
160
|
# @param short_name [String, nil] Short name / abbreviation (only for profile type)
|
|
153
161
|
#
|
|
@@ -158,31 +166,36 @@ module Sentdm
|
|
|
158
166
|
# @see Sentdm::Models::MeRetrieveResponse::Data#channels
|
|
159
167
|
class Channels < Sentdm::Internal::Type::BaseModel
|
|
160
168
|
# @!attribute rcs
|
|
161
|
-
# RCS channel
|
|
169
|
+
# RCS channel configuration. When configured, includes the RCS phone number.
|
|
162
170
|
#
|
|
163
171
|
# @return [Sentdm::Models::MeRetrieveResponse::Data::Channels::Rcs, nil]
|
|
164
172
|
optional :rcs, -> { Sentdm::Models::MeRetrieveResponse::Data::Channels::Rcs }
|
|
165
173
|
|
|
166
174
|
# @!attribute sms
|
|
167
|
-
# SMS channel
|
|
175
|
+
# SMS channel configuration. When configured, includes the sending phone number.
|
|
168
176
|
#
|
|
169
177
|
# @return [Sentdm::Models::MeRetrieveResponse::Data::Channels::SMS, nil]
|
|
170
178
|
optional :sms, -> { Sentdm::Models::MeRetrieveResponse::Data::Channels::SMS }
|
|
171
179
|
|
|
172
180
|
# @!attribute whatsapp
|
|
173
|
-
# WhatsApp Business channel
|
|
181
|
+
# WhatsApp Business channel configuration. When configured, includes the WhatsApp
|
|
182
|
+
# phone number and business name.
|
|
174
183
|
#
|
|
175
184
|
# @return [Sentdm::Models::MeRetrieveResponse::Data::Channels::Whatsapp, nil]
|
|
176
185
|
optional :whatsapp, -> { Sentdm::Models::MeRetrieveResponse::Data::Channels::Whatsapp }
|
|
177
186
|
|
|
178
187
|
# @!method initialize(rcs: nil, sms: nil, whatsapp: nil)
|
|
179
|
-
#
|
|
188
|
+
# Some parameter documentations has been truncated, see
|
|
189
|
+
# {Sentdm::Models::MeRetrieveResponse::Data::Channels} for more details.
|
|
190
|
+
#
|
|
191
|
+
# Messaging channel configuration. All three channels are always present. Each
|
|
192
|
+
# channel has a "configured" flag; configured channels expose additional details.
|
|
180
193
|
#
|
|
181
|
-
# @param rcs [Sentdm::Models::MeRetrieveResponse::Data::Channels::Rcs] RCS channel
|
|
194
|
+
# @param rcs [Sentdm::Models::MeRetrieveResponse::Data::Channels::Rcs] RCS channel configuration. When configured, includes the RCS phone number.
|
|
182
195
|
#
|
|
183
|
-
# @param sms [Sentdm::Models::MeRetrieveResponse::Data::Channels::SMS] SMS channel
|
|
196
|
+
# @param sms [Sentdm::Models::MeRetrieveResponse::Data::Channels::SMS] SMS channel configuration. When configured, includes the sending phone number.
|
|
184
197
|
#
|
|
185
|
-
# @param whatsapp [Sentdm::Models::MeRetrieveResponse::Data::Channels::Whatsapp] WhatsApp Business channel
|
|
198
|
+
# @param whatsapp [Sentdm::Models::MeRetrieveResponse::Data::Channels::Whatsapp] WhatsApp Business channel configuration. When configured, includes the WhatsApp
|
|
186
199
|
|
|
187
200
|
# @see Sentdm::Models::MeRetrieveResponse::Data::Channels#rcs
|
|
188
201
|
class Rcs < Sentdm::Internal::Type::BaseModel
|
|
@@ -199,7 +212,7 @@ module Sentdm
|
|
|
199
212
|
optional :phone_number, String, nil?: true
|
|
200
213
|
|
|
201
214
|
# @!method initialize(configured: nil, phone_number: nil)
|
|
202
|
-
# RCS channel
|
|
215
|
+
# RCS channel configuration. When configured, includes the RCS phone number.
|
|
203
216
|
#
|
|
204
217
|
# @param configured [Boolean] Whether RCS is configured for this account
|
|
205
218
|
#
|
|
@@ -221,7 +234,7 @@ module Sentdm
|
|
|
221
234
|
optional :phone_number, String, nil?: true
|
|
222
235
|
|
|
223
236
|
# @!method initialize(configured: nil, phone_number: nil)
|
|
224
|
-
# SMS channel
|
|
237
|
+
# SMS channel configuration. When configured, includes the sending phone number.
|
|
225
238
|
#
|
|
226
239
|
# @param configured [Boolean] Whether SMS is configured for this account
|
|
227
240
|
#
|
|
@@ -249,7 +262,8 @@ module Sentdm
|
|
|
249
262
|
optional :phone_number, String, nil?: true
|
|
250
263
|
|
|
251
264
|
# @!method initialize(business_name: nil, configured: nil, phone_number: nil)
|
|
252
|
-
# WhatsApp Business channel
|
|
265
|
+
# WhatsApp Business channel configuration. When configured, includes the WhatsApp
|
|
266
|
+
# phone number and business name.
|
|
253
267
|
#
|
|
254
268
|
# @param business_name [String, nil] WhatsApp Business display name
|
|
255
269
|
#
|
|
@@ -5,19 +5,19 @@ module Sentdm
|
|
|
5
5
|
# @see Sentdm::Resources::Messages#retrieve_activities
|
|
6
6
|
class MessageRetrieveActivitiesResponse < Sentdm::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute data
|
|
8
|
-
#
|
|
8
|
+
# Response for GET /messages/{id}/activities
|
|
9
9
|
#
|
|
10
10
|
# @return [Sentdm::Models::MessageRetrieveActivitiesResponse::Data, nil]
|
|
11
11
|
optional :data, -> { Sentdm::Models::MessageRetrieveActivitiesResponse::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::MessageRetrieveActivitiesResponse::Data, nil]
|
|
34
|
+
# @param data [Sentdm::Models::MessageRetrieveActivitiesResponse::Data, nil] Response for GET /messages/{id}/activities
|
|
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
|
|
|
@@ -55,7 +55,7 @@ module Sentdm
|
|
|
55
55
|
optional :message_id, String
|
|
56
56
|
|
|
57
57
|
# @!method initialize(activities: nil, message_id: nil)
|
|
58
|
-
#
|
|
58
|
+
# Response for GET /messages/{id}/activities
|
|
59
59
|
#
|
|
60
60
|
# @param activities [Array<Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Activity>] List of activity events ordered by most recent first
|
|
61
61
|
#
|
|
@@ -5,19 +5,19 @@ module Sentdm
|
|
|
5
5
|
# @see Sentdm::Resources::Messages#retrieve_status
|
|
6
6
|
class MessageRetrieveStatusResponse < Sentdm::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute data
|
|
8
|
-
#
|
|
8
|
+
# Message response for v3 API — same shape as v2 with snake_case JSON conventions
|
|
9
9
|
#
|
|
10
10
|
# @return [Sentdm::Models::MessageRetrieveStatusResponse::Data, nil]
|
|
11
11
|
optional :data, -> { Sentdm::Models::MessageRetrieveStatusResponse::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::MessageRetrieveStatusResponse::Data, nil]
|
|
34
|
+
# @param data [Sentdm::Models::MessageRetrieveStatusResponse::Data, nil] Message response for v3 API — same shape as v2 with snake_case JSON conventions
|
|
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
|
|
|
@@ -131,7 +131,7 @@ module Sentdm
|
|
|
131
131
|
# Some parameter documentations has been truncated, see
|
|
132
132
|
# {Sentdm::Models::MessageRetrieveStatusResponse::Data} for more details.
|
|
133
133
|
#
|
|
134
|
-
#
|
|
134
|
+
# Message response for v3 API — same shape as v2 with snake_case JSON conventions
|
|
135
135
|
#
|
|
136
136
|
# @param id [String]
|
|
137
137
|
#
|
|
@@ -23,7 +23,8 @@ module Sentdm
|
|
|
23
23
|
optional :sandbox, Sentdm::Internal::Type::Boolean
|
|
24
24
|
|
|
25
25
|
# @!attribute template
|
|
26
|
-
#
|
|
26
|
+
# SDK-style template reference: resolve by ID or by name, with optional
|
|
27
|
+
# parameters.
|
|
27
28
|
#
|
|
28
29
|
# @return [Sentdm::Models::MessageSendParams::Template, nil]
|
|
29
30
|
optional :template, -> { Sentdm::MessageSendParams::Template }
|
|
@@ -52,7 +53,7 @@ module Sentdm
|
|
|
52
53
|
#
|
|
53
54
|
# @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
|
|
54
55
|
#
|
|
55
|
-
# @param template [Sentdm::Models::MessageSendParams::Template]
|
|
56
|
+
# @param template [Sentdm::Models::MessageSendParams::Template] SDK-style template reference: resolve by ID or by name, with optional parameters
|
|
56
57
|
#
|
|
57
58
|
# @param to [Array<String>] List of recipient phone numbers in E.164 format (multi-recipient fan-out)
|
|
58
59
|
#
|
|
@@ -82,7 +83,8 @@ module Sentdm
|
|
|
82
83
|
optional :parameters, Sentdm::Internal::Type::HashOf[String], nil?: true
|
|
83
84
|
|
|
84
85
|
# @!method initialize(id: nil, name: nil, parameters: nil)
|
|
85
|
-
#
|
|
86
|
+
# SDK-style template reference: resolve by ID or by name, with optional
|
|
87
|
+
# parameters.
|
|
86
88
|
#
|
|
87
89
|
# @param id [String, nil] Template ID (mutually exclusive with name)
|
|
88
90
|
#
|
|
@@ -5,19 +5,19 @@ module Sentdm
|
|
|
5
5
|
# @see Sentdm::Resources::Messages#send_
|
|
6
6
|
class MessageSendResponse < Sentdm::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute data
|
|
8
|
-
#
|
|
8
|
+
# Response for the multi-recipient send message endpoint
|
|
9
9
|
#
|
|
10
10
|
# @return [Sentdm::Models::MessageSendResponse::Data, nil]
|
|
11
11
|
optional :data, -> { Sentdm::Models::MessageSendResponse::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::MessageSendResponse::Data, nil]
|
|
34
|
+
# @param data [Sentdm::Models::MessageSendResponse::Data, nil] Response for the multi-recipient send message endpoint
|
|
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
|
|
|
@@ -73,7 +73,7 @@ module Sentdm
|
|
|
73
73
|
optional :template_name, String
|
|
74
74
|
|
|
75
75
|
# @!method initialize(body: nil, recipients: nil, status: nil, template_id: nil, template_name: nil)
|
|
76
|
-
#
|
|
76
|
+
# Response for the multi-recipient send message endpoint
|
|
77
77
|
#
|
|
78
78
|
# @param body [String, nil] Resolved template body text
|
|
79
79
|
#
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
module Sentdm
|
|
4
4
|
module Models
|
|
5
|
-
class
|
|
5
|
+
class MutationRequest < Sentdm::Internal::Type::BaseModel
|
|
6
6
|
# @!attribute sandbox
|
|
7
7
|
# Sandbox flag - when true, the operation is simulated without side effects Useful
|
|
8
8
|
# for testing integrations without actual execution
|
|
@@ -12,7 +12,7 @@ module Sentdm
|
|
|
12
12
|
|
|
13
13
|
# @!method initialize(sandbox: nil)
|
|
14
14
|
# Some parameter documentations has been truncated, see
|
|
15
|
-
# {Sentdm::Models::
|
|
15
|
+
# {Sentdm::Models::MutationRequest} for more details.
|
|
16
16
|
#
|
|
17
17
|
# @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
|
|
18
18
|
end
|
|
@@ -11,13 +11,13 @@ module Sentdm
|
|
|
11
11
|
optional :data, -> { Sentdm::Models::NumberLookupResponse::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::NumberLookupResponse::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
|
|
|
@@ -4,7 +4,7 @@ module Sentdm
|
|
|
4
4
|
module Models
|
|
5
5
|
class PaginationMeta < Sentdm::Internal::Type::BaseModel
|
|
6
6
|
# @!attribute cursors
|
|
7
|
-
# Cursor-based pagination
|
|
7
|
+
# Cursor-based pagination pointers
|
|
8
8
|
#
|
|
9
9
|
# @return [Sentdm::Models::PaginationMeta::Cursors, nil]
|
|
10
10
|
optional :cursors, -> { Sentdm::PaginationMeta::Cursors }, nil?: true
|
|
@@ -42,7 +42,7 @@ module Sentdm
|
|
|
42
42
|
# @!method initialize(cursors: nil, has_more: nil, page: nil, page_size: nil, total_count: nil, total_pages: nil)
|
|
43
43
|
# Pagination metadata for list responses
|
|
44
44
|
#
|
|
45
|
-
# @param cursors [Sentdm::Models::PaginationMeta::Cursors, nil] Cursor-based pagination
|
|
45
|
+
# @param cursors [Sentdm::Models::PaginationMeta::Cursors, nil] Cursor-based pagination pointers
|
|
46
46
|
#
|
|
47
47
|
# @param has_more [Boolean] Whether there are more pages after this one
|
|
48
48
|
#
|
|
@@ -69,7 +69,7 @@ module Sentdm
|
|
|
69
69
|
optional :before, String, nil?: true
|
|
70
70
|
|
|
71
71
|
# @!method initialize(after: nil, before: nil)
|
|
72
|
-
# Cursor-based pagination
|
|
72
|
+
# Cursor-based pagination pointers
|
|
73
73
|
#
|
|
74
74
|
# @param after [String, nil] Cursor to fetch the next page
|
|
75
75
|
#
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
module Sentdm
|
|
4
4
|
module Models
|
|
5
|
-
# @see Sentdm::Resources::Profiles#
|
|
6
|
-
class
|
|
5
|
+
# @see Sentdm::Resources::Profiles#complete
|
|
6
|
+
class ProfileCompleteParams < Sentdm::Internal::Type::BaseModel
|
|
7
7
|
extend Sentdm::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Sentdm::Internal::Type::RequestParameters
|
|
9
9
|
|
|
@@ -37,7 +37,7 @@ module Sentdm
|
|
|
37
37
|
|
|
38
38
|
# @!method initialize(profile_id:, web_hook_url:, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
|
|
39
39
|
# Some parameter documentations has been truncated, see
|
|
40
|
-
# {Sentdm::Models::
|
|
40
|
+
# {Sentdm::Models::ProfileCompleteParams} for more details.
|
|
41
41
|
#
|
|
42
42
|
# @param profile_id [String]
|
|
43
43
|
#
|
|
@@ -20,9 +20,8 @@ module Sentdm
|
|
|
20
20
|
optional :allow_template_sharing, Sentdm::Internal::Type::Boolean
|
|
21
21
|
|
|
22
22
|
# @!attribute billing_contact
|
|
23
|
-
# Billing contact for
|
|
24
|
-
# "profile_and_organization".
|
|
25
|
-
# responsible for payment.
|
|
23
|
+
# Billing contact information for a profile. Required when billing_model is
|
|
24
|
+
# "profile" or "profile_and_organization".
|
|
26
25
|
#
|
|
27
26
|
# @return [Sentdm::Models::BillingContactInfo, nil]
|
|
28
27
|
optional :billing_contact, -> { Sentdm::BillingContactInfo }, nil?: true
|
|
@@ -41,9 +40,7 @@ module Sentdm
|
|
|
41
40
|
optional :billing_model, String, nil?: true
|
|
42
41
|
|
|
43
42
|
# @!attribute brand
|
|
44
|
-
# Brand and KYC
|
|
45
|
-
# the brand associated with this profile. Cannot be set when inherit_tcr_brand is
|
|
46
|
-
# true.
|
|
43
|
+
# Brand and KYC data grouped into contact, business, and compliance sections
|
|
47
44
|
#
|
|
48
45
|
# @return [Sentdm::Models::BrandsBrandData, nil]
|
|
49
46
|
optional :brand, -> { Sentdm::BrandsBrandData }, nil?: true
|
|
@@ -91,9 +88,9 @@ module Sentdm
|
|
|
91
88
|
optional :name, String
|
|
92
89
|
|
|
93
90
|
# @!attribute payment_details
|
|
94
|
-
# Payment card details for
|
|
95
|
-
# "
|
|
96
|
-
# forwarded to the payment processor.
|
|
91
|
+
# Payment card details for a profile. Accepted when billing_model is "profile" or
|
|
92
|
+
# "profile_and_organization". These details are not stored on our servers and will
|
|
93
|
+
# be forwarded to the payment processor.
|
|
97
94
|
#
|
|
98
95
|
# @return [Sentdm::Models::PaymentDetails, nil]
|
|
99
96
|
optional :payment_details, -> { Sentdm::PaymentDetails }, nil?: true
|
|
@@ -114,11 +111,11 @@ module Sentdm
|
|
|
114
111
|
optional :short_name, String, nil?: true
|
|
115
112
|
|
|
116
113
|
# @!attribute whatsapp_business_account
|
|
117
|
-
# Direct WhatsApp Business Account credentials for
|
|
118
|
-
#
|
|
119
|
-
# the organization.
|
|
120
|
-
#
|
|
121
|
-
#
|
|
114
|
+
# Direct WhatsApp Business Account credentials for a profile. Use this when the
|
|
115
|
+
# profile should have its own WhatsApp Business Account instead of inheriting from
|
|
116
|
+
# the organization. Credentials must be obtained from Meta Business Manager by
|
|
117
|
+
# creating a System User with whatsapp_business_messaging and
|
|
118
|
+
# whatsapp_business_management scopes.
|
|
122
119
|
#
|
|
123
120
|
# @return [Sentdm::Models::ProfileCreateParams::WhatsappBusinessAccount, nil]
|
|
124
121
|
optional :whatsapp_business_account,
|
|
@@ -143,11 +140,11 @@ module Sentdm
|
|
|
143
140
|
#
|
|
144
141
|
# @param allow_template_sharing [Boolean] Whether templates are shared across profiles (default: false)
|
|
145
142
|
#
|
|
146
|
-
# @param billing_contact [Sentdm::Models::BillingContactInfo, nil] Billing contact for
|
|
143
|
+
# @param billing_contact [Sentdm::Models::BillingContactInfo, nil] Billing contact information for a profile.
|
|
147
144
|
#
|
|
148
145
|
# @param billing_model [String, nil] Billing model: profile, organization, or profile_and_organization (default: prof
|
|
149
146
|
#
|
|
150
|
-
# @param brand [Sentdm::Models::BrandsBrandData, nil] Brand and KYC
|
|
147
|
+
# @param brand [Sentdm::Models::BrandsBrandData, nil] Brand and KYC data grouped into contact, business, and compliance sections
|
|
151
148
|
#
|
|
152
149
|
# @param description [String, nil] Profile description (optional)
|
|
153
150
|
#
|
|
@@ -163,13 +160,13 @@ module Sentdm
|
|
|
163
160
|
#
|
|
164
161
|
# @param name [String] Profile name (required)
|
|
165
162
|
#
|
|
166
|
-
# @param payment_details [Sentdm::Models::PaymentDetails, nil] Payment card details for
|
|
163
|
+
# @param payment_details [Sentdm::Models::PaymentDetails, nil] Payment card details for a profile.
|
|
167
164
|
#
|
|
168
165
|
# @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
|
|
169
166
|
#
|
|
170
167
|
# @param short_name [String, nil] Profile short name/abbreviation (optional). Must be 3–11 characters, contain onl
|
|
171
168
|
#
|
|
172
|
-
# @param whatsapp_business_account [Sentdm::Models::ProfileCreateParams::WhatsappBusinessAccount, nil] Direct WhatsApp Business Account credentials for
|
|
169
|
+
# @param whatsapp_business_account [Sentdm::Models::ProfileCreateParams::WhatsappBusinessAccount, nil] Direct WhatsApp Business Account credentials for a profile.
|
|
173
170
|
#
|
|
174
171
|
# @param idempotency_key [String]
|
|
175
172
|
#
|
|
@@ -205,11 +202,11 @@ module Sentdm
|
|
|
205
202
|
# Some parameter documentations has been truncated, see
|
|
206
203
|
# {Sentdm::Models::ProfileCreateParams::WhatsappBusinessAccount} for more details.
|
|
207
204
|
#
|
|
208
|
-
# Direct WhatsApp Business Account credentials for
|
|
209
|
-
#
|
|
210
|
-
# the organization.
|
|
211
|
-
#
|
|
212
|
-
#
|
|
205
|
+
# Direct WhatsApp Business Account credentials for a profile. Use this when the
|
|
206
|
+
# profile should have its own WhatsApp Business Account instead of inheriting from
|
|
207
|
+
# the organization. Credentials must be obtained from Meta Business Manager by
|
|
208
|
+
# creating a System User with whatsapp_business_messaging and
|
|
209
|
+
# whatsapp_business_management scopes.
|
|
213
210
|
#
|
|
214
211
|
# @param access_token [String] System User access token with whatsapp_business_messaging and
|
|
215
212
|
#
|
|
@@ -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 delete a profile
|
|
38
38
|
end
|