sentdm 0.19.0 → 0.20.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/README.md +31 -1
- data/lib/sentdm/internal/type/base_model.rb +5 -5
- data/lib/sentdm/internal/type/enum.rb +25 -0
- data/lib/sentdm/models/api_meta.rb +34 -0
- data/lib/sentdm/models/api_response_of_contact.rb +46 -0
- data/lib/sentdm/models/api_response_of_profile_detail.rb +43 -0
- data/lib/sentdm/models/api_response_of_user.rb +43 -0
- data/lib/sentdm/models/api_response_template.rb +43 -0
- data/lib/sentdm/models/api_response_webhook.rb +43 -0
- data/lib/sentdm/models/billing_contact_info.rb +47 -0
- data/lib/sentdm/models/brands_brand_data.rb +38 -0
- data/lib/sentdm/models/contact_delete_params.rb +2 -16
- data/lib/sentdm/models/contact_list_response.rb +12 -278
- data/lib/sentdm/models/contact_response.rb +126 -0
- data/lib/sentdm/models/destination_country.rb +21 -0
- data/lib/sentdm/models/error_detail.rb +42 -0
- data/lib/sentdm/models/me_retrieve_response.rb +12 -204
- data/lib/sentdm/models/message_retrieve_activities_response.rb +6 -74
- data/lib/sentdm/models/message_retrieve_status_response.rb +6 -74
- data/lib/sentdm/models/message_send_response.rb +6 -74
- data/lib/sentdm/models/mutation_request.rb +20 -0
- data/lib/sentdm/models/number_lookup_response.rb +6 -74
- data/lib/sentdm/models/pagination_meta.rb +80 -0
- data/lib/sentdm/models/payment_details.rb +44 -0
- data/lib/sentdm/models/profile_complete_response.rb +6 -74
- data/lib/sentdm/models/profile_create_params.rb +9 -423
- data/lib/sentdm/models/profile_delete_params.rb +2 -16
- data/lib/sentdm/models/profile_detail.rb +605 -0
- data/lib/sentdm/models/profile_list_response.rb +9 -753
- data/lib/sentdm/models/profile_settings.rb +66 -0
- data/lib/sentdm/models/profile_update_params.rb +9 -423
- data/lib/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rb +45 -0
- data/lib/sentdm/models/profiles/base_dto.rb +32 -0
- data/lib/sentdm/models/profiles/campaign_create_params.rb +3 -165
- data/lib/sentdm/models/profiles/campaign_data.rb +123 -0
- data/lib/sentdm/models/profiles/campaign_delete_params.rb +2 -17
- data/lib/sentdm/models/profiles/campaign_list_response.rb +9 -420
- data/lib/sentdm/models/profiles/campaign_update_params.rb +3 -165
- data/lib/sentdm/models/profiles/messaging_use_case_us.rb +28 -0
- data/lib/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rb +29 -0
- data/lib/sentdm/models/profiles/tcr_campaign_with_use_cases.rb +248 -0
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rb +34 -0
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rb +48 -0
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rb +38 -0
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rb +81 -0
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rb +34 -0
- data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rb +39 -0
- data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rb +116 -0
- data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rb +75 -0
- data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info.rb +58 -0
- data/lib/sentdm/models/tcr_brand_relationship.rb +18 -0
- data/lib/sentdm/models/tcr_vertical.rb +36 -0
- data/lib/sentdm/models/template.rb +90 -0
- data/lib/sentdm/models/template_body_content.rb +27 -0
- data/lib/sentdm/models/template_create_params.rb +3 -889
- data/lib/sentdm/models/template_definition.rb +66 -0
- data/lib/sentdm/models/template_list_response.rb +12 -242
- data/lib/sentdm/models/template_update_params.rb +3 -889
- data/lib/sentdm/models/template_variable.rb +80 -0
- data/lib/sentdm/models/user_list_response.rb +9 -154
- data/lib/sentdm/models/user_remove_params.rb +2 -16
- data/lib/sentdm/models/user_response.rb +82 -0
- data/lib/sentdm/models/webhook_event_type.rb +45 -0
- data/lib/sentdm/models/webhook_list_event_types_response.rb +9 -118
- data/lib/sentdm/models/webhook_list_events_response.rb +9 -153
- data/lib/sentdm/models/webhook_list_response.rb +12 -247
- data/lib/sentdm/models/webhook_response.rb +95 -0
- data/lib/sentdm/models/webhook_rotate_secret_params.rb +2 -17
- data/lib/sentdm/models/webhook_rotate_secret_response.rb +6 -74
- data/lib/sentdm/models/webhook_test_response.rb +6 -74
- data/lib/sentdm/models.rb +77 -0
- data/lib/sentdm/resources/contacts.rb +6 -6
- data/lib/sentdm/resources/profiles/campaigns.rb +6 -6
- data/lib/sentdm/resources/profiles.rb +12 -12
- data/lib/sentdm/resources/templates.rb +8 -8
- data/lib/sentdm/resources/users.rb +6 -6
- data/lib/sentdm/resources/webhooks.rb +8 -8
- data/lib/sentdm/version.rb +1 -1
- data/lib/sentdm.rb +40 -18
- data/rbi/sentdm/models/api_meta.rbi +55 -0
- data/rbi/sentdm/models/api_response_of_contact.rbi +74 -0
- data/rbi/sentdm/models/api_response_of_profile_detail.rbi +74 -0
- data/rbi/sentdm/models/api_response_of_user.rbi +74 -0
- data/rbi/sentdm/models/api_response_template.rbi +74 -0
- data/rbi/sentdm/models/api_response_webhook.rbi +74 -0
- data/rbi/sentdm/models/billing_contact_info.rbi +65 -0
- data/rbi/sentdm/models/brands_brand_data.rbi +104 -0
- data/rbi/sentdm/models/contact_delete_params.rbi +2 -19
- data/rbi/sentdm/models/contact_list_response.rbi +16 -505
- data/rbi/sentdm/models/contact_response.rbi +183 -0
- data/rbi/sentdm/models/destination_country.rbi +32 -0
- data/rbi/sentdm/models/error_detail.rbi +66 -0
- data/rbi/sentdm/models/me_retrieve_response.rbi +16 -335
- data/rbi/sentdm/models/message_retrieve_activities_response.rbi +8 -154
- data/rbi/sentdm/models/message_retrieve_status_response.rbi +8 -148
- data/rbi/sentdm/models/message_send_response.rbi +8 -135
- data/rbi/sentdm/models/mutation_request.rbi +32 -0
- data/rbi/sentdm/models/number_lookup_response.rbi +8 -135
- data/rbi/sentdm/models/pagination_meta.rbi +135 -0
- data/rbi/sentdm/models/payment_details.rbi +59 -0
- data/rbi/sentdm/models/profile_complete_response.rbi +8 -137
- data/rbi/sentdm/models/profile_create_params.rbi +12 -810
- data/rbi/sentdm/models/profile_delete_params.rbi +2 -19
- data/rbi/sentdm/models/profile_detail.rbi +874 -0
- data/rbi/sentdm/models/profile_list_response.rbi +14 -1400
- data/rbi/sentdm/models/profile_settings.rbi +86 -0
- data/rbi/sentdm/models/profile_update_params.rbi +12 -810
- data/rbi/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rbi +83 -0
- data/rbi/sentdm/models/profiles/base_dto.rbi +53 -0
- data/rbi/sentdm/models/profiles/campaign_create_params.rbi +4 -289
- data/rbi/sentdm/models/profiles/campaign_data.rbi +148 -0
- data/rbi/sentdm/models/profiles/campaign_delete_params.rbi +1 -14
- data/rbi/sentdm/models/profiles/campaign_list_response.rbi +11 -733
- data/rbi/sentdm/models/profiles/campaign_update_params.rbi +4 -289
- data/rbi/sentdm/models/profiles/messaging_use_case_us.rbi +73 -0
- data/rbi/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbi +51 -0
- data/rbi/sentdm/models/profiles/tcr_campaign_with_use_cases.rbi +425 -0
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rbi +56 -0
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rbi +87 -0
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rbi +72 -0
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rbi +104 -0
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rbi +57 -0
- data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rbi +59 -0
- data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rbi +180 -0
- data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rbi +95 -0
- data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info.rbi +81 -0
- data/rbi/sentdm/models/tcr_brand_relationship.rbi +30 -0
- data/rbi/sentdm/models/tcr_vertical.rbi +41 -0
- data/rbi/sentdm/models/template.rbi +129 -0
- data/rbi/sentdm/models/template_body_content.rbi +43 -0
- data/rbi/sentdm/models/template_create_params.rbi +4 -1701
- data/rbi/sentdm/models/template_definition.rbi +164 -0
- data/rbi/sentdm/models/template_list_response.rbi +16 -454
- data/rbi/sentdm/models/template_update_params.rbi +4 -1701
- data/rbi/sentdm/models/template_variable.rbi +120 -0
- data/rbi/sentdm/models/user_list_response.rbi +14 -271
- data/rbi/sentdm/models/user_remove_params.rbi +2 -19
- data/rbi/sentdm/models/user_response.rbi +118 -0
- data/rbi/sentdm/models/webhook_event_type.rbi +74 -0
- data/rbi/sentdm/models/webhook_list_event_types_response.rbi +12 -247
- data/rbi/sentdm/models/webhook_list_events_response.rbi +12 -314
- data/rbi/sentdm/models/webhook_list_response.rbi +16 -462
- data/rbi/sentdm/models/webhook_response.rbi +140 -0
- data/rbi/sentdm/models/webhook_rotate_secret_params.rbi +1 -14
- data/rbi/sentdm/models/webhook_rotate_secret_response.rbi +8 -148
- data/rbi/sentdm/models/webhook_test_response.rbi +8 -135
- data/rbi/sentdm/models.rbi +77 -0
- data/rbi/sentdm/resources/contacts.rbi +3 -3
- data/rbi/sentdm/resources/profiles/campaigns.rbi +4 -4
- data/rbi/sentdm/resources/profiles.rbi +9 -13
- data/rbi/sentdm/resources/templates.rbi +5 -6
- data/rbi/sentdm/resources/users.rbi +3 -3
- data/rbi/sentdm/resources/webhooks.rbi +4 -4
- data/sig/sentdm/models/api_meta.rbs +27 -0
- data/sig/sentdm/models/api_response_of_contact.rbs +39 -0
- data/sig/sentdm/models/api_response_of_profile_detail.rbs +39 -0
- data/sig/sentdm/models/api_response_of_user.rbs +39 -0
- data/sig/sentdm/models/api_response_template.rbs +39 -0
- data/sig/sentdm/models/api_response_webhook.rbs +39 -0
- data/sig/sentdm/models/billing_contact_info.rbs +30 -0
- data/sig/sentdm/models/brands_brand_data.rbs +30 -0
- data/sig/sentdm/models/contact_delete_params.rbs +6 -10
- data/sig/sentdm/models/contact_list_response.rbs +20 -256
- data/sig/sentdm/models/contact_response.rbs +111 -0
- data/sig/sentdm/models/destination_country.rbs +19 -0
- data/sig/sentdm/models/error_detail.rbs +39 -0
- data/sig/sentdm/models/me_retrieve_response.rbs +18 -176
- data/sig/sentdm/models/message_retrieve_activities_response.rbs +9 -71
- data/sig/sentdm/models/message_retrieve_status_response.rbs +9 -71
- data/sig/sentdm/models/message_send_response.rbs +9 -71
- data/sig/sentdm/models/mutation_request.rbs +15 -0
- data/sig/sentdm/models/number_lookup_response.rbs +9 -71
- data/sig/sentdm/models/pagination_meta.rbs +67 -0
- data/sig/sentdm/models/payment_details.rbs +30 -0
- data/sig/sentdm/models/profile_complete_response.rbs +9 -71
- data/sig/sentdm/models/profile_create_params.rbs +12 -363
- data/sig/sentdm/models/profile_delete_params.rbs +6 -10
- data/sig/sentdm/models/profile_detail.rbs +474 -0
- data/sig/sentdm/models/profile_list_response.rbs +15 -645
- data/sig/sentdm/models/profile_settings.rbs +50 -0
- data/sig/sentdm/models/profile_update_params.rbs +12 -363
- data/sig/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rbs +41 -0
- data/sig/sentdm/models/profiles/base_dto.rbs +27 -0
- data/sig/sentdm/models/profiles/campaign_create_params.rbs +4 -138
- data/sig/sentdm/models/profiles/campaign_data.rbs +82 -0
- data/sig/sentdm/models/profiles/campaign_delete_params.rbs +8 -15
- data/sig/sentdm/models/profiles/campaign_list_response.rbs +13 -396
- data/sig/sentdm/models/profiles/campaign_update_params.rbs +4 -138
- data/sig/sentdm/models/profiles/messaging_use_case_us.rbs +40 -0
- data/sig/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbs +27 -0
- data/sig/sentdm/models/profiles/tcr_campaign_with_use_cases.rbs +299 -0
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rbs +24 -0
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rbs +35 -0
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rbs +32 -0
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rbs +75 -0
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rbs +30 -0
- data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rbs +30 -0
- data/sig/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rbs +89 -0
- data/sig/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rbs +55 -0
- data/sig/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info.rbs +45 -0
- data/sig/sentdm/models/tcr_brand_relationship.rbs +22 -0
- data/sig/sentdm/models/tcr_vertical.rbs +58 -0
- data/sig/sentdm/models/template.rbs +79 -0
- data/sig/sentdm/models/template_body_content.rbs +30 -0
- data/sig/sentdm/models/template_create_params.rbs +6 -853
- data/sig/sentdm/models/template_definition.rbs +45 -0
- data/sig/sentdm/models/template_list_response.rbs +19 -225
- data/sig/sentdm/models/template_update_params.rbs +4 -851
- data/sig/sentdm/models/template_variable.rbs +84 -0
- data/sig/sentdm/models/user_list_response.rbs +15 -151
- data/sig/sentdm/models/user_remove_params.rbs +6 -10
- data/sig/sentdm/models/user_response.rbs +72 -0
- data/sig/sentdm/models/webhook_event_type.rbs +51 -0
- data/sig/sentdm/models/webhook_list_event_types_response.rbs +15 -130
- data/sig/sentdm/models/webhook_list_events_response.rbs +14 -142
- data/sig/sentdm/models/webhook_list_response.rbs +20 -248
- data/sig/sentdm/models/webhook_response.rbs +103 -0
- data/sig/sentdm/models/webhook_rotate_secret_params.rbs +8 -17
- data/sig/sentdm/models/webhook_rotate_secret_response.rbs +9 -71
- data/sig/sentdm/models/webhook_test_response.rbs +9 -71
- data/sig/sentdm/models.rbs +68 -0
- data/sig/sentdm/resources/contacts.rbs +3 -3
- data/sig/sentdm/resources/profiles/campaigns.rbs +4 -4
- data/sig/sentdm/resources/profiles.rbs +9 -9
- data/sig/sentdm/resources/templates.rbs +5 -5
- data/sig/sentdm/resources/users.rbs +3 -3
- data/sig/sentdm/resources/webhooks.rbs +4 -4
- metadata +121 -55
- data/lib/sentdm/models/contact_create_response.rb +0 -236
- data/lib/sentdm/models/contact_retrieve_response.rb +0 -236
- data/lib/sentdm/models/contact_update_response.rb +0 -236
- data/lib/sentdm/models/profile_create_response.rb +0 -781
- data/lib/sentdm/models/profile_retrieve_response.rb +0 -783
- data/lib/sentdm/models/profile_update_response.rb +0 -781
- data/lib/sentdm/models/profiles/campaign_create_response.rb +0 -459
- data/lib/sentdm/models/profiles/campaign_update_response.rb +0 -459
- data/lib/sentdm/models/template_create_response.rb +0 -197
- data/lib/sentdm/models/template_retrieve_response.rb +0 -197
- data/lib/sentdm/models/template_update_response.rb +0 -197
- data/lib/sentdm/models/user_invite_response.rb +0 -189
- data/lib/sentdm/models/user_retrieve_response.rb +0 -189
- data/lib/sentdm/models/user_update_role_response.rb +0 -189
- data/lib/sentdm/models/webhook_create_response.rb +0 -204
- data/lib/sentdm/models/webhook_retrieve_response.rb +0 -204
- data/lib/sentdm/models/webhook_toggle_status_response.rb +0 -204
- data/lib/sentdm/models/webhook_update_response.rb +0 -204
- data/rbi/sentdm/models/contact_create_response.rbi +0 -390
- data/rbi/sentdm/models/contact_retrieve_response.rbi +0 -392
- data/rbi/sentdm/models/contact_update_response.rbi +0 -390
- data/rbi/sentdm/models/profile_create_response.rbi +0 -1439
- data/rbi/sentdm/models/profile_retrieve_response.rbi +0 -1443
- data/rbi/sentdm/models/profile_update_response.rbi +0 -1439
- data/rbi/sentdm/models/profiles/campaign_create_response.rbi +0 -814
- data/rbi/sentdm/models/profiles/campaign_update_response.rbi +0 -814
- data/rbi/sentdm/models/template_create_response.rbi +0 -339
- data/rbi/sentdm/models/template_retrieve_response.rbi +0 -345
- data/rbi/sentdm/models/template_update_response.rbi +0 -339
- data/rbi/sentdm/models/user_invite_response.rbi +0 -323
- data/rbi/sentdm/models/user_retrieve_response.rbi +0 -323
- data/rbi/sentdm/models/user_update_role_response.rbi +0 -328
- data/rbi/sentdm/models/webhook_create_response.rbi +0 -348
- data/rbi/sentdm/models/webhook_retrieve_response.rbi +0 -350
- data/rbi/sentdm/models/webhook_toggle_status_response.rbi +0 -366
- data/rbi/sentdm/models/webhook_update_response.rbi +0 -348
- data/sig/sentdm/models/contact_create_response.rbs +0 -209
- data/sig/sentdm/models/contact_retrieve_response.rbs +0 -209
- data/sig/sentdm/models/contact_update_response.rbs +0 -209
- data/sig/sentdm/models/profile_create_response.rbs +0 -662
- data/sig/sentdm/models/profile_retrieve_response.rbs +0 -662
- data/sig/sentdm/models/profile_update_response.rbs +0 -662
- data/sig/sentdm/models/profiles/campaign_create_response.rbs +0 -424
- data/sig/sentdm/models/profiles/campaign_update_response.rbs +0 -424
- data/sig/sentdm/models/template_create_response.rbs +0 -177
- data/sig/sentdm/models/template_retrieve_response.rbs +0 -177
- data/sig/sentdm/models/template_update_response.rbs +0 -177
- data/sig/sentdm/models/user_invite_response.rbs +0 -170
- data/sig/sentdm/models/user_retrieve_response.rbs +0 -170
- data/sig/sentdm/models/user_update_role_response.rbs +0 -170
- data/sig/sentdm/models/webhook_create_response.rbs +0 -201
- data/sig/sentdm/models/webhook_retrieve_response.rbs +0 -201
- data/sig/sentdm/models/webhook_toggle_status_response.rbs +0 -201
- data/sig/sentdm/models/webhook_update_response.rbs +0 -201
|
@@ -13,14 +13,14 @@ module Sentdm
|
|
|
13
13
|
# @!attribute error
|
|
14
14
|
# Error information
|
|
15
15
|
#
|
|
16
|
-
# @return [Sentdm::Models::
|
|
17
|
-
optional :error, -> { Sentdm::
|
|
16
|
+
# @return [Sentdm::Models::ErrorDetail, nil]
|
|
17
|
+
optional :error, -> { Sentdm::ErrorDetail }, nil?: true
|
|
18
18
|
|
|
19
19
|
# @!attribute meta
|
|
20
20
|
# Request and response metadata
|
|
21
21
|
#
|
|
22
|
-
# @return [Sentdm::Models::
|
|
23
|
-
optional :meta, -> { Sentdm::
|
|
22
|
+
# @return [Sentdm::Models::APIMeta, nil]
|
|
23
|
+
optional :meta, -> { Sentdm::APIMeta }
|
|
24
24
|
|
|
25
25
|
# @!attribute success
|
|
26
26
|
# Indicates whether the request was successful
|
|
@@ -33,9 +33,9 @@ module Sentdm
|
|
|
33
33
|
#
|
|
34
34
|
# @param data [Sentdm::Models::NumberLookupResponse::Data, nil] The response data (null if error)
|
|
35
35
|
#
|
|
36
|
-
# @param error [Sentdm::Models::
|
|
36
|
+
# @param error [Sentdm::Models::ErrorDetail, nil] Error information
|
|
37
37
|
#
|
|
38
|
-
# @param meta [Sentdm::Models::
|
|
38
|
+
# @param meta [Sentdm::Models::APIMeta] Request and response metadata
|
|
39
39
|
#
|
|
40
40
|
# @param success [Boolean] Indicates whether the request was successful
|
|
41
41
|
|
|
@@ -99,74 +99,6 @@ module Sentdm
|
|
|
99
99
|
# @param mobile_network_code [String, nil]
|
|
100
100
|
# @param phone_number [String]
|
|
101
101
|
end
|
|
102
|
-
|
|
103
|
-
# @see Sentdm::Models::NumberLookupResponse#error
|
|
104
|
-
class Error < Sentdm::Internal::Type::BaseModel
|
|
105
|
-
# @!attribute code
|
|
106
|
-
# Machine-readable error code (e.g., "RESOURCE_001")
|
|
107
|
-
#
|
|
108
|
-
# @return [String, nil]
|
|
109
|
-
optional :code, String
|
|
110
|
-
|
|
111
|
-
# @!attribute details
|
|
112
|
-
# Additional validation error details (field-level errors)
|
|
113
|
-
#
|
|
114
|
-
# @return [Hash{Symbol=>Array<String>}, nil]
|
|
115
|
-
optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
|
|
116
|
-
|
|
117
|
-
# @!attribute doc_url
|
|
118
|
-
# URL to documentation about this error
|
|
119
|
-
#
|
|
120
|
-
# @return [String, nil]
|
|
121
|
-
optional :doc_url, String, nil?: true
|
|
122
|
-
|
|
123
|
-
# @!attribute message
|
|
124
|
-
# Human-readable error message
|
|
125
|
-
#
|
|
126
|
-
# @return [String, nil]
|
|
127
|
-
optional :message, String
|
|
128
|
-
|
|
129
|
-
# @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
|
|
130
|
-
# Error information
|
|
131
|
-
#
|
|
132
|
-
# @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
|
|
133
|
-
#
|
|
134
|
-
# @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
|
|
135
|
-
#
|
|
136
|
-
# @param doc_url [String, nil] URL to documentation about this error
|
|
137
|
-
#
|
|
138
|
-
# @param message [String] Human-readable error message
|
|
139
|
-
end
|
|
140
|
-
|
|
141
|
-
# @see Sentdm::Models::NumberLookupResponse#meta
|
|
142
|
-
class Meta < Sentdm::Internal::Type::BaseModel
|
|
143
|
-
# @!attribute request_id
|
|
144
|
-
# Unique identifier for this request (for tracing and support)
|
|
145
|
-
#
|
|
146
|
-
# @return [String, nil]
|
|
147
|
-
optional :request_id, String
|
|
148
|
-
|
|
149
|
-
# @!attribute timestamp
|
|
150
|
-
# Server timestamp when the response was generated
|
|
151
|
-
#
|
|
152
|
-
# @return [Time, nil]
|
|
153
|
-
optional :timestamp, Time
|
|
154
|
-
|
|
155
|
-
# @!attribute version
|
|
156
|
-
# API version used for this request
|
|
157
|
-
#
|
|
158
|
-
# @return [String, nil]
|
|
159
|
-
optional :version, String
|
|
160
|
-
|
|
161
|
-
# @!method initialize(request_id: nil, timestamp: nil, version: nil)
|
|
162
|
-
# Request and response metadata
|
|
163
|
-
#
|
|
164
|
-
# @param request_id [String] Unique identifier for this request (for tracing and support)
|
|
165
|
-
#
|
|
166
|
-
# @param timestamp [Time] Server timestamp when the response was generated
|
|
167
|
-
#
|
|
168
|
-
# @param version [String] API version used for this request
|
|
169
|
-
end
|
|
170
102
|
end
|
|
171
103
|
end
|
|
172
104
|
end
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
class PaginationMeta < Sentdm::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute cursors
|
|
7
|
+
# Cursor-based pagination pointers
|
|
8
|
+
#
|
|
9
|
+
# @return [Sentdm::Models::PaginationMeta::Cursors, nil]
|
|
10
|
+
optional :cursors, -> { Sentdm::PaginationMeta::Cursors }, nil?: true
|
|
11
|
+
|
|
12
|
+
# @!attribute has_more
|
|
13
|
+
# Whether there are more pages after this one
|
|
14
|
+
#
|
|
15
|
+
# @return [Boolean, nil]
|
|
16
|
+
optional :has_more, Sentdm::Internal::Type::Boolean
|
|
17
|
+
|
|
18
|
+
# @!attribute page
|
|
19
|
+
# Current page number (1-indexed)
|
|
20
|
+
#
|
|
21
|
+
# @return [Integer, nil]
|
|
22
|
+
optional :page, Integer
|
|
23
|
+
|
|
24
|
+
# @!attribute page_size
|
|
25
|
+
# Number of items per page
|
|
26
|
+
#
|
|
27
|
+
# @return [Integer, nil]
|
|
28
|
+
optional :page_size, Integer
|
|
29
|
+
|
|
30
|
+
# @!attribute total_count
|
|
31
|
+
# Total number of items across all pages
|
|
32
|
+
#
|
|
33
|
+
# @return [Integer, nil]
|
|
34
|
+
optional :total_count, Integer
|
|
35
|
+
|
|
36
|
+
# @!attribute total_pages
|
|
37
|
+
# Total number of pages
|
|
38
|
+
#
|
|
39
|
+
# @return [Integer, nil]
|
|
40
|
+
optional :total_pages, Integer
|
|
41
|
+
|
|
42
|
+
# @!method initialize(cursors: nil, has_more: nil, page: nil, page_size: nil, total_count: nil, total_pages: nil)
|
|
43
|
+
# Pagination metadata for list responses
|
|
44
|
+
#
|
|
45
|
+
# @param cursors [Sentdm::Models::PaginationMeta::Cursors, nil] Cursor-based pagination pointers
|
|
46
|
+
#
|
|
47
|
+
# @param has_more [Boolean] Whether there are more pages after this one
|
|
48
|
+
#
|
|
49
|
+
# @param page [Integer] Current page number (1-indexed)
|
|
50
|
+
#
|
|
51
|
+
# @param page_size [Integer] Number of items per page
|
|
52
|
+
#
|
|
53
|
+
# @param total_count [Integer] Total number of items across all pages
|
|
54
|
+
#
|
|
55
|
+
# @param total_pages [Integer] Total number of pages
|
|
56
|
+
|
|
57
|
+
# @see Sentdm::Models::PaginationMeta#cursors
|
|
58
|
+
class Cursors < Sentdm::Internal::Type::BaseModel
|
|
59
|
+
# @!attribute after
|
|
60
|
+
# Cursor to fetch the next page
|
|
61
|
+
#
|
|
62
|
+
# @return [String, nil]
|
|
63
|
+
optional :after, String, nil?: true
|
|
64
|
+
|
|
65
|
+
# @!attribute before
|
|
66
|
+
# Cursor to fetch the previous page
|
|
67
|
+
#
|
|
68
|
+
# @return [String, nil]
|
|
69
|
+
optional :before, String, nil?: true
|
|
70
|
+
|
|
71
|
+
# @!method initialize(after: nil, before: nil)
|
|
72
|
+
# Cursor-based pagination pointers
|
|
73
|
+
#
|
|
74
|
+
# @param after [String, nil] Cursor to fetch the next page
|
|
75
|
+
#
|
|
76
|
+
# @param before [String, nil] Cursor to fetch the previous page
|
|
77
|
+
end
|
|
78
|
+
end
|
|
79
|
+
end
|
|
80
|
+
end
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Sentdm
|
|
4
|
+
module Models
|
|
5
|
+
class PaymentDetails < Sentdm::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute card_number
|
|
7
|
+
# Card number (digits only, 13–19 characters)
|
|
8
|
+
#
|
|
9
|
+
# @return [String]
|
|
10
|
+
required :card_number, String
|
|
11
|
+
|
|
12
|
+
# @!attribute cvc
|
|
13
|
+
# Card security code (3–4 digits)
|
|
14
|
+
#
|
|
15
|
+
# @return [String]
|
|
16
|
+
required :cvc, String
|
|
17
|
+
|
|
18
|
+
# @!attribute expiry
|
|
19
|
+
# Card expiry date in MM/YY format (e.g. "09/27")
|
|
20
|
+
#
|
|
21
|
+
# @return [String]
|
|
22
|
+
required :expiry, String
|
|
23
|
+
|
|
24
|
+
# @!attribute zip_code
|
|
25
|
+
# Billing ZIP / postal code associated with the card
|
|
26
|
+
#
|
|
27
|
+
# @return [String]
|
|
28
|
+
required :zip_code, String
|
|
29
|
+
|
|
30
|
+
# @!method initialize(card_number:, cvc:, expiry:, zip_code:)
|
|
31
|
+
# Payment card details for a profile. Accepted when billing_model is "profile" or
|
|
32
|
+
# "profile_and_organization". These details are not stored on our servers and will
|
|
33
|
+
# be forwarded to the payment processor.
|
|
34
|
+
#
|
|
35
|
+
# @param card_number [String] Card number (digits only, 13–19 characters)
|
|
36
|
+
#
|
|
37
|
+
# @param cvc [String] Card security code (3–4 digits)
|
|
38
|
+
#
|
|
39
|
+
# @param expiry [String] Card expiry date in MM/YY format (e.g. "09/27")
|
|
40
|
+
#
|
|
41
|
+
# @param zip_code [String] Billing ZIP / postal code associated with the card
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
end
|
|
@@ -14,14 +14,14 @@ module Sentdm
|
|
|
14
14
|
# @!attribute error
|
|
15
15
|
# Error information
|
|
16
16
|
#
|
|
17
|
-
# @return [Sentdm::Models::
|
|
18
|
-
optional :error, -> { Sentdm::
|
|
17
|
+
# @return [Sentdm::Models::ErrorDetail, nil]
|
|
18
|
+
optional :error, -> { Sentdm::ErrorDetail }, nil?: true
|
|
19
19
|
|
|
20
20
|
# @!attribute meta
|
|
21
21
|
# Request and response metadata
|
|
22
22
|
#
|
|
23
|
-
# @return [Sentdm::Models::
|
|
24
|
-
optional :meta, -> { Sentdm::
|
|
23
|
+
# @return [Sentdm::Models::APIMeta, nil]
|
|
24
|
+
optional :meta, -> { Sentdm::APIMeta }
|
|
25
25
|
|
|
26
26
|
# @!attribute success
|
|
27
27
|
# Indicates whether the request was successful
|
|
@@ -37,9 +37,9 @@ module Sentdm
|
|
|
37
37
|
#
|
|
38
38
|
# @param data [Sentdm::Models::ProfileCompleteResponse::Data, nil] Response when a profile is already in the completed state and no further action
|
|
39
39
|
#
|
|
40
|
-
# @param error [Sentdm::Models::
|
|
40
|
+
# @param error [Sentdm::Models::ErrorDetail, nil] Error information
|
|
41
41
|
#
|
|
42
|
-
# @param meta [Sentdm::Models::
|
|
42
|
+
# @param meta [Sentdm::Models::APIMeta] Request and response metadata
|
|
43
43
|
#
|
|
44
44
|
# @param success [Boolean] Indicates whether the request was successful
|
|
45
45
|
|
|
@@ -69,74 +69,6 @@ module Sentdm
|
|
|
69
69
|
#
|
|
70
70
|
# @param status [String] Current process status of the profile (e.g., "completed", "submitted", "in_progr
|
|
71
71
|
end
|
|
72
|
-
|
|
73
|
-
# @see Sentdm::Models::ProfileCompleteResponse#error
|
|
74
|
-
class Error < Sentdm::Internal::Type::BaseModel
|
|
75
|
-
# @!attribute code
|
|
76
|
-
# Machine-readable error code (e.g., "RESOURCE_001")
|
|
77
|
-
#
|
|
78
|
-
# @return [String, nil]
|
|
79
|
-
optional :code, String
|
|
80
|
-
|
|
81
|
-
# @!attribute details
|
|
82
|
-
# Additional validation error details (field-level errors)
|
|
83
|
-
#
|
|
84
|
-
# @return [Hash{Symbol=>Array<String>}, nil]
|
|
85
|
-
optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
|
|
86
|
-
|
|
87
|
-
# @!attribute doc_url
|
|
88
|
-
# URL to documentation about this error
|
|
89
|
-
#
|
|
90
|
-
# @return [String, nil]
|
|
91
|
-
optional :doc_url, String, nil?: true
|
|
92
|
-
|
|
93
|
-
# @!attribute message
|
|
94
|
-
# Human-readable error message
|
|
95
|
-
#
|
|
96
|
-
# @return [String, nil]
|
|
97
|
-
optional :message, String
|
|
98
|
-
|
|
99
|
-
# @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
|
|
100
|
-
# Error information
|
|
101
|
-
#
|
|
102
|
-
# @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
|
|
103
|
-
#
|
|
104
|
-
# @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
|
|
105
|
-
#
|
|
106
|
-
# @param doc_url [String, nil] URL to documentation about this error
|
|
107
|
-
#
|
|
108
|
-
# @param message [String] Human-readable error message
|
|
109
|
-
end
|
|
110
|
-
|
|
111
|
-
# @see Sentdm::Models::ProfileCompleteResponse#meta
|
|
112
|
-
class Meta < Sentdm::Internal::Type::BaseModel
|
|
113
|
-
# @!attribute request_id
|
|
114
|
-
# Unique identifier for this request (for tracing and support)
|
|
115
|
-
#
|
|
116
|
-
# @return [String, nil]
|
|
117
|
-
optional :request_id, String
|
|
118
|
-
|
|
119
|
-
# @!attribute timestamp
|
|
120
|
-
# Server timestamp when the response was generated
|
|
121
|
-
#
|
|
122
|
-
# @return [Time, nil]
|
|
123
|
-
optional :timestamp, Time
|
|
124
|
-
|
|
125
|
-
# @!attribute version
|
|
126
|
-
# API version used for this request
|
|
127
|
-
#
|
|
128
|
-
# @return [String, nil]
|
|
129
|
-
optional :version, String
|
|
130
|
-
|
|
131
|
-
# @!method initialize(request_id: nil, timestamp: nil, version: nil)
|
|
132
|
-
# Request and response metadata
|
|
133
|
-
#
|
|
134
|
-
# @param request_id [String] Unique identifier for this request (for tracing and support)
|
|
135
|
-
#
|
|
136
|
-
# @param timestamp [Time] Server timestamp when the response was generated
|
|
137
|
-
#
|
|
138
|
-
# @param version [String] API version used for this request
|
|
139
|
-
end
|
|
140
72
|
end
|
|
141
73
|
end
|
|
142
74
|
end
|