Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Wish List Email Schedules API

10 actions 10 updates phrasing extends openapi/optimizely-wish-list-email-schedules-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Optimizely's API. It is a proposal applied on top of the contract, not a document Optimizely publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/api/v1/admin/WishListEmailSchedules'].get
$.paths['/api/v1/admin/WishListEmailSchedules'].post
$.paths['/api/v1/admin/WishListEmailSchedules({id})'].get
$.paths['/api/v1/admin/WishListEmailSchedules({id})'].put
$.paths['/api/v1/admin/WishListEmailSchedules({id})'].delete
$.paths['/api/v1/admin/WishListEmailSchedules({id})'].patch
$.paths['/api/v1/admin/WishListEmailSchedules/Default.Default()'].get
$.paths['/api/v1/admin/wishlistemailschedules/delete'].delete
$.paths['/api/v1/admin/wishlistemailschedules({key})/customproperties({custompropertyKey})'].get

OpenAPI Overlay

Raw ↑
# 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 Wish List Email Schedules API
  version: 1.0.0
extends: openapi/optimizely-wish-list-email-schedules-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/WishListEmailSchedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List wish list email schedules
      effect: read
      questions:
      - Which wish lists are set up to be emailed on a recurring schedule?
      - Can I filter wish list email schedules by user profile?
      instructions:
      - text: List all wish list email schedules.
      - text: Show wish list email schedules matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListEmailSchedules'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule recurring emails of a wish list
      effect: write
      questions:
      - How do I set up a wish list to be emailed every week?
      - Can a wish list email schedule have a start and end date?
      instructions:
      - text: Email wish list {wishListId} every {repeatPeriod} on {sendDayOfWeek} with message {message}.
        slots:
          wishListId: requestBody.wishListId
          repeatPeriod: requestBody.repeatPeriod
          sendDayOfWeek: requestBody.sendDayOfWeek
          message: requestBody.message
      - text: Create a wish list email schedule from {startDate} to {endDate} sending on {sendDayOfWeek}.
        slots:
          startDate: requestBody.startDate
          endDate: requestBody.endDate
          sendDayOfWeek: requestBody.sendDayOfWeek
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListEmailSchedules({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one wish list email schedule
      effect: read
      questions:
      - How do I look up one wish list email schedule?
      - When was a scheduled wish list email last sent?
      instructions:
      - text: Fetch wish list email schedule {id}.
        slots:
          id: path.id
      - text: Show the last sent date for wish list schedule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListEmailSchedules({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a wish list email schedule
      effect: write
      questions:
      - Can I overwrite a whole wish list email schedule?
      - Does replacing a wish list schedule require the repeat period and message again?
      instructions:
      - text: Replace wish list schedule {id} with period {repeatPeriod}, day {sendDayOfWeek} and message {message}.
        slots:
          id: path.id
          repeatPeriod: requestBody.repeatPeriod
          sendDayOfWeek: requestBody.sendDayOfWeek
          message: requestBody.message
      - text: Overwrite the full wish list email schedule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListEmailSchedules({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Stop a single wish list email schedule
      effect: destructive
      questions:
      - How do I stop one wish list from being emailed on a schedule?
      - Can I delete a wish list schedule only if its ETag matches?
      instructions:
      - text: Delete wish list email schedule {id}.
        slots:
          id: path.id
      - text: Delete wish list schedule {id} if the ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListEmailSchedules({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change the day or message of a wish list email
      effect: write
      questions:
      - Can I move an existing wish list email to a different weekday?
      - Is there a way to change just the message on a wish list email schedule?
      instructions:
      - text: Move wish list schedule {id} to send on {sendDayOfWeek}.
        slots:
          id: path.id
          sendDayOfWeek: requestBody.sendDayOfWeek
      - text: Change the message on wish list schedule {id} to {message}.
        slots:
          id: path.id
          message: requestBody.message
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WishListEmailSchedules/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a new wish list schedule
      effect: read
      questions:
      - What defaults does a new wish list email schedule start with?
      - Is there a blank wish list email schedule template?
      instructions:
      - text: Get the default values for a new wish list email schedule.
      - text: Show the empty wish list schedule record.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/wishlistemailschedules/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several wish list email schedules
      effect: destructive
      questions:
      - How do I bulk delete wish list email schedules?
      - Can I remove multiple wish list schedules by id at once?
      instructions:
      - text: Bulk delete wish list email schedules {ids}.
        slots:
          ids: query.ids
      - text: Permanently delete every wish list schedule in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/wishlistemailschedules({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a wish list schedule
      effect: read
      questions:
      - How do I read a custom property on a wish list email schedule?
      - Can I fetch one custom field from a wish list schedule?
      instructions:
      - text: Get custom property {custompropertyKey} of wish list schedule {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Show the {custompropertyKey} custom property on wish list email schedule {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'