smplkit 3.0.9 → 3.0.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. checksums.yaml +4 -4
  2. data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/actions_api.rb +9 -10
  3. data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb +11 -12
  4. data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/resource_types_api.rb +9 -10
  5. data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/usage_api.rb +9 -0
  6. data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/action_list_response.rb +4 -14
  7. data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/event_list_meta.rb +1 -0
  8. data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/event_list_response.rb +1 -1
  9. data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/{action_list_links.rb → forwarder_delivery_list_links.rb} +3 -3
  10. data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/{resource_type_list_meta.rb → forwarder_delivery_list_meta.rb} +4 -3
  11. data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_delivery_list_response.rb +3 -3
  12. data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_list_response.rb +4 -14
  13. data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/{action_list_meta.rb → list_meta.rb} +20 -19
  14. data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/{forwarder_list_links.rb → pagination_meta.rb} +78 -11
  15. data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/resource_type_list_response.rb +4 -14
  16. data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/usage_response.rb +30 -4
  17. data/lib/smplkit/_generated/audit/lib/smplkit_audit_client.rb +4 -6
  18. data/lib/smplkit/_generated/audit/spec/api/actions_api_spec.rb +3 -2
  19. data/lib/smplkit/_generated/audit/spec/api/forwarders_api_spec.rb +4 -3
  20. data/lib/smplkit/_generated/audit/spec/api/resource_types_api_spec.rb +3 -2
  21. data/lib/smplkit/_generated/audit/spec/api/usage_api_spec.rb +3 -0
  22. data/lib/smplkit/_generated/audit/spec/models/action_list_response_spec.rb +0 -6
  23. data/lib/smplkit/_generated/audit/spec/models/{action_list_links_spec.rb → forwarder_delivery_list_links_spec.rb} +6 -6
  24. data/lib/smplkit/_generated/audit/spec/models/{resource_type_list_meta_spec.rb → forwarder_delivery_list_meta_spec.rb} +6 -6
  25. data/lib/smplkit/_generated/audit/spec/models/forwarder_list_response_spec.rb +0 -6
  26. data/lib/smplkit/_generated/audit/spec/models/{action_list_meta_spec.rb → list_meta_spec.rb} +7 -7
  27. data/lib/smplkit/_generated/audit/spec/models/pagination_meta_spec.rb +54 -0
  28. data/lib/smplkit/_generated/audit/spec/models/resource_type_list_response_spec.rb +0 -6
  29. data/lib/smplkit/_generated/audit/spec/models/usage_response_spec.rb +6 -0
  30. data/lib/smplkit/_generated/logging/lib/smplkit_logging_client/api/log_groups_api.rb +9 -0
  31. data/lib/smplkit/_generated/logging/lib/smplkit_logging_client/api/logger_sources_api.rb +18 -0
  32. data/lib/smplkit/_generated/logging/lib/smplkit_logging_client/api/loggers_api.rb +11 -2
  33. data/lib/smplkit/_generated/logging/lib/smplkit_logging_client/api/services_api.rb +9 -0
  34. data/lib/smplkit/_generated/logging/lib/smplkit_logging_client/api/usage_api.rb +9 -0
  35. data/lib/smplkit/_generated/{audit/lib/smplkit_audit_client/models/forwarder_list_meta.rb → logging/lib/smplkit_logging_client/models/list_meta.rb} +23 -22
  36. data/lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/log_group_list_response.rb +30 -4
  37. data/lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger_list_response.rb +30 -4
  38. data/lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger_source_list_response.rb +30 -4
  39. data/lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/pagination_meta.rb +215 -0
  40. data/lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/service_list_response.rb +30 -4
  41. data/lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/usage_list_response.rb +30 -4
  42. data/lib/smplkit/_generated/logging/lib/smplkit_logging_client.rb +2 -0
  43. data/lib/smplkit/_generated/logging/spec/api/log_groups_api_spec.rb +3 -0
  44. data/lib/smplkit/_generated/logging/spec/api/logger_sources_api_spec.rb +6 -0
  45. data/lib/smplkit/_generated/logging/spec/api/loggers_api_spec.rb +4 -1
  46. data/lib/smplkit/_generated/logging/spec/api/services_api_spec.rb +3 -0
  47. data/lib/smplkit/_generated/logging/spec/api/usage_api_spec.rb +3 -0
  48. data/lib/smplkit/_generated/{audit/spec/models/forwarder_list_meta_spec.rb → logging/spec/models/list_meta_spec.rb} +9 -9
  49. data/lib/smplkit/_generated/logging/spec/models/log_group_list_response_spec.rb +6 -0
  50. data/lib/smplkit/_generated/logging/spec/models/logger_list_response_spec.rb +6 -0
  51. data/lib/smplkit/_generated/logging/spec/models/logger_source_list_response_spec.rb +6 -0
  52. data/lib/smplkit/_generated/logging/spec/models/pagination_meta_spec.rb +54 -0
  53. data/lib/smplkit/_generated/logging/spec/models/service_list_response_spec.rb +6 -0
  54. data/lib/smplkit/_generated/logging/spec/models/usage_list_response_spec.rb +6 -0
  55. data/lib/smplkit/audit/actions.rb +7 -6
  56. data/lib/smplkit/audit/models.rb +14 -0
  57. data/lib/smplkit/audit/resource_types.rb +7 -6
  58. data/lib/smplkit/management/audit.rb +5 -4
  59. metadata +13 -13
  60. data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/resource_type_list_links.rb +0 -148
  61. data/lib/smplkit/_generated/audit/spec/models/forwarder_list_links_spec.rb +0 -36
  62. data/lib/smplkit/_generated/audit/spec/models/resource_type_list_links_spec.rb +0 -36
