=begin #Properties #All HubSpot objects store data in default and custom properties. These endpoints provide access to read and modify object properties in HubSpot. The version of the OpenAPI document: v3 Generated by: https://openapi-generator.tech OpenAPI Generator version: 4.2.3 =end require 'cgi' module Hubspot module Crm module Properties class BatchApi attr_accessor :api_client def initialize(api_client = ApiClient.default) @api_client = api_client end # Archive a batch of properties # Archive a provided list of properties. This method will return a 204 No Content response on success regardless of the initial state of the property (e.g. active, already archived, non-existent). # @param object_type [String] # @param batch_input_property_name [BatchInputPropertyName] # @param [Hash] opts the optional parameters # @return [nil] def archive(object_type, batch_input_property_name, opts = {}) archive_with_http_info(object_type, batch_input_property_name, opts) nil end # Archive a batch of properties # Archive a provided list of properties. This method will return a 204 No Content response on success regardless of the initial state of the property (e.g. active, already archived, non-existent). # @param object_type [String] # @param batch_input_property_name [BatchInputPropertyName] # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers def archive_with_http_info(object_type, batch_input_property_name, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BatchApi.archive ...' end # verify the required parameter 'object_type' is set if @api_client.config.client_side_validation && object_type.nil? fail ArgumentError, "Missing the required parameter 'object_type' when calling BatchApi.archive" end # verify the required parameter 'batch_input_property_name' is set if @api_client.config.client_side_validation && batch_input_property_name.nil? fail ArgumentError, "Missing the required parameter 'batch_input_property_name' when calling BatchApi.archive" end # resource path local_var_path = '/crm/v3/properties/{objectType}/batch/archive'.sub('{' + 'objectType' + '}', CGI.escape(object_type.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(batch_input_property_name) # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['hapikey', 'oauth2'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: BatchApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Create a batch of properties # Create a batch of properties using the same rules as when creating an individual property. # @param object_type [String] # @param batch_input_property_create [BatchInputPropertyCreate] # @param [Hash] opts the optional parameters # @return [BatchResponseProperty] def create(object_type, batch_input_property_create, opts = {}) data, _status_code, _headers = create_with_http_info(object_type, batch_input_property_create, opts) data end # Create a batch of properties # Create a batch of properties using the same rules as when creating an individual property. # @param object_type [String] # @param batch_input_property_create [BatchInputPropertyCreate] # @param [Hash] opts the optional parameters # @return [Array<(BatchResponseProperty, Integer, Hash)>] BatchResponseProperty data, response status code and response headers def create_with_http_info(object_type, batch_input_property_create, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BatchApi.create ...' end # verify the required parameter 'object_type' is set if @api_client.config.client_side_validation && object_type.nil? fail ArgumentError, "Missing the required parameter 'object_type' when calling BatchApi.create" end # verify the required parameter 'batch_input_property_create' is set if @api_client.config.client_side_validation && batch_input_property_create.nil? fail ArgumentError, "Missing the required parameter 'batch_input_property_create' when calling BatchApi.create" end # resource path local_var_path = '/crm/v3/properties/{objectType}/batch/create'.sub('{' + 'objectType' + '}', CGI.escape(object_type.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(batch_input_property_create) # return_type return_type = opts[:return_type] || 'BatchResponseProperty' # auth_names auth_names = opts[:auth_names] || ['hapikey', 'oauth2'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: BatchApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Read a batch of properties # Read a provided list of properties. # @param object_type [String] # @param batch_read_input_property_name [BatchReadInputPropertyName] # @param [Hash] opts the optional parameters # @return [BatchResponseProperty] def read(object_type, batch_read_input_property_name, opts = {}) data, _status_code, _headers = read_with_http_info(object_type, batch_read_input_property_name, opts) data end # Read a batch of properties # Read a provided list of properties. # @param object_type [String] # @param batch_read_input_property_name [BatchReadInputPropertyName] # @param [Hash] opts the optional parameters # @return [Array<(BatchResponseProperty, Integer, Hash)>] BatchResponseProperty data, response status code and response headers def read_with_http_info(object_type, batch_read_input_property_name, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BatchApi.read ...' end # verify the required parameter 'object_type' is set if @api_client.config.client_side_validation && object_type.nil? fail ArgumentError, "Missing the required parameter 'object_type' when calling BatchApi.read" end # verify the required parameter 'batch_read_input_property_name' is set if @api_client.config.client_side_validation && batch_read_input_property_name.nil? fail ArgumentError, "Missing the required parameter 'batch_read_input_property_name' when calling BatchApi.read" end # resource path local_var_path = '/crm/v3/properties/{objectType}/batch/read'.sub('{' + 'objectType' + '}', CGI.escape(object_type.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(batch_read_input_property_name) # return_type return_type = opts[:return_type] || 'BatchResponseProperty' # auth_names auth_names = opts[:auth_names] || ['hapikey', 'oauth2'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: BatchApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end end end end end