smplkit 3.0.13 → 3.0.14

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 (67) hide show
  1. checksums.yaml +4 -4
  2. data/lib/smplkit/_generated/app/lib/smplkit_app_client/api/api_keys_api.rb +9 -0
  3. data/lib/smplkit/_generated/app/lib/smplkit_app_client/api/billing_api.rb +20 -2
  4. data/lib/smplkit/_generated/app/lib/smplkit_app_client/api/context_types_api.rb +9 -0
  5. data/lib/smplkit/_generated/app/lib/smplkit_app_client/api/context_values_api.rb +97 -0
  6. data/lib/smplkit/_generated/app/lib/smplkit_app_client/api/contexts_api.rb +16 -4
  7. data/lib/smplkit/_generated/app/lib/smplkit_app_client/api/environments_api.rb +9 -0
  8. data/lib/smplkit/_generated/app/lib/smplkit_app_client/api/invitations_api.rb +9 -0
  9. data/lib/smplkit/_generated/app/lib/smplkit_app_client/api/metrics_api.rb +27 -0
  10. data/lib/smplkit/_generated/app/lib/smplkit_app_client/api/plans_api.rb +9 -0
  11. data/lib/smplkit/_generated/app/lib/smplkit_app_client/api/products_api.rb +9 -0
  12. data/lib/smplkit/_generated/app/lib/smplkit_app_client/api/services_api.rb +9 -0
  13. data/lib/smplkit/_generated/app/lib/smplkit_app_client/api/users_api.rb +8 -17
  14. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key_list_response.rb +30 -4
  15. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/context.rb +12 -1
  16. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/context_list_response.rb +30 -4
  17. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/context_resource.rb +1 -1
  18. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/context_type_list_response.rb +30 -4
  19. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/context_value.rb +166 -0
  20. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/context_value_list_response.rb +193 -0
  21. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/context_value_resource.rb +225 -0
  22. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment_list_response.rb +30 -4
  23. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation_list_response.rb +30 -4
  24. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/invoice_list_response.rb +30 -4
  25. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/{user_list_meta.rb → list_meta.rb} +20 -19
  26. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/metric_list_response.rb +30 -4
  27. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/metric_names_response.rb +30 -4
  28. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/metric_rollup_list_response.rb +30 -4
  29. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/{page_meta.rb → pagination_meta.rb} +43 -75
  30. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/payment_method_list_response.rb +30 -4
  31. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/plan_list_response.rb +30 -4
  32. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/product_list_response.rb +30 -4
  33. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/service_list_response.rb +30 -4
  34. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/user_list_response.rb +18 -1
  35. data/lib/smplkit/_generated/app/lib/smplkit_app_client.rb +6 -2
  36. data/lib/smplkit/_generated/app/spec/api/api_keys_api_spec.rb +3 -0
  37. data/lib/smplkit/_generated/app/spec/api/billing_api_spec.rb +7 -1
  38. data/lib/smplkit/_generated/app/spec/api/context_types_api_spec.rb +3 -0
  39. data/lib/smplkit/_generated/app/spec/api/context_values_api_spec.rb +52 -0
  40. data/lib/smplkit/_generated/app/spec/api/contexts_api_spec.rb +6 -2
  41. data/lib/smplkit/_generated/app/spec/api/environments_api_spec.rb +3 -0
  42. data/lib/smplkit/_generated/app/spec/api/invitations_api_spec.rb +3 -0
  43. data/lib/smplkit/_generated/app/spec/api/metrics_api_spec.rb +9 -0
  44. data/lib/smplkit/_generated/app/spec/api/plans_api_spec.rb +3 -0
  45. data/lib/smplkit/_generated/app/spec/api/products_api_spec.rb +3 -0
  46. data/lib/smplkit/_generated/app/spec/api/services_api_spec.rb +3 -0
  47. data/lib/smplkit/_generated/app/spec/api/users_api_spec.rb +3 -2
  48. data/lib/smplkit/_generated/app/spec/models/api_key_list_response_spec.rb +6 -0
  49. data/lib/smplkit/_generated/app/spec/models/context_list_response_spec.rb +6 -0
  50. data/lib/smplkit/_generated/app/spec/models/context_spec.rb +6 -0
  51. data/lib/smplkit/_generated/app/spec/models/context_type_list_response_spec.rb +6 -0
  52. data/lib/smplkit/_generated/app/spec/models/context_value_list_response_spec.rb +42 -0
  53. data/lib/smplkit/_generated/app/spec/models/context_value_resource_spec.rb +52 -0
  54. data/lib/smplkit/_generated/app/spec/models/{user_list_meta_spec.rb → context_value_spec.rb} +7 -7
  55. data/lib/smplkit/_generated/app/spec/models/environment_list_response_spec.rb +6 -0
  56. data/lib/smplkit/_generated/app/spec/models/invitation_list_response_spec.rb +6 -0
  57. data/lib/smplkit/_generated/app/spec/models/invoice_list_response_spec.rb +6 -0
  58. data/lib/smplkit/_generated/app/spec/models/list_meta_spec.rb +36 -0
  59. data/lib/smplkit/_generated/app/spec/models/metric_list_response_spec.rb +6 -0
  60. data/lib/smplkit/_generated/app/spec/models/metric_names_response_spec.rb +6 -0
  61. data/lib/smplkit/_generated/app/spec/models/metric_rollup_list_response_spec.rb +6 -0
  62. data/lib/smplkit/_generated/app/spec/models/{page_meta_spec.rb → pagination_meta_spec.rb} +9 -9
  63. data/lib/smplkit/_generated/app/spec/models/payment_method_list_response_spec.rb +6 -0
  64. data/lib/smplkit/_generated/app/spec/models/plan_list_response_spec.rb +6 -0
  65. data/lib/smplkit/_generated/app/spec/models/product_list_response_spec.rb +6 -0
  66. data/lib/smplkit/_generated/app/spec/models/service_list_response_spec.rb +6 -0
  67. metadata +13 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f0a17676a5c8db9f0bb968df21787e502fa0f0b6c593f9c3a23cb159361234fa
