Class: Hubspot::Automation::Actions::RevisionsApi
- Inherits:
-
Object
- Object
- Hubspot::Automation::Actions::RevisionsApi
- Defined in:
- lib/hubspot/codegen/automation/actions/api/revisions_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#get_by_id(definition_id, revision_id, app_id, opts = {}) ⇒ ActionRevision
Get a revision for a custom action Returns the given version of a custom workflow action.
-
#get_by_id_with_http_info(definition_id, revision_id, app_id, opts = {}) ⇒ Array<(ActionRevision, Integer, Hash)>
Get a revision for a custom action Returns the given version of a custom workflow action.
-
#get_page(definition_id, app_id, opts = {}) ⇒ CollectionResponseActionRevisionForwardPaging
Get all revisions for a custom action Returns a list of revisions for a custom workflow action.
-
#get_page_with_http_info(definition_id, app_id, opts = {}) ⇒ Array<(CollectionResponseActionRevisionForwardPaging, Integer, Hash)>
Get all revisions for a custom action Returns a list of revisions for a custom workflow action.
-
#initialize(api_client = ApiClient.default) ⇒ RevisionsApi
constructor
A new instance of RevisionsApi.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ RevisionsApi
Returns a new instance of RevisionsApi.
21 22 23 |
# File 'lib/hubspot/codegen/automation/actions/api/revisions_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/revisions_api.rb', line 19 def api_client @api_client end |
Instance Method Details
#get_by_id(definition_id, revision_id, app_id, opts = {}) ⇒ ActionRevision
Get a revision for a custom action Returns the given version of a custom workflow action.
31 32 33 34 |
# File 'lib/hubspot/codegen/automation/actions/api/revisions_api.rb', line 31 def get_by_id(definition_id, revision_id, app_id, opts = {}) data, _status_code, _headers = get_by_id_with_http_info(definition_id, revision_id, app_id, opts) data end |
#get_by_id_with_http_info(definition_id, revision_id, app_id, opts = {}) ⇒ Array<(ActionRevision, Integer, Hash)>
Get a revision for a custom action Returns the given version of a custom workflow action.
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 95 96 |
# File 'lib/hubspot/codegen/automation/actions/api/revisions_api.rb', line 43 def get_by_id_with_http_info(definition_id, revision_id, app_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RevisionsApi.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 RevisionsApi.get_by_id" end # verify the required parameter 'revision_id' is set if @api_client.config.client_side_validation && revision_id.nil? fail ArgumentError, "Missing the required parameter 'revision_id' when calling RevisionsApi.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 RevisionsApi.get_by_id" end # resource path local_var_path = '/automation/v4/actions/{appId}/{definitionId}/revisions/{revisionId}'.sub('{' + 'definitionId' + '}', CGI.escape(definition_id.to_s)).sub('{' + 'revisionId' + '}', CGI.escape(revision_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', '*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'ActionRevision' # 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: RevisionsApi#get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_page(definition_id, app_id, opts = {}) ⇒ CollectionResponseActionRevisionForwardPaging
Get all revisions for a custom action Returns a list of revisions for a custom workflow action.
106 107 108 109 |
# File 'lib/hubspot/codegen/automation/actions/api/revisions_api.rb', line 106 def get_page(definition_id, app_id, opts = {}) data, _status_code, _headers = get_page_with_http_info(definition_id, app_id, opts) data end |
#get_page_with_http_info(definition_id, app_id, opts = {}) ⇒ Array<(CollectionResponseActionRevisionForwardPaging, Integer, Hash)>
Get all revisions for a custom action Returns a list of revisions for a custom workflow action.
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 167 168 169 170 |
# File 'lib/hubspot/codegen/automation/actions/api/revisions_api.rb', line 119 def get_page_with_http_info(definition_id, app_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RevisionsApi.get_page ...' 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 RevisionsApi.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 RevisionsApi.get_page" end # resource path local_var_path = '/automation/v4/actions/{appId}/{definitionId}/revisions'.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[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'after'] = opts[:'after'] if !opts[:'after'].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] || 'CollectionResponseActionRevisionForwardPaging' # 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: RevisionsApi#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |