@snokam/mcp-api 0.131.3 → 0.132.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/specs/production/blog.json +210 -210
- package/specs/production/office.json +347 -347
- package/specs/production/recruitment.json +159 -159
- package/specs/production/sales.json +519 -519
- package/specs/production/sanity.json +10 -56
- package/specs/test/blog.json +210 -210
- package/specs/test/office.json +347 -347
- package/specs/test/recruitment.json +159 -159
- package/specs/test/sales.json +519 -519
- package/specs/test/sanity.json +10 -56
|
@@ -90,52 +90,44 @@
|
|
|
90
90
|
]
|
|
91
91
|
}
|
|
92
92
|
},
|
|
93
|
-
"/v1.0/
|
|
94
|
-
"
|
|
93
|
+
"/v1.0/hue/lights/{id}": {
|
|
94
|
+
"put": {
|
|
95
95
|
"tags": [
|
|
96
|
-
"
|
|
96
|
+
"Hue"
|
|
97
97
|
],
|
|
98
|
-
"summary": "
|
|
99
|
-
"description": "
|
|
100
|
-
"operationId": "
|
|
101
|
-
"
|
|
102
|
-
"200": {
|
|
103
|
-
"description": "List of Sonos Music households",
|
|
104
|
-
"content": {
|
|
105
|
-
"application/json": {
|
|
106
|
-
"schema": {
|
|
107
|
-
"$ref": "#/components/schemas/sonosHouseholds"
|
|
108
|
-
}
|
|
109
|
-
}
|
|
110
|
-
},
|
|
111
|
-
"x-ms-summary": "Success"
|
|
112
|
-
}
|
|
113
|
-
},
|
|
114
|
-
"security": [
|
|
115
|
-
{
|
|
116
|
-
"Implicit": []
|
|
117
|
-
},
|
|
98
|
+
"summary": "Sets a Hue light",
|
|
99
|
+
"description": "Sets the state of a Hue light by ID.",
|
|
100
|
+
"operationId": "setLight",
|
|
101
|
+
"parameters": [
|
|
118
102
|
{
|
|
119
|
-
"
|
|
103
|
+
"name": "id",
|
|
104
|
+
"in": "path",
|
|
105
|
+
"description": "The ID of the light to set",
|
|
106
|
+
"required": true,
|
|
107
|
+
"schema": {
|
|
108
|
+
"type": "string"
|
|
109
|
+
},
|
|
110
|
+
"x-ms-summary": "The ID of the light"
|
|
120
111
|
}
|
|
121
|
-
]
|
|
122
|
-
}
|
|
123
|
-
},
|
|
124
|
-
"/v1.0/playback/status": {
|
|
125
|
-
"get": {
|
|
126
|
-
"tags": [
|
|
127
|
-
"Playback"
|
|
128
112
|
],
|
|
129
|
-
"
|
|
130
|
-
|
|
131
|
-
|
|
113
|
+
"requestBody": {
|
|
114
|
+
"description": "The light state to set",
|
|
115
|
+
"content": {
|
|
116
|
+
"application/json": {
|
|
117
|
+
"schema": {
|
|
118
|
+
"$ref": "#/components/schemas/updateLight"
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
},
|
|
122
|
+
"required": true
|
|
123
|
+
},
|
|
132
124
|
"responses": {
|
|
133
125
|
"200": {
|
|
134
|
-
"description": "
|
|
126
|
+
"description": "Light state set",
|
|
135
127
|
"content": {
|
|
136
128
|
"application/json": {
|
|
137
129
|
"schema": {
|
|
138
|
-
"$ref": "#/components/schemas/
|
|
130
|
+
"$ref": "#/components/schemas/simpleResponse"
|
|
139
131
|
}
|
|
140
132
|
}
|
|
141
133
|
},
|
|
@@ -152,21 +144,24 @@
|
|
|
152
144
|
]
|
|
153
145
|
}
|
|
154
146
|
},
|
|
155
|
-
"/v1.0/
|
|
147
|
+
"/v1.0/hue/lights": {
|
|
156
148
|
"get": {
|
|
157
149
|
"tags": [
|
|
158
|
-
"
|
|
150
|
+
"Hue"
|
|
159
151
|
],
|
|
160
|
-
"summary": "Gets
|
|
161
|
-
"description": "
|
|
162
|
-
"operationId": "
|
|
152
|
+
"summary": "Gets all Hue lights",
|
|
153
|
+
"description": "Gets a list of all Hue lights.",
|
|
154
|
+
"operationId": "GetLights",
|
|
163
155
|
"responses": {
|
|
164
156
|
"200": {
|
|
165
|
-
"description": "
|
|
157
|
+
"description": "List of Hue lights",
|
|
166
158
|
"content": {
|
|
167
159
|
"application/json": {
|
|
168
160
|
"schema": {
|
|
169
|
-
"
|
|
161
|
+
"type": "array",
|
|
162
|
+
"items": {
|
|
163
|
+
"$ref": "#/components/schemas/light"
|
|
164
|
+
}
|
|
170
165
|
}
|
|
171
166
|
}
|
|
172
167
|
},
|
|
@@ -183,46 +178,43 @@
|
|
|
183
178
|
]
|
|
184
179
|
}
|
|
185
180
|
},
|
|
186
|
-
"/v1.0/
|
|
187
|
-
"
|
|
181
|
+
"/v1.0/party": {
|
|
182
|
+
"put": {
|
|
188
183
|
"tags": [
|
|
189
|
-
"
|
|
190
|
-
],
|
|
191
|
-
"summary": "Gets a Sonos Music group",
|
|
192
|
-
"description": "Retrieves a Sonos Music group by name.",
|
|
193
|
-
"operationId": "getGroup",
|
|
194
|
-
"parameters": [
|
|
195
|
-
{
|
|
196
|
-
"name": "name",
|
|
197
|
-
"in": "path",
|
|
198
|
-
"description": "The name of the group to retrieve",
|
|
199
|
-
"required": true,
|
|
200
|
-
"schema": {
|
|
201
|
-
"type": "string"
|
|
202
|
-
},
|
|
203
|
-
"x-ms-summary": "The name of the group"
|
|
204
|
-
}
|
|
184
|
+
"Party"
|
|
205
185
|
],
|
|
186
|
+
"summary": "Sets party state",
|
|
187
|
+
"description": "Sets the party state at the office, only activate on request.",
|
|
188
|
+
"operationId": "setPartyState",
|
|
189
|
+
"requestBody": {
|
|
190
|
+
"description": "The party state to set",
|
|
191
|
+
"content": {
|
|
192
|
+
"application/json": {
|
|
193
|
+
"schema": {
|
|
194
|
+
"$ref": "#/components/schemas/setParty"
|
|
195
|
+
}
|
|
196
|
+
}
|
|
197
|
+
},
|
|
198
|
+
"required": true
|
|
199
|
+
},
|
|
206
200
|
"responses": {
|
|
207
201
|
"200": {
|
|
208
|
-
"description": "
|
|
202
|
+
"description": "Party state set",
|
|
209
203
|
"content": {
|
|
210
204
|
"application/json": {
|
|
211
205
|
"schema": {
|
|
212
|
-
"$ref": "#/components/schemas/
|
|
206
|
+
"$ref": "#/components/schemas/simpleResponse"
|
|
213
207
|
}
|
|
214
208
|
}
|
|
215
209
|
},
|
|
216
210
|
"x-ms-summary": "Success"
|
|
217
|
-
},
|
|
218
|
-
"404": {
|
|
219
|
-
"description": "Group not found",
|
|
220
|
-
"x-ms-summary": "Not Found"
|
|
221
211
|
}
|
|
222
212
|
},
|
|
223
213
|
"security": [
|
|
224
214
|
{
|
|
225
|
-
"Implicit": [
|
|
215
|
+
"Implicit": [
|
|
216
|
+
"api://bb21a8d0-366b-4a95-aa59-dbbf708322d1/.default"
|
|
217
|
+
]
|
|
226
218
|
},
|
|
227
219
|
{
|
|
228
220
|
"ApiKey": []
|
|
@@ -512,71 +504,6 @@
|
|
|
512
504
|
]
|
|
513
505
|
}
|
|
514
506
|
},
|
|
515
|
-
"/v1.0/sonos/groups": {
|
|
516
|
-
"get": {
|
|
517
|
-
"tags": [
|
|
518
|
-
"Sonos"
|
|
519
|
-
],
|
|
520
|
-
"summary": "Gets all groups",
|
|
521
|
-
"description": "Gets a list of all Sonos Music groups.",
|
|
522
|
-
"operationId": "getGroups",
|
|
523
|
-
"responses": {
|
|
524
|
-
"200": {
|
|
525
|
-
"description": "List of Sonos Music groups",
|
|
526
|
-
"content": {
|
|
527
|
-
"application/json": {
|
|
528
|
-
"schema": {
|
|
529
|
-
"type": "array",
|
|
530
|
-
"items": {
|
|
531
|
-
"$ref": "#/components/schemas/group"
|
|
532
|
-
}
|
|
533
|
-
}
|
|
534
|
-
}
|
|
535
|
-
},
|
|
536
|
-
"x-ms-summary": "Success"
|
|
537
|
-
}
|
|
538
|
-
},
|
|
539
|
-
"security": [
|
|
540
|
-
{
|
|
541
|
-
"Implicit": []
|
|
542
|
-
},
|
|
543
|
-
{
|
|
544
|
-
"ApiKey": []
|
|
545
|
-
}
|
|
546
|
-
]
|
|
547
|
-
}
|
|
548
|
-
},
|
|
549
|
-
"/v1.0/sonos/playlists": {
|
|
550
|
-
"get": {
|
|
551
|
-
"tags": [
|
|
552
|
-
"Sonos"
|
|
553
|
-
],
|
|
554
|
-
"summary": "Gets all playlists",
|
|
555
|
-
"description": "Gets a list of all Sonos Music playlists.",
|
|
556
|
-
"operationId": "getPlaylists",
|
|
557
|
-
"responses": {
|
|
558
|
-
"200": {
|
|
559
|
-
"description": "List of Sonos Music playlists",
|
|
560
|
-
"content": {
|
|
561
|
-
"application/json": {
|
|
562
|
-
"schema": {
|
|
563
|
-
"$ref": "#/components/schemas/sonosPlaylist"
|
|
564
|
-
}
|
|
565
|
-
}
|
|
566
|
-
},
|
|
567
|
-
"x-ms-summary": "Success"
|
|
568
|
-
}
|
|
569
|
-
},
|
|
570
|
-
"security": [
|
|
571
|
-
{
|
|
572
|
-
"Implicit": []
|
|
573
|
-
},
|
|
574
|
-
{
|
|
575
|
-
"ApiKey": []
|
|
576
|
-
}
|
|
577
|
-
]
|
|
578
|
-
}
|
|
579
|
-
},
|
|
580
507
|
"/v1.0/sonos/groups/{groupName}/playlist/{playlistName}": {
|
|
581
508
|
"put": {
|
|
582
509
|
"tags": [
|
|
@@ -722,32 +649,21 @@
|
|
|
722
649
|
]
|
|
723
650
|
}
|
|
724
651
|
},
|
|
725
|
-
"/v1.0/
|
|
726
|
-
"
|
|
652
|
+
"/v1.0/printer/create-printjob": {
|
|
653
|
+
"post": {
|
|
727
654
|
"tags": [
|
|
728
|
-
"
|
|
729
|
-
],
|
|
730
|
-
"summary": "Sets a Hue light",
|
|
731
|
-
"description": "Sets the state of a Hue light by ID.",
|
|
732
|
-
"operationId": "setLight",
|
|
733
|
-
"parameters": [
|
|
734
|
-
{
|
|
735
|
-
"name": "id",
|
|
736
|
-
"in": "path",
|
|
737
|
-
"description": "The ID of the light to set",
|
|
738
|
-
"required": true,
|
|
739
|
-
"schema": {
|
|
740
|
-
"type": "string"
|
|
741
|
-
},
|
|
742
|
-
"x-ms-summary": "The ID of the light"
|
|
743
|
-
}
|
|
655
|
+
"Printer"
|
|
744
656
|
],
|
|
657
|
+
"summary": "Creates a print job",
|
|
658
|
+
"description": "Uploads a PNG image to blob storage and creates a print job in the queue. Accepts multipart/form-data with a PNG file.",
|
|
659
|
+
"operationId": "createPrintJob",
|
|
745
660
|
"requestBody": {
|
|
746
|
-
"description": "
|
|
661
|
+
"description": "A PNG image file as multipart/form-data.",
|
|
747
662
|
"content": {
|
|
748
|
-
"
|
|
663
|
+
"multipart/form-data": {
|
|
749
664
|
"schema": {
|
|
750
|
-
"
|
|
665
|
+
"type": "string",
|
|
666
|
+
"format": "binary"
|
|
751
667
|
}
|
|
752
668
|
}
|
|
753
669
|
},
|
|
@@ -755,20 +671,30 @@
|
|
|
755
671
|
},
|
|
756
672
|
"responses": {
|
|
757
673
|
"200": {
|
|
758
|
-
"description": "
|
|
674
|
+
"description": "Print job created successfully",
|
|
759
675
|
"content": {
|
|
760
676
|
"application/json": {
|
|
761
677
|
"schema": {
|
|
762
|
-
"$ref": "#/components/schemas/
|
|
678
|
+
"$ref": "#/components/schemas/printJobResponse"
|
|
763
679
|
}
|
|
764
680
|
}
|
|
765
681
|
},
|
|
766
682
|
"x-ms-summary": "Success"
|
|
683
|
+
},
|
|
684
|
+
"400": {
|
|
685
|
+
"description": "Invalid file or file format",
|
|
686
|
+
"x-ms-summary": "Bad Request"
|
|
687
|
+
},
|
|
688
|
+
"401": {
|
|
689
|
+
"description": "Unauthorized access",
|
|
690
|
+
"x-ms-summary": "Unauthorized"
|
|
767
691
|
}
|
|
768
692
|
},
|
|
769
693
|
"security": [
|
|
770
694
|
{
|
|
771
|
-
"Implicit": [
|
|
695
|
+
"Implicit": [
|
|
696
|
+
"api://bb21a8d0-366b-4a95-aa59-dbbf708322d1/.default"
|
|
697
|
+
]
|
|
772
698
|
},
|
|
773
699
|
{
|
|
774
700
|
"ApiKey": []
|
|
@@ -776,24 +702,21 @@
|
|
|
776
702
|
]
|
|
777
703
|
}
|
|
778
704
|
},
|
|
779
|
-
"/v1.0/
|
|
705
|
+
"/v1.0/printer/status": {
|
|
780
706
|
"get": {
|
|
781
707
|
"tags": [
|
|
782
|
-
"
|
|
708
|
+
"Printer"
|
|
783
709
|
],
|
|
784
|
-
"summary": "Gets
|
|
785
|
-
"description": "
|
|
786
|
-
"operationId": "
|
|
710
|
+
"summary": "Gets printer status",
|
|
711
|
+
"description": "Retrieves the latest printer status including the currently loaded label size and supported image dimensions. Use this endpoint to determine the correct image dimensions before creating a print job.",
|
|
712
|
+
"operationId": "getPrinterStatus",
|
|
787
713
|
"responses": {
|
|
788
714
|
"200": {
|
|
789
|
-
"description": "
|
|
715
|
+
"description": "Printer status with currently loaded label information and supported dimensions",
|
|
790
716
|
"content": {
|
|
791
717
|
"application/json": {
|
|
792
718
|
"schema": {
|
|
793
|
-
"
|
|
794
|
-
"items": {
|
|
795
|
-
"$ref": "#/components/schemas/light"
|
|
796
|
-
}
|
|
719
|
+
"$ref": "#/components/schemas/printerStatusResponse"
|
|
797
720
|
}
|
|
798
721
|
}
|
|
799
722
|
},
|
|
@@ -808,31 +731,67 @@
|
|
|
808
731
|
"ApiKey": []
|
|
809
732
|
}
|
|
810
733
|
]
|
|
734
|
+
},
|
|
735
|
+
"post": {
|
|
736
|
+
"tags": [
|
|
737
|
+
"Printer"
|
|
738
|
+
],
|
|
739
|
+
"summary": "Report printer status",
|
|
740
|
+
"description": "A printer reports its status beacon (status + currently loaded label size) so print jobs can be validated against the loaded label.",
|
|
741
|
+
"operationId": "reportPrinterStatus",
|
|
742
|
+
"requestBody": {
|
|
743
|
+
"content": {
|
|
744
|
+
"application/json": {
|
|
745
|
+
"schema": {
|
|
746
|
+
"$ref": "#/components/schemas/reportStatusRequest"
|
|
747
|
+
}
|
|
748
|
+
}
|
|
749
|
+
},
|
|
750
|
+
"required": true
|
|
751
|
+
},
|
|
752
|
+
"responses": {
|
|
753
|
+
"204": {
|
|
754
|
+
"description": "No description",
|
|
755
|
+
"x-ms-summary": "Recorded"
|
|
756
|
+
},
|
|
757
|
+
"400": {
|
|
758
|
+
"description": "No description",
|
|
759
|
+
"x-ms-summary": "Invalid body"
|
|
760
|
+
}
|
|
761
|
+
},
|
|
762
|
+
"security": [
|
|
763
|
+
{
|
|
764
|
+
"Implicit": []
|
|
765
|
+
},
|
|
766
|
+
{
|
|
767
|
+
"ApiKey": []
|
|
768
|
+
}
|
|
769
|
+
]
|
|
811
770
|
}
|
|
812
771
|
},
|
|
813
|
-
"/v1.0/
|
|
772
|
+
"/v1.0/printer/next-job": {
|
|
814
773
|
"get": {
|
|
815
774
|
"tags": [
|
|
816
|
-
"
|
|
775
|
+
"Printer"
|
|
817
776
|
],
|
|
818
|
-
"summary": "
|
|
819
|
-
"description": "
|
|
820
|
-
"operationId": "
|
|
777
|
+
"summary": "Lease the next print job",
|
|
778
|
+
"description": "Token-authenticated pull endpoint for a printer. Returns the next queued job for the caller's business (image inlined as base64) with a receipt to acknowledge once printed, or 204 when the queue is empty.",
|
|
779
|
+
"operationId": "getNextPrintJob",
|
|
821
780
|
"responses": {
|
|
822
781
|
"200": {
|
|
823
|
-
"description": "
|
|
782
|
+
"description": "Payload of PrintJobLease",
|
|
824
783
|
"content": {
|
|
825
784
|
"application/json": {
|
|
826
785
|
"schema": {
|
|
827
|
-
"$ref": "#/components/schemas/
|
|
786
|
+
"$ref": "#/components/schemas/printJobLease"
|
|
828
787
|
}
|
|
829
788
|
}
|
|
830
789
|
},
|
|
831
|
-
"x-ms-summary": "
|
|
790
|
+
"x-ms-summary": "A leased job"
|
|
832
791
|
},
|
|
833
792
|
"204": {
|
|
834
|
-
"description": "No
|
|
835
|
-
"x-ms-summary": "No
|
|
793
|
+
"description": "No description",
|
|
794
|
+
"x-ms-summary": "No jobs queued"
|
|
836
795
|
}
|
|
837
796
|
},
|
|
838
797
|
"security": [
|
|
@@ -845,33 +804,90 @@
|
|
|
845
804
|
]
|
|
846
805
|
}
|
|
847
806
|
},
|
|
848
|
-
"/v1.0/
|
|
849
|
-
"
|
|
807
|
+
"/v1.0/printer/ack": {
|
|
808
|
+
"post": {
|
|
850
809
|
"tags": [
|
|
851
|
-
"
|
|
810
|
+
"Printer"
|
|
852
811
|
],
|
|
853
|
-
"summary": "
|
|
854
|
-
"description": "
|
|
855
|
-
"operationId": "
|
|
856
|
-
"
|
|
812
|
+
"summary": "Acknowledge a printed job",
|
|
813
|
+
"description": "Deletes a leased job from the queue once printed. Provide the messageId and popReceipt from the lease.",
|
|
814
|
+
"operationId": "ackPrintJob",
|
|
815
|
+
"requestBody": {
|
|
816
|
+
"content": {
|
|
817
|
+
"application/json": {
|
|
818
|
+
"schema": {
|
|
819
|
+
"$ref": "#/components/schemas/ackRequest"
|
|
820
|
+
}
|
|
821
|
+
}
|
|
822
|
+
},
|
|
823
|
+
"required": true
|
|
824
|
+
},
|
|
825
|
+
"responses": {
|
|
826
|
+
"204": {
|
|
827
|
+
"description": "No description",
|
|
828
|
+
"x-ms-summary": "Acknowledged"
|
|
829
|
+
},
|
|
830
|
+
"400": {
|
|
831
|
+
"description": "No description",
|
|
832
|
+
"x-ms-summary": "Missing receipt"
|
|
833
|
+
}
|
|
834
|
+
},
|
|
835
|
+
"security": [
|
|
857
836
|
{
|
|
858
|
-
"
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
"
|
|
862
|
-
|
|
863
|
-
|
|
837
|
+
"Implicit": []
|
|
838
|
+
},
|
|
839
|
+
{
|
|
840
|
+
"ApiKey": []
|
|
841
|
+
}
|
|
842
|
+
]
|
|
843
|
+
}
|
|
844
|
+
},
|
|
845
|
+
"/v1.0/sonos/households": {
|
|
846
|
+
"get": {
|
|
847
|
+
"tags": [
|
|
848
|
+
"Sonos"
|
|
849
|
+
],
|
|
850
|
+
"summary": "Gets Sonos Music households",
|
|
851
|
+
"description": "Retrieves a list of Sonos Music households.",
|
|
852
|
+
"operationId": "getHouseholds",
|
|
853
|
+
"responses": {
|
|
854
|
+
"200": {
|
|
855
|
+
"description": "List of Sonos Music households",
|
|
856
|
+
"content": {
|
|
857
|
+
"application/json": {
|
|
858
|
+
"schema": {
|
|
859
|
+
"$ref": "#/components/schemas/sonosHouseholds"
|
|
860
|
+
}
|
|
861
|
+
}
|
|
864
862
|
},
|
|
865
|
-
"x-ms-summary": "
|
|
863
|
+
"x-ms-summary": "Success"
|
|
866
864
|
}
|
|
865
|
+
},
|
|
866
|
+
"security": [
|
|
867
|
+
{
|
|
868
|
+
"Implicit": []
|
|
869
|
+
},
|
|
870
|
+
{
|
|
871
|
+
"ApiKey": []
|
|
872
|
+
}
|
|
873
|
+
]
|
|
874
|
+
}
|
|
875
|
+
},
|
|
876
|
+
"/v1.0/playback/status": {
|
|
877
|
+
"get": {
|
|
878
|
+
"tags": [
|
|
879
|
+
"Playback"
|
|
867
880
|
],
|
|
881
|
+
"summary": "Gets playback status",
|
|
882
|
+
"description": "Retrieves the playback status of the household.",
|
|
883
|
+
"operationId": "getPlaybackStatus",
|
|
868
884
|
"responses": {
|
|
869
885
|
"200": {
|
|
870
|
-
"description": "
|
|
886
|
+
"description": "Playback status of the household",
|
|
871
887
|
"content": {
|
|
872
888
|
"application/json": {
|
|
873
889
|
"schema": {
|
|
874
|
-
"$ref": "#/components/schemas/
|
|
890
|
+
"$ref": "#/components/schemas/household"
|
|
875
891
|
}
|
|
876
892
|
}
|
|
877
893
|
},
|
|
@@ -886,37 +902,74 @@
|
|
|
886
902
|
"ApiKey": []
|
|
887
903
|
}
|
|
888
904
|
]
|
|
889
|
-
}
|
|
890
|
-
|
|
905
|
+
}
|
|
906
|
+
},
|
|
907
|
+
"/v1.0/sonos/household": {
|
|
908
|
+
"get": {
|
|
891
909
|
"tags": [
|
|
892
|
-
"
|
|
910
|
+
"Sonos"
|
|
893
911
|
],
|
|
894
|
-
"summary": "
|
|
895
|
-
"description": "
|
|
896
|
-
"operationId": "
|
|
912
|
+
"summary": "Gets a Sonos Music household",
|
|
913
|
+
"description": "Retrieves a Sonos Music household.",
|
|
914
|
+
"operationId": "getHousehold",
|
|
915
|
+
"responses": {
|
|
916
|
+
"200": {
|
|
917
|
+
"description": "A Sonos Music household",
|
|
918
|
+
"content": {
|
|
919
|
+
"application/json": {
|
|
920
|
+
"schema": {
|
|
921
|
+
"$ref": "#/components/schemas/household"
|
|
922
|
+
}
|
|
923
|
+
}
|
|
924
|
+
},
|
|
925
|
+
"x-ms-summary": "Success"
|
|
926
|
+
}
|
|
927
|
+
},
|
|
928
|
+
"security": [
|
|
929
|
+
{
|
|
930
|
+
"Implicit": []
|
|
931
|
+
},
|
|
932
|
+
{
|
|
933
|
+
"ApiKey": []
|
|
934
|
+
}
|
|
935
|
+
]
|
|
936
|
+
}
|
|
937
|
+
},
|
|
938
|
+
"/v1.0/sonos/groups/{name}": {
|
|
939
|
+
"get": {
|
|
940
|
+
"tags": [
|
|
941
|
+
"Sonos"
|
|
942
|
+
],
|
|
943
|
+
"summary": "Gets a Sonos Music group",
|
|
944
|
+
"description": "Retrieves a Sonos Music group by name.",
|
|
945
|
+
"operationId": "getGroup",
|
|
897
946
|
"parameters": [
|
|
898
947
|
{
|
|
899
|
-
"name": "
|
|
948
|
+
"name": "name",
|
|
900
949
|
"in": "path",
|
|
901
|
-
"description": "The
|
|
950
|
+
"description": "The name of the group to retrieve",
|
|
902
951
|
"required": true,
|
|
903
952
|
"schema": {
|
|
904
953
|
"type": "string"
|
|
905
954
|
},
|
|
906
|
-
"x-ms-summary": "The
|
|
955
|
+
"x-ms-summary": "The name of the group"
|
|
907
956
|
}
|
|
908
957
|
],
|
|
909
958
|
"responses": {
|
|
910
959
|
"200": {
|
|
911
|
-
"description": "
|
|
960
|
+
"description": "A Sonos Music group",
|
|
912
961
|
"content": {
|
|
913
962
|
"application/json": {
|
|
914
963
|
"schema": {
|
|
915
|
-
"$ref": "#/components/schemas/
|
|
964
|
+
"$ref": "#/components/schemas/group"
|
|
916
965
|
}
|
|
917
966
|
}
|
|
918
967
|
},
|
|
919
968
|
"x-ms-summary": "Success"
|
|
969
|
+
},
|
|
970
|
+
"404": {
|
|
971
|
+
"description": "Group not found",
|
|
972
|
+
"x-ms-summary": "Not Found"
|
|
920
973
|
}
|
|
921
974
|
},
|
|
922
975
|
"security": [
|
|
@@ -929,32 +982,55 @@
|
|
|
929
982
|
]
|
|
930
983
|
}
|
|
931
984
|
},
|
|
932
|
-
"/v1.0/
|
|
933
|
-
"
|
|
985
|
+
"/v1.0/sonos/groups": {
|
|
986
|
+
"get": {
|
|
934
987
|
"tags": [
|
|
935
|
-
"
|
|
988
|
+
"Sonos"
|
|
936
989
|
],
|
|
937
|
-
"summary": "
|
|
938
|
-
"description": "
|
|
939
|
-
"operationId": "
|
|
940
|
-
"
|
|
941
|
-
"
|
|
942
|
-
|
|
943
|
-
"
|
|
944
|
-
"
|
|
945
|
-
"
|
|
990
|
+
"summary": "Gets all groups",
|
|
991
|
+
"description": "Gets a list of all Sonos Music groups.",
|
|
992
|
+
"operationId": "getGroups",
|
|
993
|
+
"responses": {
|
|
994
|
+
"200": {
|
|
995
|
+
"description": "List of Sonos Music groups",
|
|
996
|
+
"content": {
|
|
997
|
+
"application/json": {
|
|
998
|
+
"schema": {
|
|
999
|
+
"type": "array",
|
|
1000
|
+
"items": {
|
|
1001
|
+
"$ref": "#/components/schemas/group"
|
|
1002
|
+
}
|
|
1003
|
+
}
|
|
946
1004
|
}
|
|
947
|
-
}
|
|
948
|
-
|
|
949
|
-
|
|
1005
|
+
},
|
|
1006
|
+
"x-ms-summary": "Success"
|
|
1007
|
+
}
|
|
950
1008
|
},
|
|
1009
|
+
"security": [
|
|
1010
|
+
{
|
|
1011
|
+
"Implicit": []
|
|
1012
|
+
},
|
|
1013
|
+
{
|
|
1014
|
+
"ApiKey": []
|
|
1015
|
+
}
|
|
1016
|
+
]
|
|
1017
|
+
}
|
|
1018
|
+
},
|
|
1019
|
+
"/v1.0/sonos/playlists": {
|
|
1020
|
+
"get": {
|
|
1021
|
+
"tags": [
|
|
1022
|
+
"Sonos"
|
|
1023
|
+
],
|
|
1024
|
+
"summary": "Gets all playlists",
|
|
1025
|
+
"description": "Gets a list of all Sonos Music playlists.",
|
|
1026
|
+
"operationId": "getPlaylists",
|
|
951
1027
|
"responses": {
|
|
952
1028
|
"200": {
|
|
953
|
-
"description": "
|
|
1029
|
+
"description": "List of Sonos Music playlists",
|
|
954
1030
|
"content": {
|
|
955
1031
|
"application/json": {
|
|
956
1032
|
"schema": {
|
|
957
|
-
"$ref": "#/components/schemas/
|
|
1033
|
+
"$ref": "#/components/schemas/sonosPlaylist"
|
|
958
1034
|
}
|
|
959
1035
|
}
|
|
960
1036
|
},
|
|
@@ -963,9 +1039,7 @@
|
|
|
963
1039
|
},
|
|
964
1040
|
"security": [
|
|
965
1041
|
{
|
|
966
|
-
"Implicit": [
|
|
967
|
-
"api://bb21a8d0-366b-4a95-aa59-dbbf708322d1/.default"
|
|
968
|
-
]
|
|
1042
|
+
"Implicit": []
|
|
969
1043
|
},
|
|
970
1044
|
{
|
|
971
1045
|
"ApiKey": []
|
|
@@ -1066,52 +1140,34 @@
|
|
|
1066
1140
|
]
|
|
1067
1141
|
}
|
|
1068
1142
|
},
|
|
1069
|
-
"/v1.0/
|
|
1070
|
-
"
|
|
1143
|
+
"/v1.0/youtube/queue/next": {
|
|
1144
|
+
"get": {
|
|
1071
1145
|
"tags": [
|
|
1072
|
-
"
|
|
1146
|
+
"Youtube"
|
|
1073
1147
|
],
|
|
1074
|
-
"summary": "
|
|
1075
|
-
"description": "
|
|
1076
|
-
"operationId": "
|
|
1077
|
-
"requestBody": {
|
|
1078
|
-
"description": "A PNG image file as multipart/form-data.",
|
|
1079
|
-
"content": {
|
|
1080
|
-
"multipart/form-data": {
|
|
1081
|
-
"schema": {
|
|
1082
|
-
"type": "string",
|
|
1083
|
-
"format": "binary"
|
|
1084
|
-
}
|
|
1085
|
-
}
|
|
1086
|
-
},
|
|
1087
|
-
"required": true
|
|
1088
|
-
},
|
|
1148
|
+
"summary": "Gets next YouTube video",
|
|
1149
|
+
"description": "Gets the next video in the YouTube queue.",
|
|
1150
|
+
"operationId": "getNextYoutubeVideo",
|
|
1089
1151
|
"responses": {
|
|
1090
1152
|
"200": {
|
|
1091
|
-
"description": "
|
|
1153
|
+
"description": "Next video in the YouTube queue",
|
|
1092
1154
|
"content": {
|
|
1093
1155
|
"application/json": {
|
|
1094
1156
|
"schema": {
|
|
1095
|
-
"$ref": "#/components/schemas/
|
|
1157
|
+
"$ref": "#/components/schemas/nextVideo"
|
|
1096
1158
|
}
|
|
1097
1159
|
}
|
|
1098
1160
|
},
|
|
1099
1161
|
"x-ms-summary": "Success"
|
|
1100
1162
|
},
|
|
1101
|
-
"
|
|
1102
|
-
"description": "
|
|
1103
|
-
"x-ms-summary": "
|
|
1104
|
-
},
|
|
1105
|
-
"401": {
|
|
1106
|
-
"description": "Unauthorized access",
|
|
1107
|
-
"x-ms-summary": "Unauthorized"
|
|
1163
|
+
"204": {
|
|
1164
|
+
"description": "No video in the queue",
|
|
1165
|
+
"x-ms-summary": "No Content"
|
|
1108
1166
|
}
|
|
1109
1167
|
},
|
|
1110
1168
|
"security": [
|
|
1111
1169
|
{
|
|
1112
|
-
"Implicit": [
|
|
1113
|
-
"api://bb21a8d0-366b-4a95-aa59-dbbf708322d1/.default"
|
|
1114
|
-
]
|
|
1170
|
+
"Implicit": []
|
|
1115
1171
|
},
|
|
1116
1172
|
{
|
|
1117
1173
|
"ApiKey": []
|
|
@@ -1119,21 +1175,33 @@
|
|
|
1119
1175
|
]
|
|
1120
1176
|
}
|
|
1121
1177
|
},
|
|
1122
|
-
"/v1.0/
|
|
1123
|
-
"
|
|
1178
|
+
"/v1.0/youtube/queue/{id}": {
|
|
1179
|
+
"put": {
|
|
1124
1180
|
"tags": [
|
|
1125
|
-
"
|
|
1181
|
+
"Youtube"
|
|
1182
|
+
],
|
|
1183
|
+
"summary": "Adds to YouTube queue",
|
|
1184
|
+
"description": "Adds a video to the YouTube queue.",
|
|
1185
|
+
"operationId": "addToYoutubeQueue",
|
|
1186
|
+
"parameters": [
|
|
1187
|
+
{
|
|
1188
|
+
"name": "id",
|
|
1189
|
+
"in": "path",
|
|
1190
|
+
"description": "The ID of the video to add",
|
|
1191
|
+
"required": true,
|
|
1192
|
+
"schema": {
|
|
1193
|
+
"type": "string"
|
|
1194
|
+
},
|
|
1195
|
+
"x-ms-summary": "The ID of the video"
|
|
1196
|
+
}
|
|
1126
1197
|
],
|
|
1127
|
-
"summary": "Gets printer status",
|
|
1128
|
-
"description": "Retrieves the latest printer status including the currently loaded label size and supported image dimensions. Use this endpoint to determine the correct image dimensions before creating a print job.",
|
|
1129
|
-
"operationId": "getPrinterStatus",
|
|
1130
1198
|
"responses": {
|
|
1131
1199
|
"200": {
|
|
1132
|
-
"description": "
|
|
1200
|
+
"description": "Video added to the queue",
|
|
1133
1201
|
"content": {
|
|
1134
1202
|
"application/json": {
|
|
1135
1203
|
"schema": {
|
|
1136
|
-
"$ref": "#/components/schemas/
|
|
1204
|
+
"$ref": "#/components/schemas/simpleResponse"
|
|
1137
1205
|
}
|
|
1138
1206
|
}
|
|
1139
1207
|
},
|
|
@@ -1149,104 +1217,36 @@
|
|
|
1149
1217
|
}
|
|
1150
1218
|
]
|
|
1151
1219
|
},
|
|
1152
|
-
"
|
|
1220
|
+
"delete": {
|
|
1153
1221
|
"tags": [
|
|
1154
|
-
"
|
|
1222
|
+
"Youtube"
|
|
1155
1223
|
],
|
|
1156
|
-
"summary": "
|
|
1157
|
-
"description": "
|
|
1158
|
-
"operationId": "
|
|
1159
|
-
"
|
|
1160
|
-
"content": {
|
|
1161
|
-
"application/json": {
|
|
1162
|
-
"schema": {
|
|
1163
|
-
"$ref": "#/components/schemas/reportStatusRequest"
|
|
1164
|
-
}
|
|
1165
|
-
}
|
|
1166
|
-
},
|
|
1167
|
-
"required": true
|
|
1168
|
-
},
|
|
1169
|
-
"responses": {
|
|
1170
|
-
"204": {
|
|
1171
|
-
"description": "No description",
|
|
1172
|
-
"x-ms-summary": "Recorded"
|
|
1173
|
-
},
|
|
1174
|
-
"400": {
|
|
1175
|
-
"description": "No description",
|
|
1176
|
-
"x-ms-summary": "Invalid body"
|
|
1177
|
-
}
|
|
1178
|
-
},
|
|
1179
|
-
"security": [
|
|
1180
|
-
{
|
|
1181
|
-
"Implicit": []
|
|
1182
|
-
},
|
|
1224
|
+
"summary": "Removes from YouTube queue",
|
|
1225
|
+
"description": "Removes a video from the YouTube queue.",
|
|
1226
|
+
"operationId": "removeFromQueue",
|
|
1227
|
+
"parameters": [
|
|
1183
1228
|
{
|
|
1184
|
-
"
|
|
1229
|
+
"name": "id",
|
|
1230
|
+
"in": "path",
|
|
1231
|
+
"description": "The ID of the video to remove",
|
|
1232
|
+
"required": true,
|
|
1233
|
+
"schema": {
|
|
1234
|
+
"type": "string"
|
|
1235
|
+
},
|
|
1236
|
+
"x-ms-summary": "The ID of the video"
|
|
1185
1237
|
}
|
|
1186
|
-
]
|
|
1187
|
-
}
|
|
1188
|
-
},
|
|
1189
|
-
"/v1.0/printer/next-job": {
|
|
1190
|
-
"get": {
|
|
1191
|
-
"tags": [
|
|
1192
|
-
"Printer"
|
|
1193
1238
|
],
|
|
1194
|
-
"summary": "Lease the next print job",
|
|
1195
|
-
"description": "Token-authenticated pull endpoint for a printer. Returns the next queued job for the caller's business (image inlined as base64) with a receipt to acknowledge once printed, or 204 when the queue is empty.",
|
|
1196
|
-
"operationId": "getNextPrintJob",
|
|
1197
1239
|
"responses": {
|
|
1198
1240
|
"200": {
|
|
1199
|
-
"description": "
|
|
1241
|
+
"description": "Video removed from the queue",
|
|
1200
1242
|
"content": {
|
|
1201
1243
|
"application/json": {
|
|
1202
1244
|
"schema": {
|
|
1203
|
-
"$ref": "#/components/schemas/
|
|
1245
|
+
"$ref": "#/components/schemas/simpleResponse"
|
|
1204
1246
|
}
|
|
1205
1247
|
}
|
|
1206
1248
|
},
|
|
1207
|
-
"x-ms-summary": "
|
|
1208
|
-
},
|
|
1209
|
-
"204": {
|
|
1210
|
-
"description": "No description",
|
|
1211
|
-
"x-ms-summary": "No jobs queued"
|
|
1212
|
-
}
|
|
1213
|
-
},
|
|
1214
|
-
"security": [
|
|
1215
|
-
{
|
|
1216
|
-
"Implicit": []
|
|
1217
|
-
},
|
|
1218
|
-
{
|
|
1219
|
-
"ApiKey": []
|
|
1220
|
-
}
|
|
1221
|
-
]
|
|
1222
|
-
}
|
|
1223
|
-
},
|
|
1224
|
-
"/v1.0/printer/ack": {
|
|
1225
|
-
"post": {
|
|
1226
|
-
"tags": [
|
|
1227
|
-
"Printer"
|
|
1228
|
-
],
|
|
1229
|
-
"summary": "Acknowledge a printed job",
|
|
1230
|
-
"description": "Deletes a leased job from the queue once printed. Provide the messageId and popReceipt from the lease.",
|
|
1231
|
-
"operationId": "ackPrintJob",
|
|
1232
|
-
"requestBody": {
|
|
1233
|
-
"content": {
|
|
1234
|
-
"application/json": {
|
|
1235
|
-
"schema": {
|
|
1236
|
-
"$ref": "#/components/schemas/ackRequest"
|
|
1237
|
-
}
|
|
1238
|
-
}
|
|
1239
|
-
},
|
|
1240
|
-
"required": true
|
|
1241
|
-
},
|
|
1242
|
-
"responses": {
|
|
1243
|
-
"204": {
|
|
1244
|
-
"description": "No description",
|
|
1245
|
-
"x-ms-summary": "Acknowledged"
|
|
1246
|
-
},
|
|
1247
|
-
"400": {
|
|
1248
|
-
"description": "No description",
|
|
1249
|
-
"x-ms-summary": "Missing receipt"
|
|
1249
|
+
"x-ms-summary": "Success"
|
|
1250
1250
|
}
|
|
1251
1251
|
},
|
|
1252
1252
|
"security": [
|