@@ -25,6 +25,9 @@ module SmplkitGeneratedClient::Logging
25
25
  # @option opts [String] :filter_environment
26
26
  # @option opts [String] :filter_service
27
27
  # @option opts [String] :sort Field to sort by. Prefix with `-` for descending order. Default: `-last_seen`. Allowed values: `created_at`, `-created_at`, `environment`, `-environment`, `last_seen`, `-last_seen`, `service`, `-service`. (default to '-last_seen')
28
+ # @option opts [Integer] :page_number 1-based page number to return. Optional; defaults to `1` when omitted. Must be `>= 1` — requests with a smaller value are rejected with a 400 error. (default to 1)
29
+ # @option opts [Integer] :page_size Number of items per page. Optional; defaults to `1000` when omitted. Must be between `1` and `1000` inclusive — requests outside that range are rejected with a 400 error. (default to 1000)
30
+ # @option opts [Boolean] :meta_total When `true`, the response's `meta.pagination` block includes `total` (the total number of matching items across all pages) and `total_pages`. Computing these requires an extra `COUNT` query, so omit (or pass `false`) when the totals are not needed. Defaults to `false`. (default to false)
28
31
  # @return [LoggerSourceListResponse]
29
32
  def list_all_logger_sources(opts = {})
30
33
  data, _status_code, _headers = list_all_logger_sources_with_http_info(opts)
@@ -37,6 +40,9 @@ module SmplkitGeneratedClient::Logging
37
40
  # @option opts [String] :filter_environment
38
41
  # @option opts [String] :filter_service
39
42
  # @option opts [String] :sort Field to sort by. Prefix with `-` for descending order. Default: `-last_seen`. Allowed values: `created_at`, `-created_at`, `environment`, `-environment`, `last_seen`, `-last_seen`, `service`, `-service`. (default to '-last_seen')
43
+ # @option opts [Integer] :page_number 1-based page number to return. Optional; defaults to `1` when omitted. Must be `>= 1` — requests with a smaller value are rejected with a 400 error. (default to 1)
44
+ # @option opts [Integer] :page_size Number of items per page. Optional; defaults to `1000` when omitted. Must be between `1` and `1000` inclusive — requests outside that range are rejected with a 400 error. (default to 1000)
45
+ # @option opts [Boolean] :meta_total When `true`, the response's `meta.pagination` block includes `total` (the total number of matching items across all pages) and `total_pages`. Computing these requires an extra `COUNT` query, so omit (or pass `false`) when the totals are not needed. Defaults to `false`. (default to false)
40
46
  # @return [Array<(LoggerSourceListResponse, Integer, Hash)>] LoggerSourceListResponse data, response status code and response headers
41
47
  def list_all_logger_sources_with_http_info(opts = {})
42
48
  if @api_client.config.debugging
@@ -54,6 +60,9 @@ module SmplkitGeneratedClient::Logging
54
60
  query_params[:'filter[environment]'] = opts[:'filter_environment'] if !opts[:'filter_environment'].nil?
55
61
  query_params[:'filter[service]'] = opts[:'filter_service'] if !opts[:'filter_service'].nil?
56
62
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
63
+ query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
64
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
65
+ query_params[:'meta[total]'] = opts[:'meta_total'] if !opts[:'meta_total'].nil?
57
66
 
58
67
  # header parameters
59
68
  header_params = opts[:header_params] || {}
@@ -94,6 +103,9 @@ module SmplkitGeneratedClient::Logging
94
103
  # @param id [String]
95
104
  # @param [Hash] opts the optional parameters
96
105
  # @option opts [String] :sort Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;-last_seen&#x60;. Allowed values: &#x60;created_at&#x60;, &#x60;-created_at&#x60;, &#x60;environment&#x60;, &#x60;-environment&#x60;, &#x60;last_seen&#x60;, &#x60;-last_seen&#x60;, &#x60;service&#x60;, &#x60;-service&#x60;. (default to '-last_seen')
106
+ # @option opts [Integer] :page_number 1-based page number to return. Optional; defaults to &#x60;1&#x60; when omitted. Must be &#x60;&gt;&#x3D; 1&#x60; — requests with a smaller value are rejected with a 400 error. (default to 1)
107
+ # @option opts [Integer] :page_size Number of items per page. Optional; defaults to &#x60;1000&#x60; when omitted. Must be between &#x60;1&#x60; and &#x60;1000&#x60; inclusive — requests outside that range are rejected with a 400 error. (default to 1000)
108
+ # @option opts [Boolean] :meta_total When &#x60;true&#x60;, the response&#39;s &#x60;meta.pagination&#x60; block includes &#x60;total&#x60; (the total number of matching items across all pages) and &#x60;total_pages&#x60;. Computing these requires an extra &#x60;COUNT&#x60; query, so omit (or pass &#x60;false&#x60;) when the totals are not needed. Defaults to &#x60;false&#x60;. (default to false)
97
109
  # @return [LoggerSourceListResponse]
