rocket_stack_sdk 1.0.3 → 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 +3 -3
  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/FunctionsApi.md CHANGED
@@ -1,11 +1,12 @@
1
1
  # RocketStackSdk::FunctionsApi
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
  | ------ | ------------ | ----------- |
7
7
  | [**create_function**](FunctionsApi.md#create_function) | **POST** /functions | Create a new function |
8
8
  | [**get_function**](FunctionsApi.md#get_function) | **GET** /functions/{id} | Get a function by ID |
9
+ | [**get_function_code**](FunctionsApi.md#get_function_code) | **GET** /functions/{id}/code | Get function code |
9
10
  | [**invoke_function**](FunctionsApi.md#invoke_function) | **POST** /functions/{id}/invoke | Invoke a function |
10
11
  | [**list_functions**](FunctionsApi.md#list_functions) | **GET** /functions | List functions |
11
12
  | [**update_function**](FunctionsApi.md#update_function) | **PATCH** /functions/{id} | Update function settings |
@@ -172,6 +173,75 @@ end
172
173
  - **Accept**: application/json
173
174
 
174
175
 
176
+ ## get_function_code
177
+
178
+ > <GetFunctionCode200Response> get_function_code(id)
179
+
180
+ Get function code
181
+
182
+ Downloads the actual deployed Lambda code package and returns editable source files.
183
+
184
+ ### Examples
185
+
186
+ ```ruby
187
+ require 'time'
188
+ require 'rocket_stack_sdk'
189
+ # setup authorization
190
+ RocketStackSdk.configure do |config|
191
+ # Configure Bearer authorization (JWT): bearerAuth
192
+ config.access_token = 'YOUR_BEARER_TOKEN'
193
+ end
194
+
195
+ api_instance = RocketStackSdk::FunctionsApi.new
196
+ id = 'id_example' # String |
197
+
198
+ begin
199
+ # Get function code
200
+ result = api_instance.get_function_code(id)
201
+ p result
202
+ rescue RocketStackSdk::ApiError => e
203
+ puts "Error when calling FunctionsApi->get_function_code: #{e}"
204
+ end
205
+ ```
206
+
207
+ #### Using the get_function_code_with_http_info variant
208
+
209
+ This returns an Array which contains the response data, status code and headers.
210
+
211
+ > <Array(<GetFunctionCode200Response>, Integer, Hash)> get_function_code_with_http_info(id)
212
+
213
+ ```ruby
214
+ begin
215
+ # Get function code
216
+ data, status_code, headers = api_instance.get_function_code_with_http_info(id)
217
+ p status_code # => 2xx
218
+ p headers # => { ... }
219
+ p data # => <GetFunctionCode200Response>
220
+ rescue RocketStackSdk::ApiError => e
221
+ puts "Error when calling FunctionsApi->get_function_code_with_http_info: #{e}"
222
+ end
223
+ ```
224
+
225
+ ### Parameters
226
+
227
+ | Name | Type | Description | Notes |
228
+ | ---- | ---- | ----------- | ----- |
229
+ | **id** | **String** | | |
230
+
231
+ ### Return type
232
+
233
+ [**GetFunctionCode200Response**](GetFunctionCode200Response.md)
234
+
235
+ ### Authorization
236
+
237
+ [bearerAuth](../README.md#bearerAuth)
238
+
239
+ ### HTTP request headers
240
+
241
+ - **Content-Type**: Not defined
242
+ - **Accept**: application/json
243
+
244
+
175
245
  ## invoke_function
176
246
 
177
247
  > <InvokeFunction200Response> invoke_function(id, opts)
@@ -301,7 +371,7 @@ end
301
371
 
302
372
  | Name | Type | Description | Notes |
303
373
  | ---- | ---- | ----------- | ----- |
304
- | **limit** | **Float** | | [optional][default to 50] |
374
+ | **limit** | **Float** | | [optional] |
305
375
  | **cursor** | **String** | | [optional] |
306
376
 
307
377
  ### Return type
@@ -0,0 +1,22 @@
1
+ # RocketStackSdk::GetFunctionCode200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **request_id** | **String** | | |
8
+ | **data** | [**GetFunctionCode200ResponseData**](GetFunctionCode200ResponseData.md) | | [optional] |
9
+ | **error** | [**ListFunctions200ResponseError**](ListFunctions200ResponseError.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'rocket_stack_sdk'
15
+
16
+ instance = RocketStackSdk::GetFunctionCode200Response.new(
17
+ request_id: null,
18
+ data: null,
19
+ error: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,28 @@
1
+ # RocketStackSdk::GetFunctionCode200ResponseData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **source** | **String** | | |
8
+ | **runtime** | **String** | | |
9
+ | **handler** | **String** | | |
10
+ | **revision_id** | **String** | | [optional] |
11
+ | **deployed_at** | **String** | | [optional] |
12
+ | **files** | [**Array&lt;GetFunctionCode200ResponseDataFilesInner&gt;**](GetFunctionCode200ResponseDataFilesInner.md) | | |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'rocket_stack_sdk'
18
+
19
+ instance = RocketStackSdk::GetFunctionCode200ResponseData.new(
20
+ source: null,
21
+ runtime: null,
22
+ handler: null,
23
+ revision_id: null,
24
+ deployed_at: null,
25
+ files: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,20 @@
1
+ # RocketStackSdk::GetFunctionCode200ResponseDataFilesInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | | |
8
+ | **content** | **String** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'rocket_stack_sdk'
14
+
15
+ instance = RocketStackSdk::GetFunctionCode200ResponseDataFilesInner.new(
16
+ name: null,
17
+ content: null
18
+ )
19
+ ```
20
+
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **request_id** | **String** | | |
8
- | **data** | [**GetMessageStatus200ResponseData**](GetMessageStatus200ResponseData.md) | | [optional] |
8
+ | **data** | [**ListQueueMessages200ResponseDataItemsInner**](ListQueueMessages200ResponseDataItemsInner.md) | | [optional] |
9
9
  | **error** | [**ListFunctions200ResponseError**](ListFunctions200ResponseError.md) | | [optional] |
10
10
 
11
11
  ## Example
@@ -1,4 +1,4 @@
1
- # RocketStackSdk::GetMessageStatus200ResponseData
1
+ # RocketStack::GetMessageStatus200ResponseData
2
2
 
3
3
  ## Properties
4
4
 
@@ -17,7 +17,7 @@
17
17
  ```ruby
18
18
  require 'rocket_stack_sdk'
19
19
 
20
- instance = RocketStackSdk::GetMessageStatus200ResponseData.new(
20
+ instance = RocketStack::GetMessageStatus200ResponseData.new(
21
21
  message_id: null,
22
22
  status: null,
23
23
  attempts: null,
@@ -5,8 +5,8 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **payload** | **Object** | | [optional] |
8
- | **invocation_type** | **String** | | [optional][default to &#39;RequestResponse&#39;] |
9
- | **include_logs** | **Boolean** | | [optional][default to false] |
8
+ | **invocation_type** | **String** | | [optional] |
9
+ | **include_logs** | **Boolean** | | [optional] |
10
10
 
11
11
  ## Example
12
12
 
data/docs/KvApi.md CHANGED
@@ -1,22 +1,22 @@
1
1
  # RocketStackSdk::KvApi
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
  | ------ | ------------ | ----------- |
7
- | [**delete_kv_item**](KvApi.md#delete_kv_item) | **DELETE** /kv/items/{key} | Delete a KV item |
8
- | [**get_kv_item**](KvApi.md#get_kv_item) | **GET** /kv/items/{key} | Get a KV item by key |
7
+ | [**delete_kv_item**](KvApi.md#delete_kv_item) | **DELETE** /kv/items/{wildcard} | Delete a KV item |
8
+ | [**get_kv_item**](KvApi.md#get_kv_item) | **GET** /kv/items/{wildcard} | Get a KV item by key |
9
9
  | [**list_kv_items**](KvApi.md#list_kv_items) | **GET** /kv/items | List KV items |
10
- | [**put_kv_item**](KvApi.md#put_kv_item) | **PUT** /kv/items/{key} | Create or update a KV item |
10
+ | [**put_kv_item**](KvApi.md#put_kv_item) | **PUT** /kv/items/{wildcard} | Create or update a KV item |
11
11
 
12
12
 
13
13
  ## delete_kv_item
14
14
 
15
- > <DeleteKvItem200Response> delete_kv_item(key)
15
+ > <DeleteKvItem200Response> delete_kv_item(wildcard)
16
16
 
17
17
  Delete a KV item
18
18
 
19
- Deletes a key-value item by key (single path segment).
19
+ Deletes a key-value item by key.
20
20
 
21
21
  ### Examples
22
22
 
@@ -30,11 +30,11 @@ RocketStackSdk.configure do |config|
30
30
  end
31
31
 
32
32
  api_instance = RocketStackSdk::KvApi.new
33
- key = 'key_example' # String |
33
+ wildcard = 'wildcard_example' # String |
34
34
 
35
35
  begin
36
36
  # Delete a KV item
37
- result = api_instance.delete_kv_item(key)
37
+ result = api_instance.delete_kv_item(wildcard)
38
38
  p result
39
39
  rescue RocketStackSdk::ApiError => e
40
40
  puts "Error when calling KvApi->delete_kv_item: #{e}"
@@ -45,12 +45,12 @@ end
45
45
 
46
46
  This returns an Array which contains the response data, status code and headers.
47
47
 
48
- > <Array(<DeleteKvItem200Response>, Integer, Hash)> delete_kv_item_with_http_info(key)
48
+ > <Array(<DeleteKvItem200Response>, Integer, Hash)> delete_kv_item_with_http_info(wildcard)
49
49
 
50
50
  ```ruby
51
51
  begin
52
52
  # Delete a KV item
53
- data, status_code, headers = api_instance.delete_kv_item_with_http_info(key)
53
+ data, status_code, headers = api_instance.delete_kv_item_with_http_info(wildcard)
54
54
  p status_code # => 2xx
55
55
  p headers # => { ... }
56
56
  p data # => <DeleteKvItem200Response>
@@ -63,7 +63,7 @@ end
63
63
 
64
64
  | Name | Type | Description | Notes |
65
65
  | ---- | ---- | ----------- | ----- |
66
- | **key** | **String** | | |
66
+ | **wildcard** | **String** | | |
67
67
 
68
68
  ### Return type
69
69
 
@@ -81,11 +81,11 @@ end
81
81
 
82
82
  ## get_kv_item
83
83
 
84
- > <GetKvItem200Response> get_kv_item(key)
84
+ > <GetKvItem200Response> get_kv_item(wildcard)
85
85
 
86
86
  Get a KV item by key
87
87
 
88
- Retrieves a single key-value item. The key is specified as a single path segment (slashes not supported in path).
88
+ Retrieves a single key-value item by key.
89
89
 
90
90
  ### Examples
91
91
 
@@ -99,11 +99,11 @@ RocketStackSdk.configure do |config|
99
99
  end
100
100
 
101
101
  api_instance = RocketStackSdk::KvApi.new
102
- key = 'key_example' # String |
102
+ wildcard = 'wildcard_example' # String |
103
103
 
104
104
  begin
105
105
  # Get a KV item by key
106
- result = api_instance.get_kv_item(key)
106
+ result = api_instance.get_kv_item(wildcard)
107
107
  p result
108
108
  rescue RocketStackSdk::ApiError => e
109
109
  puts "Error when calling KvApi->get_kv_item: #{e}"
@@ -114,12 +114,12 @@ end
114
114
 
115
115
  This returns an Array which contains the response data, status code and headers.
116
116
 
117
- > <Array(<GetKvItem200Response>, Integer, Hash)> get_kv_item_with_http_info(key)
117
+ > <Array(<GetKvItem200Response>, Integer, Hash)> get_kv_item_with_http_info(wildcard)
118
118
 
119
119
  ```ruby
120
120
  begin
121
121
  # Get a KV item by key
122
- data, status_code, headers = api_instance.get_kv_item_with_http_info(key)
122
+ data, status_code, headers = api_instance.get_kv_item_with_http_info(wildcard)
123
123
  p status_code # => 2xx
124
124
  p headers # => { ... }
125
125
  p data # => <GetKvItem200Response>
@@ -132,7 +132,7 @@ end
132
132
 
133
133
  | Name | Type | Description | Notes |
134
134
  | ---- | ---- | ----------- | ----- |
135
- | **key** | **String** | | |
135
+ | **wildcard** | **String** | | |
136
136
 
137
137
  ### Return type
138
138
 
@@ -206,7 +206,7 @@ end
206
206
  | Name | Type | Description | Notes |
207
207
  | ---- | ---- | ----------- | ----- |
208
208
  | **prefix** | **String** | | [optional] |
209
- | **limit** | **Integer** | | [optional][default to 50] |
209
+ | **limit** | **Integer** | | [optional] |
210
210
  | **cursor** | **String** | | [optional] |
211
211
 
212
212
  ### Return type
@@ -225,11 +225,11 @@ end
225
225
 
226
226
  ## put_kv_item
227
227
 
228
- > <PutKvItem200Response> put_kv_item(key, opts)
228
+ > <PutKvItem200Response> put_kv_item(wildcard, opts)
229
229
 
230
230
  Create or update a KV item
231
231
 
232
- Creates or updates a key-value item. Supports TTL and conditional writes via ifVersion. Key is a single path segment.
232
+ Creates or updates a key-value item. Supports TTL and conditional writes via ifVersion. Use ttlSeconds OR expiresAt, never both.
233
233
 
234
234
  ### Examples
235
235
 
@@ -243,14 +243,14 @@ RocketStackSdk.configure do |config|
243
243
  end
244
244
 
245
245
  api_instance = RocketStackSdk::KvApi.new
246
- key = 'key_example' # String |
246
+ wildcard = 'wildcard_example' # String |
247
247
  opts = {
248
248
  put_kv_item_request: RocketStackSdk::PutKvItemRequest.new # PutKvItemRequest |
249
249
  }
250
250
 
251
251
  begin
252
252
  # Create or update a KV item
253
- result = api_instance.put_kv_item(key, opts)
253
+ result = api_instance.put_kv_item(wildcard, opts)
254
254
  p result
255
255
  rescue RocketStackSdk::ApiError => e
256
256
  puts "Error when calling KvApi->put_kv_item: #{e}"
@@ -261,12 +261,12 @@ end
261
261
 
262
262
  This returns an Array which contains the response data, status code and headers.
263
263
 
264
- > <Array(<PutKvItem200Response>, Integer, Hash)> put_kv_item_with_http_info(key, opts)
264
+ > <Array(<PutKvItem200Response>, Integer, Hash)> put_kv_item_with_http_info(wildcard, opts)
265
265
 
266
266
  ```ruby
267
267
  begin
268
268
  # Create or update a KV item
269
- data, status_code, headers = api_instance.put_kv_item_with_http_info(key, opts)
269
+ data, status_code, headers = api_instance.put_kv_item_with_http_info(wildcard, opts)
270
270
  p status_code # => 2xx
271
271
  p headers # => { ... }
272
272
  p data # => <PutKvItem200Response>
@@ -279,7 +279,7 @@ end
279
279
 
280
280
  | Name | Type | Description | Notes |
281
281
  | ---- | ---- | ----------- | ----- |
282
- | **key** | **String** | | |
282
+ | **wildcard** | **String** | | |
283
283
  | **put_kv_item_request** | [**PutKvItemRequest**](PutKvItemRequest.md) | | [optional] |
284
284
 
285
285
  ### Return type
@@ -0,0 +1,22 @@
1
+ # RocketStackSdk::ListCronInvocations200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **request_id** | **String** | | |
8
+ | **data** | [**ListCronInvocations200ResponseData**](ListCronInvocations200ResponseData.md) | | [optional] |
9
+ | **error** | [**ListFunctions200ResponseError**](ListFunctions200ResponseError.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'rocket_stack_sdk'
15
+
16
+ instance = RocketStackSdk::ListCronInvocations200Response.new(
17
+ request_id: null,
18
+ data: null,
19
+ error: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,20 @@
1
+ # RocketStackSdk::ListCronInvocations200ResponseData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **items** | [**Array&lt;ListCronInvocations200ResponseDataItemsInner&gt;**](ListCronInvocations200ResponseDataItemsInner.md) | | |
8
+ | **next_cursor** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'rocket_stack_sdk'
14
+
15
+ instance = RocketStackSdk::ListCronInvocations200ResponseData.new(
16
+ items: null,
17
+ next_cursor: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,42 @@
1
+ # RocketStackSdk::ListCronInvocations200ResponseDataItemsInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **invocation_id** | **String** | | |
8
+ | **action** | **String** | | |
9
+ | **outcome** | **String** | | |
10
+ | **occurred_at** | **String** | | |
11
+ | **attempt** | **Float** | | [optional] |
12
+ | **duration_ms** | **Float** | | [optional] |
13
+ | **error** | **String** | | [optional] |
14
+ | **reason** | **String** | | [optional] |
15
+ | **trigger_id** | **String** | | [optional] |
16
+ | **target_type** | **String** | | [optional] |
17
+ | **trigger_source** | **String** | | [optional] |
18
+ | **status_code** | **Float** | | [optional] |
19
+ | **backoff_seconds** | **Float** | | [optional] |
20
+
21
+ ## Example
22
+
23
+ ```ruby
24
+ require 'rocket_stack_sdk'
25
+
26
+ instance = RocketStackSdk::ListCronInvocations200ResponseDataItemsInner.new(
27
+ invocation_id: null,
28
+ action: null,
29
+ outcome: null,
30
+ occurred_at: null,
31
+ attempt: null,
32
+ duration_ms: null,
33
+ error: null,
34
+ reason: null,
35
+ trigger_id: null,
36
+ target_type: null,
37
+ trigger_source: null,
38
+ status_code: null,
39
+ backoff_seconds: null
40
+ )
41
+ ```
42
+
@@ -0,0 +1,22 @@
1
+ # RocketStackSdk::ListQueueMessages200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **request_id** | **String** | | |
8
+ | **data** | [**ListQueueMessages200ResponseData**](ListQueueMessages200ResponseData.md) | | [optional] |
9
+ | **error** | [**ListFunctions200ResponseError**](ListFunctions200ResponseError.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'rocket_stack_sdk'
15
+
16
+ instance = RocketStackSdk::ListQueueMessages200Response.new(
17
+ request_id: null,
18
+ data: null,
19
+ error: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,20 @@
1
+ # RocketStackSdk::ListQueueMessages200ResponseData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **items** | [**Array&lt;ListQueueMessages200ResponseDataItemsInner&gt;**](ListQueueMessages200ResponseDataItemsInner.md) | | |
8
+ | **next_cursor** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'rocket_stack_sdk'
14
+
15
+ instance = RocketStackSdk::ListQueueMessages200ResponseData.new(
16
+ items: null,
17
+ next_cursor: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,32 @@
1
+ # RocketStackSdk::ListQueueMessages200ResponseDataItemsInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **message_id** | **String** | | |
8
+ | **status** | **String** | | |
9
+ | **attempts** | **Float** | | |
10
+ | **last_error** | **String** | | [optional] |
11
+ | **payload_size_bytes** | **Float** | | |
12
+ | **idempotency_key** | **String** | | [optional] |
13
+ | **created_at** | **String** | | |
14
+ | **updated_at** | **String** | | |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'rocket_stack_sdk'
20
+
21
+ instance = RocketStackSdk::ListQueueMessages200ResponseDataItemsInner.new(
22
+ message_id: null,
23
+ status: null,
24
+ attempts: null,
25
+ last_error: null,
26
+ payload_size_bytes: null,
27
+ idempotency_key: null,
28
+ created_at: null,
29
+ updated_at: null
30
+ )
31
+ ```
32
+
@@ -4,9 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **value** | **Object** | | [optional] |
8
- | **ttl_seconds** | **Integer** | | [optional] |
9
- | **expires_at** | **String** | | [optional] |
7
+ | **value** | **Object** | JSON value to store (max 64KB when serialized). | [optional] |
8
+ | **ttl_seconds** | **Integer** | Relative TTL in seconds (1-2592000). Mutually exclusive with expiresAt. | [optional] |
9
+ | **expires_at** | **Time** | Absolute expiration ISO 8601 datetime. Mutually exclusive with ttlSeconds. | [optional] |
10
10
  | **if_version** | [**PutKvItemRequestIfVersion**](PutKvItemRequestIfVersion.md) | | [optional] |
11
11
 
12
12
  ## Example
data/docs/QueuesApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # RocketStackSdk::QueuesApi
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
  | [**enqueue_message**](QueuesApi.md#enqueue_message) | **POST** /queues/{id}/messages | Enqueue a message |
10
10
  | [**get_message_status**](QueuesApi.md#get_message_status) | **GET** /queues/{id}/messages/{messageId} | Get message status |
11
11
  | [**get_queue**](QueuesApi.md#get_queue) | **GET** /queues/{id} | Get a queue by ID |
12
+ | [**list_queue_messages**](QueuesApi.md#list_queue_messages) | **GET** /queues/{id}/messages | List queue messages |
12
13
  | [**list_queues**](QueuesApi.md#list_queues) | **GET** /queues | List queues |
13
14
  | [**update_queue**](QueuesApi.md#update_queue) | **PATCH** /queues/{id} | Update a queue |
14
15
 
@@ -364,6 +365,83 @@ end
364
365
  - **Accept**: application/json
365
366
 
366
367
 
368
+ ## list_queue_messages
369
+
370
+ > <ListQueueMessages200Response> list_queue_messages(id, opts)
371
+
372
+ List queue messages
373
+
374
+ Returns a paginated list of message metadata for a queue. Payload content is not stored.
375
+
376
+ ### Examples
377
+
378
+ ```ruby
379
+ require 'time'
380
+ require 'rocket_stack_sdk'
381
+ # setup authorization
382
+ RocketStackSdk.configure do |config|
383
+ # Configure Bearer authorization (JWT): bearerAuth
384
+ config.access_token = 'YOUR_BEARER_TOKEN'
385
+ end
386
+
387
+ api_instance = RocketStackSdk::QueuesApi.new
388
+ id = 'id_example' # String |
389
+ opts = {
390
+ limit: 8.14, # Float |
391
+ cursor: 'cursor_example', # String |
392
+ status: 'enqueued' # String |
393
+ }
394
+
395
+ begin
396
+ # List queue messages
397
+ result = api_instance.list_queue_messages(id, opts)
398
+ p result
399
+ rescue RocketStackSdk::ApiError => e
400
+ puts "Error when calling QueuesApi->list_queue_messages: #{e}"
401
+ end
402
+ ```
403
+
404
+ #### Using the list_queue_messages_with_http_info variant
405
+
406
+ This returns an Array which contains the response data, status code and headers.
407
+
408
+ > <Array(<ListQueueMessages200Response>, Integer, Hash)> list_queue_messages_with_http_info(id, opts)
409
+
410
+ ```ruby
411
+ begin
412
+ # List queue messages
413
+ data, status_code, headers = api_instance.list_queue_messages_with_http_info(id, opts)
414
+ p status_code # => 2xx
415
+ p headers # => { ... }
416
+ p data # => <ListQueueMessages200Response>
417
+ rescue RocketStackSdk::ApiError => e
418
+ puts "Error when calling QueuesApi->list_queue_messages_with_http_info: #{e}"
419
+ end
420
+ ```
421
+
422
+ ### Parameters
423
+
424
+ | Name | Type | Description | Notes |
425
+ | ---- | ---- | ----------- | ----- |
426
+ | **id** | **String** | | |
427
+ | **limit** | **Float** | | [optional] |
428
+ | **cursor** | **String** | | [optional] |
429
+ | **status** | **String** | | [optional] |
430
+
431
+ ### Return type
432
+
433
+ [**ListQueueMessages200Response**](ListQueueMessages200Response.md)
434
+
435
+ ### Authorization
436
+
437
+ [bearerAuth](../README.md#bearerAuth)
438
+
439
+ ### HTTP request headers
440
+
441
+ - **Content-Type**: Not defined
442
+ - **Accept**: application/json
443
+
444
+
367
445
  ## list_queues
368
446
 
369
447
  > <ListQueues200Response> list_queues(opts)
@@ -420,7 +498,7 @@ end
420
498
 
421
499
  | Name | Type | Description | Notes |
422
500
  | ---- | ---- | ----------- | ----- |
423
- | **limit** | **Float** | | [optional][default to 50] |
501
+ | **limit** | **Float** | | [optional] |
424
502
  | **cursor** | **String** | | [optional] |
425
503
 
426
504
  ### Return type
data/docs/ResourcesApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # RocketStackSdk::ResourcesApi
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
  | ------ | ------------ | ----------- |