smplkit 3.0.9 → 3.0.10

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 (39) 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_meta.rb → pagination_meta.rb} +70 -19
  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/audit/actions.rb +7 -6
  31. data/lib/smplkit/audit/models.rb +14 -0
  32. data/lib/smplkit/audit/resource_types.rb +7 -6
  33. data/lib/smplkit/management/audit.rb +5 -4
  34. metadata +9 -13
  35. data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_list_links.rb +0 -148
  36. data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/resource_type_list_links.rb +0 -148
  37. data/lib/smplkit/_generated/audit/spec/models/forwarder_list_links_spec.rb +0 -36
  38. data/lib/smplkit/_generated/audit/spec/models/forwarder_list_meta_spec.rb +0 -36
  39. data/lib/smplkit/_generated/audit/spec/models/resource_type_list_links_spec.rb +0 -36
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ce4c31b86b8e8ea2077b471cad22fda0ae63ba69ad00ed8d502b967c040cf65b
4
- data.tar.gz: b613a094bc73a92d16e7e5a055d40effdb7fe43b09e3446f76583afb99e992c5
3
+ metadata.gz: de4b3222a4fcaf4bb24e49764813b6f50977dffd4efe4ca0009ae2f6b56d3eef
4
+ data.tar.gz: ce5fa5ebc86b767bb4af87016f3bc526370c70c4fe9cc48959b4d3e3f5353e6e
5
5
  SHA512:
6
- metadata.gz: 5086bd86123dc0d0ddee5776d297c4263a053ab25690ecfb567fdd704412150abbbf99c19c0d381a16a7ad374acfbb61764655efd050b4b3e6775ccef40fed70
7
- data.tar.gz: 8053caf4b794b75532a01ec78880a90decbe1bfdc82b3e13115ceb47b42e1b1a54abbda52951b0f2289bdb9d5b7770b986ec87baceb9e38965036a45e285c9c9
6
+ metadata.gz: 8deef6d19d80264fcc7e183cd2042ec8956f765fb13e5aee0685160c1dbdeee943612d3b5dc2c235ab7c695dcf129055f18982a6ba56e72cc004c5fa0e81c61f
7
+ data.tar.gz: 4857d25f802cfa2e23ab76c21b40ad361c5d1337e26cdb2093f67004ad5ca46edfdf4280cafc8695cc5c8efec063c1b2e4b65455b6744aba9160153513bb0cfe
@@ -23,9 +23,10 @@ module SmplkitGeneratedClient::Audit
23
23
  # List the distinct `action` slugs recorded for this account. Default sort is `key` ascending; pass `sort=-key` for descending. Without `filter[resource_type]`, returns one row per distinct action. With `filter[resource_type]`, returns the actions recorded for that specific resource type.
24
24
  # @param [Hash] opts the optional parameters
25
25
  # @option opts [String] :filter_resource_type
26
- # @option opts [Integer] :page_size
27
- # @option opts [String] :page_after
28
26
  # @option opts [String] :sort Field to sort by. Prefix with `-` for descending order. Default: `key`. Allowed values: `key`, `-key`. (default to 'key')
27
+ # @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)
28
+ # @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)
29
+ # @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)
29
30
  # @return [ActionListResponse]
30
31
  def list_actions(opts = {})
31
32
  data, _status_code, _headers = list_actions_with_http_info(opts)
@@ -36,18 +37,15 @@ module SmplkitGeneratedClient::Audit
36
37
  # List the distinct `action` slugs recorded for this account. Default sort is `key` ascending; pass `sort=-key` for descending. Without `filter[resource_type]`, returns one row per distinct action. With `filter[resource_type]`, returns the actions recorded for that specific resource type.
37
38
  # @param [Hash] opts the optional parameters
38
39
  # @option opts [String] :filter_resource_type
39
- # @option opts [Integer] :page_size
40
- # @option opts [String] :page_after
41
40
  # @option opts [String] :sort Field to sort by. Prefix with `-` for descending order. Default: `key`. Allowed values: `key`, `-key`. (default to 'key')
41
+ # @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)
42
+ # @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)
43
+ # @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)
42
44
  # @return [Array<(ActionListResponse, Integer, Hash)>] ActionListResponse data, response status code and response headers
