sentdm 0.7.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.
Files changed (123) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +10 -0
  3. data/README.md +1 -1
  4. data/lib/sentdm/internal/type/base_model.rb +5 -5
  5. data/lib/sentdm/models/api_response_of_contact.rb +9 -6
  6. data/lib/sentdm/models/api_response_of_profile_detail.rb +6 -6
  7. data/lib/sentdm/models/api_response_of_user.rb +6 -6
  8. data/lib/sentdm/models/api_response_template.rb +6 -6
  9. data/lib/sentdm/models/api_response_webhook.rb +4 -4
  10. data/lib/sentdm/models/brands_brand_data.rb +6 -6
  11. data/lib/sentdm/models/contact_delete_params.rb +1 -1
  12. data/lib/sentdm/models/contact_list_response.rb +9 -9
  13. data/lib/sentdm/models/me_retrieve_response.rb +35 -21
  14. data/lib/sentdm/models/message_retrieve_activities_response.rb +7 -7
  15. data/lib/sentdm/models/message_retrieve_status_response.rb +7 -7
  16. data/lib/sentdm/models/message_send_params.rb +5 -3
  17. data/lib/sentdm/models/message_send_response.rb +7 -7
  18. data/lib/sentdm/models/{mutation_request_base.rb → mutation_request.rb} +2 -2
  19. data/lib/sentdm/models/number_lookup_response.rb +4 -4
  20. data/lib/sentdm/models/pagination_meta.rb +3 -3
  21. data/lib/sentdm/models/{profile_complete_setup_params.rb → profile_complete_params.rb} +3 -3
  22. data/lib/sentdm/models/{profile_complete_setup_response.rb → profile_complete_response.rb} +1 -1
  23. data/lib/sentdm/models/profile_create_params.rb +20 -23
  24. data/lib/sentdm/models/profile_delete_params.rb +1 -1
  25. data/lib/sentdm/models/profile_detail.rb +12 -22
  26. data/lib/sentdm/models/profile_list_response.rb +7 -7
  27. data/lib/sentdm/models/profile_update_params.rb +9 -13
  28. data/lib/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rb +4 -4
  29. data/lib/sentdm/models/profiles/base_dto.rb +32 -0
  30. data/lib/sentdm/models/profiles/campaign_create_params.rb +2 -2
  31. data/lib/sentdm/models/profiles/campaign_delete_params.rb +1 -1
  32. data/lib/sentdm/models/profiles/campaign_list_response.rb +4 -4
  33. data/lib/sentdm/models/profiles/campaign_update_params.rb +2 -2
  34. data/lib/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rb +1 -2
  35. data/lib/sentdm/models/profiles/tcr_campaign_with_use_cases.rb +2 -2
  36. data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rb +1 -4
  37. data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rb +2 -4
  38. data/lib/sentdm/models/template_create_params.rb +3 -2
  39. data/lib/sentdm/models/template_definition.rb +8 -12
  40. data/lib/sentdm/models/template_list_response.rb +9 -9
  41. data/lib/sentdm/models/template_update_params.rb +3 -2
  42. data/lib/sentdm/models/user_list_response.rb +7 -7
  43. data/lib/sentdm/models/user_remove_params.rb +1 -1
  44. data/lib/sentdm/models/webhook_list_event_types_response.rb +4 -4
  45. data/lib/sentdm/models/webhook_list_events_response.rb +4 -4
  46. data/lib/sentdm/models/webhook_list_response.rb +4 -4
  47. data/lib/sentdm/models/webhook_rotate_secret_params.rb +1 -1
  48. data/lib/sentdm/models/webhook_rotate_secret_response.rb +4 -4
  49. data/lib/sentdm/models/webhook_test_response.rb +4 -4
  50. data/lib/sentdm/models.rb +2 -4
  51. data/lib/sentdm/resources/messages.rb +1 -1
  52. data/lib/sentdm/resources/profiles/campaigns.rb +2 -2
  53. data/lib/sentdm/resources/profiles.rb +12 -12
  54. data/lib/sentdm/resources/templates.rb +2 -2
  55. data/lib/sentdm/version.rb +1 -1
  56. data/lib/sentdm.rb +4 -4
  57. data/rbi/sentdm/models/api_response_of_contact.rbi +6 -6
  58. data/rbi/sentdm/models/api_response_of_profile_detail.rbi +6 -6
  59. data/rbi/sentdm/models/api_response_of_user.rbi +6 -6
  60. data/rbi/sentdm/models/api_response_template.rbi +6 -6
  61. data/rbi/sentdm/models/api_response_webhook.rbi +4 -4
  62. data/rbi/sentdm/models/brands_brand_data.rbi +6 -6
  63. data/rbi/sentdm/models/contact_delete_params.rbi +1 -1
  64. data/rbi/sentdm/models/contact_list_response.rbi +9 -9
  65. data/rbi/sentdm/models/me_retrieve_response.rbi +33 -21
  66. data/rbi/sentdm/models/message_retrieve_activities_response.rbi +7 -7
  67. data/rbi/sentdm/models/message_retrieve_status_response.rbi +7 -7
  68. data/rbi/sentdm/models/message_send_params.rbi +6 -3
  69. data/rbi/sentdm/models/message_send_response.rbi +7 -7
  70. data/rbi/sentdm/models/{mutation_request_base.rbi → mutation_request.rbi} +2 -2
  71. data/rbi/sentdm/models/number_lookup_response.rbi +4 -4
  72. data/rbi/sentdm/models/pagination_meta.rbi +3 -3
  73. data/rbi/sentdm/models/{profile_complete_setup_params.rbi → profile_complete_params.rbi} +2 -2
  74. data/rbi/sentdm/models/{profile_complete_setup_response.rbi → profile_complete_response.rbi} +1 -1
  75. data/rbi/sentdm/models/profile_create_params.rbi +27 -33
  76. data/rbi/sentdm/models/profile_delete_params.rbi +1 -1
  77. data/rbi/sentdm/models/profile_detail.rbi +9 -22
  78. data/rbi/sentdm/models/profile_list_response.rbi +7 -7
  79. data/rbi/sentdm/models/profile_update_params.rbi +12 -20
  80. data/rbi/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rbi +4 -4
  81. data/rbi/sentdm/models/profiles/base_dto.rbi +53 -0
  82. data/rbi/sentdm/models/profiles/campaign_create_params.rbi +2 -2
  83. data/rbi/sentdm/models/profiles/campaign_delete_params.rbi +1 -1
  84. data/rbi/sentdm/models/profiles/campaign_list_response.rbi +4 -4
  85. data/rbi/sentdm/models/profiles/campaign_update_params.rbi +2 -2
  86. data/rbi/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbi +0 -2
  87. data/rbi/sentdm/models/profiles/tcr_campaign_with_use_cases.rbi +2 -2
  88. data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rbi +0 -3
  89. data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rbi +0 -4
  90. data/rbi/sentdm/models/template_create_params.rbi +4 -2
  91. data/rbi/sentdm/models/template_definition.rbi +8 -10
  92. data/rbi/sentdm/models/template_list_response.rbi +9 -9
  93. data/rbi/sentdm/models/template_update_params.rbi +4 -2
  94. data/rbi/sentdm/models/user_list_response.rbi +7 -7
  95. data/rbi/sentdm/models/user_remove_params.rbi +1 -1
  96. data/rbi/sentdm/models/webhook_list_event_types_response.rbi +4 -4
  97. data/rbi/sentdm/models/webhook_list_events_response.rbi +4 -4
  98. data/rbi/sentdm/models/webhook_list_response.rbi +4 -4
  99. data/rbi/sentdm/models/webhook_rotate_secret_params.rbi +1 -1
  100. data/rbi/sentdm/models/webhook_rotate_secret_response.rbi +4 -4
  101. data/rbi/sentdm/models/webhook_test_response.rbi +4 -4
  102. data/rbi/sentdm/models.rbi +2 -4
  103. data/rbi/sentdm/resources/messages.rbi +2 -1
  104. data/rbi/sentdm/resources/profiles/campaigns.rbi +2 -2
  105. data/rbi/sentdm/resources/profiles.rbi +20 -26
  106. data/rbi/sentdm/resources/templates.rbi +4 -2
  107. data/sig/sentdm/models/contact_delete_params.rbs +1 -1
  108. data/sig/sentdm/models/{mutation_request_base.rbs → mutation_request.rbs} +2 -2
  109. data/sig/sentdm/models/{profile_complete_setup_params.rbs → profile_complete_params.rbs} +2 -2
  110. data/sig/sentdm/models/profile_complete_response.rbs +5 -0
  111. data/sig/sentdm/models/profile_delete_params.rbs +1 -1
  112. data/sig/sentdm/models/profiles/base_dto.rbs +27 -0
  113. data/sig/sentdm/models/profiles/campaign_delete_params.rbs +1 -1
  114. data/sig/sentdm/models/profiles/tcr_campaign_with_use_cases.rbs +2 -2
  115. data/sig/sentdm/models/user_remove_params.rbs +1 -1
  116. data/sig/sentdm/models/webhook_rotate_secret_params.rbs +1 -1
  117. data/sig/sentdm/models.rbs +2 -4
  118. data/sig/sentdm/resources/profiles.rbs +1 -1
  119. metadata +14 -14
  120. data/lib/sentdm/models/base_dto.rb +0 -30
  121. data/rbi/sentdm/models/base_dto.rbi +0 -49
  122. data/sig/sentdm/models/base_dto.rbs +0 -25
  123. data/sig/sentdm/models/profile_complete_setup_response.rbs +0 -5
