@graphcommerce/magento-graphql 8.1.0-canary.9 → 9.0.0-canary.54

package/schema-247/Mutation-contactUs.graphqls

@@ -0,0 +1,40 @@
+input ContactUsInput {
+  """
+  The shopper's comment to the merchant.
+  """
+  comment: String!
+  """
+  The email address of the shopper.
+  """
+  email: String!
+  """
+  The full name of the shopper.
+  """
+  name: String!
+  """
+  The shopper's telephone number.
+  """
+  telephone: String
+}
+
+"""
+Contains the status of the request.
+"""
+type ContactUsOutput {
+  """
+  Indicates whether the request was successful.
+  """
+  status: Boolean!
+}
+
+type Mutation {
+  """
+  Send a 'Contact Us' email to the merchant.
+  """
+  contactUs(
+    """
+    An input object that defines shopper information.
+    """
+    input: ContactUsInput!
+  ): ContactUsOutput @deprecated(reason: "Magento >= 2.4.7")
+}

package/schema-247/Mutation-createGuestCart.graphqls

@@ -0,0 +1,21 @@
+input CreateGuestCartInput {
+  """
+  Optional client-generated ID
+  """
+  cart_uid: ID
+}
+
+type CreateGuestCartOutput {
+  """
+  The newly created cart.
+  """
+  cart: Cart
+}
+
+type Mutation {
+  """
+  Create a new shopping cart
+  """
+  createGuestCart(input: CreateGuestCartInput): CreateGuestCartOutput
+    @deprecated(reason: "Magento >= 2.4.7")
+}

package/schema-247/Mutation-estimateShippingMethods.graphqls

@@ -0,0 +1,44 @@
+"""
+Contains details about an address.
+"""
+input EstimateAddressInput {
+  """
+  The two-letter code representing the customer's country.
+  """
+  country_code: CountryCodeEnum!
+  """
+  The customer's ZIP or postal code.
+  """
+  postcode: String
+  """
+  An object containing the region name, region code, and region ID.
+  """
+  region: CustomerAddressRegionInput
+}
+
+input EstimateTotalsInput {
+  """
+  Customer's address to estimate totals.
+  """
+  address: EstimateAddressInput!
+  """
+  The unique ID of the cart to query.
+  """
+  cart_id: String!
+  """
+  Selected shipping method to estimate totals.
+  """
+  shipping_method: ShippingMethodInput
+}
+
+type Mutation {
+  """
+  Estimate shipping method(s) for cart based on address
+  """
+  estimateShippingMethods(
+    """
+    An input object that specifies details for estimation of available shipping methods
+    """
+    input: EstimateTotalsInput!
+  ): [AvailableShippingMethod] @deprecated(reason: "Magento >= 2.4.7")
+}

package/schema-247/Mutation-estimateTotals.graphqls

@@ -0,0 +1,21 @@
+"""
+Estimate totals output.
+"""
+type EstimateTotalsOutput {
+  """
+  Cart after totals estimation
+  """
+  cart: Cart
+}
+
+type Mutation {
+  """
+  Estimate totals for cart based on the address
+  """
+  estimateTotals(
+    """
+    An input object that specifies details for cart totals estimation
+    """
+    input: EstimateTotalsInput!
+  ): EstimateTotalsOutput! @deprecated(reason: "Magento >= 2.4.7")
+}

package/schema-247/Mutation-placeOrder.graphqls

@@ -0,0 +1,10 @@
+type PlaceOrderOutput {
+  """
+  The ID of the order.
+  """
+  order: Order
+  """
+  Full order information.
+  """
+  orderV2: CustomerOrder @deprecated(reason: "Magento >= 2.4.7")
+}

package/schema-247/ProductAttributeFilterInput-category_url_path.graphqls

@@ -0,0 +1,3 @@
+input ProductAttributeFilterInput {
+  category_url_path: FilterEqualTypeInput @deprecated(reason: "Magento >= 2.4.7")
+}

package/schema-247/Query-attributesList.graphqls

