Skip to content

Commit 8da7927

Browse files
Generate version 2.4.0
1 parent fa4ef89 commit 8da7927

File tree

67 files changed

+10952
-3242
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+10952
-3242
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ No description provided (generated by Swagger Codegen https://github.com/swagger
33

44
This PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
55

6-
- API version: 2.3.0
7-
- Package version: 2.3.0
6+
- API version: 2.4.0
7+
- Package version: 2.4.0
88
- Build package: io.swagger.codegen.languages.PhpClientCodegen
99

1010
## Requirements
1111

12-
PHP 5.4.0 and later
12+
PHP 5.5 and later
1313

1414
## Installation & Usage
1515
### Composer
@@ -37,7 +37,7 @@ Then run `composer install`
3737
Download the files and include `autoload.php`:
3838

3939
```php
40-
require_once('/path/to/ChannelEngine/autoload.php');
40+
require_once('/path/to/ChannelEngine/vendor/autoload.php');
4141
```
4242

4343
## Tests
@@ -87,12 +87,13 @@ Class | Method | HTTP request | Description
8787
*OfferApi* | [**offerStockPriceUpdate**](docs/Api/OfferApi.md#offerstockpriceupdate) | **PUT** /v2/offer | Update stock or price.
8888
*OrderApi* | [**orderAcknowledge**](docs/Api/OrderApi.md#orderacknowledge) | **POST** /v2/orders/acknowledge | Merchant: Acknowledge Order
8989
*OrderApi* | [**orderCreate**](docs/Api/OrderApi.md#ordercreate) | **POST** /v2/orders | Channel: Create Order
90+
*OrderApi* | [**orderGetByFilter**](docs/Api/OrderApi.md#ordergetbyfilter) | **GET** /v2/orders | Merchant: Get Orders By Filter
9091
*OrderApi* | [**orderGetNew**](docs/Api/OrderApi.md#ordergetnew) | **GET** /v2/orders/new | Merchant: Get New Orders
9192
*OrderApi* | [**orderInvoice**](docs/Api/OrderApi.md#orderinvoice) | **GET** /v2/orders/{merchantOrderNo}/invoice | Merchant: Download Invoice
9293
*OrderApi* | [**orderPackingSlip**](docs/Api/OrderApi.md#orderpackingslip) | **GET** /v2/orders/{merchantOrderNo}/packingslip | Merchant: Download Packing Slip
9394
*ProductApi* | [**productAcknowledgeDataChanges**](docs/Api/ProductApi.md#productacknowledgedatachanges) | **POST** /v2/products/data | Channel: Acknowledge Product Data Changes
9495
*ProductApi* | [**productAcknowledgeOfferChanges**](docs/Api/ProductApi.md#productacknowledgeofferchanges) | **POST** /v2/products/offers | Channel: Acknowledge Product Offer Changes
95-
*ProductApi* | [**productCreate**](docs/Api/ProductApi.md#productcreate) | **POST** /v2/products | Merchant: Create Product
96+
*ProductApi* | [**productCreate**](docs/Api/ProductApi.md#productcreate) | **POST** /v2/products | Merchant: Upsert Products
9697
*ProductApi* | [**productDelete**](docs/Api/ProductApi.md#productdelete) | **DELETE** /v2/products/{merchantProductNo} | Merchant: Delete Product
9798
*ProductApi* | [**productGetByMerchantProductNo**](docs/Api/ProductApi.md#productgetbymerchantproductno) | **GET** /v2/products/merchant/{merchantProductNo} | Merchant: Get Product
9899
*ProductApi* | [**productGetDataChanges**](docs/Api/ProductApi.md#productgetdatachanges) | **GET** /v2/products/data | Channel: Get Product Data Changes
@@ -147,6 +148,7 @@ Class | Method | HTTP request | Description
147148
- [MerchantShipmentTrackingRequest](docs/Model/MerchantShipmentTrackingRequest.md)
148149
- [MerchantStockPriceUpdateRequest](docs/Model/MerchantStockPriceUpdateRequest.md)
149150
- [OrderAcknowledgement](docs/Model/OrderAcknowledgement.md)
151+
- [OrderFilter](docs/Model/OrderFilter.md)
150152
- [ProductCreationResult](docs/Model/ProductCreationResult.md)
151153
- [ProductMessage](docs/Model/ProductMessage.md)
152154
- [SingleOfChannelProductChangesResponse](docs/Model/SingleOfChannelProductChangesResponse.md)

composer.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "channelengine/api-client-php",
3-
"version": "2.3.0",
3+
"version": "2.4.0",
44
"description": "",
55
"keywords": [
66
"swagger",
@@ -17,14 +17,14 @@
1717
}
1818
],
1919
"require": {
20-
"php": ">=5.4",
20+
"php": ">=5.5",
2121
"ext-curl": "*",
2222
"ext-json": "*",
23-
"ext-mbstring": "*"
23+
"ext-mbstring": "*",
24+
"guzzlehttp/guzzle": "^6.2"
2425
},
2526
"require-dev": {
26-
"phpunit/phpunit": "~4.8",
27-
"satooshi/php-coveralls": "~1.0",
27+
"phpunit/phpunit": "^4.8",
2828
"squizlabs/php_codesniffer": "~2.6",
2929
"friendsofphp/php-cs-fixer": "~1.12"
3030
},

docs/Api/CancellationApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('api
2525
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
2626
// ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');
2727

28-
$api_instance = new ChannelEngine\ApiClient\Api\CancellationApi();
28+
$api_instance = new ChannelEngine\ApiClient\Api\CancellationApi(new \Http\Adapter\Guzzle6\Client());
2929
$cancellation = new \ChannelEngine\ApiClient\Model\MerchantCancellationRequest(); // \ChannelEngine\ApiClient\Model\MerchantCancellationRequest |
3030

3131
try {
@@ -75,7 +75,7 @@ ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('api
7575
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
7676
// ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');
7777

78-
$api_instance = new ChannelEngine\ApiClient\Api\CancellationApi();
78+
$api_instance = new ChannelEngine\ApiClient\Api\CancellationApi(new \Http\Adapter\Guzzle6\Client());
7979
$createdSince = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime |
8080

8181
try {

docs/Api/ClientApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('api
2424
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
2525
// ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');
2626

27-
$api_instance = new ChannelEngine\ApiClient\Api\ClientApi();
27+
$api_instance = new ChannelEngine\ApiClient\Api\ClientApi(new \Http\Adapter\Guzzle6\Client());
2828
$language = "language_example"; // string | The programming language
2929

3030
try {

docs/Api/OfferApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('api
2222
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
2323
// ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');
2424

25-
$api_instance = new ChannelEngine\ApiClient\Api\OfferApi();
25+
$api_instance = new ChannelEngine\ApiClient\Api\OfferApi(new \Http\Adapter\Guzzle6\Client());
2626
$updates = array(new \ChannelEngine\ApiClient\Model\MerchantStockPriceUpdateRequest()); // \ChannelEngine\ApiClient\Model\MerchantStockPriceUpdateRequest[] | References to the products that should be updated, and the new values for the stock or price fields. It is possible to supply only one of the two fields or both.
2727

2828
try {

docs/Api/OrderApi.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('api
2929
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
3030
// ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');
3131

32-
$api_instance = new ChannelEngine\ApiClient\Api\OrderApi();
32+
$api_instance = new ChannelEngine\ApiClient\Api\OrderApi(new \Http\Adapter\Guzzle6\Client());
3333
$model = new \ChannelEngine\ApiClient\Model\OrderAcknowledgement(); // \ChannelEngine\ApiClient\Model\OrderAcknowledgement | Relations between the id's returned by ChannelEngine and the references which the merchant uses
3434

3535
try {
@@ -79,7 +79,7 @@ ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('api
7979
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
8080
// ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');
8181

82-
$api_instance = new ChannelEngine\ApiClient\Api\OrderApi();
82+
$api_instance = new ChannelEngine\ApiClient\Api\OrderApi(new \Http\Adapter\Guzzle6\Client());
8383
$model = new \ChannelEngine\ApiClient\Model\ChannelOrderRequest(); // \ChannelEngine\ApiClient\Model\ChannelOrderRequest |
8484

8585
try {
@@ -129,7 +129,7 @@ ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('api
129129
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
130130
// ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');
131131

132-
$api_instance = new ChannelEngine\ApiClient\Api\OrderApi();
132+
$api_instance = new ChannelEngine\ApiClient\Api\OrderApi(new \Http\Adapter\Guzzle6\Client());
133133
$filterStatuses = array("filterStatuses_example"); // string[] |
134134
$filterMerchantOrderNos = array("filterMerchantOrderNos_example"); // string[] |
135135
$filterExcludeMarketplaceFulfilledOrdersAndLines = true; // bool |
@@ -187,7 +187,7 @@ ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('api
187187
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
188188
// ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');
189189

190-
$api_instance = new ChannelEngine\ApiClient\Api\OrderApi();
190+
$api_instance = new ChannelEngine\ApiClient\Api\OrderApi(new \Http\Adapter\Guzzle6\Client());
191191

192192
try {
193193
$result = $api_instance->orderGetNew();
@@ -233,7 +233,7 @@ ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('api
233233
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
234234
// ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');
235235

236-
$api_instance = new ChannelEngine\ApiClient\Api\OrderApi();
236+
$api_instance = new ChannelEngine\ApiClient\Api\OrderApi(new \Http\Adapter\Guzzle6\Client());
237237
$merchantOrderNo = "merchantOrderNo_example"; // string | The unique order reference as used by the merchant
238238
$useCustomerCulture = true; // bool | Generate the invoice in the billing address' country's language
239239

@@ -285,7 +285,7 @@ ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('api
285285
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
286286
// ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');
287287

288-
$api_instance = new ChannelEngine\ApiClient\Api\OrderApi();
288+
$api_instance = new ChannelEngine\ApiClient\Api\OrderApi(new \Http\Adapter\Guzzle6\Client());
289289
$merchantOrderNo = "merchantOrderNo_example"; // string | The unique order reference as used by the merchant
290290
$useCustomerCulture = true; // bool | Generate the invoice in the billing address' country's language
291291

docs/Api/ProductApi.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**productAcknowledgeDataChanges**](ProductApi.md#productAcknowledgeDataChanges) | **POST** /v2/products/data | Channel: Acknowledge Product Data Changes
88
[**productAcknowledgeOfferChanges**](ProductApi.md#productAcknowledgeOfferChanges) | **POST** /v2/products/offers | Channel: Acknowledge Product Offer Changes
9-
[**productCreate**](ProductApi.md#productCreate) | **POST** /v2/products | Merchant: Create Product
9+
[**productCreate**](ProductApi.md#productCreate) | **POST** /v2/products | Merchant: Upsert Products
1010
[**productDelete**](ProductApi.md#productDelete) | **DELETE** /v2/products/{merchantProductNo} | Merchant: Delete Product
1111
[**productGetByMerchantProductNo**](ProductApi.md#productGetByMerchantProductNo) | **GET** /v2/products/merchant/{merchantProductNo} | Merchant: Get Product
1212
[**productGetDataChanges**](ProductApi.md#productGetDataChanges) | **GET** /v2/products/data | Channel: Get Product Data Changes
@@ -30,7 +30,7 @@ ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('api
3030
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
3131
// ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');
3232

33-
$api_instance = new ChannelEngine\ApiClient\Api\ProductApi();
33+
$api_instance = new ChannelEngine\ApiClient\Api\ProductApi(new \Http\Adapter\Guzzle6\Client());
3434
$changes = new \ChannelEngine\ApiClient\Model\ChannelProcessedChangesRequest(); // \ChannelEngine\ApiClient\Model\ChannelProcessedChangesRequest | The merchant references of the products which have been successfully created, updated or deleted (after a call to 'GetDataChanges')
3535

3636
try {
@@ -46,7 +46,7 @@ try {
4646

4747
Name | Type | Description | Notes
4848
------------- | ------------- | ------------- | -------------
49-
**changes** | [**\ChannelEngine\ApiClient\Model\ChannelProcessedChangesRequest**](../Model/\ChannelEngine\ApiClient\Model\ChannelProcessedChangesRequest.md)| The merchant references of the products which have been successfully created, updated or deleted (after a call to 'GetDataChanges') |
49+
**changes** | [**\ChannelEngine\ApiClient\Model\ChannelProcessedChangesRequest**](../Model/ChannelProcessedChangesRequest.md)| The merchant references of the products which have been successfully created, updated or deleted (after a call to 'GetDataChanges') |
5050

5151
### Return type
5252

@@ -80,8 +80,8 @@ ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('api
8080
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
8181
// ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');
8282

83-
$api_instance = new ChannelEngine\ApiClient\Api\ProductApi();
84-
$changes = array(new string[]()); // string[] | The channel references of the updated products
83+
$api_instance = new ChannelEngine\ApiClient\Api\ProductApi(new \Http\Adapter\Guzzle6\Client());
84+
$changes = array(new \ChannelEngine\ApiClient\Model\string[]()); // string[] | The channel references of the updated products
8585

8686
try {
8787
$result = $api_instance->productAcknowledgeOfferChanges($changes);
@@ -116,9 +116,9 @@ Name | Type | Description | Notes
116116
# **productCreate**
117117
> \ChannelEngine\ApiClient\Model\SingleOfProductCreationResult productCreate($products)
118118
119-
Merchant: Create Product
119+
Merchant: Upsert Products
120120

121-
For merchants. Create a product. The parent serves as the 'base' product of the children. For example, the children could be different sizes or colors of the parent product. For channels where every size and color are different products this does not make any difference (the children will just be sent separately, while ignoring the parent). But there are channels where the parent and the children need to be sent together, for example when there is one product with a list of sizes. In this case all the product information is retrieved from the parent product while the size list is generated from the children. Note that the parent itself is a 'blueprint' of the child products and we do our best to make sure it does not end up on the marketplaces itself. Only the children can be purchased. It's not possible to nest parent and children more than one level (A parent can have many children, but any child cannot itself also have children). The supplied MerchantProductNo needs to be unique.
121+
For merchants. Upsert (update or create) products. The parent serves as the 'base' product of the children. For example, the children could be different sizes or colors of the parent product. For channels where every size and color are different products this does not make any difference (the children will just be sent separately, while ignoring the parent). But there are channels where the parent and the children need to be sent together, for example when there is one product with a list of sizes. In this case all the product information is retrieved from the parent product while the size list is generated from the children. Note that the parent itself is a 'blueprint' of the child products and we do our best to make sure it does not end up on the marketplaces itself. Only the children can be purchased. It's not possible to nest parent and children more than one level (A parent can have many children, but any child cannot itself also have children). The supplied MerchantProductNo needs to be unique.
122122

123123
### Example
124124
```php
@@ -130,8 +130,8 @@ ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('api
130130
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
131131
// ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');
132132

133-
$api_instance = new ChannelEngine\ApiClient\Api\ProductApi();
134-
$products = array(new MerchantProductRequest()); // \ChannelEngine\ApiClient\Model\MerchantProductRequest[] |
133+
$api_instance = new ChannelEngine\ApiClient\Api\ProductApi(new \Http\Adapter\Guzzle6\Client());
134+
$products = array(new \ChannelEngine\ApiClient\Model\MerchantProductRequest()); // \ChannelEngine\ApiClient\Model\MerchantProductRequest[] |
135135

136136
try {
137137
$result = $api_instance->productCreate($products);
@@ -168,7 +168,7 @@ Name | Type | Description | Notes
168168
169169
Merchant: Delete Product
170170

171-
For merchants. Deactivate a product based on the merchant reference. Note that we do not really delete a product, as the product might still be referenced by orders etc. Therefore, the references used for this product cannot be reused. We do however deactivate the product which means that it will not be sent to channels.
171+
For merchants. Delete a product based on the merchant reference. Note that we do not really delete a product, as the product might still be referenced by orders etc. Therefore, the references used for this product cannot be reused. We do however deactivate the product which means that it will not be sent to channels.
172172

173173
### Example
174174
```php
@@ -180,7 +180,7 @@ ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('api
180180
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
181181
// ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');
182182

183-
$api_instance = new ChannelEngine\ApiClient\Api\ProductApi();
183+
$api_instance = new ChannelEngine\ApiClient\Api\ProductApi(new \Http\Adapter\Guzzle6\Client());
184184
$merchantProductNo = "merchantProductNo_example"; // string |
185185

186186
try {
@@ -230,7 +230,7 @@ ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('api
230230
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
231231
// ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');
232232

233-
$api_instance = new ChannelEngine\ApiClient\Api\ProductApi();
233+
$api_instance = new ChannelEngine\ApiClient\Api\ProductApi(new \Http\Adapter\Guzzle6\Client());
234234
$merchantProductNo = "merchantProductNo_example"; // string |
235235

236236
try {
@@ -280,7 +280,7 @@ ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('api
280280
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
281281
// ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');
282282

283-
$api_instance = new ChannelEngine\ApiClient\Api\ProductApi();
283+
$api_instance = new ChannelEngine\ApiClient\Api\ProductApi(new \Http\Adapter\Guzzle6\Client());
284284
$maxCount = 56; // int | Optional - limit the amount of products returned for each field (ToBeCreated, ToBeUpdated, ToBeRemoved) to this number.
285285

286286
try {
@@ -330,7 +330,7 @@ ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('api
330330
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
331331
// ChannelEngine\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');
332332

333-
$api_instance = new ChannelEngine\ApiClient\Api\ProductApi();
333+
$api_instance = new ChannelEngine\ApiClient\Api\ProductApi(new \Http\Adapter\Guzzle6\Client());
334334

335335
try {
336336
$result = $api_instance->productGetOfferChanges();

0 commit comments

Comments
 (0)