4
- data.tar.gz: 8f67e7c04811b7d98226dc939c29cfc4bbbd1ab6698f266ce521b7cd693558d4
3
+ metadata.gz: c96e2ae58a16657eb4fb39372c370ca2a49671fcb7414d098a4f6e0019a5be9e
4
+ data.tar.gz: d2a539076441031f5b476bf56bfd5ca06c70ebca6754db13fded0bcaafc68c4a
5
5
  SHA512:
6
- metadata.gz: 93753f37870de6cb8ef10116b52424426d6e763bdffb549dd963230b1797c466f9f6309e0198961335300b5acc0d4cf26f2162df08ae0aa5a16e45910cf9ca65
7
- data.tar.gz: 7c679e9f0e690e42617bfb8c6459f78cfb5b27fd995236057aa58d4e941f34a80a124d2ffe5bcda42a9356d2eab9de67de163bdc34c89f7c67a400e9261cc771
6
+ metadata.gz: 41fdd36eedf126ba56313482c3fc568f370f0537b49057a62716e446c05fee96083d12c28ba728f1c2d241147e9e8844de17fe62a7ecc8d4ae88b613a7f26328
7
+ data.tar.gz: 17067605a53e4faff4b07b61bc29ada2292ec41f369edd05be41ff30c6ffce8e2ffee1d9148d7ca9f6619683a90f6e4a347c424aaac34b091424c34553299378
@@ -218,6 +218,9 @@ module SmplkitGeneratedClient::App
218
218
  # @param [Hash] opts the optional parameters
219
219
  # @option opts [String] :filter_status
220
220
  # @option opts [String] :sort Field to sort by. Prefix with `-` for descending order. Default: `name`. Allowed values: `created_at`, `-created_at`, `expires_at`, `-expires_at`, `last_used_at`, `-last_used_at`, `name`, `-name`, `status`, `-status`. (default to 'name')
221
+ # @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)
222
+ # @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)
223
+ # @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)
221
224
  # @return [ApiKeyListResponse]
222
225
  def list_api_keys(opts = {})
223
226
  data, _status_code, _headers = list_api_keys_with_http_info(opts)
@@ -229,6 +232,9 @@ module SmplkitGeneratedClient::App
229
232
  # @param [Hash] opts the optional parameters
230
233
  # @option opts [String] :filter_status
231
234
  # @option opts [String] :sort Field to sort by. Prefix with `-` for descending order. Default: `name`. Allowed values: `created_at`, `-created_at`, `expires_at`, `-expires_at`, `last_used_at`, `-last_used_at`, `name`, `-name`, `status`, `-status`. (default to 'name')
235
+ # @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)
236
+ # @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)
237
+ # @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)
232
238
  # @return [Array<(ApiKeyListResponse, Integer, Hash)>] ApiKeyListResponse data, response status code and response headers
233
239
  def list_api_keys_with_http_info(opts = {})
234
240
  if @api_client.config.debugging
@@ -245,6 +251,9 @@ module SmplkitGeneratedClient::App
245
251
  query_params = opts[:query_params] || {}
