1 <?php
2 /**
3 * Copyright (C) 2014 MyAllocator
4 *
5 * A copy of the LICENSE can be found in the LICENSE file within
6 * the root directory of this library.
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included
16 * in all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
24 * IN THE SOFTWARE.
25 */
26
27 namespace MyAllocator\phpsdk\src\Api;
28
29 /**
30 * Query the update status of an asynchronous ARIUpdate.
31 * ARIUpdates are asynchronous by default and return an
32 * UpdateId for successful requests.
33 */
34 class ARIUpdateStatus extends MaApi
35 {
36 /**
37 * @var string The api to call.
38 */
39 protected $id = 'ARIUpdateStatus';
40
41 /**
42 * @var array Array of required and optional authentication and argument
43 * keys (string) for API method.
44 */
45 protected $keys = array(
46 'auth' => array(
47 'req' => array(
48 'Auth/VendorId',
49 'Auth/VendorPassword',
50 'Auth/PropertyId',
51 'UserCredentials' => array(
52 'Auth/UserId',
53 'Auth/UserPassword'
54 ),
55 'UserToken' => array(
56 'Auth/UserToken'
57 )
58 ),
59 'opt' => array()
60 ),
61 'args' => array(
62 'req' => array(
63 'UpdateId'
64 ),
65 'opt' => array()
66 )
67 );
68 }
69