Class: Hubspot::Crm::Pipelines::PipelineStageAuditsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/pipelines/api/pipeline_stage_audits_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PipelineStageAuditsApi

Returns a new instance of PipelineStageAuditsApi.



21
22
23
 
# File 'lib/hubspot/codegen/crm/pipelines/api/pipeline_stage_audits_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/crm/pipelines/api/pipeline_stage_audits_api.rb', line 19

def api_client
  @api_client
end

Instance Method Details

#get_audit(object_type, stage_id, opts = {}) ⇒ CollectionResponsePublicAuditInfoNoPaging

Return an audit of all changes to the pipeline stage Return a reverse chronological list of all mutations that have occurred on the pipeline stage identified by ‘stageId`.

Parameters:

  • object_type (String)
  • stage_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



30
31
32
33
 
# File 'lib/hubspot/codegen/crm/pipelines/api/pipeline_stage_audits_api.rb', line 30

def get_audit(object_type, stage_id, opts = {})
  data, _status_code, _headers = get_audit_with_http_info(object_type, stage_id, opts)
  data
end

#get_audit_with_http_info(object_type, stage_id, opts = {}) ⇒ Array<(CollectionResponsePublicAuditInfoNoPaging, Integer, Hash)>

Return an audit of all changes to the pipeline stage Return a reverse chronological list of all mutations that have occurred on the pipeline stage identified by &#x60;stageId&#x60;.

Parameters:

  • object_type (String)
  • stage_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



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/crm/pipelines/api/pipeline_stage_audits_api.rb', line 41

def get_audit_with_http_info(object_type, stage_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PipelineStageAuditsApi.get_audit ...'
  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 PipelineStageAuditsApi.get_audit"
  end
  # verify the required parameter 'stage_id' is set
  if @api_client.config.client_side_validation && stage_id.nil?
    fail ArgumentError, "Missing the required parameter 'stage_id' when calling PipelineStageAuditsApi.get_audit"
  end
  # resource path
  local_var_path = '/crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}/audit'.sub('{' + 'objectType' + '}', CGI.escape(object_type.to_s)).sub('{' + 'stageId' + '}', CGI.escape(stage_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[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"PipelineStageAuditsApi.get_audit",
    :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: PipelineStageAuditsApi#get_audit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end