sentdm 0.2.0 → 0.3.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 +10 -0
- data/README.md +96 -39
- data/lib/sentdm/client.rb +28 -36
- data/lib/sentdm/internal/type/base_model.rb +5 -5
- data/lib/sentdm/internal/type/enum.rb +25 -0
- data/lib/sentdm/models/api_error.rb +42 -0
- data/lib/sentdm/models/api_meta.rb +42 -0
- data/lib/sentdm/models/api_response_brand_with_kyc.rb +43 -0
- data/lib/sentdm/models/api_response_contact.rb +43 -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/brand_create_params.rb +41 -0
- data/lib/sentdm/models/brand_data.rb +237 -0
- data/lib/sentdm/models/brand_delete_params.rb +27 -0
- data/lib/sentdm/models/brand_list_params.rb +14 -0
- data/lib/sentdm/models/brand_list_response.rb +43 -0
- data/lib/sentdm/models/brand_update_params.rb +41 -0
- data/lib/sentdm/models/brand_with_kyc.rb +335 -0
- data/lib/sentdm/models/brands/api_response_tcr_campaign_with_use_cases.rb +45 -0
- data/lib/sentdm/models/brands/base_dto.rb +32 -0
- data/lib/sentdm/models/brands/campaign_create_params.rb +43 -0
- data/lib/sentdm/models/brands/campaign_data.rb +123 -0
- data/lib/sentdm/models/brands/campaign_delete_params.rb +36 -0
- data/lib/sentdm/models/brands/campaign_list_params.rb +16 -0
- data/lib/sentdm/models/brands/campaign_list_response.rb +47 -0
- data/lib/sentdm/models/brands/campaign_update_params.rb +50 -0
- data/lib/sentdm/models/brands/messaging_use_case_us.rb +28 -0
- data/lib/sentdm/models/brands/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rb +30 -0
- data/lib/sentdm/models/brands/tcr_campaign_with_use_cases.rb +236 -0
- data/lib/sentdm/models/contact.rb +122 -0
- data/lib/sentdm/models/contact_create_params.rb +41 -0
- data/lib/sentdm/models/contact_delete_params.rb +27 -0
- data/lib/sentdm/models/contact_list_params.rb +28 -5
- data/lib/sentdm/models/contact_list_response.rb +46 -21
- data/lib/sentdm/models/{message_retrieve_params.rb → contact_retrieve_params.rb} +2 -2
- data/lib/sentdm/models/contact_update_params.rb +49 -0
- data/lib/sentdm/models/destination_country.rb +21 -0
- data/lib/sentdm/models/lookup_retrieve_phone_info_params.rb +14 -0
- data/lib/sentdm/models/lookup_retrieve_phone_info_response.rb +104 -0
- data/lib/sentdm/models/me_retrieve_params.rb +14 -0
- data/lib/sentdm/models/me_retrieve_response.rb +200 -0
- data/lib/sentdm/models/message_retrieve_activities_params.rb +14 -0
- data/lib/sentdm/models/message_retrieve_activities_response.rb +103 -0
- data/lib/sentdm/models/message_retrieve_status_params.rb +14 -0
- data/lib/sentdm/models/message_retrieve_status_response.rb +237 -0
- data/lib/sentdm/models/message_send_params.rb +88 -0
- data/lib/sentdm/models/message_send_response.rb +123 -0
- data/lib/sentdm/models/mutation_request.rb +20 -0
- data/lib/sentdm/models/pagination_meta.rb +80 -0
- data/lib/sentdm/models/profile_complete_params.rb +41 -0
- data/lib/sentdm/models/profile_complete_response.rb +8 -0
- data/lib/sentdm/models/profile_create_params.rb +122 -0
- data/lib/sentdm/models/profile_delete_params.rb +34 -0
- data/lib/sentdm/models/profile_detail.rb +200 -0
- data/lib/sentdm/models/profile_list_params.rb +14 -0
- data/lib/sentdm/models/profile_list_response.rb +57 -0
- data/lib/sentdm/models/profile_retrieve_params.rb +14 -0
- data/lib/sentdm/models/profile_settings.rb +66 -0
- data/lib/sentdm/models/profile_update_params.rb +169 -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/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_create_params.rb +40 -19
- data/lib/sentdm/models/template_definition.rb +15 -255
- data/lib/sentdm/models/template_delete_params.rb +22 -1
- data/lib/sentdm/models/template_list_params.rb +9 -10
- data/lib/sentdm/models/template_list_response.rb +46 -21
- data/lib/sentdm/models/template_update_params.rb +73 -0
- data/lib/sentdm/models/user_invite_params.rb +57 -0
- data/lib/sentdm/models/user_list_params.rb +14 -0
- data/lib/sentdm/models/user_list_response.rb +57 -0
- data/lib/sentdm/models/user_remove_params.rb +34 -0
- data/lib/sentdm/models/user_response.rb +82 -0
- data/lib/sentdm/models/user_retrieve_params.rb +14 -0
- data/lib/sentdm/models/user_update_role_params.rb +49 -0
- data/lib/sentdm/models/webhook_create_params.rb +68 -0
- data/lib/sentdm/models/webhook_delete_params.rb +14 -0
- data/lib/sentdm/models/webhook_list_event_types_params.rb +14 -0
- data/lib/sentdm/models/webhook_list_event_types_response.rb +85 -0
- data/lib/sentdm/models/webhook_list_events_params.rb +32 -0
- data/lib/sentdm/models/webhook_list_events_response.rb +135 -0
- data/lib/sentdm/models/webhook_list_params.rb +38 -0
- data/lib/sentdm/models/webhook_list_response.rb +64 -0
- data/lib/sentdm/models/webhook_response.rb +87 -0
- data/lib/sentdm/models/webhook_retrieve_params.rb +14 -0
- data/lib/sentdm/models/webhook_rotate_secret_params.rb +30 -0
- data/lib/sentdm/models/webhook_rotate_secret_response.rb +56 -0
- data/lib/sentdm/models/webhook_test_params.rb +40 -0
- data/lib/sentdm/models/webhook_test_response.rb +62 -0
- data/lib/sentdm/models/webhook_toggle_status_params.rb +40 -0
- data/lib/sentdm/models/webhook_update_params.rb +68 -0
- data/lib/sentdm/models.rb +124 -10
- data/lib/sentdm/resources/brands/campaigns.rb +144 -0
- data/lib/sentdm/resources/brands.rb +128 -0
- data/lib/sentdm/resources/contacts.rb +111 -38
- data/lib/sentdm/resources/lookup.rb +35 -0
- data/lib/sentdm/resources/me.rb +34 -0
- data/lib/sentdm/resources/messages.rb +42 -77
- data/lib/sentdm/resources/profiles.rb +254 -0
- data/lib/sentdm/resources/templates.rb +94 -45
- data/lib/sentdm/resources/users.rb +158 -0
- data/lib/sentdm/resources/webhooks.rb +295 -0
- data/lib/sentdm/version.rb +1 -1
- data/lib/sentdm.rb +94 -12
- data/rbi/sentdm/client.rbi +20 -25
- data/rbi/sentdm/models/api_error.rbi +66 -0
- data/rbi/sentdm/models/api_meta.rbi +69 -0
- data/rbi/sentdm/models/api_response_brand_with_kyc.rbi +74 -0
- data/rbi/sentdm/models/api_response_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/brand_create_params.rbi +68 -0
- data/rbi/sentdm/models/brand_data.rbi +266 -0
- data/rbi/sentdm/models/brand_delete_params.rbi +62 -0
- data/rbi/sentdm/models/brand_list_params.rbi +27 -0
- data/rbi/sentdm/models/brand_list_response.rbi +71 -0
- data/rbi/sentdm/models/brand_update_params.rbi +68 -0
- data/rbi/sentdm/models/brand_with_kyc.rbi +398 -0
- data/rbi/sentdm/models/brands/api_response_tcr_campaign_with_use_cases.rbi +83 -0
- data/rbi/sentdm/models/brands/base_dto.rbi +53 -0
- data/rbi/sentdm/models/brands/campaign_create_params.rbi +73 -0
- data/rbi/sentdm/models/brands/campaign_data.rbi +148 -0
- data/rbi/sentdm/models/brands/campaign_delete_params.rbi +78 -0
- data/rbi/sentdm/models/brands/campaign_list_params.rbi +29 -0
- data/rbi/sentdm/models/brands/campaign_list_response.rbi +82 -0
- data/rbi/sentdm/models/brands/campaign_update_params.rbi +79 -0
- data/rbi/sentdm/models/brands/messaging_use_case_us.rbi +69 -0
- data/rbi/sentdm/models/brands/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbi +52 -0
- data/rbi/sentdm/models/brands/tcr_campaign_with_use_cases.rbi +404 -0
- data/rbi/sentdm/models/contact.rbi +179 -0
- data/rbi/sentdm/models/contact_create_params.rbi +68 -0
- data/rbi/sentdm/models/contact_delete_params.rbi +62 -0
- data/rbi/sentdm/models/contact_list_params.rbi +26 -4
- data/rbi/sentdm/models/contact_list_response.rbi +91 -37
- data/rbi/sentdm/models/{message_retrieve_params.rbi → contact_retrieve_params.rbi} +2 -2
- data/rbi/sentdm/models/contact_update_params.rbi +73 -0
- data/rbi/sentdm/models/destination_country.rbi +32 -0
- data/rbi/sentdm/models/lookup_retrieve_phone_info_params.rbi +30 -0
- data/rbi/sentdm/models/lookup_retrieve_phone_info_response.rbi +183 -0
- data/rbi/sentdm/models/me_retrieve_params.rbi +27 -0
- data/rbi/sentdm/models/me_retrieve_response.rbi +314 -0
- data/rbi/sentdm/models/message_retrieve_activities_params.rbi +30 -0
- data/rbi/sentdm/models/message_retrieve_activities_response.rbi +234 -0
- data/rbi/sentdm/models/message_retrieve_status_params.rbi +27 -0
- data/rbi/sentdm/models/message_retrieve_status_response.rbi +434 -0
- data/rbi/sentdm/models/message_send_params.rbi +143 -0
- data/rbi/sentdm/models/message_send_response.rbi +231 -0
- data/rbi/sentdm/models/mutation_request.rbi +32 -0
- data/rbi/sentdm/models/pagination_meta.rbi +135 -0
- data/rbi/sentdm/models/profile_complete_params.rbi +65 -0
- data/rbi/sentdm/models/profile_complete_response.rbi +8 -0
- data/rbi/sentdm/models/profile_create_params.rbi +156 -0
- data/rbi/sentdm/models/profile_delete_params.rbi +59 -0
- data/rbi/sentdm/models/profile_detail.rbi +273 -0
- data/rbi/sentdm/models/profile_list_params.rbi +27 -0
- data/rbi/sentdm/models/profile_list_response.rbi +111 -0
- data/rbi/sentdm/models/profile_retrieve_params.rbi +27 -0
- data/rbi/sentdm/models/profile_settings.rbi +86 -0
- data/rbi/sentdm/models/profile_update_params.rbi +196 -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/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_create_params.rbi +47 -23
- data/rbi/sentdm/models/template_definition.rbi +74 -405
- data/rbi/sentdm/models/template_delete_params.rbi +36 -5
- data/rbi/sentdm/models/template_list_params.rbi +8 -10
- data/rbi/sentdm/models/template_list_response.rbi +91 -37
- data/rbi/sentdm/models/template_update_params.rbi +105 -0
- data/rbi/sentdm/models/user_invite_params.rbi +90 -0
- data/rbi/sentdm/models/user_list_params.rbi +27 -0
- data/rbi/sentdm/models/user_list_response.rbi +111 -0
- data/rbi/sentdm/models/user_remove_params.rbi +59 -0
- data/rbi/sentdm/models/user_response.rbi +118 -0
- data/rbi/sentdm/models/user_retrieve_params.rbi +27 -0
- data/rbi/sentdm/models/user_update_role_params.rbi +79 -0
- data/rbi/sentdm/models/webhook_create_params.rbi +102 -0
- data/rbi/sentdm/models/webhook_delete_params.rbi +27 -0
- data/rbi/sentdm/models/webhook_list_event_types_params.rbi +27 -0
- data/rbi/sentdm/models/webhook_list_event_types_response.rbi +206 -0
- data/rbi/sentdm/models/webhook_list_events_params.rbi +48 -0
- data/rbi/sentdm/models/webhook_list_events_response.rbi +263 -0
- data/rbi/sentdm/models/webhook_list_params.rbi +59 -0
- data/rbi/sentdm/models/webhook_list_response.rbi +126 -0
- data/rbi/sentdm/models/webhook_response.rbi +134 -0
- data/rbi/sentdm/models/webhook_retrieve_params.rbi +27 -0
- data/rbi/sentdm/models/webhook_rotate_secret_params.rbi +67 -0
- data/rbi/sentdm/models/webhook_rotate_secret_response.rbi +112 -0
- data/rbi/sentdm/models/webhook_test_params.rbi +66 -0
- data/rbi/sentdm/models/webhook_test_response.rbi +111 -0
- data/rbi/sentdm/models/webhook_toggle_status_params.rbi +66 -0
- data/rbi/sentdm/models/webhook_update_params.rbi +102 -0
- data/rbi/sentdm/models.rbi +125 -10
- data/rbi/sentdm/resources/brands/campaigns.rbi +108 -0
- data/rbi/sentdm/resources/brands.rbi +93 -0
- data/rbi/sentdm/resources/contacts.rbi +89 -26
- data/rbi/sentdm/resources/lookup.rbi +24 -0
- data/rbi/sentdm/resources/me.rbi +23 -0
- data/rbi/sentdm/resources/messages.rbi +41 -60
- data/rbi/sentdm/resources/profiles.rbi +238 -0
- data/rbi/sentdm/resources/templates.rbi +94 -41
- data/rbi/sentdm/resources/users.rbi +116 -0
- data/rbi/sentdm/resources/webhooks.rbi +218 -0
- data/sig/sentdm/client.rbs +11 -8
- data/sig/sentdm/models/api_error.rbs +39 -0
- data/sig/sentdm/models/api_meta.rbs +41 -0
- data/sig/sentdm/models/api_response_brand_with_kyc.rbs +39 -0
- data/sig/sentdm/models/api_response_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/brand_create_params.rbs +36 -0
- data/sig/sentdm/models/brand_data.rbs +164 -0
- data/sig/sentdm/models/brand_delete_params.rbs +32 -0
- data/sig/sentdm/models/brand_list_params.rbs +14 -0
- data/sig/sentdm/models/brand_list_response.rbs +39 -0
- data/sig/sentdm/models/brand_update_params.rbs +36 -0
- data/sig/sentdm/models/brand_with_kyc.rbs +237 -0
- data/sig/sentdm/models/brands/api_response_tcr_campaign_with_use_cases.rbs +41 -0
- data/sig/sentdm/models/brands/base_dto.rbs +27 -0
- data/sig/sentdm/models/brands/campaign_create_params.rbs +42 -0
- data/sig/sentdm/models/brands/campaign_data.rbs +82 -0
- data/sig/sentdm/models/brands/campaign_delete_params.rbs +38 -0
- data/sig/sentdm/models/brands/campaign_list_params.rbs +17 -0
- data/sig/sentdm/models/brands/campaign_list_response.rbs +41 -0
- data/sig/sentdm/models/brands/campaign_update_params.rbs +47 -0
- data/sig/sentdm/models/brands/messaging_use_case_us.rbs +40 -0
- data/sig/sentdm/models/brands/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbs +27 -0
- data/sig/sentdm/models/brands/tcr_campaign_with_use_cases.rbs +285 -0
- data/sig/sentdm/models/{contact_list_item.rbs → contact.rbs} +31 -5
- data/sig/sentdm/models/contact_create_params.rbs +38 -0
- data/sig/sentdm/models/contact_delete_params.rbs +32 -0
- data/sig/sentdm/models/contact_list_params.rbs +19 -1
- data/sig/sentdm/models/contact_list_response.rbs +44 -31
- data/sig/sentdm/models/{message_retrieve_params.rbs → contact_retrieve_params.rbs} +2 -2
- data/sig/sentdm/models/contact_update_params.rbs +45 -0
- data/sig/sentdm/models/destination_country.rbs +19 -0
- data/sig/sentdm/models/lookup_retrieve_phone_info_params.rbs +15 -0
- data/sig/sentdm/models/lookup_retrieve_phone_info_response.rbs +102 -0
- data/sig/sentdm/models/me_retrieve_params.rbs +14 -0
- data/sig/sentdm/models/me_retrieve_response.rbs +162 -0
- data/sig/sentdm/models/message_retrieve_activities_params.rbs +15 -0
- data/sig/sentdm/models/message_retrieve_activities_response.rbs +105 -0
- data/sig/sentdm/models/message_retrieve_status_params.rbs +15 -0
- data/sig/sentdm/models/message_retrieve_status_response.rbs +224 -0
- data/sig/sentdm/models/message_send_params.rbs +79 -0
- data/sig/sentdm/models/message_send_response.rbs +108 -0
- data/sig/sentdm/models/mutation_request.rbs +15 -0
- data/sig/sentdm/models/pagination_meta.rbs +67 -0
- data/sig/sentdm/models/profile_complete_params.rbs +36 -0
- data/sig/sentdm/models/profile_complete_response.rbs +5 -0
- data/sig/sentdm/models/profile_create_params.rbs +96 -0
- data/sig/sentdm/models/profile_delete_params.rbs +32 -0
- data/sig/sentdm/models/profile_detail.rbs +168 -0
- data/sig/sentdm/models/profile_list_params.rbs +14 -0
- data/sig/sentdm/models/profile_list_response.rbs +53 -0
- data/sig/sentdm/models/profile_retrieve_params.rbs +15 -0
- data/sig/sentdm/models/profile_settings.rbs +50 -0
- data/sig/sentdm/models/profile_update_params.rbs +122 -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/tcr_brand_relationship.rbs +22 -0
- data/sig/sentdm/models/tcr_vertical.rbs +58 -0
- data/sig/sentdm/models/{template_response_v2.rbs → template.rbs} +18 -31
- data/sig/sentdm/models/template_create_params.rbs +29 -6
- data/sig/sentdm/models/template_definition.rbs +20 -233
- data/sig/sentdm/models/template_delete_params.rbs +18 -3
- data/sig/sentdm/models/template_list_response.rbs +44 -31
- data/sig/sentdm/models/template_update_params.rbs +62 -0
- data/sig/sentdm/models/user_invite_params.rbs +56 -0
- data/sig/sentdm/models/user_list_params.rbs +14 -0
- data/sig/sentdm/models/user_list_response.rbs +53 -0
- data/sig/sentdm/models/user_remove_params.rbs +32 -0
- data/sig/sentdm/models/user_response.rbs +72 -0
- data/sig/sentdm/models/user_retrieve_params.rbs +15 -0
- data/sig/sentdm/models/user_update_role_params.rbs +49 -0
- data/sig/sentdm/models/webhook_create_params.rbs +70 -0
- data/sig/sentdm/models/webhook_delete_params.rbs +15 -0
- data/sig/sentdm/models/webhook_list_event_types_params.rbs +15 -0
- data/sig/sentdm/models/webhook_list_event_types_response.rbs +98 -0
- data/sig/sentdm/models/webhook_list_events_params.rbs +32 -0
- data/sig/sentdm/models/webhook_list_events_response.rbs +146 -0
- data/sig/sentdm/models/webhook_list_params.rbs +36 -0
- data/sig/sentdm/models/webhook_list_response.rbs +67 -0
- data/sig/sentdm/models/webhook_response.rbs +98 -0
- data/sig/sentdm/models/webhook_retrieve_params.rbs +15 -0
- data/sig/sentdm/models/webhook_rotate_secret_params.rbs +38 -0
- data/sig/sentdm/models/webhook_rotate_secret_response.rbs +51 -0
- data/sig/sentdm/models/webhook_test_params.rbs +38 -0
- data/sig/sentdm/models/webhook_test_response.rbs +55 -0
- data/sig/sentdm/models/webhook_toggle_status_params.rbs +38 -0
- data/sig/sentdm/models/webhook_update_params.rbs +70 -0
- data/sig/sentdm/models.rbs +118 -10
- data/sig/sentdm/resources/brands/campaigns.rbs +38 -0
- data/sig/sentdm/resources/brands.rbs +34 -0
- data/sig/sentdm/resources/contacts.rbs +28 -8
- data/sig/sentdm/resources/lookup.rbs +12 -0
- data/sig/sentdm/resources/{number_lookup.rbs → me.rbs} +2 -3
- data/sig/sentdm/resources/messages.rbs +12 -18
- data/sig/sentdm/resources/profiles.rbs +72 -0
- data/sig/sentdm/resources/templates.rbs +24 -4
- data/sig/sentdm/resources/users.rbs +41 -0
- data/sig/sentdm/resources/webhooks.rbs +80 -0
- metadata +284 -38
- data/lib/sentdm/models/contact_list_item.rb +0 -96
- data/lib/sentdm/models/contact_retrieve_by_phone_params.rb +0 -22
- data/lib/sentdm/models/contact_retrieve_id_params.rb +0 -22
- data/lib/sentdm/models/message_retrieve_response.rb +0 -227
- data/lib/sentdm/models/message_send_quick_message_params.rb +0 -34
- data/lib/sentdm/models/message_send_to_contact_params.rb +0 -46
- data/lib/sentdm/models/message_send_to_phone_params.rb +0 -47
- data/lib/sentdm/models/number_lookup_retrieve_params.rb +0 -20
- data/lib/sentdm/models/number_lookup_retrieve_response.rb +0 -83
- data/lib/sentdm/models/template_response_v2.rb +0 -100
- data/lib/sentdm/resources/number_lookup.rb +0 -37
- data/rbi/sentdm/models/contact_list_item.rbi +0 -144
- data/rbi/sentdm/models/contact_retrieve_by_phone_params.rbi +0 -40
- data/rbi/sentdm/models/contact_retrieve_id_params.rbi +0 -40
- data/rbi/sentdm/models/message_retrieve_response.rbi +0 -376
- data/rbi/sentdm/models/message_send_quick_message_params.rbi +0 -56
- data/rbi/sentdm/models/message_send_to_contact_params.rbi +0 -63
- data/rbi/sentdm/models/message_send_to_phone_params.rbi +0 -65
- data/rbi/sentdm/models/number_lookup_retrieve_params.rbi +0 -35
- data/rbi/sentdm/models/number_lookup_retrieve_response.rbi +0 -132
- data/rbi/sentdm/models/template_response_v2.rbi +0 -149
- data/rbi/sentdm/resources/number_lookup.rbi +0 -24
- data/sig/sentdm/models/contact_retrieve_by_phone_params.rbs +0 -23
- data/sig/sentdm/models/contact_retrieve_id_params.rbs +0 -20
- data/sig/sentdm/models/message_retrieve_response.rbs +0 -188
- data/sig/sentdm/models/message_send_quick_message_params.rbs +0 -28
- data/sig/sentdm/models/message_send_to_contact_params.rbs +0 -36
- data/sig/sentdm/models/message_send_to_phone_params.rbs +0 -36
- data/sig/sentdm/models/number_lookup_retrieve_params.rbs +0 -23
- data/sig/sentdm/models/number_lookup_retrieve_response.rbs +0 -78
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
# @see Sentdm::Resources::Profiles#create
|
|
6
|
+
class ProfileCreateParams < Sentdm::Internal::Type::BaseModel
|
|
7
|
+
extend Sentdm::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Sentdm::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute allow_contact_sharing
|
|
11
|
+
# Whether contacts are shared across profiles (default: false)
|
|
12
|
+
#
|
|
13
|
+
# @return [Boolean, nil]
|
|
14
|
+
optional :allow_contact_sharing, Sentdm::Internal::Type::Boolean
|
|
15
|
+
|
|
16
|
+
# @!attribute allow_template_sharing
|
|
17
|
+
# Whether templates are shared across profiles (default: false)
|
|
18
|
+
#
|
|
19
|
+
# @return [Boolean, nil]
|
|
20
|
+
optional :allow_template_sharing, Sentdm::Internal::Type::Boolean
|
|
21
|
+
|
|
22
|
+
# @!attribute billing_model
|
|
23
|
+
# Billing model: profile, organization, or profile_and_organization (default:
|
|
24
|
+
# profile)
|
|
25
|
+
#
|
|
26
|
+
# @return [String, nil]
|
|
27
|
+
optional :billing_model, String, nil?: true
|
|
28
|
+
|
|
29
|
+
# @!attribute description
|
|
30
|
+
# Profile description (optional)
|
|
31
|
+
#
|
|
32
|
+
# @return [String, nil]
|
|
33
|
+
optional :description, String, nil?: true
|
|
34
|
+
|
|
35
|
+
# @!attribute icon
|
|
36
|
+
# Profile icon URL (optional)
|
|
37
|
+
#
|
|
38
|
+
# @return [String, nil]
|
|
39
|
+
optional :icon, String, nil?: true
|
|
40
|
+
|
|
41
|
+
# @!attribute inherit_contacts
|
|
42
|
+
# Whether this profile inherits contacts from organization (default: true)
|
|
43
|
+
#
|
|
44
|
+
# @return [Boolean, nil]
|
|
45
|
+
optional :inherit_contacts, Sentdm::Internal::Type::Boolean, nil?: true
|
|
46
|
+
|
|
47
|
+
# @!attribute inherit_tcr_brand
|
|
48
|
+
# Whether this profile inherits TCR brand from organization (default: true)
|
|
49
|
+
#
|
|
50
|
+
# @return [Boolean, nil]
|
|
51
|
+
optional :inherit_tcr_brand, Sentdm::Internal::Type::Boolean, nil?: true
|
|
52
|
+
|
|
53
|
+
# @!attribute inherit_tcr_campaign
|
|
54
|
+
# Whether this profile inherits TCR campaign from organization (default: true)
|
|
55
|
+
#
|
|
56
|
+
# @return [Boolean, nil]
|
|
57
|
+
optional :inherit_tcr_campaign, Sentdm::Internal::Type::Boolean, nil?: true
|
|
58
|
+
|
|
59
|
+
# @!attribute inherit_templates
|
|
60
|
+
# Whether this profile inherits templates from organization (default: true)
|
|
61
|
+
#
|
|
62
|
+
# @return [Boolean, nil]
|
|
63
|
+
optional :inherit_templates, Sentdm::Internal::Type::Boolean, nil?: true
|
|
64
|
+
|
|
65
|
+
# @!attribute name
|
|
66
|
+
# Profile name (required)
|
|
67
|
+
#
|
|
68
|
+
# @return [String, nil]
|
|
69
|
+
optional :name, String
|
|
70
|
+
|
|
71
|
+
# @!attribute short_name
|
|
72
|
+
# Profile short name/abbreviation (optional)
|
|
73
|
+
#
|
|
74
|
+
# @return [String, nil]
|
|
75
|
+
optional :short_name, String, nil?: true
|
|
76
|
+
|
|
77
|
+
# @!attribute test_mode
|
|
78
|
+
# Test mode flag - when true, the operation is simulated without side effects
|
|
79
|
+
# Useful for testing integrations without actual execution
|
|
80
|
+
#
|
|
81
|
+
# @return [Boolean, nil]
|
|
82
|
+
optional :test_mode, Sentdm::Internal::Type::Boolean
|
|
83
|
+
|
|
84
|
+
# @!attribute idempotency_key
|
|
85
|
+
#
|
|
86
|
+
# @return [String, nil]
|
|
87
|
+
optional :idempotency_key, String
|
|
88
|
+
|
|
89
|
+
# @!method initialize(allow_contact_sharing: nil, allow_template_sharing: nil, billing_model: nil, description: nil, icon: nil, inherit_contacts: nil, inherit_tcr_brand: nil, inherit_tcr_campaign: nil, inherit_templates: nil, name: nil, short_name: nil, test_mode: nil, idempotency_key: nil, request_options: {})
|
|
90
|
+
# Some parameter documentations has been truncated, see
|
|
91
|
+
# {Sentdm::Models::ProfileCreateParams} for more details.
|
|
92
|
+
#
|
|
93
|
+
# @param allow_contact_sharing [Boolean] Whether contacts are shared across profiles (default: false)
|
|
94
|
+
#
|
|
95
|
+
# @param allow_template_sharing [Boolean] Whether templates are shared across profiles (default: false)
|
|
96
|
+
#
|
|
97
|
+
# @param billing_model [String, nil] Billing model: profile, organization, or profile_and_organization (default: prof
|
|
98
|
+
#
|
|
99
|
+
# @param description [String, nil] Profile description (optional)
|
|
100
|
+
#
|
|
101
|
+
# @param icon [String, nil] Profile icon URL (optional)
|
|
102
|
+
#
|
|
103
|
+
# @param inherit_contacts [Boolean, nil] Whether this profile inherits contacts from organization (default: true)
|
|
104
|
+
#
|
|
105
|
+
# @param inherit_tcr_brand [Boolean, nil] Whether this profile inherits TCR brand from organization (default: true)
|
|
106
|
+
#
|
|
107
|
+
# @param inherit_tcr_campaign [Boolean, nil] Whether this profile inherits TCR campaign from organization (default: true)
|
|
108
|
+
#
|
|
109
|
+
# @param inherit_templates [Boolean, nil] Whether this profile inherits templates from organization (default: true)
|
|
110
|
+
#
|
|
111
|
+
# @param name [String] Profile name (required)
|
|
112
|
+
#
|
|
113
|
+
# @param short_name [String, nil] Profile short name/abbreviation (optional)
|
|
114
|
+
#
|
|
115
|
+
# @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
|
|
116
|
+
#
|
|
117
|
+
# @param idempotency_key [String]
|
|
118
|
+
#
|
|
119
|
+
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
|
|
120
|
+
end
|
|
121
|
+
end
|
|
122
|
+
end
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
# @see Sentdm::Resources::Profiles#delete
|
|
6
|
+
class ProfileDeleteParams < Sentdm::Internal::Type::BaseModel
|
|
7
|
+
extend Sentdm::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Sentdm::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute body_profile_id
|
|
11
|
+
# Profile ID from route parameter
|
|
12
|
+
#
|
|
13
|
+
# @return [String, nil]
|
|
14
|
+
optional :body_profile_id, String, api_name: :profile_id
|
|
15
|
+
|
|
16
|
+
# @!attribute test_mode
|
|
17
|
+
# Test mode flag - when true, the operation is simulated without side effects
|
|
18
|
+
# Useful for testing integrations without actual execution
|
|
19
|
+
#
|
|
20
|
+
# @return [Boolean, nil]
|
|
21
|
+
optional :test_mode, Sentdm::Internal::Type::Boolean
|
|
22
|
+
|
|
23
|
+
# @!method initialize(body_profile_id: nil, test_mode: nil, request_options: {})
|
|
24
|
+
# Some parameter documentations has been truncated, see
|
|
25
|
+
# {Sentdm::Models::ProfileDeleteParams} for more details.
|
|
26
|
+
#
|
|
27
|
+
# @param body_profile_id [String] Profile ID from route parameter
|
|
28
|
+
#
|
|
29
|
+
# @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
|
|
30
|
+
#
|
|
31
|
+
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
end
|
|
@@ -0,0 +1,200 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
class ProfileDetail < Sentdm::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute id
|
|
7
|
+
# Profile unique identifier
|
|
8
|
+
#
|
|
9
|
+
# @return [String, nil]
|
|
10
|
+
optional :id, String
|
|
11
|
+
|
|
12
|
+
# @!attribute created_at
|
|
13
|
+
# When the profile was created
|
|
14
|
+
#
|
|
15
|
+
# @return [Time, nil]
|
|
16
|
+
optional :created_at, Time
|
|
17
|
+
|
|
18
|
+
# @!attribute description
|
|
19
|
+
# Profile description
|
|
20
|
+
#
|
|
21
|
+
# @return [String, nil]
|
|
22
|
+
optional :description, String, nil?: true
|
|
23
|
+
|
|
24
|
+
# @!attribute email
|
|
25
|
+
# Profile email (inherited from organization)
|
|
26
|
+
#
|
|
27
|
+
# @return [String, nil]
|
|
28
|
+
optional :email, String, nil?: true
|
|
29
|
+
|
|
30
|
+
# @!attribute icon
|
|
31
|
+
# Profile icon URL
|
|
32
|
+
#
|
|
33
|
+
# @return [String, nil]
|
|
34
|
+
optional :icon, String, nil?: true
|
|
35
|
+
|
|
36
|
+
# @!attribute name
|
|
37
|
+
# Profile name
|
|
38
|
+
#
|
|
39
|
+
# @return [String, nil]
|
|
40
|
+
optional :name, String
|
|
41
|
+
|
|
42
|
+
# @!attribute organization_id
|
|
43
|
+
# Parent organization ID
|
|
44
|
+
#
|
|
45
|
+
# @return [String, nil]
|
|
46
|
+
optional :organization_id, String, nil?: true
|
|
47
|
+
|
|
48
|
+
# @!attribute settings
|
|
49
|
+
# Profile configuration settings
|
|
50
|
+
#
|
|
51
|
+
# @return [Sentdm::Models::ProfileDetail::Settings, nil]
|
|
52
|
+
optional :settings, -> { Sentdm::ProfileDetail::Settings }
|
|
53
|
+
|
|
54
|
+
# @!attribute short_name
|
|
55
|
+
# Profile short name (abbreviation)
|
|
56
|
+
#
|
|
57
|
+
# @return [String, nil]
|
|
58
|
+
optional :short_name, String, nil?: true
|
|
59
|
+
|
|
60
|
+
# @!attribute status
|
|
61
|
+
# Profile setup status: incomplete, pending_review, approved, rejected
|
|
62
|
+
#
|
|
63
|
+
# @return [String, nil]
|
|
64
|
+
optional :status, String
|
|
65
|
+
|
|
66
|
+
# @!attribute updated_at
|
|
67
|
+
# When the profile was last updated
|
|
68
|
+
#
|
|
69
|
+
# @return [Time, nil]
|
|
70
|
+
optional :updated_at, Time, nil?: true
|
|
71
|
+
|
|
72
|
+
# @!method initialize(id: nil, created_at: nil, description: nil, email: nil, icon: nil, name: nil, organization_id: nil, settings: nil, short_name: nil, status: nil, updated_at: nil)
|
|
73
|
+
# Detailed profile response for v3 API
|
|
74
|
+
#
|
|
75
|
+
# @param id [String] Profile unique identifier
|
|
76
|
+
#
|
|
77
|
+
# @param created_at [Time] When the profile was created
|
|
78
|
+
#
|
|
79
|
+
# @param description [String, nil] Profile description
|
|
80
|
+
#
|
|
81
|
+
# @param email [String, nil] Profile email (inherited from organization)
|
|
82
|
+
#
|
|
83
|
+
# @param icon [String, nil] Profile icon URL
|
|
84
|
+
#
|
|
85
|
+
# @param name [String] Profile name
|
|
86
|
+
#
|
|
87
|
+
# @param organization_id [String, nil] Parent organization ID
|
|
88
|
+
#
|
|
89
|
+
# @param settings [Sentdm::Models::ProfileDetail::Settings] Profile configuration settings
|
|
90
|
+
#
|
|
91
|
+
# @param short_name [String, nil] Profile short name (abbreviation)
|
|
92
|
+
#
|
|
93
|
+
# @param status [String] Profile setup status: incomplete, pending_review, approved, rejected
|
|
94
|
+
#
|
|
95
|
+
# @param updated_at [Time, nil] When the profile was last updated
|
|
96
|
+
|
|
97
|
+
# @see Sentdm::Models::ProfileDetail#settings
|
|
98
|
+
class Settings < Sentdm::Internal::Type::BaseModel
|
|
99
|
+
# @!attribute allow_contact_sharing
|
|
100
|
+
# Whether contacts are shared across profiles in the organization
|
|
101
|
+
#
|
|
102
|
+
# @return [Boolean, nil]
|
|
103
|
+
optional :allow_contact_sharing, Sentdm::Internal::Type::Boolean
|
|
104
|
+
|
|
105
|
+
# @!attribute allow_number_change_during_onboarding
|
|
106
|
+
# Whether number changes are allowed during onboarding
|
|
107
|
+
#
|
|
108
|
+
# @return [Boolean, nil]
|
|
109
|
+
optional :allow_number_change_during_onboarding, Sentdm::Internal::Type::Boolean, nil?: true
|
|
110
|
+
|
|
111
|
+
# @!attribute allow_template_sharing
|
|
112
|
+
# Whether templates are shared across profiles in the organization
|
|
113
|
+
#
|
|
114
|
+
# @return [Boolean, nil]
|
|
115
|
+
optional :allow_template_sharing, Sentdm::Internal::Type::Boolean
|
|
116
|
+
|
|
117
|
+
# @!attribute billing_model
|
|
118
|
+
# Billing model: profile, organization, or profile_and_organization
|
|
119
|
+
#
|
|
120
|
+
# @return [String, nil]
|
|
121
|
+
optional :billing_model, String
|
|
122
|
+
|
|
123
|
+
# @!attribute inherit_contacts
|
|
124
|
+
# Whether this profile inherits contacts from the organization
|
|
125
|
+
#
|
|
126
|
+
# @return [Boolean, nil]
|
|
127
|
+
optional :inherit_contacts, Sentdm::Internal::Type::Boolean
|
|
128
|
+
|
|
129
|
+
# @!attribute inherit_tcr_brand
|
|
130
|
+
# Whether this profile inherits TCR brand from the organization
|
|
131
|
+
#
|
|
132
|
+
# @return [Boolean, nil]
|
|
133
|
+
optional :inherit_tcr_brand, Sentdm::Internal::Type::Boolean
|
|
134
|
+
|
|
135
|
+
# @!attribute inherit_tcr_campaign
|
|
136
|
+
# Whether this profile inherits TCR campaign from the organization
|
|
137
|
+
#
|
|
138
|
+
# @return [Boolean, nil]
|
|
139
|
+
optional :inherit_tcr_campaign, Sentdm::Internal::Type::Boolean
|
|
140
|
+
|
|
141
|
+
# @!attribute inherit_templates
|
|
142
|
+
# Whether this profile inherits templates from the organization
|
|
143
|
+
#
|
|
144
|
+
# @return [Boolean, nil]
|
|
145
|
+
optional :inherit_templates, Sentdm::Internal::Type::Boolean
|
|
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 whatsapp_phone_number
|
|
166
|
+
# Direct WhatsApp phone number
|
|
167
|
+
#
|
|
168
|
+
# @return [String, nil]
|
|
169
|
+
optional :whatsapp_phone_number, String, nil?: true
|
|
170
|
+
|
|
171
|
+
# @!method initialize(allow_contact_sharing: nil, allow_number_change_during_onboarding: nil, allow_template_sharing: nil, billing_model: nil, inherit_contacts: nil, inherit_tcr_brand: nil, inherit_tcr_campaign: nil, inherit_templates: nil, sending_phone_number: nil, sending_phone_number_profile_id: nil, sending_whatsapp_number_profile_id: nil, whatsapp_phone_number: nil)
|
|
172
|
+
# Profile configuration settings
|
|
173
|
+
#
|
|
174
|
+
# @param allow_contact_sharing [Boolean] Whether contacts are shared across profiles in the organization
|
|
175
|
+
#
|
|
176
|
+
# @param allow_number_change_during_onboarding [Boolean, nil] Whether number changes are allowed during onboarding
|
|
177
|
+
#
|
|
178
|
+
# @param allow_template_sharing [Boolean] Whether templates are shared across profiles in the organization
|
|
179
|
+
#
|
|
180
|
+
# @param billing_model [String] Billing model: profile, organization, or profile_and_organization
|
|
181
|
+
#
|
|
182
|
+
# @param inherit_contacts [Boolean] Whether this profile inherits contacts from the organization
|
|
183
|
+
#
|
|
184
|
+
# @param inherit_tcr_brand [Boolean] Whether this profile inherits TCR brand from the organization
|
|
185
|
+
#
|
|
186
|
+
# @param inherit_tcr_campaign [Boolean] Whether this profile inherits TCR campaign from the organization
|
|
187
|
+
#
|
|
188
|
+
# @param inherit_templates [Boolean] Whether this profile inherits templates from the organization
|
|
189
|
+
#
|
|
190
|
+
# @param sending_phone_number [String, nil] Direct SMS phone number
|
|
191
|
+
#
|
|
192
|
+
# @param sending_phone_number_profile_id [String, nil] Reference to another profile for SMS/Telnyx configuration
|
|
193
|
+
#
|
|
194
|
+
# @param sending_whatsapp_number_profile_id [String, nil] Reference to another profile for WhatsApp configuration
|
|
195
|
+
#
|
|
196
|
+
# @param whatsapp_phone_number [String, nil] Direct WhatsApp phone number
|
|
197
|
+
end
|
|
198
|
+
end
|
|
199
|
+
end
|
|
200
|
+
end
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
# @see Sentdm::Resources::Profiles#list
|
|
6
|
+
class ProfileListParams < Sentdm::Internal::Type::BaseModel
|
|
7
|
+
extend Sentdm::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Sentdm::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!method initialize(request_options: {})
|
|
11
|
+
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
end
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
# @see Sentdm::Resources::Profiles#list
|
|
6
|
+
class ProfileListResponse < Sentdm::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute data
|
|
8
|
+
# The response data (null if error)
|
|
9
|
+
#
|
|
10
|
+
# @return [Sentdm::Models::ProfileListResponse::Data, nil]
|
|
11
|
+
optional :data, -> { Sentdm::Models::ProfileListResponse::Data }, nil?: true
|
|
12
|
+
|
|
13
|
+
# @!attribute error
|
|
14
|
+
# Error details (null if successful)
|
|
15
|
+
#
|
|
16
|
+
# @return [Sentdm::Models::APIError, nil]
|
|
17
|
+
optional :error, -> { Sentdm::APIError }, nil?: true
|
|
18
|
+
|
|
19
|
+
# @!attribute meta
|
|
20
|
+
# Metadata about the request and response
|
|
21
|
+
#
|
|
22
|
+
# @return [Sentdm::Models::APIMeta, nil]
|
|
23
|
+
optional :meta, -> { Sentdm::APIMeta }
|
|
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::ProfileListResponse::Data, nil] The response data (null if error)
|
|
35
|
+
#
|
|
36
|
+
# @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
|
|
37
|
+
#
|
|
38
|
+
# @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
|
|
39
|
+
#
|
|
40
|
+
# @param success [Boolean] Indicates whether the request was successful
|
|
41
|
+
|
|
42
|
+
# @see Sentdm::Models::ProfileListResponse#data
|
|
43
|
+
class Data < Sentdm::Internal::Type::BaseModel
|
|
44
|
+
# @!attribute profiles
|
|
45
|
+
# List of profiles in the organization
|
|
46
|
+
#
|
|
47
|
+
# @return [Array<Sentdm::Models::ProfileDetail>, nil]
|
|
48
|
+
optional :profiles, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ProfileDetail] }
|
|
49
|
+
|
|
50
|
+
# @!method initialize(profiles: nil)
|
|
51
|
+
# The response data (null if error)
|
|
52
|
+
#
|
|
53
|
+
# @param profiles [Array<Sentdm::Models::ProfileDetail>] List of profiles in the organization
|
|
54
|
+
end
|
|
55
|
+
end
|
|
56
|
+
end
|
|
57
|
+
end
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
# @see Sentdm::Resources::Profiles#retrieve
|
|
6
|
+
class ProfileRetrieveParams < Sentdm::Internal::Type::BaseModel
|
|
7
|
+
extend Sentdm::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Sentdm::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!method initialize(request_options: {})
|
|
11
|
+
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
end
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
class ProfileSettings < Sentdm::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute allow_contact_sharing
|
|
7
|
+
# Whether contacts are shared across profiles in the organization
|
|
8
|
+
#
|
|
9
|
+
# @return [Boolean, nil]
|
|
10
|
+
optional :allow_contact_sharing, Sentdm::Internal::Type::Boolean, nil?: true
|
|
11
|
+
|
|
12
|
+
# @!attribute allow_template_sharing
|
|
13
|
+
# Whether templates are shared across profiles in the organization
|
|
14
|
+
#
|
|
15
|
+
# @return [Boolean, nil]
|
|
16
|
+
optional :allow_template_sharing, Sentdm::Internal::Type::Boolean, nil?: true
|
|
17
|
+
|
|
18
|
+
# @!attribute billing_model
|
|
19
|
+
# Billing model: profile, organization, or profile_and_organization
|
|
20
|
+
#
|
|
21
|
+
# @return [String, nil]
|
|
22
|
+
optional :billing_model, String, nil?: true
|
|
23
|
+
|
|
24
|
+
# @!attribute inherit_contacts
|
|
25
|
+
# Whether this profile inherits contacts from the organization
|
|
26
|
+
#
|
|
27
|
+
# @return [Boolean, nil]
|
|
28
|
+
optional :inherit_contacts, Sentdm::Internal::Type::Boolean, nil?: true
|
|
29
|
+
|
|
30
|
+
# @!attribute inherit_tcr_brand
|
|
31
|
+
# Whether this profile inherits TCR brand from the organization
|
|
32
|
+
#
|
|
33
|
+
# @return [Boolean, nil]
|
|
34
|
+
optional :inherit_tcr_brand, Sentdm::Internal::Type::Boolean, nil?: true
|
|
35
|
+
|
|
36
|
+
# @!attribute inherit_tcr_campaign
|
|
37
|
+
# Whether this profile inherits TCR campaign from the organization
|
|
38
|
+
#
|
|
39
|
+
# @return [Boolean, nil]
|
|
40
|
+
optional :inherit_tcr_campaign, Sentdm::Internal::Type::Boolean, nil?: true
|
|
41
|
+
|
|
42
|
+
# @!attribute inherit_templates
|
|
43
|
+
# Whether this profile inherits templates from the organization
|
|
44
|
+
#
|
|
45
|
+
# @return [Boolean, nil]
|
|
46
|
+
optional :inherit_templates, Sentdm::Internal::Type::Boolean, nil?: true
|
|
47
|
+
|
|
48
|
+
# @!method initialize(allow_contact_sharing: nil, allow_template_sharing: nil, billing_model: nil, inherit_contacts: nil, inherit_tcr_brand: nil, inherit_tcr_campaign: nil, inherit_templates: nil)
|
|
49
|
+
# Profile configuration settings
|
|
50
|
+
#
|
|
51
|
+
# @param allow_contact_sharing [Boolean, nil] Whether contacts are shared across profiles in the organization
|
|
52
|
+
#
|
|
53
|
+
# @param allow_template_sharing [Boolean, nil] Whether templates are shared across profiles in the organization
|
|
54
|
+
#
|
|
55
|
+
# @param billing_model [String, nil] Billing model: profile, organization, or profile_and_organization
|
|
56
|
+
#
|
|
57
|
+
# @param inherit_contacts [Boolean, nil] Whether this profile inherits contacts from the organization
|
|
58
|
+
#
|
|
59
|
+
# @param inherit_tcr_brand [Boolean, nil] Whether this profile inherits TCR brand from the organization
|
|
60
|
+
#
|
|
61
|
+
# @param inherit_tcr_campaign [Boolean, nil] Whether this profile inherits TCR campaign from the organization
|
|
62
|
+
#
|
|
63
|
+
# @param inherit_templates [Boolean, nil] Whether this profile inherits templates from the organization
|
|
64
|
+
end
|
|
65
|
+
end
|
|
66
|
+
end
|
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
# @see Sentdm::Resources::Profiles#update
|
|
6
|
+
class ProfileUpdateParams < Sentdm::Internal::Type::BaseModel
|
|
7
|
+
extend Sentdm::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Sentdm::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute allow_contact_sharing
|
|
11
|
+
# Whether contacts are shared across profiles (optional)
|
|
12
|
+
#
|
|
13
|
+
# @return [Boolean, nil]
|
|
14
|
+
optional :allow_contact_sharing, Sentdm::Internal::Type::Boolean, nil?: true
|
|
15
|
+
|
|
16
|
+
# @!attribute allow_number_change_during_onboarding
|
|
17
|
+
# Whether number changes are allowed during onboarding (optional)
|
|
18
|
+
#
|
|
19
|
+
# @return [Boolean, nil]
|
|
20
|
+
optional :allow_number_change_during_onboarding, Sentdm::Internal::Type::Boolean, nil?: true
|
|
21
|
+
|
|
22
|
+
# @!attribute allow_template_sharing
|
|
23
|
+
# Whether templates are shared across profiles (optional)
|
|
24
|
+
#
|
|
25
|
+
# @return [Boolean, nil]
|
|
26
|
+
optional :allow_template_sharing, Sentdm::Internal::Type::Boolean, nil?: true
|
|
27
|
+
|
|
28
|
+
# @!attribute billing_model
|
|
29
|
+
# Billing model: profile, organization, or profile_and_organization (optional)
|
|
30
|
+
#
|
|
31
|
+
# @return [String, nil]
|
|
32
|
+
optional :billing_model, String, nil?: true
|
|
33
|
+
|
|
34
|
+
# @!attribute description
|
|
35
|
+
# Profile description (optional)
|
|
36
|
+
#
|
|
37
|
+
# @return [String, nil]
|
|
38
|
+
optional :description, String, nil?: true
|
|
39
|
+
|
|
40
|
+
# @!attribute icon
|
|
41
|
+
# Profile icon URL (optional)
|
|
42
|
+
#
|
|
43
|
+
# @return [String, nil]
|
|
44
|
+
optional :icon, String, nil?: true
|
|
45
|
+
|
|
46
|
+
# @!attribute inherit_contacts
|
|
47
|
+
# Whether this profile inherits contacts from organization (optional)
|
|
48
|
+
#
|
|
49
|
+
# @return [Boolean, nil]
|
|
50
|
+
optional :inherit_contacts, Sentdm::Internal::Type::Boolean, nil?: true
|
|
51
|
+
|
|
52
|
+
# @!attribute inherit_tcr_brand
|
|
53
|
+
# Whether this profile inherits TCR brand from organization (optional)
|
|
54
|
+
#
|
|
55
|
+
# @return [Boolean, nil]
|
|
56
|
+
optional :inherit_tcr_brand, Sentdm::Internal::Type::Boolean, nil?: true
|
|
57
|
+
|
|
58
|
+
# @!attribute inherit_tcr_campaign
|
|
59
|
+
# Whether this profile inherits TCR campaign from organization (optional)
|
|
60
|
+
#
|
|
61
|
+
# @return [Boolean, nil]
|
|
62
|
+
optional :inherit_tcr_campaign, Sentdm::Internal::Type::Boolean, nil?: true
|
|
63
|
+
|
|
64
|
+
# @!attribute inherit_templates
|
|
65
|
+
# Whether this profile inherits templates from organization (optional)
|
|
66
|
+
#
|
|
67
|
+
# @return [Boolean, nil]
|
|
68
|
+
optional :inherit_templates, Sentdm::Internal::Type::Boolean, nil?: true
|
|
69
|
+
|
|
70
|
+
# @!attribute name
|
|
71
|
+
# Profile name (optional)
|
|
72
|
+
#
|
|
73
|
+
# @return [String, nil]
|
|
74
|
+
optional :name, String, nil?: true
|
|
75
|
+
|
|
76
|
+
# @!attribute body_profile_id
|
|
77
|
+
# Profile ID from route parameter
|
|
78
|
+
#
|
|
79
|
+
# @return [String, nil]
|
|
80
|
+
optional :body_profile_id, String, api_name: :profile_id
|
|
81
|
+
|
|
82
|
+
# @!attribute sending_phone_number
|
|
83
|
+
# Direct phone number for SMS sending (optional)
|
|
84
|
+
#
|
|
85
|
+
# @return [String, nil]
|
|
86
|
+
optional :sending_phone_number, String, nil?: true
|
|
87
|
+
|
|
88
|
+
# @!attribute sending_phone_number_profile_id
|
|
89
|
+
# Reference to another profile to use for SMS/Telnyx configuration (optional)
|
|
90
|
+
#
|
|
91
|
+
# @return [String, nil]
|
|
92
|
+
optional :sending_phone_number_profile_id, String, nil?: true
|
|
93
|
+
|
|
94
|
+
# @!attribute sending_whatsapp_number_profile_id
|
|
95
|
+
# Reference to another profile to use for WhatsApp configuration (optional)
|
|
96
|
+
#
|
|
97
|
+
# @return [String, nil]
|
|
98
|
+
optional :sending_whatsapp_number_profile_id, String, nil?: true
|
|
99
|
+
|
|
100
|
+
# @!attribute short_name
|
|
101
|
+
# Profile short name/abbreviation (optional)
|
|
102
|
+
#
|
|
103
|
+
# @return [String, nil]
|
|
104
|
+
optional :short_name, String, nil?: true
|
|
105
|
+
|
|
106
|
+
# @!attribute test_mode
|
|
107
|
+
# Test mode flag - when true, the operation is simulated without side effects
|
|
108
|
+
# Useful for testing integrations without actual execution
|
|
109
|
+
#
|
|
110
|
+
# @return [Boolean, nil]
|
|
111
|
+
optional :test_mode, Sentdm::Internal::Type::Boolean
|
|
112
|
+
|
|
113
|
+
# @!attribute whatsapp_phone_number
|
|
114
|
+
# Direct phone number for WhatsApp sending (optional)
|
|
115
|
+
#
|
|
116
|
+
# @return [String, nil]
|
|
117
|
+
optional :whatsapp_phone_number, String, nil?: true
|
|
118
|
+
|
|
119
|
+
# @!attribute idempotency_key
|
|
120
|
+
#
|
|
121
|
+
# @return [String, nil]
|
|
122
|
+
optional :idempotency_key, String
|
|
123
|
+
|
|
124
|
+
# @!method initialize(allow_contact_sharing: nil, allow_number_change_during_onboarding: nil, allow_template_sharing: nil, billing_model: nil, description: nil, icon: nil, inherit_contacts: nil, inherit_tcr_brand: nil, inherit_tcr_campaign: nil, inherit_templates: nil, name: nil, body_profile_id: nil, sending_phone_number: nil, sending_phone_number_profile_id: nil, sending_whatsapp_number_profile_id: nil, short_name: nil, test_mode: nil, whatsapp_phone_number: nil, idempotency_key: nil, request_options: {})
|
|
125
|
+
# Some parameter documentations has been truncated, see
|
|
126
|
+
# {Sentdm::Models::ProfileUpdateParams} for more details.
|
|
127
|
+
#
|
|
128
|
+
# @param allow_contact_sharing [Boolean, nil] Whether contacts are shared across profiles (optional)
|
|
129
|
+
#
|
|
130
|
+
# @param allow_number_change_during_onboarding [Boolean, nil] Whether number changes are allowed during onboarding (optional)
|
|
131
|
+
#
|
|
132
|
+
# @param allow_template_sharing [Boolean, nil] Whether templates are shared across profiles (optional)
|
|
133
|
+
#
|
|
134
|
+
# @param billing_model [String, nil] Billing model: profile, organization, or profile_and_organization (optional)
|
|
135
|
+
#
|
|
136
|
+
# @param description [String, nil] Profile description (optional)
|
|
137
|
+
#
|
|
138
|
+
# @param icon [String, nil] Profile icon URL (optional)
|
|
139
|
+
#
|
|
140
|
+
# @param inherit_contacts [Boolean, nil] Whether this profile inherits contacts from organization (optional)
|
|
141
|
+
#
|
|
142
|
+
# @param inherit_tcr_brand [Boolean, nil] Whether this profile inherits TCR brand from organization (optional)
|
|
143
|
+
#
|
|
144
|
+
# @param inherit_tcr_campaign [Boolean, nil] Whether this profile inherits TCR campaign from organization (optional)
|
|
145
|
+
#
|
|
146
|
+
# @param inherit_templates [Boolean, nil] Whether this profile inherits templates from organization (optional)
|
|
147
|
+
#
|
|
148
|
+
# @param name [String, nil] Profile name (optional)
|
|
149
|
+
#
|
|
150
|
+
# @param body_profile_id [String] Profile ID from route parameter
|
|
151
|
+
#
|
|
152
|
+
# @param sending_phone_number [String, nil] Direct phone number for SMS sending (optional)
|
|
153
|
+
#
|
|
154
|
+
# @param sending_phone_number_profile_id [String, nil] Reference to another profile to use for SMS/Telnyx configuration (optional)
|
|
155
|
+
#
|
|
156
|
+
# @param sending_whatsapp_number_profile_id [String, nil] Reference to another profile to use for WhatsApp configuration (optional)
|
|
157
|
+
#
|
|
158
|
+
# @param short_name [String, nil] Profile short name/abbreviation (optional)
|
|
159
|
+
#
|
|
160
|
+
# @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
|
|
161
|
+
#
|
|
162
|
+
# @param whatsapp_phone_number [String, nil] Direct phone number for WhatsApp sending (optional)
|
|
163
|
+
#
|
|
164
|
+
# @param idempotency_key [String]
|
|
165
|
+
#
|
|
166
|
+
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
|
|
167
|
+
end
|
|
168
|
+
end
|
|
169
|
+
end
|