sentdm 0.3.1 → 0.5.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 +16 -0
- data/README.md +1 -27
- data/lib/sentdm/client.rb +5 -9
- data/lib/sentdm/internal/type/base_model.rb +5 -5
- data/lib/sentdm/models/api_meta.rb +1 -9
- data/lib/sentdm/models/{api_response_contact.rb → api_response_of_contact.rb} +4 -4
- data/lib/sentdm/models/base_dto.rb +30 -0
- data/lib/sentdm/models/billing_contact_info.rb +47 -0
- data/lib/sentdm/models/brands_brand_data.rb +274 -0
- data/lib/sentdm/models/contact_create_params.rb +13 -6
- data/lib/sentdm/models/contact_delete_params.rb +9 -2
- data/lib/sentdm/models/contact_list_params.rb +10 -2
- data/lib/sentdm/models/contact_list_response.rb +3 -3
- data/lib/sentdm/models/{contact.rb → contact_response.rb} +1 -1
- data/lib/sentdm/models/contact_retrieve_params.rb +7 -1
- data/lib/sentdm/models/contact_update_params.rb +13 -6
- data/lib/sentdm/models/me_retrieve_params.rb +7 -1
- data/lib/sentdm/models/me_retrieve_response.rb +152 -7
- data/lib/sentdm/models/message_retrieve_activities_params.rb +7 -1
- data/lib/sentdm/models/message_retrieve_activities_response.rb +19 -5
- data/lib/sentdm/models/message_retrieve_status_params.rb +7 -1
- data/lib/sentdm/models/message_retrieve_status_response.rb +8 -1
- data/lib/sentdm/models/message_send_params.rb +17 -10
- data/lib/sentdm/models/mutation_request_base.rb +20 -0
- data/lib/sentdm/models/{lookup_retrieve_phone_info_params.rb → number_lookup_params.rb} +9 -3
- data/lib/sentdm/models/{lookup_retrieve_phone_info_response.rb → number_lookup_response.rb} +21 -21
- data/lib/sentdm/models/payment_details.rb +44 -0
- data/lib/sentdm/models/{profile_complete_params.rb → profile_complete_setup_params.rb} +16 -9
- data/lib/sentdm/models/{profile_complete_response.rb → profile_complete_setup_response.rb} +1 -1
- data/lib/sentdm/models/profile_create_params.rb +111 -11
- data/lib/sentdm/models/profile_delete_params.rb +18 -18
- data/lib/sentdm/models/profile_detail.rb +483 -68
- data/lib/sentdm/models/profile_list_params.rb +7 -1
- data/lib/sentdm/models/profile_retrieve_params.rb +7 -1
- data/lib/sentdm/models/profile_update_params.rb +60 -22
- data/lib/sentdm/models/{brands/api_response_tcr_campaign_with_use_cases.rb → profiles/api_response_of_tcr_campaign_with_use_cases.rb} +6 -6
- data/lib/sentdm/models/profiles/campaign_create_params.rb +57 -0
- data/lib/sentdm/models/{brands → profiles}/campaign_data.rb +28 -7
- data/lib/sentdm/models/profiles/campaign_delete_params.rb +50 -0
- data/lib/sentdm/models/profiles/campaign_list_params.rb +28 -0
- data/lib/sentdm/models/{brands → profiles}/campaign_list_response.rb +5 -5
- data/lib/sentdm/models/profiles/campaign_update_params.rb +64 -0
- data/lib/sentdm/models/{brands → profiles}/messaging_use_case_us.rb +1 -1
- data/lib/sentdm/models/{brands → profiles}/tcr_campaign_with_use_cases.rb +15 -15
- data/lib/sentdm/models/template_create_params.rb +17 -10
- data/lib/sentdm/models/template_definition.rb +255 -15
- data/lib/sentdm/models/template_delete_params.rb +13 -6
- data/lib/sentdm/models/template_list_params.rb +18 -2
- data/lib/sentdm/models/template_retrieve_params.rb +7 -1
- data/lib/sentdm/models/template_update_params.rb +17 -10
- data/lib/sentdm/models/template_variable.rb +7 -1
- data/lib/sentdm/models/user_invite_params.rb +13 -6
- data/lib/sentdm/models/user_list_params.rb +7 -1
- data/lib/sentdm/models/user_remove_params.rb +17 -17
- data/lib/sentdm/models/user_retrieve_params.rb +7 -1
- data/lib/sentdm/models/user_update_role_params.rb +15 -16
- data/lib/sentdm/models/webhook_create_params.rb +13 -6
- data/lib/sentdm/models/webhook_delete_params.rb +7 -1
- data/lib/sentdm/models/webhook_list_event_types_params.rb +7 -1
- data/lib/sentdm/models/webhook_list_events_params.rb +7 -1
- data/lib/sentdm/models/webhook_list_params.rb +7 -1
- data/lib/sentdm/models/webhook_retrieve_params.rb +7 -1
- data/lib/sentdm/models/webhook_rotate_secret_params.rb +8 -2
- data/lib/sentdm/models/webhook_test_params.rb +13 -6
- data/lib/sentdm/models/webhook_toggle_status_params.rb +13 -6
- data/lib/sentdm/models/webhook_update_params.rb +13 -6
- data/lib/sentdm/models.rb +14 -38
- data/lib/sentdm/resources/contacts.rb +49 -26
- data/lib/sentdm/resources/me.rb +24 -5
- data/lib/sentdm/resources/messages.rb +24 -8
- data/lib/sentdm/resources/numbers.rb +44 -0
- data/lib/sentdm/resources/profiles/campaigns.rb +160 -0
- data/lib/sentdm/resources/profiles.rb +125 -36
- data/lib/sentdm/resources/templates.rb +47 -24
- data/lib/sentdm/resources/users.rb +40 -23
- data/lib/sentdm/resources/webhooks.rb +92 -34
- data/lib/sentdm/version.rb +1 -1
- data/lib/sentdm.rb +22 -35
- data/rbi/sentdm/client.rbi +4 -7
- data/rbi/sentdm/models/api_meta.rbi +4 -18
- data/rbi/sentdm/models/{api_response_brand_with_kyc.rbi → api_response_of_contact.rbi} +6 -6
- data/rbi/sentdm/models/base_dto.rbi +49 -0
- data/rbi/sentdm/models/billing_contact_info.rbi +65 -0
- data/rbi/sentdm/models/brands_brand_data.rbi +406 -0
- data/rbi/sentdm/models/contact_create_params.rbi +19 -10
- data/rbi/sentdm/models/contact_delete_params.rbi +10 -1
- data/rbi/sentdm/models/contact_list_params.rbi +11 -0
- data/rbi/sentdm/models/contact_list_response.rbi +4 -4
- data/rbi/sentdm/models/{contact.rbi → contact_response.rbi} +4 -2
- data/rbi/sentdm/models/contact_retrieve_params.rbi +13 -2
- data/rbi/sentdm/models/contact_update_params.rbi +19 -10
- data/rbi/sentdm/models/me_retrieve_params.rbi +16 -5
- data/rbi/sentdm/models/me_retrieve_response.rbi +316 -16
- data/rbi/sentdm/models/message_retrieve_activities_params.rbi +13 -2
- data/rbi/sentdm/models/message_retrieve_activities_response.rbi +18 -6
- data/rbi/sentdm/models/message_retrieve_status_params.rbi +13 -2
- data/rbi/sentdm/models/message_retrieve_status_response.rbi +6 -0
- data/rbi/sentdm/models/message_send_params.rbi +22 -13
- data/rbi/sentdm/models/mutation_request_base.rbi +32 -0
- data/rbi/sentdm/models/{lookup_retrieve_phone_info_params.rbi → number_lookup_params.rbi} +15 -7
- data/rbi/sentdm/models/{lookup_retrieve_phone_info_response.rbi → number_lookup_response.rbi} +16 -33
- data/rbi/sentdm/models/payment_details.rbi +59 -0
- data/rbi/sentdm/models/{profile_complete_params.rbi → profile_complete_setup_params.rbi} +21 -12
- data/rbi/sentdm/models/{profile_complete_response.rbi → profile_complete_setup_response.rbi} +1 -1
- data/rbi/sentdm/models/profile_create_params.rbi +189 -15
- data/rbi/sentdm/models/profile_delete_params.rbi +36 -24
- data/rbi/sentdm/models/profile_detail.rbi +725 -111
- data/rbi/sentdm/models/profile_list_params.rbi +16 -5
- data/rbi/sentdm/models/profile_retrieve_params.rbi +13 -2
- data/rbi/sentdm/models/profile_update_params.rbi +97 -30
- data/rbi/sentdm/models/{brands/api_response_tcr_campaign_with_use_cases.rbi → profiles/api_response_of_tcr_campaign_with_use_cases.rbi} +7 -7
- data/rbi/sentdm/models/{brands → profiles}/campaign_create_params.rbi +29 -20
- data/rbi/sentdm/models/{brands → profiles}/campaign_data.rbi +51 -16
- data/rbi/sentdm/models/{brands → profiles}/campaign_delete_params.rbi +23 -12
- data/rbi/sentdm/models/profiles/campaign_list_params.rbi +51 -0
- data/rbi/sentdm/models/{brands → profiles}/campaign_list_response.rbi +7 -5
- data/rbi/sentdm/models/{brands → profiles}/campaign_update_params.rbi +29 -20
- data/rbi/sentdm/models/{brands → profiles}/messaging_use_case_us.rbi +20 -16
- data/rbi/sentdm/models/{brands → profiles}/tcr_campaign_with_use_cases.rbi +35 -29
- data/rbi/sentdm/models/template_create_params.rbi +22 -13
- data/rbi/sentdm/models/template_definition.rbi +405 -74
- data/rbi/sentdm/models/template_delete_params.rbi +19 -10
- data/rbi/sentdm/models/template_list_params.rbi +19 -0
- data/rbi/sentdm/models/template_retrieve_params.rbi +13 -2
- data/rbi/sentdm/models/template_update_params.rbi +22 -13
- data/rbi/sentdm/models/template_variable.rbi +6 -0
- data/rbi/sentdm/models/user_invite_params.rbi +19 -10
- data/rbi/sentdm/models/user_list_params.rbi +16 -5
- data/rbi/sentdm/models/user_remove_params.rbi +35 -23
- data/rbi/sentdm/models/user_retrieve_params.rbi +13 -2
- data/rbi/sentdm/models/user_update_role_params.rbi +23 -25
- data/rbi/sentdm/models/webhook_create_params.rbi +19 -10
- data/rbi/sentdm/models/webhook_delete_params.rbi +13 -2
- data/rbi/sentdm/models/webhook_list_event_types_params.rbi +16 -5
- data/rbi/sentdm/models/webhook_list_events_params.rbi +16 -1
- data/rbi/sentdm/models/webhook_list_params.rbi +9 -0
- data/rbi/sentdm/models/webhook_retrieve_params.rbi +13 -2
- data/rbi/sentdm/models/webhook_rotate_secret_params.rbi +16 -2
- data/rbi/sentdm/models/webhook_test_params.rbi +19 -10
- data/rbi/sentdm/models/webhook_toggle_status_params.rbi +19 -10
- data/rbi/sentdm/models/webhook_update_params.rbi +19 -10
- data/rbi/sentdm/models.rbi +14 -38
- data/rbi/sentdm/resources/contacts.rbi +40 -15
- data/rbi/sentdm/resources/me.rbi +25 -7
- data/rbi/sentdm/resources/messages.rbi +17 -4
- data/rbi/sentdm/resources/numbers.rbi +32 -0
- data/rbi/sentdm/resources/profiles/campaigns.rbi +127 -0
- data/rbi/sentdm/resources/profiles.rbi +179 -39
- data/rbi/sentdm/resources/templates.rbi +47 -19
- data/rbi/sentdm/resources/users.rbi +47 -25
- data/rbi/sentdm/resources/webhooks.rbi +92 -20
- data/sig/sentdm/client.rbs +2 -4
- data/sig/sentdm/models/api_meta.rbs +2 -16
- data/sig/sentdm/models/{api_response_contact.rbs → api_response_of_contact.rbs} +6 -6
- data/sig/sentdm/models/base_dto.rbs +25 -0
- data/sig/sentdm/models/billing_contact_info.rbs +30 -0
- data/sig/sentdm/models/brands_brand_data.rbs +210 -0
- data/sig/sentdm/models/contact_create_params.rbs +16 -5
- data/sig/sentdm/models/contact_delete_params.rbs +12 -2
- data/sig/sentdm/models/contact_list_params.rbs +8 -1
- data/sig/sentdm/models/contact_list_response.rbs +7 -5
- data/sig/sentdm/models/{contact.rbs → contact_response.rbs} +2 -2
- data/sig/sentdm/models/contact_retrieve_params.rbs +12 -2
- data/sig/sentdm/models/contact_update_params.rbs +13 -6
- data/sig/sentdm/models/me_retrieve_params.rbs +14 -3
- data/sig/sentdm/models/me_retrieve_response.rbs +134 -7
- data/sig/sentdm/models/message_retrieve_activities_params.rbs +12 -2
- data/sig/sentdm/models/message_retrieve_activities_response.rbs +9 -4
- data/sig/sentdm/models/message_retrieve_status_params.rbs +12 -2
- data/sig/sentdm/models/message_retrieve_status_response.rbs +5 -0
- data/sig/sentdm/models/message_send_params.rbs +15 -8
- data/sig/sentdm/models/mutation_request_base.rbs +15 -0
- data/sig/sentdm/models/{lookup_retrieve_phone_info_params.rbs → number_lookup_params.rbs} +10 -3
- data/sig/sentdm/models/{lookup_retrieve_phone_info_response.rbs → number_lookup_response.rbs} +14 -16
- data/sig/sentdm/models/payment_details.rbs +30 -0
- data/sig/sentdm/models/{profile_complete_params.rbs → profile_complete_setup_params.rbs} +15 -8
- data/sig/sentdm/models/profile_complete_setup_response.rbs +5 -0
- data/sig/sentdm/models/profile_create_params.rbs +57 -7
- data/sig/sentdm/models/profile_delete_params.rbs +23 -13
- data/sig/sentdm/models/profile_detail.rbs +374 -68
- data/sig/sentdm/models/profile_list_params.rbs +14 -3
- data/sig/sentdm/models/profile_retrieve_params.rbs +8 -1
- data/sig/sentdm/models/profile_update_params.rbs +32 -17
- data/sig/sentdm/models/{brands/api_response_tcr_campaign_with_use_cases.rbs → profiles/api_response_of_tcr_campaign_with_use_cases.rbs} +7 -7
- data/sig/sentdm/models/profiles/campaign_create_params.rbs +54 -0
- data/sig/sentdm/models/{brands → profiles}/campaign_data.rbs +27 -5
- data/sig/sentdm/models/{brands → profiles}/campaign_delete_params.rbs +17 -10
- data/sig/sentdm/models/{brands → profiles}/campaign_list_params.rbs +12 -5
- data/sig/sentdm/models/{brands → profiles}/campaign_list_response.rbs +5 -5
- data/sig/sentdm/models/{brands → profiles}/campaign_update_params.rbs +22 -15
- data/sig/sentdm/models/{brands → profiles}/messaging_use_case_us.rbs +2 -2
- data/sig/sentdm/models/{brands → profiles}/tcr_campaign_with_use_cases.rbs +29 -29
- data/sig/sentdm/models/template_create_params.rbs +15 -8
- data/sig/sentdm/models/template_definition.rbs +233 -20
- data/sig/sentdm/models/template_delete_params.rbs +16 -5
- data/sig/sentdm/models/template_list_params.rbs +13 -1
- data/sig/sentdm/models/template_retrieve_params.rbs +12 -2
- data/sig/sentdm/models/template_update_params.rbs +15 -8
- data/sig/sentdm/models/template_variable.rbs +5 -0
- data/sig/sentdm/models/user_invite_params.rbs +13 -6
- data/sig/sentdm/models/user_list_params.rbs +14 -3
- data/sig/sentdm/models/user_remove_params.rbs +23 -13
- data/sig/sentdm/models/user_retrieve_params.rbs +8 -1
- data/sig/sentdm/models/user_update_role_params.rbs +17 -17
- data/sig/sentdm/models/webhook_create_params.rbs +13 -6
- data/sig/sentdm/models/webhook_delete_params.rbs +12 -2
- data/sig/sentdm/models/webhook_list_event_types_params.rbs +13 -3
- data/sig/sentdm/models/webhook_list_events_params.rbs +13 -1
- data/sig/sentdm/models/webhook_list_params.rbs +13 -1
- data/sig/sentdm/models/webhook_retrieve_params.rbs +12 -2
- data/sig/sentdm/models/webhook_rotate_secret_params.rbs +9 -2
- data/sig/sentdm/models/webhook_test_params.rbs +13 -6
- data/sig/sentdm/models/webhook_toggle_status_params.rbs +17 -5
- data/sig/sentdm/models/webhook_update_params.rbs +13 -6
- data/sig/sentdm/models.rbs +14 -32
- data/sig/sentdm/resources/contacts.rbs +10 -5
- data/sig/sentdm/resources/me.rbs +1 -0
- data/sig/sentdm/resources/messages.rbs +4 -1
- data/sig/sentdm/resources/{lookup.rbs → numbers.rbs} +4 -3
- data/sig/sentdm/resources/profiles/campaigns.rbs +42 -0
- data/sig/sentdm/resources/profiles.rbs +22 -9
- data/sig/sentdm/resources/templates.rbs +9 -3
- data/sig/sentdm/resources/users.rbs +10 -7
- data/sig/sentdm/resources/webhooks.rbs +18 -5
- metadata +67 -106
- data/lib/sentdm/models/api_response_brand_with_kyc.rb +0 -43
- data/lib/sentdm/models/brand_create_params.rb +0 -41
- data/lib/sentdm/models/brand_data.rb +0 -237
- data/lib/sentdm/models/brand_delete_params.rb +0 -34
- data/lib/sentdm/models/brand_list_params.rb +0 -14
- data/lib/sentdm/models/brand_list_response.rb +0 -43
- data/lib/sentdm/models/brand_update_params.rb +0 -48
- data/lib/sentdm/models/brand_with_kyc.rb +0 -335
- data/lib/sentdm/models/brands/base_dto.rb +0 -32
- data/lib/sentdm/models/brands/campaign_create_params.rb +0 -50
- data/lib/sentdm/models/brands/campaign_delete_params.rb +0 -43
- data/lib/sentdm/models/brands/campaign_list_params.rb +0 -22
- data/lib/sentdm/models/brands/campaign_update_params.rb +0 -57
- data/lib/sentdm/models/brands/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rb +0 -30
- data/lib/sentdm/models/mutation_request.rb +0 -20
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rb +0 -34
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rb +0 -40
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rb +0 -38
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rb +0 -81
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rb +0 -34
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rb +0 -39
- data/lib/sentdm/resources/brands/campaigns.rb +0 -145
- data/lib/sentdm/resources/brands.rb +0 -130
- data/lib/sentdm/resources/lookup.rb +0 -35
- data/rbi/sentdm/models/api_response_contact.rbi +0 -74
- data/rbi/sentdm/models/brand_create_params.rbi +0 -68
- data/rbi/sentdm/models/brand_data.rbi +0 -266
- data/rbi/sentdm/models/brand_delete_params.rbi +0 -68
- data/rbi/sentdm/models/brand_list_params.rbi +0 -27
- data/rbi/sentdm/models/brand_list_response.rbi +0 -71
- data/rbi/sentdm/models/brand_update_params.rbi +0 -74
- data/rbi/sentdm/models/brand_with_kyc.rbi +0 -398
- data/rbi/sentdm/models/brands/base_dto.rbi +0 -53
- data/rbi/sentdm/models/brands/campaign_list_params.rbi +0 -37
- data/rbi/sentdm/models/brands/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbi +0 -52
- data/rbi/sentdm/models/mutation_request.rbi +0 -32
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rbi +0 -56
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rbi +0 -76
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rbi +0 -79
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rbi +0 -104
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rbi +0 -60
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rbi +0 -62
- data/rbi/sentdm/resources/brands/campaigns.rbi +0 -109
- data/rbi/sentdm/resources/brands.rbi +0 -95
- data/rbi/sentdm/resources/lookup.rbi +0 -24
- data/sig/sentdm/models/api_response_brand_with_kyc.rbs +0 -39
- data/sig/sentdm/models/brand_create_params.rbs +0 -36
- data/sig/sentdm/models/brand_data.rbs +0 -164
- data/sig/sentdm/models/brand_delete_params.rbs +0 -36
- data/sig/sentdm/models/brand_list_params.rbs +0 -14
- data/sig/sentdm/models/brand_list_response.rbs +0 -39
- data/sig/sentdm/models/brand_update_params.rbs +0 -45
- data/sig/sentdm/models/brand_with_kyc.rbs +0 -237
- data/sig/sentdm/models/brands/base_dto.rbs +0 -27
- data/sig/sentdm/models/brands/campaign_create_params.rbs +0 -47
- data/sig/sentdm/models/brands/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbs +0 -27
- data/sig/sentdm/models/mutation_request.rbs +0 -15
- data/sig/sentdm/models/profile_complete_response.rbs +0 -5
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rbs +0 -24
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rbs +0 -30
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rbs +0 -38
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rbs +0 -75
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rbs +0 -32
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rbs +0 -32
- data/sig/sentdm/resources/brands/campaigns.rbs +0 -38
- data/sig/sentdm/resources/brands.rbs +0 -34
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: b04e02de625816b5c8b0b5a02ecedc198dc33f346277ebaebca6e26e8df61844
|
|
4
|
+
data.tar.gz: cb8626c2a126335a92cea456679fdb2d5865fbecbb391e6634d00b932cde65d4
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7a1eec1d9dfd462eefddb941989e06e7af9ed1e2a3fd9a84fca256af193711b0443c7dbbca66db20963722c630e34854207489842f21d8ab4fd4f174118a6178
|
|
7
|
+
data.tar.gz: d291e1ace6701e0ef970dc044aa629847472273a9ec1b422456eba805db7f4b45358ea0b71fba71f166392f20c0e4b37a20d4c23b5339ed9d55c29980defd60a
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.5.0 (2026-03-11)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.4.0...v0.5.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.4.0...v0.5.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** manual updates ([bdd5b4e](https://github.com/sentdm/sent-dm-ruby/commit/bdd5b4efe70096707888663254558a55d1a3c03b))
|
|
10
|
+
|
|
11
|
+
## 0.4.0 (2026-03-11)
|
|
12
|
+
|
|
13
|
+
Full Changelog: [v0.3.1...v0.4.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.3.1...v0.4.0)
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
|
|
17
|
+
* **api:** api update ([bd1c867](https://github.com/sentdm/sent-dm-ruby/commit/bd1c86786ab541d177d0dab68b56a584becadafd))
|
|
18
|
+
|
|
3
19
|
## 0.3.1 (2026-03-11)
|
|
4
20
|
|
|
5
21
|
Full Changelog: [v0.3.0...v0.3.1](https://github.com/sentdm/sent-dm-ruby/compare/v0.3.0...v0.3.1)
|
data/README.md
CHANGED
|
@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
|
|
|
26
26
|
<!-- x-release-please-start-version -->
|
|
27
27
|
|
|
28
28
|
```ruby
|
|
29
|
-
gem "sentdm", "~> 0.
|
|
29
|
+
gem "sentdm", "~> 0.5.0"
|
|
30
30
|
```
|
|
31
31
|
|
|
32
32
|
<!-- x-release-please-end -->
|
|
@@ -265,32 +265,6 @@ params = Sentdm::MessageSendParams.new(
|
|
|
265
265
|
sent_dm.messages.send_(**params)
|
|
266
266
|
```
|
|
267
267
|
|
|
268
|
-
### Enums
|
|
269
|
-
|
|
270
|
-
Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
|
|
271
|
-
|
|
272
|
-
```ruby
|
|
273
|
-
# :BASIC_ACCOUNT
|
|
274
|
-
puts(Sentdm::TcrBrandRelationship::BASIC_ACCOUNT)
|
|
275
|
-
|
|
276
|
-
# Revealed type: `T.all(Sentdm::TcrBrandRelationship, Symbol)`
|
|
277
|
-
T.reveal_type(Sentdm::TcrBrandRelationship::BASIC_ACCOUNT)
|
|
278
|
-
```
|
|
279
|
-
|
|
280
|
-
Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
|
|
281
|
-
|
|
282
|
-
```ruby
|
|
283
|
-
Sentdm::BrandData.new(
|
|
284
|
-
brand_relationship: Sentdm::TcrBrandRelationship::BASIC_ACCOUNT,
|
|
285
|
-
# …
|
|
286
|
-
)
|
|
287
|
-
|
|
288
|
-
Sentdm::BrandData.new(
|
|
289
|
-
brand_relationship: :BASIC_ACCOUNT,
|
|
290
|
-
# …
|
|
291
|
-
)
|
|
292
|
-
```
|
|
293
|
-
|
|
294
268
|
## Versioning
|
|
295
269
|
|
|
296
270
|
This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.
|
data/lib/sentdm/client.rb
CHANGED
|
@@ -36,21 +36,18 @@ module Sentdm
|
|
|
36
36
|
# @return [Sentdm::Resources::Profiles]
|
|
37
37
|
attr_reader :profiles
|
|
38
38
|
|
|
39
|
+
# Manage and lookup phone numbers
|
|
40
|
+
# @return [Sentdm::Resources::Numbers]
|
|
41
|
+
attr_reader :numbers
|
|
42
|
+
|
|
39
43
|
# Send and track SMS and WhatsApp messages
|
|
40
44
|
# @return [Sentdm::Resources::Messages]
|
|
41
45
|
attr_reader :messages
|
|
42
46
|
|
|
43
|
-
# @return [Sentdm::Resources::Lookup]
|
|
44
|
-
attr_reader :lookup
|
|
45
|
-
|
|
46
47
|
# Create, update, and manage customer contact lists
|
|
47
48
|
# @return [Sentdm::Resources::Contacts]
|
|
48
49
|
attr_reader :contacts
|
|
49
50
|
|
|
50
|
-
# Register and manage 10DLC brands for SMS compliance
|
|
51
|
-
# @return [Sentdm::Resources::Brands]
|
|
52
|
-
attr_reader :brands
|
|
53
|
-
|
|
54
51
|
# Retrieve account details
|
|
55
52
|
# @return [Sentdm::Resources::Me]
|
|
56
53
|
attr_reader :me
|
|
@@ -106,10 +103,9 @@ module Sentdm
|
|
|
106
103
|
@users = Sentdm::Resources::Users.new(client: self)
|
|
107
104
|
@templates = Sentdm::Resources::Templates.new(client: self)
|
|
108
105
|
@profiles = Sentdm::Resources::Profiles.new(client: self)
|
|
106
|
+
@numbers = Sentdm::Resources::Numbers.new(client: self)
|
|
109
107
|
@messages = Sentdm::Resources::Messages.new(client: self)
|
|
110
|
-
@lookup = Sentdm::Resources::Lookup.new(client: self)
|
|
111
108
|
@contacts = Sentdm::Resources::Contacts.new(client: self)
|
|
112
|
-
@brands = Sentdm::Resources::Brands.new(client: self)
|
|
113
109
|
@me = Sentdm::Resources::Me.new(client: self)
|
|
114
110
|
end
|
|
115
111
|
end
|
|
@@ -438,11 +438,11 @@ module Sentdm
|
|
|
438
438
|
# @return [Hash{Symbol=>Object}]
|
|
439
439
|
#
|
|
440
440
|
# @example
|
|
441
|
-
# # `
|
|
442
|
-
#
|
|
443
|
-
#
|
|
444
|
-
#
|
|
445
|
-
#
|
|
441
|
+
# # `base_dto` is a `Sentdm::BaseDto`
|
|
442
|
+
# base_dto => {
|
|
443
|
+
# id: id,
|
|
444
|
+
# created_at: created_at,
|
|
445
|
+
# updated_at: updated_at
|
|
446
446
|
# }
|
|
447
447
|
def deconstruct_keys(keys)
|
|
448
448
|
(keys || self.class.known_fields.keys)
|
|
@@ -9,12 +9,6 @@ module Sentdm
|
|
|
9
9
|
# @return [String, nil]
|
|
10
10
|
optional :request_id, String
|
|
11
11
|
|
|
12
|
-
# @!attribute response_time_ms
|
|
13
|
-
# Response time in milliseconds (optional)
|
|
14
|
-
#
|
|
15
|
-
# @return [Integer, nil]
|
|
16
|
-
optional :response_time_ms, Integer, nil?: true
|
|
17
|
-
|
|
18
12
|
# @!attribute timestamp
|
|
19
13
|
# Server timestamp when the response was generated
|
|
20
14
|
#
|
|
@@ -27,13 +21,11 @@ module Sentdm
|
|
|
27
21
|
# @return [String, nil]
|
|
28
22
|
optional :version, String
|
|
29
23
|
|
|
30
|
-
# @!method initialize(request_id: nil,
|
|
24
|
+
# @!method initialize(request_id: nil, timestamp: nil, version: nil)
|
|
31
25
|
# Request and response metadata
|
|
32
26
|
#
|
|
33
27
|
# @param request_id [String] Unique identifier for this request (for tracing and support)
|
|
34
28
|
#
|
|
35
|
-
# @param response_time_ms [Integer, nil] Response time in milliseconds (optional)
|
|
36
|
-
#
|
|
37
29
|
# @param timestamp [Time] Server timestamp when the response was generated
|
|
38
30
|
#
|
|
39
31
|
# @param version [String] API version used for this request
|
|
@@ -3,12 +3,12 @@
|
|
|
3
3
|
module Sentdm
|
|
4
4
|
module Models
|
|
5
5
|
# @see Sentdm::Resources::Contacts#create
|
|
6
|
-
class
|
|
6
|
+
class APIResponseOfContact < Sentdm::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute data
|
|
8
8
|
# The response data (null if error)
|
|
9
9
|
#
|
|
10
|
-
# @return [Sentdm::Models::
|
|
11
|
-
optional :data, -> { Sentdm::
|
|
10
|
+
# @return [Sentdm::Models::ContactResponse, nil]
|
|
11
|
+
optional :data, -> { Sentdm::ContactResponse }, nil?: true
|
|
12
12
|
|
|
13
13
|
# @!attribute error
|
|
14
14
|
# Error details (null if successful)
|
|
@@ -31,7 +31,7 @@ module Sentdm
|
|
|
31
31
|
# @!method initialize(data: nil, error: nil, meta: nil, success: nil)
|
|
32
32
|
# Standard API response envelope for all v3 endpoints
|
|
33
33
|
#
|
|
34
|
-
# @param data [Sentdm::Models::
|
|
34
|
+
# @param data [Sentdm::Models::ContactResponse, nil] The response data (null if error)
|
|
35
35
|
#
|
|
36
36
|
# @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
|
|
37
37
|
#
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
class BaseDto < Sentdm::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute id
|
|
7
|
+
# Unique identifier
|
|
8
|
+
#
|
|
9
|
+
# @return [String, nil]
|
|
10
|
+
optional :id, String
|
|
11
|
+
|
|
12
|
+
# @!attribute created_at
|
|
13
|
+
#
|
|
14
|
+
# @return [Time, nil]
|
|
15
|
+
optional :created_at, Time, api_name: :createdAt
|
|
16
|
+
|
|
17
|
+
# @!attribute updated_at
|
|
18
|
+
#
|
|
19
|
+
# @return [Time, nil]
|
|
20
|
+
optional :updated_at, Time, api_name: :updatedAt, nil?: true
|
|
21
|
+
|
|
22
|
+
# @!method initialize(id: nil, created_at: nil, updated_at: nil)
|
|
23
|
+
# @param id [String] Unique identifier
|
|
24
|
+
#
|
|
25
|
+
# @param created_at [Time]
|
|
26
|
+
#
|
|
27
|
+
# @param updated_at [Time, nil]
|
|
28
|
+
end
|
|
29
|
+
end
|
|
30
|
+
end
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
class BillingContactInfo < Sentdm::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute email
|
|
7
|
+
# Email address where invoices will be sent (required)
|
|
8
|
+
#
|
|
9
|
+
# @return [String]
|
|
10
|
+
required :email, String
|
|
11
|
+
|
|
12
|
+
# @!attribute name
|
|
13
|
+
# Full name of the billing contact or company (required)
|
|
14
|
+
#
|
|
15
|
+
# @return [String]
|
|
16
|
+
required :name, String
|
|
17
|
+
|
|
18
|
+
# @!attribute address
|
|
19
|
+
# Billing address (optional). Free-form text including street, city, state, postal
|
|
20
|
+
# code, and country.
|
|
21
|
+
#
|
|
22
|
+
# @return [String, nil]
|
|
23
|
+
optional :address, String, nil?: true
|
|
24
|
+
|
|
25
|
+
# @!attribute phone
|
|
26
|
+
# Phone number for the billing contact (optional)
|
|
27
|
+
#
|
|
28
|
+
# @return [String, nil]
|
|
29
|
+
optional :phone, String, nil?: true
|
|
30
|
+
|
|
31
|
+
# @!method initialize(email:, name:, address: nil, phone: nil)
|
|
32
|
+
# Some parameter documentations has been truncated, see
|
|
33
|
+
# {Sentdm::Models::BillingContactInfo} for more details.
|
|
34
|
+
#
|
|
35
|
+
# Billing contact information for a profile. Required when billing_model is
|
|
36
|
+
# "profile" or "profile_and_organization".
|
|
37
|
+
#
|
|
38
|
+
# @param email [String] Email address where invoices will be sent (required)
|
|
39
|
+
#
|
|
40
|
+
# @param name [String] Full name of the billing contact or company (required)
|
|
41
|
+
#
|
|
42
|
+
# @param address [String, nil] Billing address (optional). Free-form text including street, city, state, postal
|
|
43
|
+
#
|
|
44
|
+
# @param phone [String, nil] Phone number for the billing contact (optional)
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
end
|
|
@@ -0,0 +1,274 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
class BrandsBrandData < Sentdm::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute compliance
|
|
7
|
+
# Compliance and TCR-related information
|
|
8
|
+
#
|
|
9
|
+
# @return [Sentdm::Models::BrandsBrandData::Compliance]
|
|
10
|
+
required :compliance, -> { Sentdm::BrandsBrandData::Compliance }
|
|
11
|
+
|
|
12
|
+
# @!attribute contact
|
|
13
|
+
# Contact information for the brand
|
|
14
|
+
#
|
|
15
|
+
# @return [Sentdm::Models::BrandsBrandData::Contact]
|
|
16
|
+
required :contact, -> { Sentdm::BrandsBrandData::Contact }
|
|
17
|
+
|
|
18
|
+
# @!attribute business
|
|
19
|
+
# Business details and address information
|
|
20
|
+
#
|
|
21
|
+
# @return [Sentdm::Models::BrandsBrandData::Business, nil]
|
|
22
|
+
optional :business, -> { Sentdm::BrandsBrandData::Business }, nil?: true
|
|
23
|
+
|
|
24
|
+
# @!method initialize(compliance:, contact:, business: nil)
|
|
25
|
+
# Brand and KYC data grouped into contact, business, and compliance sections
|
|
26
|
+
#
|
|
27
|
+
# @param compliance [Sentdm::Models::BrandsBrandData::Compliance] Compliance and TCR-related information
|
|
28
|
+
#
|
|
29
|
+
# @param contact [Sentdm::Models::BrandsBrandData::Contact] Contact information for the brand
|
|
30
|
+
#
|
|
31
|
+
# @param business [Sentdm::Models::BrandsBrandData::Business, nil] Business details and address information
|
|
32
|
+
|
|
33
|
+
# @see Sentdm::Models::BrandsBrandData#compliance
|
|
34
|
+
class Compliance < Sentdm::Internal::Type::BaseModel
|
|
35
|
+
# @!attribute brand_relationship
|
|
36
|
+
# Brand relationship level with TCR (required for TCR)
|
|
37
|
+
#
|
|
38
|
+
# @return [Symbol, Sentdm::Models::TcrBrandRelationship]
|
|
39
|
+
required :brand_relationship, enum: -> { Sentdm::TcrBrandRelationship }, api_name: :brandRelationship
|
|
40
|
+
|
|
41
|
+
# @!attribute vertical
|
|
42
|
+
# Business vertical/industry category (required for TCR)
|
|
43
|
+
#
|
|
44
|
+
# @return [Symbol, Sentdm::Models::TcrVertical]
|
|
45
|
+
required :vertical, enum: -> { Sentdm::TcrVertical }
|
|
46
|
+
|
|
47
|
+
# @!attribute destination_countries
|
|
48
|
+
# List of destination countries for messaging
|
|
49
|
+
#
|
|
50
|
+
# @return [Array<Sentdm::Models::DestinationCountry>, nil]
|
|
51
|
+
optional :destination_countries,
|
|
52
|
+
-> { Sentdm::Internal::Type::ArrayOf[Sentdm::DestinationCountry] },
|
|
53
|
+
api_name: :destinationCountries,
|
|
54
|
+
nil?: true
|
|
55
|
+
|
|
56
|
+
# @!attribute expected_messaging_volume
|
|
57
|
+
# Expected daily messaging volume
|
|
58
|
+
#
|
|
59
|
+
# @return [String, nil]
|
|
60
|
+
optional :expected_messaging_volume, String, api_name: :expectedMessagingVolume, nil?: true
|
|
61
|
+
|
|
62
|
+
# @!attribute is_tcr_application
|
|
63
|
+
# Whether this is a TCR (Campaign Registry) application
|
|
64
|
+
#
|
|
65
|
+
# @return [Boolean, nil]
|
|
66
|
+
optional :is_tcr_application, Sentdm::Internal::Type::Boolean, api_name: :isTcrApplication, nil?: true
|
|
67
|
+
|
|
68
|
+
# @!attribute notes
|
|
69
|
+
# Additional notes about the business or use case
|
|
70
|
+
#
|
|
71
|
+
# @return [String, nil]
|
|
72
|
+
optional :notes, String, nil?: true
|
|
73
|
+
|
|
74
|
+
# @!attribute phone_number_prefix
|
|
75
|
+
# Phone number prefix for messaging (e.g., "+1")
|
|
76
|
+
#
|
|
77
|
+
# @return [String, nil]
|
|
78
|
+
optional :phone_number_prefix, String, api_name: :phoneNumberPrefix, nil?: true
|
|
79
|
+
|
|
80
|
+
# @!attribute primary_use_case
|
|
81
|
+
# Primary messaging use case description
|
|
82
|
+
#
|
|
83
|
+
# @return [String, nil]
|
|
84
|
+
optional :primary_use_case, String, api_name: :primaryUseCase, nil?: true
|
|
85
|
+
|
|
86
|
+
# @!method initialize(brand_relationship:, vertical:, destination_countries: nil, expected_messaging_volume: nil, is_tcr_application: nil, notes: nil, phone_number_prefix: nil, primary_use_case: nil)
|
|
87
|
+
# Compliance and TCR-related information
|
|
88
|
+
#
|
|
89
|
+
# @param brand_relationship [Symbol, Sentdm::Models::TcrBrandRelationship] Brand relationship level with TCR (required for TCR)
|
|
90
|
+
#
|
|
91
|
+
# @param vertical [Symbol, Sentdm::Models::TcrVertical] Business vertical/industry category (required for TCR)
|
|
92
|
+
#
|
|
93
|
+
# @param destination_countries [Array<Sentdm::Models::DestinationCountry>, nil] List of destination countries for messaging
|
|
94
|
+
#
|
|
95
|
+
# @param expected_messaging_volume [String, nil] Expected daily messaging volume
|
|
96
|
+
#
|
|
97
|
+
# @param is_tcr_application [Boolean, nil] Whether this is a TCR (Campaign Registry) application
|
|
98
|
+
#
|
|
99
|
+
# @param notes [String, nil] Additional notes about the business or use case
|
|
100
|
+
#
|
|
101
|
+
# @param phone_number_prefix [String, nil] Phone number prefix for messaging (e.g., "+1")
|
|
102
|
+
#
|
|
103
|
+
# @param primary_use_case [String, nil] Primary messaging use case description
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
# @see Sentdm::Models::BrandsBrandData#contact
|
|
107
|
+
class Contact < Sentdm::Internal::Type::BaseModel
|
|
108
|
+
# @!attribute name
|
|
109
|
+
# Primary contact name (required)
|
|
110
|
+
#
|
|
111
|
+
# @return [String]
|
|
112
|
+
required :name, String
|
|
113
|
+
|
|
114
|
+
# @!attribute business_name
|
|
115
|
+
# Business/brand name
|
|
116
|
+
#
|
|
117
|
+
# @return [String, nil]
|
|
118
|
+
optional :business_name, String, api_name: :businessName, nil?: true
|
|
119
|
+
|
|
120
|
+
# @!attribute email
|
|
121
|
+
# Contact email address
|
|
122
|
+
#
|
|
123
|
+
# @return [String, nil]
|
|
124
|
+
optional :email, String, nil?: true
|
|
125
|
+
|
|
126
|
+
# @!attribute phone
|
|
127
|
+
# Contact phone number in E.164 format
|
|
128
|
+
#
|
|
129
|
+
# @return [String, nil]
|
|
130
|
+
optional :phone, String, nil?: true
|
|
131
|
+
|
|
132
|
+
# @!attribute phone_country_code
|
|
133
|
+
# Contact phone country code (e.g., "1" for US)
|
|
134
|
+
#
|
|
135
|
+
# @return [String, nil]
|
|
136
|
+
optional :phone_country_code, String, api_name: :phoneCountryCode, nil?: true
|
|
137
|
+
|
|
138
|
+
# @!attribute role
|
|
139
|
+
# Contact's role in the business
|
|
140
|
+
#
|
|
141
|
+
# @return [String, nil]
|
|
142
|
+
optional :role, String, nil?: true
|
|
143
|
+
|
|
144
|
+
# @!method initialize(name:, business_name: nil, email: nil, phone: nil, phone_country_code: nil, role: nil)
|
|
145
|
+
# Contact information for the brand
|
|
146
|
+
#
|
|
147
|
+
# @param name [String] Primary contact name (required)
|
|
148
|
+
#
|
|
149
|
+
# @param business_name [String, nil] Business/brand name
|
|
150
|
+
#
|
|
151
|
+
# @param email [String, nil] Contact email address
|
|
152
|
+
#
|
|
153
|
+
# @param phone [String, nil] Contact phone number in E.164 format
|
|
154
|
+
#
|
|
155
|
+
# @param phone_country_code [String, nil] Contact phone country code (e.g., "1" for US)
|
|
156
|
+
#
|
|
157
|
+
# @param role [String, nil] Contact's role in the business
|
|
158
|
+
end
|
|
159
|
+
|
|
160
|
+
# @see Sentdm::Models::BrandsBrandData#business
|
|
161
|
+
class Business < Sentdm::Internal::Type::BaseModel
|
|
162
|
+
# @!attribute city
|
|
163
|
+
# City
|
|
164
|
+
#
|
|
165
|
+
# @return [String, nil]
|
|
166
|
+
optional :city, String, nil?: true
|
|
167
|
+
|
|
168
|
+
# @!attribute country
|
|
169
|
+
# Country code (e.g., US, CA)
|
|
170
|
+
#
|
|
171
|
+
# @return [String, nil]
|
|
172
|
+
optional :country, String, nil?: true
|
|
173
|
+
|
|
174
|
+
# @!attribute country_of_registration
|
|
175
|
+
# Country where the business is registered
|
|
176
|
+
#
|
|
177
|
+
# @return [String, nil]
|
|
178
|
+
optional :country_of_registration, String, api_name: :countryOfRegistration, nil?: true
|
|
179
|
+
|
|
180
|
+
# @!attribute entity_type
|
|
181
|
+
# Business entity type
|
|
182
|
+
#
|
|
183
|
+
# @return [Symbol, Sentdm::Models::BrandsBrandData::Business::EntityType, nil]
|
|
184
|
+
optional :entity_type,
|
|
185
|
+
enum: -> { Sentdm::BrandsBrandData::Business::EntityType },
|
|
186
|
+
api_name: :entityType,
|
|
187
|
+
nil?: true
|
|
188
|
+
|
|
189
|
+
# @!attribute legal_name
|
|
190
|
+
# Legal business name
|
|
191
|
+
#
|
|
192
|
+
# @return [String, nil]
|
|
193
|
+
optional :legal_name, String, api_name: :legalName, nil?: true
|
|
194
|
+
|
|
195
|
+
# @!attribute postal_code
|
|
196
|
+
# Postal/ZIP code
|
|
197
|
+
#
|
|
198
|
+
# @return [String, nil]
|
|
199
|
+
optional :postal_code, String, api_name: :postalCode, nil?: true
|
|
200
|
+
|
|
201
|
+
# @!attribute state
|
|
202
|
+
# State/province code
|
|
203
|
+
#
|
|
204
|
+
# @return [String, nil]
|
|
205
|
+
optional :state, String, nil?: true
|
|
206
|
+
|
|
207
|
+
# @!attribute street
|
|
208
|
+
# Street address
|
|
209
|
+
#
|
|
210
|
+
# @return [String, nil]
|
|
211
|
+
optional :street, String, nil?: true
|
|
212
|
+
|
|
213
|
+
# @!attribute tax_id
|
|
214
|
+
# Tax ID/EIN number
|
|
215
|
+
#
|
|
216
|
+
# @return [String, nil]
|
|
217
|
+
optional :tax_id, String, api_name: :taxId, nil?: true
|
|
218
|
+
|
|
219
|
+
# @!attribute tax_id_type
|
|
220
|
+
# Type of tax ID (e.g., us_ein, ca_bn)
|
|
221
|
+
#
|
|
222
|
+
# @return [String, nil]
|
|
223
|
+
optional :tax_id_type, String, api_name: :taxIdType, nil?: true
|
|
224
|
+
|
|
225
|
+
# @!attribute url
|
|
226
|
+
# Business website URL
|
|
227
|
+
#
|
|
228
|
+
# @return [String, nil]
|
|
229
|
+
optional :url, String, nil?: true
|
|
230
|
+
|
|
231
|
+
# @!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)
|
|
232
|
+
# Business details and address information
|
|
233
|
+
#
|
|
234
|
+
# @param city [String, nil] City
|
|
235
|
+
#
|
|
236
|
+
# @param country [String, nil] Country code (e.g., US, CA)
|
|
237
|
+
#
|
|
238
|
+
# @param country_of_registration [String, nil] Country where the business is registered
|
|
239
|
+
#
|
|
240
|
+
# @param entity_type [Symbol, Sentdm::Models::BrandsBrandData::Business::EntityType, nil] Business entity type
|
|
241
|
+
#
|
|
242
|
+
# @param legal_name [String, nil] Legal business name
|
|
243
|
+
#
|
|
244
|
+
# @param postal_code [String, nil] Postal/ZIP code
|
|
245
|
+
#
|
|
246
|
+
# @param state [String, nil] State/province code
|
|
247
|
+
#
|
|
248
|
+
# @param street [String, nil] Street address
|
|
249
|
+
#
|
|
250
|
+
# @param tax_id [String, nil] Tax ID/EIN number
|
|
251
|
+
#
|
|
252
|
+
# @param tax_id_type [String, nil] Type of tax ID (e.g., us_ein, ca_bn)
|
|
253
|
+
#
|
|
254
|
+
# @param url [String, nil] Business website URL
|
|
255
|
+
|
|
256
|
+
# Business entity type
|
|
257
|
+
#
|
|
258
|
+
# @see Sentdm::Models::BrandsBrandData::Business#entity_type
|
|
259
|
+
module EntityType
|
|
260
|
+
extend Sentdm::Internal::Type::Enum
|
|
261
|
+
|
|
262
|
+
PRIVATE_PROFIT = :PRIVATE_PROFIT
|
|
263
|
+
PUBLIC_PROFIT = :PUBLIC_PROFIT
|
|
264
|
+
NON_PROFIT = :NON_PROFIT
|
|
265
|
+
SOLE_PROPRIETOR = :SOLE_PROPRIETOR
|
|
266
|
+
GOVERNMENT = :GOVERNMENT
|
|
267
|
+
|
|
268
|
+
# @!method self.values
|
|
269
|
+
# @return [Array<Symbol>]
|
|
270
|
+
end
|
|
271
|
+
end
|
|
272
|
+
end
|
|
273
|
+
end
|
|
274
|
+
end
|
|
@@ -13,28 +13,35 @@ module Sentdm
|
|
|
13
13
|
# @return [String, nil]
|
|
14
14
|
optional :phone_number, String
|
|
15
15
|
|
|
16
|
-
# @!attribute
|
|
17
|
-
#
|
|
18
|
-
#
|
|
16
|
+
# @!attribute sandbox
|
|
17
|
+
# Sandbox flag - when true, the operation is simulated without side effects Useful
|
|
18
|
+
# for testing integrations without actual execution
|
|
19
19
|
#
|
|
20
20
|
# @return [Boolean, nil]
|
|
21
|
-
optional :
|
|
21
|
+
optional :sandbox, Sentdm::Internal::Type::Boolean
|
|
22
22
|
|
|
23
23
|
# @!attribute idempotency_key
|
|
24
24
|
#
|
|
25
25
|
# @return [String, nil]
|
|
26
26
|
optional :idempotency_key, String
|
|
27
27
|
|
|
28
|
-
# @!
|
|
28
|
+
# @!attribute x_profile_id
|
|
29
|
+
#
|
|
30
|
+
# @return [String, nil]
|
|
31
|
+
optional :x_profile_id, String
|
|
32
|
+
|
|
33
|
+
# @!method initialize(phone_number: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
|
|
29
34
|
# Some parameter documentations has been truncated, see
|
|
30
35
|
# {Sentdm::Models::ContactCreateParams} for more details.
|
|
31
36
|
#
|
|
32
37
|
# @param phone_number [String] Phone number of the contact to create
|
|
33
38
|
#
|
|
34
|
-
# @param
|
|
39
|
+
# @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
|
|
35
40
|
#
|
|
36
41
|
# @param idempotency_key [String]
|
|
37
42
|
#
|
|
43
|
+
# @param x_profile_id [String]
|
|
44
|
+
#
|
|
38
45
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
|
|
39
46
|
end
|
|
40
47
|
end
|
|
@@ -18,14 +18,21 @@ module Sentdm
|
|
|
18
18
|
# @return [Sentdm::Models::ContactDeleteParams::Body]
|
|
19
19
|
required :body, -> { Sentdm::ContactDeleteParams::Body }
|
|
20
20
|
|
|
21
|
-
# @!
|
|
21
|
+
# @!attribute x_profile_id
|
|
22
|
+
#
|
|
23
|
+
# @return [String, nil]
|
|
24
|
+
optional :x_profile_id, String
|
|
25
|
+
|
|
26
|
+
# @!method initialize(id:, body:, x_profile_id: nil, request_options: {})
|
|
22
27
|
# @param id [String]
|
|
23
28
|
#
|
|
24
29
|
# @param body [Sentdm::Models::ContactDeleteParams::Body] Request to delete/dissociate a contact
|
|
25
30
|
#
|
|
31
|
+
# @param x_profile_id [String]
|
|
32
|
+
#
|
|
26
33
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
|
|
27
34
|
|
|
28
|
-
class Body < Sentdm::Models::
|
|
35
|
+
class Body < Sentdm::Models::MutationRequestBase
|
|
29
36
|
# @!method initialize
|
|
30
37
|
# Request to delete/dissociate a contact
|
|
31
38
|
end
|
|
@@ -14,6 +14,7 @@ module Sentdm
|
|
|
14
14
|
required :page, Integer
|
|
15
15
|
|
|
16
16
|
# @!attribute page_size
|
|
17
|
+
# Number of items per page
|
|
17
18
|
#
|
|
18
19
|
# @return [Integer]
|
|
19
20
|
required :page_size, Integer
|
|
@@ -36,10 +37,15 @@ module Sentdm
|
|
|
36
37
|
# @return [String, nil]
|
|
37
38
|
optional :search, String, nil?: true
|
|
38
39
|
|
|
39
|
-
# @!
|
|
40
|
+
# @!attribute x_profile_id
|
|
41
|
+
#
|
|
42
|
+
# @return [String, nil]
|
|
43
|
+
optional :x_profile_id, String
|
|
44
|
+
|
|
45
|
+
# @!method initialize(page:, page_size:, channel: nil, phone: nil, search: nil, x_profile_id: nil, request_options: {})
|
|
40
46
|
# @param page [Integer] Page number (1-indexed)
|
|
41
47
|
#
|
|
42
|
-
# @param page_size [Integer]
|
|
48
|
+
# @param page_size [Integer] Number of items per page
|
|
43
49
|
#
|
|
44
50
|
# @param channel [String, nil] Optional channel filter (sms, whatsapp)
|
|
45
51
|
#
|
|
@@ -47,6 +53,8 @@ module Sentdm
|
|
|
47
53
|
#
|
|
48
54
|
# @param search [String, nil] Optional search term for filtering contacts
|
|
49
55
|
#
|
|
56
|
+
# @param x_profile_id [String]
|
|
57
|
+
#
|
|
50
58
|
# @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
|
|
51
59
|
end
|
|
52
60
|
end
|
|
@@ -44,8 +44,8 @@ module Sentdm
|
|
|
44
44
|
# @!attribute contacts
|
|
45
45
|
# List of contacts
|
|
46
46
|
#
|
|
47
|
-
# @return [Array<Sentdm::Models::
|
|
48
|
-
optional :contacts, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::
|
|
47
|
+
# @return [Array<Sentdm::Models::ContactResponse>, nil]
|
|
48
|
+
optional :contacts, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ContactResponse] }
|
|
49
49
|
|
|
50
50
|
# @!attribute pagination
|
|
51
51
|
# Pagination metadata
|
|
@@ -56,7 +56,7 @@ module Sentdm
|
|
|
56
56
|
# @!method initialize(contacts: nil, pagination: nil)
|
|
57
57
|
# The response data (null if error)
|
|
58
58
|
#
|
|
59
|
-
# @param contacts [Array<Sentdm::Models::
|
|
59
|
+
# @param contacts [Array<Sentdm::Models::ContactResponse>] List of contacts
|
|
60
60
|
#
|
|
61
61
|
# @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata
|
|
62
62
|
end
|