@@ -0,0 +1,450 @@
+type Query {
+  """
+  Retrieve EAV attributes associated to a frontend form. Use countries query provided by DirectoryGraphQl module to retrieve region_id and country_id attribute options.
+  """
+  attributesForm(
+    """
+    Form code.
+    """
+    formCode: String!
+  ): AttributesFormOutput!
+  """
+  Returns a list of attributes metadata for a given entity type.
+  """
+  attributesList(
+    """
+    Entity type.
+    """
+    entityType: AttributeEntityTypeEnum!
+    """
+    Identifies which filter inputs to search for and return.
+    """
+    filters: AttributeFilterInput
+  ): AttributesMetadataOutput
+}
+
+"""
+Metadata of EAV attributes associated to form
+"""
+type AttributesFormOutput {
+  """
+  Errors of retrieving certain attributes metadata.
+  """
+  errors: [AttributeMetadataError]!
+  """
+  Requested attributes metadata.
+  """
+  items: [CustomAttributeMetadataInterface]!
+}
+
+"""
+Metadata of EAV attributes.
+"""
+type AttributesMetadataOutput {
+  """
+  Errors of retrieving certain attributes metadata.
+  """
+  errors: [AttributeMetadataError]!
+  """
+  Requested attributes metadata.
+  """
+  items: [CustomAttributeMetadataInterface]!
+}
+
+enum CatalogAttributeApplyToEnum {
+  SIMPLE
+  VIRTUAL
+  BUNDLE
+  DOWNLOADABLE
+  CONFIGURABLE
+  GROUPED
+  CATEGORY
+}
+
+"""
+List of all entity types. Populated by the modules introducing EAV entities.
+"""
+enum AttributeEntityTypeEnum {
+  CATALOG_PRODUCT
+  CATALOG_CATEGORY
+  CUSTOMER
+  CUSTOMER_ADDRESS
+}
+
+"""
+An interface containing fields that define the EAV attribute.
+"""
+interface CustomAttributeMetadataInterface {
+  """
+  The unique identifier for an attribute code. This value should be in lowercase letters without spaces.
+  """
+  code: ID!
+  """
+  Default attribute value.
+  """
+  default_value: String
+  """
+  The type of entity that defines the attribute.
+  """
+  entity_type: AttributeEntityTypeEnum!
+  """
+  The frontend class of the attribute.
+  """
+  frontend_class: String
+  """
+  The frontend input type of the attribute.
+  """
+  frontend_input: AttributeFrontendInputEnum
+  """
+  Whether the attribute value is required.
+  """
+  is_required: Boolean!
+  """
+  Whether the attribute value must be unique.
+  """
+  is_unique: Boolean!
+  """
+  The label assigned to the attribute.
+  """
+  label: String
+  """
+  Attribute options.
+  """
+  options: [CustomAttributeOptionInterface]!
+}
+
+"""
+Base EAV implementation of CustomAttributeMetadataInterface.
+"""
+type AttributeMetadata implements CustomAttributeMetadataInterface {
+  """
+  The unique identifier for an attribute code. This value should be in lowercase letters without spaces.
+  """
+  code: ID!
+  """
+  Default attribute value.
+  """
+  default_value: String
+  """
+  The type of entity that defines the attribute.
+  """
+  entity_type: AttributeEntityTypeEnum!
+  """
+  The frontend class of the attribute.
+  """
+  frontend_class: String
+  """
+  The frontend input type of the attribute.
+  """
+  frontend_input: AttributeFrontendInputEnum
+  """
+  Whether the attribute value is required.
+  """
+  is_required: Boolean!
+  """
+  Whether the attribute value must be unique.
+  """
+  is_unique: Boolean!
+  """
+  The label assigned to the attribute.
+  """
+  label: String
+  """
+  Attribute options.
+  """
+  options: [CustomAttributeOptionInterface]!
+}
+
+"""
+Swatch attribute metadata.
+"""
+type CatalogAttributeMetadata implements CustomAttributeMetadataInterface {
+  """
+  To which catalog types an attribute can be applied.
+  """
+  apply_to: [CatalogAttributeApplyToEnum]
+  """
+  The unique identifier for an attribute code. This value should be in lowercase letters without spaces.
+  """
+  code: ID!
+  """
+  Default attribute value.
+  """
+  default_value: String
+  """
+  The type of entity that defines the attribute.
+  """
+  entity_type: AttributeEntityTypeEnum!
+  """
+  The frontend class of the attribute.
+  """
+  frontend_class: String
+  """
+  The frontend input type of the attribute.
+  """
+  frontend_input: AttributeFrontendInputEnum
+  """
+  Whether a product or category attribute can be compared against another or not.
+  """
+  is_comparable: Boolean
+  """
+  Whether a product or category attribute can be filtered or not.
+  """
+  is_filterable: Boolean
+  """
+  Whether a product or category attribute can be filtered in search or not.
+  """
+  is_filterable_in_search: Boolean
+  """
+  Whether a product or category attribute can use HTML on front or not.
+  """
+  is_html_allowed_on_front: Boolean
+  """
+  Whether the attribute value is required.
+  """
+  is_required: Boolean!
+  """
+  Whether a product or category attribute can be searched or not.
+  """
+  is_searchable: Boolean
+  """
+  Whether the attribute value must be unique.
+  """
+  is_unique: Boolean!
+  """
+  Whether a product or category attribute can be used for price rules or not.
+  """
+  is_used_for_price_rules: Boolean
+  """
+  Whether a product or category attribute is used for promo rules or not.
+  """
+  is_used_for_promo_rules: Boolean
+  """
+  Whether a product or category attribute is visible in advanced search or not.
+  """
+  is_visible_in_advanced_search: Boolean
+  """
+  Whether a product or category attribute is visible on front or not.
+  """
+  is_visible_on_front: Boolean
+  """
+  Whether a product or category attribute has WYSIWYG enabled or not.
+  """
+  is_wysiwyg_enabled: Boolean
+  """
+  The label assigned to the attribute.
+  """
+  label: String
+  """
+  Attribute options.
+  """
+  options: [CustomAttributeOptionInterface]!
+  """
+  Input type of the swatch attribute option.
+  """
+  swatch_input_type: SwatchInputTypeEnum
+  """
+  Whether update product preview image or not.
+  """
+  update_product_preview_image: Boolean
+  """
+  Whether use product image for swatch or not.
+  """
+  use_product_image_for_swatch: Boolean
+  """
+  Whether a product or category attribute is used in product listing or not.
+  """
+  used_in_product_listing: Boolean
+}
+
+"""
+EAV attribute frontend input types.
+"""
+enum AttributeFrontendInputEnum {
+  BOOLEAN
+  DATE
+  DATETIME
+  FILE
+  GALLERY
+  HIDDEN
+  IMAGE
+  MEDIA_IMAGE
+  MULTILINE
+  MULTISELECT
+  PRICE
+  SELECT
+  TEXT
+  TEXTAREA
+  WEIGHT
+  UNDEFINED
+}
+
+"""
+Customer attribute metadata.
+"""
+type CustomerAttributeMetadata implements CustomAttributeMetadataInterface {
+  """
+  The unique identifier for an attribute code. This value should be in lowercase letters without spaces.
+  """
+  code: ID!
+  """
+  Default attribute value.
+  """
+  default_value: String
+  """
+  The type of entity that defines the attribute.
+  """
+  entity_type: AttributeEntityTypeEnum!
+  """
+  The frontend class of the attribute.
+  """
+  frontend_class: String
+  """
+  The frontend input type of the attribute.
+  """
+  frontend_input: AttributeFrontendInputEnum
+  """
+  The template used for the input of the attribute (e.g., 'date').
+  """
+  input_filter: InputFilterEnum
+  """
+  Whether the attribute value is required.
+  """
+  is_required: Boolean!
+  """
+  Whether the attribute value must be unique.
+  """
+  is_unique: Boolean!
+  """
+  The label assigned to the attribute.
+  """
+  label: String
+  """
+  The number of lines of the attribute value.
+  """
+  multiline_count: Int
+  """
+  Attribute options.
+  """
+  options: [CustomAttributeOptionInterface]!
+  """
+  The position of the attribute in the form.
+  """
+  sort_order: Int
+  """
+  The validation rules of the attribute value.
+  """
+  validate_rules: [ValidationRule]
+}
+
+"""
+Defines a customer attribute validation rule.
+"""
+type ValidationRule {
+  """
+  Validation rule name applied to a customer attribute.
+  """
+  name: ValidationRuleEnum
+  """
+  Validation rule value.
+  """
+  value: String
+}
+
+"""
+List of validation rule names applied to a customer attribute.
+"""
+enum ValidationRuleEnum {
+  DATE_RANGE_MAX
+  DATE_RANGE_MIN
+  FILE_EXTENSIONS
+  INPUT_VALIDATION
+  MAX_TEXT_LENGTH
+  MIN_TEXT_LENGTH
+  MAX_FILE_SIZE
+  MAX_IMAGE_HEIGHT
+  MAX_IMAGE_WIDTH
+}
+
+interface CustomAttributeOptionInterface {
+  """
+  Is the option value default.
+  """
+  is_default: Boolean!
+  """
+  The label assigned to the attribute option.
+  """
+  label: String!
+  """
+  The attribute option value.
+  """
+  value: String!
+}
+
+"""
+Base EAV implementation of CustomAttributeOptionInterface.
+"""
+type AttributeOptionMetadata implements CustomAttributeOptionInterface {
+  """
+  Is the option value default.
+  """
+  is_default: Boolean!
+  """
+  The label assigned to the attribute option.
+  """
+  label: String!
+  """
+  The attribute option value.
+  """
+  value: String!
+}
+
+"""
+Swatch attribute metadata input types.
+"""
+enum SwatchInputTypeEnum {
+  BOOLEAN
+  DATE
+  DATETIME
+  DROPDOWN
+  FILE
+  GALLERY
+  HIDDEN
+  IMAGE
+  MEDIA_IMAGE
+  MULTILINE
+  MULTISELECT
+  PRICE
+  SELECT
+  TEXT
+  TEXTAREA
+  UNDEFINED
+  VISUAL
+  WEIGHT
+}
+
+"""
+List of templates/filters applied to customer attribute input.
+"""
+enum InputFilterEnum {
+  """
+  There are no templates or filters to be applied.
+  """
+  NONE
+  """
+  Forces attribute input to follow the date format.
+  """
+  DATE
+  """
+  Strip whitespace (or other characters) from the beginning and end of the input.
+  """
+  TRIM
+  """
+  Strip HTML Tags.
+  """
+  STRIPTAGS
+  """
+  Escape HTML Entities.
+  """
+  ESCAPEHTML
+}