246
252
  query_params[:'filter[status]'] = opts[:'filter_status'] if !opts[:'filter_status'].nil?
247
253
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
254
+ query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
255
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
256
+ query_params[:'meta[total]'] = opts[:'meta_total'] if !opts[:'meta_total'].nil?
248
257
 
249
258
  # header parameters
250
259
  header_params = opts[:header_params] || {}
@@ -334,9 +334,12 @@ module SmplkitGeneratedClient::App
334
334
  end
335
335
 
336
336
  # List Invoices
337
- # Return invoice history for the account from Stripe. Default sort is `-created_at` (newest first).
337
+ # Return invoice history for the account from Stripe. Default sort is `-created_at` (newest first). The endpoint fetches the most recent 100 invoices from Stripe (its per-request cap) and pages over the result in memory; clients should not depend on more than 100 invoices being visible at once.
338
338
  # @param [Hash] opts the optional parameters
339
339
  # @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;status&#x60;, &#x60;-status&#x60;, &#x60;total&#x60;, &#x60;-total&#x60;. (default to '-created_at')
340
+ # @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)
341
+ # @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)
342
+ # @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)
340
343
  # @return [InvoiceListResponse]
341
344
  def list_invoices(opts = {})
342
345
  data, _status_code, _headers = list_invoices_with_http_info(opts)
@@ -344,9 +347,12 @@ module SmplkitGeneratedClient::App
344
347
  end
345
348
 
346
349
  # List Invoices
347
- # Return invoice history for the account from Stripe. Default sort is &#x60;-created_at&#x60; (newest first).
350
+ # Return invoice history for the account from Stripe. Default sort is &#x60;-created_at&#x60; (newest first). The endpoint fetches the most recent 100 invoices from Stripe (its per-request cap) and pages over the result in memory; clients should not depend on more than 100 invoices being visible at once.
348
351
  # @param [Hash] opts the optional parameters
349
352
  # @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;status&#x60;, &#x60;-status&#x60;, &#x60;total&#x60;, &#x60;-total&#x60;. (default to '-created_at')
353
+ # @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)
354
+ # @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)
355
+ # @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)
350
356
  # @return [Array<(InvoiceListResponse, Integer, Hash)>] InvoiceListResponse data, response status code and response headers
351
357
  def list_invoices_with_http_info(opts = {})
352
358
  if @api_client.config.debugging
@@ -362,6 +368,9 @@ module SmplkitGeneratedClient::App
362
368
  # query parameters
363
369
  query_params = opts[:query_params] || {}
364
370
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
371
+ query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
372
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
373
+ query_params[:'meta[total]'] = opts[:'meta_total'] if !opts[:'meta_total'].nil?
365
374
 
366
375
  # header parameters
367
376
  header_params = opts[:header_params] || {}
@@ -401,6 +410,9 @@ module SmplkitGeneratedClient::App
401
410
  # List all payment methods for the account. Default is returned first, then newest first.
402
411
  # @param [Hash] opts the optional parameters
403
412
  # @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;exp_year&#x60;, &#x60;-exp_year&#x60;, &#x60;is_default&#x60;, &#x60;-is_default&#x60;, &#x60;updated_at&#x60;, &#x60;-updated_at&#x60;. (default to '-created_at')
413
+ # @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)
414
+ # @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)
415
+ # @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)
404
416
  # @return [PaymentMethodListResponse]
405
417
  def list_payment_methods(opts = {})
406
418
  data, _status_code, _headers = list_payment_methods_with_http_info(opts)
@@ -411,6 +423,9 @@ module SmplkitGeneratedClient::App
411
423
  # List all payment methods for the account. Default is returned first, then newest first.
412
424
  # @param [Hash] opts the optional parameters
413
425
  # @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;exp_year&#x60;, &#x60;-exp_year&#x60;, &#x60;is_default&#x60;, &#x60;-is_default&#x60;, &#x60;updated_at&#x60;, &#x60;-updated_at&#x60;. (default to '-created_at')
426
+ # @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)
427
+ # @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)
428
+ # @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)
414
429
  # @return [Array<(PaymentMethodListResponse, Integer, Hash)>] PaymentMethodListResponse data, response status code and response headers
415
430
  def list_payment_methods_with_http_info(opts = {})
416
431
  if @api_client.config.debugging
@@ -426,6 +441,9 @@ module SmplkitGeneratedClient::App
426
441
  # query parameters
427
442
  query_params = opts[:query_params] || {}
428
443
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
444
+ query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
445
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
446
+ query_params[:'meta[total]'] = opts[:'meta_total'] if !opts[:'meta_total'].nil?
429
447
 