98
110
  def list_logger_sources(id, opts = {})
99
111
  data, _status_code, _headers = list_logger_sources_with_http_info(id, opts)
@@ -105,6 +117,9 @@ module SmplkitGeneratedClient::Logging
105
117
  # @param id [String]
106
118
  # @param [Hash] opts the optional parameters
107
119
  # @option opts [String] :sort Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;-last_seen&#x60;. Allowed values: &#x60;created_at&#x60;, &#x60;-created_at&#x60;, &#x60;environment&#x60;, &#x60;-environment&#x60;, &#x60;last_seen&#x60;, &#x60;-last_seen&#x60;, &#x60;service&#x60;, &#x60;-service&#x60;. (default to '-last_seen')
120
+ # @option opts [Integer] :page_number 1-based page number to return. Optional; defaults to &#x60;1&#x60; when omitted. Must be &#x60;&gt;&#x3D; 1&#x60; — requests with a smaller value are rejected with a 400 error. (default to 1)
121
+ # @option opts [Integer] :page_size Number of items per page. Optional; defaults to &#x60;1000&#x60; when omitted. Must be between &#x60;1&#x60; and &#x60;1000&#x60; inclusive — requests outside that range are rejected with a 400 error. (default to 1000)
122
+ # @option opts [Boolean] :meta_total When &#x60;true&#x60;, the response&#39;s &#x60;meta.pagination&#x60; block includes &#x60;total&#x60; (the total number of matching items across all pages) and &#x60;total_pages&#x60;. Computing these requires an extra &#x60;COUNT&#x60; query, so omit (or pass &#x60;false&#x60;) when the totals are not needed. Defaults to &#x60;false&#x60;. (default to false)
108
123
  # @return [Array<(LoggerSourceListResponse, Integer, Hash)>] LoggerSourceListResponse data, response status code and response headers
109
124
  def list_logger_sources_with_http_info(id, opts = {})
110
125
  if @api_client.config.debugging
@@ -124,6 +139,9 @@ module SmplkitGeneratedClient::Logging
124
139
  # query parameters
125
140
  query_params = opts[:query_params] || {}
126
141
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
142
+ query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
143
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
144
+ query_params[:'meta[total]'] = opts[:'meta_total'] if !opts[:'meta_total'].nil?
127
145
 
128
146
  # header parameters
129
147
  header_params = opts[:header_params] || {}
@@ -214,12 +214,15 @@ module SmplkitGeneratedClient::Logging
214
214
  end
215
215
 
216
216
  # List Loggers
217
- # List loggers for this account. Default sort is `key` ascending. Supports `filter[managed]` to narrow to managed (or unmanaged) loggers, `filter[service]` to keep only loggers observed in a specific service, and `filter[last_seen]` (interval notation `[<from>,*)`) to keep only loggers with a source observation at or after the given timestamp.
217
+ # List loggers for this account. Default sort is `key` ascending. Supports `filter[managed]` to narrow to managed (or unmanaged) loggers, `filter[service]` to keep only loggers observed in a specific service, and `filter[last_seen]` (interval notation `[<from>,*)`) to keep only loggers with a source observation at or after the given timestamp. ``filter[service]`` and ``filter[last_seen]`` are applied via a cross-table membership check in Python after the SQL fetch, so pagination for those calls is applied in memory after the filter; the common path (no source-bound filter) paginates at the SQL level.
218
218
  # @param [Hash] opts the optional parameters
219
219
  # @option opts [Boolean] :filter_managed
220
220
  # @option opts [String] :filter_service
221
221
  # @option opts [String] :filter_last_seen
222
222
  # @option opts [String] :sort Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;key&#x60;. Allowed values: &#x60;created_at&#x60;, &#x60;-created_at&#x60;, &#x60;key&#x60;, &#x60;-key&#x60;, &#x60;name&#x60;, &#x60;-name&#x60;, &#x60;updated_at&#x60;, &#x60;-updated_at&#x60;. (default to 'key')
223
+ # @option opts [Integer] :page_number 1-based page number to return. Optional; defaults to &#x60;1&#x60; when omitted. Must be &#x60;&gt;&#x3D; 1&#x60; — requests with a smaller value are rejected with a 400 error. (default to 1)
224
+ # @option opts [Integer] :page_size Number of items per page. Optional; defaults to &#x60;1000&#x60; when omitted. Must be between &#x60;1&#x60; and &#x60;1000&#x60; inclusive — requests outside that range are rejected with a 400 error. (default to 1000)
225
+ # @option opts [Boolean] :meta_total When &#x60;true&#x60;, the response&#39;s &#x60;meta.pagination&#x60; block includes &#x60;total&#x60; (the total number of matching items across all pages) and &#x60;total_pages&#x60;. Computing these requires an extra &#x60;COUNT&#x60; query, so omit (or pass &#x60;false&#x60;) when the totals are not needed. Defaults to &#x60;false&#x60;. (default to false)
223
226
  # @return [LoggerListResponse]
