sentdm 0.19.0 → 0.20.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 +8 -0
- data/README.md +31 -1
- data/lib/sentdm/internal/type/base_model.rb +5 -5
- data/lib/sentdm/internal/type/enum.rb +25 -0
- data/lib/sentdm/models/api_meta.rb +34 -0
- data/lib/sentdm/models/api_response_of_contact.rb +46 -0
- data/lib/sentdm/models/api_response_of_profile_detail.rb +43 -0
- data/lib/sentdm/models/api_response_of_user.rb +43 -0
- data/lib/sentdm/models/api_response_template.rb +43 -0
- data/lib/sentdm/models/api_response_webhook.rb +43 -0
- data/lib/sentdm/models/billing_contact_info.rb +47 -0
- data/lib/sentdm/models/brands_brand_data.rb +38 -0
- data/lib/sentdm/models/contact_delete_params.rb +2 -16
- data/lib/sentdm/models/contact_list_response.rb +12 -278
- data/lib/sentdm/models/contact_response.rb +126 -0
- data/lib/sentdm/models/destination_country.rb +21 -0
- data/lib/sentdm/models/error_detail.rb +42 -0
- data/lib/sentdm/models/me_retrieve_response.rb +12 -204
- data/lib/sentdm/models/message_retrieve_activities_response.rb +6 -74
- data/lib/sentdm/models/message_retrieve_status_response.rb +6 -74
- data/lib/sentdm/models/message_send_response.rb +6 -74
- data/lib/sentdm/models/mutation_request.rb +20 -0
- data/lib/sentdm/models/number_lookup_response.rb +6 -74
- data/lib/sentdm/models/pagination_meta.rb +80 -0
- data/lib/sentdm/models/payment_details.rb +44 -0
- data/lib/sentdm/models/profile_complete_response.rb +6 -74
- data/lib/sentdm/models/profile_create_params.rb +9 -423
- data/lib/sentdm/models/profile_delete_params.rb +2 -16
- data/lib/sentdm/models/profile_detail.rb +605 -0
- data/lib/sentdm/models/profile_list_response.rb +9 -753
- data/lib/sentdm/models/profile_settings.rb +66 -0
- data/lib/sentdm/models/profile_update_params.rb +9 -423
- data/lib/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rb +45 -0
- data/lib/sentdm/models/profiles/base_dto.rb +32 -0
- data/lib/sentdm/models/profiles/campaign_create_params.rb +3 -165
- data/lib/sentdm/models/profiles/campaign_data.rb +123 -0
- data/lib/sentdm/models/profiles/campaign_delete_params.rb +2 -17
- data/lib/sentdm/models/profiles/campaign_list_response.rb +9 -420
- data/lib/sentdm/models/profiles/campaign_update_params.rb +3 -165
- data/lib/sentdm/models/profiles/messaging_use_case_us.rb +28 -0
- data/lib/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rb +29 -0
- data/lib/sentdm/models/profiles/tcr_campaign_with_use_cases.rb +248 -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 +48 -0
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rb +38 -0
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rb +81 -0
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rb +34 -0
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rb +39 -0
- data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rb +116 -0
- data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rb +75 -0
- data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info.rb +58 -0
- data/lib/sentdm/models/tcr_brand_relationship.rb +18 -0
- data/lib/sentdm/models/tcr_vertical.rb +36 -0
- data/lib/sentdm/models/template.rb +90 -0
- data/lib/sentdm/models/template_body_content.rb +27 -0
- data/lib/sentdm/models/template_create_params.rb +3 -889
- data/lib/sentdm/models/template_definition.rb +66 -0
- data/lib/sentdm/models/template_list_response.rb +12 -242
- data/lib/sentdm/models/template_update_params.rb +3 -889
- data/lib/sentdm/models/template_variable.rb +80 -0
- data/lib/sentdm/models/user_list_response.rb +9 -154
- data/lib/sentdm/models/user_remove_params.rb +2 -16
- data/lib/sentdm/models/user_response.rb +82 -0
- data/lib/sentdm/models/webhook_event_type.rb +45 -0
- data/lib/sentdm/models/webhook_list_event_types_response.rb +9 -118
- data/lib/sentdm/models/webhook_list_events_response.rb +9 -153
- data/lib/sentdm/models/webhook_list_response.rb +12 -247
- data/lib/sentdm/models/webhook_response.rb +95 -0
- data/lib/sentdm/models/webhook_rotate_secret_params.rb +2 -17
- data/lib/sentdm/models/webhook_rotate_secret_response.rb +6 -74
- data/lib/sentdm/models/webhook_test_response.rb +6 -74
- data/lib/sentdm/models.rb +77 -0
- data/lib/sentdm/resources/contacts.rb +6 -6
- data/lib/sentdm/resources/profiles/campaigns.rb +6 -6
- data/lib/sentdm/resources/profiles.rb +12 -12
- data/lib/sentdm/resources/templates.rb +8 -8
- data/lib/sentdm/resources/users.rb +6 -6
- data/lib/sentdm/resources/webhooks.rb +8 -8
- data/lib/sentdm/version.rb +1 -1
- data/lib/sentdm.rb +40 -18
- data/rbi/sentdm/models/api_meta.rbi +55 -0
- data/rbi/sentdm/models/api_response_of_contact.rbi +74 -0
- data/rbi/sentdm/models/api_response_of_profile_detail.rbi +74 -0
- data/rbi/sentdm/models/api_response_of_user.rbi +74 -0
- data/rbi/sentdm/models/api_response_template.rbi +74 -0
- data/rbi/sentdm/models/api_response_webhook.rbi +74 -0
- data/rbi/sentdm/models/billing_contact_info.rbi +65 -0
- data/rbi/sentdm/models/brands_brand_data.rbi +104 -0
- data/rbi/sentdm/models/contact_delete_params.rbi +2 -19
- data/rbi/sentdm/models/contact_list_response.rbi +16 -505
- data/rbi/sentdm/models/contact_response.rbi +183 -0
- data/rbi/sentdm/models/destination_country.rbi +32 -0
- data/rbi/sentdm/models/error_detail.rbi +66 -0
- data/rbi/sentdm/models/me_retrieve_response.rbi +16 -335
- data/rbi/sentdm/models/message_retrieve_activities_response.rbi +8 -154
- data/rbi/sentdm/models/message_retrieve_status_response.rbi +8 -148
- data/rbi/sentdm/models/message_send_response.rbi +8 -135
- data/rbi/sentdm/models/mutation_request.rbi +32 -0
- data/rbi/sentdm/models/number_lookup_response.rbi +8 -135
- data/rbi/sentdm/models/pagination_meta.rbi +135 -0
- data/rbi/sentdm/models/payment_details.rbi +59 -0
- data/rbi/sentdm/models/profile_complete_response.rbi +8 -137
- data/rbi/sentdm/models/profile_create_params.rbi +12 -810
- data/rbi/sentdm/models/profile_delete_params.rbi +2 -19
- data/rbi/sentdm/models/profile_detail.rbi +874 -0
- data/rbi/sentdm/models/profile_list_response.rbi +14 -1400
- data/rbi/sentdm/models/profile_settings.rbi +86 -0
- data/rbi/sentdm/models/profile_update_params.rbi +12 -810
- data/rbi/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rbi +83 -0
- data/rbi/sentdm/models/profiles/base_dto.rbi +53 -0
- data/rbi/sentdm/models/profiles/campaign_create_params.rbi +4 -289
- data/rbi/sentdm/models/profiles/campaign_data.rbi +148 -0
- data/rbi/sentdm/models/profiles/campaign_delete_params.rbi +1 -14
- data/rbi/sentdm/models/profiles/campaign_list_response.rbi +11 -733
- data/rbi/sentdm/models/profiles/campaign_update_params.rbi +4 -289
- data/rbi/sentdm/models/profiles/messaging_use_case_us.rbi +73 -0
- data/rbi/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbi +51 -0
- data/rbi/sentdm/models/profiles/tcr_campaign_with_use_cases.rbi +425 -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 +87 -0
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rbi +72 -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 +57 -0
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rbi +59 -0
- data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rbi +180 -0
- data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rbi +95 -0
- data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info.rbi +81 -0
- data/rbi/sentdm/models/tcr_brand_relationship.rbi +30 -0
- data/rbi/sentdm/models/tcr_vertical.rbi +41 -0
- data/rbi/sentdm/models/template.rbi +129 -0
- data/rbi/sentdm/models/template_body_content.rbi +43 -0
- data/rbi/sentdm/models/template_create_params.rbi +4 -1701
- data/rbi/sentdm/models/template_definition.rbi +164 -0
- data/rbi/sentdm/models/template_list_response.rbi +16 -454
- data/rbi/sentdm/models/template_update_params.rbi +4 -1701
- data/rbi/sentdm/models/template_variable.rbi +120 -0
- data/rbi/sentdm/models/user_list_response.rbi +14 -271
- data/rbi/sentdm/models/user_remove_params.rbi +2 -19
- data/rbi/sentdm/models/user_response.rbi +118 -0
- data/rbi/sentdm/models/webhook_event_type.rbi +74 -0
- data/rbi/sentdm/models/webhook_list_event_types_response.rbi +12 -247
- data/rbi/sentdm/models/webhook_list_events_response.rbi +12 -314
- data/rbi/sentdm/models/webhook_list_response.rbi +16 -462
- data/rbi/sentdm/models/webhook_response.rbi +140 -0
- data/rbi/sentdm/models/webhook_rotate_secret_params.rbi +1 -14
- data/rbi/sentdm/models/webhook_rotate_secret_response.rbi +8 -148
- data/rbi/sentdm/models/webhook_test_response.rbi +8 -135
- data/rbi/sentdm/models.rbi +77 -0
- data/rbi/sentdm/resources/contacts.rbi +3 -3
- data/rbi/sentdm/resources/profiles/campaigns.rbi +4 -4
- data/rbi/sentdm/resources/profiles.rbi +9 -13
- data/rbi/sentdm/resources/templates.rbi +5 -6
- data/rbi/sentdm/resources/users.rbi +3 -3
- data/rbi/sentdm/resources/webhooks.rbi +4 -4
- data/sig/sentdm/models/api_meta.rbs +27 -0
- data/sig/sentdm/models/api_response_of_contact.rbs +39 -0
- data/sig/sentdm/models/api_response_of_profile_detail.rbs +39 -0
- data/sig/sentdm/models/api_response_of_user.rbs +39 -0
- data/sig/sentdm/models/api_response_template.rbs +39 -0
- data/sig/sentdm/models/api_response_webhook.rbs +39 -0
- data/sig/sentdm/models/billing_contact_info.rbs +30 -0
- data/sig/sentdm/models/brands_brand_data.rbs +30 -0
- data/sig/sentdm/models/contact_delete_params.rbs +6 -10
- data/sig/sentdm/models/contact_list_response.rbs +20 -256
- data/sig/sentdm/models/contact_response.rbs +111 -0
- data/sig/sentdm/models/destination_country.rbs +19 -0
- data/sig/sentdm/models/error_detail.rbs +39 -0
- data/sig/sentdm/models/me_retrieve_response.rbs +18 -176
- data/sig/sentdm/models/message_retrieve_activities_response.rbs +9 -71
- data/sig/sentdm/models/message_retrieve_status_response.rbs +9 -71
- data/sig/sentdm/models/message_send_response.rbs +9 -71
- data/sig/sentdm/models/mutation_request.rbs +15 -0
- data/sig/sentdm/models/number_lookup_response.rbs +9 -71
- data/sig/sentdm/models/pagination_meta.rbs +67 -0
- data/sig/sentdm/models/payment_details.rbs +30 -0
- data/sig/sentdm/models/profile_complete_response.rbs +9 -71
- data/sig/sentdm/models/profile_create_params.rbs +12 -363
- data/sig/sentdm/models/profile_delete_params.rbs +6 -10
- data/sig/sentdm/models/profile_detail.rbs +474 -0
- data/sig/sentdm/models/profile_list_response.rbs +15 -645
- data/sig/sentdm/models/profile_settings.rbs +50 -0
- data/sig/sentdm/models/profile_update_params.rbs +12 -363
- data/sig/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rbs +41 -0
- data/sig/sentdm/models/profiles/base_dto.rbs +27 -0
- data/sig/sentdm/models/profiles/campaign_create_params.rbs +4 -138
- data/sig/sentdm/models/profiles/campaign_data.rbs +82 -0
- data/sig/sentdm/models/profiles/campaign_delete_params.rbs +8 -15
- data/sig/sentdm/models/profiles/campaign_list_response.rbs +13 -396
- data/sig/sentdm/models/profiles/campaign_update_params.rbs +4 -138
- data/sig/sentdm/models/profiles/messaging_use_case_us.rbs +40 -0
- data/sig/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbs +27 -0
- data/sig/sentdm/models/profiles/tcr_campaign_with_use_cases.rbs +299 -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 +35 -0
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rbs +32 -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 +30 -0
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rbs +30 -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/tcr_brand_relationship.rbs +22 -0
- data/sig/sentdm/models/tcr_vertical.rbs +58 -0
- data/sig/sentdm/models/template.rbs +79 -0
- data/sig/sentdm/models/template_body_content.rbs +30 -0
- data/sig/sentdm/models/template_create_params.rbs +6 -853
- data/sig/sentdm/models/template_definition.rbs +45 -0
- data/sig/sentdm/models/template_list_response.rbs +19 -225
- data/sig/sentdm/models/template_update_params.rbs +4 -851
- data/sig/sentdm/models/template_variable.rbs +84 -0
- data/sig/sentdm/models/user_list_response.rbs +15 -151
- data/sig/sentdm/models/user_remove_params.rbs +6 -10
- data/sig/sentdm/models/user_response.rbs +72 -0
- data/sig/sentdm/models/webhook_event_type.rbs +51 -0
- data/sig/sentdm/models/webhook_list_event_types_response.rbs +15 -130
- data/sig/sentdm/models/webhook_list_events_response.rbs +14 -142
- data/sig/sentdm/models/webhook_list_response.rbs +20 -248
- data/sig/sentdm/models/webhook_response.rbs +103 -0
- data/sig/sentdm/models/webhook_rotate_secret_params.rbs +8 -17
- data/sig/sentdm/models/webhook_rotate_secret_response.rbs +9 -71
- data/sig/sentdm/models/webhook_test_response.rbs +9 -71
- data/sig/sentdm/models.rbs +68 -0
- data/sig/sentdm/resources/contacts.rbs +3 -3
- data/sig/sentdm/resources/profiles/campaigns.rbs +4 -4
- data/sig/sentdm/resources/profiles.rbs +9 -9
- data/sig/sentdm/resources/templates.rbs +5 -5
- data/sig/sentdm/resources/users.rbs +3 -3
- data/sig/sentdm/resources/webhooks.rbs +4 -4
- metadata +121 -55
- data/lib/sentdm/models/contact_create_response.rb +0 -236
- data/lib/sentdm/models/contact_retrieve_response.rb +0 -236
- data/lib/sentdm/models/contact_update_response.rb +0 -236
- data/lib/sentdm/models/profile_create_response.rb +0 -781
- data/lib/sentdm/models/profile_retrieve_response.rb +0 -783
- data/lib/sentdm/models/profile_update_response.rb +0 -781
- data/lib/sentdm/models/profiles/campaign_create_response.rb +0 -459
- data/lib/sentdm/models/profiles/campaign_update_response.rb +0 -459
- data/lib/sentdm/models/template_create_response.rb +0 -197
- data/lib/sentdm/models/template_retrieve_response.rb +0 -197
- data/lib/sentdm/models/template_update_response.rb +0 -197
- data/lib/sentdm/models/user_invite_response.rb +0 -189
- data/lib/sentdm/models/user_retrieve_response.rb +0 -189
- data/lib/sentdm/models/user_update_role_response.rb +0 -189
- data/lib/sentdm/models/webhook_create_response.rb +0 -204
- data/lib/sentdm/models/webhook_retrieve_response.rb +0 -204
- data/lib/sentdm/models/webhook_toggle_status_response.rb +0 -204
- data/lib/sentdm/models/webhook_update_response.rb +0 -204
- data/rbi/sentdm/models/contact_create_response.rbi +0 -390
- data/rbi/sentdm/models/contact_retrieve_response.rbi +0 -392
- data/rbi/sentdm/models/contact_update_response.rbi +0 -390
- data/rbi/sentdm/models/profile_create_response.rbi +0 -1439
- data/rbi/sentdm/models/profile_retrieve_response.rbi +0 -1443
- data/rbi/sentdm/models/profile_update_response.rbi +0 -1439
- data/rbi/sentdm/models/profiles/campaign_create_response.rbi +0 -814
- data/rbi/sentdm/models/profiles/campaign_update_response.rbi +0 -814
- data/rbi/sentdm/models/template_create_response.rbi +0 -339
- data/rbi/sentdm/models/template_retrieve_response.rbi +0 -345
- data/rbi/sentdm/models/template_update_response.rbi +0 -339
- data/rbi/sentdm/models/user_invite_response.rbi +0 -323
- data/rbi/sentdm/models/user_retrieve_response.rbi +0 -323
- data/rbi/sentdm/models/user_update_role_response.rbi +0 -328
- data/rbi/sentdm/models/webhook_create_response.rbi +0 -348
- data/rbi/sentdm/models/webhook_retrieve_response.rbi +0 -350
- data/rbi/sentdm/models/webhook_toggle_status_response.rbi +0 -366
- data/rbi/sentdm/models/webhook_update_response.rbi +0 -348
- data/sig/sentdm/models/contact_create_response.rbs +0 -209
- data/sig/sentdm/models/contact_retrieve_response.rbs +0 -209
- data/sig/sentdm/models/contact_update_response.rbs +0 -209
- data/sig/sentdm/models/profile_create_response.rbs +0 -662
- data/sig/sentdm/models/profile_retrieve_response.rbs +0 -662
- data/sig/sentdm/models/profile_update_response.rbs +0 -662
- data/sig/sentdm/models/profiles/campaign_create_response.rbs +0 -424
- data/sig/sentdm/models/profiles/campaign_update_response.rbs +0 -424
- data/sig/sentdm/models/template_create_response.rbs +0 -177
- data/sig/sentdm/models/template_retrieve_response.rbs +0 -177
- data/sig/sentdm/models/template_update_response.rbs +0 -177
- data/sig/sentdm/models/user_invite_response.rbs +0 -170
- data/sig/sentdm/models/user_retrieve_response.rbs +0 -170
- data/sig/sentdm/models/user_update_role_response.rbs +0 -170
- data/sig/sentdm/models/webhook_create_response.rbs +0 -201
- data/sig/sentdm/models/webhook_retrieve_response.rbs +0 -201
- data/sig/sentdm/models/webhook_toggle_status_response.rbs +0 -201
- data/sig/sentdm/models/webhook_update_response.rbs +0 -201
|
@@ -1,781 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Sentdm
|
|
4
|
-
module Models
|
|
5
|
-
# @see Sentdm::Resources::Profiles#update
|
|
6
|
-
class ProfileUpdateResponse < Sentdm::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute data
|
|
8
|
-
# Detailed profile response for v3 API
|
|
9
|
-
#
|
|
10
|
-
# @return [Sentdm::Models::ProfileUpdateResponse::Data, nil]
|
|
11
|
-
optional :data, -> { Sentdm::Models::ProfileUpdateResponse::Data }, nil?: true
|
|
12
|
-
|
|
13
|
-
# @!attribute error
|
|
14
|
-
# Error information
|
|
15
|
-
#
|
|
16
|
-
# @return [Sentdm::Models::ProfileUpdateResponse::Error, nil]
|
|
17
|
-
optional :error, -> { Sentdm::Models::ProfileUpdateResponse::Error }, nil?: true
|
|
18
|
-
|
|
19
|
-
# @!attribute meta
|
|
20
|
-
# Request and response metadata
|
|
21
|
-
#
|
|
22
|
-
# @return [Sentdm::Models::ProfileUpdateResponse::Meta, nil]
|
|
23
|
-
optional :meta, -> { Sentdm::Models::ProfileUpdateResponse::Meta }
|
|
24
|
-
|
|
25
|
-
# @!attribute success
|
|
26
|
-
# Indicates whether the request was successful
|
|
27
|
-
#
|
|
28
|
-
# @return [Boolean, nil]
|
|
29
|
-
optional :success, Sentdm::Internal::Type::Boolean
|
|
30
|
-
|
|
31
|
-
# @!method initialize(data: nil, error: nil, meta: nil, success: nil)
|
|
32
|
-
# Standard API response envelope for all v3 endpoints
|
|
33
|
-
#
|
|
34
|
-
# @param data [Sentdm::Models::ProfileUpdateResponse::Data, nil] Detailed profile response for v3 API
|
|
35
|
-
#
|
|
36
|
-
# @param error [Sentdm::Models::ProfileUpdateResponse::Error, nil] Error information
|
|
37
|
-
#
|
|
38
|
-
# @param meta [Sentdm::Models::ProfileUpdateResponse::Meta] Request and response metadata
|
|
39
|
-
#
|
|
40
|
-
# @param success [Boolean] Indicates whether the request was successful
|
|
41
|
-
|
|
42
|
-
# @see Sentdm::Models::ProfileUpdateResponse#data
|
|
43
|
-
class Data < Sentdm::Internal::Type::BaseModel
|
|
44
|
-
# @!attribute id
|
|
45
|
-
# Profile unique identifier
|
|
46
|
-
#
|
|
47
|
-
# @return [String, nil]
|
|
48
|
-
optional :id, String
|
|
49
|
-
|
|
50
|
-
# @!attribute allow_contact_sharing
|
|
51
|
-
# Whether contacts are shared across profiles in the organization
|
|
52
|
-
#
|
|
53
|
-
# @return [Boolean, nil]
|
|
54
|
-
optional :allow_contact_sharing, Sentdm::Internal::Type::Boolean
|
|
55
|
-
|
|
56
|
-
# @!attribute allow_number_change_during_onboarding
|
|
57
|
-
# Whether number changes are allowed during onboarding
|
|
58
|
-
#
|
|
59
|
-
# @return [Boolean, nil]
|
|
60
|
-
optional :allow_number_change_during_onboarding, Sentdm::Internal::Type::Boolean, nil?: true
|
|
61
|
-
|
|
62
|
-
# @!attribute allow_template_sharing
|
|
63
|
-
# Whether templates are shared across profiles in the organization
|
|
64
|
-
#
|
|
65
|
-
# @return [Boolean, nil]
|
|
66
|
-
optional :allow_template_sharing, Sentdm::Internal::Type::Boolean
|
|
67
|
-
|
|
68
|
-
# @!attribute billing_contact
|
|
69
|
-
# Billing contact info returned in profile responses
|
|
70
|
-
#
|
|
71
|
-
# @return [Sentdm::Models::ProfileUpdateResponse::Data::BillingContact, nil]
|
|
72
|
-
optional :billing_contact, -> { Sentdm::Models::ProfileUpdateResponse::Data::BillingContact }, nil?: true
|
|
73
|
-
|
|
74
|
-
# @!attribute billing_model
|
|
75
|
-
# Billing model: profile, organization, or profile_and_organization
|
|
76
|
-
#
|
|
77
|
-
# @return [String, nil]
|
|
78
|
-
optional :billing_model, String
|
|
79
|
-
|
|
80
|
-
# @!attribute brand
|
|
81
|
-
# Brand response with nested contact, business, and compliance sections — mirrors
|
|
82
|
-
# the request structure.
|
|
83
|
-
#
|
|
84
|
-
# @return [Sentdm::Models::ProfileUpdateResponse::Data::Brand, nil]
|
|
85
|
-
optional :brand, -> { Sentdm::Models::ProfileUpdateResponse::Data::Brand }, nil?: true
|
|
86
|
-
|
|
87
|
-
# @!attribute created_at
|
|
88
|
-
# When the profile was created
|
|
89
|
-
#
|
|
90
|
-
# @return [Time, nil]
|
|
91
|
-
optional :created_at, Time
|
|
92
|
-
|
|
93
|
-
# @!attribute description
|
|
94
|
-
# Profile description
|
|
95
|
-
#
|
|
96
|
-
# @return [String, nil]
|
|
97
|
-
optional :description, String, nil?: true
|
|
98
|
-
|
|
99
|
-
# @!attribute email
|
|
100
|
-
# Profile email (inherited from organization)
|
|
101
|
-
#
|
|
102
|
-
# @return [String, nil]
|
|
103
|
-
optional :email, String, nil?: true
|
|
104
|
-
|
|
105
|
-
# @!attribute icon
|
|
106
|
-
# Profile icon URL
|
|
107
|
-
#
|
|
108
|
-
# @return [String, nil]
|
|
109
|
-
optional :icon, String, nil?: true
|
|
110
|
-
|
|
111
|
-
# @!attribute inherit_contacts
|
|
112
|
-
# Whether this profile inherits contacts from the organization
|
|
113
|
-
#
|
|
114
|
-
# @return [Boolean, nil]
|
|
115
|
-
optional :inherit_contacts, Sentdm::Internal::Type::Boolean
|
|
116
|
-
|
|
117
|
-
# @!attribute inherit_tcr_brand
|
|
118
|
-
# Whether this profile inherits TCR brand from the organization
|
|
119
|
-
#
|
|
120
|
-
# @return [Boolean, nil]
|
|
121
|
-
optional :inherit_tcr_brand, Sentdm::Internal::Type::Boolean
|
|
122
|
-
|
|
123
|
-
# @!attribute inherit_tcr_campaign
|
|
124
|
-
# Whether this profile inherits TCR campaign from the organization
|
|
125
|
-
#
|
|
126
|
-
# @return [Boolean, nil]
|
|
127
|
-
optional :inherit_tcr_campaign, Sentdm::Internal::Type::Boolean
|
|
128
|
-
|
|
129
|
-
# @!attribute inherit_templates
|
|
130
|
-
# Whether this profile inherits templates from the organization
|
|
131
|
-
#
|
|
132
|
-
# @return [Boolean, nil]
|
|
133
|
-
optional :inherit_templates, Sentdm::Internal::Type::Boolean
|
|
134
|
-
|
|
135
|
-
# @!attribute name
|
|
136
|
-
# Profile name
|
|
137
|
-
#
|
|
138
|
-
# @return [String, nil]
|
|
139
|
-
optional :name, String
|
|
140
|
-
|
|
141
|
-
# @!attribute organization_id
|
|
142
|
-
# Parent organization ID
|
|
143
|
-
#
|
|
144
|
-
# @return [String, nil]
|
|
145
|
-
optional :organization_id, String, nil?: true
|
|
146
|
-
|
|
147
|
-
# @!attribute sending_phone_number
|
|
148
|
-
# Direct SMS phone number
|
|
149
|
-
#
|
|
150
|
-
# @return [String, nil]
|
|
151
|
-
optional :sending_phone_number, String, nil?: true
|
|
152
|
-
|
|
153
|
-
# @!attribute sending_phone_number_profile_id
|
|
154
|
-
# Reference to another profile for SMS/Telnyx configuration
|
|
155
|
-
#
|
|
156
|
-
# @return [String, nil]
|
|
157
|
-
optional :sending_phone_number_profile_id, String, nil?: true
|
|
158
|
-
|
|
159
|
-
# @!attribute sending_whatsapp_number_profile_id
|
|
160
|
-
# Reference to another profile for WhatsApp configuration
|
|
161
|
-
#
|
|
162
|
-
# @return [String, nil]
|
|
163
|
-
optional :sending_whatsapp_number_profile_id, String, nil?: true
|
|
164
|
-
|
|
165
|
-
# @!attribute short_name
|
|
166
|
-
# Profile short name/abbreviation. 3–11 characters: letters, numbers, and spaces
|
|
167
|
-
# only, with at least one letter.
|
|
168
|
-
#
|
|
169
|
-
# @return [String, nil]
|
|
170
|
-
optional :short_name, String, nil?: true
|
|
171
|
-
|
|
172
|
-
# @!attribute status
|
|
173
|
-
# Profile setup status: incomplete, pending_review, approved, rejected
|
|
174
|
-
#
|
|
175
|
-
# @return [String, nil]
|
|
176
|
-
optional :status, String
|
|
177
|
-
|
|
178
|
-
# @!attribute updated_at
|
|
179
|
-
# When the profile was last updated
|
|
180
|
-
#
|
|
181
|
-
# @return [Time, nil]
|
|
182
|
-
optional :updated_at, Time, nil?: true
|
|
183
|
-
|
|
184
|
-
# @!attribute waba_id
|
|
185
|
-
# WhatsApp Business Account ID associated with this profile. Present whether the
|
|
186
|
-
# WABA is inherited from the organization or configured directly.
|
|
187
|
-
#
|
|
188
|
-
# @return [String, nil]
|
|
189
|
-
optional :waba_id, String, nil?: true
|
|
190
|
-
|
|
191
|
-
# @!attribute whatsapp_phone_number
|
|
192
|
-
# Direct WhatsApp phone number
|
|
193
|
-
#
|
|
194
|
-
# @return [String, nil]
|
|
195
|
-
optional :whatsapp_phone_number, String, nil?: true
|
|
196
|
-
|
|
197
|
-
# @!method initialize(id: nil, allow_contact_sharing: nil, allow_number_change_during_onboarding: nil, allow_template_sharing: nil, billing_contact: nil, billing_model: nil, brand: nil, created_at: nil, description: nil, email: nil, icon: nil, inherit_contacts: nil, inherit_tcr_brand: nil, inherit_tcr_campaign: nil, inherit_templates: nil, name: nil, organization_id: nil, sending_phone_number: nil, sending_phone_number_profile_id: nil, sending_whatsapp_number_profile_id: nil, short_name: nil, status: nil, updated_at: nil, waba_id: nil, whatsapp_phone_number: nil)
|
|
198
|
-
# Some parameter documentations has been truncated, see
|
|
199
|
-
# {Sentdm::Models::ProfileUpdateResponse::Data} for more details.
|
|
200
|
-
#
|
|
201
|
-
# Detailed profile response for v3 API
|
|
202
|
-
#
|
|
203
|
-
# @param id [String] Profile unique identifier
|
|
204
|
-
#
|
|
205
|
-
# @param allow_contact_sharing [Boolean] Whether contacts are shared across profiles in the organization
|
|
206
|
-
#
|
|
207
|
-
# @param allow_number_change_during_onboarding [Boolean, nil] Whether number changes are allowed during onboarding
|
|
208
|
-
#
|
|
209
|
-
# @param allow_template_sharing [Boolean] Whether templates are shared across profiles in the organization
|
|
210
|
-
#
|
|
211
|
-
# @param billing_contact [Sentdm::Models::ProfileUpdateResponse::Data::BillingContact, nil] Billing contact info returned in profile responses
|
|
212
|
-
#
|
|
213
|
-
# @param billing_model [String] Billing model: profile, organization, or profile_and_organization
|
|
214
|
-
#
|
|
215
|
-
# @param brand [Sentdm::Models::ProfileUpdateResponse::Data::Brand, nil] Brand response with nested contact, business, and compliance sections — mirrors
|
|
216
|
-
#
|
|
217
|
-
# @param created_at [Time] When the profile was created
|
|
218
|
-
#
|
|
219
|
-
# @param description [String, nil] Profile description
|
|
220
|
-
#
|
|
221
|
-
# @param email [String, nil] Profile email (inherited from organization)
|
|
222
|
-
#
|
|
223
|
-
# @param icon [String, nil] Profile icon URL
|
|
224
|
-
#
|
|
225
|
-
# @param inherit_contacts [Boolean] Whether this profile inherits contacts from the organization
|
|
226
|
-
#
|
|
227
|
-
# @param inherit_tcr_brand [Boolean] Whether this profile inherits TCR brand from the organization
|
|
228
|
-
#
|
|
229
|
-
# @param inherit_tcr_campaign [Boolean] Whether this profile inherits TCR campaign from the organization
|
|
230
|
-
#
|
|
231
|
-
# @param inherit_templates [Boolean] Whether this profile inherits templates from the organization
|
|
232
|
-
#
|
|
233
|
-
# @param name [String] Profile name
|
|
234
|
-
#
|
|
235
|
-
# @param organization_id [String, nil] Parent organization ID
|
|
236
|
-
#
|
|
237
|
-
# @param sending_phone_number [String, nil] Direct SMS phone number
|
|
238
|
-
#
|
|
239
|
-
# @param sending_phone_number_profile_id [String, nil] Reference to another profile for SMS/Telnyx configuration
|
|
240
|
-
#
|
|
241
|
-
# @param sending_whatsapp_number_profile_id [String, nil] Reference to another profile for WhatsApp configuration
|
|
242
|
-
#
|
|
243
|
-
# @param short_name [String, nil] Profile short name/abbreviation. 3–11 characters: letters, numbers, and spaces o
|
|
244
|
-
#
|
|
245
|
-
# @param status [String] Profile setup status: incomplete, pending_review, approved, rejected
|
|
246
|
-
#
|
|
247
|
-
# @param updated_at [Time, nil] When the profile was last updated
|
|
248
|
-
#
|
|
249
|
-
# @param waba_id [String, nil] WhatsApp Business Account ID associated with this profile.
|
|
250
|
-
#
|
|
251
|
-
# @param whatsapp_phone_number [String, nil] Direct WhatsApp phone number
|
|
252
|
-
|
|
253
|
-
# @see Sentdm::Models::ProfileUpdateResponse::Data#billing_contact
|
|
254
|
-
class BillingContact < Sentdm::Internal::Type::BaseModel
|
|
255
|
-
# @!attribute address
|
|
256
|
-
#
|
|
257
|
-
# @return [String, nil]
|
|
258
|
-
optional :address, String, nil?: true
|
|
259
|
-
|
|
260
|
-
# @!attribute email
|
|
261
|
-
#
|
|
262
|
-
# @return [String, nil]
|
|
263
|
-
optional :email, String, nil?: true
|
|
264
|
-
|
|
265
|
-
# @!attribute name
|
|
266
|
-
#
|
|
267
|
-
# @return [String, nil]
|
|
268
|
-
optional :name, String, nil?: true
|
|
269
|
-
|
|
270
|
-
# @!attribute phone
|
|
271
|
-
#
|
|
272
|
-
# @return [String, nil]
|
|
273
|
-
optional :phone, String, nil?: true
|
|
274
|
-
|
|
275
|
-
# @!method initialize(address: nil, email: nil, name: nil, phone: nil)
|
|
276
|
-
# Billing contact info returned in profile responses
|
|
277
|
-
#
|
|
278
|
-
# @param address [String, nil]
|
|
279
|
-
# @param email [String, nil]
|
|
280
|
-
# @param name [String, nil]
|
|
281
|
-
# @param phone [String, nil]
|
|
282
|
-
end
|
|
283
|
-
|
|
284
|
-
# @see Sentdm::Models::ProfileUpdateResponse::Data#brand
|
|
285
|
-
class Brand < Sentdm::Internal::Type::BaseModel
|
|
286
|
-
# @!attribute id
|
|
287
|
-
# Unique identifier for the brand
|
|
288
|
-
#
|
|
289
|
-
# @return [String, nil]
|
|
290
|
-
optional :id, String
|
|
291
|
-
|
|
292
|
-
# @!attribute business
|
|
293
|
-
# Business details and address information
|
|
294
|
-
#
|
|
295
|
-
# @return [Sentdm::Models::ProfileUpdateResponse::Data::Brand::Business, nil]
|
|
296
|
-
optional :business, -> { Sentdm::Models::ProfileUpdateResponse::Data::Brand::Business }, nil?: true
|
|
297
|
-
|
|
298
|
-
# @!attribute compliance
|
|
299
|
-
# Compliance and TCR-related information
|
|
300
|
-
#
|
|
301
|
-
# @return [Sentdm::Models::ProfileUpdateResponse::Data::Brand::Compliance, nil]
|
|
302
|
-
optional :compliance, -> { Sentdm::Models::ProfileUpdateResponse::Data::Brand::Compliance }, nil?: true
|
|
303
|
-
|
|
304
|
-
# @!attribute contact
|
|
305
|
-
# Contact information for the brand
|
|
306
|
-
#
|
|
307
|
-
# @return [Sentdm::Models::ProfileUpdateResponse::Data::Brand::Contact, nil]
|
|
308
|
-
optional :contact, -> { Sentdm::Models::ProfileUpdateResponse::Data::Brand::Contact }, nil?: true
|
|
309
|
-
|
|
310
|
-
# @!attribute created_at
|
|
311
|
-
# When the brand was created
|
|
312
|
-
#
|
|
313
|
-
# @return [Time, nil]
|
|
314
|
-
optional :created_at, Time
|
|
315
|
-
|
|
316
|
-
# @!attribute csp_id
|
|
317
|
-
# CSP (Campaign Service Provider) ID
|
|
318
|
-
#
|
|
319
|
-
# @return [String, nil]
|
|
320
|
-
optional :csp_id, String, nil?: true
|
|
321
|
-
|
|
322
|
-
# @!attribute identity_status
|
|
323
|
-
#
|
|
324
|
-
# @return [Symbol, Sentdm::Models::ProfileUpdateResponse::Data::Brand::IdentityStatus, nil]
|
|
325
|
-
optional :identity_status,
|
|
326
|
-
enum: -> { Sentdm::Models::ProfileUpdateResponse::Data::Brand::IdentityStatus },
|
|
327
|
-
nil?: true
|
|
328
|
-
|
|
329
|
-
# @!attribute is_inherited
|
|
330
|
-
# Whether this brand is inherited from the parent organization
|
|
331
|
-
#
|
|
332
|
-
# @return [Boolean, nil]
|
|
333
|
-
optional :is_inherited, Sentdm::Internal::Type::Boolean
|
|
334
|
-
|
|
335
|
-
# @!attribute status
|
|
336
|
-
#
|
|
337
|
-
# @return [Symbol, Sentdm::Models::ProfileUpdateResponse::Data::Brand::Status, nil]
|
|
338
|
-
optional :status, enum: -> { Sentdm::Models::ProfileUpdateResponse::Data::Brand::Status }, nil?: true
|
|
339
|
-
|
|
340
|
-
# @!attribute submitted_at
|
|
341
|
-
# When the brand was submitted to TCR
|
|
342
|
-
#
|
|
343
|
-
# @return [Time, nil]
|
|
344
|
-
optional :submitted_at, Time, nil?: true
|
|
345
|
-
|
|
346
|
-
# @!attribute submitted_to_tcr
|
|
347
|
-
# Whether this brand has been submitted to TCR
|
|
348
|
-
#
|
|
349
|
-
# @return [Boolean, nil]
|
|
350
|
-
optional :submitted_to_tcr, Sentdm::Internal::Type::Boolean
|
|
351
|
-
|
|
352
|
-
# @!attribute tcr_brand_id
|
|
353
|
-
# TCR brand ID (populated after TCR submission)
|
|
354
|
-
#
|
|
355
|
-
# @return [String, nil]
|
|
356
|
-
optional :tcr_brand_id, String, nil?: true
|
|
357
|
-
|
|
358
|
-
# @!attribute universal_ein
|
|
359
|
-
# Universal EIN from TCR
|
|
360
|
-
#
|
|
361
|
-
# @return [String, nil]
|
|
362
|
-
optional :universal_ein, String, nil?: true
|
|
363
|
-
|
|
364
|
-
# @!attribute updated_at
|
|
365
|
-
# When the brand was last updated
|
|
366
|
-
#
|
|
367
|
-
# @return [Time, nil]
|
|
368
|
-
optional :updated_at, Time, nil?: true
|
|
369
|
-
|
|
370
|
-
# @!method initialize(id: nil, business: nil, compliance: nil, contact: nil, created_at: nil, csp_id: nil, identity_status: nil, is_inherited: nil, status: nil, submitted_at: nil, submitted_to_tcr: nil, tcr_brand_id: nil, universal_ein: nil, updated_at: nil)
|
|
371
|
-
# Brand response with nested contact, business, and compliance sections — mirrors
|
|
372
|
-
# the request structure.
|
|
373
|
-
#
|
|
374
|
-
# @param id [String] Unique identifier for the brand
|
|
375
|
-
#
|
|
376
|
-
# @param business [Sentdm::Models::ProfileUpdateResponse::Data::Brand::Business, nil] Business details and address information
|
|
377
|
-
#
|
|
378
|
-
# @param compliance [Sentdm::Models::ProfileUpdateResponse::Data::Brand::Compliance, nil] Compliance and TCR-related information
|
|
379
|
-
#
|
|
380
|
-
# @param contact [Sentdm::Models::ProfileUpdateResponse::Data::Brand::Contact, nil] Contact information for the brand
|
|
381
|
-
#
|
|
382
|
-
# @param created_at [Time] When the brand was created
|
|
383
|
-
#
|
|
384
|
-
# @param csp_id [String, nil] CSP (Campaign Service Provider) ID
|
|
385
|
-
#
|
|
386
|
-
# @param identity_status [Symbol, Sentdm::Models::ProfileUpdateResponse::Data::Brand::IdentityStatus, nil]
|
|
387
|
-
#
|
|
388
|
-
# @param is_inherited [Boolean] Whether this brand is inherited from the parent organization
|
|
389
|
-
#
|
|
390
|
-
# @param status [Symbol, Sentdm::Models::ProfileUpdateResponse::Data::Brand::Status, nil]
|
|
391
|
-
#
|
|
392
|
-
# @param submitted_at [Time, nil] When the brand was submitted to TCR
|
|
393
|
-
#
|
|
394
|
-
# @param submitted_to_tcr [Boolean] Whether this brand has been submitted to TCR
|
|
395
|
-
#
|
|
396
|
-
# @param tcr_brand_id [String, nil] TCR brand ID (populated after TCR submission)
|
|
397
|
-
#
|
|
398
|
-
# @param universal_ein [String, nil] Universal EIN from TCR
|
|
399
|
-
#
|
|
400
|
-
# @param updated_at [Time, nil] When the brand was last updated
|
|
401
|
-
|
|
402
|
-
# @see Sentdm::Models::ProfileUpdateResponse::Data::Brand#business
|
|
403
|
-
class Business < Sentdm::Internal::Type::BaseModel
|
|
404
|
-
# @!attribute city
|
|
405
|
-
# City
|
|
406
|
-
#
|
|
407
|
-
# @return [String, nil]
|
|
408
|
-
optional :city, String, nil?: true
|
|
409
|
-
|
|
410
|
-
# @!attribute country
|
|
411
|
-
# Country code (e.g., US, CA)
|
|
412
|
-
#
|
|
413
|
-
# @return [String, nil]
|
|
414
|
-
optional :country, String, nil?: true
|
|
415
|
-
|
|
416
|
-
# @!attribute country_of_registration
|
|
417
|
-
# Country where the business is registered
|
|
418
|
-
#
|
|
419
|
-
# @return [String, nil]
|
|
420
|
-
optional :country_of_registration, String, nil?: true
|
|
421
|
-
|
|
422
|
-
# @!attribute entity_type
|
|
423
|
-
# Business entity type
|
|
424
|
-
#
|
|
425
|
-
# @return [String, nil]
|
|
426
|
-
optional :entity_type, String, nil?: true
|
|
427
|
-
|
|
428
|
-
# @!attribute legal_name
|
|
429
|
-
# Legal business name
|
|
430
|
-
#
|
|
431
|
-
# @return [String, nil]
|
|
432
|
-
optional :legal_name, String, nil?: true
|
|
433
|
-
|
|
434
|
-
# @!attribute postal_code
|
|
435
|
-
# Postal/ZIP code
|
|
436
|
-
#
|
|
437
|
-
# @return [String, nil]
|
|
438
|
-
optional :postal_code, String, nil?: true
|
|
439
|
-
|
|
440
|
-
# @!attribute state
|
|
441
|
-
# State/province code
|
|
442
|
-
#
|
|
443
|
-
# @return [String, nil]
|
|
444
|
-
optional :state, String, nil?: true
|
|
445
|
-
|
|
446
|
-
# @!attribute street
|
|
447
|
-
# Street address
|
|
448
|
-
#
|
|
449
|
-
# @return [String, nil]
|
|
450
|
-
optional :street, String, nil?: true
|
|
451
|
-
|
|
452
|
-
# @!attribute tax_id
|
|
453
|
-
# Tax ID/EIN number
|
|
454
|
-
#
|
|
455
|
-
# @return [String, nil]
|
|
456
|
-
optional :tax_id, String, nil?: true
|
|
457
|
-
|
|
458
|
-
# @!attribute tax_id_type
|
|
459
|
-
# Type of tax ID (e.g., us_ein, ca_bn)
|
|
460
|
-
#
|
|
461
|
-
# @return [String, nil]
|
|
462
|
-
optional :tax_id_type, String, nil?: true
|
|
463
|
-
|
|
464
|
-
# @!attribute url
|
|
465
|
-
# Business website URL
|
|
466
|
-
#
|
|
467
|
-
# @return [String, nil]
|
|
468
|
-
optional :url, String, nil?: true
|
|
469
|
-
|
|
470
|
-
# @!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)
|
|
471
|
-
# Business details and address information
|
|
472
|
-
#
|
|
473
|
-
# @param city [String, nil] City
|
|
474
|
-
#
|
|
475
|
-
# @param country [String, nil] Country code (e.g., US, CA)
|
|
476
|
-
#
|
|
477
|
-
# @param country_of_registration [String, nil] Country where the business is registered
|
|
478
|
-
#
|
|
479
|
-
# @param entity_type [String, nil] Business entity type
|
|
480
|
-
#
|
|
481
|
-
# @param legal_name [String, nil] Legal business name
|
|
482
|
-
#
|
|
483
|
-
# @param postal_code [String, nil] Postal/ZIP code
|
|
484
|
-
#
|
|
485
|
-
# @param state [String, nil] State/province code
|
|
486
|
-
#
|
|
487
|
-
# @param street [String, nil] Street address
|
|
488
|
-
#
|
|
489
|
-
# @param tax_id [String, nil] Tax ID/EIN number
|
|
490
|
-
#
|
|
491
|
-
# @param tax_id_type [String, nil] Type of tax ID (e.g., us_ein, ca_bn)
|
|
492
|
-
#
|
|
493
|
-
# @param url [String, nil] Business website URL
|
|
494
|
-
end
|
|
495
|
-
|
|
496
|
-
# @see Sentdm::Models::ProfileUpdateResponse::Data::Brand#compliance
|
|
497
|
-
class Compliance < Sentdm::Internal::Type::BaseModel
|
|
498
|
-
# @!attribute brand_relationship
|
|
499
|
-
#
|
|
500
|
-
# @return [Symbol, Sentdm::Models::ProfileUpdateResponse::Data::Brand::Compliance::BrandRelationship, nil]
|
|
501
|
-
optional :brand_relationship,
|
|
502
|
-
enum: -> { Sentdm::Models::ProfileUpdateResponse::Data::Brand::Compliance::BrandRelationship },
|
|
503
|
-
nil?: true
|
|
504
|
-
|
|
505
|
-
# @!attribute destination_countries
|
|
506
|
-
# List of destination countries for messaging
|
|
507
|
-
#
|
|
508
|
-
# @return [Array<Sentdm::Models::ProfileUpdateResponse::Data::Brand::Compliance::DestinationCountry>, nil]
|
|
509
|
-
optional :destination_countries,
|
|
510
|
-
-> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::ProfileUpdateResponse::Data::Brand::Compliance::DestinationCountry] }
|
|
511
|
-
|
|
512
|
-
# @!attribute expected_messaging_volume
|
|
513
|
-
# Expected daily messaging volume
|
|
514
|
-
#
|
|
515
|
-
# @return [String, nil]
|
|
516
|
-
optional :expected_messaging_volume, String, nil?: true
|
|
517
|
-
|
|
518
|
-
# @!attribute is_tcr_application
|
|
519
|
-
# Whether this is a TCR (Campaign Registry) application
|
|
520
|
-
#
|
|
521
|
-
# @return [Boolean, nil]
|
|
522
|
-
optional :is_tcr_application, Sentdm::Internal::Type::Boolean
|
|
523
|
-
|
|
524
|
-
# @!attribute notes
|
|
525
|
-
# Additional notes about the business or use case
|
|
526
|
-
#
|
|
527
|
-
# @return [String, nil]
|
|
528
|
-
optional :notes, String, nil?: true
|
|
529
|
-
|
|
530
|
-
# @!attribute phone_number_prefix
|
|
531
|
-
# Phone number prefix for messaging (e.g., "+1")
|
|
532
|
-
#
|
|
533
|
-
# @return [String, nil]
|
|
534
|
-
optional :phone_number_prefix, String, nil?: true
|
|
535
|
-
|
|
536
|
-
# @!attribute primary_use_case
|
|
537
|
-
# Primary messaging use case description
|
|
538
|
-
#
|
|
539
|
-
# @return [String, nil]
|
|
540
|
-
optional :primary_use_case, String, nil?: true
|
|
541
|
-
|
|
542
|
-
# @!attribute vertical
|
|
543
|
-
#
|
|
544
|
-
# @return [Symbol, Sentdm::Models::ProfileUpdateResponse::Data::Brand::Compliance::Vertical, nil]
|
|
545
|
-
optional :vertical,
|
|
546
|
-
enum: -> { Sentdm::Models::ProfileUpdateResponse::Data::Brand::Compliance::Vertical },
|
|
547
|
-
nil?: true
|
|
548
|
-
|
|
549
|
-
# @!method initialize(brand_relationship: nil, destination_countries: nil, expected_messaging_volume: nil, is_tcr_application: nil, notes: nil, phone_number_prefix: nil, primary_use_case: nil, vertical: nil)
|
|
550
|
-
# Compliance and TCR-related information
|
|
551
|
-
#
|
|
552
|
-
# @param brand_relationship [Symbol, Sentdm::Models::ProfileUpdateResponse::Data::Brand::Compliance::BrandRelationship, nil]
|
|
553
|
-
#
|
|
554
|
-
# @param destination_countries [Array<Sentdm::Models::ProfileUpdateResponse::Data::Brand::Compliance::DestinationCountry>] List of destination countries for messaging
|
|
555
|
-
#
|
|
556
|
-
# @param expected_messaging_volume [String, nil] Expected daily messaging volume
|
|
557
|
-
#
|
|
558
|
-
# @param is_tcr_application [Boolean] Whether this is a TCR (Campaign Registry) application
|
|
559
|
-
#
|
|
560
|
-
# @param notes [String, nil] Additional notes about the business or use case
|
|
561
|
-
#
|
|
562
|
-
# @param phone_number_prefix [String, nil] Phone number prefix for messaging (e.g., "+1")
|
|
563
|
-
#
|
|
564
|
-
# @param primary_use_case [String, nil] Primary messaging use case description
|
|
565
|
-
#
|
|
566
|
-
# @param vertical [Symbol, Sentdm::Models::ProfileUpdateResponse::Data::Brand::Compliance::Vertical, nil]
|
|
567
|
-
|
|
568
|
-
# @see Sentdm::Models::ProfileUpdateResponse::Data::Brand::Compliance#brand_relationship
|
|
569
|
-
module BrandRelationship
|
|
570
|
-
extend Sentdm::Internal::Type::Enum
|
|
571
|
-
|
|
572
|
-
BASIC_ACCOUNT = :BASIC_ACCOUNT
|
|
573
|
-
MEDIUM_ACCOUNT = :MEDIUM_ACCOUNT
|
|
574
|
-
LARGE_ACCOUNT = :LARGE_ACCOUNT
|
|
575
|
-
SMALL_ACCOUNT = :SMALL_ACCOUNT
|
|
576
|
-
KEY_ACCOUNT = :KEY_ACCOUNT
|
|
577
|
-
|
|
578
|
-
# @!method self.values
|
|
579
|
-
# @return [Array<Symbol>]
|
|
580
|
-
end
|
|
581
|
-
|
|
582
|
-
class DestinationCountry < Sentdm::Internal::Type::BaseModel
|
|
583
|
-
# @!attribute id
|
|
584
|
-
#
|
|
585
|
-
# @return [String, nil]
|
|
586
|
-
optional :id, String
|
|
587
|
-
|
|
588
|
-
# @!attribute is_main
|
|
589
|
-
#
|
|
590
|
-
# @return [Boolean, nil]
|
|
591
|
-
optional :is_main, Sentdm::Internal::Type::Boolean, api_name: :isMain
|
|
592
|
-
|
|
593
|
-
# @!method initialize(id: nil, is_main: nil)
|
|
594
|
-
# @param id [String]
|
|
595
|
-
# @param is_main [Boolean]
|
|
596
|
-
end
|
|
597
|
-
|
|
598
|
-
# @see Sentdm::Models::ProfileUpdateResponse::Data::Brand::Compliance#vertical
|
|
599
|
-
module Vertical
|
|
600
|
-
extend Sentdm::Internal::Type::Enum
|
|
601
|
-
|
|
602
|
-
PROFESSIONAL = :PROFESSIONAL
|
|
603
|
-
REAL_ESTATE = :REAL_ESTATE
|
|
604
|
-
HEALTHCARE = :HEALTHCARE
|
|
605
|
-
HUMAN_RESOURCES = :HUMAN_RESOURCES
|
|
606
|
-
ENERGY = :ENERGY
|
|
607
|
-
ENTERTAINMENT = :ENTERTAINMENT
|
|
608
|
-
RETAIL = :RETAIL
|
|
609
|
-
TRANSPORTATION = :TRANSPORTATION
|
|
610
|
-
AGRICULTURE = :AGRICULTURE
|
|
611
|
-
INSURANCE = :INSURANCE
|
|
612
|
-
POSTAL = :POSTAL
|
|
613
|
-
EDUCATION = :EDUCATION
|
|
614
|
-
HOSPITALITY = :HOSPITALITY
|
|
615
|
-
FINANCIAL = :FINANCIAL
|
|
616
|
-
POLITICAL = :POLITICAL
|
|
617
|
-
GAMBLING = :GAMBLING
|
|
618
|
-
LEGAL = :LEGAL
|
|
619
|
-
CONSTRUCTION = :CONSTRUCTION
|
|
620
|
-
NGO = :NGO
|
|
621
|
-
MANUFACTURING = :MANUFACTURING
|
|
622
|
-
GOVERNMENT = :GOVERNMENT
|
|
623
|
-
TECHNOLOGY = :TECHNOLOGY
|
|
624
|
-
COMMUNICATION = :COMMUNICATION
|
|
625
|
-
|
|
626
|
-
# @!method self.values
|
|
627
|
-
# @return [Array<Symbol>]
|
|
628
|
-
end
|
|
629
|
-
end
|
|
630
|
-
|
|
631
|
-
# @see Sentdm::Models::ProfileUpdateResponse::Data::Brand#contact
|
|
632
|
-
class Contact < Sentdm::Internal::Type::BaseModel
|
|
633
|
-
# @!attribute business_name
|
|
634
|
-
# Business/brand name
|
|
635
|
-
#
|
|
636
|
-
# @return [String, nil]
|
|
637
|
-
optional :business_name, String, nil?: true
|
|
638
|
-
|
|
639
|
-
# @!attribute email
|
|
640
|
-
# Contact email address
|
|
641
|
-
#
|
|
642
|
-
# @return [String, nil]
|
|
643
|
-
optional :email, String, nil?: true
|
|
644
|
-
|
|
645
|
-
# @!attribute name
|
|
646
|
-
# Primary contact name
|
|
647
|
-
#
|
|
648
|
-
# @return [String, nil]
|
|
649
|
-
optional :name, String
|
|
650
|
-
|
|
651
|
-
# @!attribute phone
|
|
652
|
-
# Contact phone number in E.164 format
|
|
653
|
-
#
|
|
654
|
-
# @return [String, nil]
|
|
655
|
-
optional :phone, String, nil?: true
|
|
656
|
-
|
|
657
|
-
# @!attribute phone_country_code
|
|
658
|
-
# Contact phone country code (e.g., "1" for US)
|
|
659
|
-
#
|
|
660
|
-
# @return [String, nil]
|
|
661
|
-
optional :phone_country_code, String, nil?: true
|
|
662
|
-
|
|
663
|
-
# @!attribute role
|
|
664
|
-
# Contact's role in the business
|
|
665
|
-
#
|
|
666
|
-
# @return [String, nil]
|
|
667
|
-
optional :role, String, nil?: true
|
|
668
|
-
|
|
669
|
-
# @!method initialize(business_name: nil, email: nil, name: nil, phone: nil, phone_country_code: nil, role: nil)
|
|
670
|
-
# Contact information for the brand
|
|
671
|
-
#
|
|
672
|
-
# @param business_name [String, nil] Business/brand name
|
|
673
|
-
#
|
|
674
|
-
# @param email [String, nil] Contact email address
|
|
675
|
-
#
|
|
676
|
-
# @param name [String] Primary contact name
|
|
677
|
-
#
|
|
678
|
-
# @param phone [String, nil] Contact phone number in E.164 format
|
|
679
|
-
#
|
|
680
|
-
# @param phone_country_code [String, nil] Contact phone country code (e.g., "1" for US)
|
|
681
|
-
#
|
|
682
|
-
# @param role [String, nil] Contact's role in the business
|
|
683
|
-
end
|
|
684
|
-
|
|
685
|
-
# @see Sentdm::Models::ProfileUpdateResponse::Data::Brand#identity_status
|
|
686
|
-
module IdentityStatus
|
|
687
|
-
extend Sentdm::Internal::Type::Enum
|
|
688
|
-
|
|
689
|
-
SELF_DECLARED = :SELF_DECLARED
|
|
690
|
-
UNVERIFIED = :UNVERIFIED
|
|
691
|
-
VERIFIED = :VERIFIED
|
|
692
|
-
VETTED_VERIFIED = :VETTED_VERIFIED
|
|
693
|
-
|
|
694
|
-
# @!method self.values
|
|
695
|
-
# @return [Array<Symbol>]
|
|
696
|
-
end
|
|
697
|
-
|
|
698
|
-
# @see Sentdm::Models::ProfileUpdateResponse::Data::Brand#status
|
|
699
|
-
module Status
|
|
700
|
-
extend Sentdm::Internal::Type::Enum
|
|
701
|
-
|
|
702
|
-
ACTIVE = :ACTIVE
|
|
703
|
-
INACTIVE = :INACTIVE
|
|
704
|
-
SUSPENDED = :SUSPENDED
|
|
705
|
-
|
|
706
|
-
# @!method self.values
|
|
707
|
-
# @return [Array<Symbol>]
|
|
708
|
-
end
|
|
709
|
-
end
|
|
710
|
-
end
|
|
711
|
-
|
|
712
|
-
# @see Sentdm::Models::ProfileUpdateResponse#error
|
|
713
|
-
class Error < Sentdm::Internal::Type::BaseModel
|
|
714
|
-
# @!attribute code
|
|
715
|
-
# Machine-readable error code (e.g., "RESOURCE_001")
|
|
716
|
-
#
|
|
717
|
-
# @return [String, nil]
|
|
718
|
-
optional :code, String
|
|
719
|
-
|
|
720
|
-
# @!attribute details
|
|
721
|
-
# Additional validation error details (field-level errors)
|
|
722
|
-
#
|
|
723
|
-
# @return [Hash{Symbol=>Array<String>}, nil]
|
|
724
|
-
optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
|
|
725
|
-
|
|
726
|
-
# @!attribute doc_url
|
|
727
|
-
# URL to documentation about this error
|
|
728
|
-
#
|
|
729
|
-
# @return [String, nil]
|
|
730
|
-
optional :doc_url, String, nil?: true
|
|
731
|
-
|
|
732
|
-
# @!attribute message
|
|
733
|
-
# Human-readable error message
|
|
734
|
-
#
|
|
735
|
-
# @return [String, nil]
|
|
736
|
-
optional :message, String
|
|
737
|
-
|
|
738
|
-
# @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
|
|
739
|
-
# Error information
|
|
740
|
-
#
|
|
741
|
-
# @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
|
|
742
|
-
#
|
|
743
|
-
# @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
|
|
744
|
-
#
|
|
745
|
-
# @param doc_url [String, nil] URL to documentation about this error
|
|
746
|
-
#
|
|
747
|
-
# @param message [String] Human-readable error message
|
|
748
|
-
end
|
|
749
|
-
|
|
750
|
-
# @see Sentdm::Models::ProfileUpdateResponse#meta
|
|
751
|
-
class Meta < Sentdm::Internal::Type::BaseModel
|
|
752
|
-
# @!attribute request_id
|
|
753
|
-
# Unique identifier for this request (for tracing and support)
|
|
754
|
-
#
|
|
755
|
-
# @return [String, nil]
|
|
756
|
-
optional :request_id, String
|
|
757
|
-
|
|
758
|
-
# @!attribute timestamp
|
|
759
|
-
# Server timestamp when the response was generated
|
|
760
|
-
#
|
|
761
|
-
# @return [Time, nil]
|
|
762
|
-
optional :timestamp, Time
|
|
763
|
-
|
|
764
|
-
# @!attribute version
|
|
765
|
-
# API version used for this request
|
|
766
|
-
#
|
|
767
|
-
# @return [String, nil]
|
|
768
|
-
optional :version, String
|
|
769
|
-
|
|
770
|
-
# @!method initialize(request_id: nil, timestamp: nil, version: nil)
|
|
771
|
-
# Request and response metadata
|
|
772
|
-
#
|
|
773
|
-
# @param request_id [String] Unique identifier for this request (for tracing and support)
|
|
774
|
-
#
|
|
775
|
-
# @param timestamp [Time] Server timestamp when the response was generated
|
|
776
|
-
#
|
|
777
|
-
# @param version [String] API version used for this request
|
|
778
|
-
end
|
|
779
|
-
end
|
|
780
|
-
end
|
|
781
|
-
end
|