hubspot-api-client 7.1.0 → 8.0.0

data/lib/hubspot/codegen/crm/objects/api/batch_api.rb

@@ -0,0 +1,309 @@
+=begin
+#CRM Objects
+
+#CRM objects such as companies, contacts, deals, line items, products, tickets, and quotes are standard objects in HubSpot’s CRM. These core building blocks support custom properties, store critical information, and play a central role in the HubSpot application.  ## Supported Object Types  This API provides access to collections of CRM objects, which return a map of property names to values. Each object type has its own set of default properties, which can be found by exploring the [CRM Object Properties API](https://developers.hubspot.com/docs/methods/crm-properties/crm-properties-overview).  |Object Type |Properties returned by default | |--|--| | `companies` | `name`, `domain` | | `contacts` | `firstname`, `lastname`, `email` | | `deals` | `dealname`, `amount`, `closedate`, `pipeline`, `dealstage` | | `products` | `name`, `description`, `price` | | `tickets` | `content`, `hs_pipeline`, `hs_pipeline_stage`, `hs_ticket_category`, `hs_ticket_priority`, `subject` |  Find a list of all properties for an object type using the [CRM Object Properties](https://developers.hubspot.com/docs/methods/crm-properties/get-properties) API. e.g. `GET https://api.hubapi.com/properties/v2/companies/properties`. Change the properties returned in the response using the `properties` array in the request body.
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'cgi'
+
+module Hubspot
+  module Crm
+    module Objects
+      class BatchApi
+        attr_accessor :api_client
+
+        def initialize(api_client = ApiClient.default)
+          @api_client = api_client
+        end
+        # Archive a batch of objects by ID
+        # Archive a list of objects given a collection of IDs. This method will return a `204 No Content` response on success regardless of the initial state of the object (e.g. active, already archived, non-existent).
+        # @param object_type [String] 
+        # @param batch_input_simple_public_object_id [BatchInputSimplePublicObjectId] 
+        # @param [Hash] opts the optional parameters
+        # @return [nil]
+        def archive(object_type, batch_input_simple_public_object_id, opts = {})
+          archive_with_http_info(object_type, batch_input_simple_public_object_id, opts)
+          nil
+        end
+
+        # Archive a batch of objects by ID
+        # Archive a list of objects given a collection of IDs. This method will return a `204 No Content` response on success regardless of the initial state of the object (e.g. active, already archived, non-existent).
+        # @param object_type [String] 
+        # @param batch_input_simple_public_object_id [BatchInputSimplePublicObjectId] 
+        # @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_simple_public_object_id, 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_simple_public_object_id' is set
+          if @api_client.config.client_side_validation && batch_input_simple_public_object_id.nil?
+            fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_id' when calling BatchApi.archive"
+          end
+          # resource path
+          local_var_path = '/crm/v3/objects/{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_simple_public_object_id) 
+
+          # 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 objects
+        # Create a batch of objects. This follows the same rules as creating an individual object.
+        # @param object_type [String] 
+        # @param batch_input_simple_public_object_input [BatchInputSimplePublicObjectInput] 
+        # @param [Hash] opts the optional parameters
+        # @return [BatchResponseSimplePublicObject]
+        def create(object_type, batch_input_simple_public_object_input, opts = {})
+          data, _status_code, _headers = create_with_http_info(object_type, batch_input_simple_public_object_input, opts)
+          data
+        end
+
+        # Create a batch of objects
+        # Create a batch of objects. This follows the same rules as creating an individual object.
+        # @param object_type [String] 
+        # @param batch_input_simple_public_object_input [BatchInputSimplePublicObjectInput] 
+        # @param [Hash] opts the optional parameters
+        # @return [Array<(BatchResponseSimplePublicObject, Integer, Hash)>] BatchResponseSimplePublicObject data, response status code and response headers
+        def create_with_http_info(object_type, batch_input_simple_public_object_input, 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_simple_public_object_input' is set
+          if @api_client.config.client_side_validation && batch_input_simple_public_object_input.nil?
+            fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_input' when calling BatchApi.create"
+          end
+          # resource path
+          local_var_path = '/crm/v3/objects/{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_simple_public_object_input) 
+
+          # return_type
+          return_type = opts[:return_type] || 'BatchResponseSimplePublicObject' 
+
+          # 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 objects by internal ID, or unique property values
+        # Read a list of objects given a collection of IDs. Use the `properties` request body property to control which properties are returned.
+        # @param object_type [String] 
+        # @param batch_read_input_simple_public_object_id [BatchReadInputSimplePublicObjectId] 
+        # @param [Hash] opts the optional parameters
+        # @option opts [Boolean] :archived Whether to return only results that have been archived. (default to false)
+        # @return [BatchResponseSimplePublicObject]
+        def read(object_type, batch_read_input_simple_public_object_id, opts = {})
+          data, _status_code, _headers = read_with_http_info(object_type, batch_read_input_simple_public_object_id, opts)
+          data
+        end
+
+        # Read a batch of objects by internal ID, or unique property values
+        # Read a list of objects given a collection of IDs. Use the &#x60;properties&#x60; request body property to control which properties are returned.
+        # @param object_type [String] 
+        # @param batch_read_input_simple_public_object_id [BatchReadInputSimplePublicObjectId] 
+        # @param [Hash] opts the optional parameters
+        # @option opts [Boolean] :archived Whether to return only results that have been archived.
+        # @return [Array<(BatchResponseSimplePublicObject, Integer, Hash)>] BatchResponseSimplePublicObject data, response status code and response headers
+        def read_with_http_info(object_type, batch_read_input_simple_public_object_id, 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_simple_public_object_id' is set
+          if @api_client.config.client_side_validation && batch_read_input_simple_public_object_id.nil?
+            fail ArgumentError, "Missing the required parameter 'batch_read_input_simple_public_object_id' when calling BatchApi.read"
+          end
+          # resource path
+          local_var_path = '/crm/v3/objects/{objectType}/batch/read'.sub('{' + 'objectType' + '}', CGI.escape(object_type.to_s))
+
+          # query parameters
+          query_params = opts[:query_params] || {}
+          query_params[:'archived'] = opts[:'archived'] if !opts[:'archived'].nil?
+
+          # 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_simple_public_object_id) 
+
+          # return_type
+          return_type = opts[:return_type] || 'BatchResponseSimplePublicObject' 
+
+          # 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
+
+        # Update a batch of objects
+        # Perform a partial upate on a batch of objects. This follows the same rules as performing partial updates on an individual object.
+        # @param object_type [String] 
+        # @param batch_input_simple_public_object_batch_input [BatchInputSimplePublicObjectBatchInput] 
+        # @param [Hash] opts the optional parameters
+        # @return [BatchResponseSimplePublicObject]
+        def update(object_type, batch_input_simple_public_object_batch_input, opts = {})
+          data, _status_code, _headers = update_with_http_info(object_type, batch_input_simple_public_object_batch_input, opts)
+          data
+        end
+
+        # Update a batch of objects
+        # Perform a partial upate on a batch of objects. This follows the same rules as performing partial updates on an individual object.
+        # @param object_type [String] 
+        # @param batch_input_simple_public_object_batch_input [BatchInputSimplePublicObjectBatchInput] 
+        # @param [Hash] opts the optional parameters
+        # @return [Array<(BatchResponseSimplePublicObject, Integer, Hash)>] BatchResponseSimplePublicObject data, response status code and response headers
+        def update_with_http_info(object_type, batch_input_simple_public_object_batch_input, opts = {})
+          if @api_client.config.debugging
+            @api_client.config.logger.debug 'Calling API: BatchApi.update ...'
+          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.update"
+          end
+          # verify the required parameter 'batch_input_simple_public_object_batch_input' is set
+          if @api_client.config.client_side_validation && batch_input_simple_public_object_batch_input.nil?
+            fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_batch_input' when calling BatchApi.update"
+          end
+          # resource path
+          local_var_path = '/crm/v3/objects/{objectType}/batch/update'.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_simple_public_object_batch_input) 
+
+          # return_type
+          return_type = opts[:return_type] || 'BatchResponseSimplePublicObject' 
+
+          # 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#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          end
+          return data, status_code, headers
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/codegen/crm/objects/api/search_api.rb

@@ -0,0 +1,96 @@
+=begin
+#CRM Objects
+
+#CRM objects such as companies, contacts, deals, line items, products, tickets, and quotes are standard objects in HubSpot’s CRM. These core building blocks support custom properties, store critical information, and play a central role in the HubSpot application.  ## Supported Object Types  This API provides access to collections of CRM objects, which return a map of property names to values. Each object type has its own set of default properties, which can be found by exploring the [CRM Object Properties API](https://developers.hubspot.com/docs/methods/crm-properties/crm-properties-overview).  |Object Type |Properties returned by default | |--|--| | `companies` | `name`, `domain` | | `contacts` | `firstname`, `lastname`, `email` | | `deals` | `dealname`, `amount`, `closedate`, `pipeline`, `dealstage` | | `products` | `name`, `description`, `price` | | `tickets` | `content`, `hs_pipeline`, `hs_pipeline_stage`, `hs_ticket_category`, `hs_ticket_priority`, `subject` |  Find a list of all properties for an object type using the [CRM Object Properties](https://developers.hubspot.com/docs/methods/crm-properties/get-properties) API. e.g. `GET https://api.hubapi.com/properties/v2/companies/properties`. Change the properties returned in the response using the `properties` array in the request body.
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'cgi'
+
+module Hubspot
+  module Crm
+    module Objects
+      class SearchApi
+        attr_accessor :api_client
+
+        def initialize(api_client = ApiClient.default)
+          @api_client = api_client
+        end
+        # Filter, Sort, and Search CRM Objects
+        # Filter, Sort, and Search CRM Objects
+        # @param object_type [String] 
+        # @param public_object_search_request [PublicObjectSearchRequest] 
+        # @param [Hash] opts the optional parameters
+        # @return [CollectionResponseWithTotalSimplePublicObject]
+        def search(object_type, public_object_search_request, opts = {})
+          data, _status_code, _headers = search_with_http_info(object_type, public_object_search_request, opts)
+          data
+        end
+
+        # Filter, Sort, and Search CRM Objects
+        # Filter, Sort, and Search CRM Objects
+        # @param object_type [String] 
+        # @param public_object_search_request [PublicObjectSearchRequest] 
+        # @param [Hash] opts the optional parameters
+        # @return [Array<(CollectionResponseWithTotalSimplePublicObject, Integer, Hash)>] CollectionResponseWithTotalSimplePublicObject data, response status code and response headers
+        def search_with_http_info(object_type, public_object_search_request, opts = {})
+          if @api_client.config.debugging
+            @api_client.config.logger.debug 'Calling API: SearchApi.search ...'
+          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 SearchApi.search"
+          end
+          # verify the required parameter 'public_object_search_request' is set
+          if @api_client.config.client_side_validation && public_object_search_request.nil?
+            fail ArgumentError, "Missing the required parameter 'public_object_search_request' when calling SearchApi.search"
+          end
+          # resource path
+          local_var_path = '/crm/v3/objects/{objectType}/search'.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(public_object_search_request) 
+
+          # return_type
+          return_type = opts[:return_type] || 'CollectionResponseWithTotalSimplePublicObject' 
+
+          # 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: SearchApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+          end
+          return data, status_code, headers
+        end
+      end
+    end
+  end
+end