hubspot-api-client 9.3.0 → 9.4.0

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

@@ -0,0 +1,103 @@
+=begin
+#Feedback Submissions
+
+#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: 4.3.1
+
+=end
+
+require 'cgi'
+
+module Hubspot
+  module Crm
+    module Objects
+      module FeedbackSubmissions
+        class AssociationsApi
+          attr_accessor :api_client
+
+          def initialize(api_client = ApiClient.default)
+            @api_client = api_client
+          end
+          # List associations of a feedback submission by type
+          # @param feedback_submission_id [String] 
+          # @param to_object_type [String] 
+          # @param [Hash] opts the optional parameters
+          # @option opts [Boolean] :paginate_associations  (default to false)
+          # @option opts [String] :after The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` 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 [CollectionResponseAssociatedId]
+          def get_all(feedback_submission_id, to_object_type, opts = {})
+            data, _status_code, _headers = get_all_with_http_info(feedback_submission_id, to_object_type, opts)
+            data
+          end
+
+          # List associations of a feedback submission by type
+          # @param feedback_submission_id [String] 
+          # @param to_object_type [String] 
+          # @param [Hash] opts the optional parameters
+          # @option opts [Boolean] :paginate_associations 
+          # @option opts [String] :after The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
+          # @option opts [Integer] :limit The maximum number of results to display per page.
+          # @return [Array<(CollectionResponseAssociatedId, Integer, Hash)>] CollectionResponseAssociatedId data, response status code and response headers
+          def get_all_with_http_info(feedback_submission_id, to_object_type, opts = {})
+            if @api_client.config.debugging
+              @api_client.config.logger.debug 'Calling API: AssociationsApi.get_all ...'
+            end
+            # verify the required parameter 'feedback_submission_id' is set
+            if @api_client.config.client_side_validation && feedback_submission_id.nil?
+              fail ArgumentError, "Missing the required parameter 'feedback_submission_id' 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/v3/objects/feedback_submissions/{feedbackSubmissionId}/associations/{toObjectType}'.sub('{' + 'feedbackSubmissionId' + '}', CGI.escape(feedback_submission_id.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s))
+
+            # query parameters
+            query_params = opts[:query_params] || {}
+            query_params[:'paginateAssociations'] = opts[:'paginate_associations'] if !opts[:'paginate_associations'].nil?
+            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[:body] 
+
+            # return_type
+            return_type = opts[:return_type] || 'CollectionResponseAssociatedId' 
+
+            # auth_names
+            auth_names = opts[:auth_names] || ['hapikey']
+
+            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(: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

data/lib/hubspot/codegen/crm/objects/feedback_submissions/api/basic_api.rb

@@ -0,0 +1,181 @@
+=begin
+#Feedback Submissions
+
+#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: 4.3.1
+
+=end
+
+require 'cgi'
+
+module Hubspot
+  module Crm
+    module Objects
+      module FeedbackSubmissions
+        class BasicApi
+          include Hubspot::Helpers::GetAllHelper
+
+          attr_accessor :api_client
+
+          def initialize(api_client = ApiClient.default)
+            @api_client = api_client
+          end
+          # Read
+          # Read an Object identified by `{feedbackSubmissionId}`. `{feedbackSubmissionId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param.  Control what is returned via the `properties` query param.
+          # @param feedback_submission_id [String] 
+          # @param [Hash] opts the optional parameters
+          # @option opts [Array<String>] :properties A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
+          # @option opts [Array<String>] :associations A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
+          # @option opts [Boolean] :paginate_associations  (default to false)
+          # @option opts [Boolean] :archived Whether to return only results that have been archived. (default to false)
+          # @option opts [String] :id_property The name of a property whose values are unique for this object type
+          # @return [SimplePublicObject]
+          def get_by_id(feedback_submission_id, opts = {})
+            data, _status_code, _headers = get_by_id_with_http_info(feedback_submission_id, opts)
+            data
+          end
+
+          # Read
+          # Read an Object identified by &#x60;{feedbackSubmissionId}&#x60;. &#x60;{feedbackSubmissionId}&#x60; refers to the internal object ID by default, or optionally any unique property value as specified by the &#x60;idProperty&#x60; query param.  Control what is returned via the &#x60;properties&#x60; query param.
+          # @param feedback_submission_id [String] 
+          # @param [Hash] opts the optional parameters
+          # @option opts [Array<String>] :properties A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
+          # @option opts [Array<String>] :associations A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
+          # @option opts [Boolean] :paginate_associations 
+          # @option opts [Boolean] :archived Whether to return only results that have been archived.
+          # @option opts [String] :id_property The name of a property whose values are unique for this object type
+          # @return [Array<(SimplePublicObject, Integer, Hash)>] SimplePublicObject data, response status code and response headers
+          def get_by_id_with_http_info(feedback_submission_id, opts = {})
+            if @api_client.config.debugging
+              @api_client.config.logger.debug 'Calling API: BasicApi.get_by_id ...'
+            end
+            # verify the required parameter 'feedback_submission_id' is set
+            if @api_client.config.client_side_validation && feedback_submission_id.nil?
+              fail ArgumentError, "Missing the required parameter 'feedback_submission_id' when calling BasicApi.get_by_id"
+            end
+            # resource path
+            local_var_path = '/crm/v3/objects/feedback_submissions/{feedbackSubmissionId}'.sub('{' + 'feedbackSubmissionId' + '}', CGI.escape(feedback_submission_id.to_s))
+
+            # query parameters
+            query_params = opts[:query_params] || {}
+            query_params[:'properties'] = @api_client.build_collection_param(opts[:'properties'], :multi) if !opts[:'properties'].nil?
+            query_params[:'associations'] = @api_client.build_collection_param(opts[:'associations'], :multi) if !opts[:'associations'].nil?
+            query_params[:'paginateAssociations'] = opts[:'paginate_associations'] if !opts[:'paginate_associations'].nil?
+            query_params[:'archived'] = opts[:'archived'] if !opts[:'archived'].nil?
+            query_params[:'idProperty'] = opts[:'id_property'] if !opts[:'id_property'].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[:body] 
+
+            # return_type
+            return_type = opts[:return_type] || 'SimplePublicObject' 
+
+            # auth_names
+            auth_names = opts[:auth_names] || ['hapikey']
+
+            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(:GET, local_var_path, new_options)
+            if @api_client.config.debugging
+              @api_client.config.logger.debug "API called: BasicApi#get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+            end
+            return data, status_code, headers
+          end
+
+          # List
+          # Read a page of feedback submissions. Control what is returned via the `properties` query param.
+          # @param [Hash] opts the optional parameters
+          # @option opts [Integer] :limit The maximum number of results to display per page. (default to 10)
+          # @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 [Array<String>] :properties A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
+          # @option opts [Array<String>] :associations A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
+          # @option opts [Boolean] :paginate_associations  (default to false)
+          # @option opts [Boolean] :archived Whether to return only results that have been archived. (default to false)
+          # @return [CollectionResponseSimplePublicObject]
+          def get_page(opts = {})
+            data, _status_code, _headers = get_page_with_http_info(opts)
+            data
+          end
+
+          # List
+          # Read a page of feedback submissions. Control what is returned via the &#x60;properties&#x60; query param.
+          # @param [Hash] opts the optional parameters
+          # @option opts [Integer] :limit The maximum number of results to display per page.
+          # @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 [Array<String>] :properties A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
+          # @option opts [Array<String>] :associations A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
+          # @option opts [Boolean] :paginate_associations 
+          # @option opts [Boolean] :archived Whether to return only results that have been archived.
+          # @return [Array<(CollectionResponseSimplePublicObject, Integer, Hash)>] CollectionResponseSimplePublicObject data, response status code and response headers
+          def get_page_with_http_info(opts = {})
+            if @api_client.config.debugging
+              @api_client.config.logger.debug 'Calling API: BasicApi.get_page ...'
+            end
+            # resource path
+            local_var_path = '/crm/v3/objects/feedback_submissions'
+
+            # query parameters
+            query_params = opts[:query_params] || {}
+            query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+            query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
+            query_params[:'properties'] = @api_client.build_collection_param(opts[:'properties'], :multi) if !opts[:'properties'].nil?
+            query_params[:'associations'] = @api_client.build_collection_param(opts[:'associations'], :multi) if !opts[:'associations'].nil?
+            query_params[:'paginateAssociations'] = opts[:'paginate_associations'] if !opts[:'paginate_associations'].nil?
+            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', '*/*'])
+
+            # form parameters
+            form_params = opts[:form_params] || {}
+
+            # http body (model)
+            post_body = opts[:body] 
+
+            # return_type
+            return_type = opts[:return_type] || 'CollectionResponseSimplePublicObject' 
+
+            # auth_names
+            auth_names = opts[:auth_names] || ['hapikey']
+
+            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(:GET, local_var_path, new_options)
+            if @api_client.config.debugging
+              @api_client.config.logger.debug "API called: BasicApi#get_page\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/feedback_submissions/api/batch_api.rb

@@ -0,0 +1,95 @@
+=begin
+#Feedback Submissions
+
+#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: 4.3.1
+
+=end
+
+require 'cgi'
+
+module Hubspot
+  module Crm
+    module Objects
+      module FeedbackSubmissions
+        class BatchApi
+          attr_accessor :api_client
+
+          def initialize(api_client = ApiClient.default)
+            @api_client = api_client
+          end
+          # Read a batch of feedback submissions by internal ID, or unique property values
+          # Read a list of feedback submissions given a collection of IDs. Use the `properties` request body property to control which properties are returned.
+          # @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(batch_read_input_simple_public_object_id, opts = {})
+            data, _status_code, _headers = read_batch_with_http_info(batch_read_input_simple_public_object_id, opts)
+            data
+          end
+
+          # Read a batch of feedback submissions by internal ID, or unique property values
+          # Read a list of feedback submissions given a collection of IDs. Use the `properties` request body property to control which properties are returned.
+          # @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_batch_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_batch ...'
+            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_batch"
+            end
+            # resource path
+            local_var_path = '/crm/v3/objects/feedback_submissions/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'
+            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']
+
+            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_batch\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/feedback_submissions/api/search_api.rb

@@ -0,0 +1,92 @@
+=begin
+#Feedback Submissions
+
+#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: 4.3.1
+
+=end
+
+require 'cgi'
+
+module Hubspot
+  module Crm
+    module Objects
+      module FeedbackSubmissions
+        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 public_object_search_request [PublicObjectSearchRequest] 
+          # @param [Hash] opts the optional parameters
+          # @return [CollectionResponseWithTotalSimplePublicObject]
+          def do_search(public_object_search_request, opts = {})
+            data, _status_code, _headers = do_search_with_http_info(public_object_search_request, opts)
+            data
+          end
+
+          # Filter, Sort, and Search CRM Objects
+          # Filter, Sort, and Search CRM Objects
+          # @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 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/feedback_submissions/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'
+            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']
+
+            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#do_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+            end
+            return data, status_code, headers
+          end
+        end
+      end
+    end
+  end
+end