Skip to content

Commit 70301dd

Browse files
committed
Document missing plan requirements
1 parent 4ed0ad9 commit 70301dd

File tree

6 files changed

+90
-3
lines changed

6 files changed

+90
-3
lines changed

source/includes/_custom_fields.md

+24
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ Custom Fields allow you to add your own data-fields inside SimplyPrint.
1010

1111
## List custom fields
1212

13+
<aside class="notice">
14+
This endpoint requires the <b>Print Farm</b> plan.
15+
</aside>
16+
1317
`POST /{id}/custom_fields/Get`
1418

1519
> Example request
@@ -87,6 +91,10 @@ curl -X POST https://api.simplyprint.io/{id}/custom_fields/Get \
8791

8892
## Create or update a custom field
8993

94+
<aside class="notice">
95+
This endpoint requires the <b>Print Farm</b> plan.
96+
</aside>
97+
9098
`POST /{id}/custom_fields/Save`
9199

92100
> Example request
@@ -139,6 +147,10 @@ curl -X POST https://api.simplyprint.io/{id}/custom_fields/Save \
139147

140148
## Enable or disable a custom field
141149

150+
<aside class="notice">
151+
This endpoint requires the <b>Print Farm</b> plan.
152+
</aside>
153+
142154
`POST /{id}/custom_fields/SetEnabled`
143155

144156
> Example request
@@ -176,6 +188,10 @@ curl -X POST https://api.simplyprint.io/{id}/custom_fields/SetEnabled \
176188

177189
## Delete custom fields
178190

191+
<aside class="notice">
192+
This endpoint requires the <b>Print Farm</b> plan.
193+
</aside>
194+
179195
`GET /{id}/custom_fields/Delete`
180196

181197
> Example request
@@ -219,6 +235,10 @@ curl https://api.simplyprint.io/{id}custom_fields/Delete?ids=123,124,125 \
219235

220236
## Custom field submission
221237

238+
<aside class="notice">
239+
This endpoint requires the <b>Print Farm</b> plan.
240+
</aside>
241+
222242
`POST /{id}/custom_fields/SubmitValues`
223243

224244
> Example request
@@ -251,6 +271,10 @@ curl -X POST https://api.simplyprint.io/{id}/custom_fields/SubmitValues \
251271

252272
## Custom field submission value
253273

274+
<aside class="notice">
275+
This endpoint requires the <b>Print Farm</b> plan.
276+
</aside>
277+
254278
The value of a custom field when submitted via the API is an object with a key corresponding to the field type.
255279
See the examples to the right for the different field types.
256280

source/includes/_printers.md

+26-2
Original file line numberDiff line numberDiff line change
@@ -606,6 +606,10 @@ you want to change the printer that is connected to a pi.
606606

607607
## List one-click printers
608608

609+
<aside class="notice">
610+
This endpoint requires the <b>Pro</b> plan.
611+
</aside>
612+
609613
```shell
610614
curl https://api.simplyprint.io/{id}/printers/OneClickPrint?pIds=1234,1235 \
611615
-H 'accept: application/json' \
@@ -659,7 +663,7 @@ curl https://api.simplyprint.io/{id}/printers/OneClickPrint?pIds=1234,1235 \
659663
## AutoPrint enable / disable
660664

661665
<aside class="notice">
662-
AutoPrint requires the <b>Print Farm</b> plan.
666+
This endpoint requires the <b>Print Farm</b> plan.
663667
</aside>
664668

665669
```shell
@@ -698,10 +702,14 @@ curl https://api.simplyprint.io/{id}/printers/autoprint/SetEnabled \
698702

699703
## AutoPrint check state
700704

705+
<aside class="notice">
706+
This endpoint requires the <b>Print Farm</b> plan.
707+
</aside>
708+
701709
```shell
702710
curl https://api.simplyprint.io/{id}/printers/autoprint/CheckState \
703711
-H 'accept: application/json' \
704-
-H 'X-API-KEY: {API_KEY}' \
712+
-H 'X-API-KEY: {API_KEY}'
705713
```
706714

707715
> Success response
@@ -741,6 +749,10 @@ curl https://api.simplyprint.io/{id}/printers/autoprint/CheckState \
741749

742750
## AutoPrint get settings
743751

752+
<aside class="notice">
753+
This endpoint requires the <b>Print Farm</b> plan.
754+
</aside>
755+
744756
```shell
745757
curl https://api.simplyprint.io/{id}/printers/autoprint/GetAutoPrintSettings \
746758
-H 'accept: application/json' \
@@ -787,6 +799,10 @@ curl https://api.simplyprint.io/{id}/printers/autoprint/GetAutoPrintSettings \
787799

788800
## AutoPrint save settings
789801

802+
<aside class="notice">
803+
This endpoint requires the <b>Print Farm</b> plan.
804+
</aside>
805+
790806
```shell
791807
curl https://api.simplyprint.io/{id}/printers/autoprint/SaveAutoPrintSettings \
792808
-X POST \
@@ -836,6 +852,10 @@ curl https://api.simplyprint.io/{id}/printers/autoprint/SaveAutoPrintSettings \
836852

