Class: Metronome::DataExpiryApi

Inherits:
Object
  • Object
show all
Defined in:
lib/metronome/api/data_expiry_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DataExpiryApi

Returns a new instance of DataExpiryApi.



19
20
21
 
# File 'lib/metronome/api/data_expiry_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/metronome/api/data_expiry_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_expiry_notices(date, opts = {}) ⇒ ExpiryResponse

Read items and sub-items that will or have already been expired on the given date

Parameters:

  • date (Date) —

    The date to query

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/metronome/api/data_expiry_api.rb', line 26

def get_expiry_notices(date, opts = {})
  data, _status_code, _headers = get_expiry_notices_with_http_info(date, opts)
  data
end

#get_expiry_notices_with_http_info(date, opts = {}) ⇒ Array<(ExpiryResponse, Integer, Hash)>

Read items and sub-items that will or have already been expired on the given date

Parameters:

  • date (Date) —

    The date to query

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

    the optional parameters

Returns:

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

    ExpiryResponse data, response status code and response headers



35
36
37
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/metronome/api/data_expiry_api.rb', line 35

def get_expiry_notices_with_http_info(date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DataExpiryApi.get_expiry_notices ...'
  end
  # verify the required parameter 'date' is set
  if @api_client.config.client_side_validation && date.nil?
    fail ArgumentError, "Missing the required parameter 'date' when calling DataExpiryApi.get_expiry_notices"
  end

  # PDS patch: if this is already converted to a date object, just use the date.
  date_string = nil
  if date.is_a?(Date)
    date_string = date.strftime("%Y%m%d")
  else
    if @api_client.config.client_side_validation && date.to_s.length > 8
      fail ArgumentError, 'invalid value for "date" when calling DataExpiryApi.get_expiry_notices, the character length must be smaller than or equal to 8.'
    end

    if @api_client.config.client_side_validation && date.to_s.length < 8
      fail ArgumentError, 'invalid value for "date" when calling DataExpiryApi.get_expiry_notices, the character length must be great than or equal to 8.'
    end

    pattern = Regexp.new(/^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$/)
    if @api_client.config.client_side_validation && date !~ pattern
      fail ArgumentError, "invalid value for 'date' when calling DataExpiryApi.get_expiry_notices, must conform to the pattern #{pattern}."
    end

    date_string = date
  end

  # resource path
  local_var_path = '/v1/metronome/expiry-notices/{date}'.sub('{' + 'date' + '}', CGI.escape(date_string))  # PDS patch

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

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

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