@ikas/storefront 1.0.7 → 1.0.8

package/build/api/customer/__generated__/getCustomerOrders.d.ts

@@ -1,65 +1,176 @@
-import { CancelledReasonEnum, AdjustmentEnum, AmountTypeEnum, OrderLineItemStatusEnum, OrderPackageFulfillStatusEnum, OrderPackageStatusEnum, OrderPaymentStatusEnum, ShippingMethodEnum, OrderStatusEnum } from "../../../__generated__/global-types";
+import { CancelledReasonEnum, AdjustmentEnum, AmountTypeEnum, OrderLineItemStatusEnum, ProductOptionTypeEnum, OrderPackageFulfillStatusEnum, OrderPackageStatusEnum, OrderPaymentStatusEnum, ShippingMethodEnum, OrderStatusEnum } from "../../../__generated__/global-types";
 export interface getCustomerOrders_getCustomerOrders_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 getCustomerOrders_getCustomerOrders_billingAddress_country {
     __typename: "OrderAddressCountry";
+    /**
+     * It is the name of the country of the address.
+     */
     name: string;
+    /**
+     * 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;
 }
 export interface getCustomerOrders_getCustomerOrders_billingAddress_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 getCustomerOrders_getCustomerOrders_billingAddress_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 getCustomerOrders_getCustomerOrders_billingAddress {
     __typename: "OrderAddress";
+    /**
+     * 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: getCustomerOrders_getCustomerOrders_billingAddress_city;
+    /**
+     * The company of the person associated with the address.
+     */
     company: string | null;
+    /**
+     * The country information of the address.
+     */
     country: getCustomerOrders_getCustomerOrders_billingAddress_country;
+    /**
+     * The district information of the address.
+     */
     district: getCustomerOrders_getCustomerOrders_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: getCustomerOrders_getCustomerOrders_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 getCustomerOrders_getCustomerOrders_currencyRates {
     __typename: "OrderCurrencyRate";
+    /**
+     * It is the rate of the currency.
+     */
     rate: number;
+    /**
+     * It is the original rate of the currency.
+     */
     originalRate: number;
+    /**
+     * It is the code of the currency.
+     */
     code: string;
 }
 export interface getCustomerOrders_getCustomerOrders_customer {
     __typename: "OrderCustomer";
+    /**
+     * It is the last name of the customer who created the order.
+     */
     lastName: string | null;
+    /**
+     * It is the first name of the customer who created the order.
+     */
     firstName: string | null;
+    /**
+     * It is the email of the customer who created the order.
+     */
     email: string | null;
+    /**
+     * It is the id of the customer who created the order.
+     */
     id: string | null;
 }
 export interface getCustomerOrders_getCustomerOrders_orderAdjustments {
     __typename: "OrderAdjustment";
     type: AdjustmentEnum;
+    /**
+     * It is the order of the adjustment. Adjustments are applied in this order.
+     */
     order: number;
+    /**
+     * It is the name of the adjustment.
+     */
     name: string;
     amountType: AmountTypeEnum;
+    /**
+     * It is the adjustment amount in the order. This amount can be positive or negative.
+     */
     amount: number;
 }
 export interface getCustomerOrders_getCustomerOrders_orderLineItems_discount {
@@ -70,55 +181,184 @@ export interface getCustomerOrders_getCustomerOrders_orderLineItems_discount {
 }
 export interface getCustomerOrders_getCustomerOrders_orderLineItems_variant_variantValues {
     __typename: "OrderLineVariantVariantValues";
+    /**
+     * It is the order of variant value. The variant value order starts from 0.
+     */
     variantValueName: 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.
+     */
     variantTypeName: string | null;
+    /**
+     * 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.
+     */
     order: number;
 }
 export interface getCustomerOrders_getCustomerOrders_orderLineItems_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 variant values of the variant.
+     */
     variantValues: getCustomerOrders_getCustomerOrders_orderLineItems_variant_variantValues[] | null;
 }
+export interface getCustomerOrders_getCustomerOrders_orderLineItems_options_values {
+    __typename: "OrderLineOptionValue";
+    name: string | null;
+    price: number | null;
+    value: string;
+}
+export interface getCustomerOrders_getCustomerOrders_orderLineItems_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: getCustomerOrders_getCustomerOrders_orderLineItems_options_values[];
+}
 export interface getCustomerOrders_getCustomerOrders_orderLineItems {
     __typename: "OrderLineItem";
     createdAt: any | null;
+    /**
+     * It is the currency code of the order line item.
+     */
     currencyCode: string | null;
     deleted: boolean | null;
+    /**
+     * Information about the discount. Shows the details of the discount applied to the order line item.
+     */
     discount: getCustomerOrders_getCustomerOrders_orderLineItems_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;
+    /**
+     * 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: getCustomerOrders_getCustomerOrders_orderLineItems_variant;
+    /**
+     * It is the option information of the variant value in the order line item.
+     */
+    options: getCustomerOrders_getCustomerOrders_orderLineItems_options[] | null;
 }
 export interface getCustomerOrders_getCustomerOrders_orderPackages_trackingInfo {
     __typename: "TrackingInfo";
+    /**
+     * It is the tracking number of the order package.
+     */
     trackingNumber: string | null;
+    /**
+     * It is the tracking link of the order package.
+     */
     trackingLink: string | null;
+    /**
+     * Indicates whether the notification is sent to the customer after the cargo is
+     * delivered. ***isSendNotification*** returns true if the notification is sent.
+     */
     isSendNotification: boolean | null;
+    /**
+     * It is the name of the cargo company.
+     */
     cargoCompany: string | null;
 }
 export interface getCustomerOrders_getCustomerOrders_orderPackages {
     __typename: "OrderPackage";
     updatedAt: any | null;
+    /**
+     * It is the stock location id information where the package will be shipped.
+     */
     trackingInfo: getCustomerOrders_getCustomerOrders_orderPackages_trackingInfo | null;
     stockLocationId: string;
+    /**
+     * It is the number of order package. Order package number is created with the order number - order package sequence format.
+     */
     orderPackageNumber: string;
+    /**
+     * It is the fulfill status of the package
+     */
     orderPackageFulfillStatus: OrderPackageFulfillStatusEnum;
+    /**
+     * It is the id list of the order line items in the package.
+     */
     orderLineItemIds: string[];
     id: string;
     deleted: boolean | null;
@@ -126,84 +366,249 @@ export interface getCustomerOrders_getCustomerOrders_orderPackages {
 }
 export interface getCustomerOrders_getCustomerOrders_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 getCustomerOrders_getCustomerOrders_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 getCustomerOrders_getCustomerOrders_shippingAddress_country {
     __typename: "OrderAddressCountry";
+    /**
+     * It is the name of the country of the address.
+     */
     name: string;
+    /**
+     * 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;
 }
 export interface getCustomerOrders_getCustomerOrders_shippingAddress_city {
     __typename: "OrderAddressCity";
+    /**
+     * It is the id of the city of the address.
+     */
     id: string | null;
+    /**
+     * It is the code of the city of the address.
+     */
     code: string | null;
+    /**
+     * It is the name of the city of the address.
+     */
     name: string;
 }
 export interface getCustomerOrders_getCustomerOrders_shippingAddress {
     __typename: "OrderAddress";
+    /**
+     * The tax office of the person associated with the address.
+     */
     taxOffice: string | null;
+    /**
+     * The tax number of the person associated with the address.
+     */
     taxNumber: string | null;
+    /**
+     * The state information of the address.
+     */
     state: getCustomerOrders_getCustomerOrders_shippingAddress_state | null;
+    /**
+     * The postal code of the address.
+     */
     postalCode: string | null;
+    /**
+     * The phone of the person associated with the address.
+     */
     phone: string | null;
+    /**
+     * The last name of the person associated with the address
+     */
     lastName: string;
+    /**
+     * The address"s id of the order address.
+     */
     isDefault: boolean;
+    /**
+     * The identity number of the person associated with the address.
+     */
     identityNumber: string | null;
+    /**
+     * The first name of the person associated with the address
+     */
     firstName: string;
+    /**
+     * The district information of the address.
+     */
     district: getCustomerOrders_getCustomerOrders_shippingAddress_district | null;
+    /**
+     * The country information of the address.
+     */
     country: getCustomerOrders_getCustomerOrders_shippingAddress_country;
+    /**
+     * The company of the person associated with the address.
+     */
     company: string | null;
+    /**
+     * The city information of the address.
+     */
     city: getCustomerOrders_getCustomerOrders_shippingAddress_city;
+    /**
+     * An optional additional field for the street address of the address.
+     */
     addressLine2: string | null;
+    /**
+     * The street address of the address.
+     */
     addressLine1: string;
 }
 export interface getCustomerOrders_getCustomerOrders_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;
 }
 export interface getCustomerOrders_getCustomerOrders_taxLines {
     __typename: "OrderTaxLine";
+    /**
+     * It is the percentage of the slice to which the calculated tax amount belongs.
+     */
     rate: number;
+    /**
+     * It is the price of the order tax.
+     */
     price: number;
 }
 export interface getCustomerOrders_getCustomerOrders {
     __typename: "Order";
+    /**
+     * It is the billing address of the order.
+     */
     billingAddress: getCustomerOrders_getCustomerOrders_billingAddress | null;
+    /**
+     * If the order has been cancelled, it indicates the cancellation date of the order.
+     */
     cancelledAt: any | null;
+    /**
+     * It is the cancel reason of the order. If the order has been cancelled, it indicates the cancellation reason of the order.
+     */
     cancelReason: CancelledReasonEnum | null;
     createdAt: any | null;
+    /**
+     * It is the currency value of the order.
+     */
     currencyCode: string;
+    /**
+     * A list of currency rate objects.
+     */
     currencyRates: getCustomerOrders_getCustomerOrders_currencyRates[];
+    /**
+     * Information about the customer. The order does not have to be a customer
+     * information. If the order was created by ikasPOS, the customer information may be null.
+     */
     customer: getCustomerOrders_getCustomerOrders_customer | null;
     deleted: boolean | null;
     id: string;
     merchantId: string;
+    /**
+     * An optional note, can attach to the order.
+     */
     note: string | null;
+    /**
+     * The date the order was ordered.
+     */
     orderedAt: any | null;
+    /**
+     * A list of adjustment objects, each containing information about a adjustment in the order.
+     */
     orderAdjustments: getCustomerOrders_getCustomerOrders_orderAdjustments[] | null;
+    /**
+     * A list of line item objects, each containing information about an item in the order.
+     */
     orderLineItems: getCustomerOrders_getCustomerOrders_orderLineItems[];
+    /**
+     * The position of the order in the store's order count starting from 1001. Order numbers are sequential and start from 1001.
+     */
     orderNumber: string | null;
+    /**
+     * A list of order package objects.
+     */
     orderPackages: getCustomerOrders_getCustomerOrders_orderPackages[] | null;
+    /**
+     * It is the package status enum of the order
+     */
     orderPackageStatus: OrderPackageStatusEnum | null;
+    /**
+     * It is the payment status enum of the order
+     */
     orderPaymentStatus: OrderPaymentStatusEnum | null;
+    /**
+     * It is the tag id list in the order.
+     */
     orderTagIds: string[] | null;
+    /**
+     * It is the shipping address of the order.
+     */
     shippingAddress: getCustomerOrders_getCustomerOrders_shippingAddress | null;
+    /**
+     * A list of shipping line objects, each containing information about a shipping in the order.
+     */
     shippingLines: getCustomerOrders_getCustomerOrders_shippingLines[] | null;
+    /**
+     * It is the shipping method enum of the order
+     */
     shippingMethod: ShippingMethodEnum;
+    /**
+     * It is the status enum of the order
+     */
     status: OrderStatusEnum;
+    /**
+     * A list of tax line objects, tax line objects contain the taxes of the shippingLines, orderLineItems, and giftPackageLines.
+     */
     taxLines: getCustomerOrders_getCustomerOrders_taxLines[] | null;
+    /**
+     * The total final price of the order resulting from the apply of
+     * ``orderAdjustments`` , ```shippingLines```, and  ```giftPackageLines```
+     * pricing to the order total price.
+     */
     totalFinalPrice: number;
+    /**
+     * It is the sum of the net prices of the line items in the order.
+     */
     totalPrice: number;
     updatedAt: any | null;
 }