@shopify/shop-minis-cli 0.0.42 → 0.0.44

package/build/commands/types/autogenerated/shop-minis-admin-api/graphql.d.ts

@@ -85,6 +85,14 @@ export type CallToActionEntryPointSetInput = {
     /** The text of the call to action. */
     text: Scalars['String'];
 };
+/** This is a content creator that may appear next to a Mini entry point. */
+export type ContentCreator = {
+    __typename?: 'ContentCreator';
+    /** The avatar of the content creator. */
+    avatar: Image;
+    /** The name of the content creator. */
+    name: Scalars['String'];
+};
 /** Content creator that may appear next to a Mini entry point. */
 export type ContentCreatorInput = {
     /** The avatar of the content creator. */
@@ -106,6 +114,60 @@ export type EntryPointDebug = {
     /** The issues with the entry point. */
     issues: Array<Scalars['String']>;
 };
+/** Return type for the `entryPointDeleteByOwner` mutation. */
+export type EntryPointDeleteByOwnerPayload = {
+    __typename?: 'EntryPointDeleteByOwnerPayload';
+    /** The entry point id that was deleted. */
+    deletedEntryPointId?: Maybe<Scalars['ID']>;
+    /** List of errors that occured while executing the mutation. */
+    userErrors: Array<EntryPointDeleteByOwnerUserError>;
+};
+/** A user or client error that could occur during the execution of the `entryPointDeleteByOwner` mutation. */
+export type EntryPointDeleteByOwnerUserError = {
+    __typename?: 'EntryPointDeleteByOwnerUserError';
+    /** Error code associated with the error. */
+    code: EntryPointDeleteByOwnerUserErrorCode;
+    /** Which input value this error came from. */
+    field?: Maybe<Array<Scalars['String']>>;
+    /** A description of the error. */
+    message: Scalars['String'];
+};
+/** Possible error codes that can be returned by EntryPointDeleteByOwnerUserError. */
+export declare enum EntryPointDeleteByOwnerUserErrorCode {
+    /** Error code when the entry point definition is not found from the manifest. */
+    DefinitionNotFound = "DEFINITION_NOT_FOUND",
+    /** Error code when the entry point to be deleted is not found. */
+    EntryPointNotFound = "ENTRY_POINT_NOT_FOUND",
+    /** Error code when the shop is not found. */
+    ShopNotFound = "SHOP_NOT_FOUND"
+}
+/** Return type for the `entryPointDeleteByRule` mutation. */
+export type EntryPointDeleteByRulePayload = {
+    __typename?: 'EntryPointDeleteByRulePayload';
+    /** The entry point id that was deleted. */
+    deletedEntryPointId?: Maybe<Scalars['ID']>;
+    /** List of errors that occured while executing the mutation. */
+    userErrors: Array<EntryPointDeleteByRuleUserError>;
+};
+/** A user or client error that could occur during the execution of the `entryPointDeleteByRule` mutation. */
+export type EntryPointDeleteByRuleUserError = {
+    __typename?: 'EntryPointDeleteByRuleUserError';
+    /** Error code associated with the error. */
+    code: EntryPointDeleteByRuleUserErrorCode;
+    /** Which input value this error came from. */
+    field?: Maybe<Array<Scalars['String']>>;
+    /** A description of the error. */
+    message: Scalars['String'];
+};
+/** Possible error codes that can be returned by EntryPointDeleteByRuleUserError. */
+export declare enum EntryPointDeleteByRuleUserErrorCode {
+    /** Error code when the entry point definition is not found from the manifest. */
+    DefinitionNotFound = "DEFINITION_NOT_FOUND",
+    /** Error code when the entry point to be deleted is not found. */
+    EntryPointNotFound = "ENTRY_POINT_NOT_FOUND",
+    /** Error code when the shop is not found. */
+    ShopNotFound = "SHOP_NOT_FOUND"
+}
 /** The event status enum for an entry point. */
 export declare enum EntryPointEventStatus {
     /** The active status for Mini entry point event type. */
@@ -153,43 +215,38 @@ export declare enum EntryPointLocation {
     /** The Mini should be displayed on the store page. */
     StorePage = "STORE_PAGE"
 }
-/** The information needed to create a new entry point. */
-export type EntryPointSetInput = {
-    /** The call to action entry point set input. */
-    callToActionSetInput?: InputMaybe<CallToActionEntryPointSetInput>;
-    /** The image content card entry point set input. */
-    imageContentCardSetInput?: InputMaybe<ImageContentCardEntryPointSetInput>;
-    /** The live event entry point set input. */
-    liveEventSetInput?: InputMaybe<LiveEventEntryPointSetInput>;
-    /** The product image collection entry point set input. */
-    productImageCollectionSetInput?: InputMaybe<ProductImageCollectionEntryPointSetInput>;
-    /** The product video collection entry point set input. */
-    productVideoCollectionSetInput?: InputMaybe<ProductVideoCollectionEntryPointSetInput>;
+/** This is a product used for rendering a Mini entry point. */
+export type EntryPointProduct = {
+    __typename?: 'EntryPointProduct';
+    /** The image of the product. */
+    image: Image;
+    /** The shop name. */
+    shopName: Scalars['String'];
+    /** The title of the product. */
+    title: Scalars['String'];
 };
-/** Return type for the `entryPointSet` mutation. */
-export type EntryPointSetPayload = {
-    __typename?: 'EntryPointSetPayload';
+/** Return type for the `entryPointSetByOwner` mutation. */
+export type EntryPointSetByOwnerPayload = {
+    __typename?: 'EntryPointSetByOwnerPayload';
     /** The entry point that was created or updated. */
     entryPoint?: Maybe<EntryPoint>;
     /** List of errors that occured while executing the mutation. */
-    userErrors: Array<EntryPointSetUserError>;
+    userErrors: Array<EntryPointSetByOwnerUserError>;
 };
-/** A user or client error that could occur during the execution of the `entryPointSet` mutation. */
-export type EntryPointSetUserError = {
-    __typename?: 'EntryPointSetUserError';
+/** A user or client error that could occur during the execution of the `entryPointSetByOwner` mutation. */
+export type EntryPointSetByOwnerUserError = {
+    __typename?: 'EntryPointSetByOwnerUserError';
     /** Error code associated with the error. */
-    code: EntryPointSetUserErrorCode;
+    code: EntryPointSetByOwnerUserErrorCode;
     /** Which input value this error came from. */
     field?: Maybe<Array<Scalars['String']>>;
     /** A description of the error. */
     message: Scalars['String'];
 };
-/** Possible error codes that can be returned by EntryPointSetUserError. */
-export declare enum EntryPointSetUserErrorCode {
+/** Possible error codes that can be returned by EntryPointSetByOwnerUserError. */
+export declare enum EntryPointSetByOwnerUserErrorCode {
     /** Error code when the entry point definition is not found from the manifest. */
     DefinitionNotFound = "DEFINITION_NOT_FOUND",
-    /** Error code when the product ID is not provided when setting a Product Details Page entry point. */
-    MissingProductId = "MISSING_PRODUCT_ID",
     /** Error code when the product is not eligible for Shop Minis. */
     ProductNotEligible = "PRODUCT_NOT_ELIGIBLE",
     /** Error code when the shop is not eligible for Shop Minis. */
@@ -197,6 +254,67 @@ export declare enum EntryPointSetUserErrorCode {
     /** Error code when the shop is not found. */
     ShopNotFound = "SHOP_NOT_FOUND"
 }
+/** Return type for the `entryPointSetByRule` mutation. */
+export type EntryPointSetByRulePayload = {
+    __typename?: 'EntryPointSetByRulePayload';
+    /** The entry point that was created or updated. */
+    entryPoint?: Maybe<EntryPoint>;
+    /** List of errors that occured while executing the mutation. */
+    userErrors: Array<EntryPointSetByRuleUserError>;
+};
+/** A user or client error that could occur during the execution of the `entryPointSetByRule` mutation. */
+export type EntryPointSetByRuleUserError = {
+    __typename?: 'EntryPointSetByRuleUserError';
+    /** Error code associated with the error. */
+    code: EntryPointSetByRuleUserErrorCode;
+    /** Which input value this error came from. */
+    field?: Maybe<Array<Scalars['String']>>;
+    /** A description of the error. */
+    message: Scalars['String'];
+};
+/** Possible error codes that can be returned by EntryPointSetByRuleUserError. */
+export declare enum EntryPointSetByRuleUserErrorCode {
+    /** The entry point definition is not found from the manifest. */
+    DefinitionNotFound = "DEFINITION_NOT_FOUND",
+    /** The visibility rule is invalid. */
+    InvalidVisibilityRule = "INVALID_VISIBILITY_RULE",
+    /** The shop is not eligible for Shop Minis. */
+    ShopNotEligible = "SHOP_NOT_ELIGIBLE",
+    /** The shop is not found. */
+    ShopNotFound = "SHOP_NOT_FOUND"
+}
+/** The information needed to create a new entry point. */
+export type EntryPointSetInput = {
+    /** The call to action entry point set input. */
+    callToActionSetInput?: InputMaybe<CallToActionEntryPointSetInput>;
+    /** The image content card entry point set input. */
+    imageContentCardSetInput?: InputMaybe<ImageContentCardEntryPointSetInput>;
+    /** The live event entry point set input. */
+    liveEventSetInput?: InputMaybe<LiveEventEntryPointSetInput>;
+    /** The product image collection entry point set input. */
+    productImageCollectionSetInput?: InputMaybe<ProductImageCollectionEntryPointSetInput>;
+    /** The product video collection entry point set input. */
+    productVideoCollectionSetInput?: InputMaybe<ProductVideoCollectionEntryPointSetInput>;
+};
+/** The entry point type of a Mini. */
+export declare enum EntryPointType {
+    /** The Mini should be displayed as an action button. */
+    ActionButton = "ACTION_BUTTON",
+    /** The Mini should be displayed as a call to action. */
+    CallToAction = "CALL_TO_ACTION",
+    /** The Mini should be displayed as a card with content. */
+    ContentCard = "CONTENT_CARD",
+    /** The Mini should be displayed as a card with a reminder button. */
+    EventCard = "EVENT_CARD",
+    /** The Mini should be displayed as a card with an image and content. */
+    ImageContentCard = "IMAGE_CONTENT_CARD",
+    /** The Mini should be displayed as a live event. */
+    LiveEvent = "LIVE_EVENT",
+    /** The Mini should be displayed as a collection of images. */
+    ProductImageCollection = "PRODUCT_IMAGE_COLLECTION",
+    /** The Mini should be displayed as a collection of videos. */
+    ProductVideoCollection = "PRODUCT_VIDEO_COLLECTION"
+}
 /** Represents the validity of an entry point visibility rule. */
 export type EntryPointVisibilityRuleValidity = {
     __typename?: 'EntryPointVisibilityRuleValidity';
@@ -236,6 +354,16 @@ export type EntryPointVisibilityRuleValidityUserError = {
     message: Scalars['String'];
 };
 /** Represents a video hosted outside of Shopify. */
+export type ExternalVideo = {
+    __typename?: 'ExternalVideo';
+    /** The alt text for the media. */
+    alt?: Maybe<Scalars['String']>;
+    /** The embed URL of the video for the respective host. */
+    embedUrl: Scalars['URL'];
+    /** The preview image for the media. */
+    previewImage?: Maybe<Image>;
+};
+/** Represents a video hosted outside of Shopify. */
 export type ExternalVideoInput = {
     /** A word or phrase to share the nature or contents of a media. */
     alt?: InputMaybe<Scalars['String']>;
@@ -244,6 +372,24 @@ export type ExternalVideoInput = {
     /** The preview image for the media. */
     previewImage?: InputMaybe<ImageInput>;
 };
+/** The image for the entry point. */
+export type Image = {
+    __typename?: 'Image';
+    /** URL of the image. */
+    url: Scalars['URL'];
+};
+/** This is a Mini Image Content Card entry point for the Minis Admin API. */
+export type ImageContentCardEntryPoint = EntryPoint & {
+    __typename?: 'ImageContentCardEntryPoint';
+    /** The ID of the entry point. */
+    id?: Maybe<Scalars['ID']>;
+    /** The images for the card. */
+    images: Array<Image>;
+    /** The subtitle of the card. */
+    subtitle?: Maybe<Scalars['String']>;
+    /** The title of the card. */
+    title: Scalars['String'];
+};
 /** The information needed to create a new image content card entry point. */
 export type ImageContentCardEntryPointSetInput = {
     /** The images of the image content card. */
@@ -258,6 +404,26 @@ export type ImageInput = {
     /** The URL of the image. */
     url: Scalars['URL'];
 };
+/** This is a Mini Live Event entry point. */
+export type LiveEventEntryPoint = EntryPoint & {
+    __typename?: 'LiveEventEntryPoint';
+    /** The start time of the event. */
+    eventStartTime: Scalars['ISO8601DateTime'];
+    /** The status of the event. */
+    eventStatus: Scalars['String'];
+    /** The ID of the entry point. */
+    id?: Maybe<Scalars['ID']>;
+    /** The images for the card. */
+    image?: Maybe<Image>;
+    /** The topic to subscribe to for notifications. */
+    notificationTopic: Scalars['String'];
+    /** The primary text of the card. */
+    primaryText: Scalars['String'];
+    /** The secondary text of the card. */
+    secondaryText?: Maybe<Scalars['String']>;
+    /** The video for the card. */
+    video?: Maybe<ExternalVideo>;
+};
 /** The event status of the Mini live event entry point. */
 export declare enum LiveEventEntryPointEventStatusEnum {
     /** The active status for Mini entry point event type. */
@@ -269,8 +435,8 @@ export declare enum LiveEventEntryPointEventStatusEnum {
 }
 /** The information needed to create a new live event entry point. */
 export type LiveEventEntryPointSetInput = {
-    /** The event start date for the live event entry point. */
-    eventStartDate: Scalars['ISO8601DateTime'];
+    /** The event start time for the live event entry point. */
+    eventStartTime: Scalars['ISO8601DateTime'];
     /** The event status for the live event entry point. */
     eventStatus: LiveEventEntryPointEventStatusEnum;
     /** The image for the live event entry point. */
@@ -313,10 +479,16 @@ export type MiniProductVideoCollectionEntryPointItemInput = {
 };
 export type Mutation = {
     __typename?: 'Mutation';
+    /** Deletes an entry point by using its ownerId. */
+    entryPointDeleteByOwner: EntryPointDeleteByOwnerPayload;
+    /** Deletes an entry point with a visibility rule. */
+    entryPointDeleteByRule: EntryPointDeleteByRulePayload;
     /** Updates the status of an event entry point. */
     entryPointEventStatusUpdate: EntryPointEventStatusUpdatePayload;
     /** Creates or updates an entry point. */
-    entryPointSet: EntryPointSetPayload;
+    entryPointSetByOwner: EntryPointSetByOwnerPayload;
+    /** Creates or updates entry point by setting a visibility rule. */
+    entryPointSetByRule: EntryPointSetByRulePayload;
     /** Triggers a notification. */
     notificationTrigger: NotificationTriggerPayload;
     /** Cancels a pending submission. */
@@ -326,17 +498,34 @@ export type Mutation = {
     /** Creates a new staged upload for a submission. */
     submissionUploadCreate: SubmissionUploadCreatePayload;
 };
+export type MutationEntryPointDeleteByOwnerArgs = {
+    location: EntryPointLocation;
+    ownerId: Scalars['ID'];
+    shopDomain: Scalars['String'];
+    type: EntryPointType;
+};
+export type MutationEntryPointDeleteByRuleArgs = {
+    location: EntryPointLocation;
+    shopDomain: Scalars['String'];
+    type: EntryPointType;
+};
 export type MutationEntryPointEventStatusUpdateArgs = {
     productId?: InputMaybe<Scalars['ID']>;
     shopDomain?: InputMaybe<Scalars['String']>;
     status: EntryPointEventStatus;
 };
-export type MutationEntryPointSetArgs = {
-    entryPointSetInput: EntryPointSetInput;
+export type MutationEntryPointSetByOwnerArgs = {
+    input: EntryPointSetInput;
     location: EntryPointLocation;
-    productId?: InputMaybe<Scalars['ID']>;
+    ownerId: Scalars['ID'];
     shopDomain: Scalars['String'];
 };
+export type MutationEntryPointSetByRuleArgs = {
+    input: EntryPointSetInput;
+    location: EntryPointLocation;
+    shopDomain: Scalars['String'];
+    visibilityRule: Scalars['String'];
+};
 export type MutationNotificationTriggerArgs = {
     scopedEntityId: Scalars['ID'];
     shopDomain?: InputMaybe<Scalars['String']>;
@@ -410,6 +599,31 @@ export declare enum ProductEligibilityStatus {
     /** The product is ineligible to appear in Shop. */
     Ineligible = "INELIGIBLE"
 }
+/** This is a Mini Product Image Collection entry point. */
+export type ProductImageCollectionEntryPoint = EntryPoint & {
+    __typename?: 'ProductImageCollectionEntryPoint';
+    /** The ID of the entry point. */
+    id?: Maybe<Scalars['ID']>;
+    /** The items for the entry point. */
+    items: Array<ProductImageCollectionEntryPointItem>;
+    /** The layout for the entry point. */
+    layout: ProductImageCollectionEntryPointLayoutEnum;
+};
+/** This is a Mini Product Image Collection entry point item. */
+export type ProductImageCollectionEntryPointItem = {
+    __typename?: 'ProductImageCollectionEntryPointItem';
+    /** The external ID for the item. Provided by the partner and opaque to the Shop app. */
+    externalId?: Maybe<Scalars['ID']>;
+    /** The image for the item. */
+    image: Image;
+};
+/** The layout of the Mini product image collection entry point. */
+export declare enum ProductImageCollectionEntryPointLayoutEnum {
+    /** The layout is a carousel. */
+    Carousel = "CAROUSEL",
+    /** The layout is a grid. */
+    Grid = "GRID"
+}
 /** The information needed to create a new product image collection entry point. */
 export type ProductImageCollectionEntryPointSetInput = {
     /** The items for the entry point. */
@@ -417,6 +631,28 @@ export type ProductImageCollectionEntryPointSetInput = {
     /** The layout for the entry point. */
     layout: MiniProductImageCollectionEntryPointLayoutEnum;
 };
+/** This is a Mini Product Video Collection entry point. */
+export type ProductVideoCollectionEntryPoint = EntryPoint & {
+    __typename?: 'ProductVideoCollectionEntryPoint';
+    /** The ID of the entry point. */
+    id?: Maybe<Scalars['ID']>;
+    /** The items for the entry point. */
+    items: Array<ProductVideoCollectionEntryPointItem>;
+};
+/** This is a Mini Product Video Collection entry point item. */
+export type ProductVideoCollectionEntryPointItem = {
+    __typename?: 'ProductVideoCollectionEntryPointItem';
+    /** The content creator for the item. */
+    contentCreator?: Maybe<ContentCreator>;
+    /** The external ID for the item. Provided by the partner and opaque to the Shop app. */
+    externalId?: Maybe<Scalars['ID']>;
+    /** The image for the item. */
+    image: Image;
+    /** The product for the item. */
+    product?: Maybe<EntryPointProduct>;
+    /** The video for the item. */
+    video?: Maybe<ExternalVideo>;
+};
 /** The information needed to create or update a product video collection entry point. */
 export type ProductVideoCollectionEntryPointSetInput = {
     /** The items for the entry point. */
@@ -633,25 +869,23 @@ export type Warning = {
     /** Description of the warning. */
     message: Scalars['String'];
 };
-export type CreateUploadMutationVariables = Exact<{
-    filename: Scalars['String'];
-    fileSize: Scalars['Int'];
-    checksum: Scalars['String'];
-    mimeType: Scalars['String'];
+export type CancelSubmissionMutationVariables = Exact<{
+    reference: Scalars['String'];
 }>;
-export type CreateUploadMutation = {
+export type CancelSubmissionMutation = {
     __typename?: 'Mutation';
-    submissionUploadCreate: {
-        __typename?: 'SubmissionUploadCreatePayload';
-        upload?: {
-            __typename?: 'StagedUpload';
-            url: any;
-            headers: string;
-            id: string;
+    submissionCancel: {
+        __typename?: 'SubmissionCancelPayload';
+        submission?: {
+            __typename?: 'Submission';
+            reference: string;
+            description: string;
+            status: SubmissionStatus;
+            submittedAt: any;
         } | null;
         userErrors: Array<{
-            __typename?: 'SubmissionUploadCreateUserError';
-            code: SubmissionUploadCreateUserErrorCode;
+            __typename?: 'SubmissionCancelUserError';
+            code: SubmissionCancelUserErrorCode;
             message: string;
             field?: Array<string> | null;
         }>;
@@ -680,23 +914,25 @@ export type CreateSubmissionMutation = {
         }>;
     };
 };
-export type CancelSubmissionMutationVariables = Exact<{
-    reference: Scalars['String'];
+export type CreateUploadMutationVariables = Exact<{
+    filename: Scalars['String'];
+    fileSize: Scalars['Int'];
+    checksum: Scalars['String'];
+    mimeType: Scalars['String'];
 }>;
-export type CancelSubmissionMutation = {
+export type CreateUploadMutation = {
     __typename?: 'Mutation';
-    submissionCancel: {
-        __typename?: 'SubmissionCancelPayload';
-        submission?: {
-            __typename?: 'Submission';
-            reference: string;
-            description: string;
-            status: SubmissionStatus;
-            submittedAt: any;
+    submissionUploadCreate: {
+        __typename?: 'SubmissionUploadCreatePayload';
+        upload?: {
+            __typename?: 'StagedUpload';
+            url: any;
+            headers: string;
+            id: string;
         } | null;
         userErrors: Array<{
-            __typename?: 'SubmissionCancelUserError';
-            code: SubmissionCancelUserErrorCode;
+            __typename?: 'SubmissionUploadCreateUserError';
+            code: SubmissionUploadCreateUserErrorCode;
             message: string;
             field?: Array<string> | null;
         }>;
@@ -725,18 +961,18 @@ export type SubmissionsQuery = {
         };
     };
 };
-export declare const CreateUploadDocument: DocumentNode<CreateUploadMutation, Exact<{
-    filename: Scalars['String'];
-    fileSize: Scalars['Int'];
-    checksum: Scalars['String'];
-    mimeType: Scalars['String'];
+export declare const CancelSubmissionDocument: DocumentNode<CancelSubmissionMutation, Exact<{
+    reference: Scalars['String'];
 }>>;
 export declare const CreateSubmissionDocument: DocumentNode<CreateSubmissionMutation, Exact<{
     description: Scalars['String'];
     uploadId: Scalars['ID'];
 }>>;
-export declare const CancelSubmissionDocument: DocumentNode<CancelSubmissionMutation, Exact<{
-    reference: Scalars['String'];
+export declare const CreateUploadDocument: DocumentNode<CreateUploadMutation, Exact<{
+    filename: Scalars['String'];
+    fileSize: Scalars['Int'];
+    checksum: Scalars['String'];
+    mimeType: Scalars['String'];
 }>>;
 export declare const SubmissionsDocument: DocumentNode<SubmissionsQuery, Exact<{
     first?: InputMaybe<number> | undefined;