Class: Hubspot::Automation::Actions::DefinitionsApi
- Inherits:
-
Object
- Object
- Hubspot::Automation::Actions::DefinitionsApi
- Defined in:
- lib/hubspot/codegen/automation/actions/api/definitions_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#archive(definition_id, app_id, opts = {}) ⇒ nil
Archive a custom action Archives a single custom workflow action with the specified ID.
-
#archive_with_http_info(definition_id, app_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Archive a custom action Archives a single custom workflow action with the specified ID.
-
#create(app_id, extension_action_definition_input, opts = {}) ⇒ ExtensionActionDefinition
Create new custom action Creates a new custom workflow action.
-
#create_with_http_info(app_id, extension_action_definition_input, opts = {}) ⇒ Array<(ExtensionActionDefinition, Integer, Hash)>
Create new custom action Creates a new custom workflow action.
-
#get_by_id(definition_id, app_id, opts = {}) ⇒ ExtensionActionDefinition
Get a custom action Returns a single custom workflow action with the specified ID.
-
#get_by_id_with_http_info(definition_id, app_id, opts = {}) ⇒ Array<(ExtensionActionDefinition, Integer, Hash)>
Get a custom action Returns a single custom workflow action with the specified ID.
-
#get_page(app_id, opts = {}) ⇒ CollectionResponseExtensionActionDefinitionForwardPaging
Get all custom actions Returns a list of all custom workflow actions.
-
#get_page_with_http_info(app_id, opts = {}) ⇒ Array<(CollectionResponseExtensionActionDefinitionForwardPaging, Integer, Hash)>
Get all custom actions Returns a list of all custom workflow actions.
-
#initialize(api_client = ApiClient.default) ⇒ DefinitionsApi
constructor
A new instance of DefinitionsApi.
-
#update(definition_id, app_id, extension_action_definition_patch, opts = {}) ⇒ ExtensionActionDefinition
Update a custom action Updates a custom workflow action with new values for the specified fields.
-
#update_with_http_info(definition_id, app_id, extension_action_definition_patch, opts = {}) ⇒ Array<(ExtensionActionDefinition, Integer, Hash)>
Update a custom action Updates a custom workflow action with new values for the specified fields.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ DefinitionsApi
Returns a new instance of DefinitionsApi.
21 22 23 |
# File 'lib/hubspot/codegen/automation/actions/api/definitions_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/automation/actions/api/definitions_api.rb', line 19 def api_client @api_client end |
Instance Method Details
#archive(definition_id, app_id, opts = {}) ⇒ nil
Archive a custom action Archives a single custom workflow action with the specified ID. Workflows that currently use this custom action will stop attempting to execute the action, and all future executions will be marked as a failure.
30 31 32 33 |
# File 'lib/hubspot/codegen/automation/actions/api/definitions_api.rb', line 30 def archive(definition_id, app_id, opts = {}) archive_with_http_info(definition_id, app_id, opts) nil end |
#archive_with_http_info(definition_id, app_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Archive a custom action Archives a single custom workflow action with the specified ID. Workflows that currently use this custom action will stop attempting to execute the action, and all future executions will be marked as a failure.
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/automation/actions/api/definitions_api.rb', line 41 def archive_with_http_info(definition_id, app_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DefinitionsApi.archive ...' end # verify the required parameter 'definition_id' is set if @api_client.config.client_side_validation && definition_id.nil? fail ArgumentError, "Missing the required parameter 'definition_id' when calling DefinitionsApi.archive" end # verify the required parameter 'app_id' is set if @api_client.config.client_side_validation && app_id.nil? fail ArgumentError, "Missing the required parameter 'app_id' when calling DefinitionsApi.archive" end # resource path local_var_path = '/automation/v4/actions/{appId}/{definitionId}'.sub('{' + 'definitionId' + '}', CGI.escape(definition_id.to_s)).sub('{' + 'appId' + '}', CGI.escape(app_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[:body] # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['developer_hapikey'] = 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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DefinitionsApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create(app_id, extension_action_definition_input, opts = {}) ⇒ ExtensionActionDefinition
Create new custom action Creates a new custom workflow action.
98 99 100 101 |
# File 'lib/hubspot/codegen/automation/actions/api/definitions_api.rb', line 98 def create(app_id, extension_action_definition_input, opts = {}) data, _status_code, _headers = create_with_http_info(app_id, extension_action_definition_input, opts) data end |
#create_with_http_info(app_id, extension_action_definition_input, opts = {}) ⇒ Array<(ExtensionActionDefinition, Integer, Hash)>
Create new custom action Creates a new custom workflow action.
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/automation/actions/api/definitions_api.rb', line 109 def create_with_http_info(app_id, extension_action_definition_input, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DefinitionsApi.create ...' end # verify the required parameter 'app_id' is set if @api_client.config.client_side_validation && app_id.nil? fail ArgumentError, "Missing the required parameter 'app_id' when calling DefinitionsApi.create" end # verify the required parameter 'extension_action_definition_input' is set if @api_client.config.client_side_validation && extension_action_definition_input.nil? fail ArgumentError, "Missing the required parameter 'extension_action_definition_input' when calling DefinitionsApi.create" end # resource path local_var_path = '/automation/v4/actions/{appId}'.sub('{' + 'appId' + '}', CGI.escape(app_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(['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(extension_action_definition_input) # return_type return_type = opts[:return_type] || 'ExtensionActionDefinition' # auth_names auth_names = opts[:auth_names] || ['developer_hapikey'] = 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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DefinitionsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_by_id(definition_id, app_id, opts = {}) ⇒ ExtensionActionDefinition
Get a custom action Returns a single custom workflow action with the specified ID.
169 170 171 172 |
# File 'lib/hubspot/codegen/automation/actions/api/definitions_api.rb', line 169 def get_by_id(definition_id, app_id, opts = {}) data, _status_code, _headers = get_by_id_with_http_info(definition_id, app_id, opts) data end |
#get_by_id_with_http_info(definition_id, app_id, opts = {}) ⇒ Array<(ExtensionActionDefinition, Integer, Hash)>
Get a custom action Returns a single custom workflow action with the specified ID.
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 226 227 228 229 230 231 |
# File 'lib/hubspot/codegen/automation/actions/api/definitions_api.rb', line 181 def get_by_id_with_http_info(definition_id, app_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DefinitionsApi.get_by_id ...' end # verify the required parameter 'definition_id' is set if @api_client.config.client_side_validation && definition_id.nil? fail ArgumentError, "Missing the required parameter 'definition_id' when calling DefinitionsApi.get_by_id" end # verify the required parameter 'app_id' is set if @api_client.config.client_side_validation && app_id.nil? fail ArgumentError, "Missing the required parameter 'app_id' when calling DefinitionsApi.get_by_id" end # resource path local_var_path = '/automation/v4/actions/{appId}/{definitionId}'.sub('{' + 'definitionId' + '}', CGI.escape(definition_id.to_s)).sub('{' + 'appId' + '}', CGI.escape(app_id.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] || 'ExtensionActionDefinition' # auth_names auth_names = opts[:auth_names] || ['developer_hapikey'] = 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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DefinitionsApi#get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_page(app_id, opts = {}) ⇒ CollectionResponseExtensionActionDefinitionForwardPaging
Get all custom actions Returns a list of all custom workflow actions.
241 242 243 244 |
# File 'lib/hubspot/codegen/automation/actions/api/definitions_api.rb', line 241 def get_page(app_id, opts = {}) data, _status_code, _headers = get_page_with_http_info(app_id, opts) data end |
#get_page_with_http_info(app_id, opts = {}) ⇒ Array<(CollectionResponseExtensionActionDefinitionForwardPaging, Integer, Hash)>
Get all custom actions Returns a list of all custom workflow actions.
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 297 298 299 300 301 302 |
# File 'lib/hubspot/codegen/automation/actions/api/definitions_api.rb', line 254 def get_page_with_http_info(app_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DefinitionsApi.get_page ...' end # verify the required parameter 'app_id' is set if @api_client.config.client_side_validation && app_id.nil? fail ArgumentError, "Missing the required parameter 'app_id' when calling DefinitionsApi.get_page" end # resource path local_var_path = '/automation/v4/actions/{appId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)) # 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[:'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] || 'CollectionResponseExtensionActionDefinitionForwardPaging' # auth_names auth_names = opts[:auth_names] || ['developer_hapikey'] = 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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DefinitionsApi#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update(definition_id, app_id, extension_action_definition_patch, opts = {}) ⇒ ExtensionActionDefinition
Update a custom action Updates a custom workflow action with new values for the specified fields.
311 312 313 314 |
# File 'lib/hubspot/codegen/automation/actions/api/definitions_api.rb', line 311 def update(definition_id, app_id, extension_action_definition_patch, opts = {}) data, _status_code, _headers = update_with_http_info(definition_id, app_id, extension_action_definition_patch, opts) data end |
#update_with_http_info(definition_id, app_id, extension_action_definition_patch, opts = {}) ⇒ Array<(ExtensionActionDefinition, Integer, Hash)>
Update a custom action Updates a custom workflow action with new values for the specified fields.
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 373 374 375 376 377 378 |
# File 'lib/hubspot/codegen/automation/actions/api/definitions_api.rb', line 323 def update_with_http_info(definition_id, app_id, extension_action_definition_patch, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DefinitionsApi.update ...' end # verify the required parameter 'definition_id' is set if @api_client.config.client_side_validation && definition_id.nil? fail ArgumentError, "Missing the required parameter 'definition_id' when calling DefinitionsApi.update" end # verify the required parameter 'app_id' is set if @api_client.config.client_side_validation && app_id.nil? fail ArgumentError, "Missing the required parameter 'app_id' when calling DefinitionsApi.update" end # verify the required parameter 'extension_action_definition_patch' is set if @api_client.config.client_side_validation && extension_action_definition_patch.nil? fail ArgumentError, "Missing the required parameter 'extension_action_definition_patch' when calling DefinitionsApi.update" end # resource path local_var_path = '/automation/v4/actions/{appId}/{definitionId}'.sub('{' + 'definitionId' + '}', CGI.escape(definition_id.to_s)).sub('{' + 'appId' + '}', CGI.escape(app_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(['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(extension_action_definition_patch) # return_type return_type = opts[:return_type] || 'ExtensionActionDefinition' # auth_names auth_names = opts[:auth_names] || ['developer_hapikey'] = 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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: DefinitionsApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |