Class: Hubspot::Crm::Extensions::Cards::SampleResponseApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/extensions/cards/api/sample_response_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SampleResponseApi

Returns a new instance of SampleResponseApi.



22
23
24
 
# File 'lib/hubspot/codegen/crm/extensions/cards/api/sample_response_api.rb', line 22

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/hubspot/codegen/crm/extensions/cards/api/sample_response_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#get_cards_sample_response(opts = {}) ⇒ IntegratorCardPayloadResponse

Get sample card detail response Returns an example card detail response. This is the payload with displayed details for a card that will be shown to a user. An app should send this in response to the data fetch request.

Parameters:

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

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/hubspot/codegen/crm/extensions/cards/api/sample_response_api.rb', line 29

def get_cards_sample_response(opts = {})
  data, _status_code, _headers = get_cards_sample_response_with_http_info(opts)
  data
end

#get_cards_sample_response_with_http_info(opts = {}) ⇒ Array<(IntegratorCardPayloadResponse, Integer, Hash)>

Get sample card detail response Returns an example card detail response. This is the payload with displayed details for a card that will be shown to a user. An app should send this in response to the data fetch request.

Parameters:

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

    the optional parameters

Returns:



38
39
40
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
 
# File 'lib/hubspot/codegen/crm/extensions/cards/api/sample_response_api.rb', line 38

def get_cards_sample_response_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SampleResponseApi.get_cards_sample_response ...'
  end
  # resource path
  local_var_path = '/crm/v3/extensions/cards/sample-response'

  # 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] || 'IntegratorCardPayloadResponse' 

  # auth_names
  auth_names = opts[:auth_names] || []

  new_options = 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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SampleResponseApi#get_cards_sample_response\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end