ebay-api 9.4.3 → 10.0.0-RC.1

package/lib/types/restful/specs/buy_order_v2_oas3.d.ts

@@ -0,0 +1,470 @@
+export interface paths {
+    "/guest_checkout_session/{checkoutSessionId}/apply_coupon": {
+        post: operations["applyGuestCoupon"];
+    };
+    "/guest_checkout_session/{checkoutSessionId}": {
+        get: operations["getGuestCheckoutSession"];
+    };
+    "/guest_checkout_session/initiate": {
+        post: operations["initiateGuestCheckoutSession"];
+    };
+    "/guest_checkout_session/{checkoutSessionId}/remove_coupon": {
+        post: operations["removeGuestCoupon"];
+    };
+    "/guest_checkout_session/{checkoutSessionId}/update_quantity": {
+        post: operations["updateGuestQuantity"];
+    };
+    "/guest_checkout_session/{checkoutSessionId}/update_shipping_address": {
+        post: operations["updateGuestShippingAddress"];
+    };
+    "/guest_checkout_session/{checkoutSessionId}/update_shipping_option": {
+        post: operations["updateGuestShippingOption"];
+    };
+    "/guest_purchase_order/{purchaseOrderId}": {
+        get: operations["getGuestPurchaseOrder"];
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        Adjustment: {
+            amount?: components["schemas"]["Amount"];
+            label?: string;
+        };
+        Amount: {
+            currency?: string;
+            value?: string;
+        };
+        AuthenticityVerificationProgram: {
+            description?: string;
+            outcomeReason?: string;
+            status?: string;
+            termsWebUrl?: string;
+        };
+        Coupon: {
+            redemptionCode?: string;
+        };
+        CouponRequest: {
+            redemptionCode?: string;
+        };
+        CreateGuestCheckoutSessionRequestV2: {
+            contactEmail?: string;
+            lineItemInputs?: (components["schemas"]["LineItemInput"])[];
+            shippingAddress?: components["schemas"]["ShippingAddress"];
+        };
+        Error: {
+            category?: string;
+            domain?: string;
+            errorId?: number;
+            inputRefIds?: (string)[];
+            longMessage?: string;
+            message?: string;
+            outputRefIds?: (string)[];
+            parameters?: (components["schemas"]["ErrorParameter"])[];
+            subdomain?: string;
+        };
+        ErrorParameter: {
+            name?: string;
+            value?: string;
+        };
+        Fee: {
+            amount?: components["schemas"]["Amount"];
+            feeType?: string;
+        };
+        GuestCheckoutSessionResponseV2: {
+            appliedCoupons?: (components["schemas"]["Coupon"])[];
+            checkoutSessionId?: string;
+            lineItems?: (components["schemas"]["LineItem"])[];
+            pricingSummary?: components["schemas"]["PricingSummaryV2"];
+            shippingAddress?: components["schemas"]["ShippingAddress"];
+            warnings?: (components["schemas"]["Error"])[];
+        };
+        GuestPurchaseOrderV2: {
+            lineItems?: (components["schemas"]["OrderLineItemV2"])[];
+            pricingSummary?: components["schemas"]["PricingSummary"];
+            purchaseOrderCreationDate?: string;
+            purchaseOrderId?: string;
+            purchaseOrderPaymentStatus?: string;
+            purchaseOrderStatus?: string;
+            refundedAmount?: components["schemas"]["Amount"];
+            warnings?: (components["schemas"]["Error"])[];
+        };
+        Image: {
+            imageUrl?: string;
+        };
+        ImportChargesV2: {
+            amount?: components["schemas"]["Amount"];
+            applicableChargeType?: string;
+        };
+        ImportTax: {
+            amount?: components["schemas"]["Amount"];
+            importTaxType?: string;
+        };
+        LegacyReference: {
+            legacyItemId?: string;
+            legacyOrderId?: string;
+            legacyTransactionId?: string;
+        };
+        LineItem: {
+            authenticityVerification?: components["schemas"]["AuthenticityVerificationProgram"];
+            baseUnitPrice?: components["schemas"]["Amount"];
+            fees?: (components["schemas"]["Fee"])[];
+            image?: components["schemas"]["Image"];
+            itemId?: string;
+            lineItemId?: string;
+            netPrice?: components["schemas"]["Amount"];
+            promotions?: (components["schemas"]["Promotion"])[];
+            quantity?: number;
+            seller?: components["schemas"]["Seller"];
+            shippingOptions?: (components["schemas"]["ShippingOption"])[];
+            taxDetails?: (components["schemas"]["TaxDetail"])[];
+            title?: string;
+        };
+        LineItemInput: {
+            itemId?: string;
+            quantity?: number;
+        };
+        OrderLineItemV2: {
+            authenticityVerification?: components["schemas"]["AuthenticityVerificationProgram"];
+            baseUnitPrice?: components["schemas"]["Amount"];
+            fees?: (components["schemas"]["Fee"])[];
+            image?: components["schemas"]["Image"];
+            itemId?: string;
+            itemOnHold?: boolean;
+            legacyReference?: components["schemas"]["LegacyReference"];
+            lineItemId?: string;
+            lineItemPaymentStatus?: string;
+            lineItemStatus?: string;
+            netPrice?: components["schemas"]["Amount"];
+            orderId?: string;
+            promotions?: (components["schemas"]["Promotion"])[];
+            quantity?: number;
+            seller?: components["schemas"]["Seller"];
+            shippingDetail?: components["schemas"]["ShippingDetail"];
+            taxDetails?: (components["schemas"]["TaxDetail"])[];
+            title?: string;
+        };
+        PricingSummary: {
+            additionalSavings?: components["schemas"]["Amount"];
+            adjustment?: components["schemas"]["Adjustment"];
+            deliveryCost?: components["schemas"]["Amount"];
+            deliveryDiscount?: components["schemas"]["Amount"];
+            fee?: components["schemas"]["Amount"];
+            importCharges?: components["schemas"]["Amount"];
+            importTax?: components["schemas"]["ImportTax"];
+            priceDiscount?: components["schemas"]["Amount"];
+            priceSubtotal?: components["schemas"]["Amount"];
+            tax?: components["schemas"]["Amount"];
+            total?: components["schemas"]["Amount"];
+        };
+        PricingSummaryV2: {
+            additionalSavings?: components["schemas"]["Amount"];
+            adjustment?: components["schemas"]["Adjustment"];
+            deliveryCost?: components["schemas"]["Amount"];
+            fee?: components["schemas"]["Amount"];
+            importCharges?: components["schemas"]["ImportChargesV2"];
+            importTax?: components["schemas"]["ImportTax"];
+            priceDiscount?: components["schemas"]["Amount"];
+            priceSubtotal?: components["schemas"]["Amount"];
+            tax?: components["schemas"]["Amount"];
+            total?: components["schemas"]["Amount"];
+        };
+        Promotion: {
+            discount?: components["schemas"]["Amount"];
+            message?: string;
+            promotionType?: string;
+        };
+        Recipient: {
+            firstName?: string;
+            lastName?: string;
+        };
+        Region: {
+            regionName?: string;
+            regionType?: string;
+        };
+        Seller: {
+            username?: string;
+        };
+        ShippingAddress: {
+            addressLine1?: string;
+            addressLine2?: string;
+            city?: string;
+            country?: string;
+            county?: string;
+            phoneNumber?: string;
+            postalCode?: string;
+            recipient?: components["schemas"]["Recipient"];
+            stateOrProvince?: string;
+        };
+        ShippingAddressImpl: {
+            addressLine1?: string;
+            addressLine2?: string;
+            city?: string;
+            country?: string;
+            county?: string;
+            phoneNumber?: string;
+            postalCode?: string;
+            recipient?: components["schemas"]["Recipient"];
+            stateOrProvince?: string;
+        };
+        ShippingDetail: {
+            maxEstimatedDeliveryDate?: string;
+            minEstimatedDeliveryDate?: string;
+            shippingCarrierCode?: string;
+            shippingServiceCode?: string;
+        };
+        ShippingOption: {
+            baseDeliveryCost?: components["schemas"]["Amount"];
+            deliveryDiscount?: components["schemas"]["Amount"];
+            importCharges?: components["schemas"]["Amount"];
+            maxEstimatedDeliveryDate?: string;
+            minEstimatedDeliveryDate?: string;
+            selected?: boolean;
+            shippingCarrierCode?: string;
+            shippingOptionId?: string;
+            shippingServiceCode?: string;
+        };
+        TaxDetail: {
+            includedInPrice?: boolean;
+            taxJurisdiction?: components["schemas"]["TaxJurisdiction"];
+            taxType?: string;
+        };
+        TaxJurisdiction: {
+            region?: components["schemas"]["Region"];
+            taxJurisdictionId?: string;
+        };
+        UpdateQuantity: {
+            lineItemId?: string;
+            quantity?: number;
+        };
+        UpdateShippingOption: {
+            lineItemId?: string;
+            shippingOptionId?: string;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type external = Record<string, never>;
+export interface operations {
+    applyGuestCoupon: {
+        parameters: {
+            header: {
+                "X-EBAY-C-MARKETPLACE-ID": string;
+                "Content-Type": string;
+                "X-EBAY-C-ENDUSERCTX"?: string;
+            };
+            path: {
+                checkoutSessionId: string;
+            };
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["CouponRequest"];
+            };
+        };
+        responses: {
+            200: {
+                content: {
+                    "application/json": components["schemas"]["GuestCheckoutSessionResponseV2"];
+                };
+            };
+            400: never;
+            403: never;
+            404: never;
+            409: never;
+            500: never;
+        };
+    };
+    getGuestCheckoutSession: {
+        parameters: {
+            header: {
+                "X-EBAY-C-MARKETPLACE-ID": string;
+                "X-EBAY-C-ENDUSERCTX"?: string;
+            };
+            path: {
+                checkoutSessionId: string;
+            };
+        };
+        responses: {
+            200: {
+                content: {
+                    "application/json": components["schemas"]["GuestCheckoutSessionResponseV2"];
+                };
+            };
+            400: never;
+            403: never;
+            404: never;
+            409: never;
+            500: never;
+        };
+    };
+    initiateGuestCheckoutSession: {
+        parameters: {
+            header: {
+                "X-EBAY-C-ENDUSERCTX"?: string;
+                "X-EBAY-C-MARKETPLACE-ID": string;
+                "Content-Type": string;
+            };
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["CreateGuestCheckoutSessionRequestV2"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    "X-EBAY-SECURITY-SIGNATURE"?: string;
+                };
+                content: {
+                    "application/json": components["schemas"]["GuestCheckoutSessionResponseV2"];
+                };
+            };
+            400: never;
+            409: never;
+            500: never;
+        };
+    };
+    removeGuestCoupon: {
+        parameters: {
+            header: {
+                "X-EBAY-C-MARKETPLACE-ID": string;
+                "Content-Type": string;
+                "X-EBAY-C-ENDUSERCTX"?: string;
+            };
+            path: {
+                checkoutSessionId: string;
+            };
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["CouponRequest"];
+            };
+        };
+        responses: {
+            200: {
+                content: {
+                    "application/json": components["schemas"]["GuestCheckoutSessionResponseV2"];
+                };
+            };
+            400: never;
+            403: never;
+            404: never;
+            409: never;
+            500: never;
+        };
+    };
+    updateGuestQuantity: {
+        parameters: {
+            header: {
+                "X-EBAY-C-MARKETPLACE-ID": string;
+                "Content-Type": string;
+                "X-EBAY-C-ENDUSERCTX"?: string;
+            };
+            path: {
+                checkoutSessionId: string;
+            };
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["UpdateQuantity"];
+            };
+        };
+        responses: {
+            200: {
+                content: {
+                    "application/json": components["schemas"]["GuestCheckoutSessionResponseV2"];
+                };
+            };
+            400: never;
+            403: never;
+            404: never;
+            409: never;
+            500: never;
+        };
+    };
+    updateGuestShippingAddress: {
+        parameters: {
+            header: {
+                "X-EBAY-C-MARKETPLACE-ID": string;
+                "Content-Type": string;
+                "X-EBAY-C-ENDUSERCTX"?: string;
+            };
+            path: {
+                checkoutSessionId: string;
+            };
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["ShippingAddressImpl"];
+            };
+        };
+        responses: {
+            200: {
+                content: {
+                    "application/json": components["schemas"]["GuestCheckoutSessionResponseV2"];
+                };
+            };
+            400: never;
+            403: never;
+            404: never;
+            409: never;
+            500: never;
+        };
+    };
+    updateGuestShippingOption: {
+        parameters: {
+            header: {
+                "X-EBAY-C-MARKETPLACE-ID": string;
+                "Content-Type": string;
+                "X-EBAY-C-ENDUSERCTX"?: string;
+            };
+            path: {
+                checkoutSessionId: string;
+            };
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["UpdateShippingOption"];
+            };
+        };
+        responses: {
+            200: {
+                content: {
+                    "application/json": components["schemas"]["GuestCheckoutSessionResponseV2"];
+                };
+            };
+            400: never;
+            403: never;
+            404: never;
+            409: never;
+            500: never;
+        };
+    };
+    getGuestPurchaseOrder: {
+        parameters: {
+            header?: {
+                "X-EBAY-C-MARKETPLACE-ID"?: string;
+                "X-EBAY-C-ENDUSERCTX"?: string;
+            };
+            path: {
+                purchaseOrderId: string;
+            };
+        };
+        responses: {
+            200: {
+                content: {
+                    "application/json": components["schemas"]["GuestPurchaseOrderV2"];
+                };
+            };
+            400: never;
+            403: never;
+            404: never;
+            500: never;
+        };
+    };
+}