@vendure/common
Version:
1,547 lines (1,546 loc) • 121 kB
TypeScript
export type Maybe<T> = T;
export type InputMaybe<T> = T;
export type Exact<T extends {
[key: string]: unknown;
}> = {
[K in keyof T]: T[K];
};
export type MakeOptional<T, K extends keyof T> = Omit<T, K> & {
[SubKey in K]?: Maybe<T[SubKey]>;
};
export type MakeMaybe<T, K extends keyof T> = Omit<T, K> & {
[SubKey in K]: Maybe<T[SubKey]>;
};
export type MakeEmpty<T extends {
[key: string]: unknown;
}, K extends keyof T> = {
[_ in K]?: never;
};
export type Incremental<T> = T | {
[P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never;
};
/** All built-in and custom scalars, mapped to their actual values */
export type Scalars = {
ID: {
input: string | number;
output: string | number;
};
String: {
input: string;
output: string;
};
Boolean: {
input: boolean;
output: boolean;
};
Int: {
input: number;
output: number;
};
Float: {
input: number;
output: number;
};
DateTime: {
input: any;
output: any;
};
JSON: {
input: any;
output: any;
};
Money: {
input: number;
output: number;
};
Upload: {
input: any;
output: any;
};
};
export type ActiveOrderResult = NoActiveOrderError | Order;
export type AddPaymentToOrderResult = IneligiblePaymentMethodError | NoActiveOrderError | Order | OrderPaymentStateError | OrderStateTransitionError | PaymentDeclinedError | PaymentFailedError;
export type Address = Node & {
__typename?: 'Address';
city?: Maybe<Scalars['String']['output']>;
company?: Maybe<Scalars['String']['output']>;
country: Country;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
defaultBillingAddress?: Maybe<Scalars['Boolean']['output']>;
defaultShippingAddress?: Maybe<Scalars['Boolean']['output']>;
fullName?: Maybe<Scalars['String']['output']>;
id: Scalars['ID']['output'];
phoneNumber?: Maybe<Scalars['String']['output']>;
postalCode?: Maybe<Scalars['String']['output']>;
province?: Maybe<Scalars['String']['output']>;
streetLine1: Scalars['String']['output'];
streetLine2?: Maybe<Scalars['String']['output']>;
updatedAt: Scalars['DateTime']['output'];
};
export type Adjustment = {
__typename?: 'Adjustment';
adjustmentSource: Scalars['String']['output'];
amount: Scalars['Money']['output'];
data?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
type: AdjustmentType;
};
export declare enum AdjustmentType {
DISTRIBUTED_ORDER_PROMOTION = "DISTRIBUTED_ORDER_PROMOTION",
OTHER = "OTHER",
PROMOTION = "PROMOTION"
}
/** Returned when attempting to set the Customer for an Order when already logged in. */
export type AlreadyLoggedInError = ErrorResult & {
__typename?: 'AlreadyLoggedInError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type ApplyCouponCodeResult = CouponCodeExpiredError | CouponCodeInvalidError | CouponCodeLimitError | Order;
export type Asset = Node & {
__typename?: 'Asset';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
fileSize: Scalars['Int']['output'];
focalPoint?: Maybe<Coordinate>;
height: Scalars['Int']['output'];
id: Scalars['ID']['output'];
mimeType: Scalars['String']['output'];
name: Scalars['String']['output'];
preview: Scalars['String']['output'];
source: Scalars['String']['output'];
tags: Array<Tag>;
type: AssetType;
updatedAt: Scalars['DateTime']['output'];
width: Scalars['Int']['output'];
};
export type AssetList = PaginatedList & {
__typename?: 'AssetList';
items: Array<Asset>;
totalItems: Scalars['Int']['output'];
};
export declare enum AssetType {
BINARY = "BINARY",
IMAGE = "IMAGE",
VIDEO = "VIDEO"
}
export type AuthenticationInput = {
native?: InputMaybe<NativeAuthInput>;
};
export type AuthenticationMethod = Node & {
__typename?: 'AuthenticationMethod';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
strategy: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type AuthenticationResult = CurrentUser | InvalidCredentialsError | NotVerifiedError;
export type BooleanCustomFieldConfig = CustomField & {
__typename?: 'BooleanCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
requiresPermission?: Maybe<Array<Permission>>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
/** Operators for filtering on a list of Boolean fields */
export type BooleanListOperators = {
inList: Scalars['Boolean']['input'];
};
/** Operators for filtering on a Boolean field */
export type BooleanOperators = {
eq?: InputMaybe<Scalars['Boolean']['input']>;
isNull?: InputMaybe<Scalars['Boolean']['input']>;
};
export type BooleanStructFieldConfig = StructField & {
__typename?: 'BooleanStructFieldConfig';
description?: Maybe<Array<LocalizedString>>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type Channel = Node & {
__typename?: 'Channel';
availableCurrencyCodes: Array<CurrencyCode>;
availableLanguageCodes?: Maybe<Array<LanguageCode>>;
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
/** @deprecated Use defaultCurrencyCode instead */
currencyCode: CurrencyCode;
customFields?: Maybe<Scalars['JSON']['output']>;
defaultCurrencyCode: CurrencyCode;
defaultLanguageCode: LanguageCode;
defaultShippingZone?: Maybe<Zone>;
defaultTaxZone?: Maybe<Zone>;
id: Scalars['ID']['output'];
/** Not yet used - will be implemented in a future release. */
outOfStockThreshold?: Maybe<Scalars['Int']['output']>;
pricesIncludeTax: Scalars['Boolean']['output'];
seller?: Maybe<Seller>;
token: Scalars['String']['output'];
/** Not yet used - will be implemented in a future release. */
trackInventory?: Maybe<Scalars['Boolean']['output']>;
updatedAt: Scalars['DateTime']['output'];
};
export type Collection = Node & {
__typename?: 'Collection';
assets: Array<Asset>;
breadcrumbs: Array<CollectionBreadcrumb>;
children?: Maybe<Array<Collection>>;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
featuredAsset?: Maybe<Asset>;
filters: Array<ConfigurableOperation>;
id: Scalars['ID']['output'];
languageCode?: Maybe<LanguageCode>;
name: Scalars['String']['output'];
parent?: Maybe<Collection>;
parentId: Scalars['ID']['output'];
position: Scalars['Int']['output'];
productVariants: ProductVariantList;
slug: Scalars['String']['output'];
translations: Array<CollectionTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
export type CollectionProductVariantsArgs = {
options?: InputMaybe<ProductVariantListOptions>;
};
export type CollectionBreadcrumb = {
__typename?: 'CollectionBreadcrumb';
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
slug: Scalars['String']['output'];
};
export type CollectionFilterParameter = {
_and?: InputMaybe<Array<CollectionFilterParameter>>;
_or?: InputMaybe<Array<CollectionFilterParameter>>;
createdAt?: InputMaybe<DateOperators>;
description?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
parentId?: InputMaybe<IdOperators>;
position?: InputMaybe<NumberOperators>;
slug?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type CollectionList = PaginatedList & {
__typename?: 'CollectionList';
items: Array<Collection>;
totalItems: Scalars['Int']['output'];
};
export type CollectionListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<CollectionFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<CollectionSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
topLevelOnly?: InputMaybe<Scalars['Boolean']['input']>;
};
/**
* Which Collections are present in the products returned
* by the search, and in what quantity.
*/
export type CollectionResult = {
__typename?: 'CollectionResult';
collection: Collection;
count: Scalars['Int']['output'];
};
export type CollectionSortParameter = {
createdAt?: InputMaybe<SortOrder>;
description?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
parentId?: InputMaybe<SortOrder>;
position?: InputMaybe<SortOrder>;
slug?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type CollectionTranslation = {
__typename?: 'CollectionTranslation';
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
slug: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ConfigArg = {
__typename?: 'ConfigArg';
name: Scalars['String']['output'];
value: Scalars['String']['output'];
};
export type ConfigArgDefinition = {
__typename?: 'ConfigArgDefinition';
defaultValue?: Maybe<Scalars['JSON']['output']>;
description?: Maybe<Scalars['String']['output']>;
label?: Maybe<Scalars['String']['output']>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
required: Scalars['Boolean']['output'];
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type ConfigArgInput = {
name: Scalars['String']['input'];
/** A JSON stringified representation of the actual value */
value: Scalars['String']['input'];
};
export type ConfigurableOperation = {
__typename?: 'ConfigurableOperation';
args: Array<ConfigArg>;
code: Scalars['String']['output'];
};
export type ConfigurableOperationDefinition = {
__typename?: 'ConfigurableOperationDefinition';
args: Array<ConfigArgDefinition>;
code: Scalars['String']['output'];
description: Scalars['String']['output'];
};
export type ConfigurableOperationInput = {
arguments: Array<ConfigArgInput>;
code: Scalars['String']['input'];
};
export type Coordinate = {
__typename?: 'Coordinate';
x: Scalars['Float']['output'];
y: Scalars['Float']['output'];
};
/**
* A Country of the world which your shop operates in.
*
* The `code` field is typically a 2-character ISO code such as "GB", "US", "DE" etc. This code is used in certain inputs such as
* `UpdateAddressInput` and `CreateAddressInput` to specify the country.
*/
export type Country = Node & Region & {
__typename?: 'Country';
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
enabled: Scalars['Boolean']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
parent?: Maybe<Region>;
parentId?: Maybe<Scalars['ID']['output']>;
translations: Array<RegionTranslation>;
type: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type CountryList = PaginatedList & {
__typename?: 'CountryList';
items: Array<Country>;
totalItems: Scalars['Int']['output'];
};
/** Returned if the provided coupon code is invalid */
export type CouponCodeExpiredError = ErrorResult & {
__typename?: 'CouponCodeExpiredError';
couponCode: Scalars['String']['output'];
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned if the provided coupon code is invalid */
export type CouponCodeInvalidError = ErrorResult & {
__typename?: 'CouponCodeInvalidError';
couponCode: Scalars['String']['output'];
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned if the provided coupon code is invalid */
export type CouponCodeLimitError = ErrorResult & {
__typename?: 'CouponCodeLimitError';
couponCode: Scalars['String']['output'];
errorCode: ErrorCode;
limit: Scalars['Int']['output'];
message: Scalars['String']['output'];
};
/**
* Input used to create an Address.
*
* The countryCode must correspond to a `code` property of a Country that has been defined in the
* Vendure server. The `code` property is typically a 2-character ISO code such as "GB", "US", "DE" etc.
* If an invalid code is passed, the mutation will fail.
*/
export type CreateAddressInput = {
city?: InputMaybe<Scalars['String']['input']>;
company?: InputMaybe<Scalars['String']['input']>;
countryCode: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
defaultBillingAddress?: InputMaybe<Scalars['Boolean']['input']>;
defaultShippingAddress?: InputMaybe<Scalars['Boolean']['input']>;
fullName?: InputMaybe<Scalars['String']['input']>;
phoneNumber?: InputMaybe<Scalars['String']['input']>;
postalCode?: InputMaybe<Scalars['String']['input']>;
province?: InputMaybe<Scalars['String']['input']>;
streetLine1: Scalars['String']['input'];
streetLine2?: InputMaybe<Scalars['String']['input']>;
};
export type CreateCustomerInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
emailAddress: Scalars['String']['input'];
firstName: Scalars['String']['input'];
lastName: Scalars['String']['input'];
phoneNumber?: InputMaybe<Scalars['String']['input']>;
title?: InputMaybe<Scalars['String']['input']>;
};
/**
* @description
* ISO 4217 currency code
*
* @docsCategory common
*/
export declare enum CurrencyCode {
/** United Arab Emirates dirham */
AED = "AED",
/** Afghan afghani */
AFN = "AFN",
/** Albanian lek */
ALL = "ALL",
/** Armenian dram */
AMD = "AMD",
/** Netherlands Antillean guilder */
ANG = "ANG",
/** Angolan kwanza */
AOA = "AOA",
/** Argentine peso */
ARS = "ARS",
/** Australian dollar */
AUD = "AUD",
/** Aruban florin */
AWG = "AWG",
/** Azerbaijani manat */
AZN = "AZN",
/** Bosnia and Herzegovina convertible mark */
BAM = "BAM",
/** Barbados dollar */
BBD = "BBD",
/** Bangladeshi taka */
BDT = "BDT",
/** Bulgarian lev */
BGN = "BGN",
/** Bahraini dinar */
BHD = "BHD",
/** Burundian franc */
BIF = "BIF",
/** Bermudian dollar */
BMD = "BMD",
/** Brunei dollar */
BND = "BND",
/** Boliviano */
BOB = "BOB",
/** Brazilian real */
BRL = "BRL",
/** Bahamian dollar */
BSD = "BSD",
/** Bhutanese ngultrum */
BTN = "BTN",
/** Botswana pula */
BWP = "BWP",
/** Belarusian ruble */
BYN = "BYN",
/** Belize dollar */
BZD = "BZD",
/** Canadian dollar */
CAD = "CAD",
/** Congolese franc */
CDF = "CDF",
/** Swiss franc */
CHF = "CHF",
/** Chilean peso */
CLP = "CLP",
/** Renminbi (Chinese) yuan */
CNY = "CNY",
/** Colombian peso */
COP = "COP",
/** Costa Rican colon */
CRC = "CRC",
/** Cuban convertible peso */
CUC = "CUC",
/** Cuban peso */
CUP = "CUP",
/** Cape Verde escudo */
CVE = "CVE",
/** Czech koruna */
CZK = "CZK",
/** Djiboutian franc */
DJF = "DJF",
/** Danish krone */
DKK = "DKK",
/** Dominican peso */
DOP = "DOP",
/** Algerian dinar */
DZD = "DZD",
/** Egyptian pound */
EGP = "EGP",
/** Eritrean nakfa */
ERN = "ERN",
/** Ethiopian birr */
ETB = "ETB",
/** Euro */
EUR = "EUR",
/** Fiji dollar */
FJD = "FJD",
/** Falkland Islands pound */
FKP = "FKP",
/** Pound sterling */
GBP = "GBP",
/** Georgian lari */
GEL = "GEL",
/** Ghanaian cedi */
GHS = "GHS",
/** Gibraltar pound */
GIP = "GIP",
/** Gambian dalasi */
GMD = "GMD",
/** Guinean franc */
GNF = "GNF",
/** Guatemalan quetzal */
GTQ = "GTQ",
/** Guyanese dollar */
GYD = "GYD",
/** Hong Kong dollar */
HKD = "HKD",
/** Honduran lempira */
HNL = "HNL",
/** Croatian kuna */
HRK = "HRK",
/** Haitian gourde */
HTG = "HTG",
/** Hungarian forint */
HUF = "HUF",
/** Indonesian rupiah */
IDR = "IDR",
/** Israeli new shekel */
ILS = "ILS",
/** Indian rupee */
INR = "INR",
/** Iraqi dinar */
IQD = "IQD",
/** Iranian rial */
IRR = "IRR",
/** Icelandic króna */
ISK = "ISK",
/** Jamaican dollar */
JMD = "JMD",
/** Jordanian dinar */
JOD = "JOD",
/** Japanese yen */
JPY = "JPY",
/** Kenyan shilling */
KES = "KES",
/** Kyrgyzstani som */
KGS = "KGS",
/** Cambodian riel */
KHR = "KHR",
/** Comoro franc */
KMF = "KMF",
/** North Korean won */
KPW = "KPW",
/** South Korean won */
KRW = "KRW",
/** Kuwaiti dinar */
KWD = "KWD",
/** Cayman Islands dollar */
KYD = "KYD",
/** Kazakhstani tenge */
KZT = "KZT",
/** Lao kip */
LAK = "LAK",
/** Lebanese pound */
LBP = "LBP",
/** Sri Lankan rupee */
LKR = "LKR",
/** Liberian dollar */
LRD = "LRD",
/** Lesotho loti */
LSL = "LSL",
/** Libyan dinar */
LYD = "LYD",
/** Moroccan dirham */
MAD = "MAD",
/** Moldovan leu */
MDL = "MDL",
/** Malagasy ariary */
MGA = "MGA",
/** Macedonian denar */
MKD = "MKD",
/** Myanmar kyat */
MMK = "MMK",
/** Mongolian tögrög */
MNT = "MNT",
/** Macanese pataca */
MOP = "MOP",
/** Mauritanian ouguiya */
MRU = "MRU",
/** Mauritian rupee */
MUR = "MUR",
/** Maldivian rufiyaa */
MVR = "MVR",
/** Malawian kwacha */
MWK = "MWK",
/** Mexican peso */
MXN = "MXN",
/** Malaysian ringgit */
MYR = "MYR",
/** Mozambican metical */
MZN = "MZN",
/** Namibian dollar */
NAD = "NAD",
/** Nigerian naira */
NGN = "NGN",
/** Nicaraguan córdoba */
NIO = "NIO",
/** Norwegian krone */
NOK = "NOK",
/** Nepalese rupee */
NPR = "NPR",
/** New Zealand dollar */
NZD = "NZD",
/** Omani rial */
OMR = "OMR",
/** Panamanian balboa */
PAB = "PAB",
/** Peruvian sol */
PEN = "PEN",
/** Papua New Guinean kina */
PGK = "PGK",
/** Philippine peso */
PHP = "PHP",
/** Pakistani rupee */
PKR = "PKR",
/** Polish złoty */
PLN = "PLN",
/** Paraguayan guaraní */
PYG = "PYG",
/** Qatari riyal */
QAR = "QAR",
/** Romanian leu */
RON = "RON",
/** Serbian dinar */
RSD = "RSD",
/** Russian ruble */
RUB = "RUB",
/** Rwandan franc */
RWF = "RWF",
/** Saudi riyal */
SAR = "SAR",
/** Solomon Islands dollar */
SBD = "SBD",
/** Seychelles rupee */
SCR = "SCR",
/** Sudanese pound */
SDG = "SDG",
/** Swedish krona/kronor */
SEK = "SEK",
/** Singapore dollar */
SGD = "SGD",
/** Saint Helena pound */
SHP = "SHP",
/** Sierra Leonean leone */
SLL = "SLL",
/** Somali shilling */
SOS = "SOS",
/** Surinamese dollar */
SRD = "SRD",
/** South Sudanese pound */
SSP = "SSP",
/** São Tomé and Príncipe dobra */
STN = "STN",
/** Salvadoran colón */
SVC = "SVC",
/** Syrian pound */
SYP = "SYP",
/** Swazi lilangeni */
SZL = "SZL",
/** Thai baht */
THB = "THB",
/** Tajikistani somoni */
TJS = "TJS",
/** Turkmenistan manat */
TMT = "TMT",
/** Tunisian dinar */
TND = "TND",
/** Tongan paʻanga */
TOP = "TOP",
/** Turkish lira */
TRY = "TRY",
/** Trinidad and Tobago dollar */
TTD = "TTD",
/** New Taiwan dollar */
TWD = "TWD",
/** Tanzanian shilling */
TZS = "TZS",
/** Ukrainian hryvnia */
UAH = "UAH",
/** Ugandan shilling */
UGX = "UGX",
/** United States dollar */
USD = "USD",
/** Uruguayan peso */
UYU = "UYU",
/** Uzbekistan som */
UZS = "UZS",
/** Venezuelan bolívar soberano */
VES = "VES",
/** Vietnamese đồng */
VND = "VND",
/** Vanuatu vatu */
VUV = "VUV",
/** Samoan tala */
WST = "WST",
/** CFA franc BEAC */
XAF = "XAF",
/** East Caribbean dollar */
XCD = "XCD",
/** CFA franc BCEAO */
XOF = "XOF",
/** CFP franc (franc Pacifique) */
XPF = "XPF",
/** Yemeni rial */
YER = "YER",
/** South African rand */
ZAR = "ZAR",
/** Zambian kwacha */
ZMW = "ZMW",
/** Zimbabwean dollar */
ZWL = "ZWL"
}
export type CurrentUser = {
__typename?: 'CurrentUser';
channels: Array<CurrentUserChannel>;
id: Scalars['ID']['output'];
identifier: Scalars['String']['output'];
};
export type CurrentUserChannel = {
__typename?: 'CurrentUserChannel';
code: Scalars['String']['output'];
id: Scalars['ID']['output'];
permissions: Array<Permission>;
token: Scalars['String']['output'];
};
export type CustomField = {
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
requiresPermission?: Maybe<Array<Permission>>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type CustomFieldConfig = BooleanCustomFieldConfig | DateTimeCustomFieldConfig | FloatCustomFieldConfig | IntCustomFieldConfig | LocaleStringCustomFieldConfig | LocaleTextCustomFieldConfig | RelationCustomFieldConfig | StringCustomFieldConfig | StructCustomFieldConfig | TextCustomFieldConfig;
export type Customer = Node & {
__typename?: 'Customer';
addresses?: Maybe<Array<Address>>;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
emailAddress: Scalars['String']['output'];
firstName: Scalars['String']['output'];
id: Scalars['ID']['output'];
lastName: Scalars['String']['output'];
orders: OrderList;
phoneNumber?: Maybe<Scalars['String']['output']>;
title?: Maybe<Scalars['String']['output']>;
updatedAt: Scalars['DateTime']['output'];
user?: Maybe<User>;
};
export type CustomerOrdersArgs = {
options?: InputMaybe<OrderListOptions>;
};
export type CustomerFilterParameter = {
_and?: InputMaybe<Array<CustomerFilterParameter>>;
_or?: InputMaybe<Array<CustomerFilterParameter>>;
createdAt?: InputMaybe<DateOperators>;
emailAddress?: InputMaybe<StringOperators>;
firstName?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
lastName?: InputMaybe<StringOperators>;
phoneNumber?: InputMaybe<StringOperators>;
title?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type CustomerGroup = Node & {
__typename?: 'CustomerGroup';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
customers: CustomerList;
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type CustomerGroupCustomersArgs = {
options?: InputMaybe<CustomerListOptions>;
};
export type CustomerList = PaginatedList & {
__typename?: 'CustomerList';
items: Array<Customer>;
totalItems: Scalars['Int']['output'];
};
export type CustomerListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<CustomerFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<CustomerSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type CustomerSortParameter = {
createdAt?: InputMaybe<SortOrder>;
emailAddress?: InputMaybe<SortOrder>;
firstName?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
lastName?: InputMaybe<SortOrder>;
phoneNumber?: InputMaybe<SortOrder>;
title?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
/** Operators for filtering on a list of Date fields */
export type DateListOperators = {
inList: Scalars['DateTime']['input'];
};
/** Operators for filtering on a DateTime field */
export type DateOperators = {
after?: InputMaybe<Scalars['DateTime']['input']>;
before?: InputMaybe<Scalars['DateTime']['input']>;
between?: InputMaybe<DateRange>;
eq?: InputMaybe<Scalars['DateTime']['input']>;
isNull?: InputMaybe<Scalars['Boolean']['input']>;
};
export type DateRange = {
end: Scalars['DateTime']['input'];
start: Scalars['DateTime']['input'];
};
/**
* Expects the same validation formats as the `<input type="datetime-local">` HTML element.
* See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/datetime-local#Additional_attributes
*/
export type DateTimeCustomFieldConfig = CustomField & {
__typename?: 'DateTimeCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
max?: Maybe<Scalars['String']['output']>;
min?: Maybe<Scalars['String']['output']>;
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
requiresPermission?: Maybe<Array<Permission>>;
step?: Maybe<Scalars['Int']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
/**
* Expects the same validation formats as the `<input type="datetime-local">` HTML element.
* See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/datetime-local#Additional_attributes
*/
export type DateTimeStructFieldConfig = StructField & {
__typename?: 'DateTimeStructFieldConfig';
description?: Maybe<Array<LocalizedString>>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
max?: Maybe<Scalars['String']['output']>;
min?: Maybe<Scalars['String']['output']>;
name: Scalars['String']['output'];
step?: Maybe<Scalars['Int']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type DeletionResponse = {
__typename?: 'DeletionResponse';
message?: Maybe<Scalars['String']['output']>;
result: DeletionResult;
};
export declare enum DeletionResult {
/** The entity was successfully deleted */
DELETED = "DELETED",
/** Deletion did not take place, reason given in message */
NOT_DELETED = "NOT_DELETED"
}
export type Discount = {
__typename?: 'Discount';
adjustmentSource: Scalars['String']['output'];
amount: Scalars['Money']['output'];
amountWithTax: Scalars['Money']['output'];
description: Scalars['String']['output'];
type: AdjustmentType;
};
/** Returned when attempting to create a Customer with an email address already registered to an existing User. */
export type EmailAddressConflictError = ErrorResult & {
__typename?: 'EmailAddressConflictError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export declare enum ErrorCode {
ALREADY_LOGGED_IN_ERROR = "ALREADY_LOGGED_IN_ERROR",
COUPON_CODE_EXPIRED_ERROR = "COUPON_CODE_EXPIRED_ERROR",
COUPON_CODE_INVALID_ERROR = "COUPON_CODE_INVALID_ERROR",
COUPON_CODE_LIMIT_ERROR = "COUPON_CODE_LIMIT_ERROR",
EMAIL_ADDRESS_CONFLICT_ERROR = "EMAIL_ADDRESS_CONFLICT_ERROR",
GUEST_CHECKOUT_ERROR = "GUEST_CHECKOUT_ERROR",
IDENTIFIER_CHANGE_TOKEN_EXPIRED_ERROR = "IDENTIFIER_CHANGE_TOKEN_EXPIRED_ERROR",
IDENTIFIER_CHANGE_TOKEN_INVALID_ERROR = "IDENTIFIER_CHANGE_TOKEN_INVALID_ERROR",
INELIGIBLE_PAYMENT_METHOD_ERROR = "INELIGIBLE_PAYMENT_METHOD_ERROR",
INELIGIBLE_SHIPPING_METHOD_ERROR = "INELIGIBLE_SHIPPING_METHOD_ERROR",
INSUFFICIENT_STOCK_ERROR = "INSUFFICIENT_STOCK_ERROR",
INVALID_CREDENTIALS_ERROR = "INVALID_CREDENTIALS_ERROR",
MISSING_PASSWORD_ERROR = "MISSING_PASSWORD_ERROR",
NATIVE_AUTH_STRATEGY_ERROR = "NATIVE_AUTH_STRATEGY_ERROR",
NEGATIVE_QUANTITY_ERROR = "NEGATIVE_QUANTITY_ERROR",
NOT_VERIFIED_ERROR = "NOT_VERIFIED_ERROR",
NO_ACTIVE_ORDER_ERROR = "NO_ACTIVE_ORDER_ERROR",
ORDER_INTERCEPTOR_ERROR = "ORDER_INTERCEPTOR_ERROR",
ORDER_LIMIT_ERROR = "ORDER_LIMIT_ERROR",
ORDER_MODIFICATION_ERROR = "ORDER_MODIFICATION_ERROR",
ORDER_PAYMENT_STATE_ERROR = "ORDER_PAYMENT_STATE_ERROR",
ORDER_STATE_TRANSITION_ERROR = "ORDER_STATE_TRANSITION_ERROR",
PASSWORD_ALREADY_SET_ERROR = "PASSWORD_ALREADY_SET_ERROR",
PASSWORD_RESET_TOKEN_EXPIRED_ERROR = "PASSWORD_RESET_TOKEN_EXPIRED_ERROR",
PASSWORD_RESET_TOKEN_INVALID_ERROR = "PASSWORD_RESET_TOKEN_INVALID_ERROR",
PASSWORD_VALIDATION_ERROR = "PASSWORD_VALIDATION_ERROR",
PAYMENT_DECLINED_ERROR = "PAYMENT_DECLINED_ERROR",
PAYMENT_FAILED_ERROR = "PAYMENT_FAILED_ERROR",
UNKNOWN_ERROR = "UNKNOWN_ERROR",
VERIFICATION_TOKEN_EXPIRED_ERROR = "VERIFICATION_TOKEN_EXPIRED_ERROR",
VERIFICATION_TOKEN_INVALID_ERROR = "VERIFICATION_TOKEN_INVALID_ERROR"
}
export type ErrorResult = {
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type Facet = Node & {
__typename?: 'Facet';
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
translations: Array<FacetTranslation>;
updatedAt: Scalars['DateTime']['output'];
/** Returns a paginated, sortable, filterable list of the Facet's values. Added in v2.1.0. */
valueList: FacetValueList;
values: Array<FacetValue>;
};
export type FacetValueListArgs = {
options?: InputMaybe<FacetValueListOptions>;
};
export type FacetFilterParameter = {
_and?: InputMaybe<Array<FacetFilterParameter>>;
_or?: InputMaybe<Array<FacetFilterParameter>>;
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type FacetList = PaginatedList & {
__typename?: 'FacetList';
items: Array<Facet>;
totalItems: Scalars['Int']['output'];
};
export type FacetListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<FacetFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<FacetSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type FacetSortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type FacetTranslation = {
__typename?: 'FacetTranslation';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type FacetValue = Node & {
__typename?: 'FacetValue';
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
facet: Facet;
facetId: Scalars['ID']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
translations: Array<FacetValueTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
/**
* Used to construct boolean expressions for filtering search results
* by FacetValue ID. Examples:
*
* * ID=1 OR ID=2: `{ facetValueFilters: [{ or: [1,2] }] }`
* * ID=1 AND ID=2: `{ facetValueFilters: [{ and: 1 }, { and: 2 }] }`
* * ID=1 AND (ID=2 OR ID=3): `{ facetValueFilters: [{ and: 1 }, { or: [2,3] }] }`
*/
export type FacetValueFilterInput = {
and?: InputMaybe<Scalars['ID']['input']>;
or?: InputMaybe<Array<Scalars['ID']['input']>>;
};
export type FacetValueFilterParameter = {
_and?: InputMaybe<Array<FacetValueFilterParameter>>;
_or?: InputMaybe<Array<FacetValueFilterParameter>>;
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
facetId?: InputMaybe<IdOperators>;
id?: InputMaybe<IdOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type FacetValueList = PaginatedList & {
__typename?: 'FacetValueList';
items: Array<FacetValue>;
totalItems: Scalars['Int']['output'];
};
export type FacetValueListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<FacetValueFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<FacetValueSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
/**
* Which FacetValues are present in the products returned
* by the search, and in what quantity.
*/
export type FacetValueResult = {
__typename?: 'FacetValueResult';
count: Scalars['Int']['output'];
facetValue: FacetValue;
};
export type FacetValueSortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
facetId?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type FacetValueTranslation = {
__typename?: 'FacetValueTranslation';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type FloatCustomFieldConfig = CustomField & {
__typename?: 'FloatCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
max?: Maybe<Scalars['Float']['output']>;
min?: Maybe<Scalars['Float']['output']>;
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
requiresPermission?: Maybe<Array<Permission>>;
step?: Maybe<Scalars['Float']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type FloatStructFieldConfig = StructField & {
__typename?: 'FloatStructFieldConfig';
description?: Maybe<Array<LocalizedString>>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
max?: Maybe<Scalars['Float']['output']>;
min?: Maybe<Scalars['Float']['output']>;
name: Scalars['String']['output'];
step?: Maybe<Scalars['Float']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type Fulfillment = Node & {
__typename?: 'Fulfillment';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
lines: Array<FulfillmentLine>;
method: Scalars['String']['output'];
state: Scalars['String']['output'];
/** @deprecated Use the `lines` field instead */
summary: Array<FulfillmentLine>;
trackingCode?: Maybe<Scalars['String']['output']>;
updatedAt: Scalars['DateTime']['output'];
};
export type FulfillmentLine = {
__typename?: 'FulfillmentLine';
fulfillment: Fulfillment;
fulfillmentId: Scalars['ID']['output'];
orderLine: OrderLine;
orderLineId: Scalars['ID']['output'];
quantity: Scalars['Int']['output'];
};
export declare enum GlobalFlag {
FALSE = "FALSE",
INHERIT = "INHERIT",
TRUE = "TRUE"
}
/** Returned when attempting to set the Customer on a guest checkout when the configured GuestCheckoutStrategy does not allow it. */
export type GuestCheckoutError = ErrorResult & {
__typename?: 'GuestCheckoutError';
errorCode: ErrorCode;
errorDetail: Scalars['String']['output'];
message: Scalars['String']['output'];
};
export type HistoryEntry = Node & {
__typename?: 'HistoryEntry';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
data: Scalars['JSON']['output'];
id: Scalars['ID']['output'];
type: HistoryEntryType;
updatedAt: Scalars['DateTime']['output'];
};
export type HistoryEntryFilterParameter = {
_and?: InputMaybe<Array<HistoryEntryFilterParameter>>;
_or?: InputMaybe<Array<HistoryEntryFilterParameter>>;
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
type?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type HistoryEntryList = PaginatedList & {
__typename?: 'HistoryEntryList';
items: Array<HistoryEntry>;
totalItems: Scalars['Int']['output'];
};
export type HistoryEntryListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<HistoryEntryFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<HistoryEntrySortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type HistoryEntrySortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export declare enum HistoryEntryType {
CUSTOMER_ADDED_TO_GROUP = "CUSTOMER_ADDED_TO_GROUP",
CUSTOMER_ADDRESS_CREATED = "CUSTOMER_ADDRESS_CREATED",
CUSTOMER_ADDRESS_DELETED = "CUSTOMER_ADDRESS_DELETED",
CUSTOMER_ADDRESS_UPDATED = "CUSTOMER_ADDRESS_UPDATED",
CUSTOMER_DETAIL_UPDATED = "CUSTOMER_DETAIL_UPDATED",
CUSTOMER_EMAIL_UPDATE_REQUESTED = "CUSTOMER_EMAIL_UPDATE_REQUESTED",
CUSTOMER_EMAIL_UPDATE_VERIFIED = "CUSTOMER_EMAIL_UPDATE_VERIFIED",
CUSTOMER_NOTE = "CUSTOMER_NOTE",
CUSTOMER_PASSWORD_RESET_REQUESTED = "CUSTOMER_PASSWORD_RESET_REQUESTED",
CUSTOMER_PASSWORD_RESET_VERIFIED = "CUSTOMER_PASSWORD_RESET_VERIFIED",
CUSTOMER_PASSWORD_UPDATED = "CUSTOMER_PASSWORD_UPDATED",
CUSTOMER_REGISTERED = "CUSTOMER_REGISTERED",
CUSTOMER_REMOVED_FROM_GROUP = "CUSTOMER_REMOVED_FROM_GROUP",
CUSTOMER_VERIFIED = "CUSTOMER_VERIFIED",
ORDER_CANCELLATION = "ORDER_CANCELLATION",
ORDER_COUPON_APPLIED = "ORDER_COUPON_APPLIED",
ORDER_COUPON_REMOVED = "ORDER_COUPON_REMOVED",
ORDER_CUSTOMER_UPDATED = "ORDER_CUSTOMER_UPDATED",
ORDER_FULFILLMENT = "ORDER_FULFILLMENT",
ORDER_FULFILLMENT_TRANSITION = "ORDER_FULFILLMENT_TRANSITION",
ORDER_MODIFIED = "ORDER_MODIFIED",
ORDER_NOTE = "ORDER_NOTE",
ORDER_PAYMENT_TRANSITION = "ORDER_PAYMENT_TRANSITION",
ORDER_REFUND_TRANSITION = "ORDER_REFUND_TRANSITION",
ORDER_STATE_TRANSITION = "ORDER_STATE_TRANSITION"
}
/** Operators for filtering on a list of ID fields */
export type IdListOperators = {
inList: Scalars['ID']['input'];
};
/** Operators for filtering on an ID field */
export type IdOperators = {
eq?: InputMaybe<Scalars['String']['input']>;
in?: InputMaybe<Array<Scalars['String']['input']>>;
isNull?: InputMaybe<Scalars['Boolean']['input']>;
notEq?: InputMaybe<Scalars['String']['input']>;
notIn?: InputMaybe<Array<Scalars['String']['input']>>;
};
/**
* Returned if the token used to change a Customer's email address is valid, but has
* expired according to the `verificationTokenDuration` setting in the AuthOptions.
*/
export type IdentifierChangeTokenExpiredError = ErrorResult & {
__typename?: 'IdentifierChangeTokenExpiredError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/**
* Returned if the token used to change a Customer's email address is either
* invalid or does not match any expected tokens.
*/
export type IdentifierChangeTokenInvalidError = ErrorResult & {
__typename?: 'IdentifierChangeTokenInvalidError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned when attempting to add a Payment using a PaymentMethod for which the Order is not eligible. */
export type IneligiblePaymentMethodError = ErrorResult & {
__typename?: 'IneligiblePaymentMethodError';
eligibilityCheckerMessage?: Maybe<Scalars['String']['output']>;
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned when attempting to set a ShippingMethod for which the Order is not eligible */
export type IneligibleShippingMethodError = ErrorResult & {
__typename?: 'IneligibleShippingMethodError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned when attempting to add more items to the Order than are available */
export type InsufficientStockError = ErrorResult & {
__typename?: 'InsufficientStockError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
order: Order;
quantityAvailable: Scalars['Int']['output'];
};
export type IntCustomFieldConfig = CustomField & {
__typename?: 'IntCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
max?: Maybe<Scalars['Int']['output']>;
min?: Maybe<Scalars['Int']['output']>;
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
requiresPermission?: Maybe<Array<Permission>>;
step?: Maybe<Scalars['Int']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type IntStructFieldConfig = StructField & {
__typename?: 'IntStructFieldConfig';
description?: Maybe<Array<LocalizedString>>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
max?: Maybe<Scalars['Int']['output']>;
min?: Maybe<Scalars['Int']['output']>;
name: Scalars['String']['output'];
step?: Maybe<Scalars['Int']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
/** Returned if the user authentication credentials are not valid */
export type InvalidCredentialsError = ErrorResult & {
__typename?: 'InvalidCredentialsError';
authenticationError: Scalars['String']['output'];
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/**
* @description
* Languages in the form of a ISO 639-1 language code with optional
* region or script modifier (e.g. de_AT). The selection available is based
* on the [Unicode CLDR summary list](https://unicode-org.github.io/cldr-staging/charts/37/summary/root.html)
* and includes the major spoken languages of the world and any widely-used variants.
*
* @docsCategory common
*/
export declare enum LanguageCode {
/** Afrikaans */
af = "af",
/** Akan */
ak = "ak",
/** Amharic */
am = "am",
/** Arabic */
ar = "ar",
/** Assamese */
as = "as",
/** Azerbaijani */
az = "az",
/** Belarusian */
be = "be",
/** Bulgarian */
bg = "bg",
/** Bambara */
bm = "bm",
/** Bangla */
bn = "bn",
/** Tibetan */
bo = "bo",
/** Breton */
br = "br",
/** Bosnian */
bs = "bs",
/** Catalan */
ca = "ca",
/** Chechen */
ce = "ce",
/** Corsican */
co = "co",
/** Czech */
cs = "cs",
/** Church Slavic */
cu = "cu",
/** Welsh */
cy = "cy",
/** Danish */
da = "da",
/** German */
de = "de",
/** Austrian German */
de_AT = "de_AT",
/** Swiss High German */
de_CH = "de_CH",
/** Dzongkha */
dz = "dz",
/** Ewe */
ee = "ee",
/** Greek */
el = "el",
/** English */
en = "en",
/** Australian English */
en_AU = "en_AU",
/** Canadian English */
en_CA = "en_CA",
/** British English */
en_GB = "en_GB",
/** American English */
en_US = "en_US",
/** Esperanto */
eo = "eo",
/** Spanish */
es = "es",
/** European Spanish */
es_ES = "es_ES",
/** Mexican Spanish */
es_MX = "es_MX",
/** Estonian */
et = "et",
/** Basque */
eu = "eu",
/** Persian */
fa = "fa",
/** Dari */
fa_AF = "fa_AF",
/** Fulah */
ff = "ff",
/** Finnish */
fi = "fi",
/** Faroese */
fo = "fo",
/** French */
fr = "fr",
/** Canadian French */
fr_CA = "fr_CA",
/** Swiss French */
fr_CH = "fr_CH",
/** Western Frisian */
fy = "fy",
/** Irish */
ga = "ga",
/** Scottish Gaelic */
gd = "gd",
/** Galician */
gl = "gl",
/** Gujarati */
gu = "gu",
/** Manx */
gv = "gv",
/** Hausa */
ha = "ha",
/** Hebrew */
he = "he",
/** Hindi */
hi = "hi",
/** Croatian */
hr = "hr",
/** Haitian Creole */
ht = "ht",
/** Hungarian */
hu = "hu",
/** Armenian */
hy = "hy",
/** Interlingua */
ia = "ia",
/** Indonesian */
id = "id",
/** Igbo */
ig = "ig",
/** Sichuan Yi */
ii = "ii",
/** Icelandic */
is = "is",
/** Italian */
it = "it",
/** Japanese */
ja = "ja",
/** Javanese */
jv = "jv",
/** Georgian */
ka = "ka",
/** Kikuyu */
ki = "ki",
/** Kazakh */
kk = "kk",
/** Kalaallisut */
kl = "kl",
/** Khmer */
km = "km",
/** Kannada */
kn = "kn",
/** Korean */
ko = "ko",
/** Kashmiri */
ks = "ks",
/** Kurdish */
ku = "ku",
/** Cornish */
kw = "kw",
/** Kyrgyz */
ky = "ky",
/** Latin */
la = "la",
/** Luxembourgish */
lb = "lb",
/** Ganda */
lg = "lg",
/** Lingala */
ln = "ln",
/** Lao */
lo = "lo",
/** Lithuanian */
lt = "lt",
/** Luba-Katanga */
lu = "lu",
/** Latvian */
lv = "lv",
/** Malagasy */
mg = "mg",
/** Maori */
mi = "mi",
/** Macedonian */
mk = "mk",
/** Malayalam */
ml = "ml",
/** Mongolian */
mn = "mn",
/** Marathi */
mr = "mr",
/** Malay */
ms = "ms",
/** Maltese */
mt = "mt",
/** Burmese */
my = "my",
/** Norwegian Bokmål */
nb = "nb",
/** North Ndebele */
nd = "nd",
/** Nepali */
ne = "ne",
/** Dutch */
nl = "nl",
/** Flemish */
nl_BE = "nl_BE",
/** Norwegian Nynorsk */
nn = "nn",
/** Nyanja */
ny = "ny",
/** Oromo */
om = "om",
/** Odia */
or = "or",
/** Ossetic */
os = "os",
/** Punjabi */
pa = "pa",
/** Polish */
pl = "pl",
/** Pashto */
ps = "ps",
/** Portuguese */
pt = "pt",
/** Brazilian Portuguese */
pt_BR = "pt_BR",
/** European Portuguese */
pt_PT = "pt_PT",
/** Quechua */
qu = "qu",
/** Romansh */
rm = "rm",
/** Rundi */
rn = "rn",
/** Romanian */
ro = "ro",
/** Moldavian */
ro_MD = "ro_MD",
/** Russian */
ru = "ru",
/** Kinyarwanda */
rw = "rw",
/** Sanskrit */
sa = "sa",
/** Sindhi */
sd = "sd",
/** Northern Sami */
se = "se",
/** Sango */
sg = "sg",
/** Sinhala */
si = "si",
/** Slovak */
sk = "sk",
/** Slovenian */
sl = "sl",
/** Samoan */
sm = "sm",
/** Shona */
sn = "sn",
/** Somali */
so = "so",
/** Albanian */