224
227
  def list_loggers(opts = {})
225
228
  data, _status_code, _headers = list_loggers_with_http_info(opts)
@@ -227,12 +230,15 @@ module SmplkitGeneratedClient::Logging
227
230
  end
228
231
 
229
232
  # List Loggers
230
- # List loggers for this account. Default sort is &#x60;key&#x60; ascending. Supports &#x60;filter[managed]&#x60; to narrow to managed (or unmanaged) loggers, &#x60;filter[service]&#x60; to keep only loggers observed in a specific service, and &#x60;filter[last_seen]&#x60; (interval notation &#x60;[&lt;from&gt;,*)&#x60;) to keep only loggers with a source observation at or after the given timestamp.
233
+ # List loggers for this account. Default sort is &#x60;key&#x60; ascending. Supports &#x60;filter[managed]&#x60; to narrow to managed (or unmanaged) loggers, &#x60;filter[service]&#x60; to keep only loggers observed in a specific service, and &#x60;filter[last_seen]&#x60; (interval notation &#x60;[&lt;from&gt;,*)&#x60;) to keep only loggers with a source observation at or after the given timestamp. &#x60;&#x60;filter[service]&#x60;&#x60; and &#x60;&#x60;filter[last_seen]&#x60;&#x60; are applied via a cross-table membership check in Python after the SQL fetch, so pagination for those calls is applied in memory after the filter; the common path (no source-bound filter) paginates at the SQL level.
231
234
  # @param [Hash] opts the optional parameters
232
235
  # @option opts [Boolean] :filter_managed
233
236
  # @option opts [String] :filter_service
234
237
  # @option opts [String] :filter_last_seen
235
238
  # @option opts [String] :sort Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;key&#x60;. Allowed values: &#x60;created_at&#x60;, &#x60;-created_at&#x60;, &#x60;key&#x60;, &#x60;-key&#x60;, &#x60;name&#x60;, &#x60;-name&#x60;, &#x60;updated_at&#x60;, &#x60;-updated_at&#x60;. (default to 'key')
239
+ # @option opts [Integer] :page_number 1-based page number to return. Optional; defaults to &#x60;1&#x60; when omitted. Must be &#x60;&gt;&#x3D; 1&#x60; — requests with a smaller value are rejected with a 400 error. (default to 1)
240
+ # @option opts [Integer] :page_size Number of items per page. Optional; defaults to &#x60;1000&#x60; when omitted. Must be between &#x60;1&#x60; and &#x60;1000&#x60; inclusive — requests outside that range are rejected with a 400 error. (default to 1000)
241
+ # @option opts [Boolean] :meta_total When &#x60;true&#x60;, the response&#39;s &#x60;meta.pagination&#x60; block includes &#x60;total&#x60; (the total number of matching items across all pages) and &#x60;total_pages&#x60;. Computing these requires an extra &#x60;COUNT&#x60; query, so omit (or pass &#x60;false&#x60;) when the totals are not needed. Defaults to &#x60;false&#x60;. (default to false)
236
242
  # @return [Array<(LoggerListResponse, Integer, Hash)>] LoggerListResponse data, response status code and response headers
237
243
  def list_loggers_with_http_info(opts = {})
238
244
  if @api_client.config.debugging
@@ -251,6 +257,9 @@ module SmplkitGeneratedClient::Logging
251
257
  query_params[:'filter[service]'] = opts[:'filter_service'] if !opts[:'filter_service'].nil?
252
258
  query_params[:'filter[last_seen]'] = opts[:'filter_last_seen'] if !opts[:'filter_last_seen'].nil?
253
259
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
260
+ query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
261
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
262
+ query_params[:'meta[total]'] = opts[:'meta_total'] if !opts[:'meta_total'].nil?
254
263
 
255
264
  # header parameters
256
265
  header_params = opts[:header_params] || {}
@@ -23,6 +23,9 @@ module SmplkitGeneratedClient::Logging
23
23
  # List the services that have reported a logger for this account. Default sort is `name` ascending.
24
24
  # @param [Hash] opts the optional parameters
25
25
  # @option opts [String] :sort Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;name&#x60;. Allowed values: &#x60;name&#x60;, &#x60;-name&#x60;. (default to 'name')
26
+ # @option opts [Integer] :page_number 1-based page number to return. Optional; defaults to &#x60;1&#x60; when omitted. Must be &#x60;&gt;&#x3D; 1&#x60; — requests with a smaller value are rejected with a 400 error. (default to 1)
27
+ # @option opts [Integer] :page_size Number of items per page. Optional; defaults to &#x60;1000&#x60; when omitted. Must be between &#x60;1&#x60; and &#x60;1000&#x60; inclusive — requests outside that range are rejected with a 400 error. (default to 1000)
28
+ # @option opts [Boolean] :meta_total When &#x60;true&#x60;, the response&#39;s &#x60;meta.pagination&#x60; block includes &#x60;total&#x60; (the total number of matching items across all pages) and &#x60;total_pages&#x60;. Computing these requires an extra &#x60;COUNT&#x60; query, so omit (or pass &#x60;false&#x60;) when the totals are not needed. Defaults to &#x60;false&#x60;. (default to false)
26
29
  # @return [ServiceListResponse]
