hubspot-api-client 16.0.4 → 16.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8204da9cda81deddc0e84762accf9428dc794cf0164b9f1e34008ebc04f39ac
-  data.tar.gz: 6a9e42f140a5598203c427d7f262eff8cd7482fedd562a8898e3f6284b9b503b
+  metadata.gz: 79bd74c64d716c37ef44d823499d823a5718cbc9b2bddbee9153ace3e92846b2
+  data.tar.gz: 6b2305f92d525f62f9ccca5883e87bb11d2b9971150af08fe9f508b4f4d9188f
 SHA512:
-  metadata.gz: 5146fdebcceeb22af4ca68028ad99aa1f31e17a53908cc6b4c7051b882a45ff2a31353ea78b4d6a90957e775a440a5601ce76016e37bda14b7d156a4a89bac3b
-  data.tar.gz: 71f6717ff5bbcc6af9c43006ffb942906d624ec15b040059f1fd34963bdb97c7b0516765af796059acea0aa13cd563dc355269a121de8e9b77be7eacc865c37e
+  metadata.gz: 47b6759f025b1dc365f841974763cc3cdde18f8a62245079772073ae6eb296d0d5716081daedff991a5e9dba29060f24dfff73e7944f0d250600ccd5c5b6b3ee
+  data.tar.gz: e0fddcf226c4b0cbffd2e3690b167bfcbc016f8d62920ef70efaea438ff5bfc63eb6eb71091db8d8400cd8724a403d40c4e94d3ebc6a7e28f85ce583aed71f74

data/CHANGELOG.md

@@ -5,6 +5,11 @@ 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).
 
+## [16.1.0] - 2022-12-22
+### Added
+
+- crm.objects.postal_mail API client
+
 ## [16.0.4] - 2022-12-08
 ### Changed
 

data/Gemfile.lock

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

data/lib/hubspot/codegen/crm/objects/postal_mail/api/associations_api.rb

