hubspot-api-client 16.0.4 → 16.1.1

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

@@ -0,0 +1,295 @@
+=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 BatchApi
+          attr_accessor :api_client
+
+          def initialize(api_client = ApiClient.default)
+            @api_client = api_client
+          end
+          # Archive a batch of postal mail by ID
+          # @param batch_input_simple_public_object_id [BatchInputSimplePublicObjectId] 
+          # @param [Hash] opts the optional parameters
+          # @return [nil]
+          def archive(batch_input_simple_public_object_id, opts = {})
+            archive_with_http_info(batch_input_simple_public_object_id, opts)
+            nil
+          end
+
+          # Archive a batch of postal mail by ID
+          # @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(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 '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/postal_mail/batch/archive'
+
+            # 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_simple_public_object_id)
+
+            # 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
+
+          # Create a batch of postal mail
+          # @param batch_input_simple_public_object_input [BatchInputSimplePublicObjectInput] 
+          # @param [Hash] opts the optional parameters
+          # @return [BatchResponseSimplePublicObject]
+          def create(batch_input_simple_public_object_input, opts = {})
+            data, _status_code, _headers = create_with_http_info(batch_input_simple_public_object_input, opts)
+            data
+          end
+
+          # Create a batch of postal mail
+          # @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(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 '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/postal_mail/batch/create'
+
+            # 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_simple_public_object_input)
+
+            # return_type
+            return_type = opts[:debug_return_type] || 'BatchResponseSimplePublicObject'
+
+            # 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
+
+          # Read a batch of postal mail by internal ID, or unique property values
+          # @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(batch_read_input_simple_public_object_id, opts = {})
+            data, _status_code, _headers = read_with_http_info(batch_read_input_simple_public_object_id, opts)
+            data
+          end
+
+          # Read a batch of postal mail by internal ID, or unique property values
+          # @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 [Array<(BatchResponseSimplePublicObject, Integer, Hash)>] BatchResponseSimplePublicObject data, response status code and response headers
+          def read_with_http_info(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 '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/postal_mail/batch/read'
+
+            # 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'
+            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_read_input_simple_public_object_id)
+
+            # return_type
+            return_type = opts[:debug_return_type] || 'BatchResponseSimplePublicObject'
+
+            # auth_names
+            auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']
+
+            new_options = opts.merge(
+              :operation => :"BatchApi.read",
+              :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 postal mail
+          # @param batch_input_simple_public_object_batch_input [BatchInputSimplePublicObjectBatchInput] 
+          # @param [Hash] opts the optional parameters
+          # @return [BatchResponseSimplePublicObject]
+          def update(batch_input_simple_public_object_batch_input, opts = {})
+            data, _status_code, _headers = update_with_http_info(batch_input_simple_public_object_batch_input, opts)
+            data
+          end
+
+          # Update a batch of postal mail
+          # @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(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 '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/postal_mail/batch/update'
+
+            # 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_simple_public_object_batch_input)
+
+            # return_type
+            return_type = opts[:debug_return_type] || 'BatchResponseSimplePublicObject'
+
+            # auth_names
+            auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']
+
+            new_options = opts.merge(
+              :operation => :"BatchApi.update",
+              :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
+end

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

@@ -0,0 +1,94 @@
+=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 PublicObjectApi
+          attr_accessor :api_client
+
+          def initialize(api_client = ApiClient.default)
+            @api_client = api_client
+          end
+          # Merge two postal mail with same type
+          # @param public_merge_input [PublicMergeInput] 
+          # @param [Hash] opts the optional parameters
+          # @return [SimplePublicObject]
+          def merge(public_merge_input, opts = {})
+            data, _status_code, _headers = merge_with_http_info(public_merge_input, opts)
+            data
+          end
+
+          # Merge two postal mail with same type
+          # @param public_merge_input [PublicMergeInput] 
+          # @param [Hash] opts the optional parameters
+          # @return [Array<(SimplePublicObject, Integer, Hash)>] SimplePublicObject data, response status code and response headers
+          def merge_with_http_info(public_merge_input, opts = {})
+            if @api_client.config.debugging
+              @api_client.config.logger.debug 'Calling API: PublicObjectApi.merge ...'
+            end
+            # verify the required parameter 'public_merge_input' is set
+            if @api_client.config.client_side_validation && public_merge_input.nil?
+              fail ArgumentError, "Missing the required parameter 'public_merge_input' when calling PublicObjectApi.merge"
+            end
+            # resource path
+            local_var_path = '/crm/v3/objects/postal_mail/merge'
+
+            # 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(public_merge_input)
+
+            # return_type
+            return_type = opts[:debug_return_type] || 'SimplePublicObject'
+
+            # auth_names
+            auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']
+
+            new_options = opts.merge(
+              :operation => :"PublicObjectApi.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: PublicObjectApi#merge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+            end
+            return data, status_code, headers
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,92 @@
+=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 SearchApi
+          attr_accessor :api_client
+
+          def initialize(api_client = ApiClient.default)
+            @api_client = api_client
+          end
+          # @param public_object_search_request [PublicObjectSearchRequest] 
+          # @param [Hash] opts the optional parameters
+          # @return [CollectionResponseWithTotalSimplePublicObjectForwardPaging]
+          def do_search(public_object_search_request, opts = {})
+            data, _status_code, _headers = do_search_with_http_info(public_object_search_request, opts)
+            data
+          end
+
+          # @param public_object_search_request [PublicObjectSearchRequest] 
+          # @param [Hash] opts the optional parameters
+          # @return [Array<(CollectionResponseWithTotalSimplePublicObjectForwardPaging, Integer, Hash)>] CollectionResponseWithTotalSimplePublicObjectForwardPaging data, response status code and response headers
+          def do_search_with_http_info(public_object_search_request, opts = {})
+            if @api_client.config.debugging
+              @api_client.config.logger.debug 'Calling API: SearchApi.do_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.do_search"
+            end
+            # resource path
+            local_var_path = '/crm/v3/objects/postal_mail/search'
+
+            # 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(public_object_search_request)
+
+            # return_type
+            return_type = opts[:debug_return_type] || 'CollectionResponseWithTotalSimplePublicObjectForwardPaging'
+
+            # auth_names
+            auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2']
+
+            new_options = opts.merge(
+              :operation => :"SearchApi.do_search",
+              :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#do_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+            end
+            return data, status_code, headers
+          end
+        end
+      end
+    end
+  end
+end