rcs 2.0.17 → 2.0.19
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 +6 -3
- data/.rubocop.yml +34 -0
- data/CONTRIBUTING.md +120 -0
- data/lib/pinnacle/audiences/client.rb +0 -4
- data/lib/pinnacle/audiences/contacts/types/add_contacts_params.rb +1 -0
- data/lib/pinnacle/audiences/contacts/types/remove_contacts_params.rb +1 -0
- data/lib/pinnacle/audiences/types/audiences_get_request.rb +2 -0
- data/lib/pinnacle/audiences/types/audiences_get_response.rb +1 -0
- data/lib/pinnacle/audiences/types/create_audience_params.rb +2 -0
- data/lib/pinnacle/audiences/types/list_audiences_params.rb +2 -0
- data/lib/pinnacle/audiences/types/update_audience_params.rb +2 -0
- data/lib/pinnacle/brands/client.rb +1 -3
- data/lib/pinnacle/brands/types/autofill_brand_params.rb +3 -0
- data/lib/pinnacle/brands/types/brands_get_request.rb +1 -0
- data/lib/pinnacle/brands/types/list_brands_params.rb +4 -0
- data/lib/pinnacle/brands/types/upsert_brand_params.rb +11 -0
- data/lib/pinnacle/brands/types/upsert_brand_schema_contact.rb +3 -0
- data/lib/pinnacle/brands/types/vet_brand_params.rb +3 -0
- data/lib/pinnacle/campaigns/dlc/types/dlc_campaign_help_keywords.rb +1 -0
- data/lib/pinnacle/campaigns/dlc/types/dlc_campaign_keywords.rb +2 -0
- data/lib/pinnacle/campaigns/dlc/types/dlc_campaign_links.rb +1 -0
- data/lib/pinnacle/campaigns/dlc/types/dlc_campaign_opt_in_keywords.rb +1 -0
- data/lib/pinnacle/campaigns/dlc/types/dlc_campaign_opt_out_keywords.rb +1 -0
- data/lib/pinnacle/campaigns/dlc/types/dlc_campaign_options.rb +5 -0
- data/lib/pinnacle/campaigns/dlc/types/dlc_campaign_use_case.rb +1 -0
- data/lib/pinnacle/campaigns/dlc/types/list_dlc_campaigns_params.rb +4 -0
- data/lib/pinnacle/campaigns/dlc/types/upsert_dlc_campaign_params.rb +10 -0
- data/lib/pinnacle/campaigns/rcs/types/list_rcs_campaigns_params.rb +4 -0
- data/lib/pinnacle/campaigns/rcs/types/rcs_agent.rb +7 -0
- data/lib/pinnacle/campaigns/rcs/types/rcs_agent_email.rb +1 -0
- data/lib/pinnacle/campaigns/rcs/types/rcs_agent_phone.rb +1 -0
- data/lib/pinnacle/campaigns/rcs/types/rcs_agent_website.rb +1 -0
- data/lib/pinnacle/campaigns/rcs/types/rcs_campaign_help_keywords.rb +1 -0
- data/lib/pinnacle/campaigns/rcs/types/rcs_campaign_keywords.rb +2 -0
- data/lib/pinnacle/campaigns/rcs/types/rcs_campaign_opt_in_keywords.rb +1 -0
- data/lib/pinnacle/campaigns/rcs/types/rcs_campaign_opt_out_keywords.rb +1 -0
- data/lib/pinnacle/campaigns/rcs/types/rcs_campaign_traffic.rb +1 -0
- data/lib/pinnacle/campaigns/rcs/types/rcs_links.rb +1 -0
- data/lib/pinnacle/campaigns/rcs/types/upsert_rcs_campaign_params.rb +12 -0
- data/lib/pinnacle/campaigns/toll_free/types/list_toll_free_campaigns_params.rb +4 -0
- data/lib/pinnacle/campaigns/toll_free/types/toll_free_campaign_keywords.rb +1 -0
- data/lib/pinnacle/campaigns/toll_free/types/toll_free_campaign_links.rb +1 -0
- data/lib/pinnacle/campaigns/toll_free/types/toll_free_campaign_opt_in.rb +2 -0
- data/lib/pinnacle/campaigns/toll_free/types/toll_free_campaign_opt_in_keywords.rb +1 -0
- data/lib/pinnacle/campaigns/toll_free/types/toll_free_campaign_use_case.rb +1 -0
- data/lib/pinnacle/campaigns/toll_free/types/upsert_toll_free_campaign_params.rb +9 -0
- data/lib/pinnacle/client.rb +2 -2
- data/lib/pinnacle/contacts/client.rb +0 -2
- data/lib/pinnacle/contacts/types/contacts_get_request.rb +1 -0
- data/lib/pinnacle/contacts/types/create_contact_params.rb +4 -0
- data/lib/pinnacle/contacts/types/list_contacts_params.rb +5 -0
- data/lib/pinnacle/contacts/types/update_contact_params.rb +4 -0
- data/lib/pinnacle/conversations/client.rb +0 -2
- data/lib/pinnacle/conversations/types/conversations_list_messages_request.rb +8 -0
- data/lib/pinnacle/conversations/types/list_conversations_params.rb +6 -0
- data/lib/pinnacle/conversations/types/update_conversation_params.rb +1 -0
- data/lib/pinnacle/forms/client.rb +1 -1
- data/lib/pinnacle/forms/submissions/client.rb +1 -1
- data/lib/pinnacle/forms/submissions/types/list_form_submissions_params.rb +2 -0
- data/lib/pinnacle/forms/types/forms_send_response.rb +1 -0
- data/lib/pinnacle/forms/types/list_forms_params.rb +1 -0
- data/lib/pinnacle/forms/types/update_form_params.rb +7 -0
- data/lib/pinnacle/internal/http/raw_client.rb +3 -2
- data/lib/pinnacle/internal/iterators/cursor_page_iterator.rb +14 -2
- data/lib/pinnacle/internal/iterators/item_iterator.rb +6 -0
- data/lib/pinnacle/internal/iterators/offset_page_iterator.rb +22 -2
- data/lib/pinnacle/internal/types/utils.rb +2 -2
- data/lib/pinnacle/messages/blast/types/blast_mms.rb +3 -0
- data/lib/pinnacle/messages/blast/types/blast_mms_options.rb +1 -0
- data/lib/pinnacle/messages/blast/types/blast_mms_response.rb +1 -0
- data/lib/pinnacle/messages/blast/types/blast_rcs.rb +4 -0
- data/lib/pinnacle/messages/blast/types/blast_rcs_options.rb +3 -0
- data/lib/pinnacle/messages/blast/types/blast_rcs_request_options_standalone_card.rb +1 -0
- data/lib/pinnacle/messages/blast/types/blast_rcs_response.rb +1 -0
- data/lib/pinnacle/messages/blast/types/blast_sms.rb +3 -0
- data/lib/pinnacle/messages/blast/types/blast_sms_response.rb +1 -0
- data/lib/pinnacle/messages/blasts/types/list_blasts_params.rb +4 -0
- data/lib/pinnacle/messages/mms/types/mms.rb +4 -0
- data/lib/pinnacle/messages/mms/types/mms_send_response.rb +1 -0
- data/lib/pinnacle/messages/mms/types/send_mms_options.rb +3 -0
- data/lib/pinnacle/messages/rcs/types/send_rich_message_response.rb +3 -0
- data/lib/pinnacle/messages/rcs/types/send_typing_indicator_schema.rb +1 -0
- data/lib/pinnacle/messages/schedules/types/list_scheduled_messages_params.rb +4 -0
- data/lib/pinnacle/messages/sms/types/send_sms_options.rb +1 -0
- data/lib/pinnacle/messages/sms/types/sms.rb +3 -0
- data/lib/pinnacle/messages/sms/types/sms_send_response.rb +1 -0
- data/lib/pinnacle/messages/types/list_messages_params.rb +10 -0
- data/lib/pinnacle/messages/types/react_message_params.rb +2 -0
- data/lib/pinnacle/phone_numbers/campaign/types/attach_campaign_params.rb +2 -0
- data/lib/pinnacle/phone_numbers/types/list_phone_numbers_params.rb +1 -0
- data/lib/pinnacle/phone_numbers/types/phone_numbers_get_response.rb +1 -0
- data/lib/pinnacle/phone_numbers/types/retrieve_phone_number_details_options.rb +2 -0
- data/lib/pinnacle/phone_numbers/types/retrieve_phone_number_details_params.rb +2 -0
- data/lib/pinnacle/phone_numbers/types/search_phone_number_by_digits.rb +2 -0
- data/lib/pinnacle/phone_numbers/types/search_phone_number_by_location.rb +3 -0
- data/lib/pinnacle/phone_numbers/types/search_phone_number_params.rb +4 -0
- data/lib/pinnacle/rcs/agents/types/list_agents_params.rb +3 -0
- data/lib/pinnacle/rcs/test/client.rb +2 -4
- data/lib/pinnacle/rcs/test/types/create_test_agent_request.rb +11 -0
- data/lib/pinnacle/rcs/test/types/test_agent_whitelist_request.rb +1 -0
- data/lib/pinnacle/rcs/test/types/test_get_whitelist_status_request.rb +1 -0
- data/lib/pinnacle/rcs/test/types/update_test_agent_request.rb +12 -0
- data/lib/pinnacle/rcs/types/rcs_capabilities_query.rb +1 -0
- data/lib/pinnacle/rcs/types/rcs_link_request.rb +2 -0
- data/lib/pinnacle/rcs/whitelisted_numbers/types/list_test_numbers_params.rb +4 -0
- data/lib/pinnacle/tools/contact_card/types/get_vcard_params.rb +1 -0
- data/lib/pinnacle/tools/contact_card/types/upsert_vcard_params.rb +16 -0
- data/lib/pinnacle/tools/file/types/upload_file_options.rb +1 -0
- data/lib/pinnacle/tools/file/types/upload_file_params.rb +3 -0
- data/lib/pinnacle/tools/url/client.rb +1 -1
- data/lib/pinnacle/tools/url/types/create_url_params.rb +1 -0
- data/lib/pinnacle/tools/url/types/list_links_params.rb +2 -0
- data/lib/pinnacle/tools/url/types/update_url_params.rb +2 -0
- data/lib/pinnacle/types/address_field.rb +3 -0
- data/lib/pinnacle/types/advanced_phone_information.rb +5 -0
- data/lib/pinnacle/types/advanced_phone_information_carrier.rb +3 -0
- data/lib/pinnacle/types/advanced_phone_information_contact.rb +9 -0
- data/lib/pinnacle/types/advanced_phone_information_location.rb +7 -0
- data/lib/pinnacle/types/advanced_phone_information_location_coordinates.rb +1 -0
- data/lib/pinnacle/types/advanced_phone_information_location_country.rb +2 -0
- data/lib/pinnacle/types/advanced_phone_information_type.rb +3 -0
- data/lib/pinnacle/types/agent.rb +1 -0
- data/lib/pinnacle/types/agent_email_entry.rb +1 -0
- data/lib/pinnacle/types/agent_phone_entry.rb +1 -0
- data/lib/pinnacle/types/agent_summary.rb +6 -0
- data/lib/pinnacle/types/agent_summary_carrier_launches.rb +5 -0
- data/lib/pinnacle/types/agent_summary_config.rb +11 -0
- data/lib/pinnacle/types/agent_summary_config_emails_item.rb +1 -0
- data/lib/pinnacle/types/agent_summary_config_phones_item.rb +1 -0
- data/lib/pinnacle/types/agent_summary_config_websites_item.rb +1 -0
- data/lib/pinnacle/types/agent_website_entry.rb +1 -0
- data/lib/pinnacle/types/attach_webhook_response_webhook.rb +4 -0
- data/lib/pinnacle/types/attach_webhook_result.rb +3 -0
- data/lib/pinnacle/types/attached_phone_number_result.rb +1 -0
- data/lib/pinnacle/types/audience_count_only.rb +3 -0
- data/lib/pinnacle/types/audience_summary.rb +4 -0
- data/lib/pinnacle/types/audience_with_pagination.rb +5 -0
- data/lib/pinnacle/types/autofill_campaign_params.rb +1 -0
- data/lib/pinnacle/types/autofill_dlc_campaign_response.rb +10 -0
- data/lib/pinnacle/types/autofill_dlc_response_keywords.rb +2 -0
- data/lib/pinnacle/types/autofill_dlc_response_keywords_help.rb +1 -0
- data/lib/pinnacle/types/autofill_dlc_response_keywords_opt_in.rb +1 -0
- data/lib/pinnacle/types/autofill_dlc_response_keywords_opt_out.rb +1 -0
- data/lib/pinnacle/types/autofill_dlc_response_links.rb +1 -0
- data/lib/pinnacle/types/autofill_dlc_response_options.rb +5 -0
- data/lib/pinnacle/types/autofill_dlc_response_use_case.rb +1 -0
- data/lib/pinnacle/types/bad_request_error_body.rb +1 -0
- data/lib/pinnacle/types/base_rich_message.rb +3 -0
- data/lib/pinnacle/types/basic_phone_information.rb +5 -0
- data/lib/pinnacle/types/basic_phone_information_location.rb +1 -0
- data/lib/pinnacle/types/basic_phone_information_location_country.rb +2 -0
- data/lib/pinnacle/types/blast_details.rb +5 -0
- data/lib/pinnacle/types/blast_summary.rb +7 -0
- data/lib/pinnacle/types/brand_status.rb +2 -0
- data/lib/pinnacle/types/button_clicked.rb +1 -0
- data/lib/pinnacle/types/button_clicked_data.rb +1 -0
- data/lib/pinnacle/types/button_clicked_data_button.rb +4 -0
- data/lib/pinnacle/types/button_clicked_data_button_raw.rb +1 -0
- data/lib/pinnacle/types/buy_response_capabilities.rb +2 -0
- data/lib/pinnacle/types/campaign_query.rb +1 -0
- data/lib/pinnacle/types/campaign_status_event.rb +5 -0
- data/lib/pinnacle/types/campaign_status_event_agent.rb +1 -0
- data/lib/pinnacle/types/campaign_status_event_brand.rb +1 -0
- data/lib/pinnacle/types/campaign_status_event_campaign.rb +1 -0
- data/lib/pinnacle/types/campaign_status_event_carrier_launches.rb +1 -0
- data/lib/pinnacle/types/campaign_status_event_carrier_launches_carriers.rb +3 -0
- data/lib/pinnacle/types/campaign_status_event_carrier_launches_verification.rb +1 -0
- data/lib/pinnacle/types/campaign_validation_response_errors_item.rb +2 -0
- data/lib/pinnacle/types/campaign_validation_result.rb +1 -0
- data/lib/pinnacle/types/carrier_launches.rb +1 -0
- data/lib/pinnacle/types/carrier_launches_carriers.rb +3 -0
- data/lib/pinnacle/types/carrier_launches_verification.rb +1 -0
- data/lib/pinnacle/types/checkbox_field.rb +2 -0
- data/lib/pinnacle/types/contact.rb +5 -0
- data/lib/pinnacle/types/conversation.rb +7 -0
- data/lib/pinnacle/types/conversation_by_participants_params.rb +1 -0
- data/lib/pinnacle/types/conversation_contact.rb +1 -0
- data/lib/pinnacle/types/conversation_list.rb +2 -0
- data/lib/pinnacle/types/conversation_sender.rb +1 -0
- data/lib/pinnacle/types/date_field.rb +2 -0
- data/lib/pinnacle/types/datetime_field.rb +2 -0
- data/lib/pinnacle/types/detach_webhook_result.rb +2 -0
- data/lib/pinnacle/types/detached_phone_number_result.rb +1 -0
- data/lib/pinnacle/types/dlc_campaign_status.rb +3 -0
- data/lib/pinnacle/types/dlc_campaign_summary.rb +6 -0
- data/lib/pinnacle/types/dlc_campaign_with_extended_brand_and_status.rb +13 -0
- data/lib/pinnacle/types/dlc_with_extended_brand_and_status_keywords.rb +2 -0
- data/lib/pinnacle/types/dlc_with_extended_brand_and_status_keywords_help.rb +1 -0
- data/lib/pinnacle/types/dlc_with_extended_brand_and_status_keywords_opt_in.rb +1 -0
- data/lib/pinnacle/types/dlc_with_extended_brand_and_status_keywords_opt_out.rb +1 -0
- data/lib/pinnacle/types/dlc_with_extended_brand_and_status_links.rb +1 -0
- data/lib/pinnacle/types/dlc_with_extended_brand_and_status_options.rb +5 -0
- data/lib/pinnacle/types/dlc_with_extended_brand_and_status_use_case.rb +1 -0
- data/lib/pinnacle/types/enhanced_contact_item.rb +4 -0
- data/lib/pinnacle/types/extended_brand.rb +4 -0
- data/lib/pinnacle/types/extended_brand_with_vetting.rb +2 -0
- data/lib/pinnacle/types/extended_rcs_campaign.rb +14 -0
- data/lib/pinnacle/types/failed_sender.rb +1 -0
- data/lib/pinnacle/types/fallback_message.rb +2 -0
- data/lib/pinnacle/types/field_base.rb +3 -0
- data/lib/pinnacle/types/form.rb +12 -0
- data/lib/pinnacle/types/form_background.rb +3 -0
- data/lib/pinnacle/types/form_background_gradient.rb +1 -0
- data/lib/pinnacle/types/form_background_image.rb +3 -0
- data/lib/pinnacle/types/form_color_palette.rb +2 -0
- data/lib/pinnacle/types/form_definition.rb +5 -0
- data/lib/pinnacle/types/form_field.rb +15 -0
- data/lib/pinnacle/types/form_field_option.rb +1 -0
- data/lib/pinnacle/types/form_gradient.rb +2 -0
- data/lib/pinnacle/types/form_submission.rb +9 -0
- data/lib/pinnacle/types/form_submission_answer.rb +3 -0
- data/lib/pinnacle/types/form_submission_event.rb +4 -0
- data/lib/pinnacle/types/form_submission_event_conversation.rb +2 -0
- data/lib/pinnacle/types/form_submission_event_form.rb +2 -0
- data/lib/pinnacle/types/form_submission_event_submission.rb +7 -0
- data/lib/pinnacle/types/form_submitted_field.rb +3 -0
- data/lib/pinnacle/types/form_theme_override.rb +14 -0
- data/lib/pinnacle/types/form_theme_override_colors.rb +1 -0
- data/lib/pinnacle/types/get_conversation_params.rb +1 -0
- data/lib/pinnacle/types/get_dlc_campaign_status_response_updates.rb +2 -0
- data/lib/pinnacle/types/get_toll_free_campaign_status_response_updates.rb +2 -0
- data/lib/pinnacle/types/link_click_event.rb +48 -0
- data/lib/pinnacle/types/link_summary.rb +3 -0
- data/lib/pinnacle/types/list_agents_response.rb +2 -0
- data/lib/pinnacle/types/list_audiences_response.rb +2 -0
- data/lib/pinnacle/types/list_blasts_response.rb +2 -0
- data/lib/pinnacle/types/list_brands_response.rb +2 -0
- data/lib/pinnacle/types/list_contacts_response.rb +2 -0
- data/lib/pinnacle/types/list_dlc_campaigns_response.rb +2 -0
- data/lib/pinnacle/types/list_form_submissions_response.rb +2 -0
- data/lib/pinnacle/types/list_forms_response.rb +2 -0
- data/lib/pinnacle/types/list_links_response.rb +2 -0
- data/lib/pinnacle/types/list_messages_response.rb +2 -0
- data/lib/pinnacle/types/list_phone_numbers_response.rb +2 -0
- data/lib/pinnacle/types/list_rcs_campaigns_response.rb +2 -0
- data/lib/pinnacle/types/list_scheduled_messages_response.rb +2 -0
- data/lib/pinnacle/types/list_test_numbers_response.rb +2 -0
- data/lib/pinnacle/types/list_toll_free_campaigns_response.rb +2 -0
- data/lib/pinnacle/types/list_webhooks_response.rb +2 -0
- data/lib/pinnacle/types/location_share_action_data.rb +3 -0
- data/lib/pinnacle/types/message.rb +11 -0
- data/lib/pinnacle/types/message_content.rb +3 -0
- data/lib/pinnacle/types/message_event.rb +9 -0
- data/lib/pinnacle/types/message_event_content.rb +6 -0
- data/lib/pinnacle/types/message_event_conversation.rb +2 -0
- data/lib/pinnacle/types/message_event_fallback_message.rb +5 -0
- data/lib/pinnacle/types/message_event_mms_content.rb +2 -0
- data/lib/pinnacle/types/message_event_rcs_button_data.rb +2 -0
- data/lib/pinnacle/types/message_event_rcs_button_data_button.rb +4 -0
- data/lib/pinnacle/types/message_event_rcs_button_data_button_raw.rb +1 -0
- data/lib/pinnacle/types/message_event_rcs_cards_content.rb +2 -0
- data/lib/pinnacle/types/message_event_rcs_cards_content_cards_item.rb +3 -0
- data/lib/pinnacle/types/message_event_rcs_location_data.rb +2 -0
- data/lib/pinnacle/types/message_event_rcs_location_data_data.rb +3 -0
- data/lib/pinnacle/types/message_event_rcs_media_content.rb +2 -0
- data/lib/pinnacle/types/message_event_rcs_text_content.rb +2 -0
- data/lib/pinnacle/types/message_event_sms_content.rb +1 -0
- data/lib/pinnacle/types/message_list.rb +2 -0
- data/lib/pinnacle/types/message_schedule.rb +3 -0
- data/lib/pinnacle/types/message_summary.rb +16 -0
- data/lib/pinnacle/types/message_with_reactions.rb +1 -0
- data/lib/pinnacle/types/mms_content.rb +1 -0
- data/lib/pinnacle/types/mms_validation_response_segments.rb +2 -0
- data/lib/pinnacle/types/mms_validation_response_segments_value_item.rb +2 -0
- data/lib/pinnacle/types/mms_validation_result.rb +2 -0
- data/lib/pinnacle/types/number_field.rb +3 -0
- data/lib/pinnacle/types/number_format.rb +2 -0
- data/lib/pinnacle/types/optional_brand_info.rb +10 -0
- data/lib/pinnacle/types/optional_contact.rb +3 -0
- data/lib/pinnacle/types/optional_contacts.rb +3 -0
- data/lib/pinnacle/types/owned_phone_number.rb +5 -0
- data/lib/pinnacle/types/pagination.rb +3 -0
- data/lib/pinnacle/types/phone.rb +4 -0
- data/lib/pinnacle/types/phone_capabilities.rb +2 -0
- data/lib/pinnacle/types/phone_number_campaign_attach_failed_item.rb +1 -0
- data/lib/pinnacle/types/phone_number_campaign_attach_phone_numbers_item.rb +1 -0
- data/lib/pinnacle/types/phone_number_campaign_attach_phone_numbers_item_campaign.rb +2 -0
- data/lib/pinnacle/types/phone_number_campaign_detach_failed_item.rb +1 -0
- data/lib/pinnacle/types/phone_number_campaign_detach_phone_numbers_item.rb +1 -0
- data/lib/pinnacle/types/phone_number_campaign_detach_phone_numbers_item_campaign.rb +2 -0
- data/lib/pinnacle/types/phone_number_cost.rb +2 -0
- data/lib/pinnacle/types/phone_number_details.rb +4 -0
- data/lib/pinnacle/types/phone_number_region.rb +3 -0
- data/lib/pinnacle/types/phone_number_status.rb +2 -0
- data/lib/pinnacle/types/pinnacle_file_upload_metadata.rb +3 -0
- data/lib/pinnacle/types/pinnacle_url_config.rb +1 -0
- data/lib/pinnacle/types/purchased_number.rb +1 -0
- data/lib/pinnacle/types/range_field.rb +2 -0
- data/lib/pinnacle/types/rating_field.rb +1 -0
- data/lib/pinnacle/types/rcs_agent_details.rb +11 -0
- data/lib/pinnacle/types/rcs_agent_details_emails_item.rb +1 -0
- data/lib/pinnacle/types/rcs_agent_details_phones_item.rb +1 -0
- data/lib/pinnacle/types/rcs_agent_details_websites_item.rb +1 -0
- data/lib/pinnacle/types/rcs_agent_response.rb +4 -0
- data/lib/pinnacle/types/rcs_button_call.rb +2 -0
- data/lib/pinnacle/types/rcs_button_open_url.rb +3 -0
- data/lib/pinnacle/types/rcs_button_request_user_location.rb +1 -0
- data/lib/pinnacle/types/rcs_button_schedule_event.rb +5 -0
- data/lib/pinnacle/types/rcs_button_send_location.rb +3 -0
- data/lib/pinnacle/types/rcs_button_send_location_lat_long.rb +1 -0
- data/lib/pinnacle/types/rcs_button_trigger.rb +2 -0
- data/lib/pinnacle/types/rcs_campaign.rb +11 -0
- data/lib/pinnacle/types/rcs_campaign_schema_agent.rb +7 -0
- data/lib/pinnacle/types/rcs_campaign_schema_agent_emails_item.rb +1 -0
- data/lib/pinnacle/types/rcs_campaign_schema_agent_phones_item.rb +1 -0
- data/lib/pinnacle/types/rcs_campaign_schema_agent_websites_item.rb +1 -0
- data/lib/pinnacle/types/rcs_campaign_schema_extra_agent.rb +7 -0
- data/lib/pinnacle/types/rcs_campaign_schema_extra_agent_emails_item.rb +1 -0
- data/lib/pinnacle/types/rcs_campaign_schema_extra_agent_phones_item.rb +1 -0
- data/lib/pinnacle/types/rcs_campaign_schema_extra_agent_websites_item.rb +1 -0
- data/lib/pinnacle/types/rcs_campaign_schema_extra_keywords.rb +2 -0
- data/lib/pinnacle/types/rcs_campaign_schema_extra_keywords_help.rb +1 -0
- data/lib/pinnacle/types/rcs_campaign_schema_extra_keywords_opt_in.rb +1 -0
- data/lib/pinnacle/types/rcs_campaign_schema_extra_keywords_opt_out.rb +1 -0
- data/lib/pinnacle/types/rcs_campaign_schema_extra_links.rb +1 -0
- data/lib/pinnacle/types/rcs_campaign_schema_extra_traffic.rb +1 -0
- data/lib/pinnacle/types/rcs_campaign_schema_keywords.rb +2 -0
- data/lib/pinnacle/types/rcs_campaign_schema_keywords_help.rb +1 -0
- data/lib/pinnacle/types/rcs_campaign_schema_keywords_opt_in.rb +1 -0
- data/lib/pinnacle/types/rcs_campaign_schema_keywords_opt_out.rb +1 -0
- data/lib/pinnacle/types/rcs_campaign_schema_links.rb +1 -0
- data/lib/pinnacle/types/rcs_campaign_schema_traffic.rb +1 -0
- data/lib/pinnacle/types/rcs_campaign_status.rb +2 -0
- data/lib/pinnacle/types/rcs_campaign_summary.rb +6 -0
- data/lib/pinnacle/types/rcs_capability.rb +1 -0
- data/lib/pinnacle/types/rcs_capability_actions.rb +5 -0
- data/lib/pinnacle/types/rcs_capability_cards.rb +1 -0
- data/lib/pinnacle/types/rcs_cards_content.rb +1 -0
- data/lib/pinnacle/types/rcs_cards_content_cards_item.rb +3 -0
- data/lib/pinnacle/types/rcs_content.rb +2 -0
- data/lib/pinnacle/types/rcs_link_result.rb +1 -0
- data/lib/pinnacle/types/rcs_media_content.rb +1 -0
- data/lib/pinnacle/types/rcs_media_details_content.rb +2 -0
- data/lib/pinnacle/types/rcs_validate_content.rb +2 -0
- data/lib/pinnacle/types/rcs_validate_content_media.rb +1 -0
- data/lib/pinnacle/types/rcs_validation_result.rb +3 -0
- data/lib/pinnacle/types/reaction_result.rb +1 -0
- data/lib/pinnacle/types/refreshed_file.rb +1 -0
- data/lib/pinnacle/types/rich_button.rb +5 -0
- data/lib/pinnacle/types/rich_card.rb +3 -0
- data/lib/pinnacle/types/rich_cards.rb +1 -0
- data/lib/pinnacle/types/rich_cards_message.rb +3 -0
- data/lib/pinnacle/types/rich_media_message.rb +1 -0
- data/lib/pinnacle/types/rich_message.rb +2 -0
- data/lib/pinnacle/types/rich_standalone_card_options.rb +1 -0
- data/lib/pinnacle/types/rich_text.rb +1 -0
- data/lib/pinnacle/types/scheduled_blast_details.rb +1 -0
- data/lib/pinnacle/types/scheduled_blast_response_config.rb +3 -0
- data/lib/pinnacle/types/scheduled_form_send_response_form.rb +1 -0
- data/lib/pinnacle/types/scheduled_form_send_response_submission.rb +1 -0
- data/lib/pinnacle/types/scheduled_form_send_result.rb +3 -0
- data/lib/pinnacle/types/scheduled_message.rb +1 -0
- data/lib/pinnacle/types/scheduled_message_summary.rb +8 -0
- data/lib/pinnacle/types/scheduled_send_response_config.rb +3 -0
- data/lib/pinnacle/types/select_field.rb +1 -0
- data/lib/pinnacle/types/send_form_options.rb +1 -0
- data/lib/pinnacle/types/send_form_params.rb +1 -0
- data/lib/pinnacle/types/send_form_result.rb +2 -0
- data/lib/pinnacle/types/send_form_via_rcs_params.rb +4 -0
- data/lib/pinnacle/types/send_form_via_rcs_request_form.rb +1 -0
- data/lib/pinnacle/types/send_form_via_sms_params.rb +3 -0
- data/lib/pinnacle/types/send_form_via_sms_request_form.rb +1 -0
- data/lib/pinnacle/types/send_rich_cards_options.rb +4 -0
- data/lib/pinnacle/types/send_rich_message_options.rb +3 -0
- data/lib/pinnacle/types/send_rich_message_options_4.rb +3 -0
- data/lib/pinnacle/types/send_sms_response_segments.rb +1 -0
- data/lib/pinnacle/types/send_typing_indicator_response.rb +4 -0
- data/lib/pinnacle/types/sent_mms_details.rb +5 -0
- data/lib/pinnacle/types/sent_rich_message.rb +5 -0
- data/lib/pinnacle/types/sent_rich_message_fallback_mms.rb +1 -0
- data/lib/pinnacle/types/sent_rich_message_fallback_sms.rb +1 -0
- data/lib/pinnacle/types/sent_sms_details.rb +5 -0
- data/lib/pinnacle/types/shortened_url.rb +1 -0
- data/lib/pinnacle/types/simulate_message_input.rb +1 -0
- data/lib/pinnacle/types/simulate_user_button.rb +2 -0
- data/lib/pinnacle/types/simulate_user_message.rb +2 -0
- data/lib/pinnacle/types/simulate_user_params.rb +1 -0
- data/lib/pinnacle/types/sms_validation_response_segments.rb +1 -0
- data/lib/pinnacle/types/sms_validation_response_segments_gsm_7.rb +2 -0
- data/lib/pinnacle/types/sms_validation_response_segments_utf_16.rb +1 -0
- data/lib/pinnacle/types/sms_validation_response_total.rb +1 -0
- data/lib/pinnacle/types/sms_validation_result.rb +3 -0
- data/lib/pinnacle/types/test_agent_response.rb +3 -0
- data/lib/pinnacle/types/text_field.rb +3 -0
- data/lib/pinnacle/types/textarea_field.rb +3 -0
- data/lib/pinnacle/types/time_field.rb +2 -0
- data/lib/pinnacle/types/toll_free_campaign.rb +8 -0
- data/lib/pinnacle/types/toll_free_campaign_schema_keywords.rb +1 -0
- data/lib/pinnacle/types/toll_free_campaign_schema_keywords_opt_in.rb +1 -0
- data/lib/pinnacle/types/toll_free_campaign_schema_links.rb +1 -0
- data/lib/pinnacle/types/toll_free_campaign_schema_opt_in.rb +2 -0
- data/lib/pinnacle/types/toll_free_campaign_schema_use_case.rb +1 -0
- data/lib/pinnacle/types/toll_free_campaign_status.rb +2 -0
- data/lib/pinnacle/types/toll_free_campaign_summary.rb +6 -0
- data/lib/pinnacle/types/toll_free_campaign_with_extended_brand_and_status.rb +10 -0
- data/lib/pinnacle/types/toll_free_with_extended_brand_and_status_keywords.rb +1 -0
- data/lib/pinnacle/types/toll_free_with_extended_brand_and_status_keywords_opt_in.rb +1 -0
- data/lib/pinnacle/types/toll_free_with_extended_brand_and_status_links.rb +1 -0
- data/lib/pinnacle/types/toll_free_with_extended_brand_and_status_opt_in.rb +2 -0
- data/lib/pinnacle/types/toll_free_with_extended_brand_and_status_use_case.rb +1 -0
- data/lib/pinnacle/types/upload_results.rb +2 -0
- data/lib/pinnacle/types/user_button_press.rb +5 -0
- data/lib/pinnacle/types/user_button_press_call.rb +2 -0
- data/lib/pinnacle/types/user_button_press_open_url.rb +2 -0
- data/lib/pinnacle/types/user_button_press_request_user_location.rb +2 -0
- data/lib/pinnacle/types/user_button_press_request_user_location_location.rb +3 -0
- data/lib/pinnacle/types/user_button_press_schedule_event.rb +5 -0
- data/lib/pinnacle/types/user_button_press_send_location.rb +3 -0
- data/lib/pinnacle/types/user_button_press_send_location_lat_long.rb +1 -0
- data/lib/pinnacle/types/user_button_press_trigger.rb +2 -0
- data/lib/pinnacle/types/user_event.rb +2 -0
- data/lib/pinnacle/types/user_event_conversation.rb +3 -1
- data/lib/pinnacle/types/v_card_data_file.rb +1 -0
- data/lib/pinnacle/types/v_card_geo.rb +1 -0
- data/lib/pinnacle/types/v_card_name.rb +4 -0
- data/lib/pinnacle/types/v_card_organization.rb +1 -0
- data/lib/pinnacle/types/validate_campaign_params.rb +1 -0
- data/lib/pinnacle/types/validation_error_details.rb +2 -0
- data/lib/pinnacle/types/validation_results.rb +1 -0
- data/lib/pinnacle/types/vcard.rb +15 -0
- data/lib/pinnacle/types/vcard_address.rb +8 -0
- data/lib/pinnacle/types/vcard_email.rb +1 -0
- data/lib/pinnacle/types/vcard_phone.rb +1 -0
- data/lib/pinnacle/types/vcard_resource.rb +1 -0
- data/lib/pinnacle/types/vetting_feedback.rb +3 -0
- data/lib/pinnacle/types/vetting_history.rb +4 -0
- data/lib/pinnacle/types/webhook_summary.rb +6 -0
- data/lib/pinnacle/types/webhooks.rb +3 -0
- data/lib/pinnacle/types/whitelisted_number_summary.rb +3 -0
- data/lib/pinnacle/types/zod_error.rb +1 -0
- data/lib/pinnacle/version.rb +1 -1
- data/lib/pinnacle/webhooks/types/attach_webhook_params.rb +5 -0
- data/lib/pinnacle/webhooks/types/detach_webhook_params.rb +1 -0
- data/lib/pinnacle/webhooks/types/list_webhooks_params.rb +3 -0
- data/lib/pinnacle.rb +5 -0
- data/lib/rcs.rb +1 -637
- data/reference.md +2 -2
- metadata +3 -2
|
@@ -5,12 +5,19 @@ module Pinnacle
|
|
|
5
5
|
# Conversation that was found.
|
|
6
6
|
class Conversation < Internal::Types::Model
|
|
7
7
|
field :brand_id, -> { String }, optional: false, nullable: true, api_name: "brandId"
|
|
8
|
+
|
|
8
9
|
field :campaign, -> { Pinnacle::Types::CampaignQuery }, optional: false, nullable: true
|
|
10
|
+
|
|
9
11
|
field :contact, -> { Pinnacle::Types::ConversationContact }, optional: false, nullable: false
|
|
12
|
+
|
|
10
13
|
field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
|
|
14
|
+
|
|
11
15
|
field :id, -> { String }, optional: false, nullable: false
|
|
16
|
+
|
|
12
17
|
field :notes, -> { String }, optional: false, nullable: false
|
|
18
|
+
|
|
13
19
|
field :sender, -> { Pinnacle::Types::ConversationSender }, optional: false, nullable: true
|
|
20
|
+
|
|
14
21
|
field :updated_at, -> { String }, optional: false, nullable: false, api_name: "updatedAt"
|
|
15
22
|
end
|
|
16
23
|
end
|
|
@@ -5,6 +5,7 @@ module Pinnacle
|
|
|
5
5
|
# Retrieve conversation information by sender and recipient.
|
|
6
6
|
class ConversationByParticipantsParams < Internal::Types::Model
|
|
7
7
|
field :recipient, -> { String }, optional: false, nullable: false
|
|
8
|
+
|
|
8
9
|
field :sender, -> { String }, optional: false, nullable: false
|
|
9
10
|
end
|
|
10
11
|
end
|
|
@@ -5,6 +5,7 @@ module Pinnacle
|
|
|
5
5
|
# Contact information for the recipient in a conversation.
|
|
6
6
|
class ConversationContact < Internal::Types::Model
|
|
7
7
|
field :id, -> { String }, optional: false, nullable: false
|
|
8
|
+
|
|
8
9
|
field :phone_number, -> { String }, optional: false, nullable: false, api_name: "phoneNumber"
|
|
9
10
|
end
|
|
10
11
|
end
|
|
@@ -5,7 +5,9 @@ module Pinnacle
|
|
|
5
5
|
# Response for list conversation.
|
|
6
6
|
class ConversationList < Internal::Types::Model
|
|
7
7
|
field :count, -> { Integer }, optional: false, nullable: false
|
|
8
|
+
|
|
8
9
|
field :conversations, -> { Internal::Types::Array[Pinnacle::Types::Conversation] }, optional: false, nullable: false
|
|
10
|
+
|
|
9
11
|
field :has_more, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "hasMore"
|
|
10
12
|
end
|
|
11
13
|
end
|
|
@@ -5,7 +5,9 @@ module Pinnacle
|
|
|
5
5
|
# Date picker. `min`/`max` accept `YYYY-MM-DD`.
|
|
6
6
|
class DateField < Internal::Types::Model
|
|
7
7
|
field :placeholder, -> { String }, optional: true, nullable: false
|
|
8
|
+
|
|
8
9
|
field :min, -> { String }, optional: true, nullable: false
|
|
10
|
+
|
|
9
11
|
field :max, -> { String }, optional: true, nullable: false
|
|
10
12
|
end
|
|
11
13
|
end
|
|
@@ -5,7 +5,9 @@ module Pinnacle
|
|
|
5
5
|
# Local-datetime picker. `min`/`max` accept ISO 8601 timestamps.
|
|
6
6
|
class DatetimeField < Internal::Types::Model
|
|
7
7
|
field :placeholder, -> { String }, optional: true, nullable: false
|
|
8
|
+
|
|
8
9
|
field :min, -> { String }, optional: true, nullable: false
|
|
10
|
+
|
|
9
11
|
field :max, -> { String }, optional: true, nullable: false
|
|
10
12
|
end
|
|
11
13
|
end
|
|
@@ -4,7 +4,9 @@ module Pinnacle
|
|
|
4
4
|
module Types
|
|
5
5
|
class DetachWebhookResult < Internal::Types::Model
|
|
6
6
|
field :webhook_id, -> { String }, optional: false, nullable: false, api_name: "webhookId"
|
|
7
|
+
|
|
7
8
|
field :senders, -> { Internal::Types::Array[String] }, optional: false, nullable: false
|
|
9
|
+
|
|
8
10
|
field :failed, -> { Internal::Types::Array[Pinnacle::Types::FailedSender] }, optional: false, nullable: false
|
|
9
11
|
end
|
|
10
12
|
end
|
|
@@ -4,6 +4,7 @@ module Pinnacle
|
|
|
4
4
|
module Types
|
|
5
5
|
class DetachedPhoneNumberResult < Internal::Types::Model
|
|
6
6
|
field :phone_numbers, -> { Internal::Types::Array[Pinnacle::Types::PhoneNumberCampaignDetachPhoneNumbersItem] }, optional: false, nullable: false, api_name: "phoneNumbers"
|
|
7
|
+
|
|
7
8
|
field :failed, -> { Internal::Types::Array[Pinnacle::Types::PhoneNumberCampaignDetachFailedItem] }, optional: false, nullable: false
|
|
8
9
|
end
|
|
9
10
|
end
|
|
@@ -5,8 +5,11 @@ module Pinnacle
|
|
|
5
5
|
# Response for get DLC campaign status.
|
|
6
6
|
class DlcCampaignStatus < Internal::Types::Model
|
|
7
7
|
field :error, -> { String }, optional: false, nullable: false
|
|
8
|
+
|
|
8
9
|
field :id, -> { String }, optional: false, nullable: false
|
|
10
|
+
|
|
9
11
|
field :status, -> { Pinnacle::Types::ProfileStatusEnum }, optional: false, nullable: false
|
|
12
|
+
|
|
10
13
|
field :updates, -> { Pinnacle::Types::GetDlcCampaignStatusResponseUpdates }, optional: false, nullable: false
|
|
11
14
|
end
|
|
12
15
|
end
|
|
@@ -4,11 +4,17 @@ module Pinnacle
|
|
|
4
4
|
module Types
|
|
5
5
|
class DlcCampaignSummary < Internal::Types::Model
|
|
6
6
|
field :campaign_id, -> { String }, optional: false, nullable: false, api_name: "campaignId"
|
|
7
|
+
|
|
7
8
|
field :name, -> { String }, optional: true, nullable: false
|
|
9
|
+
|
|
8
10
|
field :status, -> { Pinnacle::Types::DlcCampaignSummaryStatus }, optional: false, nullable: false
|
|
11
|
+
|
|
9
12
|
field :brand_id, -> { String }, optional: true, nullable: false, api_name: "brandId"
|
|
13
|
+
|
|
10
14
|
field :use_case, -> { String }, optional: true, nullable: false, api_name: "useCase"
|
|
15
|
+
|
|
11
16
|
field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
|
|
17
|
+
|
|
12
18
|
field :updated_at, -> { String }, optional: false, nullable: false, api_name: "updatedAt"
|
|
13
19
|
end
|
|
14
20
|
end
|
|
@@ -5,18 +5,31 @@ module Pinnacle
|
|
|
5
5
|
# Dlc campaign schema that includes extended brand and status.
|
|
6
6
|
class DlcCampaignWithExtendedBrandAndStatus < Internal::Types::Model
|
|
7
7
|
field :auto_renew, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "autoRenew"
|
|
8
|
+
|
|
8
9
|
field :brand, -> { Pinnacle::Types::ExtendedBrand }, optional: false, nullable: false
|
|
10
|
+
|
|
9
11
|
field :campaign_id, -> { String }, optional: false, nullable: false, api_name: "campaignId"
|
|
12
|
+
|
|
10
13
|
field :description, -> { String }, optional: true, nullable: false
|
|
14
|
+
|
|
11
15
|
field :keywords, -> { Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywords }, optional: false, nullable: false
|
|
16
|
+
|
|
12
17
|
field :links, -> { Pinnacle::Types::DlcWithExtendedBrandAndStatusLinks }, optional: true, nullable: false
|
|
18
|
+
|
|
13
19
|
field :message_flow, -> { String }, optional: true, nullable: false, api_name: "messageFlow"
|
|
20
|
+
|
|
14
21
|
field :name, -> { String }, optional: true, nullable: false
|
|
22
|
+
|
|
15
23
|
field :options, -> { Pinnacle::Types::DlcWithExtendedBrandAndStatusOptions }, optional: false, nullable: false
|
|
24
|
+
|
|
16
25
|
field :sample_messages, -> { Internal::Types::Array[String] }, optional: true, nullable: false, api_name: "sampleMessages"
|
|
26
|
+
|
|
17
27
|
field :status, -> { Pinnacle::Types::ProfileStatusEnum }, optional: false, nullable: false
|
|
28
|
+
|
|
18
29
|
field :use_case, -> { Pinnacle::Types::DlcWithExtendedBrandAndStatusUseCase }, optional: true, nullable: false, api_name: "useCase"
|
|
30
|
+
|
|
19
31
|
field :mno_brand_tier, -> { Pinnacle::Types::DlcWithExtendedBrandAndStatusMnoBrandTier }, optional: true, nullable: false, api_name: "mnoBrandTier"
|
|
32
|
+
|
|
20
33
|
field :mno_tcr_tier, -> { Pinnacle::Types::DlcWithExtendedBrandAndStatusMnoTcrTier }, optional: true, nullable: false, api_name: "mnoTcrTier"
|
|
21
34
|
end
|
|
22
35
|
end
|
|
@@ -5,7 +5,9 @@ module Pinnacle
|
|
|
5
5
|
# Keyword response configuration.
|
|
6
6
|
class DlcWithExtendedBrandAndStatusKeywords < Internal::Types::Model
|
|
7
7
|
field :help, -> { Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywordsHelp }, optional: false, nullable: false, api_name: "HELP"
|
|
8
|
+
|
|
8
9
|
field :opt_in, -> { Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywordsOptIn }, optional: false, nullable: false, api_name: "OPT_IN"
|
|
10
|
+
|
|
9
11
|
field :opt_out, -> { Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywordsOptOut }, optional: false, nullable: false, api_name: "OPT_OUT"
|
|
10
12
|
end
|
|
11
13
|
end
|
|
@@ -5,6 +5,7 @@ module Pinnacle
|
|
|
5
5
|
# Help keyword settings.
|
|
6
6
|
class DlcWithExtendedBrandAndStatusKeywordsHelp < Internal::Types::Model
|
|
7
7
|
field :message, -> { String }, optional: true, nullable: false
|
|
8
|
+
|
|
8
9
|
field :values, -> { Internal::Types::Array[String] }, optional: false, nullable: false
|
|
9
10
|
end
|
|
10
11
|
end
|
|
@@ -5,6 +5,7 @@ module Pinnacle
|
|
|
5
5
|
# Opt-in keyword settings.
|
|
6
6
|
class DlcWithExtendedBrandAndStatusKeywordsOptIn < Internal::Types::Model
|
|
7
7
|
field :message, -> { String }, optional: true, nullable: false
|
|
8
|
+
|
|
8
9
|
field :values, -> { Internal::Types::Array[String] }, optional: false, nullable: false
|
|
9
10
|
end
|
|
10
11
|
end
|
|
@@ -5,6 +5,7 @@ module Pinnacle
|
|
|
5
5
|
# Opt-out keyword settings.
|
|
6
6
|
class DlcWithExtendedBrandAndStatusKeywordsOptOut < Internal::Types::Model
|
|
7
7
|
field :message, -> { String }, optional: true, nullable: false
|
|
8
|
+
|
|
8
9
|
field :values, -> { Internal::Types::Array[String] }, optional: false, nullable: false
|
|
9
10
|
end
|
|
10
11
|
end
|
|
@@ -5,6 +5,7 @@ module Pinnacle
|
|
|
5
5
|
# Legal documentation links.
|
|
6
6
|
class DlcWithExtendedBrandAndStatusLinks < Internal::Types::Model
|
|
7
7
|
field :privacy_policy, -> { String }, optional: true, nullable: false, api_name: "privacyPolicy"
|
|
8
|
+
|
|
8
9
|
field :terms_of_service, -> { String }, optional: true, nullable: false, api_name: "termsOfService"
|
|
9
10
|
end
|
|
10
11
|
end
|
|
@@ -5,10 +5,15 @@ module Pinnacle
|
|
|
5
5
|
# Campaign configuration options.
|
|
6
6
|
class DlcWithExtendedBrandAndStatusOptions < Internal::Types::Model
|
|
7
7
|
field :affiliate_marketing, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "affiliateMarketing"
|
|
8
|
+
|
|
8
9
|
field :age_gated, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "ageGated"
|
|
10
|
+
|
|
9
11
|
field :direct_lending, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "directLending"
|
|
12
|
+
|
|
10
13
|
field :embedded_link, -> { String }, optional: true, nullable: false, api_name: "embeddedLink"
|
|
14
|
+
|
|
11
15
|
field :embedded_phone, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "embeddedPhone"
|
|
16
|
+
|
|
12
17
|
field :number_pooling, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "numberPooling"
|
|
13
18
|
end
|
|
14
19
|
end
|
|
@@ -5,6 +5,7 @@ module Pinnacle
|
|
|
5
5
|
# Use case for the campaign.
|
|
6
6
|
class DlcWithExtendedBrandAndStatusUseCase < Internal::Types::Model
|
|
7
7
|
field :sub, -> { Internal::Types::Array[Pinnacle::Types::SubUseCaseEnum] }, optional: true, nullable: false
|
|
8
|
+
|
|
8
9
|
field :value, -> { Pinnacle::Types::DlcCampaignUseCaseEnum }, optional: true, nullable: false
|
|
9
10
|
end
|
|
10
11
|
end
|
|
@@ -4,9 +4,13 @@ module Pinnacle
|
|
|
4
4
|
module Types
|
|
5
5
|
class EnhancedContactItem < Internal::Types::Model
|
|
6
6
|
field :description, -> { String }, optional: false, nullable: false
|
|
7
|
+
|
|
7
8
|
field :email, -> { String }, optional: false, nullable: false
|
|
9
|
+
|
|
8
10
|
field :links, -> { Internal::Types::Array[String] }, optional: false, nullable: false
|
|
11
|
+
|
|
9
12
|
field :linkedin, -> { String }, optional: false, nullable: true
|
|
13
|
+
|
|
10
14
|
field :name, -> { String }, optional: false, nullable: false
|
|
11
15
|
end
|
|
12
16
|
end
|
|
@@ -4,9 +4,13 @@ module Pinnacle
|
|
|
4
4
|
module Types
|
|
5
5
|
class ExtendedBrand < Internal::Types::Model
|
|
6
6
|
field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
|
|
7
|
+
|
|
7
8
|
field :id, -> { String }, optional: false, nullable: false
|
|
9
|
+
|
|
8
10
|
field :is_archived, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "isArchived"
|
|
11
|
+
|
|
9
12
|
field :status, -> { Pinnacle::Types::BrandStatusEnum }, optional: false, nullable: false
|
|
13
|
+
|
|
10
14
|
field :updated_at, -> { String }, optional: false, nullable: false, api_name: "updatedAt"
|
|
11
15
|
end
|
|
12
16
|
end
|
|
@@ -4,7 +4,9 @@ module Pinnacle
|
|
|
4
4
|
module Types
|
|
5
5
|
class ExtendedBrandWithVetting < Internal::Types::Model
|
|
6
6
|
field :last_tcr_vetting_date, -> { String }, optional: false, nullable: false, api_name: "lastTcrVettingDate"
|
|
7
|
+
|
|
7
8
|
field :tcr_feedback, -> { Internal::Types::Array[Pinnacle::Types::VettingFeedback] }, optional: false, nullable: false, api_name: "tcrFeedback"
|
|
9
|
+
|
|
8
10
|
field :vetting_history, -> { Internal::Types::Array[Pinnacle::Types::VettingHistory] }, optional: false, nullable: false, api_name: "vettingHistory"
|
|
9
11
|
end
|
|
10
12
|
end
|
|
@@ -4,19 +4,33 @@ module Pinnacle
|
|
|
4
4
|
module Types
|
|
5
5
|
class ExtendedRcsCampaign < Internal::Types::Model
|
|
6
6
|
field :agent, -> { Pinnacle::Types::RcsCampaignSchemaExtraAgent }, optional: false, nullable: false
|
|
7
|
+
|
|
7
8
|
field :agent_id, -> { String }, optional: false, nullable: false, api_name: "agentId"
|
|
9
|
+
|
|
8
10
|
field :brand, -> { Pinnacle::Types::ExtendedBrand }, optional: false, nullable: false
|
|
11
|
+
|
|
9
12
|
field :campaign_id, -> { String }, optional: true, nullable: false, api_name: "campaignId"
|
|
13
|
+
|
|
10
14
|
field :expected_agent_responses, -> { Internal::Types::Array[String] }, optional: true, nullable: false, api_name: "expectedAgentResponses"
|
|
15
|
+
|
|
11
16
|
field :links, -> { Pinnacle::Types::RcsCampaignSchemaExtraLinks }, optional: true, nullable: false
|
|
17
|
+
|
|
12
18
|
field :status, -> { Pinnacle::Types::ProfileStatusEnum }, optional: false, nullable: false
|
|
19
|
+
|
|
13
20
|
field :use_case_description, -> { String }, optional: true, nullable: false, api_name: "useCaseDescription"
|
|
21
|
+
|
|
14
22
|
field :messaging_type, -> { Pinnacle::Types::RcsMessagingTypeEnum }, optional: true, nullable: false, api_name: "messagingType"
|
|
23
|
+
|
|
15
24
|
field :cta_media, -> { String }, optional: true, nullable: false, api_name: "ctaMedia"
|
|
25
|
+
|
|
16
26
|
field :opt_in_method, -> { String }, optional: true, nullable: false, api_name: "optInMethod"
|
|
27
|
+
|
|
17
28
|
field :keywords, -> { Pinnacle::Types::RcsCampaignSchemaExtraKeywords }, optional: true, nullable: false
|
|
29
|
+
|
|
18
30
|
field :traffic, -> { Pinnacle::Types::RcsCampaignSchemaExtraTraffic }, optional: true, nullable: false
|
|
31
|
+
|
|
19
32
|
field :cta_language, -> { String }, optional: true, nullable: false, api_name: "ctaLanguage"
|
|
33
|
+
|
|
20
34
|
field :demo_trigger, -> { String }, optional: true, nullable: false, api_name: "demoTrigger"
|
|
21
35
|
end
|
|
22
36
|
end
|
|
@@ -14,7 +14,9 @@ module Pinnacle
|
|
|
14
14
|
# will not be charged if the fallback is sent instead.
|
|
15
15
|
class FallbackMessage < Internal::Types::Model
|
|
16
16
|
field :from, -> { String }, optional: false, nullable: false
|
|
17
|
+
|
|
17
18
|
field :text, -> { String }, optional: true, nullable: false
|
|
19
|
+
|
|
18
20
|
field :media_urls, -> { Internal::Types::Array[String] }, optional: true, nullable: false, api_name: "mediaUrls"
|
|
19
21
|
end
|
|
20
22
|
end
|
|
@@ -6,8 +6,11 @@ module Pinnacle
|
|
|
6
6
|
# `FormField`.
|
|
7
7
|
class FieldBase < Internal::Types::Model
|
|
8
8
|
field :key, -> { String }, optional: false, nullable: false
|
|
9
|
+
|
|
9
10
|
field :label, -> { String }, optional: false, nullable: false
|
|
11
|
+
|
|
10
12
|
field :required, -> { Internal::Types::Boolean }, optional: true, nullable: false
|
|
13
|
+
|
|
11
14
|
field :help_text, -> { String }, optional: true, nullable: false
|
|
12
15
|
end
|
|
13
16
|
end
|
data/lib/pinnacle/types/form.rb
CHANGED
|
@@ -5,17 +5,29 @@ module Pinnacle
|
|
|
5
5
|
# A hosted form definition.
|
|
6
6
|
class Form < Internal::Types::Model
|
|
7
7
|
field :id, -> { String }, optional: false, nullable: false
|
|
8
|
+
|
|
8
9
|
field :url, -> { String }, optional: false, nullable: false
|
|
10
|
+
|
|
9
11
|
field :name, -> { String }, optional: false, nullable: true
|
|
12
|
+
|
|
10
13
|
field :description, -> { String }, optional: false, nullable: true
|
|
14
|
+
|
|
11
15
|
field :fields, -> { Internal::Types::Array[Pinnacle::Types::FormField] }, optional: false, nullable: false
|
|
16
|
+
|
|
12
17
|
field :can_update, -> { Internal::Types::Boolean }, optional: false, nullable: false
|
|
18
|
+
|
|
13
19
|
field :expires_at, -> { String }, optional: false, nullable: true
|
|
20
|
+
|
|
14
21
|
field :theme_override, -> { Pinnacle::Types::FormThemeOverride }, optional: false, nullable: true
|
|
22
|
+
|
|
15
23
|
field :submission_count, -> { Integer }, optional: false, nullable: false
|
|
24
|
+
|
|
16
25
|
field :last_submitted_at, -> { String }, optional: false, nullable: true
|
|
26
|
+
|
|
17
27
|
field :archived_at, -> { String }, optional: false, nullable: true
|
|
28
|
+
|
|
18
29
|
field :created_at, -> { String }, optional: false, nullable: false
|
|
30
|
+
|
|
19
31
|
field :updated_at, -> { String }, optional: false, nullable: false
|
|
20
32
|
end
|
|
21
33
|
end
|
|
@@ -9,8 +9,11 @@ module Pinnacle
|
|
|
9
9
|
discriminant :type
|
|
10
10
|
|
|
11
11
|
member -> { Pinnacle::Types::FormBackgroundSolid }, key: "SOLID"
|
|
12
|
+
|
|
12
13
|
member -> { Pinnacle::Types::FormBackgroundGradient }, key: "GRADIENT"
|
|
14
|
+
|
|
13
15
|
member -> { Pinnacle::Types::FormBackgroundImage }, key: "IMAGE"
|
|
16
|
+
|
|
14
17
|
member -> { Pinnacle::Types::FormBackgroundPattern }, key: "PATTERN"
|
|
15
18
|
end
|
|
16
19
|
end
|
|
@@ -6,6 +6,7 @@ module Pinnacle
|
|
|
6
6
|
# `theme_mode`.
|
|
7
7
|
class FormBackgroundGradient < Internal::Types::Model
|
|
8
8
|
field :light, -> { Pinnacle::Types::FormGradient }, optional: false, nullable: false
|
|
9
|
+
|
|
9
10
|
field :dark, -> { Pinnacle::Types::FormGradient }, optional: false, nullable: false
|
|
10
11
|
end
|
|
11
12
|
end
|
|
@@ -5,8 +5,11 @@ module Pinnacle
|
|
|
5
5
|
# Image background. The image is tiled or scaled across the page with optional blur and dark tint overlay.
|
|
6
6
|
class FormBackgroundImage < Internal::Types::Model
|
|
7
7
|
field :url, -> { String }, optional: false, nullable: false
|
|
8
|
+
|
|
8
9
|
field :tint_opacity, -> { Integer }, optional: false, nullable: false
|
|
10
|
+
|
|
9
11
|
field :blur, -> { Internal::Types::Boolean }, optional: false, nullable: false
|
|
12
|
+
|
|
10
13
|
field :zoom, -> { Integer }, optional: false, nullable: false
|
|
11
14
|
end
|
|
12
15
|
end
|
|
@@ -5,7 +5,9 @@ module Pinnacle
|
|
|
5
5
|
# Per-mode palette. All three colors are optional; any you omit fall back to the team default for that mode.
|
|
6
6
|
class FormColorPalette < Internal::Types::Model
|
|
7
7
|
field :primary, -> { String }, optional: true, nullable: false
|
|
8
|
+
|
|
8
9
|
field :background, -> { String }, optional: true, nullable: false
|
|
10
|
+
|
|
9
11
|
field :text, -> { String }, optional: true, nullable: false
|
|
10
12
|
end
|
|
11
13
|
end
|
|
@@ -5,10 +5,15 @@ module Pinnacle
|
|
|
5
5
|
# The minimum shape needed to create a form. Used by `POST /forms` and inline by `POST /forms/send`.
|
|
6
6
|
class FormDefinition < Internal::Types::Model
|
|
7
7
|
field :name, -> { String }, optional: true, nullable: false
|
|
8
|
+
|
|
8
9
|
field :description, -> { String }, optional: true, nullable: false
|
|
10
|
+
|
|
9
11
|
field :fields, -> { Internal::Types::Array[Pinnacle::Types::FormField] }, optional: false, nullable: false
|
|
12
|
+
|
|
10
13
|
field :can_update, -> { Internal::Types::Boolean }, optional: true, nullable: false
|
|
14
|
+
|
|
11
15
|
field :expires_at, -> { String }, optional: true, nullable: false
|
|
16
|
+
|
|
12
17
|
field :theme_override, -> { Pinnacle::Types::FormThemeOverride }, optional: true, nullable: false
|
|
13
18
|
end
|
|
14
19
|
end
|
|
@@ -9,20 +9,35 @@ module Pinnacle
|
|
|
9
9
|
discriminant :type
|
|
10
10
|
|
|
11
11
|
member -> { Pinnacle::Types::TextField }, key: "TEXT"
|
|
12
|
+
|
|
12
13
|
member -> { Pinnacle::Types::TextareaField }, key: "TEXTAREA"
|
|
14
|
+
|
|
13
15
|
member -> { Pinnacle::Types::AddressField }, key: "ADDRESS"
|
|
16
|
+
|
|
14
17
|
member -> { Pinnacle::Types::EmailField }, key: "EMAIL"
|
|
18
|
+
|
|
15
19
|
member -> { Pinnacle::Types::UrlField }, key: "URL"
|
|
20
|
+
|
|
16
21
|
member -> { Pinnacle::Types::PhoneField }, key: "PHONE"
|
|
22
|
+
|
|
17
23
|
member -> { Pinnacle::Types::NumberField }, key: "NUMBER"
|
|
24
|
+
|
|
18
25
|
member -> { Pinnacle::Types::RangeField }, key: "RANGE"
|
|
26
|
+
|
|
19
27
|
member -> { Pinnacle::Types::RatingField }, key: "RATING"
|
|
28
|
+
|
|
20
29
|
member -> { Pinnacle::Types::DateField }, key: "DATE"
|
|
30
|
+
|
|
21
31
|
member -> { Pinnacle::Types::TimeField }, key: "TIME"
|
|
32
|
+
|
|
22
33
|
member -> { Pinnacle::Types::DatetimeField }, key: "DATETIME"
|
|
34
|
+
|
|
23
35
|
member -> { Pinnacle::Types::ColorField }, key: "COLOR"
|
|
36
|
+
|
|
24
37
|
member -> { Pinnacle::Types::SelectField }, key: "SELECT"
|
|
38
|
+
|
|
25
39
|
member -> { Pinnacle::Types::RadioField }, key: "RADIO"
|
|
40
|
+
|
|
26
41
|
member -> { Pinnacle::Types::CheckboxField }, key: "CHECKBOX"
|
|
27
42
|
end
|
|
28
43
|
end
|
|
@@ -5,6 +5,7 @@ module Pinnacle
|
|
|
5
5
|
# A single choice inside a `select`, `radio`, or `checkbox` field.
|
|
6
6
|
class FormFieldOption < Internal::Types::Model
|
|
7
7
|
field :value, -> { String }, optional: false, nullable: false
|
|
8
|
+
|
|
8
9
|
field :label, -> { String }, optional: false, nullable: false
|
|
9
10
|
end
|
|
10
11
|
end
|
|
@@ -5,7 +5,9 @@ module Pinnacle
|
|
|
5
5
|
# A single light- or dark-mode gradient stop pair.
|
|
6
6
|
class FormGradient < Internal::Types::Model
|
|
7
7
|
field :from, -> { String }, optional: false, nullable: false
|
|
8
|
+
|
|
8
9
|
field :to, -> { String }, optional: false, nullable: false
|
|
10
|
+
|
|
9
11
|
field :angle, -> { Pinnacle::Types::FormGradientAngle }, optional: false, nullable: false
|
|
10
12
|
end
|
|
11
13
|
end
|
|
@@ -5,14 +5,23 @@ module Pinnacle
|
|
|
5
5
|
# A single submission against a form.
|
|
6
6
|
class FormSubmission < Internal::Types::Model
|
|
7
7
|
field :id, -> { String }, optional: false, nullable: false
|
|
8
|
+
|
|
8
9
|
field :url, -> { String }, optional: false, nullable: false
|
|
10
|
+
|
|
9
11
|
field :form_id, -> { String }, optional: false, nullable: false
|
|
12
|
+
|
|
10
13
|
field :from, -> { String }, optional: false, nullable: true
|
|
14
|
+
|
|
11
15
|
field :to, -> { String }, optional: false, nullable: true
|
|
16
|
+
|
|
12
17
|
field :data, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: true
|
|
18
|
+
|
|
13
19
|
field :ip_address, -> { String }, optional: false, nullable: true
|
|
20
|
+
|
|
14
21
|
field :user_agent, -> { String }, optional: false, nullable: true
|
|
22
|
+
|
|
15
23
|
field :submitted_at, -> { String }, optional: false, nullable: true
|
|
24
|
+
|
|
16
25
|
field :created_at, -> { String }, optional: false, nullable: false
|
|
17
26
|
end
|
|
18
27
|
end
|
|
@@ -6,9 +6,13 @@ module Pinnacle
|
|
|
6
6
|
# `PINNACLE-SIGNING-SECRET` header matches your webhook's signing secret before trusting the payload.
|
|
7
7
|
class FormSubmissionEvent < Internal::Types::Model
|
|
8
8
|
field :type, -> { String }, optional: false, nullable: false
|
|
9
|
+
|
|
9
10
|
field :sender, -> { String }, optional: false, nullable: false
|
|
11
|
+
|
|
10
12
|
field :conversation, -> { Pinnacle::Types::FormSubmissionEventConversation }, optional: false, nullable: true
|
|
13
|
+
|
|
11
14
|
field :form, -> { Pinnacle::Types::FormSubmissionEventForm }, optional: false, nullable: false
|
|
15
|
+
|
|
12
16
|
field :submission, -> { Pinnacle::Types::FormSubmissionEventSubmission }, optional: false, nullable: false
|
|
13
17
|
end
|
|
14
18
|
end
|
|
@@ -13,7 +13,9 @@ module Pinnacle
|
|
|
13
13
|
# flows.
|
|
14
14
|
class FormSubmissionEventConversation < Internal::Types::Model
|
|
15
15
|
field :id, -> { String }, optional: false, nullable: false
|
|
16
|
+
|
|
16
17
|
field :from, -> { String }, optional: false, nullable: false
|
|
18
|
+
|
|
17
19
|
field :to, -> { String }, optional: false, nullable: false
|
|
18
20
|
end
|
|
19
21
|
end
|
|
@@ -5,7 +5,9 @@ module Pinnacle
|
|
|
5
5
|
# Form summary carried on the FORM.SUBMISSION event.
|
|
6
6
|
class FormSubmissionEventForm < Internal::Types::Model
|
|
7
7
|
field :id, -> { String }, optional: false, nullable: false
|
|
8
|
+
|
|
8
9
|
field :url, -> { String }, optional: false, nullable: false
|
|
10
|
+
|
|
9
11
|
field :name, -> { String }, optional: false, nullable: true
|
|
10
12
|
end
|
|
11
13
|
end
|
|
@@ -5,12 +5,19 @@ module Pinnacle
|
|
|
5
5
|
# The submitted answers plus a resolved snapshot of each form field.
|
|
6
6
|
class FormSubmissionEventSubmission < Internal::Types::Model
|
|
7
7
|
field :id, -> { String }, optional: false, nullable: false
|
|
8
|
+
|
|
8
9
|
field :from, -> { String }, optional: false, nullable: false
|
|
10
|
+
|
|
9
11
|
field :to, -> { String }, optional: false, nullable: true
|
|
12
|
+
|
|
10
13
|
field :data, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
|
|
14
|
+
|
|
11
15
|
field :fields, -> { Internal::Types::Array[Pinnacle::Types::FormSubmittedField] }, optional: false, nullable: false
|
|
16
|
+
|
|
12
17
|
field :ip_address, -> { String }, optional: false, nullable: true
|
|
18
|
+
|
|
13
19
|
field :user_agent, -> { String }, optional: false, nullable: true
|
|
20
|
+
|
|
14
21
|
field :submitted_at, -> { String }, optional: false, nullable: false
|
|
15
22
|
end
|
|
16
23
|
end
|
|
@@ -5,8 +5,11 @@ module Pinnacle
|
|
|
5
5
|
# Snapshot of a single form field paired with the value the recipient submitted.
|
|
6
6
|
class FormSubmittedField < Internal::Types::Model
|
|
7
7
|
field :key, -> { String }, optional: false, nullable: false
|
|
8
|
+
|
|
8
9
|
field :label, -> { String }, optional: false, nullable: false
|
|
10
|
+
|
|
9
11
|
field :type, -> { String }, optional: false, nullable: false
|
|
12
|
+
|
|
10
13
|
field :value, -> { Pinnacle::Types::FormSubmissionAnswer }, optional: false, nullable: true
|
|
11
14
|
end
|
|
12
15
|
end
|
|
@@ -6,19 +6,33 @@ module Pinnacle
|
|
|
6
6
|
# corresponding team defaults at render time. URL fields must use `https://`.
|
|
7
7
|
class FormThemeOverride < Internal::Types::Model
|
|
8
8
|
field :logo_url, -> { String }, optional: true, nullable: false
|
|
9
|
+
|
|
9
10
|
field :favicon_url, -> { String }, optional: true, nullable: false
|
|
11
|
+
|
|
10
12
|
field :theme_mode, -> { Pinnacle::Types::FormThemeOverrideThemeMode }, optional: true, nullable: false
|
|
13
|
+
|
|
11
14
|
field :colors, -> { Pinnacle::Types::FormThemeOverrideColors }, optional: true, nullable: false
|
|
15
|
+
|
|
12
16
|
field :font_family, -> { Pinnacle::Types::FormThemeOverrideFontFamily }, optional: true, nullable: false
|
|
17
|
+
|
|
13
18
|
field :corner_radius, -> { Pinnacle::Types::FormThemeOverrideCornerRadius }, optional: true, nullable: false
|
|
19
|
+
|
|
14
20
|
field :content_alignment, -> { Pinnacle::Types::FormThemeOverrideContentAlignment }, optional: true, nullable: false
|
|
21
|
+
|
|
15
22
|
field :background, -> { Pinnacle::Types::FormBackground }, optional: true, nullable: false
|
|
23
|
+
|
|
16
24
|
field :submit_button_label, -> { String }, optional: true, nullable: false
|
|
25
|
+
|
|
17
26
|
field :success_message, -> { String }, optional: true, nullable: false
|
|
27
|
+
|
|
18
28
|
field :redirect_url, -> { String }, optional: true, nullable: false
|
|
29
|
+
|
|
19
30
|
field :privacy_url, -> { String }, optional: true, nullable: false
|
|
31
|
+
|
|
20
32
|
field :terms_url, -> { String }, optional: true, nullable: false
|
|
33
|
+
|
|
21
34
|
field :og_image_url, -> { String }, optional: true, nullable: false
|
|
35
|
+
|
|
22
36
|
field :og_description, -> { String }, optional: true, nullable: false
|
|
23
37
|
end
|
|
24
38
|
end
|