@ikas/storefront 1.0.7 → 1.0.9

package/build/api/checkout/__generated__/getCheckoutById.d.ts

@@ -1,4 +1,4 @@
-import { ShippingMethodEnum, CheckoutRecoveryEmailStatusEnum, CheckoutRecoveryStatusEnum, CheckoutStatusEnum, AmountTypeEnum, OrderLineItemStatusEnum, CartStatusEnum, AdjustmentEnum } from "../../../__generated__/global-types";
+import { ShippingMethodEnum, CheckoutRecoveryEmailStatusEnum, CheckoutRecoveryStatusEnum, CheckoutStatusEnum, AmountTypeEnum, OrderLineItemStatusEnum, ProductOptionTypeEnum, CartStatusEnum, AdjustmentEnum } from "../../../__generated__/global-types";
 export interface getCheckoutById_getCheckoutById_availableShippingMethods {
     __typename: "AvailableShippingMethod";
     price: number;
@@ -9,47 +9,137 @@ export interface getCheckoutById_getCheckoutById_availableShippingMethods {
 }
 export interface getCheckoutById_getCheckoutById_billingAddress_city {
     __typename: "OrderAddressCity";
+    /**
+     * It is the code of the city of the address.
+     */
     code: string | null;
+    /**
+     * It is the id of the city of the address.
+     */
     id: string | null;
+    /**
+     * It is the name of the city of the address.
+     */
     name: string;
 }
 export interface getCheckoutById_getCheckoutById_billingAddress_country {
     __typename: "OrderAddressCountry";
+    /**
+     * It is the code of the country of the address.
+     */
     code: string | null;
+    /**
+     * It is the id of the country of the address.
+     */
     id: string | null;
+    /**
+     * It is the name of the country of the address.
+     */
     name: string;
+    /**
+     * It is the two-letter code of the country of the address.
+     */
     iso2: string | null;
+    /**
+     * It is the three-letter code of the country of the address.
+     */
     iso3: string | null;
 }
 export interface getCheckoutById_getCheckoutById_billingAddress_district {
     __typename: "OrderAddressDistrict";
+    /**
+     * It is the code of the district of the address.
+     */
     code: string | null;
+    /**
+     * It is the id of the district of the address.
+     */
     id: string | null;
+    /**
+     * It is the name of the district of the address.
+     */
     name: string | null;
 }
 export interface getCheckoutById_getCheckoutById_billingAddress_state {
     __typename: "OrderAddressState";
+    /**
+     * It is the code of the state of the address.
+     */
     code: string | null;
+    /**
+     * It is the id of the state of the address.
+     */
     id: string | null;
+    /**
+     * It is the name of the state of the address.
+     */
     name: string | null;
 }
 export interface getCheckoutById_getCheckoutById_billingAddress {
     __typename: "OrderAddress";
+    /**
+     * The address"s id of the order address.
+     */
     id: string | null;
+    /**
+     * The street address of the address.
+     */
     addressLine1: string;
+    /**
+     * An optional additional field for the street address of the address.
+     */
     addressLine2: string | null;
+    /**
+     * The city information of the address.
+     */
     city: getCheckoutById_getCheckoutById_billingAddress_city;
+    /**
+     * The company of the person associated with the address.
+     */
     company: string | null;
+    /**
+     * The country information of the address.
+     */
     country: getCheckoutById_getCheckoutById_billingAddress_country;
+    /**
+     * The district information of the address.
+     */
     district: getCheckoutById_getCheckoutById_billingAddress_district | null;
+    /**
+     * The first name of the person associated with the address
+     */
     firstName: string;
+    /**
+     * The identity number of the person associated with the address.
+     */
     identityNumber: string | null;
+    /**
+     * The address"s id of the order address.
+     */
     isDefault: boolean;
+    /**
+     * The last name of the person associated with the address
+     */
     lastName: string;
+    /**
+     * The phone of the person associated with the address.
+     */
     phone: string | null;
+    /**
+     * The postal code of the address.
+     */
     postalCode: string | null;
+    /**
+     * The state information of the address.
+     */
     state: getCheckoutById_getCheckoutById_billingAddress_state | null;
+    /**
+     * The tax number of the person associated with the address.
+     */
     taxNumber: string | null;
+    /**
+     * The tax office of the person associated with the address.
+     */
     taxOffice: string | null;
 }
 export interface getCheckoutById_getCheckoutById_customer {
@@ -62,60 +152,171 @@ export interface getCheckoutById_getCheckoutById_customer {
 }
 export interface getCheckoutById_getCheckoutById_shippingAddress_city {
     __typename: "OrderAddressCity";
+    /**
+     * It is the code of the city of the address.
+     */
     code: string | null;
+    /**
+     * It is the id of the city of the address.
+     */
     id: string | null;
+    /**
+     * It is the name of the city of the address.
+     */
     name: string;
 }
 export interface getCheckoutById_getCheckoutById_shippingAddress_country {
     __typename: "OrderAddressCountry";
+    /**
+     * It is the id of the country of the address.
+     */
     id: string | null;
+    /**
+     * It is the code of the country of the address.
+     */
     code: string | null;
+    /**
+     * It is the name of the country of the address.
+     */
     name: string;
+    /**
+     * It is the two-letter code of the country of the address.
+     */
     iso2: string | null;
+    /**
+     * It is the three-letter code of the country of the address.
+     */
     iso3: string | null;
 }
 export interface getCheckoutById_getCheckoutById_shippingAddress_district {
     __typename: "OrderAddressDistrict";
+    /**
+     * It is the name of the district of the address.
+     */
     name: string | null;
+    /**
+     * It is the id of the district of the address.
+     */
     id: string | null;
+    /**
+     * It is the code of the district of the address.
+     */
     code: string | null;
 }
 export interface getCheckoutById_getCheckoutById_shippingAddress_state {
     __typename: "OrderAddressState";
+    /**
+     * It is the name of the state of the address.
+     */
     name: string | null;
+    /**
+     * It is the id of the state of the address.
+     */
     id: string | null;
+    /**
+     * It is the code of the state of the address.
+     */
     code: string | null;
 }
 export interface getCheckoutById_getCheckoutById_shippingAddress {
     __typename: "OrderAddress";
+    /**
+     * The address"s id of the order address.
+     */
     id: string | null;
+    /**
+     * The street address of the address.
+     */
     addressLine1: string;
+    /**
+     * An optional additional field for the street address of the address.
+     */
     addressLine2: string | null;
+    /**
+     * The city information of the address.
+     */
     city: getCheckoutById_getCheckoutById_shippingAddress_city;
+    /**
+     * The company of the person associated with the address.
+     */
     company: string | null;
+    /**
+     * The country information of the address.
+     */
     country: getCheckoutById_getCheckoutById_shippingAddress_country;
+    /**
+     * The district information of the address.
+     */
     district: getCheckoutById_getCheckoutById_shippingAddress_district | null;
+    /**
+     * The first name of the person associated with the address
+     */
     firstName: string;
+    /**
+     * The identity number of the person associated with the address.
+     */
     identityNumber: string | null;
+    /**
+     * The address"s id of the order address.
+     */
     isDefault: boolean;
+    /**
+     * The last name of the person associated with the address
+     */
     lastName: string;
+    /**
+     * The phone of the person associated with the address.
+     */
     phone: string | null;
+    /**
+     * The postal code of the address.
+     */
     postalCode: string | null;
+    /**
+     * The state information of the address.
+     */
     state: getCheckoutById_getCheckoutById_shippingAddress_state | null;
+    /**
+     * The tax number of the person associated with the address.
+     */
     taxNumber: string | null;
+    /**
+     * The tax office of the person associated with the address.
+     */
     taxOffice: string | null;
 }
 export interface getCheckoutById_getCheckoutById_shippingLines {
     __typename: "OrderShippingLine";
+    /**
+     * It is the title of the order shipping line.
+     */
     title: string;
+    /**
+     * It is the tax value of the order shipping line price.
+     */
     taxValue: number | null;
+    /**
+     * It is the price of the order shipping line.
+     */
     price: number;
+    /**
+     * It is the shipping settings id of the order shipping line.
+     */
     shippingSettingsId: string | null;
+    /**
+     * It is the shipping zone rate id of the order shipping line.
+     */
     shippingZoneRateId: string | null;
 }
 export interface getCheckoutById_getCheckoutById_cart_taxLines {
     __typename: "OrderTaxLine";
+    /**
+     * It is the price of the order tax.
+     */
     price: number;
+    /**
+     * It is the percentage of the slice to which the calculated tax amount belongs.
+     */
     rate: number;
 }
 export interface getCheckoutById_getCheckoutById_cart_items_discount {
@@ -126,41 +327,148 @@ export interface getCheckoutById_getCheckoutById_cart_items_discount {
 }
 export interface getCheckoutById_getCheckoutById_cart_items_variant_variantValues {
     __typename: "OrderLineVariantVariantValues";
+    /**
+     * It is the order of variant value. The variant value order starts from 0.
+     */
     order: number;
+    /**
+     * It is the order of variant value. The variant value order starts from 0.
+     */
     variantTypeId: string;
+    /**
+     * It is the order of variant value. The variant value order starts from 0.
+     */
     variantTypeName: string | null;
+    /**
+     * It is the order of variant value. The variant value order starts from 0.
+     */
     variantValueId: string;
+    /**
+     * It is the order of variant value. The variant value order starts from 0.
+     */
     variantValueName: string | null;
 }
 export interface getCheckoutById_getCheckoutById_cart_items_variant {
     __typename: "OrderLineVariant";
+    /**
+     * It is the barcode list of the variant.
+     */
     barcodeList: string[] | null;
+    /**
+     * It is the id of the variant.
+     */
     id: string | null;
+    /**
+     * It is the main image id of the variant.
+     */
     mainImageId: string | null;
+    /**
+     * It is the name of the variant.
+     */
     name: string;
+    /**
+     * It is the product id of the variant.
+     */
     productId: string | null;
+    /**
+     * It is the sku of the variant.
+     */
     sku: string | null;
+    /**
+     * It is the slug of the variant. The slug value is unique each variant and product.
+     */
     slug: string | null;
+    /**
+     * It is the variant values of the variant.
+     */
     variantValues: getCheckoutById_getCheckoutById_cart_items_variant_variantValues[] | null;
 }
+export interface getCheckoutById_getCheckoutById_cart_items_options_values {
+    __typename: "OrderLineOptionValue";
+    name: string | null;
+    price: number | null;
+    value: string;
+}
+export interface getCheckoutById_getCheckoutById_cart_items_options {
+    __typename: "OrderLineOption";
+    /**
+     * It is the name of order line option in the order line item.
+     */
+    name: string;
+    /**
+     * It is the product option id of the product in the order line item.
+     */
+    productOptionId: string;
+    /**
+     * It is the product option set id of the product in the order line item.
+     */
+    productOptionsSetId: string;
+    /**
+     * It is the type of the order line option.
+     */
+    type: ProductOptionTypeEnum;
+    values: getCheckoutById_getCheckoutById_cart_items_options_values[];
+}
 export interface getCheckoutById_getCheckoutById_cart_items {
     __typename: "OrderLineItem";
     createdAt: any | null;
+    /**
+     * It is the currency code of the order line item.
+     */
     currencyCode: string | null;
+    /**
+     * Information about the discount. Shows the details of the discount applied to the order line item.
+     */
     discount: getCheckoutById_getCheckoutById_cart_items_discount | null;
+    /**
+     * It is the discount price of the order line item.
+     */
     discountPrice: number | null;
+    /**
+     * It is the final price of the order line item. If the discount price is less
+     * than the sell price, the final price is equal to the discount price.
+     */
     finalPrice: number | null;
     id: string;
+    /**
+     * It is the original order line item id of the line item. If the line item is
+     * derived from another line item, this field is filled.
+     */
     originalOrderLineItemId: string | null;
+    /**
+     * It is the selling price of the order line item.
+     */
     price: number;
+    /**
+     * It is the quantity of variant in the order line item.
+     */
     quantity: number;
+    /**
+     * It is the status enum of the order line item
+     */
     status: OrderLineItemStatusEnum;
     deleted: boolean | null;
+    /**
+     * It is the date when the last status of the order line item was updated.
+     */
     statusUpdatedAt: any | null;
+    /**
+     * It is the stock location id of the variant value in the order line item.
+     */
     stockLocationId: string | null;
+    /**
+     * It is the tax value of the order line item.
+     */
     taxValue: number | null;
     updatedAt: any | null;
+    /**
+     * Information about the variant of the order line item.
+     */
     variant: getCheckoutById_getCheckoutById_cart_items_variant;
+    /**
+     * It is the option information of the variant value in the order line item.
+     */
+    options: getCheckoutById_getCheckoutById_cart_items_options[] | null;
 }
 export interface getCheckoutById_getCheckoutById_cart {
     __typename: "Cart";
@@ -179,23 +487,53 @@ export interface getCheckoutById_getCheckoutById_cart {
 }
 export interface getCheckoutById_getCheckoutById_adjustments_appliedOrderLines {
     __typename: "OrderAdjustmentAppliedOrderLine";
+    /**
+     * Is he amount of the applied adjustment.
+     */
     amount: number;
+    /**
+     * It is the quantity of variants within the order line item to which the adjustment is applied.
+     */
     appliedQuantity: number;
+    /**
+     * It is the id of the order line item to which the adjustment is applied.
+     */
     orderLineId: string;
 }
 export interface getCheckoutById_getCheckoutById_adjustments {
     __typename: "OrderAdjustment";
+    /**
+     * It is the adjustment amount in the order. This amount can be positive or negative.
+     */
     amount: number;
     amountType: AmountTypeEnum;
+    /**
+     * It is the name of the adjustment.
+     */
     name: string;
+    /**
+     * It is the order of the adjustment. Adjustments are applied in this order.
+     */
     order: number;
     type: AdjustmentEnum;
+    /**
+     * It is the coupon id generated depending on the campaign.
+     */
     couponId: string | null;
+    /**
+     * A list of order line items, each containing information about a order line item in the order.
+     */
     appliedOrderLines: getCheckoutById_getCheckoutById_adjustments_appliedOrderLines[] | null;
 }
 export interface getCheckoutById_getCheckoutById_giftPackageLines {
     __typename: "OrderGiftPackageLine";
+    /**
+     * It is the price of the order gift package line.
+     */
     price: number;
+    /**
+     * It is the tax value of the order gift package line price.
+     */
     taxValue: number | null;
 }
 export interface getCheckoutById_getCheckoutById {