rocket_stack_sdk 1.0.3 → 1.0.5
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 +4 -4
- data/README.md +31 -13
- data/docs/CreateCronJob201ResponseData.md +3 -1
- data/docs/CreateCronJobRequestDeliveryTarget.md +9 -9
- data/docs/CreateCronJobRequestDeliveryTargetAnyOf.md +30 -0
- data/docs/CreateCronJobRequestDeliveryTargetAnyOf1.md +30 -0
- data/docs/CreateCronJobRequestSchedule.md +1 -1
- data/docs/CreateDownloadUrlRequest.md +1 -1
- data/docs/CreateQueueRequestDeliveryTarget.md +9 -9
- data/docs/CreateQueueRequestDeliveryTargetAnyOf.md +30 -0
- data/docs/CreateQueueRequestDeliveryTargetAnyOf1.md +30 -0
- data/docs/CreateScheduleRequest.md +1 -1
- data/docs/CronApi.md +85 -7
- data/docs/DeleteCronJob200Response.md +22 -0
- data/docs/DeleteCronJob200ResponseData.md +20 -0
- data/docs/FinalizeUploadRequest.md +1 -1
- data/docs/FunctionsApi.md +72 -2
- data/docs/GetFunctionCode200Response.md +22 -0
- data/docs/GetFunctionCode200ResponseData.md +28 -0
- data/docs/GetFunctionCode200ResponseDataFilesInner.md +20 -0
- data/docs/GetMessageStatus200Response.md +1 -1
- data/docs/GetMessageStatus200ResponseData.md +2 -2
- data/docs/InvokeFunctionRequest.md +2 -2
- data/docs/KvApi.md +26 -26
- data/docs/ListCronInvocations200Response.md +22 -0
- data/docs/ListCronInvocations200ResponseData.md +20 -0
- data/docs/ListCronInvocations200ResponseDataItemsInner.md +42 -0
- data/docs/ListQueueMessages200Response.md +22 -0
- data/docs/ListQueueMessages200ResponseData.md +20 -0
- data/docs/ListQueueMessages200ResponseDataItemsInner.md +32 -0
- data/docs/PutKvItemRequest.md +3 -3
- data/docs/QueuesApi.md +80 -2
- data/docs/ResourcesApi.md +1 -1
- data/docs/SchedulerApi.md +81 -3
- data/docs/StorageApi.md +5 -5
- data/docs/UpdateCronJobRequestSchedule.md +1 -1
- data/docs/UpdateScheduleRequest.md +1 -1
- data/lib/rocket_stack_sdk/api/cron_api.rb +92 -8
- data/lib/rocket_stack_sdk/api/functions_api.rb +68 -5
- data/lib/rocket_stack_sdk/api/kv_api.rb +38 -50
- data/lib/rocket_stack_sdk/api/queues_api.rb +89 -5
- data/lib/rocket_stack_sdk/api/resources_api.rb +3 -3
- data/lib/rocket_stack_sdk/api/scheduler_api.rb +89 -5
- data/lib/rocket_stack_sdk/api/storage_api.rb +9 -9
- data/lib/rocket_stack_sdk/api_client.rb +3 -3
- data/lib/rocket_stack_sdk/api_error.rb +3 -3
- data/lib/rocket_stack_sdk/api_model_base.rb +3 -3
- data/lib/rocket_stack_sdk/configuration.rb +5 -5
- data/lib/rocket_stack_sdk/models/create_cron_job201_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/create_cron_job201_response_data.rb +33 -7
- data/lib/rocket_stack_sdk/models/create_cron_job_request.rb +3 -3
- data/lib/rocket_stack_sdk/models/create_cron_job_request_delivery_target.rb +79 -319
- data/lib/rocket_stack_sdk/models/create_cron_job_request_delivery_target_any_of.rb +351 -0
- data/lib/rocket_stack_sdk/models/create_cron_job_request_delivery_target_any_of1.rb +351 -0
- data/lib/rocket_stack_sdk/models/create_cron_job_request_schedule.rb +3 -5
- data/lib/rocket_stack_sdk/models/create_download_url200_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/create_download_url200_response_data.rb +3 -3
- data/lib/rocket_stack_sdk/models/create_download_url_request.rb +4 -3
- data/lib/rocket_stack_sdk/models/create_function202_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/create_function202_response_data.rb +3 -3
- data/lib/rocket_stack_sdk/models/create_queue201_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/create_queue201_response_data.rb +3 -3
- data/lib/rocket_stack_sdk/models/create_queue_request.rb +3 -3
- data/lib/rocket_stack_sdk/models/create_queue_request_delivery_target.rb +79 -319
- data/lib/rocket_stack_sdk/models/create_queue_request_delivery_target_any_of.rb +351 -0
- data/lib/rocket_stack_sdk/models/create_queue_request_delivery_target_any_of1.rb +351 -0
- data/lib/rocket_stack_sdk/models/create_schedule201_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/create_schedule201_response_data.rb +3 -3
- data/lib/rocket_stack_sdk/models/create_schedule_request.rb +4 -3
- data/lib/rocket_stack_sdk/models/delete_cron_job200_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/delete_cron_job200_response_data.rb +190 -0
- data/lib/rocket_stack_sdk/models/delete_kv_item200_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/delete_kv_item200_response_data.rb +3 -3
- data/lib/rocket_stack_sdk/models/enqueue_message201_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/enqueue_message201_response_data.rb +3 -3
- data/lib/rocket_stack_sdk/models/enqueue_message_request.rb +3 -3
- data/lib/rocket_stack_sdk/models/finalize_upload200_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/finalize_upload200_response_data.rb +3 -3
- data/lib/rocket_stack_sdk/models/finalize_upload_request.rb +4 -3
- data/lib/rocket_stack_sdk/models/get_cron_job200_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/get_function200_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/get_function_code200_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/get_function_code200_response_data.rb +290 -0
- data/lib/rocket_stack_sdk/models/get_function_code200_response_data_files_inner.rb +190 -0
- data/lib/rocket_stack_sdk/models/get_kv_item200_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/get_kv_item200_response_data.rb +3 -3
- data/lib/rocket_stack_sdk/models/get_message_status200_response.rb +4 -4
- data/lib/rocket_stack_sdk/models/get_message_status200_response_data.rb +3 -3
- data/lib/rocket_stack_sdk/models/get_queue200_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/get_schedule200_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/get_schedule_status200_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/get_schedule_status200_response_data.rb +3 -3
- data/lib/rocket_stack_sdk/models/get_template200_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/invoke_function200_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/invoke_function200_response_data.rb +3 -3
- data/lib/rocket_stack_sdk/models/invoke_function_request.rb +3 -7
- data/lib/rocket_stack_sdk/models/list_capabilities200_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_capabilities200_response_data_inner.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_cron_invocations200_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/list_cron_invocations200_response_data.rb +176 -0
- data/lib/rocket_stack_sdk/models/list_cron_invocations200_response_data_items_inner.rb +347 -0
- data/lib/rocket_stack_sdk/models/list_cron_jobs200_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_cron_jobs200_response_data.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_cron_jobs200_response_data_items_inner.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_cron_jobs200_response_data_items_inner_schedule.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_functions200_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_functions200_response_data.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_functions200_response_data_items_inner.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_functions200_response_data_items_inner_actual_spec.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_functions200_response_data_items_inner_desired_spec.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_functions200_response_data_items_inner_desired_spec_code.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_functions200_response_error.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_functions401_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_kv_items200_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_kv_items200_response_data.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_kv_items200_response_data_items_inner.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_queue_messages200_response.rb +182 -0
- data/lib/rocket_stack_sdk/models/list_queue_messages200_response_data.rb +176 -0
- data/lib/rocket_stack_sdk/models/list_queue_messages200_response_data_items_inner.rb +312 -0
- data/lib/rocket_stack_sdk/models/list_queues200_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_queues200_response_data.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_queues200_response_data_items_inner.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_queues200_response_data_items_inner_delivery_target.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_schedules200_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_schedules200_response_data.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_schedules200_response_data_items_inner.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_snippets200_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_snippets200_response_data_inner.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_storage_objects200_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_storage_objects200_response_data.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_storage_objects200_response_data_items_inner.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_templates200_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/list_templates200_response_data_inner.rb +3 -3
- data/lib/rocket_stack_sdk/models/put_kv_item200_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/put_kv_item200_response_data.rb +3 -3
- data/lib/rocket_stack_sdk/models/put_kv_item_request.rb +7 -4
- data/lib/rocket_stack_sdk/models/put_kv_item_request_if_version.rb +4 -3
- data/lib/rocket_stack_sdk/models/update_cron_job200_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/update_cron_job200_response_data.rb +3 -3
- data/lib/rocket_stack_sdk/models/update_cron_job_request.rb +3 -3
- data/lib/rocket_stack_sdk/models/update_cron_job_request_schedule.rb +3 -5
- data/lib/rocket_stack_sdk/models/update_function_request.rb +3 -3
- data/lib/rocket_stack_sdk/models/update_queue200_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/update_queue200_response_data.rb +3 -3
- data/lib/rocket_stack_sdk/models/update_queue_request.rb +3 -3
- data/lib/rocket_stack_sdk/models/update_schedule200_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/update_schedule200_response_data.rb +3 -3
- data/lib/rocket_stack_sdk/models/update_schedule_request.rb +4 -3
- data/lib/rocket_stack_sdk/models/upload_object201_response.rb +3 -3
- data/lib/rocket_stack_sdk/models/upload_object201_response_data.rb +3 -3
- data/lib/rocket_stack_sdk/version.rb +4 -4
- data/lib/rocket_stack_sdk.rb +18 -4
- data/rocket_stack_sdk.gemspec +5 -5
- data/spec/models/create_cron_job_request_delivery_target_any_of1_spec.rb +76 -0
- data/spec/models/create_cron_job_request_delivery_target_any_of_spec.rb +76 -0
- data/spec/models/create_queue_request_delivery_target_any_of1_spec.rb +76 -0
- data/spec/models/create_queue_request_delivery_target_any_of_spec.rb +76 -0
- data/spec/models/delete_cron_job200_response_data_spec.rb +42 -0
- data/spec/models/delete_cron_job200_response_spec.rb +48 -0
- data/spec/models/get_function_code200_response_data_files_inner_spec.rb +42 -0
- data/spec/models/get_function_code200_response_data_spec.rb +74 -0
- data/spec/models/get_function_code200_response_spec.rb +48 -0
- data/spec/models/list_cron_invocations200_response_data_items_inner_spec.rb +112 -0
- data/spec/models/list_cron_invocations200_response_data_spec.rb +42 -0
- data/spec/models/list_cron_invocations200_response_spec.rb +48 -0
- data/spec/models/list_queue_messages200_response_data_items_inner_spec.rb +78 -0
- data/spec/models/list_queue_messages200_response_data_spec.rb +42 -0
- data/spec/models/list_queue_messages200_response_spec.rb +48 -0
- data/spec/spec_helper.rb +3 -3
- metadata +141 -81
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f824ef15b3d06ade80f09e6cb4a7e279fa1aebb768ade436288ade1c61133cc4
|
|
4
|
+
data.tar.gz: 9a06de49ad15a9eb991f777618c6dbbb12709e1b4dd780573d0cb6622c0815b9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 0c1cca011bf56a1b19129422129b21faf40ca955989ec6c5f421f73577f7ea3e1602ee2498e6e6f4ec4dd5357bdd49ebcd10673301782de3e1a8fce3f863b453
|
|
7
|
+
data.tar.gz: 0ec15a914a45b3f13f235f15073695eda4fa9fba2fdb2c737bc73e7890bc3a35f7c8bd52d1b818cf531195719e0973d763796969fc1f37c883d9d67499bd0a3a
|
data/README.md
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
# rocket_stack_sdk
|
|
2
2
|
|
|
3
|
-
RocketStackSdk - the Ruby gem for the Rocketstack API
|
|
3
|
+
RocketStackSdk - the Ruby gem for the Rocketstack Control Plane API
|
|
4
4
|
|
|
5
|
-
API for Functions, Queues, KV, Storage, Cron, and Scheduler.
|
|
5
|
+
Combined API for Functions, Queues, KV, Storage, Cron, and Scheduler.
|
|
6
6
|
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
8
|
|
|
9
|
-
- API version: 1.0.
|
|
10
|
-
- Package version: 1.0.
|
|
9
|
+
- API version: 1.0.0
|
|
10
|
+
- Package version: 1.0.5
|
|
11
11
|
- Generator version: 7.19.0
|
|
12
12
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
13
13
|
|
|
@@ -24,16 +24,16 @@ gem build rocket_stack_sdk.gemspec
|
|
|
24
24
|
Then either install the gem locally:
|
|
25
25
|
|
|
26
26
|
```shell
|
|
27
|
-
gem install ./rocket_stack_sdk-1.0.
|
|
27
|
+
gem install ./rocket_stack_sdk-1.0.5.gem
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
(for development, run `gem install --dev ./rocket_stack_sdk-1.0.
|
|
30
|
+
(for development, run `gem install --dev ./rocket_stack_sdk-1.0.5.gem` to install the development dependencies)
|
|
31
31
|
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
33
33
|
|
|
34
34
|
Finally add this to the Gemfile:
|
|
35
35
|
|
|
36
|
-
gem 'rocket_stack_sdk', '~> 1.0.
|
|
36
|
+
gem 'rocket_stack_sdk', '~> 1.0.5'
|
|
37
37
|
|
|
38
38
|
### Install from Git
|
|
39
39
|
|
|
@@ -66,7 +66,7 @@ RocketStackSdk.configure do |config|
|
|
|
66
66
|
end
|
|
67
67
|
|
|
68
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 |
|
|
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', function_id: 'function_id_example', webhook_url: 'webhook_url_example'})}) # CreateCronJobRequest |
|
|
70
70
|
|
|
71
71
|
begin
|
|
72
72
|
#Create a new cron job
|
|
@@ -80,30 +80,33 @@ end
|
|
|
80
80
|
|
|
81
81
|
## Documentation for API Endpoints
|
|
82
82
|
|
|
83
|
-
All URIs are relative to *https://api.rocketstack.
|
|
83
|
+
All URIs are relative to *https://api.rocketstack.sh*
|
|
84
84
|
|
|
85
85
|
Class | Method | HTTP request | Description
|
|
86
86
|
------------ | ------------- | ------------- | -------------
|
|
87
87
|
*RocketStackSdk::CronApi* | [**create_cron_job**](docs/CronApi.md#create_cron_job) | **POST** /cron | Create a new cron job
|
|
88
88
|
*RocketStackSdk::CronApi* | [**delete_cron_job**](docs/CronApi.md#delete_cron_job) | **DELETE** /cron/{id} | Delete a cron job
|
|
89
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_invocations**](docs/CronApi.md#list_cron_invocations) | **GET** /cron/{id}/invocations | List cron invocation history
|
|
90
91
|
*RocketStackSdk::CronApi* | [**list_cron_jobs**](docs/CronApi.md#list_cron_jobs) | **GET** /cron | List cron jobs
|
|
91
92
|
*RocketStackSdk::CronApi* | [**update_cron_job**](docs/CronApi.md#update_cron_job) | **PATCH** /cron/{id} | Update a cron job
|
|
92
93
|
*RocketStackSdk::FunctionsApi* | [**create_function**](docs/FunctionsApi.md#create_function) | **POST** /functions | Create a new function
|
|
93
94
|
*RocketStackSdk::FunctionsApi* | [**get_function**](docs/FunctionsApi.md#get_function) | **GET** /functions/{id} | Get a function by ID
|
|
95
|
+
*RocketStackSdk::FunctionsApi* | [**get_function_code**](docs/FunctionsApi.md#get_function_code) | **GET** /functions/{id}/code | Get function code
|
|
94
96
|
*RocketStackSdk::FunctionsApi* | [**invoke_function**](docs/FunctionsApi.md#invoke_function) | **POST** /functions/{id}/invoke | Invoke a function
|
|
95
97
|
*RocketStackSdk::FunctionsApi* | [**list_functions**](docs/FunctionsApi.md#list_functions) | **GET** /functions | List functions
|
|
96
98
|
*RocketStackSdk::FunctionsApi* | [**update_function**](docs/FunctionsApi.md#update_function) | **PATCH** /functions/{id} | Update function settings
|
|
97
99
|
*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/{
|
|
99
|
-
*RocketStackSdk::KvApi* | [**get_kv_item**](docs/KvApi.md#get_kv_item) | **GET** /kv/items/{
|
|
100
|
+
*RocketStackSdk::KvApi* | [**delete_kv_item**](docs/KvApi.md#delete_kv_item) | **DELETE** /kv/items/{wildcard} | Delete a KV item
|
|
101
|
+
*RocketStackSdk::KvApi* | [**get_kv_item**](docs/KvApi.md#get_kv_item) | **GET** /kv/items/{wildcard} | Get a KV item by key
|
|
100
102
|
*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/{
|
|
103
|
+
*RocketStackSdk::KvApi* | [**put_kv_item**](docs/KvApi.md#put_kv_item) | **PUT** /kv/items/{wildcard} | Create or update a KV item
|
|
102
104
|
*RocketStackSdk::QueuesApi* | [**create_queue**](docs/QueuesApi.md#create_queue) | **POST** /queues | Create a new queue
|
|
103
105
|
*RocketStackSdk::QueuesApi* | [**delete_queue**](docs/QueuesApi.md#delete_queue) | **DELETE** /queues/{id} | Delete a queue
|
|
104
106
|
*RocketStackSdk::QueuesApi* | [**enqueue_message**](docs/QueuesApi.md#enqueue_message) | **POST** /queues/{id}/messages | Enqueue a message
|
|
105
107
|
*RocketStackSdk::QueuesApi* | [**get_message_status**](docs/QueuesApi.md#get_message_status) | **GET** /queues/{id}/messages/{messageId} | Get message status
|
|
106
108
|
*RocketStackSdk::QueuesApi* | [**get_queue**](docs/QueuesApi.md#get_queue) | **GET** /queues/{id} | Get a queue by ID
|
|
109
|
+
*RocketStackSdk::QueuesApi* | [**list_queue_messages**](docs/QueuesApi.md#list_queue_messages) | **GET** /queues/{id}/messages | List queue messages
|
|
107
110
|
*RocketStackSdk::QueuesApi* | [**list_queues**](docs/QueuesApi.md#list_queues) | **GET** /queues | List queues
|
|
108
111
|
*RocketStackSdk::QueuesApi* | [**update_queue**](docs/QueuesApi.md#update_queue) | **PATCH** /queues/{id} | Update a queue
|
|
109
112
|
*RocketStackSdk::ResourcesApi* | [**get_template**](docs/ResourcesApi.md#get_template) | **GET** /resources/templates/{id} | Get a template by id
|
|
@@ -115,6 +118,7 @@ Class | Method | HTTP request | Description
|
|
|
115
118
|
*RocketStackSdk::SchedulerApi* | [**delete_schedule**](docs/SchedulerApi.md#delete_schedule) | **DELETE** /schedules/{id} | Delete a schedule
|
|
116
119
|
*RocketStackSdk::SchedulerApi* | [**get_schedule**](docs/SchedulerApi.md#get_schedule) | **GET** /schedules/{id} | Get a schedule by ID
|
|
117
120
|
*RocketStackSdk::SchedulerApi* | [**get_schedule_status**](docs/SchedulerApi.md#get_schedule_status) | **GET** /schedules/{id}/status | Get schedule execution status
|
|
121
|
+
*RocketStackSdk::SchedulerApi* | [**list_schedule_invocations**](docs/SchedulerApi.md#list_schedule_invocations) | **GET** /schedules/{id}/invocations | List schedule invocation history
|
|
118
122
|
*RocketStackSdk::SchedulerApi* | [**list_schedules**](docs/SchedulerApi.md#list_schedules) | **GET** /schedules | List schedules
|
|
119
123
|
*RocketStackSdk::SchedulerApi* | [**update_schedule**](docs/SchedulerApi.md#update_schedule) | **PATCH** /schedules/{id} | Update a schedule
|
|
120
124
|
*RocketStackSdk::StorageApi* | [**create_download_url**](docs/StorageApi.md#create_download_url) | **POST** /storage/download-url | Create a presigned download URL
|
|
@@ -131,6 +135,8 @@ Class | Method | HTTP request | Description
|
|
|
131
135
|
- [RocketStackSdk::CreateCronJob201ResponseData](docs/CreateCronJob201ResponseData.md)
|
|
132
136
|
- [RocketStackSdk::CreateCronJobRequest](docs/CreateCronJobRequest.md)
|
|
133
137
|
- [RocketStackSdk::CreateCronJobRequestDeliveryTarget](docs/CreateCronJobRequestDeliveryTarget.md)
|
|
138
|
+
- [RocketStackSdk::CreateCronJobRequestDeliveryTargetAnyOf](docs/CreateCronJobRequestDeliveryTargetAnyOf.md)
|
|
139
|
+
- [RocketStackSdk::CreateCronJobRequestDeliveryTargetAnyOf1](docs/CreateCronJobRequestDeliveryTargetAnyOf1.md)
|
|
134
140
|
- [RocketStackSdk::CreateCronJobRequestSchedule](docs/CreateCronJobRequestSchedule.md)
|
|
135
141
|
- [RocketStackSdk::CreateDownloadUrl200Response](docs/CreateDownloadUrl200Response.md)
|
|
136
142
|
- [RocketStackSdk::CreateDownloadUrl200ResponseData](docs/CreateDownloadUrl200ResponseData.md)
|
|
@@ -141,9 +147,13 @@ Class | Method | HTTP request | Description
|
|
|
141
147
|
- [RocketStackSdk::CreateQueue201ResponseData](docs/CreateQueue201ResponseData.md)
|
|
142
148
|
- [RocketStackSdk::CreateQueueRequest](docs/CreateQueueRequest.md)
|
|
143
149
|
- [RocketStackSdk::CreateQueueRequestDeliveryTarget](docs/CreateQueueRequestDeliveryTarget.md)
|
|
150
|
+
- [RocketStackSdk::CreateQueueRequestDeliveryTargetAnyOf](docs/CreateQueueRequestDeliveryTargetAnyOf.md)
|
|
151
|
+
- [RocketStackSdk::CreateQueueRequestDeliveryTargetAnyOf1](docs/CreateQueueRequestDeliveryTargetAnyOf1.md)
|
|
144
152
|
- [RocketStackSdk::CreateSchedule201Response](docs/CreateSchedule201Response.md)
|
|
145
153
|
- [RocketStackSdk::CreateSchedule201ResponseData](docs/CreateSchedule201ResponseData.md)
|
|
146
154
|
- [RocketStackSdk::CreateScheduleRequest](docs/CreateScheduleRequest.md)
|
|
155
|
+
- [RocketStackSdk::DeleteCronJob200Response](docs/DeleteCronJob200Response.md)
|
|
156
|
+
- [RocketStackSdk::DeleteCronJob200ResponseData](docs/DeleteCronJob200ResponseData.md)
|
|
147
157
|
- [RocketStackSdk::DeleteKvItem200Response](docs/DeleteKvItem200Response.md)
|
|
148
158
|
- [RocketStackSdk::DeleteKvItem200ResponseData](docs/DeleteKvItem200ResponseData.md)
|
|
149
159
|
- [RocketStackSdk::EnqueueMessage201Response](docs/EnqueueMessage201Response.md)
|
|
@@ -154,10 +164,12 @@ Class | Method | HTTP request | Description
|
|
|
154
164
|
- [RocketStackSdk::FinalizeUploadRequest](docs/FinalizeUploadRequest.md)
|
|
155
165
|
- [RocketStackSdk::GetCronJob200Response](docs/GetCronJob200Response.md)
|
|
156
166
|
- [RocketStackSdk::GetFunction200Response](docs/GetFunction200Response.md)
|
|
167
|
+
- [RocketStackSdk::GetFunctionCode200Response](docs/GetFunctionCode200Response.md)
|
|
168
|
+
- [RocketStackSdk::GetFunctionCode200ResponseData](docs/GetFunctionCode200ResponseData.md)
|
|
169
|
+
- [RocketStackSdk::GetFunctionCode200ResponseDataFilesInner](docs/GetFunctionCode200ResponseDataFilesInner.md)
|
|
157
170
|
- [RocketStackSdk::GetKvItem200Response](docs/GetKvItem200Response.md)
|
|
158
171
|
- [RocketStackSdk::GetKvItem200ResponseData](docs/GetKvItem200ResponseData.md)
|
|
159
172
|
- [RocketStackSdk::GetMessageStatus200Response](docs/GetMessageStatus200Response.md)
|
|
160
|
-
- [RocketStackSdk::GetMessageStatus200ResponseData](docs/GetMessageStatus200ResponseData.md)
|
|
161
173
|
- [RocketStackSdk::GetQueue200Response](docs/GetQueue200Response.md)
|
|
162
174
|
- [RocketStackSdk::GetSchedule200Response](docs/GetSchedule200Response.md)
|
|
163
175
|
- [RocketStackSdk::GetScheduleStatus200Response](docs/GetScheduleStatus200Response.md)
|
|
@@ -168,6 +180,9 @@ Class | Method | HTTP request | Description
|
|
|
168
180
|
- [RocketStackSdk::InvokeFunctionRequest](docs/InvokeFunctionRequest.md)
|
|
169
181
|
- [RocketStackSdk::ListCapabilities200Response](docs/ListCapabilities200Response.md)
|
|
170
182
|
- [RocketStackSdk::ListCapabilities200ResponseDataInner](docs/ListCapabilities200ResponseDataInner.md)
|
|
183
|
+
- [RocketStackSdk::ListCronInvocations200Response](docs/ListCronInvocations200Response.md)
|
|
184
|
+
- [RocketStackSdk::ListCronInvocations200ResponseData](docs/ListCronInvocations200ResponseData.md)
|
|
185
|
+
- [RocketStackSdk::ListCronInvocations200ResponseDataItemsInner](docs/ListCronInvocations200ResponseDataItemsInner.md)
|
|
171
186
|
- [RocketStackSdk::ListCronJobs200Response](docs/ListCronJobs200Response.md)
|
|
172
187
|
- [RocketStackSdk::ListCronJobs200ResponseData](docs/ListCronJobs200ResponseData.md)
|
|
173
188
|
- [RocketStackSdk::ListCronJobs200ResponseDataItemsInner](docs/ListCronJobs200ResponseDataItemsInner.md)
|
|
@@ -183,6 +198,9 @@ Class | Method | HTTP request | Description
|
|
|
183
198
|
- [RocketStackSdk::ListKvItems200Response](docs/ListKvItems200Response.md)
|
|
184
199
|
- [RocketStackSdk::ListKvItems200ResponseData](docs/ListKvItems200ResponseData.md)
|
|
185
200
|
- [RocketStackSdk::ListKvItems200ResponseDataItemsInner](docs/ListKvItems200ResponseDataItemsInner.md)
|
|
201
|
+
- [RocketStackSdk::ListQueueMessages200Response](docs/ListQueueMessages200Response.md)
|
|
202
|
+
- [RocketStackSdk::ListQueueMessages200ResponseData](docs/ListQueueMessages200ResponseData.md)
|
|
203
|
+
- [RocketStackSdk::ListQueueMessages200ResponseDataItemsInner](docs/ListQueueMessages200ResponseDataItemsInner.md)
|
|
186
204
|
- [RocketStackSdk::ListQueues200Response](docs/ListQueues200Response.md)
|
|
187
205
|
- [RocketStackSdk::ListQueues200ResponseData](docs/ListQueues200ResponseData.md)
|
|
188
206
|
- [RocketStackSdk::ListQueues200ResponseDataItemsInner](docs/ListQueues200ResponseDataItemsInner.md)
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **cron_job_id** | **String** | | |
|
|
8
8
|
| **status** | **String** | | |
|
|
9
|
+
| **schedule** | [**ListCronJobs200ResponseDataItemsInnerSchedule**](ListCronJobs200ResponseDataItemsInnerSchedule.md) | | |
|
|
9
10
|
|
|
10
11
|
## Example
|
|
11
12
|
|
|
@@ -14,7 +15,8 @@ require 'rocket_stack_sdk'
|
|
|
14
15
|
|
|
15
16
|
instance = RocketStackSdk::CreateCronJob201ResponseData.new(
|
|
16
17
|
cron_job_id: null,
|
|
17
|
-
status: null
|
|
18
|
+
status: null,
|
|
19
|
+
schedule: null
|
|
18
20
|
)
|
|
19
21
|
```
|
|
20
22
|
|
|
@@ -4,14 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **type** | **String** |
|
|
8
|
-
| **function_id** | **String** |
|
|
9
|
-
| **
|
|
10
|
-
| **
|
|
11
|
-
| **
|
|
12
|
-
| **max_in_flight** | **Float** | | [optional][default to 5] |
|
|
7
|
+
| **type** | **String** | Deliver to a RocketStack function. | |
|
|
8
|
+
| **function_id** | **String** | Function resource ID. Required when type is function. | |
|
|
9
|
+
| **webhook_headers** | **Hash<String, String>** | Optional webhook headers (max 10). Authorization, Cookie, Host, and Content-Length are forbidden. | [optional] |
|
|
10
|
+
| **timeout_seconds** | **Float** | | [optional] |
|
|
11
|
+
| **max_in_flight** | **Float** | | [optional] |
|
|
13
12
|
| **max_per_second** | **Float** | | [optional] |
|
|
14
|
-
| **retryable_status_codes** | **Array<Float>** |
|
|
13
|
+
| **retryable_status_codes** | **Array<Float>** | HTTP status codes that trigger delivery retries. | [optional] |
|
|
14
|
+
| **webhook_url** | **String** | HTTPS webhook URL. Must not contain credentials in the URL. | |
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -21,12 +21,12 @@ require 'rocket_stack_sdk'
|
|
|
21
21
|
instance = RocketStackSdk::CreateCronJobRequestDeliveryTarget.new(
|
|
22
22
|
type: null,
|
|
23
23
|
function_id: null,
|
|
24
|
-
webhook_url: null,
|
|
25
24
|
webhook_headers: null,
|
|
26
25
|
timeout_seconds: null,
|
|
27
26
|
max_in_flight: null,
|
|
28
27
|
max_per_second: null,
|
|
29
|
-
retryable_status_codes: null
|
|
28
|
+
retryable_status_codes: null,
|
|
29
|
+
webhook_url: null
|
|
30
30
|
)
|
|
31
31
|
```
|
|
32
32
|
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# RocketStackSdk::CreateCronJobRequestDeliveryTargetAnyOf
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | Deliver to a RocketStack function. | |
|
|
8
|
+
| **function_id** | **String** | Function resource ID. Required when type is function. | |
|
|
9
|
+
| **webhook_headers** | **Hash<String, String>** | Optional webhook headers (max 10). Authorization, Cookie, Host, and Content-Length are forbidden. | [optional] |
|
|
10
|
+
| **timeout_seconds** | **Float** | | [optional] |
|
|
11
|
+
| **max_in_flight** | **Float** | | [optional] |
|
|
12
|
+
| **max_per_second** | **Float** | | [optional] |
|
|
13
|
+
| **retryable_status_codes** | **Array<Float>** | HTTP status codes that trigger delivery retries. | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'rocket_stack_sdk'
|
|
19
|
+
|
|
20
|
+
instance = RocketStackSdk::CreateCronJobRequestDeliveryTargetAnyOf.new(
|
|
21
|
+
type: null,
|
|
22
|
+
function_id: null,
|
|
23
|
+
webhook_headers: null,
|
|
24
|
+
timeout_seconds: null,
|
|
25
|
+
max_in_flight: null,
|
|
26
|
+
max_per_second: null,
|
|
27
|
+
retryable_status_codes: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# RocketStackSdk::CreateCronJobRequestDeliveryTargetAnyOf1
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | Deliver to an HTTPS webhook. | |
|
|
8
|
+
| **webhook_url** | **String** | HTTPS webhook URL. Must not contain credentials in the URL. | |
|
|
9
|
+
| **webhook_headers** | **Hash<String, String>** | Optional webhook headers (max 10). Authorization, Cookie, Host, and Content-Length are forbidden. | [optional] |
|
|
10
|
+
| **timeout_seconds** | **Float** | | [optional] |
|
|
11
|
+
| **max_in_flight** | **Float** | | [optional] |
|
|
12
|
+
| **max_per_second** | **Float** | | [optional] |
|
|
13
|
+
| **retryable_status_codes** | **Array<Float>** | HTTP status codes that trigger delivery retries. | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'rocket_stack_sdk'
|
|
19
|
+
|
|
20
|
+
instance = RocketStackSdk::CreateCronJobRequestDeliveryTargetAnyOf1.new(
|
|
21
|
+
type: null,
|
|
22
|
+
webhook_url: null,
|
|
23
|
+
webhook_headers: null,
|
|
24
|
+
timeout_seconds: null,
|
|
25
|
+
max_in_flight: null,
|
|
26
|
+
max_per_second: null,
|
|
27
|
+
retryable_status_codes: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **expression** | **String** | | |
|
|
8
|
-
| **format** | **String** | | [optional]
|
|
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
|
-
| **path** | **String** |
|
|
7
|
+
| **path** | **String** | Object path without leading slash. Segments: letters, digits, dots, underscores, hyphens only. | |
|
|
8
8
|
| **expires_in_seconds** | **Integer** | | [optional] |
|
|
9
9
|
| **public** | **Boolean** | | [optional] |
|
|
10
10
|
|
|
@@ -4,14 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **type** | **String** |
|
|
8
|
-
| **function_id** | **String** |
|
|
9
|
-
| **
|
|
10
|
-
| **
|
|
11
|
-
| **
|
|
12
|
-
| **max_in_flight** | **Float** | | [optional][default to 10] |
|
|
7
|
+
| **type** | **String** | Deliver to a RocketStack function. | |
|
|
8
|
+
| **function_id** | **String** | Function resource ID. Required when type is function. | |
|
|
9
|
+
| **webhook_headers** | **Hash<String, String>** | Optional webhook headers (max 10). Authorization, Cookie, Host, and Content-Length are forbidden. | [optional] |
|
|
10
|
+
| **timeout_seconds** | **Float** | | [optional] |
|
|
11
|
+
| **max_in_flight** | **Float** | | [optional] |
|
|
13
12
|
| **max_per_second** | **Float** | | [optional] |
|
|
14
|
-
| **retryable_status_codes** | **Array<Float>** |
|
|
13
|
+
| **retryable_status_codes** | **Array<Float>** | HTTP status codes that trigger delivery retries. | [optional] |
|
|
14
|
+
| **webhook_url** | **String** | HTTPS webhook URL. Must not contain credentials in the URL. | |
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -21,12 +21,12 @@ require 'rocket_stack_sdk'
|
|
|
21
21
|
instance = RocketStackSdk::CreateQueueRequestDeliveryTarget.new(
|
|
22
22
|
type: null,
|
|
23
23
|
function_id: null,
|
|
24
|
-
webhook_url: null,
|
|
25
24
|
webhook_headers: null,
|
|
26
25
|
timeout_seconds: null,
|
|
27
26
|
max_in_flight: null,
|
|
28
27
|
max_per_second: null,
|
|
29
|
-
retryable_status_codes: null
|
|
28
|
+
retryable_status_codes: null,
|
|
29
|
+
webhook_url: null
|
|
30
30
|
)
|
|
31
31
|
```
|
|
32
32
|
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# RocketStackSdk::CreateQueueRequestDeliveryTargetAnyOf
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | Deliver to a RocketStack function. | |
|
|
8
|
+
| **function_id** | **String** | Function resource ID. Required when type is function. | |
|
|
9
|
+
| **webhook_headers** | **Hash<String, String>** | Optional webhook headers (max 10). Authorization, Cookie, Host, and Content-Length are forbidden. | [optional] |
|
|
10
|
+
| **timeout_seconds** | **Float** | | [optional] |
|
|
11
|
+
| **max_in_flight** | **Float** | | [optional] |
|
|
12
|
+
| **max_per_second** | **Float** | | [optional] |
|
|
13
|
+
| **retryable_status_codes** | **Array<Float>** | HTTP status codes that trigger delivery retries. | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'rocket_stack_sdk'
|
|
19
|
+
|
|
20
|
+
instance = RocketStackSdk::CreateQueueRequestDeliveryTargetAnyOf.new(
|
|
21
|
+
type: null,
|
|
22
|
+
function_id: null,
|
|
23
|
+
webhook_headers: null,
|
|
24
|
+
timeout_seconds: null,
|
|
25
|
+
max_in_flight: null,
|
|
26
|
+
max_per_second: null,
|
|
27
|
+
retryable_status_codes: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# RocketStackSdk::CreateQueueRequestDeliveryTargetAnyOf1
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | Deliver to an HTTPS webhook. | |
|
|
8
|
+
| **webhook_url** | **String** | HTTPS webhook URL. Must not contain credentials in the URL. | |
|
|
9
|
+
| **webhook_headers** | **Hash<String, String>** | Optional webhook headers (max 10). Authorization, Cookie, Host, and Content-Length are forbidden. | [optional] |
|
|
10
|
+
| **timeout_seconds** | **Float** | | [optional] |
|
|
11
|
+
| **max_in_flight** | **Float** | | [optional] |
|
|
12
|
+
| **max_per_second** | **Float** | | [optional] |
|
|
13
|
+
| **retryable_status_codes** | **Array<Float>** | HTTP status codes that trigger delivery retries. | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'rocket_stack_sdk'
|
|
19
|
+
|
|
20
|
+
instance = RocketStackSdk::CreateQueueRequestDeliveryTargetAnyOf1.new(
|
|
21
|
+
type: null,
|
|
22
|
+
webhook_url: null,
|
|
23
|
+
webhook_headers: null,
|
|
24
|
+
timeout_seconds: null,
|
|
25
|
+
max_in_flight: null,
|
|
26
|
+
max_per_second: null,
|
|
27
|
+
retryable_status_codes: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **name** | **String** | | |
|
|
8
|
-
| **run_at** | **String** |
|
|
8
|
+
| **run_at** | **String** | RFC 3339 datetime with timezone (e.g. 2026-03-15T14:30:00Z). Must be in the future (max 365 days). | |
|
|
9
9
|
| **delivery_target** | [**CreateCronJobRequestDeliveryTarget**](CreateCronJobRequestDeliveryTarget.md) | | |
|
|
10
10
|
| **paused** | **Boolean** | | [optional] |
|
|
11
11
|
| **payload_template** | **Hash<String, Object>** | | [optional] |
|
data/docs/CronApi.md
CHANGED
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
# RocketStackSdk::CronApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://api.rocketstack.
|
|
3
|
+
All URIs are relative to *https://api.rocketstack.sh*
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
7
|
| [**create_cron_job**](CronApi.md#create_cron_job) | **POST** /cron | Create a new cron job |
|
|
8
8
|
| [**delete_cron_job**](CronApi.md#delete_cron_job) | **DELETE** /cron/{id} | Delete a cron job |
|
|
9
9
|
| [**get_cron_job**](CronApi.md#get_cron_job) | **GET** /cron/{id} | Get a cron job by ID |
|
|
10
|
+
| [**list_cron_invocations**](CronApi.md#list_cron_invocations) | **GET** /cron/{id}/invocations | List cron invocation history |
|
|
10
11
|
| [**list_cron_jobs**](CronApi.md#list_cron_jobs) | **GET** /cron | List cron jobs |
|
|
11
12
|
| [**update_cron_job**](CronApi.md#update_cron_job) | **PATCH** /cron/{id} | Update a cron job |
|
|
12
13
|
|
|
@@ -31,7 +32,7 @@ RocketStackSdk.configure do |config|
|
|
|
31
32
|
end
|
|
32
33
|
|
|
33
34
|
api_instance = RocketStackSdk::CronApi.new
|
|
34
|
-
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 |
|
|
35
|
+
create_cron_job_request = RocketStackSdk::CreateCronJobRequest.new({name: 'name_example', schedule: RocketStackSdk::CreateCronJobRequestSchedule.new({expression: 'expression_example'}), delivery_target: RocketStackSdk::CreateCronJobRequestDeliveryTarget.new({type: 'function', function_id: 'function_id_example', webhook_url: 'webhook_url_example'})}) # CreateCronJobRequest |
|
|
35
36
|
|
|
36
37
|
begin
|
|
37
38
|
# Create a new cron job
|
|
@@ -82,7 +83,7 @@ end
|
|
|
82
83
|
|
|
83
84
|
## delete_cron_job
|
|
84
85
|
|
|
85
|
-
> <
|
|
86
|
+
> <DeleteCronJob200Response> delete_cron_job(id)
|
|
86
87
|
|
|
87
88
|
Delete a cron job
|
|
88
89
|
|
|
@@ -115,7 +116,7 @@ end
|
|
|
115
116
|
|
|
116
117
|
This returns an Array which contains the response data, status code and headers.
|
|
117
118
|
|
|
118
|
-
> <Array(<
|
|
119
|
+
> <Array(<DeleteCronJob200Response>, Integer, Hash)> delete_cron_job_with_http_info(id)
|
|
119
120
|
|
|
120
121
|
```ruby
|
|
121
122
|
begin
|
|
@@ -123,7 +124,7 @@ begin
|
|
|
123
124
|
data, status_code, headers = api_instance.delete_cron_job_with_http_info(id)
|
|
124
125
|
p status_code # => 2xx
|
|
125
126
|
p headers # => { ... }
|
|
126
|
-
p data # => <
|
|
127
|
+
p data # => <DeleteCronJob200Response>
|
|
127
128
|
rescue RocketStackSdk::ApiError => e
|
|
128
129
|
puts "Error when calling CronApi->delete_cron_job_with_http_info: #{e}"
|
|
129
130
|
end
|
|
@@ -137,7 +138,7 @@ end
|
|
|
137
138
|
|
|
138
139
|
### Return type
|
|
139
140
|
|
|
140
|
-
[**
|
|
141
|
+
[**DeleteCronJob200Response**](DeleteCronJob200Response.md)
|
|
141
142
|
|
|
142
143
|
### Authorization
|
|
143
144
|
|
|
@@ -218,6 +219,83 @@ end
|
|
|
218
219
|
- **Accept**: application/json
|
|
219
220
|
|
|
220
221
|
|
|
222
|
+
## list_cron_invocations
|
|
223
|
+
|
|
224
|
+
> <ListCronInvocations200Response> list_cron_invocations(id, opts)
|
|
225
|
+
|
|
226
|
+
List cron invocation history
|
|
227
|
+
|
|
228
|
+
Returns a paginated list of delivery attempts and outcomes for a cron job.
|
|
229
|
+
|
|
230
|
+
### Examples
|
|
231
|
+
|
|
232
|
+
```ruby
|
|
233
|
+
require 'time'
|
|
234
|
+
require 'rocket_stack_sdk'
|
|
235
|
+
# setup authorization
|
|
236
|
+
RocketStackSdk.configure do |config|
|
|
237
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
238
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
239
|
+
end
|
|
240
|
+
|
|
241
|
+
api_instance = RocketStackSdk::CronApi.new
|
|
242
|
+
id = 'id_example' # String |
|
|
243
|
+
opts = {
|
|
244
|
+
limit: 8.14, # Float |
|
|
245
|
+
cursor: 'cursor_example', # String |
|
|
246
|
+
outcome: 'delivered' # String |
|
|
247
|
+
}
|
|
248
|
+
|
|
249
|
+
begin
|
|
250
|
+
# List cron invocation history
|
|
251
|
+
result = api_instance.list_cron_invocations(id, opts)
|
|
252
|
+
p result
|
|
253
|
+
rescue RocketStackSdk::ApiError => e
|
|
254
|
+
puts "Error when calling CronApi->list_cron_invocations: #{e}"
|
|
255
|
+
end
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
#### Using the list_cron_invocations_with_http_info variant
|
|
259
|
+
|
|
260
|
+
This returns an Array which contains the response data, status code and headers.
|
|
261
|
+
|
|
262
|
+
> <Array(<ListCronInvocations200Response>, Integer, Hash)> list_cron_invocations_with_http_info(id, opts)
|
|
263
|
+
|
|
264
|
+
```ruby
|
|
265
|
+
begin
|
|
266
|
+
# List cron invocation history
|
|
267
|
+
data, status_code, headers = api_instance.list_cron_invocations_with_http_info(id, opts)
|
|
268
|
+
p status_code # => 2xx
|
|
269
|
+
p headers # => { ... }
|
|
270
|
+
p data # => <ListCronInvocations200Response>
|
|
271
|
+
rescue RocketStackSdk::ApiError => e
|
|
272
|
+
puts "Error when calling CronApi->list_cron_invocations_with_http_info: #{e}"
|
|
273
|
+
end
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
### Parameters
|
|
277
|
+
|
|
278
|
+
| Name | Type | Description | Notes |
|
|
279
|
+
| ---- | ---- | ----------- | ----- |
|
|
280
|
+
| **id** | **String** | | |
|
|
281
|
+
| **limit** | **Float** | | [optional] |
|
|
282
|
+
| **cursor** | **String** | | [optional] |
|
|
283
|
+
| **outcome** | **String** | | [optional] |
|
|
284
|
+
|
|
285
|
+
### Return type
|
|
286
|
+
|
|
287
|
+
[**ListCronInvocations200Response**](ListCronInvocations200Response.md)
|
|
288
|
+
|
|
289
|
+
### Authorization
|
|
290
|
+
|
|
291
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
292
|
+
|
|
293
|
+
### HTTP request headers
|
|
294
|
+
|
|
295
|
+
- **Content-Type**: Not defined
|
|
296
|
+
- **Accept**: application/json
|
|
297
|
+
|
|
298
|
+
|
|
221
299
|
## list_cron_jobs
|
|
222
300
|
|
|
223
301
|
> <ListCronJobs200Response> list_cron_jobs(opts)
|
|
@@ -274,7 +352,7 @@ end
|
|
|
274
352
|
|
|
275
353
|
| Name | Type | Description | Notes |
|
|
276
354
|
| ---- | ---- | ----------- | ----- |
|
|
277
|
-
| **limit** | **Float** | | [optional]
|
|
355
|
+
| **limit** | **Float** | | [optional] |
|
|
278
356
|
| **cursor** | **String** | | [optional] |
|
|
279
357
|
|
|
280
358
|
### Return type
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# RocketStackSdk::DeleteCronJob200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **request_id** | **String** | | |
|
|
8
|
+
| **data** | [**DeleteCronJob200ResponseData**](DeleteCronJob200ResponseData.md) | | [optional] |
|
|
9
|
+
| **error** | [**ListFunctions200ResponseError**](ListFunctions200ResponseError.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'rocket_stack_sdk'
|
|
15
|
+
|
|
16
|
+
instance = RocketStackSdk::DeleteCronJob200Response.new(
|
|
17
|
+
request_id: null,
|
|
18
|
+
data: null,
|
|
19
|
+
error: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# RocketStackSdk::DeleteCronJob200ResponseData
|
|
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::DeleteCronJob200ResponseData.new(
|
|
16
|
+
cron_job_id: null,
|
|
17
|
+
status: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|