# 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 Website Dealers API
  version: 1.0.0
extends: openapi/optimizely-website-dealers-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/WebsiteDealers'].get
  update:
    x-apievangelist-phrasing:
      intent: List dealer-to-website assignments
      effect: read
      questions:
      - Which dealers are shown on which of my commerce websites?
      - Can I filter website dealer links to just one website?
      instructions:
      - text: List all website dealer assignments.
      - text: List website dealers matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteDealers'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign a dealer to a website
      effect: write
      questions:
      - How do I make a dealer available on a particular website?
      - What do I need to link a dealer to a website?
      instructions:
      - text: Assign dealer {dealerId} to website {websiteId}.
        slots:
          dealerId: requestBody.dealerId
          websiteId: requestBody.websiteId
      - text: Link website {websiteId} with dealer {dealerId}.
        slots:
          websiteId: requestBody.websiteId
          dealerId: requestBody.dealerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteDealers({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one dealer-to-website assignment
      effect: read
      questions:
      - How do I look up a single website dealer link by its ID?
      - Which website and dealer does a specific assignment connect?
      instructions:
      - text: Get website dealer assignment {id}.
        slots:
          id: path.id
      - text: Show the website and dealer linked by record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteDealers({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a dealer-to-website assignment
      effect: write
      questions:
      - How do I overwrite a website dealer record entirely?
      - Is there a way to fully replace a dealer assignment instead of patching it?
      instructions:
      - text: Replace website dealer {id} so it links dealer {dealerId} to website {websiteId}.
        slots:
          id: path.id
          dealerId: requestBody.dealerId
          websiteId: requestBody.websiteId
      - text: Overwrite website dealer record {id} with a complete new record.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteDealers({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unassign a dealer from a website
      effect: destructive
      questions:
      - How do I stop showing a dealer on one of my websites?
      - Can I delete a website dealer link only if its ETag still matches?
      instructions:
      - text: Delete website dealer assignment {id}.
        slots:
          id: path.id
      - text: Remove website dealer link {id} if its ETag is still {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteDealers({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Point a dealer assignment at another dealer or site
      effect: write
      questions:
      - How do I switch an existing website dealer link to a different dealer?
      - Can I move a dealer assignment to another website?
      instructions:
      - text: Change the dealer on website dealer {id} to {dealerId}.
        slots:
          id: path.id
          dealerId: requestBody.dealerId
      - text: Move website dealer {id} to website {websiteId}.
        slots:
          id: path.id
          websiteId: requestBody.websiteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteDealers/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank website dealer template
      effect: read
      questions:
      - What default values does a new website dealer link start with?
      - Can I fetch an empty website dealer template before creating one?
      instructions:
      - text: Fetch the default website dealer template.
      - text: Show me the starting values for a new dealer-to-website link.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/websitedealers/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk unassign dealers from websites
      effect: destructive
      questions:
      - How do I delete several website dealer links at once?
      - Can I remove a batch of dealer assignments by ID?
      instructions:
      - text: Bulk delete the website dealer records with IDs {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these dealer assignments in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/websitedealers({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a website dealer link
      effect: read
      questions:
      - How do I read a custom property stored on a website dealer record?
      - Can I fetch one extra field value from a dealer assignment?
      instructions:
      - text: Get custom property {custompropertyKey} on website dealer {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show the custom property {custompropertyKey} of dealer assignment {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'