lib/hubspot/codegen/crm/objects/feedback_submissions/api/associations_api.rb in hubspot-api-client-12.0.0 vs lib/hubspot/codegen/crm/objects/feedback_submissions/api/associations_api.rb in hubspot-api-client-13.0.0

- old
+ new

@@ -20,62 +20,68 @@ attr_accessor :api_client def initialize(api_client = ApiClient.default) @api_client = api_client end - # List associations of a feedback submission by type + # Remove an association between two feedback submissions # @param feedback_submission_id [String] # @param to_object_type [String] + # @param to_object_id [String] + # @param association_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 [CollectionResponseAssociatedIdForwardPaging] - 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 + # @return [nil] + def archive(feedback_submission_id, to_object_type, to_object_id, association_type, opts = {}) + archive_with_http_info(feedback_submission_id, to_object_type, to_object_id, association_type, opts) + nil end - # List associations of a feedback submission by type + # Remove an association between two feedback submissions # @param feedback_submission_id [String] # @param to_object_type [String] + # @param to_object_id [String] + # @param association_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. - # @return [Array<(CollectionResponseAssociatedIdForwardPaging, Integer, Hash)>] CollectionResponseAssociatedIdForwardPaging data, response status code and response headers - def get_all_with_http_info(feedback_submission_id, to_object_type, opts = {}) + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def archive_with_http_info(feedback_submission_id, to_object_type, to_object_id, association_type, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug 'Calling API: AssociationsApi.get_all ...' + @api_client.config.logger.debug 'Calling API: AssociationsApi.archive ...' 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" + fail ArgumentError, "Missing the required parameter 'feedback_submission_id' 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.get_all" + 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 + # verify the required parameter 'association_type' is set + if @api_client.config.client_side_validation && association_type.nil? + fail ArgumentError, "Missing the required parameter 'association_type' when calling AssociationsApi.archive" + 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)) + local_var_path = '/crm/v3/objects/feedback_submissions/{feedbackSubmissionId}/associations/{toObjectType}/{toObjectId}/{associationType}'.sub('{' + 'feedbackSubmissionId' + '}', CGI.escape(feedback_submission_id.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s)).sub('{' + 'toObjectId' + '}', CGI.escape(to_object_id.to_s)).sub('{' + 'associationType' + '}', CGI.escape(association_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', '*/*']) + header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type - return_type = opts[:return_type] || 'CollectionResponseAssociatedIdForwardPaging' + return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['hapikey'] new_options = opts.merge( @@ -85,13 +91,13 @@ :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) + 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#get_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @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 # Associate a feedback submission with another object @@ -99,41 +105,41 @@ # @param to_object_type [String] # @param to_object_id [String] # @param association_type [String] # @param [Hash] opts the optional parameters # @return [SimplePublicObjectWithAssociations] - def submissions_feedback_submission_id_associations_to_object_type_to_object_id_association_type(feedback_submission_id, to_object_type, to_object_id, association_type, opts = {}) - data, _status_code, _headers = submissions_feedback_submission_id_associations_to_object_type_to_object_id_association_type_with_http_info(feedback_submission_id, to_object_type, to_object_id, association_type, opts) + def create(feedback_submission_id, to_object_type, to_object_id, association_type, opts = {}) + data, _status_code, _headers = create_with_http_info(feedback_submission_id, to_object_type, to_object_id, association_type, opts) data end # Associate a feedback submission with another object # @param feedback_submission_id [String] # @param to_object_type [String] # @param to_object_id [String] # @param association_type [String] # @param [Hash] opts the optional parameters # @return [Array<(SimplePublicObjectWithAssociations, Integer, Hash)>] SimplePublicObjectWithAssociations data, response status code and response headers - def submissions_feedback_submission_id_associations_to_object_type_to_object_id_association_type_with_http_info(feedback_submission_id, to_object_type, to_object_id, association_type, opts = {}) + def create_with_http_info(feedback_submission_id, to_object_type, to_object_id, association_type, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug 'Calling API: AssociationsApi.submissions_feedback_submission_id_associations_to_object_type_to_object_id_association_type ...' + @api_client.config.logger.debug 'Calling API: AssociationsApi.create ...' 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.submissions_feedback_submission_id_associations_to_object_type_to_object_id_association_type" + fail ArgumentError, "Missing the required parameter 'feedback_submission_id' 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.submissions_feedback_submission_id_associations_to_object_type_to_object_id_association_type" + 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.submissions_feedback_submission_id_associations_to_object_type_to_object_id_association_type" + fail ArgumentError, "Missing the required parameter 'to_object_id' when calling AssociationsApi.create" end # verify the required parameter 'association_type' is set if @api_client.config.client_side_validation && association_type.nil? - fail ArgumentError, "Missing the required parameter 'association_type' when calling AssociationsApi.submissions_feedback_submission_id_associations_to_object_type_to_object_id_association_type" + fail ArgumentError, "Missing the required parameter 'association_type' when calling AssociationsApi.create" end # resource path local_var_path = '/crm/v3/objects/feedback_submissions/{feedbackSubmissionId}/associations/{toObjectType}/{toObjectId}/{associationType}'.sub('{' + 'feedbackSubmissionId' + '}', CGI.escape(feedback_submission_id.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s)).sub('{' + 'toObjectId' + '}', CGI.escape(to_object_id.to_s)).sub('{' + 'associationType' + '}', CGI.escape(association_type.to_s)) # query parameters @@ -165,73 +171,67 @@ :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#submissions_feedback_submission_id_associations_to_object_type_to_object_id_association_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @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 - # Remove an association between two feedback submissions + # List associations of a feedback submission by type # @param feedback_submission_id [String] # @param to_object_type [String] - # @param to_object_id [String] - # @param association_type [String] # @param [Hash] opts the optional parameters - # @return [nil] - def submissions_feedback_submission_id_associations_to_object_type_to_object_id_association_type_0(feedback_submission_id, to_object_type, to_object_id, association_type, opts = {}) - submissions_feedback_submission_id_associations_to_object_type_to_object_id_association_type_0_with_http_info(feedback_submission_id, to_object_type, to_object_id, association_type, opts) - nil + # @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 [CollectionResponseAssociatedIdForwardPaging] + def get_page(feedback_submission_id, to_object_type, opts = {}) + data, _status_code, _headers = get_page_with_http_info(feedback_submission_id, to_object_type, opts) + data end - # Remove an association between two feedback submissions + # List associations of a feedback submission by type # @param feedback_submission_id [String] # @param to_object_type [String] - # @param to_object_id [String] - # @param association_type [String] # @param [Hash] opts the optional parameters - # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers - def submissions_feedback_submission_id_associations_to_object_type_to_object_id_association_type_0_with_http_info(feedback_submission_id, to_object_type, to_object_id, association_type, opts = {}) + # @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. + # @return [Array<(CollectionResponseAssociatedIdForwardPaging, Integer, Hash)>] CollectionResponseAssociatedIdForwardPaging data, response status code and response headers + def get_page_with_http_info(feedback_submission_id, to_object_type, opts = {}) if @api_client.config.debugging - @api_client.config.logger.debug 'Calling API: AssociationsApi.submissions_feedback_submission_id_associations_to_object_type_to_object_id_association_type_0 ...' + @api_client.config.logger.debug 'Calling API: AssociationsApi.get_page ...' 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.submissions_feedback_submission_id_associations_to_object_type_to_object_id_association_type_0" + fail ArgumentError, "Missing the required parameter 'feedback_submission_id' when calling AssociationsApi.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 AssociationsApi.submissions_feedback_submission_id_associations_to_object_type_to_object_id_association_type_0" + fail ArgumentError, "Missing the required parameter 'to_object_type' when calling AssociationsApi.get_page" 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.submissions_feedback_submission_id_associations_to_object_type_to_object_id_association_type_0" - end - # verify the required parameter 'association_type' is set - if @api_client.config.client_side_validation && association_type.nil? - fail ArgumentError, "Missing the required parameter 'association_type' when calling AssociationsApi.submissions_feedback_submission_id_associations_to_object_type_to_object_id_association_type_0" - end # resource path - local_var_path = '/crm/v3/objects/feedback_submissions/{feedbackSubmissionId}/associations/{toObjectType}/{toObjectId}/{associationType}'.sub('{' + 'feedbackSubmissionId' + '}', CGI.escape(feedback_submission_id.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s)).sub('{' + 'toObjectId' + '}', CGI.escape(to_object_id.to_s)).sub('{' + 'associationType' + '}', CGI.escape(association_type.to_s)) + 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[:'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(['*/*']) + 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] + return_type = opts[:return_type] || 'CollectionResponseAssociatedIdForwardPaging' # auth_names auth_names = opts[:auth_names] || ['hapikey'] new_options = opts.merge( @@ -241,12 +241,12 @@ :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) + 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#submissions_feedback_submission_id_associations_to_object_type_to_object_id_association_type_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + @api_client.config.logger.debug "API called: AssociationsApi#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end end end