# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for GetResponse APIv3 Addresses API
  version: 1.0.0
extends: openapi/getresponse-addresses-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/addresses/{addressId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a saved address
      effect: read
      questions:
      - Can I look up one stored address by its ID?
      - What details are saved on a specific address record?
      instructions:
      - text: Get address {address}.
        slots:
          address: path.addressId
      - text: Show the {fields} of address {address}.
        slots:
          fields: query.fields
          address: path.addressId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/addresses/{addressId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a saved address
      effect: write
      questions:
      - Can I fix the street or zip on an address I already saved?
      - Do fields I leave out stay unchanged when editing an address?
      instructions:
      - text: Update address {address}.
        slots:
          address: path.addressId
      - text: Change only the fields I specify on address {address}.
        slots:
          address: path.addressId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/addresses/{addressId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a saved address
      effect: destructive
      questions:
      - How do I remove an address record I no longer use?
      - Is removing an address from ecommerce data permanent?
      instructions:
      - text: Delete address {address}.
        slots:
          address: path.addressId
      - text: Remove address record {address}.
        slots:
          address: path.addressId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/addresses'].get
  update:
    x-apievangelist-phrasing:
      intent: Search saved addresses
      effect: read
      questions:
      - Which saved addresses are in a particular city or zip code?
      - Can I find addresses by a customer's last name or company?
      instructions:
      - text: Find addresses in city {city}.
        slots:
          city: query.query[city]
      - text: List addresses for last name {lastName}.
        slots:
          lastName: query.query[lastName]
      - text: Find addresses belonging to company {company}.
        slots:
          company: query.query[company]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/addresses'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a new address
      effect: write
      questions:
      - How do I store a customer shipping or billing address?
      - What can I include when creating an address record?
      instructions:
      - text: Create a new address record with the details I give you.
      - text: Save this customer's billing address.
      method: generated
      generated: '2026-09-26'