Class: Hubspot::Crm::LineItems::AssociationsApi
- Inherits:
-
Object
- Object
- Hubspot::Crm::LineItems::AssociationsApi
- Defined in:
- lib/hubspot/codegen/crm/line_items/api/associations_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#archive_association(line_item_id, associated_object_type, to_object_id, opts = {}) ⇒ nil
Remove an association between two line items.
-
#archive_association_with_http_info(line_item_id, associated_object_type, to_object_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Remove an association between two line items.
-
#create_association(line_item_id, associated_object_type, to_object_id, opts = {}) ⇒ SimplePublicObject
Associate two line items.
-
#create_association_with_http_info(line_item_id, associated_object_type, to_object_id, opts = {}) ⇒ Array<(SimplePublicObject, Integer, Hash)>
Associate two line items.
-
#get_associations(line_item_id, associated_object_type, opts = {}) ⇒ CollectionResponseSimplePublicObjectId
List associations of a line item by type.
-
#get_associations_with_http_info(line_item_id, associated_object_type, opts = {}) ⇒ Array<(CollectionResponseSimplePublicObjectId, Integer, Hash)>
List associations of a line item by type.
-
#initialize(api_client = ApiClient.default) ⇒ AssociationsApi
constructor
A new instance of AssociationsApi.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ AssociationsApi
Returns a new instance of AssociationsApi.
21 22 23 |
# File 'lib/hubspot/codegen/crm/line_items/api/associations_api.rb', line 21 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
19 20 21 |
# File 'lib/hubspot/codegen/crm/line_items/api/associations_api.rb', line 19 def api_client @api_client end |
Instance Method Details
#archive_association(line_item_id, associated_object_type, to_object_id, opts = {}) ⇒ nil
Remove an association between two line items
30 31 32 33 |
# File 'lib/hubspot/codegen/crm/line_items/api/associations_api.rb', line 30 def archive_association(line_item_id, associated_object_type, to_object_id, opts = {}) archive_association_with_http_info(line_item_id, associated_object_type, to_object_id, opts) nil end |
#archive_association_with_http_info(line_item_id, associated_object_type, to_object_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Remove an association between two line items
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 |
# File 'lib/hubspot/codegen/crm/line_items/api/associations_api.rb', line 41 def archive_association_with_http_info(line_item_id, associated_object_type, to_object_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AssociationsApi.archive_association ...' end # verify the required parameter 'line_item_id' is set if @api_client.config.client_side_validation && line_item_id.nil? fail ArgumentError, "Missing the required parameter 'line_item_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" 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 # resource path local_var_path = '/crm/v3/objects/line_items/{lineItemId}/associations/{associatedObjectType}/{toObjectId}'.sub('{' + 'lineItemId' + '}', CGI.escape(line_item_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', '/')) # 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[:body] # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['hapikey', 'oauth2'] = 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(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AssociationsApi#archive_association\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_association(line_item_id, associated_object_type, to_object_id, opts = {}) ⇒ SimplePublicObject
Associate two line items
102 103 104 105 |
# File 'lib/hubspot/codegen/crm/line_items/api/associations_api.rb', line 102 def create_association(line_item_id, associated_object_type, to_object_id, opts = {}) data, _status_code, _headers = create_association_with_http_info(line_item_id, associated_object_type, to_object_id, opts) data end |
#create_association_with_http_info(line_item_id, associated_object_type, to_object_id, opts = {}) ⇒ Array<(SimplePublicObject, Integer, Hash)>
Associate two line items
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
# File 'lib/hubspot/codegen/crm/line_items/api/associations_api.rb', line 113 def create_association_with_http_info(line_item_id, associated_object_type, to_object_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AssociationsApi.create_association ...' end # verify the required parameter 'line_item_id' is set if @api_client.config.client_side_validation && line_item_id.nil? fail ArgumentError, "Missing the required parameter 'line_item_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" 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 # resource path local_var_path = '/crm/v3/objects/line_items/{lineItemId}/associations/{associatedObjectType}/{toObjectId}'.sub('{' + 'lineItemId' + '}', CGI.escape(line_item_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', '/')) # 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', '*/*']) # 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', 'oauth2'] = 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(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AssociationsApi#create_association\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_associations(line_item_id, associated_object_type, opts = {}) ⇒ CollectionResponseSimplePublicObjectId
List associations of a line item by type
173 174 175 176 |
# File 'lib/hubspot/codegen/crm/line_items/api/associations_api.rb', line 173 def get_associations(line_item_id, associated_object_type, opts = {}) data, _status_code, _headers = get_associations_with_http_info(line_item_id, associated_object_type, opts) data end |
#get_associations_with_http_info(line_item_id, associated_object_type, opts = {}) ⇒ Array<(CollectionResponseSimplePublicObjectId, Integer, Hash)>
List associations of a line item by type
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 |
# File 'lib/hubspot/codegen/crm/line_items/api/associations_api.rb', line 183 def get_associations_with_http_info(line_item_id, associated_object_type, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AssociationsApi.get_associations ...' end # verify the required parameter 'line_item_id' is set if @api_client.config.client_side_validation && line_item_id.nil? fail ArgumentError, "Missing the required parameter 'line_item_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" end # resource path local_var_path = '/crm/v3/objects/line_items/{lineItemId}/associations/{associatedObjectType}'.sub('{' + 'lineItemId' + '}', CGI.escape(line_item_id.to_s).gsub('%2F', '/')).sub('{' + 'associatedObjectType' + '}', CGI.escape(associated_object_type.to_s).gsub('%2F', '/')) # 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', '*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'CollectionResponseSimplePublicObjectId' # auth_names auth_names = opts[:auth_names] || ['hapikey', 'oauth2'] = 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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AssociationsApi#get_associations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |