API Evangelist conversational phrasing for Admin API V1 Customer Product Sets 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 Customer Product Sets API
  version: 1.0.0
extends: openapi/optimizely-customer-product-sets-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: 12
- target: $.paths['/api/v1/admin/CustomerProductSets'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer product sets
      effect: read
      questions:
      - Which customer-specific product sets exist in my commerce admin?
      - Can I filter product sets to one customer with an OData query?
      instructions:
      - text: List all customer product sets.
      - text: List customer product sets matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerProductSets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer product set
      effect: write
      questions:
      - How do I create a curated set of products for a specific customer?
      - Can a new customer product set have activation and deactivation dates?
      instructions:
      - text: Create product set {name} for customer {customerId} described as {description}.
        slots:
          name: requestBody.name
          customerId: requestBody.customerId
          description: requestBody.description
      - text: Add a product set {name} active from {activateOn} to {deactivateOn}.
        slots:
          name: requestBody.name
          activateOn: requestBody.activateOn
          deactivateOn: requestBody.deactivateOn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerProductSets({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer product set
      effect: read
      questions:
      - What customer and dates are attached to one product set?
      - Can I expand the products when fetching a single customer product set?
      instructions:
      - text: Get customer product set {id}.
        slots:
          id: path.id
      - text: Fetch product set {id} expanding {expand}.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerProductSets({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a customer product set
      effect: write
      questions:
      - How do I overwrite a customer product set's whole record?
      - Can I resend name, description and dates to fully replace a product set?
      instructions:
      - text: Replace product set {id} with name {name} and description {description}.
        slots:
          id: path.id
          name: requestBody.name
          description: requestBody.description
      - text: Overwrite the full record of customer product set {id} for customer {customerId}.
        slots:
          id: path.id
          customerId: requestBody.customerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerProductSets({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one customer product set
      effect: destructive
      questions:
      - How do I remove a single customer product set by id?
      - Can a product set delete be guarded by an If-Match ETag?
      instructions:
      - text: Delete customer product set {id}.
        slots:
          id: path.id
      - text: Delete product set {id} only 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/CustomerProductSets({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update fields on a customer product set
      effect: write
      questions:
      - Can I just change the end date of a customer product set?
      - How do I rename a product set without resending the rest?
      instructions:
      - text: Set product set {id} to deactivate on {deactivateOn}.
        slots:
          id: path.id
          deactivateOn: requestBody.deactivateOn
      - text: Rename customer product set {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerProductSets/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a new product set
      effect: read
      questions:
      - What defaults does a new customer product set start with?
      - Is there a blank product set template for a create form?
      instructions:
      - text: Get the default template for a customer product set.
      - text: Fetch an empty customer product set with default values.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerProductSets/Default.archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive product sets via the archive action
      effect: write
      questions:
      - Can I archive several customer product sets rather than delete them?
      - Which POST action archives product sets from a list of ids?
      instructions:
      - text: Archive customer product sets {ids} with the POST archive action.
        slots:
          ids: query.ids
      - text: Run Default.archive on product sets {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/customerproductsets/archive'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive product sets via the DELETE archive route
      effect: destructive
      questions:
      - Is there a DELETE-verb route for archiving customer product sets?
      - How do I archive product sets through the customerproductsets/archive endpoint?
      instructions:
      - text: Call the DELETE archive route for product sets {ids}.
        slots:
          ids: query.ids
      - text: Archive product sets {ids} via the customerproductsets/archive route.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/customerproductsets/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete customer product sets
      effect: destructive
      questions:
      - Can I permanently delete many customer product sets in one call?
      - How do I bulk-remove product sets by id list?
      instructions:
      - text: Bulk delete customer product sets {ids}.
        slots:
          ids: query.ids
      - text: Permanently remove all product sets in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/customerproductsets({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a product set
      effect: read
      questions:
      - What custom property values are stored on a customer product set?
      - Can I read one custom attribute of a product set?
      instructions:
      - text: Get custom property {custompropertyKey} on product set {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Read extra attribute {custompropertyKey} of customer product set {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/customerproductsets({key})/products({productKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product within a customer product set
      effect: read
      questions:
      - Is a particular product included in a customer's product set?
      - Can I fetch one product that belongs to a product set?
      instructions:
      - text: Get product {productKey} in customer product set {key}.
        slots:
          key: path.key
          productKey: path.productKey
      - text: Check that product {productKey} is part of product set {key}.
        slots:
          key: path.key
          productKey: path.productKey
      method: generated
      generated: '2026-09-26'