Class: Hubspot::Crm::Tickets::BasicApi
- Inherits:
-
Object
- Object
- Hubspot::Crm::Tickets::BasicApi
- Includes:
- Helpers::GetAllHelper
- Defined in:
- lib/hubspot/codegen/crm/tickets/api/basic_api.rb
Constant Summary
Constants included from Helpers::GetAllHelper
Helpers::GetAllHelper::MAX_PAGE_SIZE
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#archive(ticket_id, opts = {}) ⇒ nil
Archive Move an Object identified by ‘ticketId` to the recycling bin.
-
#archive_with_http_info(ticket_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Archive Move an Object identified by `ticketId` to the recycling bin.
-
#create(simple_public_object_input_for_create, opts = {}) ⇒ SimplePublicObject
Create Create a ticket with the given properties and return a copy of the object, including the ID.
-
#create_with_http_info(simple_public_object_input_for_create, opts = {}) ⇒ Array<(SimplePublicObject, Integer, Hash)>
Create Create a ticket with the given properties and return a copy of the object, including the ID.
-
#get_by_id(ticket_id, opts = {}) ⇒ SimplePublicObjectWithAssociations
Read Read an Object identified by ‘ticketId`.
-
#get_by_id_with_http_info(ticket_id, opts = {}) ⇒ Array<(SimplePublicObjectWithAssociations, Integer, Hash)>
Read Read an Object identified by `ticketId`.
-
#get_page(opts = {}) ⇒ CollectionResponseSimplePublicObjectWithAssociationsForwardPaging
List Read a page of tickets.
-
#get_page_with_http_info(opts = {}) ⇒ Array<(CollectionResponseSimplePublicObjectWithAssociationsForwardPaging, Integer, Hash)>
List Read a page of tickets.
-
#initialize(api_client = ApiClient.default) ⇒ BasicApi
constructor
A new instance of BasicApi.
-
#update(ticket_id, simple_public_object_input, opts = {}) ⇒ SimplePublicObject
Update Perform a partial update of an Object identified by ‘ticketId`.
-
#update_with_http_info(ticket_id, simple_public_object_input, opts = {}) ⇒ Array<(SimplePublicObject, Integer, Hash)>
Update Perform a partial update of an Object identified by `ticketId`.
Methods included from Helpers::GetAllHelper
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
21 22 23 |
# File 'lib/hubspot/codegen/crm/tickets/api/basic_api.rb', line 21 def api_client @api_client end |
Instance Method Details
#archive(ticket_id, opts = {}) ⇒ nil
Archive Move an Object identified by ‘ticketId` to the recycling bin.
31 32 33 34 |
# File 'lib/hubspot/codegen/crm/tickets/api/basic_api.rb', line 31 def archive(ticket_id, opts = {}) archive_with_http_info(ticket_id, opts) nil end |
#archive_with_http_info(ticket_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Archive Move an Object identified by `ticketId` 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 |
# File 'lib/hubspot/codegen/crm/tickets/api/basic_api.rb', line 41 def archive_with_http_info(ticket_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BasicApi.archive ...' end # verify the required parameter 'ticket_id' is set if @api_client.config.client_side_validation && ticket_id.nil? fail ArgumentError, "Missing the required parameter 'ticket_id' when calling BasicApi.archive" end # resource path local_var_path = '/crm/v3/objects/tickets/{ticketId}'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_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 => :"BasicApi.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: BasicApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create(simple_public_object_input_for_create, opts = {}) ⇒ SimplePublicObject
Create Create a ticket with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tickets is provided.
94 95 96 97 |
# File 'lib/hubspot/codegen/crm/tickets/api/basic_api.rb', line 94 def create(simple_public_object_input_for_create, opts = {}) data, _status_code, _headers = create_with_http_info(simple_public_object_input_for_create, opts) data end |
#create_with_http_info(simple_public_object_input_for_create, opts = {}) ⇒ Array<(SimplePublicObject, Integer, Hash)>
Create Create a ticket with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tickets is provided.
104 105 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/tickets/api/basic_api.rb', line 104 def create_with_http_info(simple_public_object_input_for_create, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BasicApi.create ...' end # verify the required parameter 'simple_public_object_input_for_create' is set if @api_client.config.client_side_validation && simple_public_object_input_for_create.nil? fail ArgumentError, "Missing the required parameter 'simple_public_object_input_for_create' when calling BasicApi.create" end # resource path local_var_path = '/crm/v3/objects/tickets' # 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(simple_public_object_input_for_create) # return_type return_type = opts[:debug_return_type] || 'SimplePublicObject' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"BasicApi.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: BasicApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_by_id(ticket_id, opts = {}) ⇒ SimplePublicObjectWithAssociations
Read Read an Object identified by ‘ticketId`. `ticketId` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
167 168 169 170 |
# File 'lib/hubspot/codegen/crm/tickets/api/basic_api.rb', line 167 def get_by_id(ticket_id, opts = {}) data, _status_code, _headers = get_by_id_with_http_info(ticket_id, opts) data end |
#get_by_id_with_http_info(ticket_id, opts = {}) ⇒ Array<(SimplePublicObjectWithAssociations, Integer, Hash)>
Read Read an Object identified by `ticketId`. `ticketId` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.
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 226 227 228 229 230 231 232 233 |
# File 'lib/hubspot/codegen/crm/tickets/api/basic_api.rb', line 182 def get_by_id_with_http_info(ticket_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BasicApi.get_by_id ...' end # verify the required parameter 'ticket_id' is set if @api_client.config.client_side_validation && ticket_id.nil? fail ArgumentError, "Missing the required parameter 'ticket_id' when calling BasicApi.get_by_id" end # resource path local_var_path = '/crm/v3/objects/tickets/{ticketId}'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'properties'] = @api_client.build_collection_param(opts[:'properties'], :csv) if !opts[:'properties'].nil? query_params[:'propertiesWithHistory'] = @api_client.build_collection_param(opts[:'properties_with_history'], :multi) if !opts[:'properties_with_history'].nil? query_params[:'associations'] = @api_client.build_collection_param(opts[:'associations'], :multi) if !opts[:'associations'].nil? query_params[:'archived'] = opts[:'archived'] if !opts[:'archived'].nil? query_params[:'idProperty'] = opts[:'id_property'] if !opts[:'id_property'].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] || 'SimplePublicObjectWithAssociations' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"BasicApi.get_by_id", :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: BasicApi#get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_page(opts = {}) ⇒ CollectionResponseSimplePublicObjectWithAssociationsForwardPaging
List Read a page of tickets. Control what is returned via the ‘properties` query param.
245 246 247 248 |
# File 'lib/hubspot/codegen/crm/tickets/api/basic_api.rb', line 245 def get_page(opts = {}) data, _status_code, _headers = get_page_with_http_info(opts) data end |
#get_page_with_http_info(opts = {}) ⇒ Array<(CollectionResponseSimplePublicObjectWithAssociationsForwardPaging, Integer, Hash)>
List Read a page of tickets. Control what is returned via the `properties` query param.
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 |
# File 'lib/hubspot/codegen/crm/tickets/api/basic_api.rb', line 260 def get_page_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BasicApi.get_page ...' end # resource path local_var_path = '/crm/v3/objects/tickets' # query parameters query_params = opts[:query_params] || {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil? query_params[:'properties'] = @api_client.build_collection_param(opts[:'properties'], :csv) if !opts[:'properties'].nil? query_params[:'propertiesWithHistory'] = @api_client.build_collection_param(opts[:'properties_with_history'], :multi) if !opts[:'properties_with_history'].nil? query_params[:'associations'] = @api_client.build_collection_param(opts[:'associations'], :multi) if !opts[:'associations'].nil? 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[:debug_body] # return_type return_type = opts[:debug_return_type] || 'CollectionResponseSimplePublicObjectWithAssociationsForwardPaging' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"BasicApi.get_page", :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: BasicApi#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update(ticket_id, simple_public_object_input, opts = {}) ⇒ SimplePublicObject
Update Perform a partial update of an Object identified by ‘ticketId`. `ticketId` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
317 318 319 320 |
# File 'lib/hubspot/codegen/crm/tickets/api/basic_api.rb', line 317 def update(ticket_id, simple_public_object_input, opts = {}) data, _status_code, _headers = update_with_http_info(ticket_id, simple_public_object_input, opts) data end |
#update_with_http_info(ticket_id, simple_public_object_input, opts = {}) ⇒ Array<(SimplePublicObject, Integer, Hash)>
Update Perform a partial update of an Object identified by `ticketId`. `ticketId` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.
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 373 374 375 376 377 378 379 380 381 382 383 384 385 |
# File 'lib/hubspot/codegen/crm/tickets/api/basic_api.rb', line 329 def update_with_http_info(ticket_id, simple_public_object_input, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BasicApi.update ...' end # verify the required parameter 'ticket_id' is set if @api_client.config.client_side_validation && ticket_id.nil? fail ArgumentError, "Missing the required parameter 'ticket_id' when calling BasicApi.update" end # verify the required parameter 'simple_public_object_input' is set if @api_client.config.client_side_validation && simple_public_object_input.nil? fail ArgumentError, "Missing the required parameter 'simple_public_object_input' when calling BasicApi.update" end # resource path local_var_path = '/crm/v3/objects/tickets/{ticketId}'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'idProperty'] = opts[:'id_property'] if !opts[:'id_property'].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(simple_public_object_input) # return_type return_type = opts[:debug_return_type] || 'SimplePublicObject' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"BasicApi.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: BasicApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |