Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Punch Out Customer User Profile Maps API

10 actions 10 updates phrasing extends openapi/optimizely-punch-out-customer-user-profile-maps-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/PunchOutCustomerUserProfileMaps'].get
$.paths['/api/v1/admin/PunchOutCustomerUserProfileMaps'].post
$.paths['/api/v1/admin/PunchOutCustomerUserProfileMaps({id})'].get
$.paths['/api/v1/admin/PunchOutCustomerUserProfileMaps({id})'].put
$.paths['/api/v1/admin/PunchOutCustomerUserProfileMaps({id})'].delete
$.paths['/api/v1/admin/PunchOutCustomerUserProfileMaps({id})'].patch
$.paths['/api/v1/admin/PunchOutCustomerUserProfileMaps/Default.Default()'].get
$.paths['/api/v1/admin/punchoutcustomeruserprofilemaps/delete'].delete
$.paths['/api/v1/admin/punchoutcustomeruserprofilemaps({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 Punch Out Customer User Profile Maps API
  version: 1.0.0
extends: openapi/optimizely-punch-out-customer-user-profile-maps-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/PunchOutCustomerUserProfileMaps'].get
  update:
    x-apievangelist-phrasing:
      intent: List punchout customer-user mappings
      effect: read
      questions:
      - Which punchout users are mapped to which customers and addresses?
      - Can I filter punchout customer user profile maps by customer?
      instructions:
      - text: List all punchout customer user profile maps.
      - text: List punchout customer user maps matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutCustomerUserProfileMaps'].post
  update:
    x-apievangelist-phrasing:
      intent: Map a punchout user to a customer
      effect: write
      questions:
      - How do I map a punchout user profile to a customer and ship-to address?
      - What address does a punchout customer user mapping require?
      instructions:
      - text: Map user profile {userProfileId} to customer {customerId} at address {addressId} for punchout.
        slots:
          userProfileId: requestBody.userProfileId
          customerId: requestBody.customerId
          addressId: requestBody.addressId
      - text: Create a punchout customer user mapping with address {addressId}.
        slots:
          addressId: requestBody.addressId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutCustomerUserProfileMaps({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a punchout customer-user mapping
      effect: read
      questions:
      - How do I look up one punchout customer user mapping?
      - Which address is a specific punchout user mapped to?
      instructions:
      - text: Get punchout customer user profile map {id}.
        slots:
          id: path.id
      - text: Show the customer and address on punchout mapping {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutCustomerUserProfileMaps({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a punchout customer-user mapping
      effect: write
      questions:
      - How do I overwrite a punchout customer user mapping entirely?
      - Does replacing a punchout mapping need the address again?
      instructions:
      - text: Replace punchout mapping {id} with customer {customerId}, user {userProfileId}, address {addressId}.
        slots:
          id: path.id
          customerId: requestBody.customerId
          userProfileId: requestBody.userProfileId
          addressId: requestBody.addressId
      - text: Fully overwrite punchout customer user map {id} using address {addressId}.
        slots:
          id: path.id
          addressId: requestBody.addressId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutCustomerUserProfileMaps({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a punchout customer-user mapping
      effect: destructive
      questions:
      - How do I unmap a punchout user from a customer?
      - Can I delete a punchout mapping only if its ETag matches?
      instructions:
      - text: Delete punchout customer user profile map {id}.
        slots:
          id: path.id
      - text: Delete punchout mapping {id} if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutCustomerUserProfileMaps({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a punchout customer-user mapping
      effect: write
      questions:
      - How do I change the ship-to address on a punchout user mapping?
      - Can I point a punchout mapping at a different customer?
      instructions:
      - text: Change address of punchout mapping {id} to {addressId}.
        slots:
          id: path.id
          addressId: requestBody.addressId
      - text: Point punchout mapping {id} at customer {customerId}.
        slots:
          id: path.id
          customerId: requestBody.customerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutCustomerUserProfileMaps/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default punchout mapping template
      effect: read
      questions:
      - What default values does a new punchout customer user mapping start with?
      - Where can I get a blank punchout mapping record?
      instructions:
      - text: Get the default punchout customer user profile map template.
      - text: Show default values for a new punchout mapping.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/punchoutcustomeruserprofilemaps/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete punchout customer-user mappings
      effect: destructive
      questions:
      - How do I delete several punchout user mappings at once?
      - Can I bulk remove punchout customer user maps by id?
      instructions:
      - text: Delete punchout customer user profile maps {ids}.
        slots:
          ids: query.ids
      - text: Bulk remove punchout mappings {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/punchoutcustomeruserprofilemaps({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a punchout mapping custom property
      effect: read
      questions:
      - How do I read a custom property on a punchout customer user mapping?
      - Where is one custom property value for a punchout mapping?
      instructions:
      - text: Get custom property {custompropertyKey} of punchout mapping {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show punchout customer user map {key}'s custom property {custompropertyKey}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'