Class: Hubspot::Crm::Objects::BatchApi
- Inherits:
-
Object
- Object
- Hubspot::Crm::Objects::BatchApi
- Defined in:
- lib/hubspot/codegen/crm/objects/api/batch_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#archive(object_type, batch_input_simple_public_object_id, opts = {}) ⇒ nil
Archive a batch of objects by ID.
-
#archive_with_http_info(object_type, batch_input_simple_public_object_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Archive a batch of objects by ID.
-
#create(object_type, batch_input_simple_public_object_input_for_create, opts = {}) ⇒ BatchResponseSimplePublicObject
Create a batch of objects.
-
#create_with_http_info(object_type, batch_input_simple_public_object_input_for_create, opts = {}) ⇒ Array<(BatchResponseSimplePublicObject, Integer, Hash)>
Create a batch of objects.
-
#initialize(api_client = ApiClient.default) ⇒ BatchApi
constructor
A new instance of BatchApi.
-
#read(object_type, batch_read_input_simple_public_object_id, opts = {}) ⇒ BatchResponseSimplePublicObject
Read a batch of objects by internal ID, or unique property values.
-
#read_with_http_info(object_type, batch_read_input_simple_public_object_id, opts = {}) ⇒ Array<(BatchResponseSimplePublicObject, Integer, Hash)>
Read a batch of objects by internal ID, or unique property values.
-
#update(object_type, batch_input_simple_public_object_batch_input, opts = {}) ⇒ BatchResponseSimplePublicObject
Update a batch of objects by internal ID, or unique property values.
-
#update_with_http_info(object_type, batch_input_simple_public_object_batch_input, opts = {}) ⇒ Array<(BatchResponseSimplePublicObject, Integer, Hash)>
Update a batch of objects by internal ID, or unique property values.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
19 20 21 |
# File 'lib/hubspot/codegen/crm/objects/api/batch_api.rb', line 19 def api_client @api_client end |
Instance Method Details
#archive(object_type, batch_input_simple_public_object_id, opts = {}) ⇒ nil
Archive a batch of objects by ID
29 30 31 32 |
# File 'lib/hubspot/codegen/crm/objects/api/batch_api.rb', line 29 def archive(object_type, batch_input_simple_public_object_id, opts = {}) archive_with_http_info(object_type, batch_input_simple_public_object_id, opts) nil end |
#archive_with_http_info(object_type, batch_input_simple_public_object_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Archive a batch of objects by ID
39 40 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/objects/api/batch_api.rb', line 39 def archive_with_http_info(object_type, batch_input_simple_public_object_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BatchApi.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 BatchApi.archive" end # verify the required parameter 'batch_input_simple_public_object_id' is set if @api_client.config.client_side_validation && batch_input_simple_public_object_id.nil? fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_id' when calling BatchApi.archive" end # resource path local_var_path = '/crm/v3/objects/{objectType}/batch/archive'.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(['*/*']) # 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(batch_input_simple_public_object_id) # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"BatchApi.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(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BatchApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create(object_type, batch_input_simple_public_object_input_for_create, opts = {}) ⇒ BatchResponseSimplePublicObject
Create a batch of objects
101 102 103 104 |
# File 'lib/hubspot/codegen/crm/objects/api/batch_api.rb', line 101 def create(object_type, batch_input_simple_public_object_input_for_create, opts = {}) data, _status_code, _headers = create_with_http_info(object_type, batch_input_simple_public_object_input_for_create, opts) data end |
#create_with_http_info(object_type, batch_input_simple_public_object_input_for_create, opts = {}) ⇒ Array<(BatchResponseSimplePublicObject, Integer, Hash)>
Create a batch of objects
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 166 |
# File 'lib/hubspot/codegen/crm/objects/api/batch_api.rb', line 111 def create_with_http_info(object_type, batch_input_simple_public_object_input_for_create, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BatchApi.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 BatchApi.create" end # verify the required parameter 'batch_input_simple_public_object_input_for_create' is set if @api_client.config.client_side_validation && batch_input_simple_public_object_input_for_create.nil? fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_input_for_create' when calling BatchApi.create" end # resource path local_var_path = '/crm/v3/objects/{objectType}/batch/create'.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(batch_input_simple_public_object_input_for_create) # return_type return_type = opts[:debug_return_type] || 'BatchResponseSimplePublicObject' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"BatchApi.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: BatchApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#read(object_type, batch_read_input_simple_public_object_id, opts = {}) ⇒ BatchResponseSimplePublicObject
Read a batch of objects by internal ID, or unique property values
174 175 176 177 |
# File 'lib/hubspot/codegen/crm/objects/api/batch_api.rb', line 174 def read(object_type, batch_read_input_simple_public_object_id, opts = {}) data, _status_code, _headers = read_with_http_info(object_type, batch_read_input_simple_public_object_id, opts) data end |
#read_with_http_info(object_type, batch_read_input_simple_public_object_id, opts = {}) ⇒ Array<(BatchResponseSimplePublicObject, Integer, Hash)>
Read a batch of objects by internal ID, or unique property values
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 233 234 235 236 237 238 239 240 241 |
# File 'lib/hubspot/codegen/crm/objects/api/batch_api.rb', line 185 def read_with_http_info(object_type, batch_read_input_simple_public_object_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BatchApi.read ...' 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 BatchApi.read" end # verify the required parameter 'batch_read_input_simple_public_object_id' is set if @api_client.config.client_side_validation && batch_read_input_simple_public_object_id.nil? fail ArgumentError, "Missing the required parameter 'batch_read_input_simple_public_object_id' when calling BatchApi.read" end # resource path local_var_path = '/crm/v3/objects/{objectType}/batch/read'.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', '*/*']) # 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(batch_read_input_simple_public_object_id) # return_type return_type = opts[:debug_return_type] || 'BatchResponseSimplePublicObject' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"BatchApi.read", :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: BatchApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update(object_type, batch_input_simple_public_object_batch_input, opts = {}) ⇒ BatchResponseSimplePublicObject
Update a batch of objects by internal ID, or unique property values
248 249 250 251 |
# File 'lib/hubspot/codegen/crm/objects/api/batch_api.rb', line 248 def update(object_type, batch_input_simple_public_object_batch_input, opts = {}) data, _status_code, _headers = update_with_http_info(object_type, batch_input_simple_public_object_batch_input, opts) data end |
#update_with_http_info(object_type, batch_input_simple_public_object_batch_input, opts = {}) ⇒ Array<(BatchResponseSimplePublicObject, Integer, Hash)>
Update a batch of objects by internal ID, or unique property values
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 310 311 312 313 |
# File 'lib/hubspot/codegen/crm/objects/api/batch_api.rb', line 258 def update_with_http_info(object_type, batch_input_simple_public_object_batch_input, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BatchApi.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 BatchApi.update" end # verify the required parameter 'batch_input_simple_public_object_batch_input' is set if @api_client.config.client_side_validation && batch_input_simple_public_object_batch_input.nil? fail ArgumentError, "Missing the required parameter 'batch_input_simple_public_object_batch_input' when calling BatchApi.update" end # resource path local_var_path = '/crm/v3/objects/{objectType}/batch/update'.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(batch_input_simple_public_object_batch_input) # return_type return_type = opts[:debug_return_type] || 'BatchResponseSimplePublicObject' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"BatchApi.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(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: BatchApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |