Skip to content

Commit 34f0778

Browse files
committed
Added Account
1 parent 3fa278f commit 34f0778

File tree

8 files changed

+310
-339
lines changed

8 files changed

+310
-339
lines changed

source/includes/_account.md

Lines changed: 246 additions & 66 deletions
Large diffs are not rendered by default.

source/includes/_filament.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -201,12 +201,12 @@ To update existing filament, you need to provide a `fid` query parameter, which
201201
| `filament_type` | string | yes | Filament type. |
202202
| `cost` | float | no | Cost of filament. |
203203
| `currency` | string | no | Currency of `cost`.<br>**Max 3 characters** |
204-
| `custom_note` | string | no | Custom note. |
204+
| `custom_note` | string | no | Custom note.<br>**Max 1000 characters** |
205205
| `prod_id` | string | no | Filament product id. |
206206
| `brand` | string | yes | Filament brand. |
207207
| `brand_id` | integer | no | Filament brand id. |
208208
| `filgroup_id` | integer | no | Target SimplyPrint filament group id to insert filament into. |
209-
| `spool_id` | integer | no | Spool id. |
209+
| `spool_id` | integer | no | Filament spool id. |
210210
| `slicing_settings` | object | yes | Slicing settings. |
211211
| `slicing_settings.nozzle_temp` | integer | yes | Nozzle temperature. |
212212
| `slicing_settings.nozzle_fl_temp` | integer | yes | Nozzle first layer temperature. |

source/includes/_files.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,27 @@ curl https://api.simplyprint.io/{id}/files/GetFolder?id=5290 \
132132
> Success response
133133
134134
```json
135+
{
136+
"status": true,
137+
"message": null,
138+
"folder": {
139+
"id": 5290,
140+
"name": "org_folder_called_benchy",
141+
"org": true,
142+
"permissions": {
143+
"view": [
144+
112,
145+
151
146+
],
147+
"upload": [
148+
112
149+
],
150+
"modify": [
151+
112
152+
]
153+
}
154+
}
155+
}
135156
```
136157

137158
This endpoint returns details about a given folder.
@@ -140,6 +161,25 @@ This endpoint returns details about a given folder.
140161

141162
`GET /{id}/files/GetFolder`
142163

164+
| Parameter | Type | Required | Description |
165+
| --------- | ---- | -------- | ----------- |
166+
| `id` | integer | yes | Folder ID to get details for. |
167+
168+
### Response
169+
170+
| Parameter | Type | Description |
171+
| --------- | ---- | ----------- |
172+
| `status` | boolean | True if the request was successful. |
173+
| `message` | string | Error message if `status` is false. |
174+
| `folder` | object | Folder object. |
175+
| `folder.id` | integer | Folder ID. |
176+
| `folder.name` | string | Folder name. |
177+
| `folder.org` | boolean | True if the folder is an organization folder.<br>**Requires Print Farm plan** |
178+
| `folder.permissions` | object|null | Folder permissions. |
179+
| `folder.permissions.view` | array | Array of [group IDs](#get-company-groups) that can view the folder. |
180+
| `folder.permissions.upload` | array | Array of [group IDs](#get-company-groups) that can upload files to the folder. |
181+
| `folder.permissions.modify` | array | Array of [group IDs](#get-company-groups) that can modify the folder. |
182+
143183
## Move Folder
144184

145185
```shell

source/includes/_permissions.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Permissions
2+
3+
TODO

source/includes/_printers_old.md

Lines changed: 0 additions & 89 deletions
This file was deleted.

source/includes/_queue.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Queue
22

3-
## UpdateItem
3+
## AddItem
44

55
```shell
6-
curl https://api.simplyprint.io/{id}/queue/UpdateItem \
6+
curl https://api.simplyprint.io/{id}/queue/AddItem \
77
-X ? \
88
-H 'accept: application/json' \
99
-H 'X-API-KEY: {API_KEY}'
@@ -19,14 +19,14 @@ curl https://api.simplyprint.io/{id}/queue/UpdateItem \
1919

2020
### Request
2121

22-
`? /{id}/queue/UpdateItem`
22+
`? /{id}/queue/AddItem`
2323

2424
TODO
2525

26-
## SetOrder
26+
## GetItems
2727

2828
```shell
29-
curl https://api.simplyprint.io/{id}/queue/SetOrder \
29+
curl https://api.simplyprint.io/{id}/queue/GetItems \
3030
-X ? \
3131
-H 'accept: application/json' \
3232
-H 'X-API-KEY: {API_KEY}'
@@ -42,14 +42,14 @@ curl https://api.simplyprint.io/{id}/queue/SetOrder \
4242

4343
### Request
4444

45-
`? /{id}/queue/SetOrder`
45+
`? /{id}/queue/GetItems`
4646

4747
TODO
4848

49-
## DeleteItem
49+
## UpdateItem
5050

5151
```shell
52-
curl https://api.simplyprint.io/{id}/queue/DeleteItem \
52+
curl https://api.simplyprint.io/{id}/queue/UpdateItem \
5353
-X ? \
5454
-H 'accept: application/json' \
5555
-H 'X-API-KEY: {API_KEY}'
@@ -65,14 +65,14 @@ curl https://api.simplyprint.io/{id}/queue/DeleteItem \
6565

6666
### Request
6767

68-
`? /{id}/queue/DeleteItem`
68+
`? /{id}/queue/UpdateItem`
6969

7070
TODO
7171

72-
## AddItem
72+
## DeleteItem
7373

7474
```shell
75-
curl https://api.simplyprint.io/{id}/queue/AddItem \
75+
curl https://api.simplyprint.io/{id}/queue/DeleteItem \
7676
-X ? \
7777
-H 'accept: application/json' \
7878
-H 'X-API-KEY: {API_KEY}'
@@ -88,14 +88,14 @@ curl https://api.simplyprint.io/{id}/queue/AddItem \
8888

8989
### Request
9090

91-
`? /{id}/queue/AddItem`
91+
`? /{id}/queue/DeleteItem`
9292

9393
TODO
9494

95-
## EmptyQueue
95+
## SetOrder
9696

9797
```shell
98-
curl https://api.simplyprint.io/{id}/queue/EmptyQueue \
98+
curl https://api.simplyprint.io/{id}/queue/SetOrder \
9999
-X ? \
100100
-H 'accept: application/json' \
101101
-H 'X-API-KEY: {API_KEY}'
@@ -111,14 +111,14 @@ curl https://api.simplyprint.io/{id}/queue/EmptyQueue \
111111

112112
### Request
113113

114-
`? /{id}/queue/EmptyQueue`
114+
`? /{id}/queue/SetOrder`
115115

116116
TODO
117117

118-
## GetItems
118+
## EmptyQueue
119119

120120
```shell
121-
curl https://api.simplyprint.io/{id}/queue/GetItems \
121+
curl https://api.simplyprint.io/{id}/queue/EmptyQueue \
122122
-X ? \
123123
-H 'accept: application/json' \
124124
-H 'X-API-KEY: {API_KEY}'
@@ -134,6 +134,6 @@ curl https://api.simplyprint.io/{id}/queue/GetItems \
134134

135135
### Request
136136

137-
`? /{id}/queue/GetItems`
137+
`? /{id}/queue/EmptyQueue`
138138

139139
TODO

0 commit comments

Comments
 (0)