rocket_stack_sdk 1.0.2 → 1.0.4

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 (170) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +31 -13
  3. data/docs/CreateCronJob201ResponseData.md +3 -1
  4. data/docs/CreateCronJobRequestDeliveryTarget.md +9 -9
  5. data/docs/CreateCronJobRequestDeliveryTargetAnyOf.md +30 -0
  6. data/docs/CreateCronJobRequestDeliveryTargetAnyOf1.md +30 -0
  7. data/docs/CreateCronJobRequestSchedule.md +1 -1
  8. data/docs/CreateDownloadUrlRequest.md +1 -1
  9. data/docs/CreateQueueRequestDeliveryTarget.md +9 -9
  10. data/docs/CreateQueueRequestDeliveryTargetAnyOf.md +30 -0
  11. data/docs/CreateQueueRequestDeliveryTargetAnyOf1.md +30 -0
  12. data/docs/CreateScheduleRequest.md +1 -1
  13. data/docs/CronApi.md +85 -7
  14. data/docs/DeleteCronJob200Response.md +22 -0
  15. data/docs/DeleteCronJob200ResponseData.md +20 -0
  16. data/docs/FinalizeUploadRequest.md +1 -1
  17. data/docs/FunctionsApi.md +72 -2
  18. data/docs/GetFunctionCode200Response.md +22 -0
  19. data/docs/GetFunctionCode200ResponseData.md +28 -0
  20. data/docs/GetFunctionCode200ResponseDataFilesInner.md +20 -0
  21. data/docs/GetMessageStatus200Response.md +1 -1
  22. data/docs/GetMessageStatus200ResponseData.md +2 -2
  23. data/docs/InvokeFunctionRequest.md +2 -2
  24. data/docs/KvApi.md +26 -26
  25. data/docs/ListCronInvocations200Response.md +22 -0
  26. data/docs/ListCronInvocations200ResponseData.md +20 -0
  27. data/docs/ListCronInvocations200ResponseDataItemsInner.md +42 -0
  28. data/docs/ListQueueMessages200Response.md +22 -0
  29. data/docs/ListQueueMessages200ResponseData.md +20 -0
  30. data/docs/ListQueueMessages200ResponseDataItemsInner.md +32 -0
  31. data/docs/PutKvItemRequest.md +3 -3
  32. data/docs/QueuesApi.md +80 -2
  33. data/docs/ResourcesApi.md +1 -1
  34. data/docs/SchedulerApi.md +81 -3
  35. data/docs/StorageApi.md +5 -5
  36. data/docs/UpdateCronJobRequestSchedule.md +1 -1
  37. data/docs/UpdateScheduleRequest.md +1 -1
  38. data/lib/rocket_stack_sdk/api/cron_api.rb +92 -8
  39. data/lib/rocket_stack_sdk/api/functions_api.rb +68 -5
  40. data/lib/rocket_stack_sdk/api/kv_api.rb +38 -50
  41. data/lib/rocket_stack_sdk/api/queues_api.rb +89 -5
  42. data/lib/rocket_stack_sdk/api/resources_api.rb +3 -3
  43. data/lib/rocket_stack_sdk/api/scheduler_api.rb +89 -5
  44. data/lib/rocket_stack_sdk/api/storage_api.rb +9 -9
  45. data/lib/rocket_stack_sdk/api_client.rb +3 -3
  46. data/lib/rocket_stack_sdk/api_error.rb +3 -3
  47. data/lib/rocket_stack_sdk/api_model_base.rb +3 -3
  48. data/lib/rocket_stack_sdk/configuration.rb +5 -5
  49. data/lib/rocket_stack_sdk/models/create_cron_job201_response.rb +3 -3
  50. data/lib/rocket_stack_sdk/models/create_cron_job201_response_data.rb +33 -7
  51. data/lib/rocket_stack_sdk/models/create_cron_job_request.rb +3 -3
  52. data/lib/rocket_stack_sdk/models/create_cron_job_request_delivery_target.rb +79 -319
  53. data/lib/rocket_stack_sdk/models/create_cron_job_request_delivery_target_any_of.rb +351 -0
  54. data/lib/rocket_stack_sdk/models/create_cron_job_request_delivery_target_any_of1.rb +351 -0
  55. data/lib/rocket_stack_sdk/models/create_cron_job_request_schedule.rb +3 -5
  56. data/lib/rocket_stack_sdk/models/create_download_url200_response.rb +3 -3
  57. data/lib/rocket_stack_sdk/models/create_download_url200_response_data.rb +3 -3
  58. data/lib/rocket_stack_sdk/models/create_download_url_request.rb +4 -3
  59. data/lib/rocket_stack_sdk/models/create_function202_response.rb +3 -3
  60. data/lib/rocket_stack_sdk/models/create_function202_response_data.rb +3 -3
  61. data/lib/rocket_stack_sdk/models/create_queue201_response.rb +3 -3
  62. data/lib/rocket_stack_sdk/models/create_queue201_response_data.rb +3 -3
  63. data/lib/rocket_stack_sdk/models/create_queue_request.rb +3 -3
  64. data/lib/rocket_stack_sdk/models/create_queue_request_delivery_target.rb +79 -319
  65. data/lib/rocket_stack_sdk/models/create_queue_request_delivery_target_any_of.rb +351 -0
  66. data/lib/rocket_stack_sdk/models/create_queue_request_delivery_target_any_of1.rb +351 -0
  67. data/lib/rocket_stack_sdk/models/create_schedule201_response.rb +3 -3
  68. data/lib/rocket_stack_sdk/models/create_schedule201_response_data.rb +3 -3
  69. data/lib/rocket_stack_sdk/models/create_schedule_request.rb +4 -3
  70. data/lib/rocket_stack_sdk/models/delete_cron_job200_response.rb +182 -0
  71. data/lib/rocket_stack_sdk/models/delete_cron_job200_response_data.rb +190 -0
  72. data/lib/rocket_stack_sdk/models/delete_kv_item200_response.rb +3 -3
  73. data/lib/rocket_stack_sdk/models/delete_kv_item200_response_data.rb +3 -3
  74. data/lib/rocket_stack_sdk/models/enqueue_message201_response.rb +3 -3
  75. data/lib/rocket_stack_sdk/models/enqueue_message201_response_data.rb +3 -3
  76. data/lib/rocket_stack_sdk/models/enqueue_message_request.rb +3 -3
  77. data/lib/rocket_stack_sdk/models/finalize_upload200_response.rb +3 -3
  78. data/lib/rocket_stack_sdk/models/finalize_upload200_response_data.rb +3 -3
  79. data/lib/rocket_stack_sdk/models/finalize_upload_request.rb +4 -3
  80. data/lib/rocket_stack_sdk/models/get_cron_job200_response.rb +3 -3
  81. data/lib/rocket_stack_sdk/models/get_function200_response.rb +3 -3
  82. data/lib/rocket_stack_sdk/models/get_function_code200_response.rb +182 -0
  83. data/lib/rocket_stack_sdk/models/get_function_code200_response_data.rb +290 -0
  84. data/lib/rocket_stack_sdk/models/get_function_code200_response_data_files_inner.rb +190 -0
  85. data/lib/rocket_stack_sdk/models/get_kv_item200_response.rb +3 -3
  86. data/lib/rocket_stack_sdk/models/get_kv_item200_response_data.rb +3 -3
  87. data/lib/rocket_stack_sdk/models/get_message_status200_response.rb +4 -4
  88. data/lib/rocket_stack_sdk/models/get_message_status200_response_data.rb +4 -4
  89. data/lib/rocket_stack_sdk/models/get_queue200_response.rb +3 -3
  90. data/lib/rocket_stack_sdk/models/get_schedule200_response.rb +3 -3
  91. data/lib/rocket_stack_sdk/models/get_schedule_status200_response.rb +3 -3
  92. data/lib/rocket_stack_sdk/models/get_schedule_status200_response_data.rb +3 -3
  93. data/lib/rocket_stack_sdk/models/get_template200_response.rb +3 -3
  94. data/lib/rocket_stack_sdk/models/invoke_function200_response.rb +3 -3
  95. data/lib/rocket_stack_sdk/models/invoke_function200_response_data.rb +3 -3
  96. data/lib/rocket_stack_sdk/models/invoke_function_request.rb +3 -7
  97. data/lib/rocket_stack_sdk/models/list_capabilities200_response.rb +3 -3
  98. data/lib/rocket_stack_sdk/models/list_capabilities200_response_data_inner.rb +3 -3
  99. data/lib/rocket_stack_sdk/models/list_cron_invocations200_response.rb +182 -0
  100. data/lib/rocket_stack_sdk/models/list_cron_invocations200_response_data.rb +176 -0
  101. data/lib/rocket_stack_sdk/models/list_cron_invocations200_response_data_items_inner.rb +347 -0
  102. data/lib/rocket_stack_sdk/models/list_cron_jobs200_response.rb +3 -3
  103. data/lib/rocket_stack_sdk/models/list_cron_jobs200_response_data.rb +3 -3
  104. data/lib/rocket_stack_sdk/models/list_cron_jobs200_response_data_items_inner.rb +3 -3
  105. data/lib/rocket_stack_sdk/models/list_cron_jobs200_response_data_items_inner_schedule.rb +3 -3
  106. data/lib/rocket_stack_sdk/models/list_functions200_response.rb +3 -3
  107. data/lib/rocket_stack_sdk/models/list_functions200_response_data.rb +3 -3
  108. data/lib/rocket_stack_sdk/models/list_functions200_response_data_items_inner.rb +3 -3
  109. data/lib/rocket_stack_sdk/models/list_functions200_response_data_items_inner_actual_spec.rb +3 -3
  110. data/lib/rocket_stack_sdk/models/list_functions200_response_data_items_inner_desired_spec.rb +3 -3
  111. data/lib/rocket_stack_sdk/models/list_functions200_response_data_items_inner_desired_spec_code.rb +3 -3
  112. data/lib/rocket_stack_sdk/models/list_functions200_response_error.rb +3 -3
  113. data/lib/rocket_stack_sdk/models/list_functions401_response.rb +3 -3
  114. data/lib/rocket_stack_sdk/models/list_kv_items200_response.rb +3 -3
  115. data/lib/rocket_stack_sdk/models/list_kv_items200_response_data.rb +3 -3
  116. data/lib/rocket_stack_sdk/models/list_kv_items200_response_data_items_inner.rb +3 -3
  117. data/lib/rocket_stack_sdk/models/list_queue_messages200_response.rb +182 -0
  118. data/lib/rocket_stack_sdk/models/list_queue_messages200_response_data.rb +176 -0
  119. data/lib/rocket_stack_sdk/models/list_queue_messages200_response_data_items_inner.rb +312 -0
  120. data/lib/rocket_stack_sdk/models/list_queues200_response.rb +3 -3
  121. data/lib/rocket_stack_sdk/models/list_queues200_response_data.rb +3 -3
  122. data/lib/rocket_stack_sdk/models/list_queues200_response_data_items_inner.rb +3 -3
  123. data/lib/rocket_stack_sdk/models/list_queues200_response_data_items_inner_delivery_target.rb +3 -3
  124. data/lib/rocket_stack_sdk/models/list_schedules200_response.rb +3 -3
  125. data/lib/rocket_stack_sdk/models/list_schedules200_response_data.rb +3 -3
  126. data/lib/rocket_stack_sdk/models/list_schedules200_response_data_items_inner.rb +3 -3
  127. data/lib/rocket_stack_sdk/models/list_snippets200_response.rb +3 -3
  128. data/lib/rocket_stack_sdk/models/list_snippets200_response_data_inner.rb +3 -3
  129. data/lib/rocket_stack_sdk/models/list_storage_objects200_response.rb +3 -3
  130. data/lib/rocket_stack_sdk/models/list_storage_objects200_response_data.rb +3 -3
  131. data/lib/rocket_stack_sdk/models/list_storage_objects200_response_data_items_inner.rb +3 -3
  132. data/lib/rocket_stack_sdk/models/list_templates200_response.rb +3 -3
  133. data/lib/rocket_stack_sdk/models/list_templates200_response_data_inner.rb +3 -3
  134. data/lib/rocket_stack_sdk/models/put_kv_item200_response.rb +3 -3
  135. data/lib/rocket_stack_sdk/models/put_kv_item200_response_data.rb +3 -3
  136. data/lib/rocket_stack_sdk/models/put_kv_item_request.rb +7 -4
  137. data/lib/rocket_stack_sdk/models/put_kv_item_request_if_version.rb +4 -3
  138. data/lib/rocket_stack_sdk/models/update_cron_job200_response.rb +3 -3
  139. data/lib/rocket_stack_sdk/models/update_cron_job200_response_data.rb +3 -3
  140. data/lib/rocket_stack_sdk/models/update_cron_job_request.rb +3 -3
  141. data/lib/rocket_stack_sdk/models/update_cron_job_request_schedule.rb +3 -5
  142. data/lib/rocket_stack_sdk/models/update_function_request.rb +3 -3
  143. data/lib/rocket_stack_sdk/models/update_queue200_response.rb +3 -3
  144. data/lib/rocket_stack_sdk/models/update_queue200_response_data.rb +3 -3
  145. data/lib/rocket_stack_sdk/models/update_queue_request.rb +3 -3
  146. data/lib/rocket_stack_sdk/models/update_schedule200_response.rb +3 -3
  147. data/lib/rocket_stack_sdk/models/update_schedule200_response_data.rb +3 -3
  148. data/lib/rocket_stack_sdk/models/update_schedule_request.rb +4 -3
  149. data/lib/rocket_stack_sdk/models/upload_object201_response.rb +3 -3
  150. data/lib/rocket_stack_sdk/models/upload_object201_response_data.rb +3 -3
  151. data/lib/rocket_stack_sdk/version.rb +4 -4
  152. data/lib/rocket_stack_sdk.rb +18 -4
  153. data/rocket_stack_sdk.gemspec +5 -5
  154. data/spec/models/create_cron_job_request_delivery_target_any_of1_spec.rb +76 -0
  155. data/spec/models/create_cron_job_request_delivery_target_any_of_spec.rb +76 -0
  156. data/spec/models/create_queue_request_delivery_target_any_of1_spec.rb +76 -0
  157. data/spec/models/create_queue_request_delivery_target_any_of_spec.rb +76 -0
  158. data/spec/models/delete_cron_job200_response_data_spec.rb +42 -0
  159. data/spec/models/delete_cron_job200_response_spec.rb +48 -0
  160. data/spec/models/get_function_code200_response_data_files_inner_spec.rb +42 -0
  161. data/spec/models/get_function_code200_response_data_spec.rb +74 -0
  162. data/spec/models/get_function_code200_response_spec.rb +48 -0
  163. data/spec/models/list_cron_invocations200_response_data_items_inner_spec.rb +112 -0
  164. data/spec/models/list_cron_invocations200_response_data_spec.rb +42 -0
  165. data/spec/models/list_cron_invocations200_response_spec.rb +48 -0
  166. data/spec/models/list_queue_messages200_response_data_items_inner_spec.rb +78 -0
  167. data/spec/models/list_queue_messages200_response_data_spec.rb +42 -0
  168. data/spec/models/list_queue_messages200_response_spec.rb +48 -0
  169. data/spec/spec_helper.rb +3 -3
  170. metadata +141 -81
