rcs 2.0.5.pre.rc.1 → 2.0.5
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/lib/gemconfig.rb +14 -0
- data/lib/rcs/audiences/client.rb +347 -0
- data/lib/rcs/audiences/contacts/client.rb +177 -0
- data/lib/rcs/audiences/types/audiences_get_response.rb +58 -0
- data/lib/rcs/brands/client.rb +605 -0
- data/lib/rcs/brands/types/autofill_brand_options.rb +61 -0
- data/lib/rcs/brands/types/upsert_brand_schema_contact.rb +86 -0
- data/lib/rcs/brands/types/upsert_brand_schema_entity_type.rb +16 -0
- data/lib/rcs/brands/types/upsert_brand_schema_sector.rb +28 -0
- data/lib/rcs/brands/types/upsert_brand_schema_type.rb +16 -0
- data/lib/rcs/campaigns/client.rb +44 -0
- data/lib/rcs/campaigns/dlc/client.rb +492 -0
- data/lib/rcs/campaigns/dlc/types/dlc_campaign_help_keywords.rb +74 -0
- data/lib/rcs/campaigns/dlc/types/dlc_campaign_keywords.rb +99 -0
- data/lib/rcs/campaigns/dlc/types/dlc_campaign_links.rb +74 -0
- data/lib/rcs/campaigns/dlc/types/dlc_campaign_opt_in_keywords.rb +74 -0
- data/lib/rcs/campaigns/dlc/types/dlc_campaign_opt_out_keywords.rb +74 -0
- data/lib/rcs/campaigns/dlc/types/dlc_campaign_options.rb +110 -0
- data/lib/rcs/campaigns/dlc/types/dlc_campaign_use_case.rb +76 -0
- data/lib/rcs/campaigns/rcs/client.rb +566 -0
- data/lib/rcs/campaigns/rcs/types/rcs_agent.rb +152 -0
- data/lib/rcs/campaigns/rcs/types/rcs_agent_email.rb +73 -0
- data/lib/rcs/campaigns/rcs/types/rcs_agent_phone.rb +73 -0
- data/lib/rcs/campaigns/rcs/types/rcs_agent_website.rb +73 -0
- data/lib/rcs/campaigns/rcs/types/rcs_autofill_response.rb +246 -0
- data/lib/rcs/campaigns/rcs/types/rcs_campaign_help_keywords.rb +77 -0
- data/lib/rcs/campaigns/rcs/types/rcs_campaign_keywords.rb +98 -0
- data/lib/rcs/campaigns/rcs/types/rcs_campaign_opt_in_keywords.rb +87 -0
- data/lib/rcs/campaigns/rcs/types/rcs_campaign_opt_out_keywords.rb +83 -0
- data/lib/rcs/campaigns/rcs/types/rcs_campaign_traffic.rb +76 -0
- data/lib/rcs/campaigns/rcs/types/rcs_links.rb +74 -0
- data/lib/rcs/campaigns/rcs/types/rcs_use_case.rb +75 -0
- data/lib/rcs/campaigns/toll_free/client.rb +478 -0
- data/lib/rcs/campaigns/toll_free/types/toll_free_autofill_response.rb +172 -0
- data/lib/rcs/campaigns/toll_free/types/toll_free_campaign_help_keywords.rb +66 -0
- data/lib/rcs/campaigns/toll_free/types/toll_free_campaign_keywords.rb +86 -0
- data/lib/rcs/campaigns/toll_free/types/toll_free_campaign_links.rb +74 -0
- data/lib/rcs/campaigns/toll_free/types/toll_free_campaign_opt_in.rb +86 -0
- data/lib/rcs/campaigns/toll_free/types/toll_free_campaign_opt_in_keywords.rb +78 -0
- data/lib/rcs/campaigns/toll_free/types/toll_free_campaign_options.rb +64 -0
- data/lib/rcs/campaigns/toll_free/types/toll_free_campaign_use_case.rb +75 -0
- data/lib/rcs/contacts/client.rb +277 -0
- data/lib/rcs/conversations/client.rb +401 -0
- data/lib/rcs/conversations/types/conversations_list_messages_request_direction.rb +12 -0
- data/lib/rcs/conversations/types/conversations_list_messages_request_sort_order.rb +12 -0
- data/lib/rcs/conversations/types/conversations_list_messages_request_status.rb +17 -0
- data/lib/rcs/conversations/types/conversations_list_messages_request_type.rb +13 -0
- data/lib/rcs/messages/blast/client.rb +425 -0
- data/lib/rcs/messages/blast/types/blast_mms_options.rb +82 -0
- data/lib/rcs/messages/blast/types/blast_mms_response.rb +60 -0
- data/lib/rcs/messages/blast/types/blast_rcs_options.rb +118 -0
- data/lib/rcs/messages/blast/types/blast_rcs_request_options_standalone_card.rb +82 -0
- data/lib/rcs/messages/blast/types/blast_rcs_request_options_standalone_card_image_alignment.rb +16 -0
- data/lib/rcs/messages/blast/types/blast_rcs_request_options_standalone_card_orientation.rb +15 -0
- data/lib/rcs/messages/blast/types/blast_rcs_response.rb +60 -0
- data/lib/rcs/messages/blast/types/blast_sms_options.rb +70 -0
- data/lib/rcs/messages/blast/types/blast_sms_response.rb +60 -0
- data/lib/rcs/messages/client.rb +189 -0
- data/lib/rcs/messages/mms/client.rb +216 -0
- data/lib/rcs/messages/mms/types/mms_send_response.rb +60 -0
- data/lib/rcs/messages/mms/types/send_mms_options.rb +108 -0
- data/lib/rcs/messages/rcs/client.rb +286 -0
- data/lib/rcs/messages/rcs/types/send_rich_message_response.rb +60 -0
- data/lib/rcs/messages/rcs/types/send_typing_indicator_schema_options.rb +66 -0
- data/lib/rcs/messages/schedule/client.rb +103 -0
- data/lib/rcs/messages/sms/client.rb +198 -0
- data/lib/rcs/messages/sms/types/send_sms_options.rb +81 -0
- data/lib/rcs/messages/sms/types/sms_send_response.rb +60 -0
- data/lib/rcs/messages/types/react_message_options.rb +71 -0
- data/lib/rcs/phone_numbers/campaign/client.rb +197 -0
- data/lib/rcs/phone_numbers/client.rb +345 -0
- data/lib/rcs/phone_numbers/types/enhanced_contact_info.rb +62 -0
- data/lib/rcs/phone_numbers/types/phone_details_schema_level.rb +16 -0
- data/lib/rcs/phone_numbers/types/phone_numbers_get_response.rb +58 -0
- data/lib/rcs/phone_numbers/types/retrieve_phone_number_details_options.rb +93 -0
- data/lib/rcs/phone_numbers/types/search_phone_number_by_digits.rb +81 -0
- data/lib/rcs/phone_numbers/types/search_phone_number_by_location.rb +96 -0
- data/lib/rcs/phone_numbers/types/search_phone_number_options.rb +62 -0
- data/lib/rcs/phone_numbers/webhook/client.rb +193 -0
- data/lib/rcs/rcs/client.rb +332 -0
- data/lib/rcs/status/client.rb +30 -0
- data/lib/rcs/status/get/client.rb +383 -0
- data/lib/rcs/tools/client.rb +44 -0
- data/lib/rcs/tools/contact_card/client.rb +295 -0
- data/lib/rcs/tools/contact_card/types/get_v_card_schema_options.rb +67 -0
- data/lib/rcs/tools/file/client.rb +228 -0
- data/lib/rcs/tools/file/types/download_options.rb +66 -0
- data/lib/rcs/tools/file/types/upload_file_options.rb +88 -0
- data/lib/rcs/tools/url/client.rb +247 -0
- data/lib/rcs/types/advanced_phone_information.rb +147 -0
- data/lib/rcs/types/advanced_phone_information_carrier.rb +90 -0
- data/lib/rcs/types/advanced_phone_information_contact.rb +146 -0
- data/lib/rcs/types/advanced_phone_information_location.rb +142 -0
- data/lib/rcs/types/advanced_phone_information_location_coordinates.rb +73 -0
- data/lib/rcs/types/advanced_phone_information_location_country.rb +77 -0
- data/lib/rcs/types/advanced_phone_information_type.rb +97 -0
- data/lib/rcs/types/advanced_phone_information_type_recommendation.rb +15 -0
- data/lib/rcs/types/agent.rb +68 -0
- data/lib/rcs/types/attach_webhook_by_id_params.rb +77 -0
- data/lib/rcs/types/attach_webhook_params.rb +60 -0
- data/lib/rcs/types/attach_webhook_response_webhook.rb +88 -0
- data/lib/rcs/types/attached_phone_number_result.rb +75 -0
- data/lib/rcs/types/audience_count_only.rb +87 -0
- data/lib/rcs/types/audience_with_pagination.rb +114 -0
- data/lib/rcs/types/autofill_campaign_params.rb +81 -0
- data/lib/rcs/types/autofill_dlc_campaign_response.rb +173 -0
- data/lib/rcs/types/autofill_dlc_response_keywords.rb +93 -0
- data/lib/rcs/types/autofill_dlc_response_keywords_help.rb +70 -0
- data/lib/rcs/types/autofill_dlc_response_keywords_opt_in.rb +70 -0
- data/lib/rcs/types/autofill_dlc_response_keywords_opt_out.rb +70 -0
- data/lib/rcs/types/autofill_dlc_response_links.rb +70 -0
- data/lib/rcs/types/autofill_dlc_response_options.rb +106 -0
- data/lib/rcs/types/autofill_dlc_response_use_case.rb +72 -0
- data/lib/rcs/types/bad_request_error_body.rb +56 -0
- data/lib/rcs/types/base_rich_message.rb +82 -0
- data/lib/rcs/types/basic_phone_information.rb +127 -0
- data/lib/rcs/types/basic_phone_information_contact.rb +58 -0
- data/lib/rcs/types/basic_phone_information_location.rb +74 -0
- data/lib/rcs/types/basic_phone_information_location_country.rb +75 -0
- data/lib/rcs/types/blast_details.rb +110 -0
- data/lib/rcs/types/brand_status.rb +94 -0
- data/lib/rcs/types/brand_status_enum.rb +21 -0
- data/lib/rcs/types/button_clicked.rb +56 -0
- data/lib/rcs/types/button_clicked_data.rb +80 -0
- data/lib/rcs/types/button_clicked_data_button.rb +118 -0
- data/lib/rcs/types/button_clicked_data_button_raw.rb +58 -0
- data/lib/rcs/types/button_clicked_data_button_type.rb +15 -0
- data/lib/rcs/types/buy_response_capabilities.rb +77 -0
- data/lib/rcs/types/campaign_enum.rb +15 -0
- data/lib/rcs/types/campaign_query.rb +77 -0
- data/lib/rcs/types/campaign_submission_result.rb +57 -0
- data/lib/rcs/types/campaign_validation_response_errors_item.rb +76 -0
- data/lib/rcs/types/campaign_validation_result.rb +71 -0
- data/lib/rcs/types/company_entity_type_enum.rb +14 -0
- data/lib/rcs/types/company_sector_enum.rb +26 -0
- data/lib/rcs/types/company_type_enum.rb +14 -0
- data/lib/rcs/types/configured_webhook.rb +85 -0
- data/lib/rcs/types/contact.rb +107 -0
- data/lib/rcs/types/contact_id.rb +59 -0
- data/lib/rcs/types/conversation.rb +154 -0
- data/lib/rcs/types/conversation_by_id_params.rb +62 -0
- data/lib/rcs/types/conversation_by_participants_params.rb +72 -0
- data/lib/rcs/types/conversation_contact.rb +70 -0
- data/lib/rcs/types/conversation_list.rb +79 -0
- data/lib/rcs/types/conversation_sender.rb +60 -0
- data/lib/rcs/types/create_and_attach_webhook_by_url_params.rb +88 -0
- data/lib/rcs/types/create_url_options.rb +63 -0
- data/lib/rcs/types/delete_audience_response.rb +57 -0
- data/lib/rcs/types/detached_phone_number_result.rb +75 -0
- data/lib/rcs/types/detached_webhook_info.rb +76 -0
- data/lib/rcs/types/detailed_phone_number_enum.rb +25 -0
- data/lib/rcs/types/dlc_assignment_status_enum.rb +19 -0
- data/lib/rcs/types/dlc_campaign_status.rb +109 -0
- data/lib/rcs/types/dlc_campaign_use_case_enum.rb +35 -0
- data/lib/rcs/types/dlc_campaign_with_extended_brand_and_status.rb +224 -0
- data/lib/rcs/types/dlc_with_extended_brand_and_status_keywords.rb +94 -0
- data/lib/rcs/types/dlc_with_extended_brand_and_status_keywords_help.rb +72 -0
- data/lib/rcs/types/dlc_with_extended_brand_and_status_keywords_opt_in.rb +72 -0
- data/lib/rcs/types/dlc_with_extended_brand_and_status_keywords_opt_out.rb +72 -0
- data/lib/rcs/types/dlc_with_extended_brand_and_status_links.rb +70 -0
- data/lib/rcs/types/dlc_with_extended_brand_and_status_mno_brand_tier.rb +15 -0
- data/lib/rcs/types/dlc_with_extended_brand_and_status_mno_tcr_tier.rb +22 -0
- data/lib/rcs/types/dlc_with_extended_brand_and_status_options.rb +106 -0
- data/lib/rcs/types/dlc_with_extended_brand_and_status_use_case.rb +72 -0
- data/lib/rcs/types/enhanced_contact.rb +9 -0
- data/lib/rcs/types/enhanced_contact_item.rb +104 -0
- data/lib/rcs/types/error.rb +61 -0
- data/lib/rcs/types/extended_brand.rb +215 -0
- data/lib/rcs/types/extended_brand_with_vetting.rb +247 -0
- data/lib/rcs/types/extended_rcs_campaign.rb +267 -0
- data/lib/rcs/types/get_conversation_params.rb +57 -0
- data/lib/rcs/types/get_dlc_campaign_status_response_updates.rb +96 -0
- data/lib/rcs/types/get_toll_free_campaign_status_response_updates.rb +92 -0
- data/lib/rcs/types/link_click_event.rb +449 -0
- data/lib/rcs/types/location_share_action.rb +63 -0
- data/lib/rcs/types/location_share_action_data.rb +89 -0
- data/lib/rcs/types/message.rb +176 -0
- data/lib/rcs/types/message_content.rb +85 -0
- data/lib/rcs/types/message_event.rb +143 -0
- data/lib/rcs/types/message_event_content.rb +127 -0
- data/lib/rcs/types/message_event_conversation.rb +82 -0
- data/lib/rcs/types/message_event_direction.rb +11 -0
- data/lib/rcs/types/message_event_mms_content.rb +94 -0
- data/lib/rcs/types/message_event_rcs_button_data.rb +104 -0
- data/lib/rcs/types/message_event_rcs_cards_content.rb +103 -0
- data/lib/rcs/types/message_event_rcs_cards_content_cards_item.rb +96 -0
- data/lib/rcs/types/message_event_rcs_location_data.rb +91 -0
- data/lib/rcs/types/message_event_rcs_media_content.rb +96 -0
- data/lib/rcs/types/message_event_rcs_text_content.rb +94 -0
- data/lib/rcs/types/message_event_sms_content.rb +81 -0
- data/lib/rcs/types/message_list.rb +79 -0
- data/lib/rcs/types/message_method_enum.rb +12 -0
- data/lib/rcs/types/message_protocol_enum.rb +12 -0
- data/lib/rcs/types/message_schedule.rb +121 -0
- data/lib/rcs/types/message_status_enum.rb +17 -0
- data/lib/rcs/types/message_volume_enum.rb +20 -0
- data/lib/rcs/types/message_with_reaction.rb +197 -0
- data/lib/rcs/types/message_with_reaction_direction.rb +11 -0
- data/lib/rcs/types/messaging_profile_enum.rb +11 -0
- data/lib/rcs/types/mms_content.rb +74 -0
- data/lib/rcs/types/mms_validation_response_segments.rb +85 -0
- data/lib/rcs/types/mms_validation_response_segments_value_item.rb +75 -0
- data/lib/rcs/types/mms_validation_result.rb +82 -0
- data/lib/rcs/types/not_found_error_body.rb +59 -0
- data/lib/rcs/types/number_format.rb +79 -0
- data/lib/rcs/types/opt_in_method_enum.rb +13 -0
- data/lib/rcs/types/optional_brand_info.rb +154 -0
- data/lib/rcs/types/optional_contact.rb +83 -0
- data/lib/rcs/types/optional_contacts.rb +84 -0
- data/lib/rcs/types/pagination.rb +81 -0
- data/lib/rcs/types/phone.rb +101 -0
- data/lib/rcs/types/phone_capabilities.rb +75 -0
- data/lib/rcs/types/phone_enum.rb +13 -0
- data/lib/rcs/types/phone_feature_enum.rb +18 -0
- data/lib/rcs/types/phone_number_campaign_attach_failed_item.rb +67 -0
- data/lib/rcs/types/phone_number_campaign_attach_phone_numbers_item.rb +75 -0
- data/lib/rcs/types/phone_number_campaign_attach_phone_numbers_item_campaign.rb +82 -0
- data/lib/rcs/types/phone_number_campaign_detach_failed_item.rb +67 -0
- data/lib/rcs/types/phone_number_campaign_detach_phone_numbers_item.rb +75 -0
- data/lib/rcs/types/phone_number_campaign_detach_phone_numbers_item_campaign.rb +82 -0
- data/lib/rcs/types/phone_number_cost.rb +75 -0
- data/lib/rcs/types/phone_number_details.rb +110 -0
- data/lib/rcs/types/phone_number_enum.rb +18 -0
- data/lib/rcs/types/phone_number_region.rb +91 -0
- data/lib/rcs/types/phone_number_status.rb +90 -0
- data/lib/rcs/types/phone_number_status_enum.rb +16 -0
- data/lib/rcs/types/pinnacle_file_upload_metadata.rb +100 -0
- data/lib/rcs/types/pinnacle_url_config.rb +71 -0
- data/lib/rcs/types/profile_status_enum.rb +17 -0
- data/lib/rcs/types/purchased_number.rb +75 -0
- data/lib/rcs/types/rcs_button_call.rb +77 -0
- data/lib/rcs/types/rcs_button_open_url.rb +104 -0
- data/lib/rcs/types/rcs_button_open_url_webview_mode.rb +19 -0
- data/lib/rcs/types/rcs_button_request_user_location.rb +70 -0
- data/lib/rcs/types/rcs_button_schedule_event.rb +106 -0
- data/lib/rcs/types/rcs_button_send_location.rb +94 -0
- data/lib/rcs/types/rcs_button_send_location_lat_long.rb +68 -0
- data/lib/rcs/types/rcs_button_trigger.rb +80 -0
- data/lib/rcs/types/rcs_campaign.rb +234 -0
- data/lib/rcs/types/rcs_campaign_schema_agent.rb +134 -0
- data/lib/rcs/types/rcs_campaign_schema_agent_emails_item.rb +69 -0
- data/lib/rcs/types/rcs_campaign_schema_agent_phones_item.rb +69 -0
- data/lib/rcs/types/rcs_campaign_schema_agent_websites_item.rb +69 -0
- data/lib/rcs/types/rcs_campaign_schema_extra_agent.rb +134 -0
- data/lib/rcs/types/rcs_campaign_schema_extra_agent_emails_item.rb +70 -0
- data/lib/rcs/types/rcs_campaign_schema_extra_agent_phones_item.rb +70 -0
- data/lib/rcs/types/rcs_campaign_schema_extra_agent_websites_item.rb +71 -0
- data/lib/rcs/types/rcs_campaign_schema_extra_keywords.rb +94 -0
- data/lib/rcs/types/rcs_campaign_schema_extra_keywords_help.rb +71 -0
- data/lib/rcs/types/rcs_campaign_schema_extra_keywords_opt_in.rb +73 -0
- data/lib/rcs/types/rcs_campaign_schema_extra_keywords_opt_out.rb +73 -0
- data/lib/rcs/types/rcs_campaign_schema_extra_links.rb +70 -0
- data/lib/rcs/types/rcs_campaign_schema_extra_traffic.rb +72 -0
- data/lib/rcs/types/rcs_campaign_schema_extra_use_case.rb +71 -0
- data/lib/rcs/types/rcs_campaign_schema_keywords.rb +94 -0
- data/lib/rcs/types/rcs_campaign_schema_keywords_help.rb +71 -0
- data/lib/rcs/types/rcs_campaign_schema_keywords_opt_in.rb +73 -0
- data/lib/rcs/types/rcs_campaign_schema_keywords_opt_out.rb +73 -0
- data/lib/rcs/types/rcs_campaign_schema_links.rb +70 -0
- data/lib/rcs/types/rcs_campaign_schema_traffic.rb +72 -0
- data/lib/rcs/types/rcs_campaign_schema_use_case.rb +71 -0
- data/lib/rcs/types/rcs_campaign_status.rb +88 -0
- data/lib/rcs/types/rcs_campaign_use_case_enum.rb +23 -0
- data/lib/rcs/types/rcs_capabilities_result.rb +7 -0
- data/lib/rcs/types/rcs_capability.rb +82 -0
- data/lib/rcs/types/rcs_capability_actions.rb +105 -0
- data/lib/rcs/types/rcs_capability_cards.rb +67 -0
- data/lib/rcs/types/rcs_cards_content.rb +83 -0
- data/lib/rcs/types/rcs_cards_content_cards_item.rb +98 -0
- data/lib/rcs/types/rcs_content.rb +72 -0
- data/lib/rcs/types/rcs_link_result.rb +75 -0
- data/lib/rcs/types/rcs_media_content.rb +83 -0
- data/lib/rcs/types/rcs_media_details_content.rb +77 -0
- data/lib/rcs/types/rcs_messaging_type_enum.rb +17 -0
- data/lib/rcs/types/rcs_validate_content.rb +70 -0
- data/lib/rcs/types/rcs_validate_content_media.rb +75 -0
- data/lib/rcs/types/rcs_validation_result.rb +83 -0
- data/lib/rcs/types/rcs_whitelist_response.rb +58 -0
- data/lib/rcs/types/reaction_result.rb +71 -0
- data/lib/rcs/types/refreshed_file.rb +67 -0
- data/lib/rcs/types/rich_button.rb +148 -0
- data/lib/rcs/types/rich_card.rb +92 -0
- data/lib/rcs/types/rich_cards.rb +83 -0
- data/lib/rcs/types/rich_cards_message.rb +114 -0
- data/lib/rcs/types/rich_media_message.rb +112 -0
- data/lib/rcs/types/rich_message.rb +70 -0
- data/lib/rcs/types/rich_standalone_card_options.rb +80 -0
- data/lib/rcs/types/rich_text.rb +74 -0
- data/lib/rcs/types/rich_text_message.rb +108 -0
- data/lib/rcs/types/schedule_cancel_result.rb +58 -0
- data/lib/rcs/types/scheduled_blast_details.rb +76 -0
- data/lib/rcs/types/scheduled_blast_response_config.rb +89 -0
- data/lib/rcs/types/scheduled_message.rb +75 -0
- data/lib/rcs/types/scheduled_send_response_config.rb +89 -0
- data/lib/rcs/types/send_rcs_card_options_standalone_card_image_alignment.rb +12 -0
- data/lib/rcs/types/send_rcs_card_options_standalone_card_orientation.rb +11 -0
- data/lib/rcs/types/send_rich_cards_options.rb +136 -0
- data/lib/rcs/types/send_rich_message_options.rb +111 -0
- data/lib/rcs/types/send_sms_response_segments.rb +69 -0
- data/lib/rcs/types/send_sms_response_segments_encoding.rb +11 -0
- data/lib/rcs/types/send_typing_indicator_response.rb +100 -0
- data/lib/rcs/types/sent_mms_details.rb +118 -0
- data/lib/rcs/types/sent_rich_message.rb +104 -0
- data/lib/rcs/types/sent_sms_details.rb +110 -0
- data/lib/rcs/types/shortened_url.rb +77 -0
- data/lib/rcs/types/shortened_url_with_click_data.rb +90 -0
- data/lib/rcs/types/sms_content.rb +58 -0
- data/lib/rcs/types/sms_validation_response_segments.rb +80 -0
- data/lib/rcs/types/sms_validation_response_segments_gsm_7.rb +75 -0
- data/lib/rcs/types/sms_validation_response_segments_utf_16.rb +68 -0
- data/lib/rcs/types/sms_validation_response_total.rb +75 -0
- data/lib/rcs/types/sms_validation_result.rb +102 -0
- data/lib/rcs/types/sub_use_case_enum.rb +19 -0
- data/lib/rcs/types/submission_results.rb +57 -0
- data/lib/rcs/types/successful_conversation_update.rb +58 -0
- data/lib/rcs/types/toll_free_campaign.rb +160 -0
- data/lib/rcs/types/toll_free_campaign_schema_keywords.rb +82 -0
- data/lib/rcs/types/toll_free_campaign_schema_keywords_help.rb +62 -0
- data/lib/rcs/types/toll_free_campaign_schema_keywords_opt_in.rb +74 -0
- data/lib/rcs/types/toll_free_campaign_schema_links.rb +70 -0
- data/lib/rcs/types/toll_free_campaign_schema_opt_in.rb +78 -0
- data/lib/rcs/types/toll_free_campaign_schema_options.rb +60 -0
- data/lib/rcs/types/toll_free_campaign_schema_use_case.rb +71 -0
- data/lib/rcs/types/toll_free_campaign_status.rb +93 -0
- data/lib/rcs/types/toll_free_campaign_use_case_enum.rb +52 -0
- data/lib/rcs/types/toll_free_campaign_with_extended_brand_and_status.rb +195 -0
- data/lib/rcs/types/toll_free_status_enum.rb +20 -0
- data/lib/rcs/types/tracking.rb +17 -0
- data/lib/rcs/types/updated_contact_id.rb +59 -0
- data/lib/rcs/types/upload_results.rb +80 -0
- data/lib/rcs/types/user_event.rb +83 -0
- data/lib/rcs/types/user_event_conversation.rb +78 -0
- data/lib/rcs/types/v_card_address_schema_type_item.rb +15 -0
- data/lib/rcs/types/v_card_data.rb +239 -0
- data/lib/rcs/types/v_card_data_file.rb +74 -0
- data/lib/rcs/types/v_card_data_file_metadata.rb +62 -0
- data/lib/rcs/types/v_card_email_schema_type_item.rb +21 -0
- data/lib/rcs/types/v_card_geo.rb +70 -0
- data/lib/rcs/types/v_card_name.rb +98 -0
- data/lib/rcs/types/v_card_organization.rb +70 -0
- data/lib/rcs/types/v_card_phone_schema_type_item.rb +21 -0
- data/lib/rcs/types/validate_campaign_params.rb +81 -0
- data/lib/rcs/types/validation_error_details.rb +76 -0
- data/lib/rcs/types/validation_results.rb +71 -0
- data/lib/rcs/types/vcard.rb +217 -0
- data/lib/rcs/types/vcard_address.rb +130 -0
- data/lib/rcs/types/vcard_content.rb +225 -0
- data/lib/rcs/types/vcard_email.rb +70 -0
- data/lib/rcs/types/vcard_phone.rb +70 -0
- data/lib/rcs/types/vcard_resource.rb +73 -0
- data/lib/rcs/types/vetting_feedback.rb +81 -0
- data/lib/rcs/types/vetting_history.rb +98 -0
- data/lib/rcs/types/vetting_history_vetting_status.rb +13 -0
- data/lib/rcs/types/vetting_results.rb +57 -0
- data/lib/rcs/types/webhook_event_enum.rb +14 -0
- data/lib/rcs/types/webhook_result.rb +64 -0
- data/lib/rcs/types/webhooks.rb +77 -0
- data/lib/rcs/types/zod_error.rb +73 -0
- data/lib/rcs/webhooks/client.rb +97 -0
- data/lib/rcs.rb +124 -0
- data/lib/requests.rb +163 -0
- data/lib/types_export.rb +334 -0
- metadata +456 -468
- data/.fern/metadata.json +0 -12
- data/.fernignore +0 -6
- data/.rubocop.yml +0 -60
- data/README.md +0 -121
- data/Rakefile +0 -20
- data/custom.gemspec.rb +0 -13
- data/lib/pinnacle/audiences/client.rb +0 -183
- data/lib/pinnacle/audiences/contacts/client.rb +0 -97
- data/lib/pinnacle/audiences/contacts/types/add_contacts_params.rb +0 -14
- data/lib/pinnacle/audiences/contacts/types/remove_contacts_params.rb +0 -14
- data/lib/pinnacle/audiences/types/audiences_delete_request.rb +0 -11
- data/lib/pinnacle/audiences/types/audiences_get_request.rb +0 -13
- data/lib/pinnacle/audiences/types/audiences_get_response.rb +0 -14
- data/lib/pinnacle/audiences/types/create_audience_params.rb +0 -13
- data/lib/pinnacle/audiences/types/update_audience_params.rb +0 -13
- data/lib/pinnacle/base_client.rb +0 -75
- data/lib/pinnacle/brands/client.rb +0 -245
- data/lib/pinnacle/brands/types/autofill_brand_options.rb +0 -11
- data/lib/pinnacle/brands/types/autofill_brand_params.rb +0 -14
- data/lib/pinnacle/brands/types/brands_get_request.rb +0 -12
- data/lib/pinnacle/brands/types/upsert_brand_params.rb +0 -22
- data/lib/pinnacle/brands/types/upsert_brand_schema_contact.rb +0 -15
- data/lib/pinnacle/brands/types/upsert_brand_schema_entity_type.rb +0 -17
- data/lib/pinnacle/brands/types/upsert_brand_schema_sector.rb +0 -29
- data/lib/pinnacle/brands/types/upsert_brand_schema_type.rb +0 -17
- data/lib/pinnacle/brands/types/vet_brand_params.rb +0 -14
- data/lib/pinnacle/campaigns/client.rb +0 -29
- data/lib/pinnacle/campaigns/dlc/client.rb +0 -201
- data/lib/pinnacle/campaigns/dlc/types/dlc_campaign_help_keywords.rb +0 -15
- data/lib/pinnacle/campaigns/dlc/types/dlc_campaign_keywords.rb +0 -16
- data/lib/pinnacle/campaigns/dlc/types/dlc_campaign_links.rb +0 -15
- data/lib/pinnacle/campaigns/dlc/types/dlc_campaign_opt_in_keywords.rb +0 -15
- data/lib/pinnacle/campaigns/dlc/types/dlc_campaign_opt_out_keywords.rb +0 -15
- data/lib/pinnacle/campaigns/dlc/types/dlc_campaign_options.rb +0 -19
- data/lib/pinnacle/campaigns/dlc/types/dlc_campaign_use_case.rb +0 -15
- data/lib/pinnacle/campaigns/dlc/types/upsert_dlc_campaign_params.rb +0 -23
- data/lib/pinnacle/campaigns/rcs/client.rb +0 -199
- data/lib/pinnacle/campaigns/rcs/types/rcs_agent.rb +0 -21
- data/lib/pinnacle/campaigns/rcs/types/rcs_agent_email.rb +0 -14
- data/lib/pinnacle/campaigns/rcs/types/rcs_agent_phone.rb +0 -14
- data/lib/pinnacle/campaigns/rcs/types/rcs_agent_website.rb +0 -14
- data/lib/pinnacle/campaigns/rcs/types/rcs_autofill_response.rb +0 -13
- data/lib/pinnacle/campaigns/rcs/types/rcs_campaign_help_keywords.rb +0 -14
- data/lib/pinnacle/campaigns/rcs/types/rcs_campaign_keywords.rb +0 -15
- data/lib/pinnacle/campaigns/rcs/types/rcs_campaign_opt_in_keywords.rb +0 -14
- data/lib/pinnacle/campaigns/rcs/types/rcs_campaign_opt_out_keywords.rb +0 -14
- data/lib/pinnacle/campaigns/rcs/types/rcs_campaign_traffic.rb +0 -14
- data/lib/pinnacle/campaigns/rcs/types/rcs_links.rb +0 -15
- data/lib/pinnacle/campaigns/rcs/types/rcs_use_case.rb +0 -15
- data/lib/pinnacle/campaigns/rcs/types/upsert_rcs_campaign_params.rb +0 -28
- data/lib/pinnacle/campaigns/toll_free/client.rb +0 -201
- data/lib/pinnacle/campaigns/toll_free/types/toll_free_autofill_response.rb +0 -13
- data/lib/pinnacle/campaigns/toll_free/types/toll_free_campaign_help_keywords.rb +0 -14
- data/lib/pinnacle/campaigns/toll_free/types/toll_free_campaign_keywords.rb +0 -15
- data/lib/pinnacle/campaigns/toll_free/types/toll_free_campaign_links.rb +0 -15
- data/lib/pinnacle/campaigns/toll_free/types/toll_free_campaign_opt_in.rb +0 -16
- data/lib/pinnacle/campaigns/toll_free/types/toll_free_campaign_opt_in_keywords.rb +0 -15
- data/lib/pinnacle/campaigns/toll_free/types/toll_free_campaign_options.rb +0 -14
- data/lib/pinnacle/campaigns/toll_free/types/toll_free_campaign_use_case.rb +0 -15
- data/lib/pinnacle/campaigns/toll_free/types/upsert_toll_free_campaign_params.rb +0 -22
- data/lib/pinnacle/client.rb +0 -26
- data/lib/pinnacle/contacts/client.rb +0 -130
- data/lib/pinnacle/contacts/types/contacts_get_request.rb +0 -12
- data/lib/pinnacle/contacts/types/create_contact_params.rb +0 -15
- data/lib/pinnacle/contacts/types/update_contact_params.rb +0 -15
- data/lib/pinnacle/conversations/client.rb +0 -175
- data/lib/pinnacle/conversations/types/conversations_list_messages_request.rb +0 -19
- data/lib/pinnacle/conversations/types/conversations_list_messages_request_direction.rb +0 -14
- data/lib/pinnacle/conversations/types/conversations_list_messages_request_sort_order.rb +0 -14
- data/lib/pinnacle/conversations/types/conversations_list_messages_request_status.rb +0 -19
- data/lib/pinnacle/conversations/types/conversations_list_messages_request_type.rb +0 -15
- data/lib/pinnacle/conversations/types/list_conversations_params.rb +0 -17
- data/lib/pinnacle/conversations/types/update_conversation_params.rb +0 -12
- data/lib/pinnacle/errors/api_error.rb +0 -8
- data/lib/pinnacle/errors/client_error.rb +0 -17
- data/lib/pinnacle/errors/redirect_error.rb +0 -8
- data/lib/pinnacle/errors/response_error.rb +0 -42
- data/lib/pinnacle/errors/server_error.rb +0 -11
- data/lib/pinnacle/errors/timeout_error.rb +0 -8
- data/lib/pinnacle/internal/errors/constraint_error.rb +0 -10
- data/lib/pinnacle/internal/errors/type_error.rb +0 -10
- data/lib/pinnacle/internal/http/base_request.rb +0 -31
- data/lib/pinnacle/internal/http/raw_client.rb +0 -116
- data/lib/pinnacle/internal/iterators/cursor_item_iterator.rb +0 -28
- data/lib/pinnacle/internal/iterators/cursor_page_iterator.rb +0 -51
- data/lib/pinnacle/internal/iterators/item_iterator.rb +0 -59
- data/lib/pinnacle/internal/iterators/offset_item_iterator.rb +0 -30
- data/lib/pinnacle/internal/iterators/offset_page_iterator.rb +0 -83
- data/lib/pinnacle/internal/json/request.rb +0 -39
- data/lib/pinnacle/internal/json/serializable.rb +0 -25
- data/lib/pinnacle/internal/multipart/multipart_encoder.rb +0 -141
- data/lib/pinnacle/internal/multipart/multipart_form_data.rb +0 -78
- data/lib/pinnacle/internal/multipart/multipart_form_data_part.rb +0 -51
- data/lib/pinnacle/internal/multipart/multipart_request.rb +0 -38
- data/lib/pinnacle/internal/types/array.rb +0 -47
- data/lib/pinnacle/internal/types/boolean.rb +0 -34
- data/lib/pinnacle/internal/types/enum.rb +0 -56
- data/lib/pinnacle/internal/types/hash.rb +0 -36
- data/lib/pinnacle/internal/types/model/field.rb +0 -38
- data/lib/pinnacle/internal/types/model.rb +0 -208
- data/lib/pinnacle/internal/types/type.rb +0 -35
- data/lib/pinnacle/internal/types/union.rb +0 -161
- data/lib/pinnacle/internal/types/unknown.rb +0 -15
- data/lib/pinnacle/internal/types/utils.rb +0 -116
- data/lib/pinnacle/messages/blast/client.rb +0 -143
- data/lib/pinnacle/messages/blast/types/blast_mms.rb +0 -16
- data/lib/pinnacle/messages/blast/types/blast_mms_options.rb +0 -15
- data/lib/pinnacle/messages/blast/types/blast_mms_response.rb +0 -16
- data/lib/pinnacle/messages/blast/types/blast_rcs.rb +0 -16
- data/lib/pinnacle/messages/blast/types/blast_rcs_options.rb +0 -17
- data/lib/pinnacle/messages/blast/types/blast_rcs_request_options_standalone_card.rb +0 -20
- data/lib/pinnacle/messages/blast/types/blast_rcs_request_options_standalone_card_image_alignment.rb +0 -16
- data/lib/pinnacle/messages/blast/types/blast_rcs_request_options_standalone_card_orientation.rb +0 -16
- data/lib/pinnacle/messages/blast/types/blast_rcs_response.rb +0 -16
- data/lib/pinnacle/messages/blast/types/blast_sms.rb +0 -16
- data/lib/pinnacle/messages/blast/types/blast_sms_options.rb +0 -14
- data/lib/pinnacle/messages/blast/types/blast_sms_response.rb +0 -16
- data/lib/pinnacle/messages/client.rb +0 -110
- data/lib/pinnacle/messages/mms/client.rb +0 -87
- data/lib/pinnacle/messages/mms/types/mms.rb +0 -17
- data/lib/pinnacle/messages/mms/types/mms_send_response.rb +0 -16
- data/lib/pinnacle/messages/mms/types/send_mms_options.rb +0 -17
- data/lib/pinnacle/messages/rcs/client.rb +0 -140
- data/lib/pinnacle/messages/rcs/types/send_rich_message_response.rb +0 -16
- data/lib/pinnacle/messages/rcs/types/send_typing_indicator_schema.rb +0 -15
- data/lib/pinnacle/messages/rcs/types/send_typing_indicator_schema_options.rb +0 -14
- data/lib/pinnacle/messages/schedule/client.rb +0 -53
- data/lib/pinnacle/messages/sms/client.rb +0 -87
- data/lib/pinnacle/messages/sms/types/send_sms_options.rb +0 -15
- data/lib/pinnacle/messages/sms/types/sms.rb +0 -16
- data/lib/pinnacle/messages/sms/types/sms_send_response.rb +0 -16
- data/lib/pinnacle/messages/types/react_message_options.rb +0 -11
- data/lib/pinnacle/messages/types/react_message_params.rb +0 -13
- data/lib/pinnacle/phone_numbers/campaign/client.rb +0 -90
- data/lib/pinnacle/phone_numbers/campaign/types/attach_campaign_params.rb +0 -15
- data/lib/pinnacle/phone_numbers/campaign/types/detach_campaign_params.rb +0 -13
- data/lib/pinnacle/phone_numbers/client.rb +0 -133
- data/lib/pinnacle/phone_numbers/types/buy_phone_number_params.rb +0 -11
- data/lib/pinnacle/phone_numbers/types/enhanced_contact_info.rb +0 -12
- data/lib/pinnacle/phone_numbers/types/phone_details_schema_level.rb +0 -14
- data/lib/pinnacle/phone_numbers/types/phone_numbers_get_response.rb +0 -14
- data/lib/pinnacle/phone_numbers/types/retrieve_phone_number_details_options.rb +0 -14
- data/lib/pinnacle/phone_numbers/types/retrieve_phone_number_details_params.rb +0 -13
- data/lib/pinnacle/phone_numbers/types/search_phone_number_by_digits.rb +0 -14
- data/lib/pinnacle/phone_numbers/types/search_phone_number_by_location.rb +0 -17
- data/lib/pinnacle/phone_numbers/types/search_phone_number_options.rb +0 -12
- data/lib/pinnacle/phone_numbers/types/search_phone_number_params.rb +0 -15
- data/lib/pinnacle/phone_numbers/webhook/client.rb +0 -90
- data/lib/pinnacle/rcs/client.rb +0 -159
- data/lib/pinnacle/rcs/types/rcs_capabilities_query.rb +0 -11
- data/lib/pinnacle/rcs/types/rcs_link_request.rb +0 -14
- data/lib/pinnacle/rcs/types/rcs_whitelist_request.rb +0 -12
- data/lib/pinnacle/status/client.rb +0 -19
- data/lib/pinnacle/status/get/client.rb +0 -188
- data/lib/pinnacle/tools/client.rb +0 -29
- data/lib/pinnacle/tools/contact_card/client.rb +0 -92
- data/lib/pinnacle/tools/contact_card/types/get_v_card_schema_options.rb +0 -13
- data/lib/pinnacle/tools/contact_card/types/get_vcard_params.rb +0 -14
- data/lib/pinnacle/tools/contact_card/types/upsert_vcard_params.rb +0 -29
- data/lib/pinnacle/tools/file/client.rb +0 -94
- data/lib/pinnacle/tools/file/types/download_options.rb +0 -14
- data/lib/pinnacle/tools/file/types/refresh_file_params.rb +0 -13
- data/lib/pinnacle/tools/file/types/upload_file_options.rb +0 -15
- data/lib/pinnacle/tools/file/types/upload_file_params.rb +0 -16
- data/lib/pinnacle/tools/url/client.rb +0 -128
- data/lib/pinnacle/tools/url/types/create_url_params.rb +0 -14
- data/lib/pinnacle/tools/url/types/update_url_params.rb +0 -15
- data/lib/pinnacle/types/advanced_phone_information.rb +0 -17
- data/lib/pinnacle/types/advanced_phone_information_carrier.rb +0 -13
- data/lib/pinnacle/types/advanced_phone_information_contact.rb +0 -19
- data/lib/pinnacle/types/advanced_phone_information_location.rb +0 -18
- data/lib/pinnacle/types/advanced_phone_information_location_coordinates.rb +0 -11
- data/lib/pinnacle/types/advanced_phone_information_location_country.rb +0 -12
- data/lib/pinnacle/types/advanced_phone_information_type.rb +0 -13
- data/lib/pinnacle/types/advanced_phone_information_type_recommendation.rb +0 -13
- data/lib/pinnacle/types/agent.rb +0 -11
- data/lib/pinnacle/types/attach_webhook_by_id_params.rb +0 -11
- data/lib/pinnacle/types/attach_webhook_params.rb +0 -15
- data/lib/pinnacle/types/attach_webhook_response_webhook.rb +0 -13
- data/lib/pinnacle/types/attached_phone_number_result.rb +0 -10
- data/lib/pinnacle/types/audience_count_only.rb +0 -12
- data/lib/pinnacle/types/audience_with_pagination.rb +0 -14
- data/lib/pinnacle/types/autofill_campaign_params.rb +0 -10
- data/lib/pinnacle/types/autofill_dlc_campaign_response.rb +0 -19
- data/lib/pinnacle/types/autofill_dlc_response_keywords.rb +0 -12
- data/lib/pinnacle/types/autofill_dlc_response_keywords_help.rb +0 -11
- data/lib/pinnacle/types/autofill_dlc_response_keywords_opt_in.rb +0 -11
- data/lib/pinnacle/types/autofill_dlc_response_keywords_opt_out.rb +0 -11
- data/lib/pinnacle/types/autofill_dlc_response_links.rb +0 -11
- data/lib/pinnacle/types/autofill_dlc_response_options.rb +0 -15
- data/lib/pinnacle/types/autofill_dlc_response_use_case.rb +0 -11
- data/lib/pinnacle/types/bad_request_error_body.rb +0 -12
- data/lib/pinnacle/types/base_rich_message.rb +0 -11
- data/lib/pinnacle/types/basic_phone_information.rb +0 -16
- data/lib/pinnacle/types/basic_phone_information_contact.rb +0 -10
- data/lib/pinnacle/types/basic_phone_information_location.rb +0 -11
- data/lib/pinnacle/types/basic_phone_information_location_country.rb +0 -12
- data/lib/pinnacle/types/blast_details.rb +0 -15
- data/lib/pinnacle/types/brand_status.rb +0 -12
- data/lib/pinnacle/types/brand_status_enum.rb +0 -16
- data/lib/pinnacle/types/button_clicked.rb +0 -12
- data/lib/pinnacle/types/button_clicked_data.rb +0 -11
- data/lib/pinnacle/types/button_clicked_data_button.rb +0 -14
- data/lib/pinnacle/types/button_clicked_data_button_raw.rb +0 -14
- data/lib/pinnacle/types/button_clicked_data_button_type.rb +0 -12
- data/lib/pinnacle/types/buy_response_capabilities.rb +0 -12
- data/lib/pinnacle/types/campaign_enum.rb +0 -13
- data/lib/pinnacle/types/campaign_query.rb +0 -11
- data/lib/pinnacle/types/campaign_submission_result.rb +0 -9
- data/lib/pinnacle/types/campaign_validation_response_errors_item.rb +0 -11
- data/lib/pinnacle/types/campaign_validation_result.rb +0 -10
- data/lib/pinnacle/types/company_entity_type_enum.rb +0 -15
- data/lib/pinnacle/types/company_sector_enum.rb +0 -27
- data/lib/pinnacle/types/company_type_enum.rb +0 -15
- data/lib/pinnacle/types/configured_webhook.rb +0 -13
- data/lib/pinnacle/types/contact.rb +0 -14
- data/lib/pinnacle/types/contact_id.rb +0 -9
- data/lib/pinnacle/types/conversation.rb +0 -17
- data/lib/pinnacle/types/conversation_by_id_params.rb +0 -10
- data/lib/pinnacle/types/conversation_by_participants_params.rb +0 -11
- data/lib/pinnacle/types/conversation_contact.rb +0 -11
- data/lib/pinnacle/types/conversation_list.rb +0 -12
- data/lib/pinnacle/types/conversation_sender.rb +0 -16
- data/lib/pinnacle/types/create_and_attach_webhook_by_url_params.rb +0 -12
- data/lib/pinnacle/types/create_url_options.rb +0 -9
- data/lib/pinnacle/types/delete_audience_response.rb +0 -9
- data/lib/pinnacle/types/detached_phone_number_result.rb +0 -10
- data/lib/pinnacle/types/detached_webhook_info.rb +0 -11
- data/lib/pinnacle/types/detailed_phone_number_enum.rb +0 -22
- data/lib/pinnacle/types/dlc_assignment_status_enum.rb +0 -15
- data/lib/pinnacle/types/dlc_campaign_status.rb +0 -13
- data/lib/pinnacle/types/dlc_campaign_use_case_enum.rb +0 -36
- data/lib/pinnacle/types/dlc_campaign_with_extended_brand_and_status.rb +0 -23
- data/lib/pinnacle/types/dlc_with_extended_brand_and_status_keywords.rb +0 -12
- data/lib/pinnacle/types/dlc_with_extended_brand_and_status_keywords_help.rb +0 -11
- data/lib/pinnacle/types/dlc_with_extended_brand_and_status_keywords_opt_in.rb +0 -11
- data/lib/pinnacle/types/dlc_with_extended_brand_and_status_keywords_opt_out.rb +0 -11
- data/lib/pinnacle/types/dlc_with_extended_brand_and_status_links.rb +0 -11
- data/lib/pinnacle/types/dlc_with_extended_brand_and_status_mno_brand_tier.rb +0 -14
- data/lib/pinnacle/types/dlc_with_extended_brand_and_status_mno_tcr_tier.rb +0 -20
- data/lib/pinnacle/types/dlc_with_extended_brand_and_status_options.rb +0 -15
- data/lib/pinnacle/types/dlc_with_extended_brand_and_status_use_case.rb +0 -11
- data/lib/pinnacle/types/enhanced_contact.rb +0 -23
- data/lib/pinnacle/types/enhanced_contact_item.rb +0 -13
- data/lib/pinnacle/types/error.rb +0 -10
- data/lib/pinnacle/types/extended_brand.rb +0 -13
- data/lib/pinnacle/types/extended_brand_with_vetting.rb +0 -11
- data/lib/pinnacle/types/extended_rcs_campaign.rb +0 -26
- data/lib/pinnacle/types/get_conversation_params.rb +0 -13
- data/lib/pinnacle/types/get_dlc_campaign_status_response_updates.rb +0 -15
- data/lib/pinnacle/types/get_toll_free_campaign_status_response_updates.rb +0 -15
- data/lib/pinnacle/types/link_click_event.rb +0 -57
- data/lib/pinnacle/types/location_share_action.rb +0 -9
- data/lib/pinnacle/types/location_share_action_data.rb +0 -13
- data/lib/pinnacle/types/message.rb +0 -20
- data/lib/pinnacle/types/message_content.rb +0 -15
- data/lib/pinnacle/types/message_event.rb +0 -17
- data/lib/pinnacle/types/message_event_content.rb +0 -18
- data/lib/pinnacle/types/message_event_conversation.rb +0 -12
- data/lib/pinnacle/types/message_event_direction.rb +0 -12
- data/lib/pinnacle/types/message_event_mms_content.rb +0 -13
- data/lib/pinnacle/types/message_event_rcs_button_data.rb +0 -15
- data/lib/pinnacle/types/message_event_rcs_cards_content.rb +0 -16
- data/lib/pinnacle/types/message_event_rcs_cards_content_cards_item.rb +0 -13
- data/lib/pinnacle/types/message_event_rcs_location_data.rb +0 -15
- data/lib/pinnacle/types/message_event_rcs_media_content.rb +0 -15
- data/lib/pinnacle/types/message_event_rcs_text_content.rb +0 -13
- data/lib/pinnacle/types/message_event_sms_content.rb +0 -12
- data/lib/pinnacle/types/message_list.rb +0 -12
- data/lib/pinnacle/types/message_method_enum.rb +0 -13
- data/lib/pinnacle/types/message_protocol_enum.rb +0 -13
- data/lib/pinnacle/types/message_schedule.rb +0 -13
- data/lib/pinnacle/types/message_status_enum.rb +0 -18
- data/lib/pinnacle/types/message_volume_enum.rb +0 -21
- data/lib/pinnacle/types/message_with_reaction.rb +0 -11
- data/lib/pinnacle/types/message_with_reaction_direction.rb +0 -12
- data/lib/pinnacle/types/messaging_profile_enum.rb +0 -12
- data/lib/pinnacle/types/mms_content.rb +0 -11
- data/lib/pinnacle/types/mms_validation_response_segments.rb +0 -12
- data/lib/pinnacle/types/mms_validation_response_segments_value_item.rb +0 -11
- data/lib/pinnacle/types/mms_validation_result.rb +0 -11
- data/lib/pinnacle/types/not_found_error_body.rb +0 -9
- data/lib/pinnacle/types/number_format.rb +0 -13
- data/lib/pinnacle/types/opt_in_method_enum.rb +0 -14
- data/lib/pinnacle/types/optional_brand_info.rb +0 -19
- data/lib/pinnacle/types/optional_contact.rb +0 -12
- data/lib/pinnacle/types/optional_contacts.rb +0 -13
- data/lib/pinnacle/types/pagination.rb +0 -12
- data/lib/pinnacle/types/phone.rb +0 -14
- data/lib/pinnacle/types/phone_capabilities.rb +0 -12
- data/lib/pinnacle/types/phone_enum.rb +0 -12
- data/lib/pinnacle/types/phone_feature_enum.rb +0 -18
- data/lib/pinnacle/types/phone_number_campaign_attach_failed_item.rb +0 -10
- data/lib/pinnacle/types/phone_number_campaign_attach_phone_numbers_item.rb +0 -10
- data/lib/pinnacle/types/phone_number_campaign_attach_phone_numbers_item_campaign.rb +0 -12
- data/lib/pinnacle/types/phone_number_campaign_detach_failed_item.rb +0 -10
- data/lib/pinnacle/types/phone_number_campaign_detach_phone_numbers_item.rb +0 -10
- data/lib/pinnacle/types/phone_number_campaign_detach_phone_numbers_item_campaign.rb +0 -12
- data/lib/pinnacle/types/phone_number_cost.rb +0 -12
- data/lib/pinnacle/types/phone_number_details.rb +0 -15
- data/lib/pinnacle/types/phone_number_enum.rb +0 -18
- data/lib/pinnacle/types/phone_number_region.rb +0 -13
- data/lib/pinnacle/types/phone_number_status.rb +0 -12
- data/lib/pinnacle/types/phone_number_status_enum.rb +0 -13
- data/lib/pinnacle/types/pinnacle_file_upload_metadata.rb +0 -12
- data/lib/pinnacle/types/pinnacle_url_config.rb +0 -10
- data/lib/pinnacle/types/profile_status_enum.rb +0 -14
- data/lib/pinnacle/types/purchased_number.rb +0 -12
- data/lib/pinnacle/types/rcs_button_call.rb +0 -12
- data/lib/pinnacle/types/rcs_button_open_url.rb +0 -13
- data/lib/pinnacle/types/rcs_button_open_url_webview_mode.rb +0 -13
- data/lib/pinnacle/types/rcs_button_request_user_location.rb +0 -11
- data/lib/pinnacle/types/rcs_button_schedule_event.rb +0 -15
- data/lib/pinnacle/types/rcs_button_send_location.rb +0 -13
- data/lib/pinnacle/types/rcs_button_send_location_lat_long.rb +0 -11
- data/lib/pinnacle/types/rcs_button_trigger.rb +0 -12
- data/lib/pinnacle/types/rcs_campaign.rb +0 -23
- data/lib/pinnacle/types/rcs_campaign_schema_agent.rb +0 -17
- data/lib/pinnacle/types/rcs_campaign_schema_agent_emails_item.rb +0 -10
- data/lib/pinnacle/types/rcs_campaign_schema_agent_phones_item.rb +0 -10
- data/lib/pinnacle/types/rcs_campaign_schema_agent_websites_item.rb +0 -10
- data/lib/pinnacle/types/rcs_campaign_schema_extra_agent.rb +0 -17
- data/lib/pinnacle/types/rcs_campaign_schema_extra_agent_emails_item.rb +0 -10
- data/lib/pinnacle/types/rcs_campaign_schema_extra_agent_phones_item.rb +0 -10
- data/lib/pinnacle/types/rcs_campaign_schema_extra_agent_websites_item.rb +0 -10
- data/lib/pinnacle/types/rcs_campaign_schema_extra_keywords.rb +0 -11
- data/lib/pinnacle/types/rcs_campaign_schema_extra_keywords_help.rb +0 -10
- data/lib/pinnacle/types/rcs_campaign_schema_extra_keywords_opt_in.rb +0 -10
- data/lib/pinnacle/types/rcs_campaign_schema_extra_keywords_opt_out.rb +0 -10
- data/lib/pinnacle/types/rcs_campaign_schema_extra_links.rb +0 -11
- data/lib/pinnacle/types/rcs_campaign_schema_extra_traffic.rb +0 -10
- data/lib/pinnacle/types/rcs_campaign_schema_extra_use_case.rb +0 -11
- data/lib/pinnacle/types/rcs_campaign_schema_keywords.rb +0 -11
- data/lib/pinnacle/types/rcs_campaign_schema_keywords_help.rb +0 -10
- data/lib/pinnacle/types/rcs_campaign_schema_keywords_opt_in.rb +0 -10
- data/lib/pinnacle/types/rcs_campaign_schema_keywords_opt_out.rb +0 -10
- data/lib/pinnacle/types/rcs_campaign_schema_links.rb +0 -11
- data/lib/pinnacle/types/rcs_campaign_schema_traffic.rb +0 -10
- data/lib/pinnacle/types/rcs_campaign_schema_use_case.rb +0 -11
- data/lib/pinnacle/types/rcs_campaign_status.rb +0 -12
- data/lib/pinnacle/types/rcs_campaign_use_case_enum.rb +0 -24
- data/lib/pinnacle/types/rcs_capabilities_result.rb +0 -23
- data/lib/pinnacle/types/rcs_capability.rb +0 -11
- data/lib/pinnacle/types/rcs_capability_actions.rb +0 -16
- data/lib/pinnacle/types/rcs_capability_cards.rb +0 -10
- data/lib/pinnacle/types/rcs_cards_content.rb +0 -13
- data/lib/pinnacle/types/rcs_cards_content_cards_item.rb +0 -13
- data/lib/pinnacle/types/rcs_content.rb +0 -14
- data/lib/pinnacle/types/rcs_link_result.rb +0 -13
- data/lib/pinnacle/types/rcs_media_content.rb +0 -13
- data/lib/pinnacle/types/rcs_media_details_content.rb +0 -12
- data/lib/pinnacle/types/rcs_messaging_type_enum.rb +0 -14
- data/lib/pinnacle/types/rcs_validate_content.rb +0 -13
- data/lib/pinnacle/types/rcs_validate_content_media.rb +0 -13
- data/lib/pinnacle/types/rcs_validation_result.rb +0 -12
- data/lib/pinnacle/types/rcs_whitelist_response.rb +0 -10
- data/lib/pinnacle/types/reaction_result.rb +0 -10
- data/lib/pinnacle/types/refreshed_file.rb +0 -10
- data/lib/pinnacle/types/rich_button.rb +0 -18
- data/lib/pinnacle/types/rich_card.rb +0 -13
- data/lib/pinnacle/types/rich_cards.rb +0 -13
- data/lib/pinnacle/types/rich_cards_message.rb +0 -11
- data/lib/pinnacle/types/rich_media_message.rb +0 -10
- data/lib/pinnacle/types/rich_message.rb +0 -13
- data/lib/pinnacle/types/rich_standalone_card_options.rb +0 -17
- data/lib/pinnacle/types/rich_text.rb +0 -11
- data/lib/pinnacle/types/rich_text_message.rb +0 -7
- data/lib/pinnacle/types/schedule_cancel_result.rb +0 -10
- data/lib/pinnacle/types/scheduled_blast_details.rb +0 -11
- data/lib/pinnacle/types/scheduled_blast_response_config.rb +0 -13
- data/lib/pinnacle/types/scheduled_message.rb +0 -10
- data/lib/pinnacle/types/scheduled_send_response_config.rb +0 -13
- data/lib/pinnacle/types/send_rcs_card_options_standalone_card_image_alignment.rb +0 -12
- data/lib/pinnacle/types/send_rcs_card_options_standalone_card_orientation.rb +0 -12
- data/lib/pinnacle/types/send_rich_cards_options.rb +0 -9
- data/lib/pinnacle/types/send_rich_message_options.rb +0 -14
- data/lib/pinnacle/types/send_sms_response_segments.rb +0 -11
- data/lib/pinnacle/types/send_sms_response_segments_encoding.rb +0 -12
- data/lib/pinnacle/types/send_typing_indicator_response.rb +0 -14
- data/lib/pinnacle/types/sender.rb +0 -23
- data/lib/pinnacle/types/sent_mms_details.rb +0 -14
- data/lib/pinnacle/types/sent_rich_message.rb +0 -14
- data/lib/pinnacle/types/sent_sms_details.rb +0 -14
- data/lib/pinnacle/types/shortened_url.rb +0 -10
- data/lib/pinnacle/types/shortened_url_with_click_data.rb +0 -9
- data/lib/pinnacle/types/sms_content.rb +0 -10
- data/lib/pinnacle/types/sms_validation_response_segments.rb +0 -11
- data/lib/pinnacle/types/sms_validation_response_segments_gsm_7.rb +0 -12
- data/lib/pinnacle/types/sms_validation_response_segments_utf_16.rb +0 -11
- data/lib/pinnacle/types/sms_validation_response_total.rb +0 -10
- data/lib/pinnacle/types/sms_validation_result.rb +0 -12
- data/lib/pinnacle/types/sub_use_case_enum.rb +0 -20
- data/lib/pinnacle/types/submission_results.rb +0 -9
- data/lib/pinnacle/types/successful_conversation_update.rb +0 -10
- data/lib/pinnacle/types/toll_free_campaign.rb +0 -17
- data/lib/pinnacle/types/toll_free_campaign_schema_keywords.rb +0 -11
- data/lib/pinnacle/types/toll_free_campaign_schema_keywords_help.rb +0 -10
- data/lib/pinnacle/types/toll_free_campaign_schema_keywords_opt_in.rb +0 -11
- data/lib/pinnacle/types/toll_free_campaign_schema_links.rb +0 -11
- data/lib/pinnacle/types/toll_free_campaign_schema_opt_in.rb +0 -12
- data/lib/pinnacle/types/toll_free_campaign_schema_options.rb +0 -10
- data/lib/pinnacle/types/toll_free_campaign_schema_use_case.rb +0 -11
- data/lib/pinnacle/types/toll_free_campaign_status.rb +0 -12
- data/lib/pinnacle/types/toll_free_campaign_use_case_enum.rb +0 -53
- data/lib/pinnacle/types/toll_free_campaign_with_extended_brand_and_status.rb +0 -19
- data/lib/pinnacle/types/toll_free_status_enum.rb +0 -16
- data/lib/pinnacle/types/toll_free_with_extended_brand_and_status_keywords.rb +0 -11
- data/lib/pinnacle/types/toll_free_with_extended_brand_and_status_keywords_help.rb +0 -10
- data/lib/pinnacle/types/toll_free_with_extended_brand_and_status_keywords_opt_in.rb +0 -11
- data/lib/pinnacle/types/toll_free_with_extended_brand_and_status_links.rb +0 -11
- data/lib/pinnacle/types/toll_free_with_extended_brand_and_status_opt_in.rb +0 -12
- data/lib/pinnacle/types/toll_free_with_extended_brand_and_status_options.rb +0 -10
- data/lib/pinnacle/types/toll_free_with_extended_brand_and_status_use_case.rb +0 -11
- data/lib/pinnacle/types/tracking.rb +0 -12
- data/lib/pinnacle/types/updated_contact_id.rb +0 -9
- data/lib/pinnacle/types/upload_results.rb +0 -11
- data/lib/pinnacle/types/user_event.rb +0 -12
- data/lib/pinnacle/types/user_event_conversation.rb +0 -12
- data/lib/pinnacle/types/v_card_address_schema_type_item.rb +0 -17
- data/lib/pinnacle/types/v_card_data.rb +0 -9
- data/lib/pinnacle/types/v_card_data_file.rb +0 -11
- data/lib/pinnacle/types/v_card_data_file_metadata.rb +0 -10
- data/lib/pinnacle/types/v_card_email_schema_type_item.rb +0 -23
- data/lib/pinnacle/types/v_card_geo.rb +0 -11
- data/lib/pinnacle/types/v_card_name.rb +0 -14
- data/lib/pinnacle/types/v_card_organization.rb +0 -11
- data/lib/pinnacle/types/v_card_phone_schema_type_item.rb +0 -23
- data/lib/pinnacle/types/validate_campaign_params.rb +0 -10
- data/lib/pinnacle/types/validation_error_details.rb +0 -11
- data/lib/pinnacle/types/validation_results.rb +0 -10
- data/lib/pinnacle/types/vcard.rb +0 -24
- data/lib/pinnacle/types/vcard_address.rb +0 -17
- data/lib/pinnacle/types/vcard_content.rb +0 -9
- data/lib/pinnacle/types/vcard_email.rb +0 -10
- data/lib/pinnacle/types/vcard_phone.rb +0 -10
- data/lib/pinnacle/types/vcard_resource.rb +0 -10
- data/lib/pinnacle/types/vetting_feedback.rb +0 -12
- data/lib/pinnacle/types/vetting_history.rb +0 -13
- data/lib/pinnacle/types/vetting_history_vetting_status.rb +0 -14
- data/lib/pinnacle/types/vetting_results.rb +0 -9
- data/lib/pinnacle/types/webhook_event_enum.rb +0 -12
- data/lib/pinnacle/types/webhook_result.rb +0 -11
- data/lib/pinnacle/types/webhooks.rb +0 -12
- data/lib/pinnacle/types/zod_error.rb +0 -10
- data/lib/pinnacle/version.rb +0 -5
- data/lib/pinnacle/webhooks/client.rb +0 -51
- data/lib/pinnacle/webhooks/types/get_webhook_params.rb +0 -11
- data/lib/pinnacle/wrapper/messages/client.rb +0 -72
- data/lib/pinnacle/wrapper/tools/client.rb +0 -14
- data/lib/pinnacle/wrapper/tools/file_uploader.rb +0 -149
- data/lib/pinnacle.rb +0 -449
- data/reference.md +0 -5956
- data/wiremock/docker-compose.test.yml +0 -14
- data/wiremock/wiremock-mappings.json +0 -1
- /data/lib/{pinnacle/environment.rb → environment.rb} +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a9973f0ac25a667d4fc684411e98de98f3a414ea4c851df38c57cb08ecd48f7c
|
|
4
|
+
data.tar.gz: e33ee21925018bf8472458ce39debdd7324d3522952f2514b0c93d03b91d81de
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 862c3ef24cff2a33b06c8b82acd5f760b23ea2895e653676218b47fd7f010ed9648d6d154cc597ba6fdb1ad8b7de71e87677275642699d169b931f1ddb9d2e29
|
|
7
|
+
data.tar.gz: 1fc9c84cffa9f53caf66be90c4d1aabdc953bb7c2f90bcdfb7ff4673f17bdab89187909f91f4eaabeff3491da5b5892faa0c16a2331a54b8012c6f9d6b6c45ed
|
data/lib/gemconfig.rb
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Pinnacle
|
|
4
|
+
module Gemconfig
|
|
5
|
+
VERSION = ""
|
|
6
|
+
AUTHORS = [""].freeze
|
|
7
|
+
EMAIL = ""
|
|
8
|
+
SUMMARY = ""
|
|
9
|
+
DESCRIPTION = ""
|
|
10
|
+
HOMEPAGE = "https://github.com/pinnacle-dev/rcs-ruby"
|
|
11
|
+
SOURCE_CODE_URI = "https://github.com/pinnacle-dev/rcs-ruby"
|
|
12
|
+
CHANGELOG_URI = "https://github.com/pinnacle-dev/rcs-ruby/blob/master/CHANGELOG.md"
|
|
13
|
+
end
|
|
14
|
+
end
|
|
@@ -0,0 +1,347 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require_relative "../../requests"
|
|
4
|
+
require_relative "types/audiences_get_response"
|
|
5
|
+
require_relative "../types/audience_count_only"
|
|
6
|
+
require_relative "../types/delete_audience_response"
|
|
7
|
+
require "async"
|
|
8
|
+
|
|
9
|
+
module Pinnacle
|
|
10
|
+
class AudiencesClient
|
|
11
|
+
# @return [Pinnacle::RequestClient]
|
|
12
|
+
attr_reader :request_client
|
|
13
|
+
|
|
14
|
+
# @param request_client [Pinnacle::RequestClient]
|
|
15
|
+
# @return [Pinnacle::AudiencesClient]
|
|
16
|
+
def initialize(request_client:)
|
|
17
|
+
@request_client = request_client
|
|
18
|
+
end
|
|
19
|
+
|
|
20
|
+
# Retrieve an audience by ID with optional pagination.
|
|
21
|
+
#
|
|
22
|
+
# @param id [String] Audience ID. This identifier is a string that always begins with the prefix
|
|
23
|
+
# `aud_`, for example: `aud_abc123`.
|
|
24
|
+
# @param page [Integer] Page number. If provided with or without limit, returns paginated contacts.
|
|
25
|
+
# @param limit [Integer] Items per page. If provided with or without page, returns paginated contacts.
|
|
26
|
+
# @param request_options [Pinnacle::RequestOptions]
|
|
27
|
+
# @return [Pinnacle::Types::AudienceWithPagination, Pinnacle::Types::AudienceCountOnly]
|
|
28
|
+
# @example
|
|
29
|
+
# api = Pinnacle::Client.new(
|
|
30
|
+
# base_url: "https://api.example.com",
|
|
31
|
+
# environment: Pinnacle::Environment::DEFAULT,
|
|
32
|
+
# api_key: "YOUR_API_KEY"
|
|
33
|
+
# )
|
|
34
|
+
# api.audiences.get(id: "aud_abc123")
|
|
35
|
+
def get(id:, page: nil, limit: nil, request_options: nil)
|
|
36
|
+
response = @request_client.conn.get do |req|
|
|
37
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
38
|
+
req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
|
|
39
|
+
req.headers = {
|
|
40
|
+
**(req.headers || {}),
|
|
41
|
+
**@request_client.get_headers,
|
|
42
|
+
**(request_options&.additional_headers || {})
|
|
43
|
+
}.compact
|
|
44
|
+
req.params = {
|
|
45
|
+
**(request_options&.additional_query_parameters || {}),
|
|
46
|
+
"id": id,
|
|
47
|
+
"page": page,
|
|
48
|
+
"limit": limit
|
|
49
|
+
}.compact
|
|
50
|
+
unless request_options.nil? || request_options&.additional_body_parameters.nil?
|
|
51
|
+
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
|
|
52
|
+
end
|
|
53
|
+
req.url "#{@request_client.get_url(request_options: request_options)}/audiences"
|
|
54
|
+
end
|
|
55
|
+
Pinnacle::Audiences::Types::AudiencesGetResponse.from_json(json_object: response.body)
|
|
56
|
+
end
|
|
57
|
+
|
|
58
|
+
# Create a new audience with optional initial contacts. Phone numbers that don't
|
|
59
|
+
# exist will be auto-created as contacts.
|
|
60
|
+
#
|
|
61
|
+
# @param name [String] Audience name.
|
|
62
|
+
# @param description [String] Audience description.
|
|
63
|
+
# @param contacts [Array<String>] Optional array of phone numbers (E.164 format) or contact IDs.
|
|
64
|
+
# @param request_options [Pinnacle::RequestOptions]
|
|
65
|
+
# @return [Pinnacle::Types::AudienceCountOnly]
|
|
66
|
+
# @example
|
|
67
|
+
# api = Pinnacle::Client.new(
|
|
68
|
+
# base_url: "https://api.example.com",
|
|
69
|
+
# environment: Pinnacle::Environment::DEFAULT,
|
|
70
|
+
# api_key: "YOUR_API_KEY"
|
|
71
|
+
# )
|
|
72
|
+
# api.audiences.create(name: "Marketing Campaign Q1", description: "Contacts for Q1 marketing push")
|
|
73
|
+
def create(name:, description: nil, contacts: nil, request_options: nil)
|
|
74
|
+
response = @request_client.conn.post do |req|
|
|
75
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
76
|
+
req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
|
|
77
|
+
req.headers = {
|
|
78
|
+
**(req.headers || {}),
|
|
79
|
+
**@request_client.get_headers,
|
|
80
|
+
**(request_options&.additional_headers || {})
|
|
81
|
+
}.compact
|
|
82
|
+
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
|
83
|
+
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
|
84
|
+
end
|
|
85
|
+
req.body = {
|
|
86
|
+
**(request_options&.additional_body_parameters || {}),
|
|
87
|
+
name: name,
|
|
88
|
+
description: description,
|
|
89
|
+
contacts: contacts
|
|
90
|
+
}.compact
|
|
91
|
+
req.url "#{@request_client.get_url(request_options: request_options)}/audiences"
|
|
92
|
+
end
|
|
93
|
+
Pinnacle::Types::AudienceCountOnly.from_json(json_object: response.body)
|
|
94
|
+
end
|
|
95
|
+
|
|
96
|
+
# Permanently delete an audience and all its contact associations.
|
|
97
|
+
# Note: This will NOT delete the contacts themselves, only the audience and its
|
|
98
|
+
# memberships.
|
|
99
|
+
#
|
|
100
|
+
# @param id [String] Audience ID. This identifier is a string that always begins with the prefix
|
|
101
|
+
# `aud_`, for example: `aud_abc123`.
|
|
102
|
+
# @param request_options [Pinnacle::RequestOptions]
|
|
103
|
+
# @return [Pinnacle::Types::DeleteAudienceResponse]
|
|
104
|
+
# @example
|
|
105
|
+
# api = Pinnacle::Client.new(
|
|
106
|
+
# base_url: "https://api.example.com",
|
|
107
|
+
# environment: Pinnacle::Environment::DEFAULT,
|
|
108
|
+
# api_key: "YOUR_API_KEY"
|
|
109
|
+
# )
|
|
110
|
+
# api.audiences.delete(id: "aud_abc123")
|
|
111
|
+
def delete(id:, request_options: nil)
|
|
112
|
+
response = @request_client.conn.delete do |req|
|
|
113
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
114
|
+
req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
|
|
115
|
+
req.headers = {
|
|
116
|
+
**(req.headers || {}),
|
|
117
|
+
**@request_client.get_headers,
|
|
118
|
+
**(request_options&.additional_headers || {})
|
|
119
|
+
}.compact
|
|
120
|
+
req.params = { **(request_options&.additional_query_parameters || {}), "id": id }.compact
|
|
121
|
+
unless request_options.nil? || request_options&.additional_body_parameters.nil?
|
|
122
|
+
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
|
|
123
|
+
end
|
|
124
|
+
req.url "#{@request_client.get_url(request_options: request_options)}/audiences"
|
|
125
|
+
end
|
|
126
|
+
Pinnacle::Types::DeleteAudienceResponse.from_json(json_object: response.body)
|
|
127
|
+
end
|
|
128
|
+
|
|
129
|
+
# Update audience metadata. This endpoint does NOT modify contacts.
|
|
130
|
+
# To add or remove contacts, use the [Add
|
|
131
|
+
# Contacts](/api-reference/audiences/add-contacts) or [Remove
|
|
132
|
+
# Contacts](/api-reference/audiences/remove-contacts) endpoints.
|
|
133
|
+
#
|
|
134
|
+
# @param id [String] Audience ID to update. This identifier is a string that always begins with the
|
|
135
|
+
# prefix `aud_`, for example: `aud_abc123`.
|
|
136
|
+
# @param name [String] New audience name.
|
|
137
|
+
# @param description [String] New audience description.
|
|
138
|
+
# @param request_options [Pinnacle::RequestOptions]
|
|
139
|
+
# @return [Pinnacle::Types::AudienceCountOnly]
|
|
140
|
+
# @example
|
|
141
|
+
# api = Pinnacle::Client.new(
|
|
142
|
+
# base_url: "https://api.example.com",
|
|
143
|
+
# environment: Pinnacle::Environment::DEFAULT,
|
|
144
|
+
# api_key: "YOUR_API_KEY"
|
|
145
|
+
# )
|
|
146
|
+
# api.audiences.update(
|
|
147
|
+
# id: "aud_abc123",
|
|
148
|
+
# name: "Updated Audience Name",
|
|
149
|
+
# description: "New description"
|
|
150
|
+
# )
|
|
151
|
+
def update(id:, name: nil, description: nil, request_options: nil)
|
|
152
|
+
response = @request_client.conn.patch do |req|
|
|
153
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
154
|
+
req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
|
|
155
|
+
req.headers = {
|
|
156
|
+
**(req.headers || {}),
|
|
157
|
+
**@request_client.get_headers,
|
|
158
|
+
**(request_options&.additional_headers || {})
|
|
159
|
+
}.compact
|
|
160
|
+
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
|
161
|
+
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
|
162
|
+
end
|
|
163
|
+
req.body = {
|
|
164
|
+
**(request_options&.additional_body_parameters || {}),
|
|
165
|
+
id: id,
|
|
166
|
+
name: name,
|
|
167
|
+
description: description
|
|
168
|
+
}.compact
|
|
169
|
+
req.url "#{@request_client.get_url(request_options: request_options)}/audiences"
|
|
170
|
+
end
|
|
171
|
+
Pinnacle::Types::AudienceCountOnly.from_json(json_object: response.body)
|
|
172
|
+
end
|
|
173
|
+
end
|
|
174
|
+
|
|
175
|
+
class AsyncAudiencesClient
|
|
176
|
+
# @return [Pinnacle::AsyncRequestClient]
|
|
177
|
+
attr_reader :request_client
|
|
178
|
+
|
|
179
|
+
# @param request_client [Pinnacle::AsyncRequestClient]
|
|
180
|
+
# @return [Pinnacle::AsyncAudiencesClient]
|
|
181
|
+
def initialize(request_client:)
|
|
182
|
+
@request_client = request_client
|
|
183
|
+
end
|
|
184
|
+
|
|
185
|
+
# Retrieve an audience by ID with optional pagination.
|
|
186
|
+
#
|
|
187
|
+
# @param id [String] Audience ID. This identifier is a string that always begins with the prefix
|
|
188
|
+
# `aud_`, for example: `aud_abc123`.
|
|
189
|
+
# @param page [Integer] Page number. If provided with or without limit, returns paginated contacts.
|
|
190
|
+
# @param limit [Integer] Items per page. If provided with or without page, returns paginated contacts.
|
|
191
|
+
# @param request_options [Pinnacle::RequestOptions]
|
|
192
|
+
# @return [Pinnacle::Types::AudienceWithPagination, Pinnacle::Types::AudienceCountOnly]
|
|
193
|
+
# @example
|
|
194
|
+
# api = Pinnacle::Client.new(
|
|
195
|
+
# base_url: "https://api.example.com",
|
|
196
|
+
# environment: Pinnacle::Environment::DEFAULT,
|
|
197
|
+
# api_key: "YOUR_API_KEY"
|
|
198
|
+
# )
|
|
199
|
+
# api.audiences.get(id: "aud_abc123")
|
|
200
|
+
def get(id:, page: nil, limit: nil, request_options: nil)
|
|
201
|
+
Async do
|
|
202
|
+
response = @request_client.conn.get do |req|
|
|
203
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
204
|
+
req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
|
|
205
|
+
req.headers = {
|
|
206
|
+
**(req.headers || {}),
|
|
207
|
+
**@request_client.get_headers,
|
|
208
|
+
**(request_options&.additional_headers || {})
|
|
209
|
+
}.compact
|
|
210
|
+
req.params = {
|
|
211
|
+
**(request_options&.additional_query_parameters || {}),
|
|
212
|
+
"id": id,
|
|
213
|
+
"page": page,
|
|
214
|
+
"limit": limit
|
|
215
|
+
}.compact
|
|
216
|
+
unless request_options.nil? || request_options&.additional_body_parameters.nil?
|
|
217
|
+
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
|
|
218
|
+
end
|
|
219
|
+
req.url "#{@request_client.get_url(request_options: request_options)}/audiences"
|
|
220
|
+
end
|
|
221
|
+
Pinnacle::Audiences::Types::AudiencesGetResponse.from_json(json_object: response.body)
|
|
222
|
+
end
|
|
223
|
+
end
|
|
224
|
+
|
|
225
|
+
# Create a new audience with optional initial contacts. Phone numbers that don't
|
|
226
|
+
# exist will be auto-created as contacts.
|
|
227
|
+
#
|
|
228
|
+
# @param name [String] Audience name.
|
|
229
|
+
# @param description [String] Audience description.
|
|
230
|
+
# @param contacts [Array<String>] Optional array of phone numbers (E.164 format) or contact IDs.
|
|
231
|
+
# @param request_options [Pinnacle::RequestOptions]
|
|
232
|
+
# @return [Pinnacle::Types::AudienceCountOnly]
|
|
233
|
+
# @example
|
|
234
|
+
# api = Pinnacle::Client.new(
|
|
235
|
+
# base_url: "https://api.example.com",
|
|
236
|
+
# environment: Pinnacle::Environment::DEFAULT,
|
|
237
|
+
# api_key: "YOUR_API_KEY"
|
|
238
|
+
# )
|
|
239
|
+
# api.audiences.create(name: "Marketing Campaign Q1", description: "Contacts for Q1 marketing push")
|
|
240
|
+
def create(name:, description: nil, contacts: nil, request_options: nil)
|
|
241
|
+
Async do
|
|
242
|
+
response = @request_client.conn.post do |req|
|
|
243
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
244
|
+
req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
|
|
245
|
+
req.headers = {
|
|
246
|
+
**(req.headers || {}),
|
|
247
|
+
**@request_client.get_headers,
|
|
248
|
+
**(request_options&.additional_headers || {})
|
|
249
|
+
}.compact
|
|
250
|
+
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
|
251
|
+
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
|
252
|
+
end
|
|
253
|
+
req.body = {
|
|
254
|
+
**(request_options&.additional_body_parameters || {}),
|
|
255
|
+
name: name,
|
|
256
|
+
description: description,
|
|
257
|
+
contacts: contacts
|
|
258
|
+
}.compact
|
|
259
|
+
req.url "#{@request_client.get_url(request_options: request_options)}/audiences"
|
|
260
|
+
end
|
|
261
|
+
Pinnacle::Types::AudienceCountOnly.from_json(json_object: response.body)
|
|
262
|
+
end
|
|
263
|
+
end
|
|
264
|
+
|
|
265
|
+
# Permanently delete an audience and all its contact associations.
|
|
266
|
+
# Note: This will NOT delete the contacts themselves, only the audience and its
|
|
267
|
+
# memberships.
|
|
268
|
+
#
|
|
269
|
+
# @param id [String] Audience ID. This identifier is a string that always begins with the prefix
|
|
270
|
+
# `aud_`, for example: `aud_abc123`.
|
|
271
|
+
# @param request_options [Pinnacle::RequestOptions]
|
|
272
|
+
# @return [Pinnacle::Types::DeleteAudienceResponse]
|
|
273
|
+
# @example
|
|
274
|
+
# api = Pinnacle::Client.new(
|
|
275
|
+
# base_url: "https://api.example.com",
|
|
276
|
+
# environment: Pinnacle::Environment::DEFAULT,
|
|
277
|
+
# api_key: "YOUR_API_KEY"
|
|
278
|
+
# )
|
|
279
|
+
# api.audiences.delete(id: "aud_abc123")
|
|
280
|
+
def delete(id:, request_options: nil)
|
|
281
|
+
Async do
|
|
282
|
+
response = @request_client.conn.delete do |req|
|
|
283
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
284
|
+
req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
|
|
285
|
+
req.headers = {
|
|
286
|
+
**(req.headers || {}),
|
|
287
|
+
**@request_client.get_headers,
|
|
288
|
+
**(request_options&.additional_headers || {})
|
|
289
|
+
}.compact
|
|
290
|
+
req.params = { **(request_options&.additional_query_parameters || {}), "id": id }.compact
|
|
291
|
+
unless request_options.nil? || request_options&.additional_body_parameters.nil?
|
|
292
|
+
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
|
|
293
|
+
end
|
|
294
|
+
req.url "#{@request_client.get_url(request_options: request_options)}/audiences"
|
|
295
|
+
end
|
|
296
|
+
Pinnacle::Types::DeleteAudienceResponse.from_json(json_object: response.body)
|
|
297
|
+
end
|
|
298
|
+
end
|
|
299
|
+
|
|
300
|
+
# Update audience metadata. This endpoint does NOT modify contacts.
|
|
301
|
+
# To add or remove contacts, use the [Add
|
|
302
|
+
# Contacts](/api-reference/audiences/add-contacts) or [Remove
|
|
303
|
+
# Contacts](/api-reference/audiences/remove-contacts) endpoints.
|
|
304
|
+
#
|
|
305
|
+
# @param id [String] Audience ID to update. This identifier is a string that always begins with the
|
|
306
|
+
# prefix `aud_`, for example: `aud_abc123`.
|
|
307
|
+
# @param name [String] New audience name.
|
|
308
|
+
# @param description [String] New audience description.
|
|
309
|
+
# @param request_options [Pinnacle::RequestOptions]
|
|
310
|
+
# @return [Pinnacle::Types::AudienceCountOnly]
|
|
311
|
+
# @example
|
|
312
|
+
# api = Pinnacle::Client.new(
|
|
313
|
+
# base_url: "https://api.example.com",
|
|
314
|
+
# environment: Pinnacle::Environment::DEFAULT,
|
|
315
|
+
# api_key: "YOUR_API_KEY"
|
|
316
|
+
# )
|
|
317
|
+
# api.audiences.update(
|
|
318
|
+
# id: "aud_abc123",
|
|
319
|
+
# name: "Updated Audience Name",
|
|
320
|
+
# description: "New description"
|
|
321
|
+
# )
|
|
322
|
+
def update(id:, name: nil, description: nil, request_options: nil)
|
|
323
|
+
Async do
|
|
324
|
+
response = @request_client.conn.patch do |req|
|
|
325
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
326
|
+
req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
|
|
327
|
+
req.headers = {
|
|
328
|
+
**(req.headers || {}),
|
|
329
|
+
**@request_client.get_headers,
|
|
330
|
+
**(request_options&.additional_headers || {})
|
|
331
|
+
}.compact
|
|
332
|
+
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
|
333
|
+
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
|
334
|
+
end
|
|
335
|
+
req.body = {
|
|
336
|
+
**(request_options&.additional_body_parameters || {}),
|
|
337
|
+
id: id,
|
|
338
|
+
name: name,
|
|
339
|
+
description: description
|
|
340
|
+
}.compact
|
|
341
|
+
req.url "#{@request_client.get_url(request_options: request_options)}/audiences"
|
|
342
|
+
end
|
|
343
|
+
Pinnacle::Types::AudienceCountOnly.from_json(json_object: response.body)
|
|
344
|
+
end
|
|
345
|
+
end
|
|
346
|
+
end
|
|
347
|
+
end
|
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require_relative "../../../requests"
|
|
4
|
+
require_relative "../../types/audience_count_only"
|
|
5
|
+
require "async"
|
|
6
|
+
|
|
7
|
+
module Pinnacle
|
|
8
|
+
module Audiences
|
|
9
|
+
class ContactsClient
|
|
10
|
+
# @return [Pinnacle::RequestClient]
|
|
11
|
+
attr_reader :request_client
|
|
12
|
+
|
|
13
|
+
# @param request_client [Pinnacle::RequestClient]
|
|
14
|
+
# @return [Pinnacle::Audiences::ContactsClient]
|
|
15
|
+
def initialize(request_client:)
|
|
16
|
+
@request_client = request_client
|
|
17
|
+
end
|
|
18
|
+
|
|
19
|
+
# Remove contacts from an existing audience. This operation is idempotent.
|
|
20
|
+
# - Only removes contacts that exist in the audience
|
|
21
|
+
# - Contacts not in the audience are ignored
|
|
22
|
+
#
|
|
23
|
+
# @param id [String] Audience ID. This identifier is a string that always begins with the prefix
|
|
24
|
+
# `aud_`, for example: `aud_abc123`.
|
|
25
|
+
# @param contacts [Array<String>] Array of phone numbers (E.164 format) or contact IDs. <br><br>
|
|
26
|
+
# **Limit:** 1 min
|
|
27
|
+
# @param request_options [Pinnacle::RequestOptions]
|
|
28
|
+
# @return [Pinnacle::Types::AudienceCountOnly]
|
|
29
|
+
# @example
|
|
30
|
+
# api = Pinnacle::Client.new(
|
|
31
|
+
# base_url: "https://api.example.com",
|
|
32
|
+
# environment: Pinnacle::Environment::DEFAULT,
|
|
33
|
+
# api_key: "YOUR_API_KEY"
|
|
34
|
+
# )
|
|
35
|
+
# api.audiences.contacts.remove(id: "aud_abc123", contacts: ["+12125551234", "co_def456"])
|
|
36
|
+
def remove(id:, contacts:, request_options: nil)
|
|
37
|
+
response = @request_client.conn.delete do |req|
|
|
38
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
39
|
+
req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
|
|
40
|
+
req.headers = {
|
|
41
|
+
**(req.headers || {}),
|
|
42
|
+
**@request_client.get_headers,
|
|
43
|
+
**(request_options&.additional_headers || {})
|
|
44
|
+
}.compact
|
|
45
|
+
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
|
46
|
+
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
|
47
|
+
end
|
|
48
|
+
req.body = { **(request_options&.additional_body_parameters || {}), id: id, contacts: contacts }.compact
|
|
49
|
+
req.url "#{@request_client.get_url(request_options: request_options)}/audiences/contacts"
|
|
50
|
+
end
|
|
51
|
+
Pinnacle::Types::AudienceCountOnly.from_json(json_object: response.body)
|
|
52
|
+
end
|
|
53
|
+
|
|
54
|
+
# Add contacts to an existing audience. This operation is additive and idempotent.
|
|
55
|
+
# - Phone numbers that don't exist will be auto-created as contacts
|
|
56
|
+
# - Duplicate adds are ignored
|
|
57
|
+
# - Contacts already in the audience are ignored
|
|
58
|
+
#
|
|
59
|
+
# @param id [String] Audience ID. This identifier is a string that always begins with the prefix
|
|
60
|
+
# `aud_`, for example: `aud_abc123`.
|
|
61
|
+
# @param contacts [Array<String>] Array of phone numbers (E.164 format) or contact IDs. <br><br>
|
|
62
|
+
# **Limit:** 1 min
|
|
63
|
+
# @param request_options [Pinnacle::RequestOptions]
|
|
64
|
+
# @return [Pinnacle::Types::AudienceCountOnly]
|
|
65
|
+
# @example
|
|
66
|
+
# api = Pinnacle::Client.new(
|
|
67
|
+
# base_url: "https://api.example.com",
|
|
68
|
+
# environment: Pinnacle::Environment::DEFAULT,
|
|
69
|
+
# api_key: "YOUR_API_KEY"
|
|
70
|
+
# )
|
|
71
|
+
# api.audiences.contacts.add(id: "aud_abc123", contacts: ["+12125551234", "co_def456", "+13105551234"])
|
|
72
|
+
def add(id:, contacts:, request_options: nil)
|
|
73
|
+
response = @request_client.conn.patch do |req|
|
|
74
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
75
|
+
req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
|
|
76
|
+
req.headers = {
|
|
77
|
+
**(req.headers || {}),
|
|
78
|
+
**@request_client.get_headers,
|
|
79
|
+
**(request_options&.additional_headers || {})
|
|
80
|
+
}.compact
|
|
81
|
+
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
|
82
|
+
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
|
83
|
+
end
|
|
84
|
+
req.body = { **(request_options&.additional_body_parameters || {}), id: id, contacts: contacts }.compact
|
|
85
|
+
req.url "#{@request_client.get_url(request_options: request_options)}/audiences/contacts"
|
|
86
|
+
end
|
|
87
|
+
Pinnacle::Types::AudienceCountOnly.from_json(json_object: response.body)
|
|
88
|
+
end
|
|
89
|
+
end
|
|
90
|
+
|
|
91
|
+
class AsyncContactsClient
|
|
92
|
+
# @return [Pinnacle::AsyncRequestClient]
|
|
93
|
+
attr_reader :request_client
|
|
94
|
+
|
|
95
|
+
# @param request_client [Pinnacle::AsyncRequestClient]
|
|
96
|
+
# @return [Pinnacle::Audiences::AsyncContactsClient]
|
|
97
|
+
def initialize(request_client:)
|
|
98
|
+
@request_client = request_client
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
# Remove contacts from an existing audience. This operation is idempotent.
|
|
102
|
+
# - Only removes contacts that exist in the audience
|
|
103
|
+
# - Contacts not in the audience are ignored
|
|
104
|
+
#
|
|
105
|
+
# @param id [String] Audience ID. This identifier is a string that always begins with the prefix
|
|
106
|
+
# `aud_`, for example: `aud_abc123`.
|
|
107
|
+
# @param contacts [Array<String>] Array of phone numbers (E.164 format) or contact IDs. <br><br>
|
|
108
|
+
# **Limit:** 1 min
|
|
109
|
+
# @param request_options [Pinnacle::RequestOptions]
|
|
110
|
+
# @return [Pinnacle::Types::AudienceCountOnly]
|
|
111
|
+
# @example
|
|
112
|
+
# api = Pinnacle::Client.new(
|
|
113
|
+
# base_url: "https://api.example.com",
|
|
114
|
+
# environment: Pinnacle::Environment::DEFAULT,
|
|
115
|
+
# api_key: "YOUR_API_KEY"
|
|
116
|
+
# )
|
|
117
|
+
# api.audiences.contacts.remove(id: "aud_abc123", contacts: ["+12125551234", "co_def456"])
|
|
118
|
+
def remove(id:, contacts:, request_options: nil)
|
|
119
|
+
Async do
|
|
120
|
+
response = @request_client.conn.delete do |req|
|
|
121
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
122
|
+
req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
|
|
123
|
+
req.headers = {
|
|
124
|
+
**(req.headers || {}),
|
|
125
|
+
**@request_client.get_headers,
|
|
126
|
+
**(request_options&.additional_headers || {})
|
|
127
|
+
}.compact
|
|
128
|
+
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
|
129
|
+
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
|
130
|
+
end
|
|
131
|
+
req.body = { **(request_options&.additional_body_parameters || {}), id: id, contacts: contacts }.compact
|
|
132
|
+
req.url "#{@request_client.get_url(request_options: request_options)}/audiences/contacts"
|
|
133
|
+
end
|
|
134
|
+
Pinnacle::Types::AudienceCountOnly.from_json(json_object: response.body)
|
|
135
|
+
end
|
|
136
|
+
end
|
|
137
|
+
|
|
138
|
+
# Add contacts to an existing audience. This operation is additive and idempotent.
|
|
139
|
+
# - Phone numbers that don't exist will be auto-created as contacts
|
|
140
|
+
# - Duplicate adds are ignored
|
|
141
|
+
# - Contacts already in the audience are ignored
|
|
142
|
+
#
|
|
143
|
+
# @param id [String] Audience ID. This identifier is a string that always begins with the prefix
|
|
144
|
+
# `aud_`, for example: `aud_abc123`.
|
|
145
|
+
# @param contacts [Array<String>] Array of phone numbers (E.164 format) or contact IDs. <br><br>
|
|
146
|
+
# **Limit:** 1 min
|
|
147
|
+
# @param request_options [Pinnacle::RequestOptions]
|
|
148
|
+
# @return [Pinnacle::Types::AudienceCountOnly]
|
|
149
|
+
# @example
|
|
150
|
+
# api = Pinnacle::Client.new(
|
|
151
|
+
# base_url: "https://api.example.com",
|
|
152
|
+
# environment: Pinnacle::Environment::DEFAULT,
|
|
153
|
+
# api_key: "YOUR_API_KEY"
|
|
154
|
+
# )
|
|
155
|
+
# api.audiences.contacts.add(id: "aud_abc123", contacts: ["+12125551234", "co_def456", "+13105551234"])
|
|
156
|
+
def add(id:, contacts:, request_options: nil)
|
|
157
|
+
Async do
|
|
158
|
+
response = @request_client.conn.patch do |req|
|
|
159
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
160
|
+
req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
|
|
161
|
+
req.headers = {
|
|
162
|
+
**(req.headers || {}),
|
|
163
|
+
**@request_client.get_headers,
|
|
164
|
+
**(request_options&.additional_headers || {})
|
|
165
|
+
}.compact
|
|
166
|
+
unless request_options.nil? || request_options&.additional_query_parameters.nil?
|
|
167
|
+
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
|
|
168
|
+
end
|
|
169
|
+
req.body = { **(request_options&.additional_body_parameters || {}), id: id, contacts: contacts }.compact
|
|
170
|
+
req.url "#{@request_client.get_url(request_options: request_options)}/audiences/contacts"
|
|
171
|
+
end
|
|
172
|
+
Pinnacle::Types::AudienceCountOnly.from_json(json_object: response.body)
|
|
173
|
+
end
|
|
174
|
+
end
|
|
175
|
+
end
|
|
176
|
+
end
|
|
177
|
+
end
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require "json"
|
|
4
|
+
require_relative "../../types/audience_with_pagination"
|
|
5
|
+
require_relative "../../types/audience_count_only"
|
|
6
|
+
|
|
7
|
+
module Pinnacle
|
|
8
|
+
module Audiences
|
|
9
|
+
module Types
|
|
10
|
+
class AudiencesGetResponse
|
|
11
|
+
# Deserialize a JSON object to an instance of AudiencesGetResponse
|
|
12
|
+
#
|
|
13
|
+
# @param json_object [String]
|
|
14
|
+
# @return [Pinnacle::Audiences::Types::AudiencesGetResponse]
|
|
15
|
+
def self.from_json(json_object:)
|
|
16
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
|
17
|
+
begin
|
|
18
|
+
Pinnacle::Types::AudienceWithPagination.validate_raw(obj: struct)
|
|
19
|
+
return Pinnacle::Types::AudienceWithPagination.from_json(json_object: struct) unless struct.nil?
|
|
20
|
+
|
|
21
|
+
return nil
|
|
22
|
+
rescue StandardError
|
|
23
|
+
# noop
|
|
24
|
+
end
|
|
25
|
+
begin
|
|
26
|
+
Pinnacle::Types::AudienceCountOnly.validate_raw(obj: struct)
|
|
27
|
+
return Pinnacle::Types::AudienceCountOnly.from_json(json_object: struct) unless struct.nil?
|
|
28
|
+
|
|
29
|
+
return nil
|
|
30
|
+
rescue StandardError
|
|
31
|
+
# noop
|
|
32
|
+
end
|
|
33
|
+
struct
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
# Leveraged for Union-type generation, validate_raw attempts to parse the given
|
|
37
|
+
# hash and check each fields type against the current object's property
|
|
38
|
+
# definitions.
|
|
39
|
+
#
|
|
40
|
+
# @param obj [Object]
|
|
41
|
+
# @return [Void]
|
|
42
|
+
def self.validate_raw(obj:)
|
|
43
|
+
begin
|
|
44
|
+
return Pinnacle::Types::AudienceWithPagination.validate_raw(obj: obj)
|
|
45
|
+
rescue StandardError
|
|
46
|
+
# noop
|
|
47
|
+
end
|
|
48
|
+
begin
|
|
49
|
+
return Pinnacle::Types::AudienceCountOnly.validate_raw(obj: obj)
|
|
50
|
+
rescue StandardError
|
|
51
|
+
# noop
|
|
52
|
+
end
|
|
53
|
+
raise("Passed value matched no type within the union, validation failed.")
|
|
54
|
+
end
|
|
55
|
+
end
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
end
|