<?php

/**
 * This file is auto-generated by Saloon SDK Generator
 * Generator: SellingPartnerApi\Generator\Generators\RequestGenerator
 * Do not modify it directly.
 */

declare(strict_types=1);

namespace SellingPartnerApi\Seller\OrdersV0\Requests;

use Exception;
use Saloon\Enums\Method;
use Saloon\Http\Response;
use SellingPartnerApi\Middleware\RestrictedDataToken;
use SellingPartnerApi\Request;
use SellingPartnerApi\Seller\OrdersV0\Responses\GetOrdersResponse;

/**
 * getOrders
 */
class GetOrders extends Request
{
    protected Method $method = Method::GET;

    /**
     * @param  array  $marketplaceIds  A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces.
     *
     * Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `MarketplaceId` values.
     * @param  ?string  $createdAfter  A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.
     *
     * **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. You could specify `CreatedBefore` but not provide `LastUpdatedAfter` or `LastUpdatedBefore` when `CreatedAfter` is specified.
     * @param  ?string  $createdBefore  A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.
     *
     * **Note**: `CreatedBefore` is optional when `CreatedAfter` is specified. But if specified, `CreatedBefore` should be equal to or after the `CreatedAfter` date and at least 2 minutes before the current time.
     * @param  ?string  $lastUpdatedAfter  A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.
     *
     * **Note**: `LastUpdatedBefore` is optional when `LastUpdatedAfter` is specified. But if specified, `LastUpdatedBefore` should be equal to or after the `LastUpdatedAfter` date and at least 2 minutes before current time.
     * @param  ?string  $lastUpdatedBefore  A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.
     *
     * **Note**: LastUpdatedBefore is optional when LastUpdatedAfter is set. But if specified, LastUpdatedBefore should be equal to or after the LastUpdatedAfter date and at least 2 minutes before current time.
     * @param  ?array  $orderStatuses  A list of `OrderStatus` values used to filter the results.
     *
     * **Possible values:**
     * - `PendingAvailability` (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.)
     * - `Pending` (The order has been placed but payment has not been authorized.)
     * - `Unshipped` (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped.)
     * - `PartiallyShipped` (One or more, but not all, items in the order have been shipped.)
     * - `Shipped` (All items in the order have been shipped.)
     * - `InvoiceUnconfirmed` (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.)
     * - `Canceled` (The order has been canceled.)
     * - `Unfulfillable` (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.)
     * @param  ?array  $fulfillmentChannels  A list that indicates how an order was fulfilled. Filters the results by fulfillment channel.
     *
     * **Possible values**: `AFN` (Fulfillment by Amazon); `MFN` (Fulfilled by the seller).
     * @param  ?array  $paymentMethods  A list of payment method values. Used to select orders paid using the specified payment methods.
     *
     * **Possible values**: `COD` (Cash on delivery); `CVS` (Convenience store payment); `Other` (Any payment method other than `COD` or `CVS`).
     * @param  ?string  $buyerEmail  The email address of a buyer. Used to select orders that contain the specified email address.
     * @param  ?string  $sellerOrderId  An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified.
     * @param  ?int  $maxResultsPerPage  A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100.
     * @param  ?array  $easyShipShipmentStatuses  A list of `EasyShipShipmentStatus` values. Used to select Easy Ship orders with statuses that match the specified values. If `EasyShipShipmentStatus` is specified, only Amazon Easy Ship orders are returned.
     *
     * **Possible values:**
     * - `PendingSchedule` (The package is awaiting the schedule for pick-up.)
     * - `PendingPickUp` (Amazon has not yet picked up the package from the seller.)
     * - `PendingDropOff` (The seller will deliver the package to the carrier.)
     * - `LabelCanceled` (The seller canceled the pickup.)
     * - `PickedUp` (Amazon has picked up the package from the seller.)
     * - `DroppedOff` (The package is delivered to the carrier by the seller.)
     * - `AtOriginFC` (The packaged is at the origin fulfillment center.)
     * - `AtDestinationFC` (The package is at the destination fulfillment center.)
     * - `Delivered` (The package has been delivered.)
     * - `RejectedByBuyer` (The package has been rejected by the buyer.)
     * - `Undeliverable` (The package cannot be delivered.)
     * - `ReturningToSeller` (The package was not delivered and is being returned to the seller.)
     * - `ReturnedToSeller` (The package was not delivered and was returned to the seller.)
     * - `Lost` (The package is lost.)
     * - `OutForDelivery` (The package is out for delivery.)
     * - `Damaged` (The package was damaged by the carrier.)
     * @param  ?array  $electronicInvoiceStatuses  A list of `ElectronicInvoiceStatus` values. Used to select orders with electronic invoice statuses that match the specified values.
     *
     * **Possible values:**
     * - `NotRequired` (Electronic invoice submission is not required for this order.)
     * - `NotFound` (The electronic invoice was not submitted for this order.)
     * - `Processing` (The electronic invoice is being processed for this order.)
     * - `Errored` (The last submitted electronic invoice was rejected for this order.)
     * - `Accepted` (The last submitted electronic invoice was submitted and accepted.)
     * @param  ?string  $nextToken  A string token returned in the response of your previous request.
     * @param  ?array  $amazonOrderIds  A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
     * @param  ?string  $actualFulfillmentSupplySourceId  Denotes the recommended sourceId where the order should be fulfilled from.
     * @param  ?bool  $isIspu  When true, this order is marked to be picked up from a store rather than delivered.
     * @param  ?string  $storeChainStoreId  The store chain store identifier. Linked to a specific store in a store chain.
     * @param  ?string  $earliestDeliveryDateBefore  A date used for selecting orders with a earliest delivery date before (or at) a specified time. The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.
     * @param  ?string  $earliestDeliveryDateAfter  A date used for selecting orders with a earliest delivery date after (or at) a specified time. The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.
     * @param  ?string  $latestDeliveryDateBefore  A date used for selecting orders with a latest delivery date before (or at) a specified time. The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.
     * @param  ?string  $latestDeliveryDateAfter  A date used for selecting orders with a latest delivery date after (or at) a specified time. The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.
     */
    public function __construct(
        protected array $marketplaceIds,
        protected ?string $createdAfter = null,
        protected ?string $createdBefore = null,
        protected ?string $lastUpdatedAfter = null,
        protected ?string $lastUpdatedBefore = null,
        protected ?array $orderStatuses = null,
        protected ?array $fulfillmentChannels = null,
        protected ?array $paymentMethods = null,
        protected ?string $buyerEmail = null,
        protected ?string $sellerOrderId = null,
        protected ?int $maxResultsPerPage = null,
        protected ?array $easyShipShipmentStatuses = null,
        protected ?array $electronicInvoiceStatuses = null,
        protected ?string $nextToken = null,
        protected ?array $amazonOrderIds = null,
        protected ?string $actualFulfillmentSupplySourceId = null,
        protected ?bool $isIspu = null,
        protected ?string $storeChainStoreId = null,
        protected ?string $earliestDeliveryDateBefore = null,
        protected ?string $earliestDeliveryDateAfter = null,
        protected ?string $latestDeliveryDateBefore = null,
        protected ?string $latestDeliveryDateAfter = null,
    ) {
        $rdtMiddleware = new RestrictedDataToken('/orders/v0/orders', 'GET', ['buyerInfo', 'shippingAddress']);
        $this->middleware()->onRequest($rdtMiddleware);
    }

