|
1 | | -<?php |
2 | | - |
3 | | - |
4 | | -/** |
5 | | -* <auto-generated> |
6 | | -* This code was generated by Codezu. |
7 | | -* |
8 | | -* Changes to this file may cause incorrect behavior and will be lost if |
9 | | -* the code is regenerated. |
10 | | -* </auto-generated> |
11 | | -*/ |
12 | | - |
13 | | -namespace Mozu\Api\Clients\Commerce\Admin; |
14 | | - |
15 | | -use Mozu\Api\MozuClient; |
16 | | -use Mozu\Api\Urls\Commerce\Admin\LocationUrl; |
17 | | - |
18 | | - |
19 | | -/** |
20 | | -* Use the Locations resource to manage each physical location associated with a tenant. Locations enable tenants to associate a physical address with product inventory, provide a store finder for in-store pickup, or both. Locations that support inventory can use both direct ship and in-store pickup fulfillment types. |
21 | | -*/ |
22 | | -class LocationClient { |
23 | | - |
24 | | - /** |
25 | | - * Retrieves a list of all locations associated with a tenant, according to any filter and sort criteria specified in the request. |
26 | | - * |
27 | | - * @param string $filter A set of expressions that consist of a field, operator, and value and represent search parameter syntax when filtering results of a query. Valid operators include equals (eq), does not equal (ne), greater than (gt), less than (lt), greater than or equal to (ge), less than or equal to (le), starts with (sw), or contains (cont). For example - "filter=IsDisplayed+eq+true" |
28 | | - * @param int $pageSize The number of results to display on each page when creating paged results from a query. The maximum value is 200. |
29 | | - * @param string $responseFields Use this field to include those fields which are not included by default. |
30 | | - * @param string $sortBy The property by which to sort results and whether the results appear in ascending (a-z) order, represented by ASC or in descending (z-a) order, represented by DESC. The sortBy parameter follows an available property. For example: "sortBy=productCode+asc" |
31 | | - * @param int $startIndex When creating paged results from a query, this value indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a PageSize of 25, to get the 51st through the 75th items, use startIndex=3. |
32 | | - * @return MozuClient |
33 | | - */ |
34 | | - public static function getLocationsClient($startIndex = null, $pageSize = null, $sortBy = null, $filter = null, $responseFields = null) |
35 | | - { |
36 | | - $url = LocationUrl::getLocationsUrl($filter, $pageSize, $responseFields, $sortBy, $startIndex); |
37 | | - $mozuClient = new MozuClient(); |
38 | | - $mozuClient->withResourceUrl($url); |
39 | | - return $mozuClient; |
40 | | - |
41 | | - } |
42 | | - |
43 | | - /** |
44 | | - * Retrieves the details of the location specified in the request by location code. |
45 | | - * |
46 | | - * @param string $locationCode The unique, user-defined code that identifies a location. |
47 | | - * @param string $responseFields Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. |
48 | | - * @return MozuClient |
49 | | - */ |
50 | | - public static function getLocationClient($locationCode, $responseFields = null) |
51 | | - { |
52 | | - $url = LocationUrl::getLocationUrl($locationCode, $responseFields); |
53 | | - $mozuClient = new MozuClient(); |
54 | | - $mozuClient->withResourceUrl($url); |
55 | | - return $mozuClient; |
56 | | - |
57 | | - } |
58 | | - |
59 | | - /** |
60 | | - * Creates a new physical location for the tenant specified in the request header. |
61 | | - * |
62 | | - * @param string $responseFields Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. |
63 | | - * @param Location $location Properties of a physical location a tenant uses to manage inventory and fulfills orders, provide store finder functionality, or both. |
64 | | - * @return MozuClient |
65 | | - */ |
66 | | - public static function addLocationClient($location, $responseFields = null) |
67 | | - { |
68 | | - $url = LocationUrl::addLocationUrl($responseFields); |
69 | | - $mozuClient = new MozuClient(); |
70 | | - $mozuClient->withResourceUrl($url)->withBody($location); |
71 | | - return $mozuClient; |
72 | | - |
73 | | - } |
74 | | - |
75 | | - /** |
76 | | - * Updates one or more details of a the location specified in the request by location code. |
77 | | - * |
78 | | - * @param string $locationCode The unique, user-defined code that identifies a location. |
79 | | - * @param string $responseFields Use this field to include those fields which are not included by default. |
80 | | - * @param Location $location Properties of a physical location a tenant uses to manage inventory and fulfills orders, provide store finder functionality, or both. |
81 | | - * @return MozuClient |
82 | | - */ |
83 | | - public static function updateLocationClient($location, $locationCode, $responseFields = null) |
84 | | - { |
85 | | - $url = LocationUrl::updateLocationUrl($locationCode, $responseFields); |
86 | | - $mozuClient = new MozuClient(); |
87 | | - $mozuClient->withResourceUrl($url)->withBody($location); |
88 | | - return $mozuClient; |
89 | | - |
90 | | - } |
91 | | - |
92 | | - /** |
93 | | - * Deletes the location specified in the request. |
94 | | - * |
95 | | - * @param string $locationCode The unique, user-defined code that identifies a location. |
96 | | - */ |
97 | | - public static function deleteLocationClient($locationCode) |
98 | | - { |
99 | | - $url = LocationUrl::deleteLocationUrl($locationCode); |
100 | | - $mozuClient = new MozuClient(); |
101 | | - $mozuClient->withResourceUrl($url); |
102 | | - return $mozuClient; |
103 | | - |
104 | | - } |
105 | | - |
106 | | - |
107 | | -} |
108 | | - |
109 | | -?> |
110 | | - |
| 1 | +<?php |
| 2 | + |
| 3 | + |
| 4 | +/** |
| 5 | +* <auto-generated> |
| 6 | +* This code was generated by Codezu. |
| 7 | +* |
| 8 | +* Changes to this file may cause incorrect behavior and will be lost if |
| 9 | +* the code is regenerated. |
| 10 | +* </auto-generated> |
| 11 | +*/ |
| 12 | + |
| 13 | +namespace Mozu\Api\Clients\Commerce\Admin; |
| 14 | + |
| 15 | +use Mozu\Api\MozuClient; |
| 16 | +use Mozu\Api\Urls\Commerce\Admin\LocationUrl; |
| 17 | + |
| 18 | + |
| 19 | +/** |
| 20 | +* Use the Locations resource to manage each physical location associated with a tenant. Locations enable tenants to associate a physical address with product inventory, provide a store finder for in-store pickup, or both. Locations that support inventory can use both direct ship and in-store pickup fulfillment types. |
| 21 | +*/ |
| 22 | +class LocationClient { |
| 23 | + |
| 24 | + /** |
| 25 | + * Retrieves a list of all locations associated with a tenant, according to any filter and sort criteria specified in the request. |
| 26 | + * |
| 27 | + * @param string $filter A set of expressions that consist of a field, operator, and value and represent search parameter syntax when filtering results of a query. Valid operators include equals (eq), does not equal (ne), greater than (gt), less than (lt), greater than or equal to (ge), less than or equal to (le), starts with (sw), or contains (cont). For example - "filter=IsDisplayed+eq+true" |
| 28 | + * @param int $pageSize The number of results to display on each page when creating paged results from a query. The maximum value is 200. |
| 29 | + * @param string $responseFields Use this field to include those fields which are not included by default. |
| 30 | + * @param string $sortBy The property by which to sort results and whether the results appear in ascending (a-z) order, represented by ASC or in descending (z-a) order, represented by DESC. The sortBy parameter follows an available property. For example: "sortBy=productCode+asc" |
| 31 | + * @param int $startIndex When creating paged results from a query, this value indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a PageSize of 25, to get the 51st through the 75th items, use startIndex=3. |
| 32 | + * @return MozuClient |
| 33 | + */ |
| 34 | + public static function getLocationsClient($startIndex = null, $pageSize = null, $sortBy = null, $filter = null, $responseFields = null) |
| 35 | + { |
| 36 | + $url = LocationUrl::getLocationsUrl($filter, $pageSize, $responseFields, $sortBy, $startIndex); |
| 37 | + $mozuClient = new MozuClient(); |
| 38 | + $mozuClient->withResourceUrl($url); |
| 39 | + return $mozuClient; |
| 40 | + |
| 41 | + } |
| 42 | + |
| 43 | + /** |
| 44 | + * Retrieves the details of the location specified in the request by location code. |
| 45 | + * |
| 46 | + * @param string $locationCode The unique, user-defined code that identifies a location. |
| 47 | + * @param string $responseFields Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. |
| 48 | + * @return MozuClient |
| 49 | + */ |
| 50 | + public static function getLocationClient($locationCode, $responseFields = null) |
| 51 | + { |
| 52 | + $url = LocationUrl::getLocationUrl($locationCode, $responseFields); |
| 53 | + $mozuClient = new MozuClient(); |
| 54 | + $mozuClient->withResourceUrl($url); |
| 55 | + return $mozuClient; |
| 56 | + |
| 57 | + } |
| 58 | + |
| 59 | + /** |
| 60 | + * Creates a new physical location for the tenant specified in the request header. |
| 61 | + * |
| 62 | + * @param string $responseFields Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss. |
| 63 | + * @param Location $location Properties of a physical location a tenant uses to manage inventory and fulfills orders, provide store finder functionality, or both. |
| 64 | + * @return MozuClient |
| 65 | + */ |
| 66 | + public static function addLocationClient($location, $responseFields = null) |
| 67 | + { |
| 68 | + $url = LocationUrl::addLocationUrl($responseFields); |
| 69 | + $mozuClient = new MozuClient(); |
| 70 | + $mozuClient->withResourceUrl($url)->withBody($location); |
| 71 | + return $mozuClient; |
| 72 | + |
| 73 | + } |
| 74 | + |
| 75 | + /** |
| 76 | + * Updates one or more details of a the location specified in the request by location code. |
| 77 | + * |
| 78 | + * @param string $locationCode The unique, user-defined code that identifies a location. |
| 79 | + * @param string $responseFields Use this field to include those fields which are not included by default. |
| 80 | + * @param Location $location Properties of a physical location a tenant uses to manage inventory and fulfills orders, provide store finder functionality, or both. |
| 81 | + * @return MozuClient |
| 82 | + */ |
| 83 | + public static function updateLocationClient($location, $locationCode, $responseFields = null) |
| 84 | + { |
| 85 | + $url = LocationUrl::updateLocationUrl($locationCode, $responseFields); |
| 86 | + $mozuClient = new MozuClient(); |
| 87 | + $mozuClient->withResourceUrl($url)->withBody($location); |
| 88 | + return $mozuClient; |
| 89 | + |
| 90 | + } |
| 91 | + |
| 92 | + /** |
| 93 | + * Deletes the location specified in the request. |
| 94 | + * |
| 95 | + * @param string $locationCode The unique, user-defined code that identifies a location. |
| 96 | + */ |
| 97 | + public static function deleteLocationClient($locationCode) |
| 98 | + { |
| 99 | + $url = LocationUrl::deleteLocationUrl($locationCode); |
| 100 | + $mozuClient = new MozuClient(); |
| 101 | + $mozuClient->withResourceUrl($url); |
| 102 | + return $mozuClient; |
| 103 | + |
| 104 | + } |
| 105 | + |
| 106 | + |
| 107 | +} |
| 108 | + |
| 109 | +?> |
| 110 | +
|
0 commit comments