sentdm 0.5.0 → 0.7.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 +31 -0
- data/README.md +31 -1
- data/lib/sentdm/models/brands_brand_data.rb +13 -249
- data/lib/sentdm/models/profiles/campaign_data.rb +5 -26
- data/lib/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rb +30 -0
- 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 +119 -0
- data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rb +77 -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_definition.rb +15 -255
- data/lib/sentdm/models.rb +27 -0
- data/lib/sentdm/version.rb +1 -1
- data/lib/sentdm.rb +10 -0
- data/rbi/sentdm/models/brands_brand_data.rbi +47 -349
- data/rbi/sentdm/models/profiles/campaign_data.rbi +14 -49
- data/rbi/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbi +53 -0
- 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 +183 -0
- data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rbi +99 -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_definition.rbi +74 -405
- data/rbi/sentdm/models.rbi +27 -0
- data/sig/sentdm/models/brands_brand_data.rbs +12 -192
- data/sig/sentdm/models/profiles/campaign_data.rbs +4 -26
- 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/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.rbs +18 -0
- metadata +31 -1
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
class SentDmServicesCommonContractsPocOsTemplateFooter < Sentdm::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute template
|
|
7
|
+
# The footer template text with optional variable placeholders
|
|
8
|
+
#
|
|
9
|
+
# @return [String, nil]
|
|
10
|
+
optional :template, String
|
|
11
|
+
|
|
12
|
+
# @!attribute type
|
|
13
|
+
# The type of footer (typically "text")
|
|
14
|
+
#
|
|
15
|
+
# @return [String, nil]
|
|
16
|
+
optional :type, String, nil?: true
|
|
17
|
+
|
|
18
|
+
# @!attribute variables
|
|
19
|
+
# List of variables used in the footer template
|
|
20
|
+
#
|
|
21
|
+
# @return [Array<Sentdm::Models::TemplateVariable>, nil]
|
|
22
|
+
optional :variables, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateVariable] }, nil?: true
|
|
23
|
+
|
|
24
|
+
# @!method initialize(template: nil, type: nil, variables: nil)
|
|
25
|
+
# Footer section of a message template
|
|
26
|
+
#
|
|
27
|
+
# @param template [String] The footer template text with optional variable placeholders
|
|
28
|
+
#
|
|
29
|
+
# @param type [String, nil] The type of footer (typically "text")
|
|
30
|
+
#
|
|
31
|
+
# @param variables [Array<Sentdm::Models::TemplateVariable>, nil] List of variables used in the footer template
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
end
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
class SentDmServicesCommonContractsPocOsTemplateHeader < Sentdm::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute template
|
|
7
|
+
# The header template text with optional variable placeholders (e.g., "Welcome to
|
|
8
|
+
# {{0:variable}}")
|
|
9
|
+
#
|
|
10
|
+
# @return [String, nil]
|
|
11
|
+
optional :template, String
|
|
12
|
+
|
|
13
|
+
# @!attribute type
|
|
14
|
+
# The type of header (e.g., "text", "image", "video", "document")
|
|
15
|
+
#
|
|
16
|
+
# @return [String, nil]
|
|
17
|
+
optional :type, String, nil?: true
|
|
18
|
+
|
|
19
|
+
# @!attribute variables
|
|
20
|
+
# List of variables used in the header template
|
|
21
|
+
#
|
|
22
|
+
# @return [Array<Sentdm::Models::TemplateVariable>, nil]
|
|
23
|
+
optional :variables, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateVariable] }, nil?: true
|
|
24
|
+
|
|
25
|
+
# @!method initialize(template: nil, type: nil, variables: nil)
|
|
26
|
+
# Some parameter documentations has been truncated, see
|
|
27
|
+
# {Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateHeader} for more
|
|
28
|
+
# details.
|
|
29
|
+
#
|
|
30
|
+
# Header section of a message template
|
|
31
|
+
#
|
|
32
|
+
# @param template [String] The header template text with optional variable placeholders (e.g., "Welcome to
|
|
33
|
+
#
|
|
34
|
+
# @param type [String, nil] The type of header (e.g., "text", "image", "video", "document")
|
|
35
|
+
#
|
|
36
|
+
# @param variables [Array<Sentdm::Models::TemplateVariable>, nil] List of variables used in the header template
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
end
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
class SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo < Sentdm::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute city
|
|
7
|
+
# City
|
|
8
|
+
#
|
|
9
|
+
# @return [String, nil]
|
|
10
|
+
optional :city, String, nil?: true
|
|
11
|
+
|
|
12
|
+
# @!attribute country
|
|
13
|
+
# Country code (e.g., US, CA)
|
|
14
|
+
#
|
|
15
|
+
# @return [String, nil]
|
|
16
|
+
optional :country, String, nil?: true
|
|
17
|
+
|
|
18
|
+
# @!attribute country_of_registration
|
|
19
|
+
# Country where the business is registered
|
|
20
|
+
#
|
|
21
|
+
# @return [String, nil]
|
|
22
|
+
optional :country_of_registration, String, api_name: :countryOfRegistration, nil?: true
|
|
23
|
+
|
|
24
|
+
# @!attribute entity_type
|
|
25
|
+
# Business entity type
|
|
26
|
+
#
|
|
27
|
+
# @return [Symbol, Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType, nil]
|
|
28
|
+
optional :entity_type,
|
|
29
|
+
enum: -> {
|
|
30
|
+
Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType
|
|
31
|
+
},
|
|
32
|
+
api_name: :entityType,
|
|
33
|
+
nil?: true
|
|
34
|
+
|
|
35
|
+
# @!attribute legal_name
|
|
36
|
+
# Legal business name
|
|
37
|
+
#
|
|
38
|
+
# @return [String, nil]
|
|
39
|
+
optional :legal_name, String, api_name: :legalName, nil?: true
|
|
40
|
+
|
|
41
|
+
# @!attribute postal_code
|
|
42
|
+
# Postal/ZIP code
|
|
43
|
+
#
|
|
44
|
+
# @return [String, nil]
|
|
45
|
+
optional :postal_code, String, api_name: :postalCode, nil?: true
|
|
46
|
+
|
|
47
|
+
# @!attribute state
|
|
48
|
+
# State/province code
|
|
49
|
+
#
|
|
50
|
+
# @return [String, nil]
|
|
51
|
+
optional :state, String, nil?: true
|
|
52
|
+
|
|
53
|
+
# @!attribute street
|
|
54
|
+
# Street address
|
|
55
|
+
#
|
|
56
|
+
# @return [String, nil]
|
|
57
|
+
optional :street, String, nil?: true
|
|
58
|
+
|
|
59
|
+
# @!attribute tax_id
|
|
60
|
+
# Tax ID/EIN number
|
|
61
|
+
#
|
|
62
|
+
# @return [String, nil]
|
|
63
|
+
optional :tax_id, String, api_name: :taxId, nil?: true
|
|
64
|
+
|
|
65
|
+
# @!attribute tax_id_type
|
|
66
|
+
# Type of tax ID (e.g., us_ein, ca_bn)
|
|
67
|
+
#
|
|
68
|
+
# @return [String, nil]
|
|
69
|
+
optional :tax_id_type, String, api_name: :taxIdType, nil?: true
|
|
70
|
+
|
|
71
|
+
# @!attribute url
|
|
72
|
+
# Business website URL
|
|
73
|
+
#
|
|
74
|
+
# @return [String, nil]
|
|
75
|
+
optional :url, String, nil?: true
|
|
76
|
+
|
|
77
|
+
# @!method initialize(city: nil, country: nil, country_of_registration: nil, entity_type: nil, legal_name: nil, postal_code: nil, state: nil, street: nil, tax_id: nil, tax_id_type: nil, url: nil)
|
|
78
|
+
# Business details and address for brand KYC
|
|
79
|
+
#
|
|
80
|
+
# @param city [String, nil] City
|
|
81
|
+
#
|
|
82
|
+
# @param country [String, nil] Country code (e.g., US, CA)
|
|
83
|
+
#
|
|
84
|
+
# @param country_of_registration [String, nil] Country where the business is registered
|
|
85
|
+
#
|
|
86
|
+
# @param entity_type [Symbol, Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType, nil] Business entity type
|
|
87
|
+
#
|
|
88
|
+
# @param legal_name [String, nil] Legal business name
|
|
89
|
+
#
|
|
90
|
+
# @param postal_code [String, nil] Postal/ZIP code
|
|
91
|
+
#
|
|
92
|
+
# @param state [String, nil] State/province code
|
|
93
|
+
#
|
|
94
|
+
# @param street [String, nil] Street address
|
|
95
|
+
#
|
|
96
|
+
# @param tax_id [String, nil] Tax ID/EIN number
|
|
97
|
+
#
|
|
98
|
+
# @param tax_id_type [String, nil] Type of tax ID (e.g., us_ein, ca_bn)
|
|
99
|
+
#
|
|
100
|
+
# @param url [String, nil] Business website URL
|
|
101
|
+
|
|
102
|
+
# Business entity type
|
|
103
|
+
#
|
|
104
|
+
# @see Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo#entity_type
|
|
105
|
+
module EntityType
|
|
106
|
+
extend Sentdm::Internal::Type::Enum
|
|
107
|
+
|
|
108
|
+
PRIVATE_PROFIT = :PRIVATE_PROFIT
|
|
109
|
+
PUBLIC_PROFIT = :PUBLIC_PROFIT
|
|
110
|
+
NON_PROFIT = :NON_PROFIT
|
|
111
|
+
SOLE_PROPRIETOR = :SOLE_PROPRIETOR
|
|
112
|
+
GOVERNMENT = :GOVERNMENT
|
|
113
|
+
|
|
114
|
+
# @!method self.values
|
|
115
|
+
# @return [Array<Symbol>]
|
|
116
|
+
end
|
|
117
|
+
end
|
|
118
|
+
end
|
|
119
|
+
end
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
class SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo < Sentdm::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute brand_relationship
|
|
7
|
+
# Brand relationship level with TCR (required for TCR)
|
|
8
|
+
#
|
|
9
|
+
# @return [Symbol, Sentdm::Models::TcrBrandRelationship]
|
|
10
|
+
required :brand_relationship, enum: -> { Sentdm::TcrBrandRelationship }, api_name: :brandRelationship
|
|
11
|
+
|
|
12
|
+
# @!attribute vertical
|
|
13
|
+
# Business vertical/industry category (required for TCR)
|
|
14
|
+
#
|
|
15
|
+
# @return [Symbol, Sentdm::Models::TcrVertical]
|
|
16
|
+
required :vertical, enum: -> { Sentdm::TcrVertical }
|
|
17
|
+
|
|
18
|
+
# @!attribute destination_countries
|
|
19
|
+
# List of destination countries for messaging
|
|
20
|
+
#
|
|
21
|
+
# @return [Array<Sentdm::Models::DestinationCountry>, nil]
|
|
22
|
+
optional :destination_countries,
|
|
23
|
+
-> { Sentdm::Internal::Type::ArrayOf[Sentdm::DestinationCountry] },
|
|
24
|
+
api_name: :destinationCountries,
|
|
25
|
+
nil?: true
|
|
26
|
+
|
|
27
|
+
# @!attribute expected_messaging_volume
|
|
28
|
+
# Expected daily messaging volume
|
|
29
|
+
#
|
|
30
|
+
# @return [String, nil]
|
|
31
|
+
optional :expected_messaging_volume, String, api_name: :expectedMessagingVolume, nil?: true
|
|
32
|
+
|
|
33
|
+
# @!attribute is_tcr_application
|
|
34
|
+
# Whether this is a TCR (Campaign Registry) application
|
|
35
|
+
#
|
|
36
|
+
# @return [Boolean, nil]
|
|
37
|
+
optional :is_tcr_application, Sentdm::Internal::Type::Boolean, api_name: :isTcrApplication, nil?: true
|
|
38
|
+
|
|
39
|
+
# @!attribute notes
|
|
40
|
+
# Additional notes about the business or use case
|
|
41
|
+
#
|
|
42
|
+
# @return [String, nil]
|
|
43
|
+
optional :notes, String, nil?: true
|
|
44
|
+
|
|
45
|
+
# @!attribute phone_number_prefix
|
|
46
|
+
# Phone number prefix for messaging (e.g., "+1")
|
|
47
|
+
#
|
|
48
|
+
# @return [String, nil]
|
|
49
|
+
optional :phone_number_prefix, String, api_name: :phoneNumberPrefix, nil?: true
|
|
50
|
+
|
|
51
|
+
# @!attribute primary_use_case
|
|
52
|
+
# Primary messaging use case description
|
|
53
|
+
#
|
|
54
|
+
# @return [String, nil]
|
|
55
|
+
optional :primary_use_case, String, api_name: :primaryUseCase, nil?: true
|
|
56
|
+
|
|
57
|
+
# @!method initialize(brand_relationship:, vertical:, destination_countries: nil, expected_messaging_volume: nil, is_tcr_application: nil, notes: nil, phone_number_prefix: nil, primary_use_case: nil)
|
|
58
|
+
# Compliance and TCR information for brand registration
|
|
59
|
+
#
|
|
60
|
+
# @param brand_relationship [Symbol, Sentdm::Models::TcrBrandRelationship] Brand relationship level with TCR (required for TCR)
|
|
61
|
+
#
|
|
62
|
+
# @param vertical [Symbol, Sentdm::Models::TcrVertical] Business vertical/industry category (required for TCR)
|
|
63
|
+
#
|
|
64
|
+
# @param destination_countries [Array<Sentdm::Models::DestinationCountry>, nil] List of destination countries for messaging
|
|
65
|
+
#
|
|
66
|
+
# @param expected_messaging_volume [String, nil] Expected daily messaging volume
|
|
67
|
+
#
|
|
68
|
+
# @param is_tcr_application [Boolean, nil] Whether this is a TCR (Campaign Registry) application
|
|
69
|
+
#
|
|
70
|
+
# @param notes [String, nil] Additional notes about the business or use case
|
|
71
|
+
#
|
|
72
|
+
# @param phone_number_prefix [String, nil] Phone number prefix for messaging (e.g., "+1")
|
|
73
|
+
#
|
|
74
|
+
# @param primary_use_case [String, nil] Primary messaging use case description
|
|
75
|
+
end
|
|
76
|
+
end
|
|
77
|
+
end
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
class SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo < Sentdm::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute name
|
|
7
|
+
# Primary contact name (required)
|
|
8
|
+
#
|
|
9
|
+
# @return [String]
|
|
10
|
+
required :name, String
|
|
11
|
+
|
|
12
|
+
# @!attribute business_name
|
|
13
|
+
# Business/brand name
|
|
14
|
+
#
|
|
15
|
+
# @return [String, nil]
|
|
16
|
+
optional :business_name, String, api_name: :businessName, nil?: true
|
|
17
|
+
|
|
18
|
+
# @!attribute email
|
|
19
|
+
# Contact email address
|
|
20
|
+
#
|
|
21
|
+
# @return [String, nil]
|
|
22
|
+
optional :email, String, nil?: true
|
|
23
|
+
|
|
24
|
+
# @!attribute phone
|
|
25
|
+
# Contact phone number in E.164 format
|
|
26
|
+
#
|
|
27
|
+
# @return [String, nil]
|
|
28
|
+
optional :phone, String, nil?: true
|
|
29
|
+
|
|
30
|
+
# @!attribute phone_country_code
|
|
31
|
+
# Contact phone country code (e.g., "1" for US)
|
|
32
|
+
#
|
|
33
|
+
# @return [String, nil]
|
|
34
|
+
optional :phone_country_code, String, api_name: :phoneCountryCode, nil?: true
|
|
35
|
+
|
|
36
|
+
# @!attribute role
|
|
37
|
+
# Contact's role in the business
|
|
38
|
+
#
|
|
39
|
+
# @return [String, nil]
|
|
40
|
+
optional :role, String, nil?: true
|
|
41
|
+
|
|
42
|
+
# @!method initialize(name:, business_name: nil, email: nil, phone: nil, phone_country_code: nil, role: nil)
|
|
43
|
+
# Contact information for brand KYC
|
|
44
|
+
#
|
|
45
|
+
# @param name [String] Primary contact name (required)
|
|
46
|
+
#
|
|
47
|
+
# @param business_name [String, nil] Business/brand name
|
|
48
|
+
#
|
|
49
|
+
# @param email [String, nil] Contact email address
|
|
50
|
+
#
|
|
51
|
+
# @param phone [String, nil] Contact phone number in E.164 format
|
|
52
|
+
#
|
|
53
|
+
# @param phone_country_code [String, nil] Contact phone country code (e.g., "1" for US)
|
|
54
|
+
#
|
|
55
|
+
# @param role [String, nil] Contact's role in the business
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
end
|
|
@@ -7,25 +7,25 @@ module Sentdm
|
|
|
7
7
|
# Required template body with content for different channels (multi-channel,
|
|
8
8
|
# SMS-specific, or WhatsApp-specific)
|
|
9
9
|
#
|
|
10
|
-
# @return [Sentdm::Models::
|
|
11
|
-
required :body, -> { Sentdm::
|
|
10
|
+
# @return [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateBody]
|
|
11
|
+
required :body, -> { Sentdm::SentDmServicesCommonContractsPocOsTemplateBody }
|
|
12
12
|
|
|
13
13
|
# @!attribute authentication_config
|
|
14
14
|
# Configuration specific to AUTHENTICATION category templates (optional)
|
|
15
15
|
#
|
|
16
|
-
# @return [Sentdm::Models::
|
|
16
|
+
# @return [Sentdm::Models::SentDmServicesCommonContractsPocOsAuthenticationConfig, nil]
|
|
17
17
|
optional :authentication_config,
|
|
18
|
-
-> { Sentdm::
|
|
18
|
+
-> { Sentdm::SentDmServicesCommonContractsPocOsAuthenticationConfig },
|
|
19
19
|
api_name: :authenticationConfig,
|
|
20
20
|
nil?: true
|
|
21
21
|
|
|
22
22
|
# @!attribute buttons
|
|
23
23
|
# Optional list of interactive buttons (e.g., quick replies, URLs, phone numbers)
|
|
24
24
|
#
|
|
25
|
-
# @return [Array<Sentdm::Models::
|
|
25
|
+
# @return [Array<Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButton>, nil]
|
|
26
26
|
optional :buttons,
|
|
27
27
|
-> {
|
|
28
|
-
Sentdm::Internal::Type::ArrayOf[Sentdm::
|
|
28
|
+
Sentdm::Internal::Type::ArrayOf[Sentdm::SentDmServicesCommonContractsPocOsTemplateButton]
|
|
29
29
|
},
|
|
30
30
|
nil?: true
|
|
31
31
|
|
|
@@ -38,14 +38,14 @@ module Sentdm
|
|
|
38
38
|
# @!attribute footer
|
|
39
39
|
# Optional template footer with optional variables
|
|
40
40
|
#
|
|
41
|
-
# @return [Sentdm::Models::
|
|
42
|
-
optional :footer, -> { Sentdm::
|
|
41
|
+
# @return [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateFooter, nil]
|
|
42
|
+
optional :footer, -> { Sentdm::SentDmServicesCommonContractsPocOsTemplateFooter }, nil?: true
|
|
43
43
|
|
|
44
44
|
# @!attribute header
|
|
45
45
|
# Optional template header with optional variables
|
|
46
46
|
#
|
|
47
|
-
# @return [Sentdm::Models::
|
|
48
|
-
optional :header, -> { Sentdm::
|
|
47
|
+
# @return [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateHeader, nil]
|
|
48
|
+
optional :header, -> { Sentdm::SentDmServicesCommonContractsPocOsTemplateHeader }, nil?: true
|
|
49
49
|
|
|
50
50
|
# @!method initialize(body:, authentication_config: nil, buttons: nil, definition_version: nil, footer: nil, header: nil)
|
|
51
51
|
# Some parameter documentations has been truncated, see
|
|
@@ -54,257 +54,17 @@ module Sentdm
|
|
|
54
54
|
# Complete definition of a message template including header, body, footer, and
|
|
55
55
|
# buttons
|
|
56
56
|
#
|
|
57
|
-
# @param body [Sentdm::Models::
|
|
57
|
+
# @param body [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateBody] Required template body with content for different channels (multi-channel, SMS-s
|
|
58
58
|
#
|
|
59
|
-
# @param authentication_config [Sentdm::Models::
|
|
59
|
+
# @param authentication_config [Sentdm::Models::SentDmServicesCommonContractsPocOsAuthenticationConfig, nil] Configuration specific to AUTHENTICATION category templates (optional)
|
|
60
60
|
#
|
|
61
|
-
# @param buttons [Array<Sentdm::Models::
|
|
61
|
+
# @param buttons [Array<Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButton>, nil] Optional list of interactive buttons (e.g., quick replies, URLs, phone numbers)
|
|
62
62
|
#
|
|
63
63
|
# @param definition_version [String, nil] The version of the template definition format
|
|
64
64
|
#
|
|
65
|
-
# @param footer [Sentdm::Models::
|
|
65
|
+
# @param footer [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateFooter, nil] Optional template footer with optional variables
|
|
66
66
|
#
|
|
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
|
|
67
|
+
# @param header [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateHeader, nil] Optional template header with optional variables
|
|
308
68
|
end
|
|
309
69
|
end
|
|
310
70
|
end
|
data/lib/sentdm/models.rb
CHANGED
|
@@ -107,6 +107,33 @@ module Sentdm
|
|
|
107
107
|
|
|
108
108
|
ProfileUpdateParams = Sentdm::Models::ProfileUpdateParams
|
|
109
109
|
|
|
110
|
+
SentDmServicesCommonContractsPocOsAuthenticationConfig =
|
|
111
|
+
Sentdm::Models::SentDmServicesCommonContractsPocOsAuthenticationConfig
|
|
112
|
+
|
|
113
|
+
SentDmServicesCommonContractsPocOsTemplateBody =
|
|
114
|
+
Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateBody
|
|
115
|
+
|
|
116
|
+
SentDmServicesCommonContractsPocOsTemplateButton =
|
|
117
|
+
Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButton
|
|
118
|
+
|
|
119
|
+
SentDmServicesCommonContractsPocOsTemplateButtonProps =
|
|
120
|
+
Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButtonProps
|
|
121
|
+
|
|
122
|
+
SentDmServicesCommonContractsPocOsTemplateFooter =
|
|
123
|
+
Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateFooter
|
|
124
|
+
|
|
125
|
+
SentDmServicesCommonContractsPocOsTemplateHeader =
|
|
126
|
+
Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateHeader
|
|
127
|
+
|
|
128
|
+
SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo =
|
|
129
|
+
Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo
|
|
130
|
+
|
|
131
|
+
SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo =
|
|
132
|
+
Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo
|
|
133
|
+
|
|
134
|
+
SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo =
|
|
135
|
+
Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo
|
|
136
|
+
|
|
110
137
|
TcrBrandRelationship = Sentdm::Models::TcrBrandRelationship
|
|
111
138
|
|
|
112
139
|
TcrVertical = Sentdm::Models::TcrVertical
|
data/lib/sentdm/version.rb
CHANGED