sentdm 0.7.0 → 0.9.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 +18 -0
- data/README.md +1 -1
- data/lib/sentdm/internal/type/base_model.rb +5 -5
- data/lib/sentdm/models/api_response_of_contact.rb +11 -8
- data/lib/sentdm/models/api_response_of_profile_detail.rb +8 -8
- data/lib/sentdm/models/api_response_of_user.rb +8 -8
- data/lib/sentdm/models/api_response_template.rb +8 -8
- data/lib/sentdm/models/api_response_webhook.rb +6 -6
- data/lib/sentdm/models/brands_brand_data.rb +6 -6
- data/lib/sentdm/models/contact_delete_params.rb +1 -1
- data/lib/sentdm/models/contact_list_response.rb +11 -11
- data/lib/sentdm/models/{api_error.rb → error_detail.rb} +1 -1
- data/lib/sentdm/models/me_retrieve_response.rb +37 -23
- data/lib/sentdm/models/message_retrieve_activities_response.rb +9 -9
- data/lib/sentdm/models/message_retrieve_status_response.rb +9 -9
- data/lib/sentdm/models/message_send_params.rb +5 -3
- data/lib/sentdm/models/message_send_response.rb +9 -9
- data/lib/sentdm/models/{mutation_request_base.rb → mutation_request.rb} +2 -2
- data/lib/sentdm/models/number_lookup_response.rb +6 -6
- 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 +9 -9
- data/lib/sentdm/models/profile_update_params.rb +9 -13
- data/lib/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rb +6 -6
- 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_delete_params.rb +1 -1
- data/lib/sentdm/models/profiles/campaign_list_response.rb +6 -6
- 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 +1 -2
- data/lib/sentdm/models/profiles/tcr_campaign_with_use_cases.rb +2 -2
- data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rb +1 -4
- data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rb +2 -4
- data/lib/sentdm/models/template_create_params.rb +3 -2
- data/lib/sentdm/models/template_definition.rb +8 -12
- data/lib/sentdm/models/template_list_response.rb +11 -11
- data/lib/sentdm/models/template_update_params.rb +3 -2
- data/lib/sentdm/models/user_list_response.rb +9 -9
- data/lib/sentdm/models/user_remove_params.rb +1 -1
- data/lib/sentdm/models/webhook_list_event_types_response.rb +6 -6
- data/lib/sentdm/models/webhook_list_events_response.rb +6 -6
- data/lib/sentdm/models/webhook_list_response.rb +6 -6
- data/lib/sentdm/models/webhook_rotate_secret_params.rb +1 -1
- data/lib/sentdm/models/webhook_rotate_secret_response.rb +6 -6
- data/lib/sentdm/models/webhook_test_response.rb +6 -6
- data/lib/sentdm/models.rb +4 -6
- 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 +5 -5
- data/rbi/sentdm/models/api_response_of_contact.rbi +10 -10
- data/rbi/sentdm/models/api_response_of_profile_detail.rbi +10 -10
- data/rbi/sentdm/models/api_response_of_user.rbi +10 -10
- data/rbi/sentdm/models/api_response_template.rbi +10 -10
- data/rbi/sentdm/models/api_response_webhook.rbi +8 -8
- data/rbi/sentdm/models/brands_brand_data.rbi +6 -6
- data/rbi/sentdm/models/contact_delete_params.rbi +1 -1
- data/rbi/sentdm/models/contact_list_response.rbi +13 -13
- data/rbi/sentdm/models/{api_error.rbi → error_detail.rbi} +2 -2
- data/rbi/sentdm/models/me_retrieve_response.rbi +37 -25
- data/rbi/sentdm/models/message_retrieve_activities_response.rbi +11 -11
- data/rbi/sentdm/models/message_retrieve_status_response.rbi +11 -11
- data/rbi/sentdm/models/message_send_params.rbi +6 -3
- data/rbi/sentdm/models/message_send_response.rbi +11 -11
- data/rbi/sentdm/models/{mutation_request_base.rbi → mutation_request.rbi} +2 -2
- data/rbi/sentdm/models/number_lookup_response.rbi +8 -8
- 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 +11 -11
- data/rbi/sentdm/models/profile_update_params.rbi +12 -20
- data/rbi/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rbi +8 -8
- 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_delete_params.rbi +1 -1
- data/rbi/sentdm/models/profiles/campaign_list_response.rbi +8 -8
- 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 +0 -2
- data/rbi/sentdm/models/profiles/tcr_campaign_with_use_cases.rbi +2 -2
- data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rbi +0 -3
- data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rbi +0 -4
- data/rbi/sentdm/models/template_create_params.rbi +4 -2
- data/rbi/sentdm/models/template_definition.rbi +8 -10
- data/rbi/sentdm/models/template_list_response.rbi +13 -13
- data/rbi/sentdm/models/template_update_params.rbi +4 -2
- data/rbi/sentdm/models/user_list_response.rbi +11 -11
- data/rbi/sentdm/models/user_remove_params.rbi +1 -1
- data/rbi/sentdm/models/webhook_list_event_types_response.rbi +8 -8
- data/rbi/sentdm/models/webhook_list_events_response.rbi +8 -8
- data/rbi/sentdm/models/webhook_list_response.rbi +8 -8
- data/rbi/sentdm/models/webhook_rotate_secret_params.rbi +1 -1
- data/rbi/sentdm/models/webhook_rotate_secret_response.rbi +8 -8
- data/rbi/sentdm/models/webhook_test_response.rbi +8 -8
- data/rbi/sentdm/models.rbi +4 -6
- 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/api_response_of_contact.rbs +4 -4
- data/sig/sentdm/models/api_response_of_profile_detail.rbs +4 -4
- data/sig/sentdm/models/api_response_of_user.rbs +4 -4
- data/sig/sentdm/models/api_response_template.rbs +4 -4
- data/sig/sentdm/models/api_response_webhook.rbs +4 -4
- data/sig/sentdm/models/contact_delete_params.rbs +1 -1
- data/sig/sentdm/models/contact_list_response.rbs +4 -4
- data/sig/sentdm/models/{api_error.rbs → error_detail.rbs} +2 -2
- data/sig/sentdm/models/me_retrieve_response.rbs +4 -4
- data/sig/sentdm/models/message_retrieve_activities_response.rbs +4 -4
- data/sig/sentdm/models/message_retrieve_status_response.rbs +4 -4
- data/sig/sentdm/models/message_send_response.rbs +4 -4
- data/sig/sentdm/models/{mutation_request_base.rbs → mutation_request.rbs} +2 -2
- data/sig/sentdm/models/number_lookup_response.rbs +4 -4
- 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/profile_list_response.rbs +4 -4
- data/sig/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rbs +4 -4
- data/sig/sentdm/models/profiles/base_dto.rbs +27 -0
- data/sig/sentdm/models/profiles/campaign_delete_params.rbs +1 -1
- data/sig/sentdm/models/profiles/campaign_list_response.rbs +4 -4
- data/sig/sentdm/models/profiles/tcr_campaign_with_use_cases.rbs +2 -2
- data/sig/sentdm/models/template_list_response.rbs +4 -4
- data/sig/sentdm/models/user_list_response.rbs +4 -4
- data/sig/sentdm/models/user_remove_params.rbs +1 -1
- data/sig/sentdm/models/webhook_list_event_types_response.rbs +4 -4
- data/sig/sentdm/models/webhook_list_events_response.rbs +4 -4
- data/sig/sentdm/models/webhook_list_response.rbs +4 -4
- data/sig/sentdm/models/webhook_rotate_secret_params.rbs +1 -1
- data/sig/sentdm/models/webhook_rotate_secret_response.rbs +4 -4
- data/sig/sentdm/models/webhook_test_response.rbs +4 -4
- data/sig/sentdm/models.rbs +4 -6
- data/sig/sentdm/resources/profiles.rbs +1 -1
- metadata +17 -17
- 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
|
@@ -8,7 +8,7 @@ module Sentdm
|
|
|
8
8
|
T.any(Sentdm::Models::TemplateListResponse, Sentdm::Internal::AnyHash)
|
|
9
9
|
end
|
|
10
10
|
|
|
11
|
-
#
|
|
11
|
+
# Paginated list of templates
|
|
12
12
|
sig { returns(T.nilable(Sentdm::Models::TemplateListResponse::Data)) }
|
|
13
13
|
attr_reader :data
|
|
14
14
|
|
|
@@ -19,14 +19,14 @@ module Sentdm
|
|
|
19
19
|
end
|
|
20
20
|
attr_writer :data
|
|
21
21
|
|
|
22
|
-
# Error
|
|
23
|
-
sig { returns(T.nilable(Sentdm::
|
|
22
|
+
# Error information
|
|
23
|
+
sig { returns(T.nilable(Sentdm::ErrorDetail)) }
|
|
24
24
|
attr_reader :error
|
|
25
25
|
|
|
26
|
-
sig { params(error: T.nilable(Sentdm::
|
|
26
|
+
sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
|
|
27
27
|
attr_writer :error
|
|
28
28
|
|
|
29
|
-
#
|
|
29
|
+
# Request and response metadata
|
|
30
30
|
sig { returns(T.nilable(Sentdm::APIMeta)) }
|
|
31
31
|
attr_reader :meta
|
|
32
32
|
|
|
@@ -44,17 +44,17 @@ module Sentdm
|
|
|
44
44
|
sig do
|
|
45
45
|
params(
|
|
46
46
|
data: T.nilable(Sentdm::Models::TemplateListResponse::Data::OrHash),
|
|
47
|
-
error: T.nilable(Sentdm::
|
|
47
|
+
error: T.nilable(Sentdm::ErrorDetail::OrHash),
|
|
48
48
|
meta: Sentdm::APIMeta::OrHash,
|
|
49
49
|
success: T::Boolean
|
|
50
50
|
).returns(T.attached_class)
|
|
51
51
|
end
|
|
52
52
|
def self.new(
|
|
53
|
-
#
|
|
53
|
+
# Paginated list of templates
|
|
54
54
|
data: nil,
|
|
55
|
-
# Error
|
|
55
|
+
# Error information
|
|
56
56
|
error: nil,
|
|
57
|
-
#
|
|
57
|
+
# Request and response metadata
|
|
58
58
|
meta: nil,
|
|
59
59
|
# Indicates whether the request was successful
|
|
60
60
|
success: nil
|
|
@@ -65,7 +65,7 @@ module Sentdm
|
|
|
65
65
|
override.returns(
|
|
66
66
|
{
|
|
67
67
|
data: T.nilable(Sentdm::Models::TemplateListResponse::Data),
|
|
68
|
-
error: T.nilable(Sentdm::
|
|
68
|
+
error: T.nilable(Sentdm::ErrorDetail),
|
|
69
69
|
meta: Sentdm::APIMeta,
|
|
70
70
|
success: T::Boolean
|
|
71
71
|
}
|
|
@@ -83,7 +83,7 @@ module Sentdm
|
|
|
83
83
|
)
|
|
84
84
|
end
|
|
85
85
|
|
|
86
|
-
# Pagination metadata
|
|
86
|
+
# Pagination metadata for list responses
|
|
87
87
|
sig { returns(T.nilable(Sentdm::PaginationMeta)) }
|
|
88
88
|
attr_reader :pagination
|
|
89
89
|
|
|
@@ -97,7 +97,7 @@ module Sentdm
|
|
|
97
97
|
sig { params(templates: T::Array[Sentdm::Template::OrHash]).void }
|
|
98
98
|
attr_writer :templates
|
|
99
99
|
|
|
100
|
-
#
|
|
100
|
+
# Paginated list of templates
|
|
101
101
|
sig do
|
|
102
102
|
params(
|
|
103
103
|
pagination: Sentdm::PaginationMeta::OrHash,
|
|
@@ -105,7 +105,7 @@ module Sentdm
|
|
|
105
105
|
).returns(T.attached_class)
|
|
106
106
|
end
|
|
107
107
|
def self.new(
|
|
108
|
-
# Pagination metadata
|
|
108
|
+
# Pagination metadata for list responses
|
|
109
109
|
pagination: nil,
|
|
110
110
|
# List of templates
|
|
111
111
|
templates: nil
|
|
@@ -18,7 +18,8 @@ module Sentdm
|
|
|
18
18
|
sig { returns(T.nilable(String)) }
|
|
19
19
|
attr_accessor :category
|
|
20
20
|
|
|
21
|
-
#
|
|
21
|
+
# Complete definition of a message template including header, body, footer, and
|
|
22
|
+
# buttons
|
|
22
23
|
sig { returns(T.nilable(Sentdm::TemplateDefinition)) }
|
|
23
24
|
attr_reader :definition
|
|
24
25
|
|
|
@@ -80,7 +81,8 @@ module Sentdm
|
|
|
80
81
|
id:,
|
|
81
82
|
# Template category: MARKETING, UTILITY, AUTHENTICATION
|
|
82
83
|
category: nil,
|
|
83
|
-
#
|
|
84
|
+
# Complete definition of a message template including header, body, footer, and
|
|
85
|
+
# buttons
|
|
84
86
|
definition: nil,
|
|
85
87
|
# Template language code (e.g., en_US)
|
|
86
88
|
language: nil,
|
|
@@ -8,7 +8,7 @@ module Sentdm
|
|
|
8
8
|
T.any(Sentdm::Models::UserListResponse, Sentdm::Internal::AnyHash)
|
|
9
9
|
end
|
|
10
10
|
|
|
11
|
-
#
|
|
11
|
+
# List of users response
|
|
12
12
|
sig { returns(T.nilable(Sentdm::Models::UserListResponse::Data)) }
|
|
13
13
|
attr_reader :data
|
|
14
14
|
|
|
@@ -19,14 +19,14 @@ module Sentdm
|
|
|
19
19
|
end
|
|
20
20
|
attr_writer :data
|
|
21
21
|
|
|
22
|
-
# Error
|
|
23
|
-
sig { returns(T.nilable(Sentdm::
|
|
22
|
+
# Error information
|
|
23
|
+
sig { returns(T.nilable(Sentdm::ErrorDetail)) }
|
|
24
24
|
attr_reader :error
|
|
25
25
|
|
|
26
|
-
sig { params(error: T.nilable(Sentdm::
|
|
26
|
+
sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
|
|
27
27
|
attr_writer :error
|
|
28
28
|
|
|
29
|
-
#
|
|
29
|
+
# Request and response metadata
|
|
30
30
|
sig { returns(T.nilable(Sentdm::APIMeta)) }
|
|
31
31
|
attr_reader :meta
|
|
32
32
|
|
|
@@ -44,17 +44,17 @@ module Sentdm
|
|
|
44
44
|
sig do
|
|
45
45
|
params(
|
|
46
46
|
data: T.nilable(Sentdm::Models::UserListResponse::Data::OrHash),
|
|
47
|
-
error: T.nilable(Sentdm::
|
|
47
|
+
error: T.nilable(Sentdm::ErrorDetail::OrHash),
|
|
48
48
|
meta: Sentdm::APIMeta::OrHash,
|
|
49
49
|
success: T::Boolean
|
|
50
50
|
).returns(T.attached_class)
|
|
51
51
|
end
|
|
52
52
|
def self.new(
|
|
53
|
-
#
|
|
53
|
+
# List of users response
|
|
54
54
|
data: nil,
|
|
55
|
-
# Error
|
|
55
|
+
# Error information
|
|
56
56
|
error: nil,
|
|
57
|
-
#
|
|
57
|
+
# Request and response metadata
|
|
58
58
|
meta: nil,
|
|
59
59
|
# Indicates whether the request was successful
|
|
60
60
|
success: nil
|
|
@@ -65,7 +65,7 @@ module Sentdm
|
|
|
65
65
|
override.returns(
|
|
66
66
|
{
|
|
67
67
|
data: T.nilable(Sentdm::Models::UserListResponse::Data),
|
|
68
|
-
error: T.nilable(Sentdm::
|
|
68
|
+
error: T.nilable(Sentdm::ErrorDetail),
|
|
69
69
|
meta: Sentdm::APIMeta,
|
|
70
70
|
success: T::Boolean
|
|
71
71
|
}
|
|
@@ -90,7 +90,7 @@ module Sentdm
|
|
|
90
90
|
sig { params(users: T::Array[Sentdm::UserResponse::OrHash]).void }
|
|
91
91
|
attr_writer :users
|
|
92
92
|
|
|
93
|
-
#
|
|
93
|
+
# List of users response
|
|
94
94
|
sig do
|
|
95
95
|
params(users: T::Array[Sentdm::UserResponse::OrHash]).returns(
|
|
96
96
|
T.attached_class
|
|
@@ -27,14 +27,14 @@ module Sentdm
|
|
|
27
27
|
end
|
|
28
28
|
attr_writer :data
|
|
29
29
|
|
|
30
|
-
# Error
|
|
31
|
-
sig { returns(T.nilable(Sentdm::
|
|
30
|
+
# Error information
|
|
31
|
+
sig { returns(T.nilable(Sentdm::ErrorDetail)) }
|
|
32
32
|
attr_reader :error
|
|
33
33
|
|
|
34
|
-
sig { params(error: T.nilable(Sentdm::
|
|
34
|
+
sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
|
|
35
35
|
attr_writer :error
|
|
36
36
|
|
|
37
|
-
#
|
|
37
|
+
# Request and response metadata
|
|
38
38
|
sig { returns(T.nilable(Sentdm::APIMeta)) }
|
|
39
39
|
attr_reader :meta
|
|
40
40
|
|
|
@@ -55,7 +55,7 @@ module Sentdm
|
|
|
55
55
|
T.nilable(
|
|
56
56
|
Sentdm::Models::WebhookListEventTypesResponse::Data::OrHash
|
|
57
57
|
),
|
|
58
|
-
error: T.nilable(Sentdm::
|
|
58
|
+
error: T.nilable(Sentdm::ErrorDetail::OrHash),
|
|
59
59
|
meta: Sentdm::APIMeta::OrHash,
|
|
60
60
|
success: T::Boolean
|
|
61
61
|
).returns(T.attached_class)
|
|
@@ -63,9 +63,9 @@ module Sentdm
|
|
|
63
63
|
def self.new(
|
|
64
64
|
# The response data (null if error)
|
|
65
65
|
data: nil,
|
|
66
|
-
# Error
|
|
66
|
+
# Error information
|
|
67
67
|
error: nil,
|
|
68
|
-
#
|
|
68
|
+
# Request and response metadata
|
|
69
69
|
meta: nil,
|
|
70
70
|
# Indicates whether the request was successful
|
|
71
71
|
success: nil
|
|
@@ -77,7 +77,7 @@ module Sentdm
|
|
|
77
77
|
{
|
|
78
78
|
data:
|
|
79
79
|
T.nilable(Sentdm::Models::WebhookListEventTypesResponse::Data),
|
|
80
|
-
error: T.nilable(Sentdm::
|
|
80
|
+
error: T.nilable(Sentdm::ErrorDetail),
|
|
81
81
|
meta: Sentdm::APIMeta,
|
|
82
82
|
success: T::Boolean
|
|
83
83
|
}
|
|
@@ -25,14 +25,14 @@ module Sentdm
|
|
|
25
25
|
end
|
|
26
26
|
attr_writer :data
|
|
27
27
|
|
|
28
|
-
# Error
|
|
29
|
-
sig { returns(T.nilable(Sentdm::
|
|
28
|
+
# Error information
|
|
29
|
+
sig { returns(T.nilable(Sentdm::ErrorDetail)) }
|
|
30
30
|
attr_reader :error
|
|
31
31
|
|
|
32
|
-
sig { params(error: T.nilable(Sentdm::
|
|
32
|
+
sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
|
|
33
33
|
attr_writer :error
|
|
34
34
|
|
|
35
|
-
#
|
|
35
|
+
# Request and response metadata
|
|
36
36
|
sig { returns(T.nilable(Sentdm::APIMeta)) }
|
|
37
37
|
attr_reader :meta
|
|
38
38
|
|
|
@@ -51,7 +51,7 @@ module Sentdm
|
|
|
51
51
|
params(
|
|
52
52
|
data:
|
|
53
53
|
T.nilable(Sentdm::Models::WebhookListEventsResponse::Data::OrHash),
|
|
54
|
-
error: T.nilable(Sentdm::
|
|
54
|
+
error: T.nilable(Sentdm::ErrorDetail::OrHash),
|
|
55
55
|
meta: Sentdm::APIMeta::OrHash,
|
|
56
56
|
success: T::Boolean
|
|
57
57
|
).returns(T.attached_class)
|
|
@@ -59,9 +59,9 @@ module Sentdm
|
|
|
59
59
|
def self.new(
|
|
60
60
|
# The response data (null if error)
|
|
61
61
|
data: nil,
|
|
62
|
-
# Error
|
|
62
|
+
# Error information
|
|
63
63
|
error: nil,
|
|
64
|
-
#
|
|
64
|
+
# Request and response metadata
|
|
65
65
|
meta: nil,
|
|
66
66
|
# Indicates whether the request was successful
|
|
67
67
|
success: nil
|
|
@@ -72,7 +72,7 @@ module Sentdm
|
|
|
72
72
|
override.returns(
|
|
73
73
|
{
|
|
74
74
|
data: T.nilable(Sentdm::Models::WebhookListEventsResponse::Data),
|
|
75
|
-
error: T.nilable(Sentdm::
|
|
75
|
+
error: T.nilable(Sentdm::ErrorDetail),
|
|
76
76
|
meta: Sentdm::APIMeta,
|
|
77
77
|
success: T::Boolean
|
|
78
78
|
}
|
|
@@ -19,14 +19,14 @@ module Sentdm
|
|
|
19
19
|
end
|
|
20
20
|
attr_writer :data
|
|
21
21
|
|
|
22
|
-
# Error
|
|
23
|
-
sig { returns(T.nilable(Sentdm::
|
|
22
|
+
# Error information
|
|
23
|
+
sig { returns(T.nilable(Sentdm::ErrorDetail)) }
|
|
24
24
|
attr_reader :error
|
|
25
25
|
|
|
26
|
-
sig { params(error: T.nilable(Sentdm::
|
|
26
|
+
sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
|
|
27
27
|
attr_writer :error
|
|
28
28
|
|
|
29
|
-
#
|
|
29
|
+
# Request and response metadata
|
|
30
30
|
sig { returns(T.nilable(Sentdm::APIMeta)) }
|
|
31
31
|
attr_reader :meta
|
|
32
32
|
|
|
@@ -44,7 +44,7 @@ module Sentdm
|
|
|
44
44
|
sig do
|
|
45
45
|
params(
|
|
46
46
|
data: T.nilable(Sentdm::Models::WebhookListResponse::Data::OrHash),
|
|
47
|
-
error: T.nilable(Sentdm::
|
|
47
|
+
error: T.nilable(Sentdm::ErrorDetail::OrHash),
|
|
48
48
|
meta: Sentdm::APIMeta::OrHash,
|
|
49
49
|
success: T::Boolean
|
|
50
50
|
).returns(T.attached_class)
|
|
@@ -52,9 +52,9 @@ module Sentdm
|
|
|
52
52
|
def self.new(
|
|
53
53
|
# The response data (null if error)
|
|
54
54
|
data: nil,
|
|
55
|
-
# Error
|
|
55
|
+
# Error information
|
|
56
56
|
error: nil,
|
|
57
|
-
#
|
|
57
|
+
# Request and response metadata
|
|
58
58
|
meta: nil,
|
|
59
59
|
# Indicates whether the request was successful
|
|
60
60
|
success: nil
|
|
@@ -65,7 +65,7 @@ module Sentdm
|
|
|
65
65
|
override.returns(
|
|
66
66
|
{
|
|
67
67
|
data: T.nilable(Sentdm::Models::WebhookListResponse::Data),
|
|
68
|
-
error: T.nilable(Sentdm::
|
|
68
|
+
error: T.nilable(Sentdm::ErrorDetail),
|
|
69
69
|
meta: Sentdm::APIMeta,
|
|
70
70
|
success: T::Boolean
|
|
71
71
|
}
|
|
@@ -25,14 +25,14 @@ module Sentdm
|
|
|
25
25
|
end
|
|
26
26
|
attr_writer :data
|
|
27
27
|
|
|
28
|
-
# Error
|
|
29
|
-
sig { returns(T.nilable(Sentdm::
|
|
28
|
+
# Error information
|
|
29
|
+
sig { returns(T.nilable(Sentdm::ErrorDetail)) }
|
|
30
30
|
attr_reader :error
|
|
31
31
|
|
|
32
|
-
sig { params(error: T.nilable(Sentdm::
|
|
32
|
+
sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
|
|
33
33
|
attr_writer :error
|
|
34
34
|
|
|
35
|
-
#
|
|
35
|
+
# Request and response metadata
|
|
36
36
|
sig { returns(T.nilable(Sentdm::APIMeta)) }
|
|
37
37
|
attr_reader :meta
|
|
38
38
|
|
|
@@ -53,7 +53,7 @@ module Sentdm
|
|
|
53
53
|
T.nilable(
|
|
54
54
|
Sentdm::Models::WebhookRotateSecretResponse::Data::OrHash
|
|
55
55
|
),
|
|
56
|
-
error: T.nilable(Sentdm::
|
|
56
|
+
error: T.nilable(Sentdm::ErrorDetail::OrHash),
|
|
57
57
|
meta: Sentdm::APIMeta::OrHash,
|
|
58
58
|
success: T::Boolean
|
|
59
59
|
).returns(T.attached_class)
|
|
@@ -61,9 +61,9 @@ module Sentdm
|
|
|
61
61
|
def self.new(
|
|
62
62
|
# The response data (null if error)
|
|
63
63
|
data: nil,
|
|
64
|
-
# Error
|
|
64
|
+
# Error information
|
|
65
65
|
error: nil,
|
|
66
|
-
#
|
|
66
|
+
# Request and response metadata
|
|
67
67
|
meta: nil,
|
|
68
68
|
# Indicates whether the request was successful
|
|
69
69
|
success: nil
|
|
@@ -74,7 +74,7 @@ module Sentdm
|
|
|
74
74
|
override.returns(
|
|
75
75
|
{
|
|
76
76
|
data: T.nilable(Sentdm::Models::WebhookRotateSecretResponse::Data),
|
|
77
|
-
error: T.nilable(Sentdm::
|
|
77
|
+
error: T.nilable(Sentdm::ErrorDetail),
|
|
78
78
|
meta: Sentdm::APIMeta,
|
|
79
79
|
success: T::Boolean
|
|
80
80
|
}
|
|
@@ -19,14 +19,14 @@ module Sentdm
|
|
|
19
19
|
end
|
|
20
20
|
attr_writer :data
|
|
21
21
|
|
|
22
|
-
# Error
|
|
23
|
-
sig { returns(T.nilable(Sentdm::
|
|
22
|
+
# Error information
|
|
23
|
+
sig { returns(T.nilable(Sentdm::ErrorDetail)) }
|
|
24
24
|
attr_reader :error
|
|
25
25
|
|
|
26
|
-
sig { params(error: T.nilable(Sentdm::
|
|
26
|
+
sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
|
|
27
27
|
attr_writer :error
|
|
28
28
|
|
|
29
|
-
#
|
|
29
|
+
# Request and response metadata
|
|
30
30
|
sig { returns(T.nilable(Sentdm::APIMeta)) }
|
|
31
31
|
attr_reader :meta
|
|
32
32
|
|
|
@@ -44,7 +44,7 @@ module Sentdm
|
|
|
44
44
|
sig do
|
|
45
45
|
params(
|
|
46
46
|
data: T.nilable(Sentdm::Models::WebhookTestResponse::Data::OrHash),
|
|
47
|
-
error: T.nilable(Sentdm::
|
|
47
|
+
error: T.nilable(Sentdm::ErrorDetail::OrHash),
|
|
48
48
|
meta: Sentdm::APIMeta::OrHash,
|
|
49
49
|
success: T::Boolean
|
|
50
50
|
).returns(T.attached_class)
|
|
@@ -52,9 +52,9 @@ module Sentdm
|
|
|
52
52
|
def self.new(
|
|
53
53
|
# The response data (null if error)
|
|
54
54
|
data: nil,
|
|
55
|
-
# Error
|
|
55
|
+
# Error information
|
|
56
56
|
error: nil,
|
|
57
|
-
#
|
|
57
|
+
# Request and response metadata
|
|
58
58
|
meta: nil,
|
|
59
59
|
# Indicates whether the request was successful
|
|
60
60
|
success: nil
|
|
@@ -65,7 +65,7 @@ module Sentdm
|
|
|
65
65
|
override.returns(
|
|
66
66
|
{
|
|
67
67
|
data: T.nilable(Sentdm::Models::WebhookTestResponse::Data),
|
|
68
|
-
error: T.nilable(Sentdm::
|
|
68
|
+
error: T.nilable(Sentdm::ErrorDetail),
|
|
69
69
|
meta: Sentdm::APIMeta,
|
|
70
70
|
success: T::Boolean
|
|
71
71
|
}
|
data/rbi/sentdm/models.rbi
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
# typed: strong
|
|
2
2
|
|
|
3
3
|
module Sentdm
|
|
4
|
-
APIError = Sentdm::Models::APIError
|
|
5
|
-
|
|
6
4
|
APIMeta = Sentdm::Models::APIMeta
|
|
7
5
|
|
|
8
6
|
APIResponseOfContact = Sentdm::Models::APIResponseOfContact
|
|
@@ -15,8 +13,6 @@ module Sentdm
|
|
|
15
13
|
|
|
16
14
|
APIResponseWebhook = Sentdm::Models::APIResponseWebhook
|
|
17
15
|
|
|
18
|
-
BaseDto = Sentdm::Models::BaseDto
|
|
19
|
-
|
|
20
16
|
BillingContactInfo = Sentdm::Models::BillingContactInfo
|
|
21
17
|
|
|
22
18
|
BrandsBrandData = Sentdm::Models::BrandsBrandData
|
|
@@ -35,6 +31,8 @@ module Sentdm
|
|
|
35
31
|
|
|
36
32
|
DestinationCountry = Sentdm::Models::DestinationCountry
|
|
37
33
|
|
|
34
|
+
ErrorDetail = Sentdm::Models::ErrorDetail
|
|
35
|
+
|
|
38
36
|
MeRetrieveParams = Sentdm::Models::MeRetrieveParams
|
|
39
37
|
|
|
40
38
|
MessageRetrieveActivitiesParams =
|
|
@@ -44,7 +42,7 @@ module Sentdm
|
|
|
44
42
|
|
|
45
43
|
MessageSendParams = Sentdm::Models::MessageSendParams
|
|
46
44
|
|
|
47
|
-
|
|
45
|
+
MutationRequest = Sentdm::Models::MutationRequest
|
|
48
46
|
|
|
49
47
|
NumberLookupParams = Sentdm::Models::NumberLookupParams
|
|
50
48
|
|
|
@@ -52,7 +50,7 @@ module Sentdm
|
|
|
52
50
|
|
|
53
51
|
PaymentDetails = Sentdm::Models::PaymentDetails
|
|
54
52
|
|
|
55
|
-
|
|
53
|
+
ProfileCompleteParams = Sentdm::Models::ProfileCompleteParams
|
|
56
54
|
|
|
57
55
|
ProfileCreateParams = Sentdm::Models::ProfileCreateParams
|
|
58
56
|
|
|
@@ -66,7 +66,8 @@ module Sentdm
|
|
|
66
66
|
# Body param: Sandbox flag - when true, the operation is simulated without side
|
|
67
67
|
# effects Useful for testing integrations without actual execution
|
|
68
68
|
sandbox: nil,
|
|
69
|
-
# Body param:
|
|
69
|
+
# Body param: SDK-style template reference: resolve by ID or by name, with
|
|
70
|
+
# optional parameters.
|
|
70
71
|
template: nil,
|
|
71
72
|
# Body param: List of recipient phone numbers in E.164 format (multi-recipient
|
|
72
73
|
# fan-out)
|
|
@@ -20,7 +20,7 @@ module Sentdm
|
|
|
20
20
|
def create(
|
|
21
21
|
# Path param: Profile ID from route
|
|
22
22
|
profile_id,
|
|
23
|
-
# Body param: Campaign data
|
|
23
|
+
# Body param: Campaign data for create or update operation
|
|
24
24
|
campaign:,
|
|
25
25
|
# Body param: Sandbox flag - when true, the operation is simulated without side
|
|
26
26
|
# effects Useful for testing integrations without actual execution
|
|
@@ -55,7 +55,7 @@ module Sentdm
|
|
|
55
55
|
campaign_id,
|
|
56
56
|
# Path param: Profile ID from route
|
|
57
57
|
profile_id:,
|
|
58
|
-
# Body param: Campaign data
|
|
58
|
+
# Body param: Campaign data for create or update operation
|
|
59
59
|
campaign:,
|
|
60
60
|
# Body param: Sandbox flag - when true, the operation is simulated without side
|
|
61
61
|
# effects Useful for testing integrations without actual execution
|
|
@@ -75,9 +75,8 @@ module Sentdm
|
|
|
75
75
|
allow_contact_sharing: nil,
|
|
76
76
|
# Body param: Whether templates are shared across profiles (default: false)
|
|
77
77
|
allow_template_sharing: nil,
|
|
78
|
-
# Body param: Billing contact for
|
|
79
|
-
# "profile" or "profile_and_organization".
|
|
80
|
-
# who is responsible for payment.
|
|
78
|
+
# Body param: Billing contact information for a profile. Required when
|
|
79
|
+
# billing_model is "profile" or "profile_and_organization".
|
|
81
80
|
billing_contact: nil,
|
|
82
81
|
# Body param: Billing model: profile, organization, or profile_and_organization
|
|
83
82
|
# (default: profile).
|
|
@@ -88,9 +87,8 @@ module Sentdm
|
|
|
88
87
|
# - "profile_and_organization": the profile is billed first with the organization
|
|
89
88
|
# as fallback; billing_contact is required.
|
|
90
89
|
billing_model: nil,
|
|
91
|
-
# Body param: Brand and KYC
|
|
92
|
-
#
|
|
93
|
-
# inherit_tcr_brand is true.
|
|
90
|
+
# Body param: Brand and KYC data grouped into contact, business, and compliance
|
|
91
|
+
# sections
|
|
94
92
|
brand: nil,
|
|
95
93
|
# Body param: Profile description (optional)
|
|
96
94
|
description: nil,
|
|
@@ -110,9 +108,9 @@ module Sentdm
|
|
|
110
108
|
inherit_templates: nil,
|
|
111
109
|
# Body param: Profile name (required)
|
|
112
110
|
name: nil,
|
|
113
|
-
# Body param: Payment card details for
|
|
114
|
-
#
|
|
115
|
-
# servers
|
|
111
|
+
# Body param: Payment card details for a profile. Accepted when billing_model is
|
|
112
|
+
# "profile" or "profile_and_organization". These details are not stored on our
|
|
113
|
+
# servers and will be forwarded to the payment processor.
|
|
116
114
|
payment_details: nil,
|
|
117
115
|
# Body param: Sandbox flag - when true, the operation is simulated without side
|
|
118
116
|
# effects Useful for testing integrations without actual execution
|
|
@@ -121,11 +119,11 @@ module Sentdm
|
|
|
121
119
|
# contain only letters, numbers, and spaces, and include at least one letter.
|
|
122
120
|
# Example: "SALES", "Mkt 2", "Support1".
|
|
123
121
|
short_name: nil,
|
|
124
|
-
# Body param: Direct WhatsApp Business Account credentials for
|
|
125
|
-
#
|
|
126
|
-
# inheriting from the organization.
|
|
127
|
-
#
|
|
128
|
-
#
|
|
122
|
+
# Body param: Direct WhatsApp Business Account credentials for a profile. Use this
|
|
123
|
+
# when the profile should have its own WhatsApp Business Account instead of
|
|
124
|
+
# inheriting from the organization. Credentials must be obtained from Meta
|
|
125
|
+
# Business Manager by creating a System User with whatsapp_business_messaging and
|
|
126
|
+
# whatsapp_business_management scopes.
|
|
129
127
|
whatsapp_business_account: nil,
|
|
130
128
|
# Header param: Unique key to ensure idempotent request processing. Must be 1-255
|
|
131
129
|
# alphanumeric characters, hyphens, or underscores. Responses are cached for 24
|
|
@@ -213,10 +211,8 @@ module Sentdm
|
|
|
213
211
|
allow_number_change_during_onboarding: nil,
|
|
214
212
|
# Body param: Whether templates are shared across profiles (optional)
|
|
215
213
|
allow_template_sharing: nil,
|
|
216
|
-
# Body param: Billing contact for
|
|
217
|
-
# "profile" or "profile_and_organization"
|
|
218
|
-
# configured yet. Identifies who receives invoices and who is responsible for
|
|
219
|
-
# payment.
|
|
214
|
+
# Body param: Billing contact information for a profile. Required when
|
|
215
|
+
# billing_model is "profile" or "profile_and_organization".
|
|
220
216
|
billing_contact: nil,
|
|
221
217
|
# Body param: Billing model: profile, organization, or profile_and_organization
|
|
222
218
|
# (optional).
|
|
@@ -227,10 +223,8 @@ module Sentdm
|
|
|
227
223
|
# - "profile_and_organization": the profile is billed first with the organization
|
|
228
224
|
# as fallback; billing_contact is required.
|
|
229
225
|
billing_model: nil,
|
|
230
|
-
# Body param: Brand and KYC
|
|
231
|
-
#
|
|
232
|
-
# set when inherit_tcr_brand is true. Once a brand has been submitted to TCR it
|
|
233
|
-
# cannot be modified.
|
|
226
|
+
# Body param: Brand and KYC data grouped into contact, business, and compliance
|
|
227
|
+
# sections
|
|
234
228
|
brand: nil,
|
|
235
229
|
# Body param: Profile description (optional)
|
|
236
230
|
description: nil,
|
|
@@ -247,9 +241,9 @@ module Sentdm
|
|
|
247
241
|
inherit_templates: nil,
|
|
248
242
|
# Body param: Profile name (optional)
|
|
249
243
|
name: nil,
|
|
250
|
-
# Body param: Payment card details for
|
|
251
|
-
#
|
|
252
|
-
# servers
|
|
244
|
+
# Body param: Payment card details for a profile. Accepted when billing_model is
|
|
245
|
+
# "profile" or "profile_and_organization". These details are not stored on our
|
|
246
|
+
# servers and will be forwarded to the payment processor.
|
|
253
247
|
payment_details: nil,
|
|
254
248
|
# Body param: Sandbox flag - when true, the operation is simulated without side
|
|
255
249
|
# effects Useful for testing integrations without actual execution
|
|
@@ -349,7 +343,7 @@ module Sentdm
|
|
|
349
343
|
request_options: Sentdm::RequestOptions::OrHash
|
|
350
344
|
).returns(T.anything)
|
|
351
345
|
end
|
|
352
|
-
def
|
|
346
|
+
def complete(
|
|
353
347
|
# Path param: Profile ID from route
|
|
354
348
|
profile_id,
|
|
355
349
|
# Body param: Webhook URL to call when profile completion finishes (success or
|
|
@@ -26,7 +26,8 @@ module Sentdm
|
|
|
26
26
|
category: nil,
|
|
27
27
|
# Body param: Source of template creation (default: from-api)
|
|
28
28
|
creation_source: nil,
|
|
29
|
-
# Body param:
|
|
29
|
+
# Body param: Complete definition of a message template including header, body,
|
|
30
|
+
# footer, and buttons
|
|
30
31
|
definition: nil,
|
|
31
32
|
# Body param: Template language code (e.g., en_US) (optional, auto-detected if not
|
|
32
33
|
# provided)
|
|
@@ -89,7 +90,8 @@ module Sentdm
|
|
|
89
90
|
id,
|
|
90
91
|
# Body param: Template category: MARKETING, UTILITY, AUTHENTICATION
|
|
91
92
|
category: nil,
|
|
92
|
-
# Body param:
|
|
93
|
+
# Body param: Complete definition of a message template including header, body,
|
|
94
|
+
# footer, and buttons
|
|
93
95
|
definition: nil,
|
|
94
96
|
# Body param: Template language code (e.g., en_US)
|
|
95
97
|
language: nil,
|
|
@@ -3,7 +3,7 @@ module Sentdm
|
|
|
3
3
|
type api_response_of_contact =
|
|
4
4
|
{
|
|
5
5
|
data: Sentdm::ContactResponse?,
|
|
6
|
-
error: Sentdm::
|
|
6
|
+
error: Sentdm::ErrorDetail?,
|
|
7
7
|
meta: Sentdm::APIMeta,
|
|
8
8
|
success: bool
|
|
9
9
|
}
|
|
@@ -11,7 +11,7 @@ module Sentdm
|
|
|
11
11
|
class APIResponseOfContact < Sentdm::Internal::Type::BaseModel
|
|
12
12
|
attr_accessor data: Sentdm::ContactResponse?
|
|
13
13
|
|
|
14
|
-
attr_accessor error: Sentdm::
|
|
14
|
+
attr_accessor error: Sentdm::ErrorDetail?
|
|
15
15
|
|
|
16
16
|
attr_reader meta: Sentdm::APIMeta?
|
|
17
17
|
|
|
@@ -23,14 +23,14 @@ module Sentdm
|
|
|
23
23
|
|
|
24
24
|
def initialize: (
|
|
25
25
|
?data: Sentdm::ContactResponse?,
|
|
26
|
-
?error: Sentdm::
|
|
26
|
+
?error: Sentdm::ErrorDetail?,
|
|
27
27
|
?meta: Sentdm::APIMeta,
|
|
28
28
|
?success: bool
|
|
29
29
|
) -> void
|
|
30
30
|
|
|
31
31
|
def to_hash: -> {
|
|
32
32
|
data: Sentdm::ContactResponse?,
|
|
33
|
-
error: Sentdm::
|
|
33
|
+
error: Sentdm::ErrorDetail?,
|
|
34
34
|
meta: Sentdm::APIMeta,
|
|
35
35
|
success: bool
|
|
36
36
|
}
|