From b0ef8f18979145d95e040b19afe110cb0479502f Mon Sep 17 00:00:00 2001 From: Elizabeth Kenyon Date: Fri, 12 Jul 2024 15:29:17 -0500 Subject: [PATCH] Clarify amount for usage charge line item It is the capped or maximum amount --- .../apps/shopify-api/lib/billing/types.ts | 4 + .../docs/generated/generated_docs_data.json | 148 ++++++++++++++---- 2 files changed, 122 insertions(+), 30 deletions(-) diff --git a/packages/apps/shopify-api/lib/billing/types.ts b/packages/apps/shopify-api/lib/billing/types.ts index 2dc2078fff..3f41f19430 100644 --- a/packages/apps/shopify-api/lib/billing/types.ts +++ b/packages/apps/shopify-api/lib/billing/types.ts @@ -189,6 +189,10 @@ export interface BillingConfigUsageLineItem extends BillingConfigLineItem { * Must be set to `Usage`. */ interval: BillingInterval.Usage; + /** + * The capped amount or the maximum amount to be charged in the interval. + */ + amount: number; /** * Usage terms for this line item. */ diff --git a/packages/apps/shopify-app-remix/docs/generated/generated_docs_data.json b/packages/apps/shopify-app-remix/docs/generated/generated_docs_data.json index 34840a7593..c50901d3d7 100644 --- a/packages/apps/shopify-app-remix/docs/generated/generated_docs_data.json +++ b/packages/apps/shopify-app-remix/docs/generated/generated_docs_data.json @@ -1081,7 +1081,7 @@ "syntaxKind": "PropertySignature", "name": "isTest", "value": "boolean", - "description": "Whether to consider test purchases.", + "description": "Whether to include charges that were created on test mode. Test shops and demo shops cannot be charged.", "isOptional": true }, { @@ -1239,7 +1239,7 @@ "syntaxKind": "PropertySignature", "name": "isTest", "value": "boolean", - "description": "Whether to consider test purchases.", + "description": "Whether to include charges that were created on test mode. Test shops and demo shops cannot be charged.", "isOptional": true }, { @@ -1348,7 +1348,14 @@ "syntaxKind": "MethodDeclaration", "name": "isScopeChanged", "value": "(scopes: string | string[] | AuthScopes) => boolean", - "description": "Whether the access token has the given scopes." + "description": "Whether the access token includes the given scopes if they are provided." + }, + { + "filePath": "../shopify-api/dist/ts/lib/session/session.d.ts", + "syntaxKind": "MethodDeclaration", + "name": "isScopeIncluded", + "value": "(scopes: string | string[] | AuthScopes) => boolean", + "description": "Whether the access token includes the given scopes." }, { "filePath": "../shopify-api/dist/ts/lib/session/session.d.ts", @@ -1379,7 +1386,7 @@ "description": "Converts the session into an array of key-value pairs." } ], - "value": "export declare class Session {\n static fromPropertyArray(entries: [string, string | number | boolean][], returnUserData?: boolean): Session;\n /**\n * The unique identifier for the session.\n */\n readonly id: string;\n /**\n * The Shopify shop domain, such as `example.myshopify.com`.\n */\n shop: string;\n /**\n * The state of the session. Used for the OAuth authentication code flow.\n */\n state: string;\n /**\n * Whether the access token in the session is online or offline.\n */\n isOnline: boolean;\n /**\n * The desired scopes for the access token, at the time the session was created.\n */\n scope?: string;\n /**\n * The date the access token expires.\n */\n expires?: Date;\n /**\n * The access token for the session.\n */\n accessToken?: string;\n /**\n * Information on the user for the session. Only present for online sessions.\n */\n onlineAccessInfo?: OnlineAccessInfo;\n constructor(params: SessionParams);\n /**\n * Whether the session is active. Active sessions have an access token that is not expired, and has has the given\n * scopes if scopes is equal to a truthy value.\n */\n isActive(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token has the given scopes.\n */\n isScopeChanged(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token is expired.\n */\n isExpired(withinMillisecondsOfExpiry?: number): boolean;\n /**\n * Converts an object with data into a Session.\n */\n toObject(): SessionParams;\n /**\n * Checks whether the given session is equal to this session.\n */\n equals(other: Session | undefined): boolean;\n /**\n * Converts the session into an array of key-value pairs.\n */\n toPropertyArray(returnUserData?: boolean): [string, string | number | boolean][];\n}" + "value": "export declare class Session {\n static fromPropertyArray(entries: [string, string | number | boolean][], returnUserData?: boolean): Session;\n /**\n * The unique identifier for the session.\n */\n readonly id: string;\n /**\n * The Shopify shop domain, such as `example.myshopify.com`.\n */\n shop: string;\n /**\n * The state of the session. Used for the OAuth authentication code flow.\n */\n state: string;\n /**\n * Whether the access token in the session is online or offline.\n */\n isOnline: boolean;\n /**\n * The desired scopes for the access token, at the time the session was created.\n */\n scope?: string;\n /**\n * The date the access token expires.\n */\n expires?: Date;\n /**\n * The access token for the session.\n */\n accessToken?: string;\n /**\n * Information on the user for the session. Only present for online sessions.\n */\n onlineAccessInfo?: OnlineAccessInfo;\n constructor(params: SessionParams);\n /**\n * Whether the session is active. Active sessions have an access token that is not expired, and has has the given\n * scopes if scopes is equal to a truthy value.\n */\n isActive(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token includes the given scopes if they are provided.\n */\n isScopeChanged(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token includes the given scopes.\n */\n isScopeIncluded(scopes: AuthScopes | string | string[]): boolean;\n /**\n * Whether the access token is expired.\n */\n isExpired(withinMillisecondsOfExpiry?: number): boolean;\n /**\n * Converts an object with data into a Session.\n */\n toObject(): SessionParams;\n /**\n * Checks whether the given session is equal to this session.\n */\n equals(other: Session | undefined): boolean;\n /**\n * Converts the session into an array of key-value pairs.\n */\n toPropertyArray(returnUserData?: boolean): [string, string | number | boolean][];\n}" }, "OnlineAccessInfo": { "filePath": "../shopify-api/dist/ts/lib/auth/oauth/types.d.ts", @@ -2849,7 +2856,7 @@ "syntaxKind": "PropertySignature", "name": "isTest", "value": "boolean", - "description": "Whether to consider test purchases.", + "description": "Whether to include charges that were created on test mode. Test shops and demo shops cannot be charged.", "isOptional": true }, { @@ -3007,7 +3014,7 @@ "syntaxKind": "PropertySignature", "name": "isTest", "value": "boolean", - "description": "Whether to consider test purchases.", + "description": "Whether to include charges that were created on test mode. Test shops and demo shops cannot be charged.", "isOptional": true }, { @@ -3341,7 +3348,14 @@ "syntaxKind": "MethodDeclaration", "name": "isScopeChanged", "value": "(scopes: string | string[] | AuthScopes) => boolean", - "description": "Whether the access token has the given scopes." + "description": "Whether the access token includes the given scopes if they are provided." + }, + { + "filePath": "../shopify-api/dist/ts/lib/session/session.d.ts", + "syntaxKind": "MethodDeclaration", + "name": "isScopeIncluded", + "value": "(scopes: string | string[] | AuthScopes) => boolean", + "description": "Whether the access token includes the given scopes." }, { "filePath": "../shopify-api/dist/ts/lib/session/session.d.ts", @@ -3372,7 +3386,7 @@ "description": "Converts the session into an array of key-value pairs." } ], - "value": "export declare class Session {\n static fromPropertyArray(entries: [string, string | number | boolean][], returnUserData?: boolean): Session;\n /**\n * The unique identifier for the session.\n */\n readonly id: string;\n /**\n * The Shopify shop domain, such as `example.myshopify.com`.\n */\n shop: string;\n /**\n * The state of the session. Used for the OAuth authentication code flow.\n */\n state: string;\n /**\n * Whether the access token in the session is online or offline.\n */\n isOnline: boolean;\n /**\n * The desired scopes for the access token, at the time the session was created.\n */\n scope?: string;\n /**\n * The date the access token expires.\n */\n expires?: Date;\n /**\n * The access token for the session.\n */\n accessToken?: string;\n /**\n * Information on the user for the session. Only present for online sessions.\n */\n onlineAccessInfo?: OnlineAccessInfo;\n constructor(params: SessionParams);\n /**\n * Whether the session is active. Active sessions have an access token that is not expired, and has has the given\n * scopes if scopes is equal to a truthy value.\n */\n isActive(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token has the given scopes.\n */\n isScopeChanged(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token is expired.\n */\n isExpired(withinMillisecondsOfExpiry?: number): boolean;\n /**\n * Converts an object with data into a Session.\n */\n toObject(): SessionParams;\n /**\n * Checks whether the given session is equal to this session.\n */\n equals(other: Session | undefined): boolean;\n /**\n * Converts the session into an array of key-value pairs.\n */\n toPropertyArray(returnUserData?: boolean): [string, string | number | boolean][];\n}" + "value": "export declare class Session {\n static fromPropertyArray(entries: [string, string | number | boolean][], returnUserData?: boolean): Session;\n /**\n * The unique identifier for the session.\n */\n readonly id: string;\n /**\n * The Shopify shop domain, such as `example.myshopify.com`.\n */\n shop: string;\n /**\n * The state of the session. Used for the OAuth authentication code flow.\n */\n state: string;\n /**\n * Whether the access token in the session is online or offline.\n */\n isOnline: boolean;\n /**\n * The desired scopes for the access token, at the time the session was created.\n */\n scope?: string;\n /**\n * The date the access token expires.\n */\n expires?: Date;\n /**\n * The access token for the session.\n */\n accessToken?: string;\n /**\n * Information on the user for the session. Only present for online sessions.\n */\n onlineAccessInfo?: OnlineAccessInfo;\n constructor(params: SessionParams);\n /**\n * Whether the session is active. Active sessions have an access token that is not expired, and has has the given\n * scopes if scopes is equal to a truthy value.\n */\n isActive(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token includes the given scopes if they are provided.\n */\n isScopeChanged(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token includes the given scopes.\n */\n isScopeIncluded(scopes: AuthScopes | string | string[]): boolean;\n /**\n * Whether the access token is expired.\n */\n isExpired(withinMillisecondsOfExpiry?: number): boolean;\n /**\n * Converts an object with data into a Session.\n */\n toObject(): SessionParams;\n /**\n * Checks whether the given session is equal to this session.\n */\n equals(other: Session | undefined): boolean;\n /**\n * Converts the session into an array of key-value pairs.\n */\n toPropertyArray(returnUserData?: boolean): [string, string | number | boolean][];\n}" }, "OnlineAccessInfo": { "filePath": "../shopify-api/dist/ts/lib/auth/oauth/types.d.ts", @@ -3888,7 +3902,14 @@ "syntaxKind": "MethodDeclaration", "name": "isScopeChanged", "value": "(scopes: string | string[] | AuthScopes) => boolean", - "description": "Whether the access token has the given scopes." + "description": "Whether the access token includes the given scopes if they are provided." + }, + { + "filePath": "../shopify-api/dist/ts/lib/session/session.d.ts", + "syntaxKind": "MethodDeclaration", + "name": "isScopeIncluded", + "value": "(scopes: string | string[] | AuthScopes) => boolean", + "description": "Whether the access token includes the given scopes." }, { "filePath": "../shopify-api/dist/ts/lib/session/session.d.ts", @@ -3919,7 +3940,7 @@ "description": "Converts the session into an array of key-value pairs." } ], - "value": "export declare class Session {\n static fromPropertyArray(entries: [string, string | number | boolean][], returnUserData?: boolean): Session;\n /**\n * The unique identifier for the session.\n */\n readonly id: string;\n /**\n * The Shopify shop domain, such as `example.myshopify.com`.\n */\n shop: string;\n /**\n * The state of the session. Used for the OAuth authentication code flow.\n */\n state: string;\n /**\n * Whether the access token in the session is online or offline.\n */\n isOnline: boolean;\n /**\n * The desired scopes for the access token, at the time the session was created.\n */\n scope?: string;\n /**\n * The date the access token expires.\n */\n expires?: Date;\n /**\n * The access token for the session.\n */\n accessToken?: string;\n /**\n * Information on the user for the session. Only present for online sessions.\n */\n onlineAccessInfo?: OnlineAccessInfo;\n constructor(params: SessionParams);\n /**\n * Whether the session is active. Active sessions have an access token that is not expired, and has has the given\n * scopes if scopes is equal to a truthy value.\n */\n isActive(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token has the given scopes.\n */\n isScopeChanged(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token is expired.\n */\n isExpired(withinMillisecondsOfExpiry?: number): boolean;\n /**\n * Converts an object with data into a Session.\n */\n toObject(): SessionParams;\n /**\n * Checks whether the given session is equal to this session.\n */\n equals(other: Session | undefined): boolean;\n /**\n * Converts the session into an array of key-value pairs.\n */\n toPropertyArray(returnUserData?: boolean): [string, string | number | boolean][];\n}" + "value": "export declare class Session {\n static fromPropertyArray(entries: [string, string | number | boolean][], returnUserData?: boolean): Session;\n /**\n * The unique identifier for the session.\n */\n readonly id: string;\n /**\n * The Shopify shop domain, such as `example.myshopify.com`.\n */\n shop: string;\n /**\n * The state of the session. Used for the OAuth authentication code flow.\n */\n state: string;\n /**\n * Whether the access token in the session is online or offline.\n */\n isOnline: boolean;\n /**\n * The desired scopes for the access token, at the time the session was created.\n */\n scope?: string;\n /**\n * The date the access token expires.\n */\n expires?: Date;\n /**\n * The access token for the session.\n */\n accessToken?: string;\n /**\n * Information on the user for the session. Only present for online sessions.\n */\n onlineAccessInfo?: OnlineAccessInfo;\n constructor(params: SessionParams);\n /**\n * Whether the session is active. Active sessions have an access token that is not expired, and has has the given\n * scopes if scopes is equal to a truthy value.\n */\n isActive(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token includes the given scopes if they are provided.\n */\n isScopeChanged(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token includes the given scopes.\n */\n isScopeIncluded(scopes: AuthScopes | string | string[]): boolean;\n /**\n * Whether the access token is expired.\n */\n isExpired(withinMillisecondsOfExpiry?: number): boolean;\n /**\n * Converts an object with data into a Session.\n */\n toObject(): SessionParams;\n /**\n * Checks whether the given session is equal to this session.\n */\n equals(other: Session | undefined): boolean;\n /**\n * Converts the session into an array of key-value pairs.\n */\n toPropertyArray(returnUserData?: boolean): [string, string | number | boolean][];\n}" }, "OnlineAccessInfo": { "filePath": "../shopify-api/dist/ts/lib/auth/oauth/types.d.ts", @@ -4594,7 +4615,14 @@ "syntaxKind": "MethodDeclaration", "name": "isScopeChanged", "value": "(scopes: string | string[] | AuthScopes) => boolean", - "description": "Whether the access token has the given scopes." + "description": "Whether the access token includes the given scopes if they are provided." + }, + { + "filePath": "../shopify-api/dist/ts/lib/session/session.d.ts", + "syntaxKind": "MethodDeclaration", + "name": "isScopeIncluded", + "value": "(scopes: string | string[] | AuthScopes) => boolean", + "description": "Whether the access token includes the given scopes." }, { "filePath": "../shopify-api/dist/ts/lib/session/session.d.ts", @@ -4625,7 +4653,7 @@ "description": "Converts the session into an array of key-value pairs." } ], - "value": "export declare class Session {\n static fromPropertyArray(entries: [string, string | number | boolean][], returnUserData?: boolean): Session;\n /**\n * The unique identifier for the session.\n */\n readonly id: string;\n /**\n * The Shopify shop domain, such as `example.myshopify.com`.\n */\n shop: string;\n /**\n * The state of the session. Used for the OAuth authentication code flow.\n */\n state: string;\n /**\n * Whether the access token in the session is online or offline.\n */\n isOnline: boolean;\n /**\n * The desired scopes for the access token, at the time the session was created.\n */\n scope?: string;\n /**\n * The date the access token expires.\n */\n expires?: Date;\n /**\n * The access token for the session.\n */\n accessToken?: string;\n /**\n * Information on the user for the session. Only present for online sessions.\n */\n onlineAccessInfo?: OnlineAccessInfo;\n constructor(params: SessionParams);\n /**\n * Whether the session is active. Active sessions have an access token that is not expired, and has has the given\n * scopes if scopes is equal to a truthy value.\n */\n isActive(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token has the given scopes.\n */\n isScopeChanged(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token is expired.\n */\n isExpired(withinMillisecondsOfExpiry?: number): boolean;\n /**\n * Converts an object with data into a Session.\n */\n toObject(): SessionParams;\n /**\n * Checks whether the given session is equal to this session.\n */\n equals(other: Session | undefined): boolean;\n /**\n * Converts the session into an array of key-value pairs.\n */\n toPropertyArray(returnUserData?: boolean): [string, string | number | boolean][];\n}" + "value": "export declare class Session {\n static fromPropertyArray(entries: [string, string | number | boolean][], returnUserData?: boolean): Session;\n /**\n * The unique identifier for the session.\n */\n readonly id: string;\n /**\n * The Shopify shop domain, such as `example.myshopify.com`.\n */\n shop: string;\n /**\n * The state of the session. Used for the OAuth authentication code flow.\n */\n state: string;\n /**\n * Whether the access token in the session is online or offline.\n */\n isOnline: boolean;\n /**\n * The desired scopes for the access token, at the time the session was created.\n */\n scope?: string;\n /**\n * The date the access token expires.\n */\n expires?: Date;\n /**\n * The access token for the session.\n */\n accessToken?: string;\n /**\n * Information on the user for the session. Only present for online sessions.\n */\n onlineAccessInfo?: OnlineAccessInfo;\n constructor(params: SessionParams);\n /**\n * Whether the session is active. Active sessions have an access token that is not expired, and has has the given\n * scopes if scopes is equal to a truthy value.\n */\n isActive(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token includes the given scopes if they are provided.\n */\n isScopeChanged(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token includes the given scopes.\n */\n isScopeIncluded(scopes: AuthScopes | string | string[]): boolean;\n /**\n * Whether the access token is expired.\n */\n isExpired(withinMillisecondsOfExpiry?: number): boolean;\n /**\n * Converts an object with data into a Session.\n */\n toObject(): SessionParams;\n /**\n * Checks whether the given session is equal to this session.\n */\n equals(other: Session | undefined): boolean;\n /**\n * Converts the session into an array of key-value pairs.\n */\n toPropertyArray(returnUserData?: boolean): [string, string | number | boolean][];\n}" }, "OnlineAccessInfo": { "filePath": "../shopify-api/dist/ts/lib/auth/oauth/types.d.ts", @@ -4984,7 +5012,7 @@ "filePath": "../shopify-api/dist/ts/lib/types.d.ts", "syntaxKind": "EnumDeclaration", "name": "ApiVersion", - "value": "export declare enum ApiVersion {\n October22 = \"2022-10\",\n January23 = \"2023-01\",\n April23 = \"2023-04\",\n July23 = \"2023-07\",\n October23 = \"2023-10\",\n January24 = \"2024-01\",\n April24 = \"2024-04\",\n Unstable = \"unstable\"\n}", + "value": "export declare enum ApiVersion {\n October22 = \"2022-10\",\n January23 = \"2023-01\",\n April23 = \"2023-04\",\n July23 = \"2023-07\",\n October23 = \"2023-10\",\n January24 = \"2024-01\",\n April24 = \"2024-04\",\n July24 = \"2024-07\",\n Unstable = \"unstable\"\n}", "members": [ { "filePath": "../shopify-api/dist/ts/lib/types.d.ts", @@ -5021,6 +5049,11 @@ "name": "April24", "value": "2024-04" }, + { + "filePath": "../shopify-api/dist/ts/lib/types.d.ts", + "name": "July24", + "value": "2024-07" + }, { "filePath": "../shopify-api/dist/ts/lib/types.d.ts", "name": "Unstable", @@ -6142,7 +6175,14 @@ "syntaxKind": "MethodDeclaration", "name": "isScopeChanged", "value": "(scopes: string | string[] | AuthScopes) => boolean", - "description": "Whether the access token has the given scopes." + "description": "Whether the access token includes the given scopes if they are provided." + }, + { + "filePath": "../shopify-api/dist/ts/lib/session/session.d.ts", + "syntaxKind": "MethodDeclaration", + "name": "isScopeIncluded", + "value": "(scopes: string | string[] | AuthScopes) => boolean", + "description": "Whether the access token includes the given scopes." }, { "filePath": "../shopify-api/dist/ts/lib/session/session.d.ts", @@ -6173,7 +6213,7 @@ "description": "Converts the session into an array of key-value pairs." } ], - "value": "export declare class Session {\n static fromPropertyArray(entries: [string, string | number | boolean][], returnUserData?: boolean): Session;\n /**\n * The unique identifier for the session.\n */\n readonly id: string;\n /**\n * The Shopify shop domain, such as `example.myshopify.com`.\n */\n shop: string;\n /**\n * The state of the session. Used for the OAuth authentication code flow.\n */\n state: string;\n /**\n * Whether the access token in the session is online or offline.\n */\n isOnline: boolean;\n /**\n * The desired scopes for the access token, at the time the session was created.\n */\n scope?: string;\n /**\n * The date the access token expires.\n */\n expires?: Date;\n /**\n * The access token for the session.\n */\n accessToken?: string;\n /**\n * Information on the user for the session. Only present for online sessions.\n */\n onlineAccessInfo?: OnlineAccessInfo;\n constructor(params: SessionParams);\n /**\n * Whether the session is active. Active sessions have an access token that is not expired, and has has the given\n * scopes if scopes is equal to a truthy value.\n */\n isActive(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token has the given scopes.\n */\n isScopeChanged(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token is expired.\n */\n isExpired(withinMillisecondsOfExpiry?: number): boolean;\n /**\n * Converts an object with data into a Session.\n */\n toObject(): SessionParams;\n /**\n * Checks whether the given session is equal to this session.\n */\n equals(other: Session | undefined): boolean;\n /**\n * Converts the session into an array of key-value pairs.\n */\n toPropertyArray(returnUserData?: boolean): [string, string | number | boolean][];\n}" + "value": "export declare class Session {\n static fromPropertyArray(entries: [string, string | number | boolean][], returnUserData?: boolean): Session;\n /**\n * The unique identifier for the session.\n */\n readonly id: string;\n /**\n * The Shopify shop domain, such as `example.myshopify.com`.\n */\n shop: string;\n /**\n * The state of the session. Used for the OAuth authentication code flow.\n */\n state: string;\n /**\n * Whether the access token in the session is online or offline.\n */\n isOnline: boolean;\n /**\n * The desired scopes for the access token, at the time the session was created.\n */\n scope?: string;\n /**\n * The date the access token expires.\n */\n expires?: Date;\n /**\n * The access token for the session.\n */\n accessToken?: string;\n /**\n * Information on the user for the session. Only present for online sessions.\n */\n onlineAccessInfo?: OnlineAccessInfo;\n constructor(params: SessionParams);\n /**\n * Whether the session is active. Active sessions have an access token that is not expired, and has has the given\n * scopes if scopes is equal to a truthy value.\n */\n isActive(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token includes the given scopes if they are provided.\n */\n isScopeChanged(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token includes the given scopes.\n */\n isScopeIncluded(scopes: AuthScopes | string | string[]): boolean;\n /**\n * Whether the access token is expired.\n */\n isExpired(withinMillisecondsOfExpiry?: number): boolean;\n /**\n * Converts an object with data into a Session.\n */\n toObject(): SessionParams;\n /**\n * Checks whether the given session is equal to this session.\n */\n equals(other: Session | undefined): boolean;\n /**\n * Converts the session into an array of key-value pairs.\n */\n toPropertyArray(returnUserData?: boolean): [string, string | number | boolean][];\n}" }, "OnlineAccessInfo": { "filePath": "../shopify-api/dist/ts/lib/auth/oauth/types.d.ts", @@ -6761,7 +6801,7 @@ "filePath": "../shopify-api/dist/ts/lib/types.d.ts", "syntaxKind": "EnumDeclaration", "name": "ApiVersion", - "value": "export declare enum ApiVersion {\n October22 = \"2022-10\",\n January23 = \"2023-01\",\n April23 = \"2023-04\",\n July23 = \"2023-07\",\n October23 = \"2023-10\",\n January24 = \"2024-01\",\n April24 = \"2024-04\",\n Unstable = \"unstable\"\n}", + "value": "export declare enum ApiVersion {\n October22 = \"2022-10\",\n January23 = \"2023-01\",\n April23 = \"2023-04\",\n July23 = \"2023-07\",\n October23 = \"2023-10\",\n January24 = \"2024-01\",\n April24 = \"2024-04\",\n July24 = \"2024-07\",\n Unstable = \"unstable\"\n}", "members": [ { "filePath": "../shopify-api/dist/ts/lib/types.d.ts", @@ -6798,6 +6838,11 @@ "name": "April24", "value": "2024-04" }, + { + "filePath": "../shopify-api/dist/ts/lib/types.d.ts", + "name": "July24", + "value": "2024-07" + }, { "filePath": "../shopify-api/dist/ts/lib/types.d.ts", "name": "Unstable", @@ -6955,7 +7000,14 @@ "syntaxKind": "MethodDeclaration", "name": "isScopeChanged", "value": "(scopes: string | string[] | AuthScopes) => boolean", - "description": "Whether the access token has the given scopes." + "description": "Whether the access token includes the given scopes if they are provided." + }, + { + "filePath": "../shopify-api/dist/ts/lib/session/session.d.ts", + "syntaxKind": "MethodDeclaration", + "name": "isScopeIncluded", + "value": "(scopes: string | string[] | AuthScopes) => boolean", + "description": "Whether the access token includes the given scopes." }, { "filePath": "../shopify-api/dist/ts/lib/session/session.d.ts", @@ -6986,7 +7038,7 @@ "description": "Converts the session into an array of key-value pairs." } ], - "value": "export declare class Session {\n static fromPropertyArray(entries: [string, string | number | boolean][], returnUserData?: boolean): Session;\n /**\n * The unique identifier for the session.\n */\n readonly id: string;\n /**\n * The Shopify shop domain, such as `example.myshopify.com`.\n */\n shop: string;\n /**\n * The state of the session. Used for the OAuth authentication code flow.\n */\n state: string;\n /**\n * Whether the access token in the session is online or offline.\n */\n isOnline: boolean;\n /**\n * The desired scopes for the access token, at the time the session was created.\n */\n scope?: string;\n /**\n * The date the access token expires.\n */\n expires?: Date;\n /**\n * The access token for the session.\n */\n accessToken?: string;\n /**\n * Information on the user for the session. Only present for online sessions.\n */\n onlineAccessInfo?: OnlineAccessInfo;\n constructor(params: SessionParams);\n /**\n * Whether the session is active. Active sessions have an access token that is not expired, and has has the given\n * scopes if scopes is equal to a truthy value.\n */\n isActive(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token has the given scopes.\n */\n isScopeChanged(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token is expired.\n */\n isExpired(withinMillisecondsOfExpiry?: number): boolean;\n /**\n * Converts an object with data into a Session.\n */\n toObject(): SessionParams;\n /**\n * Checks whether the given session is equal to this session.\n */\n equals(other: Session | undefined): boolean;\n /**\n * Converts the session into an array of key-value pairs.\n */\n toPropertyArray(returnUserData?: boolean): [string, string | number | boolean][];\n}" + "value": "export declare class Session {\n static fromPropertyArray(entries: [string, string | number | boolean][], returnUserData?: boolean): Session;\n /**\n * The unique identifier for the session.\n */\n readonly id: string;\n /**\n * The Shopify shop domain, such as `example.myshopify.com`.\n */\n shop: string;\n /**\n * The state of the session. Used for the OAuth authentication code flow.\n */\n state: string;\n /**\n * Whether the access token in the session is online or offline.\n */\n isOnline: boolean;\n /**\n * The desired scopes for the access token, at the time the session was created.\n */\n scope?: string;\n /**\n * The date the access token expires.\n */\n expires?: Date;\n /**\n * The access token for the session.\n */\n accessToken?: string;\n /**\n * Information on the user for the session. Only present for online sessions.\n */\n onlineAccessInfo?: OnlineAccessInfo;\n constructor(params: SessionParams);\n /**\n * Whether the session is active. Active sessions have an access token that is not expired, and has has the given\n * scopes if scopes is equal to a truthy value.\n */\n isActive(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token includes the given scopes if they are provided.\n */\n isScopeChanged(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token includes the given scopes.\n */\n isScopeIncluded(scopes: AuthScopes | string | string[]): boolean;\n /**\n * Whether the access token is expired.\n */\n isExpired(withinMillisecondsOfExpiry?: number): boolean;\n /**\n * Converts an object with data into a Session.\n */\n toObject(): SessionParams;\n /**\n * Checks whether the given session is equal to this session.\n */\n equals(other: Session | undefined): boolean;\n /**\n * Converts the session into an array of key-value pairs.\n */\n toPropertyArray(returnUserData?: boolean): [string, string | number | boolean][];\n}" }, "OnlineAccessInfo": { "filePath": "../shopify-api/dist/ts/lib/auth/oauth/types.d.ts", @@ -7626,7 +7678,7 @@ "filePath": "../shopify-api/dist/ts/lib/types.d.ts", "syntaxKind": "EnumDeclaration", "name": "ApiVersion", - "value": "export declare enum ApiVersion {\n October22 = \"2022-10\",\n January23 = \"2023-01\",\n April23 = \"2023-04\",\n July23 = \"2023-07\",\n October23 = \"2023-10\",\n January24 = \"2024-01\",\n April24 = \"2024-04\",\n Unstable = \"unstable\"\n}", + "value": "export declare enum ApiVersion {\n October22 = \"2022-10\",\n January23 = \"2023-01\",\n April23 = \"2023-04\",\n July23 = \"2023-07\",\n October23 = \"2023-10\",\n January24 = \"2024-01\",\n April24 = \"2024-04\",\n July24 = \"2024-07\",\n Unstable = \"unstable\"\n}", "members": [ { "filePath": "../shopify-api/dist/ts/lib/types.d.ts", @@ -7663,6 +7715,11 @@ "name": "April24", "value": "2024-04" }, + { + "filePath": "../shopify-api/dist/ts/lib/types.d.ts", + "name": "July24", + "value": "2024-07" + }, { "filePath": "../shopify-api/dist/ts/lib/types.d.ts", "name": "Unstable", @@ -8956,7 +9013,7 @@ "syntaxKind": "PropertySignature", "name": "isTest", "value": "boolean", - "description": "Whether to consider test purchases.", + "description": "Whether to include charges that were created on test mode. Test shops and demo shops cannot be charged.", "isOptional": true }, { @@ -9114,7 +9171,7 @@ "syntaxKind": "PropertySignature", "name": "isTest", "value": "boolean", - "description": "Whether to consider test purchases.", + "description": "Whether to include charges that were created on test mode. Test shops and demo shops cannot be charged.", "isOptional": true }, { @@ -9223,7 +9280,14 @@ "syntaxKind": "MethodDeclaration", "name": "isScopeChanged", "value": "(scopes: string | string[] | AuthScopes) => boolean", - "description": "Whether the access token has the given scopes." + "description": "Whether the access token includes the given scopes if they are provided." + }, + { + "filePath": "../shopify-api/dist/ts/lib/session/session.d.ts", + "syntaxKind": "MethodDeclaration", + "name": "isScopeIncluded", + "value": "(scopes: string | string[] | AuthScopes) => boolean", + "description": "Whether the access token includes the given scopes." }, { "filePath": "../shopify-api/dist/ts/lib/session/session.d.ts", @@ -9254,7 +9318,7 @@ "description": "Converts the session into an array of key-value pairs." } ], - "value": "export declare class Session {\n static fromPropertyArray(entries: [string, string | number | boolean][], returnUserData?: boolean): Session;\n /**\n * The unique identifier for the session.\n */\n readonly id: string;\n /**\n * The Shopify shop domain, such as `example.myshopify.com`.\n */\n shop: string;\n /**\n * The state of the session. Used for the OAuth authentication code flow.\n */\n state: string;\n /**\n * Whether the access token in the session is online or offline.\n */\n isOnline: boolean;\n /**\n * The desired scopes for the access token, at the time the session was created.\n */\n scope?: string;\n /**\n * The date the access token expires.\n */\n expires?: Date;\n /**\n * The access token for the session.\n */\n accessToken?: string;\n /**\n * Information on the user for the session. Only present for online sessions.\n */\n onlineAccessInfo?: OnlineAccessInfo;\n constructor(params: SessionParams);\n /**\n * Whether the session is active. Active sessions have an access token that is not expired, and has has the given\n * scopes if scopes is equal to a truthy value.\n */\n isActive(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token has the given scopes.\n */\n isScopeChanged(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token is expired.\n */\n isExpired(withinMillisecondsOfExpiry?: number): boolean;\n /**\n * Converts an object with data into a Session.\n */\n toObject(): SessionParams;\n /**\n * Checks whether the given session is equal to this session.\n */\n equals(other: Session | undefined): boolean;\n /**\n * Converts the session into an array of key-value pairs.\n */\n toPropertyArray(returnUserData?: boolean): [string, string | number | boolean][];\n}" + "value": "export declare class Session {\n static fromPropertyArray(entries: [string, string | number | boolean][], returnUserData?: boolean): Session;\n /**\n * The unique identifier for the session.\n */\n readonly id: string;\n /**\n * The Shopify shop domain, such as `example.myshopify.com`.\n */\n shop: string;\n /**\n * The state of the session. Used for the OAuth authentication code flow.\n */\n state: string;\n /**\n * Whether the access token in the session is online or offline.\n */\n isOnline: boolean;\n /**\n * The desired scopes for the access token, at the time the session was created.\n */\n scope?: string;\n /**\n * The date the access token expires.\n */\n expires?: Date;\n /**\n * The access token for the session.\n */\n accessToken?: string;\n /**\n * Information on the user for the session. Only present for online sessions.\n */\n onlineAccessInfo?: OnlineAccessInfo;\n constructor(params: SessionParams);\n /**\n * Whether the session is active. Active sessions have an access token that is not expired, and has has the given\n * scopes if scopes is equal to a truthy value.\n */\n isActive(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token includes the given scopes if they are provided.\n */\n isScopeChanged(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token includes the given scopes.\n */\n isScopeIncluded(scopes: AuthScopes | string | string[]): boolean;\n /**\n * Whether the access token is expired.\n */\n isExpired(withinMillisecondsOfExpiry?: number): boolean;\n /**\n * Converts an object with data into a Session.\n */\n toObject(): SessionParams;\n /**\n * Checks whether the given session is equal to this session.\n */\n equals(other: Session | undefined): boolean;\n /**\n * Converts the session into an array of key-value pairs.\n */\n toPropertyArray(returnUserData?: boolean): [string, string | number | boolean][];\n}" }, "OnlineAccessInfo": { "filePath": "../shopify-api/dist/ts/lib/auth/oauth/types.d.ts", @@ -10508,7 +10572,7 @@ "filePath": "../shopify-api/dist/ts/lib/types.d.ts", "syntaxKind": "EnumDeclaration", "name": "ApiVersion", - "value": "export declare enum ApiVersion {\n October22 = \"2022-10\",\n January23 = \"2023-01\",\n April23 = \"2023-04\",\n July23 = \"2023-07\",\n October23 = \"2023-10\",\n January24 = \"2024-01\",\n April24 = \"2024-04\",\n Unstable = \"unstable\"\n}", + "value": "export declare enum ApiVersion {\n October22 = \"2022-10\",\n January23 = \"2023-01\",\n April23 = \"2023-04\",\n July23 = \"2023-07\",\n October23 = \"2023-10\",\n January24 = \"2024-01\",\n April24 = \"2024-04\",\n July24 = \"2024-07\",\n Unstable = \"unstable\"\n}", "members": [ { "filePath": "../shopify-api/dist/ts/lib/types.d.ts", @@ -10545,6 +10609,11 @@ "name": "April24", "value": "2024-04" }, + { + "filePath": "../shopify-api/dist/ts/lib/types.d.ts", + "name": "July24", + "value": "2024-07" + }, { "filePath": "../shopify-api/dist/ts/lib/types.d.ts", "name": "Unstable", @@ -11442,7 +11511,7 @@ }, "syntaxKind": "TypeAliasDeclaration", "name": "EnforceSessionStorage", - "value": "Config['distribution'] extends AppDistribution.ShopifyAdmin\n ? Base\n : Base & {sessionStorage: SessionStorageType}", + "value": "Base & {\n sessionStorage: SessionStorageType;\n}", "description": "" }, "SingleMerchantApp": { @@ -13006,7 +13075,14 @@ "syntaxKind": "MethodDeclaration", "name": "isScopeChanged", "value": "(scopes: string | string[] | AuthScopes) => boolean", - "description": "Whether the access token has the given scopes." + "description": "Whether the access token includes the given scopes if they are provided." + }, + { + "filePath": "../shopify-api/dist/ts/lib/session/session.d.ts", + "syntaxKind": "MethodDeclaration", + "name": "isScopeIncluded", + "value": "(scopes: string | string[] | AuthScopes) => boolean", + "description": "Whether the access token includes the given scopes." }, { "filePath": "../shopify-api/dist/ts/lib/session/session.d.ts", @@ -13037,7 +13113,7 @@ "description": "Converts the session into an array of key-value pairs." } ], - "value": "export declare class Session {\n static fromPropertyArray(entries: [string, string | number | boolean][], returnUserData?: boolean): Session;\n /**\n * The unique identifier for the session.\n */\n readonly id: string;\n /**\n * The Shopify shop domain, such as `example.myshopify.com`.\n */\n shop: string;\n /**\n * The state of the session. Used for the OAuth authentication code flow.\n */\n state: string;\n /**\n * Whether the access token in the session is online or offline.\n */\n isOnline: boolean;\n /**\n * The desired scopes for the access token, at the time the session was created.\n */\n scope?: string;\n /**\n * The date the access token expires.\n */\n expires?: Date;\n /**\n * The access token for the session.\n */\n accessToken?: string;\n /**\n * Information on the user for the session. Only present for online sessions.\n */\n onlineAccessInfo?: OnlineAccessInfo;\n constructor(params: SessionParams);\n /**\n * Whether the session is active. Active sessions have an access token that is not expired, and has has the given\n * scopes if scopes is equal to a truthy value.\n */\n isActive(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token has the given scopes.\n */\n isScopeChanged(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token is expired.\n */\n isExpired(withinMillisecondsOfExpiry?: number): boolean;\n /**\n * Converts an object with data into a Session.\n */\n toObject(): SessionParams;\n /**\n * Checks whether the given session is equal to this session.\n */\n equals(other: Session | undefined): boolean;\n /**\n * Converts the session into an array of key-value pairs.\n */\n toPropertyArray(returnUserData?: boolean): [string, string | number | boolean][];\n}" + "value": "export declare class Session {\n static fromPropertyArray(entries: [string, string | number | boolean][], returnUserData?: boolean): Session;\n /**\n * The unique identifier for the session.\n */\n readonly id: string;\n /**\n * The Shopify shop domain, such as `example.myshopify.com`.\n */\n shop: string;\n /**\n * The state of the session. Used for the OAuth authentication code flow.\n */\n state: string;\n /**\n * Whether the access token in the session is online or offline.\n */\n isOnline: boolean;\n /**\n * The desired scopes for the access token, at the time the session was created.\n */\n scope?: string;\n /**\n * The date the access token expires.\n */\n expires?: Date;\n /**\n * The access token for the session.\n */\n accessToken?: string;\n /**\n * Information on the user for the session. Only present for online sessions.\n */\n onlineAccessInfo?: OnlineAccessInfo;\n constructor(params: SessionParams);\n /**\n * Whether the session is active. Active sessions have an access token that is not expired, and has has the given\n * scopes if scopes is equal to a truthy value.\n */\n isActive(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token includes the given scopes if they are provided.\n */\n isScopeChanged(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token includes the given scopes.\n */\n isScopeIncluded(scopes: AuthScopes | string | string[]): boolean;\n /**\n * Whether the access token is expired.\n */\n isExpired(withinMillisecondsOfExpiry?: number): boolean;\n /**\n * Converts an object with data into a Session.\n */\n toObject(): SessionParams;\n /**\n * Checks whether the given session is equal to this session.\n */\n equals(other: Session | undefined): boolean;\n /**\n * Converts the session into an array of key-value pairs.\n */\n toPropertyArray(returnUserData?: boolean): [string, string | number | boolean][];\n}" }, "OnlineAccessInfo": { "filePath": "../shopify-api/dist/ts/lib/auth/oauth/types.d.ts", @@ -13520,7 +13596,14 @@ "syntaxKind": "MethodDeclaration", "name": "isScopeChanged", "value": "(scopes: string | string[] | AuthScopes) => boolean", - "description": "Whether the access token has the given scopes." + "description": "Whether the access token includes the given scopes if they are provided." + }, + { + "filePath": "../shopify-api/dist/ts/lib/session/session.d.ts", + "syntaxKind": "MethodDeclaration", + "name": "isScopeIncluded", + "value": "(scopes: string | string[] | AuthScopes) => boolean", + "description": "Whether the access token includes the given scopes." }, { "filePath": "../shopify-api/dist/ts/lib/session/session.d.ts", @@ -13551,7 +13634,7 @@ "description": "Converts the session into an array of key-value pairs." } ], - "value": "export declare class Session {\n static fromPropertyArray(entries: [string, string | number | boolean][], returnUserData?: boolean): Session;\n /**\n * The unique identifier for the session.\n */\n readonly id: string;\n /**\n * The Shopify shop domain, such as `example.myshopify.com`.\n */\n shop: string;\n /**\n * The state of the session. Used for the OAuth authentication code flow.\n */\n state: string;\n /**\n * Whether the access token in the session is online or offline.\n */\n isOnline: boolean;\n /**\n * The desired scopes for the access token, at the time the session was created.\n */\n scope?: string;\n /**\n * The date the access token expires.\n */\n expires?: Date;\n /**\n * The access token for the session.\n */\n accessToken?: string;\n /**\n * Information on the user for the session. Only present for online sessions.\n */\n onlineAccessInfo?: OnlineAccessInfo;\n constructor(params: SessionParams);\n /**\n * Whether the session is active. Active sessions have an access token that is not expired, and has has the given\n * scopes if scopes is equal to a truthy value.\n */\n isActive(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token has the given scopes.\n */\n isScopeChanged(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token is expired.\n */\n isExpired(withinMillisecondsOfExpiry?: number): boolean;\n /**\n * Converts an object with data into a Session.\n */\n toObject(): SessionParams;\n /**\n * Checks whether the given session is equal to this session.\n */\n equals(other: Session | undefined): boolean;\n /**\n * Converts the session into an array of key-value pairs.\n */\n toPropertyArray(returnUserData?: boolean): [string, string | number | boolean][];\n}" + "value": "export declare class Session {\n static fromPropertyArray(entries: [string, string | number | boolean][], returnUserData?: boolean): Session;\n /**\n * The unique identifier for the session.\n */\n readonly id: string;\n /**\n * The Shopify shop domain, such as `example.myshopify.com`.\n */\n shop: string;\n /**\n * The state of the session. Used for the OAuth authentication code flow.\n */\n state: string;\n /**\n * Whether the access token in the session is online or offline.\n */\n isOnline: boolean;\n /**\n * The desired scopes for the access token, at the time the session was created.\n */\n scope?: string;\n /**\n * The date the access token expires.\n */\n expires?: Date;\n /**\n * The access token for the session.\n */\n accessToken?: string;\n /**\n * Information on the user for the session. Only present for online sessions.\n */\n onlineAccessInfo?: OnlineAccessInfo;\n constructor(params: SessionParams);\n /**\n * Whether the session is active. Active sessions have an access token that is not expired, and has has the given\n * scopes if scopes is equal to a truthy value.\n */\n isActive(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token includes the given scopes if they are provided.\n */\n isScopeChanged(scopes: AuthScopes | string | string[] | undefined): boolean;\n /**\n * Whether the access token includes the given scopes.\n */\n isScopeIncluded(scopes: AuthScopes | string | string[]): boolean;\n /**\n * Whether the access token is expired.\n */\n isExpired(withinMillisecondsOfExpiry?: number): boolean;\n /**\n * Converts an object with data into a Session.\n */\n toObject(): SessionParams;\n /**\n * Checks whether the given session is equal to this session.\n */\n equals(other: Session | undefined): boolean;\n /**\n * Converts the session into an array of key-value pairs.\n */\n toPropertyArray(returnUserData?: boolean): [string, string | number | boolean][];\n}" }, "OnlineAccessInfo": { "filePath": "../shopify-api/dist/ts/lib/auth/oauth/types.d.ts", @@ -13910,7 +13993,7 @@ "filePath": "../shopify-api/dist/ts/lib/types.d.ts", "syntaxKind": "EnumDeclaration", "name": "ApiVersion", - "value": "export declare enum ApiVersion {\n October22 = \"2022-10\",\n January23 = \"2023-01\",\n April23 = \"2023-04\",\n July23 = \"2023-07\",\n October23 = \"2023-10\",\n January24 = \"2024-01\",\n April24 = \"2024-04\",\n Unstable = \"unstable\"\n}", + "value": "export declare enum ApiVersion {\n October22 = \"2022-10\",\n January23 = \"2023-01\",\n April23 = \"2023-04\",\n July23 = \"2023-07\",\n October23 = \"2023-10\",\n January24 = \"2024-01\",\n April24 = \"2024-04\",\n July24 = \"2024-07\",\n Unstable = \"unstable\"\n}", "members": [ { "filePath": "../shopify-api/dist/ts/lib/types.d.ts", @@ -13947,6 +14030,11 @@ "name": "April24", "value": "2024-04" }, + { + "filePath": "../shopify-api/dist/ts/lib/types.d.ts", + "name": "July24", + "value": "2024-07" + }, { "filePath": "../shopify-api/dist/ts/lib/types.d.ts", "name": "Unstable",