27
30
  def list_services(opts = {})
28
31
  data, _status_code, _headers = list_services_with_http_info(opts)
@@ -33,6 +36,9 @@ module SmplkitGeneratedClient::Logging
33
36
  # List the services that have reported a logger for this account. Default sort is &#x60;name&#x60; ascending.
34
37
  # @param [Hash] opts the optional parameters
35
38
  # @option opts [String] :sort Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;name&#x60;. Allowed values: &#x60;name&#x60;, &#x60;-name&#x60;. (default to 'name')
39
+ # @option opts [Integer] :page_number 1-based page number to return. Optional; defaults to &#x60;1&#x60; when omitted. Must be &#x60;&gt;&#x3D; 1&#x60; — requests with a smaller value are rejected with a 400 error. (default to 1)
40
+ # @option opts [Integer] :page_size Number of items per page. Optional; defaults to &#x60;1000&#x60; when omitted. Must be between &#x60;1&#x60; and &#x60;1000&#x60; inclusive — requests outside that range are rejected with a 400 error. (default to 1000)
41
+ # @option opts [Boolean] :meta_total When &#x60;true&#x60;, the response&#39;s &#x60;meta.pagination&#x60; block includes &#x60;total&#x60; (the total number of matching items across all pages) and &#x60;total_pages&#x60;. Computing these requires an extra &#x60;COUNT&#x60; query, so omit (or pass &#x60;false&#x60;) when the totals are not needed. Defaults to &#x60;false&#x60;. (default to false)
36
42
  # @return [Array<(ServiceListResponse, Integer, Hash)>] ServiceListResponse data, response status code and response headers
37
43
  def list_services_with_http_info(opts = {})
38
44
  if @api_client.config.debugging
@@ -48,6 +54,9 @@ module SmplkitGeneratedClient::Logging
48
54
  # query parameters
49
55
  query_params = opts[:query_params] || {}
50
56
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
57
+ query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
58
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
59
+ query_params[:'meta[total]'] = opts[:'meta_total'] if !opts[:'meta_total'].nil?
51
60
 
52
61
  # header parameters
53
62
  header_params = opts[:header_params] || {}
@@ -23,6 +23,9 @@ module SmplkitGeneratedClient::Logging
23
23
  # Report the current-period usage counters for this account.
24
24
  # @param [Hash] opts the optional parameters
25
25
  # @option opts [String] :filter_period
26
+ # @option opts [Integer] :page_number 1-based page number to return. Optional; defaults to &#x60;1&#x60; when omitted. Must be &#x60;&gt;&#x3D; 1&#x60; — requests with a smaller value are rejected with a 400 error. (default to 1)
27
+ # @option opts [Integer] :page_size Number of items per page. Optional; defaults to &#x60;1000&#x60; when omitted. Must be between &#x60;1&#x60; and &#x60;1000&#x60; inclusive — requests outside that range are rejected with a 400 error. (default to 1000)
28
+ # @option opts [Boolean] :meta_total When &#x60;true&#x60;, the response&#39;s &#x60;meta.pagination&#x60; block includes &#x60;total&#x60; (the total number of matching items across all pages) and &#x60;total_pages&#x60;. Computing these requires an extra &#x60;COUNT&#x60; query, so omit (or pass &#x60;false&#x60;) when the totals are not needed. Defaults to &#x60;false&#x60;. (default to false)
26
29
  # @return [UsageListResponse]
27
30
  def list_logging_usage(opts = {})
28
31
  data, _status_code, _headers = list_logging_usage_with_http_info(opts)
@@ -33,6 +36,9 @@ module SmplkitGeneratedClient::Logging
33
36
  # Report the current-period usage counters for this account.
34
37
  # @param [Hash] opts the optional parameters
35
38
  # @option opts [String] :filter_period
39
+ # @option opts [Integer] :page_number 1-based page number to return. Optional; defaults to &#x60;1&#x60; when omitted. Must be &#x60;&gt;&#x3D; 1&#x60; — requests with a smaller value are rejected with a 400 error. (default to 1)
40
+ # @option opts [Integer] :page_size Number of items per page. Optional; defaults to &#x60;1000&#x60; when omitted. Must be between &#x60;1&#x60; and &#x60;1000&#x60; inclusive — requests outside that range are rejected with a 400 error. (default to 1000)
41
+ # @option opts [Boolean] :meta_total When &#x60;true&#x60;, the response&#39;s &#x60;meta.pagination&#x60; block includes &#x60;total&#x60; (the total number of matching items across all pages) and &#x60;total_pages&#x60;. Computing these requires an extra &#x60;COUNT&#x60; query, so omit (or pass &#x60;false&#x60;) when the totals are not needed. Defaults to &#x60;false&#x60;. (default to false)
36
42
  # @return [Array<(UsageListResponse, Integer, Hash)>] UsageListResponse data, response status code and response headers