43
45
  def list_actions_with_http_info(opts = {})
44
46
  if @api_client.config.debugging
45
47
  @api_client.config.logger.debug 'Calling API: ActionsApi.list_actions ...'
46
48
  end
47
- if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
48
- fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ActionsApi.list_actions, must be greater than or equal to 1.'
49
- end
50
-
51
49
  allowable_values = ["key", "-key"]
52
50
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
53
51
  fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
@@ -58,9 +56,10 @@ module SmplkitGeneratedClient::Audit
58
56
  # query parameters
59
57
  query_params = opts[:query_params] || {}
60
58
  query_params[:'filter[resource_type]'] = opts[:'filter_resource_type'] if !opts[:'filter_resource_type'].nil?
61
- query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
62
- query_params[:'page[after]'] = opts[:'page_after'] if !opts[:'page_after'].nil?
63
59
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
60
+ query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
61
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
62
+ query_params[:'meta[total]'] = opts[:'meta_total'] if !opts[:'meta_total'].nil?
64
63
 
65
64
  # header parameters
66
65
  header_params = opts[:header_params] || {}
@@ -369,13 +369,14 @@ module SmplkitGeneratedClient::Audit
369
369
  end
370
370
 
371
371
  # List Forwarders
372
- # List forwarders for this account. Default sort is `-created_at` (newest first). Pagination uses cursor tokens; keep the same `sort` value across paginated requests.
372
+ # List forwarders for this account. Default sort is `-created_at` (newest first).
373
373
  # @param [Hash] opts the optional parameters
374
374
  # @option opts [String] :filter_forwarder_type
375
375
  # @option opts [Boolean] :filter_enabled
376
- # @option opts [Integer] :page_size
377
- # @option opts [String] :page_after
378
376
  # @option opts [String] :sort Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;-created_at&#x60;. Allowed values: &#x60;created_at&#x60;, &#x60;-created_at&#x60;, &#x60;updated_at&#x60;, &#x60;-updated_at&#x60;. (default to '-created_at')
377
+ # @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)
378
+ # @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)
379
+ # @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)
379
380
  # @return [ForwarderListResponse]
380
381
  def list_forwarders(opts = {})
381
382
  data, _status_code, _headers = list_forwarders_with_http_info(opts)
@@ -383,22 +384,19 @@ module SmplkitGeneratedClient::Audit
383
384
  end
384
385
 
385
386
  # List Forwarders
386
- # List forwarders for this account. Default sort is &#x60;-created_at&#x60; (newest first). Pagination uses cursor tokens; keep the same &#x60;sort&#x60; value across paginated requests.
387
+ # List forwarders for this account. Default sort is &#x60;-created_at&#x60; (newest first).
387
388
  # @param [Hash] opts the optional parameters
388
389
  # @option opts [String] :filter_forwarder_type
389
390
  # @option opts [Boolean] :filter_enabled
390
- # @option opts [Integer] :page_size
391
- # @option opts [String] :page_after
392
391
  # @option opts [String] :sort Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;-created_at&#x60;. Allowed values: &#x60;created_at&#x60;, &#x60;-created_at&#x60;, &#x60;updated_at&#x60;, &#x60;-updated_at&#x60;. (default to '-created_at')
392
+ # @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)
393
+ # @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)
394
+ # @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)
393
395
  # @return [Array<(ForwarderListResponse, Integer, Hash)>] ForwarderListResponse data, response status code and response headers
394
396
  def list_forwarders_with_http_info(opts = {})
395
397
  if @api_client.config.debugging
396
398
  @api_client.config.logger.debug 'Calling API: ForwardersApi.list_forwarders ...'
397
399
  end
398
- if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
399
- fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ForwardersApi.list_forwarders, must be greater than or equal to 1.'
400
- end
401
-
402
400
  allowable_values = ["created_at", "-created_at", "updated_at", "-updated_at"]
403
401
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
404
402
  fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
@@ -410,9 +408,10 @@ module SmplkitGeneratedClient::Audit
410
408
  query_params = opts[:query_params] || {}
411
409
  query_params[:'filter[forwarder_type]'] = opts[:'filter_forwarder_type'] if !opts[:'filter_forwarder_type'].nil?
