hubspot-api-client 17.1.0 → 17.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +18 -1
- data/Gemfile.lock +1 -1
- data/lib/hubspot/codegen/cms/pages/api/landing_pages_api.rb +2754 -0
- data/lib/hubspot/codegen/cms/pages/api/site_pages_api.rb +1896 -0
- data/lib/hubspot/codegen/cms/pages/api_client.rb +410 -0
- data/lib/hubspot/codegen/cms/pages/api_error.rb +61 -0
- data/lib/hubspot/codegen/cms/pages/configuration.rb +287 -0
- data/lib/hubspot/codegen/cms/pages/models/ab_test_create_request_v_next.rb +244 -0
- data/lib/hubspot/codegen/cms/pages/models/ab_test_end_request_v_next.rb +244 -0
- data/lib/hubspot/codegen/cms/pages/models/ab_test_rerun_request_v_next.rb +244 -0
- data/lib/hubspot/codegen/cms/pages/models/angle.rb +244 -0
- data/lib/hubspot/codegen/cms/pages/models/attach_to_lang_primary_request_v_next.rb +269 -0
- data/lib/hubspot/codegen/cms/pages/models/background_image.rb +259 -0
- data/lib/hubspot/codegen/cms/pages/models/batch_input_content_folder.rb +231 -0
- data/lib/hubspot/codegen/cms/pages/models/batch_input_json_node.rb +231 -0
- data/lib/hubspot/codegen/cms/pages/models/batch_input_page.rb +231 -0
- data/lib/hubspot/codegen/cms/pages/models/batch_input_string.rb +231 -0
- data/lib/hubspot/codegen/cms/pages/models/batch_response_content_folder.rb +326 -0
- data/lib/hubspot/codegen/cms/pages/models/batch_response_content_folder_with_errors.rb +354 -0
- data/lib/hubspot/codegen/cms/pages/models/batch_response_page.rb +326 -0
- data/lib/hubspot/codegen/cms/pages/models/batch_response_page_with_errors.rb +354 -0
- data/lib/hubspot/codegen/cms/pages/models/collection_response_with_total_content_folder_forward_paging.rb +255 -0
- data/lib/hubspot/codegen/cms/pages/models/collection_response_with_total_page_forward_paging.rb +255 -0
- data/lib/hubspot/codegen/cms/pages/models/collection_response_with_total_version_content_folder.rb +255 -0
- data/lib/hubspot/codegen/cms/pages/models/collection_response_with_total_version_page.rb +255 -0
- data/lib/hubspot/codegen/cms/pages/models/color_stop.rb +228 -0
- data/lib/hubspot/codegen/cms/pages/models/content_clone_request_v_next.rb +239 -0
- data/lib/hubspot/codegen/cms/pages/models/content_folder.rb +317 -0
- data/lib/hubspot/codegen/cms/pages/models/content_language_clone_request_v_next.rb +249 -0
- data/lib/hubspot/codegen/cms/pages/models/content_language_variation.rb +409 -0
- data/lib/hubspot/codegen/cms/pages/models/content_schedule_request_v_next.rb +244 -0
- data/lib/hubspot/codegen/cms/pages/models/detach_from_lang_group_request_v_next.rb +229 -0
- data/lib/hubspot/codegen/cms/pages/models/error.rb +305 -0
- data/lib/hubspot/codegen/cms/pages/models/error_detail.rb +271 -0
- data/lib/hubspot/codegen/cms/pages/models/forward_paging.rb +223 -0
- data/lib/hubspot/codegen/cms/pages/models/gradient.rb +259 -0
- data/lib/hubspot/codegen/cms/pages/models/layout_section.rb +416 -0
- data/lib/hubspot/codegen/cms/pages/models/next_page.rb +239 -0
- data/lib/hubspot/codegen/cms/pages/models/page.rb +1165 -0
- data/lib/hubspot/codegen/cms/pages/models/paging.rb +232 -0
- data/lib/hubspot/codegen/cms/pages/models/previous_page.rb +239 -0
- data/lib/hubspot/codegen/cms/pages/models/rgba_color.rb +274 -0
- data/lib/hubspot/codegen/cms/pages/models/row_meta_data.rb +243 -0
- data/lib/hubspot/codegen/cms/pages/models/set_new_language_primary_request_v_next.rb +229 -0
- data/lib/hubspot/codegen/cms/pages/models/side_or_corner.rb +244 -0
- data/lib/hubspot/codegen/cms/pages/models/standard_error.rb +330 -0
- data/lib/hubspot/codegen/cms/pages/models/styles.rb +316 -0
- data/lib/hubspot/codegen/cms/pages/models/update_languages_request_v_next.rb +246 -0
- data/lib/hubspot/codegen/cms/pages/models/version_content_folder.rb +271 -0
- data/lib/hubspot/codegen/cms/pages/models/version_page.rb +271 -0
- data/lib/hubspot/codegen/cms/pages/models/version_user.rb +259 -0
- data/lib/hubspot/codegen/crm/lists/api/lists_api.rb +635 -0
- data/lib/hubspot/codegen/crm/lists/api/memberships_api.rb +452 -0
- data/lib/hubspot/codegen/crm/lists/api_client.rb +410 -0
- data/lib/hubspot/codegen/crm/lists/api_error.rb +61 -0
- data/lib/hubspot/codegen/crm/lists/configuration.rb +287 -0
- data/lib/hubspot/codegen/crm/lists/models/collection_response_long.rb +240 -0
- data/lib/hubspot/codegen/crm/lists/models/error.rb +305 -0
- data/lib/hubspot/codegen/crm/lists/models/error_detail.rb +271 -0
- data/lib/hubspot/codegen/crm/lists/models/list_create_request.rb +278 -0
- data/lib/hubspot/codegen/crm/lists/models/list_create_response.rb +228 -0
- data/lib/hubspot/codegen/crm/lists/models/list_fetch_response.rb +228 -0
- data/lib/hubspot/codegen/crm/lists/models/list_filter_update_request.rb +228 -0
- data/lib/hubspot/codegen/crm/lists/models/list_search_request.rb +266 -0
- data/lib/hubspot/codegen/crm/lists/models/list_search_response.rb +276 -0
- data/lib/hubspot/codegen/crm/lists/models/list_update_response.rb +223 -0
- data/lib/hubspot/codegen/crm/lists/models/lists_by_id_response.rb +231 -0
- data/lib/hubspot/codegen/crm/lists/models/membership_change_request.rb +248 -0
- data/lib/hubspot/codegen/crm/lists/models/memberships_update_response.rb +264 -0
- data/lib/hubspot/codegen/crm/lists/models/next_page.rb +239 -0
- data/lib/hubspot/codegen/crm/lists/models/paging.rb +232 -0
- data/lib/hubspot/codegen/crm/lists/models/previous_page.rb +239 -0
- data/lib/hubspot/codegen/crm/lists/models/public_absolute_comparative_timestamp_refine_by.rb +292 -0
- data/lib/hubspot/codegen/crm/lists/models/public_absolute_ranged_timestamp_refine_by.rb +306 -0
- data/lib/hubspot/codegen/crm/lists/models/public_ads_search_filter.rb +336 -0
- data/lib/hubspot/codegen/crm/lists/models/public_ads_time_filter.rb +278 -0
- data/lib/hubspot/codegen/crm/lists/models/public_all_history_refine_by.rb +264 -0
- data/lib/hubspot/codegen/crm/lists/models/public_all_property_types_operation.rb +292 -0
- data/lib/hubspot/codegen/crm/lists/models/public_and_filter_branch.rb +310 -0
- data/lib/hubspot/codegen/crm/lists/models/public_association_filter_branch.rb +366 -0
- data/lib/hubspot/codegen/crm/lists/models/public_association_in_list_filter.rb +352 -0
- data/lib/hubspot/codegen/crm/lists/models/public_bool_property_operation.rb +306 -0
- data/lib/hubspot/codegen/crm/lists/models/public_calendar_date_property_operation.rb +345 -0
- data/lib/hubspot/codegen/crm/lists/models/public_campaign_influenced_filter.rb +278 -0
- data/lib/hubspot/codegen/crm/lists/models/public_communication_subscription_filter.rb +333 -0
- data/lib/hubspot/codegen/crm/lists/models/public_comparative_date_property_operation.rb +315 -0
- data/lib/hubspot/codegen/crm/lists/models/public_comparative_property_updated_operation.rb +315 -0
- data/lib/hubspot/codegen/crm/lists/models/public_constant_filter.rb +287 -0
- data/lib/hubspot/codegen/crm/lists/models/public_cta_analytics_filter.rb +310 -0
- data/lib/hubspot/codegen/crm/lists/models/public_date_point.rb +365 -0
- data/lib/hubspot/codegen/crm/lists/models/public_date_property_operation.rb +334 -0
- data/lib/hubspot/codegen/crm/lists/models/public_date_time_property_operation.rb +320 -0
- data/lib/hubspot/codegen/crm/lists/models/public_email_event_filter.rb +350 -0
- data/lib/hubspot/codegen/crm/lists/models/public_email_subscription_filter.rb +305 -0
- data/lib/hubspot/codegen/crm/lists/models/public_enumeration_property_operation.rb +308 -0
- data/lib/hubspot/codegen/crm/lists/models/public_event_analytics_filter.rb +310 -0
- data/lib/hubspot/codegen/crm/lists/models/public_event_analytics_filter_coalescing_refine_by.rb +115 -0
- data/lib/hubspot/codegen/crm/lists/models/public_event_filter_metadata.rb +242 -0
- data/lib/hubspot/codegen/crm/lists/models/public_fiscal_quarter_reference.rb +328 -0
- data/lib/hubspot/codegen/crm/lists/models/public_fiscal_year_reference.rb +328 -0
- data/lib/hubspot/codegen/crm/lists/models/public_form_submission_filter.rb +317 -0
- data/lib/hubspot/codegen/crm/lists/models/public_form_submission_on_page_filter.rb +331 -0
- data/lib/hubspot/codegen/crm/lists/models/public_in_list_filter.rb +301 -0
- data/lib/hubspot/codegen/crm/lists/models/public_in_list_filter_metadata.rb +242 -0
- data/lib/hubspot/codegen/crm/lists/models/public_index_offset.rb +295 -0
- data/lib/hubspot/codegen/crm/lists/models/public_indexed_time_point.rb +310 -0
- data/lib/hubspot/codegen/crm/lists/models/public_indexed_time_point_index_reference.rb +114 -0
- data/lib/hubspot/codegen/crm/lists/models/public_integration_event_filter.rb +294 -0
- data/lib/hubspot/codegen/crm/lists/models/public_month_reference.rb +314 -0
- data/lib/hubspot/codegen/crm/lists/models/public_multi_string_property_operation.rb +308 -0
- data/lib/hubspot/codegen/crm/lists/models/public_not_all_filter_branch.rb +310 -0
- data/lib/hubspot/codegen/crm/lists/models/public_not_any_filter_branch.rb +310 -0
- data/lib/hubspot/codegen/crm/lists/models/public_now_reference.rb +300 -0
- data/lib/hubspot/codegen/crm/lists/models/public_num_associations_filter.rb +306 -0
- data/lib/hubspot/codegen/crm/lists/models/public_num_occurrences_refine_by.rb +282 -0
- data/lib/hubspot/codegen/crm/lists/models/public_number_property_operation.rb +306 -0
- data/lib/hubspot/codegen/crm/lists/models/public_object_list.rb +373 -0
- data/lib/hubspot/codegen/crm/lists/models/public_object_list_search_result.rb +381 -0
- data/lib/hubspot/codegen/crm/lists/models/public_or_filter_branch.rb +310 -0
- data/lib/hubspot/codegen/crm/lists/models/public_page_view_analytics_filter.rb +319 -0
- data/lib/hubspot/codegen/crm/lists/models/public_privacy_analytics_filter.rb +292 -0
- data/lib/hubspot/codegen/crm/lists/models/public_property_association_filter_branch.rb +352 -0
- data/lib/hubspot/codegen/crm/lists/models/public_property_association_filter_branch_filter_branches_inner.rb +114 -0
- data/lib/hubspot/codegen/crm/lists/models/public_property_association_filter_branch_filters_inner.rb +130 -0
- data/lib/hubspot/codegen/crm/lists/models/public_property_association_in_list_filter.rb +329 -0
- data/lib/hubspot/codegen/crm/lists/models/public_property_filter.rb +292 -0
- data/lib/hubspot/codegen/crm/lists/models/public_property_filter_operation.rb +123 -0
- data/lib/hubspot/codegen/crm/lists/models/public_property_referenced_time.rb +315 -0
- data/lib/hubspot/codegen/crm/lists/models/public_quarter_reference.rb +328 -0
- data/lib/hubspot/codegen/crm/lists/models/public_ranged_date_property_operation.rb +334 -0
- data/lib/hubspot/codegen/crm/lists/models/public_ranged_number_property_operation.rb +320 -0
- data/lib/hubspot/codegen/crm/lists/models/public_ranged_time_operation.rb +361 -0
- data/lib/hubspot/codegen/crm/lists/models/public_relative_comparative_timestamp_refine_by.rb +292 -0
- data/lib/hubspot/codegen/crm/lists/models/public_relative_ranged_timestamp_refine_by.rb +306 -0
- data/lib/hubspot/codegen/crm/lists/models/public_restricted_filter_branch.rb +310 -0
- data/lib/hubspot/codegen/crm/lists/models/public_rolling_date_range_property_operation.rb +320 -0
- data/lib/hubspot/codegen/crm/lists/models/public_rolling_property_updated_operation.rb +306 -0
- data/lib/hubspot/codegen/crm/lists/models/public_set_occurrences_refine_by.rb +278 -0
- data/lib/hubspot/codegen/crm/lists/models/public_string_property_operation.rb +306 -0
- data/lib/hubspot/codegen/crm/lists/models/public_survey_monkey_filter.rb +292 -0
- data/lib/hubspot/codegen/crm/lists/models/public_survey_monkey_value_filter.rb +338 -0
- data/lib/hubspot/codegen/crm/lists/models/public_time_offset.rb +256 -0
- data/lib/hubspot/codegen/crm/lists/models/public_time_point_operation.rb +338 -0
- data/lib/hubspot/codegen/crm/lists/models/public_time_point_operation_time_point.rb +109 -0
- data/lib/hubspot/codegen/crm/lists/models/public_today_reference.rb +300 -0
- data/lib/hubspot/codegen/crm/lists/models/public_unified_events_filter.rb +307 -0
- data/lib/hubspot/codegen/crm/lists/models/public_unified_events_filter_branch.rb +350 -0
- data/lib/hubspot/codegen/crm/lists/models/public_unified_events_in_list_filter.rb +310 -0
- data/lib/hubspot/codegen/crm/lists/models/public_webinar_filter.rb +287 -0
- data/lib/hubspot/codegen/crm/lists/models/public_week_reference.rb +326 -0
- data/lib/hubspot/codegen/crm/lists/models/public_year_reference.rb +328 -0
- data/lib/hubspot/codegen/crm/objects/goals/api/basic_api.rb +391 -0
- data/lib/hubspot/codegen/crm/objects/goals/api/batch_api.rb +295 -0
- data/lib/hubspot/codegen/crm/objects/goals/api/gdpr_api.rb +96 -0
- data/lib/hubspot/codegen/crm/objects/goals/api/public_object_api.rb +94 -0
- data/lib/hubspot/codegen/crm/objects/goals/api/search_api.rb +92 -0
- data/lib/hubspot/codegen/crm/objects/goals/api_client.rb +412 -0
- data/lib/hubspot/codegen/crm/objects/goals/api_error.rb +63 -0
- data/lib/hubspot/codegen/crm/objects/goals/configuration.rb +289 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/associated_id.rb +244 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/association_spec.rb +278 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/batch_input_simple_public_object_batch_input.rb +232 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/batch_input_simple_public_object_id.rb +232 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/batch_input_simple_public_object_input_for_create.rb +232 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/batch_read_input_simple_public_object_id.rb +273 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/batch_response_simple_public_object.rb +328 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/batch_response_simple_public_object_with_errors.rb +348 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/collection_response_associated_id.rb +241 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/collection_response_simple_public_object_with_associations_forward_paging.rb +241 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/collection_response_with_total_simple_public_object_forward_paging.rb +255 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/error.rb +307 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/error_detail.rb +273 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/filter.rb +308 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/filter_group.rb +232 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/forward_paging.rb +225 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/next_page.rb +239 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/paging.rb +234 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/previous_page.rb +239 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/public_associations_for_object.rb +246 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/public_gdpr_delete_input.rb +239 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/public_merge_input.rb +244 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/public_object_id.rb +230 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/public_object_search_request.rb +301 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/simple_public_object.rb +303 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/simple_public_object_batch_input.rb +246 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/simple_public_object_id.rb +230 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/simple_public_object_input.rb +232 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/simple_public_object_input_for_create.rb +248 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/simple_public_object_with_associations.rb +314 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/standard_error.rb +324 -0
- data/lib/hubspot/codegen/crm/objects/goals/models/value_with_timestamp.rb +285 -0
- data/lib/hubspot/codegen/crm/objects/taxes/api/basic_api.rb +391 -0
- data/lib/hubspot/codegen/crm/objects/taxes/api/batch_api.rb +295 -0
- data/lib/hubspot/codegen/crm/objects/taxes/api/gdpr_api.rb +96 -0
- data/lib/hubspot/codegen/crm/objects/taxes/api/public_object_api.rb +94 -0
- data/lib/hubspot/codegen/crm/objects/taxes/api/search_api.rb +92 -0
- data/lib/hubspot/codegen/crm/objects/taxes/api_client.rb +412 -0
- data/lib/hubspot/codegen/crm/objects/taxes/api_error.rb +63 -0
- data/lib/hubspot/codegen/crm/objects/taxes/configuration.rb +289 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/associated_id.rb +244 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/association_spec.rb +278 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/batch_input_simple_public_object_batch_input.rb +232 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/batch_input_simple_public_object_id.rb +232 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/batch_input_simple_public_object_input_for_create.rb +232 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/batch_read_input_simple_public_object_id.rb +273 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/batch_response_simple_public_object.rb +328 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/batch_response_simple_public_object_with_errors.rb +348 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/collection_response_associated_id.rb +241 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/collection_response_simple_public_object_with_associations_forward_paging.rb +241 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/collection_response_with_total_simple_public_object_forward_paging.rb +255 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/error.rb +307 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/error_detail.rb +273 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/filter.rb +308 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/filter_group.rb +232 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/forward_paging.rb +225 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/next_page.rb +239 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/paging.rb +234 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/previous_page.rb +239 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/public_associations_for_object.rb +246 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/public_gdpr_delete_input.rb +239 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/public_merge_input.rb +244 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/public_object_id.rb +230 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/public_object_search_request.rb +301 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/simple_public_object.rb +303 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/simple_public_object_batch_input.rb +246 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/simple_public_object_id.rb +230 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/simple_public_object_input.rb +232 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/simple_public_object_input_for_create.rb +248 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/simple_public_object_with_associations.rb +314 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/standard_error.rb +324 -0
- data/lib/hubspot/codegen/crm/objects/taxes/models/value_with_timestamp.rb +285 -0
- data/lib/hubspot/codegen/events/send/api/behavioral_events_tracking_api.rb +94 -0
- data/lib/hubspot/codegen/events/send/api_client.rb +410 -0
- data/lib/hubspot/codegen/events/send/api_error.rb +61 -0
- data/lib/hubspot/codegen/events/send/configuration.rb +287 -0
- data/lib/hubspot/codegen/events/send/models/behavioral_event_http_completion_request.rb +290 -0
- data/lib/hubspot/codegen/events/send/models/error.rb +305 -0
- data/lib/hubspot/codegen/events/send/models/error_detail.rb +271 -0
- data/lib/hubspot/codegen/settings/business_units/api/business_unit_api.rb +95 -0
- data/lib/hubspot/codegen/settings/business_units/api_client.rb +410 -0
- data/lib/hubspot/codegen/settings/business_units/api_error.rb +61 -0
- data/lib/hubspot/codegen/settings/business_units/configuration.rb +287 -0
- data/lib/hubspot/codegen/settings/business_units/models/collection_response_public_business_unit_no_paging.rb +232 -0
- data/lib/hubspot/codegen/settings/business_units/models/error.rb +305 -0
- data/lib/hubspot/codegen/settings/business_units/models/error_detail.rb +271 -0
- data/lib/hubspot/codegen/settings/business_units/models/public_business_unit.rb +254 -0
- data/lib/hubspot/codegen/settings/business_units/models/public_business_unit_logo_metadata.rb +245 -0
- data/lib/hubspot/discovery/base_api_client.rb +1 -1
- data/lib/hubspot/discovery/cms/client.rb +1 -0
- data/lib/hubspot/discovery/cms/pages/api/landing_pages_api.rb +13 -0
- data/lib/hubspot/discovery/cms/pages/api/site_pages_api.rb +13 -0
- data/lib/hubspot/discovery/cms/pages/client.rb +20 -0
- data/lib/hubspot/discovery/crm/client.rb +1 -0
- data/lib/hubspot/discovery/crm/lists/api/lists_api.rb +13 -0
- data/lib/hubspot/discovery/crm/lists/api/memberships_api.rb +13 -0
- data/lib/hubspot/discovery/crm/lists/client.rb +20 -0
- data/lib/hubspot/discovery/crm/objects/client.rb +2 -0
- data/lib/hubspot/discovery/crm/objects/goals/api/basic_api.rb +15 -0
- data/lib/hubspot/discovery/crm/objects/goals/api/batch_api.rb +15 -0
- data/lib/hubspot/discovery/crm/objects/goals/api/gdpr_api.rb +15 -0
- data/lib/hubspot/discovery/crm/objects/goals/api/public_object_api.rb +15 -0
- data/lib/hubspot/discovery/crm/objects/goals/api/search_api.rb +15 -0
- data/lib/hubspot/discovery/crm/objects/goals/client.rb +25 -0
- data/lib/hubspot/discovery/crm/objects/taxes/api/basic_api.rb +15 -0
- data/lib/hubspot/discovery/crm/objects/taxes/api/batch_api.rb +15 -0
- data/lib/hubspot/discovery/crm/objects/taxes/api/gdpr_api.rb +15 -0
- data/lib/hubspot/discovery/crm/objects/taxes/api/public_object_api.rb +15 -0
- data/lib/hubspot/discovery/crm/objects/taxes/api/search_api.rb +15 -0
- data/lib/hubspot/discovery/crm/objects/taxes/client.rb +25 -0
- data/lib/hubspot/discovery/events/client.rb +6 -0
- data/lib/hubspot/discovery/events/send/api/behavioral_events_tracking_api.rb +13 -0
- data/lib/hubspot/discovery/events/send/client.rb +19 -0
- data/lib/hubspot/discovery/settings/business_units/api/business_unit_api.rb +13 -0
- data/lib/hubspot/discovery/settings/business_units/client.rb +19 -0
- data/lib/hubspot/discovery/settings/client.rb +1 -0
- data/lib/hubspot/version.rb +1 -1
- data/spec/discovery/client_spec.rb +1 -0
- data/spec/discovery/cms/client_spec.rb +1 -0
- data/spec/discovery/cms/pages/landing_pages_api_spec.rb +45 -0
- data/spec/discovery/cms/pages/site_pages_api_spec.rb +33 -0
- data/spec/discovery/crm/lists/lists_api_spec.rb +15 -0
- data/spec/discovery/crm/lists/memberships_api_spec.rb +12 -0
- data/spec/discovery/crm/objects/goals/basic_api_spec.rb +11 -0
- data/spec/discovery/crm/objects/goals/batch_api_spec.rb +10 -0
- data/spec/discovery/crm/objects/goals/gdpr_api_spec.rb +7 -0
- data/spec/discovery/crm/objects/goals/public_object_api_spec.rb +7 -0
- data/spec/discovery/crm/objects/goals/search_api_spec.rb +7 -0
- data/spec/discovery/crm/objects/taxes/basic_api_spec.rb +11 -0
- data/spec/discovery/crm/objects/taxes/batch_api_spec.rb +10 -0
- data/spec/discovery/crm/objects/taxes/gdpr_api_spec.rb +7 -0
- data/spec/discovery/crm/objects/taxes/public_object_api_spec.rb +7 -0
- data/spec/discovery/crm/objects/taxes/search_api_spec.rb +7 -0
- data/spec/discovery/events/send/behavioral_events_tracking_api_spec.rb +7 -0
- data/spec/discovery/settings/businnes_units/business_unit_api_spec.rb +7 -0
- data/spec/integration/contacts_spec.rb +85 -0
- metadata +303 -2
@@ -0,0 +1,452 @@
|
|
1
|
+
=begin
|
2
|
+
#Lists
|
3
|
+
|
4
|
+
#CRUD operations to manage lists and list memberships
|
5
|
+
|
6
|
+
The version of the OpenAPI document: v3
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 6.2.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module Hubspot
|
16
|
+
module Crm
|
17
|
+
module Lists
|
18
|
+
class MembershipsApi
|
19
|
+
attr_accessor :api_client
|
20
|
+
|
21
|
+
def initialize(api_client = ApiClient.default)
|
22
|
+
@api_client = api_client
|
23
|
+
end
|
24
|
+
# Add Records to a List
|
25
|
+
# Add the records provided to the list. Records that do not exist or that are already members of the list are ignored. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`.
|
26
|
+
# @param list_id [Integer] The **ILS ID** of the `MANUAL` or `SNAPSHOT` list.
|
27
|
+
# @param request_body [Array<Integer>] The IDs of the records to add to the list.
|
28
|
+
# @param [Hash] opts the optional parameters
|
29
|
+
# @return [MembershipsUpdateResponse]
|
30
|
+
def add(list_id, request_body, opts = {})
|
31
|
+
data, _status_code, _headers = add_with_http_info(list_id, request_body, opts)
|
32
|
+
data
|
33
|
+
end
|
34
|
+
|
35
|
+
# Add Records to a List
|
36
|
+
# Add the records provided to the list. Records that do not exist or that are already members of the list are ignored. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`.
|
37
|
+
# @param list_id [Integer] The **ILS ID** of the `MANUAL` or `SNAPSHOT` list.
|
38
|
+
# @param request_body [Array<Integer>] The IDs of the records to add to the list.
|
39
|
+
# @param [Hash] opts the optional parameters
|
40
|
+
# @return [Array<(MembershipsUpdateResponse, Integer, Hash)>] MembershipsUpdateResponse data, response status code and response headers
|
41
|
+
def add_with_http_info(list_id, request_body, opts = {})
|
42
|
+
if @api_client.config.debugging
|
43
|
+
@api_client.config.logger.debug 'Calling API: MembershipsApi.add ...'
|
44
|
+
end
|
45
|
+
# verify the required parameter 'list_id' is set
|
46
|
+
if @api_client.config.client_side_validation && list_id.nil?
|
47
|
+
fail ArgumentError, "Missing the required parameter 'list_id' when calling MembershipsApi.add"
|
48
|
+
end
|
49
|
+
# verify the required parameter 'request_body' is set
|
50
|
+
if @api_client.config.client_side_validation && request_body.nil?
|
51
|
+
fail ArgumentError, "Missing the required parameter 'request_body' when calling MembershipsApi.add"
|
52
|
+
end
|
53
|
+
# resource path
|
54
|
+
local_var_path = '/crm/v3/lists/{listId}/memberships/add'.sub('{' + 'listId' + '}', CGI.escape(list_id.to_s))
|
55
|
+
|
56
|
+
# query parameters
|
57
|
+
query_params = opts[:query_params] || {}
|
58
|
+
|
59
|
+
# header parameters
|
60
|
+
header_params = opts[:header_params] || {}
|
61
|
+
# HTTP header 'Accept' (if needed)
|
62
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
|
63
|
+
# HTTP header 'Content-Type'
|
64
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
65
|
+
if !content_type.nil?
|
66
|
+
header_params['Content-Type'] = content_type
|
67
|
+
end
|
68
|
+
|
69
|
+
# form parameters
|
70
|
+
form_params = opts[:form_params] || {}
|
71
|
+
|
72
|
+
# http body (model)
|
73
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
|
74
|
+
|
75
|
+
# return_type
|
76
|
+
return_type = opts[:debug_return_type] || 'MembershipsUpdateResponse'
|
77
|
+
|
78
|
+
# auth_names
|
79
|
+
auth_names = opts[:debug_auth_names] || ['oauth2']
|
80
|
+
|
81
|
+
new_options = opts.merge(
|
82
|
+
:operation => :"MembershipsApi.add",
|
83
|
+
:header_params => header_params,
|
84
|
+
:query_params => query_params,
|
85
|
+
:form_params => form_params,
|
86
|
+
:body => post_body,
|
87
|
+
:auth_names => auth_names,
|
88
|
+
:return_type => return_type
|
89
|
+
)
|
90
|
+
|
91
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
92
|
+
if @api_client.config.debugging
|
93
|
+
@api_client.config.logger.debug "API called: MembershipsApi#add\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
94
|
+
end
|
95
|
+
return data, status_code, headers
|
96
|
+
end
|
97
|
+
|
98
|
+
# Add All Records from a Source List to a Destination List
|
99
|
+
# Add all of the records from a *source list* (specified by the `sourceListId`) to a *destination list* (specified by the `listId`). Records that are already members of the *destination list* will be ignored. The *destination* and *source list* IDs must be different. The *destination* and *source lists* must contain records of the same type (e.g. contacts, companies, etc.). This endpoint only works for *destination lists* that have a `processingType` of `MANUAL` or `SNAPSHOT`. The *source list* can have any `processingType`.
|
100
|
+
# @param list_id [Integer] The **ILS ID** of the `MANUAL` or `SNAPSHOT` *destination list*, which the *source list* records are added to.
|
101
|
+
# @param source_list_id [Integer] The **ILS ID** of the *source list* to grab the records from, which are then added to the *destination list*.
|
102
|
+
# @param [Hash] opts the optional parameters
|
103
|
+
# @return [nil]
|
104
|
+
def add_all_from_list(list_id, source_list_id, opts = {})
|
105
|
+
add_all_from_list_with_http_info(list_id, source_list_id, opts)
|
106
|
+
nil
|
107
|
+
end
|
108
|
+
|
109
|
+
# Add All Records from a Source List to a Destination List
|
110
|
+
# Add all of the records from a *source list* (specified by the `sourceListId`) to a *destination list* (specified by the `listId`). Records that are already members of the *destination list* will be ignored. The *destination* and *source list* IDs must be different. The *destination* and *source lists* must contain records of the same type (e.g. contacts, companies, etc.). This endpoint only works for *destination lists* that have a `processingType` of `MANUAL` or `SNAPSHOT`. The *source list* can have any `processingType`.
|
111
|
+
# @param list_id [Integer] The **ILS ID** of the `MANUAL` or `SNAPSHOT` *destination list*, which the *source list* records are added to.
|
112
|
+
# @param source_list_id [Integer] The **ILS ID** of the *source list* to grab the records from, which are then added to the *destination list*.
|
113
|
+
# @param [Hash] opts the optional parameters
|
114
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
115
|
+
def add_all_from_list_with_http_info(list_id, source_list_id, opts = {})
|
116
|
+
if @api_client.config.debugging
|
117
|
+
@api_client.config.logger.debug 'Calling API: MembershipsApi.add_all_from_list ...'
|
118
|
+
end
|
119
|
+
# verify the required parameter 'list_id' is set
|
120
|
+
if @api_client.config.client_side_validation && list_id.nil?
|
121
|
+
fail ArgumentError, "Missing the required parameter 'list_id' when calling MembershipsApi.add_all_from_list"
|
122
|
+
end
|
123
|
+
# verify the required parameter 'source_list_id' is set
|
124
|
+
if @api_client.config.client_side_validation && source_list_id.nil?
|
125
|
+
fail ArgumentError, "Missing the required parameter 'source_list_id' when calling MembershipsApi.add_all_from_list"
|
126
|
+
end
|
127
|
+
# resource path
|
128
|
+
local_var_path = '/crm/v3/lists/{listId}/memberships/add-from/{sourceListId}'.sub('{' + 'listId' + '}', CGI.escape(list_id.to_s)).sub('{' + 'sourceListId' + '}', CGI.escape(source_list_id.to_s))
|
129
|
+
|
130
|
+
# query parameters
|
131
|
+
query_params = opts[:query_params] || {}
|
132
|
+
|
133
|
+
# header parameters
|
134
|
+
header_params = opts[:header_params] || {}
|
135
|
+
# HTTP header 'Accept' (if needed)
|
136
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
137
|
+
|
138
|
+
# form parameters
|
139
|
+
form_params = opts[:form_params] || {}
|
140
|
+
|
141
|
+
# http body (model)
|
142
|
+
post_body = opts[:debug_body]
|
143
|
+
|
144
|
+
# return_type
|
145
|
+
return_type = opts[:debug_return_type]
|
146
|
+
|
147
|
+
# auth_names
|
148
|
+
auth_names = opts[:debug_auth_names] || ['oauth2']
|
149
|
+
|
150
|
+
new_options = opts.merge(
|
151
|
+
:operation => :"MembershipsApi.add_all_from_list",
|
152
|
+
:header_params => header_params,
|
153
|
+
:query_params => query_params,
|
154
|
+
:form_params => form_params,
|
155
|
+
:body => post_body,
|
156
|
+
:auth_names => auth_names,
|
157
|
+
:return_type => return_type
|
158
|
+
)
|
159
|
+
|
160
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
161
|
+
if @api_client.config.debugging
|
162
|
+
@api_client.config.logger.debug "API called: MembershipsApi#add_all_from_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
163
|
+
end
|
164
|
+
return data, status_code, headers
|
165
|
+
end
|
166
|
+
|
167
|
+
# Add and/or Remove Records from a List
|
168
|
+
# Add and/or remove records that have already been created in the system to and/or from a list. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`.
|
169
|
+
# @param list_id [Integer] The **ILS ID** of the `MANUAL` or `SNAPSHOT` list.
|
170
|
+
# @param membership_change_request [MembershipChangeRequest] The IDs of the records to add and/or remove from the list.
|
171
|
+
# @param [Hash] opts the optional parameters
|
172
|
+
# @return [MembershipsUpdateResponse]
|
173
|
+
def add_remove(list_id, membership_change_request, opts = {})
|
174
|
+
data, _status_code, _headers = add_remove_with_http_info(list_id, membership_change_request, opts)
|
175
|
+
data
|
176
|
+
end
|
177
|
+
|
178
|
+
# Add and/or Remove Records from a List
|
179
|
+
# Add and/or remove records that have already been created in the system to and/or from a list. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`.
|
180
|
+
# @param list_id [Integer] The **ILS ID** of the `MANUAL` or `SNAPSHOT` list.
|
181
|
+
# @param membership_change_request [MembershipChangeRequest] The IDs of the records to add and/or remove from the list.
|
182
|
+
# @param [Hash] opts the optional parameters
|
183
|
+
# @return [Array<(MembershipsUpdateResponse, Integer, Hash)>] MembershipsUpdateResponse data, response status code and response headers
|
184
|
+
def add_remove_with_http_info(list_id, membership_change_request, opts = {})
|
185
|
+
if @api_client.config.debugging
|
186
|
+
@api_client.config.logger.debug 'Calling API: MembershipsApi.add_remove ...'
|
187
|
+
end
|
188
|
+
# verify the required parameter 'list_id' is set
|
189
|
+
if @api_client.config.client_side_validation && list_id.nil?
|
190
|
+
fail ArgumentError, "Missing the required parameter 'list_id' when calling MembershipsApi.add_remove"
|
191
|
+
end
|
192
|
+
# verify the required parameter 'membership_change_request' is set
|
193
|
+
if @api_client.config.client_side_validation && membership_change_request.nil?
|
194
|
+
fail ArgumentError, "Missing the required parameter 'membership_change_request' when calling MembershipsApi.add_remove"
|
195
|
+
end
|
196
|
+
# resource path
|
197
|
+
local_var_path = '/crm/v3/lists/{listId}/memberships/add-and-remove'.sub('{' + 'listId' + '}', CGI.escape(list_id.to_s))
|
198
|
+
|
199
|
+
# query parameters
|
200
|
+
query_params = opts[:query_params] || {}
|
201
|
+
|
202
|
+
# header parameters
|
203
|
+
header_params = opts[:header_params] || {}
|
204
|
+
# HTTP header 'Accept' (if needed)
|
205
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
|
206
|
+
# HTTP header 'Content-Type'
|
207
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
208
|
+
if !content_type.nil?
|
209
|
+
header_params['Content-Type'] = content_type
|
210
|
+
end
|
211
|
+
|
212
|
+
# form parameters
|
213
|
+
form_params = opts[:form_params] || {}
|
214
|
+
|
215
|
+
# http body (model)
|
216
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(membership_change_request)
|
217
|
+
|
218
|
+
# return_type
|
219
|
+
return_type = opts[:debug_return_type] || 'MembershipsUpdateResponse'
|
220
|
+
|
221
|
+
# auth_names
|
222
|
+
auth_names = opts[:debug_auth_names] || ['oauth2']
|
223
|
+
|
224
|
+
new_options = opts.merge(
|
225
|
+
:operation => :"MembershipsApi.add_remove",
|
226
|
+
:header_params => header_params,
|
227
|
+
:query_params => query_params,
|
228
|
+
:form_params => form_params,
|
229
|
+
:body => post_body,
|
230
|
+
:auth_names => auth_names,
|
231
|
+
:return_type => return_type
|
232
|
+
)
|
233
|
+
|
234
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
235
|
+
if @api_client.config.debugging
|
236
|
+
@api_client.config.logger.debug "API called: MembershipsApi#add_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
237
|
+
end
|
238
|
+
return data, status_code, headers
|
239
|
+
end
|
240
|
+
|
241
|
+
# Fetch List Memberships Ordered by ID
|
242
|
+
# Fetch the memberships of a list in order sorted by the `recordId` of the records in the list. The `recordId`s are sorted in *ascending* order if an `after` offset or no offset is provided. If only a `before` offset is provided, then the records are sorted in *descending* order. The `after` offset parameter will take precedence over the `before` offset in a case where both are provided.
|
243
|
+
# @param list_id [Integer] The **ILS ID** of the list.
|
244
|
+
# @param [Hash] opts the optional parameters
|
245
|
+
# @option opts [String] :after The paging offset token for the page that comes `after` the previously requested records. If provided, then the records in the response will be the records following the offset, sorted in *ascending* order. Takes precedence over the `before` offset.
|
246
|
+
# @option opts [String] :before The paging offset token for the page that comes `before` the previously requested records. If provided, then the records in the response will be the records preceding the offset, sorted in *descending* order.
|
247
|
+
# @option opts [Integer] :limit The number of records to return in the response. The maximum `limit` is 250. (default to 100)
|
248
|
+
# @return [CollectionResponseLong]
|
249
|
+
def get_page(list_id, opts = {})
|
250
|
+
data, _status_code, _headers = get_page_with_http_info(list_id, opts)
|
251
|
+
data
|
252
|
+
end
|
253
|
+
|
254
|
+
# Fetch List Memberships Ordered by ID
|
255
|
+
# Fetch the memberships of a list in order sorted by the `recordId` of the records in the list. The `recordId`s are sorted in *ascending* order if an `after` offset or no offset is provided. If only a `before` offset is provided, then the records are sorted in *descending* order. The `after` offset parameter will take precedence over the `before` offset in a case where both are provided.
|
256
|
+
# @param list_id [Integer] The **ILS ID** of the list.
|
257
|
+
# @param [Hash] opts the optional parameters
|
258
|
+
# @option opts [String] :after The paging offset token for the page that comes `after` the previously requested records. If provided, then the records in the response will be the records following the offset, sorted in *ascending* order. Takes precedence over the `before` offset.
|
259
|
+
# @option opts [String] :before The paging offset token for the page that comes `before` the previously requested records. If provided, then the records in the response will be the records preceding the offset, sorted in *descending* order.
|
260
|
+
# @option opts [Integer] :limit The number of records to return in the response. The maximum `limit` is 250. (default to 100)
|
261
|
+
# @return [Array<(CollectionResponseLong, Integer, Hash)>] CollectionResponseLong data, response status code and response headers
|
262
|
+
def get_page_with_http_info(list_id, opts = {})
|
263
|
+
if @api_client.config.debugging
|
264
|
+
@api_client.config.logger.debug 'Calling API: MembershipsApi.get_page ...'
|
265
|
+
end
|
266
|
+
# verify the required parameter 'list_id' is set
|
267
|
+
if @api_client.config.client_side_validation && list_id.nil?
|
268
|
+
fail ArgumentError, "Missing the required parameter 'list_id' when calling MembershipsApi.get_page"
|
269
|
+
end
|
270
|
+
# resource path
|
271
|
+
local_var_path = '/crm/v3/lists/{listId}/memberships'.sub('{' + 'listId' + '}', CGI.escape(list_id.to_s))
|
272
|
+
|
273
|
+
# query parameters
|
274
|
+
query_params = opts[:query_params] || {}
|
275
|
+
query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
|
276
|
+
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
277
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
278
|
+
|
279
|
+
# header parameters
|
280
|
+
header_params = opts[:header_params] || {}
|
281
|
+
# HTTP header 'Accept' (if needed)
|
282
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
|
283
|
+
|
284
|
+
# form parameters
|
285
|
+
form_params = opts[:form_params] || {}
|
286
|
+
|
287
|
+
# http body (model)
|
288
|
+
post_body = opts[:debug_body]
|
289
|
+
|
290
|
+
# return_type
|
291
|
+
return_type = opts[:debug_return_type] || 'CollectionResponseLong'
|
292
|
+
|
293
|
+
# auth_names
|
294
|
+
auth_names = opts[:debug_auth_names] || ['oauth2']
|
295
|
+
|
296
|
+
new_options = opts.merge(
|
297
|
+
:operation => :"MembershipsApi.get_page",
|
298
|
+
:header_params => header_params,
|
299
|
+
:query_params => query_params,
|
300
|
+
:form_params => form_params,
|
301
|
+
:body => post_body,
|
302
|
+
:auth_names => auth_names,
|
303
|
+
:return_type => return_type
|
304
|
+
)
|
305
|
+
|
306
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
307
|
+
if @api_client.config.debugging
|
308
|
+
@api_client.config.logger.debug "API called: MembershipsApi#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
309
|
+
end
|
310
|
+
return data, status_code, headers
|
311
|
+
end
|
312
|
+
|
313
|
+
# Remove Records from a List
|
314
|
+
# Remove the records provided from the list. Records that do not exist or that are not members of the list are ignored. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`.
|
315
|
+
# @param list_id [Integer] The **ILS ID** of the `MANUAL` or `SNAPSHOT` list.
|
316
|
+
# @param request_body [Array<Integer>] The IDs of the records to remove from the list.
|
317
|
+
# @param [Hash] opts the optional parameters
|
318
|
+
# @return [MembershipsUpdateResponse]
|
319
|
+
def remove(list_id, request_body, opts = {})
|
320
|
+
data, _status_code, _headers = remove_with_http_info(list_id, request_body, opts)
|
321
|
+
data
|
322
|
+
end
|
323
|
+
|
324
|
+
# Remove Records from a List
|
325
|
+
# Remove the records provided from the list. Records that do not exist or that are not members of the list are ignored. This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`.
|
326
|
+
# @param list_id [Integer] The **ILS ID** of the `MANUAL` or `SNAPSHOT` list.
|
327
|
+
# @param request_body [Array<Integer>] The IDs of the records to remove from the list.
|
328
|
+
# @param [Hash] opts the optional parameters
|
329
|
+
# @return [Array<(MembershipsUpdateResponse, Integer, Hash)>] MembershipsUpdateResponse data, response status code and response headers
|
330
|
+
def remove_with_http_info(list_id, request_body, opts = {})
|
331
|
+
if @api_client.config.debugging
|
332
|
+
@api_client.config.logger.debug 'Calling API: MembershipsApi.remove ...'
|
333
|
+
end
|
334
|
+
# verify the required parameter 'list_id' is set
|
335
|
+
if @api_client.config.client_side_validation && list_id.nil?
|
336
|
+
fail ArgumentError, "Missing the required parameter 'list_id' when calling MembershipsApi.remove"
|
337
|
+
end
|
338
|
+
# verify the required parameter 'request_body' is set
|
339
|
+
if @api_client.config.client_side_validation && request_body.nil?
|
340
|
+
fail ArgumentError, "Missing the required parameter 'request_body' when calling MembershipsApi.remove"
|
341
|
+
end
|
342
|
+
# resource path
|
343
|
+
local_var_path = '/crm/v3/lists/{listId}/memberships/remove'.sub('{' + 'listId' + '}', CGI.escape(list_id.to_s))
|
344
|
+
|
345
|
+
# query parameters
|
346
|
+
query_params = opts[:query_params] || {}
|
347
|
+
|
348
|
+
# header parameters
|
349
|
+
header_params = opts[:header_params] || {}
|
350
|
+
# HTTP header 'Accept' (if needed)
|
351
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
|
352
|
+
# HTTP header 'Content-Type'
|
353
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
354
|
+
if !content_type.nil?
|
355
|
+
header_params['Content-Type'] = content_type
|
356
|
+
end
|
357
|
+
|
358
|
+
# form parameters
|
359
|
+
form_params = opts[:form_params] || {}
|
360
|
+
|
361
|
+
# http body (model)
|
362
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
|
363
|
+
|
364
|
+
# return_type
|
365
|
+
return_type = opts[:debug_return_type] || 'MembershipsUpdateResponse'
|
366
|
+
|
367
|
+
# auth_names
|
368
|
+
auth_names = opts[:debug_auth_names] || ['oauth2']
|
369
|
+
|
370
|
+
new_options = opts.merge(
|
371
|
+
:operation => :"MembershipsApi.remove",
|
372
|
+
:header_params => header_params,
|
373
|
+
:query_params => query_params,
|
374
|
+
:form_params => form_params,
|
375
|
+
:body => post_body,
|
376
|
+
:auth_names => auth_names,
|
377
|
+
:return_type => return_type
|
378
|
+
)
|
379
|
+
|
380
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
381
|
+
if @api_client.config.debugging
|
382
|
+
@api_client.config.logger.debug "API called: MembershipsApi#remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
383
|
+
end
|
384
|
+
return data, status_code, headers
|
385
|
+
end
|
386
|
+
|
387
|
+
# Delete All Records from a List
|
388
|
+
# Remove **all** of the records from a list. ***Note:*** *The list is not deleted.* This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`.
|
389
|
+
# @param list_id [Integer] The **ILS ID** of the `MANUAL` or `SNAPSHOT` list.
|
390
|
+
# @param [Hash] opts the optional parameters
|
391
|
+
# @return [nil]
|
392
|
+
def remove_all(list_id, opts = {})
|
393
|
+
remove_all_with_http_info(list_id, opts)
|
394
|
+
nil
|
395
|
+
end
|
396
|
+
|
397
|
+
# Delete All Records from a List
|
398
|
+
# Remove **all** of the records from a list. ***Note:*** *The list is not deleted.* This endpoint only works for lists that have a `processingType` of `MANUAL` or `SNAPSHOT`.
|
399
|
+
# @param list_id [Integer] The **ILS ID** of the `MANUAL` or `SNAPSHOT` list.
|
400
|
+
# @param [Hash] opts the optional parameters
|
401
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
402
|
+
def remove_all_with_http_info(list_id, opts = {})
|
403
|
+
if @api_client.config.debugging
|
404
|
+
@api_client.config.logger.debug 'Calling API: MembershipsApi.remove_all ...'
|
405
|
+
end
|
406
|
+
# verify the required parameter 'list_id' is set
|
407
|
+
if @api_client.config.client_side_validation && list_id.nil?
|
408
|
+
fail ArgumentError, "Missing the required parameter 'list_id' when calling MembershipsApi.remove_all"
|
409
|
+
end
|
410
|
+
# resource path
|
411
|
+
local_var_path = '/crm/v3/lists/{listId}/memberships'.sub('{' + 'listId' + '}', CGI.escape(list_id.to_s))
|
412
|
+
|
413
|
+
# query parameters
|
414
|
+
query_params = opts[:query_params] || {}
|
415
|
+
|
416
|
+
# header parameters
|
417
|
+
header_params = opts[:header_params] || {}
|
418
|
+
# HTTP header 'Accept' (if needed)
|
419
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
420
|
+
|
421
|
+
# form parameters
|
422
|
+
form_params = opts[:form_params] || {}
|
423
|
+
|
424
|
+
# http body (model)
|
425
|
+
post_body = opts[:debug_body]
|
426
|
+
|
427
|
+
# return_type
|
428
|
+
return_type = opts[:debug_return_type]
|
429
|
+
|
430
|
+
# auth_names
|
431
|
+
auth_names = opts[:debug_auth_names] || ['oauth2']
|
432
|
+
|
433
|
+
new_options = opts.merge(
|
434
|
+
:operation => :"MembershipsApi.remove_all",
|
435
|
+
:header_params => header_params,
|
436
|
+
:query_params => query_params,
|
437
|
+
:form_params => form_params,
|
438
|
+
:body => post_body,
|
439
|
+
:auth_names => auth_names,
|
440
|
+
:return_type => return_type
|
441
|
+
)
|
442
|
+
|
443
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
444
|
+
if @api_client.config.debugging
|
445
|
+
@api_client.config.logger.debug "API called: MembershipsApi#remove_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
446
|
+
end
|
447
|
+
return data, status_code, headers
|
448
|
+
end
|
449
|
+
end
|
450
|
+
end
|
451
|
+
end
|
452
|
+
end
|