# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Carrier Zone Postal Code Ranges API
  version: 1.0.0
extends: openapi/optimizely-carrier-zone-postal-code-ranges-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: 9
- target: $.paths['/api/v1/admin/CarrierZonePostalCodeRanges'].get
  update:
    x-apievangelist-phrasing:
      intent: List carrier zone postal code ranges
      effect: read
      questions:
      - Which postal code ranges map to each carrier shipping zone?
      - Can I filter postal code ranges to one carrier zone?
      instructions:
      - text: List all carrier zone postal code ranges.
      - text: List postal code ranges matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CarrierZonePostalCodeRanges'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a postal code range to a carrier zone
      effect: write
      questions:
      - How do I assign a range of ZIP codes to a carrier zone?
      - What start and end values does a new postal code range need?
      instructions:
      - text: Add postal codes {postalCodeStartRange} to {postalCodeEndRange} to carrier zone {carrierZoneId}.
        slots:
          postalCodeStartRange: requestBody.postalCodeStartRange
          postalCodeEndRange: requestBody.postalCodeEndRange
          carrierZoneId: requestBody.carrierZoneId
      - text: Create a ZIP range from {postalCodeStartRange} through {postalCodeEndRange} for zone {carrierZoneId}.
        slots:
          postalCodeStartRange: requestBody.postalCodeStartRange
          postalCodeEndRange: requestBody.postalCodeEndRange
          carrierZoneId: requestBody.carrierZoneId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CarrierZonePostalCodeRanges({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a carrier zone postal code range
      effect: read
      questions:
      - Can I look up one postal code range by its ID?
      - Which zone does a particular ZIP range record belong to?
      instructions:
      - text: Show postal code range {id}.
        slots:
          id: path.id
      - text: Get postal code range {id} expanding {expand}.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CarrierZonePostalCodeRanges({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a carrier zone postal code range
      effect: write
      questions:
      - Can I overwrite a postal code range record completely?
      - What's the full-replace call for a ZIP range?
      instructions:
      - text: Replace postal code range {id} with {postalCodeStartRange} to {postalCodeEndRange}.
        slots:
          id: path.id
          postalCodeStartRange: requestBody.postalCodeStartRange
          postalCodeEndRange: requestBody.postalCodeEndRange
      - text: Overwrite ZIP range {id} and move it to zone {carrierZoneId}, from {postalCodeStartRange} to {postalCodeEndRange}.
        slots:
          id: path.id
          carrierZoneId: requestBody.carrierZoneId
          postalCodeStartRange: requestBody.postalCodeStartRange
          postalCodeEndRange: requestBody.postalCodeEndRange
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CarrierZonePostalCodeRanges({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a carrier zone postal code range
      effect: destructive
      questions:
      - How do I remove one ZIP range from a carrier zone?
      - Can I delete a postal code range only if its ETag matches?
      instructions:
      - text: Delete postal code range {id}.
        slots:
          id: path.id
      - text: Delete postal code range {id} if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CarrierZonePostalCodeRanges({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a carrier zone postal code range
      effect: write
      questions:
      - Can I widen a ZIP range by changing just its end value?
      - Is there a partial update for one postal code range?
      instructions:
      - text: Change the end of postal code range {id} to {postalCodeEndRange}.
        slots:
          id: path.id
          postalCodeEndRange: requestBody.postalCodeEndRange
      - text: Patch postal code range {id} to start at {postalCodeStartRange}.
        slots:
          id: path.id
          postalCodeStartRange: requestBody.postalCodeStartRange
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CarrierZonePostalCodeRanges/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a postal code range
      effect: read
      questions:
      - What defaults are pre-filled for a new postal code range?
      - Is there a blank ZIP range template?
      instructions:
      - text: Get the default postal code range template.
      - text: Show pre-filled values for a new carrier zone ZIP range.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/carrierzonepostalcoderanges/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several postal code ranges
      effect: destructive
      questions:
      - Can I bulk delete postal code ranges in one request?
      - Which call removes many ZIP ranges by ID list?
      instructions:
      - text: Bulk delete postal code ranges {ids}.
        slots:
          ids: query.ids
      - text: Remove the carrier zone ZIP ranges {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/carrierzonepostalcoderanges({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a postal code range
      effect: read
      questions:
      - Can I read a custom field stored on a postal code range?
      - Where are extra attributes of a ZIP range kept?
      instructions:
      - text: Get custom property {custompropertyKey} on postal code range {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show ZIP range {key}'s custom field {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'