1 <?php
2 /**
3 * MyAllocator BuildToUs PHP SDK Inbound API Interface (MA -> OTA)
4 *
5 * @package myallocator/myallocator-php-sdk-ota
6 * @author Nathan Helenihi <support@myallocator.com>
7 * @copyright Copyright (c) MyAllocator
8 * @license http://mit-license.org/
9 * @link https://github.com/MyAllocator/myallocator-php-sdk-ota
10 */
11
12 namespace MyAllocator\phpsdkota\src\Api\Inbound;
13
14 interface MaInboundInterface
15 {
16 /**
17 * Authenticate Myallocator/OTA property.
18 *
19 * After myallocator calls setupProperty, OTA stores mya_property_id to ota_property_id mapping.
20 * On each request, validate the 1:1 mya_property_id to ota_property_id mapping.
21 *
22 * args['mya_property_id']* string The property_id in MyAllocator.
23 * args['ota_property_id']* string The property_id in OTA.
24 *
25 * @param array $args (See above)
26 *
27 * @return \MyAllocator\phpsdkota\src\Object\MaResponse
28 */
29 public function authenticateProperty($args);
30
31 /**
32 * Setup a new property on OTA.
33 *
34 * args['verb']* string Defines the API endpoint method.
35 * args['guid']* string A unique 36 character code that identifies a request.
36 * args['mya_property_id']* string The property_id in MyAllocator.
37 * args['ota_property_id']* string The property_id in OTA.
38 * args['ota_regcode'] string ? TODO
39 *
40 * @param array $args (See above)
41 *
42 * @return \MyAllocator\phpsdkota\src\Object\MaResponse
43 */
44 public function setupProperty($args);
45
46 /**
47 * Get room type information for a property.
48 *
49 * args['verb']* string Defines the API endpoint method.
50 * args['guid']* string A unique 36 character code that identifies a request.
51 * args['mya_property_id']* string The property_id in MyAllocator.
52 * args['ota_property_id']* string The property_id in OTA.
53 *
54 * @param array $args (See above)
55 *
56 * @return \MyAllocator\phpsdkota\src\Object\MaResponse
57 */
58 public function getRoomTypes($args);
59
60 /**
61 * Get information for a specific booking for a property.
62 *
63 * args['verb']* string Defines the API endpoint method.
64 * args['guid']* string A unique 36 character code that identifies a request.
65 * args['mya_property_id']* string The property_id in MyAllocator.
66 * args['ota_property_id']* string The property_id in OTA.
67 * args['booking_id']* string The booking identifier.
68 * args['booking_id_version'] string The OTA version at time of booking.
69 *
70 * @param array $args (See above)
71 *
72 * @return \MyAllocator\phpsdkota\src\Object\MaResponse
73 */
74 public function getBookingId($args);
75
76 /**
77 * Get a list of bookings within a date range for a property.
78 *
79 * args['verb']* string Defines the API endpoint method.
80 * args['guid']* string A unique 36 character code that identifies a request.
81 * args['mya_property_id']* string The property_id in MyAllocator.
82 * args['ota_property_id']* string The property_id in OTA.
83 * args['start_ts']* string The start timestamp (YYYYMMDDtHHMMSSZ).
84 * args['end_ts']* string The end timestamp (YYYYMMDDtHHMMSSZ).
85 *
86 * @param array $args (See above)
87 *
88 * @return \MyAllocator\phpsdkota\src\Object\MaResponse
89 */
90 public function getBookingList($args);
91
92 /**
93 * Update inventory (rates and availability) for a property.
94 *
95 * args['verb']* string Defines the API endpoint method.
96 * args['guid']* string A unique 36 character code that identifies a request.
97 * args['mya_property_id']* string The property_id in MyAllocator.
98 * args['ota_property_id']* string The property_id in OTA.
99 * args['ota_room_id']* string The room_id in OTA.
100 * args['Inventory']* string The rates to update.
101 *
102 * @param array $args (See above)
103 *
104 * @return \MyAllocator\phpsdkota\src\Object\MaResponse
105 */
106 public function ARIUpdate($args);
107
108 /**
109 * Inbound API logs. Implement a logging method here to capture the inbound API logs.
110 *
111 * @param string $str The log.
112 */
113 public function log($str);
114 }
115