rocket_stack_sdk 1.0.1

data/docs/ResourcesApi.md

@@ -0,0 +1,290 @@
+# RocketStackSdk::ResourcesApi
+
+All URIs are relative to *https://api.rocketstack.dev*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_template**](ResourcesApi.md#get_template) | **GET** /resources/templates/{id} | Get a template by id |
+| [**list_capabilities**](ResourcesApi.md#list_capabilities) | **GET** /resources/capabilities | List app-generation capabilities |
+| [**list_snippets**](ResourcesApi.md#list_snippets) | **GET** /resources/snippets | List code snippets |
+| [**list_templates**](ResourcesApi.md#list_templates) | **GET** /resources/templates | List app templates |
+
+
+## get_template
+
+> <GetTemplate200Response> get_template(id)
+
+Get a template by id
+
+Returns a single app template with optional code.
+
+### Examples
+
+```ruby
+require 'time'
+require 'rocket_stack_sdk'
+# setup authorization
+RocketStackSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = RocketStackSdk::ResourcesApi.new
+id = 'id_example' # String | 
+
+begin
+  # Get a template by id
+  result = api_instance.get_template(id)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling ResourcesApi->get_template: #{e}"
+end
+```
+
+#### Using the get_template_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetTemplate200Response>, Integer, Hash)> get_template_with_http_info(id)
+
+```ruby
+begin
+  # Get a template by id
+  data, status_code, headers = api_instance.get_template_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetTemplate200Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling ResourcesApi->get_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**GetTemplate200Response**](GetTemplate200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_capabilities
+
+> <ListCapabilities200Response> list_capabilities
+
+List app-generation capabilities
+
+Returns capabilities (e.g. functions, queues, kv) with id, name, description. Used by MCP/Cursor to map user intent to capability IDs.
+
+### Examples
+
+```ruby
+require 'time'
+require 'rocket_stack_sdk'
+# setup authorization
+RocketStackSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = RocketStackSdk::ResourcesApi.new
+
+begin
+  # List app-generation capabilities
+  result = api_instance.list_capabilities
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling ResourcesApi->list_capabilities: #{e}"
+end
+```
+
+#### Using the list_capabilities_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListCapabilities200Response>, Integer, Hash)> list_capabilities_with_http_info
+
+```ruby
+begin
+  # List app-generation capabilities
+  data, status_code, headers = api_instance.list_capabilities_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListCapabilities200Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling ResourcesApi->list_capabilities_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListCapabilities200Response**](ListCapabilities200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_snippets
+
+> <ListSnippets200Response> list_snippets(opts)
+
+List code snippets
+
+Returns snippets. Query params: capability (e.g. queue, kv), language (e.g. node, python).
+
+### Examples
+
+```ruby
+require 'time'
+require 'rocket_stack_sdk'
+# setup authorization
+RocketStackSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = RocketStackSdk::ResourcesApi.new
+opts = {
+  capability: 'capability_example', # String | 
+  language: 'language_example' # String | 
+}
+
+begin
+  # List code snippets
+  result = api_instance.list_snippets(opts)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling ResourcesApi->list_snippets: #{e}"
+end
+```
+
+#### Using the list_snippets_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListSnippets200Response>, Integer, Hash)> list_snippets_with_http_info(opts)
+
+```ruby
+begin
+  # List code snippets
+  data, status_code, headers = api_instance.list_snippets_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListSnippets200Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling ResourcesApi->list_snippets_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **capability** | **String** |  | [optional] |
+| **language** | **String** |  | [optional] |
+
+### Return type
+
+[**ListSnippets200Response**](ListSnippets200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_templates
+
+> <ListTemplates200Response> list_templates(opts)
+
+List app templates
+
+Returns app templates. Optional query: capabilities=queue,kv to filter by capability.
+
+### Examples
+
+```ruby
+require 'time'
+require 'rocket_stack_sdk'
+# setup authorization
+RocketStackSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = RocketStackSdk::ResourcesApi.new
+opts = {
+  capabilities: 'capabilities_example' # String | 
+}
+
+begin
+  # List app templates
+  result = api_instance.list_templates(opts)
+  p result
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling ResourcesApi->list_templates: #{e}"
+end
+```
+
+#### Using the list_templates_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListTemplates200Response>, Integer, Hash)> list_templates_with_http_info(opts)
+
+```ruby
+begin
+  # List app templates
+  data, status_code, headers = api_instance.list_templates_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListTemplates200Response>
+rescue RocketStackSdk::ApiError => e
+  puts "Error when calling ResourcesApi->list_templates_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **capabilities** | **String** |  | [optional] |
+
+### Return type
+
+[**ListTemplates200Response**](ListTemplates200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+