37
43
  def list_logging_usage_with_http_info(opts = {})
38
44
  if @api_client.config.debugging
@@ -44,6 +50,9 @@ module SmplkitGeneratedClient::Logging
44
50
  # query parameters
45
51
  query_params = opts[:query_params] || {}
46
52
  query_params[:'filter[period]'] = opts[:'filter_period'] if !opts[:'filter_period'].nil?
53
+ query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
54
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
55
+ query_params[:'meta[total]'] = opts[:'meta_total'] if !opts[:'meta_total'].nil?
47
56
 
48
57
  # header parameters
49
58
  header_params = opts[:header_params] || {}
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #smplkit Audit API
2
+ #smplkit Logging API
3
3
 
4
- #Append-only change-history substrate for smpl.* resources and customer-application events. ADR-047.
4
+ #API for the smplkit logging service.
5
5
 
6
6
  The version of the OpenAPI document: 0.1.0
7
7
 
@@ -13,14 +13,15 @@ Generator version: 7.22.0
13
13
  require 'date'
14
14
  require 'time'
15
15
 
16
- module SmplkitGeneratedClient::Audit
17
- class ForwarderListMeta < ApiModelBase
18
- attr_accessor :page_size
16
+ module SmplkitGeneratedClient::Logging
17
+ # Top-level ``meta`` block included on every JSON:API list response.
18
+ class ListMeta < ApiModelBase
19
+ attr_accessor :pagination
19
20
 
20
21
  # Attribute mapping from ruby-style variable name to JSON key.
21
22
  def self.attribute_map
22
23
  {
23
- :'page_size' => :'page_size'
24
+ :'pagination' => :'pagination'
24
25
  }
25
26
  end
26
27
 
@@ -37,7 +38,7 @@ module SmplkitGeneratedClient::Audit
37
38
  # Attribute type mapping.
38
39
  def self.openapi_types
39
40
  {
40
- :'page_size' => :'Integer'
41
+ :'pagination' => :'PaginationMeta'
41
42
  }
42
43
  end
43
44
 
@@ -51,22 +52,22 @@ module SmplkitGeneratedClient::Audit
51
52
  # @param [Hash] attributes Model attributes in the form of hash
52
53
  def initialize(attributes = {})
53
54
  if (!attributes.is_a?(Hash))
54
- fail ArgumentError, "The input argument (attributes) must be a hash in `SmplkitGeneratedClient::Audit::ForwarderListMeta` initialize method"
55
+ fail ArgumentError, "The input argument (attributes) must be a hash in `SmplkitGeneratedClient::Logging::ListMeta` initialize method"
55
56
  end
56
57
 
57
58
  # check to see if the attribute exists and convert string to symbol for hash key
58
59
  acceptable_attribute_map = self.class.acceptable_attribute_map
59
60
  attributes = attributes.each_with_object({}) { |(k, v), h|
60
61
  if (!acceptable_attribute_map.key?(k.to_sym))
61
- fail ArgumentError, "`#{k}` is not a valid attribute in `SmplkitGeneratedClient::Audit::ForwarderListMeta`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
62
+ fail ArgumentError, "`#{k}` is not a valid attribute in `SmplkitGeneratedClient::Logging::ListMeta`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
62
63
  end
63
64
  h[k.to_sym] = v
64
65
  }
65
66
 
66
- if attributes.key?(:'page_size')
67
- self.page_size = attributes[:'page_size']
67
+ if attributes.key?(:'pagination')
68
+ self.pagination = attributes[:'pagination']
68
69
  else
69
- self.page_size = nil
70
+ self.pagination = nil
70
71
  end
71
72
  end
72
73
 
@@ -75,8 +76,8 @@ module SmplkitGeneratedClient::Audit
75
76
  def list_invalid_properties
76
77
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
77
78
  invalid_properties = Array.new
78
- if @page_size.nil?
79
- invalid_properties.push('invalid value for "page_size", page_size cannot be nil.')
79
+ if @pagination.nil?
80
+ invalid_properties.push('invalid value for "pagination", pagination cannot be nil.')
80
81
  end
81
82
 
82
83
  invalid_properties
@@ -86,18 +87,18 @@ module SmplkitGeneratedClient::Audit
86
87
  # @return true if the model is valid
87
88
  def valid?
88
89
  warn '[DEPRECATED] the `valid?` method is obsolete'
89
- return false if @page_size.nil?
90
+ return false if @pagination.nil?
90
91
  true
91
92
  end
92
93
 
93
94
  # Custom attribute writer method with validation
94
- # @param [Object] page_size Value to be assigned
95
- def page_size=(page_size)
96
- if page_size.nil?
97
- fail ArgumentError, 'page_size cannot be nil'
95
+ # @param [Object] pagination Value to be assigned
96
+ def pagination=(pagination)
97
+ if pagination.nil?
98
+ fail ArgumentError, 'pagination cannot be nil'
98
99
  end