package/schema-247/Query-guestOrder.graphqls

@@ -0,0 +1,31 @@
+type CustomerOrder {
+  """
+  Order customer email.
+  """
+  email: String
+}
+
+"""
+Input to retrieve an order based on details.
+"""
+input OrderInformationInput {
+  """
+  Order billing address email.
+  """
+  email: String!
+  """
+  Order number.
+  """
+  number: String!
+  """
+  Order billing address postcode.
+  """
+  postcode: String!
+}
+
+type Query {
+  """
+  Retrieve guest order details based on number, email and postcode.
+  """
+  guestOrder(input: OrderInformationInput!): CustomerOrder! @deprecated(reason: "Magento >= 2.4.7")
+}

package/schema-247/Query-guestOrderByToken.graphqls

@@ -0,0 +1,30 @@
+type PlaceOrderOutput {
+  """
+  Full order information.
+  """
+  orderV2: CustomerOrder
+}
+
+type CustomerOrder {
+  """
+  The token that can be used to retrieve the order using order query.
+  """
+  token: String!
+}
+
+"""
+Input to retrieve an order based on token.
+"""
+input OrderTokenInput {
+  """
+  Order token.
+  """
+  token: String!
+}
+
+type Query {
+  """
+  Retrieve guest order details based on token.
+  """
+  guestOrderByToken(input: OrderTokenInput!): CustomerOrder! @deprecated(reason: "Magento >= 2.4.7")
+}

