Class: Hubspot::Automation::Actions::DefinitionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/automation/actions/api/definitions_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

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.

Parameters:

  • definition_id (String) —

    The ID of the custom workflow action.

  • app_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


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.

Parameters:

  • definition_id (String) —

    The ID of the custom workflow action.

  • app_id (Integer)
  • 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
91
 
# 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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['developer_hapikey']

  new_options = opts.merge(
    :operation => :"DefinitionsApi.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, new_options)
  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.

Parameters:

  • app_id (Integer)
  • extension_action_definition_input (ExtensionActionDefinitionInput) —

    The custom workflow action to create.

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

    the optional parameters

Returns:



99
100
101
102
 
# File 'lib/hubspot/codegen/automation/actions/api/definitions_api.rb', line 99

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.

Parameters:

  • app_id (Integer)
  • extension_action_definition_input (ExtensionActionDefinitionInput) —

    The custom workflow action to create.

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

    the optional parameters

Returns:

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

    ExtensionActionDefinition data, response status code and response headers



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/automation/actions/api/definitions_api.rb', line 110

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'
  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(extension_action_definition_input)

  # return_type
  return_type = opts[:debug_return_type] || 'ExtensionActionDefinition'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['developer_hapikey']

  new_options = opts.merge(
    :operation => :"DefinitionsApi.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, new_options)
  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.

Parameters:

  • definition_id (String) —

    The ID of the custom workflow action.

  • app_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :archived (Boolean) —

    Whether to include archived custom actions. (default to false)

Returns:



174
175
176
177
 
# File 'lib/hubspot/codegen/automation/actions/api/definitions_api.rb', line 174

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.

Parameters:

  • definition_id (String) —

    The ID of the custom workflow action.

  • app_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :archived (Boolean) —

    Whether to include archived custom actions. (default to false)

Returns:

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

    ExtensionActionDefinition data, response status code and response headers



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
 
# File 'lib/hubspot/codegen/automation/actions/api/definitions_api.rb', line 186

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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ExtensionActionDefinition'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['developer_hapikey']

  new_options = opts.merge(
    :operation => :"DefinitionsApi.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, new_options)
  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.

Parameters:

  • app_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Maximum number of results per page.

  • :after (String) —

    The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.

  • :archived (Boolean) —

    Whether to include archived custom actions. (default to false)

Returns:



247
248
249
250
 
# File 'lib/hubspot/codegen/automation/actions/api/definitions_api.rb', line 247

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.

Parameters:

  • app_id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Maximum number of results per page.

  • :after (String) —

    The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.

  • :archived (Boolean) —

    Whether to include archived custom actions. (default to false)

Returns:



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/automation/actions/api/definitions_api.rb', line 260

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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CollectionResponseExtensionActionDefinitionForwardPaging'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['developer_hapikey']

  new_options = opts.merge(
    :operation => :"DefinitionsApi.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, new_options)
  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.

Parameters:

  • definition_id (String) —

    The ID of the custom workflow action.

  • app_id (Integer)
  • extension_action_definition_patch (ExtensionActionDefinitionPatch) —

    The custom workflow action fields to be updated.

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

    the optional parameters

Returns:



318
319
320
321
 
# File 'lib/hubspot/codegen/automation/actions/api/definitions_api.rb', line 318

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.

Parameters:

  • definition_id (String) —

    The ID of the custom workflow action.

  • app_id (Integer)
  • extension_action_definition_patch (ExtensionActionDefinitionPatch) —

    The custom workflow action fields to be updated.

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

    the optional parameters

Returns:

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

    ExtensionActionDefinition data, response status code and response headers



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/automation/actions/api/definitions_api.rb', line 330

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'
  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(extension_action_definition_patch)

  # return_type
  return_type = opts[:debug_return_type] || 'ExtensionActionDefinition'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['developer_hapikey']

  new_options = opts.merge(
    :operation => :"DefinitionsApi.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, new_options)
  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