412
410
  query_params[:'filter[enabled]'] = opts[:'filter_enabled'] if !opts[:'filter_enabled'].nil?
413
- query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
414
- query_params[:'page[after]'] = opts[:'page_after'] if !opts[:'page_after'].nil?
415
411
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
412
+ query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
413
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
414
+ query_params[:'meta[total]'] = opts[:'meta_total'] if !opts[:'meta_total'].nil?
416
415
 
417
416
  # header parameters
418
417
  header_params = opts[:header_params] || {}
@@ -22,9 +22,10 @@ module SmplkitGeneratedClient::Audit
22
22
  # List Resource Types
23
23
  # List the distinct `resource_type` slugs recorded for this account. The resource `id` is the slug itself. Default sort is `key` ascending; pass `sort=-key` for descending. Useful for populating filter dropdowns in a UI.
24
24
  # @param [Hash] opts the optional parameters
25
- # @option opts [Integer] :page_size
26
- # @option opts [String] :page_after
27
25
  # @option opts [String] :sort Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;key&#x60;. Allowed values: &#x60;key&#x60;, &#x60;-key&#x60;. (default to 'key')
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)
28
29
  # @return [ResourceTypeListResponse]
29
30
  def list_resource_types(opts = {})
30
31
  data, _status_code, _headers = list_resource_types_with_http_info(opts)
@@ -34,18 +35,15 @@ module SmplkitGeneratedClient::Audit
34
35
  # List Resource Types
35
36
  # List the distinct &#x60;resource_type&#x60; slugs recorded for this account. The resource &#x60;id&#x60; is the slug itself. Default sort is &#x60;key&#x60; ascending; pass &#x60;sort&#x3D;-key&#x60; for descending. Useful for populating filter dropdowns in a UI.
36
37
  # @param [Hash] opts the optional parameters
37
- # @option opts [Integer] :page_size
38
- # @option opts [String] :page_after
39
38
  # @option opts [String] :sort Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;key&#x60;. Allowed values: &#x60;key&#x60;, &#x60;-key&#x60;. (default to 'key')
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)
40
42
  # @return [Array<(ResourceTypeListResponse, Integer, Hash)>] ResourceTypeListResponse data, response status code and response headers
41
43
  def list_resource_types_with_http_info(opts = {})
42
44
  if @api_client.config.debugging
43
45
  @api_client.config.logger.debug 'Calling API: ResourceTypesApi.list_resource_types ...'
44
46
  end
45
- if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
46
- fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ResourceTypesApi.list_resource_types, must be greater than or equal to 1.'
47
- end
48
-
49
47
  allowable_values = ["key", "-key"]
50
48
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
51
49
  fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
@@ -55,9 +53,10 @@ module SmplkitGeneratedClient::Audit
55
53
 
56
54
  # query parameters
57
55
  query_params = opts[:query_params] || {}
58
- query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
59
- query_params[:'page[after]'] = opts[:'page_after'] if !opts[:'page_after'].nil?
60
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?
61
60
 
62
61
  # header parameters
63
62
  header_params = opts[:header_params] || {}
@@ -23,6 +23,9 @@ module SmplkitGeneratedClient::Audit
23
23
  # Report the current-period usage counters for this account.
24
24
  # @param filter_period [String] Period to report. &#x60;current&#x60; is the only supported value.
25
25
  # @param [Hash] opts the optional parameters
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 [UsageResponse]
27
30
  def list_usage(filter_period, opts = {})
28
31
  data, _status_code, _headers = list_usage_with_http_info(filter_period, opts)
@@ -33,6 +36,9 @@ module SmplkitGeneratedClient::Audit
33
36
  # Report the current-period usage counters for this account.
34
37
  # @param filter_period [String] Period to report. &#x60;current&#x60; is the only supported value.
35
38
  # @param [Hash] opts the optional parameters
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<(UsageResponse, Integer, Hash)>] UsageResponse data, response status code and response headers
37
43
  def list_usage_with_http_info(filter_period, opts = {})
38
44
  if @api_client.config.debugging
@@ -48,6 +54,9 @@ module SmplkitGeneratedClient::Audit
48
54
  # query parameters
49
55
  query_params = opts[:query_params] || {}