@@ -5,7 +5,6 @@ module Sentdm
5
5
  module Profiles
6
6
  class SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData < Sentdm::Internal::Type::BaseModel
7
7
  # @!attribute messaging_use_case_us
8
- # US messaging use case category
9
8
  #
10
9
  # @return [Symbol, Sentdm::Models::Profiles::MessagingUseCaseUs]
11
10
  required :messaging_use_case_us,
@@ -21,7 +20,7 @@ module Sentdm
21
20
  # @!method initialize(messaging_use_case_us:, sample_messages:)
22
21
  # Campaign use case with sample messages
23
22
  #
24
- # @param messaging_use_case_us [Symbol, Sentdm::Models::Profiles::MessagingUseCaseUs] US messaging use case category
23
+ # @param messaging_use_case_us [Symbol, Sentdm::Models::Profiles::MessagingUseCaseUs]
25
24
  #
26
25
  # @param sample_messages [Array<String>] Sample messages for this use case (1-5 messages, max 1024 characters each)
27
26
  end
@@ -3,7 +3,7 @@
3
3
  module Sentdm
4
4
  module Models
5
5
  module Profiles
6
- class TcrCampaignWithUseCases < Sentdm::Models::BaseDto
6
+ class TcrCampaignWithUseCases < Sentdm::Models::Profiles::BaseDto
7
7
  # @!attribute billed_date
