# 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 Bill To Address Fields API
  version: 1.0.0
extends: openapi/optimizely-bill-to-address-fields-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/BillToAddressFields'].get
  update:
    x-apievangelist-phrasing:
      intent: List bill-to address fields
      effect: read
      questions:
      - Which fields appear on the bill-to address form at checkout?
      - How do I see every configured billing address field?
      instructions:
      - text: List all bill-to address fields.
      - text: Show me the billing address form field setup.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/BillToAddressFields'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a bill-to address field
      effect: write
      questions:
      - How do I add a new field to the billing address form?
      - Can I make a new bill-to field required with a maximum length?
      instructions:
      - text: Add bill-to field {fieldName} displayed as {displayName}.
        slots:
          fieldName: requestBody.fieldName
          displayName: requestBody.displayName
      - text: Create billing address field {fieldName}, required {isRequired}, max length {maxFieldLength}.
        slots:
          fieldName: requestBody.fieldName
          isRequired: requestBody.isRequired
          maxFieldLength: requestBody.maxFieldLength
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/BillToAddressFields({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one bill-to address field
      effect: read
      questions:
      - How do I read the settings of a single billing address field?
      - Is a particular bill-to field visible and required?
      instructions:
      - text: Get bill-to address field {id}.
        slots:
          id: path.id
      - text: Show whether billing field {id} is required and visible.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/BillToAddressFields({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a bill-to address field
      effect: write
      questions:
      - What's the call to overwrite a billing address field definition entirely?
      - Do I need to resend the field name when replacing a bill-to field?
      instructions:
      - text: Replace bill-to field {id} with name {fieldName} and label {displayName}.
        slots:
          id: path.id
          fieldName: requestBody.fieldName
          displayName: requestBody.displayName
      - text: Overwrite billing address field {id} in full for website {websiteId}.
        slots:
          id: path.id
          websiteId: requestBody.websiteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/BillToAddressFields({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a bill-to address field
      effect: destructive
      questions:
      - How do I remove a field from the billing address form?
      - Can I delete a bill-to field only if its ETag still matches?
      instructions:
      - text: Delete bill-to address field {id}.
        slots:
          id: path.id
      - text: Delete billing field {id} if ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/BillToAddressFields({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a bill-to address field
      effect: write
      questions:
      - How do I hide a billing address field without deleting it?
      - Can I change the label shown for a bill-to field?
      instructions:
      - text: Set visibility of bill-to field {id} to {isVisible}.
        slots:
          id: path.id
          isVisible: requestBody.isVisible
      - text: Rename the label of billing field {id} to {displayName}.
        slots:
          id: path.id
          displayName: requestBody.displayName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/BillToAddressFields/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default bill-to field template
      effect: read
      questions:
      - What are the default settings for a new billing address field?
      - Where do I get a blank bill-to address field record?
      instructions:
      - text: Get the default bill-to address field template.
      - text: Show default values for a new billing field.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/billtoaddressfields/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete bill-to address fields
      effect: destructive
      questions:
      - Can I remove several billing address fields at once?
      - Can I bulk delete bill-to fields by ID?
      instructions:
      - text: Bulk delete bill-to address fields {ids}.
        slots:
          ids: query.ids
      - text: 'Remove all these billing fields: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/billtoaddressfields({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a bill-to field
      effect: read
      questions:
      - Where would I read a custom property on a billing address field?
      - Can I fetch an extra attribute attached to a bill-to field?
      instructions:
      - text: Get custom property {prop} on bill-to field {key}.
        slots:
          key: path.key
          prop: path.custompropertyKey
      - text: Show custom field {prop} for bill-to field {key}.
        slots:
          key: path.key
          prop: path.custompropertyKey
      method: generated
      generated: '2026-09-26'