rocket_stack_sdk 1.0.1
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.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +226 -0
- data/Rakefile +10 -0
- data/docs/CreateCronJob201Response.md +22 -0
- data/docs/CreateCronJob201ResponseData.md +20 -0
- data/docs/CreateCronJobRequest.md +26 -0
- data/docs/CreateCronJobRequestDeliveryTarget.md +32 -0
- data/docs/CreateCronJobRequestSchedule.md +22 -0
- data/docs/CreateDownloadUrl200Response.md +22 -0
- data/docs/CreateDownloadUrl200ResponseData.md +24 -0
- data/docs/CreateDownloadUrlRequest.md +22 -0
- data/docs/CreateFunction202Response.md +22 -0
- data/docs/CreateFunction202ResponseData.md +20 -0
- data/docs/CreateQueue201Response.md +22 -0
- data/docs/CreateQueue201ResponseData.md +20 -0
- data/docs/CreateQueueRequest.md +26 -0
- data/docs/CreateQueueRequestDeliveryTarget.md +32 -0
- data/docs/CreateSchedule201Response.md +22 -0
- data/docs/CreateSchedule201ResponseData.md +20 -0
- data/docs/CreateScheduleRequest.md +26 -0
- data/docs/CronApi.md +365 -0
- data/docs/DeleteKvItem200Response.md +22 -0
- data/docs/DeleteKvItem200ResponseData.md +18 -0
- data/docs/EnqueueMessage201Response.md +22 -0
- data/docs/EnqueueMessage201ResponseData.md +20 -0
- data/docs/EnqueueMessageRequest.md +22 -0
- data/docs/FinalizeUpload200Response.md +22 -0
- data/docs/FinalizeUpload200ResponseData.md +24 -0
- data/docs/FinalizeUploadRequest.md +18 -0
- data/docs/FunctionsApi.md +463 -0
- data/docs/GetCronJob200Response.md +22 -0
- data/docs/GetFunction200Response.md +22 -0
- data/docs/GetKvItem200Response.md +22 -0
- data/docs/GetKvItem200ResponseData.md +24 -0
- data/docs/GetMessageStatus200Response.md +22 -0
- data/docs/GetMessageStatus200ResponseData.md +30 -0
- data/docs/GetQueue200Response.md +22 -0
- data/docs/GetSchedule200Response.md +22 -0
- data/docs/GetScheduleStatus200Response.md +22 -0
- data/docs/GetScheduleStatus200ResponseData.md +26 -0
- data/docs/GetTemplate200Response.md +22 -0
- data/docs/InvokeFunction200Response.md +22 -0
- data/docs/InvokeFunction200ResponseData.md +26 -0
- data/docs/InvokeFunctionRequest.md +22 -0
- data/docs/KvApi.md +297 -0
- data/docs/ListCapabilities200Response.md +22 -0
- data/docs/ListCapabilities200ResponseDataInner.md +22 -0
- data/docs/ListCronJobs200Response.md +22 -0
- data/docs/ListCronJobs200ResponseData.md +20 -0
- data/docs/ListCronJobs200ResponseDataItemsInner.md +36 -0
- data/docs/ListCronJobs200ResponseDataItemsInnerSchedule.md +24 -0
- data/docs/ListFunctions200Response.md +22 -0
- data/docs/ListFunctions200ResponseData.md +20 -0
- data/docs/ListFunctions200ResponseDataItemsInner.md +38 -0
- data/docs/ListFunctions200ResponseDataItemsInnerActualSpec.md +18 -0
- data/docs/ListFunctions200ResponseDataItemsInnerDesiredSpec.md +36 -0
- data/docs/ListFunctions200ResponseDataItemsInnerDesiredSpecCode.md +20 -0
- data/docs/ListFunctions200ResponseError.md +22 -0
- data/docs/ListFunctions401Response.md +20 -0
- data/docs/ListKvItems200Response.md +22 -0
- data/docs/ListKvItems200ResponseData.md +20 -0
- data/docs/ListKvItems200ResponseDataItemsInner.md +24 -0
- data/docs/ListQueues200Response.md +22 -0
- data/docs/ListQueues200ResponseData.md +20 -0
- data/docs/ListQueues200ResponseDataItemsInner.md +36 -0
- data/docs/ListQueues200ResponseDataItemsInnerDeliveryTarget.md +28 -0
- data/docs/ListSchedules200Response.md +22 -0
- data/docs/ListSchedules200ResponseData.md +20 -0
- data/docs/ListSchedules200ResponseDataItemsInner.md +36 -0
- data/docs/ListSnippets200Response.md +22 -0
- data/docs/ListSnippets200ResponseDataInner.md +28 -0
- data/docs/ListStorageObjects200Response.md +22 -0
- data/docs/ListStorageObjects200ResponseData.md +20 -0
- data/docs/ListStorageObjects200ResponseDataItemsInner.md +28 -0
- data/docs/ListTemplates200Response.md +22 -0
- data/docs/ListTemplates200ResponseDataInner.md +28 -0
- data/docs/PutKvItem200Response.md +22 -0
- data/docs/PutKvItem200ResponseData.md +22 -0
- data/docs/PutKvItemRequest.md +24 -0
- data/docs/PutKvItemRequestIfVersion.md +15 -0
- data/docs/QueuesApi.md +511 -0
- data/docs/ResourcesApi.md +290 -0
- data/docs/SchedulerApi.md +505 -0
- data/docs/StorageApi.md +447 -0
- data/docs/UpdateCronJob200Response.md +22 -0
- data/docs/UpdateCronJob200ResponseData.md +22 -0
- data/docs/UpdateCronJobRequest.md +24 -0
- data/docs/UpdateCronJobRequestSchedule.md +22 -0
- data/docs/UpdateFunctionRequest.md +30 -0
- data/docs/UpdateQueue200Response.md +22 -0
- data/docs/UpdateQueue200ResponseData.md +22 -0
- data/docs/UpdateQueueRequest.md +24 -0
- data/docs/UpdateSchedule200Response.md +22 -0
- data/docs/UpdateSchedule200ResponseData.md +22 -0
- data/docs/UpdateScheduleRequest.md +24 -0
- data/docs/UploadObject201Response.md +22 -0
- data/docs/UploadObject201ResponseData.md +26 -0
- data/git_push.sh +57 -0
- data/lib/rocket_stack_sdk/api/cron_api.rb +357 -0
- data/lib/rocket_stack_sdk/api/functions_api.rb +536 -0
- data/lib/rocket_stack_sdk/api/kv_api.rb +308 -0
- data/lib/rocket_stack_sdk/api/queues_api.rb +496 -0
- data/lib/rocket_stack_sdk/api/resources_api.rb +277 -0
- data/lib/rocket_stack_sdk/api/scheduler_api.rb +483 -0
- data/lib/rocket_stack_sdk/api/storage_api.rb +474 -0
- data/lib/rocket_stack_sdk/api_client.rb +397 -0
- data/lib/rocket_stack_sdk/api_error.rb +58 -0
- data/lib/rocket_stack_sdk/api_model_base.rb +88 -0
- data/lib/rocket_stack_sdk/configuration.rb +309 -0
- data/lib/rocket_stack_sdk/models/create_cron_job201_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/create_cron_job201_response_data.rb +190 -0
- data/lib/rocket_stack_sdk/models/create_cron_job_request.rb +265 -0
- data/lib/rocket_stack_sdk/models/create_cron_job_request_delivery_target.rb +343 -0
- data/lib/rocket_stack_sdk/models/create_cron_job_request_schedule.rb +227 -0
- data/lib/rocket_stack_sdk/models/create_download_url200_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/create_download_url200_response_data.rb +211 -0
- data/lib/rocket_stack_sdk/models/create_download_url_request.rb +228 -0
- data/lib/rocket_stack_sdk/models/create_function202_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/create_function202_response_data.rb +190 -0
- data/lib/rocket_stack_sdk/models/create_queue201_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/create_queue201_response_data.rb +190 -0
- data/lib/rocket_stack_sdk/models/create_queue_request.rb +313 -0
- data/lib/rocket_stack_sdk/models/create_queue_request_delivery_target.rb +343 -0
- data/lib/rocket_stack_sdk/models/create_schedule201_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/create_schedule201_response_data.rb +190 -0
- data/lib/rocket_stack_sdk/models/create_schedule_request.rb +265 -0
- data/lib/rocket_stack_sdk/models/delete_kv_item200_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/delete_kv_item200_response_data.rb +164 -0
- data/lib/rocket_stack_sdk/models/enqueue_message201_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/enqueue_message201_response_data.rb +190 -0
- data/lib/rocket_stack_sdk/models/enqueue_message_request.rb +213 -0
- data/lib/rocket_stack_sdk/models/finalize_upload200_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/finalize_upload200_response_data.rb +242 -0
- data/lib/rocket_stack_sdk/models/finalize_upload_request.rb +182 -0
- data/lib/rocket_stack_sdk/models/get_cron_job200_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/get_function200_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/get_kv_item200_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/get_kv_item200_response_data.rb +212 -0
- data/lib/rocket_stack_sdk/models/get_message_status200_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/get_message_status200_response_data.rb +303 -0
- data/lib/rocket_stack_sdk/models/get_queue200_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/get_schedule200_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/get_schedule_status200_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/get_schedule_status200_response_data.rb +240 -0
- data/lib/rocket_stack_sdk/models/get_template200_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/invoke_function200_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/invoke_function200_response_data.rb +201 -0
- data/lib/rocket_stack_sdk/models/invoke_function_request.rb +204 -0
- data/lib/rocket_stack_sdk/models/list_capabilities200_response.rb +184 -0
- data/lib/rocket_stack_sdk/models/list_capabilities200_response_data_inner.rb +216 -0
- data/lib/rocket_stack_sdk/models/list_cron_jobs200_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/list_cron_jobs200_response_data.rb +176 -0
- data/lib/rocket_stack_sdk/models/list_cron_jobs200_response_data_items_inner.rb +384 -0
- data/lib/rocket_stack_sdk/models/list_cron_jobs200_response_data_items_inner_schedule.rb +249 -0
- data/lib/rocket_stack_sdk/models/list_functions200_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/list_functions200_response_data.rb +176 -0
- data/lib/rocket_stack_sdk/models/list_functions200_response_data_items_inner.rb +393 -0
- data/lib/rocket_stack_sdk/models/list_functions200_response_data_items_inner_actual_spec.rb +164 -0
- data/lib/rocket_stack_sdk/models/list_functions200_response_data_items_inner_desired_spec.rb +352 -0
- data/lib/rocket_stack_sdk/models/list_functions200_response_data_items_inner_desired_spec_code.rb +174 -0
- data/lib/rocket_stack_sdk/models/list_functions200_response_error.rb +201 -0
- data/lib/rocket_stack_sdk/models/list_functions401_response.rb +190 -0
- data/lib/rocket_stack_sdk/models/list_kv_items200_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/list_kv_items200_response_data.rb +178 -0
- data/lib/rocket_stack_sdk/models/list_kv_items200_response_data_items_inner.rb +228 -0
- data/lib/rocket_stack_sdk/models/list_queues200_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/list_queues200_response_data.rb +176 -0
- data/lib/rocket_stack_sdk/models/list_queues200_response_data_items_inner.rb +381 -0
- data/lib/rocket_stack_sdk/models/list_queues200_response_data_items_inner_delivery_target.rb +267 -0
- data/lib/rocket_stack_sdk/models/list_schedules200_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/list_schedules200_response_data.rb +176 -0
- data/lib/rocket_stack_sdk/models/list_schedules200_response_data_items_inner.rb +384 -0
- data/lib/rocket_stack_sdk/models/list_snippets200_response.rb +184 -0
- data/lib/rocket_stack_sdk/models/list_snippets200_response_data_inner.rb +294 -0
- data/lib/rocket_stack_sdk/models/list_storage_objects200_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/list_storage_objects200_response_data.rb +178 -0
- data/lib/rocket_stack_sdk/models/list_storage_objects200_response_data_items_inner.rb +260 -0
- data/lib/rocket_stack_sdk/models/list_templates200_response.rb +184 -0
- data/lib/rocket_stack_sdk/models/list_templates200_response_data_inner.rb +262 -0
- data/lib/rocket_stack_sdk/models/put_kv_item200_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/put_kv_item200_response_data.rb +202 -0
- data/lib/rocket_stack_sdk/models/put_kv_item_request.rb +203 -0
- data/lib/rocket_stack_sdk/models/put_kv_item_request_if_version.rb +103 -0
- data/lib/rocket_stack_sdk/models/update_cron_job200_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/update_cron_job200_response_data.rb +216 -0
- data/lib/rocket_stack_sdk/models/update_cron_job_request.rb +177 -0
- data/lib/rocket_stack_sdk/models/update_cron_job_request_schedule.rb +220 -0
- data/lib/rocket_stack_sdk/models/update_function_request.rb +337 -0
- data/lib/rocket_stack_sdk/models/update_queue200_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/update_queue200_response_data.rb +216 -0
- data/lib/rocket_stack_sdk/models/update_queue_request.rb +258 -0
- data/lib/rocket_stack_sdk/models/update_schedule200_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/update_schedule200_response_data.rb +216 -0
- data/lib/rocket_stack_sdk/models/update_schedule_request.rb +177 -0
- data/lib/rocket_stack_sdk/models/upload_object201_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/upload_object201_response_data.rb +251 -0
- data/lib/rocket_stack_sdk/version.rb +15 -0
- data/lib/rocket_stack_sdk.rb +134 -0
- data/rocket_stack_sdk.gemspec +39 -0
- data/spec/api/cron_api_spec.rb +97 -0
- data/spec/api/functions_api_spec.rb +121 -0
- data/spec/api/kv_api_spec.rb +86 -0
- data/spec/api/queues_api_spec.rb +123 -0
- data/spec/api/resources_api_spec.rb +83 -0
- data/spec/api/scheduler_api_spec.rb +121 -0
- data/spec/api/storage_api_spec.rb +114 -0
- data/spec/models/create_cron_job201_response_data_spec.rb +42 -0
- data/spec/models/create_cron_job201_response_spec.rb +48 -0
- data/spec/models/create_cron_job_request_delivery_target_spec.rb +82 -0
- data/spec/models/create_cron_job_request_schedule_spec.rb +52 -0
- data/spec/models/create_cron_job_request_spec.rb +60 -0
- data/spec/models/create_download_url200_response_data_spec.rb +54 -0
- data/spec/models/create_download_url200_response_spec.rb +48 -0
- data/spec/models/create_download_url_request_spec.rb +48 -0
- data/spec/models/create_function202_response_data_spec.rb +42 -0
- data/spec/models/create_function202_response_spec.rb +48 -0
- data/spec/models/create_queue201_response_data_spec.rb +42 -0
- data/spec/models/create_queue201_response_spec.rb +48 -0
- data/spec/models/create_queue_request_delivery_target_spec.rb +82 -0
- data/spec/models/create_queue_request_spec.rb +60 -0
- data/spec/models/create_schedule201_response_data_spec.rb +42 -0
- data/spec/models/create_schedule201_response_spec.rb +48 -0
- data/spec/models/create_schedule_request_spec.rb +60 -0
- data/spec/models/delete_kv_item200_response_data_spec.rb +36 -0
- data/spec/models/delete_kv_item200_response_spec.rb +48 -0
- data/spec/models/enqueue_message201_response_data_spec.rb +42 -0
- data/spec/models/enqueue_message201_response_spec.rb +48 -0
- data/spec/models/enqueue_message_request_spec.rb +48 -0
- data/spec/models/finalize_upload200_response_data_spec.rb +54 -0
- data/spec/models/finalize_upload200_response_spec.rb +48 -0
- data/spec/models/finalize_upload_request_spec.rb +36 -0
- data/spec/models/get_cron_job200_response_spec.rb +48 -0
- data/spec/models/get_function200_response_spec.rb +48 -0
- data/spec/models/get_kv_item200_response_data_spec.rb +54 -0
- data/spec/models/get_kv_item200_response_spec.rb +48 -0
- data/spec/models/get_message_status200_response_data_spec.rb +72 -0
- data/spec/models/get_message_status200_response_spec.rb +48 -0
- data/spec/models/get_queue200_response_spec.rb +48 -0
- data/spec/models/get_schedule200_response_spec.rb +48 -0
- data/spec/models/get_schedule_status200_response_data_spec.rb +60 -0
- data/spec/models/get_schedule_status200_response_spec.rb +48 -0
- data/spec/models/get_template200_response_spec.rb +48 -0
- data/spec/models/invoke_function200_response_data_spec.rb +60 -0
- data/spec/models/invoke_function200_response_spec.rb +48 -0
- data/spec/models/invoke_function_request_spec.rb +52 -0
- data/spec/models/list_capabilities200_response_data_inner_spec.rb +48 -0
- data/spec/models/list_capabilities200_response_spec.rb +48 -0
- data/spec/models/list_cron_jobs200_response_data_items_inner_schedule_spec.rb +58 -0
- data/spec/models/list_cron_jobs200_response_data_items_inner_spec.rb +90 -0
- data/spec/models/list_cron_jobs200_response_data_spec.rb +42 -0
- data/spec/models/list_cron_jobs200_response_spec.rb +48 -0
- data/spec/models/list_functions200_response_data_items_inner_actual_spec_spec.rb +36 -0
- data/spec/models/list_functions200_response_data_items_inner_desired_spec_code_spec.rb +42 -0
- data/spec/models/list_functions200_response_data_items_inner_desired_spec_spec.rb +98 -0
- data/spec/models/list_functions200_response_data_items_inner_spec.rb +96 -0
- data/spec/models/list_functions200_response_data_spec.rb +42 -0
- data/spec/models/list_functions200_response_error_spec.rb +48 -0
- data/spec/models/list_functions200_response_spec.rb +48 -0
- data/spec/models/list_functions401_response_spec.rb +42 -0
- data/spec/models/list_kv_items200_response_data_items_inner_spec.rb +54 -0
- data/spec/models/list_kv_items200_response_data_spec.rb +42 -0
- data/spec/models/list_kv_items200_response_spec.rb +48 -0
- data/spec/models/list_queues200_response_data_items_inner_delivery_target_spec.rb +70 -0
- data/spec/models/list_queues200_response_data_items_inner_spec.rb +90 -0
- data/spec/models/list_queues200_response_data_spec.rb +42 -0
- data/spec/models/list_queues200_response_spec.rb +48 -0
- data/spec/models/list_schedules200_response_data_items_inner_spec.rb +90 -0
- data/spec/models/list_schedules200_response_data_spec.rb +42 -0
- data/spec/models/list_schedules200_response_spec.rb +48 -0
- data/spec/models/list_snippets200_response_data_inner_spec.rb +66 -0
- data/spec/models/list_snippets200_response_spec.rb +48 -0
- data/spec/models/list_storage_objects200_response_data_items_inner_spec.rb +66 -0
- data/spec/models/list_storage_objects200_response_data_spec.rb +42 -0
- data/spec/models/list_storage_objects200_response_spec.rb +48 -0
- data/spec/models/list_templates200_response_data_inner_spec.rb +66 -0
- data/spec/models/list_templates200_response_spec.rb +48 -0
- data/spec/models/put_kv_item200_response_data_spec.rb +48 -0
- data/spec/models/put_kv_item200_response_spec.rb +48 -0
- data/spec/models/put_kv_item_request_if_version_spec.rb +21 -0
- data/spec/models/put_kv_item_request_spec.rb +54 -0
- data/spec/models/update_cron_job200_response_data_spec.rb +48 -0
- data/spec/models/update_cron_job200_response_spec.rb +48 -0
- data/spec/models/update_cron_job_request_schedule_spec.rb +52 -0
- data/spec/models/update_cron_job_request_spec.rb +54 -0
- data/spec/models/update_function_request_spec.rb +76 -0
- data/spec/models/update_queue200_response_data_spec.rb +48 -0
- data/spec/models/update_queue200_response_spec.rb +48 -0
- data/spec/models/update_queue_request_spec.rb +54 -0
- data/spec/models/update_schedule200_response_data_spec.rb +48 -0
- data/spec/models/update_schedule200_response_spec.rb +48 -0
- data/spec/models/update_schedule_request_spec.rb +54 -0
- data/spec/models/upload_object201_response_data_spec.rb +60 -0
- data/spec/models/upload_object201_response_spec.rb +48 -0
- data/spec/spec_helper.rb +111 -0
- metadata +472 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 1de07f06ecc41602f5d37110e79528c0171c9cb9aaebe9fd2f926e9f639f008a
|
|
4
|
+
data.tar.gz: 8b0cee46900ff6c5799a5ecbbcfae560e9113db210124d695ab55f314d3a2589
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 44716387dedcc445bca3a48c887384ded2b581f0b24cfd6033e9092910c5bacc672455f2f8170e92f38a19f346dc166a38af02037c72a83d7118e5a857b365cf
|
|
7
|
+
data.tar.gz: e037bde51ba41ee7393ecd679090c9d3df20470d225e05491a009fa178b4bcf2b72025df81862132cd83e0268c859454af855a3c2329c6d49afed7c42ccb07cc
|
data/Gemfile
ADDED
data/README.md
ADDED
|
@@ -0,0 +1,226 @@
|
|
|
1
|
+
# rocket_stack_sdk
|
|
2
|
+
|
|
3
|
+
RocketStackSdk - the Ruby gem for the Rocketstack API
|
|
4
|
+
|
|
5
|
+
API for Functions, Queues, KV, Storage, Cron, and Scheduler.
|
|
6
|
+
|
|
7
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
|
+
|
|
9
|
+
- API version: 1.0.1
|
|
10
|
+
- Package version: 1.0.1
|
|
11
|
+
- Generator version: 7.19.0
|
|
12
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
13
|
+
|
|
14
|
+
## Installation
|
|
15
|
+
|
|
16
|
+
### Build a gem
|
|
17
|
+
|
|
18
|
+
To build the Ruby code into a gem:
|
|
19
|
+
|
|
20
|
+
```shell
|
|
21
|
+
gem build rocket_stack_sdk.gemspec
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Then either install the gem locally:
|
|
25
|
+
|
|
26
|
+
```shell
|
|
27
|
+
gem install ./rocket_stack_sdk-1.0.1.gem
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
(for development, run `gem install --dev ./rocket_stack_sdk-1.0.1.gem` to install the development dependencies)
|
|
31
|
+
|
|
32
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
33
|
+
|
|
34
|
+
Finally add this to the Gemfile:
|
|
35
|
+
|
|
36
|
+
gem 'rocket_stack_sdk', '~> 1.0.1'
|
|
37
|
+
|
|
38
|
+
### Install from Git
|
|
39
|
+
|
|
40
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
|
41
|
+
|
|
42
|
+
gem 'rocket_stack_sdk', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
|
43
|
+
|
|
44
|
+
### Include the Ruby code directly
|
|
45
|
+
|
|
46
|
+
Include the Ruby code directly using `-I` as follows:
|
|
47
|
+
|
|
48
|
+
```shell
|
|
49
|
+
ruby -Ilib script.rb
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Getting Started
|
|
53
|
+
|
|
54
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
|
55
|
+
|
|
56
|
+
```ruby
|
|
57
|
+
# Load the gem
|
|
58
|
+
require 'rocket_stack_sdk'
|
|
59
|
+
|
|
60
|
+
# Setup authorization
|
|
61
|
+
RocketStackSdk.configure do |config|
|
|
62
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
63
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
64
|
+
# Configure a proc to get access tokens in lieu of the static access_token configuration
|
|
65
|
+
config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' }
|
|
66
|
+
end
|
|
67
|
+
|
|
68
|
+
api_instance = RocketStackSdk::CronApi.new
|
|
69
|
+
create_cron_job_request = RocketStackSdk::CreateCronJobRequest.new({name: 'name_example', schedule: RocketStackSdk::CreateCronJobRequestSchedule.new({expression: 'expression_example'}), delivery_target: RocketStackSdk::CreateCronJobRequestDeliveryTarget.new({type: 'function'})}) # CreateCronJobRequest |
|
|
70
|
+
|
|
71
|
+
begin
|
|
72
|
+
#Create a new cron job
|
|
73
|
+
result = api_instance.create_cron_job(create_cron_job_request)
|
|
74
|
+
p result
|
|
75
|
+
rescue RocketStackSdk::ApiError => e
|
|
76
|
+
puts "Exception when calling CronApi->create_cron_job: #{e}"
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## Documentation for API Endpoints
|
|
82
|
+
|
|
83
|
+
All URIs are relative to *https://api.rocketstack.dev*
|
|
84
|
+
|
|
85
|
+
Class | Method | HTTP request | Description
|
|
86
|
+
------------ | ------------- | ------------- | -------------
|
|
87
|
+
*RocketStackSdk::CronApi* | [**create_cron_job**](docs/CronApi.md#create_cron_job) | **POST** /cron | Create a new cron job
|
|
88
|
+
*RocketStackSdk::CronApi* | [**delete_cron_job**](docs/CronApi.md#delete_cron_job) | **DELETE** /cron/{id} | Delete a cron job
|
|
89
|
+
*RocketStackSdk::CronApi* | [**get_cron_job**](docs/CronApi.md#get_cron_job) | **GET** /cron/{id} | Get a cron job by ID
|
|
90
|
+
*RocketStackSdk::CronApi* | [**list_cron_jobs**](docs/CronApi.md#list_cron_jobs) | **GET** /cron | List cron jobs
|
|
91
|
+
*RocketStackSdk::CronApi* | [**update_cron_job**](docs/CronApi.md#update_cron_job) | **PATCH** /cron/{id} | Update a cron job
|
|
92
|
+
*RocketStackSdk::FunctionsApi* | [**create_function**](docs/FunctionsApi.md#create_function) | **POST** /functions | Create a new function
|
|
93
|
+
*RocketStackSdk::FunctionsApi* | [**get_function**](docs/FunctionsApi.md#get_function) | **GET** /functions/{id} | Get a function by ID
|
|
94
|
+
*RocketStackSdk::FunctionsApi* | [**invoke_function**](docs/FunctionsApi.md#invoke_function) | **POST** /functions/{id}/invoke | Invoke a function
|
|
95
|
+
*RocketStackSdk::FunctionsApi* | [**list_functions**](docs/FunctionsApi.md#list_functions) | **GET** /functions | List functions
|
|
96
|
+
*RocketStackSdk::FunctionsApi* | [**update_function**](docs/FunctionsApi.md#update_function) | **PATCH** /functions/{id} | Update function settings
|
|
97
|
+
*RocketStackSdk::FunctionsApi* | [**update_function_code**](docs/FunctionsApi.md#update_function_code) | **POST** /functions/{id}/code | Update function code
|
|
98
|
+
*RocketStackSdk::KvApi* | [**delete_kv_item**](docs/KvApi.md#delete_kv_item) | **DELETE** /kv/items/{key} | Delete a KV item
|
|
99
|
+
*RocketStackSdk::KvApi* | [**get_kv_item**](docs/KvApi.md#get_kv_item) | **GET** /kv/items/{key} | Get a KV item by key
|
|
100
|
+
*RocketStackSdk::KvApi* | [**list_kv_items**](docs/KvApi.md#list_kv_items) | **GET** /kv/items | List KV items
|
|
101
|
+
*RocketStackSdk::KvApi* | [**put_kv_item**](docs/KvApi.md#put_kv_item) | **PUT** /kv/items/{key} | Create or update a KV item
|
|
102
|
+
*RocketStackSdk::QueuesApi* | [**create_queue**](docs/QueuesApi.md#create_queue) | **POST** /queues | Create a new queue
|
|
103
|
+
*RocketStackSdk::QueuesApi* | [**delete_queue**](docs/QueuesApi.md#delete_queue) | **DELETE** /queues/{id} | Delete a queue
|
|
104
|
+
*RocketStackSdk::QueuesApi* | [**enqueue_message**](docs/QueuesApi.md#enqueue_message) | **POST** /queues/{id}/messages | Enqueue a message
|
|
105
|
+
*RocketStackSdk::QueuesApi* | [**get_message_status**](docs/QueuesApi.md#get_message_status) | **GET** /queues/{id}/messages/{messageId} | Get message status
|
|
106
|
+
*RocketStackSdk::QueuesApi* | [**get_queue**](docs/QueuesApi.md#get_queue) | **GET** /queues/{id} | Get a queue by ID
|
|
107
|
+
*RocketStackSdk::QueuesApi* | [**list_queues**](docs/QueuesApi.md#list_queues) | **GET** /queues | List queues
|
|
108
|
+
*RocketStackSdk::QueuesApi* | [**update_queue**](docs/QueuesApi.md#update_queue) | **PATCH** /queues/{id} | Update a queue
|
|
109
|
+
*RocketStackSdk::ResourcesApi* | [**get_template**](docs/ResourcesApi.md#get_template) | **GET** /resources/templates/{id} | Get a template by id
|
|
110
|
+
*RocketStackSdk::ResourcesApi* | [**list_capabilities**](docs/ResourcesApi.md#list_capabilities) | **GET** /resources/capabilities | List app-generation capabilities
|
|
111
|
+
*RocketStackSdk::ResourcesApi* | [**list_snippets**](docs/ResourcesApi.md#list_snippets) | **GET** /resources/snippets | List code snippets
|
|
112
|
+
*RocketStackSdk::ResourcesApi* | [**list_templates**](docs/ResourcesApi.md#list_templates) | **GET** /resources/templates | List app templates
|
|
113
|
+
*RocketStackSdk::SchedulerApi* | [**cancel_schedule**](docs/SchedulerApi.md#cancel_schedule) | **POST** /schedules/{id}/cancel | Cancel a schedule
|
|
114
|
+
*RocketStackSdk::SchedulerApi* | [**create_schedule**](docs/SchedulerApi.md#create_schedule) | **POST** /schedules | Create a new one-off schedule
|
|
115
|
+
*RocketStackSdk::SchedulerApi* | [**delete_schedule**](docs/SchedulerApi.md#delete_schedule) | **DELETE** /schedules/{id} | Delete a schedule
|
|
116
|
+
*RocketStackSdk::SchedulerApi* | [**get_schedule**](docs/SchedulerApi.md#get_schedule) | **GET** /schedules/{id} | Get a schedule by ID
|
|
117
|
+
*RocketStackSdk::SchedulerApi* | [**get_schedule_status**](docs/SchedulerApi.md#get_schedule_status) | **GET** /schedules/{id}/status | Get schedule execution status
|
|
118
|
+
*RocketStackSdk::SchedulerApi* | [**list_schedules**](docs/SchedulerApi.md#list_schedules) | **GET** /schedules | List schedules
|
|
119
|
+
*RocketStackSdk::SchedulerApi* | [**update_schedule**](docs/SchedulerApi.md#update_schedule) | **PATCH** /schedules/{id} | Update a schedule
|
|
120
|
+
*RocketStackSdk::StorageApi* | [**create_download_url**](docs/StorageApi.md#create_download_url) | **POST** /storage/download-url | Create a presigned download URL
|
|
121
|
+
*RocketStackSdk::StorageApi* | [**delete_storage_object**](docs/StorageApi.md#delete_storage_object) | **DELETE** /storage/objects | Delete a storage object
|
|
122
|
+
*RocketStackSdk::StorageApi* | [**finalize_upload**](docs/StorageApi.md#finalize_upload) | **POST** /storage/finalize | Finalize an upload
|
|
123
|
+
*RocketStackSdk::StorageApi* | [**get_public_object**](docs/StorageApi.md#get_public_object) | **GET** /storage/public/objects/{tenantId}/{wildcard} | Get a public object
|
|
124
|
+
*RocketStackSdk::StorageApi* | [**list_storage_objects**](docs/StorageApi.md#list_storage_objects) | **GET** /storage/objects | List storage objects
|
|
125
|
+
*RocketStackSdk::StorageApi* | [**upload_object**](docs/StorageApi.md#upload_object) | **POST** /storage/objects | Upload an object
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
## Documentation for Models
|
|
129
|
+
|
|
130
|
+
- [RocketStackSdk::CreateCronJob201Response](docs/CreateCronJob201Response.md)
|
|
131
|
+
- [RocketStackSdk::CreateCronJob201ResponseData](docs/CreateCronJob201ResponseData.md)
|
|
132
|
+
- [RocketStackSdk::CreateCronJobRequest](docs/CreateCronJobRequest.md)
|
|
133
|
+
- [RocketStackSdk::CreateCronJobRequestDeliveryTarget](docs/CreateCronJobRequestDeliveryTarget.md)
|
|
134
|
+
- [RocketStackSdk::CreateCronJobRequestSchedule](docs/CreateCronJobRequestSchedule.md)
|
|
135
|
+
- [RocketStackSdk::CreateDownloadUrl200Response](docs/CreateDownloadUrl200Response.md)
|
|
136
|
+
- [RocketStackSdk::CreateDownloadUrl200ResponseData](docs/CreateDownloadUrl200ResponseData.md)
|
|
137
|
+
- [RocketStackSdk::CreateDownloadUrlRequest](docs/CreateDownloadUrlRequest.md)
|
|
138
|
+
- [RocketStackSdk::CreateFunction202Response](docs/CreateFunction202Response.md)
|
|
139
|
+
- [RocketStackSdk::CreateFunction202ResponseData](docs/CreateFunction202ResponseData.md)
|
|
140
|
+
- [RocketStackSdk::CreateQueue201Response](docs/CreateQueue201Response.md)
|
|
141
|
+
- [RocketStackSdk::CreateQueue201ResponseData](docs/CreateQueue201ResponseData.md)
|
|
142
|
+
- [RocketStackSdk::CreateQueueRequest](docs/CreateQueueRequest.md)
|
|
143
|
+
- [RocketStackSdk::CreateQueueRequestDeliveryTarget](docs/CreateQueueRequestDeliveryTarget.md)
|
|
144
|
+
- [RocketStackSdk::CreateSchedule201Response](docs/CreateSchedule201Response.md)
|
|
145
|
+
- [RocketStackSdk::CreateSchedule201ResponseData](docs/CreateSchedule201ResponseData.md)
|
|
146
|
+
- [RocketStackSdk::CreateScheduleRequest](docs/CreateScheduleRequest.md)
|
|
147
|
+
- [RocketStackSdk::DeleteKvItem200Response](docs/DeleteKvItem200Response.md)
|
|
148
|
+
- [RocketStackSdk::DeleteKvItem200ResponseData](docs/DeleteKvItem200ResponseData.md)
|
|
149
|
+
- [RocketStackSdk::EnqueueMessage201Response](docs/EnqueueMessage201Response.md)
|
|
150
|
+
- [RocketStackSdk::EnqueueMessage201ResponseData](docs/EnqueueMessage201ResponseData.md)
|
|
151
|
+
- [RocketStackSdk::EnqueueMessageRequest](docs/EnqueueMessageRequest.md)
|
|
152
|
+
- [RocketStackSdk::FinalizeUpload200Response](docs/FinalizeUpload200Response.md)
|
|
153
|
+
- [RocketStackSdk::FinalizeUpload200ResponseData](docs/FinalizeUpload200ResponseData.md)
|
|
154
|
+
- [RocketStackSdk::FinalizeUploadRequest](docs/FinalizeUploadRequest.md)
|
|
155
|
+
- [RocketStackSdk::GetCronJob200Response](docs/GetCronJob200Response.md)
|
|
156
|
+
- [RocketStackSdk::GetFunction200Response](docs/GetFunction200Response.md)
|
|
157
|
+
- [RocketStackSdk::GetKvItem200Response](docs/GetKvItem200Response.md)
|
|
158
|
+
- [RocketStackSdk::GetKvItem200ResponseData](docs/GetKvItem200ResponseData.md)
|
|
159
|
+
- [RocketStackSdk::GetMessageStatus200Response](docs/GetMessageStatus200Response.md)
|
|
160
|
+
- [RocketStackSdk::GetMessageStatus200ResponseData](docs/GetMessageStatus200ResponseData.md)
|
|
161
|
+
- [RocketStackSdk::GetQueue200Response](docs/GetQueue200Response.md)
|
|
162
|
+
- [RocketStackSdk::GetSchedule200Response](docs/GetSchedule200Response.md)
|
|
163
|
+
- [RocketStackSdk::GetScheduleStatus200Response](docs/GetScheduleStatus200Response.md)
|
|
164
|
+
- [RocketStackSdk::GetScheduleStatus200ResponseData](docs/GetScheduleStatus200ResponseData.md)
|
|
165
|
+
- [RocketStackSdk::GetTemplate200Response](docs/GetTemplate200Response.md)
|
|
166
|
+
- [RocketStackSdk::InvokeFunction200Response](docs/InvokeFunction200Response.md)
|
|
167
|
+
- [RocketStackSdk::InvokeFunction200ResponseData](docs/InvokeFunction200ResponseData.md)
|
|
168
|
+
- [RocketStackSdk::InvokeFunctionRequest](docs/InvokeFunctionRequest.md)
|
|
169
|
+
- [RocketStackSdk::ListCapabilities200Response](docs/ListCapabilities200Response.md)
|
|
170
|
+
- [RocketStackSdk::ListCapabilities200ResponseDataInner](docs/ListCapabilities200ResponseDataInner.md)
|
|
171
|
+
- [RocketStackSdk::ListCronJobs200Response](docs/ListCronJobs200Response.md)
|
|
172
|
+
- [RocketStackSdk::ListCronJobs200ResponseData](docs/ListCronJobs200ResponseData.md)
|
|
173
|
+
- [RocketStackSdk::ListCronJobs200ResponseDataItemsInner](docs/ListCronJobs200ResponseDataItemsInner.md)
|
|
174
|
+
- [RocketStackSdk::ListCronJobs200ResponseDataItemsInnerSchedule](docs/ListCronJobs200ResponseDataItemsInnerSchedule.md)
|
|
175
|
+
- [RocketStackSdk::ListFunctions200Response](docs/ListFunctions200Response.md)
|
|
176
|
+
- [RocketStackSdk::ListFunctions200ResponseData](docs/ListFunctions200ResponseData.md)
|
|
177
|
+
- [RocketStackSdk::ListFunctions200ResponseDataItemsInner](docs/ListFunctions200ResponseDataItemsInner.md)
|
|
178
|
+
- [RocketStackSdk::ListFunctions200ResponseDataItemsInnerActualSpec](docs/ListFunctions200ResponseDataItemsInnerActualSpec.md)
|
|
179
|
+
- [RocketStackSdk::ListFunctions200ResponseDataItemsInnerDesiredSpec](docs/ListFunctions200ResponseDataItemsInnerDesiredSpec.md)
|
|
180
|
+
- [RocketStackSdk::ListFunctions200ResponseDataItemsInnerDesiredSpecCode](docs/ListFunctions200ResponseDataItemsInnerDesiredSpecCode.md)
|
|
181
|
+
- [RocketStackSdk::ListFunctions200ResponseError](docs/ListFunctions200ResponseError.md)
|
|
182
|
+
- [RocketStackSdk::ListFunctions401Response](docs/ListFunctions401Response.md)
|
|
183
|
+
- [RocketStackSdk::ListKvItems200Response](docs/ListKvItems200Response.md)
|
|
184
|
+
- [RocketStackSdk::ListKvItems200ResponseData](docs/ListKvItems200ResponseData.md)
|
|
185
|
+
- [RocketStackSdk::ListKvItems200ResponseDataItemsInner](docs/ListKvItems200ResponseDataItemsInner.md)
|
|
186
|
+
- [RocketStackSdk::ListQueues200Response](docs/ListQueues200Response.md)
|
|
187
|
+
- [RocketStackSdk::ListQueues200ResponseData](docs/ListQueues200ResponseData.md)
|
|
188
|
+
- [RocketStackSdk::ListQueues200ResponseDataItemsInner](docs/ListQueues200ResponseDataItemsInner.md)
|
|
189
|
+
- [RocketStackSdk::ListQueues200ResponseDataItemsInnerDeliveryTarget](docs/ListQueues200ResponseDataItemsInnerDeliveryTarget.md)
|
|
190
|
+
- [RocketStackSdk::ListSchedules200Response](docs/ListSchedules200Response.md)
|
|
191
|
+
- [RocketStackSdk::ListSchedules200ResponseData](docs/ListSchedules200ResponseData.md)
|
|
192
|
+
- [RocketStackSdk::ListSchedules200ResponseDataItemsInner](docs/ListSchedules200ResponseDataItemsInner.md)
|
|
193
|
+
- [RocketStackSdk::ListSnippets200Response](docs/ListSnippets200Response.md)
|
|
194
|
+
- [RocketStackSdk::ListSnippets200ResponseDataInner](docs/ListSnippets200ResponseDataInner.md)
|
|
195
|
+
- [RocketStackSdk::ListStorageObjects200Response](docs/ListStorageObjects200Response.md)
|
|
196
|
+
- [RocketStackSdk::ListStorageObjects200ResponseData](docs/ListStorageObjects200ResponseData.md)
|
|
197
|
+
- [RocketStackSdk::ListStorageObjects200ResponseDataItemsInner](docs/ListStorageObjects200ResponseDataItemsInner.md)
|
|
198
|
+
- [RocketStackSdk::ListTemplates200Response](docs/ListTemplates200Response.md)
|
|
199
|
+
- [RocketStackSdk::ListTemplates200ResponseDataInner](docs/ListTemplates200ResponseDataInner.md)
|
|
200
|
+
- [RocketStackSdk::PutKvItem200Response](docs/PutKvItem200Response.md)
|
|
201
|
+
- [RocketStackSdk::PutKvItem200ResponseData](docs/PutKvItem200ResponseData.md)
|
|
202
|
+
- [RocketStackSdk::PutKvItemRequest](docs/PutKvItemRequest.md)
|
|
203
|
+
- [RocketStackSdk::PutKvItemRequestIfVersion](docs/PutKvItemRequestIfVersion.md)
|
|
204
|
+
- [RocketStackSdk::UpdateCronJob200Response](docs/UpdateCronJob200Response.md)
|
|
205
|
+
- [RocketStackSdk::UpdateCronJob200ResponseData](docs/UpdateCronJob200ResponseData.md)
|
|
206
|
+
- [RocketStackSdk::UpdateCronJobRequest](docs/UpdateCronJobRequest.md)
|
|
207
|
+
- [RocketStackSdk::UpdateCronJobRequestSchedule](docs/UpdateCronJobRequestSchedule.md)
|
|
208
|
+
- [RocketStackSdk::UpdateFunctionRequest](docs/UpdateFunctionRequest.md)
|
|
209
|
+
- [RocketStackSdk::UpdateQueue200Response](docs/UpdateQueue200Response.md)
|
|
210
|
+
- [RocketStackSdk::UpdateQueue200ResponseData](docs/UpdateQueue200ResponseData.md)
|
|
211
|
+
- [RocketStackSdk::UpdateQueueRequest](docs/UpdateQueueRequest.md)
|
|
212
|
+
- [RocketStackSdk::UpdateSchedule200Response](docs/UpdateSchedule200Response.md)
|
|
213
|
+
- [RocketStackSdk::UpdateSchedule200ResponseData](docs/UpdateSchedule200ResponseData.md)
|
|
214
|
+
- [RocketStackSdk::UpdateScheduleRequest](docs/UpdateScheduleRequest.md)
|
|
215
|
+
- [RocketStackSdk::UploadObject201Response](docs/UploadObject201Response.md)
|
|
216
|
+
- [RocketStackSdk::UploadObject201ResponseData](docs/UploadObject201ResponseData.md)
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
## Documentation for Authorization
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
Authentication schemes defined for the API:
|
|
223
|
+
### bearerAuth
|
|
224
|
+
|
|
225
|
+
- **Type**: Bearer authentication (JWT)
|
|
226
|
+
|
data/Rakefile
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# RocketStackSdk::CreateCronJob201Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **request_id** | **String** | | |
|
|
8
|
+
| **data** | [**CreateCronJob201ResponseData**](CreateCronJob201ResponseData.md) | | [optional] |
|
|
9
|
+
| **error** | [**ListFunctions200ResponseError**](ListFunctions200ResponseError.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'rocket_stack_sdk'
|
|
15
|
+
|
|
16
|
+
instance = RocketStackSdk::CreateCronJob201Response.new(
|
|
17
|
+
request_id: null,
|
|
18
|
+
data: null,
|
|
19
|
+
error: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# RocketStackSdk::CreateCronJob201ResponseData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **cron_job_id** | **String** | | |
|
|
8
|
+
| **status** | **String** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'rocket_stack_sdk'
|
|
14
|
+
|
|
15
|
+
instance = RocketStackSdk::CreateCronJob201ResponseData.new(
|
|
16
|
+
cron_job_id: null,
|
|
17
|
+
status: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# RocketStackSdk::CreateCronJobRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | | |
|
|
8
|
+
| **schedule** | [**CreateCronJobRequestSchedule**](CreateCronJobRequestSchedule.md) | | |
|
|
9
|
+
| **delivery_target** | [**CreateCronJobRequestDeliveryTarget**](CreateCronJobRequestDeliveryTarget.md) | | |
|
|
10
|
+
| **paused** | **Boolean** | | [optional] |
|
|
11
|
+
| **payload_template** | **Hash<String, Object>** | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'rocket_stack_sdk'
|
|
17
|
+
|
|
18
|
+
instance = RocketStackSdk::CreateCronJobRequest.new(
|
|
19
|
+
name: null,
|
|
20
|
+
schedule: null,
|
|
21
|
+
delivery_target: null,
|
|
22
|
+
paused: null,
|
|
23
|
+
payload_template: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# RocketStackSdk::CreateCronJobRequestDeliveryTarget
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | | |
|
|
8
|
+
| **function_id** | **String** | | [optional] |
|
|
9
|
+
| **webhook_url** | **String** | | [optional] |
|
|
10
|
+
| **webhook_headers** | **Hash<String, String>** | | [optional] |
|
|
11
|
+
| **timeout_seconds** | **Float** | | [optional][default to 10] |
|
|
12
|
+
| **max_in_flight** | **Float** | | [optional][default to 5] |
|
|
13
|
+
| **max_per_second** | **Float** | | [optional] |
|
|
14
|
+
| **retryable_status_codes** | **Array<Float>** | | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'rocket_stack_sdk'
|
|
20
|
+
|
|
21
|
+
instance = RocketStackSdk::CreateCronJobRequestDeliveryTarget.new(
|
|
22
|
+
type: null,
|
|
23
|
+
function_id: null,
|
|
24
|
+
webhook_url: null,
|
|
25
|
+
webhook_headers: null,
|
|
26
|
+
timeout_seconds: null,
|
|
27
|
+
max_in_flight: null,
|
|
28
|
+
max_per_second: null,
|
|
29
|
+
retryable_status_codes: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# RocketStackSdk::CreateCronJobRequestSchedule
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **expression** | **String** | | |
|
|
8
|
+
| **format** | **String** | | [optional][default to 'unix5'] |
|
|
9
|
+
| **timezone** | **String** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'rocket_stack_sdk'
|
|
15
|
+
|
|
16
|
+
instance = RocketStackSdk::CreateCronJobRequestSchedule.new(
|
|
17
|
+
expression: null,
|
|
18
|
+
format: null,
|
|
19
|
+
timezone: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# RocketStackSdk::CreateDownloadUrl200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **request_id** | **String** | | |
|
|
8
|
+
| **data** | [**CreateDownloadUrl200ResponseData**](CreateDownloadUrl200ResponseData.md) | | [optional] |
|
|
9
|
+
| **error** | [**ListFunctions200ResponseError**](ListFunctions200ResponseError.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'rocket_stack_sdk'
|
|
15
|
+
|
|
16
|
+
instance = RocketStackSdk::CreateDownloadUrl200Response.new(
|
|
17
|
+
request_id: null,
|
|
18
|
+
data: null,
|
|
19
|
+
error: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# RocketStackSdk::CreateDownloadUrl200ResponseData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **path** | **String** | | |
|
|
8
|
+
| **download_url** | **String** | | |
|
|
9
|
+
| **expires_at** | **Time** | | |
|
|
10
|
+
| **public_url** | **String** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'rocket_stack_sdk'
|
|
16
|
+
|
|
17
|
+
instance = RocketStackSdk::CreateDownloadUrl200ResponseData.new(
|
|
18
|
+
path: null,
|
|
19
|
+
download_url: null,
|
|
20
|
+
expires_at: null,
|
|
21
|
+
public_url: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# RocketStackSdk::CreateDownloadUrlRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **path** | **String** | | |
|
|
8
|
+
| **expires_in_seconds** | **Integer** | | [optional] |
|
|
9
|
+
| **public** | **Boolean** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'rocket_stack_sdk'
|
|
15
|
+
|
|
16
|
+
instance = RocketStackSdk::CreateDownloadUrlRequest.new(
|
|
17
|
+
path: null,
|
|
18
|
+
expires_in_seconds: null,
|
|
19
|
+
public: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# RocketStackSdk::CreateFunction202Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **request_id** | **String** | | |
|
|
8
|
+
| **data** | [**CreateFunction202ResponseData**](CreateFunction202ResponseData.md) | | [optional] |
|
|
9
|
+
| **error** | [**ListFunctions200ResponseError**](ListFunctions200ResponseError.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'rocket_stack_sdk'
|
|
15
|
+
|
|
16
|
+
instance = RocketStackSdk::CreateFunction202Response.new(
|
|
17
|
+
request_id: null,
|
|
18
|
+
data: null,
|
|
19
|
+
error: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# RocketStackSdk::CreateFunction202ResponseData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **resource_id** | **String** | | |
|
|
8
|
+
| **status** | **String** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'rocket_stack_sdk'
|
|
14
|
+
|
|
15
|
+
instance = RocketStackSdk::CreateFunction202ResponseData.new(
|
|
16
|
+
resource_id: null,
|
|
17
|
+
status: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# RocketStackSdk::CreateQueue201Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **request_id** | **String** | | |
|
|
8
|
+
| **data** | [**CreateQueue201ResponseData**](CreateQueue201ResponseData.md) | | [optional] |
|
|
9
|
+
| **error** | [**ListFunctions200ResponseError**](ListFunctions200ResponseError.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'rocket_stack_sdk'
|
|
15
|
+
|
|
16
|
+
instance = RocketStackSdk::CreateQueue201Response.new(
|
|
17
|
+
request_id: null,
|
|
18
|
+
data: null,
|
|
19
|
+
error: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# RocketStackSdk::CreateQueue201ResponseData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **queue_id** | **String** | | |
|
|
8
|
+
| **status** | **String** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'rocket_stack_sdk'
|
|
14
|
+
|
|
15
|
+
instance = RocketStackSdk::CreateQueue201ResponseData.new(
|
|
16
|
+
queue_id: null,
|
|
17
|
+
status: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# RocketStackSdk::CreateQueueRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | | |
|
|
8
|
+
| **visibility_timeout_seconds** | **Float** | | [optional] |
|
|
9
|
+
| **retention_seconds** | **Float** | | [optional] |
|
|
10
|
+
| **max_receive_count** | **Float** | | [optional] |
|
|
11
|
+
| **delivery_target** | [**CreateQueueRequestDeliveryTarget**](CreateQueueRequestDeliveryTarget.md) | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'rocket_stack_sdk'
|
|
17
|
+
|
|
18
|
+
instance = RocketStackSdk::CreateQueueRequest.new(
|
|
19
|
+
name: null,
|
|
20
|
+
visibility_timeout_seconds: null,
|
|
21
|
+
retention_seconds: null,
|
|
22
|
+
max_receive_count: null,
|
|
23
|
+
delivery_target: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# RocketStackSdk::CreateQueueRequestDeliveryTarget
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | | |
|
|
8
|
+
| **function_id** | **String** | | [optional] |
|
|
9
|
+
| **webhook_url** | **String** | | [optional] |
|
|
10
|
+
| **webhook_headers** | **Hash<String, String>** | | [optional] |
|
|
11
|
+
| **timeout_seconds** | **Float** | | [optional][default to 10] |
|
|
12
|
+
| **max_in_flight** | **Float** | | [optional][default to 10] |
|
|
13
|
+
| **max_per_second** | **Float** | | [optional] |
|
|
14
|
+
| **retryable_status_codes** | **Array<Float>** | | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'rocket_stack_sdk'
|
|
20
|
+
|
|
21
|
+
instance = RocketStackSdk::CreateQueueRequestDeliveryTarget.new(
|
|
22
|
+
type: null,
|
|
23
|
+
function_id: null,
|
|
24
|
+
webhook_url: null,
|
|
25
|
+
webhook_headers: null,
|
|
26
|
+
timeout_seconds: null,
|
|
27
|
+
max_in_flight: null,
|
|
28
|
+
max_per_second: null,
|
|
29
|
+
retryable_status_codes: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# RocketStackSdk::CreateSchedule201Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **request_id** | **String** | | |
|
|
8
|
+
| **data** | [**CreateSchedule201ResponseData**](CreateSchedule201ResponseData.md) | | [optional] |
|
|
9
|
+
| **error** | [**ListFunctions200ResponseError**](ListFunctions200ResponseError.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'rocket_stack_sdk'
|
|
15
|
+
|
|
16
|
+
instance = RocketStackSdk::CreateSchedule201Response.new(
|
|
17
|
+
request_id: null,
|
|
18
|
+
data: null,
|
|
19
|
+
error: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# RocketStackSdk::CreateSchedule201ResponseData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **schedule_id** | **String** | | |
|
|
8
|
+
| **status** | **String** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'rocket_stack_sdk'
|
|
14
|
+
|
|
15
|
+
instance = RocketStackSdk::CreateSchedule201ResponseData.new(
|
|
16
|
+
schedule_id: null,
|
|
17
|
+
status: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|