8
8
  #
9
9
  # @return [Time, nil]
@@ -201,7 +201,7 @@ module Sentdm
201
201
  # @return [Array<Symbol>]
202
202
  end
203
203
 
204
- class UseCase < Sentdm::Models::BaseDto
204
+ class UseCase < Sentdm::Models::Profiles::BaseDto
205
205
  # @!attribute campaign_id
206
206
  #
207
207
  # @return [String, nil]
@@ -22,7 +22,6 @@ module Sentdm
22
22
  optional :country_of_registration, String, api_name: :countryOfRegistration, nil?: true
23
23
 
24
24
  # @!attribute entity_type
25
- # Business entity type
26
25
  #
27
26
  # @return [Symbol, Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType, nil]
28
27
  optional :entity_type,
@@ -83,7 +82,7 @@ module Sentdm
83
82
  #
84
83
  # @param country_of_registration [String, nil] Country where the business is registered
85
84
  #
86
- # @param entity_type [Symbol, Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType, nil] Business entity type
85
+ # @param entity_type [Symbol, Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType, nil]
87
86
  #
88
87
  # @param legal_name [String, nil] Legal business name
89
88
  #
@@ -99,8 +98,6 @@ module Sentdm
99
98
  #
100
99
  # @param url [String, nil] Business website URL
101
100
 
102
- # Business entity type
103
- #
104
101
  # @see Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo#entity_type
105
102
  module EntityType
106
103
  extend Sentdm::Internal::Type::Enum
@@ -4,13 +4,11 @@ module Sentdm
4
4
  module Models
5
5
  class SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo < Sentdm::Internal::Type::BaseModel
6
6
  # @!attribute brand_relationship
7
- # Brand relationship level with TCR (required for TCR)
8
7
  #
9
8
  # @return [Symbol, Sentdm::Models::TcrBrandRelationship]
10
9
  required :brand_relationship, enum: -> { Sentdm::TcrBrandRelationship }, api_name: :brandRelationship
11
10
 
12
11
  # @!attribute vertical
13
- # Business vertical/industry category (required for TCR)
14
12
  #
15
13
  # @return [Symbol, Sentdm::Models::TcrVertical]
16
14
  required :vertical, enum: -> { Sentdm::TcrVertical }
@@ -57,9 +55,9 @@ module Sentdm
57
55
  # @!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
56
  # Compliance and TCR information for brand registration
59
57
  #
60
- # @param brand_relationship [Symbol, Sentdm::Models::TcrBrandRelationship] Brand relationship level with TCR (required for TCR)
58
+ # @param brand_relationship [Symbol, Sentdm::Models::TcrBrandRelationship]
61
59
  #
62
- # @param vertical [Symbol, Sentdm::Models::TcrVertical] Business vertical/industry category (required for TCR)
60
+ # @param vertical [Symbol, Sentdm::Models::TcrVertical]
63
61
  #
64
62
  # @param destination_countries [Array<Sentdm::Models::DestinationCountry>, nil] List of destination countries for messaging
65
63
  #
@@ -21,7 +21,8 @@ module Sentdm
21
21
  optional :creation_source, String, nil?: true
22
22
 
23
23
  # @!attribute definition
