hubspot-api-client 16.2.1 → 16.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ded1ef7325c6a9ca806b8864e9b32f47aa31aa698b6f464db68d5ca2616791b
-  data.tar.gz: 2c9a7e63ada52b40e4916f75dc970c6cb90bcf7400add2332183eb4bf51f0dd7
+  metadata.gz: 52e4c8fb1abbce80746a0ba2d1a512e7f2402f42ddfa4330ed8a334e9798e6bc
+  data.tar.gz: 79f9c68a85531802bf73e1c9cf50095a4561ced51194882d5c57588d2470ca72
 SHA512:
-  metadata.gz: 70442a8cf0d156ebf43423659470162b3ec32a08ca1d30692a4a9d6c7baed548b3b7258ebe32ec7adef87fe200bc507f43f2a14e4309609fe385bdccb860de43
-  data.tar.gz: ecf9594a35dd4f048a90781233de0088189b3d6f06ba863902e63f0477826cfe07a231bf29c1c613d530d9df4e45416925df4070f30334f8b39ceb79251005e1
+  metadata.gz: c0d326e50bdddb2939422730caef3e4dc3036db7bdd2230c30f5c05e43f7f817506440e50f2da437ea8b09ef9b7e83ae10db6775a5830405ec8187e2626917a1
+  data.tar.gz: de8e1f260e0a1405608eeaab382c8b5b67c7e8d2a6a804c111b4bfdc71019ed56cd87925c507f9abf8b8ea7aced0bdb6d9ca96fa6c0e78b74a3a0100d7432a8a

data/CHANGELOG.md

@@ -5,7 +5,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased](https://github.com/HubSpot/hubspot-api-ruby/compare/v16.2.1...HEAD)
+## [Unreleased](https://github.com/HubSpot/hubspot-api-ruby/compare/v16.4.0...HEAD)
+
+## [16.4.0] - 2023-03-02
+### Added
+
+- Update models for `crm.properties` API client
+
+## [16.3.0] - 2023-02-21
+### Added
+
+- `crm.associations.v4` API client
+
+### Fixed
+
+- Fix `auth.oauth.refresh_tokens_api.archive_refresh_token` method
 
 
 ## [16.2.1] - 2023-01-24

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hubspot-api-client (16.2.1)
+    hubspot-api-client (16.4.0)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.4.0)
 

data/README.md