430
448
  # header parameters
431
449
  header_params = opts[:header_params] || {}
@@ -217,6 +217,9 @@ module SmplkitGeneratedClient::App
217
217
  # List all context types for the authenticated account.
218
218
  # @param [Hash] opts the optional parameters
219
219
  # @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')
220
+ # @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)
221
+ # @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)
222
+ # @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)
220
223
  # @return [ContextTypeListResponse]
221
224
  def list_context_types(opts = {})
222
225
  data, _status_code, _headers = list_context_types_with_http_info(opts)
@@ -227,6 +230,9 @@ module SmplkitGeneratedClient::App
227
230
  # List all context types for the authenticated account.
228
231
  # @param [Hash] opts the optional parameters
229
232
  # @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')
233
+ # @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)
234
+ # @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)
235
+ # @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)
230
236
  # @return [Array<(ContextTypeListResponse, Integer, Hash)>] ContextTypeListResponse data, response status code and response headers
231
237
  def list_context_types_with_http_info(opts = {})
232
238
  if @api_client.config.debugging
@@ -242,6 +248,9 @@ module SmplkitGeneratedClient::App
242
248
  # query parameters
243
249
  query_params = opts[:query_params] || {}
244
250
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
251
+ query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
252
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
253
+ query_params[:'meta[total]'] = opts[:'meta_total'] if !opts[:'meta_total'].nil?
245
254
 
246
255
  # header parameters
247
256
  header_params = opts[:header_params] || {}
@@ -0,0 +1,97 @@
1
+ =begin
2
+ #smplkit API
3
+
4
+ #API for the smplkit platform.
5
+
6
+ The version of the OpenAPI document: 0.1.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.22.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module SmplkitGeneratedClient::App
16
+ class ContextValuesApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # List Context Values
23
+ # Return distinct values observed for a single attribute across context instances of one context type. The intended use case is a typeahead picker in a rule-building UI: the customer chooses a context type and an attribute name, then this endpoint streams back the distinct values matching what they've typed so far. `filter[context_type]` and `filter[attribute]` are required. `filter[attribute]` accepts any attribute name — including the two first-class columns `key` and `name` — and is treated uniformly from the customer's perspective; the server adjusts the underlying query accordingly. `filter[search]` does a case-insensitive starts-with match. The returned set excludes empty strings and NULL values.
24
+ # @param [Hash] opts the optional parameters
25
+ # @option opts [String] :filter_context_type Context type key whose instances should be searched (e.g. &#x60;user&#x60;).
26
+ # @option opts [String] :filter_attribute Attribute name whose distinct values should be returned (e.g. &#x60;first_name&#x60;). Accepts &#x60;key&#x60; and &#x60;name&#x60; as well as any attribute key stored on the context instance.
27
+ # @option opts [String] :filter_search Optional case-insensitive starts-with match against the projected attribute value. When omitted, all distinct values are returned in the page.
28
+ # @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)
29
+ # @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)
30
+ # @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)
31
+ # @return [ContextValueListResponse]
32
+ def list_context_values(opts = {})
33
+ data, _status_code, _headers = list_context_values_with_http_info(opts)
34
+ data
35
+ end
36
+
37
+ # List Context Values
38
+ # Return distinct values observed for a single attribute across context instances of one context type. The intended use case is a typeahead picker in a rule-building UI: the customer chooses a context type and an attribute name, then this endpoint streams back the distinct values matching what they&#39;ve typed so far. &#x60;filter[context_type]&#x60; and &#x60;filter[attribute]&#x60; are required. &#x60;filter[attribute]&#x60; accepts any attribute name — including the two first-class columns &#x60;key&#x60; and &#x60;name&#x60; — and is treated uniformly from the customer&#39;s perspective; the server adjusts the underlying query accordingly. &#x60;filter[search]&#x60; does a case-insensitive starts-with match. The returned set excludes empty strings and NULL values.
39
+ # @param [Hash] opts the optional parameters
40
+ # @option opts [String] :filter_context_type Context type key whose instances should be searched (e.g. &#x60;user&#x60;).
41
+ # @option opts [String] :filter_attribute Attribute name whose distinct values should be returned (e.g. &#x60;first_name&#x60;). Accepts &#x60;key&#x60; and &#x60;name&#x60; as well as any attribute key stored on the context instance.
42
+ # @option opts [String] :filter_search Optional case-insensitive starts-with match against the projected attribute value. When omitted, all distinct values are returned in the page.
43
+ # @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)
44
+ # @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)
45
+ # @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)
46
+ # @return [Array<(ContextValueListResponse, Integer, Hash)>] ContextValueListResponse data, response status code and response headers
47
+ def list_context_values_with_http_info(opts = {})
48
+ if @api_client.config.debugging
49
+ @api_client.config.logger.debug 'Calling API: ContextValuesApi.list_context_values ...'
50
+ end
51
+ # resource path
52
+ local_var_path = '/api/v1/context_values'
53
+
54
+ # query parameters
55
+ query_params = opts[:query_params] || {}
56
+ query_params[:'filter[context_type]'] = opts[:'filter_context_type'] if !opts[:'filter_context_type'].nil?
57
+ query_params[:'filter[attribute]'] = opts[:'filter_attribute'] if !opts[:'filter_attribute'].nil?
58
+ query_params[:'filter[search]'] = opts[:'filter_search'] if !opts[:'filter_search'].nil?
59
+ query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
60
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
61
+ query_params[:'meta[total]'] = opts[:'meta_total'] if !opts[:'meta_total'].nil?
62
+
63
+ # header parameters
64
+ header_params = opts[:header_params] || {}
65
+ # HTTP header 'Accept' (if needed)
66
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) unless header_params['Accept']
67
+
68
+ # form parameters
69
+ form_params = opts[:form_params] || {}
70
+
71
+ # http body (model)
72
+ post_body = opts[:debug_body]
73
+
74
+ # return_type
75
+ return_type = opts[:debug_return_type] || 'ContextValueListResponse'
76
+
77
+ # auth_names
78
+ auth_names = opts[:debug_auth_names] || ['HTTPBearer']
79
+
80
+ new_options = opts.merge(
81
+ :operation => :"ContextValuesApi.list_context_values",
82
+ :header_params => header_params,
83
+ :query_params => query_params,
84
+ :form_params => form_params,
85
+ :body => post_body,
86
+ :auth_names => auth_names,
87
+ :return_type => return_type
88
+ )
89
+
90
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
91
+ if @api_client.config.debugging
92
+ @api_client.config.logger.debug "API called: ContextValuesApi#list_context_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
93
+ end
94
+ return data, status_code, headers
95
+ end
96
+ end
97
+ end
@@ -214,10 +214,14 @@ module SmplkitGeneratedClient::App
214
214
  end