24
- # Template definition including header, body, footer, and buttons
24
+ # Complete definition of a message template including header, body, footer, and
25
+ # buttons
25
26
  #
26
27
  # @return [Sentdm::Models::TemplateDefinition, nil]
27
28
  optional :definition, -> { Sentdm::TemplateDefinition }
@@ -63,7 +64,7 @@ module Sentdm
63
64
  #
64
65
  # @param creation_source [String, nil] Source of template creation (default: from-api)
65
66
  #
66
- # @param definition [Sentdm::Models::TemplateDefinition] Template definition including header, body, footer, and buttons
67
+ # @param definition [Sentdm::Models::TemplateDefinition] Complete definition of a message template including header, body, footer, and bu
67
68
  #
68
69
  # @param language [String, nil] Template language code (e.g., en_US) (optional, auto-detected if not provided)
69
70
  #
@@ -4,14 +4,13 @@ module Sentdm
4
4
  module Models
5
5
  class TemplateDefinition < Sentdm::Internal::Type::BaseModel
6
6
  # @!attribute body
7
- # Required template body with content for different channels (multi-channel,
8
- # SMS-specific, or WhatsApp-specific)
7
+ # Body section of a message template with channel-specific content
9
8
  #
10
9
  # @return [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateBody]
11
10
  required :body, -> { Sentdm::SentDmServicesCommonContractsPocOsTemplateBody }
12
11
 
13
12
  # @!attribute authentication_config
14
- # Configuration specific to AUTHENTICATION category templates (optional)
13
+ # Configuration for AUTHENTICATION category templates
15
14
  #
16
15
  # @return [Sentdm::Models::SentDmServicesCommonContractsPocOsAuthenticationConfig, nil]
17
16
  optional :authentication_config,
@@ -36,35 +35,32 @@ module Sentdm
36
35
  optional :definition_version, String, api_name: :definitionVersion, nil?: true
37
36
 
38
37
  # @!attribute footer
39
- # Optional template footer with optional variables
38
+ # Footer section of a message template
40
39
  #
41
40
  # @return [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateFooter, nil]
42
41
  optional :footer, -> { Sentdm::SentDmServicesCommonContractsPocOsTemplateFooter }, nil?: true
43
42
 
44
43
  # @!attribute header
45
- # Optional template header with optional variables
44
+ # Header section of a message template
46
45
  #
47
46
  # @return [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateHeader, nil]
48
47
  optional :header, -> { Sentdm::SentDmServicesCommonContractsPocOsTemplateHeader }, nil?: true
49
48
 
50
49
  # @!method initialize(body:, authentication_config: nil, buttons: nil, definition_version: nil, footer: nil, header: nil)
51
- # Some parameter documentations has been truncated, see
52
- # {Sentdm::Models::TemplateDefinition} for more details.
53
- #
54
50
  # Complete definition of a message template including header, body, footer, and
55
51
  # buttons
56
52
  #
57
- # @param body [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateBody] Required template body with content for different channels (multi-channel, SMS-s
53
+ # @param body [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateBody] Body section of a message template with channel-specific content
58
54
  #
59
- # @param authentication_config [Sentdm::Models::SentDmServicesCommonContractsPocOsAuthenticationConfig, nil] Configuration specific to AUTHENTICATION category templates (optional)
55
+ # @param authentication_config [Sentdm::Models::SentDmServicesCommonContractsPocOsAuthenticationConfig, nil] Configuration for AUTHENTICATION category templates
60
56
  #
61
57
  # @param buttons [Array<Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButton>, nil] Optional list of interactive buttons (e.g., quick replies, URLs, phone numbers)
62
58
  #
63
59
  # @param definition_version [String, nil] The version of the template definition format
64
60
  #
65
- # @param footer [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateFooter, nil] Optional template footer with optional variables
61
+ # @param footer [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateFooter, nil] Footer section of a message template
66
62
  #
67
- # @param header [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateHeader, nil] Optional template header with optional variables
63
+ # @param header [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateHeader, nil] Header section of a message template
68
64
  end
69
65
  end
70
66
  end
@@ -5,19 +5,19 @@ module Sentdm
5
5
  # @see Sentdm::Resources::Templates#list
6
6
  class TemplateListResponse < Sentdm::Internal::Type::BaseModel
7
7
  # @!attribute data
8
- # The response data (null if error)
8
+ # Paginated list of templates
9
9
  #
10
10
  # @return [Sentdm::Models::TemplateListResponse::Data, nil]
11
11
  optional :data, -> { Sentdm::Models::TemplateListResponse::Data }, nil?: true
12
12
 
13
13
  # @!attribute error
14
- # Error details (null if successful)
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
- # Metadata about the request and response
20
+ # Request and response metadata
21
21
  #
