Class: MoneyKit::ProductsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/moneykit/api/products_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ProductsApi

Returns a new instance of ProductsApi.



19
20
21
 
# File 'lib/moneykit/api/products_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/moneykit/api/products_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#refresh_products(id, refresh_products_request, opts = {}) ⇒ LinkCommon

/links/id/products Requests an update of the provided products for the link. This is an asynchronous operation. The response will be a 202 Accepted if the request was successful. Refreshes are subject to rate limiting.
Rate Limiting
<ul> <li>1 refresh per link per hour for account data</li> <li>1 refresh per link per hour for transaction data</li> <li>1 refresh per link per day for account numbers</li> <li>1 refresh per link per day for identity data</li> </ul>

Parameters:

  • id (String) —

    The unique ID for this link.

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/moneykit/api/products_api.rb', line 28

def refresh_products(id, refresh_products_request, opts = {})
  data, _status_code, _headers = refresh_products_with_http_info(id, refresh_products_request, opts)
  data
end

#refresh_products_with_http_info(id, refresh_products_request, opts = {}) ⇒ Array<(LinkCommon, Integer, Hash)>

/links/id/products Requests an update of the provided products for the link. This is an asynchronous operation. The response will be a 202 Accepted if the request was successful. Refreshes are subject to rate limiting. &lt;br&gt;&lt;br&gt; &lt;b&gt;Rate Limiting&lt;/b&gt;&lt;br&gt; &lt;ul&gt; &lt;li&gt;1 refresh per link per hour for account data&lt;/li&gt; &lt;li&gt;1 refresh per link per hour for transaction data&lt;/li&gt; &lt;li&gt;1 refresh per link per day for account numbers&lt;/li&gt; &lt;li&gt;1 refresh per link per day for identity data&lt;/li&gt; &lt;/ul&gt;

Parameters:

  • id (String) —

    The unique ID for this link.

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

    the optional parameters

Returns:

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

    LinkCommon data, response status code and response headers



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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/moneykit/api/products_api.rb', line 39

def refresh_products_with_http_info(id, refresh_products_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.refresh_products ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.refresh_products"
  end
  # verify the required parameter 'refresh_products_request' is set
  if @api_client.config.client_side_validation && refresh_products_request.nil?
    fail ArgumentError, "Missing the required parameter 'refresh_products_request' when calling ProductsApi.refresh_products"
  end
  # resource path
  local_var_path = '/links/{id}/products'.sub('{' + 'id' + '}', CGI.escape(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(refresh_products_request)

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

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

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