    public function defaultQuery(): array
    {
        return array_filter([
            'MarketplaceIds' => $this->marketplaceIds,
            'CreatedAfter' => $this->createdAfter,
            'CreatedBefore' => $this->createdBefore,
            'LastUpdatedAfter' => $this->lastUpdatedAfter,
            'LastUpdatedBefore' => $this->lastUpdatedBefore,
            'OrderStatuses' => $this->orderStatuses,
            'FulfillmentChannels' => $this->fulfillmentChannels,
            'PaymentMethods' => $this->paymentMethods,
            'BuyerEmail' => $this->buyerEmail,
            'SellerOrderId' => $this->sellerOrderId,
            'MaxResultsPerPage' => $this->maxResultsPerPage,
            'EasyShipShipmentStatuses' => $this->easyShipShipmentStatuses,
            'ElectronicInvoiceStatuses' => $this->electronicInvoiceStatuses,
            'NextToken' => $this->nextToken,
            'AmazonOrderIds' => $this->amazonOrderIds,
            'ActualFulfillmentSupplySourceId' => $this->actualFulfillmentSupplySourceId,
            'IsISPU' => $this->isIspu,
            'StoreChainStoreId' => $this->storeChainStoreId,
            'EarliestDeliveryDateBefore' => $this->earliestDeliveryDateBefore,
            'EarliestDeliveryDateAfter' => $this->earliestDeliveryDateAfter,
            'LatestDeliveryDateBefore' => $this->latestDeliveryDateBefore,
            'LatestDeliveryDateAfter' => $this->latestDeliveryDateAfter,
        ]);
    }

    public function resolveEndpoint(): string
    {
        return '/orders/v0/orders';
    }

    public function createDtoFromResponse(Response $response): GetOrdersResponse
    {
        $status = $response->status();
        $responseCls = match ($status) {
            200, 400, 403, 404, 429, 500, 503 => GetOrdersResponse::class,
            default => throw new Exception("Unhandled response status: {$status}")
        };

        return $responseCls::deserialize($response->json(), $responseCls);
    }
}
