notte-sdk 0.0.18 → 0.0.20

package/README.md

@@ -426,10 +426,38 @@ if (metadata.status === 'closed') {
 }
 ```
 
+#### Downloading the function code
+
+```typescript
+const fn = notte.NotteFunction({ function_id: 'your-function-id' });
+
+// Get the python source of the function
+const code = await fn.download();
+
+// Or write it straight to a file (the path must end with .py)
+await fn.download({ path: './my-function.py' });
+
+// A specific version, and the presigned url on its own
+const url = await fn.getUrl({ version: 'v1.0.0' });
+```
+
+Notte managed functions return an encrypted url. Pass the key on the function, or
+per call, and it is decrypted for you:
+
+```typescript
+const fn = notte.NotteFunction({
+  function_id: 'your-function-id',
+  decryption_key: 'your-decryption-key',
+});
+const code = await fn.download();
+```
+
 #### Function Methods
 
 - `run(variables?)` - Start a function run with optional input variables
 - `retrieve(functionRunId)` - Get metadata/result for a specific run
+- `download(options?)` - Download the function code, optionally writing it to `options.path`
+- `getUrl(options?)` - Get the (decrypted) download url of the function code
 - `getFunctionId()` - Get the function ID
 - `functionId` - The function ID (read-only property)
 - `decryptionKey` - The decryption key, if provided (read-only property)