@@ -39,7 +39,7 @@ contacts = client.crm.contacts.basic_api.get_page
 Please, note that hapikey is no longer supported after v13.1.0. You can get more info about hapikey sunset [here](https://developers.hubspot.com/changelog/upcoming-api-key-sunset). Also, plese, visit a [migration guide](https://developers.hubspot.com/docs/api/migrate-an-api-key-integration-to-a-private-app) if you need help with a migration process.
 
 ### Get all:
-get_all method is available for all major objects (Companies, Contacts, Deals, LineItems, Products, Quotes & Tickets) and works like
+`get_all` method is available for all objects (Companies, Contacts, Deals and etc).
 
 ```ruby
 client = Hubspot::Client.new(access_token: 'your_oauth2_access_token')
@@ -50,6 +50,38 @@ You'll need to create a [private app](https://developers.hubspot.com/docs/api/pr
 
 Please note that pagination is used under the hood to get all results.
 
+## Search:
+`do_search` method is available for all objects (Companies, Contacts, Deals and etc).
+
+Only 3 `FilterGroups` with max 3 `Filters` are supported.
+
+### Example search by date
+```ruby
+require 'hubspot-api-client'
+require 'date'
+
+api_client = Hubspot::Client.new(access_token: "YOUR_ACCESS_TOKEN")
+# timestamp in milliseconds
+timestamp = (DateTime.parse("XXXX-XX-XXTXX:XX:XX.XXXZ").to_time.to_f * 1000).to_i.to_s
+body = {
+  "filterGroups":
+    [
+      {
+        "filters":[
+          {
+            "value": timestamp,
+            "propertyName":"lastmodifieddate",
+            "operator":"EQ"
+          }
+        ]
+      }
+    ]
+}
+api_response = api_client.crm.contacts.search_api.do_search(
+  body: body
+)
+puts api_response
+```
 
 ### Crm Object Schemas client usage:
 

data/lib/hubspot/codegen/crm/associations/v4/api/batch_api.rb

@@ -0,0 +1,428 @@
+=begin
+#CrmPublicAssociationsServiceV4
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v4
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'cgi'
+
+module Hubspot
+  module Crm
+    module Associations
+      module V4
+        class BatchApi
+          attr_accessor :api_client
+
+          def initialize(api_client = ApiClient.default)
+            @api_client = api_client
+          end
+          # Delete
+          # Batch delete associations for objects
+          # @param from_object_type [String] 
+          # @param to_object_type [String] 
+          # @param batch_input_public_association_multi_archive [BatchInputPublicAssociationMultiArchive] 
+          # @param [Hash] opts the optional parameters
+          # @return [nil]
+          def archive(from_object_type, to_object_type, batch_input_public_association_multi_archive, opts = {})
+            archive_with_http_info(from_object_type, to_object_type, batch_input_public_association_multi_archive, opts)
+            nil
+          end
+
+          # Delete
+          # Batch delete associations for objects
+          # @param from_object_type [String] 
+          # @param to_object_type [String] 
+          # @param batch_input_public_association_multi_archive [BatchInputPublicAssociationMultiArchive] 
+          # @param [Hash] opts the optional parameters
+          # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+          def archive_with_http_info(from_object_type, to_object_type, batch_input_public_association_multi_archive, opts = {})
+            if @api_client.config.debugging
+              @api_client.config.logger.debug 'Calling API: BatchApi.archive ...'
+            end
+            # verify the required parameter 'from_object_type' is set
+            if @api_client.config.client_side_validation && from_object_type.nil?
+              fail ArgumentError, "Missing the required parameter 'from_object_type' when calling BatchApi.archive"
+            end
+            # verify the required parameter 'to_object_type' is set
+            if @api_client.config.client_side_validation && to_object_type.nil?
+              fail ArgumentError, "Missing the required parameter 'to_object_type' when calling BatchApi.archive"
+            end
+            # verify the required parameter 'batch_input_public_association_multi_archive' is set
+            if @api_client.config.client_side_validation && batch_input_public_association_multi_archive.nil?
+              fail ArgumentError, "Missing the required parameter 'batch_input_public_association_multi_archive' when calling BatchApi.archive"
+            end
+            # resource path
+            local_var_path = '/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/archive'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_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'
+            content_type = @api_client.select_header_content_type(['application/json'])
+            if !content_type.nil?
+                header_params['Content-Type'] = content_type
+            end
+
+            # form parameters
+            form_params = opts[:form_params] || {}
+
+            # http body (model)
+            post_body = opts[:debug_body] || @api_client.object_to_http_body(batch_input_public_association_multi_archive)
+
+            # return_type
+            return_type = opts[:debug_return_type]
+
+            # auth_names
+            auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']
+
+            new_options = opts.merge(
+              :operation => :"BatchApi.archive",
+              :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
+
+          # Delete Specific Labels
+          # Batch delete specific association labels for objects. Deleting an unlabeled association will also delete all labeled associations between those two objects
+          # @param from_object_type [String] 
+          # @param to_object_type [String] 
+          # @param batch_input_public_association_multi_post [BatchInputPublicAssociationMultiPost] 
+          # @param [Hash] opts the optional parameters
+          # @return [nil]
+          def archive_labels(from_object_type, to_object_type, batch_input_public_association_multi_post, opts = {})
+            archive_labels_with_http_info(from_object_type, to_object_type, batch_input_public_association_multi_post, opts)
+            nil
+          end
+
+          # Delete Specific Labels
+          # Batch delete specific association labels for objects. Deleting an unlabeled association will also delete all labeled associations between those two objects
+          # @param from_object_type [String] 
+          # @param to_object_type [String] 
+          # @param batch_input_public_association_multi_post [BatchInputPublicAssociationMultiPost] 
+          # @param [Hash] opts the optional parameters
+          # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+          def archive_labels_with_http_info(from_object_type, to_object_type, batch_input_public_association_multi_post, opts = {})
+            if @api_client.config.debugging
+              @api_client.config.logger.debug 'Calling API: BatchApi.archive_labels ...'
+            end
+            # verify the required parameter 'from_object_type' is set
+            if @api_client.config.client_side_validation && from_object_type.nil?
+              fail ArgumentError, "Missing the required parameter 'from_object_type' when calling BatchApi.archive_labels"
+            end
+            # verify the required parameter 'to_object_type' is set
+            if @api_client.config.client_side_validation && to_object_type.nil?
+              fail ArgumentError, "Missing the required parameter 'to_object_type' when calling BatchApi.archive_labels"
+            end
+            # verify the required parameter 'batch_input_public_association_multi_post' is set
+            if @api_client.config.client_side_validation && batch_input_public_association_multi_post.nil?
+              fail ArgumentError, "Missing the required parameter 'batch_input_public_association_multi_post' when calling BatchApi.archive_labels"
+            end
+            # resource path
+            local_var_path = '/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/labels/archive'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_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'
+            content_type = @api_client.select_header_content_type(['application/json'])
+            if !content_type.nil?
+                header_params['Content-Type'] = content_type
+            end
+
+            # form parameters
+            form_params = opts[:form_params] || {}
+
+            # http body (model)
+            post_body = opts[:debug_body] || @api_client.object_to_http_body(batch_input_public_association_multi_post)
+
+            # return_type
+            return_type = opts[:debug_return_type]
+
+            # auth_names
+            auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']
+
+            new_options = opts.merge(
+              :operation => :"BatchApi.archive_labels",
+              :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_labels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+            end
+            return data, status_code, headers
+          end
+
+          # Create
+          # Batch create associations for objects
+          # @param from_object_type [String] 
+          # @param to_object_type [String] 
+          # @param batch_input_public_association_multi_post [BatchInputPublicAssociationMultiPost] 
+          # @param [Hash] opts the optional parameters
+          # @return [BatchResponseLabelsBetweenObjectPair]
+          def create(from_object_type, to_object_type, batch_input_public_association_multi_post, opts = {})
+            data, _status_code, _headers = create_with_http_info(from_object_type, to_object_type, batch_input_public_association_multi_post, opts)
+            data
+          end
+
+          # Create
+          # Batch create associations for objects
+          # @param from_object_type [String] 
+          # @param to_object_type [String] 
+          # @param batch_input_public_association_multi_post [BatchInputPublicAssociationMultiPost] 
+          # @param [Hash] opts the optional parameters
+          # @return [Array<(BatchResponseLabelsBetweenObjectPair, Integer, Hash)>] BatchResponseLabelsBetweenObjectPair data, response status code and response headers
+          def create_with_http_info(from_object_type, to_object_type, batch_input_public_association_multi_post, opts = {})
+            if @api_client.config.debugging
+              @api_client.config.logger.debug 'Calling API: BatchApi.create ...'
+            end
+            # verify the required parameter 'from_object_type' is set
+            if @api_client.config.client_side_validation && from_object_type.nil?
+              fail ArgumentError, "Missing the required parameter 'from_object_type' when calling BatchApi.create"
+            end
+            # verify the required parameter 'to_object_type' is set
+            if @api_client.config.client_side_validation && to_object_type.nil?
+              fail ArgumentError, "Missing the required parameter 'to_object_type' when calling BatchApi.create"
+            end
+            # verify the required parameter 'batch_input_public_association_multi_post' is set
+            if @api_client.config.client_side_validation && batch_input_public_association_multi_post.nil?
+              fail ArgumentError, "Missing the required parameter 'batch_input_public_association_multi_post' when calling BatchApi.create"
+            end
+            # resource path
+            local_var_path = '/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/create'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_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'
+            content_type = @api_client.select_header_content_type(['application/json'])
+            if !content_type.nil?
+                header_params['Content-Type'] = content_type
+            end
+
+            # form parameters
+            form_params = opts[:form_params] || {}
+
+            # http body (model)
+            post_body = opts[:debug_body] || @api_client.object_to_http_body(batch_input_public_association_multi_post)
+
+            # return_type
+            return_type = opts[:debug_return_type] || 'BatchResponseLabelsBetweenObjectPair'
+
+            # auth_names
+            auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']
+
+            new_options = opts.merge(
+              :operation => :"BatchApi.create",
+              :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
+
+          #  Create Default Associations
+          # Create the default (most generic) association type between two object types
+          # @param from_object_type [String] 
+          # @param to_object_type [String] 
+          # @param batch_input_public_default_association_multi_post [BatchInputPublicDefaultAssociationMultiPost] 
+          # @param [Hash] opts the optional parameters
+          # @return [BatchResponsePublicDefaultAssociation]
+          def create_default(from_object_type, to_object_type, batch_input_public_default_association_multi_post, opts = {})
+            data, _status_code, _headers = create_default_with_http_info(from_object_type, to_object_type, batch_input_public_default_association_multi_post, opts)
+            data
+          end
+
+          #  Create Default Associations
+          # Create the default (most generic) association type between two object types
+          # @param from_object_type [String] 
+          # @param to_object_type [String] 
+          # @param batch_input_public_default_association_multi_post [BatchInputPublicDefaultAssociationMultiPost] 
+          # @param [Hash] opts the optional parameters
+          # @return [Array<(BatchResponsePublicDefaultAssociation, Integer, Hash)>] BatchResponsePublicDefaultAssociation data, response status code and response headers
+          def create_default_with_http_info(from_object_type, to_object_type, batch_input_public_default_association_multi_post, opts = {})
+            if @api_client.config.debugging
+              @api_client.config.logger.debug 'Calling API: BatchApi.create_default ...'
+            end
+            # verify the required parameter 'from_object_type' is set
+            if @api_client.config.client_side_validation && from_object_type.nil?
+              fail ArgumentError, "Missing the required parameter 'from_object_type' when calling BatchApi.create_default"
+            end
+            # verify the required parameter 'to_object_type' is set
+            if @api_client.config.client_side_validation && to_object_type.nil?
+              fail ArgumentError, "Missing the required parameter 'to_object_type' when calling BatchApi.create_default"
+            end
+            # verify the required parameter 'batch_input_public_default_association_multi_post' is set
+            if @api_client.config.client_side_validation && batch_input_public_default_association_multi_post.nil?
+              fail ArgumentError, "Missing the required parameter 'batch_input_public_default_association_multi_post' when calling BatchApi.create_default"
+            end
+            # resource path
+            local_var_path = '/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/associate/default'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_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'
+            content_type = @api_client.select_header_content_type(['application/json'])
+            if !content_type.nil?
+                header_params['Content-Type'] = content_type
+            end
+
+            # form parameters
+            form_params = opts[:form_params] || {}
+
+            # http body (model)
+            post_body = opts[:debug_body] || @api_client.object_to_http_body(batch_input_public_default_association_multi_post)
+
+            # return_type
+            return_type = opts[:debug_return_type] || 'BatchResponsePublicDefaultAssociation'
+
+            # auth_names
+            auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']
+
+            new_options = opts.merge(
+              :operation => :"BatchApi.create_default",
+              :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_default\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+            end
+            return data, status_code, headers
+          end
+
+          # Read
+          # Batch read associations for objects to specific object type. The 'after' field in a returned paging object  can be added alongside the 'id' to retrieve the next page of associations from that objectId. The 'link' field is deprecated and should be ignored. 
+          # @param from_object_type [String] 
+          # @param to_object_type [String] 
+          # @param batch_input_public_fetch_associations_batch_request [BatchInputPublicFetchAssociationsBatchRequest] 
+          # @param [Hash] opts the optional parameters
+          # @return [BatchResponsePublicAssociationMultiWithLabel]
+          def get_page(from_object_type, to_object_type, batch_input_public_fetch_associations_batch_request, opts = {})
+            data, _status_code, _headers = get_page_with_http_info(from_object_type, to_object_type, batch_input_public_fetch_associations_batch_request, opts)
+            data
+          end
+
+          # Read
+          # Batch read associations for objects to specific object type. The &#39;after&#39; field in a returned paging object  can be added alongside the &#39;id&#39; to retrieve the next page of associations from that objectId. The &#39;link&#39; field is deprecated and should be ignored. 
+          # @param from_object_type [String] 
+          # @param to_object_type [String] 
+          # @param batch_input_public_fetch_associations_batch_request [BatchInputPublicFetchAssociationsBatchRequest] 
+          # @param [Hash] opts the optional parameters
+          # @return [Array<(BatchResponsePublicAssociationMultiWithLabel, Integer, Hash)>] BatchResponsePublicAssociationMultiWithLabel data, response status code and response headers
+          def get_page_with_http_info(from_object_type, to_object_type, batch_input_public_fetch_associations_batch_request, opts = {})
+            if @api_client.config.debugging
+              @api_client.config.logger.debug 'Calling API: BatchApi.get_page ...'
+            end
+            # verify the required parameter 'from_object_type' is set
+            if @api_client.config.client_side_validation && from_object_type.nil?
+              fail ArgumentError, "Missing the required parameter 'from_object_type' when calling BatchApi.get_page"
+            end
+            # verify the required parameter 'to_object_type' is set
+            if @api_client.config.client_side_validation && to_object_type.nil?
+              fail ArgumentError, "Missing the required parameter 'to_object_type' when calling BatchApi.get_page"
+            end
+            # verify the required parameter 'batch_input_public_fetch_associations_batch_request' is set
+            if @api_client.config.client_side_validation && batch_input_public_fetch_associations_batch_request.nil?
+              fail ArgumentError, "Missing the required parameter 'batch_input_public_fetch_associations_batch_request' when calling BatchApi.get_page"
+            end
+            # resource path
+            local_var_path = '/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/read'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_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'
+            content_type = @api_client.select_header_content_type(['application/json'])
+            if !content_type.nil?
+                header_params['Content-Type'] = content_type
+            end
+
+            # form parameters
+            form_params = opts[:form_params] || {}
+
+            # http body (model)
+            post_body = opts[:debug_body] || @api_client.object_to_http_body(batch_input_public_fetch_associations_batch_request)
+
+            # return_type
+            return_type = opts[:debug_return_type] || 'BatchResponsePublicAssociationMultiWithLabel'
+
+            # auth_names
+            auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']
+
+            new_options = opts.merge(
+              :operation => :"BatchApi.get_page",
+              :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#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+            end
+            return data, status_code, headers
+          end
+        end
+      end
+    end
+  end
+end