99
100
 
100
- @page_size = page_size
101
+ @pagination = pagination
101
102
  end
102
103
 
103
104
  # Checks equality by comparing each attribute.
@@ -105,7 +106,7 @@ module SmplkitGeneratedClient::Audit
105
106
  def ==(o)
106
107
  return true if self.equal?(o)
107
108
  self.class == o.class &&
108
- page_size == o.page_size
109
+ pagination == o.pagination
109
110
  end
110
111
 
111
112
  # @see the `==` method
@@ -117,7 +118,7 @@ module SmplkitGeneratedClient::Audit
117
118
  # Calculates hash code according to all attributes.
118
119
  # @return [Integer] Hash code
119
120
  def hash
120
- [page_size].hash
121
+ [pagination].hash
121
122
  end
122
123
 
123
124
  # Builds the object from hash
@@ -18,10 +18,13 @@ module SmplkitGeneratedClient::Logging
18
18
  class LogGroupListResponse < ApiModelBase
19
19
  attr_accessor :data
20
20
 
21
+ attr_accessor :meta
22
+
21
23
  # Attribute mapping from ruby-style variable name to JSON key.
22
24
  def self.attribute_map
23
25
  {
24
- :'data' => :'data'
26
+ :'data' => :'data',
27
+ :'meta' => :'meta'
25
28
  }
26
29
  end
27
30
 
@@ -38,7 +41,8 @@ module SmplkitGeneratedClient::Logging
38
41
  # Attribute type mapping.
39
42
  def self.openapi_types
40
43
  {
41
- :'data' => :'Array<LogGroupResource>'
44
+ :'data' => :'Array<LogGroupResource>',
45
+ :'meta' => :'ListMeta'
42
46
  }
43
47
  end
44
48
 
@@ -71,6 +75,12 @@ module SmplkitGeneratedClient::Logging
71
75
  else
72
76
  self.data = nil
73
77
  end
78
+
79
+ if attributes.key?(:'meta')
80
+ self.meta = attributes[:'meta']
81
+ else
82
+ self.meta = nil
83
+ end
74
84
  end
75
85
 
76
86
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -82,6 +92,10 @@ module SmplkitGeneratedClient::Logging
82
92
  invalid_properties.push('invalid value for "data", data cannot be nil.')
83
93
  end
84
94
 
95
+ if @meta.nil?
96
+ invalid_properties.push('invalid value for "meta", meta cannot be nil.')
97
+ end
98
+
85
99
  invalid_properties
86
100
  end
87
101
 
@@ -90,6 +104,7 @@ module SmplkitGeneratedClient::Logging
90
104
  def valid?
91
105
  warn '[DEPRECATED] the `valid?` method is obsolete'
92
106
  return false if @data.nil?
107
+ return false if @meta.nil?
93
108
  true
94
109
  end
95
110
 
@@ -103,12 +118,23 @@ module SmplkitGeneratedClient::Logging
103
118
  @data = data
104
119
  end
105
120
 
121
+ # Custom attribute writer method with validation
122
+ # @param [Object] meta Value to be assigned
123
+ def meta=(meta)
124
+ if meta.nil?
125
+ fail ArgumentError, 'meta cannot be nil'
126
+ end
127
+
128
+ @meta = meta
129
+ end
130
+
106
131
  # Checks equality by comparing each attribute.
107
132
  # @param [Object] Object to be compared
108
133
  def ==(o)
109
134
  return true if self.equal?(o)
110
135
  self.class == o.class &&
111
- data == o.data
136
+ data == o.data &&
137
+ meta == o.meta
112
138
  end
113
139
 
114
140
  # @see the `==` method
@@ -120,7 +146,7 @@ module SmplkitGeneratedClient::Logging
120
146
  # Calculates hash code according to all attributes.
121
147
  # @return [Integer] Hash code
122
148
  def hash
123
- [data].hash
149
+ [data, meta].hash
124
150
  end
125
151
 
126
152
  # Builds the object from hash
@@ -18,10 +18,13 @@ module SmplkitGeneratedClient::Logging
18
18
  class LoggerListResponse < ApiModelBase
19
19
  attr_accessor :data
20
20
 
21
+ attr_accessor :meta
22
+
21
23
  # Attribute mapping from ruby-style variable name to JSON key.
22
24
  def self.attribute_map
23
25
  {
24
- :'data' => :'data'
26
+ :'data' => :'data',
27
+ :'meta' => :'meta'
25
28
  }
26
29
  end
27
30
 
@@ -38,7 +41,8 @@ module SmplkitGeneratedClient::Logging
38
41
  # Attribute type mapping.
39
42
  def self.openapi_types
40
43
  {
41
- :'data' => :'Array<LoggerResource>'
44
+ :'data' => :'Array<LoggerResource>',
45
+ :'meta' => :'ListMeta'
42
46
  }
43
47
  end
44
48
 
@@ -71,6 +75,12 @@ module SmplkitGeneratedClient::Logging
71
75
  else
72
76
  self.data = nil
73
77
  end
