Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/old/vendor/magento/module-customer-graph-ql/etc/ |
# Copyright © Magento, Inc. All rights reserved.
# See COPYING.txt for license details.
type StoreConfig {
required_character_classes_number : String @doc(description: "The number of different character classes (lowercase, uppercase, digits, special characters) required in a password.")
minimum_password_length : String @doc(description: "The minimum number of characters required for a valid password.")
autocomplete_on_storefront : Boolean @doc(description: "Indicates whether to enable autocomplete on login and forgot password forms.")
}
type Query {
customer: Customer @resolver(class: "Magento\\CustomerGraphQl\\Model\\Resolver\\Customer") @doc(description: "Return detailed information about a customer account.") @cache(cacheable: false)
isEmailAvailable (
email: String! @doc(description: "The email address to check.")
): IsEmailAvailableOutput @resolver(class: "Magento\\CustomerGraphQl\\Model\\Resolver\\IsEmailAvailable") @doc(description: "Check whether the specified email has already been used to create a customer account.")
}
type Mutation {
generateCustomerToken(email: String! @doc(description: "The customer's email address."), password: String! @doc(description: "The customer's password.")): CustomerToken @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\GenerateCustomerToken") @doc(description:"Generate a token for specified customer.")
changeCustomerPassword(currentPassword: String! @doc(description: "The customer's original password."), newPassword: String! @doc(description: "The customer's updated password.")): Customer @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\ChangePassword") @doc(description:"Change the password for the logged-in customer.")
createCustomer (input: CustomerInput! @doc(description: "An input object that defines the customer to be created.")): CustomerOutput @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\CreateCustomer") @doc(description:"Use `createCustomerV2` instead.")
createCustomerV2 (input: CustomerCreateInput! @doc(description: "An input object that defines the customer to be created.")): CustomerOutput @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\CreateCustomer") @doc(description:"Create a customer account.")
updateCustomer (input: CustomerInput! @doc(description: "An input object that defines the customer characteristics to update.")): CustomerOutput @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\UpdateCustomer") @doc(description:"Use `updateCustomerV2` instead.")
updateCustomerV2 (input: CustomerUpdateInput! @doc(description: "An input object that defines the customer characteristics to update.")): CustomerOutput @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\UpdateCustomer") @doc(description:"Update the customer's personal information.")
deleteCustomer: Boolean @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\DeleteCustomer") @doc(description:"Delete customer account")
revokeCustomerToken: RevokeCustomerTokenOutput @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\RevokeCustomerToken") @doc(description:"Revoke the customer token.")
createCustomerAddress(input: CustomerAddressInput!): CustomerAddress @resolver(class: "Magento\\CustomerGraphQl\\Model\\Resolver\\CreateCustomerAddress") @doc(description: "Create a billing or shipping address for a customer or guest.")
updateCustomerAddress(id: Int! @doc(description: "The ID assigned to the customer address."), input: CustomerAddressInput @doc(description: "An input object that contains changes to the customer address.")): CustomerAddress @resolver(class: "Magento\\CustomerGraphQl\\Model\\Resolver\\UpdateCustomerAddress") @doc(description: "Update the billing or shipping address of a customer or guest.")
deleteCustomerAddress(id: Int! @doc(description: "The ID of the customer address to be deleted.")): Boolean @resolver(class: "Magento\\CustomerGraphQl\\Model\\Resolver\\DeleteCustomerAddress") @doc(description: "Delete the billing or shipping address of a customer.")
requestPasswordResetEmail(email: String! @doc(description: "The customer's email address.")): Boolean @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\RequestPasswordResetEmail") @doc(description: "Request an email with a reset password token for the registered customer identified by the specified email.")
resetPassword(email: String! @doc(description: "The customer's email address."), resetPasswordToken: String! @doc(description: "A runtime token generated by the `requestPasswordResetEmail` mutation."), newPassword: String! @doc(description: "The customer's new password.")): Boolean @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\ResetPassword") @doc(description: "Reset a customer's password using the reset password token that the customer received in an email after requesting it using `requestPasswordResetEmail`.")
updateCustomerEmail(email: String! @doc(description: "The customer's email address."), password: String! @doc(description: "The customer's password.")): CustomerOutput @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\UpdateCustomerEmail") @doc(description: "Change the email address for the logged-in customer.")
}
input CustomerAddressInput @doc(description: "Contains details about a billing or shipping address."){
firstname: String @doc(description: "The first name of the person associated with the billing/shipping address.")
lastname: String @doc(description: "The family name of the person associated with the billing/shipping address.")
company: String @doc(description: "The customer's company.")
telephone: String @doc(description: "The customer's telephone number.")
street: [String] @doc(description: "An array of strings that define the street number and name.")
city: String @doc(description: "The customer's city or town.")
region: CustomerAddressRegionInput @doc(description: "An object containing the region name, region code, and region ID.")
postcode: String @doc(description: "The customer's ZIP or postal code.")
country_id: CountryCodeEnum @doc(description: "Deprecated: use `country_code` instead.")
country_code: CountryCodeEnum @doc(description: "The two-letter code representing the customer's country.")
default_shipping: Boolean @doc(description: "Indicates whether the address is the default shipping address.")
default_billing: Boolean @doc(description: "Indicates whether the address is the default billing address.")
fax: String @doc(description: "The customer's fax number.")
middlename: String @doc(description: "The middle name of the person associated with the billing/shipping address.")
prefix: String @doc(description: "An honorific, such as Dr., Mr., or Mrs.")
suffix: String @doc(description: "A value such as Sr., Jr., or III.")
vat_id: String @doc(description: "The customer's Tax/VAT number (for corporate customers).")
custom_attributes: [CustomerAddressAttributeInput] @doc(description: "Deprecated: Custom attributes should not be put into container.")
}
input CustomerAddressRegionInput @doc(description: "Defines the customer's state or province.") {
region_code: String @doc(description: "The address region code.")
region: String @doc(description: "The state or province name.")
region_id: Int @doc(description: "The unique ID for a pre-defined region.")
}
input CustomerAddressAttributeInput @doc(description: "Specifies the attribute code and value of a customer attribute.") {
attribute_code: String! @doc(description: "The name assigned to the attribute.")
value: String! @doc(description: "The value assigned to the attribute.")
}
type CustomerToken @doc(description: "Contains a customer authorization token.") {
token: String @doc(description: "The customer authorization token.")
}
input CustomerInput @doc(description: "An input object that assigns or updates customer attributes.") {
prefix: String @doc(description: "An honorific, such as Dr., Mr., or Mrs.")
firstname: String @doc(description: "The customer's first name.")
middlename: String @doc(description: "The customer's middle name.")
lastname: String @doc(description: "The customer's family name.")
suffix: String @doc(description: "A value such as Sr., Jr., or III.")
email: String @doc(description: "The customer's email address. Required when creating a customer.")
dob: String @doc(description: "Deprecated: Use `date_of_birth` instead.")
date_of_birth: String @doc(description: "The customer's date of birth.")
taxvat: String @doc(description: "The customer's Tax/VAT number (for corporate customers).")
gender: Int @doc(description: "The customer's gender (Male - 1, Female - 2).")
password: String @doc(description: "The customer's password.")
is_subscribed: Boolean @doc(description: "Indicates whether the customer is subscribed to the company's newsletter.")
}
input CustomerCreateInput @doc(description: "An input object for creating a customer.") {
prefix: String @doc(description: "An honorific, such as Dr., Mr., or Mrs.")
firstname: String! @doc(description: "The customer's first name.")
middlename: String @doc(description: "The customer's middle name.")
lastname: String! @doc(description: "The customer's family name.")
suffix: String @doc(description: "A value such as Sr., Jr., or III.")
email: String! @doc(description: "The customer's email address.")
dob: String @doc(description: "Deprecated: Use `date_of_birth` instead.")
date_of_birth: String @doc(description: "The customer's date of birth.")
taxvat: String @doc(description: "The customer's Tax/VAT number (for corporate customers).")
gender: Int @doc(description: "The customer's gender (Male - 1, Female - 2).")
password: String @doc(description: "The customer's password.")
is_subscribed: Boolean @doc(description: "Indicates whether the customer is subscribed to the company's newsletter.")
}
input CustomerUpdateInput @doc(description: "An input object for updating a customer.") {
date_of_birth: String @doc(description: "The customer's date of birth.")
dob: String @doc(description: "Deprecated: Use `date_of_birth` instead.")
firstname: String @doc(description: "The customer's first name.")
gender: Int @doc(description: "The customer's gender (Male - 1, Female - 2).")
is_subscribed: Boolean @doc(description: "Indicates whether the customer is subscribed to the company's newsletter.")
lastname: String @doc(description: "The customer's family name.")
middlename: String @doc(description: "The customer's middle name.")
prefix: String @doc(description: "An honorific, such as Dr., Mr., or Mrs.")
suffix: String @doc(description: "A value such as Sr., Jr., or III.")
taxvat: String @doc(description: "The customer's Tax/VAT number (for corporate customers).")
}
type CustomerOutput @doc(description: "Contains details about a newly-created or updated customer.") {
customer: Customer! @doc(description: "Customer details after creating or updating a customer.")
}
type RevokeCustomerTokenOutput @doc(description: "Contains the result of a request to revoke a customer token.") {
result: Boolean! @doc(description: "The result of a request to revoke a customer token.")
}
type Customer @doc(description: "Defines the customer name, addresses, and other details.") {
created_at: String @doc(description: "Timestamp indicating when the account was created.")
group_id: Int @deprecated(reason: "Customer group should not be exposed in the storefront scenarios.")
prefix: String @doc(description: "An honorific, such as Dr., Mr., or Mrs.")
firstname: String @doc(description: "The customer's first name.")
middlename: String @doc(description: "The customer's middle name.")
lastname: String @doc(description: "The customer's family name.")
suffix: String @doc(description: "A value such as Sr., Jr., or III.")
email: String @doc(description: "The customer's email address. Required.")
default_billing: String @doc(description: "The ID assigned to the billing address.")
default_shipping: String @doc(description: "The ID assigned to the shipping address.")
dob: String @doc(description: "The customer's date of birth.") @deprecated(reason: "Use `date_of_birth` instead.")
date_of_birth: String @doc(description: "The customer's date of birth.")
taxvat: String @doc(description: "The customer's Value-added tax (VAT) number (for corporate customers).")
id: Int @doc(description: "The ID assigned to the customer.") @deprecated(reason: "`id` is not needed as part of `Customer`, because on the server side, it can be identified based on the customer token used for authentication. There is no need to know customer ID on the client side.")
is_subscribed: Boolean @doc(description: "Indicates whether the customer is subscribed to the company's newsletter.") @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\IsSubscribed")
addresses: [CustomerAddress] @doc(description: "An array containing the customer's shipping and billing addresses.") @resolver(class: "\\Magento\\CustomerGraphQl\\Model\\Resolver\\CustomerAddresses")
gender: Int @doc(description: "The customer's gender (Male - 1, Female - 2).")
}
type CustomerAddress @doc(description: "Contains detailed information about a customer's billing or shipping address."){
id: Int @doc(description: "The ID of a `CustomerAddress` object.")
customer_id: Int @doc(description: "The customer ID") @deprecated(reason: "`customer_id` is not needed as part of `CustomerAddress`. The `id` is a unique identifier for the addresses.")
region: CustomerAddressRegion @doc(description: "An object containing the region name, region code, and region ID.")
region_id: Int @doc(description: "The unique ID for a pre-defined region.")
country_id: String @doc(description: "The customer's country.") @deprecated(reason: "Use `country_code` instead.")
country_code: CountryCodeEnum @doc(description: "The customer's country.")
street: [String] @doc(description: "An array of strings that define the street number and name.")
company: String @doc(description: "The customer's company.")
telephone: String @doc(description: "The customer's telephone number.")
fax: String @doc(description: "The customer's fax number.")
postcode: String @doc(description: "The customer's ZIP or postal code.")
city: String @doc(description: "The customer's city or town.")
firstname: String @doc(description: "The first name of the person associated with the shipping/billing address.")
lastname: String @doc(description: "The family name of the person associated with the shipping/billing address.")
middlename: String @doc(description: "The middle name of the person associated with the shipping/billing address.")
prefix: String @doc(description: "An honorific, such as Dr., Mr., or Mrs.")
suffix: String @doc(description: "A value such as Sr., Jr., or III.")
vat_id: String @doc(description: "The customer's Value-added tax (VAT) number (for corporate customers).")
default_shipping: Boolean @doc(description: "Indicates whether the address is the customer's default shipping address.")
default_billing: Boolean @doc(description: "Indicates whether the address is the customer's default billing address.")
custom_attributes: [CustomerAddressAttribute] @deprecated(reason: "Custom attributes should not be put into a container.")
extension_attributes: [CustomerAddressAttribute] @doc(description: "Contains any extension attributes for the address.")
}
type CustomerAddressRegion @doc(description: "Defines the customer's state or province.") {
region_code: String @doc(description: "The address region code.")
region: String @doc(description: "The state or province name.")
region_id: Int @doc(description: "The unique ID for a pre-defined region.")
}
type CustomerAddressAttribute @doc(description: "Specifies the attribute code and value of a customer address attribute.") {
attribute_code: String @doc(description: "The name assigned to the customer address attribute.")
value: String @doc(description: "The valuue assigned to the customer address attribute.")
}
type IsEmailAvailableOutput @doc(description: "Contains the result of the `isEmailAvailable` query.") {
is_email_available: Boolean @doc(description: "Indicates whether the specified email address can be used to create a customer.")
}
enum CountryCodeEnum @doc(description: "The list of country codes.") {
AF @doc(description: "Afghanistan")
AX @doc(description: "Åland Islands")
AL @doc(description: "Albania")
DZ @doc(description: "Algeria")
AS @doc(description: "American Samoa")
AD @doc(description: "Andorra")
AO @doc(description: "Angola")
AI @doc(description: "Anguilla")
AQ @doc(description: "Antarctica")
AG @doc(description: "Antigua & Barbuda")
AR @doc(description: "Argentina")
AM @doc(description: "Armenia")
AW @doc(description: "Aruba")
AU @doc(description: "Australia")
AT @doc(description: "Austria")
AZ @doc(description: "Azerbaijan")
BS @doc(description: "Bahamas")
BH @doc(description: "Bahrain")
BD @doc(description: "Bangladesh")
BB @doc(description: "Barbados")
BY @doc(description: "Belarus")
BE @doc(description: "Belgium")
BZ @doc(description: "Belize")
BJ @doc(description: "Benin")
BM @doc(description: "Bermuda")
BT @doc(description: "Bhutan")
BO @doc(description: "Bolivia")
BA @doc(description: "Bosnia & Herzegovina")
BW @doc(description: "Botswana")
BV @doc(description: "Bouvet Island")
BR @doc(description: "Brazil")
IO @doc(description: "British Indian Ocean Territory")
VG @doc(description: "British Virgin Islands")
BN @doc(description: "Brunei")
BG @doc(description: "Bulgaria")
BF @doc(description: "Burkina Faso")
BI @doc(description: "Burundi")
KH @doc(description: "Cambodia")
CM @doc(description: "Cameroon")
CA @doc(description: "Canada")
CV @doc(description: "Cape Verde")
KY @doc(description: "Cayman Islands")
CF @doc(description: "Central African Republic")
TD @doc(description: "Chad")
CL @doc(description: "Chile")
CN @doc(description: "China")
CX @doc(description: "Christmas Island")
CC @doc(description: "Cocos (Keeling) Islands")
CO @doc(description: "Colombia")
KM @doc(description: "Comoros")
CG @doc(description: "Congo-Brazzaville")
CD @doc(description: "Congo-Kinshasa")
CK @doc(description: "Cook Islands")
CR @doc(description: "Costa Rica")
CI @doc(description: "Côte d’Ivoire")
HR @doc(description: "Croatia")
CU @doc(description: "Cuba")
CY @doc(description: "Cyprus")
CZ @doc(description: "Czech Republic")
DK @doc(description: "Denmark")
DJ @doc(description: "Djibouti")
DM @doc(description: "Dominica")
DO @doc(description: "Dominican Republic")
EC @doc(description: "Ecuador")
EG @doc(description: "Egypt")
SV @doc(description: "El Salvador")
GQ @doc(description: "Equatorial Guinea")
ER @doc(description: "Eritrea")
EE @doc(description: "Estonia")
ET @doc(description: "Ethiopia")
FK @doc(description: "Falkland Islands")
FO @doc(description: "Faroe Islands")
FJ @doc(description: "Fiji")
FI @doc(description: "Finland")
FR @doc(description: "France")
GF @doc(description: "French Guiana")
PF @doc(description: "French Polynesia")
TF @doc(description: "French Southern Territories")
GA @doc(description: "Gabon")
GM @doc(description: "Gambia")
GE @doc(description: "Georgia")
DE @doc(description: "Germany")
GH @doc(description: "Ghana")
GI @doc(description: "Gibraltar")
GR @doc(description: "Greece")
GL @doc(description: "Greenland")
GD @doc(description: "Grenada")
GP @doc(description: "Guadeloupe")
GU @doc(description: "Guam")
GT @doc(description: "Guatemala")
GG @doc(description: "Guernsey")
GN @doc(description: "Guinea")
GW @doc(description: "Guinea-Bissau")
GY @doc(description: "Guyana")
HT @doc(description: "Haiti")
HM @doc(description: "Heard & McDonald Islands")
HN @doc(description: "Honduras")
HK @doc(description: "Hong Kong SAR China")
HU @doc(description: "Hungary")
IS @doc(description: "Iceland")
IN @doc(description: "India")
ID @doc(description: "Indonesia")
IR @doc(description: "Iran")
IQ @doc(description: "Iraq")
IE @doc(description: "Ireland")
IM @doc(description: "Isle of Man")
IL @doc(description: "Israel")
IT @doc(description: "Italy")
JM @doc(description: "Jamaica")
JP @doc(description: "Japan")
JE @doc(description: "Jersey")
JO @doc(description: "Jordan")
KZ @doc(description: "Kazakhstan")
KE @doc(description: "Kenya")
KI @doc(description: "Kiribati")
KW @doc(description: "Kuwait")
KG @doc(description: "Kyrgyzstan")
LA @doc(description: "Laos")
LV @doc(description: "Latvia")
LB @doc(description: "Lebanon")
LS @doc(description: "Lesotho")
LR @doc(description: "Liberia")
LY @doc(description: "Libya")
LI @doc(description: "Liechtenstein")
LT @doc(description: "Lithuania")
LU @doc(description: "Luxembourg")
MO @doc(description: "Macau SAR China")
MK @doc(description: "Macedonia")
MG @doc(description: "Madagascar")
MW @doc(description: "Malawi")
MY @doc(description: "Malaysia")
MV @doc(description: "Maldives")
ML @doc(description: "Mali")
MT @doc(description: "Malta")
MH @doc(description: "Marshall Islands")
MQ @doc(description: "Martinique")
MR @doc(description: "Mauritania")
MU @doc(description: "Mauritius")
YT @doc(description: "Mayotte")
MX @doc(description: "Mexico")
FM @doc(description: "Micronesia")
MD @doc(description: "Moldova")
MC @doc(description: "Monaco")
MN @doc(description: "Mongolia")
ME @doc(description: "Montenegro")
MS @doc(description: "Montserrat")
MA @doc(description: "Morocco")
MZ @doc(description: "Mozambique")
MM @doc(description: "Myanmar (Burma)")
NA @doc(description: "Namibia")
NR @doc(description: "Nauru")
NP @doc(description: "Nepal")
NL @doc(description: "Netherlands")
AN @doc(description: "Netherlands Antilles")
NC @doc(description: "New Caledonia")
NZ @doc(description: "New Zealand")
NI @doc(description: "Nicaragua")
NE @doc(description: "Niger")
NG @doc(description: "Nigeria")
NU @doc(description: "Niue")
NF @doc(description: "Norfolk Island")
MP @doc(description: "Northern Mariana Islands")
KP @doc(description: "North Korea")
NO @doc(description: "Norway")
OM @doc(description: "Oman")
PK @doc(description: "Pakistan")
PW @doc(description: "Palau")
PS @doc(description: "Palestinian Territories")
PA @doc(description: "Panama")
PG @doc(description: "Papua New Guinea")
PY @doc(description: "Paraguay")
PE @doc(description: "Peru")
PH @doc(description: "Philippines")
PN @doc(description: "Pitcairn Islands")
PL @doc(description: "Poland")
PT @doc(description: "Portugal")
QA @doc(description: "Qatar")
RE @doc(description: "Réunion")
RO @doc(description: "Romania")
RU @doc(description: "Russia")
RW @doc(description: "Rwanda")
WS @doc(description: "Samoa")
SM @doc(description: "San Marino")
ST @doc(description: "São Tomé & Príncipe")
SA @doc(description: "Saudi Arabia")
SN @doc(description: "Senegal")
RS @doc(description: "Serbia")
SC @doc(description: "Seychelles")
SL @doc(description: "Sierra Leone")
SG @doc(description: "Singapore")
SK @doc(description: "Slovakia")
SI @doc(description: "Slovenia")
SB @doc(description: "Solomon Islands")
SO @doc(description: "Somalia")
ZA @doc(description: "South Africa")
GS @doc(description: "South Georgia & South Sandwich Islands")
KR @doc(description: "South Korea")
ES @doc(description: "Spain")
LK @doc(description: "Sri Lanka")
BL @doc(description: "St. Barthélemy")
SH @doc(description: "St. Helena")
KN @doc(description: "St. Kitts & Nevis")
LC @doc(description: "St. Lucia")
MF @doc(description: "St. Martin")
PM @doc(description: "St. Pierre & Miquelon")
VC @doc(description: "St. Vincent & Grenadines")
SD @doc(description: "Sudan")
SR @doc(description: "Suriname")
SJ @doc(description: "Svalbard & Jan Mayen")
SZ @doc(description: "Swaziland")
SE @doc(description: "Sweden")
CH @doc(description: "Switzerland")
SY @doc(description: "Syria")
TW @doc(description: "Taiwan")
TJ @doc(description: "Tajikistan")
TZ @doc(description: "Tanzania")
TH @doc(description: "Thailand")
TL @doc(description: "Timor-Leste")
TG @doc(description: "Togo")
TK @doc(description: "Tokelau")
TO @doc(description: "Tonga")
TT @doc(description: "Trinidad & Tobago")
TN @doc(description: "Tunisia")
TR @doc(description: "Turkey")
TM @doc(description: "Turkmenistan")
TC @doc(description: "Turks & Caicos Islands")
TV @doc(description: "Tuvalu")
UG @doc(description: "Uganda")
UA @doc(description: "Ukraine")
AE @doc(description: "United Arab Emirates")
GB @doc(description: "United Kingdom")
US @doc(description: "United States")
UY @doc(description: "Uruguay")
UM @doc(description: "U.S. Outlying Islands")
VI @doc(description: "U.S. Virgin Islands")
UZ @doc(description: "Uzbekistan")
VU @doc(description: "Vanuatu")
VA @doc(description: "Vatican City")
VE @doc(description: "Venezuela")
VN @doc(description: "Vietnam")
WF @doc(description: "Wallis & Futuna")
EH @doc(description: "Western Sahara")
YE @doc(description: "Yemen")
ZM @doc(description: "Zambia")
ZW @doc(description: "Zimbabwe")
}