215
215
 
216
216
  # List Contexts
217
- # List all context instances for the authenticated account.
217
+ # List context instances for the authenticated account. `filter[context_type]` narrows the result to one context type. `filter[search]` does a case-insensitive substring match against the context `key`, `name`, and every attribute value, returning any context where at least one of those fields contains the search term.
218
218
  # @param [Hash] opts the optional parameters
219
- # @option opts [String] :filter_context_type
219
+ # @option opts [String] :filter_context_type Limit results to context instances of this context type (e.g. &#x60;user&#x60;).
220
+ # @option opts [String] :filter_search Case-insensitive substring match against the &#x60;key&#x60;, &#x60;name&#x60;, and any attribute value. A context is returned if at least one of those fields contains the search term.
220
221
  # @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')
222
+ # @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)
223
+ # @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)
224
+ # @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)
221
225
  # @return [ContextListResponse]
222
226
  def list_contexts(opts = {})
223
227
  data, _status_code, _headers = list_contexts_with_http_info(opts)
@@ -225,10 +229,14 @@ module SmplkitGeneratedClient::App
225
229
  end
226
230
 
227
231
  # List Contexts
228
- # List all context instances for the authenticated account.
232
+ # List context instances for the authenticated account. &#x60;filter[context_type]&#x60; narrows the result to one context type. &#x60;filter[search]&#x60; does a case-insensitive substring match against the context &#x60;key&#x60;, &#x60;name&#x60;, and every attribute value, returning any context where at least one of those fields contains the search term.
229
233
  # @param [Hash] opts the optional parameters
230
- # @option opts [String] :filter_context_type
234
+ # @option opts [String] :filter_context_type Limit results to context instances of this context type (e.g. &#x60;user&#x60;).
235
+ # @option opts [String] :filter_search Case-insensitive substring match against the &#x60;key&#x60;, &#x60;name&#x60;, and any attribute value. A context is returned if at least one of those fields contains the search term.
231
236
  # @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')
237
+ # @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)
238
+ # @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)
239
+ # @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)
232
240
  # @return [Array<(ContextListResponse, Integer, Hash)>] ContextListResponse data, response status code and response headers
233
241
  def list_contexts_with_http_info(opts = {})
234
242
  if @api_client.config.debugging
