Class: Hubspot::Crm::Associations::V4::Schema::DefinitionsApi
- Inherits:
-
Object
- Object
- Hubspot::Crm::Associations::V4::Schema::DefinitionsApi
- Defined in:
- lib/hubspot/codegen/crm/associations/v4/schema/api/definitions_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#archive(from_object_type, to_object_type, association_type_id, opts = {}) ⇒ nil
Delete Deletes an association definition.
-
#archive_with_http_info(from_object_type, to_object_type, association_type_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Deletes an association definition.
-
#create(from_object_type, to_object_type, public_association_definition_create_request, opts = {}) ⇒ CollectionResponseAssociationSpecWithLabelNoPaging
Create Create a user defined association definition.
-
#create_with_http_info(from_object_type, to_object_type, public_association_definition_create_request, opts = {}) ⇒ Array<(CollectionResponseAssociationSpecWithLabelNoPaging, Integer, Hash)>
Create Create a user defined association definition.
-
#get_all(from_object_type, to_object_type, opts = {}) ⇒ CollectionResponseAssociationSpecWithLabelNoPaging
Read Returns all association types between two object types.
-
#get_all_with_http_info(from_object_type, to_object_type, opts = {}) ⇒ Array<(CollectionResponseAssociationSpecWithLabelNoPaging, Integer, Hash)>
Read Returns all association types between two object types.
-
#initialize(api_client = ApiClient.default) ⇒ DefinitionsApi
constructor
A new instance of DefinitionsApi.
-
#update(from_object_type, to_object_type, public_association_definition_update_request, opts = {}) ⇒ nil
Update Update a user defined association definition.
-
#update_with_http_info(from_object_type, to_object_type, public_association_definition_update_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Update Update a user defined association definition.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ DefinitionsApi
Returns a new instance of DefinitionsApi.
23 24 25 |
# File 'lib/hubspot/codegen/crm/associations/v4/schema/api/definitions_api.rb', line 23 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
21 22 23 |
# File 'lib/hubspot/codegen/crm/associations/v4/schema/api/definitions_api.rb', line 21 def api_client @api_client end |
Instance Method Details
#archive(from_object_type, to_object_type, association_type_id, opts = {}) ⇒ nil
Delete Deletes an association definition
33 34 35 36 |
# File 'lib/hubspot/codegen/crm/associations/v4/schema/api/definitions_api.rb', line 33 def archive(from_object_type, to_object_type, association_type_id, opts = {}) archive_with_http_info(from_object_type, to_object_type, association_type_id, opts) nil end |
#archive_with_http_info(from_object_type, to_object_type, association_type_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Deletes an association definition
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 95 96 97 98 99 |
# File 'lib/hubspot/codegen/crm/associations/v4/schema/api/definitions_api.rb', line 45 def archive_with_http_info(from_object_type, to_object_type, association_type_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DefinitionsApi.archive ...' end # verify the required parameter 'from_object_type' is set if @api_client.config.client_side_validation && from_object_type.nil? fail ArgumentError, "Missing the required parameter 'from_object_type' when calling DefinitionsApi.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 DefinitionsApi.archive" end # verify the required parameter 'association_type_id' is set if @api_client.config.client_side_validation && association_type_id.nil? fail ArgumentError, "Missing the required parameter 'association_type_id' when calling DefinitionsApi.archive" end # resource path local_var_path = '/crm/v4/associations/{fromObjectType}/{toObjectType}/labels/{associationTypeId}'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s)).sub('{' + 'associationTypeId' + '}', CGI.escape(association_type_id.to_s)) # 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[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"DefinitionsApi.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(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DefinitionsApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create(from_object_type, to_object_type, public_association_definition_create_request, opts = {}) ⇒ CollectionResponseAssociationSpecWithLabelNoPaging
Create Create a user defined association definition
108 109 110 111 |
# File 'lib/hubspot/codegen/crm/associations/v4/schema/api/definitions_api.rb', line 108 def create(from_object_type, to_object_type, public_association_definition_create_request, opts = {}) data, _status_code, _headers = create_with_http_info(from_object_type, to_object_type, public_association_definition_create_request, opts) data end |
#create_with_http_info(from_object_type, to_object_type, public_association_definition_create_request, opts = {}) ⇒ Array<(CollectionResponseAssociationSpecWithLabelNoPaging, Integer, Hash)>
Create Create a user defined association definition
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 167 168 169 170 171 172 173 174 175 176 177 178 179 |
# File 'lib/hubspot/codegen/crm/associations/v4/schema/api/definitions_api.rb', line 120 def create_with_http_info(from_object_type, to_object_type, public_association_definition_create_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DefinitionsApi.create ...' end # verify the required parameter 'from_object_type' is set if @api_client.config.client_side_validation && from_object_type.nil? fail ArgumentError, "Missing the required parameter 'from_object_type' when calling DefinitionsApi.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 DefinitionsApi.create" end # verify the required parameter 'public_association_definition_create_request' is set if @api_client.config.client_side_validation && public_association_definition_create_request.nil? fail ArgumentError, "Missing the required parameter 'public_association_definition_create_request' when calling DefinitionsApi.create" end # resource path local_var_path = '/crm/v4/associations/{fromObjectType}/{toObjectType}/labels'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s)) # 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_association_definition_create_request) # return_type return_type = opts[:debug_return_type] || 'CollectionResponseAssociationSpecWithLabelNoPaging' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"DefinitionsApi.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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DefinitionsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_all(from_object_type, to_object_type, opts = {}) ⇒ CollectionResponseAssociationSpecWithLabelNoPaging
Read Returns all association types between two object types
187 188 189 190 |
# File 'lib/hubspot/codegen/crm/associations/v4/schema/api/definitions_api.rb', line 187 def get_all(from_object_type, to_object_type, opts = {}) data, _status_code, _headers = get_all_with_http_info(from_object_type, to_object_type, opts) data end |
#get_all_with_http_info(from_object_type, to_object_type, opts = {}) ⇒ Array<(CollectionResponseAssociationSpecWithLabelNoPaging, Integer, Hash)>
Read Returns all association types between two object types
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 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 |
# File 'lib/hubspot/codegen/crm/associations/v4/schema/api/definitions_api.rb', line 198 def get_all_with_http_info(from_object_type, to_object_type, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DefinitionsApi.get_all ...' end # verify the required parameter 'from_object_type' is set if @api_client.config.client_side_validation && from_object_type.nil? fail ArgumentError, "Missing the required parameter 'from_object_type' when calling DefinitionsApi.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 DefinitionsApi.get_all" end # resource path local_var_path = '/crm/v4/associations/{fromObjectType}/{toObjectType}/labels'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s)) # 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[:debug_body] # return_type return_type = opts[:debug_return_type] || 'CollectionResponseAssociationSpecWithLabelNoPaging' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"DefinitionsApi.get_all", :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: DefinitionsApi#get_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update(from_object_type, to_object_type, public_association_definition_update_request, opts = {}) ⇒ nil
Update Update a user defined association definition
257 258 259 260 |
# File 'lib/hubspot/codegen/crm/associations/v4/schema/api/definitions_api.rb', line 257 def update(from_object_type, to_object_type, public_association_definition_update_request, opts = {}) update_with_http_info(from_object_type, to_object_type, public_association_definition_update_request, opts) nil end |
#update_with_http_info(from_object_type, to_object_type, public_association_definition_update_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Update Update a user defined association definition
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 |
# File 'lib/hubspot/codegen/crm/associations/v4/schema/api/definitions_api.rb', line 269 def update_with_http_info(from_object_type, to_object_type, public_association_definition_update_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DefinitionsApi.update ...' end # verify the required parameter 'from_object_type' is set if @api_client.config.client_side_validation && from_object_type.nil? fail ArgumentError, "Missing the required parameter 'from_object_type' when calling DefinitionsApi.update" 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 DefinitionsApi.update" end # verify the required parameter 'public_association_definition_update_request' is set if @api_client.config.client_side_validation && public_association_definition_update_request.nil? fail ArgumentError, "Missing the required parameter 'public_association_definition_update_request' when calling DefinitionsApi.update" end # resource path local_var_path = '/crm/v4/associations/{fromObjectType}/{toObjectType}/labels'.sub('{' + 'fromObjectType' + '}', CGI.escape(from_object_type.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s)) # 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(public_association_definition_update_request) # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"DefinitionsApi.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(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DefinitionsApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |