API Evangelist conversational phrasing for Admin API V1 Affiliates API

# 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 Affiliates API
  version: 1.0.0
extends: openapi/optimizely-affiliates-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: 11
- target: $.paths['/api/v1/admin/Affiliates'].get
  update:
    x-apievangelist-phrasing:
      intent: List affiliate partners
      effect: read
      questions:
      - How can I see every affiliate configured in Commerce admin?
      - Can I filter the affiliate list to only active partners?
      instructions:
      - text: List all affiliates.
      - text: Show affiliates matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/Affiliates'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new affiliate partner
      effect: write
      questions:
      - What information do I need to register a new affiliate?
      - Can I give a new affiliate a logo image and website link?
      instructions:
      - text: Create affiliate {name} with website {url}.
        slots:
          name: requestBody.name
          url: requestBody.url
      - text: Add affiliate {name} using logo {imagePath} and description {description}.
        slots:
          name: requestBody.name
          imagePath: requestBody.imagePath
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/Affiliates({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one affiliate by id
      effect: read
      questions:
      - How do I look up a single affiliate's details?
      - What fields come back for one affiliate record?
      instructions:
      - text: Fetch affiliate {id}.
        slots:
          id: path.id
      - text: Show the details of affiliate {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/Affiliates({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an affiliate record
      effect: write
      questions:
      - Can I overwrite an affiliate's whole record at once?
      - Does fully replacing an affiliate require resending its name, URL and image?
      instructions:
      - text: Replace affiliate {id} with name {name} and URL {url}.
        slots:
          id: path.id
          name: requestBody.name
          url: requestBody.url
      - text: Overwrite the full record for affiliate {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/Affiliates({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single affiliate
      effect: destructive
      questions:
      - How do I delete one affiliate?
      - Can an affiliate delete be conditional on its ETag?
      instructions:
      - text: Delete affiliate {id}.
        slots:
          id: path.id
      - text: Delete affiliate {id} only if the ETag matches {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/Affiliates({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update part of an affiliate
      effect: write
      questions:
      - Can I just change an affiliate's website URL?
      - Is there a way to deactivate an affiliate without deleting it?
      instructions:
      - text: Change the URL of affiliate {id} to {url}.
        slots:
          id: path.id
          url: requestBody.url
      - text: Set affiliate {id} active flag to {isActive}.
        slots:
          id: path.id
          isActive: requestBody.isActive
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/Affiliates/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a new affiliate
      effect: read
      questions:
      - What defaults does a new affiliate record start with?
      - Is there an empty affiliate template to fill in?
      instructions:
      - text: Get the default field values for a new affiliate.
      - text: Show the blank affiliate record.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/Affiliates/Default.archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive affiliates via the OData archive action
      effect: destructive
      questions:
      - How do I archive affiliates with the OData Default.archive action?
      - Can I retire several affiliates through the archive action call?
      instructions:
      - text: Run the OData archive action on affiliates {ids}.
        slots:
          ids: query.ids
      - text: Archive affiliates {ids} with Default.archive.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/affiliates/archive'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive affiliates through the archive route
      effect: destructive
      questions:
      - Is there a REST route for archiving a batch of affiliates?
      - What does a DELETE on affiliates/archive do?
      instructions:
      - text: Archive affiliates {ids} using the affiliates/archive route.
        slots:
          ids: query.ids
      - text: Send the batch archive request for affiliates {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/affiliates/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete several affiliates
      effect: destructive
      questions:
      - How do I bulk delete a list of affiliates?
      - Can I permanently remove multiple affiliates in one request?
      instructions:
      - text: Bulk delete affiliates {ids}.
        slots:
          ids: query.ids
      - text: Permanently delete every affiliate in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/affiliates({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on an affiliate
      effect: read
      questions:
      - How do I read a custom property on an affiliate?
      - Can I fetch one custom field value from an affiliate record?
      instructions:
      - text: Get custom property {custompropertyKey} of affiliate {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Show the {custompropertyKey} custom property on affiliate {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'