@@ -244,7 +252,11 @@ module SmplkitGeneratedClient::App
244
252
  # query parameters
245
253
  query_params = opts[:query_params] || {}
246
254
  query_params[:'filter[context_type]'] = opts[:'filter_context_type'] if !opts[:'filter_context_type'].nil?
255
+ query_params[:'filter[search]'] = opts[:'filter_search'] if !opts[:'filter_search'].nil?
247
256
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
257
+ query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
258
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
259
+ query_params[:'meta[total]'] = opts[:'meta_total'] if !opts[:'meta_total'].nil?
248
260
 
249
261
  # header parameters
250
262
  header_params = opts[:header_params] || {}
@@ -283,6 +283,9 @@ module SmplkitGeneratedClient::App
283
283
  # List all environments for the authenticated account.
284
284
  # @param [Hash] opts the optional parameters
285
285
  # @option opts [String] :sort Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;name&#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 'name')
286
+ # @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)
287
+ # @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)
288
+ # @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)
286
289
  # @return [EnvironmentListResponse]
287
290
  def list_environments(opts = {})
288
291
  data, _status_code, _headers = list_environments_with_http_info(opts)
@@ -293,6 +296,9 @@ module SmplkitGeneratedClient::App
293
296
  # List all environments for the authenticated account.
294
297
  # @param [Hash] opts the optional parameters
295
298
  # @option opts [String] :sort Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;name&#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 'name')
299
+ # @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)
300
+ # @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)
301
+ # @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)
296
302
  # @return [Array<(EnvironmentListResponse, Integer, Hash)>] EnvironmentListResponse data, response status code and response headers
297
303
  def list_environments_with_http_info(opts = {})
298
304
  if @api_client.config.debugging
@@ -308,6 +314,9 @@ module SmplkitGeneratedClient::App
308
314
  # query parameters
309
315
  query_params = opts[:query_params] || {}
310
316
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
317
+ query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
318
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
319
+ query_params[:'meta[total]'] = opts[:'meta_total'] if !opts[:'meta_total'].nil?
311
320
 
312
321
  # header parameters
313
322
  header_params = opts[:header_params] || {}
@@ -161,6 +161,9 @@ module SmplkitGeneratedClient::App
161
161
  # @option opts [String] :filter_status
162
162
  # @option opts [String] :filter_token
163
163
  # @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;email&#x60;, &#x60;-email&#x60;, &#x60;status&#x60;, &#x60;-status&#x60;. (default to '-created_at')
164
+ # @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)
165
+ # @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)
166
+ # @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)
164
167
  # @return [InvitationListResponse]
165
168
  def list_invitations(opts = {})
166
169
  data, _status_code, _headers = list_invitations_with_http_info(opts)
@@ -173,6 +176,9 @@ module SmplkitGeneratedClient::App
173
176
  # @option opts [String] :filter_status
174
177
  # @option opts [String] :filter_token
175
178
  # @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;email&#x60;, &#x60;-email&#x60;, &#x60;status&#x60;, &#x60;-status&#x60;. (default to '-created_at')
179
+ # @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)
180
+ # @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)
181
+ # @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)
176
182
  # @return [Array<(InvitationListResponse, Integer, Hash)>] InvitationListResponse data, response status code and response headers
177
183
  def list_invitations_with_http_info(opts = {})
178
184
  if @api_client.config.debugging
@@ -190,6 +196,9 @@ module SmplkitGeneratedClient::App
190
196
  query_params[:'filter[status]'] = opts[:'filter_status'] if !opts[:'filter_status'].nil?
191
197
  query_params[:'filter[token]'] = opts[:'filter_token'] if !opts[:'filter_token'].nil?
192
198
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
199
+ query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
200
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
201
+ query_params[:'meta[total]'] = opts[:'meta_total'] if !opts[:'meta_total'].nil?
193
202
 
194
203
  # header parameters
195
204
  header_params = opts[:header_params] || {}
@@ -91,6 +91,9 @@ module SmplkitGeneratedClient::App
91
91
  # Return distinct metric names recorded for the account, each with a representative unit. Plain-JSON response (not JSON:API) — this is metadata for discovery, not a metric resource. Default sort is `name` ascending.
92
92
  # @param [Hash] opts the optional parameters
93
93
  # @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')
94
+ # @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)
95
+ # @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)
96
+ # @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)
94
97
  # @return [MetricNamesResponse]
95
98
  def list_metric_names(opts = {})
96
99
  data, _status_code, _headers = list_metric_names_with_http_info(opts)
