# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for App Store Connect Merchant IDs API
  version: 1.0.0
extends: openapi/ios-merchant-ids-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/v1/merchantIds'].get
  update:
    x-apievangelist-phrasing:
      intent: List Apple Pay merchant IDs
      effect: read
      questions:
      - What Apple Pay merchant identifiers are registered on my account?
      - Can I look up a merchant ID by its identifier string?
      instructions:
      - text: List my Apple Pay merchant IDs.
      - text: Find the merchant ID with identifier {identifier}.
        slots:
          identifier: query.filter[identifier]
      - text: Show merchant IDs named {name}.
        slots:
          name: query.filter[name]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/merchantIds'].post
  update:
    x-apievangelist-phrasing:
      intent: Register an Apple Pay merchant ID
      effect: write
      questions:
      - How do I register a new merchant identifier for Apple Pay?
      - Can I create a merchant ID without using the developer portal?
      instructions:
      - text: Register a merchant ID with {merchant_details}.
        slots:
          merchant_details: requestBody.data
      - text: Create a new Apple Pay merchant identifier for my store.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/merchantIds/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Apple Pay merchant ID
      effect: read
      questions:
      - What name and identifier does a particular merchant ID have?
      - Where can I see one Apple Pay merchant ID's details?
      instructions:
      - text: Show merchant ID {merchant}.
        slots:
          merchant: path.id
      - text: Fetch the identifier and name of merchant ID {merchant}.
        slots:
          merchant: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/merchantIds/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Apple Pay merchant ID
      effect: destructive
      questions:
      - Can I delete a merchant identifier I no longer process payments with?
      - Is removing an Apple Pay merchant ID permanent?
      instructions:
      - text: Delete merchant ID {merchant}.
        slots:
          merchant: path.id
      - text: Remove Apple Pay merchant identifier {merchant}.
        slots:
          merchant: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/merchantIds/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename an Apple Pay merchant ID
      effect: write
      questions:
      - How do I change the description of an existing merchant ID?
      - Can I edit a merchant ID's name after registering it?
      instructions:
      - text: Rename merchant ID {merchant}.
        slots:
          merchant: path.id
      - text: Update the description of Apple Pay merchant ID {merchant}.
        slots:
          merchant: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/merchantIds/{id}/relationships/certificates'].get
  update:
    x-apievangelist-phrasing:
      intent: List certificate IDs for a merchant ID
      effect: read
      questions:
      - Which certificate IDs are linked to my merchant ID?
      - Can I get only the certificate references of a merchant identifier?
      instructions:
      - text: List only the certificate IDs for merchant ID {merchant}.
        slots:
          merchant: path.id
      - text: Get up to {limit} certificate references for merchant {merchant}.
        slots:
          merchant: path.id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/merchantIds/{id}/certificates'].get
  update:
    x-apievangelist-phrasing:
      intent: List Apple Pay certificates for a merchant ID
      effect: read
      questions:
      - Which payment processing certificates belong to my merchant ID?
      - Can I find a merchant certificate by serial number or type?
      instructions:
      - text: Show the certificates for merchant ID {merchant}, with details.
        slots:
          merchant: path.id
      - text: Find the certificate with serial number {serial} on merchant {merchant}.
        slots:
          merchant: path.id
          serial: query.filter[serialNumber]
      - text: List {certificate_type} certificates for merchant ID {merchant}.
        slots:
          merchant: path.id
          certificate_type: query.filter[certificateType]
      method: generated
      generated: '2026-10-01'