22
22
  # @return [Sentdm::Models::APIMeta, nil]
23
23
  optional :meta, -> { Sentdm::APIMeta }
@@ -31,18 +31,18 @@ module Sentdm
31
31
  # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
32
32
  # Standard API response envelope for all v3 endpoints
33
33
  #
34
- # @param data [Sentdm::Models::TemplateListResponse::Data, nil] The response data (null if error)
34
+ # @param data [Sentdm::Models::TemplateListResponse::Data, nil] Paginated list of templates
35
35
  #
36
- # @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
36
+ # @param error [Sentdm::Models::APIError, nil] Error information
37
37
  #
38
- # @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
38
+ # @param meta [Sentdm::Models::APIMeta] Request and response metadata
39
39
  #
40
40
  # @param success [Boolean] Indicates whether the request was successful
41
41
 
42
42
  # @see Sentdm::Models::TemplateListResponse#data
43
43
  class Data < Sentdm::Internal::Type::BaseModel
44
44
  # @!attribute pagination
45
- # Pagination metadata
45
+ # Pagination metadata for list responses
46
46
  #
47
47
  # @return [Sentdm::Models::PaginationMeta, nil]
48
48
  optional :pagination, -> { Sentdm::PaginationMeta }
@@ -54,9 +54,9 @@ module Sentdm
54
54
  optional :templates, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Template] }
55
55
 
56
56
  # @!method initialize(pagination: nil, templates: nil)
57
- # The response data (null if error)
57
+ # Paginated list of templates
58
58
  #
59
- # @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata
59
+ # @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
60
60
  #
61
61
  # @param templates [Array<Sentdm::Models::Template>] List of templates
62
62
  end
@@ -19,7 +19,8 @@ module Sentdm
19
19
  optional :category, String, nil?: true
20
20
 
21
21
  # @!attribute definition
22
- # Template definition including header, body, footer, and buttons
22
+ # Complete definition of a message template including header, body, footer, and
23
+ # buttons
23
24
  #
24
25
  # @return [Sentdm::Models::TemplateDefinition, nil]
25
26
  optional :definition, -> { Sentdm::TemplateDefinition }, nil?: true
@@ -67,7 +68,7 @@ module Sentdm
67
68
  #
68
69
  # @param category [String, nil] Template category: MARKETING, UTILITY, AUTHENTICATION
69
70
  #
70
- # @param definition [Sentdm::Models::TemplateDefinition, nil] Template definition including header, body, footer, and buttons
71
+ # @param definition [Sentdm::Models::TemplateDefinition, nil] Complete definition of a message template including header, body, footer, and bu
71
72
  #
72
73
  # @param language [String, nil] Template language code (e.g., en_US)
73
74
  #
@@ -5,19 +5,19 @@ module Sentdm
5
5
  # @see Sentdm::Resources::Users#list
6
6
  class UserListResponse < Sentdm::Internal::Type::BaseModel
7
7
  # @!attribute data
8
- # The response data (null if error)
8
+ # List of users response
9
9
  #
10
10
  # @return [Sentdm::Models::UserListResponse::Data, nil]
11
11
  optional :data, -> { Sentdm::Models::UserListResponse::Data }, nil?: true
12
12
 
13
13
  # @!attribute error
14
- # Error details (null if successful)
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
- # Metadata about the request and response
20
+ # Request and response metadata
21
21
  #
22
22
  # @return [Sentdm::Models::APIMeta, nil]
23
23
  optional :meta, -> { Sentdm::APIMeta }
@@ -31,11 +31,11 @@ module Sentdm
31
31
  # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
32
32
  # Standard API response envelope for all v3 endpoints
33
33
  #
34
- # @param data [Sentdm::Models::UserListResponse::Data, nil] The response data (null if error)
34
+ # @param data [Sentdm::Models::UserListResponse::Data, nil] List of users response
35
35
  #
36
- # @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
36
+ # @param error [Sentdm::Models::APIError, nil] Error information
37
37
  #
38
- # @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
38
+ # @param meta [Sentdm::Models::APIMeta] Request and response metadata
39
39
  #
40
40
  # @param success [Boolean] Indicates whether the request was successful
41
41
 
@@ -48,7 +48,7 @@ module Sentdm
48
48
  optional :users, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::UserResponse] }
49
49
 
50
50
  # @!method initialize(users: nil)
51
- # The response data (null if error)
51
+ # List of users response
52
52
  #
53
53
  # @param users [Array<Sentdm::Models::UserResponse>] List of users in the organization
54
54
  end
@@ -32,7 +32,7 @@ module Sentdm
32
32
  #
33
33
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
34
34
 
35
- class Body < Sentdm::Models::MutationRequestBase
35
+ class Body < Sentdm::Models::MutationRequest
36
36
  # @!method initialize
