rcs 2.0.5 → 2.0.7
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/.fern/metadata.json +12 -0
- data/.fernignore +7 -0
- data/.rubocop.yml +60 -0
- data/README.md +121 -0
- data/Rakefile +20 -0
- data/custom.gemspec.rb +13 -0
- data/lib/pinnacle/audiences/client.rb +183 -0
- data/lib/pinnacle/audiences/contacts/client.rb +97 -0
- data/lib/pinnacle/audiences/contacts/types/add_contacts_params.rb +14 -0
- data/lib/pinnacle/audiences/contacts/types/remove_contacts_params.rb +14 -0
- data/lib/pinnacle/audiences/types/audiences_delete_request.rb +11 -0
- data/lib/pinnacle/audiences/types/audiences_get_request.rb +13 -0
- data/lib/pinnacle/audiences/types/audiences_get_response.rb +14 -0
- data/lib/pinnacle/audiences/types/create_audience_params.rb +13 -0
- data/lib/pinnacle/audiences/types/update_audience_params.rb +13 -0
- data/lib/pinnacle/brands/client.rb +245 -0
- data/lib/pinnacle/brands/types/autofill_brand_options.rb +11 -0
- data/lib/pinnacle/brands/types/autofill_brand_params.rb +14 -0
- data/lib/pinnacle/brands/types/brands_get_request.rb +12 -0
- data/lib/pinnacle/brands/types/upsert_brand_params.rb +22 -0
- data/lib/pinnacle/brands/types/upsert_brand_schema_contact.rb +15 -0
- data/lib/pinnacle/brands/types/upsert_brand_schema_entity_type.rb +17 -0
- data/lib/pinnacle/brands/types/upsert_brand_schema_sector.rb +29 -0
- data/lib/pinnacle/brands/types/upsert_brand_schema_type.rb +17 -0
- data/lib/pinnacle/brands/types/vet_brand_params.rb +14 -0
- data/lib/pinnacle/campaigns/client.rb +29 -0
- data/lib/pinnacle/campaigns/dlc/client.rb +201 -0
- data/lib/pinnacle/campaigns/dlc/types/dlc_campaign_help_keywords.rb +15 -0
- data/lib/pinnacle/campaigns/dlc/types/dlc_campaign_keywords.rb +16 -0
- data/lib/pinnacle/campaigns/dlc/types/dlc_campaign_links.rb +15 -0
- data/lib/pinnacle/campaigns/dlc/types/dlc_campaign_opt_in_keywords.rb +15 -0
- data/lib/pinnacle/campaigns/dlc/types/dlc_campaign_opt_out_keywords.rb +15 -0
- data/lib/pinnacle/campaigns/dlc/types/dlc_campaign_options.rb +19 -0
- data/lib/pinnacle/campaigns/dlc/types/dlc_campaign_use_case.rb +15 -0
- data/lib/pinnacle/campaigns/dlc/types/upsert_dlc_campaign_params.rb +23 -0
- data/lib/pinnacle/campaigns/rcs/client.rb +199 -0
- data/lib/pinnacle/campaigns/rcs/types/rcs_agent.rb +21 -0
- data/lib/pinnacle/campaigns/rcs/types/rcs_agent_email.rb +14 -0
- data/lib/pinnacle/campaigns/rcs/types/rcs_agent_phone.rb +14 -0
- data/lib/pinnacle/campaigns/rcs/types/rcs_agent_website.rb +14 -0
- data/lib/pinnacle/campaigns/rcs/types/rcs_autofill_response.rb +13 -0
- data/lib/pinnacle/campaigns/rcs/types/rcs_campaign_help_keywords.rb +14 -0
- data/lib/pinnacle/campaigns/rcs/types/rcs_campaign_keywords.rb +15 -0
- data/lib/pinnacle/campaigns/rcs/types/rcs_campaign_opt_in_keywords.rb +14 -0
- data/lib/pinnacle/campaigns/rcs/types/rcs_campaign_opt_out_keywords.rb +14 -0
- data/lib/pinnacle/campaigns/rcs/types/rcs_campaign_traffic.rb +14 -0
- data/lib/pinnacle/campaigns/rcs/types/rcs_links.rb +15 -0
- data/lib/pinnacle/campaigns/rcs/types/rcs_use_case.rb +15 -0
- data/lib/pinnacle/campaigns/rcs/types/upsert_rcs_campaign_params.rb +28 -0
- data/lib/pinnacle/campaigns/toll_free/client.rb +201 -0
- data/lib/pinnacle/campaigns/toll_free/types/toll_free_autofill_response.rb +13 -0
- data/lib/pinnacle/campaigns/toll_free/types/toll_free_campaign_help_keywords.rb +14 -0
- data/lib/pinnacle/campaigns/toll_free/types/toll_free_campaign_keywords.rb +15 -0
- data/lib/pinnacle/campaigns/toll_free/types/toll_free_campaign_links.rb +15 -0
- data/lib/pinnacle/campaigns/toll_free/types/toll_free_campaign_opt_in.rb +16 -0
- data/lib/pinnacle/campaigns/toll_free/types/toll_free_campaign_opt_in_keywords.rb +15 -0
- data/lib/pinnacle/campaigns/toll_free/types/toll_free_campaign_options.rb +14 -0
- data/lib/pinnacle/campaigns/toll_free/types/toll_free_campaign_use_case.rb +15 -0
- data/lib/pinnacle/campaigns/toll_free/types/upsert_toll_free_campaign_params.rb +22 -0
- data/lib/pinnacle/client.rb +75 -0
- data/lib/pinnacle/contacts/client.rb +130 -0
- data/lib/pinnacle/contacts/types/contacts_get_request.rb +12 -0
- data/lib/pinnacle/contacts/types/create_contact_params.rb +15 -0
- data/lib/pinnacle/contacts/types/update_contact_params.rb +15 -0
- data/lib/pinnacle/conversations/client.rb +175 -0
- data/lib/pinnacle/conversations/types/conversations_list_messages_request.rb +19 -0
- data/lib/pinnacle/conversations/types/conversations_list_messages_request_direction.rb +14 -0
- data/lib/pinnacle/conversations/types/conversations_list_messages_request_sort_order.rb +14 -0
- data/lib/pinnacle/conversations/types/conversations_list_messages_request_status.rb +19 -0
- data/lib/pinnacle/conversations/types/conversations_list_messages_request_type.rb +15 -0
- data/lib/pinnacle/conversations/types/list_conversations_params.rb +17 -0
- data/lib/pinnacle/conversations/types/update_conversation_params.rb +12 -0
- data/lib/pinnacle/errors/api_error.rb +8 -0
- data/lib/pinnacle/errors/client_error.rb +17 -0
- data/lib/pinnacle/errors/redirect_error.rb +8 -0
- data/lib/pinnacle/errors/response_error.rb +42 -0
- data/lib/pinnacle/errors/server_error.rb +11 -0
- data/lib/pinnacle/errors/timeout_error.rb +8 -0
- data/lib/pinnacle/internal/errors/constraint_error.rb +10 -0
- data/lib/pinnacle/internal/errors/type_error.rb +10 -0
- data/lib/pinnacle/internal/http/base_request.rb +31 -0
- data/lib/pinnacle/internal/http/raw_client.rb +116 -0
- data/lib/pinnacle/internal/iterators/cursor_item_iterator.rb +28 -0
- data/lib/pinnacle/internal/iterators/cursor_page_iterator.rb +51 -0
- data/lib/pinnacle/internal/iterators/item_iterator.rb +59 -0
- data/lib/pinnacle/internal/iterators/offset_item_iterator.rb +30 -0
- data/lib/pinnacle/internal/iterators/offset_page_iterator.rb +83 -0
- data/lib/pinnacle/internal/json/request.rb +39 -0
- data/lib/pinnacle/internal/json/serializable.rb +25 -0
- data/lib/pinnacle/internal/multipart/multipart_encoder.rb +141 -0
- data/lib/pinnacle/internal/multipart/multipart_form_data.rb +78 -0
- data/lib/pinnacle/internal/multipart/multipart_form_data_part.rb +51 -0
- data/lib/pinnacle/internal/multipart/multipart_request.rb +38 -0
- data/lib/pinnacle/internal/types/array.rb +47 -0
- data/lib/pinnacle/internal/types/boolean.rb +34 -0
- data/lib/pinnacle/internal/types/enum.rb +56 -0
- data/lib/pinnacle/internal/types/hash.rb +36 -0
- data/lib/pinnacle/internal/types/model/field.rb +38 -0
- data/lib/pinnacle/internal/types/model.rb +208 -0
- data/lib/pinnacle/internal/types/type.rb +35 -0
- data/lib/pinnacle/internal/types/union.rb +161 -0
- data/lib/pinnacle/internal/types/unknown.rb +15 -0
- data/lib/pinnacle/internal/types/utils.rb +116 -0
- data/lib/pinnacle/messages/blast/client.rb +143 -0
- data/lib/pinnacle/messages/blast/types/blast_mms.rb +16 -0
- data/lib/pinnacle/messages/blast/types/blast_mms_options.rb +15 -0
- data/lib/pinnacle/messages/blast/types/blast_mms_response.rb +16 -0
- data/lib/pinnacle/messages/blast/types/blast_rcs.rb +16 -0
- data/lib/pinnacle/messages/blast/types/blast_rcs_options.rb +17 -0
- data/lib/pinnacle/messages/blast/types/blast_rcs_request_options_standalone_card.rb +20 -0
- data/lib/pinnacle/messages/blast/types/blast_rcs_request_options_standalone_card_image_alignment.rb +16 -0
- data/lib/pinnacle/messages/blast/types/blast_rcs_request_options_standalone_card_orientation.rb +16 -0
- data/lib/pinnacle/messages/blast/types/blast_rcs_response.rb +16 -0
- data/lib/pinnacle/messages/blast/types/blast_sms.rb +16 -0
- data/lib/pinnacle/messages/blast/types/blast_sms_options.rb +14 -0
- data/lib/pinnacle/messages/blast/types/blast_sms_response.rb +16 -0
- data/lib/pinnacle/messages/client.rb +110 -0
- data/lib/pinnacle/messages/mms/client.rb +87 -0
- data/lib/pinnacle/messages/mms/types/mms.rb +17 -0
- data/lib/pinnacle/messages/mms/types/mms_send_response.rb +16 -0
- data/lib/pinnacle/messages/mms/types/send_mms_options.rb +17 -0
- data/lib/pinnacle/messages/rcs/client.rb +140 -0
- data/lib/pinnacle/messages/rcs/types/send_rich_message_response.rb +16 -0
- data/lib/pinnacle/messages/rcs/types/send_typing_indicator_schema.rb +15 -0
- data/lib/pinnacle/messages/rcs/types/send_typing_indicator_schema_options.rb +14 -0
- data/lib/pinnacle/messages/schedule/client.rb +53 -0
- data/lib/pinnacle/messages/sms/client.rb +87 -0
- data/lib/pinnacle/messages/sms/types/send_sms_options.rb +15 -0
- data/lib/pinnacle/messages/sms/types/sms.rb +16 -0
- data/lib/pinnacle/messages/sms/types/sms_send_response.rb +16 -0
- data/lib/pinnacle/messages/types/react_message_options.rb +11 -0
- data/lib/pinnacle/messages/types/react_message_params.rb +13 -0
- data/lib/pinnacle/phone_numbers/campaign/client.rb +90 -0
- data/lib/pinnacle/phone_numbers/campaign/types/attach_campaign_params.rb +15 -0
- data/lib/pinnacle/phone_numbers/campaign/types/detach_campaign_params.rb +13 -0
- data/lib/pinnacle/phone_numbers/client.rb +133 -0
- data/lib/pinnacle/phone_numbers/types/buy_phone_number_params.rb +11 -0
- data/lib/pinnacle/phone_numbers/types/enhanced_contact_info.rb +12 -0
- data/lib/pinnacle/phone_numbers/types/phone_details_schema_level.rb +14 -0
- data/lib/pinnacle/phone_numbers/types/phone_numbers_get_response.rb +14 -0
- data/lib/pinnacle/phone_numbers/types/retrieve_phone_number_details_options.rb +14 -0
- data/lib/pinnacle/phone_numbers/types/retrieve_phone_number_details_params.rb +13 -0
- data/lib/pinnacle/phone_numbers/types/search_phone_number_by_digits.rb +14 -0
- data/lib/pinnacle/phone_numbers/types/search_phone_number_by_location.rb +17 -0
- data/lib/pinnacle/phone_numbers/types/search_phone_number_options.rb +12 -0
- data/lib/pinnacle/phone_numbers/types/search_phone_number_params.rb +15 -0
- data/lib/pinnacle/phone_numbers/webhook/client.rb +90 -0
- data/lib/pinnacle/pinnacle_client.rb +24 -0
- data/lib/pinnacle/rcs/client.rb +159 -0
- data/lib/pinnacle/rcs/types/rcs_capabilities_query.rb +11 -0
- data/lib/pinnacle/rcs/types/rcs_link_request.rb +14 -0
- data/lib/pinnacle/rcs/types/rcs_whitelist_request.rb +12 -0
- data/lib/pinnacle/status/client.rb +19 -0
- data/lib/pinnacle/status/get/client.rb +188 -0
- data/lib/pinnacle/tools/client.rb +29 -0
- data/lib/pinnacle/tools/contact_card/client.rb +92 -0
- data/lib/pinnacle/tools/contact_card/types/get_v_card_schema_options.rb +13 -0
- data/lib/pinnacle/tools/contact_card/types/get_vcard_params.rb +14 -0
- data/lib/pinnacle/tools/contact_card/types/upsert_vcard_params.rb +29 -0
- data/lib/pinnacle/tools/file/client.rb +94 -0
- data/lib/pinnacle/tools/file/types/download_options.rb +14 -0
- data/lib/pinnacle/tools/file/types/refresh_file_params.rb +13 -0
- data/lib/pinnacle/tools/file/types/upload_file_options.rb +15 -0
- data/lib/pinnacle/tools/file/types/upload_file_params.rb +16 -0
- data/lib/pinnacle/tools/url/client.rb +128 -0
- data/lib/pinnacle/tools/url/types/create_url_params.rb +14 -0
- data/lib/pinnacle/tools/url/types/update_url_params.rb +15 -0
- data/lib/pinnacle/types/advanced_phone_information.rb +17 -0
- data/lib/pinnacle/types/advanced_phone_information_carrier.rb +13 -0
- data/lib/pinnacle/types/advanced_phone_information_contact.rb +19 -0
- data/lib/pinnacle/types/advanced_phone_information_location.rb +18 -0
- data/lib/pinnacle/types/advanced_phone_information_location_coordinates.rb +11 -0
- data/lib/pinnacle/types/advanced_phone_information_location_country.rb +12 -0
- data/lib/pinnacle/types/advanced_phone_information_type.rb +13 -0
- data/lib/pinnacle/types/advanced_phone_information_type_recommendation.rb +13 -0
- data/lib/pinnacle/types/agent.rb +11 -0
- data/lib/pinnacle/types/attach_webhook_by_id_params.rb +11 -0
- data/lib/pinnacle/types/attach_webhook_params.rb +15 -0
- data/lib/pinnacle/types/attach_webhook_response_webhook.rb +13 -0
- data/lib/pinnacle/types/attached_phone_number_result.rb +10 -0
- data/lib/pinnacle/types/audience_count_only.rb +12 -0
- data/lib/pinnacle/types/audience_with_pagination.rb +14 -0
- data/lib/pinnacle/types/autofill_campaign_params.rb +10 -0
- data/lib/pinnacle/types/autofill_dlc_campaign_response.rb +19 -0
- data/lib/pinnacle/types/autofill_dlc_response_keywords.rb +12 -0
- data/lib/pinnacle/types/autofill_dlc_response_keywords_help.rb +11 -0
- data/lib/pinnacle/types/autofill_dlc_response_keywords_opt_in.rb +11 -0
- data/lib/pinnacle/types/autofill_dlc_response_keywords_opt_out.rb +11 -0
- data/lib/pinnacle/types/autofill_dlc_response_links.rb +11 -0
- data/lib/pinnacle/types/autofill_dlc_response_options.rb +15 -0
- data/lib/pinnacle/types/autofill_dlc_response_use_case.rb +11 -0
- data/lib/pinnacle/types/bad_request_error_body.rb +12 -0
- data/lib/pinnacle/types/base_rich_message.rb +11 -0
- data/lib/pinnacle/types/basic_phone_information.rb +16 -0
- data/lib/pinnacle/types/basic_phone_information_contact.rb +10 -0
- data/lib/pinnacle/types/basic_phone_information_location.rb +11 -0
- data/lib/pinnacle/types/basic_phone_information_location_country.rb +12 -0
- data/lib/pinnacle/types/blast_details.rb +15 -0
- data/lib/pinnacle/types/brand_status.rb +12 -0
- data/lib/pinnacle/types/brand_status_enum.rb +16 -0
- data/lib/pinnacle/types/button_clicked.rb +12 -0
- data/lib/pinnacle/types/button_clicked_data.rb +11 -0
- data/lib/pinnacle/types/button_clicked_data_button.rb +14 -0
- data/lib/pinnacle/types/button_clicked_data_button_raw.rb +14 -0
- data/lib/pinnacle/types/button_clicked_data_button_type.rb +12 -0
- data/lib/pinnacle/types/buy_response_capabilities.rb +12 -0
- data/lib/pinnacle/types/campaign_enum.rb +13 -0
- data/lib/pinnacle/types/campaign_query.rb +11 -0
- data/lib/pinnacle/types/campaign_submission_result.rb +9 -0
- data/lib/pinnacle/types/campaign_validation_response_errors_item.rb +11 -0
- data/lib/pinnacle/types/campaign_validation_result.rb +10 -0
- data/lib/pinnacle/types/company_entity_type_enum.rb +15 -0
- data/lib/pinnacle/types/company_sector_enum.rb +27 -0
- data/lib/pinnacle/types/company_type_enum.rb +15 -0
- data/lib/pinnacle/types/configured_webhook.rb +13 -0
- data/lib/pinnacle/types/contact.rb +14 -0
- data/lib/pinnacle/types/contact_id.rb +9 -0
- data/lib/pinnacle/types/conversation.rb +17 -0
- data/lib/pinnacle/types/conversation_by_id_params.rb +10 -0
- data/lib/pinnacle/types/conversation_by_participants_params.rb +11 -0
- data/lib/pinnacle/types/conversation_contact.rb +11 -0
- data/lib/pinnacle/types/conversation_list.rb +12 -0
- data/lib/pinnacle/types/conversation_sender.rb +16 -0
- data/lib/pinnacle/types/create_and_attach_webhook_by_url_params.rb +12 -0
- data/lib/pinnacle/types/create_url_options.rb +9 -0
- data/lib/pinnacle/types/delete_audience_response.rb +9 -0
- data/lib/pinnacle/types/detached_phone_number_result.rb +10 -0
- data/lib/pinnacle/types/detached_webhook_info.rb +11 -0
- data/lib/pinnacle/types/detailed_phone_number_enum.rb +22 -0
- data/lib/pinnacle/types/dlc_assignment_status_enum.rb +15 -0
- data/lib/pinnacle/types/dlc_campaign_status.rb +13 -0
- data/lib/pinnacle/types/dlc_campaign_use_case_enum.rb +36 -0
- data/lib/pinnacle/types/dlc_campaign_with_extended_brand_and_status.rb +23 -0
- data/lib/pinnacle/types/dlc_with_extended_brand_and_status_keywords.rb +12 -0
- data/lib/pinnacle/types/dlc_with_extended_brand_and_status_keywords_help.rb +11 -0
- data/lib/pinnacle/types/dlc_with_extended_brand_and_status_keywords_opt_in.rb +11 -0
- data/lib/pinnacle/types/dlc_with_extended_brand_and_status_keywords_opt_out.rb +11 -0
- data/lib/pinnacle/types/dlc_with_extended_brand_and_status_links.rb +11 -0
- data/lib/pinnacle/types/dlc_with_extended_brand_and_status_mno_brand_tier.rb +14 -0
- data/lib/pinnacle/types/dlc_with_extended_brand_and_status_mno_tcr_tier.rb +20 -0
- data/lib/pinnacle/types/dlc_with_extended_brand_and_status_options.rb +15 -0
- data/lib/pinnacle/types/dlc_with_extended_brand_and_status_use_case.rb +11 -0
- data/lib/pinnacle/types/enhanced_contact.rb +23 -0
- data/lib/pinnacle/types/enhanced_contact_item.rb +13 -0
- data/lib/pinnacle/types/error.rb +10 -0
- data/lib/pinnacle/types/extended_brand.rb +13 -0
- data/lib/pinnacle/types/extended_brand_with_vetting.rb +11 -0
- data/lib/pinnacle/types/extended_rcs_campaign.rb +26 -0
- data/lib/pinnacle/types/get_conversation_params.rb +13 -0
- data/lib/pinnacle/types/get_dlc_campaign_status_response_updates.rb +15 -0
- data/lib/pinnacle/types/get_toll_free_campaign_status_response_updates.rb +15 -0
- data/lib/pinnacle/types/link_click_event.rb +57 -0
- data/lib/pinnacle/types/location_share_action.rb +9 -0
- data/lib/pinnacle/types/location_share_action_data.rb +13 -0
- data/lib/pinnacle/types/message.rb +20 -0
- data/lib/pinnacle/types/message_content.rb +15 -0
- data/lib/pinnacle/types/message_event.rb +17 -0
- data/lib/pinnacle/types/message_event_content.rb +18 -0
- data/lib/pinnacle/types/message_event_conversation.rb +12 -0
- data/lib/pinnacle/types/message_event_direction.rb +12 -0
- data/lib/pinnacle/types/message_event_mms_content.rb +13 -0
- data/lib/pinnacle/types/message_event_rcs_button_data.rb +15 -0
- data/lib/pinnacle/types/message_event_rcs_cards_content.rb +16 -0
- data/lib/pinnacle/types/message_event_rcs_cards_content_cards_item.rb +13 -0
- data/lib/pinnacle/types/message_event_rcs_location_data.rb +15 -0
- data/lib/pinnacle/types/message_event_rcs_media_content.rb +15 -0
- data/lib/pinnacle/types/message_event_rcs_text_content.rb +13 -0
- data/lib/pinnacle/types/message_event_sms_content.rb +12 -0
- data/lib/pinnacle/types/message_list.rb +12 -0
- data/lib/pinnacle/types/message_method_enum.rb +13 -0
- data/lib/pinnacle/types/message_protocol_enum.rb +13 -0
- data/lib/pinnacle/types/message_schedule.rb +13 -0
- data/lib/pinnacle/types/message_status_enum.rb +18 -0
- data/lib/pinnacle/types/message_volume_enum.rb +21 -0
- data/lib/pinnacle/types/message_with_reaction.rb +11 -0
- data/lib/pinnacle/types/message_with_reaction_direction.rb +12 -0
- data/lib/pinnacle/types/messaging_profile_enum.rb +12 -0
- data/lib/pinnacle/types/mms_content.rb +11 -0
- data/lib/pinnacle/types/mms_validation_response_segments.rb +12 -0
- data/lib/pinnacle/types/mms_validation_response_segments_value_item.rb +11 -0
- data/lib/pinnacle/types/mms_validation_result.rb +11 -0
- data/lib/pinnacle/types/not_found_error_body.rb +9 -0
- data/lib/pinnacle/types/number_format.rb +13 -0
- data/lib/pinnacle/types/opt_in_method_enum.rb +14 -0
- data/lib/pinnacle/types/optional_brand_info.rb +19 -0
- data/lib/pinnacle/types/optional_contact.rb +12 -0
- data/lib/pinnacle/types/optional_contacts.rb +13 -0
- data/lib/pinnacle/types/pagination.rb +12 -0
- data/lib/pinnacle/types/phone.rb +14 -0
- data/lib/pinnacle/types/phone_capabilities.rb +12 -0
- data/lib/pinnacle/types/phone_enum.rb +12 -0
- data/lib/pinnacle/types/phone_feature_enum.rb +18 -0
- data/lib/pinnacle/types/phone_number_campaign_attach_failed_item.rb +10 -0
- data/lib/pinnacle/types/phone_number_campaign_attach_phone_numbers_item.rb +10 -0
- data/lib/pinnacle/types/phone_number_campaign_attach_phone_numbers_item_campaign.rb +12 -0
- data/lib/pinnacle/types/phone_number_campaign_detach_failed_item.rb +10 -0
- data/lib/pinnacle/types/phone_number_campaign_detach_phone_numbers_item.rb +10 -0
- data/lib/pinnacle/types/phone_number_campaign_detach_phone_numbers_item_campaign.rb +12 -0
- data/lib/pinnacle/types/phone_number_cost.rb +12 -0
- data/lib/pinnacle/types/phone_number_details.rb +15 -0
- data/lib/pinnacle/types/phone_number_enum.rb +18 -0
- data/lib/pinnacle/types/phone_number_region.rb +13 -0
- data/lib/pinnacle/types/phone_number_status.rb +12 -0
- data/lib/pinnacle/types/phone_number_status_enum.rb +13 -0
- data/lib/pinnacle/types/pinnacle_file_upload_metadata.rb +12 -0
- data/lib/pinnacle/types/pinnacle_url_config.rb +10 -0
- data/lib/pinnacle/types/profile_status_enum.rb +14 -0
- data/lib/pinnacle/types/purchased_number.rb +12 -0
- data/lib/pinnacle/types/rcs_button_call.rb +12 -0
- data/lib/pinnacle/types/rcs_button_open_url.rb +13 -0
- data/lib/pinnacle/types/rcs_button_open_url_webview_mode.rb +13 -0
- data/lib/pinnacle/types/rcs_button_request_user_location.rb +11 -0
- data/lib/pinnacle/types/rcs_button_schedule_event.rb +15 -0
- data/lib/pinnacle/types/rcs_button_send_location.rb +13 -0
- data/lib/pinnacle/types/rcs_button_send_location_lat_long.rb +11 -0
- data/lib/pinnacle/types/rcs_button_trigger.rb +12 -0
- data/lib/pinnacle/types/rcs_campaign.rb +23 -0
- data/lib/pinnacle/types/rcs_campaign_schema_agent.rb +17 -0
- data/lib/pinnacle/types/rcs_campaign_schema_agent_emails_item.rb +10 -0
- data/lib/pinnacle/types/rcs_campaign_schema_agent_phones_item.rb +10 -0
- data/lib/pinnacle/types/rcs_campaign_schema_agent_websites_item.rb +10 -0
- data/lib/pinnacle/types/rcs_campaign_schema_extra_agent.rb +17 -0
- data/lib/pinnacle/types/rcs_campaign_schema_extra_agent_emails_item.rb +10 -0
- data/lib/pinnacle/types/rcs_campaign_schema_extra_agent_phones_item.rb +10 -0
- data/lib/pinnacle/types/rcs_campaign_schema_extra_agent_websites_item.rb +10 -0
- data/lib/pinnacle/types/rcs_campaign_schema_extra_keywords.rb +11 -0
- data/lib/pinnacle/types/rcs_campaign_schema_extra_keywords_help.rb +10 -0
- data/lib/pinnacle/types/rcs_campaign_schema_extra_keywords_opt_in.rb +10 -0
- data/lib/pinnacle/types/rcs_campaign_schema_extra_keywords_opt_out.rb +10 -0
- data/lib/pinnacle/types/rcs_campaign_schema_extra_links.rb +11 -0
- data/lib/pinnacle/types/rcs_campaign_schema_extra_traffic.rb +10 -0
- data/lib/pinnacle/types/rcs_campaign_schema_extra_use_case.rb +11 -0
- data/lib/pinnacle/types/rcs_campaign_schema_keywords.rb +11 -0
- data/lib/pinnacle/types/rcs_campaign_schema_keywords_help.rb +10 -0
- data/lib/pinnacle/types/rcs_campaign_schema_keywords_opt_in.rb +10 -0
- data/lib/pinnacle/types/rcs_campaign_schema_keywords_opt_out.rb +10 -0
- data/lib/pinnacle/types/rcs_campaign_schema_links.rb +11 -0
- data/lib/pinnacle/types/rcs_campaign_schema_traffic.rb +10 -0
- data/lib/pinnacle/types/rcs_campaign_schema_use_case.rb +11 -0
- data/lib/pinnacle/types/rcs_campaign_status.rb +12 -0
- data/lib/pinnacle/types/rcs_campaign_use_case_enum.rb +24 -0
- data/lib/pinnacle/types/rcs_capabilities_result.rb +23 -0
- data/lib/pinnacle/types/rcs_capability.rb +11 -0
- data/lib/pinnacle/types/rcs_capability_actions.rb +16 -0
- data/lib/pinnacle/types/rcs_capability_cards.rb +10 -0
- data/lib/pinnacle/types/rcs_cards_content.rb +13 -0
- data/lib/pinnacle/types/rcs_cards_content_cards_item.rb +13 -0
- data/lib/pinnacle/types/rcs_content.rb +14 -0
- data/lib/pinnacle/types/rcs_link_result.rb +13 -0
- data/lib/pinnacle/types/rcs_media_content.rb +13 -0
- data/lib/pinnacle/types/rcs_media_details_content.rb +12 -0
- data/lib/pinnacle/types/rcs_messaging_type_enum.rb +14 -0
- data/lib/pinnacle/types/rcs_validate_content.rb +13 -0
- data/lib/pinnacle/types/rcs_validate_content_media.rb +13 -0
- data/lib/pinnacle/types/rcs_validation_result.rb +12 -0
- data/lib/pinnacle/types/rcs_whitelist_response.rb +10 -0
- data/lib/pinnacle/types/reaction_result.rb +10 -0
- data/lib/pinnacle/types/refreshed_file.rb +10 -0
- data/lib/pinnacle/types/rich_button.rb +18 -0
- data/lib/pinnacle/types/rich_card.rb +13 -0
- data/lib/pinnacle/types/rich_cards.rb +13 -0
- data/lib/pinnacle/types/rich_cards_message.rb +11 -0
- data/lib/pinnacle/types/rich_media_message.rb +10 -0
- data/lib/pinnacle/types/rich_message.rb +13 -0
- data/lib/pinnacle/types/rich_standalone_card_options.rb +17 -0
- data/lib/pinnacle/types/rich_text.rb +11 -0
- data/lib/pinnacle/types/rich_text_message.rb +7 -0
- data/lib/pinnacle/types/schedule_cancel_result.rb +10 -0
- data/lib/pinnacle/types/scheduled_blast_details.rb +11 -0
- data/lib/pinnacle/types/scheduled_blast_response_config.rb +13 -0
- data/lib/pinnacle/types/scheduled_message.rb +10 -0
- data/lib/pinnacle/types/scheduled_send_response_config.rb +13 -0
- data/lib/pinnacle/types/send_rcs_card_options_standalone_card_image_alignment.rb +12 -0
- data/lib/pinnacle/types/send_rcs_card_options_standalone_card_orientation.rb +12 -0
- data/lib/pinnacle/types/send_rich_cards_options.rb +9 -0
- data/lib/pinnacle/types/send_rich_message_options.rb +14 -0
- data/lib/pinnacle/types/send_sms_response_segments.rb +11 -0
- data/lib/pinnacle/types/send_sms_response_segments_encoding.rb +12 -0
- data/lib/pinnacle/types/send_typing_indicator_response.rb +14 -0
- data/lib/pinnacle/types/sender.rb +23 -0
- data/lib/pinnacle/types/sent_mms_details.rb +14 -0
- data/lib/pinnacle/types/sent_rich_message.rb +14 -0
- data/lib/pinnacle/types/sent_sms_details.rb +14 -0
- data/lib/pinnacle/types/shortened_url.rb +10 -0
- data/lib/pinnacle/types/shortened_url_with_click_data.rb +9 -0
- data/lib/pinnacle/types/sms_content.rb +10 -0
- data/lib/pinnacle/types/sms_validation_response_segments.rb +11 -0
- data/lib/pinnacle/types/sms_validation_response_segments_gsm_7.rb +12 -0
- data/lib/pinnacle/types/sms_validation_response_segments_utf_16.rb +11 -0
- data/lib/pinnacle/types/sms_validation_response_total.rb +10 -0
- data/lib/pinnacle/types/sms_validation_result.rb +12 -0
- data/lib/pinnacle/types/sub_use_case_enum.rb +20 -0
- data/lib/pinnacle/types/submission_results.rb +9 -0
- data/lib/pinnacle/types/successful_conversation_update.rb +10 -0
- data/lib/pinnacle/types/toll_free_campaign.rb +17 -0
- data/lib/pinnacle/types/toll_free_campaign_schema_keywords.rb +11 -0
- data/lib/pinnacle/types/toll_free_campaign_schema_keywords_help.rb +10 -0
- data/lib/pinnacle/types/toll_free_campaign_schema_keywords_opt_in.rb +11 -0
- data/lib/pinnacle/types/toll_free_campaign_schema_links.rb +11 -0
- data/lib/pinnacle/types/toll_free_campaign_schema_opt_in.rb +12 -0
- data/lib/pinnacle/types/toll_free_campaign_schema_options.rb +10 -0
- data/lib/pinnacle/types/toll_free_campaign_schema_use_case.rb +11 -0
- data/lib/pinnacle/types/toll_free_campaign_status.rb +12 -0
- data/lib/pinnacle/types/toll_free_campaign_use_case_enum.rb +53 -0
- data/lib/pinnacle/types/toll_free_campaign_with_extended_brand_and_status.rb +19 -0
- data/lib/pinnacle/types/toll_free_status_enum.rb +16 -0
- data/lib/pinnacle/types/toll_free_with_extended_brand_and_status_keywords.rb +11 -0
- data/lib/pinnacle/types/toll_free_with_extended_brand_and_status_keywords_help.rb +10 -0
- data/lib/pinnacle/types/toll_free_with_extended_brand_and_status_keywords_opt_in.rb +11 -0
- data/lib/pinnacle/types/toll_free_with_extended_brand_and_status_links.rb +11 -0
- data/lib/pinnacle/types/toll_free_with_extended_brand_and_status_opt_in.rb +12 -0
- data/lib/pinnacle/types/toll_free_with_extended_brand_and_status_options.rb +10 -0
- data/lib/pinnacle/types/toll_free_with_extended_brand_and_status_use_case.rb +11 -0
- data/lib/pinnacle/types/tracking.rb +12 -0
- data/lib/pinnacle/types/updated_contact_id.rb +9 -0
- data/lib/pinnacle/types/upload_results.rb +11 -0
- data/lib/pinnacle/types/user_event.rb +12 -0
- data/lib/pinnacle/types/user_event_conversation.rb +12 -0
- data/lib/pinnacle/types/v_card_address_schema_type_item.rb +17 -0
- data/lib/pinnacle/types/v_card_data.rb +9 -0
- data/lib/pinnacle/types/v_card_data_file.rb +11 -0
- data/lib/pinnacle/types/v_card_data_file_metadata.rb +10 -0
- data/lib/pinnacle/types/v_card_email_schema_type_item.rb +23 -0
- data/lib/pinnacle/types/v_card_geo.rb +11 -0
- data/lib/pinnacle/types/v_card_name.rb +14 -0
- data/lib/pinnacle/types/v_card_organization.rb +11 -0
- data/lib/pinnacle/types/v_card_phone_schema_type_item.rb +23 -0
- data/lib/pinnacle/types/validate_campaign_params.rb +10 -0
- data/lib/pinnacle/types/validation_error_details.rb +11 -0
- data/lib/pinnacle/types/validation_results.rb +10 -0
- data/lib/pinnacle/types/vcard.rb +24 -0
- data/lib/pinnacle/types/vcard_address.rb +17 -0
- data/lib/pinnacle/types/vcard_content.rb +9 -0
- data/lib/pinnacle/types/vcard_email.rb +10 -0
- data/lib/pinnacle/types/vcard_phone.rb +10 -0
- data/lib/pinnacle/types/vcard_resource.rb +10 -0
- data/lib/pinnacle/types/vetting_feedback.rb +12 -0
- data/lib/pinnacle/types/vetting_history.rb +13 -0
- data/lib/pinnacle/types/vetting_history_vetting_status.rb +14 -0
- data/lib/pinnacle/types/vetting_results.rb +9 -0
- data/lib/pinnacle/types/webhook_event_enum.rb +12 -0
- data/lib/pinnacle/types/webhook_result.rb +11 -0
- data/lib/pinnacle/types/webhooks.rb +12 -0
- data/lib/pinnacle/types/zod_error.rb +10 -0
- data/lib/pinnacle/version.rb +5 -0
- data/lib/pinnacle/webhooks/client.rb +51 -0
- data/lib/pinnacle/webhooks/types/get_webhook_params.rb +11 -0
- data/lib/pinnacle/wrapper/messages/client.rb +72 -0
- data/lib/pinnacle/wrapper/tools/client.rb +14 -0
- data/lib/pinnacle/wrapper/tools/file_uploader.rb +149 -0
- data/lib/pinnacle.rb +450 -0
- data/reference.md +5956 -0
- data/wiremock/docker-compose.test.yml +14 -0
- data/wiremock/wiremock-mappings.json +1 -0
- metadata +468 -456
- data/lib/gemconfig.rb +0 -14
- data/lib/rcs/audiences/client.rb +0 -347
- data/lib/rcs/audiences/contacts/client.rb +0 -177
- data/lib/rcs/audiences/types/audiences_get_response.rb +0 -58
- data/lib/rcs/brands/client.rb +0 -605
- data/lib/rcs/brands/types/autofill_brand_options.rb +0 -61
- data/lib/rcs/brands/types/upsert_brand_schema_contact.rb +0 -86
- data/lib/rcs/brands/types/upsert_brand_schema_entity_type.rb +0 -16
- data/lib/rcs/brands/types/upsert_brand_schema_sector.rb +0 -28
- data/lib/rcs/brands/types/upsert_brand_schema_type.rb +0 -16
- data/lib/rcs/campaigns/client.rb +0 -44
- data/lib/rcs/campaigns/dlc/client.rb +0 -492
- data/lib/rcs/campaigns/dlc/types/dlc_campaign_help_keywords.rb +0 -74
- data/lib/rcs/campaigns/dlc/types/dlc_campaign_keywords.rb +0 -99
- data/lib/rcs/campaigns/dlc/types/dlc_campaign_links.rb +0 -74
- data/lib/rcs/campaigns/dlc/types/dlc_campaign_opt_in_keywords.rb +0 -74
- data/lib/rcs/campaigns/dlc/types/dlc_campaign_opt_out_keywords.rb +0 -74
- data/lib/rcs/campaigns/dlc/types/dlc_campaign_options.rb +0 -110
- data/lib/rcs/campaigns/dlc/types/dlc_campaign_use_case.rb +0 -76
- data/lib/rcs/campaigns/rcs/client.rb +0 -566
- data/lib/rcs/campaigns/rcs/types/rcs_agent.rb +0 -152
- data/lib/rcs/campaigns/rcs/types/rcs_agent_email.rb +0 -73
- data/lib/rcs/campaigns/rcs/types/rcs_agent_phone.rb +0 -73
- data/lib/rcs/campaigns/rcs/types/rcs_agent_website.rb +0 -73
- data/lib/rcs/campaigns/rcs/types/rcs_autofill_response.rb +0 -246
- data/lib/rcs/campaigns/rcs/types/rcs_campaign_help_keywords.rb +0 -77
- data/lib/rcs/campaigns/rcs/types/rcs_campaign_keywords.rb +0 -98
- data/lib/rcs/campaigns/rcs/types/rcs_campaign_opt_in_keywords.rb +0 -87
- data/lib/rcs/campaigns/rcs/types/rcs_campaign_opt_out_keywords.rb +0 -83
- data/lib/rcs/campaigns/rcs/types/rcs_campaign_traffic.rb +0 -76
- data/lib/rcs/campaigns/rcs/types/rcs_links.rb +0 -74
- data/lib/rcs/campaigns/rcs/types/rcs_use_case.rb +0 -75
- data/lib/rcs/campaigns/toll_free/client.rb +0 -478
- data/lib/rcs/campaigns/toll_free/types/toll_free_autofill_response.rb +0 -172
- data/lib/rcs/campaigns/toll_free/types/toll_free_campaign_help_keywords.rb +0 -66
- data/lib/rcs/campaigns/toll_free/types/toll_free_campaign_keywords.rb +0 -86
- data/lib/rcs/campaigns/toll_free/types/toll_free_campaign_links.rb +0 -74
- data/lib/rcs/campaigns/toll_free/types/toll_free_campaign_opt_in.rb +0 -86
- data/lib/rcs/campaigns/toll_free/types/toll_free_campaign_opt_in_keywords.rb +0 -78
- data/lib/rcs/campaigns/toll_free/types/toll_free_campaign_options.rb +0 -64
- data/lib/rcs/campaigns/toll_free/types/toll_free_campaign_use_case.rb +0 -75
- data/lib/rcs/contacts/client.rb +0 -277
- data/lib/rcs/conversations/client.rb +0 -401
- data/lib/rcs/conversations/types/conversations_list_messages_request_direction.rb +0 -12
- data/lib/rcs/conversations/types/conversations_list_messages_request_sort_order.rb +0 -12
- data/lib/rcs/conversations/types/conversations_list_messages_request_status.rb +0 -17
- data/lib/rcs/conversations/types/conversations_list_messages_request_type.rb +0 -13
- data/lib/rcs/messages/blast/client.rb +0 -425
- data/lib/rcs/messages/blast/types/blast_mms_options.rb +0 -82
- data/lib/rcs/messages/blast/types/blast_mms_response.rb +0 -60
- data/lib/rcs/messages/blast/types/blast_rcs_options.rb +0 -118
- data/lib/rcs/messages/blast/types/blast_rcs_request_options_standalone_card.rb +0 -82
- data/lib/rcs/messages/blast/types/blast_rcs_request_options_standalone_card_image_alignment.rb +0 -16
- data/lib/rcs/messages/blast/types/blast_rcs_request_options_standalone_card_orientation.rb +0 -15
- data/lib/rcs/messages/blast/types/blast_rcs_response.rb +0 -60
- data/lib/rcs/messages/blast/types/blast_sms_options.rb +0 -70
- data/lib/rcs/messages/blast/types/blast_sms_response.rb +0 -60
- data/lib/rcs/messages/client.rb +0 -189
- data/lib/rcs/messages/mms/client.rb +0 -216
- data/lib/rcs/messages/mms/types/mms_send_response.rb +0 -60
- data/lib/rcs/messages/mms/types/send_mms_options.rb +0 -108
- data/lib/rcs/messages/rcs/client.rb +0 -286
- data/lib/rcs/messages/rcs/types/send_rich_message_response.rb +0 -60
- data/lib/rcs/messages/rcs/types/send_typing_indicator_schema_options.rb +0 -66
- data/lib/rcs/messages/schedule/client.rb +0 -103
- data/lib/rcs/messages/sms/client.rb +0 -198
- data/lib/rcs/messages/sms/types/send_sms_options.rb +0 -81
- data/lib/rcs/messages/sms/types/sms_send_response.rb +0 -60
- data/lib/rcs/messages/types/react_message_options.rb +0 -71
- data/lib/rcs/phone_numbers/campaign/client.rb +0 -197
- data/lib/rcs/phone_numbers/client.rb +0 -345
- data/lib/rcs/phone_numbers/types/enhanced_contact_info.rb +0 -62
- data/lib/rcs/phone_numbers/types/phone_details_schema_level.rb +0 -16
- data/lib/rcs/phone_numbers/types/phone_numbers_get_response.rb +0 -58
- data/lib/rcs/phone_numbers/types/retrieve_phone_number_details_options.rb +0 -93
- data/lib/rcs/phone_numbers/types/search_phone_number_by_digits.rb +0 -81
- data/lib/rcs/phone_numbers/types/search_phone_number_by_location.rb +0 -96
- data/lib/rcs/phone_numbers/types/search_phone_number_options.rb +0 -62
- data/lib/rcs/phone_numbers/webhook/client.rb +0 -193
- data/lib/rcs/rcs/client.rb +0 -332
- data/lib/rcs/status/client.rb +0 -30
- data/lib/rcs/status/get/client.rb +0 -383
- data/lib/rcs/tools/client.rb +0 -44
- data/lib/rcs/tools/contact_card/client.rb +0 -295
- data/lib/rcs/tools/contact_card/types/get_v_card_schema_options.rb +0 -67
- data/lib/rcs/tools/file/client.rb +0 -228
- data/lib/rcs/tools/file/types/download_options.rb +0 -66
- data/lib/rcs/tools/file/types/upload_file_options.rb +0 -88
- data/lib/rcs/tools/url/client.rb +0 -247
- data/lib/rcs/types/advanced_phone_information.rb +0 -147
- data/lib/rcs/types/advanced_phone_information_carrier.rb +0 -90
- data/lib/rcs/types/advanced_phone_information_contact.rb +0 -146
- data/lib/rcs/types/advanced_phone_information_location.rb +0 -142
- data/lib/rcs/types/advanced_phone_information_location_coordinates.rb +0 -73
- data/lib/rcs/types/advanced_phone_information_location_country.rb +0 -77
- data/lib/rcs/types/advanced_phone_information_type.rb +0 -97
- data/lib/rcs/types/advanced_phone_information_type_recommendation.rb +0 -15
- data/lib/rcs/types/agent.rb +0 -68
- data/lib/rcs/types/attach_webhook_by_id_params.rb +0 -77
- data/lib/rcs/types/attach_webhook_params.rb +0 -60
- data/lib/rcs/types/attach_webhook_response_webhook.rb +0 -88
- data/lib/rcs/types/attached_phone_number_result.rb +0 -75
- data/lib/rcs/types/audience_count_only.rb +0 -87
- data/lib/rcs/types/audience_with_pagination.rb +0 -114
- data/lib/rcs/types/autofill_campaign_params.rb +0 -81
- data/lib/rcs/types/autofill_dlc_campaign_response.rb +0 -173
- data/lib/rcs/types/autofill_dlc_response_keywords.rb +0 -93
- data/lib/rcs/types/autofill_dlc_response_keywords_help.rb +0 -70
- data/lib/rcs/types/autofill_dlc_response_keywords_opt_in.rb +0 -70
- data/lib/rcs/types/autofill_dlc_response_keywords_opt_out.rb +0 -70
- data/lib/rcs/types/autofill_dlc_response_links.rb +0 -70
- data/lib/rcs/types/autofill_dlc_response_options.rb +0 -106
- data/lib/rcs/types/autofill_dlc_response_use_case.rb +0 -72
- data/lib/rcs/types/bad_request_error_body.rb +0 -56
- data/lib/rcs/types/base_rich_message.rb +0 -82
- data/lib/rcs/types/basic_phone_information.rb +0 -127
- data/lib/rcs/types/basic_phone_information_contact.rb +0 -58
- data/lib/rcs/types/basic_phone_information_location.rb +0 -74
- data/lib/rcs/types/basic_phone_information_location_country.rb +0 -75
- data/lib/rcs/types/blast_details.rb +0 -110
- data/lib/rcs/types/brand_status.rb +0 -94
- data/lib/rcs/types/brand_status_enum.rb +0 -21
- data/lib/rcs/types/button_clicked.rb +0 -56
- data/lib/rcs/types/button_clicked_data.rb +0 -80
- data/lib/rcs/types/button_clicked_data_button.rb +0 -118
- data/lib/rcs/types/button_clicked_data_button_raw.rb +0 -58
- data/lib/rcs/types/button_clicked_data_button_type.rb +0 -15
- data/lib/rcs/types/buy_response_capabilities.rb +0 -77
- data/lib/rcs/types/campaign_enum.rb +0 -15
- data/lib/rcs/types/campaign_query.rb +0 -77
- data/lib/rcs/types/campaign_submission_result.rb +0 -57
- data/lib/rcs/types/campaign_validation_response_errors_item.rb +0 -76
- data/lib/rcs/types/campaign_validation_result.rb +0 -71
- data/lib/rcs/types/company_entity_type_enum.rb +0 -14
- data/lib/rcs/types/company_sector_enum.rb +0 -26
- data/lib/rcs/types/company_type_enum.rb +0 -14
- data/lib/rcs/types/configured_webhook.rb +0 -85
- data/lib/rcs/types/contact.rb +0 -107
- data/lib/rcs/types/contact_id.rb +0 -59
- data/lib/rcs/types/conversation.rb +0 -154
- data/lib/rcs/types/conversation_by_id_params.rb +0 -62
- data/lib/rcs/types/conversation_by_participants_params.rb +0 -72
- data/lib/rcs/types/conversation_contact.rb +0 -70
- data/lib/rcs/types/conversation_list.rb +0 -79
- data/lib/rcs/types/conversation_sender.rb +0 -60
- data/lib/rcs/types/create_and_attach_webhook_by_url_params.rb +0 -88
- data/lib/rcs/types/create_url_options.rb +0 -63
- data/lib/rcs/types/delete_audience_response.rb +0 -57
- data/lib/rcs/types/detached_phone_number_result.rb +0 -75
- data/lib/rcs/types/detached_webhook_info.rb +0 -76
- data/lib/rcs/types/detailed_phone_number_enum.rb +0 -25
- data/lib/rcs/types/dlc_assignment_status_enum.rb +0 -19
- data/lib/rcs/types/dlc_campaign_status.rb +0 -109
- data/lib/rcs/types/dlc_campaign_use_case_enum.rb +0 -35
- data/lib/rcs/types/dlc_campaign_with_extended_brand_and_status.rb +0 -224
- data/lib/rcs/types/dlc_with_extended_brand_and_status_keywords.rb +0 -94
- data/lib/rcs/types/dlc_with_extended_brand_and_status_keywords_help.rb +0 -72
- data/lib/rcs/types/dlc_with_extended_brand_and_status_keywords_opt_in.rb +0 -72
- data/lib/rcs/types/dlc_with_extended_brand_and_status_keywords_opt_out.rb +0 -72
- data/lib/rcs/types/dlc_with_extended_brand_and_status_links.rb +0 -70
- data/lib/rcs/types/dlc_with_extended_brand_and_status_mno_brand_tier.rb +0 -15
- data/lib/rcs/types/dlc_with_extended_brand_and_status_mno_tcr_tier.rb +0 -22
- data/lib/rcs/types/dlc_with_extended_brand_and_status_options.rb +0 -106
- data/lib/rcs/types/dlc_with_extended_brand_and_status_use_case.rb +0 -72
- data/lib/rcs/types/enhanced_contact.rb +0 -9
- data/lib/rcs/types/enhanced_contact_item.rb +0 -104
- data/lib/rcs/types/error.rb +0 -61
- data/lib/rcs/types/extended_brand.rb +0 -215
- data/lib/rcs/types/extended_brand_with_vetting.rb +0 -247
- data/lib/rcs/types/extended_rcs_campaign.rb +0 -267
- data/lib/rcs/types/get_conversation_params.rb +0 -57
- data/lib/rcs/types/get_dlc_campaign_status_response_updates.rb +0 -96
- data/lib/rcs/types/get_toll_free_campaign_status_response_updates.rb +0 -92
- data/lib/rcs/types/link_click_event.rb +0 -449
- data/lib/rcs/types/location_share_action.rb +0 -63
- data/lib/rcs/types/location_share_action_data.rb +0 -89
- data/lib/rcs/types/message.rb +0 -176
- data/lib/rcs/types/message_content.rb +0 -85
- data/lib/rcs/types/message_event.rb +0 -143
- data/lib/rcs/types/message_event_content.rb +0 -127
- data/lib/rcs/types/message_event_conversation.rb +0 -82
- data/lib/rcs/types/message_event_direction.rb +0 -11
- data/lib/rcs/types/message_event_mms_content.rb +0 -94
- data/lib/rcs/types/message_event_rcs_button_data.rb +0 -104
- data/lib/rcs/types/message_event_rcs_cards_content.rb +0 -103
- data/lib/rcs/types/message_event_rcs_cards_content_cards_item.rb +0 -96
- data/lib/rcs/types/message_event_rcs_location_data.rb +0 -91
- data/lib/rcs/types/message_event_rcs_media_content.rb +0 -96
- data/lib/rcs/types/message_event_rcs_text_content.rb +0 -94
- data/lib/rcs/types/message_event_sms_content.rb +0 -81
- data/lib/rcs/types/message_list.rb +0 -79
- data/lib/rcs/types/message_method_enum.rb +0 -12
- data/lib/rcs/types/message_protocol_enum.rb +0 -12
- data/lib/rcs/types/message_schedule.rb +0 -121
- data/lib/rcs/types/message_status_enum.rb +0 -17
- data/lib/rcs/types/message_volume_enum.rb +0 -20
- data/lib/rcs/types/message_with_reaction.rb +0 -197
- data/lib/rcs/types/message_with_reaction_direction.rb +0 -11
- data/lib/rcs/types/messaging_profile_enum.rb +0 -11
- data/lib/rcs/types/mms_content.rb +0 -74
- data/lib/rcs/types/mms_validation_response_segments.rb +0 -85
- data/lib/rcs/types/mms_validation_response_segments_value_item.rb +0 -75
- data/lib/rcs/types/mms_validation_result.rb +0 -82
- data/lib/rcs/types/not_found_error_body.rb +0 -59
- data/lib/rcs/types/number_format.rb +0 -79
- data/lib/rcs/types/opt_in_method_enum.rb +0 -13
- data/lib/rcs/types/optional_brand_info.rb +0 -154
- data/lib/rcs/types/optional_contact.rb +0 -83
- data/lib/rcs/types/optional_contacts.rb +0 -84
- data/lib/rcs/types/pagination.rb +0 -81
- data/lib/rcs/types/phone.rb +0 -101
- data/lib/rcs/types/phone_capabilities.rb +0 -75
- data/lib/rcs/types/phone_enum.rb +0 -13
- data/lib/rcs/types/phone_feature_enum.rb +0 -18
- data/lib/rcs/types/phone_number_campaign_attach_failed_item.rb +0 -67
- data/lib/rcs/types/phone_number_campaign_attach_phone_numbers_item.rb +0 -75
- data/lib/rcs/types/phone_number_campaign_attach_phone_numbers_item_campaign.rb +0 -82
- data/lib/rcs/types/phone_number_campaign_detach_failed_item.rb +0 -67
- data/lib/rcs/types/phone_number_campaign_detach_phone_numbers_item.rb +0 -75
- data/lib/rcs/types/phone_number_campaign_detach_phone_numbers_item_campaign.rb +0 -82
- data/lib/rcs/types/phone_number_cost.rb +0 -75
- data/lib/rcs/types/phone_number_details.rb +0 -110
- data/lib/rcs/types/phone_number_enum.rb +0 -18
- data/lib/rcs/types/phone_number_region.rb +0 -91
- data/lib/rcs/types/phone_number_status.rb +0 -90
- data/lib/rcs/types/phone_number_status_enum.rb +0 -16
- data/lib/rcs/types/pinnacle_file_upload_metadata.rb +0 -100
- data/lib/rcs/types/pinnacle_url_config.rb +0 -71
- data/lib/rcs/types/profile_status_enum.rb +0 -17
- data/lib/rcs/types/purchased_number.rb +0 -75
- data/lib/rcs/types/rcs_button_call.rb +0 -77
- data/lib/rcs/types/rcs_button_open_url.rb +0 -104
- data/lib/rcs/types/rcs_button_open_url_webview_mode.rb +0 -19
- data/lib/rcs/types/rcs_button_request_user_location.rb +0 -70
- data/lib/rcs/types/rcs_button_schedule_event.rb +0 -106
- data/lib/rcs/types/rcs_button_send_location.rb +0 -94
- data/lib/rcs/types/rcs_button_send_location_lat_long.rb +0 -68
- data/lib/rcs/types/rcs_button_trigger.rb +0 -80
- data/lib/rcs/types/rcs_campaign.rb +0 -234
- data/lib/rcs/types/rcs_campaign_schema_agent.rb +0 -134
- data/lib/rcs/types/rcs_campaign_schema_agent_emails_item.rb +0 -69
- data/lib/rcs/types/rcs_campaign_schema_agent_phones_item.rb +0 -69
- data/lib/rcs/types/rcs_campaign_schema_agent_websites_item.rb +0 -69
- data/lib/rcs/types/rcs_campaign_schema_extra_agent.rb +0 -134
- data/lib/rcs/types/rcs_campaign_schema_extra_agent_emails_item.rb +0 -70
- data/lib/rcs/types/rcs_campaign_schema_extra_agent_phones_item.rb +0 -70
- data/lib/rcs/types/rcs_campaign_schema_extra_agent_websites_item.rb +0 -71
- data/lib/rcs/types/rcs_campaign_schema_extra_keywords.rb +0 -94
- data/lib/rcs/types/rcs_campaign_schema_extra_keywords_help.rb +0 -71
- data/lib/rcs/types/rcs_campaign_schema_extra_keywords_opt_in.rb +0 -73
- data/lib/rcs/types/rcs_campaign_schema_extra_keywords_opt_out.rb +0 -73
- data/lib/rcs/types/rcs_campaign_schema_extra_links.rb +0 -70
- data/lib/rcs/types/rcs_campaign_schema_extra_traffic.rb +0 -72
- data/lib/rcs/types/rcs_campaign_schema_extra_use_case.rb +0 -71
- data/lib/rcs/types/rcs_campaign_schema_keywords.rb +0 -94
- data/lib/rcs/types/rcs_campaign_schema_keywords_help.rb +0 -71
- data/lib/rcs/types/rcs_campaign_schema_keywords_opt_in.rb +0 -73
- data/lib/rcs/types/rcs_campaign_schema_keywords_opt_out.rb +0 -73
- data/lib/rcs/types/rcs_campaign_schema_links.rb +0 -70
- data/lib/rcs/types/rcs_campaign_schema_traffic.rb +0 -72
- data/lib/rcs/types/rcs_campaign_schema_use_case.rb +0 -71
- data/lib/rcs/types/rcs_campaign_status.rb +0 -88
- data/lib/rcs/types/rcs_campaign_use_case_enum.rb +0 -23
- data/lib/rcs/types/rcs_capabilities_result.rb +0 -7
- data/lib/rcs/types/rcs_capability.rb +0 -82
- data/lib/rcs/types/rcs_capability_actions.rb +0 -105
- data/lib/rcs/types/rcs_capability_cards.rb +0 -67
- data/lib/rcs/types/rcs_cards_content.rb +0 -83
- data/lib/rcs/types/rcs_cards_content_cards_item.rb +0 -98
- data/lib/rcs/types/rcs_content.rb +0 -72
- data/lib/rcs/types/rcs_link_result.rb +0 -75
- data/lib/rcs/types/rcs_media_content.rb +0 -83
- data/lib/rcs/types/rcs_media_details_content.rb +0 -77
- data/lib/rcs/types/rcs_messaging_type_enum.rb +0 -17
- data/lib/rcs/types/rcs_validate_content.rb +0 -70
- data/lib/rcs/types/rcs_validate_content_media.rb +0 -75
- data/lib/rcs/types/rcs_validation_result.rb +0 -83
- data/lib/rcs/types/rcs_whitelist_response.rb +0 -58
- data/lib/rcs/types/reaction_result.rb +0 -71
- data/lib/rcs/types/refreshed_file.rb +0 -67
- data/lib/rcs/types/rich_button.rb +0 -148
- data/lib/rcs/types/rich_card.rb +0 -92
- data/lib/rcs/types/rich_cards.rb +0 -83
- data/lib/rcs/types/rich_cards_message.rb +0 -114
- data/lib/rcs/types/rich_media_message.rb +0 -112
- data/lib/rcs/types/rich_message.rb +0 -70
- data/lib/rcs/types/rich_standalone_card_options.rb +0 -80
- data/lib/rcs/types/rich_text.rb +0 -74
- data/lib/rcs/types/rich_text_message.rb +0 -108
- data/lib/rcs/types/schedule_cancel_result.rb +0 -58
- data/lib/rcs/types/scheduled_blast_details.rb +0 -76
- data/lib/rcs/types/scheduled_blast_response_config.rb +0 -89
- data/lib/rcs/types/scheduled_message.rb +0 -75
- data/lib/rcs/types/scheduled_send_response_config.rb +0 -89
- data/lib/rcs/types/send_rcs_card_options_standalone_card_image_alignment.rb +0 -12
- data/lib/rcs/types/send_rcs_card_options_standalone_card_orientation.rb +0 -11
- data/lib/rcs/types/send_rich_cards_options.rb +0 -136
- data/lib/rcs/types/send_rich_message_options.rb +0 -111
- data/lib/rcs/types/send_sms_response_segments.rb +0 -69
- data/lib/rcs/types/send_sms_response_segments_encoding.rb +0 -11
- data/lib/rcs/types/send_typing_indicator_response.rb +0 -100
- data/lib/rcs/types/sent_mms_details.rb +0 -118
- data/lib/rcs/types/sent_rich_message.rb +0 -104
- data/lib/rcs/types/sent_sms_details.rb +0 -110
- data/lib/rcs/types/shortened_url.rb +0 -77
- data/lib/rcs/types/shortened_url_with_click_data.rb +0 -90
- data/lib/rcs/types/sms_content.rb +0 -58
- data/lib/rcs/types/sms_validation_response_segments.rb +0 -80
- data/lib/rcs/types/sms_validation_response_segments_gsm_7.rb +0 -75
- data/lib/rcs/types/sms_validation_response_segments_utf_16.rb +0 -68
- data/lib/rcs/types/sms_validation_response_total.rb +0 -75
- data/lib/rcs/types/sms_validation_result.rb +0 -102
- data/lib/rcs/types/sub_use_case_enum.rb +0 -19
- data/lib/rcs/types/submission_results.rb +0 -57
- data/lib/rcs/types/successful_conversation_update.rb +0 -58
- data/lib/rcs/types/toll_free_campaign.rb +0 -160
- data/lib/rcs/types/toll_free_campaign_schema_keywords.rb +0 -82
- data/lib/rcs/types/toll_free_campaign_schema_keywords_help.rb +0 -62
- data/lib/rcs/types/toll_free_campaign_schema_keywords_opt_in.rb +0 -74
- data/lib/rcs/types/toll_free_campaign_schema_links.rb +0 -70
- data/lib/rcs/types/toll_free_campaign_schema_opt_in.rb +0 -78
- data/lib/rcs/types/toll_free_campaign_schema_options.rb +0 -60
- data/lib/rcs/types/toll_free_campaign_schema_use_case.rb +0 -71
- data/lib/rcs/types/toll_free_campaign_status.rb +0 -93
- data/lib/rcs/types/toll_free_campaign_use_case_enum.rb +0 -52
- data/lib/rcs/types/toll_free_campaign_with_extended_brand_and_status.rb +0 -195
- data/lib/rcs/types/toll_free_status_enum.rb +0 -20
- data/lib/rcs/types/tracking.rb +0 -17
- data/lib/rcs/types/updated_contact_id.rb +0 -59
- data/lib/rcs/types/upload_results.rb +0 -80
- data/lib/rcs/types/user_event.rb +0 -83
- data/lib/rcs/types/user_event_conversation.rb +0 -78
- data/lib/rcs/types/v_card_address_schema_type_item.rb +0 -15
- data/lib/rcs/types/v_card_data.rb +0 -239
- data/lib/rcs/types/v_card_data_file.rb +0 -74
- data/lib/rcs/types/v_card_data_file_metadata.rb +0 -62
- data/lib/rcs/types/v_card_email_schema_type_item.rb +0 -21
- data/lib/rcs/types/v_card_geo.rb +0 -70
- data/lib/rcs/types/v_card_name.rb +0 -98
- data/lib/rcs/types/v_card_organization.rb +0 -70
- data/lib/rcs/types/v_card_phone_schema_type_item.rb +0 -21
- data/lib/rcs/types/validate_campaign_params.rb +0 -81
- data/lib/rcs/types/validation_error_details.rb +0 -76
- data/lib/rcs/types/validation_results.rb +0 -71
- data/lib/rcs/types/vcard.rb +0 -217
- data/lib/rcs/types/vcard_address.rb +0 -130
- data/lib/rcs/types/vcard_content.rb +0 -225
- data/lib/rcs/types/vcard_email.rb +0 -70
- data/lib/rcs/types/vcard_phone.rb +0 -70
- data/lib/rcs/types/vcard_resource.rb +0 -73
- data/lib/rcs/types/vetting_feedback.rb +0 -81
- data/lib/rcs/types/vetting_history.rb +0 -98
- data/lib/rcs/types/vetting_history_vetting_status.rb +0 -13
- data/lib/rcs/types/vetting_results.rb +0 -57
- data/lib/rcs/types/webhook_event_enum.rb +0 -14
- data/lib/rcs/types/webhook_result.rb +0 -64
- data/lib/rcs/types/webhooks.rb +0 -77
- data/lib/rcs/types/zod_error.rb +0 -73
- data/lib/rcs/webhooks/client.rb +0 -97
- data/lib/rcs.rb +0 -124
- data/lib/requests.rb +0 -163
- data/lib/types_export.rb +0 -334
- /data/lib/{environment.rb → pinnacle/environment.rb} +0 -0
|
@@ -0,0 +1,245 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Pinnacle
|
|
4
|
+
module Brands
|
|
5
|
+
class Client
|
|
6
|
+
# @param client [Pinnacle::Internal::Http::RawClient]
|
|
7
|
+
#
|
|
8
|
+
# @return [void]
|
|
9
|
+
def initialize(client:)
|
|
10
|
+
@client = client
|
|
11
|
+
end
|
|
12
|
+
|
|
13
|
+
# Automatically populate brand information based on partial input data you provide.
|
|
14
|
+
#
|
|
15
|
+
# @param request_options [Hash]
|
|
16
|
+
# @param params [Pinnacle::Brands::Types::AutofillBrandParams]
|
|
17
|
+
# @option request_options [String] :base_url
|
|
18
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
19
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
20
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
21
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
22
|
+
#
|
|
23
|
+
# @return [Pinnacle::Types::OptionalBrandInfo]
|
|
24
|
+
def autofill(request_options: {}, **params)
|
|
25
|
+
params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
|
|
26
|
+
body_prop_names = %i[additional_info name options website]
|
|
27
|
+
body_bag = params.slice(*body_prop_names)
|
|
28
|
+
|
|
29
|
+
request = Pinnacle::Internal::JSON::Request.new(
|
|
30
|
+
base_url: request_options[:base_url],
|
|
31
|
+
method: "POST",
|
|
32
|
+
path: "brands/autofill",
|
|
33
|
+
body: Pinnacle::Brands::Types::AutofillBrandParams.new(body_bag).to_h,
|
|
34
|
+
request_options: request_options
|
|
35
|
+
)
|
|
36
|
+
begin
|
|
37
|
+
response = @client.send(request)
|
|
38
|
+
rescue Net::HTTPRequestTimeout
|
|
39
|
+
raise Pinnacle::Errors::TimeoutError
|
|
40
|
+
end
|
|
41
|
+
code = response.code.to_i
|
|
42
|
+
if code.between?(200, 299)
|
|
43
|
+
Pinnacle::Types::OptionalBrandInfo.load(response.body)
|
|
44
|
+
else
|
|
45
|
+
error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
|
|
46
|
+
raise error_class.new(response.body, code: code)
|
|
47
|
+
end
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
# Create a new brand or update an existing one.
|
|
51
|
+
#
|
|
52
|
+
# <Note>
|
|
53
|
+
# **To create a new brand:** Omit `id` — one will be generated automatically.
|
|
54
|
+
#
|
|
55
|
+
# All fields are **required** except `description` and `dba`, and will be validated when
|
|
56
|
+
# [submitted](/api-reference/brands/submit).
|
|
57
|
+
# </Note>
|
|
58
|
+
#
|
|
59
|
+
# @param request_options [Hash]
|
|
60
|
+
# @param params [Pinnacle::Brands::Types::UpsertBrandParams]
|
|
61
|
+
# @option request_options [String] :base_url
|
|
62
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
63
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
64
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
65
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
66
|
+
#
|
|
67
|
+
# @return [Pinnacle::Types::ExtendedBrand]
|
|
68
|
+
def upsert(request_options: {}, **params)
|
|
69
|
+
params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
|
|
70
|
+
body_prop_names = %i[address contact dba description ein email id name sector type entity_type website]
|
|
71
|
+
body_bag = params.slice(*body_prop_names)
|
|
72
|
+
|
|
73
|
+
request = Pinnacle::Internal::JSON::Request.new(
|
|
74
|
+
base_url: request_options[:base_url],
|
|
75
|
+
method: "POST",
|
|
76
|
+
path: "brands",
|
|
77
|
+
body: Pinnacle::Brands::Types::UpsertBrandParams.new(body_bag).to_h,
|
|
78
|
+
request_options: request_options
|
|
79
|
+
)
|
|
80
|
+
begin
|
|
81
|
+
response = @client.send(request)
|
|
82
|
+
rescue Net::HTTPRequestTimeout
|
|
83
|
+
raise Pinnacle::Errors::TimeoutError
|
|
84
|
+
end
|
|
85
|
+
code = response.code.to_i
|
|
86
|
+
if code.between?(200, 299)
|
|
87
|
+
Pinnacle::Types::ExtendedBrand.load(response.body)
|
|
88
|
+
else
|
|
89
|
+
error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
|
|
90
|
+
raise error_class.new(response.body, code: code)
|
|
91
|
+
end
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
# Retrieve detailed information for a specific brand in your account by ID.
|
|
95
|
+
#
|
|
96
|
+
# @param request_options [Hash]
|
|
97
|
+
# @param params [Hash]
|
|
98
|
+
# @option request_options [String] :base_url
|
|
99
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
100
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
101
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
102
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
103
|
+
# @option params [String] :id
|
|
104
|
+
# @option params [Boolean, nil] :hide_ein
|
|
105
|
+
#
|
|
106
|
+
# @return [Pinnacle::Types::ExtendedBrandWithVetting]
|
|
107
|
+
def get(request_options: {}, **params)
|
|
108
|
+
params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
|
|
109
|
+
query_param_names = %i[hide_ein]
|
|
110
|
+
query_params = {}
|
|
111
|
+
query_params["hideEIN"] = params[:hide_ein] if params.key?(:hide_ein)
|
|
112
|
+
params = params.except(*query_param_names)
|
|
113
|
+
|
|
114
|
+
request = Pinnacle::Internal::JSON::Request.new(
|
|
115
|
+
base_url: request_options[:base_url],
|
|
116
|
+
method: "GET",
|
|
117
|
+
path: "brands/#{params[:id]}",
|
|
118
|
+
query: query_params,
|
|
119
|
+
request_options: request_options
|
|
120
|
+
)
|
|
121
|
+
begin
|
|
122
|
+
response = @client.send(request)
|
|
123
|
+
rescue Net::HTTPRequestTimeout
|
|
124
|
+
raise Pinnacle::Errors::TimeoutError
|
|
125
|
+
end
|
|
126
|
+
code = response.code.to_i
|
|
127
|
+
if code.between?(200, 299)
|
|
128
|
+
Pinnacle::Types::ExtendedBrandWithVetting.load(response.body)
|
|
129
|
+
else
|
|
130
|
+
error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
|
|
131
|
+
raise error_class.new(response.body, code: code)
|
|
132
|
+
end
|
|
133
|
+
end
|
|
134
|
+
|
|
135
|
+
# Submit your brand for review and approval by the compliance team.
|
|
136
|
+
#
|
|
137
|
+
# @param request_options [Hash]
|
|
138
|
+
# @param params [Hash]
|
|
139
|
+
# @option request_options [String] :base_url
|
|
140
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
141
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
142
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
143
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
144
|
+
# @option params [String] :brand_id
|
|
145
|
+
#
|
|
146
|
+
# @return [Pinnacle::Types::SubmissionResults]
|
|
147
|
+
def submit(request_options: {}, **params)
|
|
148
|
+
params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
|
|
149
|
+
request = Pinnacle::Internal::JSON::Request.new(
|
|
150
|
+
base_url: request_options[:base_url],
|
|
151
|
+
method: "POST",
|
|
152
|
+
path: "brands/#{params[:brand_id]}/submit",
|
|
153
|
+
request_options: request_options
|
|
154
|
+
)
|
|
155
|
+
begin
|
|
156
|
+
response = @client.send(request)
|
|
157
|
+
rescue Net::HTTPRequestTimeout
|
|
158
|
+
raise Pinnacle::Errors::TimeoutError
|
|
159
|
+
end
|
|
160
|
+
code = response.code.to_i
|
|
161
|
+
if code.between?(200, 299)
|
|
162
|
+
Pinnacle::Types::SubmissionResults.load(response.body)
|
|
163
|
+
else
|
|
164
|
+
error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
|
|
165
|
+
raise error_class.new(response.body, code: code)
|
|
166
|
+
end
|
|
167
|
+
end
|
|
168
|
+
|
|
169
|
+
# Validate your brand information for compliance and correctness before submission or storage.
|
|
170
|
+
#
|
|
171
|
+
# @param request_options [Hash]
|
|
172
|
+
# @param params [Pinnacle::Types::OptionalBrandInfo]
|
|
173
|
+
# @option request_options [String] :base_url
|
|
174
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
175
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
176
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
177
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
178
|
+
#
|
|
179
|
+
# @return [Pinnacle::Types::ValidationResults]
|
|
180
|
+
def validate(request_options: {}, **params)
|
|
181
|
+
params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
|
|
182
|
+
request = Pinnacle::Internal::JSON::Request.new(
|
|
183
|
+
base_url: request_options[:base_url],
|
|
184
|
+
method: "POST",
|
|
185
|
+
path: "brands/validate",
|
|
186
|
+
body: Pinnacle::Types::OptionalBrandInfo.new(params).to_h,
|
|
187
|
+
request_options: request_options
|
|
188
|
+
)
|
|
189
|
+
begin
|
|
190
|
+
response = @client.send(request)
|
|
191
|
+
rescue Net::HTTPRequestTimeout
|
|
192
|
+
raise Pinnacle::Errors::TimeoutError
|
|
193
|
+
end
|
|
194
|
+
code = response.code.to_i
|
|
195
|
+
if code.between?(200, 299)
|
|
196
|
+
Pinnacle::Types::ValidationResults.load(response.body)
|
|
197
|
+
else
|
|
198
|
+
error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
|
|
199
|
+
raise error_class.new(response.body, code: code)
|
|
200
|
+
end
|
|
201
|
+
end
|
|
202
|
+
|
|
203
|
+
# Submit a brand for external vetting verification to enhance your brand's trust score and improved message
|
|
204
|
+
# delivery rates.
|
|
205
|
+
#
|
|
206
|
+
# @param request_options [Hash]
|
|
207
|
+
# @param params [Pinnacle::Brands::Types::VetBrandParams]
|
|
208
|
+
# @option request_options [String] :base_url
|
|
209
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
210
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
211
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
212
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
213
|
+
# @option params [String] :brand_id
|
|
214
|
+
#
|
|
215
|
+
# @return [Pinnacle::Types::VettingResults]
|
|
216
|
+
def vet(request_options: {}, **params)
|
|
217
|
+
params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
|
|
218
|
+
path_param_names = %i[brand_id]
|
|
219
|
+
body_params = params.except(*path_param_names)
|
|
220
|
+
body_prop_names = %i[type provider vetting_class]
|
|
221
|
+
body_bag = body_params.slice(*body_prop_names)
|
|
222
|
+
|
|
223
|
+
request = Pinnacle::Internal::JSON::Request.new(
|
|
224
|
+
base_url: request_options[:base_url],
|
|
225
|
+
method: "POST",
|
|
226
|
+
path: "brands/#{params[:brand_id]}/vet",
|
|
227
|
+
body: Pinnacle::Brands::Types::VetBrandParams.new(body_bag).to_h,
|
|
228
|
+
request_options: request_options
|
|
229
|
+
)
|
|
230
|
+
begin
|
|
231
|
+
response = @client.send(request)
|
|
232
|
+
rescue Net::HTTPRequestTimeout
|
|
233
|
+
raise Pinnacle::Errors::TimeoutError
|
|
234
|
+
end
|
|
235
|
+
code = response.code.to_i
|
|
236
|
+
if code.between?(200, 299)
|
|
237
|
+
Pinnacle::Types::VettingResults.load(response.body)
|
|
238
|
+
else
|
|
239
|
+
error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
|
|
240
|
+
raise error_class.new(response.body, code: code)
|
|
241
|
+
end
|
|
242
|
+
end
|
|
243
|
+
end
|
|
244
|
+
end
|
|
245
|
+
end
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Pinnacle
|
|
4
|
+
module Brands
|
|
5
|
+
module Types
|
|
6
|
+
class AutofillBrandOptions < Internal::Types::Model
|
|
7
|
+
field :force_reload, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "forceReload"
|
|
8
|
+
end
|
|
9
|
+
end
|
|
10
|
+
end
|
|
11
|
+
end
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Pinnacle
|
|
4
|
+
module Brands
|
|
5
|
+
module Types
|
|
6
|
+
class AutofillBrandParams < Internal::Types::Model
|
|
7
|
+
field :additional_info, -> { String }, optional: true, nullable: false
|
|
8
|
+
field :name, -> { String }, optional: true, nullable: false
|
|
9
|
+
field :options, -> { Pinnacle::Brands::Types::AutofillBrandOptions }, optional: true, nullable: false
|
|
10
|
+
field :website, -> { String }, optional: true, nullable: false
|
|
11
|
+
end
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
end
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Pinnacle
|
|
4
|
+
module Brands
|
|
5
|
+
module Types
|
|
6
|
+
class BrandsGetRequest < Internal::Types::Model
|
|
7
|
+
field :id, -> { String }, optional: false, nullable: false
|
|
8
|
+
field :hide_ein, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "hideEIN"
|
|
9
|
+
end
|
|
10
|
+
end
|
|
11
|
+
end
|
|
12
|
+
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Pinnacle
|
|
4
|
+
module Brands
|
|
5
|
+
module Types
|
|
6
|
+
class UpsertBrandParams < Internal::Types::Model
|
|
7
|
+
field :address, -> { String }, optional: true, nullable: false
|
|
8
|
+
field :contact, -> { Pinnacle::Brands::Types::UpsertBrandSchemaContact }, optional: true, nullable: false
|
|
9
|
+
field :dba, -> { String }, optional: true, nullable: false
|
|
10
|
+
field :description, -> { String }, optional: true, nullable: false
|
|
11
|
+
field :ein, -> { String }, optional: true, nullable: false
|
|
12
|
+
field :email, -> { String }, optional: true, nullable: false
|
|
13
|
+
field :id, -> { String }, optional: true, nullable: false
|
|
14
|
+
field :name, -> { String }, optional: true, nullable: false
|
|
15
|
+
field :sector, -> { Pinnacle::Brands::Types::UpsertBrandSchemaSector }, optional: true, nullable: false
|
|
16
|
+
field :type, -> { Pinnacle::Brands::Types::UpsertBrandSchemaType }, optional: true, nullable: false
|
|
17
|
+
field :entity_type, -> { Pinnacle::Brands::Types::UpsertBrandSchemaEntityType }, optional: true, nullable: false, api_name: "entityType"
|
|
18
|
+
field :website, -> { String }, optional: true, nullable: false
|
|
19
|
+
end
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Pinnacle
|
|
4
|
+
module Brands
|
|
5
|
+
module Types
|
|
6
|
+
# Contact information for the brand.
|
|
7
|
+
class UpsertBrandSchemaContact < Internal::Types::Model
|
|
8
|
+
field :email, -> { String }, optional: true, nullable: false
|
|
9
|
+
field :name, -> { String }, optional: true, nullable: false
|
|
10
|
+
field :phone, -> { String }, optional: true, nullable: false
|
|
11
|
+
field :title, -> { String }, optional: true, nullable: false
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
end
|
|
15
|
+
end
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Pinnacle
|
|
4
|
+
module Brands
|
|
5
|
+
module Types
|
|
6
|
+
module UpsertBrandSchemaEntityType
|
|
7
|
+
extend Pinnacle::Internal::Types::Enum
|
|
8
|
+
|
|
9
|
+
LLC = "LLC"
|
|
10
|
+
SOLE_PROPRIETORSHIP = "SOLE_PROPRIETORSHIP"
|
|
11
|
+
PARTNERSHIP = "PARTNERSHIP"
|
|
12
|
+
CORP = "CORP"
|
|
13
|
+
S_CORP = "S_CORP"
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Pinnacle
|
|
4
|
+
module Brands
|
|
5
|
+
module Types
|
|
6
|
+
module UpsertBrandSchemaSector
|
|
7
|
+
extend Pinnacle::Internal::Types::Enum
|
|
8
|
+
|
|
9
|
+
AGRICULTURE = "AGRICULTURE"
|
|
10
|
+
COMMUNICATION = "COMMUNICATION"
|
|
11
|
+
CONSTRUCTION = "CONSTRUCTION"
|
|
12
|
+
EDUCATION = "EDUCATION"
|
|
13
|
+
ENERGY = "ENERGY"
|
|
14
|
+
ENTERTAINMENT = "ENTERTAINMENT"
|
|
15
|
+
FINANCIAL = "FINANCIAL"
|
|
16
|
+
GAMBLING = "GAMBLING"
|
|
17
|
+
GOVERNMENT = "GOVERNMENT"
|
|
18
|
+
HEALTHCARE = "HEALTHCARE"
|
|
19
|
+
HOSPITALITY = "HOSPITALITY"
|
|
20
|
+
INSURANCE = "INSURANCE"
|
|
21
|
+
MANUFACTURING = "MANUFACTURING"
|
|
22
|
+
NGO = "NGO"
|
|
23
|
+
REAL_ESTATE = "REAL_ESTATE"
|
|
24
|
+
RETAIL = "RETAIL"
|
|
25
|
+
TECHNOLOGY = "TECHNOLOGY"
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
end
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Pinnacle
|
|
4
|
+
module Brands
|
|
5
|
+
module Types
|
|
6
|
+
module UpsertBrandSchemaType
|
|
7
|
+
extend Pinnacle::Internal::Types::Enum
|
|
8
|
+
|
|
9
|
+
GOVERNMENT = "GOVERNMENT"
|
|
10
|
+
NON_PROFIT = "NON_PROFIT"
|
|
11
|
+
PRIVATE_PROFIT = "PRIVATE_PROFIT"
|
|
12
|
+
PUBLIC_PROFIT = "PUBLIC_PROFIT"
|
|
13
|
+
SOLE_PROPRIETOR = "SOLE_PROPRIETOR"
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Pinnacle
|
|
4
|
+
module Brands
|
|
5
|
+
module Types
|
|
6
|
+
class VetBrandParams < Internal::Types::Model
|
|
7
|
+
field :brand_id, -> { String }, optional: false, nullable: false, api_name: "brandId"
|
|
8
|
+
field :type, -> { String }, optional: false, nullable: false
|
|
9
|
+
field :provider, -> { String }, optional: false, nullable: false
|
|
10
|
+
field :vetting_class, -> { String }, optional: false, nullable: false, api_name: "vettingClass"
|
|
11
|
+
end
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
end
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Pinnacle
|
|
4
|
+
module Campaigns
|
|
5
|
+
class Client
|
|
6
|
+
# @param client [Pinnacle::Internal::Http::RawClient]
|
|
7
|
+
#
|
|
8
|
+
# @return [void]
|
|
9
|
+
def initialize(client:)
|
|
10
|
+
@client = client
|
|
11
|
+
end
|
|
12
|
+
|
|
13
|
+
# @return [Pinnacle::Dlc::Client]
|
|
14
|
+
def dlc
|
|
15
|
+
@dlc ||= Pinnacle::Campaigns::Dlc::Client.new(client: @client)
|
|
16
|
+
end
|
|
17
|
+
|
|
18
|
+
# @return [Pinnacle::TollFree::Client]
|
|
19
|
+
def toll_free
|
|
20
|
+
@toll_free ||= Pinnacle::Campaigns::TollFree::Client.new(client: @client)
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
# @return [Pinnacle::Rcs::Client]
|
|
24
|
+
def rcs
|
|
25
|
+
@rcs ||= Pinnacle::Campaigns::Rcs::Client.new(client: @client)
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
end
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Pinnacle
|
|
4
|
+
module Campaigns
|
|
5
|
+
module Dlc
|
|
6
|
+
class Client
|
|
7
|
+
# @param client [Pinnacle::Internal::Http::RawClient]
|
|
8
|
+
#
|
|
9
|
+
# @return [void]
|
|
10
|
+
def initialize(client:)
|
|
11
|
+
@client = client
|
|
12
|
+
end
|
|
13
|
+
|
|
14
|
+
# Generate campaign details based off existing campaign and the brand it's connected to.
|
|
15
|
+
#
|
|
16
|
+
# @param request_options [Hash]
|
|
17
|
+
# @param params [Pinnacle::Types::AutofillCampaignParams]
|
|
18
|
+
# @option request_options [String] :base_url
|
|
19
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
20
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
21
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
22
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
23
|
+
#
|
|
24
|
+
# @return [Pinnacle::Types::AutofillDlcCampaignResponse]
|
|
25
|
+
def autofill(request_options: {}, **params)
|
|
26
|
+
params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
|
|
27
|
+
request = Pinnacle::Internal::JSON::Request.new(
|
|
28
|
+
base_url: request_options[:base_url],
|
|
29
|
+
method: "POST",
|
|
30
|
+
path: "campaigns/dlc/autofill",
|
|
31
|
+
body: Pinnacle::Types::AutofillCampaignParams.new(params).to_h,
|
|
32
|
+
request_options: request_options
|
|
33
|
+
)
|
|
34
|
+
begin
|
|
35
|
+
response = @client.send(request)
|
|
36
|
+
rescue Net::HTTPRequestTimeout
|
|
37
|
+
raise Pinnacle::Errors::TimeoutError
|
|
38
|
+
end
|
|
39
|
+
code = response.code.to_i
|
|
40
|
+
if code.between?(200, 299)
|
|
41
|
+
Pinnacle::Types::AutofillDlcCampaignResponse.load(response.body)
|
|
42
|
+
else
|
|
43
|
+
error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
|
|
44
|
+
raise error_class.new(response.body, code: code)
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
# Retrieve 10DLC campaign.
|
|
49
|
+
#
|
|
50
|
+
# @param request_options [Hash]
|
|
51
|
+
# @param params [Hash]
|
|
52
|
+
# @option request_options [String] :base_url
|
|
53
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
54
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
55
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
56
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
57
|
+
# @option params [String] :campaign_id
|
|
58
|
+
#
|
|
59
|
+
# @return [Pinnacle::Types::DlcCampaignWithExtendedBrandAndStatus]
|
|
60
|
+
def get(request_options: {}, **params)
|
|
61
|
+
params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
|
|
62
|
+
request = Pinnacle::Internal::JSON::Request.new(
|
|
63
|
+
base_url: request_options[:base_url],
|
|
64
|
+
method: "GET",
|
|
65
|
+
path: "campaigns/dlc/#{params[:campaign_id]}",
|
|
66
|
+
request_options: request_options
|
|
67
|
+
)
|
|
68
|
+
begin
|
|
69
|
+
response = @client.send(request)
|
|
70
|
+
rescue Net::HTTPRequestTimeout
|
|
71
|
+
raise Pinnacle::Errors::TimeoutError
|
|
72
|
+
end
|
|
73
|
+
code = response.code.to_i
|
|
74
|
+
if code.between?(200, 299)
|
|
75
|
+
Pinnacle::Types::DlcCampaignWithExtendedBrandAndStatus.load(response.body)
|
|
76
|
+
else
|
|
77
|
+
error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
|
|
78
|
+
raise error_class.new(response.body, code: code)
|
|
79
|
+
end
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
# Submit your 10DLC campaign for approval and activation with carriers.
|
|
83
|
+
#
|
|
84
|
+
# @param request_options [Hash]
|
|
85
|
+
# @param params [Hash]
|
|
86
|
+
# @option request_options [String] :base_url
|
|
87
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
88
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
89
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
90
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
91
|
+
# @option params [String] :campaign_id
|
|
92
|
+
#
|
|
93
|
+
# @return [Pinnacle::Types::CampaignSubmissionResult]
|
|
94
|
+
def submit(request_options: {}, **params)
|
|
95
|
+
params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
|
|
96
|
+
request = Pinnacle::Internal::JSON::Request.new(
|
|
97
|
+
base_url: request_options[:base_url],
|
|
98
|
+
method: "POST",
|
|
99
|
+
path: "campaigns/dlc/submit/#{params[:campaign_id]}",
|
|
100
|
+
request_options: request_options
|
|
101
|
+
)
|
|
102
|
+
begin
|
|
103
|
+
response = @client.send(request)
|
|
104
|
+
rescue Net::HTTPRequestTimeout
|
|
105
|
+
raise Pinnacle::Errors::TimeoutError
|
|
106
|
+
end
|
|
107
|
+
code = response.code.to_i
|
|
108
|
+
if code.between?(200, 299)
|
|
109
|
+
Pinnacle::Types::CampaignSubmissionResult.load(response.body)
|
|
110
|
+
else
|
|
111
|
+
error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
|
|
112
|
+
raise error_class.new(response.body, code: code)
|
|
113
|
+
end
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
# Create a new 10DLC campaign or update an existing one.
|
|
117
|
+
#
|
|
118
|
+
# <Note>
|
|
119
|
+
# **To create a new campaign:** Omit `campaignId` — one will be generated automatically.
|
|
120
|
+
#
|
|
121
|
+
# **Before you start:** Create a [brand](/api-reference/brands/upsert) first — you'll need its `id` for the
|
|
122
|
+
# [`brand`](#request.body.brand) field.
|
|
123
|
+
#
|
|
124
|
+
# All fields are **required** unless specified otherwise, and will be validated when
|
|
125
|
+
# [submitted](/api-reference/campaigns/10-dlc/submit).
|
|
126
|
+
#
|
|
127
|
+
# **See the response for example values for each field.**
|
|
128
|
+
# </Note>
|
|
129
|
+
#
|
|
130
|
+
# @param request_options [Hash]
|
|
131
|
+
# @param params [Pinnacle::Campaigns::Dlc::Types::UpsertDlcCampaignParams]
|
|
132
|
+
# @option request_options [String] :base_url
|
|
133
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
134
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
135
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
136
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
137
|
+
#
|
|
138
|
+
# @return [Pinnacle::Types::DlcCampaignWithExtendedBrandAndStatus]
|
|
139
|
+
def upsert(request_options: {}, **params)
|
|
140
|
+
params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
|
|
141
|
+
body_prop_names = %i[auto_renew brand campaign_id description keywords links message_flow name options sample_messages use_case]
|
|
142
|
+
body_bag = params.slice(*body_prop_names)
|
|
143
|
+
|
|
144
|
+
request = Pinnacle::Internal::JSON::Request.new(
|
|
145
|
+
base_url: request_options[:base_url],
|
|
146
|
+
method: "POST",
|
|
147
|
+
path: "campaigns/dlc",
|
|
148
|
+
body: Pinnacle::Campaigns::Dlc::Types::UpsertDlcCampaignParams.new(body_bag).to_h,
|
|
149
|
+
request_options: request_options
|
|
150
|
+
)
|
|
151
|
+
begin
|
|
152
|
+
response = @client.send(request)
|
|
153
|
+
rescue Net::HTTPRequestTimeout
|
|
154
|
+
raise Pinnacle::Errors::TimeoutError
|
|
155
|
+
end
|
|
156
|
+
code = response.code.to_i
|
|
157
|
+
if code.between?(200, 299)
|
|
158
|
+
Pinnacle::Types::DlcCampaignWithExtendedBrandAndStatus.load(response.body)
|
|
159
|
+
else
|
|
160
|
+
error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
|
|
161
|
+
raise error_class.new(response.body, code: code)
|
|
162
|
+
end
|
|
163
|
+
end
|
|
164
|
+
|
|
165
|
+
# Validate your 10DLC campaign configuration against carrier requirements and compliance rules.
|
|
166
|
+
#
|
|
167
|
+
# @param request_options [Hash]
|
|
168
|
+
# @param params [Pinnacle::Types::ValidateCampaignParams]
|
|
169
|
+
# @option request_options [String] :base_url
|
|
170
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
171
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
172
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
173
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
174
|
+
#
|
|
175
|
+
# @return [Pinnacle::Types::CampaignValidationResult]
|
|
176
|
+
def validate(request_options: {}, **params)
|
|
177
|
+
params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
|
|
178
|
+
request = Pinnacle::Internal::JSON::Request.new(
|
|
179
|
+
base_url: request_options[:base_url],
|
|
180
|
+
method: "POST",
|
|
181
|
+
path: "campaigns/dlc/validate",
|
|
182
|
+
body: Pinnacle::Types::ValidateCampaignParams.new(params).to_h,
|
|
183
|
+
request_options: request_options
|
|
184
|
+
)
|
|
185
|
+
begin
|
|
186
|
+
response = @client.send(request)
|
|
187
|
+
rescue Net::HTTPRequestTimeout
|
|
188
|
+
raise Pinnacle::Errors::TimeoutError
|
|
189
|
+
end
|
|
190
|
+
code = response.code.to_i
|
|
191
|
+
if code.between?(200, 299)
|
|
192
|
+
Pinnacle::Types::CampaignValidationResult.load(response.body)
|
|
193
|
+
else
|
|
194
|
+
error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
|
|
195
|
+
raise error_class.new(response.body, code: code)
|
|
196
|
+
end
|
|
197
|
+
end
|
|
198
|
+
end
|
|
199
|
+
end
|
|
200
|
+
end
|
|
201
|
+
end
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Pinnacle
|
|
4
|
+
module Campaigns
|
|
5
|
+
module Dlc
|
|
6
|
+
module Types
|
|
7
|
+
# Help keyword settings.
|
|
8
|
+
class DlcCampaignHelpKeywords < Internal::Types::Model
|
|
9
|
+
field :message, -> { String }, optional: true, nullable: false
|
|
10
|
+
field :values, -> { Internal::Types::Array[String] }, optional: true, nullable: false
|
|
11
|
+
end
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
end
|
|
15
|
+
end
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Pinnacle
|
|
4
|
+
module Campaigns
|
|
5
|
+
module Dlc
|
|
6
|
+
module Types
|
|
7
|
+
# Keyword response configuration.
|
|
8
|
+
class DlcCampaignKeywords < Internal::Types::Model
|
|
9
|
+
field :help, -> { Pinnacle::Campaigns::Dlc::Types::DlcCampaignHelpKeywords }, optional: true, nullable: false, api_name: "HELP"
|
|
10
|
+
field :opt_in, -> { Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptInKeywords }, optional: true, nullable: false, api_name: "OPT_IN"
|
|
11
|
+
field :opt_out, -> { Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptOutKeywords }, optional: true, nullable: false, api_name: "OPT_OUT"
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|