Skip to content

Commit d28058f

Browse files
committed
add missing docs
1 parent ba3823f commit d28058f

1 file changed

Lines changed: 32 additions & 1 deletion

File tree

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,10 +226,12 @@ You can find [details about your executed Assemblies here](https://transloadit.c
226226

227227
- [Upload and resize image](https://github.com/transloadit/node-sdk/blob/main/examples/resize_an_image.ts)
228228
- [Upload image and convert to WebP](https://github.com/transloadit/node-sdk/blob/main/examples/convert_to_webp.ts)
229+
- [Rasterize SVG to PNG](https://github.com/transloadit/node-sdk/blob/main/examples/rasterize_svg_to_png.ts)
229230
- [Crop a face out of an image and download the result](https://github.com/transloadit/node-sdk/blob/main/examples/face_detect_download.ts)
230231
- [Retry example](https://github.com/transloadit/node-sdk/blob/main/examples/retry.ts)
231232
- [Calculate total costs (GB usage)](https://github.com/transloadit/node-sdk/blob/main/examples/fetch_costs_of_all_assemblies_in_timeframe.ts)
232233
- [Templates CRUD](https://github.com/transloadit/node-sdk/blob/main/examples/template_api.ts)
234+
- [Template Credentials CRUD](https://github.com/transloadit/node-sdk/blob/main/examples/credentials.ts)
233235

234236
For more fully working examples take a look at [`examples/`](https://github.com/transloadit/node-sdk/blob/main/examples/).
235237

@@ -245,6 +247,7 @@ Table of contents:
245247
- [Assemblies](#assemblies)
246248
- [Assembly notifications](#assembly-notifications)
247249
- [Templates](#templates)
250+
- [Template Credentials](#template-credentials)
248251
- [Errors](#errors)
249252
- [Rate limiting & auto retry](#rate-limiting--auto-retry)
250253

@@ -498,6 +501,34 @@ The method returns an object containing these properties:
498501

499502
Creates an `objectMode` `Readable` stream that automates handling of `listTemplates` pagination. Similar to `streamAssemblies`.
500503

504+
### Template Credentials
505+
506+
Template Credentials allow you to store third-party credentials (e.g., AWS S3, Google Cloud Storage, FTP) securely on Transloadit for use in your Assembly Instructions.
507+
508+
#### async createTemplateCredential(params)
509+
510+
Creates a new Template Credential. The `params` object should contain the credential configuration. See [API documentation](https://transloadit.com/docs/api/template-credentials-post/).
511+
512+
#### async editTemplateCredential(credentialId, params)
513+
514+
Updates an existing Template Credential identified by `credentialId`. See [API documentation](https://transloadit.com/docs/api/template-credentials-credential-id-put/).
515+
516+
#### async deleteTemplateCredential(credentialId)
517+
518+
Deletes the Template Credential identified by `credentialId`. See [API documentation](https://transloadit.com/docs/api/template-credentials-credential-id-delete/).
519+
520+
#### async getTemplateCredential(credentialId)
521+
522+
Retrieves the Template Credential identified by `credentialId`. See [API documentation](https://transloadit.com/docs/api/template-credentials-credential-id-get/).
523+
524+
#### async listTemplateCredentials(params)
525+
526+
Lists all Template Credentials. See [API documentation](https://transloadit.com/docs/api/template-credentials-get/).
527+
528+
#### streamTemplateCredentials(params)
529+
530+
Creates an `objectMode` `Readable` stream that automates handling of `listTemplateCredentials` pagination. Similar to `streamAssemblies`.
531+
501532
### Other
502533

503534
#### setDefaultTimeout(timeout)
@@ -606,7 +637,7 @@ If you want to retry on other errors, please see the [retry example code](exampl
606637
This project uses [debug](https://github.com/visionmedia/debug) so you can run node with the `DEBUG=transloadit` evironment variable to enable verbose logging. Example:
607638

608639
```bash
609-
DEBUG=transloadit* node examples/template_api.js
640+
DEBUG=transloadit* npx tsx examples/template_api.ts
610641
```
611642

612643
## Maintainers

0 commit comments

Comments
 (0)