@digipair/skill-smoobu 0.96.0 → 0.97.1

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.
Files changed (4) hide show
  1. package/index.esm.js +5 -5
  2. package/package.json +1 -1
  3. package/schema.fr.json +406 -264
  4. package/schema.json +406 -264
package/schema.json CHANGED
@@ -10,44 +10,10 @@
10
10
  "paths": {
11
11
  "/getReservationWithId": {
12
12
  "post": {
13
- "tags": ["service"],
14
- "summary": "Information about a Smoobu reservation",
15
- "parameters": [
16
- {
17
- "name": "reservationId",
18
- "summary": "Reservation ID",
19
- "required": true,
20
- "description": "Smoobu reservation ID",
21
- "schema": {
22
- "type": "string"
23
- }
24
- },
25
- {
26
- "name": "SMOOBU_API_KEY",
27
- "summary": "API Key",
28
- "required": false,
29
- "description": "Smoobu API key",
30
- "schema": {
31
- "type": "string"
32
- }
33
- },
34
- {
35
- "name": "SMOOBU_API_ENDPOINT",
36
- "summary": "API Endpoint",
37
- "required": false,
38
- "description": "Smoobu API endpoint",
39
- "schema": {
40
- "type": "string"
41
- }
42
- }
13
+ "tags": [
14
+ "service"
43
15
  ],
44
- "x-events": []
45
- }
46
- },
47
- "/sendMessage": {
48
- "post": {
49
- "tags": ["service"],
50
- "summary": "Send a message via Smoobu",
16
+ "summary": "Information about a Smoobu reservation",
51
17
  "parameters": [
52
18
  {
53
19
  "name": "reservationId",
@@ -58,15 +24,6 @@
58
24
  "type": "string"
59
25
  }
60
26
  },
61
- {
62
- "name": "message",
63
- "summary": "Message",
64
- "required": true,
65
- "description": "Message to send",
66
- "schema": {
67
- "type": "string"
68
- }
69
- },
70
27
  {
71
28
  "name": "SMOOBU_API_KEY",
72
29
  "summary": "API Key",
@@ -86,249 +43,434 @@
86
43
  }
87
44
  }
88
45
  ],
89
- "x-events": []
90
- }
91
- },
92
- "/getAllReservations": {
93
- "post": {
94
- "tags": ["service"],
95
- "summary": "List of Smoobu reservations",
96
- "parameters": [
97
- {
98
- "name": "created_from",
99
- "summary": "Created from",
100
- "required": false,
101
- "description": "Creation date from",
102
- "schema": {
103
- "type": "string"
104
- }
105
- },
106
- {
107
- "name": "created_to",
108
- "summary": "Created until",
109
- "required": false,
110
- "description": "Creation date until",
111
- "schema": {
112
- "type": "string"
113
- }
114
- },
115
- {
116
- "name": "from",
117
- "summary": "Start",
118
- "required": false,
119
- "description": "Start date",
120
- "schema": {
121
- "type": "string"
122
- }
123
- },
124
- {
125
- "name": "to",
126
- "summary": "End",
127
- "required": false,
128
- "description": "End date",
129
- "schema": {
130
- "type": "string"
131
- }
132
- },
133
- {
134
- "name": "modifiedFrom",
135
- "summary": "Modified from",
136
- "required": false,
137
- "description": "Modification date from",
138
- "schema": {
139
- "type": "string"
140
- }
141
- },
142
- {
143
- "name": "modifiedTo",
144
- "summary": "Modified until",
145
- "required": false,
146
- "description": "Modification date until",
147
- "schema": {
148
- "type": "string"
149
- }
150
- },
151
- {
152
- "name": "arrivalFrom",
153
- "summary": "Arrival from",
154
- "required": false,
155
- "description": "Arrival date from",
156
- "schema": {
157
- "type": "string"
158
- }
159
- },
160
- {
161
- "name": "arrivalTo",
162
- "summary": "Arrival until",
163
- "required": false,
164
- "description": "Arrival date until",
165
- "schema": {
166
- "type": "string"
167
- }
168
- },
169
- {
170
- "name": "departureFrom",
171
- "summary": "Departure from",
172
- "required": false,
173
- "description": "Departure date from",
174
- "schema": {
175
- "type": "string"
176
- }
177
- },
178
- {
179
- "name": "departureTo",
180
- "summary": "Departure until",
181
- "required": false,
182
- "description": "Departure date until",
183
- "schema": {
184
- "type": "string"
185
- }
186
- },
187
- {
188
- "name": "showCancellation",
189
- "summary": "Show cancellations",
190
- "required": false,
191
- "description": "Show cancellations",
192
- "schema": {
193
- "type": "string"
194
- }
195
- },
196
- {
197
- "name": "excludeBlocked",
198
- "summary": "Exclude blocked",
199
- "required": false,
200
- "description": "Exclude blocked",
201
- "schema": {
202
- "type": "string"
203
- }
204
- },
205
- {
206
- "name": "page",
207
- "summary": "Page",
208
- "required": false,
209
- "description": "Page",
210
- "schema": {
211
- "type": "string"
212
- }
213
- },
214
- {
215
- "name": "pageSize",
216
- "summary": "Page size",
217
- "required": false,
218
- "description": "Size of the page",
219
- "schema": {
220
- "type": "string"
221
- }
222
- },
223
- {
224
- "name": "apartmentId",
225
- "summary": "Apartment ID",
226
- "required": false,
227
- "description": "Apartment ID",
228
- "schema": {
229
- "type": "string"
230
- }
231
- },
232
- {
233
- "name": "includeRelated",
234
- "summary": "Include details",
235
- "required": false,
236
- "description": "Include details",
237
- "schema": {
238
- "type": "string"
239
- }
240
- },
241
- {
242
- "name": "includePriceElements",
243
- "summary": "Include price elements",
244
- "required": false,
245
- "description": "Include price elements",
246
- "schema": {
247
- "type": "string"
248
- }
249
- },
250
- {
251
- "name": "SMOOBU_API_KEY",
252
- "summary": "API Key",
253
- "required": false,
254
- "description": "Smoobu API key",
255
- "schema": {
256
- "type": "string"
257
- }
258
- },
259
- {
260
- "name": "SMOOBU_API_ENDPOINT",
261
- "summary": "API Endpoint",
262
- "required": false,
263
- "description": "Smoobu API endpoint",
264
- "schema": {
265
- "type": "string"
46
+ "x-events": [],
47
+ "responses": {
48
+ "200": {
49
+ "description": "Reservation details successfully retrieved from Smoobu",
50
+ "content": {
51
+ "application/json": {
52
+ "schema": {
53
+ "type": "object",
54
+ "description": "Smoobu reservation object with detailed information",
55
+ "properties": {
56
+ "id": {
57
+ "type": "string",
58
+ "description": "Reservation ID"
59
+ },
60
+ "arrival": {
61
+ "type": "string",
62
+ "description": "Arrival date"
63
+ },
64
+ "departure": {
65
+ "type": "string",
66
+ "description": "Departure date"
67
+ },
68
+ "guest_name": {
69
+ "type": "string",
70
+ "description": "Guest name"
71
+ },
72
+ "apartment": {
73
+ "type": "object",
74
+ "description": "Apartment details"
75
+ },
76
+ "price": {
77
+ "type": "number",
78
+ "description": "Total price"
79
+ }
80
+ }
81
+ "id": "123456",
82
+ "arrival": "2024-01-15",
83
+ "departure": "2024-01-20",
84
+ "guest_name": "John Doe",
85
+ "apartment": {
86
+ "id": "789",
87
+ "name": "Deluxe Suite"
88
+ },
89
+ "price": 450.00
90
+ }
91
+ }
266
92
  }
267
93
  }
268
- ],
269
- "x-events": []
94
+ }
270
95
  }
271
96
  }
272
97
  },
273
- "components": {
274
- "schemas": {}
275
- },
276
- "x-scene-blocks": {
277
- "/event": {
278
- "summary": "Smoobu reservation",
279
- "description": "Management of events on reservations",
280
- "tags": ["service"],
281
- "metadata": [],
98
+ "/sendMessage": {
99
+ "post": {
100
+ "tags": [
101
+ "service"
102
+ ],
103
+ "summary": "Send a message via Smoobu",
282
104
  "parameters": [
283
105
  {
284
- "name": "updateRates",
285
- "summary": "When updating rates",
286
- "required": false,
287
- "description": "Commands to execute when updating rates",
106
+ "name": "reservationId",
107
+ "summary": "Reservation ID",
108
+ "required": true,
109
+ "description": "Smoobu reservation ID",
288
110
  "schema": {
289
- "type": "array",
290
- "items": {
291
- "$ref": "https://schemas.digipair.ai/pinsSettings"
292
- }
111
+ "type": "string"
293
112
  }
294
113
  },
295
114
  {
296
- "name": "newReservation",
297
- "summary": "When a new reservation is made",
298
- "required": false,
299
- "description": "Commands to execute when a new reservation is made",
115
+ "name": "message",
116
+ "summary": "Message",
117
+ "required": true,
118
+ "description": "Message to send",
300
119
  "schema": {
301
- "type": "array",
302
- "items": {
303
- "$ref": "https://schemas.digipair.ai/pinsSettings"
304
- }
120
+ "type": "string"
305
121
  }
306
122
  },
307
123
  {
308
- "name": "cancelReservation",
309
- "summary": "When a cancellation occurs",
124
+ "name": "SMOOBU_API_KEY",
125
+ "summary": "API Key",
310
126
  "required": false,
311
- "description": "Commands to execute when a cancellation occurs",
127
+ "description": "Smoobu API key",
312
128
  "schema": {
313
- "type": "array",
314
- "items": {
315
- "$ref": "https://schemas.digipair.ai/pinsSettings"
316
- }
129
+ "type": "string"
317
130
  }
318
131
  },
319
132
  {
320
- "name": "updateReservation",
321
- "summary": "When updating a reservation",
133
+ "name": "SMOOBU_API_ENDPOINT",
134
+ "summary": "API Endpoint",
322
135
  "required": false,
323
- "description": "Commands to execute when updating a reservation",
136
+ "description": "Smoobu API endpoint",
324
137
  "schema": {
325
- "type": "array",
326
- "items": {
327
- "$ref": "https://schemas.digipair.ai/pinsSettings"
138
+ "type": "string"
139
+ }
140
+ }
141
+ ],
142
+ "x-events": [],
143
+ "responses": {
144
+ "200": {
145
+ "description": "Message successfully sent to guest via Smoobu",
146
+ "content": {
147
+ "application/json": {
148
+ "schema": {
149
+ "type": "object",
150
+ "description": "Smoobu API response for sent message",
151
+ "properties": {
152
+ "success": {
153
+ "type": "boolean",
154
+ "description": "Whether message was sent successfully"
155
+ },
156
+ "message_id": {
157
+ "type": "string",
158
+ "description": "ID of the sent message"
159
+ }
160
+ }
161
+ "success": true,
162
+ "message_id": "msg_789123"
163
+ }
328
164
  }
329
165
  }
330
166
  }
331
- ]
167
+ }
332
168
  }
333
169
  }
170
+ },
171
+ "/getAllReservations": {
172
+ "post": {
173
+ "tags": [
174
+ "service"
175
+ ],
176
+ "summary": "List of Smoobu reservations",
177
+ "parameters": [
178
+ {
179
+ "name": "created_from",
180
+ "summary": "Created from",
181
+ "required": false,
182
+ "description": "Creation date from",
183
+ "schema": {
184
+ "type": "string"
185
+ }
186
+ },
187
+ {
188
+ "name": "created_to",
189
+ "summary": "Created until",
190
+ "required": false,
191
+ "description": "Creation date until",
192
+ "schema": {
193
+ "type": "string"
194
+ }
195
+ },
196
+ {
197
+ "name": "from",
198
+ "summary": "Start",
199
+ "required": false,
200
+ "description": "Start date",
201
+ "schema": {
202
+ "type": "string"
203
+ }
204
+ },
205
+ {
206
+ "name": "to",
207
+ "summary": "End",
208
+ "required": false,
209
+ "description": "End date",
210
+ "schema": {
211
+ "type": "string"
212
+ }
213
+ },
214
+ {
215
+ "name": "modifiedFrom",
216
+ "summary": "Modified from",
217
+ "required": false,
218
+ "description": "Modification date from",
219
+ "schema": {
220
+ "type": "string"
221
+ }
222
+ },
223
+ {
224
+ "name": "modifiedTo",
225
+ "summary": "Modified until",
226
+ "required": false,
227
+ "description": "Modification date until",
228
+ "schema": {
229
+ "type": "string"
230
+ }
231
+ },
232
+ {
233
+ "name": "arrivalFrom",
234
+ "summary": "Arrival from",
235
+ "required": false,
236
+ "description": "Arrival date from",
237
+ "schema": {
238
+ "type": "string"
239
+ }
240
+ },
241
+ {
242
+ "name": "arrivalTo",
243
+ "summary": "Arrival until",
244
+ "required": false,
245
+ "description": "Arrival date until",
246
+ "schema": {
247
+ "type": "string"
248
+ }
249
+ },
250
+ {
251
+ "name": "departureFrom",
252
+ "summary": "Departure from",
253
+ "required": false,
254
+ "description": "Departure date from",
255
+ "schema": {
256
+ "type": "string"
257
+ }
258
+ },
259
+ {
260
+ "name": "departureTo",
261
+ "summary": "Departure until",
262
+ "required": false,
263
+ "description": "Departure date until",
264
+ "schema": {
265
+ "type": "string"
266
+ }
267
+ },
268
+ {
269
+ "name": "showCancellation",
270
+ "summary": "Show cancellations",
271
+ "required": false,
272
+ "description": "Show cancellations",
273
+ "schema": {
274
+ "type": "string"
275
+ }
276
+ },
277
+ {
278
+ "name": "excludeBlocked",
279
+ "summary": "Exclude blocked",
280
+ "required": false,
281
+ "description": "Exclude blocked",
282
+ "schema": {
283
+ "type": "string"
284
+ }
285
+ },
286
+ {
287
+ "name": "page",
288
+ "summary": "Page",
289
+ "required": false,
290
+ "description": "Page",
291
+ "schema": {
292
+ "type": "string"
293
+ }
294
+ },
295
+ {
296
+ "name": "pageSize",
297
+ "summary": "Page size",
298
+ "required": false,
299
+ "description": "Size of the page",
300
+ "schema": {
301
+ "type": "string"
302
+ }
303
+ },
304
+ {
305
+ "name": "apartmentId",
306
+ "summary": "Apartment ID",
307
+ "required": false,
308
+ "description": "Apartment ID",
309
+ "schema": {
310
+ "type": "string"
311
+ }
312
+ },
313
+ {
314
+ "name": "includeRelated",
315
+ "summary": "Include details",
316
+ "required": false,
317
+ "description": "Include details",
318
+ "schema": {
319
+ "type": "string"
320
+ }
321
+ },
322
+ {
323
+ "name": "includePriceElements",
324
+ "summary": "Include price elements",
325
+ "required": false,
326
+ "description": "Include price elements",
327
+ "schema": {
328
+ "type": "string"
329
+ }
330
+ },
331
+ {
332
+ "name": "SMOOBU_API_KEY",
333
+ "summary": "API Key",
334
+ "required": false,
335
+ "description": "Smoobu API key",
336
+ "schema": {
337
+ "type": "string"
338
+ }
339
+ },
340
+ {
341
+ "name": "SMOOBU_API_ENDPOINT",
342
+ "summary": "API Endpoint",
343
+ "required": false,
344
+ "description": "Smoobu API endpoint",
345
+ "schema": {
346
+ "type": "string"
347
+ }
348
+ }
349
+ ],
350
+ "x-events": [],
351
+ "responses": {
352
+ "200": {
353
+ "description": "List of reservations successfully retrieved from Smoobu",
354
+ "content": {
355
+ "application/json": {
356
+ "schema": {
357
+ "type": "object",
358
+ "description": "Paginated list of Smoobu reservations",
359
+ "properties": {
360
+ "data": {
361
+ "type": "array",
362
+ "description": "Array of reservation objects",
363
+ "items": {
364
+ "type": "object",
365
+ "properties": {
366
+ "id": {
367
+ "type": "string",
368
+ "description": "Reservation ID"
369
+ },
370
+ "arrival": {
371
+ "type": "string",
372
+ "description": "Arrival date"
373
+ },
374
+ "departure": {
375
+ "type": "string",
376
+ "description": "Departure date"
377
+ },
378
+ "guest_name": {
379
+ "type": "string",
380
+ "description": "Guest name"
381
+ }
382
+ }
383
+ }
384
+ },
385
+ "page": {
386
+ "type": "number",
387
+ "description": "Current page number"
388
+ },
389
+ "total": {
390
+ "type": "number",
391
+ "description": "Total number of reservations"
392
+ }
393
+ }
394
+ "data": [
395
+ {
396
+ "id": "123456",
397
+ "arrival": "2024-01-15",
398
+ "departure": "2024-01-20",
399
+ "guest_name": "John Doe"
400
+ }
401
+ ],
402
+ "page": 1,
403
+ "total": 25
404
+ }
405
+ }
406
+ }
407
+ }
408
+ }
409
+ }
410
+ }
411
+ }
412
+ },
413
+ "components": {
414
+ "schemas": {}
415
+ },
416
+ "x-scene-blocks": {
417
+ "/event": {
418
+ "summary": "Smoobu reservation",
419
+ "description": "Management of events on reservations",
420
+ "tags": [
421
+ "service"
422
+ ],
423
+ "metadata": [],
424
+ "parameters": [
425
+ {
426
+ "name": "updateRates",
427
+ "summary": "When updating rates",
428
+ "required": false,
429
+ "description": "Commands to execute when updating rates",
430
+ "schema": {
431
+ "type": "array",
432
+ "items": {
433
+ "$ref": "https://schemas.digipair.ai/pinsSettings"
434
+ }
435
+ }
436
+ },
437
+ {
438
+ "name": "newReservation",
439
+ "summary": "When a new reservation is made",
440
+ "required": false,
441
+ "description": "Commands to execute when a new reservation is made",
442
+ "schema": {
443
+ "type": "array",
444
+ "items": {
445
+ "$ref": "https://schemas.digipair.ai/pinsSettings"
446
+ }
447
+ }
448
+ },
449
+ {
450
+ "name": "cancelReservation",
451
+ "summary": "When a cancellation occurs",
452
+ "required": false,
453
+ "description": "Commands to execute when a cancellation occurs",
454
+ "schema": {
455
+ "type": "array",
456
+ "items": {
457
+ "$ref": "https://schemas.digipair.ai/pinsSettings"
458
+ }
459
+ }
460
+ },
461
+ {
462
+ "name": "updateReservation",
463
+ "summary": "When updating a reservation",
464
+ "required": false,
465
+ "description": "Commands to execute when updating a reservation",
466
+ "schema": {
467
+ "type": "array",
468
+ "items": {
469
+ "$ref": "https://schemas.digipair.ai/pinsSettings"
470
+ }
471
+ }
472
+ }
473
+ ]
474
+ }
334
475
  }
476
+ }