# Sideko REST API Rust SDK
## Overview
The Sideko API unlocks features including generating SDKs, setting up API Specifications with mock servers, creating documentation projects with generated API references and custom pages, managing roles and permissions, and more.
### Example Client Initialization
```rust
let client = sideko_rest_api::Client::default()
.with_api_key_auth(&std::env::var("API_KEY").unwrap())
.with_cookie_auth(&std::env::var("API_KEY").unwrap());
```
## Module Documentation and Snippets
### [api](src/resources/api/README.md)
- [create](src/resources/api/README.md#create) - Create API Project
- [delete](src/resources/api/README.md#delete) - Delete API Project
- [get](src/resources/api/README.md#get) - Get API Project
- [init](src/resources/api/README.md#init) - Create API Project with OpenAPI
- [list](src/resources/api/README.md#list) - List API Projects
### [api.spec](src/resources/api/spec/README.md)
- [create](src/resources/api/spec/README.md#create) - Create API Version
- [delete](src/resources/api/spec/README.md#delete) - Delete API Version
- [get](src/resources/api/spec/README.md#get) - Get API Version
- [get_openapi](src/resources/api/spec/README.md#get_openapi) - Get OpenAPI
- [get_stats](src/resources/api/spec/README.md#get_stats) - Get Spec Stats
- [list](src/resources/api/spec/README.md#list) - List API Versions
- [patch](src/resources/api/spec/README.md#patch) - Update API Version
### [asset](src/resources/asset/README.md)
- [create](src/resources/asset/README.md#create) - Upload Asset
- [delete](src/resources/asset/README.md#delete) - Delete Asset
- [list](src/resources/asset/README.md#list) - List Assets
- [patch](src/resources/asset/README.md#patch) - Update Asset
### [auth](src/resources/auth/README.md)
- [exchange_code](src/resources/auth/README.md#exchange_code) - Exchange Code
### [cli](src/resources/cli/README.md)
- [check_updates](src/resources/cli/README.md#check_updates) - Check for CLI Updates
### [doc](src/resources/doc/README.md)
- [check_preview](src/resources/doc/README.md#check_preview) - Check Preview Access
- [create](src/resources/doc/README.md#create) - Create Documentation Project
- [delete](src/resources/doc/README.md#delete) - Delete Documentation Project
- [get](src/resources/doc/README.md#get) - Get Documentation Project
- [list](src/resources/doc/README.md#list) - List Documentation Projects
- [patch](src/resources/doc/README.md#patch) - Update Documentation Project
### [doc.deployment](src/resources/doc/deployment/README.md)
- [get](src/resources/doc/deployment/README.md#get) - Get Documentation Deployment
- [list](src/resources/doc/deployment/README.md#list) - List Documentation Deployments
- [trigger](src/resources/doc/deployment/README.md#trigger) - Trigger Documentation Deployment
### [doc.preview](src/resources/doc/preview/README.md)
- [create_password](src/resources/doc/preview/README.md#create_password) - Create Preview Password
- [delete_password](src/resources/doc/preview/README.md#delete_password) - Deletes Preview Password
- [list_passwords](src/resources/doc/preview/README.md#list_passwords) - List Preview Passwords
### [doc.version](src/resources/doc/version/README.md)
- [get](src/resources/doc/version/README.md#get) - Get Documentation Project Version
- [list](src/resources/doc/version/README.md#list) - List Documentation Project Versions
### [doc.version.api_link](src/resources/doc/version/api_link/README.md)
- [get](src/resources/doc/version/api_link/README.md#get) - Get API Link
- [patch](src/resources/doc/version/api_link/README.md#patch) - Update API Link
### [doc.version.dropdown](src/resources/doc/version/dropdown/README.md)
- [patch](src/resources/doc/version/dropdown/README.md#patch) - Update Dropdown
### [doc.version.external_link](src/resources/doc/version/external_link/README.md)
- [patch](src/resources/doc/version/external_link/README.md#patch) - Update External Link
### [doc.version.page](src/resources/doc/version/page/README.md)
- [get](src/resources/doc/version/page/README.md#get) - Get Page
- [patch](src/resources/doc/version/page/README.md#patch) - Update Page
### [doc.version.sidebar](src/resources/doc/version/sidebar/README.md)
- [create_item](src/resources/doc/version/sidebar/README.md#create_item) - Create Sidebar Item
- [delete_item](src/resources/doc/version/sidebar/README.md#delete_item) - Delete Sidebar Item
- [list_items](src/resources/doc/version/sidebar/README.md#list_items) - List Sidebar Items
- [reorder](src/resources/doc/version/sidebar/README.md#reorder) - Reorder Sidebar
### [doc.version.space](src/resources/doc/version/space/README.md)
- [patch](src/resources/doc/version/space/README.md#patch) - Update Space
### [doc.version.title](src/resources/doc/version/title/README.md)
- [patch](src/resources/doc/version/title/README.md#patch) - Update Title
### [doc.version.topbar](src/resources/doc/version/topbar/README.md)
- [create_item](src/resources/doc/version/topbar/README.md#create_item) - Create Topbar Item
- [delete_item](src/resources/doc/version/topbar/README.md#delete_item) - Delete Topbar Item
- [list_items](src/resources/doc/version/topbar/README.md#list_items) - List Topbar Items
- [reorder](src/resources/doc/version/topbar/README.md#reorder) - Reorder Topbar
### [lint](src/resources/lint/README.md)
- [run](src/resources/lint/README.md#run) - Lint OpenAPI
### [org](src/resources/org/README.md)
- [create](src/resources/org/README.md#create) - Create Organization
- [get](src/resources/org/README.md#get) - Get Organization
### [role](src/resources/role/README.md)
- [create](src/resources/role/README.md#create) - Create New Role
- [delete](src/resources/role/README.md#delete) - Delete Role
- [list](src/resources/role/README.md#list) - List Roles
### [sdk](src/resources/sdk/README.md)
- [generate](src/resources/sdk/README.md#generate) - Generate SDK
- [generate_and_push](src/resources/sdk/README.md#generate_and_push) - Generate an SDK and automatically push to the linked version control system
- [list](src/resources/sdk/README.md#list) - List SDKs
- [update](src/resources/sdk/README.md#update) - Update SDK
### [sdk.config](src/resources/sdk/config/README.md)
- [init](src/resources/sdk/config/README.md#init) - Initialize SDK Configuration
- [sync](src/resources/sdk/config/README.md#sync) - Sync SDK Configuration
### [sdk.doc](src/resources/sdk/doc/README.md)
- [create](src/resources/sdk/doc/README.md#create) - Get SDK Documentation
### [sdk.metadata](src/resources/sdk/metadata/README.md)
- [update](src/resources/sdk/metadata/README.md#update) - Update the metadata of an SDK
### [service_account](src/resources/service_account/README.md)
- [create](src/resources/service_account/README.md#create) - Create Service Account
- [delete](src/resources/service_account/README.md#delete) - Delete Service Account
- [get](src/resources/service_account/README.md#get) - Get Service Account
- [list](src/resources/service_account/README.md#list) - List Service Accounts
### [user](src/resources/user/README.md)
- [invite](src/resources/user/README.md#invite) - Invite User
### [user.me](src/resources/user/me/README.md)
- [get](src/resources/user/me/README.md#get) - Get Current User
- [get_key](src/resources/user/me/README.md#get_key) - Get API Key