data/docs/SchedulerApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # RocketStackSdk::SchedulerApi
2
2
 
3
- All URIs are relative to *https://api.rocketstack.dev*
3
+ All URIs are relative to *https://ctrl.rocketstack.sh*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
@@ -9,6 +9,7 @@ All URIs are relative to *https://api.rocketstack.dev*
9
9
  | [**delete_schedule**](SchedulerApi.md#delete_schedule) | **DELETE** /schedules/{id} | Delete a schedule |
10
10
  | [**get_schedule**](SchedulerApi.md#get_schedule) | **GET** /schedules/{id} | Get a schedule by ID |
11
11
  | [**get_schedule_status**](SchedulerApi.md#get_schedule_status) | **GET** /schedules/{id}/status | Get schedule execution status |
12
+ | [**list_schedule_invocations**](SchedulerApi.md#list_schedule_invocations) | **GET** /schedules/{id}/invocations | List schedule invocation history |
12
13
  | [**list_schedules**](SchedulerApi.md#list_schedules) | **GET** /schedules | List schedules |
13
14
  | [**update_schedule**](SchedulerApi.md#update_schedule) | **PATCH** /schedules/{id} | Update a schedule |
14
15
 
@@ -102,7 +103,7 @@ RocketStackSdk.configure do |config|
102
103
  end
103
104
 
104
105
  api_instance = RocketStackSdk::SchedulerApi.new
105
- create_schedule_request = RocketStackSdk::CreateScheduleRequest.new({name: 'name_example', run_at: 'run_at_example', delivery_target: RocketStackSdk::CreateCronJobRequestDeliveryTarget.new({type: 'function'})}) # CreateScheduleRequest |
106
+ create_schedule_request = RocketStackSdk::CreateScheduleRequest.new({name: 'name_example', run_at: 'run_at_example', delivery_target: RocketStackSdk::CreateCronJobRequestDeliveryTarget.new({type: 'function', function_id: 'function_id_example', webhook_url: 'webhook_url_example'})}) # CreateScheduleRequest |
106
107
 
107
108
  begin
108
109
  # Create a new one-off schedule
@@ -358,6 +359,83 @@ end
358
359
  - **Accept**: application/json
359
360
 
360
361
 
362
+ ## list_schedule_invocations
363
+
364
+ > <ListCronInvocations200Response> list_schedule_invocations(id, opts)
365
+
366
+ List schedule invocation history
367
+
368
+ Returns a paginated list of delivery attempts and outcomes for a one-off schedule.
369
+
370
+ ### Examples
371
+
372
+ ```ruby
373
+ require 'time'
374
+ require 'rocket_stack_sdk'
375
+ # setup authorization
376
+ RocketStackSdk.configure do |config|
377
+ # Configure Bearer authorization (JWT): bearerAuth
378
+ config.access_token = 'YOUR_BEARER_TOKEN'
379
+ end
380
+
381
+ api_instance = RocketStackSdk::SchedulerApi.new
382
+ id = 'id_example' # String |
383
+ opts = {
384
+ limit: 8.14, # Float |
385
+ cursor: 'cursor_example', # String |
386
+ outcome: 'delivered' # String |
387
+ }
388
+
389
+ begin
390
+ # List schedule invocation history
391
+ result = api_instance.list_schedule_invocations(id, opts)
392
+ p result
393
+ rescue RocketStackSdk::ApiError => e
394
+ puts "Error when calling SchedulerApi->list_schedule_invocations: #{e}"
395
+ end
396
+ ```
397
+
398
+ #### Using the list_schedule_invocations_with_http_info variant
399
+
400
+ This returns an Array which contains the response data, status code and headers.
401
+
402
+ > <Array(<ListCronInvocations200Response>, Integer, Hash)> list_schedule_invocations_with_http_info(id, opts)
403
+
404
+ ```ruby
405
+ begin
406
+ # List schedule invocation history
407
+ data, status_code, headers = api_instance.list_schedule_invocations_with_http_info(id, opts)
408
+ p status_code # => 2xx
409
+ p headers # => { ... }
410
+ p data # => <ListCronInvocations200Response>
411
+ rescue RocketStackSdk::ApiError => e
412
+ puts "Error when calling SchedulerApi->list_schedule_invocations_with_http_info: #{e}"
413
+ end
414
+ ```
415
+
416
+ ### Parameters
417
+
418
+ | Name | Type | Description | Notes |
419
+ | ---- | ---- | ----------- | ----- |
420
+ | **id** | **String** | | |
421
+ | **limit** | **Float** | | [optional] |
422
+ | **cursor** | **String** | | [optional] |
423
+ | **outcome** | **String** | | [optional] |
424
+
425
+ ### Return type
426
+
427
+ [**ListCronInvocations200Response**](ListCronInvocations200Response.md)
428
+
429
+ ### Authorization
430
+
431
+ [bearerAuth](../README.md#bearerAuth)
432
+
433
+ ### HTTP request headers
434
+
435
+ - **Content-Type**: Not defined
436
+ - **Accept**: application/json
437
+
438
+
361
439
  ## list_schedules
362
440
 
363
441
  > <ListSchedules200Response> list_schedules(opts)
@@ -414,7 +492,7 @@ end
414
492
 
415
493
  | Name | Type | Description | Notes |
416
494
  | ---- | ---- | ----------- | ----- |
417
- | **limit** | **Float** | | [optional][default to 50] |
495
+ | **limit** | **Float** | | [optional] |
418
496
  | **cursor** | **String** | | [optional] |
419
497
 
420
498
  ### Return type
data/docs/StorageApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # RocketStackSdk::StorageApi
2
2
 
3
- All URIs are relative to *https://api.rocketstack.dev*
3
+ All URIs are relative to *https://ctrl.rocketstack.sh*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
@@ -101,7 +101,7 @@ RocketStackSdk.configure do |config|
101
101
  end
102
102
 
103
103
  api_instance = RocketStackSdk::StorageApi.new
104
- path = 'path_example' # String |
104
+ path = 'path_example' # String | Object path without leading slash. Segments: letters, digits, dots, underscores, hyphens only.
105
105
  opts = {
106
106
  public: true # Boolean |
107
107
  }
@@ -137,7 +137,7 @@ end
137
137
 
138
138
  | Name | Type | Description | Notes |
139
139
  | ---- | ---- | ----------- | ----- |
140
- | **path** | **String** | | |
140
+ | **path** | **String** | Object path without leading slash. Segments: letters, digits, dots, underscores, hyphens only. | |
141
141
  | **public** | **Boolean** | | [optional] |
142
142
 
143
143
  ### Return type
@@ -353,8 +353,8 @@ end
353
353
  | Name | Type | Description | Notes |
354
354
  | ---- | ---- | ----------- | ----- |
355
355
  | **prefix** | **String** | | [optional] |
356
- | **visibility** | **String** | | [optional][default to &#39;all&#39;] |
357
- | **limit** | **Integer** | | [optional][default to 50] |
356
+ | **visibility** | **String** | | [optional] |
357
+ | **limit** | **Integer** | | [optional] |
358
358
  | **cursor** | **String** | | [optional] |
359
359
 
360
360
  ### Return type
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **expression** | **String** | | [optional] |
8
- | **format** | **String** | | [optional][default to &#39;unix5&#39;] |
8
+ | **format** | **String** | | [optional] |
9
9
  | **timezone** | **String** | | [optional] |
10
10
 
11
11
  ## Example
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **run_at** | **String** | | [optional] |
7
+ | **run_at** | **String** | RFC 3339 datetime with timezone (e.g. 2026-03-15T14:30:00Z). Must be in the future (max 365 days). | [optional] |
8
8
  | **delivery_target** | [**CreateCronJobRequestDeliveryTarget**](CreateCronJobRequestDeliveryTarget.md) | | [optional] |
9
9
  | **paused** | **Boolean** | | [optional] |
10
10
  | **payload_template** | **Hash&lt;String, Object&gt;** | | [optional] |
@@ -1,9 +1,9 @@
1
1
  =begin
2
- #Rocketstack API
2
+ #Rocketstack Control Plane API
3
3
 
4
- #API for Functions, Queues, KV, Storage, Cron, and Scheduler.
4
+ #Combined API for Functions, Queues, KV, Storage, Cron, and Scheduler.
5
5
 
6
- The version of the OpenAPI document: 1.0.1
6
+ The version of the OpenAPI document: 1.0.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.19.0
@@ -91,7 +91,7 @@ module RocketStackSdk
91
91
  # Deletes a cron job and its associated AWS resources.
92
92
  # @param id [String]
93
93
  # @param [Hash] opts the optional parameters
94
- # @return [CreateCronJob201Response]
94
+ # @return [DeleteCronJob200Response]
95
95
  def delete_cron_job(id, opts = {})
96
96
  data, _status_code, _headers = delete_cron_job_with_http_info(id, opts)
97
97
  data
@@ -101,7 +101,7 @@ module RocketStackSdk
101
101
  # Deletes a cron job and its associated AWS resources.
102
102
  # @param id [String]
103
103
  # @param [Hash] opts the optional parameters
104
- # @return [Array<(CreateCronJob201Response, Integer, Hash)>] CreateCronJob201Response data, response status code and response headers
104
+ # @return [Array<(DeleteCronJob200Response, Integer, Hash)>] DeleteCronJob200Response data, response status code and response headers
105
105
  def delete_cron_job_with_http_info(id, opts = {})
106
106
  if @api_client.config.debugging
107
107
  @api_client.config.logger.debug 'Calling API: CronApi.delete_cron_job ...'
@@ -128,7 +128,7 @@ module RocketStackSdk
128
128
  post_body = opts[:debug_body]
129
129
 
130
130
  # return_type
131
- return_type = opts[:debug_return_type] || 'CreateCronJob201Response'
131
+ return_type = opts[:debug_return_type] || 'DeleteCronJob200Response'
132
132
 
133
133
  # auth_names
134
134
  auth_names = opts[:debug_auth_names] || ['bearerAuth']
@@ -213,10 +213,94 @@ module RocketStackSdk
213
213
  return data, status_code, headers
214
214
  end
215
215
 
216
+ # List cron invocation history
217
+ # Returns a paginated list of delivery attempts and outcomes for a cron job.
218
+ # @param id [String]
219
+ # @param [Hash] opts the optional parameters
220
+ # @option opts [Float] :limit
221
+ # @option opts [String] :cursor
222
+ # @option opts [String] :outcome
223
+ # @return [ListCronInvocations200Response]
224
+ def list_cron_invocations(id, opts = {})
225
+ data, _status_code, _headers = list_cron_invocations_with_http_info(id, opts)
226
+ data
227
+ end
228
+
229
+ # List cron invocation history
230
+ # Returns a paginated list of delivery attempts and outcomes for a cron job.
231
+ # @param id [String]
232
+ # @param [Hash] opts the optional parameters
233
+ # @option opts [Float] :limit
234
+ # @option opts [String] :cursor
235
+ # @option opts [String] :outcome
236
+ # @return [Array<(ListCronInvocations200Response, Integer, Hash)>] ListCronInvocations200Response data, response status code and response headers
237
+ def list_cron_invocations_with_http_info(id, opts = {})
238
+ if @api_client.config.debugging
239
+ @api_client.config.logger.debug 'Calling API: CronApi.list_cron_invocations ...'
240
+ end
241
+ # verify the required parameter 'id' is set
242
+ if @api_client.config.client_side_validation && id.nil?
243
+ fail ArgumentError, "Missing the required parameter 'id' when calling CronApi.list_cron_invocations"
244
+ end
245
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
246
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CronApi.list_cron_invocations, must be smaller than or equal to 100.'
247
+ end
248
+
249
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
250
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CronApi.list_cron_invocations, must be greater than or equal to 1.'
251
+ end
252
+
253
+ allowable_values = ["delivered", "retrying", "discarded", "abandoned", "enqueued"]
254
+ if @api_client.config.client_side_validation && opts[:'outcome'] && !allowable_values.include?(opts[:'outcome'])
255
+ fail ArgumentError, "invalid value for \"outcome\", must be one of #{allowable_values}"
256
+ end
257
+ # resource path
258
+ local_var_path = '/cron/{id}/invocations'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
259
+
260
+ # query parameters
261
+ query_params = opts[:query_params] || {}
262
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
263
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
264
+ query_params[:'outcome'] = opts[:'outcome'] if !opts[:'outcome'].nil?
265
+
266
+ # header parameters
267
+ header_params = opts[:header_params] || {}
268
+ # HTTP header 'Accept' (if needed)
269
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
270
+
271
+ # form parameters
272
+ form_params = opts[:form_params] || {}
273
+
274
+ # http body (model)
275
+ post_body = opts[:debug_body]
276
+
277
+ # return_type
278
+ return_type = opts[:debug_return_type] || 'ListCronInvocations200Response'
279
+
280
+ # auth_names
281
+ auth_names = opts[:debug_auth_names] || ['bearerAuth']
282
+
283
+ new_options = opts.merge(
284
+ :operation => :"CronApi.list_cron_invocations",
285
+ :header_params => header_params,
286
+ :query_params => query_params,
287
+ :form_params => form_params,
288
+ :body => post_body,
289
+ :auth_names => auth_names,
290
+ :return_type => return_type
291
+ )
292
+
293
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
294
+ if @api_client.config.debugging
295
+ @api_client.config.logger.debug "API called: CronApi#list_cron_invocations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
296
+ end
297
+ return data, status_code, headers
298
+ end
299
+
216
300
  # List cron jobs
217
301
  # Returns a paginated list of cron jobs for the tenant.
218
302
  # @param [Hash] opts the optional parameters
219
- # @option opts [Float] :limit (default to 50)
303
+ # @option opts [Float] :limit
220
304
  # @option opts [String] :cursor
221
305
  # @return [ListCronJobs200Response]
222
306
  def list_cron_jobs(opts = {})
@@ -227,7 +311,7 @@ module RocketStackSdk
227
311
  # List cron jobs
228
312
  # Returns a paginated list of cron jobs for the tenant.
229
313
  # @param [Hash] opts the optional parameters
230
- # @option opts [Float] :limit (default to 50)
314
+ # @option opts [Float] :limit
231
315
  # @option opts [String] :cursor
232
316
  # @return [Array<(ListCronJobs200Response, Integer, Hash)>] ListCronJobs200Response data, response status code and response headers
233
317
  def list_cron_jobs_with_http_info(opts = {})
@@ -1,9 +1,9 @@
1
1
  =begin
2
- #Rocketstack API
2
+ #Rocketstack Control Plane API
3
3
 
4
- #API for Functions, Queues, KV, Storage, Cron, and Scheduler.
4
+ #Combined API for Functions, Queues, KV, Storage, Cron, and Scheduler.
5
5
 
6
- The version of the OpenAPI document: 1.0.1
6
+ The version of the OpenAPI document: 1.0.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.19.0
@@ -247,6 +247,69 @@ module RocketStackSdk
247
247
  return data, status_code, headers
248
248
  end
249
249
 
250
+ # Get function code
251
+ # Downloads the actual deployed Lambda code package and returns editable source files.
252
+ # @param id [String]
253
+ # @param [Hash] opts the optional parameters
254
+ # @return [GetFunctionCode200Response]
255
+ def get_function_code(id, opts = {})
256
+ data, _status_code, _headers = get_function_code_with_http_info(id, opts)
257
+ data
258
+ end
259
+
260
+ # Get function code
261
+ # Downloads the actual deployed Lambda code package and returns editable source files.
262
+ # @param id [String]
263
+ # @param [Hash] opts the optional parameters
264
+ # @return [Array<(GetFunctionCode200Response, Integer, Hash)>] GetFunctionCode200Response data, response status code and response headers
265
+ def get_function_code_with_http_info(id, opts = {})
266
+ if @api_client.config.debugging
267
+ @api_client.config.logger.debug 'Calling API: FunctionsApi.get_function_code ...'
268
+ end
269
+ # verify the required parameter 'id' is set
270
+ if @api_client.config.client_side_validation && id.nil?
271
+ fail ArgumentError, "Missing the required parameter 'id' when calling FunctionsApi.get_function_code"
272
+ end
273
+ # resource path
274
+ local_var_path = '/functions/{id}/code'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
275
+
276
+ # query parameters
277
+ query_params = opts[:query_params] || {}
278
+
279
+ # header parameters
280
+ header_params = opts[:header_params] || {}
281
+ # HTTP header 'Accept' (if needed)
282
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
283
+
284
+ # form parameters
285
+ form_params = opts[:form_params] || {}
286
+
287
+ # http body (model)
288
+ post_body = opts[:debug_body]
289
+
290
+ # return_type
291
+ return_type = opts[:debug_return_type] || 'GetFunctionCode200Response'
292
+
293
+ # auth_names
294
+ auth_names = opts[:debug_auth_names] || ['bearerAuth']
295
+
296
+ new_options = opts.merge(
297
+ :operation => :"FunctionsApi.get_function_code",
298
+ :header_params => header_params,
299
+ :query_params => query_params,
300
+ :form_params => form_params,
301
+ :body => post_body,
302
+ :auth_names => auth_names,
303
+ :return_type => return_type
304
+ )
305
+
306
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
307
+ if @api_client.config.debugging
308
+ @api_client.config.logger.debug "API called: FunctionsApi#get_function_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
309
+ end
310
+ return data, status_code, headers
311
+ end
312
+
250
313
  # Invoke a function
251
314
  # Synchronously or asynchronously invokes a deployed function with the provided payload.
252
315
  # @param id [String]
@@ -320,7 +383,7 @@ module RocketStackSdk
320
383
  # List functions
321
384
  # Returns a paginated list of functions for the tenant.
322
385
  # @param [Hash] opts the optional parameters
323
- # @option opts [Float] :limit (default to 50)
386
+ # @option opts [Float] :limit
324
387
  # @option opts [String] :cursor
325
388
  # @return [ListFunctions200Response]
326
389
  def list_functions(opts = {})
@@ -331,7 +394,7 @@ module RocketStackSdk
331
394
  # List functions
332
395
  # Returns a paginated list of functions for the tenant.
333
396
  # @param [Hash] opts the optional parameters
334
- # @option opts [Float] :limit (default to 50)
397
+ # @option opts [Float] :limit
335
398
  # @option opts [String] :cursor
336
399
  # @return [Array<(ListFunctions200Response, Integer, Hash)>] ListFunctions200Response data, response status code and response headers
337
400
  def list_functions_with_http_info(opts = {})
@@ -1,9 +1,9 @@
1
1
  =begin
2
- #Rocketstack API
2
+ #Rocketstack Control Plane API
3
3
 
4
- #API for Functions, Queues, KV, Storage, Cron, and Scheduler.
4
+ #Combined API for Functions, Queues, KV, Storage, Cron, and Scheduler.
5
5
 
6
- The version of the OpenAPI document: 1.0.1
6
+ The version of the OpenAPI document: 1.0.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.19.0
@@ -20,34 +20,30 @@ module RocketStackSdk
20
20
  @api_client = api_client
21
21
  end
22
22
  # Delete a KV item
23
- # Deletes a key-value item by key (single path segment).
24
- # @param key [String]
23
+ # Deletes a key-value item by key.
24
+ # @param wildcard [String]
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [DeleteKvItem200Response]
27
- def delete_kv_item(key, opts = {})
28
- data, _status_code, _headers = delete_kv_item_with_http_info(key, opts)
27
+ def delete_kv_item(wildcard, opts = {})
28
+ data, _status_code, _headers = delete_kv_item_with_http_info(wildcard, opts)
29
29
  data
30
30
  end
31
31
 
32
32
  # Delete a KV item
33
- # Deletes a key-value item by key (single path segment).
34
- # @param key [String]
33
+ # Deletes a key-value item by key.
34
+ # @param wildcard [String]
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Array<(DeleteKvItem200Response, Integer, Hash)>] DeleteKvItem200Response data, response status code and response headers
37
- def delete_kv_item_with_http_info(key, opts = {})
37
+ def delete_kv_item_with_http_info(wildcard, opts = {})
38
38
  if @api_client.config.debugging
39
39
  @api_client.config.logger.debug 'Calling API: KvApi.delete_kv_item ...'
40
40
  end
41
- # verify the required parameter 'key' is set
42
- if @api_client.config.client_side_validation && key.nil?
43
- fail ArgumentError, "Missing the required parameter 'key' when calling KvApi.delete_kv_item"
41
+ # verify the required parameter 'wildcard' is set
42
+ if @api_client.config.client_side_validation && wildcard.nil?
43
+ fail ArgumentError, "Missing the required parameter 'wildcard' when calling KvApi.delete_kv_item"
44
44
  end
45
- if @api_client.config.client_side_validation && key.to_s.length < 1
46
- fail ArgumentError, 'invalid value for "key" when calling KvApi.delete_kv_item, the character length must be greater than or equal to 1.'
47
- end
48
-
49
45
  # resource path
50
- local_var_path = '/kv/items/{key}'.sub('{' + 'key' + '}', CGI.escape(key.to_s))
46
+ local_var_path = '/kv/items/{wildcard}'.sub('{' + 'wildcard' + '}', CGI.escape(wildcard.to_s))
51
47
 
52
48
  # query parameters
53
49
  query_params = opts[:query_params] || {}
@@ -87,34 +83,30 @@ module RocketStackSdk
87
83
  end
88
84
 
89
85
  # Get a KV item by key
90
- # Retrieves a single key-value item. The key is specified as a single path segment (slashes not supported in path).
91
- # @param key [String]
86
+ # Retrieves a single key-value item by key.
87
+ # @param wildcard [String]
92
88
  # @param [Hash] opts the optional parameters
93
89
  # @return [GetKvItem200Response]
94
- def get_kv_item(key, opts = {})
95
- data, _status_code, _headers = get_kv_item_with_http_info(key, opts)
90
+ def get_kv_item(wildcard, opts = {})
91
+ data, _status_code, _headers = get_kv_item_with_http_info(wildcard, opts)
96
92
  data
97
93
  end
98
94
 
99
95
  # Get a KV item by key
100
- # Retrieves a single key-value item. The key is specified as a single path segment (slashes not supported in path).
101
- # @param key [String]
96
+ # Retrieves a single key-value item by key.
97
+ # @param wildcard [String]
102
98
  # @param [Hash] opts the optional parameters
103
99
  # @return [Array<(GetKvItem200Response, Integer, Hash)>] GetKvItem200Response data, response status code and response headers
104
- def get_kv_item_with_http_info(key, opts = {})
100
+ def get_kv_item_with_http_info(wildcard, opts = {})
105
101
  if @api_client.config.debugging
106
102
  @api_client.config.logger.debug 'Calling API: KvApi.get_kv_item ...'
107
103
  end
108
- # verify the required parameter 'key' is set
109
- if @api_client.config.client_side_validation && key.nil?
110
- fail ArgumentError, "Missing the required parameter 'key' when calling KvApi.get_kv_item"
111
- end
112
- if @api_client.config.client_side_validation && key.to_s.length < 1
113
- fail ArgumentError, 'invalid value for "key" when calling KvApi.get_kv_item, the character length must be greater than or equal to 1.'
104
+ # verify the required parameter 'wildcard' is set
105
+ if @api_client.config.client_side_validation && wildcard.nil?
106
+ fail ArgumentError, "Missing the required parameter 'wildcard' when calling KvApi.get_kv_item"
114
107
  end
115
-
116
108
  # resource path
117
- local_var_path = '/kv/items/{key}'.sub('{' + 'key' + '}', CGI.escape(key.to_s))
109
+ local_var_path = '/kv/items/{wildcard}'.sub('{' + 'wildcard' + '}', CGI.escape(wildcard.to_s))
118
110
 
119
111
  # query parameters
120
112
  query_params = opts[:query_params] || {}
@@ -157,7 +149,7 @@ module RocketStackSdk
157
149
  # Returns a paginated list of KV items, optionally filtered by prefix.
158
150
  # @param [Hash] opts the optional parameters
159
151
  # @option opts [String] :prefix
160
- # @option opts [Integer] :limit (default to 50)
152
+ # @option opts [Integer] :limit
161
153
  # @option opts [String] :cursor
162
154
  # @return [ListKvItems200Response]
163
155
  def list_kv_items(opts = {})
@@ -169,7 +161,7 @@ module RocketStackSdk
169
161
  # Returns a paginated list of KV items, optionally filtered by prefix.
170
162
  # @param [Hash] opts the optional parameters
171
163
  # @option opts [String] :prefix
172
- # @option opts [Integer] :limit (default to 50)
164
+ # @option opts [Integer] :limit
173
165
  # @option opts [String] :cursor
174
166
  # @return [Array<(ListKvItems200Response, Integer, Hash)>] ListKvItems200Response data, response status code and response headers
175
167
  def list_kv_items_with_http_info(opts = {})
@@ -232,36 +224,32 @@ module RocketStackSdk
232
224
  end
233
225
 
234
226
  # Create or update a KV item
235
- # Creates or updates a key-value item. Supports TTL and conditional writes via ifVersion. Key is a single path segment.
236
- # @param key [String]
227
+ # Creates or updates a key-value item. Supports TTL and conditional writes via ifVersion. Use ttlSeconds OR expiresAt, never both.
228
+ # @param wildcard [String]
237
229
  # @param [Hash] opts the optional parameters
238
230
  # @option opts [PutKvItemRequest] :put_kv_item_request
239
231
  # @return [PutKvItem200Response]
240
- def put_kv_item(key, opts = {})
241
- data, _status_code, _headers = put_kv_item_with_http_info(key, opts)
232
+ def put_kv_item(wildcard, opts = {})
233
+ data, _status_code, _headers = put_kv_item_with_http_info(wildcard, opts)
242
234
  data
243
235
  end
244
236
 
245
237
  # Create or update a KV item
246
- # Creates or updates a key-value item. Supports TTL and conditional writes via ifVersion. Key is a single path segment.
247
- # @param key [String]
238
+ # Creates or updates a key-value item. Supports TTL and conditional writes via ifVersion. Use ttlSeconds OR expiresAt, never both.
239
+ # @param wildcard [String]
248
240
  # @param [Hash] opts the optional parameters
249
241
  # @option opts [PutKvItemRequest] :put_kv_item_request
250
242
  # @return [Array<(PutKvItem200Response, Integer, Hash)>] PutKvItem200Response data, response status code and response headers
251
- def put_kv_item_with_http_info(key, opts = {})
243
+ def put_kv_item_with_http_info(wildcard, opts = {})
252
244
  if @api_client.config.debugging
253
245
  @api_client.config.logger.debug 'Calling API: KvApi.put_kv_item ...'
254
246
  end
255
- # verify the required parameter 'key' is set
256
- if @api_client.config.client_side_validation && key.nil?
257
- fail ArgumentError, "Missing the required parameter 'key' when calling KvApi.put_kv_item"
258
- end
259
- if @api_client.config.client_side_validation && key.to_s.length < 1
260
- fail ArgumentError, 'invalid value for "key" when calling KvApi.put_kv_item, the character length must be greater than or equal to 1.'
247
+ # verify the required parameter 'wildcard' is set
248
+ if @api_client.config.client_side_validation && wildcard.nil?
249
+ fail ArgumentError, "Missing the required parameter 'wildcard' when calling KvApi.put_kv_item"
261
250
  end
262
-
263
251
  # resource path
264
- local_var_path = '/kv/items/{key}'.sub('{' + 'key' + '}', CGI.escape(key.to_s))
252
+ local_var_path = '/kv/items/{wildcard}'.sub('{' + 'wildcard' + '}', CGI.escape(wildcard.to_s))
265
253
 
266
254
  # query parameters
267
255
  query_params = opts[:query_params] || {}