37
37
  # Request to remove a user from an organization
38
38
  end
@@ -11,13 +11,13 @@ module Sentdm
11
11
  optional :data, -> { Sentdm::Models::WebhookListEventTypesResponse::Data }, nil?: true
12
12
 
13
13
  # @!attribute error
14
- # Error details (null if successful)
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
- # Metadata about the request and response
20
+ # Request and response metadata
21
21
  #
22
22
  # @return [Sentdm::Models::APIMeta, nil]
23
23
  optional :meta, -> { Sentdm::APIMeta }
@@ -33,9 +33,9 @@ module Sentdm
33
33
  #
34
34
  # @param data [Sentdm::Models::WebhookListEventTypesResponse::Data, nil] The response data (null if error)
35
35
  #
36
- # @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
36
+ # @param error [Sentdm::Models::APIError, nil] Error information
37
37
  #
38
- # @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
38
+ # @param meta [Sentdm::Models::APIMeta] Request and response metadata
39
39
  #
40
40
  # @param success [Boolean] Indicates whether the request was successful
41
41
 
@@ -11,13 +11,13 @@ module Sentdm
11
11
  optional :data, -> { Sentdm::Models::WebhookListEventsResponse::Data }, nil?: true
12
12
 
13
13
  # @!attribute error
14
- # Error details (null if successful)
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
- # Metadata about the request and response
20
+ # Request and response metadata
21
21
  #
22
22
  # @return [Sentdm::Models::APIMeta, nil]
23
23
  optional :meta, -> { Sentdm::APIMeta }
@@ -33,9 +33,9 @@ module Sentdm
33
33
  #
34
34
  # @param data [Sentdm::Models::WebhookListEventsResponse::Data, nil] The response data (null if error)
35
35
  #
36
- # @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
36
+ # @param error [Sentdm::Models::APIError, nil] Error information
37
37
  #
38
- # @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
38
+ # @param meta [Sentdm::Models::APIMeta] Request and response metadata
39
39
  #
40
40
  # @param success [Boolean] Indicates whether the request was successful
41
41
 
@@ -11,13 +11,13 @@ module Sentdm
11
11
  optional :data, -> { Sentdm::Models::WebhookListResponse::Data }, nil?: true
12
12
 
13
13
  # @!attribute error
14
- # Error details (null if successful)
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
- # Metadata about the request and response
20
+ # Request and response metadata
21
21
  #
22
22
  # @return [Sentdm::Models::APIMeta, nil]
23
23
  optional :meta, -> { Sentdm::APIMeta }
@@ -33,9 +33,9 @@ module Sentdm
33
33
  #
34
34
  # @param data [Sentdm::Models::WebhookListResponse::Data, nil] The response data (null if error)
35
35
  #
36
- # @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
36
+ # @param error [Sentdm::Models::APIError, nil] Error information
37
37
  #
38
- # @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
38
+ # @param meta [Sentdm::Models::APIMeta] Request and response metadata
39
39
  #
40
40
  # @param success [Boolean] Indicates whether the request was successful
41
41
 
@@ -34,7 +34,7 @@ module Sentdm
34
34
  # @param x_profile_id [String]
35
35
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
36
36
 
37
- class Body < Sentdm::Models::MutationRequestBase
37
+ class Body < Sentdm::Models::MutationRequest
38
38
  # @!method initialize
39
39
  end
40
40
  end
@@ -11,13 +11,13 @@ module Sentdm
11
11
  optional :data, -> { Sentdm::Models::WebhookRotateSecretResponse::Data }, nil?: true
12
12
 
13
13
  # @!attribute error
14
- # Error details (null if successful)
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
- # Metadata about the request and response
20
+ # Request and response metadata
21
21
  #
22
22
  # @return [Sentdm::Models::APIMeta, nil]
23
23
  optional :meta, -> { Sentdm::APIMeta }
@@ -33,9 +33,9 @@ module Sentdm
33
33
  #
34
34
  # @param data [Sentdm::Models::WebhookRotateSecretResponse::Data, nil] The response data (null if error)
35
35
  #
36
- # @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
36
+ # @param error [Sentdm::Models::APIError, nil] Error information
37
37
  #
38
- # @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
38
+ # @param meta [Sentdm::Models::APIMeta] Request and response metadata
39
39
  #
40
40
  # @param success [Boolean] Indicates whether the request was successful
41
41
 
@@ -11,13 +11,13 @@ module Sentdm
11
11
  optional :data, -> { Sentdm::Models::WebhookTestResponse::Data }, nil?: true
12
12
 
13
13
  # @!attribute error
14
- # Error details (null if successful)
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
- # Metadata about the request and response
20
+ # Request and response metadata
21
21
  #
22
22
  # @return [Sentdm::Models::APIMeta, nil]