@@ -101,6 +104,9 @@ module SmplkitGeneratedClient::App
101
104
  # Return distinct metric names recorded for the account, each with a representative unit. Plain-JSON response (not JSON:API) — this is metadata for discovery, not a metric resource. Default sort is &#x60;name&#x60; ascending.
102
105
  # @param [Hash] opts the optional parameters
103
106
  # @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')
107
+ # @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)
108
+ # @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)
109
+ # @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)
104
110
  # @return [Array<(MetricNamesResponse, Integer, Hash)>] MetricNamesResponse data, response status code and response headers
105
111
  def list_metric_names_with_http_info(opts = {})
106
112
  if @api_client.config.debugging
@@ -116,6 +122,9 @@ module SmplkitGeneratedClient::App
116
122
  # query parameters
117
123
  query_params = opts[:query_params] || {}
118
124
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
125
+ query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
126
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
127
+ query_params[:'meta[total]'] = opts[:'meta_total'] if !opts[:'meta_total'].nil?
119
128
 
120
129
  # header parameters
121
130
  header_params = opts[:header_params] || {}
@@ -158,6 +167,9 @@ module SmplkitGeneratedClient::App
158
167
  # @param [Hash] opts the optional parameters
159
168
  # @option opts [String] :filter_recorded_at
160
169
  # @option opts [String] :sort Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;bucket&#x60;. Allowed values: &#x60;bucket&#x60;, &#x60;-bucket&#x60;. (default to 'bucket')
170
+ # @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)
171
+ # @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)
172
+ # @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)
161
173
  # @return [MetricRollupListResponse]
162
174
  def list_metric_rollups(filter_name, filter_rollup, opts = {})
163
175
  data, _status_code, _headers = list_metric_rollups_with_http_info(filter_name, filter_rollup, opts)
@@ -171,6 +183,9 @@ module SmplkitGeneratedClient::App
171
183
  # @param [Hash] opts the optional parameters
172
184
  # @option opts [String] :filter_recorded_at
173
185
  # @option opts [String] :sort Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;bucket&#x60;. Allowed values: &#x60;bucket&#x60;, &#x60;-bucket&#x60;. (default to 'bucket')
186
+ # @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)
187
+ # @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)
188
+ # @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)
174
189
  # @return [Array<(MetricRollupListResponse, Integer, Hash)>] MetricRollupListResponse data, response status code and response headers
175
190
  def list_metric_rollups_with_http_info(filter_name, filter_rollup, opts = {})
176
191
  if @api_client.config.debugging
@@ -197,6 +212,9 @@ module SmplkitGeneratedClient::App
197
212
  query_params[:'filter[rollup]'] = filter_rollup
198
213
  query_params[:'filter[recorded_at]'] = opts[:'filter_recorded_at'] if !opts[:'filter_recorded_at'].nil?
199
214
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
215
+ query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
216
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
217
+ query_params[:'meta[total]'] = opts[:'meta_total'] if !opts[:'meta_total'].nil?
200
218
 
201
219
  # header parameters
202
220
  header_params = opts[:header_params] || {}
@@ -238,6 +256,9 @@ module SmplkitGeneratedClient::App
238
256
  # @param [Hash] opts the optional parameters
239
257
  # @option opts [String] :filter_recorded_at
240
258
  # @option opts [String] :sort Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;-recorded_at&#x60;. Allowed values: &#x60;recorded_at&#x60;, &#x60;-recorded_at&#x60;, &#x60;value&#x60;, &#x60;-value&#x60;. (default to '-recorded_at')
259
+ # @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)
260
+ # @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)
261
+ # @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)
241
262
  # @return [MetricListResponse]
242
263
  def list_metrics(filter_name, opts = {})
243
264
  data, _status_code, _headers = list_metrics_with_http_info(filter_name, opts)
@@ -250,6 +271,9 @@ module SmplkitGeneratedClient::App
250
271
  # @param [Hash] opts the optional parameters
251
272
  # @option opts [String] :filter_recorded_at
252
273
  # @option opts [String] :sort Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;-recorded_at&#x60;. Allowed values: &#x60;recorded_at&#x60;, &#x60;-recorded_at&#x60;, &#x60;value&#x60;, &#x60;-value&#x60;. (default to '-recorded_at')
274
+ # @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)
275
+ # @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)
276
+ # @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)
253
277
  # @return [Array<(MetricListResponse, Integer, Hash)>] MetricListResponse data, response status code and response headers
254
278
  def list_metrics_with_http_info(filter_name, opts = {})
255
279
  if @api_client.config.debugging
@@ -271,6 +295,9 @@ module SmplkitGeneratedClient::App
271
295
  query_params[:'filter[name]'] = filter_name
