lib/hubspot/codegen/crm/deals/api/associations_api.rb in hubspot-api-client-2.0.0 vs lib/hubspot/codegen/crm/deals/api/associations_api.rb in hubspot-api-client-2.1.0
- old
+ new
@@ -21,43 +21,49 @@
def initialize(api_client = ApiClient.default)
@api_client = api_client
end
# Remove an association between two deals
# @param deal_id [String]
- # @param associated_object_type [String]
+ # @param to_object_type [String]
# @param to_object_id [String]
+ # @param association_type [String]
# @param [Hash] opts the optional parameters
# @return [nil]
- def archive_association(deal_id, associated_object_type, to_object_id, opts = {})
- archive_association_with_http_info(deal_id, associated_object_type, to_object_id, opts)
+ def archive_association(deal_id, to_object_type, to_object_id, association_type, opts = {})
+ archive_association_with_http_info(deal_id, to_object_type, to_object_id, association_type, opts)
nil
end
# Remove an association between two deals
# @param deal_id [String]
- # @param associated_object_type [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 archive_association_with_http_info(deal_id, associated_object_type, to_object_id, opts = {})
+ def archive_association_with_http_info(deal_id, to_object_type, to_object_id, association_type, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: AssociationsApi.archive_association ...'
end
# verify the required parameter 'deal_id' is set
if @api_client.config.client_side_validation && deal_id.nil?
fail ArgumentError, "Missing the required parameter 'deal_id' when calling AssociationsApi.archive_association"
end
- # verify the required parameter 'associated_object_type' is set
- if @api_client.config.client_side_validation && associated_object_type.nil?
- fail ArgumentError, "Missing the required parameter 'associated_object_type' when calling AssociationsApi.archive_association"
+ # 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_association"
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_association"
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_association"
+ end
# resource path
- local_var_path = '/crm/v3/objects/deals/{dealId}/associations/{associatedObjectType}/{toObjectId}'.sub('{' + 'dealId' + '}', CGI.escape(deal_id.to_s).gsub('%2F', '/')).sub('{' + 'associatedObjectType' + '}', CGI.escape(associated_object_type.to_s).gsub('%2F', '/')).sub('{' + 'toObjectId' + '}', CGI.escape(to_object_id.to_s).gsub('%2F', '/'))
+ local_var_path = '/crm/v3/objects/deals/{dealId}/associations/{toObjectType}/{toObjectId}/{associationType}'.sub('{' + 'dealId' + '}', CGI.escape(deal_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] || {}
# header parameters
@@ -93,43 +99,49 @@
return data, status_code, headers
end
# Associate two deals
# @param deal_id [String]
- # @param associated_object_type [String]
+ # @param to_object_type [String]
# @param to_object_id [String]
+ # @param association_type [String]
# @param [Hash] opts the optional parameters
# @return [SimplePublicObject]
- def create_association(deal_id, associated_object_type, to_object_id, opts = {})
- data, _status_code, _headers = create_association_with_http_info(deal_id, associated_object_type, to_object_id, opts)
+ def create_association(deal_id, to_object_type, to_object_id, association_type, opts = {})
+ data, _status_code, _headers = create_association_with_http_info(deal_id, to_object_type, to_object_id, association_type, opts)
data
end
# Associate two deals
# @param deal_id [String]
- # @param associated_object_type [String]
+ # @param to_object_type [String]
# @param to_object_id [String]
+ # @param association_type [String]
# @param [Hash] opts the optional parameters
# @return [Array<(SimplePublicObject, Integer, Hash)>] SimplePublicObject data, response status code and response headers
- def create_association_with_http_info(deal_id, associated_object_type, to_object_id, opts = {})
+ def create_association_with_http_info(deal_id, to_object_type, to_object_id, association_type, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: AssociationsApi.create_association ...'
end
# verify the required parameter 'deal_id' is set
if @api_client.config.client_side_validation && deal_id.nil?
fail ArgumentError, "Missing the required parameter 'deal_id' when calling AssociationsApi.create_association"
end
- # verify the required parameter 'associated_object_type' is set
- if @api_client.config.client_side_validation && associated_object_type.nil?
- fail ArgumentError, "Missing the required parameter 'associated_object_type' when calling AssociationsApi.create_association"
+ # 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_association"
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_association"
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.create_association"
+ end
# resource path
- local_var_path = '/crm/v3/objects/deals/{dealId}/associations/{associatedObjectType}/{toObjectId}'.sub('{' + 'dealId' + '}', CGI.escape(deal_id.to_s).gsub('%2F', '/')).sub('{' + 'associatedObjectType' + '}', CGI.escape(associated_object_type.to_s).gsub('%2F', '/')).sub('{' + 'toObjectId' + '}', CGI.escape(to_object_id.to_s).gsub('%2F', '/'))
+ local_var_path = '/crm/v3/objects/deals/{dealId}/associations/{toObjectType}/{toObjectId}/{associationType}'.sub('{' + 'dealId' + '}', CGI.escape(deal_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] || {}
# header parameters
@@ -165,37 +177,37 @@
return data, status_code, headers
end
# List associations of a deal by type
# @param deal_id [String]
- # @param associated_object_type [String]
+ # @param to_object_type [String]
# @param [Hash] opts the optional parameters
- # @return [CollectionResponseSimplePublicObjectId]
- def get_associations(deal_id, associated_object_type, opts = {})
- data, _status_code, _headers = get_associations_with_http_info(deal_id, associated_object_type, opts)
+ # @return [CollectionResponseAssociatedId]
+ def get_associations(deal_id, to_object_type, opts = {})
+ data, _status_code, _headers = get_associations_with_http_info(deal_id, to_object_type, opts)
data
end
# List associations of a deal by type
# @param deal_id [String]
- # @param associated_object_type [String]
+ # @param to_object_type [String]
# @param [Hash] opts the optional parameters
- # @return [Array<(CollectionResponseSimplePublicObjectId, Integer, Hash)>] CollectionResponseSimplePublicObjectId data, response status code and response headers
- def get_associations_with_http_info(deal_id, associated_object_type, opts = {})
+ # @return [Array<(CollectionResponseAssociatedId, Integer, Hash)>] CollectionResponseAssociatedId data, response status code and response headers
+ def get_associations_with_http_info(deal_id, to_object_type, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: AssociationsApi.get_associations ...'
end
# verify the required parameter 'deal_id' is set
if @api_client.config.client_side_validation && deal_id.nil?
fail ArgumentError, "Missing the required parameter 'deal_id' when calling AssociationsApi.get_associations"
end
- # verify the required parameter 'associated_object_type' is set
- if @api_client.config.client_side_validation && associated_object_type.nil?
- fail ArgumentError, "Missing the required parameter 'associated_object_type' when calling AssociationsApi.get_associations"
+ # 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_associations"
end
# resource path
- local_var_path = '/crm/v3/objects/deals/{dealId}/associations/{associatedObjectType}'.sub('{' + 'dealId' + '}', CGI.escape(deal_id.to_s).gsub('%2F', '/')).sub('{' + 'associatedObjectType' + '}', CGI.escape(associated_object_type.to_s).gsub('%2F', '/'))
+ local_var_path = '/crm/v3/objects/deals/{dealId}/associations/{toObjectType}'.sub('{' + 'dealId' + '}', CGI.escape(deal_id.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s))
# query parameters
query_params = opts[:query_params] || {}
# header parameters
@@ -208,10 +220,10 @@
# http body (model)
post_body = opts[:body]
# return_type
- return_type = opts[:return_type] || 'CollectionResponseSimplePublicObjectId'
+ return_type = opts[:return_type] || 'CollectionResponseAssociatedId'
# auth_names
auth_names = opts[:auth_names] || ['hapikey', 'oauth2']
new_options = opts.merge(
\ No newline at end of file