
### list <a name="list"></a>
List deployments for a specific documentation project

Retrieves all deployments for a doc project

**API Endpoint**: `GET /doc_project/{doc_name}/deployment`

#### Example Snippet

```rust
let client = sideko_rest_api::SidekoClient::default()
    .with_api_key_auth(&std::env::var("API_KEY").unwrap())
    .with_cookie_auth(&std::env::var("API_KEY").unwrap());
let res = client
    .doc()
    .deployment()
    .list(sideko_rest_api::resources::doc::deployment::ListRequest {
        doc_name: "my-project".to_string(),
        ..Default::default()
    })
    .await;
```

### get <a name="get"></a>
Get a specific deployment for a specific documentation project

Retrieves single deployment

**API Endpoint**: `GET /doc_project/{doc_name}/deployment/{deployment_id}`

#### Example Snippet

```rust
let client = sideko_rest_api::SidekoClient::default()
    .with_api_key_auth(&std::env::var("API_KEY").unwrap())
    .with_cookie_auth(&std::env::var("API_KEY").unwrap());
let res = client
    .doc()
    .deployment()
    .get(sideko_rest_api::resources::doc::deployment::GetRequest {
        deployment_id: "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string(),
        doc_name: "my-project".to_string(),
    })
    .await;
```

### trigger <a name="trigger"></a>
Deploy a new generated version of documentation with linked guides & APIs

Deploys a new generated version of documentation with linked guides & APIs

**API Endpoint**: `POST /doc_project/{doc_name}/deployment`

#### Example Snippet

```rust
let client = sideko_rest_api::SidekoClient::default()
    .with_api_key_auth(&std::env::var("API_KEY").unwrap())
    .with_cookie_auth(&std::env::var("API_KEY").unwrap());
let res = client
    .doc()
    .deployment()
    .trigger(sideko_rest_api::resources::doc::deployment::TriggerRequest {
        target: sideko_rest_api::models::DeploymentTargetEnum::Preview,
        doc_name: "my-project".to_string(),
        ..Default::default()
    })
    .await;
```
