@sixtyninecommerce/client 0.31.0 → 0.33.0

package/dist/generated/shop.d.ts

@@ -1170,6 +1170,7 @@ export type NumberRange = {
 export type OrderFilterParameter = {
     _and?: InputMaybe<Array<OrderFilterParameter>>;
     _or?: InputMaybe<Array<OrderFilterParameter>>;
+    accessKey?: InputMaybe<StringOperators>;
     active?: InputMaybe<BooleanOperators>;
     chargedParcelCount?: InputMaybe<NumberOperators>;
     code?: InputMaybe<StringOperators>;
@@ -1215,6 +1216,14 @@ export type OrderListOptions = {
     /** Takes n results, for use in pagination */
     take?: InputMaybe<Scalars['Int']['input']>;
 };
+/**
+ * Which prices a money view shows. GROSS = incl. VAT, NET = excl. VAT. STORE follows how the
+ * store sets its prices; CUSTOMER how the shop shows prices to the order's customer (consumers
+ * and business customers can differ by the store's price-display settings).
+ */
+export type OrderMoneyBasis = 'CUSTOMER' | 'GROSS' | 'NET' | 'STORE';
+/** Why a view gives no still-to-pay figure: KEPT_IN_ERP, the customer's account is kept in an external accounting system (print a note instead of an amount). */
+export type OrderMoneyStillToPayNote = 'KEPT_IN_ERP';
 /**
  * How the buyer intends to settle this order. Recorded before payment so
  * promotions (and the storefront's own totals) can respond to it.
@@ -1231,10 +1240,13 @@ export type OrderPaymentIntent =
 /** What happens to a received unit: back to sellable stock, or written off. */
 export type OrderReturnDisposition = 'restock' | 'write_off';
 export type OrderReturnReasonCode = 'arrived_late' | 'damaged' | 'defective' | 'no_longer_needed' | 'not_as_described' | 'order_error' | 'other' | 'wrong_item';
-export type OrderReturnSettlementMethod = 'refund' | 'store_credit';
+export type OrderReturnSettlementMethod = 
+/** The money went onto the customer's account (unapplied cash); no refund was made. */
+'account' | 'refund' | 'store_credit';
 export type OrderReturnState = 'approved' | 'cancelled' | 'items_received' | 'rejected' | 'requested' | 'settled' | 'settlement_failed' | 'settlement_pending';
 export type OrderScope = 'CONSUMER' | 'TRADE';
 export type OrderSortParameter = {
+    accessKey?: InputMaybe<SortOrder>;
     chargedParcelCount?: InputMaybe<SortOrder>;
     code?: InputMaybe<SortOrder>;
     createdAt?: InputMaybe<SortOrder>;
@@ -1269,9 +1281,9 @@ export type OrderType = 'Aggregate' | 'Regular' | 'Seller';
 /** How to open a card payment for a held order. */
 export type ParkedOrderPaymentIntentInput = {
     /**
-     * Minor units. Omit it to pay the whole outstanding balance. A smaller amount
-     * is a further deposit and is accepted only while the store has deposits
-     * enabled; more than the outstanding balance is refused with
+     * Minor units. Omit it to pay what the order still owes (the position's
+     * `owed`). A smaller amount is a further deposit and is accepted only while
+     * the store has deposits enabled; more than `owed` is refused with
      * `AMOUNT_EXCEEDS_OUTSTANDING`.
      */
     amount?: InputMaybe<Scalars['Int']['input']>;
@@ -1302,10 +1314,11 @@ export type PayDepositInput = {
 /** How to pay some or all of what a held order still owes. */
 export type PayParkedOrderInput = {
     /**
-     * Minor units. Omit it to pay the whole outstanding balance, which is the
-     * ordinary case. A smaller amount is a further deposit and is accepted only
-     * while the store has deposits enabled; more than the outstanding balance is
-     * refused with `AMOUNT_EXCEEDS_OUTSTANDING`, carrying the position.
+     * Minor units. Omit it to pay what the order still owes (the position's
+     * `owed`), which is the ordinary case. A smaller amount is a further deposit
+     * and is accepted only while the store has deposits enabled; more than
+     * `owed` is refused with `AMOUNT_EXCEEDS_OUTSTANDING`, carrying the
+     * position, and its message names the credit notes when they lowered it.
      */
     amount?: InputMaybe<Scalars['Int']['input']>;
     /** Free-form detail passed to the payment method's handler. */
@@ -1361,6 +1374,8 @@ export type PaymentTermsStatus = 'ASSIGNED' | 'CONFLICT' | 'STALE' | 'UNASSIGNED
 export type Permission = 
 /** AdjustStock */
 'AdjustStock'
+/** Approve or reject purchase orders of the store’s legal entity that are above its approval threshold */
+ | 'ApprovePurchaseOrder'
 /** Authenticated means simply that the user is logged in */
  | 'Authenticated'
 /** Grants permission to create Administrator */
@@ -1401,6 +1416,8 @@ export type Permission =
  | 'CreateProduct'
 /** Grants permission to create Promotion */
  | 'CreatePromotion'
+/** Grants permission to create purchase orders and their lines */
+ | 'CreatePurchaseOrder'
 /** Grants permission to create Seller */
  | 'CreateSeller'
 /** Grants permission to create PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
@@ -1409,6 +1426,8 @@ export type Permission =
  | 'CreateShippingMethod'
 /** Grants permission to create StockLocation */
  | 'CreateStockLocation'
+/** Grants permission to create suppliers, their contacts, supplier items and prices */
+ | 'CreateSupplier'
 /** Grants permission to create System */
  | 'CreateSystem'
 /** Grants permission to create Tag */
@@ -1457,6 +1476,8 @@ export type Permission =
  | 'DeleteProduct'
 /** Grants permission to delete Promotion */
  | 'DeletePromotion'
+/** Grants permission to cancel purchase orders (they are never deleted) */
+ | 'DeletePurchaseOrder'
 /** Grants permission to delete Seller */
  | 'DeleteSeller'
 /** Grants permission to delete PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
@@ -1465,6 +1486,8 @@ export type Permission =
  | 'DeleteShippingMethod'
 /** Grants permission to delete StockLocation */
  | 'DeleteStockLocation'
+/** Grants permission to delete suppliers, their contacts, supplier items and prices */
+ | 'DeleteSupplier'
 /** Grants permission to delete System */
  | 'DeleteSystem'
 /** Grants permission to delete Tag */
@@ -1483,16 +1506,24 @@ export type Permission =
  | 'ManageApiToken'
 /** ManageEventSubscriptions */
  | 'ManageEventSubscriptions'
+/** Manage inventory cost for the store’s legal entity: override a variant’s unit cost, add landed charges to posted receipts and override a receipt’s exchange rate */
+ | 'ManageInventoryCost'
 /** Manage an organization and the data its stores share */
  | 'ManageOrganization'
 /** Manage POS devices, registers, staff and receipt numbering. Pairing a device gives that device the till’s order and customer access */
  | 'ManagePosDevices'
+/** Manage purchasing for the store’s legal entity: switch it on, its currency, tolerances, reorder settings and document numbering */
+ | 'ManagePurchasingSettings'
 /** Allows issuing, adjusting, blocking and unblocking stored-value accounts */
  | 'ManageStoredValue'
 /** ManageWarehouseAssignments */
  | 'ManageWarehouseAssignments'
 /** Operate a point of sale: sessions, cash, tenders, sales and refunds */
  | 'OperatePos'
+/** OverrideDiscountLimit */
+ | 'OverrideDiscountLimit'
+/** OverrideFulfillmentPaymentCoverage */
+ | 'OverrideFulfillmentPaymentCoverage'
 /** Owner means the user owns this entity, e.g. a Customer's own Order */
  | 'Owner'
 /** Public means any unauthenticated user may perform the operation */
@@ -1543,6 +1574,8 @@ export type Permission =
  | 'ReadProduct'
 /** Grants permission to read Promotion */
  | 'ReadPromotion'
+/** Grants permission to read purchase orders and their lines */
+ | 'ReadPurchaseOrder'
 /** Grants permission to read Seller */
  | 'ReadSeller'
 /** Grants permission to read PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
@@ -1553,6 +1586,8 @@ export type Permission =
  | 'ReadStockLocation'
 /** Allows reading stored-value accounts, statements and liability */
  | 'ReadStoredValue'
+/** Grants permission to read suppliers, their contacts, supplier items and prices */
+ | 'ReadSupplier'
 /** Grants permission to read System */
  | 'ReadSystem'
 /** Grants permission to read Tag */
@@ -1563,6 +1598,12 @@ export type Permission =
  | 'ReadTaxRate'
 /** Grants permission to read Zone */
  | 'ReadZone'
+/** Accept more goods on a purchase order line than its over-receipt tolerance allows, with a reason */
+ | 'ReceiveOverTolerance'
+/** Receive goods against purchase orders of the store’s legal entity, and reverse receipts, at the stock locations the staff member works at */
+ | 'ReceivePurchaseOrder'
+/** RequestOrderPayment */
+ | 'RequestOrderPayment'
 /** SuperAdmin has unrestricted access to all operations */
  | 'SuperAdmin'
 /** Grants permission to update Administrator */
@@ -1607,6 +1648,8 @@ export type Permission =
  | 'UpdateProduct'
 /** Grants permission to update Promotion */
  | 'UpdatePromotion'
+/** Grants permission to update purchase orders and their lines */
+ | 'UpdatePurchaseOrder'
 /** Grants permission to update Seller */
  | 'UpdateSeller'
 /** Grants permission to update PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
@@ -1615,6 +1658,8 @@ export type Permission =
  | 'UpdateShippingMethod'
 /** Grants permission to update StockLocation */
  | 'UpdateStockLocation'
+/** Grants permission to update suppliers, their contacts, supplier items and prices */
+ | 'UpdateSupplier'
 /** Grants permission to update System */
  | 'UpdateSystem'
 /** Grants permission to update Tag */
@@ -1655,7 +1700,7 @@ export type PickupLocationSearchInput = {
  * defensively: new codes are added over time, and any code this build does not
  * know decodes to `UNKNOWN`.
  */
-export type PlacementRejectionCode = 'AGE_REQUIREMENT_NOT_MET' | 'AGE_VERIFICATION_REQUIRED' | 'CUSTOMER_REQUIRED' | 'DELIVERY_TERMS_UNAVAILABLE' | 'FULFILLMENT_MINIMUM_NOT_MET' | 'HOOK_REJECTED' | 'HOOK_UNAVAILABLE' | 'INSUFFICIENT_STOCK' | 'LINE_MINIMUM_QUANTITY_NOT_MET' | 'LINE_SALES_UNIT_NOT_MET' | 'ORDER_EMPTY' | 'ORDER_MINIMUM_AMOUNT_NOT_MET' | 'ORDER_MINIMUM_QUANTITY_NOT_MET' | 'PAYMENT_INTENT_MISMATCH' | 'PAYMENT_TERMS_UNAVAILABLE' | 'PLACEMENT_BLOCKED' | 'PRODUCT_EXCLUDED_FROM_STORE' | 'SHIPPING_ADDRESS_INCOMPLETE' | 'SHIPPING_COUNTRY_NOT_SERVED' | 'SHIPPING_METHOD_REQUIRED' | 'SHIPPING_RATE_UNAVAILABLE' | 'TAX_CHANGED' | 'UNKNOWN' | 'VARIANT_NOT_FOR_SALE_IN_CURRENCY';
+export type PlacementRejectionCode = 'AGE_REQUIREMENT_NOT_MET' | 'AGE_VERIFICATION_REQUIRED' | 'CUSTOMER_REQUIRED' | 'DELIVERY_TERMS_UNAVAILABLE' | 'FULFILLMENT_MINIMUM_NOT_MET' | 'GIFT_CARD_LINE_FREE' | 'GIFT_CARD_NEEDS_BUYER_EMAIL' | 'GIFT_CARD_NOT_FOR_SALE' | 'GIFT_CARD_ORDER_DISCOUNT' | 'HOOK_REJECTED' | 'HOOK_UNAVAILABLE' | 'INSUFFICIENT_STOCK' | 'LINE_MINIMUM_QUANTITY_NOT_MET' | 'LINE_SALES_UNIT_NOT_MET' | 'ORDER_EMPTY' | 'ORDER_MINIMUM_AMOUNT_NOT_MET' | 'ORDER_MINIMUM_QUANTITY_NOT_MET' | 'PAYMENT_INTENT_MISMATCH' | 'PAYMENT_TERMS_UNAVAILABLE' | 'PLACEMENT_BLOCKED' | 'PRODUCT_EXCLUDED_FROM_STORE' | 'SHIPPING_ADDRESS_INCOMPLETE' | 'SHIPPING_COUNTRY_NOT_SERVED' | 'SHIPPING_METHOD_REQUIRED' | 'SHIPPING_RATE_UNAVAILABLE' | 'TAX_CHANGED' | 'UNKNOWN' | 'VARIANT_NOT_FOR_SALE_IN_CURRENCY';
 /**
  * A merchant's publication state for a product that is launched but not (yet)
  * simply in stock. Not a stock figure: stock arriving does not end it — only
@@ -2177,6 +2222,9 @@ export type ProductVariantFragment = {
     priceListName: string | null;
     retailPrice: number | null;
     retailPriceWithTax: number | null;
+    dropShip: {
+        leadTimeDays: number | null;
+    } | null;
     availability: ProductAvailabilityFragment;
     taxRateApplied: {
         value: number;
@@ -2849,6 +2897,9 @@ export type OrderFragment = {
         name: string;
         couponCode: string | null;
         description: string;
+        conditions: Array<{
+            code: string;
+        }>;
     }>;
     shippingLines: Array<{
         priceWithTax: number;
@@ -3308,6 +3359,58 @@ export type ApplyPreferredShippingMethodMutation = {
         message: string;
     };
 };
+export type StorePickupLocationFragment = {
+    id: string;
+    name: string;
+    phone: string | null;
+    openingHours: unknown | null;
+    instructions: string | null;
+    available: boolean | null;
+    address: {
+        streetLine1: string | null;
+        streetLine2: string | null;
+        city: string | null;
+        province: string | null;
+        postalCode: string | null;
+        countryCode: string | null;
+    } | null;
+};
+export type StorePickupLocationsQueryVariables = Exact<{
+    [key: string]: never;
+}>;
+export type StorePickupLocationsQuery = {
+    storePickupLocations: Array<StorePickupLocationFragment>;
+};
+export type SetActiveOrderStorePickupLocationMutationVariables = Exact<{
+    stockLocationId?: InputMaybe<Scalars['ID']['input']>;
+}>;
+export type SetActiveOrderStorePickupLocationMutation = {
+    setActiveOrderStorePickupLocation: OrderFragment;
+};
+export type ActiveOrderStorePickupQueryVariables = Exact<{
+    [key: string]: never;
+}>;
+export type ActiveOrderStorePickupQuery = {
+    activeOrder: {
+        id: string;
+        storePickup: {
+            status: string;
+            readyAt: string | null;
+            holdUntil: string | null;
+            collectedAt: string | null;
+            location: StorePickupLocationFragment;
+        } | null;
+    } | null;
+};
+export type EligibleShippingMethodCodesQueryVariables = Exact<{
+    [key: string]: never;
+}>;
+export type EligibleShippingMethodCodesQuery = {
+    eligibleShippingMethods: Array<{
+        id: string;
+        code: string;
+    }>;
+};
 export type PaymentMethodsQueryVariables = Exact<{
     [key: string]: never;
 }>;
@@ -3603,6 +3706,20 @@ export type SyncMolliePaymentStatusMutation = {
     } | null;
 };
 export type ParkedOrderFragment = {
+    id: string;
+    code: string;
+    state: string;
+    reason: string | null;
+    position: {
+        total: number;
+        covered: number;
+        outstanding: number;
+        creditNoted: number;
+        owed: number;
+        currencyCode: string;
+    };
+};
+export type ParkedOrderLegacyFragment = {
     id: string;
     code: string;
     state: string;
@@ -3620,12 +3737,48 @@ export type ParkedOrdersQueryVariables = Exact<{
 export type ParkedOrdersQuery = {
     parkedOrders: Array<ParkedOrderFragment>;
 };
+export type ParkedOrdersLegacyQueryVariables = Exact<{
+    [key: string]: never;
+}>;
+export type ParkedOrdersLegacyQuery = {
+    parkedOrders: Array<ParkedOrderLegacyFragment>;
+};
 export type PayParkedOrderMutationVariables = Exact<{
     orderCode: Scalars['String']['input'];
     input: PayParkedOrderInput;
     idempotencyKey?: InputMaybe<Scalars['String']['input']>;
 }>;
 export type PayParkedOrderMutation = {
+    payParkedOrder: {
+        settled: boolean;
+        order: {
+            id: string;
+            code: string;
+            state: string;
+        };
+        payment: {
+            id: string;
+            state: string;
+            amount: number;
+            method: string;
+            metadata: unknown | null;
+        };
+        position: {
+            total: number;
+            covered: number;
+            outstanding: number;
+            creditNoted: number;
+            owed: number;
+            currencyCode: string;
+        };
+    };
+};
+export type PayParkedOrderLegacyMutationVariables = Exact<{
+    orderCode: Scalars['String']['input'];
+    input: PayParkedOrderInput;
+    idempotencyKey?: InputMaybe<Scalars['String']['input']>;
+}>;
+export type PayParkedOrderLegacyMutation = {
     payParkedOrder: {
         settled: boolean;
         order: {
@@ -3810,6 +3963,11 @@ export type CustomerOrdersQuery = {
                 lines: Array<{
                     id: string;
                     backorderedQuantity: number;
+                    expectedArrival: {
+                        date: string | null;
+                        confirmed: boolean;
+                        source: string;
+                    } | null;
                 }>;
             } & OrderSummaryFragment & OrderFulfillmentParcelsFragment)>;
         };
@@ -4122,12 +4280,129 @@ export type OrderByCodeQuery = {
         lines: Array<{
             id: string;
             backorderedQuantity: number;
+            expectedArrival: {
+                date: string | null;
+                confirmed: boolean;
+                source: string;
+            } | null;
         }>;
         customFields: {
             chargedParcelCount: number | null;
         } | null;
     } & OrderFragment & OrderFulfillmentsFragment & OrderFulfillmentParcelsFragment & OrderPaymentTermsFragment & OrderDeliveryTermsFragment) | null;
 };
+export type OrderMoneyViewFragment = {
+    basis: OrderMoneyBasis;
+    currencyCode: CurrencyCode;
+    subtotal: number;
+    shippingTotal: number;
+    totalExcludingTax: number;
+    taxIncluded: boolean;
+    taxTotal: number;
+    rounding: number | null;
+    total: number;
+    totalBeforeRounding: number;
+    reconciles: boolean;
+    lines: Array<{
+        orderLineId: string;
+        quantity: number;
+        taxRate: number;
+        unitAmount: number | null;
+        amount: number;
+    }>;
+    goodsAdjustments: Array<{
+        key: string;
+        description: string;
+        amount: number;
+        taxRate: number | null;
+    }>;
+    surcharges: Array<{
+        key: string;
+        description: string;
+        amount: number;
+        taxRate: number | null;
+    }>;
+    shipping: Array<{
+        key: string;
+        description: string;
+        amount: number;
+        taxRate: number | null;
+    }>;
+    shippingAdjustments: Array<{
+        key: string;
+        description: string;
+        amount: number;
+        taxRate: number | null;
+    }>;
+    taxes: Array<{
+        taxRate: number;
+        base: number;
+        amount: number;
+    }>;
+    balance: {
+        paid: number;
+        giftCard: number;
+        storeCredit: number;
+        credited: number;
+        stillToPay: number;
+    };
+};
+export type ActiveOrderMoneyViewQueryVariables = Exact<{
+    basis: OrderMoneyBasis;
+}>;
+export type ActiveOrderMoneyViewQuery = {
+    activeOrder: {
+        id: string;
+        code: string;
+        moneyView: OrderMoneyViewFragment;
+    } | null;
+};
+export type OrderMoneyViewByCodeQueryVariables = Exact<{
+    code: Scalars['String']['input'];
+    basis: OrderMoneyBasis;
+}>;
+export type OrderMoneyViewByCodeQuery = {
+    orderByCode: {
+        id: string;
+        code: string;
+        moneyView: OrderMoneyViewFragment;
+    } | null;
+};
+export type ActiveOrderAccessKeyQueryVariables = Exact<{
+    [key: string]: never;
+}>;
+export type ActiveOrderAccessKeyQuery = {
+    activeOrder: {
+        id: string;
+        accessKey: string | null;
+    } | null;
+};
+export type OrderMoneyViewProbeQueryVariables = Exact<{
+    [key: string]: never;
+}>;
+export type OrderMoneyViewProbeQuery = {
+    activeOrder: {
+        id: string;
+    } | null;
+};
+export type CustomerOrdersWithMoneyViewQueryVariables = Exact<{
+    options?: InputMaybe<OrderListOptions>;
+    basis: OrderMoneyBasis;
+}>;
+export type CustomerOrdersWithMoneyViewQuery = {
+    activeCustomer: {
+        orders: {
+            totalItems: number;
+            items: Array<({
+                lines: Array<{
+                    id: string;
+                    backorderedQuantity: number;
+                }>;
+                moneyView: OrderMoneyViewFragment;
+            } & OrderSummaryFragment & OrderFulfillmentParcelsFragment)>;
+        };
+    } | null;
+};
 export type FavoriteVariantIdsQueryVariables = Exact<{
     [key: string]: never;
 }>;
@@ -4831,9 +5106,48 @@ export type ReturnableLinesForOrderQuery = {
             returnableQty: number;
             unitPriceWithTax: number;
             unitPriceWithTaxUnrounded: number;
+            creditedQty: number;
+            correctionCredits: Array<{
+                orderLineId: string;
+                creditNoteId: string;
+                creditNoteNumber: string;
+                ledger: string;
+                quantity: number;
+                amount: number;
+            }>;
         }>;
     };
 };
+export type ReturnableLinesForOrderLegacyQueryVariables = Exact<{
+    orderId: Scalars['ID']['input'];
+}>;
+export type ReturnableLinesForOrderLegacyQuery = {
+    returnableLinesForOrder: {
+        orderId: string;
+        eligible: boolean;
+        reason: string | null;
+        returnWindowEndsAt: string | null;
+        lines: Array<{
+            orderLineId: string;
+            productVariantId: string;
+            productVariantName: string;
+            productVariantSku: string;
+            fulfilledQty: number;
+            returnableQty: number;
+            unitPriceWithTax: number;
+            unitPriceWithTaxUnrounded: number;
+        }>;
+    };
+};
+export type ClaimPosReceiptMutationVariables = Exact<{
+    token: Scalars['String']['input'];
+}>;
+export type ClaimPosReceiptMutation = {
+    claimPosReceipt: {
+        orderCode: string;
+        alreadyYours: boolean;
+    };
+};
 export type ProductReviewFragment = {
     id: string;
     rating: number | null;