837853
## AutoPrint get gcode templates
838854

855+
<aside class="notice">
856+
This endpoint requires the <b>Print Farm</b> plan.
857+
</aside>
858+
839859
```shell
840860
curl https://api.simplyprint.io/{id}/printers/autoprint/GetGcodeTemplates \
841861
-H 'accept: application/json' \
@@ -887,6 +907,10 @@ curl https://api.simplyprint.io/{id}/printers/autoprint/GetGcodeTemplates \
887907

888908
## AutoPrint set cleared beds amount
889909

910+
<aside class="notice">
911+
This endpoint requires the <b>Print Farm</b> plan.
912+
</aside>
913+
890914
```shell
891915
curl https://api.simplyprint.io/{id}/printers/autoprint/SetClearedBedsAmount \
892916
-X POST \

source/includes/_queue.md

+4
Original file line numberDiff line numberDiff line change
@@ -691,6 +691,10 @@ This endpoint empties the queue.
691691

692692
## Revive item
693693

694+
<aside class="notice">
695+
This endpoint requires the <b>Print Farm</b> plan.
696+
</aside>
697+
694698
```shell
695699
curl https://api.simplyprint.io/{id}/queue/ReviveItem?job=1234 \
696700
-H 'accept: application/json' \

source/includes/_schools.md

+8
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
## List classes
44

5+
<aside class="notice">
6+
This endpoint is only available on the <b>School</b> plan.
7+
</aside>
8+
59
`GET /{id}/account/settings/school/classes/GetClasses`
610

711
> Example request
@@ -75,6 +79,10 @@ curl https://api.simplyprint.io/{id}/account/settings/school/classes/GetClasses
7579

7680
## Create or update a class
7781

82+
<aside class="notice">
83+
This endpoint is only available on the <b>School</b> plan.
84+
</aside>
85+
7886
`POST /{id}/account/settings/school/classes/SaveClass`
7987

8088
> Example Request

source/includes/_users.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,10 @@ curl https://api.simplyprint.io/{id}/users/GetPaginatedUsers \
4343
"total_prints": 68,
4444
"rank": 185,
4545
"teacher": false,
46-
"classes": [1234, 5678]
46+
"classes": [
47+
1234,
48+
5678
49+
]
4750
}
4851
],
4952
"page_amount": 1
@@ -357,6 +360,10 @@ This endpoint deletes a user from the company. Use this endpoint with caution.
357360

358361
## Set Teacher
359362

363+
<aside class="notice">
364+
This endpoint is only available on the <b>School</b> plan.
365+
</aside>
366+
360367
`POST /{id}/users/SetIsTeacher`
361368

362369
> Example request

source/includes/_webhooks.md

+20
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ When one of those events is triggered, we'll send an HTTP POST payload to the we
99

1010
## List webhooks
1111

12+
<aside class="notice">
13+
This endpoint is only available on the <b>Print Farm</b> plan.
14+
</aside>
15+
1216
`GET /{id}/webhooks/Get`
1317

1418
> Example request
@@ -65,6 +69,10 @@ curl "https://api.simplyprint.io/{id}/webhooks/Get" \
6569

6670
## Create or update a webhook
6771

72+
<aside class="notice">
73+
This endpoint is only available on the <b>Print Farm</b> plan.
74+
</aside>
75+
6876
`POST /{id}/webhooks/Create`
6977

7078
> Example request
@@ -123,6 +131,10 @@ https://api.simplyprint.io/{id}/webhooks/Create \
123131

124132
## Delete a webhook
125133

134+
<aside class="notice">
135+
This endpoint is only available on the <b>Print Farm</b> plan.
136+
</aside>
137+
126138
`POST /{id}/webhooks/Delete`
127139

128140
> Example request
@@ -160,6 +172,10 @@ https://api.simplyprint.io/{id}/webhooks/Delete \
160172

161173
## Enable or disable a webhook
162174

175+
<aside class="notice">
176+
This endpoint is only available on the <b>Print Farm</b> plan.
177+
</aside>
178+
163179
`POST /{id}/webhooks/SetEnabled`
164180

165181
> Example request
@@ -198,6 +214,10 @@ https://api.simplyprint.io/{id}/webhooks/SetEnabled \
198214

199215
## Manually trigger webhook
200216

217+
<aside class="notice">
218+
This endpoint is only available on the <b>Print Farm</b> plan.
219+
</aside>
220+
201221
The event type will be `test`.
202222

203223
`POST /{id}/webhooks/TriggerTestWebhook`

0 commit comments

Comments
 (0)