Class: Hubspot::Crm::Properties::CoreApi
- Inherits:
-
Object
- Object
- Hubspot::Crm::Properties::CoreApi
- Defined in:
- lib/hubspot/codegen/crm/properties/api/core_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#archive(object_type, property_name, opts = {}) ⇒ nil
Archive a property Move a property identified by propertyName to the recycling bin.
-
#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.
-
#create(object_type, property_create, opts = {}) ⇒ Property
Create a property Create and return a copy of a new property for the specified object type.
-
#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.
-
#get_all(object_type, opts = {}) ⇒ CollectionResponsePropertyNoPaging
Read all properties Read all existing properties for the specified object type and HubSpot account.
-
#get_all_with_http_info(object_type, opts = {}) ⇒ Array<(CollectionResponsePropertyNoPaging, Integer, Hash)>
Read all properties Read all existing properties for the specified object type and HubSpot account.
-
#get_by_name(object_type, property_name, opts = {}) ⇒ Property
Read a property Read a property identified by propertyName.
-
#get_by_name_with_http_info(object_type, property_name, opts = {}) ⇒ Array<(Property, Integer, Hash)>
Read a property Read a property identified by propertyName.
-
#initialize(api_client = ApiClient.default) ⇒ CoreApi
constructor
A new instance of CoreApi.
-
#update(object_type, property_name, property_update, opts = {}) ⇒ Property
Update a property Perform a partial update of a property identified by propertyName.
-
#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.
Constructor Details
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.
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.
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 |
# 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[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"CoreApi.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: 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.
99 100 101 102 |
# File 'lib/hubspot/codegen/crm/properties/api/core_api.rb', line 99 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.
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 161 162 163 164 165 |
# File 'lib/hubspot/codegen/crm/properties/api/core_api.rb', line 110 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' 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(property_create) # return_type return_type = opts[:debug_return_type] || 'Property' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"CoreApi.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: CoreApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_all(object_type, opts = {}) ⇒ CollectionResponsePropertyNoPaging
Read all properties Read all existing properties for the specified object type and HubSpot account.
174 175 176 177 |
# File 'lib/hubspot/codegen/crm/properties/api/core_api.rb', line 174 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<(CollectionResponsePropertyNoPaging, Integer, Hash)>
Read all properties Read all existing properties for the specified object type and HubSpot account.
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 233 234 |
# File 'lib/hubspot/codegen/crm/properties/api/core_api.rb', line 186 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? query_params[:'properties'] = opts[:'properties'] if !opts[:'properties'].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[:debug_body] # return_type return_type = opts[:debug_return_type] || 'CollectionResponsePropertyNoPaging' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"CoreApi.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: 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.
244 245 246 247 |
# File 'lib/hubspot/codegen/crm/properties/api/core_api.rb', line 244 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.
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 297 298 299 300 301 302 303 304 305 306 307 308 309 |
# File 'lib/hubspot/codegen/crm/properties/api/core_api.rb', line 257 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? query_params[:'properties'] = opts[:'properties'] if !opts[:'properties'].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[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Property' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"CoreApi.get_by_name", :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: 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.
318 319 320 321 |
# File 'lib/hubspot/codegen/crm/properties/api/core_api.rb', line 318 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.
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 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 |
# File 'lib/hubspot/codegen/crm/properties/api/core_api.rb', line 330 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' 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(property_update) # return_type return_type = opts[:debug_return_type] || 'Property' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"CoreApi.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(:PATCH, local_var_path, ) 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 |