@@ -0,0 +1,264 @@
+=begin
+#Postal Mail
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'cgi'
+
+module Hubspot
+  module Crm
+    module Objects
+      module PostalMail
+        class AssociationsApi
+          attr_accessor :api_client
+
+          def initialize(api_client = ApiClient.default)
+            @api_client = api_client
+          end
+          # Delete
+          # deletes all associations between two records.
+          # @param postal_mail [Integer] 
+          # @param to_object_type [String] 
+          # @param to_object_id [Integer] 
+          # @param [Hash] opts the optional parameters
+          # @return [nil]
+          def archive(postal_mail, to_object_type, to_object_id, opts = {})
+            archive_with_http_info(postal_mail, to_object_type, to_object_id, opts)
+            nil
+          end
+
+          # Delete
+          # deletes all associations between two records.
+          # @param postal_mail [Integer] 
+          # @param to_object_type [String] 
+          # @param to_object_id [Integer] 
+          # @param [Hash] opts the optional parameters
+          # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+          def archive_with_http_info(postal_mail, to_object_type, to_object_id, opts = {})
+            if @api_client.config.debugging
+              @api_client.config.logger.debug 'Calling API: AssociationsApi.archive ...'
+            end
+            # verify the required parameter 'postal_mail' is set
+            if @api_client.config.client_side_validation && postal_mail.nil?
+              fail ArgumentError, "Missing the required parameter 'postal_mail' when calling AssociationsApi.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 AssociationsApi.archive"
+            end
+            # verify the required parameter 'to_object_id' is set
+            if @api_client.config.client_side_validation && to_object_id.nil?
+              fail ArgumentError, "Missing the required parameter 'to_object_id' when calling AssociationsApi.archive"
+            end
+            # resource path
+            local_var_path = '/crm/v4/objects/postal_mail/{postalMail}/associations/{toObjectType}/{toObjectId}'.sub('{' + 'postalMail' + '}', CGI.escape(postal_mail.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s)).sub('{' + 'toObjectId' + '}', CGI.escape(to_object_id.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(['*/*'])
+
+            # form parameters
+            form_params = opts[:form_params] || {}
+
+            # http body (model)
+            post_body = opts[:debug_body]
+
+            # return_type
+            return_type = opts[:debug_return_type]
+
+            # auth_names
+            auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']
+
+            new_options = opts.merge(
+              :operation => :"AssociationsApi.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(:DELETE, local_var_path, new_options)
+            if @api_client.config.debugging
+              @api_client.config.logger.debug "API called: AssociationsApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+            end
+            return data, status_code, headers
+          end
+
+          # Create
+          # Set association labels between two records.
+          # @param postal_mail [Integer] 
+          # @param to_object_type [String] 
+          # @param to_object_id [Integer] 
+          # @param association_spec [Array<AssociationSpec>] 
+          # @param [Hash] opts the optional parameters
+          # @return [LabelsBetweenObjectPair]
+          def create(postal_mail, to_object_type, to_object_id, association_spec, opts = {})
+            data, _status_code, _headers = create_with_http_info(postal_mail, to_object_type, to_object_id, association_spec, opts)
+            data
+          end
+
+          # Create
+          # Set association labels between two records.
+          # @param postal_mail [Integer] 
+          # @param to_object_type [String] 
+          # @param to_object_id [Integer] 
+          # @param association_spec [Array<AssociationSpec>] 
+          # @param [Hash] opts the optional parameters
+          # @return [Array<(LabelsBetweenObjectPair, Integer, Hash)>] LabelsBetweenObjectPair data, response status code and response headers
+          def create_with_http_info(postal_mail, to_object_type, to_object_id, association_spec, opts = {})
+            if @api_client.config.debugging
+              @api_client.config.logger.debug 'Calling API: AssociationsApi.create ...'
+            end
+            # verify the required parameter 'postal_mail' is set
+            if @api_client.config.client_side_validation && postal_mail.nil?
+              fail ArgumentError, "Missing the required parameter 'postal_mail' when calling AssociationsApi.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 AssociationsApi.create"
+            end
+            # verify the required parameter 'to_object_id' is set
+            if @api_client.config.client_side_validation && to_object_id.nil?
+              fail ArgumentError, "Missing the required parameter 'to_object_id' when calling AssociationsApi.create"
+            end
+            # verify the required parameter 'association_spec' is set
+            if @api_client.config.client_side_validation && association_spec.nil?
+              fail ArgumentError, "Missing the required parameter 'association_spec' when calling AssociationsApi.create"
+            end
+            # resource path
+            local_var_path = '/crm/v4/objects/postal_mail/{postalMail}/associations/{toObjectType}/{toObjectId}'.sub('{' + 'postalMail' + '}', CGI.escape(postal_mail.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s)).sub('{' + 'toObjectId' + '}', CGI.escape(to_object_id.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(association_spec)
+
+            # return_type
+            return_type = opts[:debug_return_type] || 'LabelsBetweenObjectPair'
+
+            # auth_names
+            auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']
+
+            new_options = opts.merge(
+              :operation => :"AssociationsApi.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(:PUT, local_var_path, new_options)
+            if @api_client.config.debugging
+              @api_client.config.logger.debug "API called: AssociationsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+            end
+            return data, status_code, headers
+          end
+
+          # List
+          # List all associations of a postal mail by object type. Limit 1000 per call.
+          # @param postal_mail [Integer] 
+          # @param to_object_type [String] 
+          # @param [Hash] opts the optional parameters
+          # @option opts [String] :after The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.
+          # @option opts [Integer] :limit The maximum number of results to display per page. (default to 500)
+          # @return [CollectionResponseMultiAssociatedObjectWithLabelForwardPaging]
+          def get_all(postal_mail, to_object_type, opts = {})
+            data, _status_code, _headers = get_all_with_http_info(postal_mail, to_object_type, opts)
+            data
+          end
+
+          # List
+          # List all associations of a postal mail by object type. Limit 1000 per call.
+          # @param postal_mail [Integer] 
+          # @param to_object_type [String] 
+          # @param [Hash] opts the optional parameters
+          # @option opts [String] :after The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.
+          # @option opts [Integer] :limit The maximum number of results to display per page. (default to 500)
+          # @return [Array<(CollectionResponseMultiAssociatedObjectWithLabelForwardPaging, Integer, Hash)>] CollectionResponseMultiAssociatedObjectWithLabelForwardPaging data, response status code and response headers
+          def get_all_with_http_info(postal_mail, to_object_type, opts = {})
+            if @api_client.config.debugging
+              @api_client.config.logger.debug 'Calling API: AssociationsApi.get_all ...'
+            end
+            # verify the required parameter 'postal_mail' is set
+            if @api_client.config.client_side_validation && postal_mail.nil?
+              fail ArgumentError, "Missing the required parameter 'postal_mail' when calling AssociationsApi.get_all"
+            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 AssociationsApi.get_all"
+            end
+            # resource path
+            local_var_path = '/crm/v4/objects/postal_mail/{postalMail}/associations/{toObjectType}'.sub('{' + 'postalMail' + '}', CGI.escape(postal_mail.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s))
+
+            # query parameters
+            query_params = opts[:query_params] || {}
+            query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
+            query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+
+            # header parameters
+            header_params = opts[:header_params] || {}
+            # HTTP header 'Accept' (if needed)
+            header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])
+
+            # form parameters
+            form_params = opts[:form_params] || {}
+
+            # http body (model)
+            post_body = opts[:debug_body]
+
+            # return_type
+            return_type = opts[:debug_return_type] || 'CollectionResponseMultiAssociatedObjectWithLabelForwardPaging'
+
+            # auth_names
+            auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']
+
+            new_options = opts.merge(
+              :operation => :"AssociationsApi.get_all",
+              :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(:GET, local_var_path, new_options)
+            if @api_client.config.debugging
+              @api_client.config.logger.debug "API called: AssociationsApi#get_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+            end
+            return data, status_code, headers
+          end
+        end
+      end
+    end
+  end
+end