gohighlevel 0.0.1
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 +7 -0
- data/LICENSE.txt +21 -0
- data/README.md +246 -0
- data/gohighlevel.gemspec +31 -0
- data/lib/gohighlevel.rb +3 -0
- data/lib/high_level/client.rb +104 -0
- data/lib/high_level/configuration.rb +62 -0
- data/lib/high_level/errors.rb +47 -0
- data/lib/high_level/middleware/authentication.rb +78 -0
- data/lib/high_level/middleware/error_handler.rb +46 -0
- data/lib/high_level/middleware/instrumentation.rb +40 -0
- data/lib/high_level/middleware/refresh_on_401.rb +75 -0
- data/lib/high_level/models/ad_manager/ad_campaign_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/ad_campaign_group_data_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/ad_schedule_target_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/audience_custom_audience_item_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/audience_dimension_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/audience_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/audience_interest_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/audience_locale_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/audience_location_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/audience_location_geometry.rb +12 -0
- data/lib/high_level/models/ad_manager/audience_placements_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/audience_segments_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/budget.rb +12 -0
- data/lib/high_level/models/ad_manager/call_asset_payload_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/campaign_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/consent_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/conversion_value_settings.rb +12 -0
- data/lib/high_level/models/ad_manager/create_conversation_form_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/create_google_integration_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/create_integration_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/create_lead_form_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/create_linkedin_integration_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/create_offline_user_list_job_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/creation_locale_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/custom_disclaimer.rb +12 -0
- data/lib/high_level/models/ad_manager/custom_disclaimer_checkbox.rb +12 -0
- data/lib/high_level/models/ad_manager/custom_question_field_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/facebook_audience_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/fb_set_default_page_body_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/fb_update_audience_body_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/flexible_rule_user_list_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/form_question.rb +12 -0
- data/lib/high_level/models/ad_manager/form_question_option.rb +12 -0
- data/lib/high_level/models/ad_manager/geo_address_component_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/geo_geometry_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/geo_lat_lng_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/geo_location_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/geo_viewport_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/google_ad_content_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/google_ad_group_audience_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/google_ad_group_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/google_ad_schedule_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/google_asset_image_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/google_assets_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/google_bidding_strategy_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/google_budget_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/google_campaign_audience_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/google_campaign_goal_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/google_carousel_card_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/google_demographic_target_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/google_geo_location_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/google_keyword_item_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/google_keywords_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/google_locale_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/google_media_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/google_network_settings_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/google_segment_target_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/google_target_interests_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/google_you_tube_video_link_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/greeting_card.rb +12 -0
- data/lib/high_level/models/ad_manager/hidden_field_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/keyword_suggestion_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/lead_form_asset_payload_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/lead_form_content_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/lead_form_field_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/lead_form_question_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/legal_info_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/linked_in_ad_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/linked_in_budget_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/linked_in_create_lead_form_body_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/linked_in_media_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/linked_in_update_ad_status_body_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/locale_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/localized_string_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/location_id_body_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/media_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/member_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/multiple_choice_option_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/multiple_choice_question_details_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/post_submission_call_to_action_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/post_submission_call_to_action_target_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/post_submission_info_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/publish_ad_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/question_details_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/rule_based_user_list_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/rule_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/rule_item_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/rule_item_group_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/rule_operand_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/selected_attribute_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/sitelink_asset_payload_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/sponsored_account_owner_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/string_rule_item_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/target_audience_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/thank_you_page.rb +12 -0
- data/lib/high_level/models/ad_manager/unit_cost_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/update_custom_audience_batch_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/update_custom_audience_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/upsert_ad_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/upsert_adset_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/upsert_assets_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/upsert_audience_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/upsert_campaign_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/upsert_conversion_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/upsert_conversion_pixel_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/upsert_segment_dto.rb +12 -0
- data/lib/high_level/models/ad_manager/welcome_message_question.rb +12 -0
- data/lib/high_level/models/affiliate_manager/affiliate_list_meta_response_dto.rb +12 -0
- data/lib/high_level/models/affiliate_manager/commission_affiliate_response_dto.rb +12 -0
- data/lib/high_level/models/affiliate_manager/commission_campaign_response_dto.rb +12 -0
- data/lib/high_level/models/affiliate_manager/commission_customer_response_dto.rb +12 -0
- data/lib/high_level/models/affiliate_manager/commission_list_item_response_dto.rb +12 -0
- data/lib/high_level/models/affiliate_manager/commission_list_meta_response_dto.rb +12 -0
- data/lib/high_level/models/affiliate_manager/get_affiliate_response_dto.rb +12 -0
- data/lib/high_level/models/affiliate_manager/get_commission_list_response_dto.rb +12 -0
- data/lib/high_level/models/affiliate_manager/get_payout_list_response_dto.rb +12 -0
- data/lib/high_level/models/affiliate_manager/list_affiliates_response_dto.rb +12 -0
- data/lib/high_level/models/affiliate_manager/o_auth_affiliate_list_item_response_dto.rb +12 -0
- data/lib/high_level/models/affiliate_manager/payout_list_item_response_dto.rb +12 -0
- data/lib/high_level/models/affiliate_manager/payout_list_meta_response_dto.rb +12 -0
- data/lib/high_level/models/agent_studio/create_public_agent_dto.rb +12 -0
- data/lib/high_level/models/agent_studio/create_public_agent_response_dto.rb +12 -0
- data/lib/high_level/models/agent_studio/delete_public_agent_response_dto.rb +12 -0
- data/lib/high_level/models/agent_studio/execute_public_agent_dto.rb +12 -0
- data/lib/high_level/models/agent_studio/execute_public_agent_response_dto.rb +12 -0
- data/lib/high_level/models/agent_studio/get_agent_by_id_response_dto.rb +12 -0
- data/lib/high_level/models/agent_studio/get_published_agents_response_dto.rb +12 -0
- data/lib/high_level/models/agent_studio/internal_server_error_dto.rb +12 -0
- data/lib/high_level/models/agent_studio/promote_and_publish_dto.rb +12 -0
- data/lib/high_level/models/agent_studio/promote_and_publish_response_dto.rb +12 -0
- data/lib/high_level/models/agent_studio/public_attachment_schema.rb +12 -0
- data/lib/high_level/models/agent_studio/update_public_agent_metadata_dto.rb +12 -0
- data/lib/high_level/models/agent_studio/update_public_agent_response_dto.rb +12 -0
- data/lib/high_level/models/agent_studio/update_public_agent_version_dto.rb +12 -0
- data/lib/high_level/models/associations/create_association_req_dto.rb +12 -0
- data/lib/high_level/models/associations/create_relation_req_dto.rb +12 -0
- data/lib/high_level/models/associations/delete_associations_response_dto.rb +12 -0
- data/lib/high_level/models/associations/get_post_successful_response_dto.rb +12 -0
- data/lib/high_level/models/associations/update_association_req_dto.rb +12 -0
- data/lib/high_level/models/blogs/author_response_dto.rb +12 -0
- data/lib/high_level/models/blogs/authors_response_dto.rb +12 -0
- data/lib/high_level/models/blogs/blog_get_response_wrapper_dto.rb +12 -0
- data/lib/high_level/models/blogs/blog_post_create_response_wrapper_dto.rb +12 -0
- data/lib/high_level/models/blogs/blog_post_get_response_wrapper_dto.rb +12 -0
- data/lib/high_level/models/blogs/blog_post_response_dto.rb +12 -0
- data/lib/high_level/models/blogs/blog_post_update_response_wrapper_dto.rb +12 -0
- data/lib/high_level/models/blogs/blog_response_dto.rb +12 -0
- data/lib/high_level/models/blogs/categories_response_dto.rb +12 -0
- data/lib/high_level/models/blogs/category_response_dto.rb +12 -0
- data/lib/high_level/models/blogs/create_blog_post_params.rb +12 -0
- data/lib/high_level/models/blogs/update_blog_post_params.rb +12 -0
- data/lib/high_level/models/blogs/url_slug_check_response_dto.rb +12 -0
- data/lib/high_level/models/brand_boards/brand_board_list_item_dto.rb +12 -0
- data/lib/high_level/models/brand_boards/color.rb +12 -0
- data/lib/high_level/models/brand_boards/create_brand_board_param.rb +12 -0
- data/lib/high_level/models/brand_boards/font.rb +12 -0
- data/lib/high_level/models/brand_boards/get_brand_board_success_dto.rb +12 -0
- data/lib/high_level/models/brand_boards/get_brand_boards_by_location_success_dto.rb +12 -0
- data/lib/high_level/models/brand_boards/invalid_location_dto.rb +12 -0
- data/lib/high_level/models/brand_boards/logo.rb +12 -0
- data/lib/high_level/models/brand_boards/meta_data.rb +12 -0
- data/lib/high_level/models/brand_boards/not_found_dto.rb +12 -0
- data/lib/high_level/models/brand_boards/update_brand_board_body.rb +12 -0
- data/lib/high_level/models/businesses/business_created_by_or_updated_by.rb +12 -0
- data/lib/high_level/models/businesses/business_dto.rb +12 -0
- data/lib/high_level/models/businesses/create_business_dto.rb +12 -0
- data/lib/high_level/models/businesses/delete_business_response_dto.rb +12 -0
- data/lib/high_level/models/businesses/get_business_by_id_response_dto.rb +12 -0
- data/lib/high_level/models/businesses/get_business_by_location_response_dto.rb +12 -0
- data/lib/high_level/models/businesses/update_business_dto.rb +12 -0
- data/lib/high_level/models/businesses/update_business_response_dto.rb +12 -0
- data/lib/high_level/models/calendars/all_groups_successful_response_dto.rb +12 -0
- data/lib/high_level/models/calendars/appointment_create_schema.rb +12 -0
- data/lib/high_level/models/calendars/appointment_edit_schema.rb +12 -0
- data/lib/high_level/models/calendars/appointment_schema_response.rb +12 -0
- data/lib/high_level/models/calendars/availability.rb +12 -0
- data/lib/high_level/models/calendars/block_slot_create_request_dto.rb +12 -0
- data/lib/high_level/models/calendars/block_slot_edit_request_dto.rb +12 -0
- data/lib/high_level/models/calendars/blocked_slot_successful_response_dto.rb +12 -0
- data/lib/high_level/models/calendars/calendar_by_id_successful_response_dto.rb +12 -0
- data/lib/high_level/models/calendars/calendar_create_dto.rb +12 -0
- data/lib/high_level/models/calendars/calendar_delete_successful_response_dto.rb +12 -0
- data/lib/high_level/models/calendars/calendar_dto.rb +12 -0
- data/lib/high_level/models/calendars/calendar_event_dto.rb +12 -0
- data/lib/high_level/models/calendars/calendar_notification.rb +12 -0
- data/lib/high_level/models/calendars/calendar_notification_delete_response_dto.rb +12 -0
- data/lib/high_level/models/calendars/calendar_notification_response_dto.rb +12 -0
- data/lib/high_level/models/calendars/calendar_resource_by_id_response_dto.rb +12 -0
- data/lib/high_level/models/calendars/calendar_resource_response_dto.rb +12 -0
- data/lib/high_level/models/calendars/calendar_update_dto.rb +12 -0
- data/lib/high_level/models/calendars/calendars_get_successful_response_dto.rb +12 -0
- data/lib/high_level/models/calendars/create_calendar_notification_dto.rb +12 -0
- data/lib/high_level/models/calendars/create_calendar_resource_dto.rb +12 -0
- data/lib/high_level/models/calendars/create_schedule_dto.rb +12 -0
- data/lib/high_level/models/calendars/created_or_updated_by.rb +12 -0
- data/lib/high_level/models/calendars/delete_appointment_schema.rb +12 -0
- data/lib/high_level/models/calendars/delete_event_successful_response_dto.rb +12 -0
- data/lib/high_level/models/calendars/delete_note_successful_response_dto.rb +12 -0
- data/lib/high_level/models/calendars/get_all_schedules_response_dto.rb +12 -0
- data/lib/high_level/models/calendars/get_calendar_event_successful_response_dto.rb +12 -0
- data/lib/high_level/models/calendars/get_calendar_events_successful_response_dto.rb +12 -0
- data/lib/high_level/models/calendars/get_create_update_note_successful_response_dto.rb +12 -0
- data/lib/high_level/models/calendars/get_note_schema.rb +12 -0
- data/lib/high_level/models/calendars/get_notes_list_successful_response_dto.rb +12 -0
- data/lib/high_level/models/calendars/group_create_dto.rb +12 -0
- data/lib/high_level/models/calendars/group_create_successful_response_dto.rb +12 -0
- data/lib/high_level/models/calendars/group_dto.rb +12 -0
- data/lib/high_level/models/calendars/group_status_update_params.rb +12 -0
- data/lib/high_level/models/calendars/group_successful_response_dto.rb +12 -0
- data/lib/high_level/models/calendars/group_update_dto.rb +12 -0
- data/lib/high_level/models/calendars/hour.rb +12 -0
- data/lib/high_level/models/calendars/location_configuration.rb +12 -0
- data/lib/high_level/models/calendars/location_configuration_response.rb +12 -0
- data/lib/high_level/models/calendars/look_busy_configuration.rb +12 -0
- data/lib/high_level/models/calendars/note_created_by_schema.rb +12 -0
- data/lib/high_level/models/calendars/notes_dto.rb +12 -0
- data/lib/high_level/models/calendars/open_hour.rb +12 -0
- data/lib/high_level/models/calendars/recurring.rb +12 -0
- data/lib/high_level/models/calendars/resource_delete_response_dto.rb +12 -0
- data/lib/high_level/models/calendars/schedule_interval_dto.rb +12 -0
- data/lib/high_level/models/calendars/schedule_object_response_dto.rb +12 -0
- data/lib/high_level/models/calendars/schedule_response_dto.rb +12 -0
- data/lib/high_level/models/calendars/schedule_rule_dto.rb +12 -0
- data/lib/high_level/models/calendars/schedules_dto.rb +12 -0
- data/lib/high_level/models/calendars/slots_schema.rb +12 -0
- data/lib/high_level/models/calendars/team_member.rb +12 -0
- data/lib/high_level/models/calendars/team_member_response.rb +12 -0
- data/lib/high_level/models/calendars/update_availability.rb +12 -0
- data/lib/high_level/models/calendars/update_calendar_notifications_dto.rb +12 -0
- data/lib/high_level/models/calendars/update_calendar_resource_dto.rb +12 -0
- data/lib/high_level/models/calendars/update_schedule_dto.rb +12 -0
- data/lib/high_level/models/calendars/validate_group_slug_post_body.rb +12 -0
- data/lib/high_level/models/calendars/validate_group_slug_success_response_dto.rb +12 -0
- data/lib/high_level/models/campaigns/campaigns_schema.rb +12 -0
- data/lib/high_level/models/campaigns/campaigns_successful_response_dto.rb +12 -0
- data/lib/high_level/models/companies/get_company_by_id_schema.rb +12 -0
- data/lib/high_level/models/companies/get_company_by_id_successful_response_dto.rb +12 -0
- data/lib/high_level/models/companies/i_onboarding_dto.rb +12 -0
- data/lib/high_level/models/contacts/add_contact_to_campaign_dto.rb +12 -0
- data/lib/high_level/models/contacts/attribution_source.rb +12 -0
- data/lib/high_level/models/contacts/checkbox_field.rb +12 -0
- data/lib/high_level/models/contacts/contacts_bulk_upate_response.rb +12 -0
- data/lib/high_level/models/contacts/contacts_business_update.rb +12 -0
- data/lib/high_level/models/contacts/contacts_by_id_successful_response_dto.rb +12 -0
- data/lib/high_level/models/contacts/contacts_meta_schema.rb +12 -0
- data/lib/high_level/models/contacts/contacts_search_schema.rb +12 -0
- data/lib/high_level/models/contacts/contacts_search_successful_response_dto.rb +12 -0
- data/lib/high_level/models/contacts/contacts_workflow_successful_response_dto.rb +12 -0
- data/lib/high_level/models/contacts/create_add_followers_successful_response_dto.rb +12 -0
- data/lib/high_level/models/contacts/create_add_tag_successful_response_dto.rb +12 -0
- data/lib/high_level/models/contacts/create_contact_dto.rb +12 -0
- data/lib/high_level/models/contacts/create_contact_schema.rb +12 -0
- data/lib/high_level/models/contacts/create_contacts_successful_response_dto.rb +12 -0
- data/lib/high_level/models/contacts/create_delete_cantacts_campaigns_successful_response_dto.rb +12 -0
- data/lib/high_level/models/contacts/create_delete_tag_successful_response_dto.rb +12 -0
- data/lib/high_level/models/contacts/create_task_params.rb +12 -0
- data/lib/high_level/models/contacts/create_workflow_dto.rb +12 -0
- data/lib/high_level/models/contacts/custom_field_schema.rb +12 -0
- data/lib/high_level/models/contacts/custom_fields_input_array_schema.rb +12 -0
- data/lib/high_level/models/contacts/custom_fields_input_object_schema.rb +12 -0
- data/lib/high_level/models/contacts/custom_fields_input_string_schema.rb +12 -0
- data/lib/high_level/models/contacts/delete_contacts_successful_response_dto.rb +12 -0
- data/lib/high_level/models/contacts/delete_followers_successful_response_dto.rb +12 -0
- data/lib/high_level/models/contacts/delete_note_successful_response_dto.rb +12 -0
- data/lib/high_level/models/contacts/delete_task_successful_response_dto.rb +12 -0
- data/lib/high_level/models/contacts/dnd_setting_schema.rb +12 -0
- data/lib/high_level/models/contacts/dnd_settings_schema.rb +12 -0
- data/lib/high_level/models/contacts/file_field.rb +12 -0
- data/lib/high_level/models/contacts/followers_dto.rb +12 -0
- data/lib/high_level/models/contacts/get_contect_by_id_schema.rb +12 -0
- data/lib/high_level/models/contacts/get_create_update_note_successful_response_dto.rb +12 -0
- data/lib/high_level/models/contacts/get_event_schema.rb +12 -0
- data/lib/high_level/models/contacts/get_events_successful_response_dto.rb +12 -0
- data/lib/high_level/models/contacts/get_note_schema.rb +12 -0
- data/lib/high_level/models/contacts/get_notes_list_successful_response_dto.rb +12 -0
- data/lib/high_level/models/contacts/inbound_dnd_setting_schema.rb +12 -0
- data/lib/high_level/models/contacts/inbound_dnd_settings_schema.rb +12 -0
- data/lib/high_level/models/contacts/large_text_field.rb +12 -0
- data/lib/high_level/models/contacts/monetory_field.rb +12 -0
- data/lib/high_level/models/contacts/multi_select_field.rb +12 -0
- data/lib/high_level/models/contacts/notes_dto.rb +12 -0
- data/lib/high_level/models/contacts/numeric_field.rb +12 -0
- data/lib/high_level/models/contacts/radio_field.rb +12 -0
- data/lib/high_level/models/contacts/search_body_v2_dto.rb +12 -0
- data/lib/high_level/models/contacts/single_select_field.rb +12 -0
- data/lib/high_level/models/contacts/tags_dto.rb +12 -0
- data/lib/high_level/models/contacts/task_by_is_successful_response_dto.rb +12 -0
- data/lib/high_level/models/contacts/task_schema.rb +12 -0
- data/lib/high_level/models/contacts/tasks_list_successful_response_dto.rb +12 -0
- data/lib/high_level/models/contacts/text_field.rb +12 -0
- data/lib/high_level/models/contacts/update_contact_dto.rb +12 -0
- data/lib/high_level/models/contacts/update_contacts_successful_response_dto.rb +12 -0
- data/lib/high_level/models/contacts/update_note_dto.rb +12 -0
- data/lib/high_level/models/contacts/update_tags_dto.rb +12 -0
- data/lib/high_level/models/contacts/update_tags_response_dto.rb +12 -0
- data/lib/high_level/models/contacts/update_task_body.rb +12 -0
- data/lib/high_level/models/contacts/update_task_status_params.rb +12 -0
- data/lib/high_level/models/contacts/upsert_contact_dto.rb +12 -0
- data/lib/high_level/models/contacts/upsert_contacts_successful_response_dto.rb +12 -0
- data/lib/high_level/models/conversation_ai/action_data_dto.rb +12 -0
- data/lib/high_level/models/conversation_ai/actions_id_dto.rb +12 -0
- data/lib/high_level/models/conversation_ai/advanced_followup_dto.rb +12 -0
- data/lib/high_level/models/conversation_ai/appointment_booking_dto.rb +12 -0
- data/lib/high_level/models/conversation_ai/create_action_dto.rb +12 -0
- data/lib/high_level/models/conversation_ai/create_action_response_dto.rb +12 -0
- data/lib/high_level/models/conversation_ai/create_employee_dto.rb +12 -0
- data/lib/high_level/models/conversation_ai/delete_action_data_dto.rb +12 -0
- data/lib/high_level/models/conversation_ai/delete_action_response_dto.rb +12 -0
- data/lib/high_level/models/conversation_ai/delete_employee_response_dto.rb +12 -0
- data/lib/high_level/models/conversation_ai/employee_list_item_dto.rb +12 -0
- data/lib/high_level/models/conversation_ai/employee_response_dto.rb +12 -0
- data/lib/high_level/models/conversation_ai/fetch_action_details_response_dto.rb +12 -0
- data/lib/high_level/models/conversation_ai/fetch_actions_for_employee_response_dto.rb +12 -0
- data/lib/high_level/models/conversation_ai/fetch_ai_response_details_response_dto.rb +12 -0
- data/lib/high_level/models/conversation_ai/followup_sequence.rb +12 -0
- data/lib/high_level/models/conversation_ai/followup_settings.rb +12 -0
- data/lib/high_level/models/conversation_ai/human_hand_over_dto.rb +12 -0
- data/lib/high_level/models/conversation_ai/interval.rb +12 -0
- data/lib/high_level/models/conversation_ai/search_employee_response_dto.rb +12 -0
- data/lib/high_level/models/conversation_ai/stop_bot_dto.rb +12 -0
- data/lib/high_level/models/conversation_ai/transfer_bot_dto.rb +12 -0
- data/lib/high_level/models/conversation_ai/trigger_workflow_dto.rb +12 -0
- data/lib/high_level/models/conversation_ai/update_action_response_dto.rb +12 -0
- data/lib/high_level/models/conversation_ai/update_contact_field_dto.rb +12 -0
- data/lib/high_level/models/conversation_ai/update_employee_dto.rb +12 -0
- data/lib/high_level/models/conversation_ai/update_followup_settings_dto.rb +12 -0
- data/lib/high_level/models/conversation_ai/working_hours.rb +12 -0
- data/lib/high_level/models/conversations/add_message_attachments_dto.rb +12 -0
- data/lib/high_level/models/conversations/call_data_dto.rb +12 -0
- data/lib/high_level/models/conversations/cancel_scheduled_response_dto.rb +12 -0
- data/lib/high_level/models/conversations/complete_file_upload_dto.rb +12 -0
- data/lib/high_level/models/conversations/complete_file_upload_response_dto.rb +12 -0
- data/lib/high_level/models/conversations/conversation_create_response_dto.rb +12 -0
- data/lib/high_level/models/conversations/conversation_dto.rb +12 -0
- data/lib/high_level/models/conversations/conversation_schema.rb +12 -0
- data/lib/high_level/models/conversations/create_conversation_dto.rb +12 -0
- data/lib/high_level/models/conversations/create_conversation_success_response.rb +12 -0
- data/lib/high_level/models/conversations/create_custom_subtype_dto.rb +12 -0
- data/lib/high_level/models/conversations/create_live_chat_message_feedback_response.rb +12 -0
- data/lib/high_level/models/conversations/delete_conversation_successful_response.rb +12 -0
- data/lib/high_level/models/conversations/error_dto.rb +12 -0
- data/lib/high_level/models/conversations/export_messages_response_dto.rb +12 -0
- data/lib/high_level/models/conversations/forward_config_dto.rb +12 -0
- data/lib/high_level/models/conversations/forward_response_dto.rb +12 -0
- data/lib/high_level/models/conversations/get_conversation_by_id_response.rb +12 -0
- data/lib/high_level/models/conversations/get_conversation_successful_response.rb +12 -0
- data/lib/high_level/models/conversations/get_email_message_response_dto.rb +12 -0
- data/lib/high_level/models/conversations/get_message_response_dto.rb +12 -0
- data/lib/high_level/models/conversations/get_message_transcription_response_dto.rb +12 -0
- data/lib/high_level/models/conversations/get_messages_by_conversation_response_dto.rb +12 -0
- data/lib/high_level/models/conversations/initiate_file_upload_dto.rb +12 -0
- data/lib/high_level/models/conversations/initiate_file_upload_response_dto.rb +12 -0
- data/lib/high_level/models/conversations/message_meta.rb +12 -0
- data/lib/high_level/models/conversations/process_message_body_dto.rb +12 -0
- data/lib/high_level/models/conversations/process_message_response_dto.rb +12 -0
- data/lib/high_level/models/conversations/process_outbound_message_body_dto.rb +12 -0
- data/lib/high_level/models/conversations/send_conversation_response_dto.rb +12 -0
- data/lib/high_level/models/conversations/send_message_body_dto.rb +12 -0
- data/lib/high_level/models/conversations/send_message_response_dto.rb +12 -0
- data/lib/high_level/models/conversations/send_review_reply_dto.rb +12 -0
- data/lib/high_level/models/conversations/start_after_array_number_schema.rb +12 -0
- data/lib/high_level/models/conversations/start_after_number_schema.rb +12 -0
- data/lib/high_level/models/conversations/subscription_action_dto.rb +12 -0
- data/lib/high_level/models/conversations/update_conversation_dto.rb +12 -0
- data/lib/high_level/models/conversations/update_custom_subtype_dto.rb +12 -0
- data/lib/high_level/models/conversations/update_message_status_dto.rb +12 -0
- data/lib/high_level/models/conversations/upload_files_dto.rb +12 -0
- data/lib/high_level/models/conversations/upload_files_error_response_dto.rb +12 -0
- data/lib/high_level/models/conversations/upload_files_response_dto.rb +12 -0
- data/lib/high_level/models/conversations/user_subscription_change_dto.rb +12 -0
- data/lib/high_level/models/conversations/user_typing_body.rb +12 -0
- data/lib/high_level/models/courses/category_interface.rb +12 -0
- data/lib/high_level/models/courses/instructor_details.rb +12 -0
- data/lib/high_level/models/courses/post_interface.rb +12 -0
- data/lib/high_level/models/courses/post_material_interface.rb +12 -0
- data/lib/high_level/models/courses/product_interface.rb +12 -0
- data/lib/high_level/models/courses/public_exporter_payload.rb +12 -0
- data/lib/high_level/models/courses/sub_category_interface.rb +12 -0
- data/lib/high_level/models/custom_fields/create_custom_fields_dto.rb +12 -0
- data/lib/high_level/models/custom_fields/create_folder.rb +12 -0
- data/lib/high_level/models/custom_fields/custom_field_successful_response_dto.rb +12 -0
- data/lib/high_level/models/custom_fields/custom_fields_response_dto.rb +12 -0
- data/lib/high_level/models/custom_fields/custom_folder_delete_response_dto.rb +12 -0
- data/lib/high_level/models/custom_fields/i_custom_field.rb +12 -0
- data/lib/high_level/models/custom_fields/i_custom_field_folder.rb +12 -0
- data/lib/high_level/models/custom_fields/option_dto.rb +12 -0
- data/lib/high_level/models/custom_fields/update_custom_fields_dto.rb +12 -0
- data/lib/high_level/models/custom_fields/update_folder.rb +12 -0
- data/lib/high_level/models/custom_menus/create_custom_menu_dto.rb +12 -0
- data/lib/high_level/models/custom_menus/custom_menu_schema.rb +12 -0
- data/lib/high_level/models/custom_menus/delete_custom_menu_successful_response_dto.rb +12 -0
- data/lib/high_level/models/custom_menus/get_custom_menus_response_dto.rb +12 -0
- data/lib/high_level/models/custom_menus/get_single_custom_menus_successful_response_dto.rb +12 -0
- data/lib/high_level/models/custom_menus/icon_schema.rb +12 -0
- data/lib/high_level/models/custom_menus/icon_schema_optional.rb +12 -0
- data/lib/high_level/models/custom_menus/update_custom_menu_dto.rb +12 -0
- data/lib/high_level/models/custom_menus/update_custom_menu_link_response_dto.rb +12 -0
- data/lib/high_level/models/email_isv/email_not_verified_response_dto.rb +12 -0
- data/lib/high_level/models/email_isv/email_verified_response_dto.rb +12 -0
- data/lib/high_level/models/email_isv/lead_connector_recomandation_dto.rb +12 -0
- data/lib/high_level/models/email_isv/verification_body_dto.rb +12 -0
- data/lib/high_level/models/emails/builder_update_successful_dto.rb +12 -0
- data/lib/high_level/models/emails/create_builder_dto.rb +12 -0
- data/lib/high_level/models/emails/create_builder_succesful_response_dto.rb +12 -0
- data/lib/high_level/models/emails/delete_builder_succesful_response_dto.rb +12 -0
- data/lib/high_level/models/emails/fetch_builder_succesful_response_dto.rb +12 -0
- data/lib/high_level/models/emails/i_builder_json_mapper.rb +12 -0
- data/lib/high_level/models/emails/invalid_location_dto.rb +12 -0
- data/lib/high_level/models/emails/not_found_dto.rb +12 -0
- data/lib/high_level/models/emails/save_builder_data_dto.rb +12 -0
- data/lib/high_level/models/emails/schedule_dto.rb +12 -0
- data/lib/high_level/models/emails/schedule_fetch_successful_dto.rb +12 -0
- data/lib/high_level/models/emails/template_settings.rb +12 -0
- data/lib/high_level/models/forms/contact_session_ids.rb +12 -0
- data/lib/high_level/models/forms/event_data_schema.rb +12 -0
- data/lib/high_level/models/forms/forms_params.rb +12 -0
- data/lib/high_level/models/forms/forms_submissions_submissions_schema.rb +12 -0
- data/lib/high_level/models/forms/forms_submissions_successful_response_dto.rb +12 -0
- data/lib/high_level/models/forms/forms_successful_response_dto.rb +12 -0
- data/lib/high_level/models/forms/meta_schema.rb +12 -0
- data/lib/high_level/models/forms/others_schema.rb +12 -0
- data/lib/high_level/models/forms/page_details_schema.rb +12 -0
- data/lib/high_level/models/funnels/create_redirect_params.rb +12 -0
- data/lib/high_level/models/funnels/create_redirect_response_dto.rb +12 -0
- data/lib/high_level/models/funnels/delete_redirect_response_dto.rb +12 -0
- data/lib/high_level/models/funnels/funnel_list_response_dto.rb +12 -0
- data/lib/high_level/models/funnels/funnel_page_count_response_dto.rb +12 -0
- data/lib/high_level/models/funnels/funnel_page_response_dto.rb +12 -0
- data/lib/high_level/models/funnels/redirect_list_response_dto.rb +12 -0
- data/lib/high_level/models/funnels/redirect_response_dto.rb +12 -0
- data/lib/high_level/models/funnels/update_redirect_params.rb +12 -0
- data/lib/high_level/models/funnels/update_redirect_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/additional_emails_dto.rb +12 -0
- data/lib/high_level/models/invoices/address.rb +12 -0
- data/lib/high_level/models/invoices/address_dto.rb +12 -0
- data/lib/high_level/models/invoices/alt_dto.rb +12 -0
- data/lib/high_level/models/invoices/attachments_dto.rb +12 -0
- data/lib/high_level/models/invoices/auto_invoice.rb +12 -0
- data/lib/high_level/models/invoices/auto_invoicing_dto.rb +12 -0
- data/lib/high_level/models/invoices/auto_payment_details_dto.rb +12 -0
- data/lib/high_level/models/invoices/auto_payment_invoice_schedule_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/auto_payment_schedule_dto.rb +12 -0
- data/lib/high_level/models/invoices/bacs_direct_debit_dto.rb +12 -0
- data/lib/high_level/models/invoices/becs_direct_debit_dto.rb +12 -0
- data/lib/high_level/models/invoices/business_details.rb +12 -0
- data/lib/high_level/models/invoices/business_details_dto.rb +12 -0
- data/lib/high_level/models/invoices/cancel_invoice_schedule_dto.rb +12 -0
- data/lib/high_level/models/invoices/cancel_invoice_schedule_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/card_dto.rb +12 -0
- data/lib/high_level/models/invoices/cheque_dto.rb +12 -0
- data/lib/high_level/models/invoices/contact_details.rb +12 -0
- data/lib/high_level/models/invoices/contact_details_dto.rb +12 -0
- data/lib/high_level/models/invoices/create_estimates_dto.rb +12 -0
- data/lib/high_level/models/invoices/create_invoice_dto.rb +12 -0
- data/lib/high_level/models/invoices/create_invoice_from_estimate_dto.rb +12 -0
- data/lib/high_level/models/invoices/create_invoice_from_estimate_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/create_invoice_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/create_invoice_schedule_dto.rb +12 -0
- data/lib/high_level/models/invoices/create_invoice_schedule_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/create_invoice_template_dto.rb +12 -0
- data/lib/high_level/models/invoices/create_invoice_template_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/custom_notification_dto.rb +12 -0
- data/lib/high_level/models/invoices/custom_notification_item_dto.rb +12 -0
- data/lib/high_level/models/invoices/custom_r_rule_options_dto.rb +12 -0
- data/lib/high_level/models/invoices/default_invoice_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/delete_invoice_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/delete_invoice_schedule_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/delete_invoice_template_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/discount_dto.rb +12 -0
- data/lib/high_level/models/invoices/estimate_id_param.rb +12 -0
- data/lib/high_level/models/invoices/estimate_line_item_dto.rb +12 -0
- data/lib/high_level/models/invoices/estimate_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/estimate_template_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/estimate_templates_dto.rb +12 -0
- data/lib/high_level/models/invoices/frequency_settings_dto.rb +12 -0
- data/lib/high_level/models/invoices/generate_estimate_number_response.rb +12 -0
- data/lib/high_level/models/invoices/generate_invoice_number_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/get_invoice_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/get_invoice_settings_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/get_schedule_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/get_template_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/invoice_item_dto.rb +12 -0
- data/lib/high_level/models/invoices/invoice_product_settings_dto.rb +12 -0
- data/lib/high_level/models/invoices/invoice_settings_business_details_dto.rb +12 -0
- data/lib/high_level/models/invoices/invoice_settings_sender_configuration_dto.rb +12 -0
- data/lib/high_level/models/invoices/item_tax_dto.rb +12 -0
- data/lib/high_level/models/invoices/late_fees_configuration_dto.rb +12 -0
- data/lib/high_level/models/invoices/late_fees_frequency_dto.rb +12 -0
- data/lib/high_level/models/invoices/late_fees_grace_dto.rb +12 -0
- data/lib/high_level/models/invoices/late_fees_max_fees_dto.rb +12 -0
- data/lib/high_level/models/invoices/list_estimate_template_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/list_estimates_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/list_invoices_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/list_schedules_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/list_templates_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/old_create_invoice_dto.rb +12 -0
- data/lib/high_level/models/invoices/patch_invoice_stats_last_viewed_dto.rb +12 -0
- data/lib/high_level/models/invoices/payment_method_dto.rb +12 -0
- data/lib/high_level/models/invoices/payment_schedule_config_dto.rb +12 -0
- data/lib/high_level/models/invoices/payment_schedule_date_config_dto.rb +12 -0
- data/lib/high_level/models/invoices/payment_schedule_dto.rb +12 -0
- data/lib/high_level/models/invoices/processing_fee_dto.rb +12 -0
- data/lib/high_level/models/invoices/processing_fee_paid_charge_dto.rb +12 -0
- data/lib/high_level/models/invoices/record_payment_dto.rb +12 -0
- data/lib/high_level/models/invoices/record_payment_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/reminder_dto.rb +12 -0
- data/lib/high_level/models/invoices/reminder_execution_details_list.rb +12 -0
- data/lib/high_level/models/invoices/reminder_settings_dto.rb +12 -0
- data/lib/high_level/models/invoices/reminders_configuration_dto.rb +12 -0
- data/lib/high_level/models/invoices/schedule_invoice_schedule_dto.rb +12 -0
- data/lib/high_level/models/invoices/schedule_invoice_schedule_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/schedule_options_dto.rb +12 -0
- data/lib/high_level/models/invoices/send_estimate_dto.rb +12 -0
- data/lib/high_level/models/invoices/send_invoice_dto.rb +12 -0
- data/lib/high_level/models/invoices/send_invoices_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/sent_to.rb +12 -0
- data/lib/high_level/models/invoices/sent_to_dto.rb +12 -0
- data/lib/high_level/models/invoices/sepa_direct_debit_dto.rb +12 -0
- data/lib/high_level/models/invoices/stripe_payment_method_dto.rb +12 -0
- data/lib/high_level/models/invoices/text2_pay_dto.rb +12 -0
- data/lib/high_level/models/invoices/text2_pay_invoice_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/tips_configuration_dto.rb +12 -0
- data/lib/high_level/models/invoices/total_summary_dto.rb +12 -0
- data/lib/high_level/models/invoices/update_and_schedule_invoice_schedule_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/update_estimate_dto.rb +12 -0
- data/lib/high_level/models/invoices/update_invoice_dto.rb +12 -0
- data/lib/high_level/models/invoices/update_invoice_late_fees_configuration_dto.rb +12 -0
- data/lib/high_level/models/invoices/update_invoice_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/update_invoice_schedule_dto.rb +12 -0
- data/lib/high_level/models/invoices/update_invoice_schedule_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/update_invoice_template_dto.rb +12 -0
- data/lib/high_level/models/invoices/update_invoice_template_response_dto.rb +12 -0
- data/lib/high_level/models/invoices/update_payment_methods_configuration_dto.rb +12 -0
- data/lib/high_level/models/invoices/us_bank_account_dto.rb +12 -0
- data/lib/high_level/models/invoices/void_invoice_dto.rb +12 -0
- data/lib/high_level/models/invoices/void_invoice_response_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/add_faq_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/bad_request_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/crawled_url_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/crawling_aggregate_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/crawling_record_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/crawling_status_data_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/crawling_status_response_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/create_faq_response_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/create_knowledge_base_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/create_knowledge_base_response_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/delete_faq_response_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/delete_knowledge_base_response_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/delete_website_url_request_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/delete_website_url_response_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/discover_website_data_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/discover_website_request_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/discover_website_response_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/error_details_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/faq_response_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/get_all_knowledge_bases_paginated_data_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/get_all_knowledge_bases_paginated_response_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/get_all_urls_by_knowledge_base_response_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/get_knowledge_base_by_id_data_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/get_knowledge_base_by_id_response_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/internal_server_error_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/knowledge_base_data_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/knowledge_base_list_item_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/knowledge_base_metadata_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/list_faqs_response_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/operation_details_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/train_discovered_urls_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/train_discovered_urls_response_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/unauthorized_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/unprocessable_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/update_faq_body_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/update_faq_response_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/update_knowledge_base_dto.rb +12 -0
- data/lib/high_level/models/knowledge_base/update_knowledge_base_response_dto.rb +12 -0
- data/lib/high_level/models/links/delete_links_successful_response_dto.rb +12 -0
- data/lib/high_level/models/links/get_link_successful_response_dto.rb +12 -0
- data/lib/high_level/models/links/get_links_successful_response_dto.rb +12 -0
- data/lib/high_level/models/links/link_schema.rb +12 -0
- data/lib/high_level/models/links/link_update_dto.rb +12 -0
- data/lib/high_level/models/links/links_dto.rb +12 -0
- data/lib/high_level/models/locations/business_schema.rb +12 -0
- data/lib/high_level/models/locations/create_custom_fields_dto.rb +12 -0
- data/lib/high_level/models/locations/create_location_dto.rb +12 -0
- data/lib/high_level/models/locations/create_location_successful_response_dto.rb +12 -0
- data/lib/high_level/models/locations/custom_field_delete_successful_response_dto.rb +12 -0
- data/lib/high_level/models/locations/custom_field_schema.rb +12 -0
- data/lib/high_level/models/locations/custom_field_successful_response_dto.rb +12 -0
- data/lib/high_level/models/locations/custom_fields_list_successful_response_dto.rb +12 -0
- data/lib/high_level/models/locations/custom_r_rules_options.rb +12 -0
- data/lib/high_level/models/locations/custom_value_delete_successful_response_dto.rb +12 -0
- data/lib/high_level/models/locations/custom_value_id_successful_response_dto.rb +12 -0
- data/lib/high_level/models/locations/custom_value_schema.rb +12 -0
- data/lib/high_level/models/locations/custom_values_dto.rb +12 -0
- data/lib/high_level/models/locations/custom_values_list_successful_response_dto.rb +12 -0
- data/lib/high_level/models/locations/delete_recurring_task_response_dto.rb +12 -0
- data/lib/high_level/models/locations/email_template_schema.rb +12 -0
- data/lib/high_level/models/locations/file_upload_body.rb +12 -0
- data/lib/high_level/models/locations/file_upload_response_dto.rb +12 -0
- data/lib/high_level/models/locations/get_email_template_response_schema.rb +12 -0
- data/lib/high_level/models/locations/get_location_by_id_schema.rb +12 -0
- data/lib/high_level/models/locations/get_location_by_id_successful_response_dto.rb +12 -0
- data/lib/high_level/models/locations/get_location_schema.rb +12 -0
- data/lib/high_level/models/locations/get_sms_template_response_schema.rb +12 -0
- data/lib/high_level/models/locations/get_templates_successful_response_dto.rb +12 -0
- data/lib/high_level/models/locations/location_deleted_successful_response_dto.rb +12 -0
- data/lib/high_level/models/locations/location_tag_delete_successful_response_dto.rb +12 -0
- data/lib/high_level/models/locations/location_tag_successful_response_dto.rb +12 -0
- data/lib/high_level/models/locations/location_tags_schema.rb +12 -0
- data/lib/high_level/models/locations/location_tags_successful_response_dto.rb +12 -0
- data/lib/high_level/models/locations/location_task_list_successful_response_dto.rb +12 -0
- data/lib/high_level/models/locations/mailgun_schema.rb +12 -0
- data/lib/high_level/models/locations/prospect_info_dto.rb +12 -0
- data/lib/high_level/models/locations/recurring_task_create_dto.rb +12 -0
- data/lib/high_level/models/locations/recurring_task_response_dto.rb +12 -0
- data/lib/high_level/models/locations/recurring_task_single_response_dto.rb +12 -0
- data/lib/high_level/models/locations/recurring_task_update_dto.rb +12 -0
- data/lib/high_level/models/locations/search_successful_response_dto.rb +12 -0
- data/lib/high_level/models/locations/settings_schema.rb +12 -0
- data/lib/high_level/models/locations/sms_template_schema.rb +12 -0
- data/lib/high_level/models/locations/snapshot_put_schema.rb +12 -0
- data/lib/high_level/models/locations/social_schema.rb +12 -0
- data/lib/high_level/models/locations/tag_body.rb +12 -0
- data/lib/high_level/models/locations/task_search_params_dto.rb +12 -0
- data/lib/high_level/models/locations/text_box_list_options_schema.rb +12 -0
- data/lib/high_level/models/locations/twilio_schema.rb +12 -0
- data/lib/high_level/models/locations/update_custom_fields_dto.rb +12 -0
- data/lib/high_level/models/locations/update_location_dto.rb +12 -0
- data/lib/high_level/models/marketplace/delete_integration_body_dto.rb +12 -0
- data/lib/high_level/models/marketplace/delete_integration_response.rb +12 -0
- data/lib/high_level/models/marketplace/get_installer_details_response_dto.rb +12 -0
- data/lib/high_level/models/marketplace/get_rebilling_config_response_dto.rb +12 -0
- data/lib/high_level/models/marketplace/installer_details_dto.rb +12 -0
- data/lib/high_level/models/marketplace/internal_server_error_dto.rb +12 -0
- data/lib/high_level/models/marketplace/migrate_connection_dto.rb +12 -0
- data/lib/high_level/models/marketplace/migrate_connection_response_dto.rb +12 -0
- data/lib/high_level/models/marketplace/plans_dto.rb +12 -0
- data/lib/high_level/models/marketplace/raise_charge_body_dto.rb +12 -0
- data/lib/high_level/models/marketplace/subscription_plan_dto.rb +12 -0
- data/lib/high_level/models/marketplace/usage_plan_dto.rb +12 -0
- data/lib/high_level/models/marketplace/whitelabel_details_dto.rb +12 -0
- data/lib/high_level/models/medias/create_folder_params.rb +12 -0
- data/lib/high_level/models/medias/delete_media_object_item.rb +12 -0
- data/lib/high_level/models/medias/delete_media_objects_body_params.rb +12 -0
- data/lib/high_level/models/medias/folder_dto.rb +12 -0
- data/lib/high_level/models/medias/get_files_response_dto.rb +12 -0
- data/lib/high_level/models/medias/move_or_delete_object_params.rb +12 -0
- data/lib/high_level/models/medias/update_media_object.rb +12 -0
- data/lib/high_level/models/medias/update_media_objects.rb +12 -0
- data/lib/high_level/models/medias/update_object.rb +12 -0
- data/lib/high_level/models/medias/upload_file_response_dto.rb +12 -0
- data/lib/high_level/models/objects/create_custom_object_record_dto.rb +12 -0
- data/lib/high_level/models/objects/create_custom_object_schema_dto.rb +12 -0
- data/lib/high_level/models/objects/created_by_response_dto.rb +12 -0
- data/lib/high_level/models/objects/custom_object_by_id_response_dto.rb +12 -0
- data/lib/high_level/models/objects/custom_object_display_property_details.rb +12 -0
- data/lib/high_level/models/objects/custom_object_label_dto.rb +12 -0
- data/lib/high_level/models/objects/custom_object_label_update_dto.rb +12 -0
- data/lib/high_level/models/objects/custom_object_list_response_dto.rb +12 -0
- data/lib/high_level/models/objects/custom_object_response_dto.rb +12 -0
- data/lib/high_level/models/objects/i_custom_field.rb +12 -0
- data/lib/high_level/models/objects/i_custom_object_schema.rb +12 -0
- data/lib/high_level/models/objects/i_record_schema.rb +12 -0
- data/lib/high_level/models/objects/object_record_delete_response_dto.rb +12 -0
- data/lib/high_level/models/objects/option_dto.rb +12 -0
- data/lib/high_level/models/objects/record_by_id_response_dto.rb +12 -0
- data/lib/high_level/models/objects/record_response_dto.rb +12 -0
- data/lib/high_level/models/objects/search_record_response_dto.rb +12 -0
- data/lib/high_level/models/objects/search_records_body.rb +12 -0
- data/lib/high_level/models/objects/update_custom_object_record_dto.rb +12 -0
- data/lib/high_level/models/objects/update_custom_object_schema_dto.rb +12 -0
- data/lib/high_level/models/opportunities/additional_details_dto.rb +12 -0
- data/lib/high_level/models/opportunities/create_add_followers_successful_response_dto.rb +12 -0
- data/lib/high_level/models/opportunities/create_dto.rb +12 -0
- data/lib/high_level/models/opportunities/custom_field_response_schema.rb +12 -0
- data/lib/high_level/models/opportunities/custom_fields_input_array_schema.rb +12 -0
- data/lib/high_level/models/opportunities/custom_fields_input_object_schema.rb +12 -0
- data/lib/high_level/models/opportunities/custom_fields_input_string_schema.rb +12 -0
- data/lib/high_level/models/opportunities/delete_followers_successful_response_dto.rb +12 -0
- data/lib/high_level/models/opportunities/delete_update_opportunity_successful_response_dto.rb +12 -0
- data/lib/high_level/models/opportunities/followers_dto.rb +12 -0
- data/lib/high_level/models/opportunities/get_pipelines_successful_response_dto.rb +12 -0
- data/lib/high_level/models/opportunities/get_post_opportunity_successful_response_dto.rb +12 -0
- data/lib/high_level/models/opportunities/lost_reason_response_schema.rb +12 -0
- data/lib/high_level/models/opportunities/lost_reasons_response_schema.rb +12 -0
- data/lib/high_level/models/opportunities/opportunity_search_body_dto.rb +12 -0
- data/lib/high_level/models/opportunities/pipelines_response_schema.rb +12 -0
- data/lib/high_level/models/opportunities/post_search_successful_response_dto.rb +12 -0
- data/lib/high_level/models/opportunities/search_meta_response_schema.rb +12 -0
- data/lib/high_level/models/opportunities/search_opportunities_contact_response_schema.rb +12 -0
- data/lib/high_level/models/opportunities/search_opportunities_response_schema.rb +12 -0
- data/lib/high_level/models/opportunities/search_successful_response_dto.rb +12 -0
- data/lib/high_level/models/opportunities/update_opportunity_dto.rb +12 -0
- data/lib/high_level/models/opportunities/update_status_dto.rb +12 -0
- data/lib/high_level/models/opportunities/upsert_opportunity_dto.rb +12 -0
- data/lib/high_level/models/opportunities/upsert_opportunity_successful_response_dto.rb +12 -0
- data/lib/high_level/models/payments/amount_summary.rb +12 -0
- data/lib/high_level/models/payments/apply_to_future_payments_config.rb +12 -0
- data/lib/high_level/models/payments/apply_to_future_payments_config_dto.rb +12 -0
- data/lib/high_level/models/payments/card_dto.rb +12 -0
- data/lib/high_level/models/payments/cheque_dto.rb +12 -0
- data/lib/high_level/models/payments/connect_custom_providers_config_dto.rb +12 -0
- data/lib/high_level/models/payments/connect_custom_providers_response_schema.rb +12 -0
- data/lib/high_level/models/payments/coupon_dto.rb +12 -0
- data/lib/high_level/models/payments/create_coupon_params.rb +12 -0
- data/lib/high_level/models/payments/create_coupon_response_dto.rb +12 -0
- data/lib/high_level/models/payments/create_custom_providers_dto.rb +12 -0
- data/lib/high_level/models/payments/create_custom_providers_response_schema.rb +12 -0
- data/lib/high_level/models/payments/create_fulfillment_dto.rb +12 -0
- data/lib/high_level/models/payments/create_fulfillment_response_dto.rb +12 -0
- data/lib/high_level/models/payments/create_white_label_integration_provider_dto.rb +12 -0
- data/lib/high_level/models/payments/create_whitelabel_integration_response_dto.rb +12 -0
- data/lib/high_level/models/payments/custom_provider_keys.rb +12 -0
- data/lib/high_level/models/payments/custom_r_rule_options_dto.rb +12 -0
- data/lib/high_level/models/payments/default_price_response_dto.rb +12 -0
- data/lib/high_level/models/payments/default_product_response_dto.rb +12 -0
- data/lib/high_level/models/payments/delete_coupon_params.rb +12 -0
- data/lib/high_level/models/payments/delete_coupon_response_dto.rb +12 -0
- data/lib/high_level/models/payments/delete_custom_providers_config_dto.rb +12 -0
- data/lib/high_level/models/payments/delete_custom_providers_response_schema.rb +12 -0
- data/lib/high_level/models/payments/disconnect_custom_providers_response_schema.rb +12 -0
- data/lib/high_level/models/payments/fulfilled_item.rb +12 -0
- data/lib/high_level/models/payments/fulfillment_items.rb +12 -0
- data/lib/high_level/models/payments/fulfillment_schema.rb +12 -0
- data/lib/high_level/models/payments/fulfillment_tracking.rb +12 -0
- data/lib/high_level/models/payments/get_custom_providers_response_schema.rb +12 -0
- data/lib/high_level/models/payments/get_order_response_schema.rb +12 -0
- data/lib/high_level/models/payments/get_subscription_response_schema.rb +12 -0
- data/lib/high_level/models/payments/get_txn_response_schema.rb +12 -0
- data/lib/high_level/models/payments/integration_provider_schema.rb +12 -0
- data/lib/high_level/models/payments/list_coupons_response_dto.rb +12 -0
- data/lib/high_level/models/payments/list_fulfillment_response_dto.rb +12 -0
- data/lib/high_level/models/payments/list_orders_response_dto.rb +12 -0
- data/lib/high_level/models/payments/list_subscription_response_dto.rb +12 -0
- data/lib/high_level/models/payments/list_txns_response_dto.rb +12 -0
- data/lib/high_level/models/payments/list_whitelabel_integration_provider_response_dto.rb +12 -0
- data/lib/high_level/models/payments/membership_offer_dto.rb +12 -0
- data/lib/high_level/models/payments/order_response_schema.rb +12 -0
- data/lib/high_level/models/payments/order_source.rb +12 -0
- data/lib/high_level/models/payments/post_record_order_payment_body.rb +12 -0
- data/lib/high_level/models/payments/post_record_order_payment_response.rb +12 -0
- data/lib/high_level/models/payments/product_label_dto.rb +12 -0
- data/lib/high_level/models/payments/product_variant_dto.rb +12 -0
- data/lib/high_level/models/payments/product_variant_option_dto.rb +12 -0
- data/lib/high_level/models/payments/recurring_dto.rb +12 -0
- data/lib/high_level/models/payments/schedule_options_dto.rb +12 -0
- data/lib/high_level/models/payments/subscription_response_schema.rb +12 -0
- data/lib/high_level/models/payments/txn_response_schema.rb +12 -0
- data/lib/high_level/models/payments/update_coupon_params.rb +12 -0
- data/lib/high_level/models/payments/update_custom_provider_capabilities_dto.rb +12 -0
- data/lib/high_level/models/payments/update_custom_provider_capabilities_response_schema.rb +12 -0
- data/lib/high_level/models/phone_system/available_numbers_response_dto.rb +12 -0
- data/lib/high_level/models/phone_system/available_phone_number_dto.rb +12 -0
- data/lib/high_level/models/phone_system/detailed_phone_number_dto.rb +12 -0
- data/lib/high_level/models/phone_system/number_pool_dto.rb +12 -0
- data/lib/high_level/models/phone_system/purchase_phone_number_body_dto.rb +12 -0
- data/lib/high_level/models/phone_system/twilio_account_response_dto.rb +12 -0
- data/lib/high_level/models/products/bulk_edit_price_dto.rb +12 -0
- data/lib/high_level/models/products/bulk_edit_product_dto.rb +12 -0
- data/lib/high_level/models/products/bulk_edit_request_dto.rb +12 -0
- data/lib/high_level/models/products/bulk_edit_response_dto.rb +12 -0
- data/lib/high_level/models/products/bulk_update_dto.rb +12 -0
- data/lib/high_level/models/products/bulk_update_filters.rb +12 -0
- data/lib/high_level/models/products/bulk_update_response_dto.rb +12 -0
- data/lib/high_level/models/products/collection_schema.rb +12 -0
- data/lib/high_level/models/products/collection_seo_dto.rb +12 -0
- data/lib/high_level/models/products/count_reviews_by_status_response_dto.rb +12 -0
- data/lib/high_level/models/products/create_collection_response_dto.rb +12 -0
- data/lib/high_level/models/products/create_price_dto.rb +12 -0
- data/lib/high_level/models/products/create_price_response_dto.rb +12 -0
- data/lib/high_level/models/products/create_product_collections_dto.rb +12 -0
- data/lib/high_level/models/products/create_product_dto.rb +12 -0
- data/lib/high_level/models/products/create_product_response_dto.rb +12 -0
- data/lib/high_level/models/products/default_collection_response_dto.rb +12 -0
- data/lib/high_level/models/products/default_price_response_dto.rb +12 -0
- data/lib/high_level/models/products/default_product_response_dto.rb +12 -0
- data/lib/high_level/models/products/delete_price_response_dto.rb +12 -0
- data/lib/high_level/models/products/delete_product_collection_response_dto.rb +12 -0
- data/lib/high_level/models/products/delete_product_response_dto.rb +12 -0
- data/lib/high_level/models/products/delete_product_review_response_dto.rb +12 -0
- data/lib/high_level/models/products/get_inventory_response_dto.rb +12 -0
- data/lib/high_level/models/products/get_price_response_dto.rb +12 -0
- data/lib/high_level/models/products/get_product_response_dto.rb +12 -0
- data/lib/high_level/models/products/get_product_stats_response_dto.rb +12 -0
- data/lib/high_level/models/products/inventory_item_dto.rb +12 -0
- data/lib/high_level/models/products/list_collection_response_dto.rb +12 -0
- data/lib/high_level/models/products/list_prices_response_dto.rb +12 -0
- data/lib/high_level/models/products/list_product_reviews_response_dto.rb +12 -0
- data/lib/high_level/models/products/list_products_response_dto.rb +12 -0
- data/lib/high_level/models/products/list_products_stats.rb +12 -0
- data/lib/high_level/models/products/membership_offer_dto.rb +12 -0
- data/lib/high_level/models/products/price_dimensions_dto.rb +12 -0
- data/lib/high_level/models/products/price_meta_dto.rb +12 -0
- data/lib/high_level/models/products/price_update_field.rb +12 -0
- data/lib/high_level/models/products/product_categories.rb +12 -0
- data/lib/high_level/models/products/product_label_dto.rb +12 -0
- data/lib/high_level/models/products/product_media_dto.rb +12 -0
- data/lib/high_level/models/products/product_review_dto.rb +12 -0
- data/lib/high_level/models/products/product_seo_dto.rb +12 -0
- data/lib/high_level/models/products/product_variant_dto.rb +12 -0
- data/lib/high_level/models/products/product_variant_option_dto.rb +12 -0
- data/lib/high_level/models/products/recurring_dto.rb +12 -0
- data/lib/high_level/models/products/shipping_options_dto.rb +12 -0
- data/lib/high_level/models/products/update_display_priority_body_dto.rb +12 -0
- data/lib/high_level/models/products/update_inventory_dto.rb +12 -0
- data/lib/high_level/models/products/update_inventory_item_dto.rb +12 -0
- data/lib/high_level/models/products/update_inventory_response_dto.rb +12 -0
- data/lib/high_level/models/products/update_price_dto.rb +12 -0
- data/lib/high_level/models/products/update_price_response_dto.rb +12 -0
- data/lib/high_level/models/products/update_product_collection_response_dto.rb +12 -0
- data/lib/high_level/models/products/update_product_collections_dto.rb +12 -0
- data/lib/high_level/models/products/update_product_dto.rb +12 -0
- data/lib/high_level/models/products/update_product_response_dto.rb +12 -0
- data/lib/high_level/models/products/update_product_review_dto.rb +12 -0
- data/lib/high_level/models/products/update_product_review_object_dto.rb +12 -0
- data/lib/high_level/models/products/update_product_reviews_dto.rb +12 -0
- data/lib/high_level/models/products/update_product_reviews_response_dto.rb +12 -0
- data/lib/high_level/models/products/update_product_store_dto.rb +12 -0
- data/lib/high_level/models/products/update_product_store_response_dto.rb +12 -0
- data/lib/high_level/models/products/user_details_dto.rb +12 -0
- data/lib/high_level/models/products/weight_options_dto.rb +12 -0
- data/lib/high_level/models/proposals/bad_request_dto.rb +12 -0
- data/lib/high_level/models/proposals/cc_recipient_item.rb +12 -0
- data/lib/high_level/models/proposals/discount_dto.rb +12 -0
- data/lib/high_level/models/proposals/document_dto.rb +12 -0
- data/lib/high_level/models/proposals/document_list_response_dto.rb +12 -0
- data/lib/high_level/models/proposals/fillable_fields_dto.rb +12 -0
- data/lib/high_level/models/proposals/grand_total_dto.rb +12 -0
- data/lib/high_level/models/proposals/notification_send_setting_dto.rb +12 -0
- data/lib/high_level/models/proposals/notification_sender_setting_dto.rb +12 -0
- data/lib/high_level/models/proposals/notification_settings_dto.rb +12 -0
- data/lib/high_level/models/proposals/proposal_estimate_links_dto.rb +12 -0
- data/lib/high_level/models/proposals/recipient_item.rb +12 -0
- data/lib/high_level/models/proposals/send_document_dto.rb +12 -0
- data/lib/high_level/models/proposals/send_document_from_public_api_body_dto.rb +12 -0
- data/lib/high_level/models/proposals/send_document_response_dto.rb +12 -0
- data/lib/high_level/models/proposals/send_template_response_dto.rb +12 -0
- data/lib/high_level/models/proposals/template_list_pagination_response_dto.rb +12 -0
- data/lib/high_level/models/proposals/template_list_response_dto.rb +12 -0
- data/lib/high_level/models/proposals/unauthorized_dto.rb +12 -0
- data/lib/high_level/models/saas_api/agency_plan_response_dto.rb +12 -0
- data/lib/high_level/models/saas_api/bad_request_dto.rb +12 -0
- data/lib/high_level/models/saas_api/bulk_disable_saas_dto.rb +12 -0
- data/lib/high_level/models/saas_api/bulk_disable_saas_response_dto.rb +12 -0
- data/lib/high_level/models/saas_api/bulk_enable_saas_action_payload_dto.rb +12 -0
- data/lib/high_level/models/saas_api/bulk_enable_saas_request_dto.rb +12 -0
- data/lib/high_level/models/saas_api/bulk_enable_saas_response_dto.rb +12 -0
- data/lib/high_level/models/saas_api/enable_saas_dto.rb +12 -0
- data/lib/high_level/models/saas_api/enable_saas_response_dto.rb +12 -0
- data/lib/high_level/models/saas_api/get_saas_locations_response_dto.rb +12 -0
- data/lib/high_level/models/saas_api/internal_server_error_dto.rb +12 -0
- data/lib/high_level/models/saas_api/location_subscription_response_dto.rb +12 -0
- data/lib/high_level/models/saas_api/pause_location_dto.rb +12 -0
- data/lib/high_level/models/saas_api/resource_not_found_dto.rb +12 -0
- data/lib/high_level/models/saas_api/saas_location_dto.rb +12 -0
- data/lib/high_level/models/saas_api/saas_plan_response_dto.rb +12 -0
- data/lib/high_level/models/saas_api/unauthorized_dto.rb +12 -0
- data/lib/high_level/models/saas_api/update_rebilling_dto.rb +12 -0
- data/lib/high_level/models/saas_api/update_rebilling_response_dto.rb +12 -0
- data/lib/high_level/models/saas_api/update_subscription_dto.rb +12 -0
- data/lib/high_level/models/snapshots/create_snapshot_share_link_request_dto.rb +12 -0
- data/lib/high_level/models/snapshots/create_snapshot_share_link_successful_response_dto.rb +12 -0
- data/lib/high_level/models/snapshots/get_latest_snapshot_push_status_successful_response_dto.rb +12 -0
- data/lib/high_level/models/snapshots/get_snapshot_push_status_successful_response_dto.rb +12 -0
- data/lib/high_level/models/snapshots/get_snapshots_successful_response_dto.rb +12 -0
- data/lib/high_level/models/snapshots/snapshot_status_schema.rb +12 -0
- data/lib/high_level/models/snapshots/snapshot_status_schema_with_assets.rb +12 -0
- data/lib/high_level/models/snapshots/snapshots_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/accounts_list_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/accounts_list_response_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/attach_fb_account_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/attach_gmb_location_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/attach_ig_account_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/attach_linkedin_account_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/attach_tiktok_account_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/attach_twitter_account_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/bulk_delete_post_successful_response_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/bulk_delete_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/category_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/create_post_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/create_post_successful_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/create_post_successful_response_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/csv_default_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/csv_import_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/csv_media_response_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/csv_post_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/csv_post_status_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/csv_response.rb +12 -0
- data/lib/high_level/models/social_media_posting/csv_response_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/date_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/delete_account_response_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/delete_csv_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/delete_post_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/delete_post_response_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/delete_post_successful_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/delete_post_successful_response_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/delete_posts_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/end_date_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/facebook_page_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/formated_approval_details.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_account_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_by_id_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_by_id_response_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_by_location_id_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_by_location_id_response_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_category_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_csv_post_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_csv_post_response_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_facebook_accounts_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_facebook_accounts_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_google_location_account_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_google_location_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_google_location_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_group_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_instagram_accounts_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_instagram_accounts_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_linked_in_account_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_linked_in_accounts_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_post_formatted_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_post_successful_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_post_successful_response_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_tags_by_id_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_tags_by_id_response_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_tags_by_location_id_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_tags_by_location_id_response_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_tiktok_account_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_tiktok_account_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_tiktok_business_account_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_tiktok_business_account_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_twitter_accounts_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_twitter_accounts_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_upload_status_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/get_upload_status_response_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/gmb_post_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/google_accounts_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/google_location_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/i_og_tags_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/instagram_account_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/linked_in_page_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/linked_in_profile_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/location_and_account_delete_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/og_image_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/og_tags_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/post_approval_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/post_create_request.rb +12 -0
- data/lib/high_level/models/social_media_posting/post_media_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/post_successful_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/post_successful_response_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/post_user_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/search_post_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/set_accounts_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/set_accounts_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/social_google_media_account_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/social_media_facebook_account_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/social_media_fb_account_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/social_media_gmb_account_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/social_media_instagram_account_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/social_media_instagram_account_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/social_media_linked_in_account_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/social_media_linked_in_account_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/social_media_tag_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/social_media_tiktok_account_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/social_media_tiktok_account_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/social_media_twitter_account_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/social_media_twitter_account_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/start_date_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/tiktok_post_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/tiktok_profile_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/time_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/twitter_profile_schema.rb +12 -0
- data/lib/high_level/models/social_media_posting/update_post_successful_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/update_tag_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/upload_csvdto.rb +12 -0
- data/lib/high_level/models/social_media_posting/upload_file_response_dto.rb +12 -0
- data/lib/high_level/models/social_media_posting/upload_file_response_schema.rb +12 -0
- data/lib/high_level/models/store/available_shipping_rate.rb +12 -0
- data/lib/high_level/models/store/contact_address.rb +12 -0
- data/lib/high_level/models/store/create_shipping_carrier_dto.rb +12 -0
- data/lib/high_level/models/store/create_shipping_carrier_response_dto.rb +12 -0
- data/lib/high_level/models/store/create_shipping_rate_dto.rb +12 -0
- data/lib/high_level/models/store/create_shipping_rate_response_dto.rb +12 -0
- data/lib/high_level/models/store/create_shipping_zone_dto.rb +12 -0
- data/lib/high_level/models/store/create_shipping_zone_response_dto.rb +12 -0
- data/lib/high_level/models/store/create_store_setting_dto.rb +12 -0
- data/lib/high_level/models/store/create_store_setting_response_dto.rb +12 -0
- data/lib/high_level/models/store/delete_shipping_carrier_response_dto.rb +12 -0
- data/lib/high_level/models/store/delete_shipping_rate_response_dto.rb +12 -0
- data/lib/high_level/models/store/delete_shipping_zone_response_dto.rb +12 -0
- data/lib/high_level/models/store/get_available_shipping_rates.rb +12 -0
- data/lib/high_level/models/store/get_available_shipping_rates_response_dto.rb +12 -0
- data/lib/high_level/models/store/get_shipping_carrier_response_dto.rb +12 -0
- data/lib/high_level/models/store/get_shipping_rate_response_dto.rb +12 -0
- data/lib/high_level/models/store/get_shipping_zone_response_dto.rb +12 -0
- data/lib/high_level/models/store/get_store_setting_response_dto.rb +12 -0
- data/lib/high_level/models/store/list_shipping_carrier_response_dto.rb +12 -0
- data/lib/high_level/models/store/list_shipping_rate_response_dto.rb +12 -0
- data/lib/high_level/models/store/list_shipping_zone_response_dto.rb +12 -0
- data/lib/high_level/models/store/order_source.rb +12 -0
- data/lib/high_level/models/store/product_item.rb +12 -0
- data/lib/high_level/models/store/shipping_carrier_schema.rb +12 -0
- data/lib/high_level/models/store/shipping_carrier_service_dto.rb +12 -0
- data/lib/high_level/models/store/shipping_rate_schema.rb +12 -0
- data/lib/high_level/models/store/shipping_zone_country_dto.rb +12 -0
- data/lib/high_level/models/store/shipping_zone_country_state_dto.rb +12 -0
- data/lib/high_level/models/store/shipping_zone_schema.rb +12 -0
- data/lib/high_level/models/store/store_order_fulfillment_notification_dto.rb +12 -0
- data/lib/high_level/models/store/store_order_notification_dto.rb +12 -0
- data/lib/high_level/models/store/store_setting_schema.rb +12 -0
- data/lib/high_level/models/store/store_shipping_origin_dto.rb +12 -0
- data/lib/high_level/models/store/update_shipping_carrier_dto.rb +12 -0
- data/lib/high_level/models/store/update_shipping_carrier_response_dto.rb +12 -0
- data/lib/high_level/models/store/update_shipping_rate_dto.rb +12 -0
- data/lib/high_level/models/store/update_shipping_rate_response_dto.rb +12 -0
- data/lib/high_level/models/store/update_shipping_zone_dto.rb +12 -0
- data/lib/high_level/models/store/update_shipping_zone_response_dto.rb +12 -0
- data/lib/high_level/models/surveys/contact_session_ids.rb +12 -0
- data/lib/high_level/models/surveys/event_data_schema.rb +12 -0
- data/lib/high_level/models/surveys/get_surveys_schema.rb +12 -0
- data/lib/high_level/models/surveys/get_surveys_submission_successful_response_dto.rb +12 -0
- data/lib/high_level/models/surveys/get_surveys_successful_response_dto.rb +12 -0
- data/lib/high_level/models/surveys/meta_schema.rb +12 -0
- data/lib/high_level/models/surveys/others_schema.rb +12 -0
- data/lib/high_level/models/surveys/page_details_schema.rb +12 -0
- data/lib/high_level/models/surveys/submission_schema.rb +12 -0
- data/lib/high_level/models/users/create_user_dto.rb +12 -0
- data/lib/high_level/models/users/delete_user_successful_response_dto.rb +12 -0
- data/lib/high_level/models/users/filter_by_email_dto.rb +12 -0
- data/lib/high_level/models/users/location_successful_response_dto.rb +12 -0
- data/lib/high_level/models/users/permissions_dto.rb +12 -0
- data/lib/high_level/models/users/role_schema.rb +12 -0
- data/lib/high_level/models/users/search_user_successful_response_dto.rb +12 -0
- data/lib/high_level/models/users/update_user_dto.rb +12 -0
- data/lib/high_level/models/users/user_schema.rb +12 -0
- data/lib/high_level/models/users/user_successful_response_dto.rb +12 -0
- data/lib/high_level/models/voice_ai/agent_action_response_dto.rb +12 -0
- data/lib/high_level/models/voice_ai/agent_creation_request_dto.rb +12 -0
- data/lib/high_level/models/voice_ai/agent_working_hours_dto.rb +12 -0
- data/lib/high_level/models/voice_ai/appointment_booking_action_parameters.rb +12 -0
- data/lib/high_level/models/voice_ai/call_action_schema.rb +12 -0
- data/lib/high_level/models/voice_ai/call_log_dto.rb +12 -0
- data/lib/high_level/models/voice_ai/call_logs_response_dto.rb +12 -0
- data/lib/high_level/models/voice_ai/call_transfer_action_parameters.rb +12 -0
- data/lib/high_level/models/voice_ai/create_action_response_dto.rb +12 -0
- data/lib/high_level/models/voice_ai/create_agent_response_dto.rb +12 -0
- data/lib/high_level/models/voice_ai/create_single_action_dto.rb +12 -0
- data/lib/high_level/models/voice_ai/custom_action_api_details_dto.rb +12 -0
- data/lib/high_level/models/voice_ai/custom_action_header_dto.rb +12 -0
- data/lib/high_level/models/voice_ai/custom_action_parameter_dto.rb +12 -0
- data/lib/high_level/models/voice_ai/custom_action_parameters.rb +12 -0
- data/lib/high_level/models/voice_ai/data_extraction_action_parameters.rb +12 -0
- data/lib/high_level/models/voice_ai/extracted_data_schema.rb +12 -0
- data/lib/high_level/models/voice_ai/get_action_response_dto.rb +12 -0
- data/lib/high_level/models/voice_ai/get_agent_response_dto.rb +12 -0
- data/lib/high_level/models/voice_ai/get_agents_response_dto.rb +12 -0
- data/lib/high_level/models/voice_ai/in_call_data_extraction_action_parameters.rb +12 -0
- data/lib/high_level/models/voice_ai/interval_dto.rb +12 -0
- data/lib/high_level/models/voice_ai/knowledge_base_parameters.rb +12 -0
- data/lib/high_level/models/voice_ai/patch_agent_dto.rb +12 -0
- data/lib/high_level/models/voice_ai/patch_agent_response_dto.rb +12 -0
- data/lib/high_level/models/voice_ai/send_post_call_notification_dto.rb +12 -0
- data/lib/high_level/models/voice_ai/send_post_call_notification_schema.rb +12 -0
- data/lib/high_level/models/voice_ai/sms_parameters.rb +12 -0
- data/lib/high_level/models/voice_ai/translation_dto.rb +12 -0
- data/lib/high_level/models/voice_ai/translation_schema.rb +12 -0
- data/lib/high_level/models/voice_ai/update_action_response_dto.rb +12 -0
- data/lib/high_level/models/voice_ai/update_single_action_dto.rb +12 -0
- data/lib/high_level/models/voice_ai/workflow_trigger_parameters.rb +12 -0
- data/lib/high_level/models/workflows/get_workflow_successful_response_dto.rb +12 -0
- data/lib/high_level/models/workflows/workflow_schema.rb +12 -0
- data/lib/high_level/oauth.rb +106 -0
- data/lib/high_level/pagination.rb +71 -0
- data/lib/high_level/resource_registry.rb +49 -0
- data/lib/high_level/resources/ad_manager.rb +1140 -0
- data/lib/high_level/resources/affiliate_manager.rb +57 -0
- data/lib/high_level/resources/agent_studio.rb +164 -0
- data/lib/high_level/resources/associations.rb +126 -0
- data/lib/high_level/resources/base.rb +46 -0
- data/lib/high_level/resources/blogs.rb +94 -0
- data/lib/high_level/resources/brand_boards.rb +68 -0
- data/lib/high_level/resources/businesses.rb +58 -0
- data/lib/high_level/resources/calendars.rb +471 -0
- data/lib/high_level/resources/campaigns.rb +20 -0
- data/lib/high_level/resources/companies.rb +21 -0
- data/lib/high_level/resources/contacts.rb +339 -0
- data/lib/high_level/resources/conversation_ai.rb +149 -0
- data/lib/high_level/resources/conversations.rb +349 -0
- data/lib/high_level/resources/courses.rb +22 -0
- data/lib/high_level/resources/custom_fields.rb +280 -0
- data/lib/high_level/resources/custom_menus.rb +68 -0
- data/lib/high_level/resources/email_isv.rb +23 -0
- data/lib/high_level/resources/emails.rb +61 -0
- data/lib/high_level/resources/forms.rb +43 -0
- data/lib/high_level/resources/funnels.rb +94 -0
- data/lib/high_level/resources/invoices.rb +513 -0
- data/lib/high_level/resources/knowledge_base.rb +163 -0
- data/lib/high_level/resources/links.rb +75 -0
- data/lib/high_level/resources/locations.rb +328 -0
- data/lib/high_level/resources/marketplace.rb +103 -0
- data/lib/high_level/resources/medias.rb +94 -0
- data/lib/high_level/resources/objects.rb +117 -0
- data/lib/high_level/resources/opportunities.rb +133 -0
- data/lib/high_level/resources/payments.rb +289 -0
- data/lib/high_level/resources/phone_system.rb +58 -0
- data/lib/high_level/resources/products.rb +332 -0
- data/lib/high_level/resources/proposals.rb +62 -0
- data/lib/high_level/resources/saas_api.rb +334 -0
- data/lib/high_level/resources/snapshots.rb +59 -0
- data/lib/high_level/resources/social_media_posting.rb +618 -0
- data/lib/high_level/resources/store.rb +244 -0
- data/lib/high_level/resources/surveys.rb +30 -0
- data/lib/high_level/resources/users.rb +82 -0
- data/lib/high_level/resources/voice_ai.rb +143 -0
- data/lib/high_level/resources/workflows.rb +20 -0
- data/lib/high_level/storage/active_record.rb +121 -0
- data/lib/high_level/storage/base.rb +81 -0
- data/lib/high_level/storage/memory.rb +108 -0
- data/lib/high_level/storage/mongo.rb +116 -0
- data/lib/high_level/storage/redis.rb +100 -0
- data/lib/high_level/token_refresher.rb +116 -0
- data/lib/high_level/token_resolver.rb +158 -0
- data/lib/high_level/version.rb +6 -0
- data/lib/high_level/webhooks.rb +76 -0
- data/lib/high_level.rb +25 -0
- metadata +1237 -0
|
@@ -0,0 +1,1140 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# GENERATED FROM vendor/openapi/apps/ad-manager.json @ 192cd68b065a7423c543d82721eb8644cdc883c7
|
|
4
|
+
# DO NOT EDIT — regenerate via bin/generate.
|
|
5
|
+
|
|
6
|
+
module HighLevel
|
|
7
|
+
module Resources
|
|
8
|
+
class AdManager < Base
|
|
9
|
+
# Get reporting data
|
|
10
|
+
#
|
|
11
|
+
# Retrieve aggregated Facebook ad reporting metrics for a location
|
|
12
|
+
def fb_get_reporting(location_id: nil, group_by: nil, start_date: nil, end_date: nil, type: nil, fields: nil, **_opts)
|
|
13
|
+
request(
|
|
14
|
+
method: :get,
|
|
15
|
+
path: "/ad-publishing/facebook/reporting",
|
|
16
|
+
security: ["bearer"],
|
|
17
|
+
params: { "locationId" => location_id, "groupBy" => group_by, "startDate" => start_date, "endDate" => end_date, "type" => type, "fields" => fields }.compact
|
|
18
|
+
)
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
# Get campaign reporting
|
|
22
|
+
#
|
|
23
|
+
# Retrieve reporting metrics for a specific Facebook campaign
|
|
24
|
+
def fb_get_campaign_reporting(campaign_id:, location_id: nil, start_date: nil, end_date: nil, **_opts)
|
|
25
|
+
request(
|
|
26
|
+
method: :get,
|
|
27
|
+
path: "/ad-publishing/facebook/reporting/campaign/#{campaign_id}",
|
|
28
|
+
security: ["bearer"],
|
|
29
|
+
params: { "locationId" => location_id, "startDate" => start_date, "endDate" => end_date }.compact
|
|
30
|
+
)
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
# Get reporting list
|
|
34
|
+
#
|
|
35
|
+
# Retrieve a list of Facebook campaigns, adsets, or ads with reporting data
|
|
36
|
+
def fb_get_reporting_list(location_id: nil, list_type: nil, start_date: nil, end_date: nil, campaign_id: nil, type: nil, **_opts)
|
|
37
|
+
request(
|
|
38
|
+
method: :get,
|
|
39
|
+
path: "/ad-publishing/facebook/reporting/list",
|
|
40
|
+
security: ["bearer"],
|
|
41
|
+
params: { "locationId" => location_id, "listType" => list_type, "startDate" => start_date, "endDate" => end_date, "campaignId" => campaign_id, "type" => type }.compact
|
|
42
|
+
)
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
# Get current Facebook user
|
|
46
|
+
#
|
|
47
|
+
# Retrieve the authenticated Facebook user profile for a location
|
|
48
|
+
def fb_get_current_user(location_id: nil, **_opts)
|
|
49
|
+
request(
|
|
50
|
+
method: :get,
|
|
51
|
+
path: "/ad-publishing/facebook/me",
|
|
52
|
+
security: ["bearer"],
|
|
53
|
+
params: { "locationId" => location_id }.compact
|
|
54
|
+
)
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# Get Facebook pages
|
|
58
|
+
#
|
|
59
|
+
# Retrieve Facebook pages associated with the connected account
|
|
60
|
+
def fb_get_pages(location_id: nil, fetch_existing: nil, **_opts)
|
|
61
|
+
request(
|
|
62
|
+
method: :get,
|
|
63
|
+
path: "/ad-publishing/facebook/pages",
|
|
64
|
+
security: ["bearer"],
|
|
65
|
+
params: { "locationId" => location_id, "fetchExisting" => fetch_existing }.compact
|
|
66
|
+
)
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
# Get Instagram accounts for page
|
|
70
|
+
#
|
|
71
|
+
# Retrieve Instagram accounts linked to a specific Facebook page
|
|
72
|
+
def fb_get_instagram_accounts(page_id:, location_id: nil, type: nil, **_opts)
|
|
73
|
+
request(
|
|
74
|
+
method: :get,
|
|
75
|
+
path: "/ad-publishing/facebook/page/#{page_id}/instagram",
|
|
76
|
+
security: ["bearer"],
|
|
77
|
+
params: { "locationId" => location_id, "type" => type }.compact
|
|
78
|
+
)
|
|
79
|
+
end
|
|
80
|
+
|
|
81
|
+
# Get page lead forms
|
|
82
|
+
#
|
|
83
|
+
# Retrieve lead gen forms for a specific Facebook page
|
|
84
|
+
def fb_get_page_lead_forms(page_id:, location_id: nil, **_opts)
|
|
85
|
+
request(
|
|
86
|
+
method: :get,
|
|
87
|
+
path: "/ad-publishing/facebook/page/#{page_id}/forms",
|
|
88
|
+
security: ["bearer"],
|
|
89
|
+
params: { "locationId" => location_id }.compact
|
|
90
|
+
)
|
|
91
|
+
end
|
|
92
|
+
|
|
93
|
+
# Create page lead form
|
|
94
|
+
#
|
|
95
|
+
# Create a new lead gen form on a Facebook page
|
|
96
|
+
def fb_create_page_lead_form(page_id:, body:, **_opts)
|
|
97
|
+
request(
|
|
98
|
+
method: :post,
|
|
99
|
+
path: "/ad-publishing/facebook/page/#{page_id}/forms",
|
|
100
|
+
security: ["bearer"],
|
|
101
|
+
body: body
|
|
102
|
+
)
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
# Get ad accounts
|
|
106
|
+
#
|
|
107
|
+
# Retrieve Facebook ad accounts available for the connected user
|
|
108
|
+
def fb_get_ad_accounts(location_id: nil, type: nil, next_: nil, fetch_all: nil, limit: nil, **_opts)
|
|
109
|
+
request(
|
|
110
|
+
method: :get,
|
|
111
|
+
path: "/ad-publishing/facebook/ad-accounts",
|
|
112
|
+
security: ["bearer"],
|
|
113
|
+
params: { "locationId" => location_id, "type" => type, "next" => next_, "fetchAll" => fetch_all, "limit" => limit }.compact
|
|
114
|
+
)
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
# Get ad account details
|
|
118
|
+
#
|
|
119
|
+
# Retrieve details of a specific Facebook ad account
|
|
120
|
+
def fb_get_ad_account(ad_account_id:, location_id: nil, **_opts)
|
|
121
|
+
request(
|
|
122
|
+
method: :get,
|
|
123
|
+
path: "/ad-publishing/facebook/ad-accounts/#{ad_account_id}",
|
|
124
|
+
security: ["bearer"],
|
|
125
|
+
params: { "locationId" => location_id }.compact
|
|
126
|
+
)
|
|
127
|
+
end
|
|
128
|
+
|
|
129
|
+
# Delete ad account
|
|
130
|
+
#
|
|
131
|
+
# Remove a Facebook ad account connection from a location
|
|
132
|
+
def fb_delete_ad_account(ad_account_id:, body:, **_opts)
|
|
133
|
+
request(
|
|
134
|
+
method: :delete,
|
|
135
|
+
path: "/ad-publishing/facebook/ad-accounts/#{ad_account_id}",
|
|
136
|
+
security: ["bearer"],
|
|
137
|
+
body: body
|
|
138
|
+
)
|
|
139
|
+
end
|
|
140
|
+
|
|
141
|
+
# Get conversation forms
|
|
142
|
+
#
|
|
143
|
+
# Retrieve Facebook conversation lead forms for a location
|
|
144
|
+
def fb_get_conversation_forms(location_id: nil, **_opts)
|
|
145
|
+
request(
|
|
146
|
+
method: :get,
|
|
147
|
+
path: "/ad-publishing/facebook/conversation-forms",
|
|
148
|
+
security: ["bearer"],
|
|
149
|
+
params: { "locationId" => location_id }.compact
|
|
150
|
+
)
|
|
151
|
+
end
|
|
152
|
+
|
|
153
|
+
# Create conversation form
|
|
154
|
+
#
|
|
155
|
+
# Create a new Facebook conversation lead form
|
|
156
|
+
def fb_create_conversation_form(body:, **_opts)
|
|
157
|
+
request(
|
|
158
|
+
method: :post,
|
|
159
|
+
path: "/ad-publishing/facebook/conversation-forms",
|
|
160
|
+
security: ["bearer"],
|
|
161
|
+
body: body
|
|
162
|
+
)
|
|
163
|
+
end
|
|
164
|
+
|
|
165
|
+
# Get Facebook integration
|
|
166
|
+
#
|
|
167
|
+
# Retrieve the Facebook ad integration details for a location
|
|
168
|
+
def fb_get_integration(location_id: nil, **_opts)
|
|
169
|
+
request(
|
|
170
|
+
method: :get,
|
|
171
|
+
path: "/ad-publishing/facebook/integration",
|
|
172
|
+
security: ["bearer"],
|
|
173
|
+
params: { "locationId" => location_id }.compact
|
|
174
|
+
)
|
|
175
|
+
end
|
|
176
|
+
|
|
177
|
+
# Create Facebook integration
|
|
178
|
+
#
|
|
179
|
+
# Create a Facebook ad integration for a location with page and ad account
|
|
180
|
+
def fb_create_integration(body:, **_opts)
|
|
181
|
+
request(
|
|
182
|
+
method: :post,
|
|
183
|
+
path: "/ad-publishing/facebook/integration",
|
|
184
|
+
security: ["bearer"],
|
|
185
|
+
body: body
|
|
186
|
+
)
|
|
187
|
+
end
|
|
188
|
+
|
|
189
|
+
# Delete Facebook integration
|
|
190
|
+
#
|
|
191
|
+
# Remove the Facebook ad integration from a location
|
|
192
|
+
def fb_delete_integration(body:, **_opts)
|
|
193
|
+
request(
|
|
194
|
+
method: :delete,
|
|
195
|
+
path: "/ad-publishing/facebook/integration",
|
|
196
|
+
security: ["bearer"],
|
|
197
|
+
body: body
|
|
198
|
+
)
|
|
199
|
+
end
|
|
200
|
+
|
|
201
|
+
# Search targeting options
|
|
202
|
+
#
|
|
203
|
+
# Search Facebook geo-locations and interests for ad targeting
|
|
204
|
+
def fb_search_targeting(type: nil, query: nil, search_type: nil, **_opts)
|
|
205
|
+
request(
|
|
206
|
+
method: :get,
|
|
207
|
+
path: "/ad-publishing/facebook/targeting/search",
|
|
208
|
+
security: ["bearer"],
|
|
209
|
+
params: { "type" => type, "query" => query, "searchType" => search_type }.compact
|
|
210
|
+
)
|
|
211
|
+
end
|
|
212
|
+
|
|
213
|
+
# Publish campaign
|
|
214
|
+
#
|
|
215
|
+
# Publish a Facebook campaign and push it live to Facebook
|
|
216
|
+
def fb_publish_campaign(campaign_id:, body:, **_opts)
|
|
217
|
+
request(
|
|
218
|
+
method: :post,
|
|
219
|
+
path: "/ad-publishing/facebook/campaigns/#{campaign_id}/publish",
|
|
220
|
+
security: ["bearer"],
|
|
221
|
+
body: body
|
|
222
|
+
)
|
|
223
|
+
end
|
|
224
|
+
|
|
225
|
+
# Delete page connection
|
|
226
|
+
#
|
|
227
|
+
# Remove a Facebook page connection from a location
|
|
228
|
+
def fb_delete_page(location_id: nil, page_id: nil, **_opts)
|
|
229
|
+
request(
|
|
230
|
+
method: :delete,
|
|
231
|
+
path: "/ad-publishing/facebook/page",
|
|
232
|
+
security: ["bearer"],
|
|
233
|
+
params: { "locationId" => location_id, "pageId" => page_id }.compact
|
|
234
|
+
)
|
|
235
|
+
end
|
|
236
|
+
|
|
237
|
+
# Get conversion pixels
|
|
238
|
+
#
|
|
239
|
+
# Retrieve Facebook conversion pixels for a location
|
|
240
|
+
def fb_get_pixels(location_id: nil, channel: nil, page_id: nil, ig_user_id: nil, **_opts)
|
|
241
|
+
request(
|
|
242
|
+
method: :get,
|
|
243
|
+
path: "/ad-publishing/facebook/pixels",
|
|
244
|
+
security: ["bearer"],
|
|
245
|
+
params: { "locationId" => location_id, "channel" => channel, "pageId" => page_id, "igUserId" => ig_user_id }.compact
|
|
246
|
+
)
|
|
247
|
+
end
|
|
248
|
+
|
|
249
|
+
# Upsert conversion pixel
|
|
250
|
+
#
|
|
251
|
+
# Create or update a Facebook conversion pixel configuration
|
|
252
|
+
def fb_upsert_pixel(body:, **_opts)
|
|
253
|
+
request(
|
|
254
|
+
method: :put,
|
|
255
|
+
path: "/ad-publishing/facebook/pixels",
|
|
256
|
+
security: ["bearer"],
|
|
257
|
+
body: body
|
|
258
|
+
)
|
|
259
|
+
end
|
|
260
|
+
|
|
261
|
+
# Get custom audiences
|
|
262
|
+
#
|
|
263
|
+
# Retrieve Facebook custom audiences for a location
|
|
264
|
+
def fb_get_custom_audiences(location_id: nil, type: nil, source: nil, ad_account_id: nil, **_opts)
|
|
265
|
+
request(
|
|
266
|
+
method: :get,
|
|
267
|
+
path: "/ad-publishing/facebook/custom-audience",
|
|
268
|
+
security: ["bearer"],
|
|
269
|
+
params: { "locationId" => location_id, "type" => type, "source" => source, "adAccountId" => ad_account_id }.compact
|
|
270
|
+
)
|
|
271
|
+
end
|
|
272
|
+
|
|
273
|
+
# Get custom audience by ID
|
|
274
|
+
#
|
|
275
|
+
# Retrieve a specific Facebook custom audience by its ID
|
|
276
|
+
def fb_get_custom_audience_by_id(audience_id:, location_id: nil, **_opts)
|
|
277
|
+
request(
|
|
278
|
+
method: :get,
|
|
279
|
+
path: "/ad-publishing/facebook/custom-audience/#{audience_id}",
|
|
280
|
+
security: ["bearer"],
|
|
281
|
+
params: { "locationId" => location_id }.compact
|
|
282
|
+
)
|
|
283
|
+
end
|
|
284
|
+
|
|
285
|
+
# Update custom audience
|
|
286
|
+
#
|
|
287
|
+
# Update name or description of a Facebook custom audience
|
|
288
|
+
def fb_update_custom_audience(audience_id:, body:, **_opts)
|
|
289
|
+
request(
|
|
290
|
+
method: :put,
|
|
291
|
+
path: "/ad-publishing/facebook/custom-audience/#{audience_id}",
|
|
292
|
+
security: ["bearer"],
|
|
293
|
+
body: body
|
|
294
|
+
)
|
|
295
|
+
end
|
|
296
|
+
|
|
297
|
+
# Delete custom audience
|
|
298
|
+
#
|
|
299
|
+
# Delete a Facebook custom audience by ID
|
|
300
|
+
def fb_delete_custom_audience(audience_id:, location_id: nil, **_opts)
|
|
301
|
+
request(
|
|
302
|
+
method: :delete,
|
|
303
|
+
path: "/ad-publishing/facebook/custom-audience/#{audience_id}",
|
|
304
|
+
security: ["bearer"],
|
|
305
|
+
params: { "locationId" => location_id }.compact
|
|
306
|
+
)
|
|
307
|
+
end
|
|
308
|
+
|
|
309
|
+
# Add custom audience member
|
|
310
|
+
#
|
|
311
|
+
# Add a member to a Facebook custom audience
|
|
312
|
+
def fb_add_custom_audience_member(audience_id:, body:, **_opts)
|
|
313
|
+
request(
|
|
314
|
+
method: :put,
|
|
315
|
+
path: "/ad-publishing/facebook/custom-audience/#{audience_id}/member",
|
|
316
|
+
security: ["bearer"],
|
|
317
|
+
body: body
|
|
318
|
+
)
|
|
319
|
+
end
|
|
320
|
+
|
|
321
|
+
# Remove custom audience member
|
|
322
|
+
#
|
|
323
|
+
# Remove a member from a Facebook custom audience
|
|
324
|
+
def fb_remove_custom_audience_member(audience_id:, body:, **_opts)
|
|
325
|
+
request(
|
|
326
|
+
method: :delete,
|
|
327
|
+
path: "/ad-publishing/facebook/custom-audience/#{audience_id}/member",
|
|
328
|
+
security: ["bearer"],
|
|
329
|
+
body: body
|
|
330
|
+
)
|
|
331
|
+
end
|
|
332
|
+
|
|
333
|
+
# Batch update audience members
|
|
334
|
+
#
|
|
335
|
+
# Add or remove members in bulk from a Facebook custom audience via CSV or smart lists
|
|
336
|
+
def fb_batch_update_audience_members(audience_id:, body:, **_opts)
|
|
337
|
+
request(
|
|
338
|
+
method: :put,
|
|
339
|
+
path: "/ad-publishing/facebook/custom-audience/#{audience_id}/member/batch",
|
|
340
|
+
security: ["bearer"],
|
|
341
|
+
body: body
|
|
342
|
+
)
|
|
343
|
+
end
|
|
344
|
+
|
|
345
|
+
# Set default page
|
|
346
|
+
#
|
|
347
|
+
# Set the default Facebook page for a location
|
|
348
|
+
def fb_set_default_page(body:, location_id: nil, **_opts)
|
|
349
|
+
request(
|
|
350
|
+
method: :put,
|
|
351
|
+
path: "/ad-publishing/facebook/page/default",
|
|
352
|
+
security: ["bearer"],
|
|
353
|
+
params: { "locationId" => location_id }.compact,
|
|
354
|
+
body: body
|
|
355
|
+
)
|
|
356
|
+
end
|
|
357
|
+
|
|
358
|
+
# Get lead form by ID
|
|
359
|
+
#
|
|
360
|
+
# Retrieve a specific Facebook lead form by its ID
|
|
361
|
+
def fb_get_lead_form(lead_form_id:, location_id: nil, **_opts)
|
|
362
|
+
request(
|
|
363
|
+
method: :get,
|
|
364
|
+
path: "/ad-publishing/facebook/lead-form/#{lead_form_id}",
|
|
365
|
+
security: ["bearer"],
|
|
366
|
+
params: { "locationId" => location_id }.compact
|
|
367
|
+
)
|
|
368
|
+
end
|
|
369
|
+
|
|
370
|
+
# Get campaign with linked entities
|
|
371
|
+
#
|
|
372
|
+
# Retrieve a Facebook campaign with its linked adsets and ads
|
|
373
|
+
def fb_get_campaign(campaign_id:, location_id: nil, fields: nil, source: nil, **_opts)
|
|
374
|
+
request(
|
|
375
|
+
method: :get,
|
|
376
|
+
path: "/ad-publishing/facebook/campaign/#{campaign_id}",
|
|
377
|
+
security: ["bearer"],
|
|
378
|
+
params: { "locationId" => location_id, "fields" => fields, "source" => source }.compact
|
|
379
|
+
)
|
|
380
|
+
end
|
|
381
|
+
|
|
382
|
+
# Get entities
|
|
383
|
+
#
|
|
384
|
+
# Retrieve Facebook campaigns, adsets, or ads based on entity type
|
|
385
|
+
def fb_get_entity(location_id: nil, type: nil, next_: nil, fetch_all: nil, campaign_id: nil, ad_set_id: nil, entity_type: nil, search_id: nil, selected_ad_account_id: nil, **_opts)
|
|
386
|
+
request(
|
|
387
|
+
method: :get,
|
|
388
|
+
path: "/ad-publishing/facebook/entity",
|
|
389
|
+
security: ["bearer"],
|
|
390
|
+
params: { "locationId" => location_id, "type" => type, "next" => next_, "fetchAll" => fetch_all, "campaignId" => campaign_id, "adSetId" => ad_set_id, "entityType" => entity_type, "searchId" => search_id, "selectedAdAccountId" => selected_ad_account_id }.compact
|
|
391
|
+
)
|
|
392
|
+
end
|
|
393
|
+
|
|
394
|
+
# Upsert campaign
|
|
395
|
+
#
|
|
396
|
+
# Create or update a Facebook campaign
|
|
397
|
+
def fb_upsert_campaign(body:, **_opts)
|
|
398
|
+
request(
|
|
399
|
+
method: :put,
|
|
400
|
+
path: "/ad-publishing/facebook/campaigns",
|
|
401
|
+
security: ["bearer"],
|
|
402
|
+
body: body
|
|
403
|
+
)
|
|
404
|
+
end
|
|
405
|
+
|
|
406
|
+
# Upsert adset
|
|
407
|
+
#
|
|
408
|
+
# Create or update a Facebook ad set
|
|
409
|
+
def fb_upsert_adset(body:, **_opts)
|
|
410
|
+
request(
|
|
411
|
+
method: :put,
|
|
412
|
+
path: "/ad-publishing/facebook/adsets",
|
|
413
|
+
security: ["bearer"],
|
|
414
|
+
body: body
|
|
415
|
+
)
|
|
416
|
+
end
|
|
417
|
+
|
|
418
|
+
# Upsert ad
|
|
419
|
+
#
|
|
420
|
+
# Create or update a Facebook ad (v2)
|
|
421
|
+
def fb_upsert_ad(body:, **_opts)
|
|
422
|
+
request(
|
|
423
|
+
method: :put,
|
|
424
|
+
path: "/ad-publishing/facebook/ads-v2",
|
|
425
|
+
security: ["bearer"],
|
|
426
|
+
body: body
|
|
427
|
+
)
|
|
428
|
+
end
|
|
429
|
+
|
|
430
|
+
# Pause campaign
|
|
431
|
+
#
|
|
432
|
+
# Pause a running Facebook campaign
|
|
433
|
+
def fb_pause_campaign(campaign_id:, body:, **_opts)
|
|
434
|
+
request(
|
|
435
|
+
method: :post,
|
|
436
|
+
path: "/ad-publishing/facebook/campaigns/#{campaign_id}/pause",
|
|
437
|
+
security: ["bearer"],
|
|
438
|
+
body: body
|
|
439
|
+
)
|
|
440
|
+
end
|
|
441
|
+
|
|
442
|
+
# Resume campaign
|
|
443
|
+
#
|
|
444
|
+
# Resume a paused Facebook campaign
|
|
445
|
+
def fb_resume_campaign(campaign_id:, body:, **_opts)
|
|
446
|
+
request(
|
|
447
|
+
method: :post,
|
|
448
|
+
path: "/ad-publishing/facebook/campaigns/#{campaign_id}/resume",
|
|
449
|
+
security: ["bearer"],
|
|
450
|
+
body: body
|
|
451
|
+
)
|
|
452
|
+
end
|
|
453
|
+
|
|
454
|
+
# Duplicate campaign
|
|
455
|
+
#
|
|
456
|
+
# Duplicate an existing Facebook campaign
|
|
457
|
+
def fb_duplicate_campaign(campaign_id:, body:, **_opts)
|
|
458
|
+
request(
|
|
459
|
+
method: :post,
|
|
460
|
+
path: "/ad-publishing/facebook/campaigns/#{campaign_id}/duplicate",
|
|
461
|
+
security: ["bearer"],
|
|
462
|
+
body: body
|
|
463
|
+
)
|
|
464
|
+
end
|
|
465
|
+
|
|
466
|
+
# Delete campaign
|
|
467
|
+
#
|
|
468
|
+
# Delete a Facebook campaign by ID
|
|
469
|
+
def fb_delete_campaign(campaign_id:, body:, **_opts)
|
|
470
|
+
request(
|
|
471
|
+
method: :delete,
|
|
472
|
+
path: "/ad-publishing/facebook/campaigns/#{campaign_id}",
|
|
473
|
+
security: ["bearer"],
|
|
474
|
+
body: body
|
|
475
|
+
)
|
|
476
|
+
end
|
|
477
|
+
|
|
478
|
+
# Pause ad set
|
|
479
|
+
#
|
|
480
|
+
# Pause a running Facebook ad set
|
|
481
|
+
def fb_pause_adset(adset_id:, body:, **_opts)
|
|
482
|
+
request(
|
|
483
|
+
method: :post,
|
|
484
|
+
path: "/ad-publishing/facebook/adsets/#{adset_id}/pause",
|
|
485
|
+
security: ["bearer"],
|
|
486
|
+
body: body
|
|
487
|
+
)
|
|
488
|
+
end
|
|
489
|
+
|
|
490
|
+
# Resume ad set
|
|
491
|
+
#
|
|
492
|
+
# Resume a paused Facebook ad set
|
|
493
|
+
def fb_resume_adset(adset_id:, body:, **_opts)
|
|
494
|
+
request(
|
|
495
|
+
method: :post,
|
|
496
|
+
path: "/ad-publishing/facebook/adsets/#{adset_id}/resume",
|
|
497
|
+
security: ["bearer"],
|
|
498
|
+
body: body
|
|
499
|
+
)
|
|
500
|
+
end
|
|
501
|
+
|
|
502
|
+
# Duplicate ad set
|
|
503
|
+
#
|
|
504
|
+
# Duplicate an existing Facebook ad set
|
|
505
|
+
def fb_duplicate_adset(adset_id:, **_opts)
|
|
506
|
+
request(
|
|
507
|
+
method: :post,
|
|
508
|
+
path: "/ad-publishing/facebook/adsets/#{adset_id}/duplicate",
|
|
509
|
+
security: ["bearer"]
|
|
510
|
+
)
|
|
511
|
+
end
|
|
512
|
+
|
|
513
|
+
# Delete ad set
|
|
514
|
+
#
|
|
515
|
+
# Delete a Facebook ad set by ID
|
|
516
|
+
def fb_delete_adset(adset_id:, body:, **_opts)
|
|
517
|
+
request(
|
|
518
|
+
method: :delete,
|
|
519
|
+
path: "/ad-publishing/facebook/adsets/#{adset_id}",
|
|
520
|
+
security: ["bearer"],
|
|
521
|
+
body: body
|
|
522
|
+
)
|
|
523
|
+
end
|
|
524
|
+
|
|
525
|
+
# Pause ad
|
|
526
|
+
#
|
|
527
|
+
# Pause a running Facebook ad
|
|
528
|
+
def fb_pause_ad(ad_id:, body:, **_opts)
|
|
529
|
+
request(
|
|
530
|
+
method: :post,
|
|
531
|
+
path: "/ad-publishing/facebook/ads/#{ad_id}/pause",
|
|
532
|
+
security: ["bearer"],
|
|
533
|
+
body: body
|
|
534
|
+
)
|
|
535
|
+
end
|
|
536
|
+
|
|
537
|
+
# Resume ad
|
|
538
|
+
#
|
|
539
|
+
# Resume a paused Facebook ad
|
|
540
|
+
def fb_resume_ad(ad_id:, body:, **_opts)
|
|
541
|
+
request(
|
|
542
|
+
method: :post,
|
|
543
|
+
path: "/ad-publishing/facebook/ads/#{ad_id}/resume",
|
|
544
|
+
security: ["bearer"],
|
|
545
|
+
body: body
|
|
546
|
+
)
|
|
547
|
+
end
|
|
548
|
+
|
|
549
|
+
# Duplicate ad
|
|
550
|
+
#
|
|
551
|
+
# Duplicate an existing Facebook ad
|
|
552
|
+
def fb_duplicate_ad(ad_id:, **_opts)
|
|
553
|
+
request(
|
|
554
|
+
method: :post,
|
|
555
|
+
path: "/ad-publishing/facebook/ads/#{ad_id}/duplicate",
|
|
556
|
+
security: ["bearer"]
|
|
557
|
+
)
|
|
558
|
+
end
|
|
559
|
+
|
|
560
|
+
# Delete ad
|
|
561
|
+
#
|
|
562
|
+
# Delete a Facebook ad by ID
|
|
563
|
+
def fb_delete_ad(ad_id:, body:, **_opts)
|
|
564
|
+
request(
|
|
565
|
+
method: :delete,
|
|
566
|
+
path: "/ad-publishing/facebook/ads/#{ad_id}",
|
|
567
|
+
security: ["bearer"],
|
|
568
|
+
body: body
|
|
569
|
+
)
|
|
570
|
+
end
|
|
571
|
+
|
|
572
|
+
# Get reporting data
|
|
573
|
+
#
|
|
574
|
+
# Retrieve aggregated Google Ads reporting metrics for a location
|
|
575
|
+
def google_get_reporting(location_id: nil, group_by: nil, start_date: nil, end_date: nil, type: nil, fields: nil, **_opts)
|
|
576
|
+
request(
|
|
577
|
+
method: :get,
|
|
578
|
+
path: "/ad-publishing/google/reporting",
|
|
579
|
+
security: ["bearer"],
|
|
580
|
+
params: { "locationId" => location_id, "groupBy" => group_by, "startDate" => start_date, "endDate" => end_date, "type" => type, "fields" => fields }.compact
|
|
581
|
+
)
|
|
582
|
+
end
|
|
583
|
+
|
|
584
|
+
# Get reporting list
|
|
585
|
+
#
|
|
586
|
+
# Retrieve a list of Google campaigns or ad groups with reporting data
|
|
587
|
+
def google_get_reporting_list(location_id: nil, list_type: nil, start_date: nil, end_date: nil, campaign_id: nil, type: nil, **_opts)
|
|
588
|
+
request(
|
|
589
|
+
method: :get,
|
|
590
|
+
path: "/ad-publishing/google/reporting/list",
|
|
591
|
+
security: ["bearer"],
|
|
592
|
+
params: { "locationId" => location_id, "listType" => list_type, "startDate" => start_date, "endDate" => end_date, "campaignId" => campaign_id, "type" => type }.compact
|
|
593
|
+
)
|
|
594
|
+
end
|
|
595
|
+
|
|
596
|
+
# Get campaign reporting
|
|
597
|
+
#
|
|
598
|
+
# Retrieve reporting metrics for a specific Google campaign
|
|
599
|
+
def google_get_campaign_reporting(campaign_id:, location_id: nil, start_date: nil, end_date: nil, **_opts)
|
|
600
|
+
request(
|
|
601
|
+
method: :get,
|
|
602
|
+
path: "/ad-publishing/google/reporting/campaign/#{campaign_id}",
|
|
603
|
+
security: ["bearer"],
|
|
604
|
+
params: { "locationId" => location_id, "startDate" => start_date, "endDate" => end_date }.compact
|
|
605
|
+
)
|
|
606
|
+
end
|
|
607
|
+
|
|
608
|
+
# Get conversions
|
|
609
|
+
#
|
|
610
|
+
# Retrieve Google Ads conversion actions for a location
|
|
611
|
+
def google_get_conversions(location_id: nil, type: nil, conversion_type: nil, category: nil, start_date: nil, end_date: nil, **_opts)
|
|
612
|
+
request(
|
|
613
|
+
method: :get,
|
|
614
|
+
path: "/ad-publishing/google/conversions",
|
|
615
|
+
security: ["bearer"],
|
|
616
|
+
params: { "locationId" => location_id, "type" => type, "conversionType" => conversion_type, "category" => category, "startDate" => start_date, "endDate" => end_date }.compact
|
|
617
|
+
)
|
|
618
|
+
end
|
|
619
|
+
|
|
620
|
+
# Upsert conversion
|
|
621
|
+
#
|
|
622
|
+
# Create or update a Google Ads conversion action
|
|
623
|
+
def google_upsert_conversion(body:, **_opts)
|
|
624
|
+
request(
|
|
625
|
+
method: :put,
|
|
626
|
+
path: "/ad-publishing/google/conversions",
|
|
627
|
+
security: ["bearer"],
|
|
628
|
+
body: body
|
|
629
|
+
)
|
|
630
|
+
end
|
|
631
|
+
|
|
632
|
+
# Get conversion by ID
|
|
633
|
+
#
|
|
634
|
+
# Retrieve a specific Google Ads conversion action by ID
|
|
635
|
+
def google_get_conversion_by_id(conversion_id:, location_id: nil, **_opts)
|
|
636
|
+
request(
|
|
637
|
+
method: :get,
|
|
638
|
+
path: "/ad-publishing/google/conversions/#{conversion_id}",
|
|
639
|
+
security: ["bearer"],
|
|
640
|
+
params: { "locationId" => location_id }.compact
|
|
641
|
+
)
|
|
642
|
+
end
|
|
643
|
+
|
|
644
|
+
# Delete conversion
|
|
645
|
+
#
|
|
646
|
+
# Delete a Google Ads conversion action by ID
|
|
647
|
+
def google_delete_conversion(conversion_id:, location_id: nil, **_opts)
|
|
648
|
+
request(
|
|
649
|
+
method: :delete,
|
|
650
|
+
path: "/ad-publishing/google/conversions/#{conversion_id}",
|
|
651
|
+
security: ["bearer"],
|
|
652
|
+
params: { "locationId" => location_id }.compact
|
|
653
|
+
)
|
|
654
|
+
end
|
|
655
|
+
|
|
656
|
+
# Get Google integration
|
|
657
|
+
#
|
|
658
|
+
# Retrieve the Google Ads integration details for a location
|
|
659
|
+
def google_get_integration(location_id: nil, **_opts)
|
|
660
|
+
request(
|
|
661
|
+
method: :get,
|
|
662
|
+
path: "/ad-publishing/google/integration",
|
|
663
|
+
security: ["bearer"],
|
|
664
|
+
params: { "locationId" => location_id }.compact
|
|
665
|
+
)
|
|
666
|
+
end
|
|
667
|
+
|
|
668
|
+
# Create Google integration
|
|
669
|
+
#
|
|
670
|
+
# Create a Google Ads integration for a location
|
|
671
|
+
def google_create_integration(body:, **_opts)
|
|
672
|
+
request(
|
|
673
|
+
method: :post,
|
|
674
|
+
path: "/ad-publishing/google/integration",
|
|
675
|
+
security: ["bearer"],
|
|
676
|
+
body: body
|
|
677
|
+
)
|
|
678
|
+
end
|
|
679
|
+
|
|
680
|
+
# Get current Google user
|
|
681
|
+
#
|
|
682
|
+
# Retrieve the authenticated Google user info for a location
|
|
683
|
+
def google_get_current_user(location_id: nil, **_opts)
|
|
684
|
+
request(
|
|
685
|
+
method: :get,
|
|
686
|
+
path: "/ad-publishing/google/me",
|
|
687
|
+
security: ["bearer"],
|
|
688
|
+
params: { "locationId" => location_id }.compact
|
|
689
|
+
)
|
|
690
|
+
end
|
|
691
|
+
|
|
692
|
+
# Get Google ad accounts
|
|
693
|
+
#
|
|
694
|
+
# Retrieve Google Ads accounts available for the connected user
|
|
695
|
+
def google_get_ad_accounts(location_id: nil, type: nil, **_opts)
|
|
696
|
+
request(
|
|
697
|
+
method: :get,
|
|
698
|
+
path: "/ad-publishing/google/ad-accounts",
|
|
699
|
+
security: ["bearer"],
|
|
700
|
+
params: { "locationId" => location_id, "type" => type }.compact
|
|
701
|
+
)
|
|
702
|
+
end
|
|
703
|
+
|
|
704
|
+
# Get ad account details
|
|
705
|
+
#
|
|
706
|
+
# Retrieve details of a specific Google Ads account
|
|
707
|
+
def google_get_ad_account_details(ad_account_id:, location_id: nil, **_opts)
|
|
708
|
+
request(
|
|
709
|
+
method: :get,
|
|
710
|
+
path: "/ad-publishing/google/ad-accounts/#{ad_account_id}",
|
|
711
|
+
security: ["bearer"],
|
|
712
|
+
params: { "locationId" => location_id }.compact
|
|
713
|
+
)
|
|
714
|
+
end
|
|
715
|
+
|
|
716
|
+
# Delete ad account
|
|
717
|
+
#
|
|
718
|
+
# Remove a Google Ads account connection from a location
|
|
719
|
+
def google_delete_ad_account(ad_account_id:, body:, **_opts)
|
|
720
|
+
request(
|
|
721
|
+
method: :delete,
|
|
722
|
+
path: "/ad-publishing/google/ad-accounts/#{ad_account_id}",
|
|
723
|
+
security: ["bearer"],
|
|
724
|
+
body: body
|
|
725
|
+
)
|
|
726
|
+
end
|
|
727
|
+
|
|
728
|
+
# Publish ad
|
|
729
|
+
#
|
|
730
|
+
# Publish a Google ad and push it live
|
|
731
|
+
def google_publish_ad(ad_id:, **_opts)
|
|
732
|
+
request(
|
|
733
|
+
method: :post,
|
|
734
|
+
path: "/ad-publishing/google/ads/#{ad_id}/publish",
|
|
735
|
+
security: ["bearer"]
|
|
736
|
+
)
|
|
737
|
+
end
|
|
738
|
+
|
|
739
|
+
# Search targeting options
|
|
740
|
+
#
|
|
741
|
+
# Search Google geo-locations for ad targeting
|
|
742
|
+
def google_search_targeting(type: nil, query: nil, location_id: nil, **_opts)
|
|
743
|
+
request(
|
|
744
|
+
method: :get,
|
|
745
|
+
path: "/ad-publishing/google/targeting/search",
|
|
746
|
+
security: ["bearer"],
|
|
747
|
+
params: { "type" => type, "query" => query, "locationId" => location_id }.compact
|
|
748
|
+
)
|
|
749
|
+
end
|
|
750
|
+
|
|
751
|
+
# Get keyword ideas
|
|
752
|
+
#
|
|
753
|
+
# Retrieve keyword suggestions for Google Ads campaigns
|
|
754
|
+
def google_get_keyword_ideas(body:, location_id: nil, **_opts)
|
|
755
|
+
request(
|
|
756
|
+
method: :post,
|
|
757
|
+
path: "/ad-publishing/google/keyword-ideas",
|
|
758
|
+
security: ["bearer"],
|
|
759
|
+
params: { "locationId" => location_id }.compact,
|
|
760
|
+
body: body
|
|
761
|
+
)
|
|
762
|
+
end
|
|
763
|
+
|
|
764
|
+
# Get assets
|
|
765
|
+
#
|
|
766
|
+
# Retrieve Google Ads creative assets for a location
|
|
767
|
+
def google_get_assets(location_id: nil, type: nil, id: nil, advertiser_only: nil, **_opts)
|
|
768
|
+
request(
|
|
769
|
+
method: :get,
|
|
770
|
+
path: "/ad-publishing/google/assets",
|
|
771
|
+
security: ["bearer"],
|
|
772
|
+
params: { "locationId" => location_id, "type" => type, "id" => id, "advertiserOnly" => advertiser_only }.compact
|
|
773
|
+
)
|
|
774
|
+
end
|
|
775
|
+
|
|
776
|
+
# Upsert assets
|
|
777
|
+
#
|
|
778
|
+
# Create or update Google Ads creative assets
|
|
779
|
+
def google_upsert_assets(body:, **_opts)
|
|
780
|
+
request(
|
|
781
|
+
method: :post,
|
|
782
|
+
path: "/ad-publishing/google/assets",
|
|
783
|
+
security: ["bearer"],
|
|
784
|
+
body: body
|
|
785
|
+
)
|
|
786
|
+
end
|
|
787
|
+
|
|
788
|
+
# Get entities
|
|
789
|
+
#
|
|
790
|
+
# Retrieve Google campaigns, ad groups, or ads based on entity type
|
|
791
|
+
def google_get_entity(location_id: nil, type: nil, campaign_id: nil, ad_group_id: nil, entity_type: nil, search_id: nil, start_date: nil, end_date: nil, selected_ad_account_id: nil, **_opts)
|
|
792
|
+
request(
|
|
793
|
+
method: :get,
|
|
794
|
+
path: "/ad-publishing/google/entity",
|
|
795
|
+
security: ["bearer"],
|
|
796
|
+
params: { "locationId" => location_id, "type" => type, "campaignId" => campaign_id, "adGroupId" => ad_group_id, "entityType" => entity_type, "searchId" => search_id, "startDate" => start_date, "endDate" => end_date, "selectedAdAccountId" => selected_ad_account_id }.compact
|
|
797
|
+
)
|
|
798
|
+
end
|
|
799
|
+
|
|
800
|
+
# Get target interests
|
|
801
|
+
#
|
|
802
|
+
# Retrieve affinity and in-market audience options for Google Ads targeting
|
|
803
|
+
def google_get_target_interests(location_id: nil, type: nil, advertising_channel_type: nil, **_opts)
|
|
804
|
+
request(
|
|
805
|
+
method: :get,
|
|
806
|
+
path: "/ad-publishing/google/target-interests",
|
|
807
|
+
security: ["bearer"],
|
|
808
|
+
params: { "locationId" => location_id, "type" => type, "advertisingChannelType" => advertising_channel_type }.compact
|
|
809
|
+
)
|
|
810
|
+
end
|
|
811
|
+
|
|
812
|
+
# Get segments
|
|
813
|
+
#
|
|
814
|
+
# Retrieve Google Ads audience segments for a location
|
|
815
|
+
def google_get_segments(location_id: nil, type: nil, **_opts)
|
|
816
|
+
request(
|
|
817
|
+
method: :get,
|
|
818
|
+
path: "/ad-publishing/google/segments",
|
|
819
|
+
security: ["bearer"],
|
|
820
|
+
params: { "locationId" => location_id, "type" => type }.compact
|
|
821
|
+
)
|
|
822
|
+
end
|
|
823
|
+
|
|
824
|
+
# Upsert segment
|
|
825
|
+
#
|
|
826
|
+
# Create or update a Google Ads audience segment
|
|
827
|
+
def google_upsert_segment(body:, location_id: nil, type: nil, **_opts)
|
|
828
|
+
request(
|
|
829
|
+
method: :put,
|
|
830
|
+
path: "/ad-publishing/google/segments",
|
|
831
|
+
security: ["bearer"],
|
|
832
|
+
params: { "locationId" => location_id, "type" => type }.compact,
|
|
833
|
+
body: body
|
|
834
|
+
)
|
|
835
|
+
end
|
|
836
|
+
|
|
837
|
+
# Get segment by ID
|
|
838
|
+
#
|
|
839
|
+
# Retrieve a specific Google Ads audience segment by ID
|
|
840
|
+
def google_get_segment_by_id(segment_id:, location_id: nil, type: nil, **_opts)
|
|
841
|
+
request(
|
|
842
|
+
method: :get,
|
|
843
|
+
path: "/ad-publishing/google/segments/#{segment_id}",
|
|
844
|
+
security: ["bearer"],
|
|
845
|
+
params: { "locationId" => location_id, "type" => type }.compact
|
|
846
|
+
)
|
|
847
|
+
end
|
|
848
|
+
|
|
849
|
+
# Delete segment
|
|
850
|
+
#
|
|
851
|
+
# Delete a Google Ads audience segment by ID
|
|
852
|
+
def google_delete_segment(segment_id:, location_id: nil, type: nil, **_opts)
|
|
853
|
+
request(
|
|
854
|
+
method: :delete,
|
|
855
|
+
path: "/ad-publishing/google/segments/#{segment_id}",
|
|
856
|
+
security: ["bearer"],
|
|
857
|
+
params: { "locationId" => location_id, "type" => type }.compact
|
|
858
|
+
)
|
|
859
|
+
end
|
|
860
|
+
|
|
861
|
+
# Create offline user list job
|
|
862
|
+
#
|
|
863
|
+
# Create a job to upload users to a Google customer match list
|
|
864
|
+
def google_create_offline_user_list_job(body:, **_opts)
|
|
865
|
+
request(
|
|
866
|
+
method: :post,
|
|
867
|
+
path: "/ad-publishing/google/segments/offline-user-list-job",
|
|
868
|
+
security: ["bearer"],
|
|
869
|
+
body: body
|
|
870
|
+
)
|
|
871
|
+
end
|
|
872
|
+
|
|
873
|
+
# Get audiences
|
|
874
|
+
#
|
|
875
|
+
# Retrieve Google Ads combined audiences for a location
|
|
876
|
+
def google_get_audiences(location_id: nil, **_opts)
|
|
877
|
+
request(
|
|
878
|
+
method: :get,
|
|
879
|
+
path: "/ad-publishing/google/audiences",
|
|
880
|
+
security: ["bearer"],
|
|
881
|
+
params: { "locationId" => location_id }.compact
|
|
882
|
+
)
|
|
883
|
+
end
|
|
884
|
+
|
|
885
|
+
# Upsert audience
|
|
886
|
+
#
|
|
887
|
+
# Create or update a Google Ads combined audience
|
|
888
|
+
def google_upsert_audience(body:, **_opts)
|
|
889
|
+
request(
|
|
890
|
+
method: :put,
|
|
891
|
+
path: "/ad-publishing/google/audiences",
|
|
892
|
+
security: ["bearer"],
|
|
893
|
+
body: body
|
|
894
|
+
)
|
|
895
|
+
end
|
|
896
|
+
|
|
897
|
+
# Get audience by ID
|
|
898
|
+
#
|
|
899
|
+
# Retrieve a specific Google Ads combined audience by ID
|
|
900
|
+
def google_get_audience_by_id(audience_id:, location_id: nil, **_opts)
|
|
901
|
+
request(
|
|
902
|
+
method: :get,
|
|
903
|
+
path: "/ad-publishing/google/audiences/#{audience_id}",
|
|
904
|
+
security: ["bearer"],
|
|
905
|
+
params: { "locationId" => location_id }.compact
|
|
906
|
+
)
|
|
907
|
+
end
|
|
908
|
+
|
|
909
|
+
# Upsert Google campaign
|
|
910
|
+
#
|
|
911
|
+
# Create or update a full Google Ads campaign structure
|
|
912
|
+
def google_upsert_campaign(body:, **_opts)
|
|
913
|
+
request(
|
|
914
|
+
method: :put,
|
|
915
|
+
path: "/ad-publishing/google/ads",
|
|
916
|
+
security: ["bearer"],
|
|
917
|
+
body: body
|
|
918
|
+
)
|
|
919
|
+
end
|
|
920
|
+
|
|
921
|
+
# Get Google campaign by ID
|
|
922
|
+
#
|
|
923
|
+
# Retrieve a specific Google Ads campaign by ID
|
|
924
|
+
def google_get_campaign_by_id(ad_id:, location_id: nil, **_opts)
|
|
925
|
+
request(
|
|
926
|
+
method: :get,
|
|
927
|
+
path: "/ad-publishing/google/ads/#{ad_id}",
|
|
928
|
+
security: ["bearer"],
|
|
929
|
+
params: { "locationId" => location_id }.compact
|
|
930
|
+
)
|
|
931
|
+
end
|
|
932
|
+
|
|
933
|
+
# Get conversion goals
|
|
934
|
+
#
|
|
935
|
+
# Retrieve Google Ads conversion goals for a location
|
|
936
|
+
def google_get_conversion_goals(location_id: nil, **_opts)
|
|
937
|
+
request(
|
|
938
|
+
method: :get,
|
|
939
|
+
path: "/ad-publishing/google/conversion-goals",
|
|
940
|
+
security: ["bearer"],
|
|
941
|
+
params: { "locationId" => location_id }.compact
|
|
942
|
+
)
|
|
943
|
+
end
|
|
944
|
+
|
|
945
|
+
# Get LinkedIn integration
|
|
946
|
+
#
|
|
947
|
+
# Retrieve the LinkedIn Ads integration details for a location
|
|
948
|
+
def li_get_integration(location_id: nil, **_opts)
|
|
949
|
+
request(
|
|
950
|
+
method: :get,
|
|
951
|
+
path: "/ad-publishing/linkedin/integration",
|
|
952
|
+
security: ["bearer"],
|
|
953
|
+
params: { "locationId" => location_id }.compact
|
|
954
|
+
)
|
|
955
|
+
end
|
|
956
|
+
|
|
957
|
+
# Create LinkedIn integration
|
|
958
|
+
#
|
|
959
|
+
# Create a LinkedIn Ads integration for a location with ad account details
|
|
960
|
+
def li_create_integration(body:, **_opts)
|
|
961
|
+
request(
|
|
962
|
+
method: :post,
|
|
963
|
+
path: "/ad-publishing/linkedin/integration",
|
|
964
|
+
security: ["bearer"],
|
|
965
|
+
body: body
|
|
966
|
+
)
|
|
967
|
+
end
|
|
968
|
+
|
|
969
|
+
# Get LinkedIn ad accounts
|
|
970
|
+
#
|
|
971
|
+
# Retrieve LinkedIn Ads accounts available for the connected user
|
|
972
|
+
def li_get_ad_accounts(location_id: nil, **_opts)
|
|
973
|
+
request(
|
|
974
|
+
method: :get,
|
|
975
|
+
path: "/ad-publishing/linkedin/ad-accounts",
|
|
976
|
+
security: ["bearer"],
|
|
977
|
+
params: { "locationId" => location_id }.compact
|
|
978
|
+
)
|
|
979
|
+
end
|
|
980
|
+
|
|
981
|
+
# Get ad account details
|
|
982
|
+
#
|
|
983
|
+
# Retrieve details of a specific LinkedIn ad account
|
|
984
|
+
def li_get_ad_account_details(location_id: nil, ad_account_id: nil, **_opts)
|
|
985
|
+
request(
|
|
986
|
+
method: :get,
|
|
987
|
+
path: "/ad-publishing/linkedin/ad-account",
|
|
988
|
+
security: ["bearer"],
|
|
989
|
+
params: { "locationId" => location_id, "adAccountId" => ad_account_id }.compact
|
|
990
|
+
)
|
|
991
|
+
end
|
|
992
|
+
|
|
993
|
+
# Delete ad account
|
|
994
|
+
#
|
|
995
|
+
# Remove a LinkedIn ad account connection from a location
|
|
996
|
+
def li_delete_ad_account(location_id: nil, ad_account_id: nil, **_opts)
|
|
997
|
+
request(
|
|
998
|
+
method: :delete,
|
|
999
|
+
path: "/ad-publishing/linkedin/ad-account",
|
|
1000
|
+
security: ["bearer"],
|
|
1001
|
+
params: { "locationId" => location_id, "adAccountId" => ad_account_id }.compact
|
|
1002
|
+
)
|
|
1003
|
+
end
|
|
1004
|
+
|
|
1005
|
+
# Get current LinkedIn user
|
|
1006
|
+
#
|
|
1007
|
+
# Retrieve the authenticated LinkedIn user info for a location
|
|
1008
|
+
def li_get_current_user(location_id: nil, **_opts)
|
|
1009
|
+
request(
|
|
1010
|
+
method: :get,
|
|
1011
|
+
path: "/ad-publishing/linkedin/me",
|
|
1012
|
+
security: ["bearer"],
|
|
1013
|
+
params: { "locationId" => location_id }.compact
|
|
1014
|
+
)
|
|
1015
|
+
end
|
|
1016
|
+
|
|
1017
|
+
# Get ad campaign group
|
|
1018
|
+
#
|
|
1019
|
+
# Retrieve a LinkedIn ad campaign group by ID
|
|
1020
|
+
def li_get_campaign_group(ad_id:, location_id: nil, **_opts)
|
|
1021
|
+
request(
|
|
1022
|
+
method: :get,
|
|
1023
|
+
path: "/ad-publishing/linkedin/ads/#{ad_id}",
|
|
1024
|
+
security: ["bearer"],
|
|
1025
|
+
params: { "locationId" => location_id }.compact
|
|
1026
|
+
)
|
|
1027
|
+
end
|
|
1028
|
+
|
|
1029
|
+
# Publish ad campaign group
|
|
1030
|
+
#
|
|
1031
|
+
# Publish a LinkedIn ad campaign group and push it live
|
|
1032
|
+
def li_publish_campaign_group(ad_id:, body:, **_opts)
|
|
1033
|
+
request(
|
|
1034
|
+
method: :post,
|
|
1035
|
+
path: "/ad-publishing/linkedin/ads/#{ad_id}/publish",
|
|
1036
|
+
security: ["bearer"],
|
|
1037
|
+
body: body
|
|
1038
|
+
)
|
|
1039
|
+
end
|
|
1040
|
+
|
|
1041
|
+
# Upsert ad campaign group
|
|
1042
|
+
#
|
|
1043
|
+
# Create or update a LinkedIn ad campaign group with campaigns and ads
|
|
1044
|
+
def li_upsert_campaign_group(body:, **_opts)
|
|
1045
|
+
request(
|
|
1046
|
+
method: :put,
|
|
1047
|
+
path: "/ad-publishing/linkedin/ads",
|
|
1048
|
+
security: ["bearer"],
|
|
1049
|
+
body: body
|
|
1050
|
+
)
|
|
1051
|
+
end
|
|
1052
|
+
|
|
1053
|
+
# Search targeting options
|
|
1054
|
+
#
|
|
1055
|
+
# Search LinkedIn targeting facets such as locations, industries, and job titles
|
|
1056
|
+
def li_search_targeting(location_id: nil, facet: nil, query: nil, q: nil, **_opts)
|
|
1057
|
+
request(
|
|
1058
|
+
method: :get,
|
|
1059
|
+
path: "/ad-publishing/linkedin/targeting/search",
|
|
1060
|
+
security: ["bearer"],
|
|
1061
|
+
params: { "locationId" => location_id, "facet" => facet, "query" => query, "q" => q }.compact
|
|
1062
|
+
)
|
|
1063
|
+
end
|
|
1064
|
+
|
|
1065
|
+
# Get lead forms
|
|
1066
|
+
#
|
|
1067
|
+
# Retrieve LinkedIn lead gen forms for an ad account
|
|
1068
|
+
def li_get_lead_forms(account_id:, location_id: nil, **_opts)
|
|
1069
|
+
request(
|
|
1070
|
+
method: :get,
|
|
1071
|
+
path: "/ad-publishing/linkedin/#{account_id}/forms",
|
|
1072
|
+
security: ["bearer"],
|
|
1073
|
+
params: { "locationId" => location_id }.compact
|
|
1074
|
+
)
|
|
1075
|
+
end
|
|
1076
|
+
|
|
1077
|
+
# Create lead form
|
|
1078
|
+
#
|
|
1079
|
+
# Create a new LinkedIn lead gen form for an ad account
|
|
1080
|
+
def li_create_lead_form(body:, location_id: nil, **_opts)
|
|
1081
|
+
request(
|
|
1082
|
+
method: :post,
|
|
1083
|
+
path: "/ad-publishing/linkedin/#{account_id}/form",
|
|
1084
|
+
security: ["bearer"],
|
|
1085
|
+
params: { "locationId" => location_id }.compact,
|
|
1086
|
+
body: body
|
|
1087
|
+
)
|
|
1088
|
+
end
|
|
1089
|
+
|
|
1090
|
+
# Update ad status
|
|
1091
|
+
#
|
|
1092
|
+
# Pause or resume a LinkedIn ad, campaign, or ad group
|
|
1093
|
+
def li_update_ad_status(ad_id:, body:, location_id: nil, **_opts)
|
|
1094
|
+
request(
|
|
1095
|
+
method: :patch,
|
|
1096
|
+
path: "/ad-publishing/linkedin/#{ad_id}/status",
|
|
1097
|
+
security: ["bearer"],
|
|
1098
|
+
params: { "locationId" => location_id }.compact,
|
|
1099
|
+
body: body
|
|
1100
|
+
)
|
|
1101
|
+
end
|
|
1102
|
+
|
|
1103
|
+
# Get ad analytics
|
|
1104
|
+
#
|
|
1105
|
+
# Retrieve LinkedIn Ads analytics data with configurable pivot and time grouping
|
|
1106
|
+
def li_get_ad_analytics(location_id: nil, pivot: nil, group_by: nil, start_date: nil, end_date: nil, entity_urns: nil, fields: nil, **_opts)
|
|
1107
|
+
request(
|
|
1108
|
+
method: :get,
|
|
1109
|
+
path: "/ad-publishing/linkedin/reporting",
|
|
1110
|
+
security: ["bearer"],
|
|
1111
|
+
params: { "locationId" => location_id, "pivot" => pivot, "groupBy" => group_by, "startDate" => start_date, "endDate" => end_date, "entityUrns" => entity_urns, "fields" => fields }.compact
|
|
1112
|
+
)
|
|
1113
|
+
end
|
|
1114
|
+
|
|
1115
|
+
# Get reporting list
|
|
1116
|
+
#
|
|
1117
|
+
# Retrieve a list of LinkedIn campaigns or campaign groups with reporting data
|
|
1118
|
+
def li_get_reporting_list(location_id: nil, list_type: nil, campaign_id: nil, campaign_group_id: nil, start_date: nil, end_date: nil, fields: nil, **_opts)
|
|
1119
|
+
request(
|
|
1120
|
+
method: :get,
|
|
1121
|
+
path: "/ad-publishing/linkedin/reporting/list",
|
|
1122
|
+
security: ["bearer"],
|
|
1123
|
+
params: { "locationId" => location_id, "listType" => list_type, "campaignId" => campaign_id, "campaignGroupId" => campaign_group_id, "startDate" => start_date, "endDate" => end_date, "fields" => fields }.compact
|
|
1124
|
+
)
|
|
1125
|
+
end
|
|
1126
|
+
|
|
1127
|
+
# Get campaign group reporting
|
|
1128
|
+
#
|
|
1129
|
+
# Retrieve reporting metrics for a specific LinkedIn campaign group
|
|
1130
|
+
def li_get_campaign_group_reporting(campaign_group_id:, location_id: nil, start_date: nil, end_date: nil, fields: nil, **_opts)
|
|
1131
|
+
request(
|
|
1132
|
+
method: :get,
|
|
1133
|
+
path: "/ad-publishing/linkedin/reporting/campaign-group/#{campaign_group_id}",
|
|
1134
|
+
security: ["bearer"],
|
|
1135
|
+
params: { "locationId" => location_id, "startDate" => start_date, "endDate" => end_date, "fields" => fields }.compact
|
|
1136
|
+
)
|
|
1137
|
+
end
|
|
1138
|
+
end
|
|
1139
|
+
end
|
|
1140
|
+
end
|