50
56
  query_params[:'filter[period]'] = filter_period
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] || {}
@@ -19,14 +19,11 @@ module SmplkitGeneratedClient::Audit
19
19
 
20
20
  attr_accessor :meta
21
21
 
22
- attr_accessor :links
23
-
24
22
  # Attribute mapping from ruby-style variable name to JSON key.
25
23
  def self.attribute_map
26
24
  {
27
25
  :'data' => :'data',
28
- :'meta' => :'meta',
29
- :'links' => :'links'
26
+ :'meta' => :'meta'
30
27
  }
31
28
  end
32
29
 
@@ -44,15 +41,13 @@ module SmplkitGeneratedClient::Audit
44
41
  def self.openapi_types
45
42
  {
46
43
  :'data' => :'Array<ActionResource>',
47
- :'meta' => :'ActionListMeta',
48
- :'links' => :'ActionListLinks'
44
+ :'meta' => :'ListMeta'
49
45
  }
50
46
  end
51
47
 
52
48
  # List of attributes with nullable: true
53
49
  def self.openapi_nullable
54
50
  Set.new([
55
- :'links'
56
51
  ])
57
52
  end
58
53
 
@@ -85,10 +80,6 @@ module SmplkitGeneratedClient::Audit
85
80
  else
86
81
  self.meta = nil
87
82
  end
88
-
89
- if attributes.key?(:'links')
90
- self.links = attributes[:'links']
91
- end
92
83
  end
93
84
 
94
85
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -142,8 +133,7 @@ module SmplkitGeneratedClient::Audit
142
133
  return true if self.equal?(o)
143
134
  self.class == o.class &&
144
135
  data == o.data &&
145
- meta == o.meta &&
146
- links == o.links
136
+ meta == o.meta
147
137
  end
148
138
 
149
139
  # @see the `==` method
@@ -155,7 +145,7 @@ module SmplkitGeneratedClient::Audit
155
145
  # Calculates hash code according to all attributes.
156
146
  # @return [Integer] Hash code
157
147
  def hash
158
- [data, meta, links].hash
148
+ [data, meta].hash
159
149
  end
160
150
 
161
151
  # Builds the object from hash
@@ -14,6 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::Audit
17
+ # Cursor-pagination meta for the audit-event list endpoint. Audit events are append-only at high cardinality (millions of rows per account at production tenants), so this endpoint stays on cursor pagination — the documented exception in ADR-014. Every other read-many endpoint in the platform follows the standard offset convention (`page[number]` / `page[size]`).
17
18
  class EventListMeta < ApiModelBase
18
19
  attr_accessor :page_size
19
20
 
@@ -14,7 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::Audit
17
- # JSON:API collection response for audit events.
17
+ # JSON:API collection response for audit events (cursor paged).
18
18
  class EventListResponse < ApiModelBase
19
19
  attr_accessor :data
20
20
 
@@ -14,7 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::Audit
17
- class ActionListLinks < ApiModelBase
17
+ class ForwarderDeliveryListLinks < ApiModelBase
18
18
  attr_accessor :_next
19
19
 
20
20
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -52,14 +52,14 @@ module SmplkitGeneratedClient::Audit
52
52
  # @param [Hash] attributes Model attributes in the form of hash
53
53
  def initialize(attributes = {})
54
54
  if (!attributes.is_a?(Hash))
55
- fail ArgumentError, "The input argument (attributes) must be a hash in `SmplkitGeneratedClient::Audit::ActionListLinks` initialize method"
55
+ fail ArgumentError, "The input argument (attributes) must be a hash in `SmplkitGeneratedClient::Audit::ForwarderDeliveryListLinks` initialize method"
56
56
  end
57
57
 
58
58
  # check to see if the attribute exists and convert string to symbol for hash key
59
59
  acceptable_attribute_map = self.class.acceptable_attribute_map
60
60
  attributes = attributes.each_with_object({}) { |(k, v), h|
61
61
  if (!acceptable_attribute_map.key?(k.to_sym))
62
- fail ArgumentError, "`#{k}` is not a valid attribute in `SmplkitGeneratedClient::Audit::ActionListLinks`. 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::Audit::ForwarderDeliveryListLinks`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
63
63
  end
64
64
  h[k.to_sym] = v
65
65
  }
