Class: Hubspot::Crm::Schemas::CoreApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/schemas/api/core_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CoreApi

Returns a new instance of CoreApi.



21
22
23
 
# File 'lib/hubspot/codegen/crm/schemas/api/core_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/schemas/api/core_api.rb', line 19

def api_client
  @api_client
end

Instance Method Details

#archive(object_type, opts = {}) ⇒ nil

Delete a schema Deletes a schema. Any existing records of this schema must be deleted first. Otherwise this call will fail.

Parameters:

  • object_type (String) —

    Fully qualified name or object type ID of your schema.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :archived (Boolean) —

    Whether to return only results that have been archived. (default to false)

Returns:

  • (nil) 


30
31
32
33
 
# File 'lib/hubspot/codegen/crm/schemas/api/core_api.rb', line 30

def archive(object_type, opts = {})
  archive_with_http_info(object_type, opts)
  nil
end

#archive_association(object_type, association_identifier, opts = {}) ⇒ nil

Remove an association Removes an existing association from a schema.

Parameters:

  • object_type (String) —

    Fully qualified name or object type ID of your schema.

  • association_identifier (String) —

    Unique ID of the association to remove.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


95
96
97
98
 
# File 'lib/hubspot/codegen/crm/schemas/api/core_api.rb', line 95

def archive_association(object_type, association_identifier, opts = {})
  archive_association_with_http_info(object_type, association_identifier, opts)
  nil
end

#archive_association_with_http_info(object_type, association_identifier, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove an association Removes an existing association from a schema.

Parameters:

  • object_type (String) —

    Fully qualified name or object type ID of your schema.

  • association_identifier (String) —

    Unique ID of the association to remove.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



106
107
108
109
110
111
112
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
 
# File 'lib/hubspot/codegen/crm/schemas/api/core_api.rb', line 106