package/schema-247/Query-recaptchaV3Config.graphqls

@@ -0,0 +1,53 @@
+"""
+Contains reCAPTCHA V3-Invisible configuration details.
+"""
+type ReCaptchaConfigurationV3 {
+  """
+  The position of the invisible reCAPTCHA badge on each page.
+  """
+  badge_position: String!
+  """
+  The message that appears to the user if validation fails.
+  """
+  failure_message: String!
+  """
+  A list of forms on the storefront that have been configured to use reCAPTCHA V3.
+  """
+  forms: [ReCaptchaFormEnum]!
+  """
+  Return whether recaptcha is enabled or not
+  """
+  is_enabled: Boolean!
+  """
+  A two-character code that specifies the language that is used for Google reCAPTCHA text and messaging.
+  """
+  language_code: String
+  """
+  The minimum score that identifies a user interaction as a potential risk.
+  """
+  minimum_score: Float!
+  """
+  The website key generated when the Google reCAPTCHA account was registered.
+  """
+  website_key: String!
+}
+
+enum ReCaptchaFormEnum {
+  PLACE_ORDER
+  CONTACT
+  CUSTOMER_LOGIN
+  CUSTOMER_FORGOT_PASSWORD
+  CUSTOMER_CREATE
+  CUSTOMER_EDIT
+  NEWSLETTER
+  PRODUCT_REVIEW
+  SENDFRIEND
+  BRAINTREE
+}
+
+type Query {
+  """
+  Returns details about Google reCAPTCHA V3-Invisible configuration.
+  """
+  recaptchaV3Config: ReCaptchaConfigurationV3 @deprecated(reason: "Magento >= 2.4.7")
+}