@@ -14,7 +14,8 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::Audit
17
- class ResourceTypeListMeta < ApiModelBase
17
+ # Cursor-pagination meta for the forwarder-delivery log endpoint. Forwarder deliveries are append-only at high cardinality (one row per delivery attempt per event) and scroll with the same workload as audit events, so this endpoint stays on cursor pagination — the documented exception in ADR-014. The parent `/forwarders` collection follows the standard offset convention.
18
+ class ForwarderDeliveryListMeta < ApiModelBase
18
19
  attr_accessor :page_size
19
20
 
20
21
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -51,14 +52,14 @@ 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::ResourceTypeListMeta` initialize method"
55
+ fail ArgumentError, "The input argument (attributes) must be a hash in `SmplkitGeneratedClient::Audit::ForwarderDeliveryListMeta` 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::ResourceTypeListMeta`. 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::Audit::ForwarderDeliveryListMeta`. 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
  }
@@ -14,7 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::Audit
17
- # JSON:API collection response for forwarder deliveries.
17
+ # JSON:API collection response for forwarder deliveries (cursor paged).
18
18
  class ForwarderDeliveryListResponse < ApiModelBase
19
19
  attr_accessor :data
20
20
 
@@ -45,8 +45,8 @@ module SmplkitGeneratedClient::Audit
45
45
  def self.openapi_types
46
46
  {
47
47
  :'data' => :'Array<ForwarderDeliveryResource>',
48
- :'meta' => :'ForwarderListMeta',
49
- :'links' => :'ForwarderListLinks'
48
+ :'meta' => :'ForwarderDeliveryListMeta',
49
+ :'links' => :'ForwarderDeliveryListLinks'
50
50
  }
51
51
  end
52
52
 
@@ -20,14 +20,11 @@ module SmplkitGeneratedClient::Audit
20
20
 
21
21
  attr_accessor :meta
22
22
 
23
- attr_accessor :links
24
-
25
23
  # Attribute mapping from ruby-style variable name to JSON key.
26
24
  def self.attribute_map
27
25
  {
28
26
  :'data' => :'data',
29
- :'meta' => :'meta',
30
- :'links' => :'links'
27
+ :'meta' => :'meta'
31
28
  }
32
29
  end
33
30
 
@@ -45,15 +42,13 @@ module SmplkitGeneratedClient::Audit
45
42
  def self.openapi_types
46
43
  {
47
44
  :'data' => :'Array<ForwarderResource>',
48
- :'meta' => :'ForwarderListMeta',
49
- :'links' => :'ForwarderListLinks'
45
+ :'meta' => :'ListMeta'
50
46
  }
51
47
  end
52
48
 
53
49
  # List of attributes with nullable: true
54
50
  def self.openapi_nullable
55
51
  Set.new([
56
- :'links'
57
52
  ])
58
53
  end
59
54
 
@@ -86,10 +81,6 @@ module SmplkitGeneratedClient::Audit
86
81
  else
87
82
  self.meta = nil
88
83
  end
89
-
90
- if attributes.key?(:'links')
91
- self.links = attributes[:'links']
92
- end
93
84
  end
94
85
 
95
86
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -143,8 +134,7 @@ module SmplkitGeneratedClient::Audit
143
134
  return true if self.equal?(o)
144
135
  self.class == o.class &&
145
136
  data == o.data &&
146
- meta == o.meta &&
147
- links == o.links
137
+ meta == o.meta
148
138
  end
149
139
 
150
140
  # @see the `==` method
@@ -156,7 +146,7 @@ module SmplkitGeneratedClient::Audit
156
146
  # Calculates hash code according to all attributes.
157
147
  # @return [Integer] Hash code
158
148
  def hash
159
- [data, meta, links].hash
149
+ [data, meta].hash
160
150
  end
161
151
 
162
152
  # Builds the object from hash
@@ -14,13 +14,14 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::Audit
17
- class ActionListMeta < ApiModelBase
18
- attr_accessor :page_size
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::ActionListMeta` initialize method"
55
+ fail ArgumentError, "The input argument (attributes) must be a hash in `SmplkitGeneratedClient::Audit::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::ActionListMeta`. 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::Audit::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