def archive_association_with_http_info(object_type, association_identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.archive_association ...'
  end
  # verify the required parameter 'object_type' is set
  if @api_client.config.client_side_validation && object_type.nil?
    fail ArgumentError, "Missing the required parameter 'object_type' when calling CoreApi.archive_association"
  end
  # verify the required parameter 'association_identifier' is set
  if @api_client.config.client_side_validation && association_identifier.nil?
    fail ArgumentError, "Missing the required parameter 'association_identifier' when calling CoreApi.archive_association"
  end
  # resource path
  local_var_path = '/crm/v3/schemas/{objectType}/associations/{associationIdentifier}'.sub('{' + 'objectType' + '}', CGI.escape(object_type.to_s)).sub('{' + 'associationIdentifier' + '}', CGI.escape(association_identifier.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[:body] 

  # return_type
  return_type = opts[:return_type] 

  # 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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CoreApi#archive_association\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#archive_with_http_info(object_type, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a schema Deletes a schema. Any existing records of this schema must be deleted first. Otherwise this call will fail.

Parameters:

  • object_type (String) —

    Fully qualified name or object type ID of your schema.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :archived (Boolean) —

    Whether to return only results that have been archived.

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/hubspot/codegen/crm/schemas/api/core_api.rb', line 41

def archive_with_http_info(object_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.archive ...'
  end
  # verify the required parameter 'object_type' is set
  if @api_client.config.client_side_validation && object_type.nil?
    fail ArgumentError, "Missing the required parameter 'object_type' when calling CoreApi.archive"
  end
  # resource path
  local_var_path = '/crm/v3/schemas/{objectType}'.sub('{' + 'objectType' + '}', CGI.escape(object_type.to_s))

  # 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(['*/*'])

  # 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']

  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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CoreApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create(object_schema_egg, opts = {}) ⇒ ObjectSchema

Create a new schema Define a new object schema, along with custom properties and associations. The entire object schema, including its object type ID, properties, and associations will be returned in the response.

Parameters:

  • object_schema_egg (ObjectSchemaEgg) —

    Object schema definition, including properties and associations.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



162
163
164
165
 
# File 'lib/hubspot/codegen/crm/schemas/api/core_api.rb', line 162

def create(object_schema_egg, opts = {})
  data, _status_code, _headers = create_with_http_info(object_schema_egg, opts)
  data
end

#create_association(object_type, association_definition_egg, opts = {}) ⇒ AssociationDefinition

Create an association Defines a new association between the primary schema’s object type and other object types.

Parameters:

  • object_type (String) —

    Fully qualified name or object type ID of your schema.

  • association_definition_egg (AssociationDefinitionEgg) —

    Attributes that define the association.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



227
228
229
230
 
# File 'lib/hubspot/codegen/crm/schemas/api/core_api.rb', line 227

def create_association(object_type, association_definition_egg, opts = {})
  data, _status_code, _headers = create_association_with_http_info(object_type, association_definition_egg, opts)
  data
end

#create_association_with_http_info(object_type, association_definition_egg, opts = {}) ⇒ Array<(AssociationDefinition, Integer, Hash)>

Create an association Defines a new association between the primary schema&#39;s object type and other object types.

Parameters:

  • object_type (String) —

    Fully qualified name or object type ID of your schema.

  • association_definition_egg (AssociationDefinitionEgg) —

    Attributes that define the association.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AssociationDefinition, Integer, Hash)>) —

    AssociationDefinition data, response status code and response headers



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/hubspot/codegen/crm/schemas/api/core_api.rb', line 238

def create_association_with_http_info(object_type, association_definition_egg, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.create_association ...'
  end
  # verify the required parameter 'object_type' is set
  if @api_client.config.client_side_validation && object_type.nil?
    fail ArgumentError, "Missing the required parameter 'object_type' when calling CoreApi.create_association"
  end
  # verify the required parameter 'association_definition_egg' is set
  if @api_client.config.client_side_validation && association_definition_egg.nil?
    fail ArgumentError, "Missing the required parameter 'association_definition_egg' when calling CoreApi.create_association"
  end
  # resource path
  local_var_path = '/crm/v3/schemas/{objectType}/associations'.sub('{' + 'objectType' + '}', CGI.escape(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'
  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(association_definition_egg) 

  # return_type
  return_type = opts[:return_type] || 'AssociationDefinition' 

  # 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: CoreApi#create_association\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_with_http_info(object_schema_egg, opts = {}) ⇒ Array<(ObjectSchema, Integer, Hash)>

Create a new schema Define a new object schema, along with custom properties and associations. The entire object schema, including its object type ID, properties, and associations will be returned in the response.

Parameters:

  • object_schema_egg (ObjectSchemaEgg) —

    Object schema definition, including properties and associations.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ObjectSchema, Integer, Hash)>) —

    ObjectSchema data, response status code and response headers



172
173
174
175
176
177
178
179
180
181
182
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
 
# File 'lib/hubspot/codegen/crm/schemas/api/core_api.rb', line 172

def create_with_http_info(object_schema_egg, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.create ...'
  end
  # verify the required parameter 'object_schema_egg' is set
  if @api_client.config.client_side_validation && object_schema_egg.nil?
    fail ArgumentError, "Missing the required parameter 'object_schema_egg' when calling CoreApi.create"
  end
  # resource path
  local_var_path = '/crm/v3/schemas'

  # 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(object_schema_egg) 

  # return_type
  return_type = opts[:return_type] || 'ObjectSchema' 

  # 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: CoreApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all(opts = {}) ⇒ CollectionResponseObjectSchemaNoPaging

Get all schemas Returns all object schemas that have been defined for your account.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :archived (Boolean) —

    Whether to return only results that have been archived. (default to false)

Returns:



296
297
298
299
 
# File 'lib/hubspot/codegen/crm/schemas/api/core_api.rb', line 296

def get_all(opts = {})
  data, _status_code, _headers = get_all_with_http_info(opts)
  data
end

#get_all_with_http_info(opts = {}) ⇒ Array<(CollectionResponseObjectSchemaNoPaging, Integer, Hash)>

Get all schemas Returns all object schemas that have been defined for your account.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :archived (Boolean) —

    Whether to return only results that have been archived.

Returns:



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/hubspot/codegen/crm/schemas/api/core_api.rb', line 306

def get_all_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_all ...'
  end
  # resource path
  local_var_path = '/crm/v3/schemas'

  # 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', '*/*'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'CollectionResponseObjectSchemaNoPaging' 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

  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: CoreApi#get_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_by_id(object_type, opts = {}) ⇒ ObjectSchema

Get an existing schema Returns an existing object schema.

Parameters:

  • object_type (String) —

    Fully qualified name or object type ID of your schema.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



355
356
357
358
 
# File 'lib/hubspot/codegen/crm/schemas/api/core_api.rb', line 355

def get_by_id(object_type, opts = {})
  data, _status_code, _headers = get_by_id_with_http_info(object_type, opts)
  data
end

#get_by_id_with_http_info(object_type, opts = {}) ⇒ Array<(ObjectSchema, Integer, Hash)>

Get an existing schema Returns an existing object schema.

Parameters:

  • object_type (String) —

    Fully qualified name or object type ID of your schema.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ObjectSchema, Integer, Hash)>) —

    ObjectSchema data, response status code and response headers



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/hubspot/codegen/crm/schemas/api/core_api.rb', line 365

def get_by_id_with_http_info(object_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_by_id ...'
  end
  # verify the required parameter 'object_type' is set
  if @api_client.config.client_side_validation && object_type.nil?
    fail ArgumentError, "Missing the required parameter 'object_type' when calling CoreApi.get_by_id"
  end
  # resource path
  local_var_path = '/crm/v3/schemas/{objectType}'.sub('{' + 'objectType' + '}', CGI.escape(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[:body] 

  # return_type
  return_type = opts[:return_type] || 'ObjectSchema' 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

  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: CoreApi#get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update(object_type, object_type_definition_patch, opts = {}) ⇒ ObjectTypeDefinition

Update a schema Update the details for an existing object schema.

Parameters:

  • object_type (String) —

    Fully qualified name or object type ID of your schema.

  • object_type_definition_patch (ObjectTypeDefinitionPatch) —

    Attributes to update in your schema.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



418
419
420
421
 
# File 'lib/hubspot/codegen/crm/schemas/api/core_api.rb', line 418

def update(object_type, object_type_definition_patch, opts = {})
  data, _status_code, _headers = update_with_http_info(object_type, object_type_definition_patch, opts)
  data
end

#update_with_http_info(object_type, object_type_definition_patch, opts = {}) ⇒ Array<(ObjectTypeDefinition, Integer, Hash)>

Update a schema Update the details for an existing object schema.

Parameters:

  • object_type (String) —

    Fully qualified name or object type ID of your schema.

  • object_type_definition_patch (ObjectTypeDefinitionPatch) —

    Attributes to update in your schema.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ObjectTypeDefinition, Integer, Hash)>) —

    ObjectTypeDefinition data, response status code and response headers



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/hubspot/codegen/crm/schemas/api/core_api.rb', line 429

def update_with_http_info(object_type, object_type_definition_patch, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.update ...'
  end
  # verify the required parameter 'object_type' is set
  if @api_client.config.client_side_validation && object_type.nil?
    fail ArgumentError, "Missing the required parameter 'object_type' when calling CoreApi.update"
  end
  # verify the required parameter 'object_type_definition_patch' is set
  if @api_client.config.client_side_validation && object_type_definition_patch.nil?
    fail ArgumentError, "Missing the required parameter 'object_type_definition_patch' when calling CoreApi.update"
  end
  # resource path
  local_var_path = '/crm/v3/schemas/{objectType}'.sub('{' + 'objectType' + '}', CGI.escape(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'
  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(object_type_definition_patch) 

  # return_type
  return_type = opts[:return_type] || 'ObjectTypeDefinition' 

  # 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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CoreApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end