23
23
  optional :meta, -> { Sentdm::APIMeta }
@@ -33,9 +33,9 @@ module Sentdm
33
33
  #
34
34
  # @param data [Sentdm::Models::WebhookTestResponse::Data, nil] The response data (null if error)
35
35
  #
36
- # @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
36
+ # @param error [Sentdm::Models::APIError, nil] Error information
37
37
  #
38
- # @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
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
 
data/lib/sentdm/models.rb CHANGED
@@ -53,8 +53,6 @@ module Sentdm
53
53
 
54
54
  APIResponseWebhook = Sentdm::Models::APIResponseWebhook
55
55
 
56
- BaseDto = Sentdm::Models::BaseDto
57
-
58
56
  BillingContactInfo = Sentdm::Models::BillingContactInfo
59
57
 
60
58
  BrandsBrandData = Sentdm::Models::BrandsBrandData
@@ -81,7 +79,7 @@ module Sentdm
81
79
 
82
80
  MessageSendParams = Sentdm::Models::MessageSendParams
83
81
 
84
- MutationRequestBase = Sentdm::Models::MutationRequestBase
82
+ MutationRequest = Sentdm::Models::MutationRequest
85
83
 
86
84
  NumberLookupParams = Sentdm::Models::NumberLookupParams
87
85
 
@@ -89,7 +87,7 @@ module Sentdm
89
87
 
90
88
  PaymentDetails = Sentdm::Models::PaymentDetails
91
89
 
92
- ProfileCompleteSetupParams = Sentdm::Models::ProfileCompleteSetupParams
90
+ ProfileCompleteParams = Sentdm::Models::ProfileCompleteParams
93
91
 
94
92
  ProfileCreateParams = Sentdm::Models::ProfileCreateParams
95
93
 
@@ -75,7 +75,7 @@ module Sentdm
75
75
  #
76
76
  # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
77
77
  #
78
- # @param template [Sentdm::Models::MessageSendParams::Template] Body param: Template reference (by id or name, with optional parameters)
78
+ # @param template [Sentdm::Models::MessageSendParams::Template] Body param: SDK-style template reference: resolve by ID or by name, with optiona
79
79
  #
80
80
  # @param to [Array<String>] Body param: List of recipient phone numbers in E.164 format (multi-recipient fan
81
81
  #
@@ -15,7 +15,7 @@ module Sentdm
15
15
  #
16
16
  # @param profile_id [String] Path param: Profile ID from route
17
17
  #
18
- # @param campaign [Sentdm::Models::Profiles::CampaignData] Body param: Campaign data
18
+ # @param campaign [Sentdm::Models::Profiles::CampaignData] Body param: Campaign data for create or update operation
19
19
  #
20
20
  # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
21
21
  #
@@ -53,7 +53,7 @@ module Sentdm
53
53
  #
54
54
  # @param profile_id [String] Path param: Profile ID from route
55
55
  #
56
- # @param campaign [Sentdm::Models::Profiles::CampaignData] Body param: Campaign data
56
+ # @param campaign [Sentdm::Models::Profiles::CampaignData] Body param: Campaign data for create or update operation
57
57
  #
58
58
  # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
59
59
  #
@@ -54,11 +54,11 @@ module Sentdm
54
54
  #
55
55
  # @param allow_template_sharing [Boolean] Body param: Whether templates are shared across profiles (default: false)
56
56
  #
57
- # @param billing_contact [Sentdm::Models::BillingContactInfo, nil] Body param: Billing contact for this profile. Required when billing_model is "pr
57
+ # @param billing_contact [Sentdm::Models::BillingContactInfo, nil] Body param: Billing contact information for a profile.
58
58
  #
59
59
  # @param billing_model [String, nil] Body param: Billing model: profile, organization, or profile_and_organization (d
60
60
  #
61
- # @param brand [Sentdm::Models::BrandsBrandData, nil] Body param: Brand and KYC information for this profile (optional).
61
+ # @param brand [Sentdm::Models::BrandsBrandData, nil] Body param: Brand and KYC data grouped into contact, business, and compliance se
62
62
  #
63
63
  # @param description [String, nil] Body param: Profile description (optional)
64
64
  #
@@ -74,13 +74,13 @@ module Sentdm
74
74
  #
75
75
  # @param name [String] Body param: Profile name (required)
76
76
  #
77
- # @param payment_details [Sentdm::Models::PaymentDetails, nil] Body param: Payment card details for this profile (optional).
77
+ # @param payment_details [Sentdm::Models::PaymentDetails, nil] Body param: Payment card details for a profile.
78
78
  #
79
79
  # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
80
80
  #
81
81
  # @param short_name [String, nil] Body param: Profile short name/abbreviation (optional). Must be 3–11 characters,