78
+
79
+ if attributes.key?(:'meta')
80
+ self.meta = attributes[:'meta']
81
+ else
82
+ self.meta = nil
83
+ end
74
84
  end
75
85
 
76
86
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -82,6 +92,10 @@ module SmplkitGeneratedClient::Logging
82
92
  invalid_properties.push('invalid value for "data", data cannot be nil.')
83
93
  end
84
94
 
95
+ if @meta.nil?
96
+ invalid_properties.push('invalid value for "meta", meta cannot be nil.')
97
+ end
98
+
85
99
  invalid_properties
86
100
  end
87
101
 
@@ -90,6 +104,7 @@ module SmplkitGeneratedClient::Logging
90
104
  def valid?
91
105
  warn '[DEPRECATED] the `valid?` method is obsolete'
92
106
  return false if @data.nil?
107
+ return false if @meta.nil?
93
108
  true
94
109
  end
95
110
 
@@ -103,12 +118,23 @@ module SmplkitGeneratedClient::Logging
103
118
  @data = data
104
119
  end
105
120
 
121
+ # Custom attribute writer method with validation
122
+ # @param [Object] meta Value to be assigned
123
+ def meta=(meta)
124
+ if meta.nil?
125
+ fail ArgumentError, 'meta cannot be nil'
126
+ end
127
+
128
+ @meta = meta
129
+ end
130
+
106
131
  # Checks equality by comparing each attribute.
107
132
  # @param [Object] Object to be compared
108
133
  def ==(o)
109
134
  return true if self.equal?(o)
110
135
  self.class == o.class &&
111
- data == o.data
136
+ data == o.data &&
137
+ meta == o.meta
112
138
  end
113
139
 
114
140
  # @see the `==` method
@@ -120,7 +146,7 @@ module SmplkitGeneratedClient::Logging
120
146
  # Calculates hash code according to all attributes.
121
147
  # @return [Integer] Hash code
122
148
  def hash
123
- [data].hash
149
+ [data, meta].hash
124
150
  end
125
151
 
126
152
  # Builds the object from hash
@@ -18,10 +18,13 @@ module SmplkitGeneratedClient::Logging
18
18
  class LoggerSourceListResponse < ApiModelBase
19
19
  attr_accessor :data
20
20
 
21
+ attr_accessor :meta
22
+
21
23
  # Attribute mapping from ruby-style variable name to JSON key.
22
24
  def self.attribute_map
23
25
  {
24
- :'data' => :'data'
26
+ :'data' => :'data',
27
+ :'meta' => :'meta'
25
28
  }
26
29
  end
27
30
 
@@ -38,7 +41,8 @@ module SmplkitGeneratedClient::Logging
38
41
  # Attribute type mapping.
39
42
  def self.openapi_types
40
43
  {
41
- :'data' => :'Array<LoggerSourceResource>'
44
+ :'data' => :'Array<LoggerSourceResource>',
45
+ :'meta' => :'ListMeta'
42
46
  }
43
47
  end
44
48
 
@@ -71,6 +75,12 @@ module SmplkitGeneratedClient::Logging
71
75
  else
72
76
  self.data = nil
73
77
  end
78
+
79
+ if attributes.key?(:'meta')
80
+ self.meta = attributes[:'meta']
81
+ else
82
+ self.meta = nil
83
+ end
74
84
  end
75
85
 
76
86
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -82,6 +92,10 @@ module SmplkitGeneratedClient::Logging
82
92
  invalid_properties.push('invalid value for "data", data cannot be nil.')
83
93
  end
84
94
 
95
+ if @meta.nil?
96
+ invalid_properties.push('invalid value for "meta", meta cannot be nil.')
97
+ end
98
+
85
99
  invalid_properties
86
100
  end
87
101
 
@@ -90,6 +104,7 @@ module SmplkitGeneratedClient::Logging
90
104
  def valid?
91
105
  warn '[DEPRECATED] the `valid?` method is obsolete'
92
106
  return false if @data.nil?
107
+ return false if @meta.nil?
93
108
  true
94
109
  end
95
110
 
@@ -103,12 +118,23 @@ module SmplkitGeneratedClient::Logging
103
118
  @data = data
104
119
  end
105
120
 
121
+ # Custom attribute writer method with validation
122
+ # @param [Object] meta Value to be assigned
123
+ def meta=(meta)
124
+ if meta.nil?
125
+ fail ArgumentError, 'meta cannot be nil'
126
+ end
127
+
128
+ @meta = meta
129
+ end
130
+
106
131
  # Checks equality by comparing each attribute.
107
132
  # @param [Object] Object to be compared
108
133
  def ==(o)
109
134
  return true if self.equal?(o)
110
135
  self.class == o.class &&
111
- data == o.data
136
+ data == o.data &&
137
+ meta == o.meta
112
138
  end
113
139
 
114
140
  # @see the `==` method
@@ -120,7 +146,7 @@ module SmplkitGeneratedClient::Logging
120
146
  # Calculates hash code according to all attributes.
121
147
  # @return [Integer] Hash code
122
148
  def hash
123
- [data].hash
149
+ [data, meta].hash
124
150
  end
125
151
 
126
152
  # Builds the object from hash