Class: Hubspot::Crm::Properties::CoreApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/properties/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/properties/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/properties/api/core_api.rb', line 19

def api_client
  @api_client
end

Instance Method Details

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

Archive a property Move a property identified by propertyName to the recycling bin.

Parameters:

  • object_type (String)
  • property_name (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


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

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

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

Archive a property Move a property identified by propertyName to the recycling bin.

Parameters:

  • object_type (String)
  • property_name (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

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

def archive_with_http_info(object_type, property_name, 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
  # verify the required parameter 'property_name' is set
  if @api_client.config.client_side_validation && property_name.nil?
    fail ArgumentError, "Missing the required parameter 'property_name' when calling CoreApi.archive"
  end
  # resource path
  local_var_path = '/crm/v3/properties/{objectType}/{propertyName}'.sub('{' + 'objectType' + '}', CGI.escape(object_type.to_s)).sub('{' + 'propertyName' + '}', CGI.escape(property_name.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', '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(: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_type, property_create, opts = {}) ⇒ Property

Create a property Create and return a copy of a new property for the specified object type.

Parameters:

  • object_type (String)
  • property_create (PropertyCreate)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



98
99
100
101
 
# File 'lib/hubspot/codegen/crm/properties/api/core_api.rb', line 98

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

#create_with_http_info(object_type, property_create, opts = {}) ⇒ Array<(Property, Integer, Hash)>

Create a property Create and return a copy of a new property for the specified object type.

Parameters:

  • object_type (String)
  • property_create (PropertyCreate)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    Property data, response status code and response headers



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
156
157
158
159
160
 
# File 'lib/hubspot/codegen/crm/properties/api/core_api.rb', line 109

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

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

  # 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(: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(object_type, opts = {}) ⇒ CollectionResponseProperty

Read all properties Read all existing properties for the specified object type and HubSpot account.

Parameters:

  • object_type (String)
  • 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:



168
169
170
171
 
# File 'lib/hubspot/codegen/crm/properties/api/core_api.rb', line 168

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

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

Read all properties Read all existing properties for the specified object type and HubSpot account.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :archived (Boolean) —

    Whether to return only results that have been archived.

Returns:

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

    CollectionResponseProperty data, response status code and response headers



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
220
221
222
223
224
225
 
# File 'lib/hubspot/codegen/crm/properties/api/core_api.rb', line 179

def get_all_with_http_info(object_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_all ...'
  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_all"
  end
  # resource path
  local_var_path = '/crm/v3/properties/{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(['application/json', '*/*'])

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

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

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

  # 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_name(object_type, property_name, opts = {}) ⇒ Property

Read a property Read a property identified by propertyName.

Parameters:

  • object_type (String)
  • property_name (String)
  • 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:



234
235
236
237
 
# File 'lib/hubspot/codegen/crm/properties/api/core_api.rb', line 234

def get_by_name(object_type, property_name, opts = {})
  data, _status_code, _headers = get_by_name_with_http_info(object_type, property_name, opts)
  data
end

#get_by_name_with_http_info(object_type, property_name, opts = {}) ⇒ Array<(Property, Integer, Hash)>

Read a property Read a property identified by propertyName.

Parameters:

  • object_type (String)
  • property_name (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :archived (Boolean) —

    Whether to return only results that have been archived.

Returns:

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

    Property data, response status code and response headers



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
290
291
292
293
294
295
296
 
# File 'lib/hubspot/codegen/crm/properties/api/core_api.rb', line 246

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

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

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

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

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

#update(object_type, property_name, property_update, opts = {}) ⇒ Property

Update a property Perform a partial update of a property identified by propertyName. Provided fields will be overwritten.

Parameters:

  • object_type (String)
  • property_name (String)
  • property_update (PropertyUpdate)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



305
306
307
308
 
# File 'lib/hubspot/codegen/crm/properties/api/core_api.rb', line 305

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

#update_with_http_info(object_type, property_name, property_update, opts = {}) ⇒ Array<(Property, Integer, Hash)>

Update a property Perform a partial update of a property identified by propertyName. Provided fields will be overwritten.

Parameters:

  • object_type (String)
  • property_name (String)
  • property_update (PropertyUpdate)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    Property data, response status code and response headers



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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/hubspot/codegen/crm/properties/api/core_api.rb', line 317

def update_with_http_info(object_type, property_name, property_update, 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 'property_name' is set
  if @api_client.config.client_side_validation && property_name.nil?
    fail ArgumentError, "Missing the required parameter 'property_name' when calling CoreApi.update"
  end
  # verify the required parameter 'property_update' is set
  if @api_client.config.client_side_validation && property_update.nil?
    fail ArgumentError, "Missing the required parameter 'property_update' when calling CoreApi.update"
  end
  # resource path
  local_var_path = '/crm/v3/properties/{objectType}/{propertyName}'.sub('{' + 'objectType' + '}', CGI.escape(object_type.to_s)).sub('{' + 'propertyName' + '}', CGI.escape(property_name.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(property_update) 

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

  # 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(: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