272
296
  query_params[:'filter[recorded_at]'] = opts[:'filter_recorded_at'] if !opts[:'filter_recorded_at'].nil?
273
297
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
298
+ query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
299
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
300
+ query_params[:'meta[total]'] = opts[:'meta_total'] if !opts[:'meta_total'].nil?
274
301
 
275
302
  # header parameters
276
303
  header_params = opts[:header_params] || {}
@@ -23,6 +23,9 @@ module SmplkitGeneratedClient::App
23
23
  # Return all plan tier definitions as JSON:API resources. Default sort is `sort_order` ascending — the natural ladder defined in `plans.yaml`. Pass `sort=display_name` for an alphabetical view.
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;sort_order&#x60;. Allowed values: &#x60;display_name&#x60;, &#x60;-display_name&#x60;, &#x60;id&#x60;, &#x60;-id&#x60;, &#x60;sort_order&#x60;, &#x60;-sort_order&#x60;. (default to 'sort_order')
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 [PlanListResponse]
27
30
  def list_plans(opts = {})
28
31
  data, _status_code, _headers = list_plans_with_http_info(opts)
@@ -33,6 +36,9 @@ module SmplkitGeneratedClient::App
33
36
  # Return all plan tier definitions as JSON:API resources. Default sort is &#x60;sort_order&#x60; ascending — the natural ladder defined in &#x60;plans.yaml&#x60;. Pass &#x60;sort&#x3D;display_name&#x60; for an alphabetical view.
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;sort_order&#x60;. Allowed values: &#x60;display_name&#x60;, &#x60;-display_name&#x60;, &#x60;id&#x60;, &#x60;-id&#x60;, &#x60;sort_order&#x60;, &#x60;-sort_order&#x60;. (default to 'sort_order')
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<(PlanListResponse, Integer, Hash)>] PlanListResponse data, response status code and response headers
37
43
  def list_plans_with_http_info(opts = {})
38
44
  if @api_client.config.debugging
@@ -48,6 +54,9 @@ module SmplkitGeneratedClient::App
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::App
23
23
  # Return all flag-enabled products with their plans, limits, and marketing content. Default sort is `display_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;display_name&#x60;. Allowed values: &#x60;display_name&#x60;, &#x60;-display_name&#x60;, &#x60;id&#x60;, &#x60;-id&#x60;. (default to 'display_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 [ProductListResponse]
27
30
  def list_products(opts = {})
28
31
  data, _status_code, _headers = list_products_with_http_info(opts)
@@ -33,6 +36,9 @@ module SmplkitGeneratedClient::App
33
36
  # Return all flag-enabled products with their plans, limits, and marketing content. Default sort is &#x60;display_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;display_name&#x60;. Allowed values: &#x60;display_name&#x60;, &#x60;-display_name&#x60;, &#x60;id&#x60;, &#x60;-id&#x60;. (default to 'display_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<(ProductListResponse, Integer, Hash)>] ProductListResponse data, response status code and response headers
37
43
  def list_products_with_http_info(opts = {})
38
44
  if @api_client.config.debugging
@@ -48,6 +54,9 @@ module SmplkitGeneratedClient::App
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] || {}
@@ -217,6 +217,9 @@ module SmplkitGeneratedClient::App
217
217
  # List all services for the authenticated account.
218
218
  # @param [Hash] opts the optional parameters
219
219
  # @option opts [String] :sort Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;name&#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 'name')
220
+ # @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)
221
+ # @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)
222
+ # @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)
220
223
  # @return [ServiceListResponse]
221
224
  def list_services(opts = {})
222
225
  data, _status_code, _headers = list_services_with_http_info(opts)
@@ -227,6 +230,9 @@ module SmplkitGeneratedClient::App
227
230
  # List all services for the authenticated account.
228
231
  # @param [Hash] opts the optional parameters
229
232
  # @option opts [String] :sort Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;name&#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 'name')
233
+ # @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)
234
+ # @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)
235
+ # @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)
230
236
  # @return [Array<(ServiceListResponse, Integer, Hash)>] ServiceListResponse data, response status code and response headers
231
237
  def list_services_with_http_info(opts = {})
232
238
  if @api_client.config.debugging
@@ -242,6 +248,9 @@ module SmplkitGeneratedClient::App
242
248
  # query parameters
243
249
  query_params = opts[:query_params] || {}
244
250
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
251
+ query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
252
+ query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
253
+ query_params[:'meta[total]'] = opts[:'meta_total'] if !opts[:'meta_total'].nil?
245
254
 
246
255
  # header parameters
247
256
  header_params = opts[:header_params] || {}