# 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 Allowed Customers API
  version: 1.0.0
extends: openapi/optimizely-website-allowed-customers-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/WebsiteAllowedCustomers'].get
  update:
    x-apievangelist-phrasing:
      intent: List customers allowed on websites
      effect: read
      questions:
      - Which customers are allowed to use which storefront websites?
      - Can I filter the allowed-customer list to one website?
      instructions:
      - text: List website allowed customers matching {filter}.
        slots:
          filter: query.$filter
      - text: Show the first {top} website allowed customer records.
        slots:
          top: query.$top
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteAllowedCustomers'].post
  update:
    x-apievangelist-phrasing:
      intent: Allow a customer on a website
      effect: write
      questions:
      - How do I give a customer access to a restricted storefront website?
      - What ids do I need to allow a customer onto a site?
      instructions:
      - text: Allow customer {customerId} on website {websiteId}.
        slots:
          customerId: requestBody.customerId
          websiteId: requestBody.websiteId
      - text: Grant website {websiteId} access to customer {customerId}.
        slots:
          websiteId: requestBody.websiteId
          customerId: requestBody.customerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteAllowedCustomers({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one website allowed customer record
      effect: read
      questions:
      - Where do I look up a single website allowed customer record by id?
      - Which website and customer does a given access record link?
      instructions:
      - text: Get website allowed customer record {id}.
        slots:
          id: path.id
      - text: Show the website and customer on access record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteAllowedCustomers({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a website allowed customer record
      effect: write
      questions:
      - Can I fully overwrite a website allowed customer record?
      - Is it possible to swap both the website and customer on an access record in one replace?
      instructions:
      - text: Replace access record {id} with website {websiteId} and customer {customerId}.
        slots:
          id: path.id
          websiteId: requestBody.websiteId
          customerId: requestBody.customerId
      - text: Overwrite the entire website allowed customer record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteAllowedCustomers({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a customer's access to a website
      effect: destructive
      questions:
      - Can I revoke a customer's access to a storefront website?
      - Is an If-Match ETag honored when removing an allowed customer?
      instructions:
      - text: Delete website allowed customer record {id}.
        slots:
          id: path.id
      - text: Remove access record {id} only if ETag {etag} matches.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteAllowedCustomers({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a website allowed customer record
      effect: write
      questions:
      - Can I move an existing access record to a different website?
      - How do I change which customer an access record allows without replacing it?
      instructions:
      - text: Change access record {id} to website {websiteId}.
        slots:
          id: path.id
          websiteId: requestBody.websiteId
      - text: Reassign access record {id} to customer {customerId}.
        slots:
          id: path.id
          customerId: requestBody.customerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteAllowedCustomers/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Call the Default function on allowed customers
      effect: read
      questions:
      - What does the Default function on WebsiteAllowedCustomers return?
      - Where do I get the default website allowed customer entity?
      instructions:
      - text: Call the Default function on WebsiteAllowedCustomers.
      - text: Fetch the default website allowed customer entity.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/websiteallowedcustomers/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk remove website allowed customers
      effect: destructive
      questions:
      - Can I revoke many customers' website access at once by id?
      - Is there a bulk delete for website allowed customer records?
      instructions:
      - text: Bulk delete website allowed customer records {ids}.
        slots:
          ids: query.ids
      - text: Remove every access record in the id list {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/websiteallowedcustomers({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on an allowed customer
      effect: read
      questions:
      - How do I read a custom property stored on a website allowed customer record?
      - Can I fetch one extension field from a website access record?
      instructions:
      - text: Get custom property {custompropertyKey} of allowed customer record {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Show custom field {custompropertyKey} on website access record {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'