82
82
  #
83
- # @param whatsapp_business_account [Sentdm::Models::ProfileCreateParams::WhatsappBusinessAccount, nil] Body param: Direct WhatsApp Business Account credentials for this profile.
83
+ # @param whatsapp_business_account [Sentdm::Models::ProfileCreateParams::WhatsappBusinessAccount, nil] Body param: Direct WhatsApp Business Account credentials for a profile.
84
84
  #
85
85
  # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
86
86
  #
@@ -165,11 +165,11 @@ module Sentdm
165
165
  #
166
166
  # @param allow_template_sharing [Boolean, nil] Body param: Whether templates are shared across profiles (optional)
167
167
  #
168
- # @param billing_contact [Sentdm::Models::BillingContactInfo, nil] Body param: Billing contact for this profile. Required when billing_model is "pr
168
+ # @param billing_contact [Sentdm::Models::BillingContactInfo, nil] Body param: Billing contact information for a profile.
169
169
  #
170
170
  # @param billing_model [String, nil] Body param: Billing model: profile, organization, or profile_and_organization (o
171
171
  #
172
- # @param brand [Sentdm::Models::BrandsBrandData, nil] Body param: Brand and KYC information for this profile (optional).
172
+ # @param brand [Sentdm::Models::BrandsBrandData, nil] Body param: Brand and KYC data grouped into contact, business, and compliance se
173
173
  #
174
174
  # @param description [String, nil] Body param: Profile description (optional)
175
175
  #
@@ -185,7 +185,7 @@ module Sentdm
185
185
  #
186
186
  # @param name [String, nil] Body param: Profile name (optional)
187
187
  #
188
- # @param payment_details [Sentdm::Models::PaymentDetails, nil] Body param: Payment card details for this profile (optional).
188
+ # @param payment_details [Sentdm::Models::PaymentDetails, nil] Body param: Payment card details for a profile.
189
189
  #
190
190
  # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
191
191
  #
@@ -281,7 +281,7 @@ module Sentdm
281
281
  end
282
282
 
283
283
  # Some parameter documentations has been truncated, see
284
- # {Sentdm::Models::ProfileCompleteSetupParams} for more details.
284
+ # {Sentdm::Models::ProfileCompleteParams} for more details.
285
285
  #
286
286
  # Final step in profile compliance workflow. Validates all prerequisites (general
287
287
  # data, brand, campaigns), connects profile to Telnyx/WhatsApp, and sets status
@@ -302,7 +302,7 @@ module Sentdm
302
302
  # - If non-TCR with destination country (IsMain=true) → SUBMITTED
303
303
  # - Otherwise → COMPLETED
304
304
  #
305
- # @overload complete_setup(profile_id, web_hook_url:, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
305
+ # @overload complete(profile_id, web_hook_url:, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
306
306
  #
307
307
  # @param profile_id [String] Path param: Profile ID from route
308
308
  #
@@ -318,9 +318,9 @@ module Sentdm
318
318
  #
319
319
  # @return [Object]
320
320
  #
321
- # @see Sentdm::Models::ProfileCompleteSetupParams
322
- def complete_setup(profile_id, params)
323
- parsed, options = Sentdm::ProfileCompleteSetupParams.dump_request(params)
321
+ # @see Sentdm::Models::ProfileCompleteParams
322
+ def complete(profile_id, params)
323
+ parsed, options = Sentdm::ProfileCompleteParams.dump_request(params)
324
324
  header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
325
325
  @client.request(
326
326
  method: :post,
@@ -17,7 +17,7 @@ module Sentdm
17
17
  #
18
18
  # @param creation_source [String, nil] Body param: Source of template creation (default: from-api)
19
19
  #
20
- # @param definition [Sentdm::Models::TemplateDefinition] Body param: Template definition including header, body, footer, and buttons
20
+ # @param definition [Sentdm::Models::TemplateDefinition] Body param: Complete definition of a message template including header, body, fo
21
21
  #
22
22
  # @param language [String, nil] Body param: Template language code (e.g., en_US) (optional, auto-detected if not
23
23
  #
@@ -87,7 +87,7 @@ module Sentdm
87
87
  #
88
88
  # @param category [String, nil] Body param: Template category: MARKETING, UTILITY, AUTHENTICATION
89
89
  #
90
- # @param definition [Sentdm::Models::TemplateDefinition, nil] Body param: Template definition including header, body, footer, and buttons
90
+ # @param definition [Sentdm::Models::TemplateDefinition, nil] Body param: Complete definition of a message template including header, body, fo
91
91
  #
92
92
  # @param language [String, nil] Body param: Template language code (e.g., en_US)
93
93
  #
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Sentdm
4
- VERSION = "0.7.0"
4
+ VERSION = "0.8.0"
5
5
  end