sideko_rest_api 0.9.2

Rust API Client
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

# asset

## Module Functions

### Delete Asset <a name="delete"></a>

Delete a media asset in your organization

**API Endpoint**: `DELETE /organization/asset/{id}`

#### Parameters

| Parameter | Required | Description | Example                                              |
| --------- | :------: | ----------- | ---------------------------------------------------- |
| `id`      |    ✓     |             | `"3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string()` |

#### 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
    .asset()
    .delete(sideko_rest_api::resources::asset::DeleteRequest {
        id: "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string(),
    })
    .await;
```

### List Assets <a name="list"></a>

Get all media assets for an organization

**API Endpoint**: `GET /organization/asset`

#### Parameters

| Parameter | Required | Description | Example                |
| --------- | :------: | ----------- | ---------------------- |
| `name`    |    ✗     |             | `"string".to_string()` |
| `page`    |    ✗     |             | `123`                  |

#### 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
    .asset()
    .list(sideko_rest_api::resources::asset::ListRequest {
        ..Default::default()
    })
    .await;
```

#### Response

##### Type

[ListAssetsPage](/src/models/list_assets_page.rs)

##### Example

```rust
ListAssetsPage {pagination: Pagination {page: 123, page_count: 123, page_limit: 123, total_count: 123}, results: vec![Asset {extension: "string".to_string(), id: "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string(), name: "string".to_string(), url: "http://www.example.com".to_string()}]}
```

### Update Asset <a name="patch"></a>

Update a media asset in your organization

**API Endpoint**: `PATCH /organization/asset/{id}`

#### Parameters

| Parameter | Required | Description                        | Example                                              |
| --------- | :------: | ---------------------------------- | ---------------------------------------------------- |
| `id`      |    ✓     |                                    | `"3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string()` |
| `name`    |    ✗     | Asset name (without any extension) | `"string".to_string()`                               |

#### 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
    .asset()
    .patch(sideko_rest_api::resources::asset::PatchRequest {
        id: "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string(),
        ..Default::default()
    })
    .await;
```

#### Response

##### Type

[Asset](/src/models/asset.rs)

##### Example

```rust
Asset {extension: "string".to_string(), id: "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string(), name: "string".to_string(), url: "http://www.example.com".to_string()}
```

### Upload Asset <a name="create"></a>

Add a media asset like logos or other media to an organization

**API Endpoint**: `POST /organization/asset`

#### Parameters

| Parameter | Required | Description | Example                                              |
| --------- | :------: | ----------- | ---------------------------------------------------- |
| `file`    |    ✓     |             | `UploadFile::from_path("uploads/file.pdf").unwrap()` |

#### 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
    .asset()
    .create(sideko_rest_api::resources::asset::CreateRequest {
        file: sideko_rest_api::UploadFile::from_path("uploads/image.png").unwrap(),
    })
    .await;
```

#### Response

##### Type

Vec of [Asset](/src/models/asset.rs)

##### Example

```rust
vec![Asset {extension: "string".to_string(), id: "3e4666bf-d5e5-4aa7-b8ce-cefe41c7568a".to_string(), name: "string".to_string(), url: "http://www.example.com".to_string()}]
```