wehub-resource-sync
99 lines
3.1 KiB
Markdown
99 lines
3.1 KiB
Markdown
---
|
|
allowed-tools: Bash, Read, Write, Edit
|
|
argument-hint: [resource] [method] [flags]
|
|
description: Manage Google Keep notes.
|
|
---
|
|
|
|
# Google Workspace Keep
|
|
|
|
Execute Google Workspace Keep operations: $ARGUMENTS
|
|
|
|
## Prerequisites
|
|
|
|
- Google Workspace CLI (`gws`) must be installed
|
|
- Authentication configured: Run `gws auth status` to verify
|
|
- Review `gws keep --help` for all available commands
|
|
|
|
## Available Resources and Methods
|
|
|
|
# keep (v1)
|
|
|
|
> **PREREQUISITE:** Read `../gws-shared/SKILL.md` for auth, global flags, and security rules. If missing, run `gws generate-skills` to create it.
|
|
|
|
```bash
|
|
gws keep <resource> <method> [flags]
|
|
```
|
|
|
|
## API Resources
|
|
|
|
### media
|
|
|
|
- `download` — Gets an attachment. To download attachment media via REST requires the alt=media query parameter. Returns a 400 bad request error if attachment media is not available in the requested MIME type.
|
|
|
|
### notes
|
|
|
|
- `create` — Creates a new note.
|
|
- `delete` — Deletes a note. Caller must have the `OWNER` role on the note to delete. Deleting a note removes the resource immediately and cannot be undone. Any collaborators will lose access to the note.
|
|
- `get` — Gets a note.
|
|
- `list` — Lists notes. Every list call returns a page of results with `page_size` as the upper bound of returned items. A `page_size` of zero allows the server to choose the upper bound. The ListNotesResponse contains at most `page_size` entries. If there are more things left to list, it provides a `next_page_token` value. (Page tokens are opaque values.) To get the next page of results, copy the result's `next_page_token` into the next request's `page_token`.
|
|
- `permissions` — Operations on the 'permissions' resource
|
|
|
|
## Discovering Commands
|
|
|
|
Before calling any API method, inspect it:
|
|
|
|
```bash
|
|
# Browse resources and methods
|
|
gws keep --help
|
|
|
|
# Inspect a method's required params, types, and defaults
|
|
gws schema keep.<resource>.<method>
|
|
```
|
|
|
|
Use `gws schema` output to build your `--params` and `--json` flags.
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
# List available resources and methods
|
|
gws keep --help
|
|
|
|
# Inspect method schema before calling
|
|
gws schema keep.<resource>.<method>
|
|
|
|
# Execute command with arguments
|
|
gws keep $ARGUMENTS
|
|
```
|
|
|
|
## Task
|
|
|
|
Execute the requested Keep operation: $ARGUMENTS
|
|
|
|
1. **Verify Prerequisites**
|
|
- Check `gws` is installed: `gws --version`
|
|
- Verify authentication: `gws auth status`
|
|
- Review available commands: `gws keep --help`
|
|
|
|
2. **Inspect Method Schema**
|
|
- Before calling any method, inspect its parameters
|
|
- Use `gws schema` to understand required fields
|
|
- Review parameter types and constraints
|
|
|
|
3. **Execute Operation**
|
|
- Build command with appropriate flags
|
|
- Use `--params` for query/path parameters
|
|
- Use `--json` for request body
|
|
- Handle pagination with `--max-results` or `--page-token`
|
|
|
|
4. **Error Handling**
|
|
- Check command output for errors
|
|
- Review API quotas and rate limits
|
|
- Handle authentication issues
|
|
- Retry transient failures
|
|
|
|
---
|
|
|
|
**License**: Apache License 2.0
|
|
**Source**: [Google Workspace CLI](https://github.com/googleworkspace/cli)
|
|
**Original Skill**: `gws-keep`
|