You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore: Update amf-helper-mixin dependency and add agents-api documentation
- Upgraded @api-components/amf-helper-mixin from version 4.5.22 to 4.5.30 in package.json and package-lock.json.
- Added new agents-api.yaml file for the Hotel Reservations API, including paths for creating and retrieving reservations.
- Updated apis.json to include the new agents-api.
- Modified index.js to include the agents-api in the demo API list.
description: API to manage hotel room bookings, check availability, and apply loyalty benefits.
6
+
x-sfdc:
7
+
agent:
8
+
topic:
9
+
name: Hotel_Room_Reservation
10
+
classificationDescription: This API allows agents to book, modify, and cancel hotel reservations, as well as apply loyalty upgrades.
11
+
scope: Your job is to assist customers in booking hotel rooms based on their preferences, loyalty status, and availability. You should also be able to recommend upgrades if the customer qualifies.
12
+
instructions:
13
+
- Always check the customer's loyalty status before finalizing the booking.
14
+
- If the preferred room type is unavailable, suggest alternative options with similar amenities.
15
+
- Never confirm a reservation without validating payment information.
16
+
- If the customer qualifies for an upgrade, apply it automatically and notify them.
17
+
paths:
18
+
/reservations:
19
+
post:
20
+
summary: Create a new hotel reservation
21
+
description: Book a hotel room with specified preferences and apply loyalty upgrades if eligible.
22
+
operationId: reservationCreate
23
+
x-sfdc:
24
+
agent:
25
+
action:
26
+
publishAsAgentAction: true
27
+
requestBody:
28
+
required: true
29
+
description: customer-reservation
30
+
content:
31
+
application/json:
32
+
schema:
33
+
additionalProperties: false
34
+
type: object
35
+
x-sfdc:
36
+
agent:
37
+
action:
38
+
isUserInput: true
39
+
properties:
40
+
customerId:
41
+
type: string
42
+
description: Unique identifier of the customer.
43
+
checkInDate:
44
+
type: string
45
+
format: date
46
+
description: Date of check-in.
47
+
checkOutDate:
48
+
type: string
49
+
format: date
50
+
description: Date of check-out.
51
+
roomType:
52
+
type: string
53
+
enum: [Standard, Deluxe, Suite]
54
+
description: Preferred room type.
55
+
specialRequests:
56
+
type: string
57
+
description: Additional requests like pillow type or air freshener choice.
58
+
responses:
59
+
'201':
60
+
description: Reservation successfully created
61
+
content:
62
+
application/json:
63
+
schema:
64
+
additionalProperties: false
65
+
type: object
66
+
x-sfdc:
67
+
agent:
68
+
action:
69
+
isDisplayable: true
70
+
privacy:
71
+
isPii: true
72
+
properties:
73
+
reservationId:
74
+
type: string
75
+
description: Unique ID of the created reservation.
76
+
upgradeApplied:
77
+
type: boolean
78
+
description: Indicates if a loyalty-based upgrade was applied.
79
+
totalPrice:
80
+
type: number
81
+
format: float
82
+
description: Final price after applying any discounts or upgrades.
83
+
'400':
84
+
description: Invalid input provided
85
+
/reservations/reservationlookup:
86
+
get:
87
+
summary: Retrieve reservation details
88
+
description: Get details of a specific reservation by ID.
89
+
x-sfdc:
90
+
agent:
91
+
action:
92
+
publishAsAgentAction: true
93
+
operationId: reservationRetrieve
94
+
requestBody:
95
+
required: true
96
+
description: customer-reservation
97
+
content:
98
+
application/json:
99
+
schema:
100
+
additionalProperties: false
101
+
type: object
102
+
x-sfdc:
103
+
agent:
104
+
action:
105
+
isUserInput: true
106
+
properties:
107
+
reservationID:
108
+
type: string
109
+
description: Unique identifier of the reservation.
0 commit comments