-
Notifications
You must be signed in to change notification settings - Fork 52
/
VendorOrdersSDK.php
1013 lines (886 loc) · 50.1 KB
/
VendorOrdersSDK.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
declare(strict_types=1);
namespace AmazonPHP\SellingPartner\Api\VendorOrdersApi;
use AmazonPHP\SellingPartner\AccessToken;
use AmazonPHP\SellingPartner\Configuration;
use AmazonPHP\SellingPartner\Exception\ApiException;
use AmazonPHP\SellingPartner\Exception\InvalidArgumentException;
use AmazonPHP\SellingPartner\HttpFactory;
use AmazonPHP\SellingPartner\HttpSignatureHeaders;
use AmazonPHP\SellingPartner\ObjectSerializer;
use Psr\Http\Client\ClientExceptionInterface;
use Psr\Http\Client\ClientInterface;
use Psr\Http\Message\RequestInterface;
use Psr\Log\LoggerInterface;
/**
* Selling Partner API for Retail Procurement Orders.
*
* The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data.
*
* The version of the OpenAPI document: v1
*
* This class was auto-generated by https://openapi-generator.tech
* Do not change it, it will be overwritten with next execution of /bin/generate.sh
*/
final class VendorOrdersSDK implements VendorOrdersSDKInterface
{
public function __construct(private readonly ClientInterface $client, private readonly HttpFactory $httpFactory, private readonly Configuration $configuration, private readonly LoggerInterface $logger)
{
}
/**
* Operation getPurchaseOrder.
*
* @param string $purchase_order_number The purchase order identifier for the order that you want. Formatting Notes: 8-character alpha-numeric code. (required)
*
* @throws ApiException on non-2xx response
* @throws InvalidArgumentException
*/
public function getPurchaseOrder(AccessToken $accessToken, string $region, string $purchase_order_number) : \AmazonPHP\SellingPartner\Model\VendorOrders\GetPurchaseOrderResponse
{
$request = $this->getPurchaseOrderRequest($accessToken, $region, $purchase_order_number);
$this->configuration->extensions()->preRequest('VendorOrders', 'getPurchaseOrder', $request);
try {
$correlationId = $this->configuration->idGenerator()->generate();
$sanitizedRequest = $request;
foreach ($this->configuration->loggingSkipHeaders() as $sensitiveHeader) {
$sanitizedRequest = $sanitizedRequest->withoutHeader($sensitiveHeader);
}
if ($this->configuration->loggingEnabled('VendorOrders', 'getPurchaseOrder')) {
$this->logger->log(
$this->configuration->logLevel('VendorOrders', 'getPurchaseOrder'),
'Amazon Selling Partner API pre request',
[
'api' => 'VendorOrders',
'operation' => 'getPurchaseOrder',
'request_correlation_id' => $correlationId,
'request_body' => (string) $sanitizedRequest->getBody(),
'request_headers' => $sanitizedRequest->getHeaders(),
'request_uri' => (string) $sanitizedRequest->getUri(),
]
);
}
$response = $this->client->sendRequest($request);
$this->configuration->extensions()->postRequest('VendorOrders', 'getPurchaseOrder', $request, $response);
if ($this->configuration->loggingEnabled('VendorOrders', 'getPurchaseOrder')) {
$sanitizedResponse = $response;
foreach ($this->configuration->loggingSkipHeaders() as $sensitiveHeader) {
$sanitizedResponse = $sanitizedResponse->withoutHeader($sensitiveHeader);
}
$this->logger->log(
$this->configuration->logLevel('VendorOrders', 'getPurchaseOrder'),
'Amazon Selling Partner API post request',
[
'api' => 'VendorOrders',
'operation' => 'getPurchaseOrder',
'response_correlation_id' => $correlationId,
'response_body' => (string) $sanitizedResponse->getBody(),
'response_headers' => $sanitizedResponse->getHeaders(),
'response_status_code' => $sanitizedResponse->getStatusCode(),
'request_uri' => (string) $sanitizedRequest->getUri(),
'request_body' => (string) $sanitizedRequest->getBody(),
]
);
}
} catch (ClientExceptionInterface $e) {
throw new ApiException(
"[{$e->getCode()}] {$e->getMessage()}",
(int) $e->getCode(),
null,
null,
$e
);
}
$statusCode = $response->getStatusCode();
if ($statusCode < 200 || $statusCode > 299) {
throw new ApiException(
\sprintf(
'[%d] Error connecting to the API (%s)',
$statusCode,
(string) $request->getUri()
),
$statusCode,
$response->getHeaders(),
(string) $response->getBody()
);
}
return ObjectSerializer::deserialize(
$this->configuration,
(string) $response->getBody(),
'\AmazonPHP\SellingPartner\Model\VendorOrders\GetPurchaseOrderResponse',
[]
);
}
/**
* Create request for operation 'getPurchaseOrder'.
*
* @param string $purchase_order_number The purchase order identifier for the order that you want. Formatting Notes: 8-character alpha-numeric code. (required)
*
* @throws \AmazonPHP\SellingPartner\Exception\InvalidArgumentException
*/
public function getPurchaseOrderRequest(AccessToken $accessToken, string $region, string $purchase_order_number) : RequestInterface
{
// verify the required parameter 'purchase_order_number' is set
if ($purchase_order_number === null || (\is_array($purchase_order_number) && \count($purchase_order_number) === 0)) {
throw new InvalidArgumentException(
'Missing the required parameter $purchase_order_number when calling getPurchaseOrder'
);
}
$resourcePath = '/vendor/orders/v1/purchaseOrders/{purchaseOrderNumber}';
$formParams = [];
$queryParams = [];
$headerParams = [];
$multipart = false;
$query = '';
if (\count($queryParams)) {
$query = \http_build_query($queryParams);
}
// path params
if ($purchase_order_number !== null) {
$resourcePath = \str_replace(
'{' . 'purchaseOrderNumber' . '}',
ObjectSerializer::toPathValue($purchase_order_number),
$resourcePath
);
}
if ($multipart) {
$headers = [
'accept' => ['application/json'],
'host' => [$this->configuration->apiHost($region)],
'user-agent' => [$this->configuration->userAgent()],
];
} else {
$headers = [
'content-type' => ['application/json'],
'accept' => ['application/json'],
'host' => [$this->configuration->apiHost($region)],
'user-agent' => [$this->configuration->userAgent()],
];
}
$request = $this->httpFactory->createRequest(
'GET',
$this->configuration->apiURL($region) . $resourcePath . '?' . $query
);
// for model (json/xml)
if (\count($formParams) > 0) {
if ($multipart) {
$multipartContents = [];
foreach ($formParams as $formParamName => $formParamValue) {
$formParamValueItems = \is_array($formParamValue) ? $formParamValue : [$formParamValue];
foreach ($formParamValueItems as $formParamValueItem) {
$multipartContents[] = [
'name' => $formParamName,
'contents' => $formParamValueItem,
];
}
}
$request = $request->withParsedBody($multipartContents);
} elseif ($headers['content-type'] === ['application/json']) {
$request = $request->withBody($this->httpFactory->createStreamFromString(\json_encode($formParams, JSON_THROW_ON_ERROR)));
} else {
$request = $request->withParsedBody($formParams);
}
}
foreach (\array_merge($headerParams, $headers) as $name => $header) {
$request = $request->withHeader($name, $header);
}
return HttpSignatureHeaders::forConfig(
$this->configuration,
$accessToken,
$region,
$request
);
}
/**
* Operation getPurchaseOrders.
*
* @param null|int $limit The limit to the number of records returned. Default value is 100 records. (optional)
* @param null|\DateTimeInterface $created_after Purchase orders that became available after this time will be included in the result. Must be in ISO-8601 date/time format. (optional)
* @param null|\DateTimeInterface $created_before Purchase orders that became available before this time will be included in the result. Must be in ISO-8601 date/time format. (optional)
* @param null|string $sort_order Sort in ascending or descending order by purchase order creation date. (optional)
* @param null|string $next_token Used for pagination when there is more purchase orders than the specified result size limit. The token value is returned in the previous API call (optional)
* @param null|bool $include_details When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true. (optional)
* @param null|\DateTimeInterface $changed_after Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format. (optional)
* @param null|\DateTimeInterface $changed_before Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format. (optional)
* @param null|string $po_item_state Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero. (optional)
* @param null|bool $is_po_changed When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false. (optional)
* @param null|string $purchase_order_state Filters purchase orders based on the purchase order state. (optional)
* @param null|string $ordering_vendor_code Filters purchase orders based on the specified ordering vendor code. This value should be same as 'sellingParty.partyId' in the purchase order. If not included in the filter, all purchase orders for all of the vendor codes that exist in the vendor group used to authorize the API client application are returned. (optional)
*
* @throws ApiException on non-2xx response
* @throws InvalidArgumentException
*/
public function getPurchaseOrders(AccessToken $accessToken, string $region, ?int $limit = null, ?\DateTimeInterface $created_after = null, ?\DateTimeInterface $created_before = null, ?string $sort_order = null, ?string $next_token = null, ?bool $include_details = null, ?\DateTimeInterface $changed_after = null, ?\DateTimeInterface $changed_before = null, ?string $po_item_state = null, ?bool $is_po_changed = null, ?string $purchase_order_state = null, ?string $ordering_vendor_code = null) : \AmazonPHP\SellingPartner\Model\VendorOrders\GetPurchaseOrdersResponse
{
$request = $this->getPurchaseOrdersRequest($accessToken, $region, $limit, $created_after, $created_before, $sort_order, $next_token, $include_details, $changed_after, $changed_before, $po_item_state, $is_po_changed, $purchase_order_state, $ordering_vendor_code);
$this->configuration->extensions()->preRequest('VendorOrders', 'getPurchaseOrders', $request);
try {
$correlationId = $this->configuration->idGenerator()->generate();
$sanitizedRequest = $request;
foreach ($this->configuration->loggingSkipHeaders() as $sensitiveHeader) {
$sanitizedRequest = $sanitizedRequest->withoutHeader($sensitiveHeader);
}
if ($this->configuration->loggingEnabled('VendorOrders', 'getPurchaseOrders')) {
$this->logger->log(
$this->configuration->logLevel('VendorOrders', 'getPurchaseOrders'),
'Amazon Selling Partner API pre request',
[
'api' => 'VendorOrders',
'operation' => 'getPurchaseOrders',
'request_correlation_id' => $correlationId,
'request_body' => (string) $sanitizedRequest->getBody(),
'request_headers' => $sanitizedRequest->getHeaders(),
'request_uri' => (string) $sanitizedRequest->getUri(),
]
);
}
$response = $this->client->sendRequest($request);
$this->configuration->extensions()->postRequest('VendorOrders', 'getPurchaseOrders', $request, $response);
if ($this->configuration->loggingEnabled('VendorOrders', 'getPurchaseOrders')) {
$sanitizedResponse = $response;
foreach ($this->configuration->loggingSkipHeaders() as $sensitiveHeader) {
$sanitizedResponse = $sanitizedResponse->withoutHeader($sensitiveHeader);
}
$this->logger->log(
$this->configuration->logLevel('VendorOrders', 'getPurchaseOrders'),
'Amazon Selling Partner API post request',
[
'api' => 'VendorOrders',
'operation' => 'getPurchaseOrders',
'response_correlation_id' => $correlationId,
'response_body' => (string) $sanitizedResponse->getBody(),
'response_headers' => $sanitizedResponse->getHeaders(),
'response_status_code' => $sanitizedResponse->getStatusCode(),
'request_uri' => (string) $sanitizedRequest->getUri(),
'request_body' => (string) $sanitizedRequest->getBody(),
]
);
}
} catch (ClientExceptionInterface $e) {
throw new ApiException(
"[{$e->getCode()}] {$e->getMessage()}",
(int) $e->getCode(),
null,
null,
$e
);
}
$statusCode = $response->getStatusCode();
if ($statusCode < 200 || $statusCode > 299) {
throw new ApiException(
\sprintf(
'[%d] Error connecting to the API (%s)',
$statusCode,
(string) $request->getUri()
),
$statusCode,
$response->getHeaders(),
(string) $response->getBody()
);
}
return ObjectSerializer::deserialize(
$this->configuration,
(string) $response->getBody(),
'\AmazonPHP\SellingPartner\Model\VendorOrders\GetPurchaseOrdersResponse',
[]
);
}
/**
* Create request for operation 'getPurchaseOrders'.
*
* @param null|int $limit The limit to the number of records returned. Default value is 100 records. (optional)
* @param null|\DateTimeInterface $created_after Purchase orders that became available after this time will be included in the result. Must be in ISO-8601 date/time format. (optional)
* @param null|\DateTimeInterface $created_before Purchase orders that became available before this time will be included in the result. Must be in ISO-8601 date/time format. (optional)
* @param null|string $sort_order Sort in ascending or descending order by purchase order creation date. (optional)
* @param null|string $next_token Used for pagination when there is more purchase orders than the specified result size limit. The token value is returned in the previous API call (optional)
* @param null|bool $include_details When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true. (optional)
* @param null|\DateTimeInterface $changed_after Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format. (optional)
* @param null|\DateTimeInterface $changed_before Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format. (optional)
* @param null|string $po_item_state Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero. (optional)
* @param null|bool $is_po_changed When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false. (optional)
* @param null|string $purchase_order_state Filters purchase orders based on the purchase order state. (optional)
* @param null|string $ordering_vendor_code Filters purchase orders based on the specified ordering vendor code. This value should be same as 'sellingParty.partyId' in the purchase order. If not included in the filter, all purchase orders for all of the vendor codes that exist in the vendor group used to authorize the API client application are returned. (optional)
*
* @throws \AmazonPHP\SellingPartner\Exception\InvalidArgumentException
*/
public function getPurchaseOrdersRequest(AccessToken $accessToken, string $region, ?int $limit = null, ?\DateTimeInterface $created_after = null, ?\DateTimeInterface $created_before = null, ?string $sort_order = null, ?string $next_token = null, ?bool $include_details = null, ?\DateTimeInterface $changed_after = null, ?\DateTimeInterface $changed_before = null, ?string $po_item_state = null, ?bool $is_po_changed = null, ?string $purchase_order_state = null, ?string $ordering_vendor_code = null) : RequestInterface
{
if ($limit !== null && $limit > 100) {
throw new InvalidArgumentException('invalid value for "$limit" when calling VendorOrdersApi.getPurchaseOrders, must be smaller than or equal to 100.');
}
if ($limit !== null && $limit < 1) {
throw new InvalidArgumentException('invalid value for "$limit" when calling VendorOrdersApi.getPurchaseOrders, must be bigger than or equal to 1.');
}
$resourcePath = '/vendor/orders/v1/purchaseOrders';
$formParams = [];
$queryParams = [];
$headerParams = [];
$multipart = false;
$query = '';
// query params
if (\is_array($limit)) {
$limit = ObjectSerializer::serializeCollection($limit, '', true);
}
if ($limit !== null) {
$queryParams['limit'] = ObjectSerializer::toString($limit);
}
// query params
if (\is_array($created_after)) {
$created_after = ObjectSerializer::serializeCollection($created_after, '', true);
}
if ($created_after !== null) {
$queryParams['createdAfter'] = ObjectSerializer::toString($created_after);
}
// query params
if (\is_array($created_before)) {
$created_before = ObjectSerializer::serializeCollection($created_before, '', true);
}
if ($created_before !== null) {
$queryParams['createdBefore'] = ObjectSerializer::toString($created_before);
}
// query params
if (\is_array($sort_order)) {
$sort_order = ObjectSerializer::serializeCollection($sort_order, '', true);
}
if ($sort_order !== null) {
$queryParams['sortOrder'] = ObjectSerializer::toString($sort_order);
}
// query params
if (\is_array($next_token)) {
$next_token = ObjectSerializer::serializeCollection($next_token, '', true);
}
if ($next_token !== null) {
$queryParams['nextToken'] = ObjectSerializer::toString($next_token);
}
// query params
if (\is_array($include_details)) {
$include_details = ObjectSerializer::serializeCollection($include_details, '', true);
}
if ($include_details !== null) {
$queryParams['includeDetails'] = ObjectSerializer::toString($include_details);
}
// query params
if (\is_array($changed_after)) {
$changed_after = ObjectSerializer::serializeCollection($changed_after, '', true);
}
if ($changed_after !== null) {
$queryParams['changedAfter'] = ObjectSerializer::toString($changed_after);
}
// query params
if (\is_array($changed_before)) {
$changed_before = ObjectSerializer::serializeCollection($changed_before, '', true);
}
if ($changed_before !== null) {
$queryParams['changedBefore'] = ObjectSerializer::toString($changed_before);
}
// query params
if (\is_array($po_item_state)) {
$po_item_state = ObjectSerializer::serializeCollection($po_item_state, '', true);
}
if ($po_item_state !== null) {
$queryParams['poItemState'] = ObjectSerializer::toString($po_item_state);
}
// query params
if (\is_array($is_po_changed)) {
$is_po_changed = ObjectSerializer::serializeCollection($is_po_changed, '', true);
}
if ($is_po_changed !== null) {
$queryParams['isPOChanged'] = ObjectSerializer::toString($is_po_changed);
}
// query params
if (\is_array($purchase_order_state)) {
$purchase_order_state = ObjectSerializer::serializeCollection($purchase_order_state, '', true);
}
if ($purchase_order_state !== null) {
$queryParams['purchaseOrderState'] = ObjectSerializer::toString($purchase_order_state);
}
// query params
if (\is_array($ordering_vendor_code)) {
$ordering_vendor_code = ObjectSerializer::serializeCollection($ordering_vendor_code, '', true);
}
if ($ordering_vendor_code !== null) {
$queryParams['orderingVendorCode'] = ObjectSerializer::toString($ordering_vendor_code);
}
if (\count($queryParams)) {
$query = \http_build_query($queryParams);
}
if ($multipart) {
$headers = [
'accept' => ['application/json'],
'host' => [$this->configuration->apiHost($region)],
'user-agent' => [$this->configuration->userAgent()],
];
} else {
$headers = [
'content-type' => ['application/json'],
'accept' => ['application/json'],
'host' => [$this->configuration->apiHost($region)],
'user-agent' => [$this->configuration->userAgent()],
];
}
$request = $this->httpFactory->createRequest(
'GET',
$this->configuration->apiURL($region) . $resourcePath . '?' . $query
);
// for model (json/xml)
if (\count($formParams) > 0) {
if ($multipart) {
$multipartContents = [];
foreach ($formParams as $formParamName => $formParamValue) {
$formParamValueItems = \is_array($formParamValue) ? $formParamValue : [$formParamValue];
foreach ($formParamValueItems as $formParamValueItem) {
$multipartContents[] = [
'name' => $formParamName,
'contents' => $formParamValueItem,
];
}
}
$request = $request->withParsedBody($multipartContents);
} elseif ($headers['content-type'] === ['application/json']) {
$request = $request->withBody($this->httpFactory->createStreamFromString(\json_encode($formParams, JSON_THROW_ON_ERROR)));
} else {
$request = $request->withParsedBody($formParams);
}
}
foreach (\array_merge($headerParams, $headers) as $name => $header) {
$request = $request->withHeader($name, $header);
}
return HttpSignatureHeaders::forConfig(
$this->configuration,
$accessToken,
$region,
$request
);
}
/**
* Operation getPurchaseOrdersStatus.
*
* @param null|int $limit The limit to the number of records returned. Default value is 100 records. (optional)
* @param null|string $sort_order Sort in ascending or descending order by purchase order creation date. (optional)
* @param null|string $next_token Used for pagination when there are more purchase orders than the specified result size limit. (optional)
* @param null|\DateTimeInterface $created_after Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format. (optional)
* @param null|\DateTimeInterface $created_before Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format. (optional)
* @param null|\DateTimeInterface $updated_after Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO-8601 date/time format. (optional)
* @param null|\DateTimeInterface $updated_before Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO-8601 date/time format. (optional)
* @param null|string $purchase_order_number Provides purchase order status for the specified purchase order number. (optional)
* @param null|string $purchase_order_status Filters purchase orders based on the specified purchase order status. If not included in filter, this will return purchase orders for all statuses. (optional)
* @param null|string $item_confirmation_status Filters purchase orders based on their item confirmation status. If the item confirmation status is not included in the filter, purchase orders for all confirmation statuses are included. (optional)
* @param null|string $item_receive_status Filters purchase orders based on the purchase order's item receive status. If the item receive status is not included in the filter, purchase orders for all receive statuses are included. (optional)
* @param null|string $ordering_vendor_code Filters purchase orders based on the specified ordering vendor code. This value should be same as 'sellingParty.partyId' in the purchase order. If not included in filter, all purchase orders for all the vendor codes that exist in the vendor group used to authorize API client application are returned. (optional)
* @param null|string $ship_to_party_id Filters purchase orders for a specific buyer's Fulfillment Center/warehouse by providing ship to location id here. This value should be same as 'shipToParty.partyId' in the purchase order. If not included in filter, this will return purchase orders for all the buyer's warehouses used for vendor group purchase orders. (optional)
*
* @throws ApiException on non-2xx response
* @throws InvalidArgumentException
*/
public function getPurchaseOrdersStatus(AccessToken $accessToken, string $region, ?int $limit = null, ?string $sort_order = null, ?string $next_token = null, ?\DateTimeInterface $created_after = null, ?\DateTimeInterface $created_before = null, ?\DateTimeInterface $updated_after = null, ?\DateTimeInterface $updated_before = null, ?string $purchase_order_number = null, ?string $purchase_order_status = null, ?string $item_confirmation_status = null, ?string $item_receive_status = null, ?string $ordering_vendor_code = null, ?string $ship_to_party_id = null) : \AmazonPHP\SellingPartner\Model\VendorOrders\GetPurchaseOrdersStatusResponse
{
$request = $this->getPurchaseOrdersStatusRequest($accessToken, $region, $limit, $sort_order, $next_token, $created_after, $created_before, $updated_after, $updated_before, $purchase_order_number, $purchase_order_status, $item_confirmation_status, $item_receive_status, $ordering_vendor_code, $ship_to_party_id);
$this->configuration->extensions()->preRequest('VendorOrders', 'getPurchaseOrdersStatus', $request);
try {
$correlationId = $this->configuration->idGenerator()->generate();
$sanitizedRequest = $request;
foreach ($this->configuration->loggingSkipHeaders() as $sensitiveHeader) {
$sanitizedRequest = $sanitizedRequest->withoutHeader($sensitiveHeader);
}
if ($this->configuration->loggingEnabled('VendorOrders', 'getPurchaseOrdersStatus')) {
$this->logger->log(
$this->configuration->logLevel('VendorOrders', 'getPurchaseOrdersStatus'),
'Amazon Selling Partner API pre request',
[
'api' => 'VendorOrders',
'operation' => 'getPurchaseOrdersStatus',
'request_correlation_id' => $correlationId,
'request_body' => (string) $sanitizedRequest->getBody(),
'request_headers' => $sanitizedRequest->getHeaders(),
'request_uri' => (string) $sanitizedRequest->getUri(),
]
);
}
$response = $this->client->sendRequest($request);
$this->configuration->extensions()->postRequest('VendorOrders', 'getPurchaseOrdersStatus', $request, $response);
if ($this->configuration->loggingEnabled('VendorOrders', 'getPurchaseOrdersStatus')) {
$sanitizedResponse = $response;
foreach ($this->configuration->loggingSkipHeaders() as $sensitiveHeader) {
$sanitizedResponse = $sanitizedResponse->withoutHeader($sensitiveHeader);
}
$this->logger->log(
$this->configuration->logLevel('VendorOrders', 'getPurchaseOrdersStatus'),
'Amazon Selling Partner API post request',
[
'api' => 'VendorOrders',
'operation' => 'getPurchaseOrdersStatus',
'response_correlation_id' => $correlationId,
'response_body' => (string) $sanitizedResponse->getBody(),
'response_headers' => $sanitizedResponse->getHeaders(),
'response_status_code' => $sanitizedResponse->getStatusCode(),
'request_uri' => (string) $sanitizedRequest->getUri(),
'request_body' => (string) $sanitizedRequest->getBody(),
]
);
}
} catch (ClientExceptionInterface $e) {
throw new ApiException(
"[{$e->getCode()}] {$e->getMessage()}",
(int) $e->getCode(),
null,
null,
$e
);
}
$statusCode = $response->getStatusCode();
if ($statusCode < 200 || $statusCode > 299) {
throw new ApiException(
\sprintf(
'[%d] Error connecting to the API (%s)',
$statusCode,
(string) $request->getUri()
),
$statusCode,
$response->getHeaders(),
(string) $response->getBody()
);
}
return ObjectSerializer::deserialize(
$this->configuration,
(string) $response->getBody(),
'\AmazonPHP\SellingPartner\Model\VendorOrders\GetPurchaseOrdersStatusResponse',
[]
);
}
/**
* Create request for operation 'getPurchaseOrdersStatus'.
*
* @param null|int $limit The limit to the number of records returned. Default value is 100 records. (optional)
* @param null|string $sort_order Sort in ascending or descending order by purchase order creation date. (optional)
* @param null|string $next_token Used for pagination when there are more purchase orders than the specified result size limit. (optional)
* @param null|\DateTimeInterface $created_after Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format. (optional)
* @param null|\DateTimeInterface $created_before Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format. (optional)
* @param null|\DateTimeInterface $updated_after Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO-8601 date/time format. (optional)
* @param null|\DateTimeInterface $updated_before Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO-8601 date/time format. (optional)
* @param null|string $purchase_order_number Provides purchase order status for the specified purchase order number. (optional)
* @param null|string $purchase_order_status Filters purchase orders based on the specified purchase order status. If not included in filter, this will return purchase orders for all statuses. (optional)
* @param null|string $item_confirmation_status Filters purchase orders based on their item confirmation status. If the item confirmation status is not included in the filter, purchase orders for all confirmation statuses are included. (optional)
* @param null|string $item_receive_status Filters purchase orders based on the purchase order's item receive status. If the item receive status is not included in the filter, purchase orders for all receive statuses are included. (optional)
* @param null|string $ordering_vendor_code Filters purchase orders based on the specified ordering vendor code. This value should be same as 'sellingParty.partyId' in the purchase order. If not included in filter, all purchase orders for all the vendor codes that exist in the vendor group used to authorize API client application are returned. (optional)
* @param null|string $ship_to_party_id Filters purchase orders for a specific buyer's Fulfillment Center/warehouse by providing ship to location id here. This value should be same as 'shipToParty.partyId' in the purchase order. If not included in filter, this will return purchase orders for all the buyer's warehouses used for vendor group purchase orders. (optional)
*
* @throws \AmazonPHP\SellingPartner\Exception\InvalidArgumentException
*/
public function getPurchaseOrdersStatusRequest(AccessToken $accessToken, string $region, ?int $limit = null, ?string $sort_order = null, ?string $next_token = null, ?\DateTimeInterface $created_after = null, ?\DateTimeInterface $created_before = null, ?\DateTimeInterface $updated_after = null, ?\DateTimeInterface $updated_before = null, ?string $purchase_order_number = null, ?string $purchase_order_status = null, ?string $item_confirmation_status = null, ?string $item_receive_status = null, ?string $ordering_vendor_code = null, ?string $ship_to_party_id = null) : RequestInterface
{
if ($limit !== null && $limit > 100) {
throw new InvalidArgumentException('invalid value for "$limit" when calling VendorOrdersApi.getPurchaseOrdersStatus, must be smaller than or equal to 100.');
}
if ($limit !== null && $limit < 1) {
throw new InvalidArgumentException('invalid value for "$limit" when calling VendorOrdersApi.getPurchaseOrdersStatus, must be bigger than or equal to 1.');
}
$resourcePath = '/vendor/orders/v1/purchaseOrdersStatus';
$formParams = [];
$queryParams = [];
$headerParams = [];
$multipart = false;
$query = '';
// query params
if (\is_array($limit)) {
$limit = ObjectSerializer::serializeCollection($limit, '', true);
}
if ($limit !== null) {
$queryParams['limit'] = ObjectSerializer::toString($limit);
}
// query params
if (\is_array($sort_order)) {
$sort_order = ObjectSerializer::serializeCollection($sort_order, '', true);
}
if ($sort_order !== null) {
$queryParams['sortOrder'] = ObjectSerializer::toString($sort_order);
}
// query params
if (\is_array($next_token)) {
$next_token = ObjectSerializer::serializeCollection($next_token, '', true);
}
if ($next_token !== null) {
$queryParams['nextToken'] = ObjectSerializer::toString($next_token);
}
// query params
if (\is_array($created_after)) {
$created_after = ObjectSerializer::serializeCollection($created_after, '', true);
}
if ($created_after !== null) {
$queryParams['createdAfter'] = ObjectSerializer::toString($created_after);
}
// query params
if (\is_array($created_before)) {
$created_before = ObjectSerializer::serializeCollection($created_before, '', true);
}
if ($created_before !== null) {
$queryParams['createdBefore'] = ObjectSerializer::toString($created_before);
}
// query params
if (\is_array($updated_after)) {
$updated_after = ObjectSerializer::serializeCollection($updated_after, '', true);
}
if ($updated_after !== null) {
$queryParams['updatedAfter'] = ObjectSerializer::toString($updated_after);
}
// query params
if (\is_array($updated_before)) {
$updated_before = ObjectSerializer::serializeCollection($updated_before, '', true);
}
if ($updated_before !== null) {
$queryParams['updatedBefore'] = ObjectSerializer::toString($updated_before);
}
// query params
if (\is_array($purchase_order_number)) {
$purchase_order_number = ObjectSerializer::serializeCollection($purchase_order_number, '', true);
}
if ($purchase_order_number !== null) {
$queryParams['purchaseOrderNumber'] = ObjectSerializer::toString($purchase_order_number);
}
// query params
if (\is_array($purchase_order_status)) {
$purchase_order_status = ObjectSerializer::serializeCollection($purchase_order_status, '', true);
}
if ($purchase_order_status !== null) {
$queryParams['purchaseOrderStatus'] = ObjectSerializer::toString($purchase_order_status);
}
// query params
if (\is_array($item_confirmation_status)) {
$item_confirmation_status = ObjectSerializer::serializeCollection($item_confirmation_status, '', true);
}
if ($item_confirmation_status !== null) {
$queryParams['itemConfirmationStatus'] = ObjectSerializer::toString($item_confirmation_status);
}
// query params
if (\is_array($item_receive_status)) {
$item_receive_status = ObjectSerializer::serializeCollection($item_receive_status, '', true);
}
if ($item_receive_status !== null) {
$queryParams['itemReceiveStatus'] = ObjectSerializer::toString($item_receive_status);
}
// query params
if (\is_array($ordering_vendor_code)) {
$ordering_vendor_code = ObjectSerializer::serializeCollection($ordering_vendor_code, '', true);
}
if ($ordering_vendor_code !== null) {
$queryParams['orderingVendorCode'] = ObjectSerializer::toString($ordering_vendor_code);
}
// query params
if (\is_array($ship_to_party_id)) {
$ship_to_party_id = ObjectSerializer::serializeCollection($ship_to_party_id, '', true);
}
if ($ship_to_party_id !== null) {
$queryParams['shipToPartyId'] = ObjectSerializer::toString($ship_to_party_id);
}
if (\count($queryParams)) {
$query = \http_build_query($queryParams);
}
if ($multipart) {
$headers = [
'accept' => ['application/json'],
'host' => [$this->configuration->apiHost($region)],
'user-agent' => [$this->configuration->userAgent()],
];
} else {
$headers = [
'content-type' => ['application/json'],
'accept' => ['application/json'],
'host' => [$this->configuration->apiHost($region)],
'user-agent' => [$this->configuration->userAgent()],
];
}
$request = $this->httpFactory->createRequest(
'GET',
$this->configuration->apiURL($region) . $resourcePath . '?' . $query
);
// for model (json/xml)
if (\count($formParams) > 0) {
if ($multipart) {
$multipartContents = [];
foreach ($formParams as $formParamName => $formParamValue) {
$formParamValueItems = \is_array($formParamValue) ? $formParamValue : [$formParamValue];
foreach ($formParamValueItems as $formParamValueItem) {
$multipartContents[] = [
'name' => $formParamName,
'contents' => $formParamValueItem,
];
}
}
$request = $request->withParsedBody($multipartContents);
} elseif ($headers['content-type'] === ['application/json']) {
$request = $request->withBody($this->httpFactory->createStreamFromString(\json_encode($formParams, JSON_THROW_ON_ERROR)));
} else {
$request = $request->withParsedBody($formParams);
}
}
foreach (\array_merge($headerParams, $headers) as $name => $header) {
$request = $request->withHeader($name, $header);
}
return HttpSignatureHeaders::forConfig(
$this->configuration,
$accessToken,
$region,
$request
);
}
/**
* Operation submitAcknowledgement.
*
* @param \AmazonPHP\SellingPartner\Model\VendorOrders\SubmitAcknowledgementRequest $body body (required)
*
* @throws ApiException on non-2xx response
* @throws InvalidArgumentException
*/
public function submitAcknowledgement(AccessToken $accessToken, string $region, \AmazonPHP\SellingPartner\Model\VendorOrders\SubmitAcknowledgementRequest $body) : \AmazonPHP\SellingPartner\Model\VendorOrders\SubmitAcknowledgementResponse
{
$request = $this->submitAcknowledgementRequest($accessToken, $region, $body);
$this->configuration->extensions()->preRequest('VendorOrders', 'submitAcknowledgement', $request);
try {
$correlationId = $this->configuration->idGenerator()->generate();
$sanitizedRequest = $request;
foreach ($this->configuration->loggingSkipHeaders() as $sensitiveHeader) {
$sanitizedRequest = $sanitizedRequest->withoutHeader($sensitiveHeader);
}
if ($this->configuration->loggingEnabled('VendorOrders', 'submitAcknowledgement')) {
$this->logger->log(
$this->configuration->logLevel('VendorOrders', 'submitAcknowledgement'),
'Amazon Selling Partner API pre request',
[
'api' => 'VendorOrders',
'operation' => 'submitAcknowledgement',
'request_correlation_id' => $correlationId,
'request_body' => (string) $sanitizedRequest->getBody(),
'request_headers' => $sanitizedRequest->getHeaders(),
'request_uri' => (string) $sanitizedRequest->getUri(),
]
);
}
$response = $this->client->sendRequest($request);
$this->configuration->extensions()->postRequest('VendorOrders', 'submitAcknowledgement', $request, $response);
if ($this->configuration->loggingEnabled('VendorOrders', 'submitAcknowledgement')) {
$sanitizedResponse = $response;
foreach ($this->configuration->loggingSkipHeaders() as $sensitiveHeader) {
$sanitizedResponse = $sanitizedResponse->withoutHeader($sensitiveHeader);
}
$this->logger->log(
$this->configuration->logLevel('VendorOrders', 'submitAcknowledgement'),
'Amazon Selling Partner API post request',
[
'api' => 'VendorOrders',
'operation' => 'submitAcknowledgement',
'response_correlation_id' => $correlationId,
'response_body' => (string) $sanitizedResponse->getBody(),
'response_headers' => $sanitizedResponse->getHeaders(),
'response_status_code' => $sanitizedResponse->getStatusCode(),
'request_uri' => (string) $sanitizedRequest->getUri(),
'request_body' => (string) $sanitizedRequest->getBody(),
]
);
}
} catch (ClientExceptionInterface $e) {
throw new ApiException(
"[{$e->getCode()}] {$e->getMessage()}",
(int) $e->getCode(),
null,
null,
$e
);
}
$statusCode = $response->getStatusCode();
if ($statusCode < 200 || $statusCode > 299) {
throw new ApiException(
\sprintf(
'[%d] Error connecting to the API (%s)',
$statusCode,
(string) $request->getUri()
),
$statusCode,
$response->getHeaders(),
(string) $response->getBody()
);
}
return ObjectSerializer::deserialize(
$this->configuration,
(string) $response->getBody(),
'\AmazonPHP\SellingPartner\Model\VendorOrders\SubmitAcknowledgementResponse',
[]
);
}
/**
* Create request for operation 'submitAcknowledgement'.
*
* @param \AmazonPHP\SellingPartner\Model\VendorOrders\SubmitAcknowledgementRequest $body (required)
*
* @throws \AmazonPHP\SellingPartner\Exception\InvalidArgumentException
*/
public function submitAcknowledgementRequest(AccessToken $accessToken, string $region, \AmazonPHP\SellingPartner\Model\VendorOrders\SubmitAcknowledgementRequest $body) : RequestInterface
{
// verify the required parameter 'body' is set
if ($body === null || (\is_array($body) && \count($body) === 0)) {
throw new InvalidArgumentException(
'Missing the required parameter $body when calling submitAcknowledgement'
);
}
$resourcePath = '/vendor/orders/v1/acknowledgements';
$formParams = [];
$queryParams = [];
$headerParams = [];
$multipart = false;
$query = '';
if (\count($queryParams)) {
$query = \http_build_query($queryParams);
}
if ($multipart) {
$headers = [
'accept' => ['application/json'],
'host' => [$this->configuration->apiHost($region)],
'user-agent' => [$this->configuration->userAgent()],
];
} else {
$headers = [
'content-type' => ['application/json'],
'accept' => ['application/json'],
'host' => [$this->configuration->apiHost($region)],
'user-agent' => [$this->configuration->userAgent()],
];
}
$request = $this->httpFactory->createRequest(
'POST',
$this->configuration->apiURL($region) . $resourcePath . '?' . $query
);
// for model (json/xml)
if (isset($body)) {
if ($headers['content-type'] === ['application/json']) {
$httpBody = \json_encode(ObjectSerializer::sanitizeForSerialization($body), JSON_THROW_ON_ERROR);
} else {
$httpBody = $body;
}
$request = $request->withBody($this->httpFactory->createStreamFromString($httpBody));
} elseif (\count($formParams) > 0) {
if ($multipart) {
$multipartContents = [];
foreach ($formParams as $formParamName => $formParamValue) {
$formParamValueItems = \is_array($formParamValue) ? $formParamValue : [$formParamValue];
foreach ($formParamValueItems as $formParamValueItem) {
$multipartContents[] = [
'name' => $formParamName,
'contents' => $formParamValueItem,
];
}
}
$request = $request->withParsedBody($multipartContents);
} elseif ($headers['content-type'] === ['application/json']) {
$request = $request->withBody($this->httpFactory->createStreamFromString(\json_encode($formParams, JSON_THROW_ON_ERROR)));
} else {
$request = $request->withParsedBody($formParams);
}
}