Skip to content

Commit 78cfbb9

Browse files
rennyGclaude
andcommitted
Update JSDoc from latest checkout-web review changes
Re-apply full checkout-web diff with review feedback. Includes {API_VERSION} placeholder URLs, updated descriptions, and Shopify Function link fixes. All fully qualified URLs preserved. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 7745d67 commit 78cfbb9

5 files changed

Lines changed: 125 additions & 125 deletions

File tree

packages/ui-extensions/src/surfaces/checkout/api/checkout/checkout.ts

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ export interface CartLineAddChange {
211211
attributes?: Attribute[];
212212

213213
/**
214-
* The identifier of the [selling plan](/docs/apps/build/purchase-options/subscriptions) to associate with this line item, such as a subscription or pre-order plan.
214+
* The identifier of the [selling plan](https://shopify.dev/docs/apps/build/purchase-options/subscriptions) to associate with this line item, such as a subscription or pre-order plan.
215215
*/
216216
sellingPlanId?: SellingPlan['id'];
217217

@@ -274,7 +274,7 @@ export interface CartLineUpdateChange {
274274
attributes?: Attribute[];
275275

276276
/**
277-
* The [selling plan](/docs/apps/build/purchase-options/subscriptions) to associate with this line item. Pass `null` to remove the item from its current selling plan.
277+
* The [selling plan](https://shopify.dev/docs/apps/build/purchase-options/subscriptions) to associate with this line item. Pass `null` to remove the item from its current selling plan.
278278
*/
279279
sellingPlanId?: SellingPlan['id'] | null;
280280

@@ -423,7 +423,7 @@ export interface GiftCardChangeResultError {
423423
message: string;
424424
}
425425

426-
/** Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace. */
426+
/** Removes a cart [metafield](https://shopify.dev/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace. */
427427
export interface MetafieldRemoveCartChange {
428428
/**
429429
* Identifies this as a cart metafield removal. Set this when creating a change to delete an existing metafield by key and namespace.
@@ -442,7 +442,7 @@ export interface MetafieldRemoveCartChange {
442442
}
443443

444444
/**
445-
* Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.
445+
* Creates or updates a cart [metafield](https://shopify.dev/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.
446446
*/
447447
export interface MetafieldUpdateCartChange {
448448
/**
@@ -465,7 +465,7 @@ export interface MetafieldUpdateCartChange {
465465

466466
/**
467467
* The metafield’s information type.
468-
* See the [metafield types documentation](/docs/apps/build/custom-data/metafields/list-of-data-types) for a list of supported types.
468+
* See the [metafield types documentation](https://shopify.dev/docs/apps/build/custom-data/metafields/list-of-data-types) for a list of supported types.
469469
*/
470470
type: string;
471471
};
@@ -474,7 +474,7 @@ export interface MetafieldUpdateCartChange {
474474
/**
475475
* The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.
476476
*
477-
* - `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).
477+
* - `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](https://shopify.dev/docs/apps/build/custom-data/metafields).
478478
* - `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.
479479
*/
480480
export type MetafieldChange =
@@ -596,59 +596,59 @@ export type ShippingAddressChangeResult =
596596
export interface CheckoutApi {
597597
/**
598598
* Updates or removes an attribute on the cart and checkout. On success, the
599-
* [`attributes`](/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.
599+
* [`attributes`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#standardapi-propertydetail-attributes) property updates to reflect the change.
600600
*
601-
* > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.
601+
* > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.
602602
*
603603
* @deprecated Use cart metafields instead.
604604
*/
605605
applyAttributeChange(change: AttributeChange): Promise<AttributeChangeResult>;
606606

607607
/**
608-
* Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.
608+
* Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#standardapi-propertydetail-lines) property updates with the new state.
609609
*
610-
* > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.
610+
* > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.
611611
*/
612612
applyCartLinesChange(change: CartLineChange): Promise<CartLineChangeResult>;
613613

614614
/**
615-
* Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.
615+
* Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#standardapi-propertydetail-discountcodes) property updates with the new state.
616616
*
617617
* > Caution:
618-
* > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.
618+
* > See [security considerations](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.
619619
*
620-
* > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.
620+
* > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.
621621
*/
622622
applyDiscountCodeChange(
623623
change: DiscountCodeChange,
624624
): Promise<DiscountCodeChangeResult>;
625625

626626
/**
627-
* Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.
627+
* Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property updates with the new state.
628628
*
629629
* > Caution:
630-
* > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.
630+
* > See [security considerations](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.
631631
*
632632
* > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.
633633
*/
634634
applyGiftCardChange(change: GiftCardChange): Promise<GiftCardChangeResult>;
635635

636636
/**
637637
* Creates, updates, or removes a cart metafield on the checkout. On success, the
638-
* [`metafields`](/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.
638+
* [`metafields`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#standardapi-propertydetail-metafields) property updates to reflect the change.
639639
*
640-
* Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.
640+
* Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](https://shopify.dev/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.
641641
*
642-
* > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.
642+
* > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.
643643
*/
644644
applyMetafieldChange(change: MetafieldChange): Promise<MetafieldChangeResult>;
645645

646646
/**
647647
* Sets or removes the buyer's note on the checkout. On success, the
648-
* [`note`](/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note)
648+
* [`note`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#standardapi-propertydetail-note)
649649
* property updates to reflect the change.
650650
*
651-
* > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.
651+
* > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.
652652
*/
653653
applyNoteChange(change: NoteChange): Promise<NoteChangeResult>;
654654

@@ -662,9 +662,9 @@ export interface CheckoutApi {
662662
* are merged into the existing address without prompting the buyer. On success,
663663
* the `shippingAddress` property updates to reflect the change.
664664
*
665-
* > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.
665+
* > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.
666666
*
667-
* {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
667+
* {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data).
668668
*/
669669
applyShippingAddressChange?(
670670
change: ShippingAddressChange,

packages/ui-extensions/src/surfaces/checkout/api/order-confirmation/order-confirmation.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ export interface OrderConfirmation {
44
order: {
55
/**
66
* A globally unique identifier for the order. This becomes the
7-
* [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the
7+
* [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) object ID in the
88
* GraphQL Admin API after the order is created.
99
*
1010
* @example 'gid://shopify/Order/123'

0 commit comments

Comments
 (0)